Skip to content

Commit 53edfec

Browse files
committed
Improve command quality
1 parent afbc194 commit 53edfec

16 files changed

Lines changed: 406 additions & 158 deletions

assets/commands/aa-status.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Display the number of policies in **kill mode**
4343
# PARAMETERS
4444

4545
**--enabled**
46-
> Returns error code if AppArmor is not active
46+
> Returns error code if AppArmor is not enabled
4747
4848
**--profiled**
4949
> Shows count of loaded AppArmor policies
@@ -52,16 +52,19 @@ Display the number of policies in **kill mode**
5252
> Shows count of enforcing policies
5353
5454
**--complaining**
55-
> Shows count of non-enforcing policies
55+
> Shows count of non-enforcing (complain mode) policies
5656
5757
**--kill**
5858
> Shows count of enforcing policies that terminate tasks on violations
5959
60+
**--prompt**
61+
> Shows count of enforcing policies with fallback to userspace mediation
62+
6063
**--special-unconfined**
6164
> Shows count of unconfined mode policies
6265
6366
**--process-mixed**
64-
> Shows processes confined by stacked profiles in different modes
67+
> Shows count of processes confined by profile stacks with profiles in different modes
6568
6669
**--verbose**
6770
> Displays comprehensive AppArmor policy data (default behavior)
@@ -72,6 +75,24 @@ Display the number of policies in **kill mode**
7275
**--pretty-json**
7376
> Provides human and machine-readable JSON output
7477
78+
**--count**
79+
> Shows only counts for selected information
80+
81+
**--show** _TYPE_
82+
> Specify what to display: processes, profiles, or all (default: all)
83+
84+
**--filter.mode** _REGEX_
85+
> Filter output by profile mode using a POSIX regular expression
86+
87+
**--filter.profiles** _REGEX_
88+
> Filter output by confining profile name using a POSIX regular expression
89+
90+
**--filter.pid** _REGEX_
91+
> Filter output by process PID using a POSIX regular expression
92+
93+
**--filter.exe** _REGEX_
94+
> Filter output by executable name using a POSIX regular expression
95+
7596
**--help**
7697
> Displays usage information
7798

assets/commands/ansible-inventory.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TAGLINE
22

3-
Inspect and display inventory data
3+
Show Ansible inventory information
44

55
# TLDR
66

@@ -24,13 +24,21 @@ Output in **YAML** format
2424

2525
```ansible-inventory --list --yaml```
2626

27-
List hosts matching **pattern**
27+
List hosts matching a **group pattern**
2828

2929
```ansible-inventory --graph [webservers]```
3030

31+
**Export** inventory to a file
32+
33+
```ansible-inventory --list --export --output [inventory.json]```
34+
35+
Show inventory in **TOML** format
36+
37+
```ansible-inventory --list --toml```
38+
3139
# SYNOPSIS
3240

33-
**ansible-inventory** [_-i inventory_] [_--list_|_--graph_|_--host host_]
41+
**ansible-inventory** [_options_] [_-i inventory_] [_--list_|_--graph_|_--host host_] [_group_]
3442

3543
# DESCRIPTION
3644

assets/commands/antlr.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Generate parsers from grammar files
4545
> Location to search for imported grammars and token files
4646
4747
**-Dlanguage=**_lang_
48-
> Target language: Java (default), Python3, CSharp, JavaScript, TypeScript, Go, Cpp, Swift, Dart, PHP
48+
> Target language: Java (default), Python3, CSharp, JavaScript, TypeScript, Go, Cpp, Swift, Dart, PHP. Use **-D**_option_**=**_value_ to override any grammar-level option.
4949
5050
**-package** _name_
5151
> Package or namespace for generated code
@@ -83,6 +83,12 @@ Generate parsers from grammar files
8383
**-Xlog**
8484
> Create detailed log file (antlr-timestamp.log)
8585
86+
**-Xexact-output-dir**
87+
> Place all output directly into **-o** directory regardless of paths or package structure
88+
89+
**-XdbgST**
90+
> Launch StringTemplate visualizer on generated code
91+
8692
# DESCRIPTION
8793

8894
**ANTLR** (ANother Tool for Language Recognition) is a parser generator that creates lexers, parsers, and tree walkers from grammar files. It generates code that can read, process, and translate structured text or binary data.

assets/commands/browsh.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ Modern text-based web browser for terminals
88

99
```browsh```
1010

11-
**Open specific URL**
11+
**Open a specific** URL
1212

1313
```browsh [https://example.com]```
1414

15-
**Run in Docker container**
15+
**Run with a visible** Firefox **GUI** window instead of headless mode
1616

