storm/I38
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Code and documentation cleanup.

Browse Source
This commit is contained in:
Storm Dragon committed 2026-05-16 19:23:30 -04:00
1 parent 9859cc348b
commit 1b95555007
13 files changed
+165 -116
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

I38.md
+34 -34
View File
@@ -1,6 +1,6 @@
# Welcome to I38 - Accessible i3 Window Manager
> **Note:** This help guide has been tailored to your specific configuration. You've chosen **BROWSER** as your web browser, **MODKEY** as your mod key, and you're using the **SCREENREADER** screen reader.
> **Note:** This help guide has been tailored to your specific configuration. You've chosen **@WEBBROWSER@** as your web browser, **@MODKEY@** as your mod key, and you're using the **@SCREENREADER@** screen reader.
## Introduction to I38
@@ -36,10 +36,10 @@ Workspaces act like virtual desktops, allowing you to organize applications. You
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.
- Switch between windows: `Alt` + `Tab` (next) or `Alt` + `Shift` + `Tab` (previous)
- Launch terminal: `MODKEY` + `Return`
- Close window: `MODKEY` + `F4`
- Toggle fullscreen: `MODKEY` + `BackSpace`
- List windows in current workspace: `RATPOISONKEY` then `'` (apostrophe)
- Launch terminal: `@MODKEY@` + `Return`
- Close window: `@MODKEY@` + `F4`
- Toggle fullscreen: `@MODKEY@` + `BackSpace`
- List windows in current workspace: `@RATPOISONKEY@` then `'` (apostrophe)
*GNOME/MATE comparison:* Alt+Tab works similarly to GNOME/MATE, but window placement is automatic rather than manual.
@@ -48,22 +48,22 @@ Windows in I38 are arranged in a tabbed layout by default, which means windows t
### Default Mode
This is the standard mode for working with applications. Most commands start with your mod key (`MODKEY`).
This is the standard mode for working with applications. Most commands start with your mod key (`@MODKEY@`).
TOPLEVELKEYBINDINGS
### Ratpoison Mode
Ratpoison mode allows quick access to common actions using shorter key combinations. To enter Ratpoison mode, press `RATPOISONKEY`. After pressing this key, you can execute commands with single keystrokes.
Ratpoison mode allows quick access to common actions using shorter key combinations. To enter Ratpoison mode, press `@RATPOISONKEY@`. After pressing this key, you can execute commands with single keystrokes.
Common Ratpoison mode commands:
| Key | Action |
|-----|--------|
| `c` | Launch a terminal |
| `e` | Open text editor (TEXTEDITOR) |
| `e` | Open text editor (@TEXTEDITOR@) |
| `i` | Launch IRC client |
| `w` | Launch web browser (BROWSER) |
| `w` | Launch web browser (@WEBBROWSER@) |
| `k` | Kill (close) the current window |
| `F1` | Show ratpoison mode keybindings |
| `Escape` or `Control` + `g` | Exit Ratpoison mode without taking action |
@@ -80,7 +80,7 @@ Common Ratpoison mode commands:
### Bypass Mode
Bypass mode passes all keys directly to the application, which is useful for applications that need many keyboard shortcuts. To enter bypass mode, press `MODKEY` + `Shift` + `BackSpace`. Use the same key combination to exit bypass mode.
Bypass mode passes all keys directly to the application, which is useful for applications that need many keyboard shortcuts. To enter bypass mode, press `@MODKEY@` + `Shift` + `BackSpace`. Use the same key combination to exit bypass mode.
*GNOME/MATE comparison:* In GNOME/MATE, applications always receive keyboard input directly. Bypass mode simulates this behavior within i3.
@@ -136,7 +136,7 @@ In Panel Mode, single keypresses launch different information panels:
| `Shift` + `b` | Show detailed battery information |
| `m` | Launch password manager |
| `p` | Show power options |
| `Control` + `MODKEY` + `l` | Lock screen *(if screen lock PIN is configured)* |
| `Control` + `@MODKEY@` + `l` | Lock screen *(if screen lock PIN is configured)* |
| `Escape` or `Control` + `g` | Exit Panel Mode without taking action |
Just like Ratpoison Mode, Panel Mode automatically returns you to Default Mode after a selection is made or when you press Escape/Control+g to cancel.
@@ -200,11 +200,11 @@ waytray is an optional dependency. If installed, I38 will automatically configur
### Screen Reader
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.
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.
- Toggle screen reader: `RATPOISONKEY` then `Shift` + `t`
- Restart screen reader: `RATPOISONKEY` then `Shift` + `o` (for Orca) or `Shift` + `c` (for Cthulhu)
- Interrupt speech: `MODKEY` + `Shift` + `F5`
- Toggle screen reader: `@RATPOISONKEY@` then `Shift` + `t`
- Restart screen reader: `@RATPOISONKEY@` then `Shift` + `o` (for Orca) or `Shift` + `c` (for Cthulhu)
- Interrupt speech: `@MODKEY@` + `Shift` + `F5`
*GNOME/MATE comparison:* GNOME uses Orca by default with its own keyboard shortcuts. I38 integrates screen readers more deeply with the window manager.
@@ -216,14 +216,14 @@ If you've enabled braille display support during setup, I38 will start XBrlAPI a
If required dependencies are installed, you can use OCR to read text from images or inaccessible applications:
- `MODKEY` + `F5`: Perform OCR on the entire screen and speak the content
- In Ratpoison mode: `Print` or `MODKEY` + `r`: Perform OCR and save to clipboard
- `@MODKEY@` + `F5`: Perform OCR on the entire screen and speak the content
- In Ratpoison mode: `Print` or `@MODKEY@` + `r`: Perform OCR and save to clipboard
*GNOME/MATE comparison:* OCR features are typically not integrated into GNOME/MATE by default.
### Screen Lock
If you enabled the I38 privacy screen lock during setup, press `Control` + `Alt` + `Tab` to enter panel mode, then press `Control` + `MODKEY` + `l` to lock the screen. This is a privacy screen for I38, not a secure system lock.
If you enabled the I38 privacy screen lock during setup, press `Control` + `Alt` + `Tab` to enter panel mode, then press `Control` + `@MODKEY@` + `l` to lock the screen. This is a privacy screen for I38, not a secure system lock.
When a screen lock PIN is configured, I38 can also autolock after an idle timeout. The default is never. Autolock is X11/i3-only and requires `xprintidle`; if `playerctl` is installed, I38 will avoid autolocking during likely video playback.
@@ -244,8 +244,8 @@ This audio feedback provides non-visual confirmation of actions and state change
Access applications in multiple ways:
- Applications menu: `MODKEY` + `F1`
- Run dialog (enter a command): `MODKEY` + `F2` or in Ratpoison mode, `!` (exclamation mark)
- Applications menu: `@MODKEY@` + `F1`
- Run dialog (enter a command): `@MODKEY@` + `F2` or in Ratpoison mode, `!` (exclamation mark)
- Common applications have dedicated shortcuts in Ratpoison mode (see table above)
The applications menu is organized by categories similar to traditional desktop environments.
@@ -276,9 +276,9 @@ The reminder tool provides the following features:
### System Volume
- Increase volume: `MODKEY` + `XF86AudioRaiseVolume`
- Decrease volume: `MODKEY` + `XF86AudioLowerVolume`
- Mute/unmute: `MODKEY` + `XF86AudioMute`
- Increase volume: `@MODKEY@` + `XF86AudioRaiseVolume`
- Decrease volume: `@MODKEY@` + `XF86AudioLowerVolume`
- Mute/unmute: `@MODKEY@` + `XF86AudioMute`
### Media Player Controls
@@ -286,7 +286,7 @@ The reminder tool provides the following features:
- Next track: `XF86AudioNext`
- Previous track: `XF86AudioPrev`
- Stop: `XF86AudioStop`
- Media info: `MODKEY` + `XF86AudioPlay`
- Media info: `@MODKEY@` + `XF86AudioPlay`
In Ratpoison mode, these are also available with Alt+Shift combinations:
@@ -304,7 +304,7 @@ In Ratpoison mode, these are also available with Alt+Shift combinations:
## File Management
I38 uses FILEBROWSER for file management. Launch it in Ratpoison mode with the `f` key.
@FILEBROWSERHELP@
*GNOME/MATE comparison:* Similar functionality to Nautilus (GNOME) or Caja (MATE), but launched via keyboard shortcut rather than from a desktop icon or menu.
@@ -333,26 +333,26 @@ This is only available if you chose multiple keyboard layouts during setup.
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.
- Show desktop icons: `MODKEY` + `Control` + `d`
- Show desktop icons: `@MODKEY@` + `Control` + `d`
## Clipboard Management
I38 includes clipboard management features:
- Access clipboard history: `MODKEY` + `Control` + `c`
- Access clipboard history: `@MODKEY@` + `Control` + `c`
## Bookmark Management
- Access bookmarks: `MODKEY` + `Control` + `b`
- Access bookmarks: `@MODKEY@` + `Control` + `b`
*GNOME/MATE comparison:* Bookmarks are typically managed within applications in GNOME/MATE. I38 provides a system-wide bookmark manager.
## Tips for New Users
- **Use the window list**: When you're lost, use `RATPOISONKEY` then `'` to show all windows in the current workspace.
- **Bookmark important websites**: Use `MODKEY` + `Control` + `b` to access bookmarks.
- **Use the window list**: When you're lost, use `@RATPOISONKEY@` then `'` to show all windows in the current workspace.
- **Bookmark important websites**: Use `@MODKEY@` + `Control` + `b` to access bookmarks.
- **Remember the help shortcuts**:
- `MODKEY` + `Shift` + `F1` opens the complete I38 HTML guide
- `@MODKEY@` + `Shift` + `F1` opens the complete I38 HTML guide
- Press `F1` in ratpoison or panel mode for quick keybinding reference specific to that mode
- **Let the sound effects guide you**: Pay attention to the audio cues to understand what's happening.
- **Take advantage of OCR**: If an application isn't accessible, try the OCR function.
@@ -388,8 +388,8 @@ I38 checks for updates in the background during your desktop session. If a newer
To update I38 on this system:
1. Open a terminal with `MODKEY` + `Return`.
2. Type `cd "I38CHECKOUTPATH"` and press Enter.
1. Open a terminal with `@MODKEY@` + `Return`.
2. Type `cd "@I38CHECKOUTPATH@"` and press Enter.
3. Type `git pull` and press Enter.
4. Type `./i38.sh` and press Enter.
@@ -401,7 +401,7 @@ If you only need to copy the latest scripts and do not want to regenerate the fu
If you need assistance with I38, you can:
- Press `MODKEY` + `Shift` + `F1` to view the help documentation
- Press `@MODKEY@` + `Shift` + `F1` to view the help documentation
- Visit the Stormux website at [stormux.org](https://stormux.org)
- Join the Stormux irc at irc.stormux.org #stormux or #a11y
- Check the i3 documentation at [i3wm.org/docs/userguide.html](https://i3wm.org/docs/userguide.html)