Skip to content

Commit 48810b8

Browse files
committed
Add commands
1 parent acddf62 commit 48810b8

188 files changed

Lines changed: 15124 additions & 47 deletions

File tree

Some content is hidden

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

assets/commands/charmap.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# TLDR
2+
3+
**Open character map**
4+
5+
```charmap```
6+
7+
**Search for character** by name
8+
9+
```charmap --search "[heart]"```
10+
11+
**Copy character to clipboard**
12+
13+
```charmap --copy "[character]"```
14+
15+
# SYNOPSIS
16+
17+
**charmap** [_options_]
18+
19+
# DESCRIPTION
20+
21+
**charmap** is a Unicode character map application, typically part of GNOME desktop. It allows browsing and searching through all Unicode characters, viewing character details, and copying characters to the clipboard.
22+
23+
The application displays characters organized by Unicode block, with options to filter by script, language, or search term. Each character shows its code point, official name, and related information.
24+
25+
# PARAMETERS
26+
27+
**--search** _text_
28+
> Search for characters by name.
29+
30+
**--copy** _char_
31+
> Copy character to clipboard.
32+
33+
**--help**
34+
> Display help information.
35+
36+
**--version**
37+
> Display version information.
38+
39+
# CAVEATS
40+
41+
Requires a graphical environment. Character availability depends on installed fonts. Some characters may display as boxes if fonts don't include them.
42+
43+
# HISTORY
44+
45+
**charmap** is part of the **GNOME** desktop environment. Character map utilities have existed since early GUI systems, helping users access characters not on their keyboard. The GNOME version, known as **gucharmap**, was created in the early 2000s.
46+
47+
# SEE ALSO
48+
49+
[gucharmap](/man/gucharmap)(1), [xfd](/man/xfd)(1), [unicode](/man/unicode)(1)

assets/commands/chef.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# TLDR
2+
3+
**Generate a new cookbook**
4+
5+
```chef generate cookbook [cookbook_name]```
6+
7+
**Generate a new recipe**
8+
9+
```chef generate recipe [cookbook_name] [recipe_name]```
10+
11+
**Verify cookbook syntax**
12+
13+
```chef exec cookstyle [cookbook_path]```
14+
15+
**Run cookbook locally**
16+
17+
```chef-client --local-mode --runlist "[recipe[cookbook::recipe]]"```
18+
19+
**Show installed version**
20+
21+
```chef --version```
22+
23+
**Install gem into Chef**
24+
25+
```chef gem install [gem_name]```
26+
27+
**Run InSpec tests**
28+
29+
```chef exec inspec exec [test_path]```
30+
31+
# SYNOPSIS
32+
33+
**chef** _command_ [_options_]
34+
35+
# DESCRIPTION
36+
37+
**chef** is the command-line interface for Chef Workstation, a configuration management and infrastructure automation platform. It provides tools for developing, testing, and managing cookbooks that define system configurations.
38+
39+
Cookbooks contain recipes written in Ruby DSL that describe desired system states. Chef applies these recipes to nodes, ensuring consistent configuration across infrastructure. The workflow includes local development, testing with Test Kitchen, and deployment to Chef Server.
40+
41+
# PARAMETERS
42+
43+
**generate** _type_ _name_
44+
> Generate cookbook, recipe, template, or other component.
45+
46+
**exec** _command_
47+
> Run command in Chef context with bundled Ruby.
48+
49+
**gem** _subcommand_
50+
> Manage Ruby gems in Chef's environment.
51+
52+
**install** _policyfile_
53+
> Install cookbooks from Policyfile.
54+
55+
**update** _policyfile_
56+
> Update cookbooks in Policyfile.
57+
58+
**export** _policyfile_ _path_
59+
> Export policy archive for deployment.
60+
61+
**push** _policy_group_ _policyfile_
62+
> Push policy to Chef Server.
63+
64+
**--version**
65+
> Show version information.
66+
67+
**--help**
68+
> Display help information.
69+
70+
# CAVEATS
71+
72+
Requires Ruby knowledge for recipe development. Chef Server setup needed for centralized management. Local mode testing requires sufficient resources. Cookbooks may have complex dependencies.
73+
74+
# HISTORY
75+
76+
**Chef** was created by **Adam Jacob** at **Opscode** (later Chef Software) in **2009**. It pioneered the "infrastructure as code" concept alongside Puppet. Chef was written in Ruby and Erlang, and gained popularity for its flexibility. In **2020**, Chef was acquired by **Progress Software**. The tooling has evolved from knife-centric workflows to modern Chef Workstation.
77+
78+
# SEE ALSO
79+
80+
[knife](/man/knife)(1), [kitchen](/man/kitchen)(1), [inspec](/man/inspec)(1), [ansible](/man/ansible)(1), [puppet](/man/puppet)(1)

assets/commands/clippy.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# TLDR
2+
3+
**Run clippy on project**
4+
5+
```cargo clippy```
6+
7+
**Run clippy and fix** issues automatically
8+
9+
```cargo clippy --fix```
10+
11+
**Run clippy on all targets**
12+
13+
```cargo clippy --all-targets```
14+
15+
**Deny all warnings** (treat as errors)
16+
17+
```cargo clippy -- -D warnings```
18+
19+
**Allow specific lint**
20+
21+
```cargo clippy -- -A clippy::[lint_name]```
22+
23+
**Show all available lints**
24+
25+
```cargo clippy --list```
26+
27+
**Run clippy in release mode**
28+
29+
```cargo clippy --release```
30+
31+
# SYNOPSIS
32+
33+
**cargo clippy** [_options_] [-- _clippy_options_]
34+
35+
# DESCRIPTION
36+
37+
**clippy** is a collection of lints to catch common mistakes and improve Rust code. It provides hundreds of lints covering correctness, style, performance, complexity, and more.
38+
39+
Clippy integrates with Cargo and analyzes code during compilation, providing actionable warnings. Lints range from simple style suggestions to detecting subtle bugs and performance issues. Many lints include automatic fixes that can be applied with `--fix`.
40+
41+
# PARAMETERS
42+
43+
**--fix**
44+
> Automatically apply lint suggestions.
45+
46+
**--all-targets**
47+
> Check all targets including tests and examples.
48+
49+
**--all-features**
50+
> Check with all features enabled.
51+
52+
**--release**
53+
> Check in release mode.
54+
55+
**--list**
56+
> List all available lints.
57+
58+
**-- -D** _lint_
59+
> Deny specific lint (treat as error).
60+
61+
**-- -W** _lint_
62+
> Warn on specific lint.
63+
64+
**-- -A** _lint_
65+
> Allow (ignore) specific lint.
66+
67+
**-- -F** _lint_
68+
> Forbid lint (cannot be overridden).
69+
70+
# LINT CATEGORIES
71+
72+
**clippy::correctness**: Likely bugs
73+
**clippy::suspicious**: Questionable code
74+
**clippy::style**: Style improvements
75+
**clippy::complexity**: Overly complex code
76+
**clippy::perf**: Performance improvements
77+
**clippy::pedantic**: Stricter lints
78+
**clippy::nursery**: Experimental lints
79+
80+
# CAVEATS
81+
82+
Some lints may have false positives. Pedantic lints can be noisy. Automatic fixes should be reviewed. May conflict with rustfmt on some suggestions.
83+
84+
# HISTORY
85+
86+
**clippy** was created by **Manish Goregaokar** and others starting in **2014** as a third-party tool. The name references Microsoft's Office assistant. It became an official Rust component in **2018**, distributed via rustup. Clippy has grown to include over 600 lints and is widely used in the Rust ecosystem.
87+
88+
# SEE ALSO
89+
90+
[cargo](/man/cargo)(1), [rustc](/man/rustc)(1), [rustfmt](/man/rustfmt)(1), [rustup](/man/rustup)(1)

assets/commands/cmus-remote.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# TLDR
2+
3+
**Toggle play/pause**
4+
5+
```cmus-remote -u```
6+
7+
**Play**
8+
9+
```cmus-remote -p```
10+
11+
**Pause**
12+
13+
```cmus-remote -U```
14+
15+
**Stop playback**
16+
17+
```cmus-remote -s```
18+
19+
**Next track**
20+
21+
```cmus-remote -n```
22+
23+
**Previous track**
24+
25+
```cmus-remote -r```
26+
27+
**Seek forward** 10 seconds
28+
29+
```cmus-remote -k +10```
30+
31+
**Set volume**
32+
33+
```cmus-remote -v [50]%```
34+
35+
**Add file to queue**
36+
37+
```cmus-remote -q [file.mp3]```
38+
39+
# SYNOPSIS
40+
41+
**cmus-remote** [_options_] [_file_|_dir_|_playlist_]
42+
43+
# DESCRIPTION
44+
45+
**cmus-remote** is a remote control interface for cmus, the ncurses-based music player. It sends commands to a running cmus instance via socket connection.
46+
47+
The tool allows controlling playback, managing playlists, and querying player status from scripts or other applications. It's commonly used for media key bindings and status bar integrations.
48+
49+
# PARAMETERS
50+
51+
**-p**, **--play**
52+
> Start playback.
53+
54+
**-u**, **--pause**
55+
> Toggle pause.
56+
57+
**-U**, **--pause-playback**
58+
> Pause without toggle.
59+
60+
**-s**, **--stop**
61+
> Stop playback.
62+
63+
**-n**, **--next**
64+
> Play next track.
65+
66+
**-r**, **--prev**
67+
> Play previous track.
68+
69+
**-k** _seconds_
70+
> Seek relative (+/-seconds).
71+
72+
**-v** _volume_
73+
> Set volume (absolute or +/-).
74+
75+
**-q** _file_
76+
> Add file to queue.
77+
78+
**-c** _file_
79+
> Add file to library.
80+
81+
**-l** _file_
82+
> Load playlist.
83+
84+
**-S** _name_
85+
> Toggle setting.
86+
87+
**-Q**
88+
> Query and print status.
89+
90+
**-C** _command_
91+
> Send raw cmus command.
92+
93+
# CAVEATS
94+
95+
Requires running cmus instance. Socket permissions must allow connection. Some commands may not work if cmus is not playing.
96+
97+
# HISTORY
98+
99+
**cmus-remote** is part of the **cmus** project, created by **Timo Hirvonen** in **2005**. It provides scriptable control for the terminal-based music player, enabling integration with window managers, status bars, and multimedia keyboards.
100+
101+
# SEE ALSO
102+
103+
[cmus](/man/cmus)(1), [mpd](/man/mpd)(1), [mpc](/man/mpc)(1), [playerctl](/man/playerctl)(1)

assets/commands/colcrt.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# TLDR
2+
3+
**Filter nroff output** for terminal display
4+
5+
```colcrt [file]```
6+
7+
**Suppress underlining**
8+
9+
```colcrt -2 [file]```
10+
11+
**Half-line handling**
12+
13+
```colcrt - [file]```
14+
15+
**Process nroff output** via pipe
16+
17+
```nroff -man [man.1] | colcrt```
18+
19+
# SYNOPSIS
20+
21+
**colcrt** [_options_] [_file_...]
22+
23+
# DESCRIPTION
24+
25+
**colcrt** filters nroff output for CRT (terminal) preview. It handles reverse line feeds and translates underlines and half-line motions into forms suitable for terminal display.
26+
27+
The tool is primarily useful for previewing formatted man pages and other nroff output on terminals that cannot handle overstriking. It converts underlining to dashes on a separate line.
28+
29+
# PARAMETERS
30+
31+
**-**
32+
> Print half-lines as full lines, useful for terminals without half-line capability.
33+
34+
**-2**
35+
> Suppress underlining entirely, printing only the text.
36+
37+
# CAVEATS
38+
39+
Designed for older terminal handling. Modern terminals typically handle nroff output directly. Output may not preserve all formatting. Primarily historical utility.
40+
41+
# HISTORY
42+
43+
**colcrt** is a traditional Unix utility dating back to **BSD** systems in the **1970s**. It was created when terminals had varied capabilities and could not all handle the escape sequences in nroff output. Though rarely needed today, it remains in many Unix distributions.
44+
45+
# SEE ALSO
46+
47+
[nroff](/man/nroff)(1), [col](/man/col)(1), [ul](/man/ul)(1), [man](/man/man)(1)

0 commit comments

Comments
 (0)