17-
```docker run --rm -it browsh/browsh```
17+
```browsh --firefox.with-gui```
1818

19-
**Take screenshot**
19+
**Use a custom** Firefox **binary** path
2020

21-
```ALT+SHIFT+p```
21+
```browsh --firefox.path [/path/to/firefox]```
2222

23-
**Toggle monochrome mode**
23+
**Run in HTTP server** mode for browser-based access
2424

25-
```ALT+m```
25+
```browsh --http-server-mode```
2626

27-
**Toggle mobile user agent**
27+
**Connect to an already running** Firefox instance
2828

29-
```ALT+u```
29+
```browsh --firefox.use-existing```
3030

3131
# SYNOPSIS
3232

@@ -41,16 +41,25 @@ The browser supports HTML5, CSS3, JavaScript, images, WebGL content, and video p
4141
# PARAMETERS
4242

4343
**--firefox.path** _path_
44-
> Path to Firefox binary
44+
> Path to Firefox executable. Default is "firefox".
45+
46+
**--firefox.use-existing**
47+
> Connect to an already running Firefox instance instead of launching a new one. Firefox must have been started with the --marionette flag.
48+
49+
**--firefox.with-gui**
50+
> Run Firefox with a visible GUI window instead of headless mode.
4551
4652
**--http-server-mode**
47-
> Run as HTTP server for browser access
53+
> Run as an HTTP server for browser access.
4854
4955
**--startup-url** _url_
50-
> URL to open on startup
56+
> URL to open on startup. Default is "https://google.com".
5157
5258
**--time-limit** _seconds_
53-
> Limit session duration
59+
> Kill browsh after the specified number of seconds.
60+
61+
**--debug**
62+
> Enable debug logging to ./debug.log.
5463
5564
# KEY BINDINGS
5665

@@ -83,4 +92,4 @@ Browsh was created as a modern replacement for text browsers like Lynx, capable
8392

8493
# SEE ALSO
8594

86-
[lynx](/man/lynx)(1), [w3m](/man/w3m)(1), [links](/man/links)(1), [firefox](/man/firefox)(1)
95+
[lynx](/man/lynx)(1), [w3m](/man/w3m)(1), [links](/man/links)(1), [elinks](/man/elinks)(1), [firefox](/man/firefox)(1)

assets/commands/chronic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Silences command output unless it fails
3030

3131
# SYNOPSIS
3232

33-
**chronic** [-ve] _command_ ...
33+
**chronic** [-ev] _command_ ...
3434

3535
# DESCRIPTION
3636

assets/commands/cinnamon.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,25 @@ Traditional Linux desktop environment
44

55
# TLDR
66

7-
**Start Cinnamon desktop (typically via display manager)**
7+
**Start Cinnamon** desktop (typically via display manager)
88

99
```cinnamon```
1010

11-
**Replace the current window manager with Cinnamon**
11+
**Replace** the current window manager with Cinnamon
1212

1313
```cinnamon --replace```
1414

15-
**Display version information**
15+
**Replace** the window manager without session manager connection
16+
17+
```cinnamon --replace --sm-disable```
18+
19+
**Display version** information
1620

1721
```cinnamon --version```
1822

1923
# SYNOPSIS
2024

21-
**cinnamon** [**--replace**] [**--display** _DISPLAY_]
25+
**cinnamon** [**--replace**] [**--sm-disable**] [**-d** _DISPLAY_] [**--screen** _SCREEN_]
2226

2327
# DESCRIPTION
2428

@@ -33,14 +37,26 @@ Cinnamon supports extensive customization through applets (panel widgets), deskl
3337
**--replace**
3438
> Replace the currently running window manager
3539
36-
**--display** _DISPLAY_
40+
**-d**, **--display** _DISPLAY_
3741
> X display to use
3842
39-
**--debug**
40-
> Enable debug output
43+
**--screen** _SCREEN_
44+
> X screen to use
45+
46+
**--sm-disable**
47+
> Disable connection to the session manager
48+
49+
**--sm-client-id** _ID_
50+
> Specify session management ID
51+
52+
**--sm-save-file** _FILE_
53+
> Initialize session from a saved session file
54+
55+
**--sync**
56+
> Make X calls synchronous
4157
4258
**--version**
43-
> Display version information
59+
> Print version and exit
4460
4561
# CAVEATS
4662

@@ -54,4 +70,4 @@ Cinnamon does not support using a different window manager; Muffin is integral t
5470

5571
# SEE ALSO
5672

