diff --git a/tldr/asdf b/tldr/asdf index 2bd7bbaa..f1b31486 100644 --- a/tldr/asdf +++ b/tldr/asdf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # asdf > Command-line interface for managing versions of different packages. -> More information: . +> More information: . - List all available plugins: @@ -26,8 +26,12 @@ source: https://github.com/tldr-pages/tldr.git - Set global version for a package: -`asdf global {{name}} {{version}}` +`asdf set -u {{name}} {{version}}` - Set local version for a package: -`asdf local {{name}} {{version}}` +`asdf set {{name}} {{version}}` + +- See the current version used for a package: + +`asdf current {{name}}` diff --git a/tldr/at b/tldr/at index 37cbbf58..19828c8b 100644 --- a/tldr/at +++ b/tldr/at @@ -9,10 +9,6 @@ source: https://github.com/tldr-pages/tldr.git > Results will be sent to the users mail. > More information: . -- Start the `atd` daemon: - -`systemctl start atd` - - Create commands interactively and execute them in 5 minutes (press `` when done): `at now + 5 minutes` diff --git a/tldr/autoconf b/tldr/autoconf index 3a4729fe..55b35de1 100644 --- a/tldr/autoconf +++ b/tldr/autoconf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # autoconf > Generate configuration scripts to automatically configure software source code packages. -> More information: . +> More information: . - Generate a configuration script from `configure.ac` (if present) or `configure.in` and save this script to `configure`: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate a configuration script from the specified template (even if the input file has not changed) and write the output to a file: -`autoconf --force --output {{outfile}} {{template-file}}` +`autoconf {{[-f|--force]}} {{[-o|--output]}} {{outfile}} {{template-file}}` diff --git a/tldr/b2sum b/tldr/b2sum index ed20d091..caf47c19 100644 --- a/tldr/b2sum +++ b/tldr/b2sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of BLAKE2 checksums and filenames and verify all files have matching checksums: -`b2sum --check {{path/to/file.b2}}` +`b2sum {{[-c|--check]}} {{path/to/file.b2}}` - Only show a message for missing files or when verification fails: -`b2sum --check --quiet {{path/to/file.b2}}` +`b2sum {{[-c|--check]}} --quiet {{path/to/file.b2}}` - Only show a message when verification fails, ignoring missing files: -`b2sum --ignore-missing --check --quiet {{path/to/file.b2}}` +`b2sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.b2}}` - Check a known BLAKE2 checksum of a file: -`echo {{known_blake2_checksum_of_the_file}} {{path/to/file}} | b2sum --check` +`echo {{known_blake2_checksum_of_the_file}} {{path/to/file}} | b2sum {{[-c|--check]}}` diff --git a/tldr/b3sum b/tldr/b3sum index ab136a3e..d637834b 100644 --- a/tldr/b3sum +++ b/tldr/b3sum @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of BLAKE3 checksums and filenames and verify all files have matching checksums: -`b3sum --check {{path/to/file.b3}}` +`b3sum {{[-c|--check]}} {{path/to/file.b3}}` - Only show a message for missing files or when verification fails: -`b3sum --check --quiet {{path/to/file.b3}}` +`b3sum {{[-c|--check]}} --quiet {{path/to/file.b3}}` - Check a known BLAKE3 checksum of a file: -`echo {{known_blake3_checksum_of_the_file}} {{path/to/file}} | b3sum --check` +`echo {{known_blake3_checksum_of_the_file}} {{path/to/file}} | b3sum {{[-c|--check]}}` diff --git a/tldr/batch b/tldr/batch index 912528e3..b71159ee 100644 --- a/tldr/batch +++ b/tldr/batch @@ -10,10 +10,6 @@ source: https://github.com/tldr-pages/tldr.git > See also: `at`, `atq`, `atrm` `mail`. > More information: . -- Start the `atd` daemon: - -`systemctl start atd` - - Execute commands from `stdin` (press `` when done): `batch` diff --git a/tldr/bind b/tldr/bind index 3095bd49..a19e7408 100644 --- a/tldr/bind +++ b/tldr/bind @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bind > Bash builtin to manage bash hotkeys and variables. -> More information: . +> More information: . - List all bound commands and their hotkeys: diff --git a/tldr/bison b/tldr/bison index 1d172907..c770dfd3 100644 --- a/tldr/bison +++ b/tldr/bison @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bison > GNU parser generator. -> More information: . +> More information: . - Compile a bison definition file: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Compile in debug mode, which causes the resulting parser to write additional information to `stdout`: -`bison --debug {{path/to/file.y}}` +`bison {{[-t|--debug]}} {{path/to/file.y}}` - Specify the output filename: -`bison --output {{path/to/output.c}} {{path/to/file.y}}` +`bison {{[-o|--output]}} {{path/to/output.c}} {{path/to/file.y}}` - Be verbose when compiling: -`bison --verbose` +`bison {{[-v|--verbose]}}` diff --git a/tldr/chroot b/tldr/chroot index 5ab97515..05d2b5f0 100644 --- a/tldr/chroot +++ b/tldr/chroot @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Run command as new root directory: -`chroot {{path/to/new/root}} {{command}}` +`sudo chroot {{path/to/new/root}} {{command}}` - Use a specific user and group: -`chroot --userspec={{username_or_id:group_name_or_id}}` +`sudo chroot --userspec {{username_or_id:group_name_or_id}}` diff --git a/tldr/complete b/tldr/complete index 1dbb1282..247a1756 100644 --- a/tldr/complete +++ b/tldr/complete @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # complete > Get argument autocompletion to shell commands. -> More information: . +> More information: . - Apply a function that performs autocompletion to a command: diff --git a/tldr/cvs b/tldr/cvs index 60c1a87d..a8f52f3a 100644 --- a/tldr/cvs +++ b/tldr/cvs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cvs > Concurrent Versions System, a revision control system. -> More information: . +> More information: . - Create a new repository (requires the `CVSROOT` environment variable to be set externally): diff --git a/tldr/date b/tldr/date index 2b2212e9..ec9e7905 100644 --- a/tldr/date +++ b/tldr/date @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the current date in UTC, using the ISO 8601 format: -`date -u +%Y-%m-%dT%H:%M:%S%Z` +`date {{[-u|--utc]}} +%Y-%m-%dT%H:%M:%S%Z` - Display the current date as a Unix timestamp (seconds since the Unix epoch): @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Convert a date specified as a Unix timestamp to the default format: -`date -d @{{1473305798}}` +`date {{[-d|--date]}} @{{1473305798}}` - Convert a given date to the Unix timestamp format: -`date -d "{{2018-09-01 00:00}}" +%s --utc` +`date {{[-d|--date]}} "{{2018-09-01 00:00}}" +%s {{[-u|--utc]}}` - Display the current date using the RFC-3339 format (`YYYY-MM-DD hh:mm:ss TZ`): diff --git a/tldr/dc b/tldr/dc index 30388d4c..b6692791 100644 --- a/tldr/dc +++ b/tldr/dc @@ -19,16 +19,16 @@ source: https://github.com/tldr-pages/tldr.git - Calculate an expression with the specified scale: -`dc --expression='{{10}} k {{5 3 /}} p'` +`dc {{[-e|--expression]}} '{{10}} k {{5 3 /}} p'` - Calculate 4 times 5 (4 5 *), subtract 17 (17 -), and [p]rint the output: -`dc --expression='4 5 * 17 - p'` +`dc {{[-e|--expression]}} '4 5 * 17 - p'` - Specify the number of decimal places to 7 (7 k), calculate 5 divided by -3 (5 _3 /) and [p]rint: -`dc --expression='7 k 5 _3 / p'` +`dc {{[-e|--expression]}} '7 k 5 _3 / p'` - Calculate the golden ratio, phi: set number of decimal places to 100 (100 k), square root of 5 (5 v) plus 1 (1 +), divided by 2 (2 /), and [p]rint result: -`dc --expression='100 k 5 v 1 + 2 / p'` +`dc {{[-e|--expression]}} '100 k 5 v 1 + 2 / p'` diff --git a/tldr/dircolors b/tldr/dircolors index 2333f53a..6bd0a360 100644 --- a/tldr/dircolors +++ b/tldr/dircolors @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Output commands for Bourne shell: -`dircolors --bourne-shell` +`dircolors {{[-b|--bourne-shell]}}` - Output commands for C shell: -`dircolors --c-shell` +`dircolors {{[-c|--c-shell]}}` - View the default colors for file types and extensions: -`dircolors --print-data` +`dircolors {{[-p|--print-database]}}` diff --git a/tldr/dirname b/tldr/dirname index 7565b38b..11a56369 100644 --- a/tldr/dirname +++ b/tldr/dirname @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Delimit output with a NUL character instead of a newline (useful when combining with `xargs`): -`dirname --zero {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` +`dirname {{[-z|--zero]}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/tldr/emacsclient b/tldr/emacsclient index 00bafe8c..f8364b06 100644 --- a/tldr/emacsclient +++ b/tldr/emacsclient @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Open a file in console mode (without an X window): -`emacsclient --no-window-system {{path/to/file}}` +`emacsclient {{[-nw|--no-window-system]}} {{path/to/file}}` - Open a file in a new Emacs window: -`emacsclient --create-frame {{path/to/file}}` +`emacsclient {{[-c|--create-frame]}} {{path/to/file}}` - Evaluate a command, printing the output to `stdout`, and then quit: -`emacsclient --eval '({{command}})'` +`emacsclient {{[-e|--eval]}} '({{command}})'` - Specify an alternative editor in case no Emacs server is running: -`emacsclient --alternate-editor {{editor}} {{path/to/file}}` +`emacsclient {{[-a|--alternate-editor]}} {{editor}} {{path/to/file}}` - Stop a running Emacs server and all its instances, asking for confirmation on unsaved files: -`emacsclient --eval '(save-buffers-kill-emacs)'` +`emacsclient {{[-e|--eval]}} '(save-buffers-kill-emacs)'` diff --git a/tldr/enscript b/tldr/enscript index 1f66b4fe..02e88199 100644 --- a/tldr/enscript +++ b/tldr/enscript @@ -6,19 +6,19 @@ source: https://github.com/tldr-pages/tldr.git # enscript > Convert text files to PostScript, HTML, RTF, ANSI, and overstrikes. -> More information: . +> More information: . - Generate a PostScript file from a text file: -`enscript {{path/to/input_file}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}}` - Generate a file in a different language than PostScript: -`enscript {{path/to/input_file}} --language={{html|rtf|...}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} {{[-w|--language]}} {{html|rtf|...}} {{[-o|--output]}} {{path/to/output_file}}` - Generate a PostScript file with a landscape layout, splitting the page into columns (maximum 9): -`enscript {{path/to/input_file}} --columns={{num}} --landscape --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} --columns {{num}} {{[-r|--landscape]}} {{[-o|--output]}} {{path/to/output_file}}` - Display available syntax highlighting languages and file formats: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate a PostScript file with syntax highlighting and color for a specified language: -`enscript {{path/to/input_file}} --color=1 --highlight={{language}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} --color 1 {{[-E|--highlight]}} {{language}} {{[-o|--output]}} {{path/to/output_file}}` diff --git a/tldr/env b/tldr/env index 0023f51f..4ac1e687 100644 --- a/tldr/env +++ b/tldr/env @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Clear the environment and run a program: -`env -i {{program}}` +`env {{[-i|--ignore-environment]}} {{program}}` - Remove variable from the environment and run a program: -`env -u {{variable}} {{program}}` +`env {{[-u|--unset]}} {{variable}} {{program}}` - Set a variable and run a program: diff --git a/tldr/expand b/tldr/expand index 99ee2b1c..e075ed44 100644 --- a/tldr/expand +++ b/tldr/expand @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Do not convert tabs after non blanks: -`expand -i {{path/to/file}}` +`expand {{[-i|--initial]}} {{path/to/file}}` - Have tabs a certain number of characters apart, not 8: -`expand -t {{number}} {{path/to/file}}` +`expand {{[-t|--tabs]}} {{number}} {{path/to/file}}` - Use a comma separated list of explicit tab positions: -`expand -t {{1,4,6}}` +`expand {{[-t|--tabs]}} {{1,4,6}}` diff --git a/tldr/fgrep b/tldr/fgrep index 3160671f..920e3557 100644 --- a/tldr/fgrep +++ b/tldr/fgrep @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Search only lines that match entirely in one or more files: -`fgrep -x {{search_string}} {{path/to/file1 path/to/file2 ...}}` +`fgrep {{[-x|--line-regexp]}} {{search_string}} {{path/to/file1 path/to/file2 ...}}` - Count the number of lines that match the given string in a file: -`fgrep -c {{search_string}} {{path/to/file}}` +`fgrep {{[-c|--count]}} {{search_string}} {{path/to/file}}` - Show the line number in the file along with the line matched: -`fgrep -n {{search_string}} {{path/to/file}}` +`fgrep {{[-n|--line-number]}} {{search_string}} {{path/to/file}}` - Display all lines except those that contain the search string: -`fgrep -v {{search_string}} {{path/to/file}}` +`fgrep {{[-v|--invert-match]}} {{search_string}} {{path/to/file}}` - Display filenames whose content matches the search string at least once: -`fgrep -l {{search_string}} {{path/to/file1 path/to/file2 ...}}` +`fgrep {{[-l|--files-with-matches]}} {{search_string}} {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/fmt b/tldr/fmt index e136617a..fb625525 100644 --- a/tldr/fmt +++ b/tldr/fmt @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Reformat a file producing output lines of (at most) `n` characters: -`fmt -w {{n}} {{path/to/file}}` +`fmt {{[-w|--width]}} {{n}} {{path/to/file}}` - Reformat a file without joining lines shorter than the given width together: -`fmt -s {{path/to/file}}` +`fmt {{[-s|--split-only]}} {{path/to/file}}` - Reformat a file with uniform spacing (1 space between words and 2 spaces between paragraphs): -`fmt -u {{path/to/file}}` +`fmt {{[-u|--uniform-spacing]}} {{path/to/file}}` diff --git a/tldr/freebsd/ipmitool b/tldr/freebsd/ipmitool new file mode 100644 index 00000000..71b509b8 --- /dev/null +++ b/tldr/freebsd/ipmitool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# ipmitool + +> Interface with the Intelligent Platform Management Interface (IPMI). +> More information: . + +- Load the IPMI kernel module for local connections: + +`kldload ipmi.ko` + +- Open IPMI shell on the local hardware : + +`ipmitool shell` + +- Open IPMI shell on a remote host: + +`ipmitool -H {{ip_address}} -U {{user_name}} shell` diff --git a/tldr/glances b/tldr/glances index ab1c6849..cfda29e9 100644 --- a/tldr/glances +++ b/tldr/glances @@ -14,16 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Run in web server mode to show results in browser: -`glances -w` +`glances {{[-w|--webserver]}}` - Run in server mode to allow connections from other Glances clients: -`glances -s` +`glances {{[-s|--server]}}` - Connect to a Glances server: -`glances -c {{hostname}}` +`glances {{[-c|--client]}} {{hostname}}` - Require a password in (web) server mode: -`glances -s --password` +`glances {{[-s|--server]}} --password` + +- Exit Glances: + +`` + +- Display help: + +`glances {{[-h|--help]}}` diff --git a/tldr/gnuplot b/tldr/gnuplot index 50d8d0aa..3315328f 100644 --- a/tldr/gnuplot +++ b/tldr/gnuplot @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Persist the graph plot preview window after gnuplot exits: -`gnuplot --persist {{path/to/definition.plt}}` +`gnuplot {{[-p|--persist]}} {{path/to/definition.plt}}` diff --git a/tldr/gpg b/tldr/gpg index a677e135..f8d25e69 100644 --- a/tldr/gpg +++ b/tldr/gpg @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a GPG public and private key interactively: -`gpg --full-generate-key` +`gpg {{[--full-gen-key|--full-generate-key]}}` - List all keys from the public keyring: diff --git a/tldr/gpg-zip b/tldr/gpg-zip index 8ba606db..911aef2a 100644 --- a/tldr/gpg-zip +++ b/tldr/gpg-zip @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Encrypt a directory into `archive.gpg` using a passphrase: -`gpg-zip --symmetric --output {{archive.gpg}} {{path/to/directory}}` +`gpg-zip {{[-c|--symmetric]}} {{[-o|--output]}} {{archive.gpg}} {{path/to/directory}}` - Decrypt `archive.gpg` into a directory of the same name: -`gpg-zip --decrypt {{path/to/archive.gpg}}` +`gpg-zip {{[-d|--decrypt]}} {{path/to/archive.gpg}}` - List the contents of the encrypted `archive.gpg`: diff --git a/tldr/gpgconf b/tldr/gpgconf index cbcef3f9..f53b51c9 100644 --- a/tldr/gpgconf +++ b/tldr/gpgconf @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List the directories used by gpgconf: -`gpgconf --list-dirs` +`gpgconf {{[-L|--list-dirs]}}` - List all options of a component: diff --git a/tldr/gprof b/tldr/gprof index 829eef53..99f63c2f 100644 --- a/tldr/gprof +++ b/tldr/gprof @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Compile binary to default `a.out` with gprof information and run it to get `gmon.out`: -`gcc -pg {{program.c}} && ./a.out` +`gcc {{[-p|-pg]}} {{program.c}} && ./a.out` - Run gprof on default `a.out` and `gmon.out` to obtain profile output: @@ -23,8 +23,8 @@ source: https://github.com/tldr-pages/tldr.git - Suppress profile field's description: -`gprof -b` +`gprof {{[-b|--brief]}}` - Display routines that have zero usage: -`gprof -bz` +`gprof {{[-bz|--brief --display-unused-functions]}}` diff --git a/tldr/groff b/tldr/groff index fcff8317..c45b43bc 100644 --- a/tldr/groff +++ b/tldr/groff @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # groff > GNU replacement for the `troff` and `nroff` typesetting utilities. -> More information: . +> More information: . - Format output for a PostScript printer, saving the output to a file: diff --git a/tldr/hello b/tldr/hello index ef5b756f..17b33b47 100644 --- a/tldr/hello +++ b/tldr/hello @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hello > Print "Hello, world!", "hello, world" or a customizable text. -> More information: . +> More information: . - Print "Hello, world!": @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Print "hello, world", the traditional type: -`hello --traditional` +`hello {{[-t|--traditional]}}` - Print a text message: -`hello --greeting="{{greeting_text}}"` +`hello {{[-g|--greeting]}} "{{greeting_text}}"` diff --git a/tldr/help2man b/tldr/help2man index 90755646..64a0c47f 100644 --- a/tldr/help2man +++ b/tldr/help2man @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Specify the "name" paragraph in the man page: -`help2man {{executable}} --name {{name}}` +`help2man {{executable}} {{[-n|--name]}} {{name}}` - Specify the section for the man page (defaults to 1): -`help2man {{executable}} --section {{section}}` +`help2man {{executable}} {{[-s|--section]}} {{section}}` - Output to a file instead of `stdout`: -`help2man {{executable}} --output {{path/to/file}}` +`help2man {{executable}} {{[-o|--output]}} {{path/to/file}}` - Display help: diff --git a/tldr/history b/tldr/history index 6ebfd68d..9ba81c71 100644 --- a/tldr/history +++ b/tldr/history @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # history > Command-line history. -> More information: . +> More information: . - Display the commands history list with line numbers: diff --git a/tldr/indent b/tldr/indent index c5ebde92..e364976e 100644 --- a/tldr/indent +++ b/tldr/indent @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # indent > Change the appearance of a C/C++ program by inserting or deleting whitespace. -> More information: . +> More information: . - Format C/C++ source according to the Linux style guide, automatically back up the original files, and replace with the indented versions: -`indent --linux-style {{path/to/source.c}} {{path/to/another_source.c}}` +`indent {{[-linux|--linux-style]}} {{path/to/source.c}} {{path/to/another_source.c}}` - Format C/C++ source according to the GNU style, saving the indented version to a different file: -`indent --gnu-style {{path/to/source.c}} -o {{path/to/indented_source.c}}` +`indent {{[-gnu|--gnu-style]}} {{path/to/source.c}} -o {{path/to/indented_source.c}}` - Format C/C++ source according to the style of Kernighan & Ritchie (K&R), no tabs, 3 spaces per indent, and wrap lines at 120 characters: -`indent --k-and-r-style --indent-level3 --no-tabs --line-length120 {{path/to/source.c}} -o {{path/to/indented_source.c}}` +`indent {{[-kr|--k-and-r-style]}} {{[-il|--indent-level]}}3 {{[-nut|--no-tabs]}} {{[-l|--line-length]}}120 {{path/to/source.c}} -o {{path/to/indented_source.c}}` diff --git a/tldr/install b/tldr/install index 3b21e6ee..8cae3c7c 100644 --- a/tldr/install +++ b/tldr/install @@ -15,19 +15,19 @@ source: https://github.com/tldr-pages/tldr.git - Copy files to the destination, setting their ownership: -`install --owner {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-o|--owner]}} {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files to the destination, setting their group ownership: -`install --group {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-g|--group]}} {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files to the destination, setting their `mode`: -`install --mode {{+x}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-m|--mode]}} {{+x}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files and apply access/modification times of source to the destination: -`install --preserve-timestamps {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-p|--preserve-timestamps]}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files and create the directories at the destination if they don't exist: diff --git a/tldr/ipmitool b/tldr/ipmitool new file mode 100644 index 00000000..e8f881b5 --- /dev/null +++ b/tldr/ipmitool @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipmitool + +> Interface with the Intelligent Platform Management Interface (IPMI). +> More information: . + +- Open IPMI shell on the local hardware : + +`sudo ipmitool shell` + +- Open IPMI shell on a remote host: + +`ipmitool -H {{ip_address}} -U {{user_name}} shell` diff --git a/tldr/jcal b/tldr/jcal index 9c8c6472..4bfc25da 100644 --- a/tldr/jcal +++ b/tldr/jcal @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jcal > Display calendar information in the Jalali format, with the current day highlighted. -> More information: . +> More information: . - Display a calendar for the current month: diff --git a/tldr/linux/ac b/tldr/linux/ac index 6539dd7c..02c9dd49 100644 --- a/tldr/linux/ac +++ b/tldr/linux/ac @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Print how long users have been connected in hours: -`ac --individual-totals` +`ac {{[-p|--individual-totals]}}` - Print how long a particular user has been connected in hours: -`ac --individual-totals {{username}}` +`ac {{[-p|--individual-totals]}} {{username}}` - Print how long a particular user has been connected in hours per day (with total): -`ac --daily-totals --individual-totals {{username}}` +`ac {{[-d|--daily-totals]}} {{[-p|--individual-totals]}} {{username}}` - Also display additional details: diff --git a/tldr/linux/at b/tldr/linux/at index fb17a39d..364fc06f 100644 --- a/tldr/linux/at +++ b/tldr/linux/at @@ -5,21 +5,34 @@ source: https://github.com/tldr-pages/tldr.git --- # at -> Executes commands at a specified time. -> More information: . +> Execute commands once at a later time. +> Results will be sent to the users mail. +> More information: . -- Open an `at` prompt to create a new set of scheduled commands, press `Ctrl + D` to save and exit: +- Start the `atd` daemon: + +`systemctl start atd` + +- Create commands interactively and execute them in 5 minutes (press `` when done): + +`at now + 5 minutes` + +- Create commands interactively and execute them at a specific time: `at {{hh:mm}}` -- Execute the commands and email the result using a local mailing program such as Sendmail: +- Execute a command from `stdin` at 10:00 AM today: -`at {{hh:mm}} -m` +`echo "{{command}}" | at 1000` -- Execute a script at the given time: +- Execute commands from a given file next Tuesday: -`at {{hh:mm}} -f {{path/to/file}}` +`at -f {{path/to/file}} 9:30 PM Tue` -- Display a system notification at 11pm on February 18th: +- List all queued jobs for the current user (same as `atq`): -`echo "notify-send '{{Wake up!}}'" | at {{11pm}} {{Feb 18}}` +`at -l` + +- View a specied job: + +`at -c {{job_number}}` diff --git a/tldr/linux/atool b/tldr/linux/atool index 6abc05a2..bba8ddb6 100644 --- a/tldr/linux/atool +++ b/tldr/linux/atool @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # atool > Manage archives of various formats. -> More information: . +> More information: . - List files in a Zip archive: -`atool --list {{path/to/archive.zip}}` +`atool {{[-l|--list]}} {{path/to/archive.zip}}` - Unpack a tar.gz archive into a new subdirectory (or current directory if it contains only one file): -`atool --extract {{path/to/archive.tar.gz}}` +`atool {{[-x|--extract]}} {{path/to/archive.tar.gz}}` - Create a new 7z archive with two files: -`atool --add {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` +`atool {{[-a|--add]}} {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` - Extract all Zip and rar archives in the current directory: -`atool --each --extract {{*.zip *.rar}}` +`atool {{[-e|--each]}} {{[-E|--extract]}} {{*.zip *.rar}}` diff --git a/tldr/linux/batch b/tldr/linux/batch new file mode 100644 index 00000000..bbadf6ee --- /dev/null +++ b/tldr/linux/batch @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# batch + +> Execute commands at a later time when the system load levels permit. +> Results will be sent to the user's mail. +> See also: `at`, `atq`, `atrm` `mail`. +> More information: . + +- Start the `atd` daemon: + +`systemctl start atd` + +- Execute commands from `stdin` (press `` when done): + +`batch` + +- Execute a command from `stdin`: + +`echo "{{./make_db_backup.sh}}" | batch` diff --git a/tldr/linux/chcon b/tldr/linux/chcon index 640a1eba..20483f4b 100644 --- a/tldr/linux/chcon +++ b/tldr/linux/chcon @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - View security context of a file: -`ls -lZ {{path/to/file}}` +`ls {{[-lZ|-l --context]}} {{path/to/file}}` - Change the security context of a target file, using a reference file: -`chcon --reference={{reference_file}} {{target_file}}` +`chcon --reference {{reference_file}} {{target_file}}` - Change the full SELinux security context of a file: @@ -23,16 +23,16 @@ source: https://github.com/tldr-pages/tldr.git - Change only the user part of SELinux security context: -`chcon -u {{user}} {{filename}}` +`chcon {{[-u|--user]}} {{user}} {{filename}}` - Change only the role part of SELinux security context: -`chcon -r {{role}} {{filename}}` +`chcon {{[-r|--role]}} {{role}} {{filename}}` - Change only the type part of SELinux security context: -`chcon -t {{type}} {{filename}}` +`chcon {{[-t|--type]}} {{type}} {{filename}}` - Change only the range/level part of SELinux security context: -`chcon -l {{range/level}} {{filename}}` +`chcon {{[-l|--range]}} {{range/level}} {{filename}}` diff --git a/tldr/linux/chfn b/tldr/linux/chfn index 8c565f7a..55d56d43 100644 --- a/tldr/linux/chfn +++ b/tldr/linux/chfn @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Update a user's "Name" field in the output of `finger`: -`chfn -f {{new_display_name}} {{username}}` +`chfn {{[-f|--full-name]}} {{new_display_name}} {{username}}` - Update a user's "Office Room Number" field for the output of `finger`: -`chfn -o {{new_office_room_number}} {{username}}` +`chfn {{[-o|--office]}} {{new_office_room_number}} {{username}}` - Update a user's "Office Phone Number" field for the output of `finger`: -`chfn -p {{new_office_telephone_number}} {{username}}` +`chfn {{[-p|--office-phone]}} {{new_office_telephone_number}} {{username}}` - Update a user's "Home Phone Number" field for the output of `finger`: -`chfn -h {{new_home_telephone_number}} {{username}}` +`chfn {{[-h|--home-phone]}} {{new_home_telephone_number}} {{username}}` diff --git a/tldr/linux/csplit b/tldr/linux/csplit index 3d85b338..82bcddda 100644 --- a/tldr/linux/csplit +++ b/tldr/linux/csplit @@ -19,11 +19,11 @@ source: https://github.com/tldr-pages/tldr.git - Split a file every 5 lines, ignoring exact-division error: -`csplit -k {{path/to/file}} 5 {*}` +`csplit {{[-k|--keep-files]}} {{path/to/file}} 5 {*}` - Split a file at line 5 and use a custom prefix for the output files: -`csplit {{path/to/file}} 5 -f {{prefix}}` +`csplit {{path/to/file}} 5 {{[-f|--prefix]}} {{prefix}}` - Split a file at a line matching a regular expression: diff --git a/tldr/linux/datamash b/tldr/linux/datamash index 67c4bd23..80844ce9 100644 --- a/tldr/linux/datamash +++ b/tldr/linux/datamash @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # datamash > Perform basic numeric, textual and statistical operations on input textual data files. -> More information: . +> More information: . - Get max, min, mean and median of a single column of numbers: @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git 3 4 5 -5' | datamash -R {{number_of_decimals_wanted}} mean 1` +5' | datamash {{[-R|--round]}} {{number_of_decimals_wanted}} mean 1` - Get the mean of a single column of numbers ignoring "Na" and "NaN" (literal) strings: diff --git a/tldr/linux/ddrescue b/tldr/linux/ddrescue index 6fd7d260..c481940b 100644 --- a/tldr/linux/ddrescue +++ b/tldr/linux/ddrescue @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ddrescue > Data recovery tool that reads data from damaged block devices. -> More information: . +> More information: . - Take an image of a device, creating a log file: @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Clone Disk A to Disk B, creating a log file: -`sudo ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}} {{path/to/log.txt}}` +`sudo ddrescue {{[-f|--force]}} {{[-n|--no-scrape]}} {{/dev/sdX}} {{/dev/sdY}} {{path/to/log.txt}}` diff --git a/tldr/linux/diff3 b/tldr/linux/diff3 index c799d425..ad6bd278 100644 --- a/tldr/linux/diff3 +++ b/tldr/linux/diff3 @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Show all changes, outlining conflicts: -`diff3 --show-all {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` +`diff3 {{[-A|--show-all]}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` diff --git a/tldr/linux/fold b/tldr/linux/fold index b8f31bfd..4e52b37d 100644 --- a/tldr/linux/fold +++ b/tldr/linux/fold @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Fold lines in a fixed width: -`fold --width {{width}} {{path/to/file}}` +`fold {{[-w|--width]}} {{width}} {{path/to/file}}` - Count width in bytes (the default is to count in columns): -`fold --bytes --width {{width_in_bytes}} {{path/to/file}}` +`fold {{[-b|--bytes]}} {{[-w|--width]}} {{width_in_bytes}} {{path/to/file}}` - Break the line after the rightmost blank within the width limit: -`fold --spaces --width {{width}} {{path/to/file}}` +`fold {{[-s|--spaces]}} {{[-w|--width]}} {{width}} {{path/to/file}}` diff --git a/tldr/linux/gcov b/tldr/linux/gcov index 2891780b..b520e8e9 100644 --- a/tldr/linux/gcov +++ b/tldr/linux/gcov @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Write individual execution counts for every basic block: -`gcov --all-blocks {{path/to/file.cpp}}` +`gcov {{[-a|--all-blocks]}} {{path/to/file.cpp}}` - Write branch frequencies to the output file and print summary information to `stdout` as a percentage: -`gcov --branch-probabilities {{path/to/file.cpp}}` +`gcov {{[-b|--branch-probabilities]}} {{path/to/file.cpp}}` - Write branch frequencies as the number of branches taken, rather than the percentage: -`gcov --branch-counts {{path/to/file.cpp}}` +`gcov {{[-c|--branch-counts]}} {{path/to/file.cpp}}` - Do not create a `gcov` output file: -`gcov --no-output {{path/to/file.cpp}}` +`gcov {{[-n|--no-output]}} {{path/to/file.cpp}}` - Write file level as well as function level summaries: -`gcov --function-summaries {{path/to/file.cpp}}` +`gcov {{[-f|--function-summaries]}} {{path/to/file.cpp}}` diff --git a/tldr/linux/getopt b/tldr/linux/getopt index a8a1b552..b2a964e1 100644 --- a/tldr/linux/getopt +++ b/tldr/linux/getopt @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # getopt > Parse command-line arguments. -> More information: . +> More information: . - Parse optional `verbose`/`version` flags with shorthands: -`getopt --options vV --longoptions verbose,version -- --version --verbose` +`getopt {{[-o|--options]}} vV {{[-l|--longoptions]}} verbose,version -- --version --verbose` - Add a `--file` option with a required argument with shorthand `-f`: -`getopt --options f: --longoptions file: -- --file=somefile` +`getopt {{[-o|--options]}} f: {{[-l|--longoptions]}} file: -- --file=somefile` - Add a `--verbose` option with an optional argument with shorthand `-v`, and pass a non-option parameter `arg`: -`getopt --options v:: --longoptions verbose:: -- --verbose arg` +`getopt {{[-o|--options]}} v:: {{[-l|--longoptions]}} verbose:: -- --verbose arg` - Accept a `-r` and `--verbose` flag, a `--accept` option with an optional argument and add a `--target` with a required argument option with shorthands: -`getopt --options rv::s::t: --longoptions verbose,source::,target: -- -v --target target` +`getopt {{[-o|--options]}} rv::s::t: {{[-l|--longoptions]}} verbose,source::,target: -- -v --target target` diff --git a/tldr/linux/grub-install b/tldr/linux/grub-install index b60d5030..2640f77a 100644 --- a/tldr/linux/grub-install +++ b/tldr/linux/grub-install @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Install GRUB on a BIOS system: -`grub-install --target={{i386-pc}} {{path/to/device}}` +`grub-install --target {{i386-pc}} {{path/to/device}}` - Install GRUB on an UEFI system: -`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --bootloader-id={{GRUB}}` +`grub-install --target {{x86_64-efi}} --efi-directory {{path/to/efi_directory}} --bootloader-id {{GRUB}}` - Install GRUB pre-loading specific modules: -`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --modules="{{part_gpt part_msdos}}"` +`grub-install --target {{x86_64-efi}} --efi-directory {{path/to/efi_directory}} --modules "{{part_gpt part_msdos}}"` diff --git a/tldr/linux/grub-mkconfig b/tldr/linux/grub-mkconfig index 29d88320..3fbca912 100644 --- a/tldr/linux/grub-mkconfig +++ b/tldr/linux/grub-mkconfig @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate the configuration file: -`sudo grub-mkconfig --output={{/boot/grub/grub.cfg}}` +`sudo grub-mkconfig {{[-o|--output]}} {{/boot/grub/grub.cfg}}` - Display help: diff --git a/tldr/linux/grub-script-check b/tldr/linux/grub-script-check index c0c1e362..82204d3f 100644 --- a/tldr/linux/grub-script-check +++ b/tldr/linux/grub-script-check @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display each line of input after reading it: -`grub-script-check --verbose` +`grub-script-check {{[-v|--verbose]}}` - Display help: diff --git a/tldr/linux/guix-package b/tldr/linux/guix-package index 9092ea16..5757e706 100644 --- a/tldr/linux/guix-package +++ b/tldr/linux/guix-package @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - Install a new package: -`guix package -i {{package}}` +`guix package {{[-i|--install]}} {{package}}` - Remove a package: -`guix package -r {{package}}` +`guix package {{[-r|--remove]}} {{package}}` - Search the package database for a regular expression: -`guix package -s "{{search_pattern}}"` +`guix package {{[-s|--search]}} "{{search_pattern}}"` - List installed packages: -`guix package -I` +`guix package {{[-I|--list-installed]}}` - List generations: -`guix package -l` +`guix package {{[-l|--list-generations]}}` - Roll back to the previous generation: diff --git a/tldr/linux/ipcs b/tldr/linux/ipcs index 8912e865..2445aa6c 100644 --- a/tldr/linux/ipcs +++ b/tldr/linux/ipcs @@ -17,26 +17,26 @@ source: https://github.com/tldr-pages/tldr.git `ipcs {{--shmems|--queues|--semaphores}}` -- Show full details on the resource with a specific [i]D: +- Show full details on the resource with a specific ID: -`ipcs {{--shmems|--queues|--semaphores}} --id {{resource_id}}` +`ipcs {{--shmems|--queues|--semaphores}} {{[-i|--id]}} {{resource_id}}` -- Show [l]imits in [b]ytes or in a human-readable format: +- Show limits in [b]ytes or in a human-readable format: -`ipcs --limits {{--bytes|--human}}` +`ipcs {{[-l|--limits]}} {{--bytes|--human}}` - Show s[u]mmary about current usage: -`ipcs --summary` +`ipcs {{[-u|--summary]}}` -- Show [c]reator's and owner's UIDs and PIDs for all IPC facilities: +- Show creator's and owner's UIDs and PIDs for all IPC facilities: -`ipcs --creator` +`ipcs {{[-c|--creator]}}` -- Show the [p]ID of the last operators for all IPC facilities: +- Show the PID of the last operators for all IPC facilities: -`ipcs --pid` +`ipcs {{[-p|--pid]}}` -- Show last access [t]imes for all IPC facilities: +- Show last access times for all IPC facilities: -`ipcs --time` +`ipcs {{[-t|--time]}}` diff --git a/tldr/linux/ipmitool b/tldr/linux/ipmitool new file mode 100644 index 00000000..58c5e5b1 --- /dev/null +++ b/tldr/linux/ipmitool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ipmitool + +> Interface with the Intelligent Platform Management Interface (IPMI). +> More information: . + +- Start the IPMI driver for local connections: + +`systemctl start ipmidrv` + +- Open IPMI shell on the local hardware : + +`sudo ipmitool shell` + +- Open IPMI shell on a remote host: + +`ipmitool -H {{ip_address}} -U {{user_name}} shell` diff --git a/tldr/linux/libtool b/tldr/linux/libtool index 4b234051..dccd79b3 100644 --- a/tldr/linux/libtool +++ b/tldr/linux/libtool @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Compile a source file into a `libtool` object: -`libtool --mode=compile gcc -c {{path/to/source.c}} -o {{path/to/source.lo}}` +`libtool --mode=compile gcc {{[-c|--compile]}} {{path/to/source.c}} {{[-o|--output]}} {{path/to/source.lo}}` - Create a library or an executable: -`libtool --mode=link gcc -o {{path/to/library.lo}} {{path/to/source.lo}}` +`libtool --mode=link gcc {{[-o|--output]}} {{path/to/library.lo}} {{path/to/source.lo}}` - Automatically set the library path so that another program can use uninstalled `libtool` generated programs or libraries: diff --git a/tldr/linux/libtoolize b/tldr/linux/libtoolize index f28533fd..b1337156 100644 --- a/tldr/linux/libtoolize +++ b/tldr/linux/libtoolize @@ -11,4 +11,4 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a project for `libtool` by copying necessary files (avoiding symbolic links) and overwriting existing files if needed: -`libtoolize --copy --force` +`libtoolize {{[-c|--copy]}} {{[-f|--force]}}` diff --git a/tldr/linux/mknod b/tldr/linux/mknod index 1a33b213..81c96d72 100644 --- a/tldr/linux/mknod +++ b/tldr/linux/mknod @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Create a device file with default SELinux security context: -`sudo mknod -Z {{path/to/device_file}} {{type}} {{major_device_number}} {{minor_device_number}}` +`sudo mknod {{[-Z |--context=]}}{{path/to/device_file}} {{type}} {{major_device_number}} {{minor_device_number}}` diff --git a/tldr/linux/mktemp b/tldr/linux/mktemp index 47127118..6b007bd8 100644 --- a/tldr/linux/mktemp +++ b/tldr/linux/mktemp @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a custom directory (defaults to `$TMPDIR`, or `/tmp`): -`mktemp --tmpdir={{/path/to/tempdir}}` +`mktemp {{[-p |--tmpdir=]}}{{/path/to/tempdir}}` - Use a custom path template (`X`s are replaced with random alphanumeric characters): diff --git a/tldr/linux/parted b/tldr/linux/parted index e836f0de..efac79f4 100644 --- a/tldr/linux/parted +++ b/tldr/linux/parted @@ -7,19 +7,19 @@ source: https://github.com/tldr-pages/tldr.git > A partition manipulation program. > See also: `parted-interactive`, `partprobe`. -> More information: . +> More information: . - List partitions on all block devices: -`sudo parted --list` +`sudo parted {{[-l|--list]}}` - Create a new partition table of the specified label-type: -`sudo parted {{/dev/sdX}} --script mklabel {{aix|amiga|bsd|dvh|gpt|loop|mac|msdos|pc98|sun}}` +`sudo parted {{/dev/sdX}} {{[-s|--script]}} mklabel {{aix|amiga|bsd|dvh|gpt|loop|mac|msdos|pc98|sun}}` - Create a new `gpt` partition table with a 500MiB boot partition and give the rest for the system partition: -`sudo parted {{/dev/sdX}} --script mklabel gpt mkpart primary 0% 500MiB mkpart primary 500MiB 100%` +`sudo parted {{/dev/sdX}} {{[-s|--script]}} mklabel gpt mkpart primary 0% 500MiB mkpart primary 500MiB 100%` - Start interactive mode with the specified disk selected: diff --git a/tldr/linux/ptx b/tldr/linux/ptx index 54c09a95..0a832f7d 100644 --- a/tldr/linux/ptx +++ b/tldr/linux/ptx @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Generate a permuted index where the first field of each line is an index reference: -`ptx --references {{path/to/file}}` +`ptx {{[-r|--references]}} {{path/to/file}}` - Generate a permuted index with automatically generated index references: -`ptx --auto-reference {{path/to/file}}` +`ptx {{[-A|--auto-reference]}} {{path/to/file}}` - Generate a permuted index with a fixed width: -`ptx --width={{width_in_columns}} {{path/to/file}}` +`ptx {{[-w|--width]}} {{width_in_columns}} {{path/to/file}}` - Generate a permuted index with a list of filtered words: -`ptx --only-file={{path/to/filter}} {{path/to/file}}` +`ptx {{[-o|--only-file]}} {{path/to/filter}} {{path/to/file}}` - Generate a permuted index with SYSV-style behaviors: -`ptx --traditional {{path/to/file}}` +`ptx {{[-G|--traditional]}} {{path/to/file}}` diff --git a/tldr/linux/pw-profiler b/tldr/linux/pw-profiler index e1d677b5..3018d8bd 100644 --- a/tldr/linux/pw-profiler +++ b/tldr/linux/pw-profiler @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Change the log output file: -`pw-profiler --output {{path/to/file.log}}` +`pw-profiler {{[-o|--output]}} {{path/to/file.log}}` - Profile a remote instance: -`pw-profiler --remote {{remote_name}}` +`pw-profiler {{[-r|--remote]}} {{remote_name}}` - Display help: -`pw-profiler --help` +`pw-profiler {{[-h|--help]}}` diff --git a/tldr/linux/rcp b/tldr/linux/rcp index bbbcc004..5d6032b3 100644 --- a/tldr/linux/rcp +++ b/tldr/linux/rcp @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Copy a directory recursively: -`rcp -r {{path/to/local_directory}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-r|--recursive]}} {{path/to/local_directory}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` - Preserve the file attributes: -`rcp -p {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-p|--preserve]}} {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` - Force copy without a confirmation: -`rcp -f {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-f|--from]}} {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` diff --git a/tldr/linux/rexec b/tldr/linux/rexec index 917ec94d..027e279d 100644 --- a/tldr/linux/rexec +++ b/tldr/linux/rexec @@ -9,18 +9,18 @@ source: https://github.com/tldr-pages/tldr.git > Note: Use `rexec` with caution, as it transmits data in plain text. Consider secure alternatives like SSH for encrypted communication. > More information: . -- Execute a command on a remote [h]ost: +- Execute a command on a remote host: -`rexec -h={{remote_host}} {{ls -l}}` +`rexec {{[-h|--host]}} {{remote_host}} {{ls -l}}` -- Specify the remote [u]sername on a remote [h]ost: +- Specify the remote username on a remote host: -`rexec -username={{username}} -h={{remote_host}} {{ps aux}}` +`rexec {{[-u|--username]}} {{username}} {{[-h|--host]}} {{remote_host}} {{ps aux}}` -- Redirect `stdin` from `/dev/null` on a remote [h]ost: +- Redirect `stdin` from `/dev/null` on a remote host: -`rexec --no-err -h={{remote_host}} {{ls -l}}` +`rexec {{[-n|--noerr]}} {{[-h|--host]}} {{remote_host}} {{ls -l}}` -- Specify the remote [P]ort on a remote [h]ost: +- Specify the remote port on a remote host: -`rexec -P={{1234}} -h={{remote_host}} {{ls -l}}` +`rexec {{[-P|--port]}} {{1234}} {{[-h|--host]}} {{remote_host}} {{ls -l}}` diff --git a/tldr/linux/rlogin b/tldr/linux/rlogin index b5f0fd51..84be4952 100644 --- a/tldr/linux/rlogin +++ b/tldr/linux/rlogin @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Log in to a remote host with a specific username: -`rlogin -l {{username}} {{remote_host}}` +`rlogin {{[-l|--user]}} {{username}} {{remote_host}}` diff --git a/tldr/linux/rsh b/tldr/linux/rsh index a94dedd6..1ba1f953 100644 --- a/tldr/linux/rsh +++ b/tldr/linux/rsh @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a command on a remote host with a specific username: -`rsh {{remote_host}} -l {{username}} {{ls -l}}` +`rsh {{remote_host}} {{[-l|--user]}} {{username}} {{ls -l}}` - Redirect `stdin` to `/dev/null` when executing a command on a remote host: diff --git a/tldr/linux/runcon b/tldr/linux/runcon index e799fef5..1e216e1d 100644 --- a/tldr/linux/runcon +++ b/tldr/linux/runcon @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Specify the domain to run a command in: -`runcon -t {{domain}}_t {{command}}` +`runcon {{[-t|--type]}} {{domain}}_t {{command}}` - Specify the context role to run a command with: -`runcon -r {{role}}_r {{command}}` +`runcon {{[-r|--role]}} {{role}}_r {{command}}` - Specify the full context to run a command with: diff --git a/tldr/linux/sed b/tldr/linux/sed index 26447f1c..247d5c13 100644 --- a/tldr/linux/sed +++ b/tldr/linux/sed @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a specific script file and print the result to `stdout`: -`{{command}} | sed {{-f|--file}} {{path/to/script.sed}}` +`{{command}} | sed {{[-f|--file]}} {{path/to/script.sed}}` - Print just the first line to `stdout`: diff --git a/tldr/linux/shar b/tldr/linux/shar index dffd76f8..7365be93 100644 --- a/tldr/linux/shar +++ b/tldr/linux/shar @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a shell script that when executed extracts the given files from itself: -`shar --vanilla-operation {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-V|--vanilla-operation]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Compress the files in the archive: -`shar --compactor {{xz}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-C|--compactor]}} {{xz}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Treat all files as binary (i.e. `uuencode` everything): -`shar --uuencode {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-B|--uuencode]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Treat all files as text (i.e. `uuencode` nothing): -`shar --text-files {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-T|--text-files]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Include a name and cut mark in the header comment of the archive: -`shar --archive-name "{{My files}}" --cut-mark {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-n|--archive-name]}} "{{My files}}" {{[-c|--cut-mark]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` diff --git a/tldr/linux/steamos-chroot b/tldr/linux/steamos-chroot index 0000721c..b2b9d443 100644 --- a/tldr/linux/steamos-chroot +++ b/tldr/linux/steamos-chroot @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Switch to the other A/B partition: -`steamos-chroot --partset other` +`steamos-chroot {{[-p|--partset]}} other` - Switch to a partition on another drive: -`steamos-chroot --disk {{/dev/sdX}} --partset {{A|B}}` +`steamos-chroot {{[-d|--disk]}} {{/dev/sdX}} {{[-p|--partset]}} {{A|B}}` - Display help: -`steamos-chroot --help` +`steamos-chroot {{[-h|--help]}}` diff --git a/tldr/linux/wireplumber b/tldr/linux/wireplumber new file mode 100644 index 00000000..c57cbb18 --- /dev/null +++ b/tldr/linux/wireplumber @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wireplumber + +> A modular session/policy manager for PipeWire and a GObject-based high-level library that wraps PipeWire’s API. +> See also: `wpctl`, `pipewire`. +> More information: . + +- Make WirePlumber start with the user session immediately (for systemd systems): + +`systemctl --user --now enable wireplumber` + +- Run WirePlumber, after `pipewire` is started (for non-systemd systems): + +`wireplumber` + +- Specify a different context configuration file: + +`wireplumber --config-file {{path/to/file}}` + +- Display help: + +`wireplumber --help` + +- Display version: + +`wireplumber --version` diff --git a/tldr/ls b/tldr/ls index 6bb785ad..d61e79f1 100644 --- a/tldr/ls +++ b/tldr/ls @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - List all files in [l]ong format (permissions, ownership, size, and modification date): -`ls {{[-la|--all -l]}}` +`ls {{[-la|-l --all]}}` - List files in [l]ong format with size displayed using human-readable units (KiB, MiB, GiB): diff --git a/tldr/lzip b/tldr/lzip index c18a556b..5b73bfe5 100644 --- a/tldr/lzip +++ b/tldr/lzip @@ -15,28 +15,28 @@ source: https://github.com/tldr-pages/tldr.git - Archive a file, keeping the input file: -`lzip -k {{path/to/file}}` +`lzip {{[-k|--keep]}} {{path/to/file}}` - Archive a file with the best compression (level=9): -`lzip -k {{path/to/file}} --best` +`lzip {{[-k|--keep]}} {{path/to/file}} --best` - Archive a file at the fastest speed (level=0): -`lzip -k {{path/to/file}} --fast` +`lzip {{[-k|--keep]}} {{path/to/file}} --fast` - Test the integrity of compressed file: -`lzip --test {{path/to/archive.lz}}` +`lzip {{[-t|--test]}} {{path/to/archive.lz}}` - Decompress a file, replacing it with the original uncompressed version: -`lzip -d {{path/to/archive.lz}}` +`lzip {{[-d|--decompress]}} {{path/to/archive.lz}}` - Decompress a file, keeping the archive: -`lzip -d -k {{path/to/archive.lz}}` +`lzip {{[-d|--decompress]}} {{[-k|--keep]}} {{path/to/archive.lz}}` - List files which are in an archive and show compression stats: -`lzip --list {{path/to/archive.lz}}` +`lzip {{[-l|--list]}} {{path/to/archive.lz}}` diff --git a/tldr/m4 b/tldr/m4 index d0da1ee7..705b9724 100644 --- a/tldr/m4 +++ b/tldr/m4 @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Define a macro before processing files: -`m4 -D{{macro_name}}={{macro_value}} {{path/to/file}}` +`m4 {{[-D|--define]}} {{macro_name}}={{macro_value}} {{path/to/file}}` diff --git a/tldr/make b/tldr/make index 7bf32944..6556069c 100644 --- a/tldr/make +++ b/tldr/make @@ -19,19 +19,19 @@ source: https://github.com/tldr-pages/tldr.git - Call a specific target, executing 4 jobs at a time in parallel: -`make -j{{4}} {{target}}` +`make {{[-j|--jobs]}} {{4}} {{target}}` - Use a specific Makefile: -`make --file {{path/to/file}}` +`make {{[-f|--file]}} {{path/to/file}}` - Execute make from another directory: -`make --directory {{path/to/directory}}` +`make {{[-C|--directory]}} {{path/to/directory}}` - Force making of a target, even if source files are unchanged: -`make --always-make {{target}}` +`make {{[-B|--always-make]}} {{target}}` - Override a variable defined in the Makefile: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Override variables defined in the Makefile by the environment: -`make --environment-overrides {{target}}` +`make {{[-e|--environment-overrides]}} {{target}}` diff --git a/tldr/mariadb b/tldr/mariadb new file mode 100644 index 00000000..7e203789 --- /dev/null +++ b/tldr/mariadb @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mariadb + +> The mariadb client tool. +> More information: . + +- Connect to a specific MariaDB database: + +`mariadb {{db_name}}` + +- Connect to a specific MariaDB database using username and password: + +`mariadb --user {{user_name}} --password {{your_password}} {{db_name}}` + +- Show warnings after every statement in interactive and batch mode: + +`mariadb --show-warning` + +- Display less verbose outputs (can be used multiple times to produce less output): + +`mariadb {{-s|-ss|-sss|--silent}}` + +- Execute SQL statements from a script file: + +`mariadb {{db_name}} < {{path/to/script.sql}} > {{path/to/output.tab}}` + +- Check memory and open file usage at exit: + +`mariadb --debug-check` + +- Connect using a socket file for local connections: + +`mariadb {{[-S|--socket]}} {{path/to/socket_name}}` + +- Display help: + +`mariadb {{[-?|--help]}}` diff --git a/tldr/md5sum b/tldr/md5sum index 13e663e4..82d2b018 100644 --- a/tldr/md5sum +++ b/tldr/md5sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of MD5 checksums and filenames and verify all files have matching checksums: -`md5sum --check {{path/to/file.md5}}` +`md5sum {{[-c|--check]}} {{path/to/file.md5}}` - Only show a message for missing files or when verification fails: -`md5sum --check --quiet {{path/to/file.md5}}` +`md5sum {{[-c|--check]}} --quiet {{path/to/file.md5}}` - Only show a message when verification fails, ignoring missing files: -`md5sum --ignore-missing --check --quiet {{path/to/file.md5}}` +`md5sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.md5}}` - Check a known MD5 checksum of a file: -`echo {{known_md5_checksum_of_the_file}} {{path/to/file}} | md5sum --check` +`echo {{known_md5_checksum_of_the_file}} {{path/to/file}} | md5sum {{[-c|--check]}}` diff --git a/tldr/mkfifo b/tldr/mkfifo index f74890cb..f3988726 100644 --- a/tldr/mkfifo +++ b/tldr/mkfifo @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Share your terminal session in real-time: -`mkfifo {{path/to/pipe}}; script -f {{path/to/pipe}}` +`mkfifo {{path/to/pipe}}; script {{[-f|--flush]}} {{path/to/pipe}}` diff --git a/tldr/moe b/tldr/moe index a665ce41..e533772a 100644 --- a/tldr/moe +++ b/tldr/moe @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Open a file as read-only: -`moe --read-only {{path/to/file}}` +`moe {{[-o|--read-only]}} {{path/to/file}}` - Edit a file without creating backups: -`moe --no-backup {{path/to/file}}` +`moe {{[-B|--no-backup]}} {{path/to/file}}` - Edit a file ignoring case in searches: -`moe --ignore-case {{path/to/file}}` +`moe {{[-i|--ignore-case]}} {{path/to/file}}` - Save and Quit: diff --git a/tldr/numfmt b/tldr/numfmt index fdcf26ae..57ac7b6b 100644 --- a/tldr/numfmt +++ b/tldr/numfmt @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Convert 1.5K (SI Units) to 1500: -`numfmt --from=si 1.5K` +`numfmt --from si 1.5K` - Convert 5th field (1-indexed) to IEC Units without converting header: -`ls -l | numfmt --header=1 --field=5 --to=iec` +`ls -l | numfmt --header=1 --field 5 --to iec` - Convert to IEC units, pad with 5 characters, left aligned: -`du -s * | numfmt --to=iec --format="%-5f"` +`du {{[-s|--summarize]}} * | numfmt --to iec --format "%-5f"` diff --git a/tldr/oathtool b/tldr/oathtool index c6d16a0a..031676f9 100644 --- a/tldr/oathtool +++ b/tldr/oathtool @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Generate TOTP token (behaves like Google Authenticator): -`oathtool --totp --base32 "{{secret}}"` +`oathtool --totp {{[-b|--base32]}} "{{secret}}"` - Generate a TOTP token for a specific time: -`oathtool --totp --now "{{2004-02-29 16:21:42}}" --base32 "{{secret}}"` +`oathtool --totp {{[-N|--now]}} "{{2004-02-29 16:21:42}}" {{[-b|--base32]}} "{{secret}}"` - Validate a TOTP token: -`oathtool --totp --base32 "{{secret}}" "{{token}}"` +`oathtool --totp {{[-b|--base32]}} "{{secret}}" "{{token}}"` diff --git a/tldr/od b/tldr/od index 77429ea9..1a66128a 100644 --- a/tldr/od +++ b/tldr/od @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Display file in verbose mode, i.e. without replacing duplicate lines with `*`: -`od -v {{path/to/file}}` +`od {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format (2-byte units), with byte offsets in decimal format: -`od --format={{x}} --address-radix={{d}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{x}} {{[-A|--address-radix]}} {{d}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format (1-byte units), and 4 bytes per line: -`od --format={{x1}} --width={{4}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{x1}} {{[-w|--width=]}}{{4}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format along with its character representation, and do not print byte offsets: -`od --format={{xz}} --address-radix={{n}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{xz}} {{[-A|--address-radix]}} {{n}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Read only 100 bytes of a file starting from the 500th byte: -`od --read-bytes 100 --skip-bytes=500 -v {{path/to/file}}` +`od {{[-N|--read-bytes]}} 100 {{[-j|--skip-bytes]}} 500 {{[-v|--output-duplicates]}} {{path/to/file}}` diff --git a/tldr/openstack-help b/tldr/openstack-help new file mode 100644 index 00000000..205bee5f --- /dev/null +++ b/tldr/openstack-help @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack help + +> Display help information about the openstackclient cli. +> More information: . + +- Display a description of a particular command: + +`openstack help {{command_name}}` + +- Get help for Identity v3: + +`openstack --os-identity-api-version 3 --help` + +- Display help: + +`openstack --help` diff --git a/tldr/openstack-image b/tldr/openstack-image new file mode 100644 index 00000000..3ccb4b8b --- /dev/null +++ b/tldr/openstack-image @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack image + +> OpenStack Image service, aka OpenStack Glance, allows users to upload and discover data assets meant to be used with other services. +> More information: . + +- List available images: + +`openstack image list {{--private|--shared|--all}}` + +- Display image details: + +`openstack image show --human-readable {{image_id}}` + +- Create/upload an image: + +`openstack image create --file {{path/to/file}} {{--private|--shared|--all}} {{image_name}}` + +- Delete image(s): + +`openstack image delete {{image_id1 image_id2 ...}}` + +- Save an image locally: + +`openstack image save --file {{filename}} {{image_id}}` diff --git a/tldr/openstack-server b/tldr/openstack-server new file mode 100644 index 00000000..47eb090e --- /dev/null +++ b/tldr/openstack-server @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack server + +> Manage OpenStack virtual machines. +> OpenStack Compute service, aka OpenStack Nova, mainly hosts and manages cloud computing systems. +> More information: . + +- List servers: + +`openstack server list` + +- Start server(s): + +`openstack server start {{instance_id1 instance_id2 ...}}` + +- Stop server: + +`openstack server stop {{instance_id1 instance_id2 ...}}` + +- Create new server: + +`openstack server create --image {{image_id}} --flavor {{flavor_id}} --network {{network_id}} --wait {{server_name}}` + +- Delete server(s): + +`openstack server delete {{instance_id1 instance_id2 ...}}` + +- Migrate server to different host: + +`openstack server migrate --live {{host_hostname}} {{--shared-migration|--block-migration}} --wait {{instance_id}}` + +- Perform a soft or hard reset to the server: + +`openstack server reboot {{--soft|--hard}} --wait {{instance_id}}` diff --git a/tldr/openstack-volume b/tldr/openstack-volume new file mode 100644 index 00000000..521f636b --- /dev/null +++ b/tldr/openstack-volume @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack volume + +> Manage OpenStack volumes. +> OpenStack Block Storage service, aka OpenStack Cinder, provides volumes to Nova vm's, Ironic bare-metal hosts, containers, and others. +> More information: . + +- List volumes: + +`openstack volume list --all-projects` + +- Show volume details: + +`openstack volume show {{volume_id}}` + +- Create new volume: + +`openstack volume create --size {{size_in_GB}} --image {{image_id}} --snapshot {{snapshot_id}} {{--bootable|--non-bootable}} {{volume_name}}` + +- Delete volumes(s): + +`openstack volume delete {{volume_id1 volume_id2 ...}}` + +- Migrate volume to a new host: + +`openstack volume migrate --host {{host_hostname}} {{instance_id}}` + +- Set volume properties: + +`openstack volume set --name {{volume_new_name}} --size {{volume_new_size}} {{--attached|--detached}} {{--bootable|--non-bootable}} {{volume_id}}` diff --git a/tldr/osx/head b/tldr/osx/head index 98c2c789..a5fe925f 100644 --- a/tldr/osx/head +++ b/tldr/osx/head @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Output the first few lines of a file: -`head --lines {{8}} {{path/to/file}}` +`head {{[-n|--lines]}} {{8}} {{path/to/file}}` - Output the first few bytes of a file: -`head --bytes {{8}} {{path/to/file}}` +`head {{[-c|--bytes]}} {{8}} {{path/to/file}}` - Output everything but the last few lines of a file: -`head --lines -{{8}} {{path/to/file}}` +`head {{[-n|--lines]}} -{{8}} {{path/to/file}}` - Output everything but the last few bytes of a file: -`head --bytes -{{8}} {{path/to/file}}` +`head {{[-c|--bytes]}} -{{8}} {{path/to/file}}` diff --git a/tldr/parallel b/tldr/parallel index 4d974439..264ef4b5 100644 --- a/tldr/parallel +++ b/tldr/parallel @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Download 4 files simultaneously from a text file containing links showing progress: -`parallel -j4 --bar --eta wget -q {} :::: {{path/to/links.txt}}` +`parallel -j4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` - Print the jobs which `parallel` is running in `stderr`: -`parallel -t {{command}} ::: {{args}}` +`parallel {{[-t|--verbose]}} {{command}} ::: {{args}}` diff --git a/tldr/paste b/tldr/paste index ed9e09a1..16a6e4fd 100644 --- a/tldr/paste +++ b/tldr/paste @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Join all the lines into a single line, using TAB as delimiter: -`paste -s {{path/to/file}}` +`paste {{[-s|--serial]}} {{path/to/file}}` - Join all the lines into a single line, using the specified delimiter: -`paste -s -d {{delimiter}} {{path/to/file}}` +`paste {{[-s|--serial]}} {{[-d|--delimiters]}} {{delimiter}} {{path/to/file}}` - Merge two files side by side, each in its column, using TAB as delimiter: @@ -22,9 +22,9 @@ source: https://github.com/tldr-pages/tldr.git - Merge two files side by side, each in its column, using the specified delimiter: -`paste -d {{delimiter}} {{path/to/file1}} {{path/to/file2}}` +`paste {{[-d|--delimiters]}} {{delimiter}} {{path/to/file1}} {{path/to/file2}}` - Merge two files, with lines added alternatively: -`paste -d ' +`paste {{[-d|--delimiters]}} ' ' {{path/to/file1}} {{path/to/file2}}` diff --git a/tldr/popd b/tldr/popd index 35d72b6e..801a40d4 100644 --- a/tldr/popd +++ b/tldr/popd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Remove a directory placed on the directory stack via the pushd shell built-in. > See also `pushd` to place a directory on the stack and `dirs` to display directory stack contents. -> More information: . +> More information: . - Remove the top directory from the stack and cd to it: diff --git a/tldr/pr b/tldr/pr index 8f4f94cd..4b563e6b 100644 --- a/tldr/pr +++ b/tldr/pr @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Print with a custom centered header: -`pr -h "{{header}}" {{path/to/file1 path/to/file2 ...}}` +`pr {{[-h|--header]}} "{{header}}" {{path/to/file1 path/to/file2 ...}}` - Print with numbered lines and a custom date format: -`pr -n -D "{{format}}" {{path/to/file1 path/to/file2 ...}}` +`pr {{[-n|--number-lines]}} {{[-D|--date-format]}} "{{format}}" {{path/to/file1 path/to/file2 ...}}` - Print all files together, one in each column, without a header or footer: -`pr -m -T {{path/to/file1 path/to/file2 ...}}` +`pr {{[-m|--merge]}} {{[-T|--omit-pagination]}} {{path/to/file1 path/to/file2 ...}}` - Print, beginning at page 2 up to page 5, with a given page length (including header and footer): -`pr +2:5 -l {{page_length}} {{path/to/file1 path/to/file2 ...}}` +`pr +2:5 {{[-l|--length]}} {{page_length}} {{path/to/file1 path/to/file2 ...}}` - Print with an offset for each line and a truncating custom page width: -`pr -o {{offset}} -W {{width}} {{path/to/file1 path/to/file2 ...}}` +`pr {{[-o|--indent]}} {{offset}} {{[-W|--page_width]}} {{width}} {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/printenv b/tldr/printenv index 89c0739d..23fc7030 100644 --- a/tldr/printenv +++ b/tldr/printenv @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the value of a variable and end with NUL instead of newline: -`printenv --null {{HOME}}` +`printenv {{[-0|--null]}} {{HOME}}` diff --git a/tldr/qcp b/tldr/qcp index eba6ea24..6b97ee2d 100644 --- a/tldr/qcp +++ b/tldr/qcp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qcp > Copy files using the default text editor to define the filenames. -> More information: . +> More information: . - Copy a single file (open an editor with the source filename on the left and the target filename on the right): @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Copy files, but swap the positions of the source and the target filenames in the editor: -`qcp --option swap {{*.jpg}}` +`qcp {{[-o|--option]}} swap {{*.jpg}}` diff --git a/tldr/qmv b/tldr/qmv index 3cb7d01a..be6d7d89 100644 --- a/tldr/qmv +++ b/tldr/qmv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qmv > Move files and directories using the default text editor to define the filenames. -> More information: . +> More information: . - Move a single file (open an editor with the source filename on the left and the target filename on the right): @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Move multiple directories: -`qmv -d {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` +`qmv {{[-d|--directory]}} {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` - Move all files and directories inside a directory: -`qmv --recursive {{path/to/directory}}` +`qmv {{[-R|--recursive]}} {{path/to/directory}}` - Move files, but swap the positions of the source and the target filenames in the editor: -`qmv --option swap {{*.jpg}}` +`qmv {{[-o|--option]}} swap {{*.jpg}}` - Rename all files and folders in the current directory, but show only target filenames in the editor (you can think of it as a kind of simple mode): -`qmv --format=do .` +`qmv {{[-f|--format]}} do .` diff --git a/tldr/readlink b/tldr/readlink index 31f32c10..1a95e7d4 100644 --- a/tldr/readlink +++ b/tldr/readlink @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Get the absolute path to a file: -`readlink -f {{path/to/file}}` +`readlink {{[-f|--canonicalize]}} {{path/to/file}}` diff --git a/tldr/realpath b/tldr/realpath index 7cf4bbce..3def7ed0 100644 --- a/tldr/realpath +++ b/tldr/realpath @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Require all path components to exist: -`realpath --canonicalize-existing {{path/to/file_or_directory}}` +`realpath {{[-e|--canonicalize-existing]}} {{path/to/file_or_directory}}` - Resolve ".." components before symlinks: -`realpath --logical {{path/to/file_or_directory}}` +`realpath {{[-L|--logical]}} {{path/to/file_or_directory}}` - Disable symlink expansion: -`realpath --no-symlinks {{path/to/file_or_directory}}` +`realpath {{[-s|--no-symlinks]}} {{path/to/file_or_directory}}` - Suppress error messages: -`realpath --quiet {{path/to/file_or_directory}}` +`realpath {{[-q|--quiet]}} {{path/to/file_or_directory}}` diff --git a/tldr/recsel b/tldr/recsel index e46932a5..90dbbd06 100644 --- a/tldr/recsel +++ b/tldr/recsel @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # recsel > Print records from a recfile: a human-editable, plain text database. -> More information: . +> More information: . - Extract name and version field: -`recsel -p name,version {{data.rec}}` +`recsel {{[-p|--print]}} name,version {{data.rec}}` - Use "~" to match a string with a given regular expression: -`recsel -e "{{field_name}} ~ '{{regular_expression}}' {{data.rec}}"` +`recsel {{[-e|--expression]}} "{{field_name}} ~ '{{regular_expression}}' {{data.rec}}"` - Use a predicate to match a name and a version: -`recsel -e "name ~ '{{regular_expression}}' && version ~ '{{regular_expression}}'" {{data.rec}}` +`recsel {{[-e|--expression]}} "name ~ '{{regular_expression}}' && version ~ '{{regular_expression}}'" {{data.rec}}` diff --git a/tldr/rgrep b/tldr/rgrep index edf6974d..32197e6b 100644 --- a/tldr/rgrep +++ b/tldr/rgrep @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Recursively find patterns in files using regular expressions. > Equivalent to `grep -r`. -> More information: . +> More information: . - Recursively search for a pattern in the current working directory: @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Recursively search for a case-insensitive pattern in the current working directory: -`rgrep --ignore-case "{{search_pattern}}"` +`rgrep {{[-i|--ignore-case]}} "{{search_pattern}}"` - Recursively search for an extended regular expression pattern (supports `?`, `+`, `{}`, `()` and `|`) in the current working directory: -`rgrep --extended-regexp "{{search_pattern}}"` +`rgrep {{[-E|--extended-regexp]}} "{{search_pattern}}"` - Recursively search for an exact string (disables regular expressions) in the current working directory: -`rgrep --fixed-strings "{{exact_string}}"` +`rgrep {{[-F|--fixed-strings]}} "{{exact_string}}"` - Recursively search for a pattern in a specified directory (or file): diff --git a/tldr/scheme b/tldr/scheme index b42e8dad..06b92d6e 100644 --- a/tldr/scheme +++ b/tldr/scheme @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # scheme > MIT Scheme language interpreter and REPL (interactive shell). -> More information: . +> More information: . - Start a REPL (interactive shell): diff --git a/tldr/sha1sum b/tldr/sha1sum index 0bc0ebd8..b7523a11 100644 --- a/tldr/sha1sum +++ b/tldr/sha1sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA1 checksums and filenames and verify all files have matching checksums: -`sha1sum --check {{path/to/file.sha1}}` +`sha1sum {{[-c|--check]}} {{path/to/file.sha1}}` - Only show a message for missing files or when verification fails: -`sha1sum --check --quiet {{path/to/file.sha1}}` +`sha1sum {{[-c|--check]}} --quiet {{path/to/file.sha1}}` - Only show a message when verification fails, ignoring missing files: -`sha1sum --ignore-missing --check --quiet {{path/to/file.sha1}}` +`sha1sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha1}}` - Check a known SHA1 checksum of a file: -`echo {{known_sha1_checksum_of_the_file}} {{path/to/file}} | sha1sum --check` +`echo {{known_sha1_checksum_of_the_file}} {{path/to/file}} | sha1sum {{[-c|--check]}}` diff --git a/tldr/sha224sum b/tldr/sha224sum index 3c210983..5bcbb9d1 100644 --- a/tldr/sha224sum +++ b/tldr/sha224sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA224 checksums and filenames and verify all files have matching checksums: -`sha224sum --check {{path/to/file.sha224}}` +`sha224sum {{[-c|--check]}} {{path/to/file.sha224}}` - Only show a message for missing files or when verification fails: -`sha224sum --check --quiet {{path/to/file.sha224}}` +`sha224sum {{[-c|--check]}} --quiet {{path/to/file.sha224}}` - Only show a message when verification fails, ignoring missing files: -`sha224sum --ignore-missing --check --quiet {{path/to/file.sha224}}` +`sha224sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha224}}` - Check a known SHA224 checksum of a file: -`echo {{known_sha224_checksum_of_the_file}} {{path/to/file}} | sha224sum --check` +`echo {{known_sha224_checksum_of_the_file}} {{path/to/file}} | sha224sum {{[-c|--check]}}` diff --git a/tldr/sha256sum b/tldr/sha256sum index aa8e5619..d077c47d 100644 --- a/tldr/sha256sum +++ b/tldr/sha256sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA256 checksums and filenames and verify all files have matching checksums: -`sha256sum --check {{path/to/file.sha256}}` +`sha256sum {{[-c|--check]}} {{path/to/file.sha256}}` - Only show a message for missing files or when verification fails: -`sha256sum --check --quiet {{path/to/file.sha256}}` +`sha256sum {{[-c|--check]}} --quiet {{path/to/file.sha256}}` - Only show a message when verification fails, ignoring missing files: -`sha256sum --ignore-missing --check --quiet {{path/to/file.sha256}}` +`sha256sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha256}}` - Check a known SHA256 checksum of a file: -`echo {{known_sha256_checksum_of_the_file}} {{path/to/file}} | sha256sum --check` +`echo {{known_sha256_checksum_of_the_file}} {{path/to/file}} | sha256sum {{[-c|--check]}}` diff --git a/tldr/sha384sum b/tldr/sha384sum index 075715c6..f3f59dbe 100644 --- a/tldr/sha384sum +++ b/tldr/sha384sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA384 checksums and filenames and verify all files have matching checksums: -`sha384sum --check {{path/to/file.sha384}}` +`sha384sum {{[-c|--check]}} {{path/to/file.sha384}}` - Only show a message for missing files or when verification fails: -`sha384sum --check --quiet {{path/to/file.sha384}}` +`sha384sum {{[-c|--check]}} --quiet {{path/to/file.sha384}}` - Only show a message when verification fails, ignoring missing files: -`sha384sum --ignore-missing --check --quiet {{path/to/file.sha384}}` +`sha384sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha384}}` - Check a known SHA384 checksum of a file: -`echo {{known_sha384_checksum_of_the_file}} {{path/to/file}} | sha384sum --check` +`echo {{known_sha384_checksum_of_the_file}} {{path/to/file}} | sha384sum {{[-c|--check]}}` diff --git a/tldr/sha512sum b/tldr/sha512sum index e38feef3..ef1d8873 100644 --- a/tldr/sha512sum +++ b/tldr/sha512sum @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA512 checksums and filenames and verify all files have matching checksums: -`sha512sum --check {{path/to/file.sha512}}` +`sha512sum {{[-c|--check]}} {{path/to/file.sha512}}` - Only show a message for missing files or when verification fails: -`sha512sum --check --quiet {{path/to/file.sha512}}` +`sha512sum {{[-c|--check]}} --quiet {{path/to/file.sha512}}` - Only show a message when verification fails, ignoring missing files: -`sha512sum --ignore-missing --check --quiet {{path/to/file.sha512}}` +`sha512sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha512}}` - Check a known SHA512 checksum of a file: -`echo {{known_sha512_checksum_of_the_file}} {{path/to/file}} | sha512sum --check` +`echo {{known_sha512_checksum_of_the_file}} {{path/to/file}} | sha512sum {{[-c|--check]}}` diff --git a/tldr/shasum b/tldr/shasum index 5f90def3..833c87b7 100644 --- a/tldr/shasum +++ b/tldr/shasum @@ -26,16 +26,16 @@ source: https://github.com/tldr-pages/tldr.git - Read a file of SHA checksums and filenames and verify all files have matching checksums (the algorithm will be automatically detected): -`shasum --check {{path/to/file}}` +`shasum {{[-c|--check]}} {{path/to/file}}` - Only show a message for missing files or when verification fails: -`shasum --check --quiet {{path/to/file}}` +`shasum {{[-c|--check]}} --quiet {{path/to/file}}` - Only show a message when verification fails, ignoring missing files: -`shasum --ignore-missing --check --quiet {{path/to/file}}` +`shasum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file}}` - Check a known SHA checksum of a file: -`echo {{known_sha_checksum_of_the_file}} {{path/to/file}} | shasum --check` +`echo {{known_sha_checksum_of_the_file}} {{path/to/file}} | shasum {{[-c|--check]}}` diff --git a/tldr/shuf b/tldr/shuf index 9e89ff4a..d1a1ca4a 100644 --- a/tldr/shuf +++ b/tldr/shuf @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Only output the first 5 entries of the result: -`shuf --head-count=5 {{path/to/file}}` +`shuf {{[-n|--head-count]}} 5 {{path/to/file}}` - Write the output to another file: -`shuf {{path/to/input_file}} --output={{path/to/output_file}}` +`shuf {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}}` - Generate 3 random numbers in the range 1-10 (inclusive): -`shuf --head-count=3 --input-range=1-10 --repeat` +`shuf {{[-n|--head-count]}} 3 {{[-i|--input-range]}} 1-10 {{[-r|--repeat]}}` diff --git a/tldr/split b/tldr/split index 2c1c0066..e5654e39 100644 --- a/tldr/split +++ b/tldr/split @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Split a file, each split having 10 lines (except the last split): -`split -l 10 {{path/to/file}}` +`split {{[-l|--lines]}} 10 {{path/to/file}}` - Split a file into 5 files. File is split such that each split has same size (except the last split): -`split -n 5 {{path/to/file}}` +`split {{[-n|--number]}} 5 {{path/to/file}}` - Split a file with 512 bytes in each split (except the last split; use 512k for kilobytes and 512m for megabytes): -`split -b 512 {{path/to/file}}` +`split {{[-b|--bytes]}} 512 {{path/to/file}}` - Split a file with at most 512 bytes in each split without breaking lines: -`split -C 512 {{path/to/file}}` +`split {{[-C|--line-bytes]}} 512 {{path/to/file}}` diff --git a/tldr/stat b/tldr/stat index f28b6655..4cffbfd0 100644 --- a/tldr/stat +++ b/tldr/stat @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Display properties about a specific file such as size, permissions, creation and access dates among others without labels: -`stat --terse {{path/to/file}}` +`stat {{[-t|--terse]}} {{path/to/file}}` - Display information about the filesystem where a specific file is located: -`stat --file-system {{path/to/file}}` +`stat {{[-f|--file-system]}} {{path/to/file}}` - Show only octal file permissions: -`stat --format="%a %n" {{path/to/file}}` +`stat {{[-c|--format]}} "%a %n" {{path/to/file}}` - Show the owner and group of a specific file: -`stat --format="%U %G" {{path/to/file}}` +`stat {{[-c|--format]}} "%U %G" {{path/to/file}}` - Show the size of a specific file in bytes: -`stat --format="%s %n" {{path/to/file}}` +`stat {{[-c|--format]}} "%s %n" {{path/to/file}}` diff --git a/tldr/stdbuf b/tldr/stdbuf index 3ff6b9a4..db07454e 100644 --- a/tldr/stdbuf +++ b/tldr/stdbuf @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Change `stdin` buffer size to 512 KiB: -`stdbuf --input=512K {{command}}` +`stdbuf {{[-i|--input]}} 512K {{command}}` - Change `stdout` buffer to line-buffered: -`stdbuf --output=L {{command}}` +`stdbuf {{[-o|--output]}} L {{command}}` - Change `stderr` buffer to unbuffered: -`stdbuf --error=0 {{command}}` +`stdbuf {{[-e|--error]}} 0 {{command}}` diff --git a/tldr/stow b/tldr/stow index 1cfa3f13..10037c5c 100644 --- a/tldr/stow +++ b/tldr/stow @@ -8,24 +8,24 @@ source: https://github.com/tldr-pages/tldr.git > Symlink manager. > Often used to manage dotfiles. > See also: `chezmoi`, `tuckr`, `vcsh`, `homeshick`. -> More information: . +> More information: . - Symlink all files recursively to a given directory: -`stow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Delete symlinks recursively from a given directory: -`stow --delete --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-D|--delete]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Simulate to see what the result would be like: -`stow --simulate --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-n|--simulate]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Delete and resymlink: -`stow --restow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-R|--restow]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Exclude files matching a regular expression: -`stow --ignore={{regular_expression}} --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow --ignore={{regular_expression}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` diff --git a/tldr/stty b/tldr/stty index 2d7f4c63..f22d025d 100644 --- a/tldr/stty +++ b/tldr/stty @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Display all settings for the current terminal: -`stty --all` +`stty {{[-a|--all]}}` - Set the number of rows or columns: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Get the actual transfer speed of a device: -`stty --file {{path/to/device_file}} speed` +`stty {{[-F|--file]}} {{path/to/device_file}} speed` - Reset all modes to reasonable values for the current terminal: diff --git a/tldr/sum b/tldr/sum index e31d0094..61d1bd34 100644 --- a/tldr/sum +++ b/tldr/sum @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Compute a checksum with System V-compatible algorithm and 512-byte blocks: -`sum --sysv {{path/to/file}}` +`sum {{[-s|--sysv]}} {{path/to/file}}` diff --git a/tldr/tailscale-set b/tldr/tailscale-set new file mode 100644 index 00000000..e9772e35 --- /dev/null +++ b/tldr/tailscale-set @@ -0,0 +1,15 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tailscale set + +> Change the specified preferences. +> These options can also be changed during the initial setup. +> This command can set all options documented in the page for `tailscale up`. +> More information: . + +- View documentation for `tailscale up`: + +`tldr tailscale up` diff --git a/tldr/timeout b/tldr/timeout index 00050f5f..0eec16da 100644 --- a/tldr/timeout +++ b/tldr/timeout @@ -12,18 +12,18 @@ source: https://github.com/tldr-pages/tldr.git `timeout 3s sleep 10` -- Send a [s]ignal to the command after the time limit expires (`TERM` by default, `kill -l` to list all signals): +- Send a signal to the command after the time limit expires (`TERM` by default, `kill -l` to list all signals): -`timeout --signal {{INT|HUP|KILL|...}} {{5s}} {{sleep 10}}` +`timeout {{[-s|--signal]}} {{INT|HUP|KILL|...}} {{5s}} {{sleep 10}}` -- Send [v]erbose output to `stderr` showing signal sent upon timeout: +- Send verbose output to `stderr` showing signal sent upon timeout: -`timeout --verbose {{0.5s|1m|1h|1d|...}} {{command}}` +`timeout {{[-v|--verbose]}} {{0.5s|1m|1h|1d|...}} {{command}}` - Preserve the exit status of the command regardless of timing out: -`timeout --preserve-status {{1s|1m|1h|1d|...}} {{command}}` +`timeout {{[-p|--preserve-status]}} {{1s|1m|1h|1d|...}} {{command}}` - Send a forceful `KILL` signal after certain duration if the command ignores initial signal upon timeout: -`timeout --kill-after={{5m}} {{30s}} {{command}}` +`timeout {{[-k|--kill-after]}} {{5m}} {{30s}} {{command}}` diff --git a/tldr/tr b/tldr/tr index 6ffb5886..e6ede6fb 100644 --- a/tldr/tr +++ b/tldr/tr @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Delete all occurrences of the specified set of characters from the input: -`tr -d '{{input_characters}}' < {{path/to/file}}` +`tr {{[-d|--delete]}} '{{input_characters}}' < {{path/to/file}}` - Compress a series of identical characters to a single character: -`tr -s '{{input_characters}}' < {{path/to/file}}` +`tr {{[-s|--squeeze-repeats]}} '{{input_characters}}' < {{path/to/file}}` - Translate the contents of a file to upper-case: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Strip out non-printable characters from a file: -`tr -cd "[:print:]" < {{path/to/file}}` +`tr {{[-cd|--complement --delete]}} "[:print:]" < {{path/to/file}}` diff --git a/tldr/truncate b/tldr/truncate index 4315fea2..515adac6 100644 --- a/tldr/truncate +++ b/tldr/truncate @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Set a size of 10 GB to an existing file, or create a new file with the specified size: -`truncate --size 10G {{path/to/file}}` +`truncate {{[-s|--size]}} 10G {{path/to/file}}` - Extend the file size by 50 MiB, fill with holes (which reads as zero bytes): -`truncate --size +50M {{path/to/file}}` +`truncate {{[-s|--size]}} +50M {{path/to/file}}` - Shrink the file by 2 GiB, by removing data from the end of file: -`truncate --size -2G {{path/to/file}}` +`truncate {{[-s|--size]}} -2G {{path/to/file}}` - Empty the file's content: -`truncate --size 0 {{path/to/file}}` +`truncate {{[-s|--size]}} 0 {{path/to/file}}` - Empty the file's content, but do not create the file if it does not exist: -`truncate --no-create --size 0 {{path/to/file}}` +`truncate {{[-c|--no-create]}} {{[-s|--size]}} 0 {{path/to/file}}` diff --git a/tldr/unexpand b/tldr/unexpand index a32451e2..1322c45d 100644 --- a/tldr/unexpand +++ b/tldr/unexpand @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Convert all blanks, instead of just initial blanks: -`unexpand -a {{path/to/file}}` +`unexpand {{[-a|--all]}} {{path/to/file}}` - Convert only leading sequences of blanks (overrides -a): @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Have tabs a certain number of characters apart, not 8 (enables -a): -`unexpand -t {{number}} {{path/to/file}}` +`unexpand {{[-t|--tabs]}} {{number}} {{path/to/file}}` diff --git a/tldr/until b/tldr/until index 2a171e70..1fad84d2 100644 --- a/tldr/until +++ b/tldr/until @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Wait for a systemd service to be active: -`until systemctl is-active --quiet {{nginx}}; do {{echo "Waiting..."}}; sleep 1; done; {{echo "Launched!"}}` +`until systemctl is-active {{[-q|--quiet]}} {{nginx}}; do {{echo "Waiting..."}}; sleep 1; done; {{echo "Launched!"}}` diff --git a/tldr/virt-sysprep b/tldr/virt-sysprep index f88a5e5b..80216d37 100644 --- a/tldr/virt-sysprep +++ b/tldr/virt-sysprep @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Remove sensitive system data from a virtual machine image: -`sudo virt-sysprep --add {{path/to/image.qcow2}}` +`sudo virt-sysprep {{[-a|--add]}} {{path/to/image.qcow2}}` - Specify a virtual machine by its name and run all enabled operations but don't actually apply the changes: -`sudo virt-sysprep --domain {{vm_name}} --dry-run` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} {{[-n|--dry-run]}}` - Run only the specified operations: -`sudo virt-sysprep --domain {{vm_name}} --operations {{operation1,operation2,...}}` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} --operations {{operation1,operation2,...}}` - Generate a new `/etc/machine-id` file and enable customizations to be able to change the host name to avoid network conflicts: -`sudo virt-sysprep --domain {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` - Display help: diff --git a/tldr/wdiff b/tldr/wdiff index ae12ee1c..4d27a372 100644 --- a/tldr/wdiff +++ b/tldr/wdiff @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wdiff > Display word differences between text files. -> More information: . +> More information: . - Compare two files: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Ignore case when comparing: -`wdiff --ignore-case {{path/to/file1}} {{path/to/file2}}` +`wdiff {{[-i|--ignore-case]}} {{path/to/file1}} {{path/to/file2}}` - Display how many words are deleted, inserted or replaced: -`wdiff --statistics {{path/to/file1}} {{path/to/file2}}` +`wdiff {{[-s|--statistics]}} {{path/to/file1}} {{path/to/file2}}` diff --git a/tldr/wget2 b/tldr/wget2 index 72e01982..8363d352 100644 --- a/tldr/wget2 +++ b/tldr/wget2 @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > An improved version of `wget` for downloading files from the web. > Supports HTTP, HTTPS, and HTTP/2 protocols with enhanced performance. > By default, `wget2` uses multiple threads for faster downloads. -> More information: . +> More information: . - Download the contents of a URL to a file using multiple threads (default behavior differs from `wget`): @@ -16,28 +16,28 @@ source: https://github.com/tldr-pages/tldr.git - Limit the number of threads used for downloading (default is 5 threads): -`wget2 --max-threads={{10}} {{https://example.com/foo}}` +`wget2 --max-threads {{10}} {{https://example.com/foo}}` - Download a single web page and all its resources (scripts, stylesheets, images, etc.): -`wget2 --page-requisites --convert-links {{https://example.com/somepage.html}}` +`wget2 {{[-p|--page-requisites]}} {{[-k|--convert-links]}} {{https://example.com/somepage.html}}` - Mirror a website, but do not ascend to the parent directory (does not download embedded page elements): -`wget2 --mirror --no-parent {{https://example.com/somepath/}}` +`wget2 {{[-m|--mirror]}} {{[-np|--no-parent]}} {{https://example.com/somepath/}}` - Limit the download speed and the number of connection retries: -`wget2 --limit-rate={{300k}} --tries={{100}} {{https://example.com/somepath/}}` +`wget2 --limit-rate {{300k}} {{[-t|--tries]}} {{100}} {{https://example.com/somepath/}}` - Continue an incomplete download (behavior is consistent with `wget`): -`wget2 --continue {{https://example.com}}` +`wget2 {{[-c|--continue]}} {{https://example.com}}` - Download all URLs stored in a text file to a specific directory: -`wget2 --directory-prefix {{path/to/directory}} --input-file {{URLs.txt}}` +`wget2 {{[-P|--directory-prefix]}} {{path/to/directory}} {{[-i|--input-file]}} {{URLs.txt}}` - Download a file from an HTTP server using Basic Auth (also works for HTTPS): -`wget2 --user={{username}} --password={{password}} {{https://example.com}}` +`wget2 --user {{username}} --password {{password}} {{https://example.com}}` diff --git a/tldr/wireplumber b/tldr/wireplumber index 8913ad00..598ffdbd 100644 --- a/tldr/wireplumber +++ b/tldr/wireplumber @@ -9,10 +9,6 @@ source: https://github.com/tldr-pages/tldr.git > See also: `wpctl`, `pipewire`. > More information: . -- Make WirePlumber start with the user session immediately (for systemd systems): - -`systemctl --user --now enable wireplumber` - - Run WirePlumber, after `pipewire` is started (for non-systemd systems): `wireplumber` diff --git a/tldr/zcat b/tldr/zcat index 6003b30e..e56e97e3 100644 --- a/tldr/zcat +++ b/tldr/zcat @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Print compression details of a `gzip` archive to `stdout`: -`zcat -l {{file.txt.gz}}` +`zcat {{[-l|--list]}} {{file.txt.gz}}`