Skip to content

Commit f06f0b6

Browse files
committed
Improve command quality
1 parent 8d8bde2 commit f06f0b6

48 files changed

Lines changed: 884 additions & 307 deletions

Some content is hidden

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

assets/commands/apptainer-test.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,15 @@ Run validation tests defined in a container
5454
**--fakeroot**
5555
> Run test with fake root privileges.
5656
57-
**--pwd** _path_
57+
**--cwd**, **--pwd** _path_
5858
> Set working directory inside container.
5959
60+
**--writable**, **-w**
61+
> Make file system accessible as read-write.
62+
63+
**--writable-tmpfs**
64+
> Make file system read-write with non-persistent data (tmpfs overlay).
65+
6066
**--help**, **-h**
6167
> Display help for the test command.
6268
@@ -80,4 +86,4 @@ The test subcommand has been part of Singularity/Apptainer since early versions,
8086

8187
# SEE ALSO
8288

83-
[apptainer](/man/apptainer)(1), [apptainer-build](/man/apptainer-build)(1), [apptainer-run](/man/apptainer-run)(1), [apptainer-inspect](/man/apptainer-inspect)(1)
89+
[apptainer](/man/apptainer)(1), [apptainer-build](/man/apptainer-build)(1), [apptainer-run](/man/apptainer-run)(1), [apptainer-exec](/man/apptainer-exec)(1), [apptainer-inspect](/man/apptainer-inspect)(1)

assets/commands/aptitude-create-state-bundle.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Create with **verbose** output
1414

1515
# SYNOPSIS
1616

17-
**aptitude-create-state-bundle** [_--force-bzip2_] [_--print-inputs_] _output_
17+
**aptitude-create-state-bundle** [_options_] _output-file_
1818

1919
# DESCRIPTION
2020

@@ -25,10 +25,13 @@ The bundle includes package lists, aptitude settings, and resolver state.
2525
# PARAMETERS
2626

2727
**--force-bzip2**
28-
> Use bzip2 compression even for .gz extension
28+
> Force bzip2 compression regardless of file extension.
29+
30+
**--force-gzip**
31+
> Force gzip compression even if bzip2 is available.
2932
3033
**--print-inputs**
31-
> List files that would be included
34+
> Display the list of files and directories that would be included without creating the bundle.
3235
3336
**-v**, **--verbose**
3437
> Verbose output

assets/commands/asn1parse.1s.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,27 @@ Parse and display ASN.1 encoded data
66

77
**Parse** ASN.1 data
88

9-
```asn1parse -in [file.der]```
9+
```openssl asn1parse -in [file.der]```
1010

1111
Parse **PEM** encoded file
1212

13-
```asn1parse -in [file.pem] -inform PEM```
13+
```openssl asn1parse -in [file.pem] -inform PEM```
1414

1515
Parse with **offset**
1616

17-
```asn1parse -in [file.der] -offset [100]```
17+
```openssl asn1parse -in [file.der] -offset [100]```
1818

19-
Show **structure** in detail
19+
Show **structure** with hex dump
2020

21-
```asn1parse -in [file.der] -dump```
21+
```openssl asn1parse -in [file.der] -dump```
22+
23+
Parse **nested** ASN.1 structure at a given offset
24+
25+
```openssl asn1parse -in [file.pem] -strparse [offset]```
2226

2327
# SYNOPSIS
2428

25-
**asn1parse** [_-in file_] [_-inform format_] [_-offset n_] [_-dump_] [_options_]
29+
**openssl asn1parse** [**-help**] [**-inform** _DER|PEM_] [**-in** _filename_] [**-out** _filename_] [**-noout**] [**-offset** _number_] [**-length** _number_] [**-i**] [**-dump**] [**-dlimit** _num_] [**-strparse** _offset_] [**-genstr** _string_] [**-genconf** _file_] [**-strictpem**]
2630

2731
# DESCRIPTION
2832

@@ -32,32 +36,47 @@ The tool is invaluable for debugging certificate issues, understanding data stru
3236

3337
# PARAMETERS
3438

35-
**-in** _file_
36-
> Input file
39+
**-help**
40+
> Print usage message.
3741
38-
**-inform** _format_
39-
> Input format: PEM or DER
42+
**-in** _filename_
43+
> Input file, default is standard input.
4044
41-
**-out** _file_
42-
> Output file
45+
**-inform** _DER|PEM_
46+
> Input format; the default is PEM.
47+
48+
**-out** _filename_
49+
> Output file to place the DER encoded data into.
4350
4451
**-noout**
45-
> Don't output parsed structure
52+
> Don't output the parsed version of the input file.
53+
54+
**-offset** _number_
55+
> Starting offset to begin parsing, default is start of file.
4656
47-
**-offset** _n_
48-
> Start parsing at offset n
57+
**-length** _number_
58+
> Number of bytes to parse, default is until end of file.
4959
50-
**-length** _n_
51-
> Parse n bytes
60+
**-i**
61+
> Indent the output according to the depth of the structures.
5262
5363
**-dump**
54-
> Hex dump of content
64+
> Dump unknown data in hex format.
65+
66+
**-dlimit** _num_
67+
> Like **-dump**, but only the first num bytes are output.
5568
5669
**-strparse** _offset_
57-
> Parse nested structure at offset
70+
> Parse the contents octets of the ASN.1 object starting at offset.
5871
5972
**-genstr** _string_
60-
> Generate ASN.1 from string
73+
> Generate encoded data based on string using ASN1_generate_nconf format.
74+
75+
**-genconf** _file_
76+
> Generate encoded data from file using ASN1_generate_nconf format.
77+
78+
**-strictpem**
79+
> Ignore any data prior to the BEGIN marker or after END marker in PEM.
6180
6281
# CAVEATS
6382

