From a3692d638b28a159bb58fffb7b85b1d0ba27de7c Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Fri, 28 Mar 2025 00:18:38 +0000 Subject: [PATCH] Update cheatsheets --- tldr/% | 4 ++-- tldr/ddgr | 4 ++-- tldr/dirs | 4 ++-- tldr/go-vet | 4 ++-- tldr/googler | 4 ++-- tldr/julia | 4 ++-- tldr/linux/agetty | 4 ++-- tldr/linux/apx-subsystems | 14 +++++++------- tldr/linux/arithmetic | 2 +- tldr/linux/arpspoof | 2 +- tldr/linux/asterisk | 2 +- tldr/linux/atool | 2 +- tldr/linux/autorecon | 12 ++++++------ tldr/linux/bwa | 2 +- tldr/linux/cat | 2 +- tldr/linux/cdrdao | 2 +- tldr/linux/cpupower | 12 ++++++------ tldr/linux/cryptcat | 2 +- tldr/linux/dbclient | 2 +- tldr/linux/dnf-group | 2 +- tldr/linux/dpigs | 18 +++++++++--------- tldr/linux/dropbearkey | 2 +- tldr/linux/duperemove | 2 +- tldr/linux/esearch | 4 ++-- tldr/linux/getfacl | 8 ++++---- tldr/linux/init | 2 +- tldr/linux/iptables-save | 8 ++++---- tldr/linux/journalctl | 4 ++-- tldr/linux/lldpctl | 2 +- tldr/linux/logread | 4 ++-- tldr/linux/lsipc | 8 ++++---- tldr/linux/macchanger | 12 ++++++------ tldr/linux/namcap | 6 +++--- tldr/linux/needrestart | 2 +- tldr/linux/netselect | 4 ++-- tldr/linux/nitch | 8 ++++---- tldr/linux/nl | 2 +- tldr/linux/pdftoppm | 4 ++-- tldr/linux/pkgctl-diff | 14 +++++++------- tldr/linux/pyrit | 2 +- tldr/linux/qrcp | 8 ++++---- tldr/linux/rig | 4 ++-- tldr/linux/ruget | 4 ++-- tldr/linux/setfacl | 12 ++++++------ tldr/linux/setsebool | 4 ++-- tldr/linux/shutdown | 2 +- tldr/linux/swaybg | 12 ++++++------ tldr/linux/tcpick | 6 +++--- tldr/linux/tlp-stat | 4 ++-- tldr/linux/torsocks | 10 +++++----- tldr/linux/tunelp | 20 ++++++++++---------- tldr/linux/urpmf | 2 +- tldr/linux/yakuake | 2 +- tldr/logout | 2 +- tldr/lp | 4 ++-- tldr/macptopbm | 4 ++-- tldr/marimo | 34 ++++++++++++++++++++++++++++++++++ tldr/mpg321 | 4 ++-- tldr/ntpctl | 8 ++++---- tldr/pamenlarge | 4 ++-- tldr/pamoil | 4 ++-- tldr/pamstretch | 4 ++-- tldr/pamstretch-gen | 2 +- tldr/pbmpscale | 2 +- tldr/pbmreduce | 6 +++--- tldr/qcp | 2 +- tldr/qmv | 2 +- tldr/rawtopgm | 6 +++--- tldr/readarray | 4 ++-- tldr/return | 2 +- tldr/shift | 4 ++-- tldr/tofu | 33 +++++++++++++++++++++++++++++++++ tldr/tofu-fmt | 25 +++++++++++++++++++++++++ tldr/tofu-output | 25 +++++++++++++++++++++++++ tldr/tofu-plan | 37 +++++++++++++++++++++++++++++++++++++ tldr/wait | 2 +- tldr/windows/choice | 2 +- 77 files changed, 334 insertions(+), 180 deletions(-) create mode 100644 tldr/marimo create mode 100644 tldr/tofu create mode 100644 tldr/tofu-fmt create mode 100644 tldr/tofu-output create mode 100644 tldr/tofu-plan diff --git a/tldr/% b/tldr/% index 92f718c6..c3c60361 100644 --- a/tldr/% +++ b/tldr/% @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `%-` -- Bring a job numbered `N` to front: +- Bring the job number `n` to front: -`%{{N}}` +`%{{n}}` - Bring a job whose command starts with `string` to front: diff --git a/tldr/ddgr b/tldr/ddgr index 57dd59db..2634c183 100644 --- a/tldr/ddgr +++ b/tldr/ddgr @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `ddgr {{keyword}}` -- Limit the number of search results to `N`: +- Limit the number of search results to `n`: -`ddgr -n {{N}} {{keyword}}` +`ddgr -n {{n}} {{keyword}}` - Display the complete URL in search results: diff --git a/tldr/dirs b/tldr/dirs index 2b5adbee..e16096af 100644 --- a/tldr/dirs +++ b/tldr/dirs @@ -17,9 +17,9 @@ source: https://github.com/tldr-pages/tldr.git `dirs -p` -- Display only the nth entry in the directory stack, starting at 0: +- Display only the `n`th entry in the directory stack, starting at 0: -`dirs +{{N}}` +`dirs +{{n}}` - Clear the directory stack: diff --git a/tldr/go-vet b/tldr/go-vet index ef9195dc..519c8e78 100644 --- a/tldr/go-vet +++ b/tldr/go-vet @@ -25,9 +25,9 @@ source: https://github.com/tldr-pages/tldr.git `go tool vet help {{check_name}}` -- Display offending lines plus N lines of surrounding context: +- Display offending lines plus `n` lines of surrounding context: -`go vet -c={{N}}` +`go vet -c={{n}}` - Output analysis and errors in JSON format: diff --git a/tldr/googler b/tldr/googler index abd56893..9af32c73 100644 --- a/tldr/googler +++ b/tldr/googler @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `googler -j {{keyword}}` -- Show N search results (default 10): +- Show `n` search results (default: 10): -`googler -n {{N}} {{keyword}}` +`googler -n {{n}} {{keyword}}` - Disable automatic spelling correction: diff --git a/tldr/julia b/tldr/julia index 53054e38..72698663 100644 --- a/tldr/julia +++ b/tldr/julia @@ -32,6 +32,6 @@ source: https://github.com/tldr-pages/tldr.git `julia -E '{{(1 - cos(pi/4))/2}}'` -- Start Julia in multithreaded mode, using N threads: +- Start Julia in multithreaded mode, using `n` threads: -`julia -t {{N}}` +`julia -t {{n}}` diff --git a/tldr/linux/agetty b/tldr/linux/agetty index 70e43949..de0dbd71 100644 --- a/tldr/linux/agetty +++ b/tldr/linux/agetty @@ -18,9 +18,9 @@ source: https://github.com/tldr-pages/tldr.git `agetty {{[-t|--timeout]}} {{timeout_in_seconds}} -` -- Assume the `tty` is [8]-bit, overriding the `TERM` environment variable set by `init`: +- Assume the `tty` is 8-bit, overriding the `TERM` environment variable set by `init`: -`agetty -8 - {{term_var}}` +`agetty {{[-8|--8bits]}} - {{term_var}}` - Skip the login (no login) and invoke, as root, another login program instead of `/bin/login`: diff --git a/tldr/linux/apx-subsystems b/tldr/linux/apx-subsystems index 5d706c05..9b6bf36c 100644 --- a/tldr/linux/apx-subsystems +++ b/tldr/linux/apx-subsystems @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage subsystems in `apx`. > Subsystems are containers that can be created based on pre-existing stacks. -> More information: . +> More information: . - Interactively create a new subsystem: @@ -19,16 +19,16 @@ source: https://github.com/tldr-pages/tldr.git - Reset a specific subsystem to its initial state: -`apx subsystems reset --name {{string}}` +`apx subsystems reset {{[-n|--name]}} {{string}}` -- [f]orce reset a specific subsystem: +- Force reset a specific subsystem: -`apx subsystems reset --name {{string}} --force` +`apx subsystems reset {{[-n|--name]}} {{string}} {{[-f|--force]}}` - Remove a specific subsystem: -`apx subsystems rm --name {{string}}` +`apx subsystems rm {{[-n|--name]}} {{string}}` -- [f]orce remove a specific subsystem: +- Force remove a specific subsystem: -`apx subsystems rm --name {{string}} --force` +`apx subsystems rm {{[-n|--name]}} {{string}} {{[-f|--force]}}` diff --git a/tldr/linux/arithmetic b/tldr/linux/arithmetic index 8c940c06..5a0b9a28 100644 --- a/tldr/linux/arithmetic +++ b/tldr/linux/arithmetic @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # arithmetic > Quiz on simple arithmetic problems. -> More information: . +> More information: . - Start an arithmetic quiz: diff --git a/tldr/linux/arpspoof b/tldr/linux/arpspoof index 511a1192..e2c8dd1b 100644 --- a/tldr/linux/arpspoof +++ b/tldr/linux/arpspoof @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # arpspoof > Forge ARP replies to intercept packets. -> More information: . +> More information: . - Poison all hosts to intercept packets on [i]nterface for the host: diff --git a/tldr/linux/asterisk b/tldr/linux/asterisk index e7f20648..fce3ed25 100644 --- a/tldr/linux/asterisk +++ b/tldr/linux/asterisk @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # asterisk > Run and manage telephone and exchange (phone) server instances. -> More information: . +> More information: . - [r]econnect to a running server, and turn on logging 3 levels of [v]erbosity: diff --git a/tldr/linux/atool b/tldr/linux/atool index bba8ddb6..d777484a 100644 --- a/tldr/linux/atool +++ b/tldr/linux/atool @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # atool > Manage archives of various formats. -> More information: . +> More information: . - List files in a Zip archive: diff --git a/tldr/linux/autorecon b/tldr/linux/autorecon index 6c568670..77f52bb1 100644 --- a/tldr/linux/autorecon +++ b/tldr/linux/autorecon @@ -12,14 +12,14 @@ source: https://github.com/tldr-pages/tldr.git `sudo autorecon {{host_or_ip1,host_or_ip2,...}}` -- Perform reconnaissance on [t]arget(s) from a file: +- Perform reconnaissance on target(s) from a file: -`sudo autorecon --target-file {{path/to/file}}` +`sudo autorecon {{[-t|--target-file]}} {{path/to/file}}` -- [o]utput results to a different directory: +- Output results to a different directory: -`sudo autorecon --output {{path/to/results}} {{host_or_ip1,host_or_ip2,...}}` +`sudo autorecon {{[-o|--output]}} {{path/to/results}} {{host_or_ip1,host_or_ip2,...}}` -- Limit scanning to specific [p]orts and protocols (`T` for TCP, `U` for UDP, `B` for both): +- Limit scanning to specific ports and protocols (`T` for TCP, `U` for UDP, `B` for both): -`sudo autorecon --ports {{T:21-25,80,443,U:53,B:123}} {{host_or_ip1,host_or_ip2,...}}` +`sudo autorecon {{[-p|--ports]}} {{T:21-25,80,443,U:53,B:123}} {{host_or_ip1,host_or_ip2,...}}` diff --git a/tldr/linux/bwa b/tldr/linux/bwa index 5ff37f74..478e733a 100644 --- a/tldr/linux/bwa +++ b/tldr/linux/bwa @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Burrows-Wheeler Alignment tool. > Short, low-divergent DNA sequences mapper against a large reference genome, such as the human genome. -> More information: . +> More information: . - Index the reference genome: diff --git a/tldr/linux/cat b/tldr/linux/cat index 74f88a71..db8b961a 100644 --- a/tldr/linux/cat +++ b/tldr/linux/cat @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `cat - > {{path/to/file}}` -- [n]umber all output lines: +- Number all output lines: `cat {{[-n|--number]}} {{path/to/file}}` diff --git a/tldr/linux/cdrdao b/tldr/linux/cdrdao index 7159a031..1cc11031 100644 --- a/tldr/linux/cdrdao +++ b/tldr/linux/cdrdao @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cdrdao > Read and write CDs in disc-at-once mode. -> More information: . +> More information: . - Read a CD and write its contents to a file: diff --git a/tldr/linux/cpupower b/tldr/linux/cpupower index 342942d9..1474c535 100644 --- a/tldr/linux/cpupower +++ b/tldr/linux/cpupower @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - List CPUs: -`sudo cpupower --cpu {{all}} info` +`sudo cpupower {{[-c|--cpu]}} {{all}} info` - Print information about all cores: -`sudo cpupower --cpu {{all}} info` +`sudo cpupower {{[-c|--cpu]}} {{all}} info` - Set all CPUs to a power-saving frequency governor: -`sudo cpupower --cpu {{all}} frequency-set --governor {{powersave}}` +`sudo cpupower {{[-c|--cpu]}} {{all}} frequency-set --governor {{powersave}}` -- Print CPU 0's available frequency [g]overnors: +- Print CPU 0's available frequency governors: -`sudo cpupower --cpu {{0}} frequency-info g | grep "analyzing\|governors"` +`sudo cpupower {{[-c|--cpu]}} {{0}} frequency-info {{[-g|--governors]}} | grep "analyzing\|governors"` - Print CPU 4's frequency from the hardware, in a human-readable format: -`sudo cpupower --cpu {{4}} frequency-info --hwfreq --human` +`sudo cpupower {{[-c|--cpu]}} {{4}} frequency-info {{[-w|--hwfreq]}} {{[-m|--human]}}` diff --git a/tldr/linux/cryptcat b/tldr/linux/cryptcat index c0bf1429..38e564d3 100644 --- a/tldr/linux/cryptcat +++ b/tldr/linux/cryptcat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cryptcat > Cryptcat is netcat with encryption capabilities. -> More information: . +> More information: . - [l]isten on a specified [p]ort and print any data received: diff --git a/tldr/linux/dbclient b/tldr/linux/dbclient index 54465194..f31bcfdd 100644 --- a/tldr/linux/dbclient +++ b/tldr/linux/dbclient @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dbclient > Lightweight Dropbear Secure Shell client. -> More information: . +> More information: . - Connect to a remote host: diff --git a/tldr/linux/dnf-group b/tldr/linux/dnf-group index 78761d59..983b6bab 100644 --- a/tldr/linux/dnf-group +++ b/tldr/linux/dnf-group @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dnf group > Manage virtual collections of packages on Fedora-based systems. -> More information: . +> More information: . - List DNF groups, showing installed and uninstalled status in a table: diff --git a/tldr/linux/dpigs b/tldr/linux/dpigs index f00da6f8..f3bf8bd7 100644 --- a/tldr/linux/dpigs +++ b/tldr/linux/dpigs @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Show which installed packages occupy the most space on `apt` based systems. > More information: . -- Display the N largest packages on the system: +- Display the `n` largest packages on the system: -`dpigs --lines={{N}}` +`dpigs {{[-n|--lines]}} {{n}}` -- Use the specified file instead of the default dpkg [s]tatus file: +- Use the specified file instead of the default dpkg status file: -`dpigs --status={{path/to/file}}` +`dpigs {{[-s|--status]}} {{path/to/file}}` -- Display the largest [S]ource packages of binary packages installed on the system: +- Display the largest source packages of binary packages installed on the system: -`dpigs --source` +`dpigs {{[-S|--source]}}` -- Display package sizes in [H]uman-readable format: +- Display package sizes in human-readable format: -`dpigs --human-readable` +`dpigs {{[-H|--human-readable]}}` - Display help: -`dpigs --help` +`dpigs {{[-h|--help]}}` diff --git a/tldr/linux/dropbearkey b/tldr/linux/dropbearkey index 20b20264..6cac5e22 100644 --- a/tldr/linux/dropbearkey +++ b/tldr/linux/dropbearkey @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dropbearkey > Generate SSH keys in Dropbear format. -> More information: . +> More information: . - Generate an SSH key of [t]ype ed25519 and write it to key [f]ile: diff --git a/tldr/linux/duperemove b/tldr/linux/duperemove index 5a2da567..c5c762b8 100644 --- a/tldr/linux/duperemove +++ b/tldr/linux/duperemove @@ -24,4 +24,4 @@ source: https://github.com/tldr-pages/tldr.git - Limit I/O threads (for hashing and dedupe stage) and CPU threads (for duplicate extent finding stage): -`duperemove -r -d --hashfile={{path/to/hashfile}} --io-threads={{N}} --cpu-threads={{N}} {{path/to/directory}}` +`duperemove -r -d --hashfile={{path/to/hashfile}} --io-threads={{n}} --cpu-threads={{n}} {{path/to/directory}}` diff --git a/tldr/linux/esearch b/tldr/linux/esearch index f1f4974f..4d9feb99 100644 --- a/tldr/linux/esearch +++ b/tldr/linux/esearch @@ -21,6 +21,6 @@ source: https://github.com/tldr-pages/tldr.git `esearch -db nuccore -query "{{insulin [PROT] AND rodents [ORGN]}}"` -- Display [h]elp: +- Display help: -`esearch -h` +`esearch {{[-h|-help]}}` diff --git a/tldr/linux/getfacl b/tldr/linux/getfacl index f2c515c0..57f62871 100644 --- a/tldr/linux/getfacl +++ b/tldr/linux/getfacl @@ -12,10 +12,10 @@ source: https://github.com/tldr-pages/tldr.git `getfacl {{path/to/file_or_directory}}` -- Display the file access control list with [n]umeric user and group IDs: +- Display the file access control list with numeric user and group IDs: -`getfacl --numeric {{path/to/file_or_directory}}` +`getfacl {{[-n|--numeric]}} {{path/to/file_or_directory}}` -- Display the file access control list with [t]abular output format: +- Display the file access control list with tabular output format: -`getfacl --tabular {{path/to/file_or_directory}}` +`getfacl {{[-t|--tabular]}} {{path/to/file_or_directory}}` diff --git a/tldr/linux/init b/tldr/linux/init index a69b3eb2..7a29e55b 100644 --- a/tldr/linux/init +++ b/tldr/linux/init @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Linux run level manager. > Requires the SYSVINIT compile-time option to be enabled if using systemd. -> More information: . +> More information: . - Set the system to run a graphical environment: diff --git a/tldr/linux/iptables-save b/tldr/linux/iptables-save index 69193652..0fb866cd 100644 --- a/tldr/linux/iptables-save +++ b/tldr/linux/iptables-save @@ -13,10 +13,10 @@ source: https://github.com/tldr-pages/tldr.git `sudo iptables-save` -- Print the `iptables` configuration of a specific [t]able: +- Print the `iptables` configuration of a specific table: -`sudo iptables-save --table {{table}}` +`sudo iptables-save {{[-t|--table]}} {{table}}` -- Save the `iptables` configuration to a [f]ile: +- Save the `iptables` configuration to a file: -`sudo iptables-save --file {{path/to/file}}` +`sudo iptables-save {{[-f|--file]}} {{path/to/file}}` diff --git a/tldr/linux/journalctl b/tldr/linux/journalctl index 1ad9680a..5743e44a 100644 --- a/tldr/linux/journalctl +++ b/tldr/linux/journalctl @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `journalctl --vacuum-time 2d` -- Show only the last N lines and follow new messages (like `tail -f` for traditional syslog): +- Show only the last `n` lines and follow new messages (like `tail -f` for traditional syslog): -`journalctl {{[-n|--lines]}} {{N}} {{[-f|--follow]}}` +`journalctl {{[-n|--lines]}} {{n}} {{[-f|--follow]}}` - Show all messages by a specific unit: diff --git a/tldr/linux/lldpctl b/tldr/linux/lldpctl index 44457f5b..88294147 100644 --- a/tldr/linux/lldpctl +++ b/tldr/linux/lldpctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lldpctl > Print link layer discovery protocol information. -> More information: . +> More information: . - Start the lldp daemon: diff --git a/tldr/linux/logread b/tldr/linux/logread index 863d1849..d4bd7e62 100644 --- a/tldr/linux/logread +++ b/tldr/linux/logread @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `logread` -- Print a specified number of messages: +- Print `n` messages: -`logread -l {{N}}` +`logread -l {{n}}` - Filter messages by (Keyword/Regular Expression): diff --git a/tldr/linux/lsipc b/tldr/linux/lsipc index a67385b7..a9ace079 100644 --- a/tldr/linux/lsipc +++ b/tldr/linux/lsipc @@ -17,13 +17,13 @@ source: https://github.com/tldr-pages/tldr.git `lsipc {{--shmems|--queues|--semaphores}}` -- Show full details on the resource with a specific [i]D: +- Show full details on the resource with a specific ID: -`lsipc {{--shmems|--queues|--semaphores}} --id {{resource_id}}` +`lsipc {{--shmems|--queues|--semaphores}} {{[-i|--id]}} {{resource_id}}` -- Print the given [o]utput columns (see all supported columns with `--help`): +- Print the given output columns (see all supported columns with `--help`): -`lsipc --output {{KEY,ID,PERMS,SEND,STATUS,NSEMS,RESOURCE,...}}` +`lsipc {{[-o|--output]}} {{KEY,ID,PERMS,SEND,STATUS,NSEMS,RESOURCE,...}}` - Use [r]aw, [J]SON, [l]ist or [e]xport (key="value") format: diff --git a/tldr/linux/macchanger b/tldr/linux/macchanger index 090d29a6..6109b709 100644 --- a/tldr/linux/macchanger +++ b/tldr/linux/macchanger @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - View the current and permanent MAC addresses of a interface: -`macchanger --show {{interface}}` +`macchanger {{[-s|--show]}} {{interface}}` - Set interface to a random MAC: -`macchanger --random {{interface}}` +`macchanger {{[-r|--random]}} {{interface}}` - Set an interface to a random MAC address, and pretend to be a [b]urned-[i]n-[a]ddress: -`macchanger --random --bia {{interface}}` +`macchanger {{[-r|--random]}} {{[-b|--bia]}} {{interface}}` - Set an interface to a specific MAC address: -`macchanger --mac {{XX:XX:XX:XX:XX:XX}} {{interface}}` +`macchanger {{[-m|--mac]}} {{XX:XX:XX:XX:XX:XX}} {{interface}}` - Print the identifications (the first three bytes of a MAC address) of all known vendors: -`macchanger --list` +`macchanger {{[-l|--list]}}` - Reset an interface to its permanent hardware MAC address: -`macchanger --permanent {{interface}}` +`macchanger {{[-p|--permanent]}} {{interface}}` diff --git a/tldr/linux/namcap b/tldr/linux/namcap index ef5b3962..4f548938 100644 --- a/tldr/linux/namcap +++ b/tldr/linux/namcap @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # namcap > Check binary packages and source `PKGBUILD`s for common packaging mistakes. -> More information: . +> More information: . - Check a specific `PKGBUILD` file: @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `namcap {{path/to/package.pkg.tar.zst}}` -- Check a file, printing extra [i]nformational messages: +- Check a file, printing extra informational messages: -`namcap -i {{path/to/file}}` +`namcap {{[-i|--info]}} {{path/to/file}}` diff --git a/tldr/linux/needrestart b/tldr/linux/needrestart index c44bbcf3..a3dcbbc0 100644 --- a/tldr/linux/needrestart +++ b/tldr/linux/needrestart @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # needrestart > Check which daemons need to be restarted after library upgrades. -> More information: . +> More information: . - List outdated processes: diff --git a/tldr/linux/netselect b/tldr/linux/netselect index e025f0d5..22d631b3 100644 --- a/tldr/linux/netselect +++ b/tldr/linux/netselect @@ -20,9 +20,9 @@ source: https://github.com/tldr-pages/tldr.git `sudo netselect -m {{10}} {{host_1}} {{host_2}}` -- Print fastest N servers among the hosts: +- Print `n` fastest servers among the hosts: -`sudo netselect -s {{N}} {{host_1}} {{host_2}} {{host_3}}` +`sudo netselect -s {{n}} {{host_1}} {{host_2}} {{host_3}}` - Display help: diff --git a/tldr/linux/nitch b/tldr/linux/nitch index b2f6671a..47094bde 100644 --- a/tldr/linux/nitch +++ b/tldr/linux/nitch @@ -12,10 +12,10 @@ source: https://github.com/tldr-pages/tldr.git `nitch` -- Display [h]elp: +- Display help: -`nitch --help` +`nitch {{[-h|--help]}}` -- Display [v]ersion: +- Display version: -`nitch --version` +`nitch {{[-v|--version]}}` diff --git a/tldr/linux/nl b/tldr/linux/nl index facf4fa6..79564161 100644 --- a/tldr/linux/nl +++ b/tldr/linux/nl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nl > Number lines from a file or from `stdin`. -> More information: . +> More information: . - Number non-blank lines in a file: diff --git a/tldr/linux/pdftoppm b/tldr/linux/pdftoppm index 916c3a1a..a5dd7e3d 100644 --- a/tldr/linux/pdftoppm +++ b/tldr/linux/pdftoppm @@ -8,9 +8,9 @@ source: https://github.com/tldr-pages/tldr.git > Convert PDF document pages to portable Pixmap (image formats). > More information: . -- Specify the range of pages to convert (N-first page, M-last page): +- Specify the range of pages to convert (`n` - first page, `m` - last page): -`pdftoppm -f {{N}} -l {{M}} {{path/to/file.pdf}} {{image_name_prefix}}` +`pdftoppm -f {{n}} -l {{m}} {{path/to/file.pdf}} {{image_name_prefix}}` - Convert only the first page of a PDF: diff --git a/tldr/linux/pkgctl-diff b/tldr/linux/pkgctl-diff index fab5ce6d..a833cb04 100644 --- a/tldr/linux/pkgctl-diff +++ b/tldr/linux/pkgctl-diff @@ -7,20 +7,20 @@ source: https://github.com/tldr-pages/tldr.git > Compare package files using different modes. > See also: `pkgctl`. -> More information: . +> More information: . -- Compare package files in tar content [l]ist different mode (default): +- Compare package files in tar content list different mode (default): -`pkgctl diff --list {{path/to/file|pkgname}}` +`pkgctl diff {{[-l|--list]}} {{path/to/file|pkgname}}` -- Compare package files in [d]iffoscope different mode: +- Compare package files in diffoscope different mode: -`pkgctl diff --diffoscope {{path/to/file|pkgname}}` +`pkgctl diff {{[-d|--diffoscope]}} {{path/to/file|pkgname}}` - Compare package files in `.PKGINFO` different mode: -`pkgctl diff --pkginfo {{path/to/file|pkgname}}` +`pkgctl diff {{[-p|--pkginfo]}} {{path/to/file|pkgname}}` - Compare package files in `.BUILDINFO` different mode: -`pkgctl diff --buildinfo {{path/to/file|pkgname}}` +`pkgctl diff {{[-b|--buildinfo]}} {{path/to/file|pkgname}}` diff --git a/tldr/linux/pyrit b/tldr/linux/pyrit index 8009a51c..f9d6a6fa 100644 --- a/tldr/linux/pyrit +++ b/tldr/linux/pyrit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pyrit > WPA/WPA2 cracking tool using computational power. -> More information: . +> More information: . - Display system cracking speed: diff --git a/tldr/linux/qrcp b/tldr/linux/qrcp index cb380881..bbd60ced 100644 --- a/tldr/linux/qrcp +++ b/tldr/linux/qrcp @@ -20,13 +20,13 @@ source: https://github.com/tldr-pages/tldr.git `qrcp send --zip {{path/to/file_or_directory}}` -- Use a specific [p]ort: +- Use a specific port: -`qrcp {{send|receive}} --port {{port_number}}` +`qrcp {{send|receive}} {{[-p|--port]}} {{port_number}}` -- Use a specific network [i]nterface: +- Use a specific network interface: -`qrcp {{send|receive}} --interface {{interface}}` +`qrcp {{send|receive}} {{[-i|--interface]}} {{interface}}` - Keep the server alive: diff --git a/tldr/linux/rig b/tldr/linux/rig index ece63e1d..ba5b60e2 100644 --- a/tldr/linux/rig +++ b/tldr/linux/rig @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `rig -{{m|f}}` -- Use data files from a specific directory (default is `/usr/share/rig`): +- Use [d]ata files from a specific directory (default is `/usr/share/rig`): `rig -d {{path/to/directory}}` @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `rig -c {{number}}` -- Display a specific number of female identities: +- Display a specific number of [f]emale identities: `rig -f -c {{number}}` diff --git a/tldr/linux/ruget b/tldr/linux/ruget index 23a652f8..c12cdf95 100644 --- a/tldr/linux/ruget +++ b/tldr/linux/ruget @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `ruget {{https://example.com/file}}` -- Download the contents of a URL to a specified [o]utput file: +- Download the contents of a URL to a specified output file: -`ruget --output {{file_name}} {{https://example.com/file}}` +`ruget {{[-o|--output]}} {{file_name}} {{https://example.com/file}}` diff --git a/tldr/linux/setfacl b/tldr/linux/setfacl index 8cf07aee..42a37972 100644 --- a/tldr/linux/setfacl +++ b/tldr/linux/setfacl @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Set file access control lists (ACL). > More information: . -- [M]odify ACL of a file for user with read and write access: +- Modify ACL of a file for user with read and write access: -`setfacl --modify u:{{username}}:rw {{path/to/file_or_directory}}` +`setfacl {{[-m|--modify]}} u:{{username}}:rw {{path/to/file_or_directory}}` -- [M]odify [d]efault ACL of a file for all users: +- Modify default ACL of a file for all users: -`setfacl --modify --default u::rw {{path/to/file_or_directory}}` +`setfacl {{[-m|--modify]}} {{[-d|--default]}} u::rw {{path/to/file_or_directory}}` - Remove ACL of a file for a user: -`setfacl --remove u:{{username}} {{path/to/file_or_directory}}` +`setfacl {{[-x|--remove]}} u:{{username}} {{path/to/file_or_directory}}` - Remove all ACL entries of a file: -`setfacl --remove-all {{path/to/file_or_directory}}` +`setfacl {{[-X|--remove-all]}} {{path/to/file_or_directory}}` diff --git a/tldr/linux/setsebool b/tldr/linux/setsebool index 01bb64e6..01db1b9b 100644 --- a/tldr/linux/setsebool +++ b/tldr/linux/setsebool @@ -17,11 +17,11 @@ source: https://github.com/tldr-pages/tldr.git `sudo setsebool {{httpd_can_network_connect}} {{1|true|on|0|false|off}}` -- Set or unset a boolean [p]ersistently: +- Set or unset a boolean [P]ersistently: `sudo setsebool -P {{container_use_devices}} {{1|true|on|0|false|off}}` -- Set or unset multiple booleans [p]ersistently at once: +- Set or unset multiple booleans [P]ersistently at once: `sudo setsebool -P {{ftpd_use_fusefs=1 mount_anyfile=0 ...}}` diff --git a/tldr/linux/shutdown b/tldr/linux/shutdown index 1bfe166a..1588c60c 100644 --- a/tldr/linux/shutdown +++ b/tldr/linux/shutdown @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `shutdown {{[-r|--reboot]}} +{{5}} &` -- Shutdown at 1:00 pm (Uses 24[h] clock): +- Shutdown at 1:00 pm (Uses 24h clock): `shutdown -h 13:00` diff --git a/tldr/linux/swaybg b/tldr/linux/swaybg index 51eff864..760e9b7b 100644 --- a/tldr/linux/swaybg +++ b/tldr/linux/swaybg @@ -8,14 +8,14 @@ source: https://github.com/tldr-pages/tldr.git > Wallpaper tool for Wayland compositors. > More information: . -- Set the wallpaper to an [i]mage: +- Set the wallpaper to an image: -`swaybg --image {{path/to/image}}` +`swaybg {{[-i|--image]}} {{path/to/image}}` -- Set the wallpaper [m]ode: +- Set the wallpaper mode: -`swaybg --image {{path/to/image}} --mode {{stretch|fit|fill|center|tile|solid_color}}` +`swaybg {{[-i|--image]}} {{path/to/image}} {{[-m|--mode]}} {{stretch|fit|fill|center|tile|solid_color}}` -- Set the wallpaper to a static [c]olor: +- Set the wallpaper to a static color: -`swaybg --color "{{#rrggbb}}"` +`swaybg {{[-c|--color]}} "{{#rrggbb}}"` diff --git a/tldr/linux/tcpick b/tldr/linux/tcpick index 4d836729..89bf1d51 100644 --- a/tldr/linux/tcpick +++ b/tldr/linux/tcpick @@ -9,13 +9,13 @@ source: https://github.com/tldr-pages/tldr.git > It can capture and display TCP connections and data. It can also monitor network traffic on a interface, host, or port. > More information: . -- Capture traffic on a specific [i]nterface, port and host:: +- Capture traffic on a specific interface, port and host:: -`sudo tcpick -i {{interface}} -C -h {{host}} -p {{port}}` +`sudo tcpick {{[-i|--interface]}} {{interface}} {{[-C|--colors]}} -h {{host}} -p {{port}}` - Capture traffic on port 80 (HTTP) of a specific host: -`sudo tcpick -i {{eth0}} -C -h {{192.168.1.100}} -p {{80}}` +`sudo tcpick {{[-i|--interface]}} {{eth0}} {{[-C|--colors]}} -h {{192.168.1.100}} -p {{80}}` - Display help: diff --git a/tldr/linux/tlp-stat b/tldr/linux/tlp-stat index 8e52124b..592c528a 100644 --- a/tldr/linux/tlp-stat +++ b/tldr/linux/tlp-stat @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Show verbose information about devices that support verbosity: -`sudo tlp-stat --verbose --{{battery|processor|pcie|usb}}` +`sudo tlp-stat {{[-v|--verbose]}} --{{battery|processor|pcie|usb}}` - Show configuration: @@ -33,7 +33,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo tlp-stat --psup` -- Show [temp]eratures and fan speed: +- Show [t]emperatures and fan speed: `sudo tlp-stat {{[-t|--temp]}}` diff --git a/tldr/linux/torsocks b/tldr/linux/torsocks index 085d4c52..f821d9cb 100644 --- a/tldr/linux/torsocks +++ b/tldr/linux/torsocks @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Route the traffic of any application through the Tor network. > Note: `torsocks` will assume that it should connect to the Tor SOCKS proxy running at 127.0.0.1:9050 being the defaults of the Tor daemon. -> More information: . +> More information: . - Run a command using Tor: @@ -25,10 +25,10 @@ source: https://github.com/tldr-pages/tldr.git `torsocks show` -- [i]solate traffic through a different Tor circuit, improving anonymity: +- Isolate traffic through a different Tor circuit, improving anonymity: -`torsocks --isolate {{curl https://check.torproject.org/api/ip}}` +`torsocks {{[-i|--isolate]}} {{curl https://check.torproject.org/api/ip}}` -- Connect to a Tor proxy running on a specific [a]ddress and [P]ort: +- Connect to a Tor proxy running on a specific address and port: -`torsocks --address {{ip}} --port {{port}} {{command}}` +`torsocks {{[-a|--address]}} {{ip}} {{[-P|--port]}} {{port}} {{command}}` diff --git a/tldr/linux/tunelp b/tldr/linux/tunelp index 90fc4b33..f0909ee9 100644 --- a/tldr/linux/tunelp +++ b/tldr/linux/tunelp @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > Part of `util-linux`. > More information: . -- Check the [s]tatus of a parallel port device: +- Check the status of a parallel port device: -`tunelp --status {{/dev/lp0}}` +`tunelp {{[-s|--status]}} {{/dev/lp0}}` -- [r]eset a given parallel port: +- Reset a given parallel port: -`tunelp --reset {{/dev/lp0}}` +`tunelp {{[-r|--reset]}} {{/dev/lp0}}` -- Use a given [i]RQ for a device, each one representing an interrupt line: +- Use a given IRQ for a device, each one representing an interrupt line: -`tunelp -i 5 {{/dev/lp0}}` +`tunelp {{[-i|--irq]}} 5 {{/dev/lp0}}` -- Try a given number of times to output a [c]haracter to the printer before sleeping for a given [t]ime: +- Try a given number of times to output a character to the printer before sleeping for a given time: -`tunelp --chars {{times}} --time {{time_in_centiseconds}} {{/dev/lp0}}` +`tunelp {{[-c|--chars]}} {{times}} {{[-t|--time]}} {{time_in_centiseconds}} {{/dev/lp0}}` -- Enable or disable [a]borting on error (disabled by default): +- Enable or disable aborting on error (disabled by default): -`tunelp --abort {{on|off}}` +`tunelp {{[-a|--abort]}} {{on|off}}` diff --git a/tldr/linux/urpmf b/tldr/linux/urpmf index b86973ac..7709bacc 100644 --- a/tldr/linux/urpmf +++ b/tldr/linux/urpmf @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Find files in packages and query information about them in Mageia. > See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmi.update`, `urpmq`. -> More information: . +> More information: . - Search for packages that contain a file: diff --git a/tldr/linux/yakuake b/tldr/linux/yakuake index 98efb3e7..e243e50b 100644 --- a/tldr/linux/yakuake +++ b/tldr/linux/yakuake @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # yakuake > A drop-down terminal for KDE. -> More information: . +> More information: . - Start up Yakuake: diff --git a/tldr/logout b/tldr/logout index 88c32100..65ddce21 100644 --- a/tldr/logout +++ b/tldr/logout @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Exit a login shell and specify a return value: -`logout {{N}}` +`logout {{exit_code}}` diff --git a/tldr/lp b/tldr/lp index d582548c..6866bc12 100644 --- a/tldr/lp +++ b/tldr/lp @@ -20,9 +20,9 @@ source: https://github.com/tldr-pages/tldr.git `lp -d {{printer_name}} {{path/to/filename}}` -- Print N copies of file to default printer (replace N with desired number of copies): +- Print `n` copies of a file to the default printer: -`lp -n {{N}} {{path/to/filename}}` +`lp -n {{n}} {{path/to/filename}}` - Print only certain pages to the default printer (print pages 1, 3-5, and 16): diff --git a/tldr/macptopbm b/tldr/macptopbm index dbe51d39..43e93c1e 100644 --- a/tldr/macptopbm +++ b/tldr/macptopbm @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `macptopbm {{path/to/file.macp}} > {{path/to/output.pbm}}` -- Skip over a specified number of bytes when reading the file: +- Skip over `n` bytes when reading the file: -`macptopbm -extraskip {{N}} > {{path/to/output.pbm}}` +`macptopbm -extraskip {{n}} > {{path/to/output.pbm}}` - Suppress all informational messages: diff --git a/tldr/marimo b/tldr/marimo new file mode 100644 index 00000000..e783bb2b --- /dev/null +++ b/tldr/marimo @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# marimo + +> A reactive Python notebook environment. +> Combines features of Jupyter, Streamlit, and other notebook tools with reactive execution. +> More information: . + +- Create or edit notebooks by starting a marimo server: + +`marimo edit` + +- Start a marimo server on a specific port without launching a browser: + +`marimo edit {{[-p|--port]}} {{port_number}} --headless` + +- Edit a specific notebook: + +`marimo edit {{path/to/notebook.py}}` + +- Run a marimo notebook as an app in read-only mode: + +`marimo run {{path/to/notebook.py}}` + +- Start an interactive tutorial to learn marimo: + +`marimo tutorial {{intro|components|dataflow|io}}` + +- View command-specific help: + +`marimo {{edit|run|tutorial|config|new|...}} --help` diff --git a/tldr/mpg321 b/tldr/mpg321 index d9f8e3e3..b515c38c 100644 --- a/tldr/mpg321 +++ b/tldr/mpg321 @@ -9,9 +9,9 @@ source: https://github.com/tldr-pages/tldr.git > Mpg321 was written (sometime in 1999) to be a drop-in replacement for the (previously) non-free mpg123 player. > More information: . -- Play an audio source exactly N times (N=0 means forever): +- Play an audio source exactly `n` times (0 means forever): -`mpg321 -l {{N}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 -l {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Play a directory recursively: diff --git a/tldr/ntpctl b/tldr/ntpctl index bd56b421..1e0f7271 100644 --- a/tldr/ntpctl +++ b/tldr/ntpctl @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Show all data: -`ntpctl -s {{a|all}}` +`ntpctl -s {{[a|all]}}` - Show information about each peer: -`ntpctl -s {{p|peers}}` +`ntpctl -s {{[p|peers]}}` - Show the status of peers and sensors, and whether the system clock is synced: -`ntpctl -s {{s|status}}` +`ntpctl -s {{[s|status]}}` - Show information about each sensor: -`ntpctl -s {{S|Sensors}}` +`ntpctl -s {{[S|Sensors]}}` diff --git a/tldr/pamenlarge b/tldr/pamenlarge index fdeec1f8..7769b23b 100644 --- a/tldr/pamenlarge +++ b/tldr/pamenlarge @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Enlarge the specified image by the specified factor: -`pamenlarge -scale {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamenlarge -scale {{n}} {{path/to/image.pam}} > {{path/to/output.pam}}` - Enlarge the specified image by the specified factors horizontally and vertically: -`pamenlarge -xscale {{XN}} -yscale {{YN}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamenlarge -xscale {{xn}} -yscale {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/tldr/pamoil b/tldr/pamoil index 1aefac8d..11dfe487 100644 --- a/tldr/pamoil +++ b/tldr/pamoil @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `pamoil {{path/to/input_file.pam}} > {{path/to/output_file.pam}}` -- Consider a neighborhood of N pixels for the "smearing" effect: +- Consider a neighborhood of `n` pixels for the "smearing" effect: -`pamoil -n {{N}} {{path/to/input_file.pam}} > {{path/to/output_file.pam}}` +`pamoil -n {{n}} {{path/to/input_file.pam}} > {{path/to/output_file.pam}}` diff --git a/tldr/pamstretch b/tldr/pamstretch index 98388e1a..dacef3fa 100644 --- a/tldr/pamstretch +++ b/tldr/pamstretch @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Scale up a PAM image by an integer factor: -`pamstretch {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamstretch {{n}} {{path/to/image.pam}} > {{path/to/output.pam}}` - Scale up a PAM image by the specified factors in the horizontal and vertical directions: -`pamstretch -xscale {{XN}} -yscale {{YN}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamstretch -xscale {{xn}} -yscale {{yn}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/tldr/pamstretch-gen b/tldr/pamstretch-gen index e7d43b2c..215fab41 100644 --- a/tldr/pamstretch-gen +++ b/tldr/pamstretch-gen @@ -11,4 +11,4 @@ source: https://github.com/tldr-pages/tldr.git - Scale up a PAM image by the specified decimal factor: -`pamstretch-gen {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` +`pamstretch-gen {{n}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/tldr/pbmpscale b/tldr/pbmpscale index 43073b04..fae897f9 100644 --- a/tldr/pbmpscale +++ b/tldr/pbmpscale @@ -11,4 +11,4 @@ source: https://github.com/tldr-pages/tldr.git - Enlarge a PBM image by the specified factor with edge smoothing: -`pbmpscale {{N}} {{path/to/image.pbm}} > {{path/to/file.pbm}}` +`pbmpscale {{n}} {{path/to/image.pbm}} > {{path/to/file.pbm}}` diff --git a/tldr/pbmreduce b/tldr/pbmreduce index 96908f6a..d9da134e 100644 --- a/tldr/pbmreduce +++ b/tldr/pbmreduce @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Reduce the specified image by the specified factor: -`pbmreduce {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmreduce {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` - Use simple thresholding when reducing: -`pbmreduce -threshold {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmreduce -threshold {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` - Use the specified threshold for all quantizations: -`pbmreduce -value {{0.6}} {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` +`pbmreduce -value {{0.6}} {{n}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/tldr/qcp b/tldr/qcp index 6b97ee2d..91b0586a 100644 --- a/tldr/qcp +++ b/tldr/qcp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qcp > Copy files using the default text editor to define the filenames. -> More information: . +> More information: . - Copy a single file (open an editor with the source filename on the left and the target filename on the right): diff --git a/tldr/qmv b/tldr/qmv index be6d7d89..787ac1f1 100644 --- a/tldr/qmv +++ b/tldr/qmv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qmv > Move files and directories using the default text editor to define the filenames. -> More information: . +> More information: . - Move a single file (open an editor with the source filename on the left and the target filename on the right): diff --git a/tldr/rawtopgm b/tldr/rawtopgm index adeb70cf..7215153e 100644 --- a/tldr/rawtopgm +++ b/tldr/rawtopgm @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `rawtopgm {{width}} {{height}} -bottomfirst {{path/to/image.raw}} > {{path/to/output.pgm}}` -- Ignore the first n bytes of the specified file: +- Ignore the first `n` bytes of the specified file: `rawtopgm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` @@ -28,9 +28,9 @@ source: https://github.com/tldr-pages/tldr.git `rawtopgm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.pgm}}` -- Specify the maxval for the grey values in the input to be equal to N: +- Specify the maxval for the grey values in the input to be equal to `n`: -`rawtopgm {{width}} {{height}} -maxval {{N}} {{path/to/image.raw}} > {{path/to/output.pgm}}` +`rawtopgm {{width}} {{height}} -maxval {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` - Specify the number of bytes that represent each sample in the input and that the byte-sequence is to be interpreted as little-endian: diff --git a/tldr/readarray b/tldr/readarray index a039f653..03fbaba8 100644 --- a/tldr/readarray +++ b/tldr/readarray @@ -20,9 +20,9 @@ source: https://github.com/tldr-pages/tldr.git `readarray -t {{array_name}} < {{path/to/file.txt}}` -- Copy at most the specified number of lines: +- Copy at most `n` lines: -`readarray -n {{N}} {{array_name}} < {{path/to/file.txt}}` +`readarray -n {{n}} {{array_name}} < {{path/to/file.txt}}` - Display help: diff --git a/tldr/return b/tldr/return index 9147d7a6..0feb4ef7 100644 --- a/tldr/return +++ b/tldr/return @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Specify the function's return value: -`{{func_name}}() { return {{N}}; }` +`{{func_name}}() { return {{exit_code}}; }` diff --git a/tldr/shift b/tldr/shift index c0ee29d6..3ed038b8 100644 --- a/tldr/shift +++ b/tldr/shift @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `shift` -- Remove the first `N` positional parameters: +- Remove the first `n` positional parameters: -`shift {{N}}` +`shift {{n}}` diff --git a/tldr/tofu b/tldr/tofu new file mode 100644 index 00000000..4c382cf6 --- /dev/null +++ b/tldr/tofu @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tofu + +> Create and deploy infrastructure as code to cloud providers. Open-source fork of Terraform. +> More information: . + +- Initialize a new or existing OpenTofu configuration: + +`tofu init` + +- Verify that the configuration files are syntactically valid: + +`tofu validate` + +- Format configuration according to OpenTofu language style conventions: + +`tofu fmt` + +- Generate and show an execution plan: + +`tofu plan` + +- Build or change infrastructure: + +`tofu apply` + +- Destroy Tofu-managed infrastructure: + +`tofu destroy` diff --git a/tldr/tofu-fmt b/tldr/tofu-fmt new file mode 100644 index 00000000..26811d42 --- /dev/null +++ b/tldr/tofu-fmt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tofu fmt + +> Format configuration according to OpenTofu language style conventions. +> More information: . + +- Format the configuration in the current directory: + +`tofu fmt` + +- Format the configuration in the current directory and subdirectories: + +`tofu fmt -recursive` + +- Display diffs of formatting changes: + +`tofu fmt -diff` + +- Do not list files that were formatted to `stdout`: + +`tofu fmt -list=false` diff --git a/tldr/tofu-output b/tldr/tofu-output new file mode 100644 index 00000000..9007c5c5 --- /dev/null +++ b/tldr/tofu-output @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tofu output + +> Export structured data about your OpenTofu resources. +> More information: . + +- With no additional arguments, `output` will display all outputs for the root module: + +`tofu output` + +- Output only a value with specific name: + +`tofu output {{name}}` + +- Convert the output value to a raw string (useful for shell scripts): + +`tofu output -raw` + +- Format the outputs as a JSON object, with a key per output (useful with `jq`): + +`tofu output -json` diff --git a/tldr/tofu-plan b/tldr/tofu-plan new file mode 100644 index 00000000..e715b013 --- /dev/null +++ b/tldr/tofu-plan @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tofu plan + +> Generate and show OpenTofu execution plans. +> More information: . + +- Generate and show the execution plan in the currently directory: + +`tofu plan` + +- Show a plan to destroy all remote objects that currently exist: + +`tofu plan -destroy` + +- Show a plan to update the Tofu state and output values: + +`tofu plan -refresh-only` + +- Specify values for input variables: + +`tofu plan -var '{{name1}}={{value1}}' -var '{{name2}}={{value2}}'` + +- Focus Tofu's attention on only a subset of resources: + +`tofu plan -target {{resource_type.resource_name[instance index]}}` + +- Output a plan as JSON: + +`tofu plan -json` + +- Write a plan to a specific file: + +`tofu plan -no-color > {{path/to/file}}` diff --git a/tldr/wait b/tldr/wait index bee5f0b9..da46e7b0 100644 --- a/tldr/wait +++ b/tldr/wait @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Wait for a job to finish: -`wait %{{N}}` +`wait %{{job_number}}` - Display help: diff --git a/tldr/windows/choice b/tldr/windows/choice index 5bf5779b..84169c84 100644 --- a/tldr/windows/choice +++ b/tldr/windows/choice @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Prompt the current user to select a choice and prefer the [d]efault choice in a specific [t]ime: -`choice /t {{5}} /d {{N}}` +`choice /t {{5}} /d {{default_choice}}` - Display help: