Skip to content

Commit

Permalink
Base: Update Terminal's help documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
djwisdom authored and linusg committed Aug 28, 2022
1 parent d53a369 commit 83dd8f1
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Base/usr/share/man/man1/Terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,34 @@ $ Terminal [options]

Terminal is a terminal emulator application for Serenity.

It will generally be launched from Serenity menu, an on-screen menu, or the `Open in Terminal` action in File Manager and on the Desktop. You can also launch the current help item from within the help document, click on the `Open` link above to launch Terminal.

Selecting `File->Terminal Settings` will launch Terminal Settings dialog and display user configurable application properties. This dialog box contains two tabs namely Terminal tab and View tab.

The _Settings Terminal_ tab shows the option to either enable System beep, or use Visual bell or disable bell altogether. It can also enable or disable the display of terminal scrollbar and to change its exit behavior.

The _Settings View_ tab shows the option of specifying background opacity. Opacity is the amount in which the Terminal's background is transparent, displaying what's underneath. Set the opacity level to your taste while maintaining readability balance.

You also have the option of using Terminal's system default font or to select a new one by clicking on the ellipsis. Remember to uncheck `Use system default` checkbox before doing so.

You can change the shape of the cursor from block type, to underline or to bar type. You can also opt to enable or disable cursor's blink property.

You can select to change the Terminal's color scheme. Just click on the drop-down list and pick a color scheme. Examples of color schemes are Dracula, Monokai, Solarized and Zenburn.

Clicking on the _Apply_ button will cause the currently selected options to take effect immediately.

You can press the shortcut key F11 to display Terminal in fullscreen mode. Press F11 again to revert back to normal window display mode.

## Options

* `--help`: Display help message and exit
* `--version`: Print version
* `-e`: Execute this command inside the terminal
* `-k`: Keep the terminal open after the command has finished executing

## Examples

```sh
$ Terminal -e Shell
$ Terminal -k -e Browser
```

0 comments on commit 83dd8f1

Please sign in to comment.