@@ -69,4 +88,4 @@ Requires understanding of ASN.1 structure. Output can be verbose for complex obj
6988

7089
# SEE ALSO
7190

72-
[openssl](/man/openssl)(1), [x509](/man/x509)(1), [req](/man/req)(1)
91+
[openssl](/man/openssl)(1), [openssl-x509](/man/openssl-x509)(1), [openssl-req](/man/openssl-req)(1)

assets/commands/aws-vault.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,25 @@ The tool provides defense-in-depth security for AWS credentials and enables easy
5959
> Rotate access keys
6060
6161
**export** _profile_
62-
> Export credentials as environment variables
62+
> Export credentials as environment variables.
63+
64+
**clear** _profile_
65+
> Clear temporary credentials from the session store.
6366
6467
**--duration=**_time_
65-
> Session duration (e.g., 12h, 1h30m)
68+
> Session duration (e.g., 12h, 1h30m).
6669
6770
**--mfa-token=**_token_
68-
> MFA token code
71+
> MFA token code.
6972
7073
**--no-session**
71-
> Don't create STS session
74+
> Use long-term credentials instead of creating an STS session.
75+
76+
**--server**
77+
> Start a local EC2 metadata server instead of using environment variables.
78+
79+
**--backend=**_backend_
80+
> Credential storage backend (keychain, kwallet, pass, secret-service, file).
7281
7382
# FEATURES
7483

assets/commands/az-image.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Manage custom virtual machine images in Azure
3434

3535
# SUBCOMMANDS
3636

37+
**copy**
38+
> Copy a managed image to other regions (requires extension).
39+
3740
**create**
3841
> Create a custom virtual machine image from managed disks or snapshots.
3942
@@ -47,7 +50,10 @@ Manage custom virtual machine images in Azure
4750
> Get information about an image.
4851
4952
**update**
50-
> Update an image.
53+
> Update custom VM images.
54+
55+
**wait**
56+
> Place the CLI in a waiting state until a condition is met.
5157
5258
# PARAMETERS
5359

@@ -66,6 +72,15 @@ Manage custom virtual machine images in Azure
6672
**--os-type**
6773
> Operating system type: Linux or Windows.
6874
75+
**--location** **-l**
76+
> Location for the image.
77+
78+
**--hyper-v-generation**
79+
> Hypervisor generation of the VM: V1 or V2.
80+
81+
**--tags**
82+
> Space-separated tags: key[=value].
83+
6984
**--data-disk-sources**
7085
> Managed disks or snapshots for data disks.
7186
@@ -81,4 +96,4 @@ Requires Azure CLI to be installed and authenticated with **az login**. The sour
8196

8297
# SEE ALSO
8398

84-
[az](/man/az)(1), [az-disk](/man/az-disk)(1), [az-snapshot](/man/az-snapshot)(1)
99+
[az](/man/az)(1), [az-disk](/man/az-disk)(1), [az-vm](/man/az-vm)(1)

assets/commands/brew-update.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Fetch the latest Homebrew and package definitions
3030

3131
# DESCRIPTION
3232

33-
**brew update** fetches the newest version of Homebrew and all formulae definitions from GitHub. It updates Homebrew itself and refreshes the list of available packages.
33+
**brew update** fetches the newest version of Homebrew and all formulae from GitHub using git, and performs any necessary migrations.
3434

3535
This command does not upgrade installed packages - use **brew upgrade** for that.
3636

@@ -53,9 +53,6 @@ Aliases: **brew up**
5353
**--merge**
5454
> Use git merge instead of git rebase
5555
56-
**--quiet, -q**
57-
> Suppress output
58-
5956
# AUTO-UPDATE
6057

6158
Homebrew auto-updates before **brew install** by default. Configure with:

assets/commands/bzgrep.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ Search bzip2 compressed files for patterns
2222

2323
# SYNOPSIS
2424

25-
**bzgrep** [_grep-options_] [_pattern_] [_file_...]
25+
**bzgrep** [_grep-options_] [**-e**] _pattern_ [_filename_...]
2626

2727
# DESCRIPTION
2828

29-
**bzgrep** searches for patterns in bzip2-compressed files without decompressing them to disk. It's a wrapper around grep that transparently handles .bz2 files.
29+
**bzgrep** invokes grep on bzip2-compressed files. If no file is specified, standard input is decompressed if necessary and fed to grep. Otherwise the given files are uncompressed if necessary and fed to grep.
3030

