Introduction to I38 help file loads on first start after config generation.
This commit is contained in:
Storm Dragon
parent
d66d60ee49
commit
5229b3b18a
566
I38.html
Normal file
566
I38.html
Normal file
@ -0,0 +1,566 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="pandoc" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||||
<title>Welcome to I38</title>
|
||||
<style>
|
||||
html {
|
||||
color: #1a1a1a;
|
||||
background-color: #fdfdfd;
|
||||
}
|
||||
body {
|
||||
margin: 0 auto;
|
||||
max-width: 36em;
|
||||
padding-left: 50px;
|
||||
padding-right: 50px;
|
||||
padding-top: 50px;
|
||||
padding-bottom: 50px;
|
||||
hyphens: auto;
|
||||
overflow-wrap: break-word;
|
||||
text-rendering: optimizeLegibility;
|
||||
font-kerning: normal;
|
||||
}
|
||||
@media (max-width: 600px) {
|
||||
body {
|
||||
font-size: 0.9em;
|
||||
padding: 12px;
|
||||
}
|
||||
h1 {
|
||||
font-size: 1.8em;
|
||||
}
|
||||
}
|
||||
@media print {
|
||||
html {
|
||||
background-color: white;
|
||||
}
|
||||
body {
|
||||
background-color: transparent;
|
||||
color: black;
|
||||
font-size: 12pt;
|
||||
}
|
||||
p, h2, h3 {
|
||||
orphans: 3;
|
||||
widows: 3;
|
||||
}
|
||||
h2, h3, h4 {
|
||||
page-break-after: avoid;
|
||||
}
|
||||
}
|
||||
p {
|
||||
margin: 1em 0;
|
||||
}
|
||||
a {
|
||||
color: #1a1a1a;
|
||||
}
|
||||
a:visited {
|
||||
color: #1a1a1a;
|
||||
}
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
svg {
|
||||
height: auto;
|
||||
max-width: 100%;
|
||||
}
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
margin-top: 1.4em;
|
||||
}
|
||||
h5, h6 {
|
||||
font-size: 1em;
|
||||
font-style: italic;
|
||||
}
|
||||
h6 {
|
||||
font-weight: normal;
|
||||
}
|
||||
ol, ul {
|
||||
padding-left: 1.7em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
li > ol, li > ul {
|
||||
margin-top: 0;
|
||||
}
|
||||
blockquote {
|
||||
margin: 1em 0 1em 1.7em;
|
||||
padding-left: 1em;
|
||||
border-left: 2px solid #e6e6e6;
|
||||
color: #606060;
|
||||
}
|
||||
code {
|
||||
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
|
||||
font-size: 85%;
|
||||
margin: 0;
|
||||
hyphens: manual;
|
||||
}
|
||||
pre {
|
||||
margin: 1em 0;
|
||||
overflow: auto;
|
||||
}
|
||||
pre code {
|
||||
padding: 0;
|
||||
overflow: visible;
|
||||
overflow-wrap: normal;
|
||||
}
|
||||
.sourceCode {
|
||||
background-color: transparent;
|
||||
overflow: visible;
|
||||
}
|
||||
hr {
|
||||
border: none;
|
||||
border-top: 1px solid #1a1a1a;
|
||||
height: 1px;
|
||||
margin: 1em 0;
|
||||
}
|
||||
table {
|
||||
margin: 1em 0;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
overflow-x: auto;
|
||||
display: block;
|
||||
font-variant-numeric: lining-nums tabular-nums;
|
||||
}
|
||||
table caption {
|
||||
margin-bottom: 0.75em;
|
||||
}
|
||||
tbody {
|
||||
margin-top: 0.5em;
|
||||
border-top: 1px solid #1a1a1a;
|
||||
border-bottom: 1px solid #1a1a1a;
|
||||
}
|
||||
th {
|
||||
border-top: 1px solid #1a1a1a;
|
||||
padding: 0.25em 0.5em 0.25em 0.5em;
|
||||
}
|
||||
td {
|
||||
padding: 0.125em 0.5em 0.25em 0.5em;
|
||||
}
|
||||
header {
|
||||
margin-bottom: 4em;
|
||||
text-align: center;
|
||||
}
|
||||
#TOC li {
|
||||
list-style: none;
|
||||
}
|
||||
#TOC ul {
|
||||
padding-left: 1.3em;
|
||||
}
|
||||
#TOC > ul {
|
||||
padding-left: 0;
|
||||
}
|
||||
#TOC a:not(:hover) {
|
||||
text-decoration: none;
|
||||
}
|
||||
code{white-space: pre-wrap;}
|
||||
span.smallcaps{font-variant: small-caps;}
|
||||
div.columns{display: flex; gap: min(4vw, 1.5em);}
|
||||
div.column{flex: auto; overflow-x: auto;}
|
||||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||||
/* The extra [class] is a hack that increases specificity enough to
|
||||
override a similar rule in reveal.js */
|
||||
ul.task-list[class]{list-style: none;}
|
||||
ul.task-list li input[type="checkbox"] {
|
||||
font-size: inherit;
|
||||
width: 0.8em;
|
||||
margin: 0 0.8em 0.2em -1.6em;
|
||||
vertical-align: middle;
|
||||
}
|
||||
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header id="title-block-header">
|
||||
<h1 class="title">Welcome to I38</h1>
|
||||
</header>
|
||||
<h1 id="welcome-to-i38---accessible-i3-window-manager">Welcome to I38 -
|
||||
Accessible i3 Window Manager</h1>
|
||||
<blockquote>
|
||||
<p><strong>Note:</strong> This help guide has been tailored to your
|
||||
specific configuration. You’ve chosen <strong>BROWSER</strong> as your
|
||||
web browser, <strong>MODKEY</strong> as your mod key, and you’re using
|
||||
the <strong>SCREENREADER</strong> screen reader.</p>
|
||||
</blockquote>
|
||||
<h2 id="introduction-to-i38">Introduction to I38</h2>
|
||||
<p>I38 is a configuration for the i3 window manager that makes it more
|
||||
accessible for blind people. It features audio feedback, screen reader
|
||||
integration, and keyboard shortcuts designed for non-visual
|
||||
navigation.</p>
|
||||
<p>Unlike traditional desktop environments like GNOME or MATE, i3 is a
|
||||
tiling window manager, which means windows are arranged in a
|
||||
non-overlapping layout. This can be more efficient to navigate by
|
||||
keyboard, as windows are organized in a predictable structure.</p>
|
||||
<h3 id="coming-from-gnome-or-mate">Coming from GNOME or MATE?</h3>
|
||||
<p>If you’re transitioning from GNOME or MATE, here are some key
|
||||
differences to understand:</p>
|
||||
<ul>
|
||||
<li><strong>Window Management</strong>: In GNOME/MATE, windows can
|
||||
overlap freely and are typically manipulated with a mouse. In i3/I38,
|
||||
windows tile automatically and are primarily controlled with keyboard
|
||||
shortcuts.</li>
|
||||
<li><strong>Panels and Indicators</strong>: Instead of persistent panels
|
||||
with menus and indicators, I38 uses keyboard shortcuts to access
|
||||
functionality.</li>
|
||||
<li><strong>Workspace Navigation</strong>: While GNOME/MATE have
|
||||
workspaces that you can switch between, I38’s workspaces are more
|
||||
central to the workflow and are accessed via dedicated keyboard
|
||||
shortcuts.</li>
|
||||
<li><strong>Application Launching</strong>: Rather than using a start
|
||||
menu or activities overview, I38 provides keyboard shortcuts for
|
||||
launching applications.</li>
|
||||
</ul>
|
||||
<p>I38 has been configured to make this transition easier by providing a
|
||||
tabbed layout (similar to browser tabs) and shortcuts that may feel
|
||||
somewhat familiar.</p>
|
||||
<h2 id="basic-concepts">Basic Concepts</h2>
|
||||
<h3 id="workspaces">Workspaces</h3>
|
||||
<p>Workspaces act like virtual desktops, allowing you to organize
|
||||
applications. You have 10 workspaces available.</p>
|
||||
<ul>
|
||||
<li>Switch to workspace: <code>Control</code> + <code>F1</code> through
|
||||
<code>F10</code></li>
|
||||
<li>Move window to workspace: <code>Control</code> + <code>Shift</code>
|
||||
+ <code>F1</code> through <code>F10</code></li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> Similar to workspaces in GNOME/MATE,
|
||||
but with dedicated keyboard shortcuts rather than overview modes or
|
||||
workspace switchers.</p>
|
||||
<h3 id="window-management">Window Management</h3>
|
||||
<p>Windows in I38 are arranged in a tabbed layout by default, which
|
||||
means windows take up the entire screen and you can switch between them
|
||||
like browser tabs.</p>
|
||||
<ul>
|
||||
<li>Switch between windows: <code>Alt</code> + <code>Tab</code> (next)
|
||||
or <code>Alt</code> + <code>Shift</code> + <code>Tab</code>
|
||||
(previous)</li>
|
||||
<li>Launch terminal: <code>MODKEY</code> + <code>Return</code></li>
|
||||
<li>Close window: <code>MODKEY</code> + <code>F4</code></li>
|
||||
<li>Toggle fullscreen: <code>MODKEY</code> + <code>BackSpace</code></li>
|
||||
<li>List windows in current workspace: <code>RATPOISONKEY</code> then
|
||||
<code>'</code> (apostrophe)</li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> Alt+Tab works similarly to
|
||||
GNOME/MATE, but window placement is automatic rather than manual.</p>
|
||||
<h2 id="modes-in-i38">Modes in I38</h2>
|
||||
<h3 id="default-mode">Default Mode</h3>
|
||||
<p>This is the standard mode for working with applications. Most
|
||||
commands start with your mod key (<code>MODKEY</code>).</p>
|
||||
<h3 id="ratpoison-mode">Ratpoison Mode</h3>
|
||||
<p>Ratpoison mode allows quick access to common actions using shorter
|
||||
key combinations. To enter Ratpoison mode, press
|
||||
<code>RATPOISONKEY</code>. After pressing this key, you can execute
|
||||
commands with single keystrokes.</p>
|
||||
<p>Common Ratpoison mode commands:</p>
|
||||
<table>
|
||||
<colgroup>
|
||||
<col style="width: 38%" />
|
||||
<col style="width: 61%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Key</th>
|
||||
<th>Action</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>c</code></td>
|
||||
<td>Launch a terminal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>e</code></td>
|
||||
<td>Open text editor (TEXTEDITOR)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>w</code></td>
|
||||
<td>Launch web browser (BROWSER)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>k</code></td>
|
||||
<td>Kill (close) the current window</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>?</code></td>
|
||||
<td>Show I38 help</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Escape</code> or <code>Control</code> + <code>g</code></td>
|
||||
<td>Exit Ratpoison mode without taking action</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Shift</code> + <code>c</code></td>
|
||||
<td>Restart Cthulhu screen reader</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Shift</code> + <code>o</code></td>
|
||||
<td>Restart Orca screen reader</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Shift</code> + <code>t</code></td>
|
||||
<td>Toggle screen reader</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Control</code> + <code>;</code></td>
|
||||
<td>Reload I38 configuration</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Control</code> + <code>q</code></td>
|
||||
<td>Exit i3 (log out)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>!</code></td>
|
||||
<td>Open run dialog</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Alt</code> + <code>b</code></td>
|
||||
<td>Check battery status</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>g</code></td>
|
||||
<td>Check game controller status</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><em>GNOME/MATE comparison:</em> This mode has no direct equivalent in
|
||||
GNOME/MATE. Think of it as a command palette or quick launcher activated
|
||||
by a single key.</p>
|
||||
<h3 id="bypass-mode">Bypass Mode</h3>
|
||||
<p>Bypass mode passes all keys directly to the application, which is
|
||||
useful for applications that need many keyboard shortcuts. To enter
|
||||
bypass mode, press <code>MODKEY</code> + <code>Shift</code> +
|
||||
<code>BackSpace</code>. Use the same key combination to exit bypass
|
||||
mode.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> In GNOME/MATE, applications always
|
||||
receive keyboard input directly. Bypass mode simulates this behavior
|
||||
within i3.</p>
|
||||
<h2 id="accessibility-features">Accessibility Features</h2>
|
||||
<h3 id="screen-reader">Screen Reader</h3>
|
||||
<p>I38 is configured to work with your screen reader (SCREENREADER). The
|
||||
screen reader will provide spoken feedback about what’s happening on
|
||||
screen so long as there is a window. If you don’t have a window open and
|
||||
need to change something SCREENREADER related, press Control+Alt+d to
|
||||
bring up the desktop, then screen reader keys should work.</p>
|
||||
<ul>
|
||||
<li>Toggle screen reader: <code>RATPOISONKEY</code> then
|
||||
<code>Shift</code> + <code>t</code></li>
|
||||
<li>Restart screen reader: <code>RATPOISONKEY</code> then
|
||||
<code>Shift</code> + <code>o</code> (for Orca) or <code>Shift</code> +
|
||||
<code>c</code> (for Cthulhu)</li>
|
||||
<li>Interrupt speech: <code>MODKEY</code> + <code>Shift</code> +
|
||||
<code>F5</code></li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> GNOME uses Orca by default with its
|
||||
own keyboard shortcuts. I38 integrates screen readers more deeply with
|
||||
the window manager.</p>
|
||||
<h3 id="braille-display-support">Braille Display Support</h3>
|
||||
<p>If you’ve enabled braille display support during setup, I38 will
|
||||
start XBrlAPI automatically to provide braille output from your screen
|
||||
reader.</p>
|
||||
<h3 id="ocr-optical-character-recognition">OCR (Optical Character
|
||||
Recognition)</h3>
|
||||
<p>If installed, you can use OCR to read text from images or
|
||||
inaccessible applications:</p>
|
||||
<ul>
|
||||
<li><code>MODKEY</code> + <code>F5</code>: Perform OCR on the entire
|
||||
screen and speak the content</li>
|
||||
<li>In Ratpoison mode: <code>Print</code> or <code>MODKEY</code> +
|
||||
<code>r</code>: Perform OCR and save to clipboard</li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> OCR features are typically not
|
||||
integrated into GNOME/MATE by default.</p>
|
||||
<h3 id="sound-effects">Sound Effects</h3>
|
||||
<p>I38 provides audio feedback for many actions:</p>
|
||||
<ul>
|
||||
<li>Window open/close: Ascending/descending tones</li>
|
||||
<li>Mode changes: Distinctive sounds for each mode</li>
|
||||
<li>Workspace changes: Subtle audio cues</li>
|
||||
<li>Fullscreen toggle: Special sound effect</li>
|
||||
</ul>
|
||||
<p>This audio feedback provides non-visual confirmation of actions and
|
||||
state changes.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> GNOME/MATE typically have fewer sound
|
||||
effects for window management actions.</p>
|
||||
<h2 id="application-menu-and-running-programs">Application Menu and
|
||||
Running Programs</h2>
|
||||
<p>Access applications in multiple ways:</p>
|
||||
<ul>
|
||||
<li>Applications menu: <code>MODKEY</code> + <code>F1</code></li>
|
||||
<li>Run dialog (enter a command): <code>MODKEY</code> + <code>F2</code>
|
||||
or in Ratpoison mode, <code>!</code> (exclamation mark)</li>
|
||||
<li>Common applications have dedicated shortcuts in Ratpoison mode (see
|
||||
table above)</li>
|
||||
</ul>
|
||||
<p>The applications menu is organized by categories similar to
|
||||
traditional desktop environments.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> Instead of clicking on application
|
||||
icons or using a start menu, I38 provides keyboard shortcuts to access
|
||||
applications.</p>
|
||||
<h2 id="reminders-and-notifications">Reminders and Notifications</h2>
|
||||
<p>I38 includes integration with the <code>remind</code> program for
|
||||
managing reminders:</p>
|
||||
<ul>
|
||||
<li>Access the reminder tool: <code>RATPOISONKEY</code> then
|
||||
<code>r</code></li>
|
||||
<li>Create various types of reminders (one-time, daily, weekly,
|
||||
monthly)</li>
|
||||
<li>Get notification alerts for your reminders</li>
|
||||
</ul>
|
||||
<p>The reminder tool provides the following features:</p>
|
||||
<ul>
|
||||
<li><strong>One-time Reminders</strong>: Set for a specific date and
|
||||
time</li>
|
||||
<li><strong>Daily Reminders</strong>: Occur every day at the specified
|
||||
time</li>
|
||||
<li><strong>Weekly Reminders</strong>: Occur on specific days of the
|
||||
week</li>
|
||||
<li><strong>Monthly Reminders</strong>: Occur on a specific day each
|
||||
month or the last day of each month</li>
|
||||
<li><strong>Custom Reminders</strong>: Create complex reminder
|
||||
patterns</li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> Similar to calendar applications in
|
||||
GNOME/MATE but with a simplified interface optimized for keyboard
|
||||
navigation.</p>
|
||||
<h2 id="volume-and-media-controls">Volume and Media Controls</h2>
|
||||
<h3 id="system-volume">System Volume</h3>
|
||||
<ul>
|
||||
<li>Increase volume: <code>MODKEY</code> +
|
||||
<code>XF86AudioRaiseVolume</code></li>
|
||||
<li>Decrease volume: <code>MODKEY</code> +
|
||||
<code>XF86AudioLowerVolume</code></li>
|
||||
<li>Mute/unmute: <code>MODKEY</code> + <code>XF86AudioMute</code></li>
|
||||
</ul>
|
||||
<h3 id="media-player-controls">Media Player Controls</h3>
|
||||
<ul>
|
||||
<li>Play/Pause: <code>XF86AudioPlay</code></li>
|
||||
<li>Next track: <code>XF86AudioNext</code></li>
|
||||
<li>Previous track: <code>XF86AudioPrev</code></li>
|
||||
<li>Stop: <code>XF86AudioStop</code></li>
|
||||
<li>Media info: <code>MODKEY</code> + <code>XF86AudioPlay</code></li>
|
||||
</ul>
|
||||
<p>In Ratpoison mode, these are also available with Alt+Shift
|
||||
combinations:</p>
|
||||
<ul>
|
||||
<li>Increase volume: <code>Alt</code> + <code>Shift</code> +
|
||||
<code>=</code></li>
|
||||
<li>Decrease volume: <code>Alt</code> + <code>Shift</code> +
|
||||
<code>-</code></li>
|
||||
<li>Previous track: <code>Alt</code> + <code>Shift</code> +
|
||||
<code>z</code></li>
|
||||
<li>Pause: <code>Alt</code> + <code>Shift</code> + <code>c</code></li>
|
||||
<li>Play: <code>Alt</code> + <code>Shift</code> + <code>x</code></li>
|
||||
<li>Stop: <code>Alt</code> + <code>Shift</code> + <code>v</code></li>
|
||||
<li>Next track: <code>Alt</code> + <code>Shift</code> +
|
||||
<code>b</code></li>
|
||||
<li>Media info: <code>Alt</code> + <code>Shift</code> +
|
||||
<code>u</code></li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> Media controls are similar to those
|
||||
in GNOME/MATE, with the addition of audio feedback.</p>
|
||||
<h2 id="file-management">File Management</h2>
|
||||
<p>I38 uses FILEBROWSER for file management. Launch it in Ratpoison mode
|
||||
with the <code>f</code> key.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> Similar functionality to Nautilus
|
||||
(GNOME) or Caja (MATE), but launched via keyboard shortcut rather than
|
||||
from a desktop icon or menu.</p>
|
||||
<h2 id="system-operations">System Operations</h2>
|
||||
<ul>
|
||||
<li>Reload I38 configuration: In Ratpoison mode, <code>Control</code> +
|
||||
<code>;</code> (semicolon)</li>
|
||||
<li>Exit i3 (log out): In Ratpoison mode, <code>Control</code> +
|
||||
<code>q</code></li>
|
||||
<li>Check battery status: In Ratpoison mode, <code>Alt</code> +
|
||||
<code>b</code></li>
|
||||
<li>Check game controller status: In Ratpoison mode, <code>g</code></li>
|
||||
<li>Adjust screen brightness (if xrandr is available): In Ratpoison
|
||||
mode, <code>Alt</code> + <code>s</code></li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> These functions are typically
|
||||
available through system menus or indicators in GNOME/MATE.</p>
|
||||
<h2 id="keyboard-layouts">Keyboard Layouts</h2>
|
||||
<p>Switch between layouts: <code>Super</code> + <code>Space</code></p>
|
||||
<p>This is only available if you chose multiple keyboard layouts during
|
||||
setup.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> Similar to keyboard layout switching
|
||||
in GNOME/MATE, but with a different default shortcut.</p>
|
||||
<h2 id="desktop-and-window-decorations">Desktop and Window
|
||||
Decorations</h2>
|
||||
<p>Unlike GNOME or MATE, i3 uses minimal window decorations. Windows
|
||||
don’t have title bars with minimize/maximize buttons. Instead, windows
|
||||
fill their available space automatically, and interactions are performed
|
||||
through keyboard shortcuts.</p>
|
||||
<ul>
|
||||
<li>Show desktop icons: <code>MODKEY</code> + <code>Control</code> +
|
||||
<code>d</code></li>
|
||||
</ul>
|
||||
<h2 id="clipboard-management">Clipboard Management</h2>
|
||||
<p>I38 includes clipboard management features:</p>
|
||||
<ul>
|
||||
<li>Access clipboard history: <code>MODKEY</code> + <code>Control</code>
|
||||
+ <code>c</code></li>
|
||||
</ul>
|
||||
<h2 id="bookmark-management">Bookmark Management</h2>
|
||||
<ul>
|
||||
<li>Access bookmarks: <code>MODKEY</code> + <code>Control</code> +
|
||||
<code>b</code></li>
|
||||
</ul>
|
||||
<p><em>GNOME/MATE comparison:</em> Bookmarks are typically managed
|
||||
within applications in GNOME/MATE. I38 provides a system-wide bookmark
|
||||
manager.</p>
|
||||
<h2 id="tips-for-new-users">Tips for New Users</h2>
|
||||
<ul>
|
||||
<li><strong>Start with Ratpoison mode</strong>: Learn the single-key
|
||||
commands first, as they’re easier to remember.</li>
|
||||
<li><strong>Use the window list</strong>: When you’re lost, use
|
||||
<code>RATPOISONKEY</code> then <code>'</code> to show all windows in the
|
||||
current workspace.</li>
|
||||
<li><strong>Bookmark important websites</strong>: Use
|
||||
<code>MODKEY</code> + <code>Control</code> + <code>b</code> to access
|
||||
bookmarks.</li>
|
||||
<li><strong>Remember the help shortcut</strong>: <code>MODKEY</code> +
|
||||
<code>Shift</code> + <code>F1</code> is your friend when you need
|
||||
guidance.</li>
|
||||
<li><strong>Let the sound effects guide you</strong>: Pay attention to
|
||||
the audio cues to understand what’s happening.</li>
|
||||
<li><strong>Take advantage of OCR</strong>: If an application isn’t
|
||||
accessible, try the OCR function.</li>
|
||||
</ul>
|
||||
<h3 id="transitioning-from-gnomemate">Transitioning from GNOME/MATE</h3>
|
||||
<ul>
|
||||
<li>Start by learning the basic navigation shortcuts before exploring
|
||||
advanced features</li>
|
||||
<li>The tabbed layout should feel somewhat familiar if you’re used to
|
||||
browser tabs</li>
|
||||
<li>Alt+Tab works similarly to GNOME/MATE for switching between
|
||||
windows</li>
|
||||
<li>Focus on keyboard commands rather than looking for visual elements
|
||||
like panels or docks</li>
|
||||
</ul>
|
||||
<h2 id="customization">Customization</h2>
|
||||
<p>You can customize I38 by editing the file
|
||||
<code>~/.config/i3/customizations</code>. This file will not be
|
||||
overwritten when you update I38.</p>
|
||||
<p>Example customizations:</p>
|
||||
<pre><code># Change background color
|
||||
exec_always --no-startup-id xsetroot -solid "#2E3440"
|
||||
|
||||
# Add custom keybinding
|
||||
bindsym $mod+F12 exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ 100%</code></pre>
|
||||
<p>To reconfigure I38 completely, run the <code>i38.sh</code> script
|
||||
again.</p>
|
||||
<p><em>GNOME/MATE comparison:</em> Much more text-based configuration
|
||||
compared to the graphical settings dialogs in GNOME/MATE.</p>
|
||||
<h2 id="getting-help">Getting Help</h2>
|
||||
<p>If you need assistance with I38, you can:</p>
|
||||
<ul>
|
||||
<li>Press <code>MODKEY</code> + <code>Shift</code> + <code>F1</code> to
|
||||
view the help documentation</li>
|
||||
<li>Visit the Stormux website at <a
|
||||
href="https://stormux.org">stormux.org</a></li>
|
||||
<li>Check the i3 documentation at <a
|
||||
href="https://i3wm.org/docs/userguide.html">i3wm.org/docs/userguide.html</a></li>
|
||||
</ul>
|
||||
<hr />
|
||||
<p><em>I38 - Making i3 accessible. A Stormux project. License: GPL
|
||||
v3</em></p>
|
||||
</body>
|
||||
</html>
|
||||
26
i38.sh
26
i38.sh
@ -719,8 +719,34 @@ else
|
||||
echo "exec_always --no-startup-id ${i3Path}/scripts/desktop.sh"
|
||||
fi)
|
||||
|
||||
# First run help documentation
|
||||
exec --no-startup-id bash -c 'if [[ -f "${i3Path}/firstrun" ]]; then ${webBrowser} "${i3Path}/I38.html"& rm "${i3Path}/firstrun"; fi'
|
||||
|
||||
# If you want to add personal customizations to i3, add them in ${i3Path}/customizations
|
||||
# It is not overwritten with the config file is recreated.
|
||||
include "${i3Path}/customizations"
|
||||
EOF
|
||||
touch "${i3Path}/customizations"
|
||||
# Move html help file to destination
|
||||
cp I38.html "${i3Path}/I38.html"
|
||||
|
||||
# More readable version of variables.
|
||||
escapeKey="${escapeKey//Mod1/Alt}"
|
||||
escapeKey="${escapeKey//Mod4/Super}"
|
||||
mod="${mod//Mod1/Alt}"
|
||||
mod="${mod//Mod4/Super}"
|
||||
webBrowser="${webBrowser##*/}"
|
||||
screenReader="${screenReader##*/}"
|
||||
textEditor="${textEditor##*/}"
|
||||
fileBrowser="${fileBrowser##*/}"
|
||||
|
||||
# Customize the html file to the user's choices.
|
||||
sed -i -e "s|BROWSER|${webBrowser}|g" \
|
||||
-e "s|MODKEY|${mod}|g" \
|
||||
-e "s|SCREENREADER|${screenReader}|g" \
|
||||
-e "s|RATPOISONKEY|${escapeKey}|g" \
|
||||
-e "s|TEXTEDITOR|${textEditor}|g" \
|
||||
-e "s|FILEBROWSER|${fileBrowser}|g" "${i3Path}/I38.html"
|
||||
|
||||
# Create the firstrun file
|
||||
touch "${i3Path}/firstrun"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user