diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-24 19:42:34 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-24 19:42:34 +0200 |
| commit | aa19a1a964e9a195cf6fe03499e393fd44b0da5a (patch) | |
| tree | c5e1c0af435e6200f45f21ba9039b22b2c19a69b /doc | |
| parent | 23088b800c9e4166396996de82fb1b13c8671127 (diff) | |
| download | river-aa19a1a964e9a195cf6fe03499e393fd44b0da5a.tar.gz river-aa19a1a964e9a195cf6fe03499e393fd44b0da5a.tar.xz | |
docs: add -help and -version options to man pages
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/river.1.scd | 8 | ||||
| -rw-r--r-- | doc/riverctl.1.scd | 10 | ||||
| -rw-r--r-- | doc/rivertile.1.scd | 6 |
3 files changed, 22 insertions, 2 deletions
diff --git a/doc/river.1.scd b/doc/river.1.scd index 24652a3..0b13f46 100644 --- a/doc/river.1.scd +++ b/doc/river.1.scd @@ -6,7 +6,7 @@ river - dynamic tiling Wayland compositor # SYNOPSIS -*river* [*-c* _shell_command_] [*-l* _log_level_] +*river* [_options_] # DESCRIPTION @@ -20,6 +20,12 @@ utility may be used to communicate with river over these protocols. # OPTIONS +*-help* + Print a help message and exit. + +*-version* + Print the version number and exit. + *-c* _shell_command_ Override the default search paths for an init executable: instead _shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION* diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd index 060888e..6a8332a 100644 --- a/doc/riverctl.1.scd +++ b/doc/riverctl.1.scd @@ -6,13 +6,21 @@ riverctl - command-line interface for controlling river # SYNOPSIS -*riverctl* _command_ [_command specific arguments_] +*riverctl* [_options_] _command_ [_command specific arguments_] # DESCRIPTION *riverctl* is a command-line utility used to control and configure river over the Wayland protocol. +# OPTIONS + +*-help* + Print a help message and exit. + +*-version* + Print the version number and exit. + # COMMANDS ## ACTIONS diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd index 6143a31..24424ce 100644 --- a/doc/rivertile.1.scd +++ b/doc/rivertile.1.scd @@ -17,6 +17,12 @@ modified while rivertile is running with the help of *riverctl*(1). # OPTIONS +*-help* + Print a help message and exit. + +*-version* + Print the version number and exit. + *-view-padding* _pixels_ Set the padding around views in pixels. (Default: 6) |