diff --git a/tldr/$ b/tldr/$ index e71e5e53..2e1599dc 100644 --- a/tldr/$ +++ b/tldr/$ @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Print out a Bash array: -`echo ${array[@]}` +`echo ${{{array_name[@]}}}` diff --git a/tldr/^ b/tldr/^ index 69c63ce9..076b7487 100644 --- a/tldr/^ +++ b/tldr/^ @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Replace all occurrences of `string1`: -`^{{string1}}^{{string2}}^:&` +`^{{string1}}^{{string2}}^:g&` - Print the substituted command without running it: diff --git a/tldr/acme.sh b/tldr/acme.sh index 0880a00c..e612a5f8 100644 --- a/tldr/acme.sh +++ b/tldr/acme.sh @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Issue a certificate using webroot mode: -`acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} {{/path/to/webroot}}` +`acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} /{{path/to/webroot}}` - Issue a certificate for multiple domains using standalone mode using port 80: @@ -35,4 +35,4 @@ source: https://github.com/tldr-pages/tldr.git - Install certificate files into the specified locations (useful for automatic certificate renewal): -`acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` +`acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file /{{path/to/example.com.key}} --fullchain-file /{{path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` diff --git a/tldr/agate b/tldr/agate index ff06fb39..94b3ca5d 100644 --- a/tldr/agate +++ b/tldr/agate @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run and generate a private key and certificate: -`agate --content {{path/to/content/}} --addr {{[::]:1965}} --addr {{0.0.0.0:1965}} --hostname {{example.com}} --lang {{en-US}}` +`agate --content {{path/to/content}}/ --addr {{[::]:1965}} --addr {{0.0.0.0:1965}} --hostname {{example.com}} --lang {{en-US}}` - Run server: diff --git a/tldr/alr b/tldr/alr index 853c74c2..3b56dece 100644 --- a/tldr/alr +++ b/tldr/alr @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Ada package manager. > Manage Ada toolchains, dependencies, tools and libraries. -> More information: . +> More information: . - Create a binary or library project: diff --git a/tldr/archwiki-rs b/tldr/archwiki-rs index 1151ba9a..f48c0ffe 100644 --- a/tldr/archwiki-rs +++ b/tldr/archwiki-rs @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Download a local copy of all ArchWiki pages into a specific directory: -`archwiki-rs local-wiki {{/path/to/local_wiki}} --format {{plain-text|markdown|html}}` +`archwiki-rs local-wiki /{{path/to/local_wiki}} --format {{plain-text|markdown|html}}` diff --git a/tldr/argos-translate b/tldr/argos-translate index f5c3aabf..ddac8734 100644 --- a/tldr/argos-translate +++ b/tldr/argos-translate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # argos-translate > An open-source offline translation library and CLI tool written in Python. -> More information: . +> More information: . - Install translation pairs for Spanish to English translation: diff --git a/tldr/aspell b/tldr/aspell index 10c35b79..26c2f547 100644 --- a/tldr/aspell +++ b/tldr/aspell @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # aspell > Interactive spell checker. -> More information: . +> More information: . - Spell check a single file: diff --git a/tldr/aws-s3-ls b/tldr/aws-s3-ls index 2149a4eb..bb999c6b 100644 --- a/tldr/aws-s3-ls +++ b/tldr/aws-s3-ls @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - List all files in a path with a given prefix: -`aws s3 ls --recursive {{bucket_name}}/{{path/to/directory/}}{{prefix}}` +`aws s3 ls --recursive {{bucket_name}}/{{path/to/directory}}/{{prefix}}` - Display help: diff --git a/tldr/babel b/tldr/babel index 51cdace7..529549cb 100644 --- a/tldr/babel +++ b/tldr/babel @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # babel > A transpiler which converts code from JavaScript ES6/ES7 syntax to ES5 syntax. -> More information: . +> More information: . - Transpile a specified input file and output to `stdout`: diff --git a/tldr/bash b/tldr/bash index fe1c3033..cc46bd62 100644 --- a/tldr/bash +++ b/tldr/bash @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Bourne-Again SHell, an `sh`-compatible command-line interpreter. > See also: `zsh`, `histexpand` (history expansion). -> More information: . +> More information: . - Start an interactive shell session: diff --git a/tldr/bird b/tldr/bird index 9c322f7b..dcdd08c3 100644 --- a/tldr/bird +++ b/tldr/bird @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > BIRD Internet Routing Daemon. > Routing daemon with support for BGP, OSPF, Babel and others. -> More information: . +> More information: . - Start Bird with a specific configuration file: diff --git a/tldr/birdc b/tldr/birdc index bd352aaf..a614226c 100644 --- a/tldr/birdc +++ b/tldr/birdc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > BIRD remote control. > Retrieve information like routes from bird and perform configurations during runtime. -> More information: . +> More information: . - Open the remote control console: diff --git a/tldr/blender b/tldr/blender index ee3b39c2..e0d52c29 100644 --- a/tldr/blender +++ b/tldr/blender @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Render the 10th frame of an animation as a single image, saved to an existing directory (absolute path): -`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-o|--render-output]}} {{/path/to/output_directory}} {{[-f|--render-frame]}} {{10}}` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-o|--render-output]}} /{{path/to/output_directory}} {{[-f|--render-frame]}} {{10}}` - Render the second last frame in an animation as a JPEG image, saved to an existing directory (relative path): diff --git a/tldr/bower b/tldr/bower index d771574f..0e52d8b1 100644 --- a/tldr/bower +++ b/tldr/bower @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A package manager optimized for front-end web development. > A package can be a GitHub user/repo shorthand, a Git endpoint, a URL or a registered package. -> More information: . +> More information: . - Install a project's dependencies, listed in its bower.json: diff --git a/tldr/browsh b/tldr/browsh index b291b533..b53d10e0 100644 --- a/tldr/browsh +++ b/tldr/browsh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # browsh > View webpages on the terminal using a Firefox backend. -> More information: . +> More information: . - Start browsh: diff --git a/tldr/bzgrep b/tldr/bzgrep index fac9ffd8..c951b50a 100644 --- a/tldr/bzgrep +++ b/tldr/bzgrep @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Search `stdin` for lines that do not match a pattern: -`cat {{/path/to/bz/compressed/file}} | bzgrep {{[-v|--invert-match]}} "{{search_pattern}}"` +`cat {{path/to/bz/compressed/file}} | bzgrep {{[-v|--invert-match]}} "{{search_pattern}}"` diff --git a/tldr/case b/tldr/case index 9be1574b..6087cfd8 100644 --- a/tldr/case +++ b/tldr/case @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Allow matching multiple patterns: -`case {{$ANIMAL}} in {{cat}}) echo "It's a cat" ;;& {{cat|dog}}) echo "It's a cat or a dog" ;;& *) echo "Fallback" ;; esac` +`case {{$ANIMAL}} in {{cat}}) {{echo "It's a cat"}} ;;& {{cat|dog}}) {{echo "It's a cat or a dog"}} ;;& *) {{echo "Fallback"}} ;; esac` - Continue to the next pattern's commands without checking the pattern: -`case {{$ANIMAL}} in {{cat}}) echo "It's a cat" ;& {{dog}}) echo "It's either a dog or cat fell through" ;& *) echo "Fallback" ;; esac` +`case {{$ANIMAL}} in {{cat}}) echo {{"It's a cat"}} ;& {{dog}}) {{echo "It's either a dog or cat fell through"}} ;& *) {{echo "Fallback"}} ;; esac` - Display help: diff --git a/tldr/cisco-ios/clock b/tldr/cisco-ios/clock new file mode 100644 index 00000000..f081b8cb --- /dev/null +++ b/tldr/cisco-ios/clock @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# clock + +> Set the system clock. +> More information: . + +- Enter privileged execution mode: + +`clock set {{23}}:{{59}}:{{59}} {{31}} {{april}} {{2000}}` + +- Auto negotiate with the far end of the link, defaulting to active-clock: + +`clock active prefer` + +- Auto negotiate with the far end of the link, defaulting to passive-clock: + +`clock passive prefer` + +- Show the current clock mode negotiated by the firmware: + +`clock show interfaces` diff --git a/tldr/cisco-ios/configure b/tldr/cisco-ios/configure new file mode 100644 index 00000000..add38e6a --- /dev/null +++ b/tldr/cisco-ios/configure @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# configure + +> Enter configuration mode. +> More information: . + +- Configure from the terminal: + +`{{[conf|configure]}} {{[t|terminal]}}` + +- Back out one level in configuration mode: + +`exit` + +- Exit out of configuration mode: + +`end` diff --git a/tldr/cisco-ios/crypto b/tldr/cisco-ios/crypto index 971deb49..97a51a54 100644 --- a/tldr/cisco-ios/crypto +++ b/tldr/cisco-ios/crypto @@ -12,3 +12,11 @@ source: https://github.com/tldr-pages/tldr.git - Generate an `rsa` key: `crypto key generate rsa` + +- Define a modulus for a key: + +`crypto key generate rsa modulus {{1024}}` + +- Remove all keys: + +`crypto key zeroize` diff --git a/tldr/cisco-ios/delete b/tldr/cisco-ios/delete new file mode 100644 index 00000000..1d8428dc --- /dev/null +++ b/tldr/cisco-ios/delete @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# delete + +> Delete individual files. +> More information: . + +- Delete a file from flash memory: + +`delete {{vlan.dat}}` diff --git a/tldr/cisco-ios/dir b/tldr/cisco-ios/dir new file mode 100644 index 00000000..7f1687f3 --- /dev/null +++ b/tldr/cisco-ios/dir @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# dir + +> List files. +> More information: . + +- List files in the current working directory: + +`dir` + +- List files in a specific filesystem: + +`dir {{flash}}:` + +- List available filesystems: + +`dir ?` diff --git a/tldr/cisco-ios/erase b/tldr/cisco-ios/erase new file mode 100644 index 00000000..0fd8f584 --- /dev/null +++ b/tldr/cisco-ios/erase @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# erase + +> Delete preset things. +> More information: . + +- Erase the startup configuration: + +`erase startup-config` + +- Erase a filesystem: + +`erase {{flash}}:` diff --git a/tldr/cisco-ios/ip b/tldr/cisco-ios/ip new file mode 100644 index 00000000..56093dd5 --- /dev/null +++ b/tldr/cisco-ios/ip @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# ip + +> Manage IP configurations. +> Accessed in configuration mode. +> More information: . + +- Set the SSH version: + +`ip ssh version {{2}}` + +- Set the address of the device (This is done under `interface command`): + +`ip address {{10.0.0.1}} {{255.255.255.0}}` + +- Set the address to be determined with DHCP (This is done under `interface command`): + +`ip address dhcp` + +- Define a domain name: + +`ip domain-name {{example.com}}` diff --git a/tldr/cisco-ios/line b/tldr/cisco-ios/line new file mode 100644 index 00000000..8d81eed0 --- /dev/null +++ b/tldr/cisco-ios/line @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# line + +> Manage lines. +> Accessed in configuration mode. +> More information: . + +- Configure lines from 0 to 15: + +`line vty 0 15` diff --git a/tldr/cisco-ios/login b/tldr/cisco-ios/login new file mode 100644 index 00000000..b638e286 --- /dev/null +++ b/tldr/cisco-ios/login @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# login + +> Manage line transport protocols. +> Accessed in configuration mode under `line`. +> More information: . + +- Use local username and password for authentication: + +`login local` diff --git a/tldr/cisco-ios/reload b/tldr/cisco-ios/reload new file mode 100644 index 00000000..62e5076a --- /dev/null +++ b/tldr/cisco-ios/reload @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# reload + +> Control reboot behavior. +> More information: . + +- Reboot the system: + +`reload` + +- Reboot after `n` seconds: + +`reload in {{n}}` + +- Cancel pending reboots: + +`reload cancel` diff --git a/tldr/cisco-ios/show b/tldr/cisco-ios/show new file mode 100644 index 00000000..b4824379 --- /dev/null +++ b/tldr/cisco-ios/show @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# show + +> Show various system information. +> More information: . + +- Show switch IP addresses: + +`{{[s|show]}} ip interface brief` + +- Show specific interface configuration: + +`{{[s|show]}} ip interface {{vlan1}}` + +- Show vlan configuration: + +`{{[s|show]}} vlan` + +- Show currently running configuration: + +`{{[s|show]}} running-config` + +- Show SSH configuration: + +`{{[s|show]}} ip ssh` diff --git a/tldr/cisco-ios/transport b/tldr/cisco-ios/transport new file mode 100644 index 00000000..8212f293 --- /dev/null +++ b/tldr/cisco-ios/transport @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# transport + +> Manage line transport protocols. +> Accessed in configuration mode under `line`. +> More information: . + +- Restrict line protocols to `ssh`: + +`transport input ssh` diff --git a/tldr/cisco-ios/username b/tldr/cisco-ios/username new file mode 100644 index 00000000..7f23c34a --- /dev/null +++ b/tldr/cisco-ios/username @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# username + +> Manage users. +> Accessed in configuration mode. +> More information: . + +- Set up an admin account: + +`username {{admin}} privilege 15 secret {{password}}` diff --git a/tldr/cisco-ios/write b/tldr/cisco-ios/write new file mode 100644 index 00000000..0d03598e --- /dev/null +++ b/tldr/cisco-ios/write @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, cisco-ios] +source: https://github.com/tldr-pages/tldr.git +--- +# write + +> Write data to memory. +> More information: . + +- Write current configuration to memory: + +`write memory` + +- Delete the configuration in memory: + +`write erase` + +- Display help: + +`write ?` diff --git a/tldr/clangd b/tldr/clangd index 9fb6a2c5..2c50f315 100644 --- a/tldr/clangd +++ b/tldr/clangd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Language server that provides IDE-like features to editors. > It should be used via an editor plugin rather than invoked directly. -> More information: . +> More information: . - Display available options: diff --git a/tldr/cmp b/tldr/cmp index 8b24a223..34a91177 100644 --- a/tldr/cmp +++ b/tldr/cmp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cmp > Compare two files byte by byte. -> More information: . +> More information: . - Output char and line number of the first difference between two files: diff --git a/tldr/codecrafters b/tldr/codecrafters index 7a4808a9..c4b376e8 100644 --- a/tldr/codecrafters +++ b/tldr/codecrafters @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # codecrafters > Practice writing complex software. -> More information: . +> More information: . - Run tests without committing changes: diff --git a/tldr/compgen b/tldr/compgen index fe600c6a..5fb6c32e 100644 --- a/tldr/compgen +++ b/tldr/compgen @@ -5,16 +5,22 @@ source: https://github.com/tldr-pages/tldr.git --- # compgen -> A built-in command for auto-completion in Bash, which is called on pressing `` key twice. +> Bash built-in command for generating possible completion matches in Bash. +> Usually used within custom completion functions. +> See also: `complete`, `compopt`. > More information: . -- List all commands that you could run: +- List all shell built-ins, aliases, functions and executables that you could run: `compgen -c` -- List all commands that you could run that start with a specified string: +- List all commands that you could run that start with a specified string and save results to `COMPREPLY`: -`compgen -c {{str}}` +`compgen -V COMPREPLY -c {{str}}` + +- Match against a wordlist: + +`compgen -W "{{apple orange banana}}" {{a}}` - List all aliases: @@ -35,7 +41,3 @@ source: https://github.com/tldr-pages/tldr.git - List all users on the system: `compgen -u` - -- Display help: - -`compgen --help` diff --git a/tldr/complete b/tldr/complete index 247a1756..930f267a 100644 --- a/tldr/complete +++ b/tldr/complete @@ -5,17 +5,31 @@ source: https://github.com/tldr-pages/tldr.git --- # complete -> Get argument autocompletion to shell commands. -> More information: . +> Get and set argument autocompletion rules of shell commands in Bash. +> The specified completions will be invoked when `` is pressed in Bash. +> See also: `compgen`, `compopt`. +> More information: . -- Apply a function that performs autocompletion to a command: +- Set arguments of a command to autocomplete through a function (completion response is sent in `COMPREPLY` variable): `complete -F {{function}} {{command}}` -- Apply a command that performs autocompletion to another command: +- Set arguments of a command to autocomplete through another command (`$1` is the command, `$2` is the argument the cursor is on, and `$3` is the argument preceding the cursor): `complete -C {{autocomplete_command}} {{command}}` +- Set arguments of a command to autocomplete to shell builtins: + +`complete -b {{command}}` + - Apply autocompletion without appending a space to the completed word: `complete -o nospace -F {{function}} {{command}}` + +- List all loaded complete specifications: + +`complete -p` + +- List loaded complete specifications for a command: + +`complete -p {{command}}` diff --git a/tldr/compopt b/tldr/compopt index 3c00cefd..32362205 100644 --- a/tldr/compopt +++ b/tldr/compopt @@ -6,12 +6,22 @@ source: https://github.com/tldr-pages/tldr.git # compopt > Print or change the completion options for a command. -> More information: . +> `-o` means enabled and `+o` means disabled. +> See also: `compgen`, `complete`. +> More information: . + +- Print the completion options for given command: + +`compopt {{command}}` + +- Enable or disable a completion option of a command: + +`compopt {{-o|+o}} {{option1}} {{-o|+o}} {{option2}} {{command}}` - Print the options for the currently executing completion: `compopt` -- Print the completion options for given command: +- Enable or disable a completion option of a command: -`compopt {{command}}` +`compopt {{-o|+o}} {{option1}} {{-o|+o}} {{option2}}` diff --git a/tldr/composer b/tldr/composer index 58089d6e..a6482ca5 100644 --- a/tldr/composer +++ b/tldr/composer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # composer > A package-based dependency manager for PHP projects. -> More information: . +> More information: . - Interactively create a `composer.json` file: diff --git a/tldr/conan b/tldr/conan index 10856314..c4fff640 100644 --- a/tldr/conan +++ b/tldr/conan @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The open source, decentralized and cross-platform package manager to create and share all your native binaries. > Some subcommands such as `frogarian` have their own usage documentation. -> More information: . +> More information: . - Install packages based on `conanfile.txt`: diff --git a/tldr/continue b/tldr/continue index db4087d3..bdb74754 100644 --- a/tldr/continue +++ b/tldr/continue @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Skip to the next iteration: -`while :; do continue; echo "This will never be reached"; done` +`while :; do continue; {{echo "This will never be reached"}}; done` - Skip to the next iteration from within a nested loop: -`for i in {1..3}; do while :; do continue 2; done; done` +`for i in {{{1..3}}}; do {{echo $i}}; while :; do continue 2; done; done` diff --git a/tldr/coproc b/tldr/coproc index c70373e5..cad2698b 100644 --- a/tldr/coproc +++ b/tldr/coproc @@ -26,11 +26,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a coprocess which repeatedly reads `stdin` and runs some commands on the input: -`coproc {{name}} { while read line; do {{command1; command2; ...}}; done }` +`coproc {{name}} { while read {{line}}; do {{command1; command2; ...}}; done }` - Create a coprocess which repeatedly reads `stdin`, runs a pipeline on the input, and writes the output to `stdout`: -`coproc {{name}} { while read line; do echo "$line" | {{command1 | command2 | ...}} | cat /dev/fd/0; done }` +`coproc {{name}} { while read {{line}}; do {{echo "$line"}} | {{command1 | command2 | ...}} | cat /dev/fd/0; done }` - Create and use a coprocess running `bc`: diff --git a/tldr/crontab b/tldr/crontab index 9f6d6533..60f4927b 100644 --- a/tldr/crontab +++ b/tldr/crontab @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # crontab > Schedule cron jobs to run on a time interval for the current user. -> More information: . +> More information: . - Edit the crontab file for the current user: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Sample crontab entry, which runs a certain script at 02:30 every Friday: -`30 2 * * Fri {{/absolute/path/to/script.sh}}` +`30 2 * * Fri /{{path/to/script.sh}}` diff --git a/tldr/cryfs b/tldr/cryfs index a9170328..ff984d87 100644 --- a/tldr/cryfs +++ b/tldr/cryfs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cryfs > A cryptographic filesystem for the cloud. -> More information: . +> More information: . - Mount an encrypted filesystem. The initialization wizard will be started on the first execution: diff --git a/tldr/ctags b/tldr/ctags index 13843755..73e2a847 100644 --- a/tldr/ctags +++ b/tldr/ctags @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ctags > Generate an index (or tag) file of language objects found in source files for many popular programming languages. -> More information: . +> More information: . - Generate tags for a single file, and output them to a file named "tags" in the current directory, overwriting the file if it exists: diff --git a/tldr/dcfldd b/tldr/dcfldd index a3f02511..ba31e374 100644 --- a/tldr/dcfldd +++ b/tldr/dcfldd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dcfldd > Enhanced version of dd for forensics and security. -> More information: . +> More information: . - Copy a disk to a raw image file and hash the image using SHA256: diff --git a/tldr/declare b/tldr/declare index 708b55dc..0571e051 100644 --- a/tldr/declare +++ b/tldr/declare @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Print a function definition: `declare -f {{function_name}}` + +- Print a variable definition: + +`declare -p {{variable_name}}` diff --git a/tldr/devcontainer b/tldr/devcontainer index 138826e7..46c112b2 100644 --- a/tldr/devcontainer +++ b/tldr/devcontainer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # devcontainer > Use a Docker container as a development environment. -> More information: . +> More information: . - Create and run a Dev Container: diff --git a/tldr/dillo b/tldr/dillo index 9cb7f1b7..81379fa8 100644 --- a/tldr/dillo +++ b/tldr/dillo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dillo > A lightweight web browser intended for slow computers. -> More information: . +> More information: . - Launch Dillo: diff --git a/tldr/docker-run b/tldr/docker-run index a1c724d8..08b3ac06 100644 --- a/tldr/docker-run +++ b/tldr/docker-run @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Run command in a new container with bind mounted volumes: -`docker run {{[-v|--volume]}} {{/path/to/host_path}}:{{/path/to/container_path}} {{image}} {{command}}` +`docker run {{[-v|--volume]}} /{{path/to/host_path}}:/{{path/to/container_path}} {{image}} {{command}}` - Run command in a new container with published ports: diff --git a/tldr/encfs b/tldr/encfs index df0c2651..eef4faa3 100644 --- a/tldr/encfs +++ b/tldr/encfs @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Initialize or mount an encrypted filesystem: -`encfs {{/path/to/cipher_dir}} {{/path/to/mount_point}}` +`encfs /{{path/to/cipher_dir}} /{{path/to/mount_point}}` - Initialize an encrypted filesystem with standard settings: -`encfs --standard {{/path/to/cipher_dir}} {{/path/to/mount_point}}` +`encfs --standard /{{path/to/cipher_dir}} /{{path/to/mount_point}}` - Run encfs in the foreground instead of spawning a daemon: -`encfs -f {{/path/to/cipher_dir}} {{/path/to/mount_point}}` +`encfs -f /{{path/to/cipher_dir}} /{{path/to/mount_point}}` - Mount an encrypted snapshot of a plain directory: diff --git a/tldr/envsubst b/tldr/envsubst index 60261bed..9ee0b505 100644 --- a/tldr/envsubst +++ b/tldr/envsubst @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Substitutes environment variables with their value in shell format strings. > Variables to be replaced should be in either `${var}` or `$var` format. -> More information: . +> More information: . - Replace environment variables in `stdin` and output to `stdout`: diff --git a/tldr/ern b/tldr/ern index 96afc26d..6b9a7469 100644 --- a/tldr/ern +++ b/tldr/ern @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Create an Electrode Native container: -`ern create-container --miniapps {{/path/to/miniapp_directory}} --platform {{ios|android}}` +`ern create-container --miniapps /{{path/to/miniapp_directory}} --platform {{ios|android}}` - Publish an Electrode Native container to a local Maven repository: diff --git a/tldr/esbuild b/tldr/esbuild index bf8f2686..38e58400 100644 --- a/tldr/esbuild +++ b/tldr/esbuild @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # esbuild > JavaScript bundler and minifier built for speed. -> More information: . +> More information: . - Bundle a JavaScript application and print to `stdout`: diff --git a/tldr/espanso b/tldr/espanso index cb5c8eeb..c0b81182 100644 --- a/tldr/espanso +++ b/tldr/espanso @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # espanso > Cross-platform Text Expander written in Rust. -> More information: . +> More information: . - Check status: diff --git a/tldr/exo-iam b/tldr/exo-iam index e5a371fe..fa2ff0a5 100644 --- a/tldr/exo-iam +++ b/tldr/exo-iam @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a new IAM role: -`cat {{/path/to/policy.json}} | exo iam role create {{iam_role_name}} --editable --policy -` +`cat {{path/to/policy.json}} | exo iam role create {{iam_role_name}} --editable --policy -` - Show the policy of an existing IAM role: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Update the default Organization policy (the default Organization policy will be applied to all of the API keys within the Organization): -`cat {{/path/to/policy.json}} | exo iam org-policy update -` +`cat {{path/to/policy.json}} | exo iam org-policy update -` diff --git a/tldr/flake8 b/tldr/flake8 index bc4f13ac..cdd04906 100644 --- a/tldr/flake8 +++ b/tldr/flake8 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # flake8 > Check the style and quality of Python code. -> More information: . +> More information: . - Lint a file or directory recursively: @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `flake8 --show-source {{path/to/file_or_directory}}` -- Lint a file or directory recursively and ignore a list of rules. (All available rules can be found at flake8rules.com): +- Lint a file or directory recursively and ignore a list of rules. (All available rules can be found at ): -`flake8 --ignore {{rule1,rule2}} {{path/to/file_or_directory}}` +`flake8 --ignore {{rule1,rule2,...}} {{path/to/file_or_directory}}` - Lint a file or directory recursively but exclude files matching the given globs or substrings: diff --git a/tldr/fossil b/tldr/fossil index 226c2e8d..05cdacfb 100644 --- a/tldr/fossil +++ b/tldr/fossil @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Distributed version control system. > Some subcommands such as `commit` have their own usage documentation. -> More information: . +> More information: . - Execute a Fossil subcommand: diff --git a/tldr/fossil-commit b/tldr/fossil-commit index d867a384..d817690e 100644 --- a/tldr/fossil-commit +++ b/tldr/fossil-commit @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a new version containing all the changes in the current checkout; user will be prompted for a comment: -`fossil commit` +`fossil {{[ci|commit]}}` - Create a new version containing all the changes in the current checkout, using the specified [m]essage: -`fossil commit {{[-m|--comment]}} "{{comment}}"` +`fossil {{[ci|commit]}} {{[-m|--comment]}} "{{comment}}"` - Create a new version containing all the changes in the current checkout with a comment read from a specific file: -`fossil commit {{[-M|--message-file]}} {{path/to/commit_message_file}}` +`fossil {{[ci|commit]}} {{[-M|--message-file]}} {{path/to/commit_message_file}}` - Create a new version containing changes from the specified files; user will be prompted for a comment: -`fossil commit {{path/to/file1 path/to/file2 ...}}` +`fossil {{[ci|commit]}} {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/fossil-delete b/tldr/fossil-delete index 90e8fbb1..16e2da8f 100644 --- a/tldr/fossil-delete +++ b/tldr/fossil-delete @@ -5,8 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # fossil delete -> This command is an alias of `fossil rm`. +> Remove files or directories from Fossil version control. +> See also: `fossil forget`. +> More information: . -- View documentation for the original command: +- Remove a file or directory from Fossil version control: -`tldr fossil rm` +`fossil {{[rm|delete]}} {{path/to/file_or_directory}}` + +- Remove a file or directory from Fossil version control, and also delete it from the disk: + +`fossil {{[rm|delete]}} --hard {{path/to/file_or_directory}}` + +- Re-add all previously removed and uncommitted files to Fossil version control: + +`fossil {{[rm|delete]}} --reset` diff --git a/tldr/fossil-rm b/tldr/fossil-rm index cae93c35..4f89cac0 100644 --- a/tldr/fossil-rm +++ b/tldr/fossil-rm @@ -5,18 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # fossil rm -> Remove files or directories from Fossil version control. -> See also: `fossil forget`. -> More information: . +> This command is an alias of `fossil delete`. -- Remove a file or directory from Fossil version control: +- View documentation for the original command: -`fossil rm {{path/to/file_or_directory}}` - -- Remove a file or directory from Fossil version control, and also delete it from the disk: - -`fossil rm --hard {{path/to/file_or_directory}}` - -- Re-add all previously removed and uncommitted files to Fossil version control: - -`fossil rm --reset` +`tldr fossil delete` diff --git a/tldr/gendesk b/tldr/gendesk index 55feeddf..b3408ad7 100644 --- a/tldr/gendesk +++ b/tldr/gendesk @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a `.desktop` file named `app`: -`gendesk -n --name "{{app}}" --exec "{{/path/to/app}}" --icon "{{/path/to/icon.png}}" --comment "{{This is application}}"` +`gendesk -n --name "{{app}}" --exec "/{{path/to/app}}" --icon "/{{path/to/icon.png}}" --comment "{{This is application}}"` - Create a `.desktop` file named `app`, do not display any output, and overwrite it if it exists: -`gendesk -q -f -n --name "{{app}}" --exec "{{/path/to/app}}" --icon "{{/path/to/icon.png}}" --comment "{{This is application}}"` +`gendesk -q -f -n --name "{{app}}" --exec "/{{path/to/app}}" --icon "/{{path/to/icon.png}}" --comment "{{This is application}}"` - Display help: diff --git a/tldr/getopts b/tldr/getopts index 758738f8..647192c5 100644 --- a/tldr/getopts +++ b/tldr/getopts @@ -9,21 +9,25 @@ source: https://github.com/tldr-pages/tldr.git > This command does not support longform options and thus using `getopt` is recommended instead. > More information: . -- Check if an option is set: +- Check if an option is the first set option in the current context: -`getopts {{x}} {{opt}}; echo $opt` +`getopts {{x}} {{opt}}; echo ${{opt}}` -- Set an option to require an argument and check said argument: +- Check if an option is set in a string (specified option must be the first element of the string): -`getopts {{x}}: {{opt}}; echo $OPTARG` +`getopts {{x}} {{opt}} "{{string text}}"; echo ${{opt}}` + +- Set an option to require an argument and print them: + +`getopts {{x}}: {{opt}}; echo ${{opt}} $OPTARG` - Check for multiple options: -`while getopts {{xyz}} {{opt}}; do case $opt in x) echo x is set;; y) echo y is set;; z) echo z is set;; esac; done` +`while getopts {{xyz}} {{opt}}; do case ${{opt}} in x) {{echo x is set}};; y) {{echo y is set}};; z) {{echo z is set}};; esac; done` - Set `getopts` to silent mode and handle option errors: -`while getopts :{{x:}} {{opt}}; do case $opt in x) ;; :) echo "Argument required";; ?) echo "Invalid argument" esac;; done` +`while getopts :{{x:}} {{opt}}; do case ${{opt}} in x) ;; :) {{echo "Argument required"}};; ?) {{echo "Invalid argument"}} esac;; done` - Reset `getopts`: diff --git a/tldr/gettext b/tldr/gettext index d3309bf7..e92aade4 100644 --- a/tldr/gettext +++ b/tldr/gettext @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Translates a string using stored translations in a compiled `.mo` file. > Translations are stored in `/usr/share/locale//LC_MESSAGES/` with `domain` being the filename without its extension. > See also: `msgfmt`, `msgunfmt`. -> More information: . +> More information: . - Get the translation of a string as specified in the domain file (falls back to given `msgid` if no translation exists): diff --git a/tldr/git-blame b/tldr/git-blame index 033074aa..0da5e052 100644 --- a/tldr/git-blame +++ b/tldr/git-blame @@ -24,6 +24,10 @@ source: https://github.com/tldr-pages/tldr.git `git blame {{commit}}~ {{path/to/file}}` +- Jump to the parent of a specific commit and track a specific text and 10 of its following lines: + +`git blame -L '/{{text}}/',+10 {{a82812aa}}^ tldr.py` + - Print author name and commit hash information for a specific line range: `git blame -L {{start_line}},{{end_line}} {{path/to/file}}` diff --git a/tldr/git-bulk b/tldr/git-bulk index 628914a1..8381ac50 100644 --- a/tldr/git-bulk +++ b/tldr/git-bulk @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Register a workspace for bulk operations: -`git bulk --addworkspace {{workspace_name}} {{/absolute/path/to/repository}}` +`git bulk --addworkspace {{workspace_name}} /{{path/to/repository}}` - Clone a repository inside a specific directory, then register the repository as a workspace: -`git bulk --addworkspace {{workspace_name}} {{/absolute/path/to/parent_directory}} --from {{remote_repository_location}}` +`git bulk --addworkspace {{workspace_name}} /{{path/to/parent_directory}} --from {{remote_repository_location}}` - Clone repositories from a newline-separated list of remote locations, then register them as workspaces: -`git bulk --addworkspace {{workspace_name}} {{/path/to/root/directory}} --from {{/path/to/file}}` +`git bulk --addworkspace {{workspace_name}} /{{path/to/root/directory}} --from /{{path/to/file}}` - List all registered workspaces: diff --git a/tldr/git-checkout-index b/tldr/git-checkout-index index 476718e5..853608c7 100644 --- a/tldr/git-checkout-index +++ b/tldr/git-checkout-index @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Export a copy of the entire tree at the last commit to the specified directory (the trailing slash is important): -`git checkout-index {{[-a|--all]}} {{[-f|--force]}} --prefix {{path/to/export_directory/}}` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}} --prefix {{path/to/export_directory}}/` diff --git a/tldr/git-subtree b/tldr/git-subtree index 184e21e2..5c53bfd5 100644 --- a/tldr/git-subtree +++ b/tldr/git-subtree @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Add a Git repository as a subtree: -`git subtree add {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree add {{[-P|--prefix]}} {{path/to/directory}}/ --squash {{repository_url}} {{branch_name}}` - Update subtree repository to its latest commit: -`git subtree pull {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree pull {{[-P|--prefix]}} {{path/to/directory}}/ {{repository_url}} {{branch_name}}` - Merge recent changes up to the latest subtree commit into the subtree: -`git subtree merge {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree merge {{[-P|--prefix]}} {{path/to/directory}}/ --squash {{repository_url}} {{branch_name}}` - Push commits to a subtree repository: -`git subtree push {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree push {{[-P|--prefix]}} {{path/to/directory}}/ {{repository_url}} {{branch_name}}` - Extract a new project history from the history of a subtree: -`git subtree split {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{[-b|--branch]}} {{branch_name}}` +`git subtree split {{[-P|--prefix]}} {{path/to/directory}}/ {{repository_url}} {{[-b|--branch]}} {{branch_name}}` diff --git a/tldr/gnuplot b/tldr/gnuplot index 3315328f..82b66e19 100644 --- a/tldr/gnuplot +++ b/tldr/gnuplot @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gnuplot > A graph plotter that outputs in several formats. -> More information: . +> More information: . - Start the interactive graph plotting shell: diff --git a/tldr/go b/tldr/go index 679a02b1..63ae9f80 100644 --- a/tldr/go +++ b/tldr/go @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage Go source code. > Some subcommands such as `build` have their own usage documentation. -> More information: . +> More information: . - Download and install a package, specified by its import path: diff --git a/tldr/godoc b/tldr/godoc index 5cb93d8e..ed26cbcc 100644 --- a/tldr/godoc +++ b/tldr/godoc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # godoc > View documentation for go packages. -> More information: . +> More information: . - Display help for a specific package: diff --git a/tldr/godot b/tldr/godot index b8d17570..0babda66 100644 --- a/tldr/godot +++ b/tldr/godot @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # godot > An open source 2D and 3D game engine. -> More information: . +> More information: . - Run a project if the current directory contains a `project.godot` file, otherwise open the project manager: diff --git a/tldr/hashcat b/tldr/hashcat index f6eccc86..80a15d53 100644 --- a/tldr/hashcat +++ b/tldr/hashcat @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Perform a combination attack (mode 1) using the concatenation of words from two different custom dictionaries: -`hashcat --hash-type {{hash_type_id}} --attack-mode {{1}} {{hash_value}} {{/path/to/dictionary1.txt}} {{/path/to/dictionary2.txt}}` +`hashcat --hash-type {{hash_type_id}} --attack-mode {{1}} {{hash_value}} /{{path/to/dictionary1.txt}} /{{path/to/dictionary2.txt}}` - Show result of an already cracked hash: diff --git a/tldr/haxelib b/tldr/haxelib index 32eccb20..76947734 100644 --- a/tldr/haxelib +++ b/tldr/haxelib @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # haxelib > Haxe Library Manager. -> More information: . +> More information: . - Search for a Haxe library: diff --git a/tldr/hello b/tldr/hello index 17b33b47..802647aa 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!": diff --git a/tldr/helm b/tldr/helm index ca018b8a..6f399826 100644 --- a/tldr/helm +++ b/tldr/helm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A package manager for Kubernetes. > Some subcommands such as `install` have their own usage documentation. -> More information: . +> More information: . - Create a helm chart: diff --git a/tldr/heroku b/tldr/heroku index 25030cab..9a01319f 100644 --- a/tldr/heroku +++ b/tldr/heroku @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # heroku > Create and manage Heroku apps. -> More information: . +> More information: . - Log in to your Heroku account: diff --git a/tldr/hexo b/tldr/hexo index b99d5c2c..26f95d96 100644 --- a/tldr/hexo +++ b/tldr/hexo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hexo > A fast, simple & powerful blog framework. -> More information: . +> More information: . - Initialize a website: diff --git a/tldr/history b/tldr/history index 9ba81c71..63d68e17 100644 --- a/tldr/history +++ b/tldr/history @@ -5,8 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # history -> Command-line history. -> More information: . +> Manage command-line history. +> More information: . - Display the commands history list with line numbers: @@ -31,3 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - [d]elete the history entry at the specified offset: `history -d {{offset}}` + +- Add a command to history without running it: + +`history -s {{command}}` diff --git a/tldr/htop b/tldr/htop index 249cc601..1a391491 100644 --- a/tldr/htop +++ b/tldr/htop @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # htop > Display dynamic real-time information about running processes. An enhanced version of `top`. -> More information: . +> More information: . - Start `htop`: diff --git a/tldr/hugo b/tldr/hugo index 14269c64..19833550 100644 --- a/tldr/hugo +++ b/tldr/hugo @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Template-based static site generator. Uses modules, components, and themes. > Some subcommands such as `server` have their own usage documentation. -> More information: . +> More information: . - Create a new Hugo site: diff --git a/tldr/ifs b/tldr/ifs index 5feb64ae..afe9229d 100644 --- a/tldr/ifs +++ b/tldr/ifs @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > IFS (Internal Field Separator) is a special environment variable that defines the delimiter used for word splitting in Unix shells. > The default value of IFS is a space, tab, and newline. The three characters serve as delimiters. -> More information: . +> More information: . - View the current IFS value: diff --git a/tldr/javadoc b/tldr/javadoc index acb30573..044b54cd 100644 --- a/tldr/javadoc +++ b/tldr/javadoc @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate documentation for Java source code and save the result in a directory: -`javadoc -d {{path/to/directory/}} {{path/to/java_source_code}}` +`javadoc -d {{path/to/directory}}/ {{path/to/java_source_code}}` - Generate documentation with a specific encoding: diff --git a/tldr/jq b/tldr/jq index 373fd370..90c157a1 100644 --- a/tldr/jq +++ b/tldr/jq @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a specific expression only using the `jq` binary (print a colored and formatted JSON output): -`jq '.' {{/path/to/file.json}}` +`jq '.' /{{path/to/file.json}}` - Execute a specific script: diff --git a/tldr/keepassxc-cli b/tldr/keepassxc-cli index 0fc3eca1..0b61561a 100644 --- a/tldr/keepassxc-cli +++ b/tldr/keepassxc-cli @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List the contents of a folder: -`keepassxc-cli ls {{path/to/database_file}} {{/path/to/directory}}` +`keepassxc-cli ls {{path/to/database_file}} /{{path/to/directory}}` - Add an entry with an auto-generated password: diff --git a/tldr/kismet b/tldr/kismet index 2d5d3eb2..4b48eeda 100644 --- a/tldr/kismet +++ b/tldr/kismet @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kismet > A wireless network and device detector, sniffer, wardriving tool, and WIDS (wireless intrusion detection) framework. -> More information: . +> More information: . - Capture packets from a specific wireless interface: diff --git a/tldr/kubectl-apply b/tldr/kubectl-apply index f924ccc4..d979306b 100644 --- a/tldr/kubectl-apply +++ b/tldr/kubectl-apply @@ -9,18 +9,26 @@ source: https://github.com/tldr-pages/tldr.git > Create and update resources in a cluster. > More information: . -- Apply a configuration to a resource by file name or `stdin`: +- Apply a configuration to a resource by file name: -`kubectl apply {{[-f|--filename]}} {{resource_filename}}` +`kubectl apply {{[-f|--filename]}} {{path/to/filename}}` + +- Apply a configuration to a resource from `kustomization.yaml` in a directory: + +`kubectl apply {{[-k|--kustomize]}} {{path/to/directory}}` + +- Apply a configuration to a resource by `stdin`: + +`{{cat pod.json}} | kubectl apply {{[-f|--filename]}} -` - Edit the latest last-applied-configuration annotations of resources from the default editor: -`kubectl apply edit-last-applied {{[-f|--filename]}} {{resource_filename}}` +`kubectl apply edit-last-applied {{[-f|--filename]}} {{path/to/filename}}` - Set the latest last-applied-configuration annotations by setting it to match the contents of a file: -`kubectl apply set-last-applied {{[-f|--filename]}} {{resource_filename}}` +`kubectl apply set-last-applied {{[-f|--filename]}} {{path/to/filename}}` - View the latest last-applied-configuration annotations by type/name or file: -`kubectl apply view-last-applied {{[-f|--filename]}} {{resource_filename}}` +`kubectl apply view-last-applied {{[-f|--filename]}} {{path/to/filename}}` diff --git a/tldr/kubectl-config b/tldr/kubectl-config index 46bac384..7e6e1e15 100644 --- a/tldr/kubectl-config +++ b/tldr/kubectl-config @@ -22,6 +22,10 @@ source: https://github.com/tldr-pages/tldr.git `kubectl config current-context` +- Set the default namespace of the current context: + +`kubectl config set-context --current --namespace {{namespace}}` + - Switch to another context: `kubectl config {{use|use-context}} {{context_name}}` diff --git a/tldr/kubectl-edit b/tldr/kubectl-edit index 5a56fec0..b744d3d4 100644 --- a/tldr/kubectl-edit +++ b/tldr/kubectl-edit @@ -8,17 +8,21 @@ source: https://github.com/tldr-pages/tldr.git > Edit Kubernetes resources. > More information: . -- Edit a pod: +- Edit a pod in the default namespace: -`kubectl edit pod/{{pod_name}}` +`kubectl edit {{[po|pod]}}/{{pod_name}}` -- Edit a deployment: +- Edit a deployment in the default namespace: -`kubectl edit deployment/{{deployment_name}}` +`kubectl edit {{[deploy|deployment]}}/{{deployment_name}}` -- Edit a service: +- Edit a service in the default namespace: -`kubectl edit svc/{{service_name}}` +`kubectl edit {{[svc|service]}}/{{service_name}}` + +- Edit all entries of a given resource in a given namespace: + +`kubectl edit {{resource}} {{[-n|--namespace]}} {{namespace}}` - Edit a resource using a specific editor: diff --git a/tldr/kubectl-exec b/tldr/kubectl-exec new file mode 100644 index 00000000..450c4c1d --- /dev/null +++ b/tldr/kubectl-exec @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl exec + +> Execute a command in a container. +> More information: . + +- Open Bash in a pod, using the first container by default: + +`kubectl exec {{pod_name}} {{-it|--stdin --tty]}} -- bash` diff --git a/tldr/kubectl-label b/tldr/kubectl-label index 77c290a4..ac736dd9 100644 --- a/tldr/kubectl-label +++ b/tldr/kubectl-label @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Label a pod: -`kubectl label pod {{pod_name}} {{key}}={{value}}` +`kubectl label {{[po|pod]}} {{pod_name}} {{key}}={{value}}` - Update a pod label by overwriting the existing value: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Label all pods in the namespace: -`kubectl label pods --all {{key}}={{value}}` +`kubectl label {{[po|pods]}} --all {{key}}={{value}}` - Label a pod identified by the pod definition file: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Remove the label from a pod: -`kubectl label pod {{pod_name}} {{key}}-` +`kubectl label {{[po|pod]}} {{pod_name}} {{key}}-` diff --git a/tldr/libreoffice b/tldr/libreoffice index 32a49472..795f2385 100644 --- a/tldr/libreoffice +++ b/tldr/libreoffice @@ -5,21 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # libreoffice -> CLI for the powerful and free office suite LibreOffice. -> More information: . +> This command is an alias of `soffice`. -- Open one or more files in read-only mode: +- View documentation for the original command: -`libreoffice --view {{path/to/file1 path/to/file2 ...}}` - -- Display the content of one or more files: - -`libreoffice --cat {{path/to/file1 path/to/file2 ...}}` - -- Print files using a specific printer: - -`libreoffice --pt {{printer_name}} {{path/to/file1 path/to/file2 ...}}` - -- Convert all `.doc` files in current directory to PDF: - -`libreoffice --convert-to pdf *.doc` +`tldr soffice` diff --git a/tldr/linkchecker b/tldr/linkchecker index c0060e98..efd823c5 100644 --- a/tldr/linkchecker +++ b/tldr/linkchecker @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # linkchecker > Client to check HTML documents and websites for broken links. -> More information: . +> More information: . - Find broken links on : diff --git a/tldr/linux/aa-audit b/tldr/linux/aa-audit index c2187c47..a2a47663 100644 --- a/tldr/linux/aa-audit +++ b/tldr/linux/aa-audit @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a profile to audit mode from a specific directory: -`sudo aa-audit {{[-d|--dir]}} {{/path/to/profiles}} {{profile_name}}` +`sudo aa-audit {{[-d|--dir]}} /{{path/to/profiles}} {{profile_name}}` - Force audit mode even if already applied: diff --git a/tldr/linux/aa-cleanprof b/tldr/linux/aa-cleanprof index c285b7a7..2d601588 100644 --- a/tldr/linux/aa-cleanprof +++ b/tldr/linux/aa-cleanprof @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Specify the directory containing profiles: -`sudo aa-cleanprof {{[-d|--dir]}} {{/path/to/profiles}} {{profile_name}}` +`sudo aa-cleanprof {{[-d|--dir]}} /{{path/to/profiles}} {{profile_name}}` - Run silently without prompts: diff --git a/tldr/linux/aa-genprof b/tldr/linux/aa-genprof index 3772eef4..73e4c4b9 100644 --- a/tldr/linux/aa-genprof +++ b/tldr/linux/aa-genprof @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Specify a custom directory for profiles: -`sudo aa-genprof {{[-d|--dir]}} {{/path/to/profiles}} {{program_path}}` +`sudo aa-genprof {{[-d|--dir]}} /{{path/to/profiles}} {{program_path}}` - Specify a custom logfile for profiling: -`sudo aa-genprof {{[-f|--file]}} {{/path/to/logfile}} {{program_path}}` +`sudo aa-genprof {{[-f|--file]}} /{{path/to/logfile}} {{program_path}}` - Display help: diff --git a/tldr/linux/aa-logprof b/tldr/linux/aa-logprof index 3aa5705d..f0a1ffd1 100644 --- a/tldr/linux/aa-logprof +++ b/tldr/linux/aa-logprof @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Use a specific directory for AppArmor profiles: -`sudo aa-logprof {{[-d|--dir]}} {{/path/to/profiles}}` +`sudo aa-logprof {{[-d|--dir]}} /{{path/to/profiles}}` - Use a specific log file instead of the default: -`sudo aa-logprof {{[-f|--file]}} {{/path/to/logfile}}` +`sudo aa-logprof {{[-f|--file]}} /{{path/to/logfile}}` - Ignore all log entries before the specified mark: diff --git a/tldr/linux/aa-mergeprof b/tldr/linux/aa-mergeprof index 8de58375..dcc5755e 100644 --- a/tldr/linux/aa-mergeprof +++ b/tldr/linux/aa-mergeprof @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Merge profile files into a specific directory: -`sudo aa-mergeprof {{[-d|--dir]}} {{/path/to/profiles}} {{file1 file2 ...}}` +`sudo aa-mergeprof {{[-d|--dir]}} /{{path/to/profiles}} {{file1 file2 ...}}` - Display help: diff --git a/tldr/linux/abrt-cli b/tldr/linux/abrt-cli index 10fbdcd3..5c1c5d52 100644 --- a/tldr/linux/abrt-cli +++ b/tldr/linux/abrt-cli @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Automatic Bug Reporting Tool for Fedora-based systems. > Used to detect, analyze, and report application crashes. -> More information: . +> More information: . - List detected problems: diff --git a/tldr/linux/agetty b/tldr/linux/agetty index 3a3834dd..d52d4669 100644 --- a/tldr/linux/agetty +++ b/tldr/linux/agetty @@ -32,4 +32,4 @@ source: https://github.com/tldr-pages/tldr.git - Change the root directory and write a specific fake host into the `utmp` file: -`agetty {{[-r|--chroot]}} {{/path/to/root_directory}} {{[-H|--host]}} {{fake_host}} -` +`agetty {{[-r|--chroot]}} /{{path/to/root_directory}} {{[-H|--host]}} {{fake_host}} -` diff --git a/tldr/linux/apparmor_parser b/tldr/linux/apparmor_parser index 3a28d94c..81874aef 100644 --- a/tldr/linux/apparmor_parser +++ b/tldr/linux/apparmor_parser @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Replace a profile, rebuild cache, and write it to a custom directory: -`sudo apparmor_parser {{[-r|--replace]}} {{[-W|--write-cache]}} {{[-L|--cache-loc]}} {{/path/to/cache}} {{path/to/profile}}` +`sudo apparmor_parser {{[-r|--replace]}} {{[-W|--write-cache]}} {{[-L|--cache-loc]}} /{{path/to/cache}} {{path/to/profile}}` diff --git a/tldr/linux/apt-file b/tldr/linux/apt-file index dd8d0caa..b3c4984c 100644 --- a/tldr/linux/apt-file +++ b/tldr/linux/apt-file @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Search for packages that contain the specified file or path: -`apt-file {{search|find}} {{partial_path/to/file}}` +`apt-file {{search|find}} {{path/to/file}}` - List the contents of a specific package: diff --git a/tldr/linux/auditctl b/tldr/linux/auditctl index dd6aae43..7d3d34d2 100644 --- a/tldr/linux/auditctl +++ b/tldr/linux/auditctl @@ -26,11 +26,11 @@ source: https://github.com/tldr-pages/tldr.git - Watch a file for changes: -`sudo auditctl -a always,exit -F arch=b64 -F path={{/path/to/file}} -F perm=wa` +`sudo auditctl -a always,exit -F arch=b64 -F path=/{{path/to/file}} -F perm=wa` - Recursively watch a directory for changes: -`sudo auditctl -a always,exit -F arch=b64 -F dir={{/path/to/directory/}} -F perm=wa` +`sudo auditctl -a always,exit -F arch=b64 -F dir=/{{path/to/directory}}/ -F perm=wa` - Display [h]elp: diff --git a/tldr/linux/aur b/tldr/linux/aur index 249da306..15c54d43 100644 --- a/tldr/linux/aur +++ b/tldr/linux/aur @@ -29,6 +29,14 @@ source: https://github.com/tldr-pages/tldr.git `aur sync {{[-u|--upgrades]}}` +- Clean build files after install: + +`aur sync {{[-C|--clean]}} {{package}}` + - Install a package without viewing changes in Vim and do not confirm dependency installation: `aur sync --noview {{[-n|--noconfirm]}} {{package}}` + +- Remove a package form the repository metadata (does not remove the package file itself): + +`repo-remove {{path/to/database.db.tar.gz}} {{package}}` diff --git a/tldr/linux/avahi-browse b/tldr/linux/avahi-browse index 9a8486e5..403dc267 100644 --- a/tldr/linux/avahi-browse +++ b/tldr/linux/avahi-browse @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Display services and hosts exposed on the local network via mDNS/DNS-SD. > Avahi is compatible with Bonjour (Zeroconf) found in Apple devices. -> More information: . +> More information: . - List services available on the local network along with their addresses and ports, ignoring ones on the local machine: diff --git a/tldr/linux/avahi-resolve b/tldr/linux/avahi-resolve index d3a4740e..bcf2e291 100644 --- a/tldr/linux/avahi-resolve +++ b/tldr/linux/avahi-resolve @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # avahi-resolve > Translate between host names and IP Addresses. -> More information: . +> More information: . - Resolve a local service to its IPv4: diff --git a/tldr/linux/bootctl b/tldr/linux/bootctl index 1d4b4d36..833f076c 100644 --- a/tldr/linux/bootctl +++ b/tldr/linux/bootctl @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Specify the path to the EFI system partition (defaults to `/efi/`, `/boot/` or `/boot/efi`): -`bootctl --esp-path {{/path/to/efi_system_partition/}}` +`bootctl --esp-path /{{path/to/efi_system_partition}}/` - Install `systemd-boot` into the EFI system partition: diff --git a/tldr/linux/cage b/tldr/linux/cage index 915ccc3f..4f90cff0 100644 --- a/tldr/linux/cage +++ b/tldr/linux/cage @@ -16,6 +16,14 @@ source: https://github.com/tldr-pages/tldr.git `cage -- {{application}} {{arguments}}` +- Hide window [d]ecorations (this can lock you from accessing the terminal): + +`cage -d {{application}}` + +- Allow [s]witching terminals with ``: + +`cage -s {{application}}` + - Display help: `cage -h` diff --git a/tldr/linux/chvt b/tldr/linux/chvt new file mode 100644 index 00000000..0d54c60b --- /dev/null +++ b/tldr/linux/chvt @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chvt + +> Change foreground virtual terminal. +> More information: . + +- Change to a specific TTY: + +`sudo chvt {{3}}` diff --git a/tldr/linux/datamash b/tldr/linux/datamash index 80844ce9..7a01a5c6 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: diff --git a/tldr/linux/dconf b/tldr/linux/dconf index 4c3d2e37..eb289bca 100644 --- a/tldr/linux/dconf +++ b/tldr/linux/dconf @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Print a specific key value: -`dconf read {{/path/to/key}}` +`dconf read /{{path/to/key}}` - Print a specific path sub-directories and sub-keys: -`dconf list {{/path/to/directory/}}` +`dconf list /{{path/to/directory}}/` - Write a specific key value: -`dconf write {{/path/to/key}} "{{value}}"` +`dconf write /{{path/to/key}} "{{value}}"` - Reset a specific key value: -`dconf reset {{/path/to/key}}` +`dconf reset /{{path/to/key}}` - Watch a specific key/directory for changes: -`dconf watch {{/path/to/key|/path/to/directory/}}` +`dconf watch /{{path/to/key|/path/to/directory}}/` - Dump a specific directory in INI file format: -`dconf dump {{/path/to/directory/}}` +`dconf dump /{{path/to/directory}}/` diff --git a/tldr/linux/dconf-read b/tldr/linux/dconf-read index 91432ba8..a72112fe 100644 --- a/tldr/linux/dconf-read +++ b/tldr/linux/dconf-read @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Print a specific key value: -`dconf read {{/path/to/key}}` +`dconf read /{{path/to/key}}` - Print a specific key [d]efault value: -`dconf read -d {{/path/to/key}}` +`dconf read -d /{{path/to/key}}` diff --git a/tldr/linux/dconf-reset b/tldr/linux/dconf-reset index acc69e9a..15203593 100644 --- a/tldr/linux/dconf-reset +++ b/tldr/linux/dconf-reset @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Reset a specific key value: -`dconf reset {{/path/to/key}}` +`dconf reset /{{path/to/key}}` - Reset a specific directory: -`dconf reset -f {{/path/to/directory/}}` +`dconf reset -f /{{path/to/directory}}/` diff --git a/tldr/linux/dconf-write b/tldr/linux/dconf-write index af63dd91..6abd4ce6 100644 --- a/tldr/linux/dconf-write +++ b/tldr/linux/dconf-write @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Write a specific key value: -`dconf write {{/path/to/key}} "{{value}}"` +`dconf write /{{path/to/key}} "{{value}}"` - Write a specific string key value: -`dconf write {{/path/to/key}} "'{{string}}'"` +`dconf write /{{path/to/key}} "'{{string}}'"` - Write a specific integer key value: -`dconf write {{/path/to/key}} "{{5}}"` +`dconf write /{{path/to/key}} "{{5}}"` - Write a specific boolean key value: -`dconf write {{/path/to/key}} "{{true|false}}"` +`dconf write /{{path/to/key}} "{{true|false}}"` - Write a specific array key value: -`dconf write {{/path/to/key}} "[{{'first', 'second', ...}}]"` +`dconf write /{{path/to/key}} "[{{'first', 'second', ...}}]"` - Write a specific empty array key value: -`dconf write {{/path/to/key}} "@as []"` +`dconf write /{{path/to/key}} "@as []"` diff --git a/tldr/linux/debootstrap b/tldr/linux/debootstrap index a947c268..4777fff6 100644 --- a/tldr/linux/debootstrap +++ b/tldr/linux/debootstrap @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Create a Debian stable release system inside the `debian-root` directory: -`sudo debootstrap stable {{path/to/debian-root/}} http://deb.debian.org/debian` +`sudo debootstrap stable {{path/to/debian-root}}/ http://deb.debian.org/debian` - Create a minimal system including only required packages: -`sudo debootstrap --variant=minbase stable {{path/to/debian-root/}}` +`sudo debootstrap --variant=minbase stable {{path/to/debian-root}}/` - Create an Ubuntu 20.04 system inside the `focal-root` directory with a local mirror: -`sudo debootstrap focal {{path/to/focal-root/}} {{file:///path/to/mirror/}}` +`sudo debootstrap focal {{path/to/focal-root}}/ {{file:///path/to/mirror/}}` - Switch to a bootstrapped system: diff --git a/tldr/linux/diff3 b/tldr/linux/diff3 index ad6bd278..137bc25f 100644 --- a/tldr/linux/diff3 +++ b/tldr/linux/diff3 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # diff3 > Compare three files line by line. -> More information: . +> More information: . - Compare files: diff --git a/tldr/linux/dnsdomainname b/tldr/linux/dnsdomainname index 8b1dc198..095a3f04 100644 --- a/tldr/linux/dnsdomainname +++ b/tldr/linux/dnsdomainname @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Show the system's DNS domain name. > Note: The tool uses `gethostname` to get the hostname of the system and then `getaddrinfo` to resolve it into a canonical name. -> More information: . +> More information: . - Show the system's DNS domain name: diff --git a/tldr/linux/etckeeper b/tldr/linux/etckeeper index 4c5145bb..1c969a22 100644 --- a/tldr/linux/etckeeper +++ b/tldr/linux/etckeeper @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # etckeeper > Track system configuration files in Git. -> More information: . +> More information: . - Set up a Git repo and perform various setup tasks (run from `/etc`): diff --git a/tldr/linux/fbset b/tldr/linux/fbset new file mode 100644 index 00000000..f4086833 --- /dev/null +++ b/tldr/linux/fbset @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fbset + +> Show and modify frame buffer device settings. +> More information: . + +- Show current framebuffer settings: + +`sudo fbset {{[-i|--info]}}` + +- Set a framebuffer mode defined in `/etc/fb.modes`: + +`sudo fbset "{{800}}x{{600}}-{{60}}"` + +- Set an arbitrary framebuffer mode: + +`sudo fbset {{TTY_horizontal}} {{TTY_vertical}} {{monitor_horizontal}} {{monitor_vertical}} {{color_depth}}` diff --git a/tldr/linux/fpsync b/tldr/linux/fpsync index 8a1f2ad1..fb29c24c 100644 --- a/tldr/linux/fpsync +++ b/tldr/linux/fpsync @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Recursively synchronize a directory to another location: -`fpsync -v {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v /{{path/to/source}}/ /{{path/to/destination}}/` - Recursively synchronize a directory with the final pass (It enables rsync's `--delete` option with each synchronization job): -`fpsync -v -E {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v -E /{{path/to/source}}/ /{{path/to/destination}}/` - Recursively synchronize a directory to a destination using 8 concurrent synchronization jobs: -`fpsync -v -n 8 -E {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v -n 8 -E /{{path/to/source}}/ /{{path/to/destination}}/` - Recursively synchronize a directory to a destination using 8 concurrent synchronization jobs spread over two remote workers (machine1 and machine2): -`fpsync -v -n 8 -E -w login@machine1 -w login@machine2 -d {{/path/to/shared/directory}} {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v -n 8 -E -w login@machine1 -w login@machine2 -d /{{path/to/shared/directory}} /{{path/to/source}}/ /{{path/to/destination}}/` - Recursively synchronize a directory to a destination using 4 local workers, each one transferring at most 1000 files and 100 MB per synchronization job: -`fpsync -v -n 4 -f 1000 -s $((100 * 1024 * 1024)) {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v -n 4 -f 1000 -s $((100 * 1024 * 1024)) /{{path/to/source}}/ /{{path/to/destination}}/` - Recursively synchronize any directories but exclude specific `.snapshot*` files (Note: Options and values must be separated by a pipe character): -`fpsync -v -O "-x|.snapshot*" {{/path/to/source/}} {{/path/to/destination/}}` +`fpsync -v -O "-x|.snapshot*" /{{path/to/source}}/ /{{path/to/destination}}/` diff --git a/tldr/linux/growpart b/tldr/linux/growpart index 25cd6476..887e34db 100644 --- a/tldr/linux/growpart +++ b/tldr/linux/growpart @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Show what modifications would be made when growing partition `n` in a disk image: -`growpart {{[-N|--dry-run]}} {{/path/to/disk.img}} {{n}}` +`growpart {{[-N|--dry-run]}} /{{path/to/disk.img}} {{n}}` diff --git a/tldr/linux/grub-install b/tldr/linux/grub-install index 74bd2ae8..efdd4983 100644 --- a/tldr/linux/grub-install +++ b/tldr/linux/grub-install @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # grub-install > Install GRUB to a device. -> More information: . +> More information: . - Install GRUB on a BIOS system: diff --git a/tldr/linux/grub-mkconfig b/tldr/linux/grub-mkconfig index b82fc11c..9a526259 100644 --- a/tldr/linux/grub-mkconfig +++ b/tldr/linux/grub-mkconfig @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # grub-mkconfig > Generate a GRUB configuration file. -> More information: . +> More information: . - Do a dry run and print the configuration to `stdout`: diff --git a/tldr/linux/grub-reboot b/tldr/linux/grub-reboot index b34bc00f..0a2e6fca 100644 --- a/tldr/linux/grub-reboot +++ b/tldr/linux/grub-reboot @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Set the default boot entry to an entry number, name or identifier for an alternative boot directory for the next boot: -`sudo grub-reboot --boot-directory {{/path/to/boot_directory}} {{entry_number}}` +`sudo grub-reboot --boot-directory /{{path/to/boot_directory}} {{entry_number}}` diff --git a/tldr/linux/grub-script-check b/tldr/linux/grub-script-check index 82204d3f..402c1fae 100644 --- a/tldr/linux/grub-script-check +++ b/tldr/linux/grub-script-check @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The program `grub-script-check` takes a GRUB script file and checks it for syntax errors. > It may take a path as a non-option argument. If none is supplied, it will read from `stdin`. -> More information: . +> More information: . - Check a specific script file for syntax errors: diff --git a/tldr/linux/grub-set-default b/tldr/linux/grub-set-default index ab8b83bb..2edef59b 100644 --- a/tldr/linux/grub-set-default +++ b/tldr/linux/grub-set-default @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Set the default boot entry to an entry number, name or identifier for an alternative boot directory: -`sudo grub-set-default --boot-directory {{/path/to/boot_directory}} {{entry_number}}` +`sudo grub-set-default --boot-directory /{{path/to/boot_directory}} {{entry_number}}` diff --git a/tldr/linux/guix-package b/tldr/linux/guix-package index 476a3e71..57f76af5 100644 --- a/tldr/linux/guix-package +++ b/tldr/linux/guix-package @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # guix package > Install, upgrade and remove Guix packages, or rollback to previous configurations. -> More information: . +> More information: . - Install a new package: diff --git a/tldr/linux/imv b/tldr/linux/imv index a6520b80..d846b5da 100644 --- a/tldr/linux/imv +++ b/tldr/linux/imv @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - View images [r]ecursively from a path: -`imv -r --slideshow {{path/to/path}}` +`imv -r --slideshow {{path/to/directory}}` - Open multiple images via `stdin`: diff --git a/tldr/linux/kde-builder b/tldr/linux/kde-builder index aa25f975..ecaf82d2 100644 --- a/tldr/linux/kde-builder +++ b/tldr/linux/kde-builder @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Easily build KDE components from its source repositories. > Drop-in replacement for `kdesrc-build`. -> More information: . +> More information: . - Initialize `kde-builder`: @@ -33,9 +33,9 @@ source: https://github.com/tldr-pages/tldr.git `kde-builder --run {{executable_name}}` -- Build all configured components: +- Install login session: -`kde-builder` +`kde-builder --install-login-session-only` - Use system libraries in place of a component if it fails to build: diff --git a/tldr/linux/kdocker b/tldr/linux/kdocker index 8476a88a..d43c687d 100644 --- a/tldr/linux/kdocker +++ b/tldr/linux/kdocker @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Display a cursor to send a window to the system tray with a custom icon when pressing the left mouse button: -`kdocker -i {{/path/to/icon}}` +`kdocker -i /{{path/to/icon}}` - Open an application, send it to the system tray and if focus is lost, minimize it: diff --git a/tldr/linux/links b/tldr/linux/links index d837f140..aa5970e5 100644 --- a/tldr/linux/links +++ b/tldr/linux/links @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # links > Command-line web browser. -> More information: . +> More information: . - Visit a website: diff --git a/tldr/linux/links2 b/tldr/linux/links2 index 5e124d09..40583dde 100644 --- a/tldr/linux/links2 +++ b/tldr/linux/links2 @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Command-line web browser. > See also: `links`. -> More information: . +> More information: . - Visit a website in graphics mode: diff --git a/tldr/linux/loadkeys b/tldr/linux/loadkeys index 60d5c35d..9ee5eaad 100644 --- a/tldr/linux/loadkeys +++ b/tldr/linux/loadkeys @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Load a keymap from the specified file for the console: -`loadkeys {{[-C|--console]}} {{/dev/ttyN}} {{/path/to/file}}` +`loadkeys {{[-C|--console]}} {{/dev/ttyN}} /{{path/to/file}}` diff --git a/tldr/linux/lxc-checkconfig b/tldr/linux/lxc-checkconfig index d69e27af..ee19f071 100644 --- a/tldr/linux/lxc-checkconfig +++ b/tldr/linux/lxc-checkconfig @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Check any kernel for LXC support: -`CONFIG={{/path/to/configuration}} lxc-checkconfig` +`CONFIG=/{{path/to/configuration}} lxc-checkconfig` diff --git a/tldr/linux/lxc-create b/tldr/linux/lxc-create index 030e8750..53e76c04 100644 --- a/tldr/linux/lxc-create +++ b/tldr/linux/lxc-create @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a container in a target directory: -`sudo lxc-create {{[-P|--lxcpath]}} {{/path/to/directory/}} {{[-n|--name]}} {{container_name}} {{[-t|--template]}} download` +`sudo lxc-create {{[-P|--lxcpath]}} /{{path/to/directory}}/ {{[-n|--name]}} {{container_name}} {{[-t|--template]}} download` - Create a container passing options to a template: diff --git a/tldr/linux/matchpathcon b/tldr/linux/matchpathcon index 4f624aed..a42d6ea5 100644 --- a/tldr/linux/matchpathcon +++ b/tldr/linux/matchpathcon @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Lookup the persistent security context setting of an absolute path: -`matchpathcon {{/path/to/file}}` +`matchpathcon /{{path/to/file}}` - Restrict lookup to settings on a specific file type: -`matchpathcon -m {{file|dir|pipe|chr_file|blk_file|lnk_file|sock_file}} {{/path/to/file}}` +`matchpathcon -m {{file|dir|pipe|chr_file|blk_file|lnk_file|sock_file}} /{{path/to/file}}` - [V]erify that the persistent and current security context of a path agree: -`matchpathcon -V {{/path/to/file}}` +`matchpathcon -V /{{path/to/file}}` diff --git a/tldr/linux/mktemp b/tldr/linux/mktemp index bde39c2e..e49b39bc 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 {{[-p |--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/mmdebstrap b/tldr/linux/mmdebstrap index 2fd41fed..3a8e850e 100644 --- a/tldr/linux/mmdebstrap +++ b/tldr/linux/mmdebstrap @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a Debian Stable directory chroot: -`sudo mmdebstrap stable {{path/to/debian-root/}}` +`sudo mmdebstrap stable {{path/to/debian-root}}/` - Create a Debian Bookworm tarball chroot using a mirror: diff --git a/tldr/linux/modetest b/tldr/linux/modetest new file mode 100644 index 00000000..6529fa29 --- /dev/null +++ b/tldr/linux/modetest @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# modetest + +> Diagnose Direct Rendering Manager and Kernel Mode Setting. +> More information: . + +- List connectors and their available modes for a specific driver: + +`modetest -M {{mgag200}} -c` + +- Set the resolution of a connector: + +`sudo modetest -M {{mgag200}} -s {{connector_id}}:{{1600}}x{{1200}}` diff --git a/tldr/linux/modprobe b/tldr/linux/modprobe index e78c2fe1..4edeeb6b 100644 --- a/tldr/linux/modprobe +++ b/tldr/linux/modprobe @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Pretend to load a module into the kernel, but don't actually do it: -`sudo modprobe --dry-run {{module_name}}` +`sudo modprobe {{[-n|--dry-run]}} {{module_name}}` - Load a module into the kernel: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove a module from the kernel: -`sudo modprobe --remove {{module_name}}` +`sudo modprobe {{[-r|--remove]}} {{module_name}}` - Remove a module and those that depend on it from the kernel: @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Show a kernel module's dependencies: -`sudo modprobe --show-depends {{module_name}}` +`sudo modprobe {{[-D|--show-depends]}} {{module_name}}` diff --git a/tldr/linux/nerdctl b/tldr/linux/nerdctl new file mode 100644 index 00000000..e09ebfa1 --- /dev/null +++ b/tldr/linux/nerdctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nerdctl + +> Docker-compatible CLI for containerd. +> More information: . + +- List all containers (running and stopped): + +`nerdctl ps {{[-a|--all]}}` + +- Start a container from an image, with a custom name: + +`nerdctl run --name {{container_name}} {{image}}` + +- Start or stop an existing container: + +`nerdctl {{start|stop}} {{container_name}}` + +- Pull an image from a container registry: + +`nerdctl pull {{image}}` + +- Display the list of already downloaded images: + +`nerdctl images` + +- Open an interactive tty with Bourne shell (`sh`) inside a running container: + +`nerdctl exec {{[-it|--interactive --tty]}} {{container_name}} sh` + +- Remove stopped containers: + +`nerdctl rm {{container1 container2 ...}}` + +- Fetch and follow the logs of a container: + +`nerdctl logs {{[-f|--follow]}} {{container_name}}` diff --git a/tldr/linux/opkg b/tldr/linux/opkg index a057235b..d137579a 100644 --- a/tldr/linux/opkg +++ b/tldr/linux/opkg @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Find out which package owns a file: -`opkg search {{/path/to/file}}` +`opkg search /{{path/to/file}}` - List all files belonging to a package: diff --git a/tldr/linux/parted b/tldr/linux/parted index 656232a0..6e2838a9 100644 --- a/tldr/linux/parted +++ b/tldr/linux/parted @@ -7,7 +7,7 @@ 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: diff --git a/tldr/linux/pct-config b/tldr/linux/pct-config new file mode 100644 index 00000000..a9b8400e --- /dev/null +++ b/tldr/linux/pct-config @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pct config + +> Print the configuration of a container. +> More information: . + +- Display the saved configuration: + +`pct config {{100}}` + +- Display the running configuration without pending changes: + +`pct config {{100}} --current` + +- Display configuration of a specific snapshot: + +`pct config {{100}} --snapshot {{snapshot_name}}` diff --git a/tldr/linux/pct-destroy b/tldr/linux/pct-destroy new file mode 100644 index 00000000..b2ae8028 --- /dev/null +++ b/tldr/linux/pct-destroy @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pct destroy + +> Destroy a container. +> More information: . + +- Destroy a container: + +`pct {{[des|destroy]}} {{100}}` + +- Destroy a container even if it's running: + +`pct {{[des|destroy]}} {{100}} --force` + +- Also delete all references to this container: + +`pct {{[des|destroy]}} {{100}} --purge` diff --git a/tldr/linux/pct-set b/tldr/linux/pct-set index b6fdab3f..19d6a047 100644 --- a/tldr/linux/pct-set +++ b/tldr/linux/pct-set @@ -16,6 +16,18 @@ source: https://github.com/tldr-pages/tldr.git `pct set {{100}} --net0 name=eth0,bridge=vmbr0,ip={{10.0.0.100/24}},gw={{10.0.0.1}}` -- Set container memory limit: +- Set container memory and CPU limit: -`pct set {{100}} --memory {{8192}}` +`pct set {{100}} --memory {{8192}} --cpulimit {{4}}` + +- Mount a host file location in a guest: + +`pct set {{100}} --mp{{0}} /{{path/to/host_directory}},mp=/{{path/to/guest_mount_point}}` + +- Set container tags: + +`pct set {{100}} --tags {{tag1,tag2,...}}` + +- Remove an option: + +`pct set {{100}} --delete {{net0,mp0,mp1,...}}` diff --git a/tldr/linux/pivpn b/tldr/linux/pivpn index f0eb03b6..018353f2 100644 --- a/tldr/linux/pivpn +++ b/tldr/linux/pivpn @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Easy security-hardened OpenVPN setup and manager. > Originally designed for the Raspberry Pi, but works on other Linux devices too. -> More information: . +> More information: . - Add a new client device: diff --git a/tldr/linux/plasma-apply-wallpaperimage b/tldr/linux/plasma-apply-wallpaperimage index 201102be..eb999160 100644 --- a/tldr/linux/plasma-apply-wallpaperimage +++ b/tldr/linux/plasma-apply-wallpaperimage @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Apply a wallpaper: -`plasma-apply-wallpaperimage {{/path/to/image}}` +`plasma-apply-wallpaperimage /{{path/to/image}}` - Apply a wallpaper with a fill mode: -`plasma-apply-wallpaperimage --fill-mode {{stretch|preserveAspectFit|preserveAspectCrop|tile|tileVertically|tileHorizontally|pad}} {{/path/to/image}}` +`plasma-apply-wallpaperimage --fill-mode {{stretch|preserveAspectFit|preserveAspectCrop|tile|tileVertically|tileHorizontally|pad}} /{{path/to/image}}` - Display help: diff --git a/tldr/linux/pveam b/tldr/linux/pveam index 85ac0fd4..63cc591c 100644 --- a/tldr/linux/pveam +++ b/tldr/linux/pveam @@ -23,3 +23,11 @@ source: https://github.com/tldr-pages/tldr.git - List downloaded templates: `pveam {{[l|list]}} {{local}}` + +- List available templates in a specific section: + +`pveam {{[a|available]}} --section {{system|turnkeylinux|mail}}` + +- Remove a template: + +`pveam {{[r|remove]}} {{local}}:{{vztmpl}}/{{template_name}}` diff --git a/tldr/linux/pvesm b/tldr/linux/pvesm index f9c7a551..b7db4eb9 100644 --- a/tldr/linux/pvesm +++ b/tldr/linux/pvesm @@ -20,6 +20,14 @@ source: https://github.com/tldr-pages/tldr.git `pvesm add {{[d|dir]}} {{storage_name}} --path {{path/to/directory}}` +- Set a storage to contain specific content: + +`pvesm set {{storage_name}} --content {{iso,images,backup,vztmpl,...}}` + +- Delete a file from storage: + +`pvesm free {{local:iso/archlinux-2025.08.01-x86_64.iso}}` + - Remove a storage: `pvesm {{[r|remove]}} {{storage_name}}` diff --git a/tldr/linux/qjoypad b/tldr/linux/qjoypad index cf7fa6ff..5284aa44 100644 --- a/tldr/linux/qjoypad +++ b/tldr/linux/qjoypad @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qjoypad > Translate input from gamepads or joysticks into keyboard strokes or mouse actions. -> More information: . +> More information: . - Start QJoyPad: diff --git a/tldr/linux/qm b/tldr/linux/qm index 4053cf0e..e166870c 100644 --- a/tldr/linux/qm +++ b/tldr/linux/qm @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `qm list` -- Using an ISO file uploaded on the local storage, create a virtual machine with a 4 GB IDE disk on the `local-lvm` storage and an ID of 100: +- Using an ISO file uploaded on the local storage, create a virtual machine with a 4 GB SCSI disk on the `local-lvm` storage and an ID of 100: -`qm {{[cr|create]}} {{100}} --ide0 {{local-lvm:4}} --net0 {{e1000}} --cdrom {{local:iso/proxmox-mailgateway_2.1.iso}}` +`qm {{[cr|create]}} {{100}} --scsi0 {{local-lvm:4}} --net0 {{e1000}} --cdrom {{local:iso/proxmox-mailgateway_2.1.iso}}` - Show the configuration of a virtual machine, specifying its ID: diff --git a/tldr/linux/rcp b/tldr/linux/rcp index 5d6032b3..ceb2e6c4 100644 --- a/tldr/linux/rcp +++ b/tldr/linux/rcp @@ -7,20 +7,20 @@ source: https://github.com/tldr-pages/tldr.git > Copy files between local and remote systems. > It mimics the behavior of the `cp` command but operates across different machines. -> More information: . +> More information: . - Copy a file to a remote host: -`rcp {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{path/to/local_file}} {{username}}@{{remote_host}}:/{{path/to/destination}}/` - Copy a directory recursively: -`rcp {{[-r|--recursive]}} {{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|--preserve]}} {{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|--from]}} {{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/remote-viewer b/tldr/linux/remote-viewer new file mode 100644 index 00000000..b72569be --- /dev/null +++ b/tldr/linux/remote-viewer @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# remote-viewer + +> View desktops remotely. +> More information: . + +- View a remote using a `virt-viewer` file: + +`remote-viewer {{path/to/virt_viewer_file}}` diff --git a/tldr/linux/rexec b/tldr/linux/rexec index 027e279d..744ec2b0 100644 --- a/tldr/linux/rexec +++ b/tldr/linux/rexec @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Execute a command on a remote host. > Note: Use `rexec` with caution, as it transmits data in plain text. Consider secure alternatives like SSH for encrypted communication. -> More information: . +> More information: . - Execute a command on a remote host: diff --git a/tldr/linux/rlogin b/tldr/linux/rlogin index 84be4952..807c9b31 100644 --- a/tldr/linux/rlogin +++ b/tldr/linux/rlogin @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rlogin > Log in to a remote host. -> More information: . +> More information: . - Log in to a remote host: diff --git a/tldr/linux/rpm b/tldr/linux/rpm index a6ca9b28..61b658dc 100644 --- a/tldr/linux/rpm +++ b/tldr/linux/rpm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > RPM Package Manager. > For equivalent commands in other package managers, see . -> More information: . +> More information: . - Show version of httpd package: diff --git a/tldr/linux/rsh b/tldr/linux/rsh index 1ba1f953..d68ccbfc 100644 --- a/tldr/linux/rsh +++ b/tldr/linux/rsh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rsh > Execute commands on a remote host. -> More information: . +> More information: . - Execute a command on a remote host: diff --git a/tldr/linux/sfill b/tldr/linux/sfill index 811a2a34..72074d86 100644 --- a/tldr/linux/sfill +++ b/tldr/linux/sfill @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Overwrite free space and inodes of a disk with 38 writes (slow but secure): -`sfill {{/path/to/mounted_disk_directory}}` +`sfill /{{path/to/mounted_disk_directory}}` - Overwrite free space and inodes of a disk with 6 writes (fast but [l]ess secure) and show status ([v]erbose): -`sfill -l -v {{/path/to/mounted_disk_directory}}` +`sfill -l -v /{{path/to/mounted_disk_directory}}` - Overwrite free space and inodes of a disk with 1 write (very fast but [l]ess secure [v]erbose) and show status: -`sfill -ll -v {{/path/to/mounted_disk_directory}}` +`sfill -ll -v /{{path/to/mounted_disk_directory}}` - Overwrite only free space of a d[I]sk: -`sfill -I {{/path/to/mounted_disk_directory}}` +`sfill -I /{{path/to/mounted_disk_directory}}` - Overwrite only free [i]nodes of a disk: -`sfill -i {{/path/to/mounted_disk_directory}}` +`sfill -i /{{path/to/mounted_disk_directory}}` diff --git a/tldr/linux/synoupgrade b/tldr/linux/synoupgrade index f576f053..a0c82a96 100644 --- a/tldr/linux/synoupgrade +++ b/tldr/linux/synoupgrade @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade the DSM using a patch file (should be an absolute path): -`sudo synoupgrade --patch {{/path/to/file.pat}}` +`sudo synoupgrade --patch /{{path/to/file.pat}}` - Display help: diff --git a/tldr/linux/systemctl b/tldr/linux/systemctl index 4eb0cd1e..c735398b 100644 --- a/tldr/linux/systemctl +++ b/tldr/linux/systemctl @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl > Control the systemd system and service manager. +> Some subcommands such as `disable`, `status`, `reboot` etc. have their own usage documentation. > More information: . - Show all running services: diff --git a/tldr/linux/systemctl-status b/tldr/linux/systemctl-status new file mode 100644 index 00000000..d053fe75 --- /dev/null +++ b/tldr/linux/systemctl-status @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl status + +> Display the status of systemd units. +> More information: . + +- Show the status of a systemd unit: + +`systemctl status {{unit}}.{{service|timer|socket|target|...}}` + +- Show the status of failed units: + +`systemctl status --failed` + +- List all running services: + +`systemctl status` + +- List all units in the system: + +`systemctl status --all` + +- List all units of a specific type: + +`systemctl status --type {{service|timer|socket|target|...}}` + +- List all units with a specific state: + +`systemctl status --state {{active|inactive|failed}}` diff --git a/tldr/linux/systemd-machine-id-setup b/tldr/linux/systemd-machine-id-setup index 5ce4b961..19981d5d 100644 --- a/tldr/linux/systemd-machine-id-setup +++ b/tldr/linux/systemd-machine-id-setup @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Operate on a disk image instead of a directory tree: -`systemd-machine-id-setup --image {{/path/to/image}}` +`systemd-machine-id-setup --image /{{path/to/image}}` diff --git a/tldr/linux/talk b/tldr/linux/talk index 12f2d830..3df89812 100644 --- a/tldr/linux/talk +++ b/tldr/linux/talk @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # talk > A visual communication program which copies lines from your terminal to that of another user. -> More information: . +> More information: . - Start a talk session with a user on the same machine: diff --git a/tldr/linux/terminator b/tldr/linux/terminator index dc36f616..26db6b89 100644 --- a/tldr/linux/terminator +++ b/tldr/linux/terminator @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # terminator > Arrange multiple GNOME terminals in one window. -> More information: . +> More information: . - Start `terminator` window: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Start with a fullscreen window: -`terminator -f` +`terminator {{[-f|--fullscreen]}}` - Split terminals horizontally: diff --git a/tldr/linux/trash b/tldr/linux/trash index d7858c51..6035aeaa 100644 --- a/tldr/linux/trash +++ b/tldr/linux/trash @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Remove all files with a specific original location: -`trash-rm {{/path/to/file_or_directory}}` +`trash-rm /{{path/to/file_or_directory}}` diff --git a/tldr/linux/umount b/tldr/linux/umount index cd16995e..265361e0 100644 --- a/tldr/linux/umount +++ b/tldr/linux/umount @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Unmount a filesystem, by passing the path to the source it is mounted from: -`umount {{path/to/device_file}}` +`sudo umount {{path/to/device_file}}` - Unmount a filesystem, by passing the path to the target where it is mounted: -`umount {{path/to/mounted_directory}}` +`sudo umount {{path/to/mounted_directory}}` - When an unmount fails, try to remount the filesystem read-only: -`umount {{[-r|--read-only]}} {{path/to/mounted_directory}}` +`sudo umount {{[-r|--read-only]}} {{path/to/mounted_directory}}` - Recursively unmount each specified directory: -`umount {{[-R|--recursive]}} {{path/to/mounted_directory}}` +`sudo umount {{[-R|--recursive]}} {{path/to/mounted_directory}}` - Unmount all mounted filesystems (except the `proc` filesystem): -`umount {{[-a|--all]}}` +`sudo umount {{[-a|--all]}}` diff --git a/tldr/linux/urpmi.addmedia b/tldr/linux/urpmi.addmedia index 80e67337..687b95b0 100644 --- a/tldr/linux/urpmi.addmedia +++ b/tldr/linux/urpmi.addmedia @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git - Add a medium from a hard drive (run `genhdlist2` in the directory first): -`sudo urpmi.addmedia --distrib HD file:/{{/path/to/repo}}` +`sudo urpmi.addmedia --distrib HD file://{{path/to/repo}}` - Add important media from a chosen mirror: diff --git a/tldr/linux/wf-recorder b/tldr/linux/wf-recorder index dda90433..c1e4f1f7 100644 --- a/tldr/linux/wf-recorder +++ b/tldr/linux/wf-recorder @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Record including audio, both with mic and system sounds: -`wf-recorder {{[-a|--audio]}} {{[-f|--file]}} {{/path/to/file_with_audio.webm}}` +`wf-recorder {{[-a|--audio]}} {{[-f|--file]}} /{{path/to/file_with_audio.webm}}` - Select and record a portion of the screen using `slurp`, outputting to default `recording.mp4`: diff --git a/tldr/linux/wine b/tldr/linux/wine index 2129edb9..ac1c4f14 100644 --- a/tldr/linux/wine +++ b/tldr/linux/wine @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wine > Run Windows executables on Unix-based systems. -> More information: . +> More information: . - Run a specific program inside the `wine` environment: diff --git a/tldr/linux/xcursorgen b/tldr/linux/xcursorgen index e4597e41..68656ce1 100644 --- a/tldr/linux/xcursorgen +++ b/tldr/linux/xcursorgen @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Create an X cursor file using a configuration file and specify the path to the image files: -`xcursorgen --prefix {{path/to/image_directory/}} {{path/to/config.cursor}} {{path/to/output_file}}` +`xcursorgen --prefix {{path/to/image_directory}}/ {{path/to/config.cursor}} {{path/to/output_file}}` - Create an X cursor file using a configuration file and write the output to `stdout`: diff --git a/tldr/ln b/tldr/ln index a1df00a0..87306390 100644 --- a/tldr/ln +++ b/tldr/ln @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a symbolic link to a file or directory: -`ln {{[-s|--symbolic]}} {{/path/to/file_or_directory}} {{path/to/symlink}}` +`ln {{[-s|--symbolic]}} /{{path/to/file_or_directory}} {{path/to/symlink}}` - Overwrite an existing symbolic link to point to a different file: -`ln {{[-sf|--symbolic --force]}} {{/path/to/new_file}} {{path/to/symlink}}` +`ln {{[-sf|--symbolic --force]}} /{{path/to/new_file}} {{path/to/symlink}}` - Create a hard link to a file: -`ln {{/path/to/file}} {{path/to/hardlink}}` +`ln /{{path/to/file}} {{path/to/hardlink}}` diff --git a/tldr/lzop b/tldr/lzop index 23f03428..39a73dec 100644 --- a/tldr/lzop +++ b/tldr/lzop @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lzop > Compress or decompress files with LZO compression. -> More information: . +> More information: . - Compress a file into a new file with the `.lzo` suffix: diff --git a/tldr/meld b/tldr/meld index 49438ce0..f4c387a0 100644 --- a/tldr/meld +++ b/tldr/meld @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # meld > Graphical diffing and merging tool. -> More information: . +> More information: . - Start `meld`: diff --git a/tldr/micromamba b/tldr/micromamba index f91a7be6..4fb2d5ce 100644 --- a/tldr/micromamba +++ b/tldr/micromamba @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Create a new environment at a specific path, installing named packages into it: -`micromamba create {{[-p|--prefix]}} {{/path/to/env}} {{python=3.11 numpy}}` +`micromamba create {{[-p|--prefix]}} /{{path/to/env}} {{python=3.11 numpy}}` - Activate an environment by name or path: -`micromamba activate {{[-p|--prefix]}} {{/path/to/env}}` +`micromamba activate {{[-p|--prefix]}} /{{path/to/env}}` - Run a command inside an environment without activating it in the shell: -`micromamba run {{[-p|--prefix]}} {{/path/to/env}} {{pytest tests/}}` +`micromamba run {{[-p|--prefix]}} /{{path/to/env}} {{pytest tests/}}` - Install packages into the currently active environment: diff --git a/tldr/mktemp b/tldr/mktemp index 55ed9a5e..f3437244 100644 --- a/tldr/mktemp +++ b/tldr/mktemp @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a custom directory if `$TMPDIR` is not set (the default is platform-dependent, but usually `/tmp`): -`mktemp -p {{/path/to/tempdir}}` +`mktemp -p /{{path/to/tempdir}}` - Use a custom path template (`X`s are replaced with random alphanumeric characters): diff --git a/tldr/monodevelop b/tldr/monodevelop index 21c5977a..46fc67c3 100644 --- a/tldr/monodevelop +++ b/tldr/monodevelop @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # monodevelop > Cross platform IDE for C#, F# and more. -> More information: . +> More information: . - Start MonoDevelop: diff --git a/tldr/mosh b/tldr/mosh index 621431ca..455d2260 100644 --- a/tldr/mosh +++ b/tldr/mosh @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Usage when `mosh-server` binary is outside standard path: -`mosh --server={{path/to/bin/}}mosh-server {{remote_host}}` +`mosh --server={{path/to/mosh-server}} {{remote_host}}` diff --git a/tldr/mpd b/tldr/mpd index 9f1e3459..76375b7e 100644 --- a/tldr/mpd +++ b/tldr/mpd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Music Player Daemon. > See also: `mpc`, `ncmpcpp`. -> More information: . +> More information: . - Start MPD: diff --git a/tldr/mpijavac b/tldr/mpijavac new file mode 100644 index 00000000..39f807b5 --- /dev/null +++ b/tldr/mpijavac @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mpijavac + +> Open MPI compiler wrapper for Java. +> See also: `mpirun`. +> More information: . + +- Compile a Java source file: + +`mpijavac {{path/to/source_file.java}}` + +- Pass application-specific classpaths to compiler: + +`mpijavac -cp {{path/to/my/app.jar}} {{path/to/source_file.java}}` + +- Show the flags necessary to build MPI Java applications: + +`mpijavac --showme` + +- Show the flags necessary to compile MPI Java applications: + +`mpijavac --showme:compile` + +- Show full invoked Java compiler command line: + +`mpijavac {{path/to/source_file.java}} --showme` diff --git a/tldr/msgcat b/tldr/msgcat index 44603351..f069c6bd 100644 --- a/tldr/msgcat +++ b/tldr/msgcat @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Concatenate and merge multiple `.po` translation files. > Useful in software localization pipelines to combine message catalogs with filtering options. -> More information: . +> More information: . - Combine multiple `.po` files into one: diff --git a/tldr/msgfmt b/tldr/msgfmt index cd30a6fe..a8a4999f 100644 --- a/tldr/msgfmt +++ b/tldr/msgfmt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # msgfmt > Compile message catalog to binary format. -> More information: . +> More information: . - Compile a file to `messages.mo`: diff --git a/tldr/msginit b/tldr/msginit index 59e746ba..84cfc2d2 100644 --- a/tldr/msginit +++ b/tldr/msginit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # msginit > Generate language specific translation files based on Portable Object Templates. -> More information: . +> More information: . - Generate Portable Object files in system locale from `messages.pot`: diff --git a/tldr/msgmerge b/tldr/msgmerge index f7ac51b4..239d51fb 100644 --- a/tldr/msgmerge +++ b/tldr/msgmerge @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # msgmerge > Update an existing translation file from a new template. -> More information: . +> More information: . - Update a translation file: diff --git a/tldr/msgunfmt b/tldr/msgunfmt index 0b0c5df3..5b960cc5 100644 --- a/tldr/msgunfmt +++ b/tldr/msgunfmt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # msgunfmt > Decompile message catalog from the binary format. -> More information: . +> More information: . - Output conversion: diff --git a/tldr/mullvad b/tldr/mullvad index 93baf490..82e629b9 100644 --- a/tldr/mullvad +++ b/tldr/mullvad @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > CLI client for Mullvad VPN. > See also: `fastd`, `ivpn`, `mozillavpn`, `warp-cli`. -> More information: . +> More information: . - Link your Mullvad account with the specified account number: diff --git a/tldr/multipass b/tldr/multipass index cdace6cb..5b7955c0 100644 --- a/tldr/multipass +++ b/tldr/multipass @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # multipass > Manage Ubuntu virtual machines using native hypervisors. -> More information: . +> More information: . - List the aliases that can be used to launch an instance: diff --git a/tldr/mutagen b/tldr/mutagen index 5dca4150..9b9aedc1 100644 --- a/tldr/mutagen +++ b/tldr/mutagen @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Start a synchronization session between a local directory and a remote host: -`mutagen sync create --name={{session_name}} {{/path/to/local/directory/}} {{user}}@{{host}}:{{/path/to/remote/directory/}}` +`mutagen sync create --name={{session_name}} /{{path/to/local/directory}}/ {{user}}@{{host}}:/{{path/to/remote/directory}}/` - Start a synchronization session between a local directory and a Docker container: -`mutagen sync create --name={{session_name}} {{/path/to/local/directory/}} docker://{{user}}@{{container_name}}{{/path/to/remote/directory/}}` +`mutagen sync create --name={{session_name}} /{{path/to/local/directory}}/ docker://{{user}}@{{container_name}}/{{path/to/remote/directory}}/` - Stop a running session: diff --git a/tldr/nasm b/tldr/nasm index 8084f287..3e6825dd 100644 --- a/tldr/nasm +++ b/tldr/nasm @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Add a directory (must be written with trailing slash) to the include file search path before assembling: -`nasm -i {{path/to/include_dir/}} {{source.asm}}` +`nasm -i {{path/to/include_dir}}/ {{source.asm}}` diff --git a/tldr/newsboat b/tldr/newsboat index 458e861f..669fa63d 100644 --- a/tldr/newsboat +++ b/tldr/newsboat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # newsboat > An RSS/Atom feed reader for text terminals. -> More information: . +> More information: . - First import feed URLs from an OPML file: diff --git a/tldr/nxc-vnc b/tldr/nxc-vnc index c95ac2f6..567c81b7 100644 --- a/tldr/nxc-vnc +++ b/tldr/nxc-vnc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nxc vnc > Pentest and exploit VNC servers. -> More information: . +> More information: . - Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: diff --git a/tldr/opam b/tldr/opam index fb78954e..f16b3b4a 100644 --- a/tldr/opam +++ b/tldr/opam @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > OCaml Package Manager. > Manage OCaml compilers, tools and libraries. -> More information: . +> More information: . - Initialize opam for first use: diff --git a/tldr/openstack-network b/tldr/openstack-network new file mode 100644 index 00000000..5e09c8a9 --- /dev/null +++ b/tldr/openstack-network @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack network + +> Manage OpenStack network resources. +> More information: . + +- List all networks: + +`openstack network list` + +- Show details of a network: + +`openstack network show {{network_id_or_name}}` + +- Create a new network with a given name: + +`openstack network create {{network_name}}` + +- Delete a network: + +`openstack network delete {{network_id_or_name}}` + +- Enable a network: + +`openstack network set --enable {{network_id_or_name}}` + +- Disable a network: + +`openstack network set --disable {{network_id_or_name}}` diff --git a/tldr/openstack-port b/tldr/openstack-port new file mode 100644 index 00000000..6c56fdf1 --- /dev/null +++ b/tldr/openstack-port @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack port + +> Manage OpenStack network ports (virtual network interfaces). +> More information: . + +- List all ports: + +`openstack port list` + +- Show detailed information about a specific port: + +`openstack port show {{port_id_or_name}}` + +- Create a port on a specific network: + +`openstack port create --network {{network_id_or_name}} {{port_name}}` + +- Create a port and assign it a fixed IP `192.168.1.50`: + +`openstack port create --network {{network_id}} --fixed-ip subnet={{subnet_id}},ip-address=192.168.1.50 {{port_name}}` + +- Delete a port: + +`openstack port delete {{port_id_or_name}}` diff --git a/tldr/openstack-subnet b/tldr/openstack-subnet new file mode 100644 index 00000000..c9cca7c6 --- /dev/null +++ b/tldr/openstack-subnet @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openstack subnet + +> Manage OpenStack subnets (IP address blocks within a network). +> More information: . + +- List all subnets: + +`openstack subnet list` + +- Show details of a specific subnet: + +`openstack subnet show {{subnet_id_or_name}}` + +- List subnets associated with a network: + +`openstack subnet list --network {{network_id_or_name}}` + +- Create a subnet with subnet range `192.168.0.0/24` in a given network: + +`openstack subnet create --network {{network_id_or_name}} --subnet-range 192.168.0.0/24 {{subnet_name}}` + +- Delete a subnet: + +`openstack subnet delete {{subnet_id_or_name}}` + +- Update a subnet with DNS `8.8.8.8` and set a new name: + +`openstack subnet set --dns-nameserver 8.8.8.8 --name {{new_subnet_name}} {{subnet_id}}` diff --git a/tldr/openvpn b/tldr/openvpn index ac76d294..92a689a0 100644 --- a/tldr/openvpn +++ b/tldr/openvpn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # openvpn > OpenVPN client and daemon binary. -> More information: . +> More information: . - Connect to server using a configuration file: diff --git a/tldr/osx/cot b/tldr/osx/cot index e4cefe5d..3f386992 100644 --- a/tldr/osx/cot +++ b/tldr/osx/cot @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cot > The Plain-Text Editor for macOS. -> More information: . +> More information: . - Start CotEditor: diff --git a/tldr/osx/dockutil b/tldr/osx/dockutil index 2496627a..9e2dea14 100644 --- a/tldr/osx/dockutil +++ b/tldr/osx/dockutil @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Replace one application with another in the current user's dock: -`dockutil --add {{/path/to/application}} --replacing '{{dock_item_label}}'` +`dockutil --add /{{path/to/application}} --replacing '{{dock_item_label}}'` - Add a directory with view options and display it as a folder icon or stack: -`dockutil --add {{/path/to/directory}} --view {{grid|fan|list|auto}} --display {{folder|stack}}` +`dockutil --add /{{path/to/directory}} --view {{grid|fan|list|auto}} --display {{folder|stack}}` - Add a URL dock item after another item: diff --git a/tldr/osx/mist b/tldr/osx/mist index 61950541..4f967ab7 100644 --- a/tldr/osx/mist +++ b/tldr/osx/mist @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - List and export macOS Installers to a CSV file: -`mist list installer --export "{{/path/to/export.csv}}"` +`mist list installer --export "/{{path/to/export.csv}}"` - Download the latest macOS Sonoma Firmware for Apple Silicon Macs, with a custom name: diff --git a/tldr/osx/mktemp b/tldr/osx/mktemp index 6227bb05..a4366a09 100644 --- a/tldr/osx/mktemp +++ b/tldr/osx/mktemp @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a custom directory (defaults to the output of `getconf DARWIN_USER_TEMP_DIR`, or `/tmp`): -`mktemp --tmpdir {{/path/to/tempdir}}` +`mktemp --tmpdir /{{path/to/tempdir}}` - Use a custom path template (`X`s are replaced with random alphanumeric characters): diff --git a/tldr/osx/tart b/tldr/osx/tart index a4146d43..5aa314d8 100644 --- a/tldr/osx/tart +++ b/tldr/osx/tart @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Run an existing VM with a specific mounted directory: -`tart run --dir={{path/to/directory}}:{{/path/to/local_directory}} {{vm-name}}` +`tart run --dir={{path/to/directory}}:/{{path/to/local_directory}} {{vm-name}}` - List VMs: diff --git a/tldr/packer b/tldr/packer index f98595d9..d466fbd5 100644 --- a/tldr/packer +++ b/tldr/packer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # packer > Build automated machine images. -> More information: . +> More information: . - Build an image: diff --git a/tldr/pdfjoin b/tldr/pdfjoin index e6d525a3..5ecf8e8d 100644 --- a/tldr/pdfjoin +++ b/tldr/pdfjoin @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Merge page subranges from two PDFs: -`pdfjoin {{/path/to/file1.pdf}} {{2-}} {{file2}} {{last-3}} --outfile {{output_file}}` +`pdfjoin /{{path/to/file1.pdf}} {{2-}} {{file2}} {{last-3}} --outfile {{output_file}}` diff --git a/tldr/pinta b/tldr/pinta index 0e77fc65..3cecc78e 100644 --- a/tldr/pinta +++ b/tldr/pinta @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pinta > A free, open source program for drawing and image editing. -> More information: . +> More information: . - Start Pinta: diff --git a/tldr/pngquant b/tldr/pngquant index c2b90184..ff73bb5a 100644 --- a/tldr/pngquant +++ b/tldr/pngquant @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pngquant > PNG converter and lossy image compressor. -> More information: . +> More information: . - Compress a specific PNG as much as possible and write result to a new file: diff --git a/tldr/podman-run b/tldr/podman-run index 500e2c04..ced07a7a 100644 --- a/tldr/podman-run +++ b/tldr/podman-run @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Run command in a new container with bind mounted volumes: -`podman run --volume {{/path/to/host_path}}:{{/path/to/container_path}} {{image:tag}} {{command}}` +`podman run --volume /{{path/to/host_path}}:/{{path/to/container_path}} {{image:tag}} {{command}}` - Run command in a new container with published ports: diff --git a/tldr/popd b/tldr/popd index 83960b3c..4129a527 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/prettier b/tldr/prettier index 902ba54d..c1b41af5 100644 --- a/tldr/prettier +++ b/tldr/prettier @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # prettier > An opinionated code formatter for JavaScript, JSON, CSS, YAML, and more. -> More information: . +> More information: . - Format a file and print the result to `stdout`: diff --git a/tldr/pushd b/tldr/pushd index 3f90cbbc..965f7d78 100644 --- a/tldr/pushd +++ b/tldr/pushd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Place a directory on a stack so it can be accessed later. > See also: `popd` to switch back to original directory and `dirs` to display directory stack contents. -> More information: . +> More information: . - Switch to directory and push it on the stack: diff --git a/tldr/pytest b/tldr/pytest index dec71716..d8a9f1b7 100644 --- a/tldr/pytest +++ b/tldr/pytest @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pytest > Run Python tests. -> More information: . +> More information: . - Run tests from specific files: diff --git a/tldr/qdbus b/tldr/qdbus index 14528263..0169cab3 100644 --- a/tldr/qdbus +++ b/tldr/qdbus @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - List methods, signals and properties available on a specific object: -`qdbus {{service_name}} {{/path/to/object}}` +`qdbus {{service_name}} /{{path/to/object}}` - Execute a specific method passing arguments and display the returned value: -`qdbus {{service_name}} {{/path/to/object}} {{method_name}} {{argument1}} {{argument2}}` +`qdbus {{service_name}} /{{path/to/object}} {{method_name}} {{argument1}} {{argument2}}` - Display the current brightness value in a KDE Plasma session: diff --git a/tldr/qutebrowser b/tldr/qutebrowser index 143b65e3..b67a71b0 100644 --- a/tldr/qutebrowser +++ b/tldr/qutebrowser @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qutebrowser > A keyboard-driven, vim-like browser based on PyQt5. -> More information: . +> More information: . - Open qutebrowser with a specified storage directory: diff --git a/tldr/railway b/tldr/railway index bc7a1bbb..4c9f7f60 100644 --- a/tldr/railway +++ b/tldr/railway @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # railway > Connect code to a Railway project. -> More information: . +> More information: . - Login to a Railway account: diff --git a/tldr/rbash b/tldr/rbash index f403c786..3b5bdd08 100644 --- a/tldr/rbash +++ b/tldr/rbash @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Restricted Bash shell, equivalent to `bash --restricted`. > Does not permit changing the working directory, redirecting command output, or modifying environment variables, among other things. > See also: `histexpand` for history expansion. -> More information: . +> More information: . - Start an interactive shell session: diff --git a/tldr/rr b/tldr/rr index d8c44af3..e3e403ef 100644 --- a/tldr/rr +++ b/tldr/rr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rr > Debugging tool designed to record and replay program execution. -> More information: . +> More information: . - Record an application: diff --git a/tldr/rsync b/tldr/rsync index eca3da75..9db23ddc 100644 --- a/tldr/rsync +++ b/tldr/rsync @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Transfer directory contents, but not the directory itself: -`rsync {{[-r|--recursive]}} {{path/to/source/}} {{path/to/destination}}` +`rsync {{[-r|--recursive]}} {{path/to/source}}/ {{path/to/destination}}` - Use archive mode, resolve symlinks, and skip files that are newer on the destination: diff --git a/tldr/rtmpdump b/tldr/rtmpdump index 6a60f74d..b37623b0 100644 --- a/tldr/rtmpdump +++ b/tldr/rtmpdump @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rtmpdump > Dump media content streamed over the RTMP protocol. -> More information: . +> More information: . - Download a file: diff --git a/tldr/sbcl b/tldr/sbcl index 39e1e7f5..6ad2b080 100644 --- a/tldr/sbcl +++ b/tldr/sbcl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sbcl > High performance Common Lisp compiler. -> More information: . +> More information: . - Start a REPL (interactive shell): diff --git a/tldr/serverless b/tldr/serverless index d62816db..b5636c42 100644 --- a/tldr/serverless +++ b/tldr/serverless @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Toolkit for deploying and operating serverless architectures on AWS, Google Cloud, Azure and IBM OpenWhisk. > Commands can be run either using the `serverless` command or its alias, `sls`. -> More information: . +> More information: . - Create a serverless project: diff --git a/tldr/sftp b/tldr/sftp index 0f4a3ae7..ec1a9277 100644 --- a/tldr/sftp +++ b/tldr/sftp @@ -24,15 +24,15 @@ source: https://github.com/tldr-pages/tldr.git - Transfer remote file to the local system: -`get {{/path/remote_file}}` +`get {{path/remote_file}}` - Transfer local file to the remote system: -`put {{/path/local_file}}` +`put /{{path/local_file}}` - Transfer remote directory to the local system recursively (works with `put` too): -`get -R {{/path/remote_directory}}` +`get -R {{path/remote_directory}}` - Get list of files on local machine: diff --git a/tldr/shopt b/tldr/shopt index cafc47f8..6ea40bbf 100644 --- a/tldr/shopt +++ b/tldr/shopt @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage Bash shell options: variables (stored in `$BASHOPTS`) that control behavior specific to the Bash shell. > Generic POSIX shell variables (stored in `$SHELLOPTS`) are managed with the `set` command instead. -> More information: . +> More information: . - List of all settable options and whether they are set: diff --git a/tldr/soffice b/tldr/soffice new file mode 100644 index 00000000..f59bcf21 --- /dev/null +++ b/tldr/soffice @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# soffice + +> CLI for the powerful and free LibreOffice suite. +> More information: . + +- Open one or more files in read-only mode: + +`soffice --view {{path/to/file1 path/to/file2 ...}}` + +- Display the content of one or more files: + +`soffice --cat {{path/to/file1 path/to/file2 ...}}` + +- Print files using a specific printer: + +`soffice --pt {{printer_name}} {{path/to/file1 path/to/file2 ...}}` + +- Convert all `.doc` files in the current directory to PDF: + +`soffice --convert-to pdf *.doc` diff --git a/tldr/stow b/tldr/stow index 209c5e43..52786325 100644 --- a/tldr/stow +++ b/tldr/stow @@ -8,7 +8,7 @@ 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: diff --git a/tldr/streamlit b/tldr/streamlit index bc543e10..922c2615 100644 --- a/tldr/streamlit +++ b/tldr/streamlit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # streamlit > Framework for creating interactive, data-driven web apps in Python. -> More information: . +> More information: . - Check for the Streamlit installation: diff --git a/tldr/sunos/share b/tldr/sunos/share index 2c7e1c97..9ec662c5 100644 --- a/tldr/sunos/share +++ b/tldr/sunos/share @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Share a directory with read/write access: -`share -F nfs -o rw {{/path/to/directory}}` +`share -F nfs -o rw /{{path/to/directory}}` - Share a directory with read-only access: -`share -F nfs -o ro {{/path/to/directory}}` +`share -F nfs -o ro /{{path/to/directory}}` - Share a directory with specific options (e.g., allow root access from a specific host): -`share -F nfs -o rw,root={{hostname}} {{/path/to/directory}}` +`share -F nfs -o rw,root={{hostname}} /{{path/to/directory}}` - Make sharing persistent by adding entries to `/etc/dfs/dfstab`: -`echo "share -F nfs -o rw {{/path/to/directory}}" >> /etc/dfs/dfstab` +`echo "share -F nfs -o rw /{{path/to/directory}}" >> /etc/dfs/dfstab` diff --git a/tldr/suspend b/tldr/suspend index 45930e75..60053638 100644 --- a/tldr/suspend +++ b/tldr/suspend @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Continue from suspension if `suspend` was used in a non-nested shell (run this in a separate terminal): -`pkill -CONT bash` +`pkill -CONT {{bash}}` - Force suspension even if this would lock you out of the system: diff --git a/tldr/svn b/tldr/svn index 6433dab6..113fdb7c 100644 --- a/tldr/svn +++ b/tldr/svn @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # svn > Subversion client tool. -> More information: . +> More information: . - Check out a working copy from a repository: -`svn co {{url/to/repository}}` +`svn {{[co|checkout]}} {{url/to/repository}}` - Bring changes from the repository into the working copy: -`svn up` +`svn {{[up|update]}}` - Put files and directories under version control, scheduling them for addition to repository. They will be added in next commit: @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Send changes from your working copy to the repository: -`svn ci -m {{commit_log_message}} [{{PATH}}]` +`svn {{[ci|commit]}} {{[-m|--message]}} {{commit_log_message}} [{{PATH}}]` - Display changes from the last 10 revisions, showing modified files for each revision: -`svn log -vl {{10}}` +`svn log {{[-vl|--verbose --limit]}} {{10}}` - Display help: -`svn help` +`svn {{[h|help]}}` diff --git a/tldr/svn-changelist b/tldr/svn-changelist index 9e8f36a4..e8d5a189 100644 --- a/tldr/svn-changelist +++ b/tldr/svn-changelist @@ -6,23 +6,23 @@ source: https://github.com/tldr-pages/tldr.git # svn changelist > Associate a changelist with a set of files. -> More information: . +> More information: . - Add files to a changelist, creating the changelist if it does not exist: -`svn changelist {{changelist_name}} {{path/to/file1 path/to/file2 ...}}` +`svn {{[cl|changelist]}} {{changelist_name}} {{path/to/file1 path/to/file2 ...}}` - Remove files from a changelist: -`svn changelist --remove {{path/to/file1 path/to/file2 ...}}` +`svn {{[cl|changelist]}} --remove {{path/to/file1 path/to/file2 ...}}` - Remove the whole changelist at once: -`svn changelist --remove --recursive --changelist {{changelist_name}} .` +`svn {{[cl|changelist]}} --remove {{[-R|--recursive]}} --changelist {{changelist_name}} .` - Add the contents of a space-separated list of directories to a changelist: -`svn changelist --recursive {{changelist_name}} {{path/to/directory1 path/to/directory2 ...}}` +`svn {{[cl|changelist]}} {{[-R|--recursive]}} {{changelist_name}} {{path/to/directory1 path/to/directory2 ...}}` - Commit a changelist: diff --git a/tldr/swipl b/tldr/swipl index 63f08e71..ec83d1c1 100644 --- a/tldr/swipl +++ b/tldr/swipl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # swipl > SWI-Prolog - A comprehensive free Prolog environment. -> More information: . +> More information: . - Start an interactive session: diff --git a/tldr/syncthing b/tldr/syncthing index fcb43e33..b33e74f3 100644 --- a/tldr/syncthing +++ b/tldr/syncthing @@ -16,26 +16,26 @@ source: https://github.com/tldr-pages/tldr.git `syncthing --no-browser` -- Print the device ID: - -`syncthing --device-id` - - Change the home directory: `syncthing --home {{path/to/directory}}` -- Force a full index exchange in order to resolve out of sync files: +- Run Syncthing with increased logging: -`syncthing --reset-deltas` +`syncthing --verbose` + +- Pause all devices: + +`syncthing cli config devices pause --all` + +- Resume all devices: + +`syncthing cli config devices resume --all` - Change the address upon which the web interface listens: `syncthing --gui-address {{ip_address:port|path/to/socket.sock}}` -- Show filepaths to the files used by Syncthing: +- Set the log level for output: -`syncthing --paths` - -- Disable the Syncthing monitor process: - -`syncthing --no-restart` +`syncthing --log-level {{info|warning|error|debug}}` diff --git a/tldr/tcc b/tldr/tcc index a81221e0..544eecf2 100644 --- a/tldr/tcc +++ b/tldr/tcc @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Interpret C source files with a shebang inside the file: -`#!{{/full/path/to/tcc}} -run` +`#!/{{path/to/tcc}} -run` diff --git a/tldr/tcpreplay b/tldr/tcpreplay index 45b475c1..cfa178df 100644 --- a/tldr/tcpreplay +++ b/tldr/tcpreplay @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tcpreplay > Replay network traffic stored in a `pcap` file. -> More information: . +> More information: . - List available network interfaces: diff --git a/tldr/testssl b/tldr/testssl index ebc3869a..8de8445c 100644 --- a/tldr/testssl +++ b/tldr/testssl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # testssl > Check SSL/TLS protocols and ciphers supported by a server. -> More information: . +> More information: . - Test a server (run every check) on port 443: diff --git a/tldr/tig b/tldr/tig index 24653e9f..5dfadc57 100644 --- a/tldr/tig +++ b/tldr/tig @@ -25,6 +25,10 @@ source: https://github.com/tldr-pages/tldr.git `tig {{base_ref}}..{{compared_ref}}` +- Browse git blame interactively (press `<,>` to jump to parent): + +`tig blame {{path/to/file}}` + - Display commits from all branches and stashes: `tig --all` diff --git a/tldr/todoman b/tldr/todoman index 4c09d738..f0d09387 100644 --- a/tldr/todoman +++ b/tldr/todoman @@ -5,9 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # todoman -> A simple, standards-based, cli todo manager. -> `todoman` is a common name for the command `todo`, but not a command itself. -> More information: . +> This command is an alias of `todo`. - View documentation for the original command: diff --git a/tldr/tofu b/tldr/tofu index 4c382cf6..0ec4fc06 100644 --- a/tldr/tofu +++ b/tldr/tofu @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tofu > Create and deploy infrastructure as code to cloud providers. Open-source fork of Terraform. -> More information: . +> More information: . - Initialize a new or existing OpenTofu configuration: diff --git a/tldr/tqdm b/tldr/tqdm index d0965030..6abf2b1c 100644 --- a/tldr/tqdm +++ b/tldr/tqdm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tqdm > Show progress over time of a command. -> More information: . +> More information: . - Show iterations per second and use `stdout` afterwards: diff --git a/tldr/transfersh b/tldr/transfersh index c2491714..b0f7f9d7 100644 --- a/tldr/transfersh +++ b/tldr/transfersh @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Upload all files from a directory recursively: -`transfersh --recursive {{path/to/directory/}}` +`transfersh --recursive {{path/to/directory}}/` - Upload a specific directory as an uncompressed tar: diff --git a/tldr/transmission-remote b/tldr/transmission-remote index dbd53444..876e8eda 100644 --- a/tldr/transmission-remote +++ b/tldr/transmission-remote @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Add a torrent file or magnet link to Transmission and download to a specified directory: -`transmission-remote {{hostname}} {{[-a|--all]}} {{torrent|url}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-a|--all]}} {{torrent|url}} {{[-w|--download-dir]}} /{{path/to/download_directory}}` - Change the default download directory: -`transmission-remote {{hostname}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-w|--download-dir]}} /{{path/to/download_directory}}` - List all torrents: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Move torrents 1-10 and 15-20 to a new directory (which will be created if it does not exist): -`transmission-remote {{hostname}} {{[-t|--torrent]}} "1-10,15-20" --move {{/path/to/new_directory}}` +`transmission-remote {{hostname}} {{[-t|--torrent]}} "1-10,15-20" --move /{{path/to/new_directory}}` diff --git a/tldr/trip b/tldr/trip index 72534507..330fd107 100644 --- a/tldr/trip +++ b/tldr/trip @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > A network diagnostic tool. > Combines the functionality of `traceroute` and `ping`. > Designed to assist with the analysis of networking issues. -> More information: . +> More information: . - Basic usage with default parameters: diff --git a/tldr/trunk b/tldr/trunk index 5fe6a04f..d7348b3c 100644 --- a/tldr/trunk +++ b/tldr/trunk @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Build for production at root or subdirectory: -`trunk build --release --dist {{path/to/distribution}} --public-url {{/path/to/app/subdir}}` +`trunk build --release --dist {{path/to/distribution}} --public-url /{{path/to/app/subdir}}` - List all available tools in the repo and if they are enabled: diff --git a/tldr/typeorm b/tldr/typeorm index 4e527afb..a7b7d076 100644 --- a/tldr/typeorm +++ b/tldr/typeorm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # typeorm > A JavaScript ORM that can run on Node.js, browser, Cordova, Ionic, React Native, NativeScript, and Electron platforms. -> More information: . +> More information: . - Generate a new initial TypeORM project structure: diff --git a/tldr/ulimit b/tldr/ulimit index 20825fed..d80c0f34 100644 --- a/tldr/ulimit +++ b/tldr/ulimit @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Set max per-user process limit: -`ulimit -u 30` +`ulimit -u {{30}}` - Display help (Bash only): diff --git a/tldr/updog b/tldr/updog index 0ac69c35..dc7f14e8 100644 --- a/tldr/updog +++ b/tldr/updog @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Start a HTTP server for a specified directory: -`updog --directory {{/path/to/directory}}` +`updog --directory /{{path/to/directory}}` - Start a HTTP server on a specified port: diff --git a/tldr/uv-add b/tldr/uv-add index f235776d..a262e943 100644 --- a/tldr/uv-add +++ b/tldr/uv-add @@ -35,7 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Add package as editable: -`uv add --editable {{path/to/package/}}` +`uv add --editable {{path/to/package}}/` - Enable an extra when installing package, may be provided multiple times: diff --git a/tldr/vala b/tldr/vala index 18e8613f..0960a7ad 100644 --- a/tldr/vala +++ b/tldr/vala @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Vala code runner. > Tutorial: . -> More information: . +> More information: . - Run a vala file, with gtk+: diff --git a/tldr/valac b/tldr/valac index 3ff5ee75..4c5215e3 100644 --- a/tldr/valac +++ b/tldr/valac @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Vala code compiler. > Tutorial: . -> More information: . +> More information: . - Compile a vala file, with gtk+: diff --git a/tldr/varnishlog b/tldr/varnishlog index 4678b9ba..5324350c 100644 --- a/tldr/varnishlog +++ b/tldr/varnishlog @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Only display requests to a specific path: -`varnishlog -q 'ReqURL eq "{{/path}}"'` +`varnishlog -q 'ReqURL eq "/{{path}}"'` - Only display requests to paths matching a `regex`: diff --git a/tldr/virsh-undefine b/tldr/virsh-undefine index e5e00f42..4a86e09b 100644 --- a/tldr/virsh-undefine +++ b/tldr/virsh-undefine @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete the configuration file and the specified storage volumes using the target name or the source name (as obtained from the `virsh domblklist` command): -`virsh undefine --domain {{vm_name}} --storage {{sda,path/to/source}}` +`virsh undefine --domain {{vm_name}} --storage {{sda,sdb,path/to/source,...}}` diff --git a/tldr/wdiff b/tldr/wdiff index 4d27a372..6cc1e53f 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: diff --git a/tldr/weasyprint b/tldr/weasyprint index 6131d738..d3378f53 100644 --- a/tldr/weasyprint +++ b/tldr/weasyprint @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # weasyprint > Render HTML to PDF or PNG. -> More information: . +> More information: . - Render an HTML file to PDF: diff --git a/tldr/while b/tldr/while index f021af94..a3b31d29 100644 --- a/tldr/while +++ b/tldr/while @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Read `stdin` and perform an action on every line: -`while read line; do echo "$line"; done` +`while read line; do {{echo "$line"}}; done` - Execute a command forever once every second: diff --git a/tldr/wkhtmltopdf b/tldr/wkhtmltopdf index ea5224f7..dbc57cc1 100644 --- a/tldr/wkhtmltopdf +++ b/tldr/wkhtmltopdf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wkhtmltopdf > Convert HTML documents or web pages into PDF files. -> More information: . +> More information: . - Convert a HTML document into PDF: diff --git a/tldr/wp b/tldr/wp index 986e8583..be673929 100644 --- a/tldr/wp +++ b/tldr/wp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wp > The official interface to manage WordPress instances. -> More information: . +> More information: . - Print information about the operating system, shell, PHP, and WP-CLI (`wp`) installation: diff --git a/tldr/xgettext b/tldr/xgettext index fb018f23..e68b45d1 100644 --- a/tldr/xgettext +++ b/tldr/xgettext @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xgettext > Extract gettext strings from code files. -> More information: . +> More information: . - Scan file and output strings to `messages.po`: diff --git a/tldr/yard b/tldr/yard index 94a070b9..0d1a1fe5 100644 --- a/tldr/yard +++ b/tldr/yard @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # yard > Documentation tool for Ruby. -> More information: . +> More information: . - Create the documentation: diff --git a/tldr/zfs b/tldr/zfs index a64c2c7f..ddac3a96 100644 --- a/tldr/zfs +++ b/tldr/zfs @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Change mountpoint for a filesystem: -`zfs set mountpoint={{/my/mount/path}} {{pool_name/filesystem_name}}` +`zfs set mountpoint=/{{path/to/mount_point}} {{pool_name/filesystem_name}}` diff --git a/tldr/zola b/tldr/zola index f8aec594..d1d86680 100644 --- a/tldr/zola +++ b/tldr/zola @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Build the whole site into a different directory: -`zola build --output-dir {{path/to/output_directory/}}` +`zola build --output-dir {{path/to/output_directory}}/` - Build and serve the site using a local server (default is `127.0.0.1:1111`): diff --git a/tldr/{ b/tldr/{ index 304e26d0..acac30f0 100644 --- a/tldr/{ +++ b/tldr/{ @@ -10,31 +10,31 @@ source: https://github.com/tldr-pages/tldr.git - Isolate variable names: -`echo ${HOME}work` +`echo ${{{HOME}work}}` - Brace expand sequences: -`echo {1..3} {a..c}{dir1,dir2,dir3}` +`echo {{{1..3}}} {{{a..c}}}{{{dir1,dir2,dir3}}}` - Check if `variable` is set before returning text: -`echo ${variable:+variable is set and contains $variable}` +`echo ${{{variable:+variable is set and contains $variable}}}` - Set default values in case `variable` is unset: -`echo ${variable:-default}` +`echo ${{{variable:-default}}}` - Return `variable` length in characters: -`echo ${#variable}` +`echo ${{{#variable}}}` - Return a string slice: -`echo ${variable:3:7}` +`echo ${{{variable:3:7}}}` - Recursively expand a `variable`: -`echo ${!variable}` +`echo ${{{!variable}}}` - Group command output together: