Skip to content

Commit 14d46c8

Browse files
committed
Improve command quality
1 parent c9bc1e9 commit 14d46c8

101 files changed

Lines changed: 2763 additions & 970 deletions

Some content is hidden

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

assets/basics/index.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
.DS_Store
21
aitools.md
32
compressionarchiving.md
43
cryptocurrencies.md
54
emacstexteditor.md
65
filesfolders.md
76
git.md
87
hackingtools.md
9-
index.txt
108
input.md
119
json.md
1210
microtexteditor.md
@@ -27,4 +25,4 @@ textprocessing.md
2725
tmux.md
2826
usersgroups.md
2927
videoaudio.md
30-
vimtexteditor.md
28+
vimtexteditor.md

assets/commands/NetworkManager.conf.md

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,61 @@ main configuration file for NetworkManager
3030
> Main configuration section.
3131
3232
**plugins**
33-
> Connection plugins to use.
33+
> System settings plugin names (keyfile is always appended).
3434
3535
**dns**
36-
> DNS processing mode.
36+
> DNS processing mode (default, dnsmasq, systemd-resolved, none).
37+
38+
**dhcp**
39+
> DHCP client to use (internal, dhcpcd).
40+
41+
**hostname-mode**
42+
> How the transient hostname is managed (default, dhcp, none).
43+
44+
**no-auto-default**
45+
> Devices for which no automatic default connection is created.
46+
47+
**[keyfile]**
48+
> Keyfile plugin-specific settings.
49+
50+
**[ifupdown]**
51+
> Settings for the ifupdown plugin (Debian/Ubuntu).
52+
53+
**managed**
54+
> Whether devices listed in /etc/network/interfaces are managed by NetworkManager (true/false).
3755
3856
**[connection]**
39-
> Default connection settings.
57+
> Default values for connection properties.
4058
4159
**[device]**
42-
> Device-specific settings.
60+
> Per-device persistent configuration.
4361
4462
**[logging]**
45-
> Logging configuration.
63+
> Controls logging output.
64+
65+
**level**
66+
> Log verbosity level (OFF, ERR, WARN, INFO, DEBUG, TRACE).
67+
68+
**domains**
69+
> Filter log messages by topic (PLATFORM, WIFI, DHCP4, DNS, VPN, etc.).
70+
71+
**[connectivity]**
72+
> Optional internet connectivity checking.
73+
74+
**uri**
75+
> URL to check for connectivity.
76+
77+
**interval**
78+
> Check frequency in seconds (default: 300).
79+
80+
**[global-dns]**
81+
> System-wide DNS configuration that overrides per-connection settings.
4682
4783
# DESCRIPTION
4884

49-
**NetworkManager.conf** is the main configuration file for NetworkManager. It controls DNS handling, plugins, device management, and various global settings.
85+
**NetworkManager.conf** is the main configuration file for NetworkManager. It controls DNS handling, plugins, device management, and various global settings. The file uses an ini-style key file format with sections of key-value pairs.
5086

51-
Additional configuration can be placed in /etc/NetworkManager/conf.d/.
87+
Additional configuration can be placed in /etc/NetworkManager/conf.d/ as drop-in files.
5288

5389
# EXAMPLE CONFIG
5490

@@ -73,16 +109,16 @@ level=WARN
73109
# DNS MODES
74110

75111
```
76-
default - Use resolv.conf
77-
dnsmasq - Local dnsmasq
78-
systemd-resolved - Use resolved
79-
none - No DNS management
112+
default - Update resolv.conf directly
113+
dnsmasq - Run local dnsmasq instance
114+
systemd-resolved - Use systemd-resolved
115+
none - No DNS management
80116
```
81117

82118
# CAVEATS
83119

84-
Syntax errors may prevent NM from starting. Use conf.d/ for drop-in files. Restart NM after changes.
120+
Syntax errors may prevent NetworkManager from starting. Use conf.d/ for drop-in files. Restart NetworkManager after changes with `systemctl restart NetworkManager`.
85121

86122
# SEE ALSO
87123

88-
[NetworkManager](/man/NetworkManager)(8), [nmcli](/man/nmcli)(1), [nm-settings](/man/nm-settings)(5)
124+
[NetworkManager](/man/NetworkManager)(8), [nmcli](/man/nmcli)(1), [nmtui](/man/nmtui)(1), [nm-settings](/man/nm-settings)(5)

assets/commands/aa-mergeprof.md

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

3-
Merge AppArmor profile files into the profile directory
3+
Merge AppArmor security profiles
44

55
# TLDR
66

77
**Merge** one or more profile files into the default profile directory
88

99
```sudo aa-mergeprof [file1] [file2]```
1010

11-
Merge profile files into a **specific directory**
11+
**Merge** profile files into a **specific directory**
1212

1313
```sudo aa-mergeprof -d /path/to/profiles [file1] [file2]```
1414

1515
# SYNOPSIS
1616

