summaryrefslogtreecommitdiff
path: root/Base/usr/share/man
diff options
context:
space:
mode:
authorCubic Love <7754483+cubiclove@users.noreply.github.com>2023-02-28 19:25:37 +0000
committerAndrew Kaster <andrewdkaster@gmail.com>2023-03-25 14:35:11 -0600
commit0b14ef134d411ccc01a8c70d62f8bdf331892b16 (patch)
tree4074e9b640e673d6dbfef48853178d3d85506617 /Base/usr/share/man
parent911baf3b7c4a69fe691b2603bfeb771acaea2256 (diff)
downloadserenity-0b14ef134d411ccc01a8c70d62f8bdf331892b16.zip
Base: Add Keyboard Shortcuts & Tips and Tricks man pages
Add a list of system and general keyboard shortcuts as well as a list of tips and tricks to man7 (Miscellanea). Add links to these in the Help-index to aid discoverability for new users.
Diffstat (limited to 'Base/usr/share/man')
-rw-r--r--Base/usr/share/man/man7/Help-index.md8
-rw-r--r--Base/usr/share/man/man7/KeyboardShortcuts.md69
-rw-r--r--Base/usr/share/man/man7/Tips-and-Tricks.md62
3 files changed, 137 insertions, 2 deletions
diff --git a/Base/usr/share/man/man7/Help-index.md b/Base/usr/share/man/man7/Help-index.md
index 4ae617b356..8883c6c74d 100644
--- a/Base/usr/share/man/man7/Help-index.md
+++ b/Base/usr/share/man/man7/Help-index.md
@@ -1,4 +1,4 @@
-![Help icon](/res/icons/32x32/app-help.png)
+![Help Icon](/res/icons/32x32/app-help.png)
## Welcome to the SerenityOS on-line help system!
@@ -12,6 +12,10 @@ There's also a full-text search option under the **Search** tab.
If you want more information on the structure of the manual system, take a look at [`man(7)`](help://man/7/man).
+### Getting Started
+* [Keyboard Shortcuts](help://man/7/KeyboardShortcuts)
+* [Tips and Tricks](help://man/7/Tips-and-Tricks)
+
---
-Thank you for using ***SerenityOS Help!***
+Thank you for using ***SerenityOS Help!*** \ No newline at end of file
diff --git a/Base/usr/share/man/man7/KeyboardShortcuts.md b/Base/usr/share/man/man7/KeyboardShortcuts.md
new file mode 100644
index 0000000000..5006a46a56
--- /dev/null
+++ b/Base/usr/share/man/man7/KeyboardShortcuts.md
@@ -0,0 +1,69 @@
+![Keyboard Icon](/res/icons/32x32/app-keyboard-settings.png)
+
+## Name
+Keyboard Shortcuts
+
+## Description
+This is a collection of common keyboard shortcuts in SerenityOS.
+
+### Keywords
+* `Super` means the ⊞ Windows or ⌘ Command key (and is sometimes called 'Meta' on Linux)
+* `Alt` is equivalent to ⌥ Option on macOS
+
+## General
+| Shortcut | Action |
+|---------------|------------------------------------------------------------------------------------------------|
+| `Super` | Open the System Menu (navigate via arrow keys) |
+| `Super+Space` | Open [Assistant](help://man/1/Applications/Assistant) (system search and application launcher) |
+
+### Window Management
+| Shortcut | Action |
+|--------------------------|-----------------------------------------------------------------------|
+| `Super+Up` | Maximize the window |
+| `Super+Down` | Minimize the window (or un-maximize) |
+| `Super+Left` | Snap window to left half of the screen |
+| `Super+Right` | Snap window to right half of the screen |
+| `Super+LeftMouseButton` | Move window (grabbing anywhere within) |
+| `Super+RightMouseButton` | Resize window (in the direction of mouse drag) |
+| `F11` | Fullscreen mode (only available in some applications) |
+| `Alt+Spacebar` | Open the window's context menu |
+| `Super+D` | Show and hide the Desktop |
+| `Alt+Tab` | Application Switcher (`Shift` reverses direction) |
+| `Super+Number` | Switch to application in taskbar position 1-9 (or minimize if active) |
+| `Ctrl+Alt+Arrows` | Move Workspace |
+| `Shift+Ctrl+Alt+Arrows` | Move Workspace with the active window |
+
+### Common within Applications
+| Shortcut | Action |
+|----------------|---------------------------------------------------------------|
+| `Ctrl+Z` | Undo |
+| `Ctrl+Shift+Z` | Redo |
+| `Ctrl+A` | Select All |
+| `Ctrl+X` | Cut |
+| `Ctrl+C` | Copy |
+| `Ctrl+V` | Paste |
+| `Ctrl+O` | Open File |
+| `Ctrl+S` | Save |
+| `Ctrl+Shift+S` | Save As |
+| `Ctrl+Shift+A` | Open Command Palette (a searchable list of available actions) |
+| `Alt+Left` | Go Back |
+| `Alt+Right` | Go Forward |
+| `Ctrl+Right` | Expand Tree Node |
+| `Ctrl+Left` | Collapse Tree Node |
+| `F1` | Open the application's Manual |
+| `Tab` | Cycle focus within an application |
+| `Alt+F4` | Quit |
+
+### Text Input
+| Shortcut | Action |
+|------------------|-------------------------------------------------------|
+| `Ctrl+Alt+Space` | Emoji Picker |
+| `Shift+Alt` | Hold `Shift` and press `Alt` to cycle through keymaps |
+
+### Accessibility
+| Shortcut | Action |
+|-----------|------------------|
+| `Super+H` | Highlight Cursor |
+
+## See also
+* [Tips and Tricks](help://man/7/Tips-and-Tricks) \ No newline at end of file
diff --git a/Base/usr/share/man/man7/Tips-and-Tricks.md b/Base/usr/share/man/man7/Tips-and-Tricks.md
new file mode 100644
index 0000000000..65351f29de
--- /dev/null
+++ b/Base/usr/share/man/man7/Tips-and-Tricks.md
@@ -0,0 +1,62 @@
+![Welcome Icon](/res/icons/32x32/app-welcome.png)
+
+## Name
+Tips and Tricks
+
+## Description
+This is a list of useful tips and tricks to help you make the most out of SerenityOS.
+
+## General
+* When on the Desktop or in File Manager, start typing the name of an item to select it.
+* Bold text in context menus hints at the default behavior of a double-click.
+* Hold `Ctrl` to accelerate mouse wheel interaction with sliders and spin boxes.
+* Hold `Ctrl` while activating a menu item to prevent that menu from closing.
+* Many applications can open a compatible file if you drag-and-drop it into their window.
+* Change default file and protocol associations in `~/.config/LaunchServer.ini`.
+
+### Window Management
+* Double-click a window's title bar to maximize it.
+* Click on a window's icon to open the window's context menu.
+* Double-click on the edge of an application's window to maximize it in that direction.
+* Middle-click on a window's maximize button to extend the window vertically (this can be undone in the same way).
+* Drag resizable windows to any side or corner of the screen to automatically resize them to fill half or one-quarter of the screen.
+* Right-click on the Workspace Picker applet and select 'Workspace Settings' to easily customize the number and layout of Workspaces (virtual desktops).
+
+### Fun
+* It can help to get a second pair of `$ Eyes` on a problem… or fifty: `$ Eyes -n 100`.
+
+## Applications
+
+### [Assistant](help://man/1/Applications/Assistant)
+* Assistant can help you to quickly find files and launch applications. Open it with `Super+Space`.
+* Enter a URL to open it in the web browser.
+* Do quick calculations by typing the equal sign (=) followed by a mathematical expression, e.g. `=22*101`. Press Return to copy the result.
+
+### [Browser](help://man/1/Applications/Browser)
+* Browser has built-in content filtering, which can be used for ad blocking. Update the filters in `~/.config/BrowserContentFiltering.txt`.
+
+### Keyboard Mapper
+* Create and edit custom keymaps with `$ KeyboardMapper`.
+
+### Run
+* The Run dialog accepts all [Shell](help://man/5/Shell) commands.
+
+### [Terminal](help://man/1/Applications/Terminal)
+* Some of the bold or underlined text in Terminal can be double-clicked to open or right-clicked for additional actions.
+ * For example, right-click on a file or folder and select 'Copy URL' to copy the path.
+* Many Serenity applications already have convenient aliases. Use `$ cat /etc/shellrc` to view them.
+
+### [Text Editor](help://man/1/Applications/TextEditor)
+* Text files can be dragged directly from Terminal and dropped on Text Editor to open them.
+* Text Editor has multiple viewing modes. You can edit HTML or Markdown and live preview it at the same time.
+
+## Development
+* Supplying `# profile` with a process identifier (PID) of `-1` as root enables systemwide profiling.
+* Make applications inspectable by including `MAKE_INSPECTABLE=1` in their environment. Inspectable processes can be examined with [Inspector](help://man/1/Applications/Inspector) via remote procedure calls (RPCs). For example, to make the Eyes application inspectable, enter the following Shell commands:
+```sh
+$ export MAKE_INSPECTABLE=1
+$ Eyes &
+```
+
+## See also
+* [Keyboard Shortcuts](help://man/7/KeyboardShortcuts) \ No newline at end of file