From 1ec381096808f52b329b69901a3857aaf0713232 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Sun, 20 Jul 2025 00:24:01 +0000 Subject: [PATCH] Update cheatsheets --- tldr/helm | 8 +++---- tldr/hexdump | 1 + tldr/hexyl | 1 + tldr/linux/btrfs | 10 ++++----- tldr/linux/btrfs-balance | 14 ++++++------ tldr/linux/btrfs-check | 14 ++++++------ tldr/linux/btrfs-device | 10 ++++----- tldr/linux/btrfs-filesystem | 14 ++++++------ tldr/linux/btrfs-inspect-internal | 12 +++++----- tldr/linux/btrfs-property | 10 ++++----- tldr/linux/btrfs-rescue | 10 ++++----- tldr/linux/btrfs-restore | 10 ++++----- tldr/linux/btrfs-scrub | 12 +++++----- tldr/linux/btrfs-subvolume | 12 +++++----- tldr/linux/btrfs-version | 4 ++-- tldr/linux/counter-strike-2 | 2 +- tldr/linux/factorio | 2 +- tldr/linux/hexdump | 1 + tldr/linux/netplan | 4 ++-- tldr/linux/nmcli | 8 +++---- tldr/linux/nmcli-agent | 7 +++--- tldr/linux/nmcli-connection | 15 ++++++------- tldr/linux/nmcli-device | 9 ++++---- tldr/linux/nmcli-general | 13 +++++------ tldr/linux/nmcli-monitor | 3 +-- tldr/linux/nmcli-networking | 9 ++++---- tldr/linux/nmcli-radio | 13 +++++------ tldr/linux/terraria | 2 +- tldr/linux/trace-cmd | 22 ++++++++++-------- tldr/linux/trace-cmd-list | 26 ++++++++++++++++++++++ tldr/linux/trace-cmd-record | 34 ++++++++++++++++++++++++++++ tldr/linux/trace-cmd-report | 18 +++++++++++++++ tldr/linux/wpa_cli | 12 +++++----- tldr/linux/zypper | 12 +++++----- tldr/minecraft | 2 +- tldr/od | 1 + tldr/rabbitmqctl | 29 ++++++++++++++++++++++++ tldr/rabbitmqctl-cluster | 37 +++++++++++++++++++++++++++++++ tldr/rabbitmqctl-users | 37 +++++++++++++++++++++++++++++++ tldr/rabbitmqctl-vhosts | 30 +++++++++++++++++++++++++ tldr/xxd | 1 + 41 files changed, 352 insertions(+), 139 deletions(-) create mode 100644 tldr/linux/trace-cmd-list create mode 100644 tldr/linux/trace-cmd-record create mode 100644 tldr/linux/trace-cmd-report create mode 100644 tldr/rabbitmqctl create mode 100644 tldr/rabbitmqctl-cluster create mode 100644 tldr/rabbitmqctl-users create mode 100644 tldr/rabbitmqctl-vhosts diff --git a/tldr/helm b/tldr/helm index d41e643c..ca018b8a 100644 --- a/tldr/helm +++ b/tldr/helm @@ -19,15 +19,15 @@ source: https://github.com/tldr-pages/tldr.git - List helm repositories: -`helm repo list` +`helm repo {{[ls|list]}}` - Update helm repositories: -`helm repo update` +`helm repo {{[up|update]}}` - Delete a helm repository: -`helm repo remove {{repository_name}}` +`helm repo {{[rm|remove]}} {{repository_name}}` - Install a helm chart: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Update helm dependencies: -`helm dependency update` +`helm {{[dep|dependency]}} {{[up|update]}}` diff --git a/tldr/hexdump b/tldr/hexdump index 436fa585..7abae8b5 100644 --- a/tldr/hexdump +++ b/tldr/hexdump @@ -7,6 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Display file contents in hexadecimal, decimal, octal, or ASCII. > Useful for inspecting dump file, binary data, or debug output. +> See also: `hexyl`, `od`, `xxd`. > More information: . - Print the hexadecimal representation of a file, replacing duplicate lines by `*`: diff --git a/tldr/hexyl b/tldr/hexyl index 95aa3cf9..dbfa8ad2 100644 --- a/tldr/hexyl +++ b/tldr/hexyl @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hexyl > A simple hex viewer for the terminal. Uses colored output to distinguish different categories of bytes. +> See also: `od`, `xxd`, `hexdump`. > More information: . - Print the hexadecimal representation of a file: diff --git a/tldr/linux/btrfs b/tldr/linux/btrfs index 2d7d365b..636cb6a2 100644 --- a/tldr/linux/btrfs +++ b/tldr/linux/btrfs @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Create subvolume: -`sudo btrfs subvolume create {{path/to/subvolume}}` +`sudo btrfs {{[su|subvolume]}} {{[c|create]}} {{path/to/subvolume}}` - List subvolumes: -`sudo btrfs subvolume list {{path/to/mount_point}}` +`sudo btrfs {{[su|subvolume]}} {{[l|list]}} {{path/to/mount_point}}` - Show space usage information: -`sudo btrfs filesystem df {{path/to/mount_point}}` +`sudo btrfs {{[f|filesystem]}} df {{path/to/mount_point}}` - Enable quota: -`sudo btrfs quota enable {{path/to/subvolume}}` +`sudo btrfs {{[qu|quota]}} {{[e|enable]}} {{path/to/subvolume}}` - Show quota: -`sudo btrfs qgroup show {{path/to/subvolume}}` +`sudo btrfs {{[qg|qgroup]}} {{[s|show]}} {{path/to/subvolume}}` diff --git a/tldr/linux/btrfs-balance b/tldr/linux/btrfs-balance index 92f16ccb..fbfa5b92 100644 --- a/tldr/linux/btrfs-balance +++ b/tldr/linux/btrfs-balance @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Show the status of a running or paused balance operation: -`sudo btrfs balance status {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} status {{path/to/btrfs_filesystem}}` - Balance all block groups (slow; rewrites all blocks in filesystem): -`sudo btrfs balance start {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} start {{path/to/btrfs_filesystem}}` - Balance data block groups which are less than 15% utilized, running the operation in the background: -`sudo btrfs balance start {{[--bg|--background]}} -dusage={{15}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} start {{[--bg|--background]}} -dusage={{15}} {{path/to/btrfs_filesystem}}` - Balance a max of 10 metadata chunks with less than 20% utilization and at least 1 chunk on a given device `devid` (see `btrfs filesystem show`): -`sudo btrfs balance start -musage={{20}},limit={{10}},devid={{devid}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} start -musage={{20}},limit={{10}},devid={{devid}} {{path/to/btrfs_filesystem}}` - Convert data blocks to the raid6 and metadata to raid1c3 (see mkfs.btrfs(8) for profiles): -`sudo btrfs balance start -dconvert={{raid6}} -mconvert={{raid1c3}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} start -dconvert={{raid6}} -mconvert={{raid1c3}} {{path/to/btrfs_filesystem}}` - Convert data blocks to raid1, skipping already converted chunks (e.g. after a previous cancelled conversion operation): -`sudo btrfs balance start -dconvert={{raid1}},soft {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} start -dconvert={{raid1}},soft {{path/to/btrfs_filesystem}}` - Cancel, pause, or resume a running or paused balance operation: -`sudo btrfs balance {{cancel|pause|resume}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[b|balance]}} {{cancel|pause|resume}} {{path/to/btrfs_filesystem}}` diff --git a/tldr/linux/btrfs-check b/tldr/linux/btrfs-check index e5fc17e3..adc10eb9 100644 --- a/tldr/linux/btrfs-check +++ b/tldr/linux/btrfs-check @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Check a btrfs filesystem: -`sudo btrfs check {{path/to/partition}}` +`sudo btrfs {{[c|check]}} {{path/to/partition}}` - Check and repair a btrfs filesystem (dangerous): -`sudo btrfs check --repair {{path/to/partition}}` +`sudo btrfs {{[c|check]}} --repair {{path/to/partition}}` - Show the progress of the check: -`sudo btrfs check {{[-p|--progress]}} {{path/to/partition}}` +`sudo btrfs {{[c|check]}} {{[-p|--progress]}} {{path/to/partition}}` - Verify the checksum of each data block (if the filesystem is good): -`sudo btrfs check --check-data-csum {{path/to/partition}}` +`sudo btrfs {{[c|check]}} --check-data-csum {{path/to/partition}}` - Use the `n`-th superblock (`n` can be 0, 1 or 2): -`sudo btrfs check {{[-s|--super]}} {{n}} {{path/to/partition}}` +`sudo btrfs {{[c|check]}} {{[-s|--super]}} {{n}} {{path/to/partition}}` - Rebuild the checksum tree: -`sudo btrfs check --repair --init-csum-tree {{path/to/partition}}` +`sudo btrfs {{[c|check]}} --repair --init-csum-tree {{path/to/partition}}` - Rebuild the extent tree: -`sudo btrfs check --repair --init-extent-tree {{path/to/partition}}` +`sudo btrfs {{[c|check]}} --repair --init-extent-tree {{path/to/partition}}` diff --git a/tldr/linux/btrfs-device b/tldr/linux/btrfs-device index 80a43efe..bf2bf7d4 100644 --- a/tldr/linux/btrfs-device +++ b/tldr/linux/btrfs-device @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Add one or more devices to a btrfs filesystem: -`sudo btrfs device add {{path/to/block_device1 path/to/block_device2 ...}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[d|device]}} {{[a|add]}} {{path/to/block_device1 path/to/block_device2 ...}} {{path/to/btrfs_filesystem}}` - Remove a device from a btrfs filesystem: -`sudo btrfs device remove {{path/to/device1|device_id1 path/to/device2|device_id2 ...}}` +`sudo btrfs {{[d|device]}} {{[rem|remove]}} {{path/to/device1|device_id1 path/to/device2|device_id2 ...}}` - Display error statistics: -`sudo btrfs device stats {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[d|device]}} {{[st|stats]}} {{path/to/btrfs_filesystem}}` - Scan all disks and inform the kernel of all detected btrfs filesystems: -`sudo btrfs device scan {{[-d|--all-devices]}}` +`sudo btrfs {{[d|device]}} {{[sc|scan]}} {{[-d|--all-devices]}}` - Display detailed per-disk allocation statistics: -`sudo btrfs device usage {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[d|device]}} {{[u|usage]}} {{path/to/btrfs_filesystem}}` diff --git a/tldr/linux/btrfs-filesystem b/tldr/linux/btrfs-filesystem index 59d8fceb..67e9c337 100644 --- a/tldr/linux/btrfs-filesystem +++ b/tldr/linux/btrfs-filesystem @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Show filesystem usage (optionally run as root to show detailed information): -`btrfs filesystem usage {{path/to/btrfs_mount}}` +`btrfs {{[f|filesystem]}} {{[u|usage]}} {{path/to/btrfs_mount}}` - Show usage by individual devices: -`sudo btrfs filesystem show {{path/to/btrfs_mount}}` +`sudo btrfs {{[f|filesystem]}} {{[sh|show]}} {{path/to/btrfs_mount}}` - Defragment a single file on a btrfs filesystem (avoid while a deduplication agent is running): -`sudo btrfs filesystem defragment {{[-v|--verbose]}} {{path/to/file}}` +`sudo btrfs {{[f|filesystem]}} {{[de|defragment]}} {{[-v|--verbose]}} {{path/to/file}}` - Defragment a directory recursively (does not cross subvolume boundaries): -`sudo btrfs filesystem defragment {{[-v|--verbose]}} -r {{path/to/directory}}` +`sudo btrfs {{[f|filesystem]}} {{[de|defragment]}} {{[-v|--verbose]}} -r {{path/to/directory}}` - Force syncing unwritten data blocks to disk(s): -`sudo btrfs filesystem sync {{path/to/btrfs_mount}}` +`sudo btrfs {{[f|filesystem]}} {{[sy|sync]}} {{path/to/btrfs_mount}}` - Summarize disk usage for the files in a directory recursively: -`sudo btrfs filesystem du {{[-s|--summarize]}} {{path/to/directory}}` +`sudo btrfs {{[f|filesystem]}} du {{[-s|--summarize]}} {{path/to/directory}}` - Create a swap file: -`sudo btrfs filesystem mkswapfile --size {{8g}} --uuid {{clear|random|time|UUID_value}} {{path/to/swapfile}}` +`sudo btrfs {{[f|filesystem]}} {{[m|mkswapfile]}} --size {{8g}} --uuid {{clear|random|time|UUID_value}} {{path/to/swapfile}}` diff --git a/tldr/linux/btrfs-inspect-internal b/tldr/linux/btrfs-inspect-internal index f2002842..6512dbb3 100644 --- a/tldr/linux/btrfs-inspect-internal +++ b/tldr/linux/btrfs-inspect-internal @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Print superblock's information: -`sudo btrfs inspect-internal dump-super {{path/to/partition}}` +`sudo btrfs {{[i|inspect-internal]}} {{[dump-s|dump-super]}} {{path/to/partition}}` - Print superblock's and all of its copies' information: -`sudo btrfs inspect-internal dump-super {{[-a|--all]}} {{path/to/partition}}` +`sudo btrfs {{[i|inspect-internal]}} {{[dump-s|dump-super]}} {{[-a|--all]}} {{path/to/partition}}` - Print filesystem's metadata information: -`sudo btrfs inspect-internal dump-tree {{path/to/partition}}` +`sudo btrfs {{[i|inspect-internal]}} {{[dump-t|dump-tree]}} {{path/to/partition}}` - Print list of files in inode `n`-th: -`sudo btrfs inspect-internal inode-resolve {{n}} {{path/to/btrfs_mount}}` +`sudo btrfs {{[i|inspect-internal]}} {{[i|inode-resolve]}} {{n}} {{path/to/btrfs_mount}}` - Print list of files at a given logical address: -`sudo btrfs inspect-internal logical-resolve {{logical_address}} {{path/to/btrfs_mount}}` +`sudo btrfs {{[i|inspect-internal]}} {{[lo|logical-resolve]}} {{logical_address}} {{path/to/btrfs_mount}}` - Print stats of root, extent, csum and fs trees: -`sudo btrfs inspect-internal tree-stats {{path/to/partition}}` +`sudo btrfs {{[i|inspect-internal]}} {{[t|tree-stats]}} {{path/to/partition}}` diff --git a/tldr/linux/btrfs-property b/tldr/linux/btrfs-property index 1c2184ca..80ea511e 100644 --- a/tldr/linux/btrfs-property +++ b/tldr/linux/btrfs-property @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - List available properties (and descriptions) for the given btrfs object: -`sudo btrfs property list {{path/to/btrfs_object}}` +`sudo btrfs {{[p|property]}} {{[l|list]}} {{path/to/btrfs_object}}` - Get all properties for the given btrfs object: -`sudo btrfs property get {{path/to/btrfs_object}}` +`sudo btrfs {{[p|property]}} {{[g|get]}} {{path/to/btrfs_object}}` - Get the `label` property for the given btrfs filesystem or device: -`sudo btrfs property get {{path/to/btrfs_filesystem}} label` +`sudo btrfs {{[p|property]}} {{[g|get]}} {{path/to/btrfs_filesystem}} label` - Get all object type-specific properties for the given btrfs filesystem or device: -`sudo btrfs property get -t {{subvol|filesystem|inode|device}} {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[p|property]}} {{[g|get]}} -t {{subvol|filesystem|inode|device}} {{path/to/btrfs_filesystem}}` - Set the `compression` property for a given btrfs inode (either a file or directory): -`sudo btrfs property set {{path/to/btrfs_inode}} compression {{zstd|zlib|lzo|none}}` +`sudo btrfs {{[p|property]}} {{[s|set]}} {{path/to/btrfs_inode}} compression {{zstd|zlib|lzo|none}}` diff --git a/tldr/linux/btrfs-rescue b/tldr/linux/btrfs-rescue index a45d2869..67892ea8 100644 --- a/tldr/linux/btrfs-rescue +++ b/tldr/linux/btrfs-rescue @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Rebuild the filesystem metadata tree (very slow): -`sudo btrfs rescue chunk-recover {{path/to/partition}}` +`sudo btrfs {{[resc|rescue]}} {{[ch|chunk-recover]}} {{path/to/partition}}` - Fix device size alignment related problems (e.g. unable to mount the filesystem with super total bytes mismatch): -`sudo btrfs rescue fix-device-size {{path/to/partition}}` +`sudo btrfs {{[resc|rescue]}} {{[fix-de|fix-device-size]}} {{path/to/partition}}` - Recover a corrupted superblock from correct copies (recover the root of filesystem tree): -`sudo btrfs rescue super-recover {{path/to/partition}}` +`sudo btrfs {{[resc|rescue]}} {{[s|super-recover]}} {{path/to/partition}}` - Recover from an interrupted transactions (fixes log replay problems): -`sudo btrfs rescue zero-log {{path/to/partition}}` +`sudo btrfs {{[resc|rescue]}} {{[z|zero-log]}} {{path/to/partition}}` - Create a `/dev/btrfs-control` control device when `mknod` is not installed: -`sudo btrfs rescue create-control-device` +`sudo btrfs {{[resc|rescue]}} {{[c|create-control-device]}}` diff --git a/tldr/linux/btrfs-restore b/tldr/linux/btrfs-restore index 33018b82..2cd95aa0 100644 --- a/tldr/linux/btrfs-restore +++ b/tldr/linux/btrfs-restore @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Restore all files from a btrfs filesystem to a given directory: -`sudo btrfs restore {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs {{[rest|restore]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` - List (don't write) files to be restored from a btrfs filesystem: -`sudo btrfs restore {{[-D|--dry-run]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs {{[rest|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): -`sudo btrfs restore --path-regex {{regex}} -c {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs {{[rest|restore]}} --path-regex {{regex}} -c {{path/to/btrfs_device}} {{path/to/target_directory}}` - Restore files from a btrfs filesystem using a specific root [t]ree `bytenr` (see `btrfs-find-root`): -`sudo btrfs restore -t {{bytenr}} {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs {{[rest|restore]}} -t {{bytenr}} {{path/to/btrfs_device}} {{path/to/target_directory}}` - Restore files from a btrfs filesystem (along with metadata, extended attributes, and Symlinks), overwriting files in the target: -`sudo btrfs restore {{[-m|--metadata]}} {{[-x|--xattr]}} {{[-S|--symlinks]}} {{[-o|--overwrite]}} {{path/to/btrfs_device}} {{path/to/target_directory}}` +`sudo btrfs {{[rest|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 329f11ec..6beb1fc6 100644 --- a/tldr/linux/btrfs-scrub +++ b/tldr/linux/btrfs-scrub @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Start a scrub: -`sudo btrfs scrub start {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} start {{path/to/btrfs_mount}}` - Show the status of an ongoing or last completed scrub: -`sudo btrfs scrub status {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} status {{path/to/btrfs_mount}}` - Cancel an ongoing scrub: -`sudo btrfs scrub cancel {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} {{[c|cancel]}} {{path/to/btrfs_mount}}` - Resume a previously cancelled scrub: -`sudo btrfs scrub resume {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} {{[r|resume]}} {{path/to/btrfs_mount}}` - Start a scrub, but do not put the program in the [B]ackground: -`sudo btrfs scrub start -B {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} start -B {{path/to/btrfs_mount}}` - Start a scrub in quiet mode (does not print errors or statistics): -`sudo btrfs scrub start {{[-q|--quiet]}} {{path/to/btrfs_mount}}` +`sudo btrfs {{[sc|scrub]}} start {{[-q|--quiet]}} {{path/to/btrfs_mount}}` diff --git a/tldr/linux/btrfs-subvolume b/tldr/linux/btrfs-subvolume index 4c7c3680..d1b4d800 100644 --- a/tldr/linux/btrfs-subvolume +++ b/tldr/linux/btrfs-subvolume @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Create a new empty subvolume: -`sudo btrfs subvolume create {{path/to/new_subvolume}}` +`sudo btrfs {{[su|subvolume]}} {{[c|create]}} {{path/to/new_subvolume}}` - List all subvolumes and snapshots in the specified filesystem: -`sudo btrfs subvolume list {{path/to/btrfs_filesystem}}` +`sudo btrfs {{[su|subvolume]}} {{[l|list]}} {{path/to/btrfs_filesystem}}` - Delete a subvolume: -`sudo btrfs subvolume delete {{path/to/subvolume}}` +`sudo btrfs {{[su|subvolume]}} {{[d|delete]}} {{path/to/subvolume}}` - Create a [r]ead-only snapshot of an existing subvolume: -`sudo btrfs subvolume snapshot -r {{path/to/source_subvolume}} {{path/to/target}}` +`sudo btrfs {{[su|subvolume]}} {{[sn|snapshot]}} -r {{path/to/source_subvolume}} {{path/to/target}}` - Create a read-write snapshot of an existing subvolume: -`sudo btrfs subvolume snapshot {{path/to/source_subvolume}} {{path/to/target}}` +`sudo btrfs {{[su|subvolume]}} {{[sn|snapshot]}} {{path/to/source_subvolume}} {{path/to/target}}` - Show detailed information about a subvolume: -`sudo btrfs subvolume show {{path/to/subvolume}}` +`sudo btrfs {{[su|subvolume]}} {{[sh|show]}} {{path/to/subvolume}}` diff --git a/tldr/linux/btrfs-version b/tldr/linux/btrfs-version index 1ca6758d..7bdea281 100644 --- a/tldr/linux/btrfs-version +++ b/tldr/linux/btrfs-version @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`btrfs version --help` +`btrfs {{[v|version]}} --help` - Display version: -`btrfs version` +`btrfs {{[v|version]}}` diff --git a/tldr/linux/counter-strike-2 b/tldr/linux/counter-strike-2 index c1be36be..66849ba8 100644 --- a/tldr/linux/counter-strike-2 +++ b/tldr/linux/counter-strike-2 @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, linux] source: https://github.com/tldr-pages/tldr.git --- -# counter strike 2 +# Counter Strike 2 > Host a headless Counter Strike 2 server. > More information: . diff --git a/tldr/linux/factorio b/tldr/linux/factorio index 9860e122..c9271293 100644 --- a/tldr/linux/factorio +++ b/tldr/linux/factorio @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, linux] source: https://github.com/tldr-pages/tldr.git --- -# factorio +# Factorio > Create and start a headless Factorio server. > More information: . diff --git a/tldr/linux/hexdump b/tldr/linux/hexdump index 7047e7a1..3b62243b 100644 --- a/tldr/linux/hexdump +++ b/tldr/linux/hexdump @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hexdump > An ASCII, decimal, hexadecimal, octal dump. +> See also: `hexyl`, `od`, `xxd`. > More information: . - Print the hexadecimal representation of a file, replacing duplicate lines by '*': diff --git a/tldr/linux/netplan b/tldr/linux/netplan index 3b378602..5148dd76 100644 --- a/tldr/linux/netplan +++ b/tldr/linux/netplan @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # netplan > Network configuration utility using YAML. -> More information: . +> More information: . - Apply a network configuration and make it persistent: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Try configuration changes without applying them permanently: -`sudo netplan try --timeout={{seconds}}` +`sudo netplan try --timeout {{seconds}}` - Return to previous working configuration after failed apply: diff --git a/tldr/linux/nmcli b/tldr/linux/nmcli index c3e6bbca..4214716b 100644 --- a/tldr/linux/nmcli +++ b/tldr/linux/nmcli @@ -8,17 +8,17 @@ source: https://github.com/tldr-pages/tldr.git > Manage the network configuration using NetworkManager. > More information: . -- View documentation for running `nmcli` as a NetworkManager secret/polkit agent: +- View documentation for managing network interfaces and establishing new Wi-Fi connections: -`tldr nmcli agent` +`tldr nmcli device` - View documentation for managing network connections: `tldr nmcli connection` -- View documentation for managing network interfaces and establishing new Wi-Fi connections: +- View documentation for running `nmcli` as a NetworkManager secret/polkit agent: -`tldr nmcli device` +`tldr nmcli agent` - View documentation for managing general settings of NetworkManager: diff --git a/tldr/linux/nmcli-agent b/tldr/linux/nmcli-agent index 2211c405..3c8d1791 100644 --- a/tldr/linux/nmcli-agent +++ b/tldr/linux/nmcli-agent @@ -6,17 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # nmcli agent > Run `nmcli` as a NetworkManager secret agent or polkit agent. -> This subcommand can also be called with `nmcli a`. > More information: . - Register `nmcli` as a secret agent and listen for secret requests: -`nmcli agent secret` +`nmcli {{[a|agent]}} {{[s|secret]}}` - Register `nmcli` as a polkit agent and listen for authorization requests: -`nmcli agent polkit` +`nmcli {{[a|agent]}} {{[p|polkit]}}` - Register `nmcli` as a secret agent and a polkit agent: -`nmcli agent all` +`nmcli {{[a|agent]}} {{[a|all]}}` diff --git a/tldr/linux/nmcli-connection b/tldr/linux/nmcli-connection index 762c4d22..2d566668 100644 --- a/tldr/linux/nmcli-connection +++ b/tldr/linux/nmcli-connection @@ -6,33 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # nmcli connection > Manage connections with NetworkManager. -> This subcommand can also be called with `nmcli c`. > More information: . - List all NetworkManager connections (shows name, UUID, type and device): -`nmcli connection` +`nmcli {{[c|connection]}}` - Activate a connection: -`nmcli connection up uuid {{uuid}}` +`nmcli {{[c|connection]}} {{[u|up]}} {{uuid}}` - Deactivate a connection: -`nmcli connection down uuid {{uuid}}` +`nmcli {{[c|connection]}} {{[d|down]}} {{uuid}}` - Create an auto-configured dual stack connection: -`nmcli connection add ifname {{interface_name}} type {{ethernet}} ipv4.method {{auto}} ipv6.method {{auto}}` +`nmcli {{[c|connection]}} {{[a|add]}} ifname {{interface_name}} type {{ethernet}} ipv4.method {{auto}} ipv6.method {{auto}}` - Create a static IPv6-only connection: -`nmcli connection add ifname {{interface_name}} type {{ethernet}} ip6 {{2001:db8::2/64}} gw6 {{2001:db8::1}} ipv6.dns {{2001:db8::1}} ipv4.method {{ignore}}` +`nmcli {{[c|connection]}} {{[a|add]}} ifname {{interface_name}} type {{ethernet}} ip6 {{2001:db8::2/64}} gw6 {{2001:db8::1}} ipv6.dns {{2001:db8::1}} ipv4.method {{ignore}}` - Create a static IPv4-only connection: -`nmcli connection add ifname {{interface_name}} type {{ethernet}} ip4 {{10.0.0.7/8}} gw4 {{10.0.0.1}} ipv4.dns {{10.0.0.1}} ipv6.method {{ignore}}` +`nmcli {{[c|connection]}} {{[a|add]}} ifname {{interface_name}} type {{ethernet}} ip4 {{10.0.0.7/8}} gw4 {{10.0.0.1}} ipv4.dns {{10.0.0.1}} ipv6.method {{ignore}}` - Create a VPN connection using OpenVPN from an OVPN file: -`nmcli connection import type {{openvpn}} file {{path/to/vpn_config.ovpn}}` +`nmcli {{[c|connection]}} {{[i|import]}} type {{openvpn}} file {{path/to/vpn_config.ovpn}}` diff --git a/tldr/linux/nmcli-device b/tldr/linux/nmcli-device index 7d9380ce..5a6c1974 100644 --- a/tldr/linux/nmcli-device +++ b/tldr/linux/nmcli-device @@ -6,21 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # nmcli device > Manage network interfaces and establish new Wi-Fi connections using NetworkManager. -> This subcommand can also be called with `nmcli d`. > More information: . - Print the statuses of all network interfaces: -`nmcli device status` +`nmcli {{[d|device]}}` - Print the available Wi-Fi access points: -`nmcli device wifi` +`nmcli {{[d|device]}} {{[w|wifi]}}` - Connect to a Wi-Fi network with the specified SSID (you will be prompted for a password): -`nmcli --ask device wifi connect {{ssid}}` +`nmcli {{[d|device]}} {{[w|wifi]}} {{[c|connect]}} {{ssid}} {{[-a|--ask]}}` - Print the password and QR code for the current Wi-Fi network: -`nmcli device wifi show-password` +`nmcli {{[d|device]}} {{[w|wifi]}} {{[s|show-password]}}` diff --git a/tldr/linux/nmcli-general b/tldr/linux/nmcli-general index f95b215f..48e8c689 100644 --- a/tldr/linux/nmcli-general +++ b/tldr/linux/nmcli-general @@ -6,29 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # nmcli general > Manage general settings of NetworkManager. -> This subcommand can also be called with `nmcli g`. > More information: . - Show the general status of NetworkManager: -`nmcli general` +`nmcli {{[g|general]}}` - Show the hostname of the current device: -`nmcli general hostname` +`nmcli {{[g|general]}} {{[h|hostname]}}` - Change the hostname of the current device: -`sudo nmcli general hostname {{new_hostname}}` +`sudo nmcli {{[g|general]}} {{[h|hostname]}} {{new_hostname}}` - Show the permissions of NetworkManager: -`nmcli general permissions` +`nmcli {{[g|general]}} {{[p|permissions]}}` - Show the current logging level and domains: -`nmcli general logging` +`nmcli {{[g|general]}} {{[l|logging]}}` - Set the logging level and/or domains (see `man NetworkManager.conf` for all available domains): -`nmcli general logging level {{INFO|OFF|ERR|WARN|DEBUG|TRACE}} domain {{domain_1,domain_2,...}}` +`sudo nmcli {{[g|general]}} {{[l|logging]}} {{[l|level]}} {{INFO|OFF|ERR|WARN|DEBUG|TRACE}} domain {{domain_1,domain_2,...}}` diff --git a/tldr/linux/nmcli-monitor b/tldr/linux/nmcli-monitor index 8d144fbc..dc12ca56 100644 --- a/tldr/linux/nmcli-monitor +++ b/tldr/linux/nmcli-monitor @@ -6,9 +6,8 @@ source: https://github.com/tldr-pages/tldr.git # nmcli monitor > Monitor changes to the NetworkManager connection status. -> This subcommand can also be called with `nmcli m`. > More information: . - Start monitoring NetworkManager changes: -`nmcli monitor` +`nmcli {{[m|monitor]}}` diff --git a/tldr/linux/nmcli-networking b/tldr/linux/nmcli-networking index 52beae36..9ddb464e 100644 --- a/tldr/linux/nmcli-networking +++ b/tldr/linux/nmcli-networking @@ -6,21 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # nmcli networking > Manage the networking status of NetworkManager. -> This subcommand can also be called with `nmcli n`. > More information: . - Show the networking status of NetworkManager: -`nmcli networking` +`nmcli {{[n|networking]}}` - Enable or disable networking and all interfaces managed by NetworkManager: -`nmcli networking {{on|off}}` +`nmcli {{[n|networking]}} {{on|off}}` - Show the last known connectivity state: -`nmcli networking connectivity` +`nmcli {{[n|networking]}} {{[c|connectivity]}}` - Show the current connectivity state: -`nmcli networking connectivity check` +`nmcli {{[n|networking]}} {{[c|connectivity]}} {{[c|check]}}` diff --git a/tldr/linux/nmcli-radio b/tldr/linux/nmcli-radio index e6a1db9c..2a153838 100644 --- a/tldr/linux/nmcli-radio +++ b/tldr/linux/nmcli-radio @@ -6,29 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # nmcli radio > Show the status of radio switches or enable/disable them using NetworkManager. -> This subcommand can also be called with `nmcli r`. > More information: . - Show status of Wi-Fi: -`nmcli radio wifi` +`nmcli {{[r|radio]}} {{[w|wifi]}}` - Turn Wi-Fi on or off: -`nmcli radio wifi {{on|off}}` +`nmcli {{[r|radio]}} {{[w|wifi]}} {{on|off}}` - Show status of WWAN: -`nmcli radio wwan` +`nmcli {{[r|radio]}} {{[ww|wwan]}}` - Turn WWAN on or off: -`nmcli radio wwan {{on|off}}` +`nmcli {{[r|radio]}} {{[ww|wwan]}} {{on|off}}` - Show status of both switches: -`nmcli radio all` +`nmcli {{[r|radio]}}` - Turn both switches on or off: -`nmcli radio all {{on|off}}` +`nmcli {{[r|radio]}} {{[a|all]}} {{on|off}}` diff --git a/tldr/linux/terraria b/tldr/linux/terraria index d2bab755..cb89e3e8 100644 --- a/tldr/linux/terraria +++ b/tldr/linux/terraria @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, linux] source: https://github.com/tldr-pages/tldr.git --- -# terraria +# Terraria > Create and start a headless Terraria server. > More information: . diff --git a/tldr/linux/trace-cmd b/tldr/linux/trace-cmd index 14935f05..f06bec38 100644 --- a/tldr/linux/trace-cmd +++ b/tldr/linux/trace-cmd @@ -6,33 +6,37 @@ source: https://github.com/tldr-pages/tldr.git # trace-cmd > Utility to interact with the Ftrace Linux kernel internal tracer. -> This utility only runs as root. +> See also: `trace-cmd list`, `trace-cmd record`, `trace-cmd report`. > More information: . - Display the status of tracing system: -`trace-cmd stat` +`sudo trace-cmd stat` - List available tracers: -`trace-cmd list -t` +`sudo trace-cmd list -t` - Start tracing with a specific plugin: -`trace-cmd start -p {{timerlat|osnoise|hwlat|blk|mmiotrace|function_graph|wakeup_dl|wakeup_rt|wakeup|function|nop}}` +`sudo trace-cmd start -p {{function|function_graph|preemptirqsoff|irqsoff|preemptoff|wakeup|...}}` - View the trace output: -`trace-cmd show` +`sudo trace-cmd show` - Stop the tracing but retain the buffers: -`trace-cmd stop` +`sudo trace-cmd stop` - Clear the trace buffers: -`trace-cmd clear` +`sudo trace-cmd clear` -- Clear the trace buffers and stop tracing: +- Record a trace: -`trace-cmd reset` +`sudo trace-cmd record` + +- Display the recorded trace: + +`sudo trace-cmd report` diff --git a/tldr/linux/trace-cmd-list b/tldr/linux/trace-cmd-list new file mode 100644 index 00000000..c788cbf0 --- /dev/null +++ b/tldr/linux/trace-cmd-list @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trace-cmd list + +> Show available tracers, events, or options for tracing. +> See also: `trace-cmd record`, `trace-cmd report`. +> More information: . + +- List available tracers: + +`sudo trace-cmd list -t` + +- List available plugins: + +`sudo trace-cmd list -p` + +- List available events: + +`sudo trace-cmd list -e` + +- List available functions: + +`sudo trace-cmd list -f` diff --git a/tldr/linux/trace-cmd-record b/tldr/linux/trace-cmd-record new file mode 100644 index 00000000..f722c926 --- /dev/null +++ b/tldr/linux/trace-cmd-record @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trace-cmd record + +> Capture kernel trace events. +> See also: `trace-cmd list`, `trace-cmd report`. +> More information: . + +- Record a trace with a specific plugin: + +`sudo trace-cmd record -p {{plugin}}` + +- Record a trace of a specific executable: + +`sudo trace-cmd record -F {{executable}}` + +- Record a trace of a specific function: + +`sudo trace-cmd record -g {{function}}` + +- Exclude a specific function from the trace: + +`sudo trace-cmd record -n {{function}}` + +- Limit the function call graph depth: + +`sudo trace-cmd record --max-graph-depth {{depth}}` + +- Record a trace from a specific process ID: + +`sudo trace-cmd record -P {{pid}}` diff --git a/tldr/linux/trace-cmd-report b/tldr/linux/trace-cmd-report new file mode 100644 index 00000000..8cf92a58 --- /dev/null +++ b/tldr/linux/trace-cmd-report @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trace-cmd report + +> Display recorded trace events. +> See also: `trace-cmd list`, `trace-cmd record`. +> More information: . + +- Display the recorded trace: + +`sudo trace-cmd report` + +- Display the recorded trace for a specific CPU: + +`sudo trace-cmd report --cpu {{cpu_number}}` diff --git a/tldr/linux/wpa_cli b/tldr/linux/wpa_cli index c0515cd2..38cf7d77 100644 --- a/tldr/linux/wpa_cli +++ b/tldr/linux/wpa_cli @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Scan for available networks: -`wpa_cli scan` +`sudo wpa_cli scan` - Show scan results: -`wpa_cli scan_results` +`sudo wpa_cli scan_results` - Add a network: -`wpa_cli add_network {{number}}` +`sudo wpa_cli {{[add_n|add_network]}} {{number}}` - Set a network's SSID: -`wpa_cli set_network {{number}} ssid "{{SSID}}"` +`sudo wpa_cli {{[set_n|set_network]}} {{number}} ssid "{{SSID}}"` - Enable network: -`wpa_cli enable_network {{number}}` +`sudo wpa_cli {{[en|enable_network]}} {{number}}` - Save config: -`wpa_cli save_config` +`sudo wpa_cli {{[sa|save_config]}}` diff --git a/tldr/linux/zypper b/tldr/linux/zypper index 50c463c9..cb44edc8 100644 --- a/tldr/linux/zypper +++ b/tldr/linux/zypper @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Synchronize list of packages and versions available: -`zypper refresh` +`zypper {{[ref|refresh]}}` - Install a new package: -`zypper install {{package}}` +`zypper {{[in|install]}} {{package}}` - Remove a package: -`zypper remove {{package}}` +`zypper {{[rm|remove]}} {{package}}` - Upgrade installed packages to the newest available versions: -`zypper update` +`zypper {{[up|update]}}` - Search package via keyword: -`zypper search {{keyword}}` +`zypper {{[se|search]}} {{keyword}}` - Show information related to configured repositories: -`zypper repos --sort-by-priority` +`zypper {{[lr|repos]}} --sort-by-priority` diff --git a/tldr/minecraft b/tldr/minecraft index 2372414c..acc1042b 100644 --- a/tldr/minecraft +++ b/tldr/minecraft @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# minecraft +# Minecraft > Run a headless Minecraft server. > More information: . diff --git a/tldr/od b/tldr/od index 35d8befb..554f285a 100644 --- a/tldr/od +++ b/tldr/od @@ -7,6 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Display file contents in octal, decimal or hexadecimal format. > Optionally display the byte offsets and/or printable representation for each line. +> See also: `hexyl`, `xxd`, `hexdump`. > More information: . - Display file using default settings: octal format, 8 bytes per line, byte offsets in octal, and duplicate lines replaced with `*`: diff --git a/tldr/rabbitmqctl b/tldr/rabbitmqctl new file mode 100644 index 00000000..26b4a22d --- /dev/null +++ b/tldr/rabbitmqctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rabbitmqctl + +> Manage, configure, and inspect RabbitMQ servers. +> More information: . + +- Display the status of the current node: + +`rabbitmqctl status` + +- View documentation for RabbitMQ cluster commands: + +`tldr rabbitmqctl cluster` + +- View documentation for RabbitMQ user commands: + +`tldr rabbitmqctl users` + +- View documentation for RabbitMQ vhosts commands: + +`tldr rabbitmqctl vhosts` + +- Learn more about a specific command: + +`rabbitmqctl help {{command}}` diff --git a/tldr/rabbitmqctl-cluster b/tldr/rabbitmqctl-cluster new file mode 100644 index 00000000..55470e7a --- /dev/null +++ b/tldr/rabbitmqctl-cluster @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rabbitmqctl-cluster + +> Manage RabbitMQ nodes in a cluster. +> More information: . + +- Display the status of the cluster: + +`rabbitmqctl cluster_status` + +- Display the status of the current node: + +`rabbitmqctl status` + +- Start the RabbitMQ application on a specific node: + +`rabbitmqctl {{[-n|--node]}} {{nodename}} start_app` + +- Stop the RabbitMQ application on a specific node: + +`rabbitmqctl {{[-n|--node]}} {{nodename}} stop_app` + +- Stop a specific RabbitMQ node: + +`rabbitmqctl {{[-n|--node]}} {{nodename}} stop` + +- Reset a specific RabbitMQ node to a clean state: + +`rabbitmqctl {{[-n|--node]}} {{nodename}} reset` + +- Make the current node join an existing cluster: + +`rabbitmqctl join_cluster {{nodename}}` diff --git a/tldr/rabbitmqctl-users b/tldr/rabbitmqctl-users new file mode 100644 index 00000000..ba49bed2 --- /dev/null +++ b/tldr/rabbitmqctl-users @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rabbitmqctl-users + +> Manage RabbitMQ users, their permissions, and tags. +> More information: . + +- List all users: + +`rabbitmqctl list_users` + +- Add a new user with a password: + +`rabbitmqctl add_user {{username}} {{password}}` + +- Delete an existing user: + +`rabbitmqctl delete_user {{username}}` + +- Change the password for a user: + +`rabbitmqctl change_password {{username}} {{new_password}}` + +- Set permissions for a user on a specific virtual host: + +`rabbitmqctl set_permissions {{[-p|--vhost]}} {{vhost}} {{username}} {{read}} {{write}} {{configure}}` + +- Clear all permissions for a user on a specific virtual host: + +`rabbitmqctl clear_permissions {{[-p|--vhost]}} {{vhost}} {{username}}` + +- Assign one or more tags (e.g., administrator) to a user: + +`rabbitmqctl set_user_tags {{username}} {{tag1}} [{{tag2}}]` diff --git a/tldr/rabbitmqctl-vhosts b/tldr/rabbitmqctl-vhosts new file mode 100644 index 00000000..1d13fed4 --- /dev/null +++ b/tldr/rabbitmqctl-vhosts @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rabbitmqctl-vhosts + +> Manage virtual hosts (vhosts) in RabbitMQ. +> Vhosts are used to separate multiple logical brokers on the same RabbitMQ server. +> More information: . + +- List all virtual hosts: + +`rabbitmqctl list_vhosts` + +- Add a new virtual host: + +`rabbitmqctl add_vhost {{vhost_name}}` + +- Delete a virtual host: + +`rabbitmqctl delete_vhost {{vhost_name}}` + +- Set permissions for a user on a specific virtual host: + +`rabbitmqctl set_permissions {{[-p|--vhost]}} {{vhost_name}} {{username}} {{read}} {{write}} {{configure}}` + +- Clear permissions for a user on a specific virtual host: + +`rabbitmqctl clear_permissions {{[-p|--vhost]}} {{vhost_name}} {{username}}` diff --git a/tldr/xxd b/tldr/xxd index 86d3acc5..5a42063c 100644 --- a/tldr/xxd +++ b/tldr/xxd @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xxd > Create a hexadecimal representation (hexdump) from a binary file, or vice-versa. +> See also: `hexyl`, `od`, `hexdump`. > More information: . - Generate a hexdump from a binary file and display the output: