*: add help example (#15981)

pages/common/browsh.md

@@ -18,3 +18,7 @@
 - Exit browsh:
 
 `<Ctrl q>`
+
+- Display help:
+
+`browsh {{[-h|--help]}}`

pages/common/btop.md

@@ -27,3 +27,7 @@
 - Exit `btop`:
 
 `<q>`
+
+- Display help:
+
+`btop {{[-h|--help]}}`

pages/common/carbonyl.md

@@ -14,3 +14,7 @@
 - Exit carbonyl:
 
 `<Ctrl c>`
+
+- Display help:
+
+`carbonyl {{[-h|--help]}}`

pages/common/case.md

@@ -18,3 +18,7 @@
 - Continue to the next pattern's commands without checking the pattern:
 
 `case {{$ANIMAL}} in {{cat}}) echo "It's a cat" ;& {{dog}}) echo "It's either a dog or cat fell through" ;& *) echo "Fallback" ;; esac`
+
+- Display help:
+
+`help case`

pages/common/function.md

@@ -10,3 +10,7 @@
 - Run a function named `func_name`:
 
 `func_name`
+
+- Display help:
+
+`help function`

pages/common/gettext.md

@@ -6,3 +6,7 @@
 - Get the translation of a string or output a default string if it doesn't exist:
 
 `LANGUAGE={{locale}} gettext {{msgid}} {{default_value}}`
+
+- Display help:
+
+`gettext {{[-h|--help]}}`

pages/common/hash.md

@@ -18,3 +18,7 @@
 - Print the full path of `command`:
 
 `hash -t {{command}}`
+
+- Display help:
+
+`hash --help`

pages/common/local.md

@@ -23,3 +23,7 @@
 - Declare a readonly variable with the specified value:
 
 `local -r {{variable}}="{{value}}"`
+
+- Display help:
+
+`local --help`

pages/common/magick-mogrify.md

@@ -28,3 +28,7 @@
 - Reduce file sizes of all GIF images in the current directory by reducing quality:
 
 `magick mogrify -layers 'optimize' -fuzz {{7%}} {{*.gif}}`
+
+- Display help:
+
+`magick mogrify -help`

pages/common/mail.md

@@ -19,3 +19,7 @@
 - Send a `tar.gz` file as an attachment:
 
 `tar cvzf - {{path/to/directory1 path/to/directory2}} | uuencode {{data.tar.gz}} | mail --subject "{{subject_line}}" {{to_user@example.com}}`
+
+- Display help:
+
+`mail {{[-h|--help]}}`

pages/common/mariadb-install-db.md

@@ -6,3 +6,7 @@
 - Initialize a database:
 
 `sudo mariadb-install-db --user {{user}} --basedir {{/usr}} --datadir {{/var/lib/mysql}}`
+
+- Display help:
+
+`mariadb-install-db --help`

pages/common/msgfmt.md

@@ -10,3 +10,7 @@
 - Convert a `.po` file to a `.mo` file:
 
 `msgfmt {{path/to/file.po}} {{[-o|--output-file]}} {{path/to/file.mo}}`
+
+- Display help:
+
+`msgfmt {{[-h|--help]}}`

pages/common/msginit.md

@@ -10,3 +10,7 @@
 - Define locale to generate from a specific template:
 
 `msginit {{[-l|--locale]}} {{locale}} {{[-i|--input]}} {{path/to/messages.pot}}`
+
+- Display help:
+
+`msginit {{[-h|--help]}}`

pages/common/msgmerge.md

@@ -1,4 +1,4 @@
-# Exclamation mark
+# msgmerge
 
 > Update an existing translation file from a new template.
 > More information: <https://www.gnu.org/software/gettext/manual/html_node/msgmerge-Invocation.html>.
@@ -6,3 +6,7 @@
 - Update a translation file:
 
 `msgmerge {{[-U|--update]}} {{path/to/file.po}} {{path/to/messages.pot}}`
+
+- Display help:
+
+`msgmerge {{[-h|--help]}}`

pages/common/o.md

@@ -18,3 +18,7 @@
 - Quit Orbiton:
 
 `<Ctrl q>`
+
+- Display help:
+
+`o {{[-h|--help]}}`

pages/common/picocom.md

@@ -18,3 +18,7 @@
 - Exit picocom:
 
 `<Ctrl a><Ctrl x>`
+
+- Display help:
+
+`picocom {{[-h|--help]}}`

pages/common/pwd.md

@@ -1,6 +1,6 @@
 # pwd
 
-> Print name of current/working directory.
+> Print the name of current/working directory.
 > More information: <https://www.gnu.org/software/coreutils/manual/html_node/pwd-invocation.html>.
 
 - Print the current directory:
@@ -10,3 +10,7 @@
 - Print the current directory, and resolve all symlinks (i.e. show the "physical" path):
 
 `pwd {{[-P|--physical]}}`
+
+- Display help:
+
+`pwd --help`

pages/common/readarray.md

@@ -18,3 +18,7 @@
 - Copy at most the specified number of lines:
 
 `readarray -n {{N}} {{array_name}} < {{path/to/file.txt}}`
+
+- Display help:
+
+`help mapfile`

pages/common/script.md

@@ -30,3 +30,7 @@
 - Execute quietly without start and done messages:
 
 `script {{[-q|--quiet]}} {{logfile.log}}`
+
+- Display help:
+
+`script {{[-h|--help]}}`

pages/common/snmpbulkget.md

@@ -10,3 +10,7 @@
 - Display the full Object Identifier (OID) path:
 
 `snmpbulkget -v {{version}} -c {{community}} -O f {{ip}} {{oid}}`
+
+- Display help:
+
+`snmpbulkget {{[-h|--help]}}`

pages/common/snmpdf.md

@@ -6,3 +6,7 @@
 - Fetch the disk space usage:
 
 `snmpdf -v {{version}} -c {{community}} {{ip}}`
+
+- Display help:
+
+`snmpdf {{[-h|--help]}}`

pages/common/snmpget.md

@@ -10,3 +10,7 @@
 - Display the full Object Identifier (OID) path:
 
 `snmpget -v {{version}} -c {{community}} -O f {{ip}} {{oid}}`
+
+- Display help:
+
+`snmpget {{[-h|--help]}}`

pages/common/snmpgetnext.md

@@ -10,3 +10,7 @@
 - Display the full Object Identifier (OID) path:
 
 `snmpgetnext -v {{version}} -c {{community}} -O f {{ip}} {{oid}}`
+
+- Display help:
+
+`snmpgetnext {{[-h|--help]}}`

pages/common/snmpnetstat.md

@@ -6,3 +6,7 @@
 - Fetch the networking status:
 
 `snmpnetstat -v {{version}} -c {{community}} {{ip}}`
+
+- Display help:
+
+`snmpnetstat {{[-h|--help]}}`

pages/common/snmpset.md

@@ -6,3 +6,7 @@
 - Set a value:
 
 `snmpset -v {{version}} -c {{community}} {{ip}} {{oid}} {{value_type}} {{value}}`
+
+- Display help:
+
+`snmpset {{[-h|--help]}}`

pages/common/snmpstatus.md

@@ -6,3 +6,7 @@
 - Fetch the values:
 
 `snmpstatus -v {{version}} -c {{community}} {{ip}}`
+
+- Display help:
+
+`snmpstatus {{[-h|--help]}}`

pages/common/snmptable.md

@@ -6,3 +6,7 @@
 - Fetch data:
 
 `snmptable -v {{version}} -c {{community}} {{ip}} {{oid}}`
+
+- Display help:
+
+`snmptable {{[-h|--help]}}`

pages/common/snmptest.md

@@ -6,3 +6,7 @@
 - Start the prompt:
 
 `snmptest -v {{version}} -c {{community}} {{ip}}`
+
+- Display help:
+
+`snmptest {{[-h|--help]}}`

pages/common/snmpwalk.md

@@ -22,3 +22,7 @@
 - Query system information on a remote host by OID using SNMPv3 without authentication or encryption:
 
 `snmpwalk -v 3 -l {{noAuthNoPriv}} -u {{username}} {{ip}} {{oid}}`
+
+- Display help:
+
+`snmpwalk {{[-h|--help]}}`

pages/common/stty.md

@@ -26,3 +26,7 @@
 - Turn character echoing off or on:
 
 `stty {{-echo|echo}}`
+
+- Display help:
+
+`stty --help`

pages/common/ulimit.md

@@ -18,3 +18,7 @@
 - Set max per-user process limit:
 
 `ulimit -u 30`
+
+- Display help:
+
+`help ulimit`

pages/common/virt-sysprep.md

@@ -22,3 +22,7 @@
 - Generate a new `/etc/machine-id` file and enable customizations to be able to change the host name to avoid network conflicts:
 
 `sudo virt-sysprep --domain {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}`
+
+- Display help:
+
+`virt-sysprep {{[-he|--help]}}`

pages/common/wait.md

@@ -14,3 +14,7 @@
 - Wait for a job to finish:
 
 `wait %{{N}}`
+
+- Display help:
+
+`wait --help`

pages/common/xgettext.md

@@ -18,3 +18,7 @@
 - Don't add a header containing metadata to the output file:
 
 `xgettext --omit-header {{path/to/input_file}}`
+
+- Display help:
+
+`xgettext {{[-h|--help]}}`

pages/linux/apachectl.md

@@ -30,3 +30,7 @@
 - Print full Apache configuration:
 
 `apachectl -S`
+
+- Display help:
+
+`apachectl -h`

pages/linux/aurpublish.md

@@ -10,3 +10,7 @@
 - Add githooks to the current repository:
 
 `aurpublish setup`
+
+- Display help:
+
+`aurpublish {{[-h|--help]}}`

pages/linux/bridge.md

@@ -22,3 +22,7 @@
 - Watch for changes in bridge interfaces:
 
 `bridge {{[mo|monitor]}}`
+
+- Display help:
+
+`bridge {{[h|help]}}`

pages/linux/cu.md

@@ -22,3 +22,7 @@
 - Exit the `cu` session when in connection:
 
 `<Enter><~><.>`
+
+- Display help:
+
+`cu --help`

pages/linux/dialog.md

@@ -14,3 +14,7 @@
 - Prompt the user for a yes/no question:
 
 `dialog --yesno "{{Continue?}}" {{7}} {{40}}`
+
+- Display help:
+
+`dialog`

pages/linux/fadvise.md

@@ -13,4 +13,4 @@
 
 - Display help:
 
-`fadvise --help`
+`fadvise {{[-h|--help]}}`

pages/linux/fincore.md

@@ -10,3 +10,7 @@
 - Display all possible data columns:
 
 `fincore --output-all {{path/to/file}}`
+
+- Display help:
+
+`fincore {{[-h|--help]}}`

pages/linux/fluidsynth.md

@@ -10,3 +10,7 @@
 - Specify the audio driver:
 
 `fluidsynth {{[-a|--audio-driver]}} {{pipewire|pulseaudio}} {{path/to/soundfont.sf2}} {{path/to/file.midi}}`
+
+- Display help:
+
+`fluidsynth {{[-h|--help]}}`

pages/linux/gtk-launch.md

@@ -6,3 +6,7 @@
 - Launch an application:
 
 `gtk-launch {{Application_name}}`
+
+- Display help:
+
+`gtk-launch {{[-h|--help]}}`

pages/linux/ifstatus.md

@@ -6,3 +6,7 @@
 - Display interface status:
 
 `ifstatus {{interface_name}}`
+
+- Display help:
+
+`ifstatus`

pages/linux/informant.md

@@ -17,4 +17,4 @@
 
 - Display help:
 
-`informant --help`
+`informant {{[-h|--help]}}`

pages/linux/ip-maddress.md

@@ -18,3 +18,7 @@
 - Leave a static multicast group:
 
 `sudo ip {{[m|maddress]}} {{[d|delete]}} {{33:33:00:00:00:02}} dev {{eth0}}`
+
+- Display help:
+
+`ip {{[m|maddress]}} {{[h|help]}}`

pages/linux/iwinfo.md

@@ -26,3 +26,7 @@
 - List available transmit power levels for the interface:
 
 `iwinfo {{interface}} txpowerlist`
+
+- Display help:
+
+`iwinfo h`

pages/linux/kwallet-query.md

@@ -14,3 +14,7 @@
 - List all available folders:
 
 `kwallet-query  {{kdewallet}} {{[-l|--list-entries]}} {{[-f|--folder]}} ""`
+
+- Display help:
+
+`kwallet-query {{[-h|--help]}}`

pages/linux/libinput.md

@@ -21,4 +21,4 @@
 
 - Display help:
 
-`libinput -h`
+`libinput {{[-h|--help]}}`

pages/linux/loginctl.md

@@ -26,3 +26,7 @@
 - Log a user out on all of their sessions:
 
 `loginctl terminate-user {{username}}`
+
+- Display help:
+
+`loginctl {{[-h|--help]}}`

pages/linux/logread.md

@@ -18,3 +18,7 @@
 - Print log messages as they happen:
 
 `logread -f`
+
+- Display help:
+
+`logread -h`

pages/linux/lsfd.md

@@ -18,3 +18,7 @@
 - List open IPv4 or IPv6 sockets:
 
 `lsfd -i{{4|6}}`
+
+- Display help:
+
+`lsfd {{[-h|--help]}}`

pages/linux/lxc-attach.md

@@ -6,3 +6,7 @@
 - Attach to a container:
 
 `sudo lxc-attach {{container_name}}`
+
+- Display help:
+
+`lxc-attach {{[-?|--help]}}`

pages/linux/lxc-console.md

@@ -14,3 +14,7 @@
 - Exit `lxc-console`:
 
 `<Ctrl a><q>`
+
+- Display help:
+
+`lxc-console {{[-?|--help]}}`

pages/linux/lxc-create.md

@@ -14,3 +14,7 @@
 - Create a container passing options to a template:
 
 `sudo lxc-create {{[-n|--name]}} {{container_name}} {{[-t|--template]}} download -- {{[-d|--dist]}} {{distro-name}} {{[-r|--release]}} {{release-version}} {{[-a|--arch]}} {{arch}}`
+
+- Display help:
+
+`lxc-create {{[-?|--help]}}`

pages/linux/lxc-destroy.md

@@ -6,3 +6,7 @@
 - Delete a container:
 
 `sudo lxc-destroy {{container_name}}`
+
+- Display help:
+
+`lxc-destroy {{[-?|--help]}}`

pages/linux/lxc-info.md

@@ -6,3 +6,7 @@
 - Query information from a container:
 
 `sudo lxc-info {{container_name}}`
+
+- Display help:
+
+`lxc-info {{[-?|--help]}}`

pages/linux/lxc-ls.md

@@ -22,3 +22,7 @@
 - List containers in a fancy, column-based output:
 
 `sudo lxc-ls {{[-f|--fancy]}}`
+
+- Display help:
+
+`lxc-ls {{[-?|--help]}}`

pages/linux/lxc-start.md

@@ -18,3 +18,7 @@
 - Exit out of a foreground container (run this in a separate terminal):
 
 `sudo lxc-stop {{container_name}}`
+
+- Display help:
+
+`lxc-start {{[-?|--help]}}`

pages/linux/lxc-stop.md

@@ -6,3 +6,7 @@
 - Stop a container:
 
 `sudo lxc-stop {{container_name}}`
+
+- Display help:
+
+`lxc-stop {{[-?|--help]}}`

pages/linux/minicom.md

@@ -18,3 +18,7 @@
 - Exit minicom:
 
 `<Ctrl a><x><Enter>`
+
+- Display help:
+
+`minicom {{[-h|--help]}}`

pages/linux/nstat.md

@@ -10,3 +10,7 @@
 - View all-time network statistics:
 
 `nstat {{[-a|--ignore]}}`
+
+- Display help:
+
+`nstat {{[-h|--help]}}`

pages/linux/parted-interactive.md

@@ -27,3 +27,7 @@
 - Remove a partition in interactive mode:
 
 `rm {{/dev/sdXN}}`
+
+- Display help:
+
+`?`

pages/linux/parted.md

@@ -19,3 +19,7 @@
 - Start interactive mode with the specified disk selected:
 
 `sudo parted {{/dev/sdX}}`
+
+- Display help:
+
+`parted {{[-h|--help]}}`

pages/linux/pg.md

@@ -6,3 +6,7 @@
 - View a file:
 
 `pg {{path/to/file}}`
+
+- Display help:
+
+`pg {{[-h|--help]}}`

pages/linux/pw-cat.md

@@ -18,3 +18,7 @@
 - Record a sample recording using a different sample rate:
 
 `pw-cat --record --rate {{6000}} {{path/to/file.wav}}`
+
+- Display help:
+
+`pw-cat {{[-h|--help]}}`

pages/linux/pw-reserve.md

@@ -10,3 +10,7 @@
 - Monitor a device instead of reserving it:
 
 `pw-reserve {{[-n|--name]}} {{audioN}} {{[-m|--monitor]}}`
+
+- Display help:
+
+`pw-reserve {{[-h|--help]}}`

pages/linux/pw-v4l2.md

@@ -6,3 +6,7 @@
 - Run a program:
 
 `pw-v4l2 {{program}}`
+
+- Display help:
+
+`pw-v4l2 -h`

pages/linux/qmake.md

@@ -22,3 +22,7 @@
 - Enable debug mode:
 
 `qmake -d`
+
+- Display help:
+
+`qmake -help`

pages/linux/reflector.md

@@ -18,3 +18,7 @@
 - Use a configuration file to fetch mirrors:
 
 `sudo reflector @{{/etc/xdg/reflector/reflector.conf}}`
+
+- Display help:
+
+`reflector {{[-h|--help]}}`

pages/linux/systemd-ask-password.md

@@ -30,3 +30,7 @@
 - Pass the asked password to another program:
 
 `systemd-ask-password | {{command}}`
+
+- Display help:
+
+`systemd-ask-password {{[-h|--help]}}`

pages/linux/ubuntu-drivers.md

@@ -10,3 +10,7 @@
 - Install drivers for detected hardware:
 
 `sudo ubuntu-drivers install`
+
+- Display help:
+
+`ubuntu-drivers`

pages/linux/ubus.md

@@ -14,3 +14,7 @@
 - Listen to events:
 
 `ubus subscribe {{event_name}}`
+
+- Display help:
+
+`ubus`

pages/linux/uci.md

@@ -30,3 +30,7 @@
 - Discard uncommitted changes:
 
 `uci revert {{config}}`
+
+- Display help:
+
+`uci`

pages/linux/waypipe.md

@@ -14,3 +14,7 @@
 - Skip testing for Vulkan support:
 
 `waypipe --test-skip-vulkan ssh {{user}}@{{server}} {{program}}`
+
+- Display help:
+
+`waypipe {{[-h|--help]}}`