31-
The tool provides the same functionality as grep but for compressed files.
31+
When invoked as **bzegrep** or **bzfgrep**, egrep or fgrep is used instead of grep. The grep program can also be overridden via the **GREP** environment variable.
3232

3333
# PARAMETERS
3434

35-
Supports standard grep options:
35+
All options are passed directly to grep:
3636

3737
**-i**
3838
> Case-insensitive search
@@ -49,6 +49,9 @@ Supports standard grep options:
4949
**-l**
5050
> List matching files
5151
52+
**-e** _pattern_
53+
> Use pattern as the search pattern (useful for patterns starting with -)
54+
5255
**-H**
5356
> Print filename
5457
@@ -58,10 +61,10 @@ Supports standard grep options:
5861
# RELATED COMMANDS
5962

6063
**bzegrep**
61-
> Extended regular expressions (grep -E)
64+
> Extended regular expressions (egrep / grep -E)
6265
6366
**bzfgrep**
64-
> Fixed strings (grep -F)
67+
> Fixed strings (fgrep / grep -F)
6568
6669
# WORKFLOW
6770

@@ -80,6 +83,9 @@ bzgrep -C 3 "error" logfile.bz2
8083

8184
# Count occurrences
8285
bzgrep -c "error" logfile.bz2
86+
87+
# Override grep with fgrep
88+
GREP=fgrep bzgrep string files
8389
```
8490

8591
# CAVEATS
@@ -92,4 +98,4 @@ Slower than searching uncompressed files. Must decompress entire file to search.
9298

9399
# SEE ALSO
94100

95-
[grep](/man/grep)(1), [bzcat](/man/bzcat)(1), [zgrep](/man/zgrep)(1)
101+
[grep](/man/grep)(1), [egrep](/man/egrep)(1), [fgrep](/man/fgrep)(1), [bzdiff](/man/bzdiff)(1), [bzmore](/man/bzmore)(1), [bzless](/man/bzless)(1), [bzip2](/man/bzip2)(1), [zgrep](/man/zgrep)(1)

assets/commands/crane-digest.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ retrieve image content digest
2424
**--full-ref**
2525
> Print the full image reference with digest.
2626
27+
**--tarball** _path_
28+
> Path to tarball containing the image.
29+
2730
# DESCRIPTION
2831

2932
**crane digest** retrieves the content-addressable digest (SHA256) of a container image. The digest uniquely identifies the image content regardless of tag.

assets/commands/cwl-runner.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,27 @@ Common Workflow Language executor
5858
**--quiet**
5959
> Only print warnings and errors.
6060
61-
**--strict**
62-
> Strict validation mode.
61+
**--validate**
62+
> Validate the CWL document without running.
6363
6464
**--leave-tmpdir**
6565
> Don't delete temporary directories.
6666
67+
**--version**
68+
> Print version and exit.
69+
70+
**--make-template**
71+
> Generate template input object.
72+
73+
**--on-error** _action_
74+
> Workflow behavior on failure (stop or continue).
75+
76+
**--singularity**
77+
> Use Singularity container runtime instead of Docker.
78+
79+
**--podman**
80+
> Use Podman container runtime instead of Docker.
81+
6782
# DESCRIPTION
6883

6984
**cwl-runner** executes workflows defined in Common Workflow Language (CWL), a specification for describing analysis workflows in data-intensive sciences. CWL workflows are portable across different execution environments.

assets/commands/dhcpd.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,33 @@ ISC DHCP server daemon for IP address assignment
5858
**-4** / **-6**
5959
> Force IPv4 or IPv6 mode.
6060
61+
**-p** _port_
62+
> Listen on alternate UDP port (default 67).
63+
64+
**-s** _address_
65+
> Send replies to specified address instead of broadcast.
66+
6167
**-q**
62-
> Quiet startup.
68+
> Quiet startup (suppress copyright message).
69+
70+
**-user** _user_
71+
> Setuid to user after privileged operations.
72+
73+
**-group** _group_
74+
> Setgid to group after privileged operations.
75+
76+
**-chroot** _dir_
77+
> Chroot to directory.
78+
79+
**-tf** _tracefile_
80+
> Log startup state and transactions for debugging.
6381
6482
**--no-pid**
6583
> Don't write PID file.
6684
85+
**--version**
86+
> Display version and exit.
87+
6788
# CONFIGURATION
6889

6990
**/etc/dhcp/dhcpd.conf**:
@@ -100,4 +121,4 @@ ISC DHCP was originally developed by **Ted Lemon** at the Internet Systems Conso
100121

101122
# SEE ALSO
102123

103-
[dhcpd.conf](/man/dhcpd.conf)(5), [dhcpd.leases](/man/dhcpd.leases)(5), [dhclient](/man/dhclient)(8), [kea-dhcp4](/man/kea-dhcp4)(8)
124+
[dhclient](/man/dhclient)(8)

0 commit comments

Comments
 (0)