Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add -help and -version options to man pages

Browse Source
This commit is contained in:
Isaac Freund 2021-07-24 19:42:34 +02:00
parent 23088b800c
commit aa19a1a964
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
3 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/river.1.scd
View File

@ -6,7 +6,7 @@ river - dynamic tiling Wayland compositor
# SYNOPSIS # SYNOPSIS
*river* [*-c* _shell_command_] [*-l* _log_level_] *river* [_options_]
# DESCRIPTION # DESCRIPTION
@ -20,6 +20,12 @@ utility may be used to communicate with river over these protocols.
# OPTIONS # OPTIONS
*-help*
Print a help message and exit.
*-version*
Print the version number and exit.
*-c* _shell_command_ *-c* _shell_command_
Override the default search paths for an init executable: instead Override the default search paths for an init executable: instead
_shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION* _shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION*

10
doc/riverctl.1.scd
View File

@ -6,13 +6,21 @@ riverctl - command-line interface for controlling river
# SYNOPSIS # SYNOPSIS
*riverctl* _command_ [_command specific arguments_] *riverctl* [_options_] _command_ [_command specific arguments_]
# DESCRIPTION # DESCRIPTION
*riverctl* is a command-line utility used to control and configure river *riverctl* is a command-line utility used to control and configure river
over the Wayland protocol. over the Wayland protocol.
# OPTIONS
*-help*
Print a help message and exit.
*-version*
Print the version number and exit.
# COMMANDS # COMMANDS
## ACTIONS ## ACTIONS

6
doc/rivertile.1.scd
View File

@ -17,6 +17,12 @@ modified while rivertile is running with the help of *riverctl*(1).
# OPTIONS # OPTIONS
*-help*
Print a help message and exit.
*-version*
Print the version number and exit.
*-view-padding* _pixels_ *-view-padding* _pixels_
Set the padding around views in pixels. (Default: 6) Set the padding around views in pixels. (Default: 6)