pages*: make help and version commands comply with the style guide (#12107)

* pages*: use generic word for help

* git: add newline to the end

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* pages*: make help and version commands comply with the style guide

* java: fix Java name

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
Vitor Henrique
2024-01-30 01:55:24 -03:00
committed by GitHub
parent d0a73c4b9c
commit 46a054215a
175 changed files with 386 additions and 385 deletions

View File

@@ -19,6 +19,6 @@
`sudo a2query -M`
- Display the Apache version:
- Display Apache version:
`sudo a2query -v`

View File

@@ -3,10 +3,6 @@
> File indexing and searching framework for KDE Plasma.
> More information: <https://wiki.archlinux.org/index.php/Baloo>.
- Display help:
`balooctl`
- Display the status of the indexer:
`balooctl status`
@@ -34,3 +30,7 @@
- Check for any unindexed files and index them:
`balooctl check`
- Display help:
`balooctl --help`

View File

@@ -3,10 +3,10 @@
> Display btrfs-progs version.
> More information: <https://btrfs.readthedocs.io/en/latest/btrfs.html>.
- Display btrfs-progs version:
`btrfs version`
- Display help:
`btrfs version --help`
- Display btrfs-progs version:
`btrfs version`

View File

@@ -3,10 +3,6 @@
> System statistics collection daemon.
> More information: <https://collectd.org/>.
- Show usage help, including the program version:
`collectd -h`
- Test the configuration file and then exit:
`collectd -t`
@@ -30,3 +26,7 @@
- Don't fork into the background:
`collectd -f`
- Display help and version:
`collectd -h`

View File

@@ -19,10 +19,10 @@
`sudo envycontrol --reset`
- Display version:
`envycontrol --version`
- Display help:
`envycontrol --help`
- Display version:
`envycontrol --version`

View File

@@ -7,18 +7,18 @@
`flash`
- Display the program version:
`flash -v`
- Display information about the flashcard system:
`flash -i`
- Display a list of available commands:
`flash -h`
- Change the previewer from default `bat` to `cat`:
`flash -p {{cat}}`
- Display help:
`flash -h`
- Display version:
`flash -v`

View File

@@ -7,10 +7,6 @@
`gdebi {{path/to/package.deb}}`
- Display the program version:
`gdebi --version`
- Do not show progress information:
`gdebi {{path/to/package.deb}} --quiet`
@@ -22,3 +18,7 @@
- Use alternative root dir:
`gdebi {{path/to/package.deb}} --root={{path/to/root_dir}}`
- Display version:
`gdebi --version`

View File

@@ -11,6 +11,6 @@
`gnome-calculator --solve {{2^5 * 2 + 5}}`
- Display the version:
- Display version:
`gnome-calculator --version`

View File

@@ -3,10 +3,6 @@
> Manage gnome extensions from the terminal.
> More information: <https://wiki.gnome.org/Projects/GnomeShell/Extensions>.
- Display the version:
`gnome-extensions version`
- List all the installed extensions:
`gnome-extensions list`
@@ -15,10 +11,6 @@
`gnome-extensions info "{{extension_id}}"`
- Display help for a subcommand (like `list`):
`gnome-extensions help {{subcommand}}`
- Enable a specific extension:
`gnome-extensions enable "{{extension_id}}"`
@@ -30,3 +22,11 @@
- Uninstall a specific extension:
`gnome-extension uninstall "{{extension_id}}"`
- Display help for a specific subcommand (like `list`):
`gnome-extensions help {{subcommand}}`
- Display version:
`gnome-extensions version`

View File

@@ -11,6 +11,6 @@
`sudo grub-mkconfig --output={{/boot/grub/grub.cfg}}`
- Print the help page:
- Display help:
`grub-mkconfig --help`

View File

@@ -12,10 +12,10 @@
`grub-script-check --verbose`
- Display version:
`grub-script-check --version`
- Display help:
`grub-script-check --help`
- Display version:
`grub-script-check --version`

View File

@@ -12,6 +12,6 @@
`i3status -c {{path/to/i3status.conf}}`
- Display the `i3status` version and help:
- Display help and version:
`i3status -h`

View File

@@ -23,6 +23,6 @@
`sudo iftop -n`
- Get help about interactive commands:
- Display help:
`?`

View File

@@ -11,6 +11,6 @@
`ispell {{path/to/file}}`
- Display the version:
- Display version:
`ispell -v`

View File

@@ -23,6 +23,6 @@
`kdocker -l {{application}}`
- Print version:
- Display version:
`kdocker --version`

View File

@@ -11,6 +11,6 @@
`laptop-detect --verbose`
- Display the version:
- Display version:
`laptop-detect --version`

View File

@@ -7,10 +7,10 @@
`lci {{path/to/file}}`
- Display version:
`lci -v`
- Display help:
`lci -h`
- Display version:
`lci -v`

View File

@@ -7,10 +7,6 @@
`sudo lvm`
- List the Logical Volume Manager commands:
`sudo lvm help`
- Initialize a drive or partition to be used as a physical volume:
`sudo lvm pvcreate {{/dev/sdXY}}`
@@ -34,3 +30,7 @@
- Display information about logical volumes:
`sudo lvm lvdisplay`
- Display help for a specific command:
`lvm help {{command}}`

View File

@@ -3,6 +3,6 @@
> Show information about MATE desktop environment.
> More information: <https://manned.org/mate-about>.
- Print MATE version:
- Display MATE version:
`mate-about --version`

View File

@@ -19,6 +19,6 @@
`sudo netselect -s {{N}} {{host_1}} {{host_2}} {{host_3}}`
- List available options:
- Display help:
`netselect`

View File

@@ -28,6 +28,6 @@
`pacman --remove --print {{package}}`
- Display help for this subcommand:
- Display help:
`pacman --remove --help`

View File

@@ -15,10 +15,6 @@
`phar delete -f {{path/to/phar_file}} -e {{file_or_directory}}`
- Display full usage information and available hashing/compression algorithms:
`phar help`
- Compress or uncompress files and directories in a Phar file:
`phar compress -f {{path/to/phar_file}} -c {{algorithm}}`
@@ -34,3 +30,7 @@
- Sign a Phar file with an OpenSSL private key:
`phar sign -f {{path/to/phar_file}} -h openssl -y {{path/to/private_key}}`
- Display help and available hashing/compression algorithms:
`phar help`

View File

@@ -11,6 +11,10 @@
`pi {{number}}`
- Display recommended readings:
`pi --bibliography`
- Display help:
`pi --help`
@@ -18,7 +22,3 @@
- Display version:
`pi --version`
- Display recommended readings:
`pi --bibliography`

View File

@@ -23,6 +23,6 @@
`protontricks -s {{game_name}}`
- Show the protontricks help message:
- Display help:
`protontricks --help`

View File

@@ -19,6 +19,6 @@
`qtchooser --install {{version_name}} {{path/to/qmake}}`
- Display all available options:
- Display help:
`qtchooser --help`

View File

@@ -11,6 +11,6 @@
`termusic -c {path/to/music_file}`
- View termusic's usage info:
- Display help:
`termusic --help`

View File

@@ -8,7 +8,7 @@
`toolbox {{subcommand}}`
- Display help for a `toolbox` subcommand (such as `create`, `enter`, `rm`, `rmi`, etc.):
- Display help for a specific subcommand (such as `create`, `enter`, `rm`, `rmi`, etc.):
`toolbox help {{subcommand}}`

View File

@@ -27,6 +27,6 @@
`top -p $(pgrep -d ',' {{process_name}})`
- Get help about interactive commands:
- Display help about interactive commands:
`?`

View File

@@ -8,10 +8,10 @@
`updpkgsums`
- Display Version:
`updpkgsums -v`
- Display help:
`updpkgsums -h`
- Display version:
`updpkgsums -v`

View File

@@ -23,6 +23,6 @@
`vcgencmd bootloader_config`
- Display Help:
- Display help:
`vcgencmd --help`

View File

@@ -7,6 +7,6 @@
`vipw`
- Display the current version of `vipw`:
- Display version:
`vipw --version`