From 062b88d05af310172d7984fa327ab73413be81d5 Mon Sep 17 00:00:00 2001 From: 4G3NT <76431337+4G3NT@users.noreply.github.com> Date: Tue, 27 Jun 2023 14:57:35 -0700 Subject: [PATCH] pages/*: prefer brand name and add backticks around commands (#10422) * pages/*: prefer brand name and add backticks around commands --------- Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com> --- pages/common/babeld.md | 10 +++++----- pages/common/beanstalkd.md | 4 ++-- pages/common/browser-sync.md | 2 +- pages/common/diskonaut.md | 4 ++-- pages/common/elinks.md | 4 ++-- pages/common/fastd.md | 2 +- pages/common/fzf.md | 10 +++++----- pages/common/gdb.md | 2 +- pages/common/hangups.md | 2 +- pages/common/htop.md | 4 ++-- pages/common/khal.md | 2 +- pages/common/locust.md | 6 +++--- pages/common/meld.md | 2 +- pages/common/mosquitto.md | 2 +- pages/common/mytop.md | 2 +- pages/common/newsboat.md | 2 +- pages/common/peco.md | 6 +++--- pages/common/screenfetch.md | 2 +- pages/common/sdcv.md | 2 +- pages/common/sk.md | 6 +++--- pages/common/speedcrunch.md | 2 +- pages/common/supervisord.md | 2 +- pages/common/telnet.md | 2 +- pages/common/wordgrinder.md | 2 +- pages/common/wpm.md | 8 ++++---- pages/common/wuzz.md | 2 +- pages/linux/bpytop.md | 2 +- pages/linux/calcurse.md | 2 +- pages/linux/chronyc.md | 2 +- pages/linux/collectd.md | 2 +- pages/linux/engrampa.md | 2 +- pages/linux/hardinfo.md | 2 +- pages/linux/nethogs.md | 2 +- pages/linux/nmon.md | 2 +- pages/linux/raspi-config.md | 2 +- pages/linux/terminator.md | 2 +- pages/linux/top.md | 2 +- pages/linux/xman.md | 2 +- pages/osx/top.md | 8 ++++---- 39 files changed, 63 insertions(+), 63 deletions(-) diff --git a/pages/common/babeld.md b/pages/common/babeld.md index 17b84d3a0..a80e772ac 100644 --- a/pages/common/babeld.md +++ b/pages/common/babeld.md @@ -3,22 +3,22 @@ > Routing daemon for Babel which uses firewall-style filters. > More information: . -- Start babeld with a specific configuration file: +- Start `babeld` with a specific configuration file: `babeld -c {{path/to/babeld.conf}}` -- Start babeld with multiple configuration files (read in order): +- Start `babeld` with multiple configuration files (read in order): `babeld -c {{path/to/ports.conf}} -c {{path/to/filters.conf}} -c {{path/to/interfaces.conf}}` -- Start babeld and daemonise afterwards: +- Start `babeld` and daemonise afterwards: `babeld -D` -- Start babeld and pass a configuration command: +- Start `babeld` and pass a configuration command: `babeld -C {{'redistribute metric 256'}}` -- Start babeld and specify on which interfaces to operate: +- Start `babeld` and specify on which interfaces to operate: `babeld {{eth0}} {{eth1}} {{wlan0}}` diff --git a/pages/common/beanstalkd.md b/pages/common/beanstalkd.md index c12098782..2a4da04af 100644 --- a/pages/common/beanstalkd.md +++ b/pages/common/beanstalkd.md @@ -3,11 +3,11 @@ > A simple and generic work-queue server. > More information: . -- Start beanstalkd, listening on port 11300: +- Start Beanstalk, listening on port 11300: `beanstalkd` -- Start beanstalkd listening on a custom port and address: +- Start Beanstalk listening on a custom port and address: `beanstalkd -l {{ip_address}} -p {{port_number}}` diff --git a/pages/common/browser-sync.md b/pages/common/browser-sync.md index 2b45d057a..66dc792af 100644 --- a/pages/common/browser-sync.md +++ b/pages/common/browser-sync.md @@ -15,6 +15,6 @@ `browser-sync init` -- Start browser-sync from config file: +- Start Browsersync from config file: `browser-sync start --config {{config_file}}` diff --git a/pages/common/diskonaut.md b/pages/common/diskonaut.md index 26827bd95..abb6524f7 100644 --- a/pages/common/diskonaut.md +++ b/pages/common/diskonaut.md @@ -3,11 +3,11 @@ > Terminal disk space navigator, written in Rust. > More information: . -- Start diskonaut in the current directory: +- Start `diskonaut` in the current directory: `diskonaut` -- Start diskonaut in a specific directory: +- Start `diskonaut` in a specific directory: `diskonaut {{path/to/directory}}` diff --git a/pages/common/elinks.md b/pages/common/elinks.md index aaefc281e..944f9bd67 100644 --- a/pages/common/elinks.md +++ b/pages/common/elinks.md @@ -1,9 +1,9 @@ # elinks -> A text based browser similar to lynx. +> A text based browser similar to `lynx`. > More information: . -- Start elinks: +- Start ELinks: `elinks` diff --git a/pages/common/fastd.md b/pages/common/fastd.md index 698b1a124..e4198533a 100644 --- a/pages/common/fastd.md +++ b/pages/common/fastd.md @@ -4,7 +4,7 @@ > Works on Layer 2 or Layer 3, supports different encryption methods, used by Freifunk. > More information: . -- Start fastd with a specific configuration file: +- Start `fastd` with a specific configuration file: `fastd --config {{path/to/fastd.conf}}` diff --git a/pages/common/fzf.md b/pages/common/fzf.md index cb8996626..85360a591 100644 --- a/pages/common/fzf.md +++ b/pages/common/fzf.md @@ -4,11 +4,11 @@ > Similar to `sk`. > More information: . -- Start fzf on all files in the specified directory: +- Start `fzf` on all files in the specified directory: `find {{path/to/directory}} -type f | fzf` -- Start fzf for running processes: +- Start `fzf` for running processes: `ps aux | fzf` @@ -16,14 +16,14 @@ `find {{path/to/directory}} -type f | fzf --multi > {{path/to/file}}` -- Start fzf with a specified query: +- Start `fzf` with a specified query: `fzf --query "{{query}}"` -- Start fzf on entries that start with core and end with either go, rb, or py: +- Start `fzf` on entries that start with core and end with either go, rb, or py: `fzf --query "^core go$ | rb$ | py$"` -- Start fzf on entries that not match pyc and match exactly travis: +- Start `fzf` on entries that not match pyc and match exactly travis: `fzf --query "!pyc 'travis"` diff --git a/pages/common/gdb.md b/pages/common/gdb.md index eb3f96656..903877f6f 100644 --- a/pages/common/gdb.md +++ b/pages/common/gdb.md @@ -19,6 +19,6 @@ `gdb -ex "{{commands}}" {{executable}}` -- Start gdb and pass arguments to the executable: +- Start `gdb` and pass arguments to the executable: `gdb --args {{executable}} {{argument1}} {{argument2}}` diff --git a/pages/common/hangups.md b/pages/common/hangups.md index 27f44b0a3..bbe0d8bf7 100644 --- a/pages/common/hangups.md +++ b/pages/common/hangups.md @@ -3,7 +3,7 @@ > Third party command-line client for Google Hangouts. > More information: . -- Start hangups: +- Start `hangups`: `hangups` diff --git a/pages/common/htop.md b/pages/common/htop.md index b2841eadc..1ddd2845c 100644 --- a/pages/common/htop.md +++ b/pages/common/htop.md @@ -3,11 +3,11 @@ > Display dynamic real-time information about running processes. An enhanced version of `top`. > More information: . -- Start htop: +- Start `htop`: `htop` -- Start htop displaying processes owned by a specific user: +- Start `htop` displaying processes owned by a specific user: `htop --user {{username}}` diff --git a/pages/common/khal.md b/pages/common/khal.md index 74074aeaf..15e606a70 100644 --- a/pages/common/khal.md +++ b/pages/common/khal.md @@ -3,7 +3,7 @@ > A text-based calendar and scheduling application for the command-line. > More information: . -- Start khal on interactive mode: +- Start Khal on interactive mode: `ikhal` diff --git a/pages/common/locust.md b/pages/common/locust.md index 0be82af79..0860db682 100644 --- a/pages/common/locust.md +++ b/pages/common/locust.md @@ -15,14 +15,14 @@ `locust --no-web --clients={{100}} --hatch-rate={{1}} --host={{http://example.com}}` -- Start locust in master mode: +- Start Locust in master mode: `locust --master --host={{http://example.com}}` -- Connect locust slave to master: +- Connect Locust slave to master: `locust --slave --host={{http://example.com}}` -- Connect locust slave to master on a different machine: +- Connect Locust slave to master on a different machine: `locust --slave --master-host={{master_hostname}} --host={{http://example.com}}` diff --git a/pages/common/meld.md b/pages/common/meld.md index 26ad9b2b8..db618ab89 100644 --- a/pages/common/meld.md +++ b/pages/common/meld.md @@ -3,7 +3,7 @@ > Graphical diffing and merging tool. > More information: . -- Start meld: +- Start `meld`: `meld` diff --git a/pages/common/mosquitto.md b/pages/common/mosquitto.md index d2c690b20..b7a707058 100644 --- a/pages/common/mosquitto.md +++ b/pages/common/mosquitto.md @@ -3,7 +3,7 @@ > An MQTT broker. > More information: . -- Start mosquitto: +- Start Mosquitto: `mosquitto` diff --git a/pages/common/mytop.md b/pages/common/mytop.md index 2c9220121..841cff4b6 100644 --- a/pages/common/mytop.md +++ b/pages/common/mytop.md @@ -3,7 +3,7 @@ > Display MySQL server performance info like `top`. > More information: . -- Start mytop: +- Start `mytop`: `mytop` diff --git a/pages/common/newsboat.md b/pages/common/newsboat.md index 4dab865e0..ab685967e 100644 --- a/pages/common/newsboat.md +++ b/pages/common/newsboat.md @@ -11,7 +11,7 @@ `echo {{http://example.com/path/to/feed}} >> "${HOME}/.newsboat/urls"` -- Start newsboat and refresh all feeds on startup: +- Start Newsboat and refresh all feeds on startup: `newsboat -r` diff --git a/pages/common/peco.md b/pages/common/peco.md index 233b5c3f3..d5dba23d2 100644 --- a/pages/common/peco.md +++ b/pages/common/peco.md @@ -3,14 +3,14 @@ > Interactive filtering tool. > More information: . -- Start peco on all files in the specified directory: +- Start `peco` on all files in the specified directory: `find {{path/to/directory}} -type f | peco` -- Start peco for running processes: +- Start `peco` for running processes: `ps aux | peco` -- Start peco with a specified query: +- Start `peco` with a specified query: `peco --query "{{query}}"` diff --git a/pages/common/screenfetch.md b/pages/common/screenfetch.md index cd1aa9ac7..7afd95d90 100644 --- a/pages/common/screenfetch.md +++ b/pages/common/screenfetch.md @@ -3,7 +3,7 @@ > Display system information. > More information: . -- Start screenfetch: +- Start `screenfetch`: `screenfetch` diff --git a/pages/common/sdcv.md b/pages/common/sdcv.md index 24729d363..b72a31518 100644 --- a/pages/common/sdcv.md +++ b/pages/common/sdcv.md @@ -4,7 +4,7 @@ > Dictionaries are provided separately from the client. > More information: . -- Start sdcv interactively: +- Start `sdcv` interactively: `sdcv` diff --git a/pages/common/sk.md b/pages/common/sk.md index 87b7fb6b2..8d8a6c7b8 100644 --- a/pages/common/sk.md +++ b/pages/common/sk.md @@ -4,15 +4,15 @@ > Similar to `fzf`. > More information: . -- Start skim on all files in the specified directory: +- Start `skim` on all files in the specified directory: `find {{path/to/directory}} -type f | sk` -- Start skim for running processes: +- Start `skim` for running processes: `ps aux | sk` -- Start skim with a specified query: +- Start `skim` with a specified query: `sk --query "{{query}}"` diff --git a/pages/common/speedcrunch.md b/pages/common/speedcrunch.md index fe46785a1..179c29122 100644 --- a/pages/common/speedcrunch.md +++ b/pages/common/speedcrunch.md @@ -3,7 +3,7 @@ > A high-precision scientific calculator. > More information: . -- Start speedcrunch: +- Start SpeedCrunch: `speedcrunch` diff --git a/pages/common/supervisord.md b/pages/common/supervisord.md index 4509c510c..c81236e8e 100644 --- a/pages/common/supervisord.md +++ b/pages/common/supervisord.md @@ -4,7 +4,7 @@ > Supervisord is the server part of supervisor; it is primarily managed via a configuration file. > More information: . -- Start supervisord with specified configuration file: +- Start `supervisord` with specified configuration file: `supervisord -c {{path/to/file}}` diff --git a/pages/common/telnet.md b/pages/common/telnet.md index b8e34c2c2..6bd4046fa 100644 --- a/pages/common/telnet.md +++ b/pages/common/telnet.md @@ -19,7 +19,7 @@ `Ctrl + ]` -- Start telnet with "x" as the session termination character: +- Start `telnet` with "x" as the session termination character: `telnet -e {{x}} {{ip_address}} {{port}}` diff --git a/pages/common/wordgrinder.md b/pages/common/wordgrinder.md index 54a5277a4..a209e184b 100644 --- a/pages/common/wordgrinder.md +++ b/pages/common/wordgrinder.md @@ -3,7 +3,7 @@ > Command-line word processor. > More information: . -- Start wordgrinder (loads a blank document by default): +- Start WordGrinder (loads a blank document by default): `wordgrinder` diff --git a/pages/common/wpm.md b/pages/common/wpm.md index a538eae82..e72de1cf8 100644 --- a/pages/common/wpm.md +++ b/pages/common/wpm.md @@ -3,15 +3,15 @@ > Typeracer-like console app for measuring your WPM. > More information: . -- Start the program: +- Start `wpm`: `wpm` -- Start wpm with short texts: +- Start `wpm` with short texts: `wpm --short` -- Start wpm using a specific text file: +- Start `wpm` using a specific text file: `wpm --load {{path/to/file.txt}}` @@ -23,6 +23,6 @@ `wpm --stats` -- Start wpm with monochrome colors: +- Start `wpm` with monochrome colors: `wpm --monochrome` diff --git a/pages/common/wuzz.md b/pages/common/wuzz.md index 87753143d..2641b7f0a 100644 --- a/pages/common/wuzz.md +++ b/pages/common/wuzz.md @@ -3,7 +3,7 @@ > Tool to interactively inspect HTTP requests and responses. > More information: . -- Start wuzz: +- Start `wuzz`: `wuzz` diff --git a/pages/linux/bpytop.md b/pages/linux/bpytop.md index 977d97b69..529b55963 100644 --- a/pages/linux/bpytop.md +++ b/pages/linux/bpytop.md @@ -3,7 +3,7 @@ > Display dynamic real-time information about running processes with graphs. Similar to `gtop` and `htop`. > More information: . -- Start bpytop: +- Start `bpytop`: `bpytop` diff --git a/pages/linux/calcurse.md b/pages/linux/calcurse.md index 6f6534735..4727f3d24 100644 --- a/pages/linux/calcurse.md +++ b/pages/linux/calcurse.md @@ -3,7 +3,7 @@ > A text-based calendar and scheduling application for the command-line. > More information: . -- Start calcurse on interactive mode: +- Start `calcurse` on interactive mode: `calcurse` diff --git a/pages/linux/chronyc.md b/pages/linux/chronyc.md index 64f187c4b..abd2e6c66 100644 --- a/pages/linux/chronyc.md +++ b/pages/linux/chronyc.md @@ -3,7 +3,7 @@ > Query the Chrony NTP daemon. > More information: . -- Start chronyc in interactive mode: +- Start `chronyc` in interactive mode: `chronyc` diff --git a/pages/linux/collectd.md b/pages/linux/collectd.md index b2fc04d10..89545ee4f 100644 --- a/pages/linux/collectd.md +++ b/pages/linux/collectd.md @@ -15,7 +15,7 @@ `collectd -T` -- Start collectd: +- Start `collectd`: `collectd` diff --git a/pages/linux/engrampa.md b/pages/linux/engrampa.md index 6f48e64b6..324df9ea9 100644 --- a/pages/linux/engrampa.md +++ b/pages/linux/engrampa.md @@ -4,7 +4,7 @@ > See also: `zip`, `tar`. > More information: . -- Start engrampa: +- Start Engrampa: `engrampa` diff --git a/pages/linux/hardinfo.md b/pages/linux/hardinfo.md index 530d79761..4c1b064e8 100644 --- a/pages/linux/hardinfo.md +++ b/pages/linux/hardinfo.md @@ -3,7 +3,7 @@ > Show hardware information in GUI window. > More information: . -- Start hardinfo: +- Start `hardinfo`: `hardinfo` diff --git a/pages/linux/nethogs.md b/pages/linux/nethogs.md index 54bddba2d..095773c46 100644 --- a/pages/linux/nethogs.md +++ b/pages/linux/nethogs.md @@ -3,7 +3,7 @@ > Monitor bandwidth usage per process. > More information: . -- Start nethogs as root (default device is eth0): +- Start NetHogs as root (default device is `eth0`): `sudo nethogs` diff --git a/pages/linux/nmon.md b/pages/linux/nmon.md index c3d7d5faa..b5be7277c 100644 --- a/pages/linux/nmon.md +++ b/pages/linux/nmon.md @@ -3,7 +3,7 @@ > A system administrator, tuner, and benchmark tool. > More information: . -- Start nmon: +- Start `nmon`: `nmon` diff --git a/pages/linux/raspi-config.md b/pages/linux/raspi-config.md index c98462090..5b313f8d8 100644 --- a/pages/linux/raspi-config.md +++ b/pages/linux/raspi-config.md @@ -3,6 +3,6 @@ > An `ncurses` terminal GUI to config a Raspberry Pi. > More information: . -- Start raspi-config: +- Start `raspi-config`: `sudo raspi-config` diff --git a/pages/linux/terminator.md b/pages/linux/terminator.md index ff71d1caa..08a1de926 100644 --- a/pages/linux/terminator.md +++ b/pages/linux/terminator.md @@ -3,7 +3,7 @@ > Arrange multiple GNOME terminals in one window. > More information: . -- Start terminator window: +- Start `terminator` window: `terminator` diff --git a/pages/linux/top.md b/pages/linux/top.md index 6bcb43619..a43b53335 100644 --- a/pages/linux/top.md +++ b/pages/linux/top.md @@ -3,7 +3,7 @@ > Display dynamic real-time information about running processes. > More information: . -- Start top: +- Start `top`: `top` diff --git a/pages/linux/xman.md b/pages/linux/xman.md index 12f4a0ad9..d1a065293 100644 --- a/pages/linux/xman.md +++ b/pages/linux/xman.md @@ -3,7 +3,7 @@ > Manual page viewer for X Window System. > More information: . -- Start xman in three-button window: +- Start `xman` in three-button window: `xman` diff --git a/pages/osx/top.md b/pages/osx/top.md index 4bb904212..0e6da397e 100644 --- a/pages/osx/top.md +++ b/pages/osx/top.md @@ -3,19 +3,19 @@ > Display dynamic real-time information about running processes. > More information: . -- Start top, all options are available in the interface: +- Start `top`, all options are available in the interface: `top` -- Start top sorting processes by internal memory size (default order - process ID): +- Start `top` sorting processes by internal memory size (default order - process ID): `top -o mem` -- Start top sorting processes first by CPU, then by running time: +- Start `top` sorting processes first by CPU, then by running time: `top -o cpu -O time` -- Start top displaying only processes owned by given user: +- Start `top` displaying only processes owned by given user: `top -user {{user_name}}`