17-
**aa-mergeprof** _file_ [_file_ ...] [_-d /path/to/profiles_]
17+
**aa-mergeprof** _file_ [_file_ ...] [**-d** _/path/to/profiles_]
1818

1919
# DESCRIPTION
2020

21-
**aa-mergeprof** merges one or more AppArmor security profile files into the system profile directory. It is an interactive tool that presents differences between existing and incoming profiles, allowing administrators to resolve conflicts manually. This is useful for importing profiles from other systems, combining profiles from different sources, or consolidating profiles after a system migration.
21+
**aa-mergeprof** is an interactive tool that merges one or more AppArmor security profile files into the system profile directory. When conflicts exist between incoming and existing profiles, it presents the differences and allows the administrator to choose how to resolve them. This is useful for importing profiles from other systems, combining profiles from different sources, or consolidating profiles after a system migration.
2222

2323
# PARAMETERS
2424

25-
**-d, --dir /path/to/profiles**
26-
> Specifies the destination directory for merged profiles; defaults to /etc/apparmor.d
25+
**-d**, **--dir** _/path/to/profiles_
26+
> Specifies the target directory for merged profiles. Defaults to **/etc/apparmor.d**.
2727
28-
**-h, --help**
29-
> Display help information
28+
**-h**, **--help**
29+
> Display help information and exit.
3030
3131
# CAVEATS
3232

33-
Merging profiles may overwrite existing profiles in the destination directory. Review changes before committing merged profiles.
33+
Merging profiles may overwrite existing profiles in the destination directory. The tool is interactive and requires manual conflict resolution -- it cannot be run unattended. Requires root privileges.
3434

3535
# HISTORY
3636

3737
Part of the **AppArmor** utilities package for managing application security profiles on Linux systems.
3838

3939
# SEE ALSO
4040

41-
[aa-genprof](/man/aa-genprof)(8), [aa-logprof](/man/aa-logprof)(8), [aa-cleanprof](/man/aa-cleanprof)(8), [apparmor](/man/apparmor)(7)
41+
[aa-genprof](/man/aa-genprof)(8), [aa-logprof](/man/aa-logprof)(8), [aa-cleanprof](/man/aa-cleanprof)(8), [aa-enforce](/man/aa-enforce)(8), [aa-complain](/man/aa-complain)(8), [apparmor](/man/apparmor)(7)

assets/commands/afconvert.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,74 @@ Set **bit rate** for AAC encoding
2020

2121
```afconvert -f m4af -d aac -b [128000] [input.wav] [output.m4a]```
2222

23+
Convert with VBR **strategy**
24+
25+
```afconvert -f m4af -d aac -s 3 -b [128000] [input.wav] [output.m4a]```
26+
27+
List supported **formats**
28+
29+
```afconvert -hf```
30+
2331
# SYNOPSIS
2432

25-
**afconvert** [_-f file-format_] [_-d data-format_] [_-b bit-rate_] _input_ _output_
33+
**afconvert** [_options_] _input_ [_output_]
2634

2735
# DESCRIPTION
2836

29-
**afconvert** is a macOS command-line tool for converting between audio file formats. It supports all audio formats handled by Core Audio, including WAV, AIFF, MP3, AAC, ALAC, CAF, and more.
37+
**afconvert** is a macOS command-line tool for converting between audio file formats. It supports all audio formats handled by Core Audio, including WAV, AIFF, MP3, AAC, ALAC, CAF, and more. If no output file is specified, the name is generated automatically and saved in the same directory as the input.
3038

3139
The tool provides access to Apple's audio codecs and can perform sample rate conversion, bit depth conversion, and channel remapping along with format conversion.
3240

3341
# PARAMETERS
3442

35-
**-f** _format_
36-
> Output file format: m4af, WAVE, AIFF, caff, etc.
43+
**-f**, **--file** _format_
44+
> Output file format (m4af, WAVE, AIFF, caff, etc.).
45+
46+
**-d**, **--data** _format_
47+
> Audio data format (aac, alac, BEI16, LEF32, etc.). Can include sample rate and format flags.
48+
49+
**-b**, **--bitrate** _rate_
50+
> Total bit rate in bits per second for compressed formats.
51+
52+
**-c**, **--channels** _number_
53+
> Number of output channels.
54+
55+
**-l**, **--channellayout** _tag_
56+
> Channel layout tag.
57+
58+
**-q**, **--quality** _quality_
59+
> Codec quality (0-127, higher is better).
60+
61+
**-r**, **--src-quality** _quality_
62+
> Sample rate converter quality (0-127, default: 127).
63+
64+
**--src-complexity** _complexity_
65+
> Sample rate converter complexity (line, norm, bats).
3766
38-
**-d** _format_
39-
> Audio data format: aac, alac, BEI16, LEF32, etc.
67+
**-s**, **--strategy** _strategy_
68+
> Bitrate allocation strategy (0=CBR, 1=ABR, 2=VBR_constrained, 3=VBR).
4069
41-
**-b** _rate_
42-
> Bit rate in bits per second for compressed formats
70+
**-o** _filename_
71+
> Specify output file path.
4372
44-
**-s** _rate_
45-
> Sample rate for output file
73+
**--dither** _algorithm_
74+
> Dither algorithm (1 or 2).
4675
47-
**-c** _channels_
48-
> Number of output channels
76+
**--mix**
77+
> Enable channel downmixing.
4978
50-
**-q** _quality_
51-
> Encoder quality (0-127, higher is better)
79+
**-v**, **--verbose**
80+
> Display progress information.
5281
53-
**-v**
54-
> Verbose output
82+
**-h**, **--help**
83+
> Display help information.
5584
56-
**-h**
57-
> Display available formats and help
85+
**-hf**, **--help-formats**
86+
> List all supported file and data formats.
5887
5988
# CAVEATS
6089

