Skip to content

Commit 67b7b8f

Browse files
authored
common/*: switch from using mnemonics to option placeholders (#16034)
1 parent 42454b6 commit 67b7b8f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+594
-590
lines changed

pages/common/abduco.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# abduco
22

33
> Terminal session manager.
4-
> More information: <https://www.brain-dump.org/projects/abduco/>.
4+
> More information: <https://manned.org/abduco>.
55
66
- List sessions:
77

pages/common/ac.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ac
22

33
> Print statistics on how long users have been connected.
4-
> More information: <https://man.openbsd.org/ac>.
4+
> More information: <https://manned.org/ac.8>.
55
66
- Print how long the current user has been connected in hours:
77

pages/common/act.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# act
22

33
> Execute GitHub Actions locally using Docker.
4-
> More information: <https://github.com/nektos/act>.
4+
> More information: <https://manned.org/act>.
55
6-
- [l]ist the available jobs:
6+
- List the available jobs:
77

8-
`act -l`
8+
`act {{[-l|--list]}}`
99

1010
- Run the default event:
1111

@@ -15,18 +15,18 @@
1515

1616
`act {{event_type}}`
1717

18-
- Run a specific [j]ob:
18+
- Run a specific job:
1919

20-
`act -j {{job_id}}`
20+
`act {{[-j|--job]}} {{job_id}}`
2121

2222
- Do [n]ot actually run the actions (i.e. a dry run):
2323

24-
`act -n`
24+
`act {{[-n|--dryrun]}}`
2525

26-
- Show [v]erbose logs:
26+
- Show verbose logs:
2727

28-
`act -v`
28+
`act {{[-v|--verbose]}}`
2929

30-
- Run a specific [W]orkflow with the push event:
30+
- Run a specific workflow with the push event:
3131

32-
`act push -W {{path/to/workflow}}`
32+
`act push {{[-W|--workflows]}} {{path/to/workflow}}`

pages/common/ag.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ag
22

33
> The Silver Searcher. Like `ack`, but aims to be faster.
4-
> More information: <https://github.com/ggreer/the_silver_searcher>.
4+
> More information: <https://manned.org/ag>.
55
66
- Find files containing "foo", and print the line matches in context:
77

@@ -11,22 +11,22 @@
1111

1212
`ag {{foo}} {{path/to/directory}}`
1313

14-
- Find files containing "foo", but only [l]ist the filenames:
14+
- Find files containing "foo", but only list the filenames:
1515

16-
`ag -l {{foo}}`
16+
`ag {{[-l|--files-with-matches]}} {{foo}}`
1717

18-
- Find files containing "FOO" case-[i]nsensitively, and print [o]nly the match, rather than the whole line:
18+
- Find files containing "FOO" case-insensitively, and print only the match, rather than the whole line:
1919

20-
`ag -i -o {{FOO}}`
20+
`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} {{FOO}}`
2121

2222
- Find "foo" in files with a name matching "bar":
2323

24-
`ag {{foo}} -G {{bar}}`
24+
`ag {{foo}} {{[-G|--file-search-regex]}} {{bar}}`
2525

2626
- Find files whose contents match a regular expression:
2727

2828
`ag '{{^ba(r|z)$}}'`
2929

3030
- Find files with a name matching "foo":
3131

32-
`ag -g {{foo}}`
32+
`ag {{[-g|--filename-pattern]}} {{foo}}`

pages/common/age-keygen.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
- Generate a key pair, save it to an unencrypted file, and print the public key to `stdout`:
88

9-
`age-keygen --output {{path/to/file}}`
9+
`age-keygen {{[-o|--output]}} {{path/to/file}}`
1010

1111
- Convert an identit[y] to a recipient and print the public key to `stdout`:
1212

pages/common/alacritty.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# alacritty
22

33
> Cross-platform, GPU-accelerated terminal emulator.
4-
> More information: <https://github.com/alacritty/alacritty>.
4+
> More information: <https://manned.org/alacritty>.
55
66
- Start a new Alacritty process and create a window:
77

@@ -21,7 +21,7 @@
2121

2222
- [e]xecute a command in a new Alacritty window (also works with `alacritty msg create-window`):
2323

24-
`alacritty -e {{command}}`
24+
`alacritty {{[-e|--command]}} {{command}}`
2525

2626
- Use an alternative configuration file (defaults to `$XDG_CONFIG_HOME/alacritty/alacritty.toml`):
2727

pages/common/ani-cli.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
# ani-cli
22

33
> A cli to browse and watch anime.
4-
> More information: <https://github.com/pystardust/ani-cli>.
4+
> More information: <https://manned.org/ani-cli>.
55
66
- Search anime by name:
77

88
`ani-cli "{{anime_name}}"`
99

10-
- [d]ownload episode:
10+
- Download episode:
1111

12-
`ani-cli -d "{{anime_name}}"`
12+
`ani-cli {{[-d|--download]}} "{{anime_name}}"`
1313

14-
- [d]ownload a [r]ange of episodes:
14+
- Download a range of episodes:
1515

16-
`ani-cli -d -r "{{1 6}}" "{{anime_name}}"`
16+
`ani-cli {{[-d|--download]}} {{[-r|--range]}} "{{1 6}}" "{{anime_name}}"`
1717

18-
- [d]ownload the entire series (a range of all episodes):
18+
- Download the entire series (a range of all episodes):
1919

20-
`ani-cli -d -r "1 -1" "{{anime_name}}"`
20+
`ani-cli {{[-d|--download]}} {{[-r|--range]}} "1 -1" "{{anime_name}}"`
2121

22-
- Use [v]LC as the media player:
22+
- Use VLC as the media player:
2323

24-
`ani-cli -v "{{anime_name}}"`
24+
`ani-cli {{[-v|-vlc]}} "{{anime_name}}"`
2525

26-
- Watch a specific [e]pisode:
26+
- Watch a specific episode:
2727

28-
`ani-cli -e {{episode_number}} "{{anime_name}}"`
28+
`ani-cli {{[-e|--episode]}} {{episode_number}} "{{anime_name}}"`
2929

30-
- [c]ontinue watching anime from history:
30+
- Continue watching anime from history:
3131

32-
`ani-cli -c`
32+
`ani-cli {{[-c|--continue]}}`
3333

34-
- [U]pdate `ani-cli`:
34+
- Update `ani-cli`:
3535

36-
`ani-cli -U`
36+
`ani-cli {{[-U|--update]}}`

pages/common/ansible-playbook.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@
77

88
`ansible-playbook {{playbook}}`
99

10-
- Run tasks in playbook with custom host [i]nventory:
10+
- Run tasks in playbook with custom host inventory:
1111

12-
`ansible-playbook {{playbook}} -i {{inventory_file}}`
12+
`ansible-playbook {{playbook}} {{[-i|--inventory]}} {{inventory_file}}`
1313

14-
- Run tasks in playbook with [e]xtra variables defined via the command-line:
14+
- Run tasks in playbook with extra variables defined via the command-line:
1515

16-
`ansible-playbook {{playbook}} -e "{{variable1}}={{value1}} {{variable2}}={{value2}}"`
16+
`ansible-playbook {{playbook}} {{[-e|--extra-vars]}} "{{variable1}}={{value1}} {{variable2}}={{value2}}"`
1717

18-
- Run tasks in playbook with [e]xtra variables defined in a JSON file:
18+
- Run tasks in playbook with extra variables defined in a JSON file:
1919

20-
`ansible-playbook {{playbook}} -e "@{{variables.json}}"`
20+
`ansible-playbook {{playbook}} {{[-e|--extra-vars]}} "@{{variables.json}}"`
2121

2222
- Run tasks in playbook for the given tags:
2323

24-
`ansible-playbook {{playbook}} --tags {{tag1,tag2}}`
24+
`ansible-playbook {{playbook}} {{[-t|--tags]}} {{tag1,tag2}}`
2525

2626
- Run tasks in a playbook starting at a specific task:
2727

2828
`ansible-playbook {{playbook}} --start-at {{task_name}}`
2929

3030
- Run tasks in a playbook without making any changes (dry-run):
3131

32-
`ansible-playbook {{playbook}} --check --diff`
32+
`ansible-playbook {{playbook}} {{[-C|--check]}} {{[-D|--diff]}}`

pages/common/ansible.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22

33
> Manage groups of computers remotely over SSH. (use the `/etc/ansible/hosts` file to add new groups/hosts).
44
> Some subcommands such as `galaxy` have their own usage documentation.
5-
> More information: <https://www.ansible.com/>.
5+
> More information: <https://docs.ansible.com/ansible/latest/cli/ansible.html>.
66
77
- List hosts belonging to a group:
88

99
`ansible {{group}} --list-hosts`
1010

11-
- Ping a group of hosts by invoking the ping [m]odule:
11+
- Ping a group of hosts by invoking the ping module:
1212

13-
`ansible {{group}} -m ping`
13+
`ansible {{group}} {{[-m|--module-name]}} ping`
1414

1515
- Display facts about a group of hosts by invoking the setup [m]odule:
1616

17-
`ansible {{group}} -m setup`
17+
`ansible {{group}} {{[-m|--module-name]}} setup`
1818

1919
- Execute a command on a group of hosts by invoking command module with arguments:
2020

21-
`ansible {{group}} -m command -a '{{my_command}}'`
21+
`ansible {{group}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'`
2222

2323
- Execute a command with administrative privileges:
2424

25-
`ansible {{group}} --become --ask-become-pass -m command -a '{{my_command}}'`
25+
`ansible {{group}} {{[-b|--become]}} --ask-become-pass {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'`
2626

2727
- Execute a command using a custom inventory file:
2828

29-
`ansible {{group}} -i {{inventory_file}} -m command -a '{{my_command}}'`
29+
`ansible {{group}} {{[-i|--inventory]}} {{inventory_file}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'`
3030

3131
- List the groups in an inventory:
3232

33-
`ansible localhost -m debug -a '{{var=groups.keys()}}'`
33+
`ansible localhost {{[-m|--module-name]}} debug {{[-a|--args]}} '{{var=groups.keys()}}'`

pages/common/ant.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# ant
22

33
> Apache Ant: build and manage Java-based projects.
4-
> More information: <https://ant.apache.org>.
4+
> More information: <https://ant.apache.org/manual/index.html>.
55
66
- Build a project with default build file `build.xml`:
77

88
`ant`
99

10-
- Build a project using build [f]ile other than `build.xml`:
10+
- Build a project using build file other than `build.xml`:
1111

12-
`ant -f {{buildfile.xml}}`
12+
`ant {{[-f|-buildfile]}} {{buildfile.xml}}`
1313

1414
- Print information on possible targets for this project:
1515

16-
`ant -p`
16+
`ant {{[-p|-projecthelp]}}`
1717

1818
- Print debugging information:
1919

20-
`ant -d`
20+
`ant {{[-d|-debug]}}`
2121

2222
- Execute all targets that do not depend on fail target(s):
2323

24-
`ant -k`
24+
`ant {{[-k|-keep-going]}}`

pages/common/apkleaks.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
> Note: APKLeaks utilizes the `jadx` disassembler to decompile APK files.
55
> More information: <https://github.com/dwisiswant0/apkleaks>.
66
7-
- Scan an APK [f]ile for URIs, endpoints, and secrets:
7+
- Scan an APK file for URIs, endpoints, and secrets:
88

9-
`apkleaks --file {{path/to/file.apk}}`
9+
`apkleaks {{[-f|--file]}} {{path/to/file.apk}}`
1010

11-
- Scan and save the [o]utput to a specific file:
11+
- Scan and save the output to a specific file:
1212

13-
`apkleaks --file {{path/to/file.apk}} --output {{path/to/output.txt}}`
13+
`apkleaks {{[-f|--file]}} {{path/to/file.apk}} {{[-o|--output]}} {{path/to/output.txt}}`
1414

15-
- Pass `jadx` disassembler [a]rguments:
15+
- Pass `jadx` disassembler arguments:
1616

17-
`apkleaks --file {{path/to/file.apk}} --args "{{--threads-count 5 --deobf}}"`
17+
`apkleaks {{[-f|--file]}} {{path/to/file.apk}} {{[-a|--args]}} "{{--threads-count 5 --deobf}}"`

pages/common/apropos.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
- Search without restricting the output to the terminal width ([l]ong output):
1111

12-
`apropos -l {{regular_expression}}`
12+
`apropos {{[-l|--long]}} {{regular_expression}}`
1313

14-
- Search for pages that match [a]ll the expressions given:
14+
- Search for pages that match all the expressions given:
1515

16-
`apropos {{regular_expression_1}} -a {{regular_expression_2}} -a {{regular_expression_3}}`
16+
`apropos {{regular_expression_1}} {{[-a|--and]}} {{regular_expression_2}} {{[-a|--and]}} {{regular_expression_3}}`

pages/common/arp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# arp
22

33
> Show and manipulate your system's ARP cache.
4-
> More information: <https://manned.org/arp>.
4+
> More information: <https://manned.org/arp.8>.
55
66
- Show the current ARP table:
77

pages/common/arping.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Discover and probe hosts in a network using the ARP protocol.
44
> Useful for MAC address discovery.
5-
> More information: <https://github.com/ThomasHabets/arping>.
5+
> More information: <https://manned.org/arping>.
66
77
- Ping a host by ARP request packets:
88

pages/common/atoum.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# atoum
22

33
> A simple, modern and intuitive unit testing framework for PHP.
4-
> More information: <https://atoum.org>.
4+
> More information: <https://atoum.readthedocs.io/en/latest/option_cli.html>.
55
66
- Initialize a configuration file:
77

@@ -11,26 +11,26 @@
1111

1212
`atoum`
1313

14-
- Run tests using the specified [c]onfiguration file:
14+
- Run tests using the specified configuration file:
1515

16-
`atoum -c {{path/to/file}}`
16+
`atoum {{[-c|--configuration]}} {{path/to/file}}`
1717

18-
- Run a specific test [f]ile:
18+
- Run a specific test file:
1919

20-
`atoum -f {{path/to/file}}`
20+
`atoum {{[-f|--files]}} {{path/to/file}}`
2121

22-
- Run a specific [d]irectory of tests:
22+
- Run a specific directory of tests:
2323

24-
`atoum -d {{path/to/directory}}`
24+
`atoum {{[-d|--directories]}} {{path/to/directory}}`
2525

26-
- Run all tests under a specific name[s]pace:
26+
- Run all tests under a specific namespace:
2727

28-
`atoum -ns {{namespace}}`
28+
`atoum {{[-ns|--namespaces]}} {{namespace}}`
2929

30-
- Run all tests with a specific [t]ag:
30+
- Run all tests with a specific tag:
3131

32-
`atoum -t {{tag}}`
32+
`atoum {{[-t|--tags]}} {{tag}}`
3333

3434
- Load a custom bootstrap file before running tests:
3535

36-
`atoum --bootstrap-file {{path/to/file}}`
36+
`atoum {{[-bf|--bootstrap-file]}} {{path/to/file}}`

pages/common/autossh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Run, monitor and restart SSH connections.
44
> Auto-reconnects to keep port forwarding tunnels up. Accepts all SSH flags.
5-
> More information: <https://www.harding.motd.ca/autossh>.
5+
> More information: <https://manned.org/autossh>.
66
77
- Start an SSH session, restarting when the [M]onitoring port fails to return data:
88

pages/common/avrdude.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# avrdude
22

33
> Driver program for Atmel AVR microcontrollers programming.
4-
> More information: <https://www.nongnu.org/avrdude/>.
4+
> More information: <https://www.nongnu.org/avrdude/user-manual/avrdude_3.html#Option-Descriptions>.
55
66
- [r]ead the flash ROM of a AVR microcontroller with a specific [p]art ID:
77

0 commit comments

Comments
 (0)