57-
[muffin](/man/muffin)(1), [nemo](/man/nemo)(1)
73+
[muffin](/man/muffin)(1), [nemo](/man/nemo)(1), [cinnamon-launcher](/man/cinnamon-launcher)(1)

assets/commands/dolt-clone.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ create local copy of remote database repository
2020

2121
```dolt clone -b [branch] [owner/repo]```
2222

23+
**Shallow clone** with limited history depth
24+
25+
```dolt clone --depth [1] [owner/repo]```
26+
27+
**Clone a private** repository with authentication
28+
29+
```dolt clone --user [username] [owner/repo]```
30+
2331
# SYNOPSIS
2432

2533
**dolt clone** [_options_] _repository_ [_directory_]
@@ -38,9 +46,15 @@ _DIRECTORY_
3846
**--remote** _NAME_
3947
> Name for the remote (default: origin).
4048
49+
**--depth** _N_
50+
> Perform a shallow clone with history limited to N commits.
51+
4152
**--single-branch**
4253
> Clone only one branch.
4354
55+
**--user** _USERNAME_
56+
> User name for authentication with the remote. Password is read from the DOLT_REMOTE_PASSWORD environment variable.
57+
4458
**--help**
4559
> Display help information.
4660
@@ -62,4 +76,4 @@ dolt clone is part of **Dolt**, implementing Git's clone semantics for database
6276

6377
# SEE ALSO
6478

65-
[dolt](/man/dolt)(1), [dolt-push](/man/dolt-push)(1), [dolt-pull](/man/dolt-pull)(1), [git-clone](/man/git-clone)(1)
79+
[dolt](/man/dolt)(1), [dolt-fetch](/man/dolt-fetch)(1), [dolt-branch](/man/dolt-branch)(1), [git-clone](/man/git-clone)(1)

assets/commands/exec.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ shell builtin to replace process with command
44

55
# TLDR
66

7-
**Execute** a specific command
7+
**Execute** a specific command, **replacing** the current shell
88

99
```exec [command -with -flags]```
1010

@@ -16,35 +16,53 @@ Execute as **login shell**
1616

1717
```exec -l [command -with -flags]```
1818

19-
Execute with **different name**
19+
Execute with a **different name** as argv[0]
2020

2121
```exec -a [name] [command -with -flags]```
2222

23+
**Redirect** all shell **stdout** to a file
24+
25+
```exec >[path/to/logfile]```
26+
27+
**Redirect** both **stdout and stderr** to a file
28+
29+
```exec >[path/to/logfile] 2>&1```
30+
31+
Open a file on **file descriptor** 3 for reading
32+
33+
```exec 3<[path/to/file]```
34+
35+
**Close** file descriptor 3
36+
37+
```exec 3>&-```
38+
2339
# SYNOPSIS
2440

25-
**exec** [_options_] [_command_] [_arguments_]
41+
**exec** [_-cl_] [_-a name_] [_command_] [_arguments_] [_redirection ..._]
2642

2743
# PARAMETERS
2844

2945
**-c**
30-
> Execute with mostly empty environment
46+
> Execute the command with a mostly empty environment, clearing inherited environment variables.
3147
3248
**-l**
33-
> Pass command as login shell
49+
> Place a dash at the beginning of argv[0], causing the command to behave as a login shell.
3450
3551
**-a** _name_
36-
> Pass name as argv[0] to command
52+
> Pass _name_ as argv[0] to the executed command instead of the actual command name.
3753
3854
# DESCRIPTION
3955

4056
**exec** replaces the current shell process with the specified command without creating a child process. When exec completes, the shell session ends because the shell process no longer exists.
4157

42-
Built-in shell command commonly used in shell scripts and wrapper scripts.
58+
If no command is specified but redirections are provided, the redirections take effect in the current shell. This allows redirecting stdin, stdout, or stderr for all subsequent commands, and opening or closing arbitrary file descriptors.
59+
60+
If the command cannot be executed, a non-interactive shell exits unless the **execfail** shell option is set. An interactive shell does not exit if exec fails.
4361

4462
# CAVEATS
4563

46-
Shell built-in command. The shell terminates after exec completes. File descriptors can be redirected before exec. Used in init scripts and process management.
64+
Shell built-in command. The shell terminates after exec completes, so any commands after exec in a script will not run. File descriptor redirections without a command persist in the current shell. Behavior may vary slightly between bash, zsh, and other POSIX shells.
4765

4866
# SEE ALSO
4967

50-
[bash](/man/bash)(1), [sh](/man/sh)(1)
68+
[bash](/man/bash)(1), [sh](/man/sh)(1), [env](/man/env)(1), [zsh](/man/zsh)(1)

0 commit comments

Comments
 (0)