From a360d4dc4566a25c2c504922ce795a5b601f9d0c Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Sun, 20 Apr 2025 00:20:58 +0000 Subject: [PATCH] Update cheatsheets --- tldr/git-clone | 2 +- tldr/ld | 6 +++--- tldr/linux/acpi | 12 +++++------ tldr/linux/apt | 4 ++-- tldr/linux/apt-key | 2 +- tldr/linux/arecord | 12 +++++------ tldr/linux/arptables | 34 ++++++++++++++++++++++++++++++ tldr/linux/audit2allow | 4 ++-- tldr/linux/beep | 4 ++-- tldr/linux/betterlockscreen | 8 +++---- tldr/linux/blight | 4 ++-- tldr/linux/bmon | 8 +++---- tldr/linux/btrfs-filesystem | 6 +++--- tldr/linux/btrfs-restore | 4 ++-- tldr/linux/btrfs-scrub | 2 +- tldr/linux/cacaclock | 4 ++-- tldr/linux/conky | 10 ++++----- tldr/linux/conntrack | 10 ++++----- tldr/linux/cpufreq-aperf | 6 +++--- tldr/linux/cpufreq-info | 12 +++++------ tldr/linux/cpufreq-set | 8 +++---- tldr/linux/cpuid | 6 +++--- tldr/linux/createrepo | 4 ++-- tldr/linux/dd | 2 +- tldr/linux/ddcutil | 6 +++--- tldr/linux/dget | 2 +- tldr/linux/dirb | 2 +- tldr/linux/distrobox-create | 4 ++-- tldr/linux/distrobox-enter | 2 +- tldr/linux/distrobox-export | 10 ++++----- tldr/linux/distrobox-list | 2 +- tldr/linux/distrobox-rm | 2 +- tldr/linux/distrobox-stop | 2 +- tldr/linux/distrobox-upgrade | 2 +- tldr/linux/dmesg | 2 +- tldr/linux/dmidecode | 10 ++++----- tldr/linux/dnsrecon | 14 ++++++------ tldr/linux/dpkg | 14 ++++++------ tldr/linux/dunstify | 6 +++--- tldr/linux/eclean-kernel | 21 ++++++++++++++++++ tldr/linux/edquota | 12 +++++------ tldr/linux/envycontrol | 8 +++---- tldr/linux/ethtool | 10 ++++----- tldr/linux/eww | 4 ++-- tldr/linux/expac | 14 ++++++------ tldr/linux/fakeroot | 4 ++-- tldr/linux/fcrackzip | 12 +++++------ tldr/linux/file-rename | 4 ++-- tldr/linux/flashrom | 10 ++++----- tldr/linux/foreman | 4 ++-- tldr/linux/fuzzel | 2 +- tldr/linux/genie | 6 +++--- tldr/linux/getfattr | 4 ++-- tldr/linux/goaccess | 4 ++-- tldr/linux/hardinfo | 4 ++-- tldr/linux/hollywood | 2 +- tldr/linux/ifdown | 2 +- tldr/linux/ifup | 2 +- tldr/linux/imgp | 6 +++--- tldr/linux/iostat | 2 +- tldr/linux/kexec | 8 +++---- tldr/linux/knock | 4 ++-- tldr/linux/knockd | 4 ++-- tldr/linux/konsave | 14 ++++++------ tldr/linux/ldconfig | 2 +- tldr/linux/logger | 2 +- tldr/linux/lsb_release | 8 +++---- tldr/linux/lsfd | 2 +- tldr/linux/lsscsi | 6 +++--- tldr/linux/ltrace | 2 +- tldr/linux/lvcreate | 8 +++---- tldr/linux/lvextend | 6 +++--- tldr/linux/lvreduce | 4 ++-- tldr/linux/lvs | 8 +++---- tldr/linux/lxterminal | 2 +- tldr/linux/mkfs.btrfs | 6 +++--- tldr/linux/mkfs.ntfs | 4 ++-- tldr/linux/mopac | 2 +- tldr/linux/ncat | 8 +++---- tldr/linux/netselect-apt | 4 ++-- tldr/linux/nixos-option | 2 +- tldr/linux/nixos-rebuild | 2 +- tldr/linux/notify-send | 6 +++--- tldr/linux/nsxiv | 2 +- tldr/linux/paccache | 8 +++---- tldr/linux/pacdiff | 8 +++---- tldr/linux/pasuspender | 2 +- tldr/linux/paxs | 10 ++++----- tldr/linux/pdfattach | 2 +- tldr/linux/pdfxup | 6 +++--- tldr/linux/perf | 2 +- tldr/linux/perl-rename | 2 +- tldr/linux/picom | 2 +- tldr/linux/pinout | 2 +- tldr/linux/pkginfo | 6 +++--- tldr/linux/prename | 4 ++-- tldr/linux/pridecat | 8 +++---- tldr/linux/protonvpn-connect | 2 +- tldr/linux/pvs | 8 +++---- tldr/linux/pw-cat | 8 +++---- tldr/linux/pw-loopback | 10 ++++----- tldr/linux/pw-mon | 6 +++--- tldr/linux/pw-top | 6 +++--- tldr/linux/rankmirrors | 6 +++--- tldr/linux/reportbug | 2 +- tldr/linux/repquota | 12 +++++------ tldr/linux/rpicam-hello | 2 +- tldr/linux/rpicam-jpeg | 6 +++--- tldr/linux/rpicam-raw | 4 ++-- tldr/linux/rpicam-still | 6 +++--- tldr/linux/rpicam-vid | 2 +- tldr/linux/rusnapshot | 12 +++++------ tldr/linux/sacct | 10 ++++----- tldr/linux/salloc | 4 ++-- tldr/linux/screenkey | 8 +++---- tldr/linux/sdiag | 8 +++---- tldr/linux/semanage-fcontext | 8 +++---- tldr/linux/setfattr | 6 +++--- tldr/linux/sh5util | 6 +++--- tldr/linux/sic | 2 +- tldr/linux/sinfo | 10 ++++----- tldr/linux/slop | 8 +++---- tldr/linux/slurmrestd | 2 +- tldr/linux/sm | 8 +++---- tldr/linux/snapper | 10 ++++----- tldr/linux/sport | 2 +- tldr/linux/sprio | 8 +++---- tldr/linux/squeue | 4 ++-- tldr/linux/sreport | 2 +- tldr/linux/sshare | 4 ++-- tldr/linux/sstat | 6 +++--- tldr/linux/stress | 8 +++---- tldr/linux/strigger | 6 +++--- tldr/linux/strip | 2 +- tldr/linux/swaks | 10 ++++----- tldr/linux/sysctl | 6 +++--- tldr/linux/sysdig | 8 +++---- tldr/linux/systemd-socket-activate | 2 +- tldr/linux/toilet | 6 +++--- tldr/linux/turbostat | 4 ++-- tldr/linux/unsquashfs | 10 ++++----- tldr/linux/updpkgsums | 4 ++-- tldr/linux/urpmq | 6 +++--- tldr/linux/usbip | 10 ++++----- tldr/linux/uvcdynctrl | 14 ++++++------ tldr/linux/vgs | 8 +++---- tldr/linux/vnstat | 8 +++---- tldr/linux/wf-recorder | 6 +++--- tldr/linux/xclip | 14 ++++++------ tldr/linux/yay | 4 ++-- tldr/linux/yum | 2 +- tldr/nm | 8 +++---- tldr/venv | 4 ++++ 153 files changed, 493 insertions(+), 434 deletions(-) create mode 100644 tldr/linux/arptables create mode 100644 tldr/linux/eclean-kernel diff --git a/tldr/git-clone b/tldr/git-clone index 021e8386..f2d6ee10 100644 --- a/tldr/git-clone +++ b/tldr/git-clone @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Clone a local repository: -`git clone {{[-l|--local]]} {{path/to/local/repository}}` +`git clone {{[-l|--local]}} {{path/to/local/repository}}` - Clone quietly: diff --git a/tldr/ld b/tldr/ld index 7beebac2..aad52253 100644 --- a/tldr/ld +++ b/tldr/ld @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Link a specific object file with no dependencies into an executable: -`ld {{path/to/file.o}} --output {{path/to/output_executable}}` +`ld {{path/to/file.o}} {{[-o|--output]}} {{path/to/output_executable}}` - Link two object files together: -`ld {{path/to/file1.o}} {{path/to/file2.o}} --output {{path/to/output_executable}}` +`ld {{path/to/file1.o}} {{path/to/file2.o}} {{[-o|--output]}} {{path/to/output_executable}}` - Dynamically link an x86_64 program to glibc (file paths change depending on the system): -`ld --output {{path/to/output_executable}} --dynamic-linker /lib/ld-linux-x86-64.so.2 /lib/crt1.o /lib/crti.o -lc {{path/to/file.o}} /lib/crtn.o` +`ld {{[-o|--output]}} {{path/to/output_executable}} {{[-I|--dynamic-linker]}} /lib/ld-linux-x86-64.so.2 /lib/crt1.o /lib/crti.o -lc {{path/to/file.o}} /lib/crtn.o` diff --git a/tldr/linux/acpi b/tldr/linux/acpi index d9b08057..c1d5b661 100644 --- a/tldr/linux/acpi +++ b/tldr/linux/acpi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # acpi > Shows battery status or thermal information. -> More information: . +> More information: . - Show battery information: @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Show thermal information: -`acpi -t` +`acpi {{[-t|--thermal]}}` - Show cooling device information: -`acpi -c` +`acpi {{[-c|--cooling]}}` - Show thermal information in Fahrenheit: -`acpi -tf` +`acpi {{[-tf|--thermal --fahrenheit]}}` - Show all information: -`acpi -V` +`acpi {{[-V|--everything]}}` - Extract information from `/proc` instead of `/sys`: -`acpi -p` +`acpi {{[-p|--proc]}}` diff --git a/tldr/linux/apt b/tldr/linux/apt index 0ad0d656..35c9b9b6 100644 --- a/tldr/linux/apt +++ b/tldr/linux/apt @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo apt update` -- Search for a given package (use `apt search -n package` to search within package name only): +- Search for a given package (use `apt search --name-only package` to search within package name only): `apt search {{package}}` @@ -40,4 +40,4 @@ source: https://github.com/tldr-pages/tldr.git - List installed packages: -`apt list --installed` +`apt list {{[-i|--installed]}}` diff --git a/tldr/linux/apt-key b/tldr/linux/apt-key index 874664c0..6c80bb46 100644 --- a/tldr/linux/apt-key +++ b/tldr/linux/apt-key @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Add a remote key to the trusted keystore: -`wget -qO - {{https://host.tld/filename.key}} | apt-key add -` +`wget {{[-qO|--quiet --output-document]}} - {{https://host.tld/filename.key}} | apt-key add -` - Add a key from keyserver with only key ID: diff --git a/tldr/linux/arecord b/tldr/linux/arecord index 4fdf9a17..cfe57fc5 100644 --- a/tldr/linux/arecord +++ b/tldr/linux/arecord @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Record a snippet in "CD" quality (finish with `` when done): -`arecord -vv --format=cd {{path/to/file.wav}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{path/to/file.wav}}` - Record a snippet in "CD" quality, with a fixed duration of 10 seconds: -`arecord -vv --format=cd --duration={{10}} {{path/to/file.wav}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{[-d|--duration]}} {{10}} {{path/to/file.wav}}` - Record a snippet and save it as an MP3 (finish with `` when done): -`arecord -vv --format=cd --file-type raw | lame -r - {{path/to/file.mp3}}` +`arecord {{[-vv|--verbose --verbose]}} {{[-f|--format]}} cd {{[-t|--file-type]}} raw | lame -r - {{path/to/file.mp3}}` - List all sound cards and digital audio devices: -`arecord --list-devices` +`arecord {{[-l|--list-devices]}}` - Allow interactive interface (e.g. use `` or `` to play or pause): -`arecord --interactive` +`arecord {{[-i|--interactive]}}` - Test your microphone by recording a 5 second sample and playing it back: -`arecord -d 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav` +`arecord {{[-d|--duration]}} 5 test-mic.wav && aplay test-mic.wav && rm test-mic.wav` diff --git a/tldr/linux/arptables b/tldr/linux/arptables new file mode 100644 index 00000000..c3afcf97 --- /dev/null +++ b/tldr/linux/arptables @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arptables + +> Manage ARP filtering rules using the `nftables` backend. +> Part of the `xtables-nft` suite for ARP packet filtering. +> More information: . + +- List all ARP rules in the filter table: + +`sudo arptables {{[-L|--list]}}` + +- Append a rule to drop ARP packets from a specific IP address: + +`sudo arptables {{[-A|--append]}} INPUT {{[-s|--source-ip]}} {{192.168.0.1}} {{[-j|--jump]}} DROP` + +- Delete a specific rule from the INPUT chain by its rule number: + +`sudo arptables {{[-D|--delete]}} INPUT {{rule_number}}` + +- Flush all rules in the filter table: + +`sudo arptables {{[-F|--flush]}}` + +- Set the default policy of the OUTPUT chain to ACCEPT: + +`sudo arptables {{[-P|--policy]}} OUTPUT ACCEPT` + +- Save the current ARP rules to a file: + +`sudo arptables-save > {{path/to/file}}` diff --git a/tldr/linux/audit2allow b/tldr/linux/audit2allow index 0d956d53..82247775 100644 --- a/tldr/linux/audit2allow +++ b/tldr/linux/audit2allow @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a local policy to allow access for all denied services: -`sudo audit2allow --all -M {{local_policy_name}}` +`sudo audit2allow {{[-a|--all]}} -M {{local_policy_name}}` - Generate a local policy module to grant access to a specific process/service/command from the audit logs: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Install a local policy module: -`sudo semodule -i {{local_policy_name}}.pp` +`sudo semodule {{[-i|--install]}} {{local_policy_name}}.pp` diff --git a/tldr/linux/beep b/tldr/linux/beep index c6dd4d1e..cde0ac97 100644 --- a/tldr/linux/beep +++ b/tldr/linux/beep @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Play each new frequency and duration as a distinct beep: -`beep -f {{frequency}} -l {{duration}} -n -f {{frequency}} -l {{duration}}` +`beep -f {{frequency}} -l {{duration}} {{[-n|--new]}} -f {{frequency}} -l {{duration}}` - Play the C major scale: -`beep -f {{262}} -n -f {{294}} -n -f {{330}} -n -f {{349}} -n -f {{392}} -n -f {{440}} -n -f {{494}} -n -f {{523}}` +`beep -f {{262}} {{[-n|--new]}} -f {{294}} {{[-n|--new]}} -f {{330}} {{[-n|--new]}} -f {{349}} {{[-n|--new]}} -f {{392}} {{[-n|--new]}} -f {{440}} {{[-n|--new]}} -f {{494}} {{[-n|--new]}} -f {{523}}` diff --git a/tldr/linux/betterlockscreen b/tldr/linux/betterlockscreen index a71393ec..65aa3545 100644 --- a/tldr/linux/betterlockscreen +++ b/tldr/linux/betterlockscreen @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Lock the screen: -`betterlockscreen --lock` +`betterlockscreen {{[-l|--lock]}}` - Change the lock screen background: -`betterlockscreen -u {{path/to/image.png}}` +`betterlockscreen {{[-u|--update]}} {{path/to/image.png}}` - Lock the screen, showing some custom text: -`betterlockscreen -l pixel -t "{{custom lock screen text}}"` +`betterlockscreen {{[-l|--lock]}} pixel --text "{{custom lock screen text}}"` - Lock the screen, with a custom monitor off timeout in seconds: -`betterlockscreen --off {{5}} -l` +`betterlockscreen --off {{5}} {{[-l|--lock]}}` diff --git a/tldr/linux/blight b/tldr/linux/blight index 07e0e078..436abb4a 100644 --- a/tldr/linux/blight +++ b/tldr/linux/blight @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Set display brightness to 50%: -`blight set {{50}} -r` +`blight set {{50}} {{[-r|--relative]}}` - Show current display brightness: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Increase display brightness in %: -`blight inc {{number}} -r` +`blight inc {{number}} {{[-r|--relative]}}` - Decrease display brightness with internal units: diff --git a/tldr/linux/bmon b/tldr/linux/bmon index a1eeffe6..8dbc16ae 100644 --- a/tldr/linux/bmon +++ b/tldr/linux/bmon @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Display the list of all the interfaces: -`bmon -a` +`bmon {{[-a|--show-all]}}` - Display data transfer rates in bits per second: -`bmon -b` +`bmon {{[-b|--use-bit]}}` - Specify the policy to define which network interface(s) is/are displayed: -`bmon -p {{interface_1,interface_2,interface_3}}` +`bmon {{[-p|--policy]}} {{interface_1,interface_2,interface_3}}` - Specify the interval (in seconds) in which rate per counter is calculated: -`bmon -R {{2.0}}` +`bmon {{[-R|--rate-interval]}} {{2.0}}` diff --git a/tldr/linux/btrfs-filesystem b/tldr/linux/btrfs-filesystem index 93291884..e5218340 100644 --- a/tldr/linux/btrfs-filesystem +++ b/tldr/linux/btrfs-filesystem @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Defragment a single file on a btrfs filesystem (avoid while a deduplication agent is running): -`sudo btrfs filesystem defragment -v {{path/to/file}}` +`sudo btrfs filesystem defragment {{[-v|--verbose]}} {{path/to/file}}` - Defragment a directory recursively (does not cross subvolume boundaries): -`sudo btrfs filesystem defragment -v -r {{path/to/directory}}` +`sudo btrfs filesystem defragment {{[-v|--verbose]}} -r {{path/to/directory}}` - Force syncing unwritten data blocks to disk(s): @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Summarize disk usage for the files in a directory recursively: -`sudo btrfs filesystem du --summarize {{path/to/directory}}` +`sudo btrfs filesystem du {{[-s|--summarize]}} {{path/to/directory}}` diff --git a/tldr/linux/btrfs-restore b/tldr/linux/btrfs-restore index 4ebc5620..33018b82 100644 --- a/tldr/linux/btrfs-restore +++ b/tldr/linux/btrfs-restore @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List (don't write) files to be restored from a btrfs filesystem: -`sudo btrfs restore --dry-run {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs restore {{[-D|--dry-run]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` - Restore files matching a given regex ([c]ase-insensitive) files to be restored from a btrfs filesystem (all parent directories of target file(s) must match as well): @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Restore files from a btrfs filesystem (along with metadata, extended attributes, and Symlinks), overwriting files in the target: -`sudo btrfs restore --metadata --xattr --symlinks --overwrite {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs restore {{[-m|--metadata]}} {{[-x|--xattr]}} {{[-S|--symlinks]}} {{[-o|--overwrite]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` diff --git a/tldr/linux/btrfs-scrub b/tldr/linux/btrfs-scrub index c811334c..dcac2350 100644 --- a/tldr/linux/btrfs-scrub +++ b/tldr/linux/btrfs-scrub @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Start a scrub in quiet mode (does not print errors or statistics): -`sudo btrfs scrub start -q {{path/to/btrfs_mount}}` +`sudo btrfs scrub start {{[-q|--quiet]}} {{path/to/btrfs_mount}}` diff --git a/tldr/linux/cacaclock b/tldr/linux/cacaclock index ea4d42bb..4bc82cab 100644 --- a/tldr/linux/cacaclock +++ b/tldr/linux/cacaclock @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Change the font: -`cacaclock -f {{font}}` +`cacaclock {{[-f|--font]}} {{font}}` - Change the format using an `strftime` format specification: -`cacaclock -d {{strftime_arguments}}` +`cacaclock {{[-d|--dateformat]}} {{strftime_arguments}}` diff --git a/tldr/linux/conky b/tldr/linux/conky index 83c3063b..6e2b115a 100644 --- a/tldr/linux/conky +++ b/tldr/linux/conky @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a new default config: -`conky -C > ~/.conkyrc` +`conky {{[-C|--print-config]}} > ~/.conkyrc` - Launch Conky with a given configuration file: -`conky -c {{path/to/config}}` +`conky {{[-c|--config]}} {{path/to/config}}` - Start in the background (daemonize): -`conky -d` +`conky {{[-d|--daemonize]}}` - Align Conky on the desktop: -`conky -a {{top|bottom|middle}}_{{left|right|middle}}` +`conky {{[-a|--alignment]}} {{top|bottom|middle}}_{{left|right|middle}}` - Pause for 5 seconds at startup before launching: -`conky -p {{5}}` +`conky {{[-p|--pause]}} {{5}}` diff --git a/tldr/linux/conntrack b/tldr/linux/conntrack index 100a7857..cc99044e 100644 --- a/tldr/linux/conntrack +++ b/tldr/linux/conntrack @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - List all currently tracked connections: -`conntrack --dump` +`conntrack {{[-L|--dump]}}` - Display a real-time event log of connection changes: -`conntrack --event` +`conntrack {{[-E|--event]}}` - Display a real-time event log of connection changes and associated timestamps: -`conntrack --event -o timestamp` +`conntrack {{[-E|--event]}} {{[-o|--output]}} timestamp` - Display a real-time event log of connection changes for a specific IP address: -`conntrack --event --orig-src {{ip_address}}` +`conntrack {{[-E|--event]}} {{[-s|--orig-src]}} {{ip_address}}` - Delete all flows for a specific source IP address: -`conntrack --delete --orig-src {{ip_address}}` +`conntrack {{[-D|--delete]}} {{[-s|--orig-src]}} {{ip_address}}` diff --git a/tldr/linux/cpufreq-aperf b/tldr/linux/cpufreq-aperf index 9a6fa16f..e0b83925 100644 --- a/tldr/linux/cpufreq-aperf +++ b/tldr/linux/cpufreq-aperf @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Start calculating for CPU 1 only: -`sudo cpufreq-aperf -c {{1}}` +`sudo cpufreq-aperf {{[-c|--cpu]}} {{1}}` - Start calculating with a 3 second refresh interval for all CPU cores: -`sudo cpufreq-aperf -i {{3}}` +`sudo cpufreq-aperf {{[-i|--interval]}} {{3}}` - Calculate only once: -`sudo cpufreq-aperf -o` +`sudo cpufreq-aperf {{[-o|--once]}}` diff --git a/tldr/linux/cpufreq-info b/tldr/linux/cpufreq-info index 08114ea5..f9104012 100644 --- a/tldr/linux/cpufreq-info +++ b/tldr/linux/cpufreq-info @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Show CPU frequency information for the specified CPU: -`cpufreq-info -c {{cpu_number}}` +`cpufreq-info {{[-c|--cpu]}} {{cpu_number}}` - Show the allowed minimum and maximum CPU frequency: -`cpufreq-info -l` +`cpufreq-info {{[-l|--hwlimits]}}` - Show the current minimum and maximum CPU frequency and policy in table format: -`cpufreq-info -o` +`cpufreq-info {{[-o|--proc]}}` - Show available CPU frequency policies: -`cpufreq-info -g` +`cpufreq-info {{[-g|--governors]}}` - Show current CPU work frequency in a human-readable format, according to the cpufreq kernel module: -`cpufreq-info -f -m` +`cpufreq-info {{[-f|--freq]}} {{[-m|--human]}}` - Show current CPU work frequency in a human-readable format, by reading it from hardware (only available to root): -`sudo cpufreq-info -w -m` +`sudo cpufreq-info {{[-w|--hwfreq]}} {{[-m|--human]}}` diff --git a/tldr/linux/cpufreq-set b/tldr/linux/cpufreq-set index 3e0af385..1ceb6e67 100644 --- a/tldr/linux/cpufreq-set +++ b/tldr/linux/cpufreq-set @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Set the CPU frequency policy of CPU 1 to "userspace": -`sudo cpufreq-set -c {{1}} -g {{userspace}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-g|--governor]}} {{userspace}}` - Set the current minimum CPU frequency of CPU 1: -`sudo cpufreq-set -c {{1}} --min {{min_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-d|--min]}} {{min_frequency}}` - Set the current maximum CPU frequency of CPU 1: -`sudo cpufreq-set -c {{1}} --max {{max_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-u|--max]}} {{max_frequency}}` - Set the current work frequency of CPU 1: -`sudo cpufreq-set -c {{1}} -f {{work_frequency}}` +`sudo cpufreq-set {{[-c|--cpu]}} {{1}} {{[-f|--freq]}} {{work_frequency}}` diff --git a/tldr/linux/cpuid b/tldr/linux/cpuid index 7942b6a0..889d4ac2 100644 --- a/tldr/linux/cpuid +++ b/tldr/linux/cpuid @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cpuid > Display detailed information about all CPUs. -> More information: . +> More information: . - Display information for all CPUs: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Display information only for the current CPU: -`cpuid -1` +`cpuid {{[-1|--one-cpu]}}` - Display raw hex information with no decoding: -`cpuid -r` +`cpuid {{[-r|--raw]}}` diff --git a/tldr/linux/createrepo b/tldr/linux/createrepo index 53ddb129..275025b9 100644 --- a/tldr/linux/createrepo +++ b/tldr/linux/createrepo @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a repository, exclude test RPMs and display verbose logs: -`createrepo -v -x {{test_*.rpm}} {{path/to/directory}}` +`createrepo {{[-v|--verbose]}} {{[-x|--excludes]}} {{test_*.rpm}} {{path/to/directory}}` - Initialize a repository, using SHA1 as the checksum algorithm, and ignoring symbolic links: -`createrepo -S -s {{sha1}} {{path/to/directory}}` +`createrepo {{[-S|--skip-symlinks]}} {{[-s|--checksum]}} {{sha1}} {{path/to/directory}}` diff --git a/tldr/linux/dd b/tldr/linux/dd index ac4162ad..a690d133 100644 --- a/tldr/linux/dd +++ b/tldr/linux/dd @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Check the progress of an ongoing `dd` operation (run this command from another shell): -`kill -USR1 $(pgrep -x dd)` +`kill -USR1 $(pgrep {{[-x|--exact]}} dd)` diff --git a/tldr/linux/ddcutil b/tldr/linux/ddcutil index 0e4d167e..19669275 100644 --- a/tldr/linux/ddcutil +++ b/tldr/linux/ddcutil @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Change the brightness (option 0x10) of display 1 to 50%: -`ddcutil --display {{1}} setvcp {{10}} {{50}}` +`ddcutil {{[-d|--display]}} {{1}} setvcp {{10}} {{50}}` - Increase the contrast (option 0x12) of display 1 by 5%: -`ddcutil -d {{1}} setvcp {{12}} {{+}} {{5}}` +`ddcutil {{[-d|--display]}} {{1}} setvcp {{12}} {{+}} {{5}}` - Read the settings of display 1: -`ddcutil -d {{1}} getvcp {{ALL}}` +`ddcutil {{[-d|--display]}} {{1}} getvcp {{ALL}}` diff --git a/tldr/linux/dget b/tldr/linux/dget index 98aa17a9..f0881724 100644 --- a/tldr/linux/dget +++ b/tldr/linux/dget @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Download a package source tarball from its `.dsc` file but don't extract it: -`dget -d {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` +`dget {{[-d|--download-only]}} {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` diff --git a/tldr/linux/dirb b/tldr/linux/dirb index ec5305af..8140e3b6 100644 --- a/tldr/linux/dirb +++ b/tldr/linux/dirb @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dirb > Scan HTTP-based webservers for directories and files. -> More information: . +> More information: . - Scan a webserver using the default wordlist: diff --git a/tldr/linux/distrobox-create b/tldr/linux/distrobox-create index d8c42793..61a87301 100644 --- a/tldr/linux/distrobox-create +++ b/tldr/linux/distrobox-create @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Create a Distrobox container using the Ubuntu image: -`distrobox-create {{container_name}} --image {{ubuntu:latest}}` +`distrobox-create {{container_name}} {{[-i|--image]}} {{ubuntu:latest}}` - Clone a Distrobox container: -`distrobox-create --clone {{container_name}} {{cloned_container_name}}` +`distrobox-create {{[-c|--clone]}} {{container_name}} {{cloned_container_name}}` diff --git a/tldr/linux/distrobox-enter b/tldr/linux/distrobox-enter index 35548dc6..f80a8106 100644 --- a/tldr/linux/distrobox-enter +++ b/tldr/linux/distrobox-enter @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Enter a Distrobox container without instantiating a tty: -`distrobox-enter --name {{container_name}} -- {{uptime -p}}` +`distrobox-enter {{[-n|--name]}} {{container_name}} -- {{uptime --pretty}}` diff --git a/tldr/linux/distrobox-export b/tldr/linux/distrobox-export index f901f50d..ec0fb431 100644 --- a/tldr/linux/distrobox-export +++ b/tldr/linux/distrobox-export @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Export an app from the container to the host (the desktop entry/icon will show up in your host system's application list): -`distrobox-export --app {{package}} --extra-flags "--foreground"` +`distrobox-export {{[-a|--app]}} {{package}} {{[-ef|--extra-flags]}} "--foreground"` - Export a binary from the container to the host: -`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/binary_on_host}}` +`distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/binary_on_host}}` - Export a binary from the container to the host (i.e.`$HOME/.local/bin`) : -`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/export}}` +`distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/export}}` - Export a service from the container to the host (`--sudo` will run the service as root inside the container): -`distrobox-export --service {{package}} --extra-flags "--allow-newer-config" --sudo` +`distrobox-export --service {{package}} {{[-ef|--extra-flags]}} "--allow-newer-config" {{[-S|--sudo]}}` - Unexport/delete an exported application: -`distrobox-export --app {{package}} --delete` +`distrobox-export {{[-a|--app]}} {{package}} {{[-d|--delete]}}` diff --git a/tldr/linux/distrobox-list b/tldr/linux/distrobox-list index fb1e9ab2..99d5d6cc 100644 --- a/tldr/linux/distrobox-list +++ b/tldr/linux/distrobox-list @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - List all Distrobox containers with verbose information: -`distrobox-list --verbose` +`distrobox-list {{[-v|--verbose]}}` diff --git a/tldr/linux/distrobox-rm b/tldr/linux/distrobox-rm index d144e50f..eee969c3 100644 --- a/tldr/linux/distrobox-rm +++ b/tldr/linux/distrobox-rm @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Remove a Distrobox container forcefully: -`distrobox-rm {{container_name}} --force` +`distrobox-rm {{container_name}} {{[-f|--force]}}` diff --git a/tldr/linux/distrobox-stop b/tldr/linux/distrobox-stop index 3b30b4ba..39debe05 100644 --- a/tldr/linux/distrobox-stop +++ b/tldr/linux/distrobox-stop @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Stop a Distrobox container non-interactively (without confirmation): -`distrobox-stop --name {{container_name}} --yes` +`distrobox-stop {{[-n|--name]}} {{container_name}} {{[-Y|--yes]}}` diff --git a/tldr/linux/distrobox-upgrade b/tldr/linux/distrobox-upgrade index 5a5f6482..a28ee2f7 100644 --- a/tldr/linux/distrobox-upgrade +++ b/tldr/linux/distrobox-upgrade @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade all containers using the container's native package managers: -`distrobox-upgrade --all` +`distrobox-upgrade {{[-a|--all]}}` - Upgrade specific containers via the container's native package manager: diff --git a/tldr/linux/dmesg b/tldr/linux/dmesg index 0f9f8787..6120319b 100644 --- a/tldr/linux/dmesg +++ b/tldr/linux/dmesg @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo dmesg {{[-l|--level]}} err` -- Show kernel messages and keep reading new ones, similar to `tail -f` (available in kernels 3.5.0 and newer): +- Show kernel messages and keep reading new ones, similar to `tail --follow` (available in kernels 3.5.0 and newer): `sudo dmesg {{[-w|--follow]}}` diff --git a/tldr/linux/dmidecode b/tldr/linux/dmidecode index 566c6256..b7eeafb7 100644 --- a/tldr/linux/dmidecode +++ b/tldr/linux/dmidecode @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Show the BIOS version: -`sudo dmidecode -s bios-version` +`sudo dmidecode {{[-s|--string]}} bios-version` - Show the system's serial number: -`sudo dmidecode -s system-serial-number` +`sudo dmidecode {{[-s|--string]}} system-serial-number` - Show BIOS information: -`sudo dmidecode -t bios` +`sudo dmidecode {{[-t|--type]}} bios` - Show CPU information: -`sudo dmidecode -t processor` +`sudo dmidecode {{[-t|--type]}} processor` - Show memory information: -`sudo dmidecode -t memory` +`sudo dmidecode {{[-t|--type]}} memory` diff --git a/tldr/linux/dnsrecon b/tldr/linux/dnsrecon index b7a86329..ec50fbcf 100644 --- a/tldr/linux/dnsrecon +++ b/tldr/linux/dnsrecon @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Scan a domain and save the results to an SQLite database: -`dnsrecon --domain {{example.com}} --db {{path/to/database.sqlite}}` +`dnsrecon {{[-d|--domain]}} {{example.com}} --db {{path/to/database.sqlite}}` - Scan a domain, specifying the nameserver and performing a zone transfer: -`dnsrecon --domain {{example.com}} --name_server {{nameserver.example.com}} --type axfr` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-n|--name_server]}} {{nameserver.example.com}} {{[-t|--type]}} axfr` - Scan a domain, using a brute-force attack and a dictionary of subdomains and hostnames: -`dnsrecon --domain {{example.com}} --dictionary {{path/to/dictionary.txt}} --type brt` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-D|--dictionary]}} {{path/to/dictionary.txt}} {{[-t|--type]}} brt` - Scan a domain, performing a reverse lookup of IP ranges from the SPF record and saving the results to a JSON file: -`dnsrecon --domain {{example.com}} -s --json` +`dnsrecon {{[-d|--domain]}} {{example.com}} -s {{[-j|--json]}}` - Scan a domain, performing a Google enumeration and saving the results to a CSV file: -`dnsrecon --domain {{example.com}} -g --csv` +`dnsrecon {{[-d|--domain]}} {{example.com}} -g {{[-c|--csv]}}` - Scan a domain, performing DNS cache snooping: -`dnsrecon --domain {{example.com}} --type snoop --name_server {{nameserver.example.com}} --dictionary {{path/to/dictionary.txt}}` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-t|--type]}} snoop {{[-n|--name_server]}} {{nameserver.example.com}} {{[-D|--dictionary]}} {{path/to/dictionary.txt}}` - Scan a domain, performing zone walking: -`dnsrecon --domain {{example.com}} --type zonewalk` +`dnsrecon {{[-d|--domain]}} {{example.com}} {{[-t|--type]}} zonewalk` diff --git a/tldr/linux/dpkg b/tldr/linux/dpkg index ba6af6ee..332ce79f 100644 --- a/tldr/linux/dpkg +++ b/tldr/linux/dpkg @@ -12,28 +12,28 @@ source: https://github.com/tldr-pages/tldr.git - Install a package: -`dpkg -i {{path/to/file.deb}}` +`dpkg {{[-i|--install]}} {{path/to/file.deb}}` - Remove a package: -`dpkg -r {{package}}` +`dpkg {{[-r|--remove]}} {{package}}` - List installed packages: -`dpkg -l {{pattern}}` +`dpkg {{[-l|--list]}} {{pattern}}` - List a package's contents: -`dpkg -L {{package}}` +`dpkg {{[-L|--listfiles]}} {{package}}` - List contents of a local package file: -`dpkg -c {{path/to/file.deb}}` +`dpkg {{[-c|--contents]}} {{path/to/file.deb}}` - Find out which package owns a file: -`dpkg -S {{path/to/file}}` +`dpkg {{[-S|--search]}} {{path/to/file}}` - Purge an installed or already removed package, including configuration: -`dpkg -P {{package}}` +`dpkg {{[-P|--purge]}} {{package}}` diff --git a/tldr/linux/dunstify b/tldr/linux/dunstify index 905b494f..fd321173 100644 --- a/tldr/linux/dunstify +++ b/tldr/linux/dunstify @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Show a notification with specified urgency: -`dunstify "{{Title}}" "{{Message}}" -u {{low|normal|critical}}` +`dunstify "{{Title}}" "{{Message}}" {{[-u|--urgency]}} {{low|normal|critical}}` - Specify a message ID (overwrites any previous messages with the same ID): -`dunstify "{{Title}}" "{{Message}}" -r {{123}}` +`dunstify "{{Title}}" "{{Message}}" {{[-r|--replace]}} {{123}}` - Display help: -`dunstify --help` +`dunstify {{[-?|--help]}}` diff --git a/tldr/linux/eclean-kernel b/tldr/linux/eclean-kernel new file mode 100644 index 00000000..c9e99813 --- /dev/null +++ b/tldr/linux/eclean-kernel @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eclean-kernel + +> Remove old kernels in Gentoo. +> More information: . + +- List all kernel files: + +`sudo eclean-kernel {{[-l|--list-kernels]}}` + +- Remove all kernels except for the two newest ones: + +`sudo eclean-kernel {{[-n|--num]}} 2` + +- Remove all kernels except for the two newest ones and ask before removal: + +`sudo eclean-kernel {{[-a|--all]}} {{[-n|--num]}} 2` diff --git a/tldr/linux/edquota b/tldr/linux/edquota index 8df490af..bfdc6a08 100644 --- a/tldr/linux/edquota +++ b/tldr/linux/edquota @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Edit quota of the current user: -`edquota --user $(whoami)` +`edquota {{[-u|--user]}} $(whoami)` - Edit quota of a specific user: -`sudo edquota --user {{username}}` +`sudo edquota {{[-u|--user]}} {{username}}` - Edit quota for a group: -`sudo edquota --group {{group}}` +`sudo edquota {{[-g|--group]}} {{group}}` - Restrict operations to a given filesystem (by default edquota operates on all filesystems with quotas): -`sudo edquota --file-system {{filesystem}}` +`sudo edquota {{[-f|--file-system]}} {{filesystem}}` - Edit the default grace period: -`sudo edquota -t` +`sudo edquota {{[-t|--edit-period]}}` - Duplicate a quota to other users: -`sudo edquota -p {{reference_user}} {{destination_user1}} {{destination_user2}}` +`sudo edquota {{[-p|--prototype]}} {{reference_user}} {{destination_user1}} {{destination_user2}}` diff --git a/tldr/linux/envycontrol b/tldr/linux/envycontrol index f6b9a250..56264eb4 100644 --- a/tldr/linux/envycontrol +++ b/tldr/linux/envycontrol @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Switch between different GPU modes: -`sudo envycontrol -s {{nvidia|integrated|hybrid}}` +`sudo envycontrol {{[-s|--switch]}} {{nvidia|integrated|hybrid}}` - Specify your display manager manually: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Check current GPU mode: -`sudo envycontrol --query` +`sudo envycontrol {{[-q|--query]}}` - Reset settings: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`envycontrol --help` +`envycontrol {{[-h|--help]}}` - Display version: -`envycontrol --version` +`envycontrol {{[-v|--version]}}` diff --git a/tldr/linux/ethtool b/tldr/linux/ethtool index 69d0f2dc..e0f322cb 100644 --- a/tldr/linux/ethtool +++ b/tldr/linux/ethtool @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Display the driver information for an interface: -`ethtool --driver {{eth0}}` +`ethtool {{[-i|--driver]}} {{eth0}}` - Display all supported features for an interface: -`ethtool --show-features {{eth0}}` +`ethtool {{[-k|--show-features]}} {{eth0}}` - Display the network usage statistics for an interface: -`ethtool --statistics {{eth0}}` +`ethtool {{[-S|--statistics]}} {{eth0}}` - Blink one or more LEDs on an interface for 10 seconds: -`ethtool --identify {{eth0}} {{10}}` +`ethtool {{[-p|--identify]}} {{eth0}} {{10}}` - Set the link speed, duplex mode, and parameter auto-negotiation for a given interface: -`ethtool -s {{eth0}} speed {{10|100|1000}} duplex {{half|full}} autoneg {{on|off}}` +`ethtool {{[-s|--change]}} {{eth0}} speed {{10|100|1000}} duplex {{half|full}} autoneg {{on|off}}` diff --git a/tldr/linux/eww b/tldr/linux/eww index f9f29db7..7e7e0633 100644 --- a/tldr/linux/eww +++ b/tldr/linux/eww @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Open a widget: -`eww -c {{path/to/source_code_directory}} open {{window_name}}` +`eww {{[-c|--config]}} {{path/to/source_code_directory}} open {{window_name}}` - Close a widget: -`eww -c {{path/to/source_code_directory}} close {{window_name}}` +`eww {{[-c|--config]}} {{path/to/source_code_directory}} close {{window_name}}` - Reload the configuration: diff --git a/tldr/linux/expac b/tldr/linux/expac index 0ffb29b6..4ce03b0f 100644 --- a/tldr/linux/expac +++ b/tldr/linux/expac @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - List the dependencies of a package: -`expac -S '%D' {{package}}` +`expac {{[-S|--sync]}} '%D' {{package}}` - List the optional dependencies of a package: -`expac -S "%o" {{package}}` +`expac {{[-S|--sync]}} "%o" {{package}}` - List the download size of packages in MiB: -`expac -S -H M '%k %n' {{package1 package2 ...}}` +`expac {{[-S|--sync]}} {{[-H|--humansize]}} M '%k %n' {{package1 package2 ...}}` - List packages marked for upgrade with their download size: -`expac -S -H M '%k %n' $(pacman -Qqu) | sort -sh` +`expac {{[-S|--sync]}} {{[-H|--humansize]}} M '%k %n' $(pacman -Qqu) | sort {{[-sh|--sort --human-numeric-sort]}}` - List explicitly-installed packages with their optional dependencies: -`expac -d ' +`expac {{[-d|--delim]}} ' -' -l ' - ' -Q '%n +' {{[-l|listdelim]}} ' + ' {{[-Q|--query]}} '%n %O' $(pacman -Qeq)` diff --git a/tldr/linux/fakeroot b/tldr/linux/fakeroot index d6eaa5a1..2ba75ad4 100644 --- a/tldr/linux/fakeroot +++ b/tldr/linux/fakeroot @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Run a command keeping the real ownership of files instead of pretending they are owned by root: -`fakeroot --unknown-is-real -- {{command}} {{command_arguments}}` +`fakeroot {{[-u|--unknown-is-real]}} -- {{command}} {{command_arguments}}` - Display help: -`fakeroot --help` +`fakeroot {{[-h|--help]}}` diff --git a/tldr/linux/fcrackzip b/tldr/linux/fcrackzip index 2ece95cb..7fce6581 100644 --- a/tldr/linux/fcrackzip +++ b/tldr/linux/fcrackzip @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Brute-force a password with a length of 4 to 8 characters, and contains only alphanumeric characters (order matters): -`fcrackzip --brute-force --length 4-8 --charset aA1 {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 4-8 {{[-c|--charset]}} aA1 {{archive}}` - Brute-force a password in verbose mode with a length of 3 characters that only contains lowercase characters, `$` and `%`: -`fcrackzip -v --brute-force --length 3 --charset a:$% {{archive}}` +`fcrackzip {{[-v|--verbose]}} {{[-b|--brute-force]}} {{[-l|--length]}} 3 {{[-c|--charset]}} a:$% {{archive}}` - Brute-force a password that contains only lowercase and special characters: -`fcrackzip --brute-force --length 4 --charset a! {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 4 {{[-c|--charset]}} a! {{archive}}` - Brute-force a password containing only digits, starting from the password `12345`: -`fcrackzip --brute-force --length 5 --charset 1 --init-password 12345 {{archive}}` +`fcrackzip {{[-b|--brute-force]}} {{[-l|--length]}} 5 {{[-c|--charset]}} 1 {{[-p|--init-password]}} 12345 {{archive}}` - Crack a password using a wordlist: -`fcrackzip --use-unzip --dictionary --init-password {{wordlist}} {{archive}}` +`fcrackzip {{[-u|--use-unzip]}} {{[-D|--dictionary]}} {{[-p|--init-password]}} {{wordlist}} {{archive}}` - Benchmark cracking performance: -`fcrackzip --benchmark` +`fcrackzip {{[-B|--benchmark]}}` diff --git a/tldr/linux/file-rename b/tldr/linux/file-rename index 2e7de773..8c96f91b 100644 --- a/tldr/linux/file-rename +++ b/tldr/linux/file-rename @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--nono]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: -`rename -f {{'s/foo/bar/'}} {{*}}` +`rename {{[-f|--force]}} {{'s/foo/bar/'}} {{*}}` - Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): diff --git a/tldr/linux/flashrom b/tldr/linux/flashrom index 3cb131b9..fe88af54 100644 --- a/tldr/linux/flashrom +++ b/tldr/linux/flashrom @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Probe the chip, ensuring the wiring is correct: -`flashrom --programmer {{programmer}}` +`flashrom {{[-p|--programmer]}} {{programmer}}` - Read flash and save it to a file: -`flashrom -p {{programmer}} --read {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-r|--read]}} {{path/to/file}}` - Write a file to the flash: -`flashrom -p {{programmer}} --write {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-w|--write]}} {{path/to/file}}` - Verify the flash against a file: -`flashrom -p {{programmer}} --verify {{path/to/file}}` +`flashrom {{[-p|--programmer]}} {{programmer}} {{[-v|--verify]}} {{path/to/file}}` - Probe the chip using Raspberry Pi: -`flashrom -p {{linux_spi:dev=/dev/spidev0.0}}` +`flashrom {{[-p|--programmer]}} {{linux_spi:dev=/dev/spidev0.0}}` diff --git a/tldr/linux/foreman b/tldr/linux/foreman index dbfd1074..e61730c0 100644 --- a/tldr/linux/foreman +++ b/tldr/linux/foreman @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Start an application with a specified Procfile: -`foreman start -f {{Procfile}}` +`foreman start {{[-f|--procfile]}} {{Procfile}}` - Start a specific application: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Start all processes except the one named "worker": -`foreman start -m all=1,{{worker}}=0` +`foreman start {{[-m|--formation]}} all=1,{{worker}}=0` diff --git a/tldr/linux/fuzzel b/tldr/linux/fuzzel index daf2528c..958bc5ce 100644 --- a/tldr/linux/fuzzel +++ b/tldr/linux/fuzzel @@ -35,7 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Reset apps usage count (default cache directory: `$XDG_CACHE_HOME/fuzzel`): -`rm -v $HOME/.cache/fuzzel` +`rm {{[-v|--verbose]}} $HOME/.cache/fuzzel` - Launch `fuzzel` on a specific monitor, see `wlr-randr` or `swaymsg -t get_outputs`: diff --git a/tldr/linux/genie b/tldr/linux/genie index feafb474..e6888cc9 100644 --- a/tldr/linux/genie +++ b/tldr/linux/genie @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Initialize the bottle (run once, at start): -`genie -i` +`genie {{[-i|--initialize]}}` - Run a login shell inside the bottle: -`genie -s` +`genie {{[-s|--shell]}}` - Run a specified command inside the bottle: -`genie -c {{command}}` +`genie {{[-c|--command]}} {{command}}` diff --git a/tldr/linux/getfattr b/tldr/linux/getfattr index d37a8876..d268a885 100644 --- a/tldr/linux/getfattr +++ b/tldr/linux/getfattr @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Retrieve all extended attributes of a file and display them in a detailed format: -`getfattr -d {{path/to/file}}` +`getfattr {{[-d|--dump]}} {{path/to/file}}` - Get a specific attribute of a file: -`getfattr -n user.{{attribute_name}} {{path/to/file}}` +`getfattr {{[-n|--name]}} user.{{attribute_name}} {{path/to/file}}` diff --git a/tldr/linux/goaccess b/tldr/linux/goaccess index 11650d2b..aa84f8d5 100644 --- a/tldr/linux/goaccess +++ b/tldr/linux/goaccess @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Analyze a log from `stdin`: -`tail -f {{path/to/logfile}} | goaccess -` +`tail {{[-f|--follow]}} {{path/to/logfile}} | goaccess -` - Analyze a log and write it to an HTML file in real-time: -`goaccess {{path/to/logfile}} --output {{path/to/file.html}} --real-time-html` +`goaccess {{path/to/logfile}} {{[-o|--output]}} {{path/to/file.html}} --real-time-html` diff --git a/tldr/linux/hardinfo b/tldr/linux/hardinfo index c701a197..332ca740 100644 --- a/tldr/linux/hardinfo +++ b/tldr/linux/hardinfo @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Print report to `stdout`: -`hardinfo -r` +`hardinfo {{[-r|--generate-report]}}` - Save report to HTML file: -`hardinfo -r -f html > hardinfo.html` +`hardinfo {{[-r|--generate-report]}} {{[-f|--report-format]}} html > hardinfo.html` diff --git a/tldr/linux/hollywood b/tldr/linux/hollywood index 8db4ea3e..c06229b2 100644 --- a/tldr/linux/hollywood +++ b/tldr/linux/hollywood @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`hollywood -h` +`hollywood {{[-h|--help]}}` diff --git a/tldr/linux/ifdown b/tldr/linux/ifdown index 5f73d690..28bf01d6 100644 --- a/tldr/linux/ifdown +++ b/tldr/linux/ifdown @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Disable all interfaces which are enabled: -`ifdown -a` +`ifdown {{[-a|--all]}}` diff --git a/tldr/linux/ifup b/tldr/linux/ifup index c8fa55b2..7d0cb30e 100644 --- a/tldr/linux/ifup +++ b/tldr/linux/ifup @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Enable all the interfaces defined with "auto" in `/etc/network/interfaces`: -`ifup -a` +`ifup {{[-a|--all]}}` diff --git a/tldr/linux/imgp b/tldr/linux/imgp index a0c00f05..0cf06205 100644 --- a/tldr/linux/imgp +++ b/tldr/linux/imgp @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Convert single images and/or whole directories containing valid image formats: -`imgp -x {{1366x1000}} {{path/to/directory}} {{path/to/file}}` +`imgp {{[-x|--res]}} {{1366x1000}} {{path/to/directory}} {{path/to/file}}` - Scale an image by 75% and overwrite the source image to a target resolution: -`imgp -x {{75}} -w {{path/to/file}}` +`imgp {{[-x|--res]}} {{75}} z-w {{path/to/file}}` - Rotate an image clockwise by 90 degrees: -`imgp -o {{90}} {{path/to/file}}` +`imgp {{[-o|--rotate]}} {{90}} {{path/to/file}}` diff --git a/tldr/linux/iostat b/tldr/linux/iostat index 77b50803..d440bfc4 100644 --- a/tldr/linux/iostat +++ b/tldr/linux/iostat @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Display CPU statistics: -`iostat {{[-c|--compact]}}` +`iostat -c` - Display disk statistics with disk names (including LVM): diff --git a/tldr/linux/kexec b/tldr/linux/kexec index 3c7240f2..0e05be27 100644 --- a/tldr/linux/kexec +++ b/tldr/linux/kexec @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Load a new kernel: -`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --command-line={{arguments}}` +`kexec {{[-l|--load]}} {{path/to/kernel}} --initrd={{path/to/initrd}} --command-line={{arguments}}` - Load a new kernel with current boot parameters: -`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --reuse-cmdline` +`kexec {{[-l|--load]}} {{path/to/kernel}} --initrd={{path/to/initrd}} --reuse-cmdline` - Execute a currently loaded kernel: -`kexec -e` +`kexec {{[-e|--exec]}}` - Unload current kexec target kernel: -`kexec -u` +`kexec {{[-u|--unload]}}` diff --git a/tldr/linux/knock b/tldr/linux/knock index 1e461190..53d3fc2c 100644 --- a/tldr/linux/knock +++ b/tldr/linux/knock @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Knock on port using UDP: -`knock -u {{hostname}} {{portnumber}}` +`knock {{[-u|--udp]}} {{hostname}} {{portnumber}}` - Force usage of IPv4/IPv6: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display errors and details of connection: -`knock -v {{hostname}} {{portnumber}}` +`knock {{[-v|--verbose]}} {{hostname}} {{portnumber}}` diff --git a/tldr/linux/knockd b/tldr/linux/knockd index 28dc3792..c9c100c1 100644 --- a/tldr/linux/knockd +++ b/tldr/linux/knockd @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Start knockd system daemon: -`knockd -d` +`knockd {{[-d|--daemon]}}` - Use specified configuration file for knockd: -`knockd -c {{path/to/file}}.configuration` +`knockd {{[-c|--config]}} {{path/to/file}}.configuration` diff --git a/tldr/linux/konsave b/tldr/linux/konsave index e6519b13..72c91296 100644 --- a/tldr/linux/konsave +++ b/tldr/linux/konsave @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Save the current configuration as a profile: -`konsave --save {{profile_name}}` +`konsave {{[-s|--save]}} {{profile_name}}` - Apply a profile: -`konsave --apply {{profile_name}}` +`konsave {{[-a|--apply]}} {{profile_name}}` - Save the current configuration as a profile, overwriting existing profiles if they exist with the same name: -`konsave -s {{profile_name}} --force` +`konsave {{[-s|--save]}} {{profile_name}} {{[-f|--force]}}` - List all profiles: -`konsave --list` +`konsave {{[-l|--list]}}` - Remove a profile: -`konsave --remove {{profile_name}}` +`konsave {{[-r|--remove]}} {{profile_name}}` - Export a profile as a `.knsv` to the home directory: -`konsave --export-profile {{profile_name}}` +`konsave {{[-e|--export-profile]}} {{profile_name}}` - Import a `.knsv` profile: -`konsave --import-profile {{path/to/profile_name.knsv}}` +`konsave {{[-i|--import-profile]}} {{path/to/profile_name.knsv}}` diff --git a/tldr/linux/ldconfig b/tldr/linux/ldconfig index 5cb56396..c5876f28 100644 --- a/tldr/linux/ldconfig +++ b/tldr/linux/ldconfig @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Print the libraries in the cache and check whether a given library is present: -`ldconfig -p | grep {{library_name}}` +`ldconfig {{[-p|--print-cache]}} | grep {{library_name}}` diff --git a/tldr/linux/logger b/tldr/linux/logger index 59419aa0..3a256bbc 100644 --- a/tldr/linux/logger +++ b/tldr/linux/logger @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # logger -> Add messages to syslog (/var/log/syslog). +> Add messages to the system log. > More information: . - Log a message to syslog: diff --git a/tldr/linux/lsb_release b/tldr/linux/lsb_release index 0a23b992..d1c0fdb6 100644 --- a/tldr/linux/lsb_release +++ b/tldr/linux/lsb_release @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Print all available information: -`lsb_release -a` +`lsb_release {{[-a|--all]}}` - Print a description (usually the full name) of the operating system: -`lsb_release -d` +`lsb_release {{[-d|--description]}}` - Print only the operating system name (ID), suppressing the field name: -`lsb_release -i -s` +`lsb_release {{[-is|--id --short]}}` - Print the release number and codename of the distribution, suppressing the field names: -`lsb_release -rcs` +`lsb_release {{[-rcs|--release --codename --short]}}` diff --git a/tldr/linux/lsfd b/tldr/linux/lsfd index eb5362d1..4675344d 100644 --- a/tldr/linux/lsfd +++ b/tldr/linux/lsfd @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - List open IPv4 or IPv6 sockets: -`lsfd -i{{4|6}}` +`lsfd {{-i4|-i6}}` - Display help: diff --git a/tldr/linux/lsscsi b/tldr/linux/lsscsi index 398c493d..b7f60b4b 100644 --- a/tldr/linux/lsscsi +++ b/tldr/linux/lsscsi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lsscsi > List SCSI devices (or hosts) and their attributes. -> More information: . +> More information: . - List all SCSI devices: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - List all SCSI devices with detailed attributes: -`lsscsi -L` +`lsscsi {{[-L|--list]}}` - List all SCSI devices with human-readable disk capacity: -`lsscsi -s` +`lsscsi {{[-s|--size]}}` diff --git a/tldr/linux/ltrace b/tldr/linux/ltrace index 2f92ac83..f60a29a7 100644 --- a/tldr/linux/ltrace +++ b/tldr/linux/ltrace @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Write to file instead of terminal: -`ltrace -o {{file}} {{path/to/program}}` +`ltrace {{[-o|--output]}} {{file}} {{path/to/program}}` diff --git a/tldr/linux/lvcreate b/tldr/linux/lvcreate index cf0230da..770cdf88 100644 --- a/tldr/linux/lvcreate +++ b/tldr/linux/lvcreate @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a logical volume of 10 gigabytes in the volume group vg1: -`lvcreate -L {{10G}} {{vg1}}` +`lvcreate {{[-L|--size]}} {{10G}} {{vg1}}` - Create a 1500 megabyte linear logical volume named mylv in the volume group vg1: -`lvcreate -L {{1500}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-L|--size]}} {{1500}} {{[-n|--name]}} {{mylv}} {{vg1}}` - Create a logical volume called mylv that uses 60% of the total space in volume group vg1: -`lvcreate -l {{60%VG}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-l|--extents]}} {{60%VG}} {{[-n|--name]}} {{mylv}} {{vg1}}` - Create a logical volume called mylv that uses all the unallocated space in the volume group vg1: -`lvcreate -l {{100%FREE}} -n {{mylv}} {{vg1}}` +`lvcreate {{[-l|--extents]}} {{100%FREE}} {{[-n|--name]}} {{mylv}} {{vg1}}` diff --git a/tldr/linux/lvextend b/tldr/linux/lvextend index 1c783c84..a7f8a7e7 100644 --- a/tldr/linux/lvextend +++ b/tldr/linux/lvextend @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Increase a volume's size to 120 GB: -`lvextend --size {{120G}} {{logical_volume}}` +`lvextend {{[-L|--size]}} {{120G}} {{logical_volume}}` - Increase a volume's size by 40 GB as well as the underlying filesystem: -`lvextend --size +{{40G}} -r {{logical_volume}}` +`lvextend {{[-L|--size]}} +{{40G}} {{[-r|--resizefs]}} {{logical_volume}}` - Increase a volume's size to 100% of the free physical volume space: -`lvextend --size +{{100}}%FREE {{logical_volume}}` +`lvextend {{[-L|--size]}} +{{100}}%FREE {{logical_volume}}` diff --git a/tldr/linux/lvreduce b/tldr/linux/lvreduce index f815958e..e4b6245c 100644 --- a/tldr/linux/lvreduce +++ b/tldr/linux/lvreduce @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Reduce a volume's size to 120 GB: -`lvreduce --size {{120G}} {{logical_volume}}` +`lvreduce {{[-L|--size]}} {{120G}} {{logical_volume}}` - Reduce a volume's size by 40 GB as well as the underlying filesystem: -`lvreduce --size -{{40G}} -r {{logical_volume}}` +`lvreduce {{[-L|--size]}} -{{40G}} {{[-r|--resizefs]}} {{logical_volume}}` diff --git a/tldr/linux/lvs b/tldr/linux/lvs index cabc5a1b..1071fb30 100644 --- a/tldr/linux/lvs +++ b/tldr/linux/lvs @@ -15,19 +15,19 @@ source: https://github.com/tldr-pages/tldr.git - Display all logical volumes: -`lvs -a` +`lvs {{[-a|--all]}}` - Change default display to show more details: -`lvs -v` +`lvs {{[-v|--verbose]}}` - Display only specific fields: -`lvs -o {{field_name_1}},{{field_name_2}}` +`lvs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`lvs -o +{{field_name}}` +`lvs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/tldr/linux/lxterminal b/tldr/linux/lxterminal index b2425fad..e7bb4d3b 100644 --- a/tldr/linux/lxterminal +++ b/tldr/linux/lxterminal @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Open an LXTerminal window, run a command, and then exit: -`lxterminal -e "{{command}}"` +`lxterminal {{[-e|--command]}} "{{command}}"` - Open an LXTerminal window with multiple tabs: diff --git a/tldr/linux/mkfs.btrfs b/tldr/linux/mkfs.btrfs index 9bb44b98..cfabb36d 100644 --- a/tldr/linux/mkfs.btrfs +++ b/tldr/linux/mkfs.btrfs @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a btrfs filesystem on a single device: -`sudo mkfs.btrfs --metadata single --data single {{/dev/sdX}}` +`sudo mkfs.btrfs {{[-m|--metadata]}} single {{[-d|--data]}} single {{/dev/sdX}}` - Create a btrfs filesystem on multiple devices with raid1: -`sudo mkfs.btrfs --metadata raid1 --data raid1 {{/dev/sdX /dev/sdY /dev/sdZ ...}}` +`sudo mkfs.btrfs {{[-m|--metadata]}} raid1 {{[-d|--data]}} raid1 {{/dev/sdX /dev/sdY /dev/sdZ ...}}` - Set a label for the filesystem: -`sudo mkfs.btrfs --label "{{label}}" {{/dev/sdX /dev/sdY ...}}` +`sudo mkfs.btrfs {{[-L|--label]}} "{{label}}" {{/dev/sdX /dev/sdY ...}}` diff --git a/tldr/linux/mkfs.ntfs b/tldr/linux/mkfs.ntfs index 511bf07f..56407c44 100644 --- a/tldr/linux/mkfs.ntfs +++ b/tldr/linux/mkfs.ntfs @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Create filesystem with a volume-label: -`mkfs.ntfs -L {{volume_label}} {{/dev/sdXY}}` +`mkfs.ntfs {{[-L|--label]}} {{volume_label}} {{/dev/sdXY}}` - Create filesystem with specific UUID: -`mkfs.ntfs -U {{UUID}} {{/dev/sdXY}}` +`mkfs.ntfs {{[-U|--with-uuid]}} {{UUID}} {{/dev/sdXY}}` diff --git a/tldr/linux/mopac b/tldr/linux/mopac index c9baff7e..0603e4cc 100644 --- a/tldr/linux/mopac +++ b/tldr/linux/mopac @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git #comment H 0.95506 0.05781 -0.03133 -F 1.89426 0.05781 -0.03133" > test.mop; mopac test.mop & tail -f test.out` +F 1.89426 0.05781 -0.03133" > test.mop; mopac test.mop & tail {{[-f|--follow]}} test.out` diff --git a/tldr/linux/ncat b/tldr/linux/ncat index 3d471149..6fa0c255 100644 --- a/tldr/linux/ncat +++ b/tldr/linux/ncat @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Listen for input on the specified port and write it to the specified file: -`ncat -l {{port}} > {{path/to/file}}` +`ncat {{[-l|--listen]}} {{port}} > {{path/to/file}}` - Accept multiple connections and keep ncat open after they have been closed: -`ncat -lk {{port}}` +`ncat {{[-lk|--listen --keep-open]}} {{port}}` - Write output of specified file to the specified host on the specified port: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Accept multiple incoming connections on an encrypted channel evading detection of traffic content: -`ncat --ssl -k -l {{port}}` +`ncat --ssl {{[-k|--keep-open]}} {{[-l|--listen]}} {{port}}` - Connect to an open `ncat` connection over SSL: @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Check connectivity to a remote host on a particular port with timeout: -`ncat -w {{seconds}} -vz {{host}} {{port}}` +`ncat {{[-w|--wait]}} {{seconds}} {{[-vz|--verbose -z]}} {{host}} {{port}}` diff --git a/tldr/linux/netselect-apt b/tldr/linux/netselect-apt index e7d7f514..fb5d3d7c 100644 --- a/tldr/linux/netselect-apt +++ b/tldr/linux/netselect-apt @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Include non-free section: -`sudo netselect-apt --non-free` +`sudo netselect-apt {{[-n|--non-free]}}` - Specify a country for the mirror list lookup: -`sudo netselect-apt -c {{India}}` +`sudo netselect-apt {{[-c|--country]}} {{India}}` diff --git a/tldr/linux/nixos-option b/tldr/linux/nixos-option index 48292d0c..f7cf7cda 100644 --- a/tldr/linux/nixos-option +++ b/tldr/linux/nixos-option @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Show recursively all values of a user: -`nixos-option -r users.users.{{user}}` +`nixos-option {{[-r|--recursive]}} users.users.{{user}}` diff --git a/tldr/linux/nixos-rebuild b/tldr/linux/nixos-rebuild index bb6b2a17..bc9b875c 100644 --- a/tldr/linux/nixos-rebuild +++ b/tldr/linux/nixos-rebuild @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Build and switch to the new configuration, making it the boot default and naming the boot entry: -`sudo nixos-rebuild switch -p {{name}}` +`sudo nixos-rebuild switch {{[-p|--profile-name]}} {{name}}` - Build and switch to the new configuration, making it the boot default and installing updates: diff --git a/tldr/linux/notify-send b/tldr/linux/notify-send index 6a935830..3077d829 100644 --- a/tldr/linux/notify-send +++ b/tldr/linux/notify-send @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Show a notification with a custom icon: -`notify-send -i {{icon.png}} "{{Test}}" "{{This is a test}}"` +`notify-send {{[-i|--icon]}} {{icon.png}} "{{Test}}" "{{This is a test}}"` - Show a notification for 5 seconds: -`notify-send -t 5000 "{{Test}}" "{{This is a test}}"` +`notify-send {{[-t|--expire-time]}} 5000 "{{Test}}" "{{This is a test}}"` - Show a notification with an app's icon and name: -`notify-send "{{Test}}" --icon={{google-chrome}} --app-name="{{Google Chrome}}"` +`notify-send "{{Test}}" {{[-i|--icon]}} {{google-chrome}} {{[-a|--app-name]}} "{{Google Chrome}}"` diff --git a/tldr/linux/nsxiv b/tldr/linux/nsxiv index 223f8ecc..296fe30e 100644 --- a/tldr/linux/nsxiv +++ b/tldr/linux/nsxiv @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Search directories recursively for images to view: -`nsxiv -r {{path/to/directory1 path/to/directory2 ...}}` +`nsxiv {{[-r|--recursive]}} {{path/to/directory1 path/to/directory2 ...}}` - Quit nsxiv: diff --git a/tldr/linux/paccache b/tldr/linux/paccache index ffd77e06..030c92bf 100644 --- a/tldr/linux/paccache +++ b/tldr/linux/paccache @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Remove all but the 3 most recent package versions from the `pacman` cache: -`paccache -r` +`paccache {{[-r|--remove]}}` - Set the number of package versions to keep: -`paccache -rk {{num_versions}}` +`paccache {{[-rk|--remove --keep]}} {{num_versions}}` - Perform a dry-run and show the number of candidate packages for deletion: -`paccache -d` +`paccache {{[-d|--dryrun]}}` - Move candidate packages to a directory instead of deleting them: -`paccache -m {{path/to/directory}}` +`paccache {{[-m|--move]}} {{path/to/directory}}` diff --git a/tldr/linux/pacdiff b/tldr/linux/pacdiff index 76edf31d..ef1327a1 100644 --- a/tldr/linux/pacdiff +++ b/tldr/linux/pacdiff @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Use sudo and sudoedit to remove and merge files: -`pacdiff --sudo` +`pacdiff {{[-s|--sudo]}}` - Review files needing maintenance, creating `.bak`ups of the original if you `(O)verwrite`: -`pacdiff --sudo --backup` +`pacdiff {{[-s|--sudo]}} {{[-b|--backup]}}` - Use a specific editor to view and merge configuration files (default is `vim -d`): @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Scan for configuration files with `locate` instead of using `pacman` database: -`pacdiff --locate` +`pacdiff {{[-l|--locate]}}` - Display help: -`pacdiff --help` +`pacdiff {{[-h|--help]}}` diff --git a/tldr/linux/pasuspender b/tldr/linux/pasuspender index ed9319c7..89d19d1c 100644 --- a/tldr/linux/pasuspender +++ b/tldr/linux/pasuspender @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - Suspend PulseAudio while running `jackd`: -`pasuspender -- {{jackd -d alsa --device hw:0}}` +`pasuspender -- {{jackd {{[-d|--driver]}} alsa {{[-d|--device]}} hw:0}}` diff --git a/tldr/linux/paxs b/tldr/linux/paxs index 2672c100..d3b19ba1 100644 --- a/tldr/linux/paxs +++ b/tldr/linux/paxs @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade all packages: -`paxs -u` +`paxs {{[-u|--upgrade-all]}}` - Install a package (prompting for the source): -`paxs -i {{package}}` +`paxs {{[-i|--install]}} {{package}}` - Remove a package (prompting for the source): -`paxs -r {{package}}` +`paxs {{[-r|--remove]}} {{package}}` - Check for updates across all package managers: -`paxs -c` +`paxs {{[-c|--check-update]}}` - Display help: -`paxs -h` +`paxs {{[-h|--help]}}` diff --git a/tldr/linux/pdfattach b/tldr/linux/pdfattach index fbfce2e7..88abef23 100644 --- a/tldr/linux/pdfattach +++ b/tldr/linux/pdfattach @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`pdfattach -h` +`pdfattach {{[-h|--help]}}` - Display version: diff --git a/tldr/linux/pdfxup b/tldr/linux/pdfxup index f410bde3..300a9f12 100644 --- a/tldr/linux/pdfxup +++ b/tldr/linux/pdfxup @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a 2-up PDF: -`pdfxup -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` - Create a PDF with 3 columns and 2 lines per page: -`pdfxup -x {{3}} -y {{2}} -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-x|--columns]}} {{3}} {{[-y|--rows]}} {{2}} {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` - Create a PDF in booklet mode (2-up, and pages are sorted to form a book when folded): -`pdfxup -b -o {{path/to/output.pdf}} {{path/to/input.pdf}}` +`pdfxup {{[-b|--booklet]}} {{[-o|--output]}} {{path/to/output.pdf}} {{path/to/input.pdf}}` diff --git a/tldr/linux/perf b/tldr/linux/perf index 30197945..82793c4a 100644 --- a/tldr/linux/perf +++ b/tldr/linux/perf @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Record the profile of an existing process into `perf.data`: -`sudo perf record -p {{pid}}` +`sudo perf record {{[-p|--pid]}} {{pid}}` - Read `perf.data` (created by `perf record`) and display the profile: diff --git a/tldr/linux/perl-rename b/tldr/linux/perl-rename index 6089247b..7008ef84 100644 --- a/tldr/linux/perl-rename +++ b/tldr/linux/perl-rename @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--no-act]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: diff --git a/tldr/linux/picom b/tldr/linux/picom index 1f4ab8e0..e484a770 100644 --- a/tldr/linux/picom +++ b/tldr/linux/picom @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Start `picom` as a background process: -`picom -b` +`picom {{[-b|--daemon]}}` - Use a custom configuration file: diff --git a/tldr/linux/pinout b/tldr/linux/pinout index 5d8f3ef3..969fdefb 100644 --- a/tldr/linux/pinout +++ b/tldr/linux/pinout @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Open in the default browser: -`pinout -x` +`pinout {{[-x|--xyz]}}` diff --git a/tldr/linux/pkginfo b/tldr/linux/pkginfo index 5dff2072..e95b48b5 100644 --- a/tldr/linux/pkginfo +++ b/tldr/linux/pkginfo @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - List installed packages and their versions: -`pkginfo -i` +`pkginfo {{[-i|--installed]}}` - List files owned by a package: -`pkginfo -l {{package}}` +`pkginfo {{[-l|--list]}} {{package}}` - List the owner(s) of files matching a pattern: -`pkginfo -o {{pattern}}` +`pkginfo {{[-o|--owner]}} {{pattern}}` - Print the footprint of a file: diff --git a/tldr/linux/prename b/tldr/linux/prename index 6fb56a09..463ecff4 100644 --- a/tldr/linux/prename +++ b/tldr/linux/prename @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Dry-run - display which renames would occur without performing them: -`rename -n {{'s/foo/bar/'}} {{*}}` +`rename {{[-n|--nono]}} {{'s/foo/bar/'}} {{*}}` - Force renaming even if the operation would remove existing destination files: -`rename -f {{'s/foo/bar/'}} {{*}}` +`rename {{[-f|--force]}} {{'s/foo/bar/'}} {{*}}` - Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): diff --git a/tldr/linux/pridecat b/tldr/linux/pridecat index 8c14a83d..11e61fc0 100644 --- a/tldr/linux/pridecat +++ b/tldr/linux/pridecat @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pridecat -> Like cat but more colorful :). +> Like cat but more colorful. > More information: . - Print the contents of a file in pride colors to `stdout`: @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Print contents of a file in trans colors: -`pridecat {{path/to/file}} --{{transgender|trans}}` +`pridecat {{path/to/file}} {{[--trans|--transgender]}}` - Alternate between lesbian and bisexual pride flags: -`pridecat {{path/to/file}} --lesbian --bi` +`pridecat {{path/to/file}} --lesbian {{[--bi|--bisexual]}}` - Print contents of a file with the background colors changed: -`pridecat {{path/to/file}} -b` +`pridecat {{path/to/file}} {{[-b|--background]}}` - List directory contents in pride flag colors: diff --git a/tldr/linux/protonvpn-connect b/tldr/linux/protonvpn-connect index b0d08e11..475b477f 100644 --- a/tldr/linux/protonvpn-connect +++ b/tldr/linux/protonvpn-connect @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`protonvpn connect --help` +`protonvpn {{[c|connect]}} --help` diff --git a/tldr/linux/pvs b/tldr/linux/pvs index acbcac01..538392a1 100644 --- a/tldr/linux/pvs +++ b/tldr/linux/pvs @@ -15,19 +15,19 @@ source: https://github.com/tldr-pages/tldr.git - Display non-physical volumes: -`pvs -a` +`pvs {{[-a|--all]}}` - Change default display to show more details: -`pvs -v` +`pvs {{[-v|--verbose]}}` - Display only specific fields: -`pvs -o {{field_name_1}},{{field_name_2}}` +`pvs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`pvs -o +{{field_name}}` +`pvs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/tldr/linux/pw-cat b/tldr/linux/pw-cat index 94fbe950..d26be5d6 100644 --- a/tldr/linux/pw-cat +++ b/tldr/linux/pw-cat @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Play a WAV file over the default target: -`pw-cat --playback {{path/to/file.wav}}` +`pw-cat {{[-p|--playback]}} {{path/to/file.wav}}` - Play a WAV file with a specified resampler quality (4 by default): -`pw-cat --quality {{0..15}} --playback {{path/to/file.wav}}` +`pw-cat {{[-q|--quality]}} {{0..15}} {{[-p|--playback]}} {{path/to/file.wav}}` - Record a sample recording at a volume level of 125%: -`pw-cat --record --volume {{1.25}} {{path/to/file.wav}}` +`pw-cat {{[-r|--record]}} --volume {{1.25}} {{path/to/file.wav}}` - Record a sample recording using a different sample rate: -`pw-cat --record --rate {{6000}} {{path/to/file.wav}}` +`pw-cat {{[-r|--record]}} --rate {{6000}} {{path/to/file.wav}}` - Display help: diff --git a/tldr/linux/pw-loopback b/tldr/linux/pw-loopback index ce4bad3b..f95558ba 100644 --- a/tldr/linux/pw-loopback +++ b/tldr/linux/pw-loopback @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a loopback device that automatically connects to the speakers: -`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-i|--capture-props]}} '{{media.class=Audio/Sink}}'` - Create a loopback device that automatically connects to the microphone: -`pw-loopback -m '{{[FL FR]}}' --playback-props='{{media.class=Audio/Source}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source}}'` - Create a dummy loopback device that doesn't automatically connect to anything: -`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}' --playback-props='{{media.class=Audio/Source}}'` +`pw-loopback {{[-m|--channel-map]}} '{{[FL FR]}}' {{[-i|--capture-props]}} '{{media.class=Audio/Sink}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source}}'` - Create a loopback device that automatically connects to the speakers and swaps the left and right channels between the sink and source: -`pw-loopback --capture-props='{{media.class=Audio/Sink audio.position=[FL FR]}}' --playback-props='{{audio.position=[FR FL]}}'` +`pw-loopback {{[-i|--capture-props]}} '{{media.class=Audio/Sink audio.position=[FL FR]}}' {{[-o|--playback-props]}} '{{audio.position=[FR FL]}}'` - Create a loopback device that automatically connects to the microphone and swaps the left and right channels between the sink and source: -`pw-loopback --capture-props='{{audio.position=[FR FL]}}' --playback-props='{{media.class=Audio/Source audio.position=[FL FR]}}'` +`pw-loopback {{[-i|--capture-props]}} '{{audio.position=[FR FL]}}' {{[-o|--playback-props]}} '{{media.class=Audio/Source audio.position=[FL FR]}}'` diff --git a/tldr/linux/pw-mon b/tldr/linux/pw-mon index cab28d0d..04ddb07c 100644 --- a/tldr/linux/pw-mon +++ b/tldr/linux/pw-mon @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Monitor a specific remote instance: -`pw-mon --remote={{remote_name}}` +`pw-mon {{[-r|--remote]}} {{remote_name}}` - Monitor the default instance specifying a color configuration: -`pw-mon --color={{never|always|auto}}` +`pw-mon {{[-N|--color]}} {{never|always|auto}}` - Display help: -`pw-mon --help` +`pw-mon {{[-h|--help]}}` diff --git a/tldr/linux/pw-top b/tldr/linux/pw-top index d982cb07..4b94fc5e 100644 --- a/tldr/linux/pw-top +++ b/tldr/linux/pw-top @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Monitor a remote instance: -`pw-top --remote {{remote_name}}` +`pw-top {{[-r|--remote]}} {{remote_name}}` - Print information periodically instead of running in interactive mode: -`pw-top --batch-mode` +`pw-top {{[-b|--batch-mode]}}` - Print information periodically for a specific number of times: -`pw-top --batch-mode --iterations {{3}}` +`pw-top {{[-b|--batch-mode]}} {{[-n|--iterations]}} {{3}}` diff --git a/tldr/linux/rankmirrors b/tldr/linux/rankmirrors index f6edccbf..46057acc 100644 --- a/tldr/linux/rankmirrors +++ b/tldr/linux/rankmirrors @@ -19,12 +19,12 @@ source: https://github.com/tldr-pages/tldr.git - Be verbose when generating the mirrorlist: -`rankmirrors -v {{/etc/pacman.d/mirrorlist}}` +`rankmirrors {{[-v|--verbose]}} {{/etc/pacman.d/mirrorlist}}` - Test only a specific URL: -`rankmirrors --url {{url}}` +`rankmirrors {{[-u|--url]}} {{url}}` - Output only the response times instead of a full mirrorlist: -`rankmirrors --times {{/etc/pacman.d/mirrorlist}}` +`rankmirrors {{[-t|--times]}} {{/etc/pacman.d/mirrorlist}}` diff --git a/tldr/linux/reportbug b/tldr/linux/reportbug index 8c71b093..ecee84f1 100644 --- a/tldr/linux/reportbug +++ b/tldr/linux/reportbug @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Write the bug report to a file instead of sending it by e-mail: -`reportbug -o {{filename}} {{package}}` +`reportbug {{[-o|--output]}} {{filename}} {{package}}` diff --git a/tldr/linux/repquota b/tldr/linux/repquota index 852e75bf..0b52f24f 100644 --- a/tldr/linux/repquota +++ b/tldr/linux/repquota @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Report stats for all quotas in use: -`sudo repquota -all` +`sudo repquota {{[-a|--all]}}` - Report quota stats for all users, even those who aren't using any of their quota: -`sudo repquota -v {{filesystem}}` +`sudo repquota {{[-v|--verbose]}} {{filesystem}}` - Report on quotas for users only: -`repquota --user {{filesystem}}` +`repquota {{[-u|--user]}} {{filesystem}}` - Report on quotas for groups only: -`sudo repquota --group {{filesystem}}` +`sudo repquota {{[-g|--group]}} {{filesystem}}` - Report on used quota and limits in a human-readable format: -`sudo repquota --human-readable {{filesystem}}` +`sudo repquota {{[-s|--human-readable]}} {{filesystem}}` - Report on all quotas for users and groups in a human-readable format: -`sudo repquota -augs` +`sudo repquota {{[-augs|--all --user --group --human-readable]}}` diff --git a/tldr/linux/rpicam-hello b/tldr/linux/rpicam-hello index 7d4482af..4bd03487 100644 --- a/tldr/linux/rpicam-hello +++ b/tldr/linux/rpicam-hello @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Display a camera preview stream for a specific amount of time (in milliseconds): -`rpicam-hello -t {{time}}` +`rpicam-hello {{[-t|--timeout]}} {{time}}` - Tune the configuration for a particular camera sensor: diff --git a/tldr/linux/rpicam-jpeg b/tldr/linux/rpicam-jpeg index 80e7432f..e923cda2 100644 --- a/tldr/linux/rpicam-jpeg +++ b/tldr/linux/rpicam-jpeg @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Capture an image and name the file: -`rpicam-jpeg -o {{path/to/file.jpg}}` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}}` - Capture an image with set dimensions: -`rpicam-jpeg -o {{path/to/file.jpg}} --width {{1920}} --height {{1080}}` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}} --width {{1920}} --height {{1080}}` - Capture an image with an exposure of 20 seconds and a gain of 150%: -`rpicam-jpeg -o {{path/to/file.jpg}} --shutter 20000 --gain 1.5` +`rpicam-jpeg {{[-o|--output]}} {{path/to/file.jpg}} --shutter 20000 --gain 1.5` diff --git a/tldr/linux/rpicam-raw b/tldr/linux/rpicam-raw index e6633bbc..510cfeab 100644 --- a/tldr/linux/rpicam-raw +++ b/tldr/linux/rpicam-raw @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Capture a video for a specific amount of seconds: -`rpicam-raw -t {{2000}} -o {{path/to/file.raw}}` +`rpicam-raw {{[-t|--timeout]}} {{2000}} {{[-o|--output]}} {{path/to/file.raw}}` - Change video dimensions and framerate: -`rpicam-raw -t {{5000}} --width {{4056}} --height {{3040}} -o {{path/to/file.raw}} --framerate {{8}}` +`rpicam-raw {{[-t|--timeout]}} {{5000}} --width {{4056}} --height {{3040}} {{[-o|--output]}} {{path/to/file.raw}} --framerate {{8}}` diff --git a/tldr/linux/rpicam-still b/tldr/linux/rpicam-still index b63a4a2f..6d1c4578 100644 --- a/tldr/linux/rpicam-still +++ b/tldr/linux/rpicam-still @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Capture a photo with different encoding: -`rpicam-still -e {{bmp|png|rgb|yuv420}} -o {{path/to/file.{{bmp|png|rgb|yuv420}}}}` +`rpicam-still {{[-e|--encoding]}} {{bmp|png|rgb|yuv420}} {{[-o|--output]}} {{path/to/file.{{bmp|png|rgb|yuv420}}}}` - Capture a raw image: -`rpicam-still -r -o {{path/to/file.jpg}}` +`rpicam-still {{[-r|--raw]}} {{[-o|--output]}} {{path/to/file.jpg}}` - Capture a 100 second exposure image: -`rpicam-still -o {{path/to/file.jpg}} --shutter 100000` +`rpicam-still {{[-o|--output]}} {{path/to/file.jpg}} --shutter 100000` diff --git a/tldr/linux/rpicam-vid b/tldr/linux/rpicam-vid index 6f17925b..e796db30 100644 --- a/tldr/linux/rpicam-vid +++ b/tldr/linux/rpicam-vid @@ -11,4 +11,4 @@ source: https://github.com/tldr-pages/tldr.git - Capture a 10 second video: -`rpicam-vid -t 10000 -o {{path/to/file.h264}}` +`rpicam-vid {{[-t|--timeout]}} 10000 {{[-o|--output]}} {{path/to/file.h264}}` diff --git a/tldr/linux/rusnapshot b/tldr/linux/rusnapshot index c03b5b4e..f6f26d3c 100644 --- a/tldr/linux/rusnapshot +++ b/tldr/linux/rusnapshot @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Create a snapshot using a configuration file: -`sudo rusnapshot --config {{path/to/config.toml}} --cr` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --cr` - List created snapshots: -`sudo rusnapshot -c {{path/to/config.toml}} --list` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} {{[-l|--list]}}` - Delete a snapshot by ID or the name of the snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --del --id {{snapshot_id}}` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --del --id {{snapshot_id}}` - Delete all `hourly` snapshots: -`sudo rusnapshot -c {{path/to/config.toml}} --list --keep {{0}} --clean --kind {{hourly}}` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} {{[-l|--list]}} {{[-k|--keep]}} {{0}} --clean --kind {{hourly}}` - Create a read-write snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --cr --rw` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --cr {{[-r|--rw]}}` - Restore a snapshot: -`sudo rusnapshot -c {{path/to/config.toml}} --id {{snapshot_id}} --restore` +`sudo rusnapshot {{[-c|--config]}} {{path/to/config.toml}} --id {{snapshot_id}} {{[-r|--restore]}}` diff --git a/tldr/linux/sacct b/tldr/linux/sacct index 9ed4b247..c0276af3 100644 --- a/tldr/linux/sacct +++ b/tldr/linux/sacct @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Display job ID, job state, job exit code for recent jobs: -`sacct --brief` +`sacct {{[-b|--brief]}}` - Display the allocations of a job: -`sacct --jobs {{job_id}} --allocations` +`sacct {{[-j|--jobs]}} {{job_id}} {{[-X|--allocations]}}` - Display elapsed time, job name, number of requested CPUs, and memory requested of a job: -`sacct --jobs {{job_id}} --format=Elapsed,JobName,ReqCPUS,ReqMem` +`sacct {{[-j|--jobs]}} {{job_id}} {{[-o|--format]}} Elapsed,JobName,ReqCPUS,ReqMem` - Display recent jobs that occurred from one week ago up to the present day: -`sacct --starttime=$(date -d "1 week ago" +'%F')` +`sacct {{[-S|--starttime]}} $(date {{[-d|--date]}} "1 week ago" +'%F')` - Output a larger number of characters for an attribute: -`sacct --format=JobID,JobName%100` +`sacct {{[-o|--format]}} JobID,JobName%100` diff --git a/tldr/linux/salloc b/tldr/linux/salloc index ed4dd537..0956ba69 100644 --- a/tldr/linux/salloc +++ b/tldr/linux/salloc @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Execute the specified command synchronously on a node in the cluster: -`salloc {{ls -a}}` +`salloc {{ls --all}}` - Only allocate nodes fulfilling the specified constraints: -`salloc --constraint={{(amd|intel)&gpu}}` +`salloc {{[-C|--constraint]}} {{(amd|intel)&gpu}}` diff --git a/tldr/linux/screenkey b/tldr/linux/screenkey index a3e90f8d..6c6c73fb 100644 --- a/tldr/linux/screenkey +++ b/tldr/linux/screenkey @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display keys and mouse buttons which are currently being pressed on the screen: -`screenkey --mouse` +`screenkey {{[-M|--mouse]}}` - Launch the settings menu of screenkey: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch screenkey at a specific position: -`screenkey --position {{top|center|bottom|fixed}}` +`screenkey {{[-p|--position]}} {{top|center|bottom|fixed}}` - Change the format of the key modifiers displayed on screen: @@ -30,8 +30,8 @@ source: https://github.com/tldr-pages/tldr.git - Change the appearance of screenkey: -`screenkey --bg-color "{{#a1b2c3}}" --font {{Hack}} --font-color {{yellow}} --opacity {{0.8}}` +`screenkey --bg-color "{{#a1b2c3}}" {{[-f|--font]}} {{Hack}} --font-color {{yellow}} --opacity {{0.8}}` - Drag and select a window on screen to display screenkey: -`screenkey --position fixed --geometry {{$(slop -n -f '%g')}}` +`screenkey {{[-p|--position]}} fixed {{[-g|--geometry]}} {{$(slop {{[-n|--nodecorations]}} {{[-f|--format]}} '%g')}}` diff --git a/tldr/linux/sdiag b/tldr/linux/sdiag index 5be72f98..d4702415 100644 --- a/tldr/linux/sdiag +++ b/tldr/linux/sdiag @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Show all performance counters related to the execution of `slurmctld`: -`sdiag --all` +`sdiag {{[-a|--all]}}` - Reset performance counters related to the execution of `slurmctld`: -`sdiag --reset` +`sdiag {{[-r|--reset]}}` - Specify the output format: -`sdiag --all --{{json|yaml}}` +`sdiag {{[-a|--all]}} --{{json|yaml}}` - Specify the cluster to send commands to: -`sdiag --all --cluster={{cluster_name}}` +`sdiag {{[-a|--all]}} {{[-M|--cluster]}} {{cluster_name}}` diff --git a/tldr/linux/semanage-fcontext b/tldr/linux/semanage-fcontext index 80013f08..5b9db5ed 100644 --- a/tldr/linux/semanage-fcontext +++ b/tldr/linux/semanage-fcontext @@ -11,19 +11,19 @@ source: https://github.com/tldr-pages/tldr.git - List all file labelling rules: -`sudo semanage fcontext --list` +`sudo semanage fcontext {{[-l|--list]}}` - List all user-defined file labelling rules without headings: -`sudo semanage fcontext --list --locallist --noheading` +`sudo semanage fcontext {{[-l|--list]}} {{[-C|--locallist]}} {{[-n|--noheading]}}` - Add a user-defined rule that labels any path which matches a PCRE regex: -`sudo semanage fcontext --add --type {{samba_share_t}} {{'/mnt/share(/.*)?'}}` +`sudo semanage fcontext {{[-a|--add]}} {{[-t|--type]}} {{samba_share_t}} {{'/mnt/share(/.*)?'}}` - Delete a user-defined rule using its PCRE regex: -`sudo semanage fcontext --delete {{'/mnt/share(/.*)?'}}` +`sudo semanage fcontext {{[-d|--delete]}} {{'/mnt/share(/.*)?'}}` - Relabel a directory recursively by applying the new rules: diff --git a/tldr/linux/setfattr b/tldr/linux/setfattr index 4b714ca0..6e5b923c 100644 --- a/tldr/linux/setfattr +++ b/tldr/linux/setfattr @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Set name of attribute for file: -`setfattr -n user.{{attribute_name}} {{path/to/file}}` +`setfattr {{[-n|--name]}} user.{{attribute_name}} {{path/to/file}}` - Set a user-defined value of an extended attribute on a file: -`setfattr -n user.{{attribute_name}} -v "{{value}}" {{path/to/file}}` +`setfattr {{[-n|--name]}} user.{{attribute_name}} {{[-v|--value]}} "{{value}}" {{path/to/file}}` - Remove a specific attribute of a file: -`setfattr -x user.{{attribute_name}} {{path/to/file}}` +`setfattr {{[-x|--remove]}} user.{{attribute_name}} {{path/to/file}}` diff --git a/tldr/linux/sh5util b/tldr/linux/sh5util index 32e2790d..54f828ad 100644 --- a/tldr/linux/sh5util +++ b/tldr/linux/sh5util @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Merge HDF5 files produced on each allocated node for the specified job or step: -`sh5util --jobs={{job_id|job_id.step_id}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}}` - Extract one or more data series from a merged job file: -`sh5util --jobs={{job_id|job_id.step_id}} --extract -i {{path/to/file.h5}} --series={{Energy|Filesystem|Network|Task}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}} {{[-E|--extract]}} {{[-i|--input]}} {{path/to/file.h5}} {{[-s|--series]}} {{Energy|Filesystem|Network|Task}}` - Extract one data item from all nodes in a merged job file: -`sh5util --jobs={{job_id|job_id.step_id}} --item-extract --series={{Energy|Filesystem|Network|Task}} --data={{data_item}}` +`sh5util {{[-j|--jobs]}} {{job_id|job_id.step_id}} {{[-I|--item-extract]}} {{[-s|--series]}} {{Energy|Filesystem|Network|Task}} {{[-d|--data]}} {{data_item}}` diff --git a/tldr/linux/sic b/tldr/linux/sic index dd1309f3..aed56854 100644 --- a/tldr/linux/sic +++ b/tldr/linux/sic @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Simple IRC client. > Part of the suckless tools. -> More information: . +> More information: . - Connect to the default host (irc.ofct.net) with the nickname set in the `$USER` environment variable: diff --git a/tldr/linux/sinfo b/tldr/linux/sinfo index fd9c5303..1cbf2e59 100644 --- a/tldr/linux/sinfo +++ b/tldr/linux/sinfo @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Show a quick summary overview of the cluster: -`sinfo --summarize` +`sinfo {{[-s|--summarize]}}` - View the detailed status of all partitions across the entire cluster: @@ -19,16 +19,16 @@ source: https://github.com/tldr-pages/tldr.git - View the detailed status of a specific partition: -`sinfo --partition {{partition_name}}` +`sinfo {{[-p|--partition]}} {{partition_name}}` - View information about idle nodes: -`sinfo --states {{idle}}` +`sinfo {{[-t|--states]}} {{idle}}` - Summarise dead nodes: -`sinfo --dead` +`sinfo {{[-d|--dead]}}` - List dead nodes and the reasons why: -`sinfo --list-reasons` +`sinfo {{[-R|--list-reasons]}}` diff --git a/tldr/linux/slop b/tldr/linux/slop index 15ad5a34..deb38171 100644 --- a/tldr/linux/slop +++ b/tldr/linux/slop @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Double click, rather than click and drag, to draw a selection: -`slop -D` +`slop {{[-D|--nodrag]}}` - Highlight the selection rather than outlining it: -`slop -l` +`slop {{[-l|--highlight]}}` - Specify the output format: -`slop -f {{format_string}}` +`slop {{[-f|--format]}} {{format_string}}` - Specify the selection rectangle's color: -`slop -c {{red}},{{green}},{{blue}},{{alpha}}` +`slop {{[-c|--color]}} {{red}},{{green}},{{blue}},{{alpha}}` diff --git a/tldr/linux/slurmrestd b/tldr/linux/slurmrestd index c7aa63e9..f299ea5e 100644 --- a/tldr/linux/slurmrestd +++ b/tldr/linux/slurmrestd @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Change the group ID (and drop supplemental groups) before processing client requests: -`slurmrestd --g {{group_id}} {{[host]:port | unix:/path/to/socket}}` +`slurmrestd -g {{group_id}} {{[host]:port | unix:/path/to/socket}}` - Comma-delimited list of authentication plugins to load: diff --git a/tldr/linux/sm b/tldr/linux/sm index 59c63cc7..7a022d4b 100644 --- a/tldr/linux/sm +++ b/tldr/linux/sm @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Display a message with inverted colors: -`sm -i "{{Hello World!}}"` +`sm {{[-i|--invert]}} "{{Hello World!}}"` - Display a message with a custom foreground color: -`sm -f {{blue}} "{{Hello World!}}"` +`sm {{[-f|--foreground]}} {{blue}} "{{Hello World!}}"` - Display a message with a custom background color: -`sm -b {{#008888}} "{{Hello World!}}"` +`sm {{[-b|--background]}} {{#008888}} "{{Hello World!}}"` - Display a message rotated 3 times (in steps of 90 degrees, counterclockwise): -`sm -r {{3}} "{{Hello World!}}"` +`sm {{[-r|--rotate]}} {{3}} "{{Hello World!}}"` - Display a message using the output from another command: diff --git a/tldr/linux/snapper b/tldr/linux/snapper index f8685b75..27fc23cc 100644 --- a/tldr/linux/snapper +++ b/tldr/linux/snapper @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Create snapper config: -`snapper -c {{config}} create-config {{path/to/directory}}` +`snapper {{[-c|--config]}} {{config}} create-config {{path/to/directory}}` - Create a snapshot with a description: -`snapper -c {{config}} create -d "{{snapshot_description}}"` +`snapper {{[-c|--config]}} {{config}} create {{[-d|--description]}} "{{snapshot_description}}"` - List snapshots for a config: -`snapper -c {{config}} list` +`snapper {{[-c|--config]}} {{config}} list` - Delete a snapshot: -`snapper -c {{config}} delete {{snapshot_number}}` +`snapper {{[-c|--config]}} {{config}} delete {{snapshot_number}}` - Delete a range of snapshots: -`snapper -c {{config}} delete {{snapshot1}}-{{snapshot2}}` +`snapper {{[-c|--config]}} {{config}} delete {{snapshot1}}-{{snapshot2}}` diff --git a/tldr/linux/sport b/tldr/linux/sport index 3f4c66d2..66482b95 100644 --- a/tldr/linux/sport +++ b/tldr/linux/sport @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Pull the list of SlackBuilds to run `sport` for the first time: -`sudo mkdir -p /usr/ports && sudo rsync -av rsync://slackbuilds.org /slackbuilds/$(awk '{print $2}' /etc/slackware-version)/ /usr/ports/` +`sudo mkdir {{[-p|--parents]}} /usr/ports && sudo rsync {{[-av|--archive --verbose]}} rsync://slackbuilds.org /slackbuilds/$(awk '{print $2}' /etc/slackware-version)/ /usr/ports/` - Pull in any updates to the system's tree via `rsync`: diff --git a/tldr/linux/sprio b/tldr/linux/sprio index bd6a2492..087cc7a5 100644 --- a/tldr/linux/sprio +++ b/tldr/linux/sprio @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - View the factors determining the specified job's scheduling priority: -`sprio --jobs={{job_id_1,job_id_2,...}}` +`sprio {{[-j|--jobs]}} {{job_id_1,job_id_2,...}}` - Output additional information: -`sprio --long` +`sprio {{[-l|--long]}}` - View information for the jobs of specified users: -`sprio --user={{user_name_1,user_name_2,...}}` +`sprio {{[-u|--user]}} {{user_name_1,user_name_2,...}}` - Print the weights for each factor determining job scheduling priority: -`sprio --weights` +`sprio {{[-w|--weights]}}` diff --git a/tldr/linux/squeue b/tldr/linux/squeue index e8b61e4b..1591bba3 100644 --- a/tldr/linux/squeue +++ b/tldr/linux/squeue @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - View jobs queued by a specific user: -`squeue -u {{username}}` +`squeue {{[-u|--user]}} {{username}}` - View the queue and refresh every 5 seconds: -`squeue -i {{5}}` +`squeue {{[-i|--iterate]}} {{5}}` - View the queue with expected start times: diff --git a/tldr/linux/sreport b/tldr/linux/sreport index d3516072..8f94c296 100644 --- a/tldr/linux/sreport +++ b/tldr/linux/sreport @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Show pipe delimited cluster utilization data: -`sreport --parsable cluster utilization` +`sreport {{[-p|--parsable]}} cluster utilization` - Show number of jobs run: diff --git a/tldr/linux/sshare b/tldr/linux/sshare index 9e905e40..fd169656 100644 --- a/tldr/linux/sshare +++ b/tldr/linux/sshare @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Control the fields to display: -`sshare --format={{format_string}}` +`sshare {{[-o|--format]}} {{format_string}}` - Display information for the specified users only: -`sshare --users={{user_id_1,user_id_2,...}}` +`sshare {{[-u|--users]}} {{user_id_1,user_id_2,...}}` diff --git a/tldr/linux/sstat b/tldr/linux/sstat index b6bbecad..b7a34ee9 100644 --- a/tldr/linux/sstat +++ b/tldr/linux/sstat @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display status information of a comma-separated list of jobs: -`sstat --jobs={{job_id}}` +`sstat {{[-j|--jobs]}} {{job_id}}` - Display job ID, average CPU and average virtual memory size of a comma-separated list of jobs, with pipes as column delimiters: -`sstat --parsable --jobs={{job_id}} --format={{JobID,AveCPU,AveVMSize}}` +`sstat {{[-p|--parsable]}} {{[-j|--jobs]}} {{job_id}} {{[-o|--format]}} {{JobID,AveCPU,AveVMSize}}` - Display list of fields available: -`sstat --helpformat` +`sstat {{[-e|--helpformat]}}` diff --git a/tldr/linux/stress b/tldr/linux/stress index 92d9dc83..c29ff6ea 100644 --- a/tldr/linux/stress +++ b/tldr/linux/stress @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Spawn 4 workers to stress test CPU: -`stress -c {{4}}` +`stress {{[-c|--cpu]}} {{4}}` - Spawn 2 workers to stress test IO and timeout after 5 seconds: -`stress -i {{2}} -t {{5}}` +`stress {{[-i|--io]}} {{2}} {{[-t|--timeout]}} {{5}}` - Spawn 2 workers to stress test memory (each worker allocates 256M bytes): -`stress -m {{2}} --vm-bytes {{256M}}` +`stress {{[-m|--vm]}} {{2}} --vm-bytes {{256M}}` - Spawn 2 workers spinning on write()/unlink() (each worker writes 1G bytes): -`stress -d {{2}} --hdd-bytes {{1GB}}` +`stress {{[-d|--hdd]}} {{2}} --hdd-bytes {{1GB}}` diff --git a/tldr/linux/strigger b/tldr/linux/strigger index 9db3667a..69694d32 100644 --- a/tldr/linux/strigger +++ b/tldr/linux/strigger @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Register a new trigger. Execute the specified program when the specified event occurs: -`strigger --set --{{primary_database_failure|primary_slurmdbd_failure|primary_slurmctld_acct_buffer_full|primary_slurmctld_failure|...}} --program={{path/to/executable}}` +`strigger --set --{{primary_database_failure|primary_slurmdbd_failure|primary_slurmctld_acct_buffer_full|primary_slurmctld_failure|...}} {{[-p|--program]}} {{path/to/executable}}` - Execute the specified program when the specified job terminated: -`strigger --set --jobid={{job_id}} --fini --program="{{path/to/executable}} {{argument1 argument2 ...}}"` +`strigger --set {{[-j|--jobid]}} {{job_id}} {{[-f|--fini]}} {{[-p|--program]}} "{{path/to/executable}} {{argument1 argument2 ...}}"` - View active triggers: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - View active triggers regarding the specified job: -`strigger --get --jobid={{job_id}}` +`strigger --get {{[-j|--jobid]}} {{job_id}}` - Clear the specified trigger: diff --git a/tldr/linux/strip b/tldr/linux/strip index 32baf55f..b1386f03 100644 --- a/tldr/linux/strip +++ b/tldr/linux/strip @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Strip debug symbols only: -`strip --strip-debug {{path/to/file.o}}` +`strip {{[-d|--strip-debug]}} {{path/to/file.o}}` diff --git a/tldr/linux/swaks b/tldr/linux/swaks index ab45741a..a9f267a9 100644 --- a/tldr/linux/swaks +++ b/tldr/linux/swaks @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Deliver a standard test email to `user@example.com` on port 25 of `test-server.example.net`: -`swaks --to {{user@example.com}} --server {{test-server.example.net}}` +`swaks {{[-t|--to]}} {{user@example.com}} {{[-s|--server]}} {{test-server.example.net}}` - Deliver a standard test email, requiring CRAM-MD5 authentication as user `me@example.com`. An "X-Test" header will be added to the email body: -`swaks --to {{user@example.com}} --from {{me@example.com}} --auth {{CRAM-MD5}} --auth-user {{me@example.com}} --header-X-Test "{{test_email}}"` +`swaks {{[-t|--to]}} {{user@example.com}} {{[-f|--from]}} {{me@example.com}} {{[-a|--auth]}} {{CRAM-MD5}} {{[-au|--auth-user]}} {{me@example.com}} --header-X-Test "{{test_email}}"` - Test a virus scanner using EICAR in an attachment. Don't show the message DATA part: -`swaks -t {{user@example.com}} --attach - --server {{test-server.example.com}} --suppress-data {{path/to/eicar.txt}}` +`swaks {{[-t|--to]}} {{user@example.com}} --attach - {{[-s|--server]}} {{test-server.example.com}} {{[-n|--suppress-data]}} {{path/to/eicar.txt}}` - Test a spam scanner using GTUBE in the body of an email, routed via the MX records for `example.com`: -`swaks --to {{user@example.com}} --body {{path/to/gtube_file}}` +`swaks {{[-t|--to]}} {{user@example.com}} --body {{path/to/gtube_file}}` - Deliver a standard test email to `user@example.com` using the LMTP protocol via a UNIX domain socket file: -`swaks --to {{user@example.com}} --socket {{/var/lda.sock}} --protocol {{LMTP}}` +`swaks {{[-t|--to]}} {{user@example.com}} --socket {{/var/lda.sock}} --protocol {{LMTP}}` diff --git a/tldr/linux/sysctl b/tldr/linux/sysctl index 9597f75f..9be8ddea 100644 --- a/tldr/linux/sysctl +++ b/tldr/linux/sysctl @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Show all available variables and their values: -`sysctl -a` +`sysctl {{[-a|--all]}}` - Set a changeable kernel state variable: -`sysctl -w {{section.tunable}}={{value}}` +`sysctl {{[-w|--write]}} {{section.tunable}}={{value}}` - Get currently open file handlers: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Apply changes from `/etc/sysctl.conf`: -`sysctl -p` +`sysctl {{[-p|--load]}}` diff --git a/tldr/linux/sysdig b/tldr/linux/sysdig index c85eaf6e..a0fd1fb9 100644 --- a/tldr/linux/sysdig +++ b/tldr/linux/sysdig @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Capture all the events from the live system and save them to disk: -`sysdig -w {{path/to/file}}.scap` +`sysdig {{[-w|--write]}} {{path/to/file}}.scap` - Read events from a file and print them to screen: -`sysdig -r {{path/to/file}}.scap` +`sysdig {{[-r|--read]}} {{path/to/file}}.scap` - Filter and Print all the open system calls invoked by cat: @@ -31,8 +31,8 @@ source: https://github.com/tldr-pages/tldr.git - List the available chisels: -`sysdig -cl` +`sysdig {{[-cl|--list-chisels]}}` - Use the spy_ip chisel to look at the data exchanged with ip address: -`sysdig -c spy_ip {{ip_address}}` +`sysdig {{[-c|--chisel]}} spy_ip {{ip_address}}` diff --git a/tldr/linux/systemd-socket-activate b/tldr/linux/systemd-socket-activate index 1610cbbe..aa16304b 100644 --- a/tldr/linux/systemd-socket-activate +++ b/tldr/linux/systemd-socket-activate @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Activate a service with a specified port: -`systemd-socket-activate {{path/to/socket.service}} -l {{8080}}` +`systemd-socket-activate {{path/to/socket.service}} {{{[-l|--listen]}}} {{8080}}` diff --git a/tldr/linux/toilet b/tldr/linux/toilet index 86655f4b..9ca0a1dc 100644 --- a/tldr/linux/toilet +++ b/tldr/linux/toilet @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Generate ASCII art using a custom font file: -`toilet {{input_text}} -f {{font_filename}}` +`toilet {{input_text}} {{[-f|--font]}} {{font_filename}}` - Generate ASCII art using a filter: -`toilet {{input_text}} --filter {{filter_name}}` +`toilet {{input_text}} {{[-F|--filter]}} {{filter_name}}` - Show available toilet filters: -`toilet --filter list` +`toilet {{[-F|--filter]}} list` diff --git a/tldr/linux/turbostat b/tldr/linux/turbostat index 6153d3e4..ce029f5a 100644 --- a/tldr/linux/turbostat +++ b/tldr/linux/turbostat @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display statistics every specified amount of seconds: -`sudo turbostat -i {{n_seconds}}` +`sudo turbostat {{[-i|--interval]}} {{n_seconds}}` - Do not decode and print the system configuration header information: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Display useful information about CPU every 1 second, without header information: -`sudo turbostat --quiet --interval 1 --cpu 0-{{CPU_thread_count}} --show "PkgWatt","Busy%","Core","CoreTmp","Thermal"` +`sudo turbostat --quiet {{[-i|--interval]}} 1 --cpu 0-{{CPU_thread_count}} --show "PkgWatt","Busy%","Core","CoreTmp","Thermal"` - Display help: diff --git a/tldr/linux/unsquashfs b/tldr/linux/unsquashfs index 96024e24..dc9171e7 100644 --- a/tldr/linux/unsquashfs +++ b/tldr/linux/unsquashfs @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Extract a squashfs filesystem to the specified directory: -`unsquashfs -dest {{path/to/directory}} {{filesystem.squashfs}}` +`unsquashfs {{[-d|-dest]}} {{path/to/directory}} {{filesystem.squashfs}}` - Display the names of files as they are extracted: -`unsquashfs -info {{filesystem.squashfs}}` +`unsquashfs {{[-i|-info]}} {{filesystem.squashfs}}` - Display the names of files and their attributes as they are extracted: -`unsquashfs -linfo {{filesystem.squashfs}}` +`unsquashfs {{[-li|-linfo]}} {{filesystem.squashfs}}` - List files inside the squashfs filesystem (without extracting): -`unsquashfs -ls {{filesystem.squashfs}}` +`unsquashfs {{[-l|-ls]}} {{filesystem.squashfs}}` - List files and their attributes inside the squashfs filesystem (without extracting): -`unsquashfs -lls {{filesystem.squashfs}}` +`unsquashfs {{[-ll|-lls]}} {{filesystem.squashfs}}` diff --git a/tldr/linux/updpkgsums b/tldr/linux/updpkgsums index 2d7f38cb..9a96a3f8 100644 --- a/tldr/linux/updpkgsums +++ b/tldr/linux/updpkgsums @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`updpkgsums -h` +`updpkgsums {{[-h|--help]}}` - Display version: -`updpkgsums -v` +`updpkgsums {{[-v|--version]}}` diff --git a/tldr/linux/urpmq b/tldr/linux/urpmq index a8c50eca..53441aa1 100644 --- a/tldr/linux/urpmq +++ b/tldr/linux/urpmq @@ -19,11 +19,11 @@ source: https://github.com/tldr-pages/tldr.git - Display direct and indirect dependencies of a package: -`urpmq --requires-recursive {{package}}` +`urpmq {{[-d|--requires-recursive]}} {{package}}` - List the not installed packages needed for an RPM file with their sources: -`sudo urpmq --requires-recursive -m --sources {{path/to/file.rpm}}` +`sudo urpmq {{[-d|--requires-recursive]}} -m --sources {{path/to/file.rpm}}` - List all configured media with their URLs, including inactive media: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Search for a package printing [g]roup, version and [r]elease: -`urpmq -g -r --fuzzy {{keyword}}` +`urpmq -g -r {{[-y|--fuzzy]}} {{keyword}}` - Search for a package with using its exact name: diff --git a/tldr/linux/usbip b/tldr/linux/usbip index b9f2a50e..afd164cf 100644 --- a/tldr/linux/usbip +++ b/tldr/linux/usbip @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - List all local USB devices and their bus ID's: -`usbip list --local` +`usbip list {{[-l|--local]}}` - Start a `usbip` daemon on the server: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Bind a USB device to `usbip` on the server: -`sudo usbip bind --busid {{bus_id}}` +`sudo usbip bind {{[-b|--busid]}} {{bus_id}}` - Load the kernel module required by `usbip` on the client: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Attach to the `usbip` device on the client (bus ID is the same as on the server): -`sudo usbip attach -r {{ip_address}} --busid {{bus_id}}` +`sudo usbip attach {{[-r|--remote]}} {{ip_address}} {{[-b|--busid]}} {{bus_id}}` - List attached devices: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Detach from a device: -`sudo usbip detach --port {{port}}` +`sudo usbip detach {{[-p|--port]}} {{port}}` - Unbind a device: -`usbip unbind --busid {{bus_id}}` +`usbip unbind {{[-b|--busid]}} {{bus_id}}` diff --git a/tldr/linux/uvcdynctrl b/tldr/linux/uvcdynctrl index 3809ce73..375c3735 100644 --- a/tldr/linux/uvcdynctrl +++ b/tldr/linux/uvcdynctrl @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - List all available cameras: -`uvcdynctrl -l` +`uvcdynctrl {{[-l|--list]}}` - Use a specific device (defaults to `video0`): -`uvcdynctrl -d {{device_name}}` +`uvcdynctrl {{[-d|--device]}} {{device_name}}` - List available controls: -`uvcdynctrl -c` +`uvcdynctrl {{[-c|--clist]}}` - Set a new control value (for negative values, use `-- -value`): -`uvcdynctrl -s {{control_name}} {{value}}` +`uvcdynctrl {{[-s|--set]}} {{control_name}} {{value}}` - Get the current control value: -`uvcdynctrl -g {{control_name}}` +`uvcdynctrl {{[-g|--get]}} {{control_name}}` - Save the state of the current controls to a file: -`uvcdynctrl -W {{filename}}` +`uvcdynctrl {{[-W|--save]}} {{filename}}` - Load the state of the controls from a file: -`uvcdynctrl -L {{filename}}` +`uvcdynctrl {{[-L|--load]}} {{filename}}` diff --git a/tldr/linux/vgs b/tldr/linux/vgs index 408653bb..f06aadfe 100644 --- a/tldr/linux/vgs +++ b/tldr/linux/vgs @@ -15,19 +15,19 @@ source: https://github.com/tldr-pages/tldr.git - Display all volume groups: -`vgs -a` +`vgs {{[-a|--all]}}` - Change default display to show more details: -`vgs -v` +`vgs {{[-v|--verbose]}}` - Display only specific fields: -`vgs -o {{field_name_1}},{{field_name_2}}` +`vgs {{[-o|--options]}} {{field_name_1}},{{field_name_2}}` - Append field to default display: -`vgs -o +{{field_name}}` +`vgs {{[-o|--options]}} +{{field_name}}` - Suppress heading line: diff --git a/tldr/linux/vnstat b/tldr/linux/vnstat index 63245842..fe17223b 100644 --- a/tldr/linux/vnstat +++ b/tldr/linux/vnstat @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Display traffic summary for a specific network interface: -`vnstat -i {{network_interface}}` +`vnstat {{[-i|--iface]}} {{network_interface}}` - Display live stats for a specific network interface: -`vnstat -l -i {{network_interface}}` +`vnstat {{[-l|--live]}} {{[-i|--iface]}} {{network_interface}}` - Show traffic statistics on an hourly basis for the last 24 hours using a bar graph: -`vnstat -hg` +`vnstat {{[-hg|--hoursgraph]}}` - Measure and show average traffic for 30 seconds: -`vnstat -tr {{30}}` +`vnstat {{[-tr|--traffic]}} {{30}}` diff --git a/tldr/linux/wf-recorder b/tldr/linux/wf-recorder index 80b8480e..dda90433 100644 --- a/tldr/linux/wf-recorder +++ b/tldr/linux/wf-recorder @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Record storing to an MP4 file: -`wf-recorder --file={{output.mp4}}` +`wf-recorder {{[-f|--file]}} {{output.mp4}}` - Record including audio, both with mic and system sounds: -`wf-recorder --audio --file={{/path/to/file_with_audio.webm}}` +`wf-recorder {{[-a|--audio]}} {{[-f|--file]}} {{/path/to/file_with_audio.webm}}` - Select and record a portion of the screen using `slurp`, outputting to default `recording.mp4`: -`wf-recorder -g "$(slurp)"` +`wf-recorder {{[-g|--geometry]}} "$(slurp)"` diff --git a/tldr/linux/xclip b/tldr/linux/xclip index 9b87e49d..baf49950 100644 --- a/tldr/linux/xclip +++ b/tldr/linux/xclip @@ -16,28 +16,28 @@ source: https://github.com/tldr-pages/tldr.git - Copy the output from a command to a given X11 selection area: -`echo 123 | xclip -selection {{primary|secondary|clipboard}}` +`echo 123 | xclip {{[-se|-selection]}} {{primary|secondary|clipboard}}` - Copy the output from a command to the system clipboard, using short notation: -`echo 123 | xclip -sel clip` +`echo 123 | xclip {{[-se|-selection]}} clip` - Copy the contents of a file into the system clipboard: -`xclip -sel clip {{input_file.txt}}` +`xclip {{[-se|-selection]}} clip {{input_file.txt}}` - Copy the contents of a PNG into the system clipboard (can be pasted in other programs correctly): -`xclip -sel clip -t image/png {{input_file.png}}` +`xclip {{[-se|-selection]}} clip {{[-t|-target]}} image/png {{input_file.png}}` - Copy the user input in the console into the system clipboard: -`xclip -i` +`xclip {{[-i|-in]}}` - Paste the contents of the X11 primary selection area to the console: -`xclip -o` +`xclip {{[-o|-out]}}` - Paste the contents of the system clipboard to the console: -`xclip -o -sel clip` +`xclip {{[-o|-out]}} {{[-se|-selection]}} clip` diff --git a/tldr/linux/yay b/tldr/linux/yay index b91e02f1..0da89aa3 100644 --- a/tldr/linux/yay +++ b/tldr/linux/yay @@ -21,9 +21,9 @@ source: https://github.com/tldr-pages/tldr.git `yay -Sua` -- Install a new package from the repos and AUR: +- Install a new package from the repos and AUR and do not ask to confirm transactions: -`yay -S {{package}}` +`yay -S {{package}} --noconfirm` - Remove an installed package and both its dependencies and configuration files: diff --git a/tldr/linux/yum b/tldr/linux/yum index effd89a1..95f489f8 100644 --- a/tldr/linux/yum +++ b/tldr/linux/yum @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Install a new package and assume yes to all questions (also works with update, great for automated updates): -`yum -y install {{package}}` +`yum {{[-y|--assumeyes]}} install {{package}}` - Find the package that provides a particular command: diff --git a/tldr/nm b/tldr/nm index 35d850c6..99af764b 100644 --- a/tldr/nm +++ b/tldr/nm @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - List global (extern) functions in a file (prefixed with T): -`nm -g {{path/to/file.o}}` +`nm {{[-g|--extern-only]}} {{path/to/file.o}}` - List only undefined symbols in a file: -`nm -u {{path/to/file.o}}` +`nm {{[-u|--undefined-only]}} {{path/to/file.o}}` - List all symbols, even debugging symbols: -`nm -a {{path/to/file.o}}` +`nm {{[-a|--debug-syms]}} {{path/to/file.o}}` - Demangle C++ symbols (make them readable): -`nm --demangle {{path/to/file.o}}` +`nm {{[-C|--demangle]}} {{path/to/file.o}}` diff --git a/tldr/venv b/tldr/venv index f1c46523..e79c093d 100644 --- a/tldr/venv +++ b/tldr/venv @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Deactivate the virtual environment: `deactivate` + +- Create an alias that generates a `venv` folder and automatically activates it: + +`alias venv='python -m venv .venv && source {{.venv/bin/activate|.venv\Scriptsctivate.bat}}'`