diff --git a/pages/linux/certbot.md b/pages/linux/certbot.md index 291f56530e..5ddf7306bb 100644 --- a/pages/linux/certbot.md +++ b/pages/linux/certbot.md @@ -2,19 +2,19 @@ > The Let's Encrypt Agent for automatically obtaining and renewing TLS certificates. > Successor to `letsencrypt`. -> More information: . +> More information: . - Obtain a new certificate via webroot authorization, but do not install it automatically: -`sudo certbot certonly --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}}` +`sudo certbot certonly --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via nginx authorization, installing the new certificate automatically: -`sudo certbot --nginx --domain {{subdomain.example.com}}` +`sudo certbot --nginx {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via apache authorization, installing the new certificate automatically: -`sudo certbot --apache --domain {{subdomain.example.com}}` +`sudo certbot --apache {{[-d|--domain]}} {{subdomain.example.com}}` - Renew all Let's Encrypt certificates that expire in 30 days or less (don't forget to restart any servers that use them afterwards): @@ -22,8 +22,8 @@ - Simulate the obtaining of a new certificate, but don't actually save any new certificates to disk: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --dry-run` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --dry-run` - Obtain an untrusted test certificate instead: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --test-cert` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --test-cert` diff --git a/pages/linux/cewl.md b/pages/linux/cewl.md index 5e97adb7df..cb01033ee3 100644 --- a/pages/linux/cewl.md +++ b/pages/linux/cewl.md @@ -1,19 +1,19 @@ # cewl > URL spidering tool for making a cracking wordlist from web content. -> More information: . +> More information: . - Create a wordlist file from the given URL up to 2 links depth: -`cewl --depth {{2}} --write {{path/to/wordlist.txt}} {{url}}` +`cewl {{[-d|--depth]}} 2 {{[-w|--write]}} {{path/to/wordlist.txt}} {{url}}` - Output an alphanumeric wordlist from the given URL with words of minimum 5 characters: -`cewl --with-numbers --min_word_length {{5}} {{url}}` +`cewl --with-numbers {{[-m|--min_word_length]}} 5 {{url}}` - Output a wordlist from the given URL in debug mode including email addresses: -`cewl --debug --email {{url}}` +`cewl --debug {{[-e|--email]}} {{url}}` - Output a wordlist from the given URL using HTTP Basic or Digest authentication: diff --git a/pages/linux/compsize.md b/pages/linux/compsize.md index 95a758b720..acd558897d 100644 --- a/pages/linux/compsize.md +++ b/pages/linux/compsize.md @@ -2,7 +2,7 @@ > Calculate the compression ratio of a set of files on a btrfs filesystem. > See also `btrfs filesystem` for recompressing a file by defragmenting it. -> More information: . +> More information: . - Calculate the current compression ratio for a file or directory: @@ -10,8 +10,8 @@ - Don't traverse filesystem boundaries: -`sudo compsize --one-file-system {{path/to/file_or_directory}}` +`sudo compsize {{[-x|--one-file-system]}} {{path/to/file_or_directory}}` - Show raw byte counts instead of human-readable sizes: -`sudo compsize --bytes {{path/to/file_or_directory}}` +`sudo compsize {{[-b|--bytes]}} {{path/to/file_or_directory}}` diff --git a/pages/linux/dex.md b/pages/linux/dex.md index 2cf6fde3ae..749f208ea0 100644 --- a/pages/linux/dex.md +++ b/pages/linux/dex.md @@ -5,27 +5,27 @@ - Execute all programs in the autostart folders: -`dex --autostart` +`dex {{[-a|--autostart]}}` - Execute all programs in the specified folders: -`dex --autostart --search-paths {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` +`dex {{[-a|--autostart]} {{[-s|--search-paths]}} {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` - Preview the programs would be executed in a GNOME specific autostart: -`dex --autostart --environment {{GNOME}}` +`dex {{[-a|--autostart]} {{[-e|--environment]}} {{GNOME}}` - Preview the programs would be executed in a regular autostart: -`dex --autostart --dry-run` +`dex {{[-a|--autostart]} {{[-d|--dry-run]}}` - Preview the value of the DesktopEntry property `Name`: -`dex --property {{Name}} {{path/to/file.desktop}}` +`dex {{[-p|--property]}} {{Name}} {{path/to/file.desktop}}` - Create a DesktopEntry for a program in the current directory: -`dex --create {{path/to/file.desktop}}` +`dex {{[-c|--create]}} {{path/to/file.desktop}}` - Execute a single program (with `Terminal=true` in the desktop file) in the given terminal: diff --git a/pages/linux/dkms.md b/pages/linux/dkms.md index cfac3cba66..f3cf2d820e 100644 --- a/pages/linux/dkms.md +++ b/pages/linux/dkms.md @@ -1,7 +1,7 @@ # dkms > A framework that allows for dynamic building of kernel modules. -> More information: . +> More information: . - List currently installed modules: diff --git a/pages/linux/dstat.md b/pages/linux/dstat.md index 622e09e62b..d719d8a5fd 100644 --- a/pages/linux/dstat.md +++ b/pages/linux/dstat.md @@ -13,7 +13,7 @@ - Display CPU and memory statistics only: -`dstat --cpu --mem` +`dstat {{[-c|--cpu]}} {{[-m|--mem]}}` - List all available dstat plugins: diff --git a/pages/linux/exif.md b/pages/linux/exif.md index 3dfb1240d2..5c7a11232e 100644 --- a/pages/linux/exif.md +++ b/pages/linux/exif.md @@ -1,7 +1,7 @@ # exif > Show and change EXIF information in JPEG files. -> More information: . +> More information: . - Show all recognized EXIF information in an image: @@ -9,16 +9,16 @@ - Show a table listing known EXIF tags and whether each one exists in an image: -`exif --list-tags --no-fixup {{image.jpg}}` +`exif {{[-l|--list-tags]}} --no-fixup {{path/to/image.jpg}}` -- Extract the image thumbnail into the file `thumbnail.jpg`: +- Extract the image thumbnail into a separate file: -`exif --extract-thumbnail --output={{thumbnail.jpg}} {{image.jpg}}` +`exif {{[-e|--extract-thumbnail]}} {{[-o|--output]}} {{path/to/thumbnail.jpg}} {{path/to/image.jpg}}` - Show the raw contents of the "Model" tag in the given image: -`exif --ifd={{0}} --tag={{Model}} --machine-readable {{image.jpg}}` +`exif --ifd {{0}} {{[-t|--tag]}} "Model" {{[-m|--machine-readable]}} {{path/to/image.jpg}}` - Change the value of the "Artist" tag to John Smith and save to `new.jpg`: -`exif --output={{new.jpg}} --ifd={{0}} --tag="{{Artist}}" --set-value="{{John Smith}}" --no-fixup {{image.jpg}}` +`exif {{[-o|--output]}} {{path/to/new.jpg}} --ifd {{0}} {{[-t|--tag]}} "Artist" --set-value "John Smith" --no-fixup {{path/to/image.jpg}}` diff --git a/pages/linux/fail2ban-client.md b/pages/linux/fail2ban-client.md index f43625ade4..a31cd7f06e 100644 --- a/pages/linux/fail2ban-client.md +++ b/pages/linux/fail2ban-client.md @@ -1,7 +1,7 @@ # fail2ban-client > Configure and control fail2ban server. -> More information: . +> More information: . - Retrieve current status of the jail service: diff --git a/pages/linux/findfs.md b/pages/linux/findfs.md index 0c396b4feb..b6d512fb55 100644 --- a/pages/linux/findfs.md +++ b/pages/linux/findfs.md @@ -1,7 +1,7 @@ # findfs > Finds a filesystem by label or UUID. -> More information: . +> More information: . - Search block devices by filesystem label: diff --git a/pages/linux/maim.md b/pages/linux/maim.md index 3a6693ee9c..a9fc5664a3 100644 --- a/pages/linux/maim.md +++ b/pages/linux/maim.md @@ -1,7 +1,7 @@ # maim > Screenshot utility. -> More information: . +> More information: . - Capture a screenshot and save it to the given path: @@ -9,12 +9,12 @@ - Capture a screenshot of the selected region: -`maim --select {{path/to/screenshot.png}}` +`maim {{[-s|--select]}} {{path/to/screenshot.png}}` - Capture a screenshot of the selected region and save it in the clipboard (requires `xclip`): -`maim --select | xclip -selection clipboard -target image/png` +`maim {{[-s|--select]}} | xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png` - Capture a screenshot of the current active window (requires `xdotool`): -`maim --window $(xdotool getactivewindow) {{path/to/screenshot.png}}` +`maim {{[-i|--window]}} $(xdotool getactivewindow) {{path/to/screenshot.png}}` diff --git a/pages/linux/ntpq.md b/pages/linux/ntpq.md index 2ce51dec1c..970a3f47fb 100644 --- a/pages/linux/ntpq.md +++ b/pages/linux/ntpq.md @@ -1,24 +1,24 @@ # ntpq > Query the Network Time Protocol (NTP) daemon. -> More information: . +> More information: . - Start `ntpq` in interactive mode: -`ntpq --interactive` +`ntpq` - Print a list of NTP peers: -`ntpq --peers` +`ntpq {{[-p|--peers]}}` - Print a list of NTP peers without resolving hostnames from IP addresses: -`ntpq --numeric --peers` +`ntpq {{[-n|--numeric]}} {{[-p|--peers]}}` - Use `ntpq` in debugging mode: -`ntpq --debug-level` +`ntpq {{[-d|--debug-level]}}` - Print NTP system variables values: -`ntpq --command={{rv}}` +`ntpq {{[-c|--command]}} {{rv}}` diff --git a/pages/linux/openfortivpn.md b/pages/linux/openfortivpn.md index 00fbb3fc19..437db47b21 100644 --- a/pages/linux/openfortivpn.md +++ b/pages/linux/openfortivpn.md @@ -1,15 +1,15 @@ # openfortivpn > A VPN client, for Fortinet's proprietary PPP+SSL VPN solution. -> More information: . +> More information: . - Connect to a VPN with a username and password: -`openfortivpn --username={{username}} --password={{password}}` +`openfortivpn {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Connect to a VPN using a specific configuration file (defaults to `/etc/openfortivpn/config`): -`sudo openfortivpn --config={{path/to/config}}` +`sudo openfortivpn {{[-c|--config]}} {{path/to/config}}` - Connect to a VPN by specifying the host and port: @@ -17,4 +17,4 @@ - Trust a given gateway by passing in its certificate's sha256 sum: -`openfortivpn --trusted-cert={{sha256_sum}}` +`openfortivpn --trusted-cert {{sha256_sum}}` diff --git a/pages/linux/photorec.md b/pages/linux/photorec.md index b2d6c2e3e3..1dafd2da0b 100644 --- a/pages/linux/photorec.md +++ b/pages/linux/photorec.md @@ -2,7 +2,7 @@ > Deleted file recovery tool. > It is recommended to write recovered files to a disk separate to the one being recovered from. -> More information: . +> More information: . - Run PhotoRec on a specific device: diff --git a/pages/linux/pmount.md b/pages/linux/pmount.md index c5c1ec3cf1..c6f995f32b 100644 --- a/pages/linux/pmount.md +++ b/pages/linux/pmount.md @@ -9,15 +9,15 @@ - Mount a device with a specific filesystem type to `/media/label`: -`pmount --type {{filesystem}} {{/dev/to/block/device}} {{label}}` +`pmount {{[-t|--type]}} {{filesystem}} {{/dev/to/block/device}} {{label}}` - Mount a CD-ROM (filesystem type ISO9660) in read-only mode: -`pmount --type {{iso9660}} --read-only {{/dev/cdrom}}` +`pmount {{[-t|--type]}} iso9660 {{[-r|--read-only]}} {{/dev/cdrom}}` - Mount an NTFS-formatted disk, forcing read-write access: -`pmount --type {{ntfs}} --read-write {{/dev/sdX}}` +`pmount {{[-t|--type]}} ntfs {{[-w|--read-write]}} {{/dev/sdX}}` - Display all mounted removable devices: diff --git a/pages/linux/resolveip.md b/pages/linux/resolveip.md index 32e55be9ba..5c1f622ec6 100644 --- a/pages/linux/resolveip.md +++ b/pages/linux/resolveip.md @@ -11,6 +11,6 @@ `resolveip {{1.1.1.1}}` -- Silent mode. Produces less output: +- Resolve a hostname to an IP address with less output: -`resolveip --silent {{example.org}}` +`resolveip {{[-s|--silent]}} {{example.org}}` diff --git a/pages/linux/rpcclient.md b/pages/linux/rpcclient.md index 50ef9f3ed1..193193ece1 100644 --- a/pages/linux/rpcclient.md +++ b/pages/linux/rpcclient.md @@ -5,19 +5,19 @@ - Connect to a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{ip}}` - Connect to a remote host on a domain without a password: -`rpcclient --user {{username}} --workgroup {{domain}} --no-pass {{ip}}` +`rpcclient {{[-U|--user]}} {{username}} {{[-W|--workgroup]}} {{domain}} {{[-N|--no-pass]}} {{ip}}` - Connect to a remote host, passing the password hash: -`rpcclient --user {{domain}}\{{username}} --pw-nt-hash {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}} --pw-nt-hash {{ip}}` - Execute shell commands on a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} --command {{semicolon_separated_commands}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{[-c|--command]}} {{semicolon_separated_commands}} {{ip}}` - Display domain users: diff --git a/pages/linux/sam.md b/pages/linux/sam.md index 5b1e996f95..ee5e72ba18 100644 --- a/pages/linux/sam.md +++ b/pages/linux/sam.md @@ -1,7 +1,7 @@ # sam > AWS Serverless Application Model (SAM) CLI. -> More information: . +> More information: . - Initialize a serverless application: @@ -9,7 +9,7 @@ - Initialize a serverless application with a specific runtime: -`sam init --runtime {{python3.7}}` +`sam init {{[-r|--runtime]}} {{python3.7}}` - Package a SAM application: diff --git a/pages/linux/scanimage.md b/pages/linux/scanimage.md index 6f374fc806..2aa3d2f56c 100644 --- a/pages/linux/scanimage.md +++ b/pages/linux/scanimage.md @@ -5,8 +5,8 @@ - List available scanners to ensure the target device is connected and recognized: -`scanimage -L` +`scanimage {{[-L|--list-devices]}}` - Scan an image and save it to a file: -`scanimage --format={{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` +`scanimage --format {{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` diff --git a/pages/linux/smbget.md b/pages/linux/smbget.md index ed60024117..d2b83cca6c 100644 --- a/pages/linux/smbget.md +++ b/pages/linux/smbget.md @@ -13,8 +13,8 @@ - Connect with a username and password: -`smbget {{smb://server/share/file}} --user {{username%password}}` +`smbget {{smb://server/share/file}} {{[-U|--user]}} {{username%password}}` - Require encrypted transfers: -`smbget {{smb://server/share/file}} --encrypt` +`smbget {{smb://server/share/file}} {{[-e|--encrypt]}}` diff --git a/pages/linux/srun.md b/pages/linux/srun.md index 141ecc6cf7..74623a337a 100644 --- a/pages/linux/srun.md +++ b/pages/linux/srun.md @@ -9,8 +9,8 @@ - Submit an interactive job with different attributes: -`srun --ntasks-per-node={{num_cores}} --mem-per-cpu={{memory_MB}} --pty /bin/bash` +`srun --ntasks-per-node {{num_cores}} --mem-per-cpu {{memory_MB}} --pty /bin/bash` - Connect to a worker node with a job running: -`srun --jobid={{job_id}} --pty /bin/bash` +`srun --jobid {{job_id}} --pty /bin/bash` diff --git a/pages/linux/tcptraceroute.md b/pages/linux/tcptraceroute.md index 56d750c0e2..141d4fe2e5 100644 --- a/pages/linux/tcptraceroute.md +++ b/pages/linux/tcptraceroute.md @@ -1,7 +1,7 @@ # tcptraceroute > A traceroute implementation using TCP packets. -> More information: . +> More information: . - Trace the route to a host: diff --git a/pages/linux/tic.md b/pages/linux/tic.md index daf307e7f4..4dbeda37b8 100644 --- a/pages/linux/tic.md +++ b/pages/linux/tic.md @@ -1,7 +1,7 @@ # tic > Compile terminfo and install for ncurses. -> More information: . +> More information: . - Compile and install terminfo for a terminal: diff --git a/pages/linux/timeshift.md b/pages/linux/timeshift.md index 0d33617c9b..bca54463b0 100644 --- a/pages/linux/timeshift.md +++ b/pages/linux/timeshift.md @@ -1,7 +1,7 @@ # timeshift > System restore utility. -> More information: . +> More information: . - List snapshots: diff --git a/pages/linux/tlp.md b/pages/linux/tlp.md index 6c43b43b58..ef923741c0 100644 --- a/pages/linux/tlp.md +++ b/pages/linux/tlp.md @@ -2,7 +2,7 @@ > Advanced power management for Linux. > See also `tlp-stat`. -> More information: . +> More information: . - Apply settings (according to the actual power source): diff --git a/pages/linux/unshadow.md b/pages/linux/unshadow.md index 5100f6fabd..67f9ff8ec1 100644 --- a/pages/linux/unshadow.md +++ b/pages/linux/unshadow.md @@ -1,7 +1,7 @@ # unshadow > Utility provided by the John the Ripper project to obtain the traditional Unix password file if the system uses shadow passwords. -> More information: . +> More information: . - Combine the `/etc/shadow` and `/etc/passwd` of the current system: diff --git a/pages/linux/veracrypt.md b/pages/linux/veracrypt.md index cee9806610..170f212286 100644 --- a/pages/linux/veracrypt.md +++ b/pages/linux/veracrypt.md @@ -1,20 +1,20 @@ # veracrypt > Free and open source disk encryption software. -> More information: . +> More information: . - Create a new volume through a text user interface and use `/dev/urandom` as a source of random data: -`veracrypt --text --create --random-source={{/dev/urandom}}` +`veracrypt {{[-t|--text]}} {{[-c|--create]}} --random-source={{/dev/urandom}}` - Decrypt a volume interactively through a text user interface and mount it to a directory: -`veracrypt --text {{path/to/volume}} {{path/to/mount_point}}` +`veracrypt {{[-t|--text]}} {{path/to/volume}} {{path/to/mount_point}}` - Decrypt a partition using a keyfile and mount it to a directory: -`veracrypt --keyfiles={{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` +`veracrypt {{[-k|--keyfiles]}} {{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` - Dismount a volume on the directory it is mounted to: -`veracrypt --dismount {{path/to/mounted_point}}` +`veracrypt {{[-d|--dismount]}} {{path/to/mounted_point}}` diff --git a/pages/linux/wg-quick.md b/pages/linux/wg-quick.md index f663eefa95..81717cb171 100644 --- a/pages/linux/wg-quick.md +++ b/pages/linux/wg-quick.md @@ -1,7 +1,7 @@ # wg-quick > Quickly set up WireGuard tunnels based on config files. -> More information: . +> More information: . - Set up a VPN tunnel: diff --git a/pages/linux/xbacklight.md b/pages/linux/xbacklight.md index d8053354b0..45dc7f3993 100644 --- a/pages/linux/xbacklight.md +++ b/pages/linux/xbacklight.md @@ -1,7 +1,7 @@ # xbacklight > Utility to adjust backlight brightness using the RandR extension. -> More information: . +> More information: . - Get the current screen brightness as a percentage: diff --git a/pages/linux/xclip.md b/pages/linux/xclip.md index 55d31b49a1..8cb9d92524 100644 --- a/pages/linux/xclip.md +++ b/pages/linux/xclip.md @@ -15,15 +15,15 @@ - Copy the output from a command to the system clipboard, using short notation: -`echo 123 | xclip {{[-se|-selection]}} clip` +`echo 123 | xclip {{[-se|-selection]}} {{[c|clipboard]}}` - Copy the contents of a file into the system clipboard: -`xclip {{[-se|-selection]}} clip {{input_file.txt}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{input_file.txt}}` - Copy the contents of a PNG into the system clipboard (can be pasted in other programs correctly): -`xclip {{[-se|-selection]}} clip {{[-t|-target]}} image/png {{input_file.png}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png {{input_file.png}}` - Copy the user input in the console into the system clipboard: @@ -35,4 +35,4 @@ - Paste the contents of the system clipboard to the console: -`xclip {{[-o|-out]}} {{[-se|-selection]}} clip` +`xclip {{[-o|-out]}} {{[-se|-selection]}} {{[c|clipboard]}}` diff --git a/pages/linux/xvfb-run.md b/pages/linux/xvfb-run.md index 01638a6f01..09a551c81f 100644 --- a/pages/linux/xvfb-run.md +++ b/pages/linux/xvfb-run.md @@ -1,7 +1,7 @@ # xvfb-run > Run a command in a virtual X server environment. -> More information: . +> More information: . - Run the specified command in a virtual X server: @@ -9,8 +9,8 @@ - Try to get a free server number, if the default (99) is not available: -`xvfb-run --auto-servernum {{command}}` +`xvfb-run {{[-a|--auto-servernum]}} {{command}}` - Pass arguments to the Xvfb server: -`xvfb-run --server-args "{{-screen 0 1024x768x24}}" {{command}}` +`xvfb-run {{[-s|--server-args]}} "{{-screen 0 1024x768x24}}" {{command}}`