61-
This tool is macOS-only. Some format conversions may be lossy. AAC encoding quality varies with bit rate settings. Not all format combinations are valid.
90+
This tool is macOS-only. Some format conversions may be lossy. AAC encoding quality varies with bit rate settings. Not all format combinations are valid. Use **-hf** to see which formats are supported on your system.
6291

6392
# HISTORY
6493

assets/commands/apptainer-config.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ The command operates through two subcommands: **fakeroot** for managing user nam
7575
**--dry-run**
7676
> Display the resulting configuration without writing to file (global subcommand)
7777
78+
**-h**, **--help**
79+
> Display help for the config command
80+
7881
# CONFIGURATION
7982

8083
The global subcommand modifies **/etc/apptainer/apptainer.conf** (or the equivalent path for unprivileged installations). Common directives include:
@@ -101,4 +104,4 @@ Apptainer originated as **Singularity**, created by **Gregory Kurtzer** at **Law
101104

102105
# SEE ALSO
103106

104-
[apptainer](/man/apptainer)(1), [docker](/man/docker)(1), [podman](/man/podman)(1)
107+
[apptainer](/man/apptainer)(1), [singularity](/man/singularity)(1), [docker](/man/docker)(1), [podman](/man/podman)(1)

assets/commands/apt-key.md

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

3-
Manage trusted keys for package authentication.
3+
Deprecated APT key management utility for package authentication
44

55
# TLDR
66

@@ -24,15 +24,27 @@ Add a key from **keyserver** with only key ID
2424

2525
```apt-key adv --keyserver pgp.mit.edu --recv [KEYID]```
2626

27+
**Export** all trusted keys
28+
29+
```apt-key exportall```
30+
31+
**Modern replacement**: download a key directly into trusted.gpg.d (no apt-key needed)
32+
33+
```curl -fsSL [https://example.com/key.gpg] | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/[example].gpg```
34+
35+
**Modern replacement**: use signed-by in sources.list
36+
37+
```echo "deb [signed-by=/usr/share/keyrings/[example].gpg] [https://repo.example.com] [stable] main" | sudo tee /etc/apt/sources.list.d/[example].list```
38+
2739
# SYNOPSIS
2840

2941
**apt-key** [_command_] [_arguments_]
3042

3143
# DESCRIPTION
3244

33-
**apt-key** is a key management utility for the APT Package Manager on Debian and Ubuntu. It manages the list of keys used by apt to authenticate packages.
45+
**apt-key** is a deprecated key management utility for the APT Package Manager on Debian and Ubuntu. It manages the list of keys used by apt to authenticate packages.
3446

35-
**Note:** apt-key is now deprecated. Keys should be stored in /etc/apt/trusted.gpg.d/ or /usr/share/keyrings/ and referenced via signed-by in sources.list.
47+
**Note:** apt-key is deprecated since Debian 11 (Bullseye) and Ubuntu 22.04 (Jammy). The recommended approach is to place keyring files directly in /etc/apt/trusted.gpg.d/ (with .gpg or .asc extension) or in /usr/share/keyrings/ and reference them via the `signed-by` option in sources.list entries. Only `apt-key del` remains supported for use in maintainer scripts.
3648

3749
# PARAMETERS
3850

@@ -61,7 +73,10 @@ Add a key from **keyserver** with only key ID
6173
> Output all trusted keys to standard output
6274
6375
**finger**
64-
> List fingerprints of trusted keys
76+
> List fingerprints of trusted keys (deprecated)
77+
78+
**--keyring** _filename_
79+
> Operate on a specific keyring file (deprecated)
6580
6681
# CONFIGURATION
6782

@@ -81,4 +96,4 @@ Part of the **APT** (Advanced Package Tool) suite. Deprecated starting with Debi
8196

8297
# SEE ALSO
8398

84-
[apt](/man/apt)(8), [apt-get](/man/apt-get)(8), [gpg](/man/gpg)(1)
99+
[apt](/man/apt)(8), [apt-get](/man/apt-get)(8), [gpg](/man/gpg)(1), [apt-secure](/man/apt-secure)(8)

0 commit comments

Comments
 (0)