Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

linux/*: switch from using mnemonics to option placeholders #16029

Merged
merged 6 commits into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pages/linux/agetty.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@

`agetty {{[-t|--timeout]}} {{timeout_in_seconds}} -`

- Assume the `tty` is [8]-bit, overriding the `TERM` environment variable set by `init`:
- Assume the `tty` is 8-bit, overriding the `TERM` environment variable set by `init`:

`agetty -8 - {{term_var}}`
`agetty {{[-8|--8bits]}} - {{term_var}}`

- Skip the login (no login) and invoke, as root, another login program instead of `/bin/login`:

Expand Down
14 changes: 7 additions & 7 deletions pages/linux/apx-subsystems.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Manage subsystems in `apx`.
> Subsystems are containers that can be created based on pre-existing stacks.
> More information: <https://github.com/Vanilla-OS/apx>.
> More information: <https://docs.vanillaos.org/docs/en/apx-manpage#subsystems>.

- Interactively create a new subsystem:

Expand All @@ -14,16 +14,16 @@

- Reset a specific subsystem to its initial state:

`apx subsystems reset --name {{string}}`
`apx subsystems reset {{[-n|--name]}} {{string}}`

- [f]orce reset a specific subsystem:
- Force reset a specific subsystem:

`apx subsystems reset --name {{string}} --force`
`apx subsystems reset {{[-n|--name]}} {{string}} {{[-f|--force]}}`

- Remove a specific subsystem:

`apx subsystems rm --name {{string}}`
`apx subsystems rm {{[-n|--name]}} {{string}}`

- [f]orce remove a specific subsystem:
- Force remove a specific subsystem:

`apx subsystems rm --name {{string}} --force`
`apx subsystems rm {{[-n|--name]}} {{string}} {{[-f|--force]}}`
2 changes: 1 addition & 1 deletion pages/linux/arithmetic.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# arithmetic

> Quiz on simple arithmetic problems.
> More information: <https://manned.org/arithmetic.6>.
> More information: <https://manned.org/arithmetic>.

- Start an arithmetic quiz:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/arpspoof.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# arpspoof

> Forge ARP replies to intercept packets.
> More information: <https://monkey.org/~dugsong/dsniff>.
> More information: <https://manned.org/arpspoof>.

- Poison all hosts to intercept packets on [i]nterface for the host:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/asterisk.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# asterisk

> Run and manage telephone and exchange (phone) server instances.
> More information: <https://docs.asterisk.org>.
> More information: <https://docs.asterisk.org/Operation/>.

- [r]econnect to a running server, and turn on logging 3 levels of [v]erbosity:

Expand Down
12 changes: 6 additions & 6 deletions pages/linux/autorecon.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

`sudo autorecon {{host_or_ip1,host_or_ip2,...}}`

- Perform reconnaissance on [t]arget(s) from a file:
- Perform reconnaissance on target(s) from a file:

`sudo autorecon --target-file {{path/to/file}}`
`sudo autorecon {{[-t|--target-file]}} {{path/to/file}}`

- [o]utput results to a different directory:
- Output results to a different directory:

`sudo autorecon --output {{path/to/results}} {{host_or_ip1,host_or_ip2,...}}`
`sudo autorecon {{[-o|--output]}} {{path/to/results}} {{host_or_ip1,host_or_ip2,...}}`

- Limit scanning to specific [p]orts and protocols (`T` for TCP, `U` for UDP, `B` for both):
- Limit scanning to specific ports and protocols (`T` for TCP, `U` for UDP, `B` for both):

`sudo autorecon --ports {{T:21-25,80,443,U:53,B:123}} {{host_or_ip1,host_or_ip2,...}}`
`sudo autorecon {{[-p|--ports]}} {{T:21-25,80,443,U:53,B:123}} {{host_or_ip1,host_or_ip2,...}}`
2 changes: 1 addition & 1 deletion pages/linux/bwa.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Burrows-Wheeler Alignment tool.
> Short, low-divergent DNA sequences mapper against a large reference genome, such as the human genome.
> More information: <https://github.com/lh3/bwa>.
> More information: <https://manned.org/bwa>.

- Index the reference genome:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/cat.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

`cat - > {{path/to/file}}`

- [n]umber all output lines:
- Number all output lines:

`cat {{[-n|--number]}} {{path/to/file}}`

Expand Down
12 changes: 6 additions & 6 deletions pages/linux/cpupower.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@

- List CPUs:

`sudo cpupower --cpu {{all}} info`
`sudo cpupower {{[-c|--cpu]}} {{all}} info`

- Print information about all cores:

`sudo cpupower --cpu {{all}} info`
`sudo cpupower {{[-c|--cpu]}} {{all}} info`

- Set all CPUs to a power-saving frequency governor:

`sudo cpupower --cpu {{all}} frequency-set --governor {{powersave}}`
`sudo cpupower {{[-c|--cpu]}} {{all}} frequency-set --governor {{powersave}}`

- Print CPU 0's available frequency [g]overnors:
- Print CPU 0's available frequency governors:

`sudo cpupower --cpu {{0}} frequency-info g | grep "analyzing\|governors"`
`sudo cpupower {{[-c|--cpu]}} {{0}} frequency-info {{[-g|--governors]}} | grep "analyzing\|governors"`

- Print CPU 4's frequency from the hardware, in a human-readable format:

`sudo cpupower --cpu {{4}} frequency-info --hwfreq --human`
`sudo cpupower {{[-c|--cpu]}} {{4}} frequency-info {{[-w|--hwfreq]}} {{[-m|--human]}}`
2 changes: 1 addition & 1 deletion pages/linux/cryptcat.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# cryptcat

> Cryptcat is netcat with encryption capabilities.
> More information: <https://cryptcat.sourceforge.net>.
> More information: <https://manned.org/cryptcat>.

- [l]isten on a specified [p]ort and print any data received:

Expand Down
2 changes: 1 addition & 1 deletion pages/linux/dbclient.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# dbclient

> Lightweight Dropbear Secure Shell client.
> More information: <https://manned.org/dbclient.1>.
> More information: <https://manned.org/dbclient>.

- Connect to a remote host:

Expand All @@ -11,7 +11,7 @@

`dbclient {{user}}@{{host}} -p 2222`

- Connect to a remote host using a specific [i]dentity key in dropbear format:

Check failure on line 14 in pages/linux/dbclient.md

View workflow job for this annotation

GitHub Actions / build

dentity ==> identity, density, entity

`dbclient -i {{path/to/key_file}} {{user}}@{{host}}`

Expand Down
16 changes: 8 additions & 8 deletions pages/linux/dpigs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@

- Display the N largest packages on the system:

`dpigs --lines={{N}}`
`dpigs {{[-n|--lines]}} {{N}}`

- Use the specified file instead of the default dpkg [s]tatus file:
- Use the specified file instead of the default dpkg status file:

`dpigs --status={{path/to/file}}`
`dpigs {{[-s|--status]}} {{path/to/file}}`

- Display the largest [S]ource packages of binary packages installed on the system:
- Display the largest source packages of binary packages installed on the system:

`dpigs --source`
`dpigs {{[-S|--source]}}`

- Display package sizes in [H]uman-readable format:
- Display package sizes in human-readable format:

`dpigs --human-readable`
`dpigs {{[-H|--human-readable]}}`

- Display help:

`dpigs --help`
`dpigs {{[-h|--help]}}`
2 changes: 1 addition & 1 deletion pages/linux/dropbearkey.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# dropbearkey

> Generate SSH keys in Dropbear format.
> More information: <https://manned.org/dropbearkey.1>.
> More information: <https://manned.org/dropbearkey>.

- Generate an SSH key of [t]ype ed25519 and write it to key [f]ile:

Expand Down
4 changes: 2 additions & 2 deletions pages/linux/esearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@

`esearch -db nuccore -query "{{insulin [PROT] AND rodents [ORGN]}}"`

- Display [h]elp:
- Display help:

`esearch -h`
`esearch {{[-h|-help]}}`
8 changes: 4 additions & 4 deletions pages/linux/getfacl.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

`getfacl {{path/to/file_or_directory}}`

- Display the file access control list with [n]umeric user and group IDs:
- Display the file access control list with numeric user and group IDs:

`getfacl --numeric {{path/to/file_or_directory}}`
`getfacl {{[-n|--numeric]}} {{path/to/file_or_directory}}`

- Display the file access control list with [t]abular output format:
- Display the file access control list with tabular output format:

`getfacl --tabular {{path/to/file_or_directory}}`
`getfacl {{[-t|--tabular]}} {{path/to/file_or_directory}}`
8 changes: 4 additions & 4 deletions pages/linux/iptables-save.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@

`sudo iptables-save`

- Print the `iptables` configuration of a specific [t]able:
- Print the `iptables` configuration of a specific table:

`sudo iptables-save --table {{table}}`
`sudo iptables-save {{[-t|--table]}} {{table}}`

- Save the `iptables` configuration to a [f]ile:
- Save the `iptables` configuration to a file:

`sudo iptables-save --file {{path/to/file}}`
`sudo iptables-save {{[-f|--file]}} {{path/to/file}}`
8 changes: 4 additions & 4 deletions pages/linux/lsipc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@

`lsipc {{--shmems|--queues|--semaphores}}`

- Show full details on the resource with a specific [i]D:
- Show full details on the resource with a specific ID:

`lsipc {{--shmems|--queues|--semaphores}} --id {{resource_id}}`
`lsipc {{--shmems|--queues|--semaphores}} {{[-i|--id]}} {{resource_id}}`

- Print the given [o]utput columns (see all supported columns with `--help`):
- Print the given output columns (see all supported columns with `--help`):

`lsipc --output {{KEY,ID,PERMS,SEND,STATUS,NSEMS,RESOURCE,...}}`
`lsipc {{[-o|--output]}} {{KEY,ID,PERMS,SEND,STATUS,NSEMS,RESOURCE,...}}`

- Use [r]aw, [J]SON, [l]ist or [e]xport (key="value") format:

Check failure on line 23 in pages/linux/lsipc.md

View workflow job for this annotation

GitHub Actions / build

ist ==> is, it, its, it's, sit, list

`lsipc {{--raw|--json|--list|--export}}`

Expand Down
12 changes: 6 additions & 6 deletions pages/linux/macchanger.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@

- View the current and permanent MAC addresses of a interface:

`macchanger --show {{interface}}`
`macchanger {{[-s|--show]}} {{interface}}`

- Set interface to a random MAC:

`macchanger --random {{interface}}`
`macchanger {{[-r|--random]}} {{interface}}`

- Set an interface to a random MAC address, and pretend to be a [b]urned-[i]n-[a]ddress:

Check failure on line 14 in pages/linux/macchanger.md

View workflow job for this annotation

GitHub Actions / build

ddress ==> address, dress

`macchanger --random --bia {{interface}}`
`macchanger {{[-r|--random]}} {{[-b|--bia]}} {{interface}}`

- Set an interface to a specific MAC address:

`macchanger --mac {{XX:XX:XX:XX:XX:XX}} {{interface}}`
`macchanger {{[-m|--mac]}} {{XX:XX:XX:XX:XX:XX}} {{interface}}`

- Print the identifications (the first three bytes of a MAC address) of all known vendors:

`macchanger --list`
`macchanger {{[-l|--list]}}`

- Reset an interface to its permanent hardware MAC address:

`macchanger --permanent {{interface}}`
`macchanger {{[-p|--permanent]}} {{interface}}`
6 changes: 3 additions & 3 deletions pages/linux/namcap.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# namcap

> Check binary packages and source `PKGBUILD`s for common packaging mistakes.
> More information: <https://manned.org/namcap.1>.
> More information: <https://manned.org/namcap>.

- Check a specific `PKGBUILD` file:

Expand All @@ -11,6 +11,6 @@

`namcap {{path/to/package.pkg.tar.zst}}`

- Check a file, printing extra [i]nformational messages:
- Check a file, printing extra informational messages:

`namcap -i {{path/to/file}}`
`namcap {{[-i|--info]}} {{path/to/file}}`
2 changes: 1 addition & 1 deletion pages/linux/needrestart.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# needrestart

> Check which daemons need to be restarted after library upgrades.
> More information: <https://github.com/liske/needrestart>.
> More information: <https://manned.org/needrestart>.

- List outdated processes:

Expand Down
8 changes: 4 additions & 4 deletions pages/linux/nitch.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# nitch

Check failure on line 1 in pages/linux/nitch.md

View workflow job for this annotation

GitHub Actions / build

nitch ==> niche

> A small and incredibly fast system fetch written fully in Nim.
> More information: <https://github.com/ssleert/nitch>.

Check failure on line 4 in pages/linux/nitch.md

View workflow job for this annotation

GitHub Actions / build

nitch ==> niche

- Display system information (hostname, kernel, uptime, etc.):

`nitch`

Check failure on line 8 in pages/linux/nitch.md

View workflow job for this annotation

GitHub Actions / build

nitch ==> niche

- Display [h]elp:
- Display help:

`nitch --help`
`nitch {{[-h|--help]}}`

Check failure on line 12 in pages/linux/nitch.md

View workflow job for this annotation

GitHub Actions / build

nitch ==> niche

- Display [v]ersion:
- Display version:

`nitch --version`
`nitch {{[-v|--version]}}`

Check failure on line 16 in pages/linux/nitch.md

View workflow job for this annotation

GitHub Actions / build

nitch ==> niche
14 changes: 7 additions & 7 deletions pages/linux/pkgctl-diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

> Compare package files using different modes.
> See also: `pkgctl`.
> More information: <https://manned.org/pkgctl-diff.1>.
> More information: <https://manned.org/pkgctl-diff>.

- Compare package files in tar content [l]ist different mode (default):
- Compare package files in tar content list different mode (default):

`pkgctl diff --list {{path/to/file|pkgname}}`
`pkgctl diff {{[-l|--list]}} {{path/to/file|pkgname}}`

- Compare package files in [d]iffoscope different mode:
- Compare package files in diffoscope different mode:

`pkgctl diff --diffoscope {{path/to/file|pkgname}}`
`pkgctl diff {{[-d|--diffoscope]}} {{path/to/file|pkgname}}`

- Compare package files in `.PKGINFO` different mode:

`pkgctl diff --pkginfo {{path/to/file|pkgname}}`
`pkgctl diff {{[-p|--pkginfo]}} {{path/to/file|pkgname}}`

- Compare package files in `.BUILDINFO` different mode:

`pkgctl diff --buildinfo {{path/to/file|pkgname}}`
`pkgctl diff {{[-b|--buildinfo]}} {{path/to/file|pkgname}}`
2 changes: 1 addition & 1 deletion pages/linux/pyrit.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# pyrit

> WPA/WPA2 cracking tool using computational power.
> More information: <https://github.com/JPaulMora/Pyrit>.
> More information: <https://manned.org/pyrit>.

- Display system cracking speed:

Expand Down
8 changes: 4 additions & 4 deletions pages/linux/qrcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

`qrcp send --zip {{path/to/file_or_directory}}`

- Use a specific [p]ort:
- Use a specific port:

`qrcp {{send|receive}} --port {{port_number}}`
`qrcp {{send|receive}} {{[-p|--port]}} {{port_number}}`

- Use a specific network [i]nterface:
- Use a specific network interface:

`qrcp {{send|receive}} --interface {{interface}}`
`qrcp {{send|receive}} {{[-i|--interface]}} {{interface}}`

- Keep the server alive:

Expand Down
4 changes: 2 additions & 2 deletions pages/linux/rig.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

`rig -{{m|f}}`

- Use data files from a specific directory (default is `/usr/share/rig`):
- Use [d]ata files from a specific directory (default is `/usr/share/rig`):

`rig -d {{path/to/directory}}`

- Display a specific number of identities:

`rig -c {{number}}`

- Display a specific number of female identities:
- Display a specific number of [f]emale identities:

`rig -f -c {{number}}`
Loading