diff --git a/! b/! new file mode 100644 index 00000000..796779f0 --- /dev/null +++ b/! @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Exclamation mark + +> Bash builtin to substitute with a command found in history. +> More information: . + +- Substitute with the previous command and run it with `sudo`: + +`sudo !!` + +- Substitute with a command based on its line number found with `history`: + +`!{{number}}` + +- Substitute with a command that was used a specified number of lines back: + +`!-{{number}}` + +- Substitute with the most recent command that starts with a string: + +`!{{string}}` + +- Substitute with the arguments of the latest command: + +`{{command}} !*` diff --git a/2to3 b/2to3 new file mode 100644 index 00000000..1aa314e6 --- /dev/null +++ b/2to3 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# 2to3 + +> Automated Python 2 to 3 code conversion. +> More information: . + +- Display the changes that would be performed without performing them (dry-run): + +`2to3 {{path/to/file.py}}` + +- Convert a Python 2 file to Python 3: + +`2to3 --write {{path/to/file.py}}` + +- Convert specific Python 2 language features to Python 3: + +`2to3 --write {{path/to/file.py}} --fix={{raw_input}} --fix={{print}}` + +- Convert all Python 2 language features except the specified ones to Python 3: + +`2to3 --write {{path/to/file.py}} --nofix={{has_key}} --nofix={{isinstance}}` + +- List all available language features that can be converted from Python 2 to Python 3: + +`2to3 --list-fixes` + +- Convert all Python 2 files in a directory to Python 3: + +`2to3 --output-dir={{path/to/python3_directory}} --write-unchanged-files --nobackups {{path/to/python2_directory}}` + +- Run 2to3 with multiple threads: + +`2to3 --processes={{4}} --output-dir={{path/to/python3_directory}} --write --nobackups --no-diff {{path/to/python2_directory}}` diff --git a/7z b/7z new file mode 100644 index 00000000..e10bc465 --- /dev/null +++ b/7z @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# 7z + +> File archiver with a high compression ratio. +> More information: . + +- [a]dd a file or directory to a new or existing archive: + +`7z a {{path/to/archive.7z}} {{path/to/file_or_directory}}` + +- Encrypt an existing archive (including filenames): + +`7z a {{path/to/encrypted.7z}} -p{{password}} -mhe=on {{path/to/archive.7z}}` + +- E[x]tract an archive preserving the original directory structure: + +`7z x {{path/to/archive.7z}}` + +- E[x]tract an archive to a specific directory: + +`7z x {{path/to/archive.7z}} -o{{path/to/output}}` + +- E[x]tract an archive to `stdout`: + +`7z x {{path/to/archive.7z}} -so` + +- [a]rchive using a specific archive type: + +`7z a -t{{7z|bzip2|gzip|lzip|tar|zip}} {{path/to/archive}} {{path/to/file_or_directory}}` + +- [l]ist the contents of an archive: + +`7z l {{path/to/archive.7z}}` + +- Set the level of compression (higher means more compression, but slower): + +`7z a {{path/to/archive.7z}} -mx={{0|1|3|5|7|9}} {{path/to/file_or_directory}}` diff --git a/7za b/7za new file mode 100644 index 00000000..2008f6bc --- /dev/null +++ b/7za @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# 7za + +> File archiver with a high compression ratio. +> Similar to `7z` except that it supports fewer file types but is cross-platform. +> More information: . + +- [a]rchive a file or directory: + +`7za a {{path/to/archive.7z}} {{path/to/file_or_directory}}` + +- Encrypt an existing archive (including file names): + +`7za a {{path/to/encrypted.7z}} -p{{password}} -mhe={{on}} {{path/to/archive.7z}}` + +- E[x]tract an archive preserving the original directory structure: + +`7za x {{path/to/archive.7z}}` + +- E[x]tract an archive to a specific directory: + +`7za x {{path/to/archive.7z}} -o{{path/to/output}}` + +- E[x]tract an archive to `stdout`: + +`7za x {{path/to/archive.7z}} -so` + +- [a]rchive using a specific archive type: + +`7za a -t{{7z|bzip2|gzip|lzip|tar|...}} {{path/to/archive.7z}} {{path/to/file_or_directory}}` + +- [l]ist the contents of an archive: + +`7za l {{path/to/archive.7z}}` + +- Set the level of compression (higher means more compression, but slower): + +`7za a {{path/to/archive.7z}} -mx={{0|1|3|5|7|9}} {{path/to/file_or_directory}}` diff --git a/7zr b/7zr new file mode 100644 index 00000000..7f5c9778 --- /dev/null +++ b/7zr @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# 7zr + +> File archiver with a high compression ratio. +> Similar to `7z` except that it only supports `.7z` files. +> More information: . + +- [a]rchive a file or directory: + +`7zr a {{path/to/archive.7z}} {{path/to/file_or_directory}}` + +- Encrypt an existing archive (including file names): + +`7zr a {{path/to/encrypted.7z}} -p{{password}} -mhe={{on}} {{path/to/archive.7z}}` + +- E[x]tract an archive preserving the original directory structure: + +`7zr x {{path/to/archive.7z}}` + +- E[x]tract an archive to a specific directory: + +`7zr x {{path/to/archive.7z}} -o{{path/to/output}}` + +- E[x]tract an archive to `stdout`: + +`7zr x {{path/to/archive.7z}} -so` + +- [l]ist the contents of an archive: + +`7zr l {{path/to/archive.7z}}` + +- Set the level of compression (higher means more compression, but slower): + +`7zr a {{path/to/archive.7z}} -mx={{0|1|3|5|7|9}} {{path/to/file_or_directory}}` diff --git a/[ b/[ new file mode 100644 index 00000000..6a9b02ae --- /dev/null +++ b/[ @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# [ + +> Check file types and compare values. +> Returns a status of 0 if the condition evaluates to true, 1 if it evaluates to false. +> More information: . + +- Test if a given variable is equal/not equal to the specified string: + +`[ "${{variable}}" {{=|!=}} "{{string}}" ]` + +- Test if a given variable is [eq]ual/[n]ot [e]qual/[g]reater [t]han/[l]ess [t]han/[g]reater than or [e]qual/[l]ess than or [e]qual to the specified number: + +`[ "${{variable}}" -{{eq|ne|gt|lt|ge|le}} {{integer}} ]` + +- Test if the specified variable has a [n]on-empty value: + +`[ -n "${{variable}}" ]` + +- Test if the specified variable has an empty value: + +`[ -z "${{variable}}" ]` + +- Test if the specified [f]ile exists: + +`[ -f {{path/to/file}} ]` + +- Test if the specified [d]irectory exists: + +`[ -d {{path/to/directory}} ]` + +- Test if the specified file or directory [e]xists: + +`[ -e {{path/to/file_or_directory}} ]` diff --git a/[[ b/[[ new file mode 100644 index 00000000..4abe8c0e --- /dev/null +++ b/[[ @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# [[ + +> Check file types and compare values. +> Returns a status of 0 if the condition evaluates to true, 1 if it evaluates to false. +> More information: . + +- Test if a given variable is equal/not equal to the specified string: + +`[[ ${{variable}} {{==|!=}} "{{string}}" ]]` + +- Test if a given string conforms the specified glob/regex: + +`[[ ${{variable}} {{==|=~}} {{pattern}} ]]` + +- Test if a given variable is [eq]ual/[n]ot [e]qual/[g]reater [t]han/[l]ess [t]han/[g]reater than or [e]qual/[l]ess than or [e]qual to the specified number: + +`[[ ${{variable}} -{{eq|ne|gt|lt|ge|le}} {{integer}} ]]` + +- Test if the specified variable has a [n]on-empty value: + +`[[ -n ${{variable}} ]]` + +- Test if the specified variable has an empty value: + +`[[ -z ${{variable}} ]]` + +- Test if the specified [f]ile exists: + +`[[ -f {{path/to/file}} ]]` + +- Test if the specified [d]irectory exists: + +`[[ -d {{path/to/directory}} ]]` + +- Test if the specified file or directory [e]xists: + +`[[ -e {{path/to/file_or_directory}} ]]` diff --git a/a2ping b/a2ping new file mode 100644 index 00000000..9c05226a --- /dev/null +++ b/a2ping @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# a2ping + +> Convert images into EPS or PDF files. +> More information: . + +- Convert an image to PDF (Note: Specifying an output filename is optional): + +`a2ping {{path/to/image.ext}} {{path/to/output.pdf}}` + +- Compress the document using the specified method: + +`a2ping --nocompress {{none|zip|best|flate}} {{path/to/file}}` + +- Scan HiResBoundingBox if present (defaults to yes): + +`a2ping --nohires {{path/to/file}}` + +- Allow page content below and left of the origin (defaults to no): + +`a2ping --below {{path/to/file}}` + +- Pass extra arguments to `gs`: + +`a2ping --gsextra {{arguments}} {{path/to/file}}` + +- Pass extra arguments to external program (i.e `pdftops`): + +`a2ping --extra {{arguments}} {{path/to/file}}` + +- Display help: + +`a2ping -h` diff --git a/aapt b/aapt new file mode 100644 index 00000000..e5a1ad79 --- /dev/null +++ b/aapt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aapt + +> Android Asset Packaging Tool: compile and package an Android app's resources. +> More information: . + +- List files contained in an APK archive: + +`aapt list {{path/to/app.apk}}` + +- Display an app's metadata (version, permissions, etc.): + +`aapt dump badging {{path/to/app.apk}}` + +- Create a new APK archive with files from the specified directory: + +`aapt package -F {{path/to/app.apk}} {{path/to/directory}}` diff --git a/ab b/ab new file mode 100644 index 00000000..10e5b259 --- /dev/null +++ b/ab @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ab + +> Apache HTTP server benchmarking tool. +> More information: . + +- Execute 100 HTTP GET requests to a given URL: + +`ab -n 100 {{url}}` + +- Execute 100 HTTP GET requests, in concurrent batches of 10, to a URL: + +`ab -n 100 -c 10 {{url}}` + +- Execute 100 HTTP POST requests to a URL, using a JSON payload from a file: + +`ab -n 100 -T {{application/json}} -p {{path/to/file.json}} {{url}}` + +- Use HTTP [k]eep-Alive, i.e. perform multiple requests within one HTTP session: + +`ab -k {{url}}` + +- Set the maximum number of seconds ([t]imeout) to spend for benchmarking (30 by default): + +`ab -t {{60}} {{url}}` + +- Write the results to a CSV file: + +`ab -e {{path/to/file.csv}}` diff --git a/abduco b/abduco new file mode 100644 index 00000000..5bde0de8 --- /dev/null +++ b/abduco @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# abduco + +> Terminal session manager. +> More information: . + +- List sessions: + +`abduco` + +- [A]ttach to a session, creating it if it doesn't exist: + +`abduco -A {{name}} {{bash}}` + +- [A]ttach to a session with `dvtm`, creating it if it doesn't exist: + +`abduco -A {{name}}` + +- Detach from a session: + +` + \` + +- [A]ttach to a session in [r]ead-only mode: + +`abduco -Ar {{name}}` diff --git a/ac b/ac new file mode 100644 index 00000000..f11be924 --- /dev/null +++ b/ac @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ac + +> Print statistics on how long users have been connected. +> More information: . + +- Print how long the current user has been connected in hours: + +`ac` + +- Print how long users have been connected in hours: + +`ac -p` + +- Print how long a particular user has been connected in hours: + +`ac -p {{username}}` + +- Print how long a particular user has been connected in hours per [d]ay (with total): + +`ac -dp {{username}}` diff --git a/accelerate b/accelerate new file mode 100644 index 00000000..cd3282a7 --- /dev/null +++ b/accelerate @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Accelerate + +> A library that enables the same PyTorch code to be run across any distributed configuration. +> More information: . + +- Print environment information: + +`accelerate env` + +- Interactively create a configuration file: + +`accelerate config` + +- Print the estimated GPU memory cost of running a Hugging Face model with different data types: + +`accelerate estimate-memory {{name/model}}` + +- Test an Accelerate configuration file: + +`accelerate test --config_file {{path/to/config.yaml}}` + +- Run a model on CPU with Accelerate: + +`accelerate launch {{path/to/script.py}} {{--cpu}}` + +- Run a model on multi-GPU with Accelerate, with 2 machines: + +`accelerate launch {{path/to/script.py}} --multi_gpu --num_machines 2` diff --git a/ack b/ack new file mode 100644 index 00000000..f13d829d --- /dev/null +++ b/ack @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ack + +> A search tool like `grep`, optimized for developers. +> See also: `rg`, which is much faster. +> More information: . + +- Search for files containing a string or regular expression in the current directory recursively: + +`ack "{{search_pattern}}"` + +- Search for a case-insensitive pattern: + +`ack --ignore-case "{{search_pattern}}"` + +- Search for lines matching a pattern, printing [o]nly the matched text and not the rest of the line: + +`ack -o "{{search_pattern}}"` + +- Limit search to files of a specific type: + +`ack --type={{ruby}} "{{search_pattern}}"` + +- Do not search in files of a specific type: + +`ack --type=no{{ruby}} "{{search_pattern}}"` + +- Count the total number of matches found: + +`ack --count --no-filename "{{search_pattern}}"` + +- Print the file names and the number of matches for each file only: + +`ack --count --files-with-matches "{{search_pattern}}"` + +- List all the values that can be used with `--type`: + +`ack --help-types` diff --git a/acme.sh b/acme.sh new file mode 100644 index 00000000..4eb7f276 --- /dev/null +++ b/acme.sh @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# acme.sh + +> Shell script implementing ACME client protocol, an alternative to `certbot`. +> See also `acme.sh dns`. +> More information: . + +- Issue a certificate using webroot mode: + +`acme.sh --issue --domain {{example.com}} --webroot {{/path/to/webroot}}` + +- Issue a certificate for multiple domains using standalone mode using port 80: + +`acme.sh --issue --standalone --domain {{example.com}} --domain {{www.example.com}}` + +- Issue a certificate using standalone TLS mode using port 443: + +`acme.sh --issue --alpn --domain {{example.com}}` + +- Issue a certificate using a working Nginx configuration: + +`acme.sh --issue --nginx --domain {{example.com}}` + +- Issue a certificate using a working Apache configuration: + +`acme.sh --issue --apache --domain {{example.com}}` + +- Issue a wildcard (\*) certificate using an automatic DNS API mode: + +`acme.sh --issue --dns {{dns_cf}} --domain {{*.example.com}}` + +- Install certificate files into the specified locations (useful for automatic certificate renewal): + +`acme.sh --install-cert -d {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd {{"systemctl force-reload nginx"}}` diff --git a/acme.sh-dns b/acme.sh-dns new file mode 100644 index 00000000..63ca591e --- /dev/null +++ b/acme.sh-dns @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# acme.sh --dns + +> Use a DNS-01 challenge to issue a TLS certificate. +> More information: . + +- Issue a certificate using an automatic DNS API mode: + +`acme.sh --issue --dns {{gnd_gd}} --domain {{example.com}}` + +- Issue a wildcard certificate (denoted by an asterisk) using an automatic DNS API mode: + +`acme.sh --issue --dns {{dns_namesilo}} --domain {{example.com}} --domain {{*.example.com}}` + +- Issue a certificate using a DNS alias mode: + +`acme.sh --issue --dns {{dns_cf}} --domain {{example.com}} --challenge-alias {{alias-for-example-validation.com}}` + +- Issue a certificate while disabling automatic Cloudflare/Google DNS polling after the DNS record is added by specifying a custom wait time in seconds: + +`acme.sh --issue --dns {{dns_namecheap}} --domain {{example.com}} --dnssleep {{300}}` + +- Issue a certificate using a manual DNS mode: + +`acme.sh --issue --dns --domain {{example.com}} --yes-I-know-dns-manual-mode-enough-go-ahead-please` diff --git a/act b/act new file mode 100644 index 00000000..1ef4de62 --- /dev/null +++ b/act @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# act + +> Execute GitHub Actions locally using Docker. +> More information: . + +- [l]ist the available jobs: + +`act -l` + +- Run the default event: + +`act` + +- Run a specific event: + +`act {{event_type}}` + +- Run a specific [j]ob: + +`act -j {{job_id}}` + +- Do [n]ot actually run the actions (i.e. a dry run): + +`act -n` + +- Show [v]erbose logs: + +`act -v` + +- Run a specific [W]orkflow with the push event: + +`act push -W {{path/to/workflow}}` diff --git a/acyclic b/acyclic new file mode 100644 index 00000000..19a833d1 --- /dev/null +++ b/acyclic @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# acyclic + +> Make a directed graph acyclic by reversing some edges. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Make a directed graph acyclic by reversing some edges: + +`acyclic {{path/to/input.gv}} > {{path/to/output.gv}}` + +- Print if a graph is acyclic, has a cycle, or is undirected, producing no output graph: + +`acyclic -v -n {{path/to/input.gv}}` + +- Display help: + +`acyclic -?` diff --git a/adb b/adb new file mode 100644 index 00000000..72ef0752 --- /dev/null +++ b/adb @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb + +> Android Debug Bridge: communicate with an Android emulator instance or connected Android devices. +> Some subcommands such as `adb shell` have their own usage documentation. +> More information: . + +- Check whether the adb server process is running and start it: + +`adb start-server` + +- Terminate the adb server process: + +`adb kill-server` + +- Start a remote shell in the target emulator/device instance: + +`adb shell` + +- Push an Android application to an emulator/device: + +`adb install -r {{path/to/file.apk}}` + +- Copy a file/directory from the target device: + +`adb pull {{path/to/device_file_or_directory}} {{path/to/local_destination_directory}}` + +- Copy a file/directory to the target device: + +`adb push {{path/to/local_file_or_directory}} {{path/to/device_destination_directory}}` + +- List all connected devices: + +`adb devices` diff --git a/adb-install b/adb-install new file mode 100644 index 00000000..c2f65710 --- /dev/null +++ b/adb-install @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb install + +> Android Debug Bridge Install: push packages to an Android emulator instance or connected Android devices. +> More information: . + +- Push an Android application to an emulator/device: + +`adb install {{path/to/file.apk}}` + +- Push an Android application to a specific emulator/device (overrides `$ANDROID_SERIAL`): + +`adb -s {{serial_number}} install {{path/to/file.apk}}` + +- [r]einstall an existing app, keeping its data: + +`adb install -r {{path/to/file.apk}}` + +- Push an Android application allowing version code [d]owngrade (debuggable packages only): + +`adb install -d {{path/to/file.apk}}` + +- [g]rant all permissions listed in the app manifest: + +`adb install -g {{path/to/file.apk}}` + +- Quickly update an installed package by only updating the parts of the APK that changed: + +`adb install --fastdeploy {{path/to/file.apk}}` diff --git a/adb-logcat b/adb-logcat new file mode 100644 index 00000000..5efb690d --- /dev/null +++ b/adb-logcat @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb logcat + +> Dump a log of system messages. +> More information: . + +- Display system logs: + +`adb logcat` + +- Display lines that match a regular [e]xpression: + +`adb logcat -e {{regular_expression}}` + +- Display logs for a tag in a specific mode ([V]erbose, [D]ebug, [I]nfo, [W]arning, [E]rror, [F]atal, [S]ilent), filtering other tags: + +`adb logcat {{tag}}:{{mode}} *:S` + +- Display logs for React Native applications in [V]erbose mode [S]ilencing other tags: + +`adb logcat ReactNative:V ReactNativeJS:V *:S` + +- Display logs for all tags with priority level [W]arning and higher: + +`adb logcat *:W` + +- Display logs for a specific PID: + +`adb logcat --pid={{pid}}` + +- Display logs for the process of a specific package: + +`adb logcat --pid=$(adb shell pidof -s {{package}})` + +- Color the log (usually use with filters): + +`adb logcat -v color` diff --git a/adb-reverse b/adb-reverse new file mode 100644 index 00000000..cde94953 --- /dev/null +++ b/adb-reverse @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb reverse + +> Android Debug Bridge Reverse: reverse socket connections from an Android emulator instance or connected Android devices. +> More information: . + +- List all reverse socket connections from emulators and devices: + +`adb reverse --list` + +- Reverse a TCP port from an emulator or device to localhost: + +`adb reverse tcp:{{remote_port}} tcp:{{local_port}}` + +- Remove a reverse socket connections from an emulator or device: + +`adb reverse --remove tcp:{{remote_port}}` + +- Remove all reverse socket connections from all emulators and devices: + +`adb reverse --remove-all` diff --git a/adb-shell b/adb-shell new file mode 100644 index 00000000..0b42266b --- /dev/null +++ b/adb-shell @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb shell + +> Android Debug Bridge Shell: run remote shell commands on an Android emulator instance or connected Android devices. +> More information: . + +- Start a remote interactive shell on the emulator or device: + +`adb shell` + +- Get all the properties from emulator or device: + +`adb shell getprop` + +- Revert all runtime permissions to their default: + +`adb shell pm reset-permissions` + +- Revoke a dangerous permission for an application: + +`adb shell pm revoke {{package}} {{permission}}` + +- Trigger a key event: + +`adb shell input keyevent {{keycode}}` + +- Clear the data of an application on an emulator or device: + +`adb shell pm clear {{package}}` + +- Start an activity on emulator or device: + +`adb shell am start -n {{package}}/{{activity}}` + +- Start the home activity on an emulator or device: + +`adb shell am start -W -c android.intent.category.HOME -a android.intent.action.MAIN` diff --git a/adguardhome b/adguardhome new file mode 100644 index 00000000..c0cb9bc1 --- /dev/null +++ b/adguardhome @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# AdGuardHome + +> A network-wide software for blocking ads & tracking. +> More information: . + +- Run AdGuard Home: + +`AdGuardHome` + +- Specify a configuration file: + +`AdGuardHome --config {{path/to/AdGuardHome.yaml}}` + +- Store the data in a specific work directory: + +`AdGuardHome --work-dir {{path/to/directory}}` + +- Install or uninstall AdGuard Home as a service: + +`AdGuardHome --service {{install|uninstall}}` + +- Start the AdGuard Home service: + +`AdGuardHome --service start` + +- Reload the configuration for the AdGuard Home service: + +`AdGuardHome --service reload` + +- Stop or restart the AdGuard Home service: + +`AdGuardHome --service {{stop|restart}}` diff --git a/adscript b/adscript new file mode 100644 index 00000000..ecaa7554 --- /dev/null +++ b/adscript @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adscript + +> Compiler for Adscript files. +> More information: . + +- Compile a file to an object file: + +`adscript --output {{path/to/file.o}} {{path/to/input_file.adscript}}` + +- Compile and link a file to a standalone executable: + +`adscript --executable --output {{path/to/file}} {{path/to/input_file.adscript}}` + +- Compile a file to LLVM IR instead of native machine code: + +`adscript --llvm-ir --output {{path/to/file.ll}} {{path/to/input_file.adscript}}` + +- Cross-compile a file to an object file for a foreign CPU architecture or operating system: + +`adscript --target-triple {{i386-linux-elf}} --output {{path/to/file.o}} {{path/to/input_file.adscript}}` diff --git a/afconvert b/afconvert new file mode 100644 index 00000000..4df58909 --- /dev/null +++ b/afconvert @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# afconvert + +> Convert between AFF and raw file formats. +> More information: . + +- Use a specific extension (default: `aff`): + +`afconvert -a {{extension}} {{path/to/input_file}} {{path/to/output_file1 path/to/output_file2 ...}}` + +- Use a specific compression level (default: `7`): + +`afconvert -X{{0..7}} {{path/to/input_file}} {{path/to/output_file1 path/to/output_file2 ...}}` diff --git a/ag b/ag new file mode 100644 index 00000000..7236d020 --- /dev/null +++ b/ag @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ag + +> The Silver Searcher. Like `ack`, but aims to be faster. +> More information: . + +- Find files containing "foo", and print the line matches in context: + +`ag {{foo}}` + +- Find files containing "foo" in a specific directory: + +`ag {{foo}} {{path/to/directory}}` + +- Find files containing "foo", but only [l]ist the filenames: + +`ag -l {{foo}}` + +- Find files containing "FOO" case-[i]nsensitively, and print [o]nly the match, rather than the whole line: + +`ag -i -o {{FOO}}` + +- Find "foo" in files with a name matching "bar": + +`ag {{foo}} -G {{bar}}` + +- Find files whose contents match a regular expression: + +`ag '{{^ba(r|z)$}}'` + +- Find files with a name matching "foo": + +`ag -g {{foo}}` diff --git a/agate b/agate new file mode 100644 index 00000000..bee909c8 --- /dev/null +++ b/agate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# agate + +> A simple server for the Gemini network protocol. +> More information: . + +- 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}}` + +- Run server: + +`agate {{path/to/file}}` + +- Display help: + +`agate -h` diff --git a/age b/age new file mode 100644 index 00000000..65f8b2d5 --- /dev/null +++ b/age @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# age + +> A simple, modern and secure file encryption tool. +> See `age-keygen` for how to generate key pairs. +> More information: . + +- Generate an encrypted file that can be decrypted with a passphrase: + +`age --passphrase --output {{path/to/encrypted_file}} {{path/to/unencrypted_file}}` + +- Encrypt a file with one or more public keys entered as literals (repeat the `--recipient` flag to specify multiple public keys): + +`age --recipient {{public_key}} --output {{path/to/encrypted_file}} {{path/to/unencrypted_file}}` + +- Encrypt a file to one or more recipients with their public keys specified in a file (one per line): + +`age --recipients-file {{path/to/recipients_file}} --output {{path/to/encrypted_file}} {{path/to/unencrypted_file}}` + +- Decrypt a file with a passphrase: + +`age --decrypt --output {{path/to/decrypted_file}} {{path/to/encrypted_file}}` + +- Decrypt a file with a private key file: + +`age --decrypt --identity {{path/to/private_key_file}} --output {{path/to/decrypted_file}} {{path/to/encrypted_file}}` diff --git a/age-keygen b/age-keygen new file mode 100644 index 00000000..7181609d --- /dev/null +++ b/age-keygen @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# age-keygen + +> Generate `age` key pairs. +> See `age` for how to encrypt/decrypt files. +> More information: . + +- Generate a key pair, save it to an unencrypted file, and print the public key to `stdout`: + +`age-keygen --output {{path/to/file}}` + +- Convert an identit[y] to a recipient and print the public key to `stdout`: + +`age-keygen -y {{path/to/file}}` diff --git a/aircrack-ng b/aircrack-ng new file mode 100644 index 00000000..f1a2ec20 --- /dev/null +++ b/aircrack-ng @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aircrack-ng + +> Crack WEP and WPA/WPA2 keys from handshake in captured packets. +> Part of Aircrack-ng network software suite. +> More information: . + +- Crack key from capture file using [w]ordlist: + +`aircrack-ng -w {{path/to/wordlist.txt}} {{path/to/capture.cap}}` + +- Crack key from capture file using [w]ordlist and the access point's [e]ssid: + +`aircrack-ng -w {{path/to/wordlist.txt}} -e {{essid}} {{path/to/capture.cap}}` + +- Crack key from capture file using [w]ordlist and the access point's MAC address: + +`aircrack-ng -w {{path/to/wordlist.txt}} --bssid {{mac}} {{path/to/capture.cap}}` diff --git a/airdecap-ng b/airdecap-ng new file mode 100644 index 00000000..23f58320 --- /dev/null +++ b/airdecap-ng @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# airdecap-ng + +> Decrypt a WEP, WPA, or WPA2 encrypted capture file. +> Part of Aircrack-ng network software suite. +> More information: . + +- Remove wireless headers from an open network capture file and use the access point's MAC address to filter: + +`airdecap-ng -b {{ap_mac}} {{path/to/capture.cap}}` + +- Decrypt a [w]EP encrypted capture file using the key in hex format: + +`airdecap-ng -w {{hex_key}} {{path/to/capture.cap}}` + +- Decrypt a WPA/WPA2 encrypted capture file using the access point's [e]ssid and [p]assword: + +`airdecap-ng -e {{essid}} -p {{password}} {{path/to/capture.cap}}` + +- Decrypt a WPA/WPA2 encrypted capture file preserving the headers using the access point's [e]ssid and [p]assword: + +`airdecap-ng -l -e {{essid}} -p {{password}} {{path/to/capture.cap}}` + +- Decrypt a WPA/WPA2 encrypted capture file using the access point's [e]ssid and [p]assword and use its MAC address to filter: + +`airdecap-ng -b {{ap_mac}} -e {{essid}} -p {{password}} {{path/to/capture.cap}}` diff --git a/aireplay-ng b/aireplay-ng new file mode 100644 index 00000000..e14eef76 --- /dev/null +++ b/aireplay-ng @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aireplay-ng + +> Inject packets into a wireless network. +> Part of `aircrack-ng`. +> More information: . + +- Send a specific number of disassociate packets given an access point's MAC address, a client's MAC address and an interface: + +`sudo aireplay-ng --deauth {{count}} --bssid {{ap_mac}} --dmac {{client_mac}} {{interface}}` diff --git a/airmon-ng b/airmon-ng new file mode 100644 index 00000000..4acb8ce2 --- /dev/null +++ b/airmon-ng @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# airmon-ng + +> Activate monitor mode on wireless network devices. +> Part of `aircrack-ng`. +> More information: . + +- List wireless devices and their statuses: + +`sudo airmon-ng` + +- Turn on monitor mode for a specific device: + +`sudo airmon-ng start {{wlan0}}` + +- Kill disturbing processes that use wireless devices: + +`sudo airmon-ng check kill` + +- Turn off monitor mode for a specific network interface: + +`sudo airmon-ng stop {{wlan0mon}}` diff --git a/airodump-ng b/airodump-ng new file mode 100644 index 00000000..71fa157e --- /dev/null +++ b/airodump-ng @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# airodump-ng + +> Capture packets and display information about wireless networks. +> Part of `aircrack-ng`. +> More information: . + +- Capture packets and display information about a wireless network: + +`sudo airodump-ng {{interface}}` + +- Capture packets and display information about a wireless network given the MAC address and channel, and save the output to a file: + +`sudo airodump-ng --channel {{channel}} --write {{path/to/file}} --bssid {{mac}} {{interface}}` diff --git a/airpaste b/airpaste new file mode 100644 index 00000000..69248467 --- /dev/null +++ b/airpaste @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# airpaste + +> Share messages and files on the same network using mDNS. +> More information: . + +- Wait for a message and display it when received: + +`airpaste` + +- Send text: + +`echo {{text}} | airpaste` + +- Send a file: + +`airpaste < {{path/to/file}}` + +- Receive a file: + +`airpaste > {{path/to/file}}` + +- Create or join a channel: + +`airpaste {{channel_name}}` diff --git a/airshare b/airshare new file mode 100644 index 00000000..9c3935d3 --- /dev/null +++ b/airshare @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# airshare + +> Transfer data between two machines in a local network. +> More information: . + +- Share files or directories: + +`airshare {{code}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Receive a file: + +`airshare {{code}}` + +- Host a receiving server (use this to be able to upload files using the web interface): + +`airshare --upload {{code}}` + +- Send files or directories to a receiving server: + +`airshare --upload {{code}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Send files whose paths have been copied to the clipboard: + +`airshare --file-path {{code}}` + +- Receive a file and copy it to the clipboard: + +`airshare --clip-receive {{code}}` diff --git a/ajson b/ajson new file mode 100644 index 00000000..f4fec29d --- /dev/null +++ b/ajson @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ajson + +> Executes JSONPath on JSON objects. +> More information: . + +- Read JSON from a file and execute a specified JSONPath expression: + +`ajson '{{$..json[?(@.path)]}}' {{path/to/file.json}}` + +- Read JSON from `stdin` and execute a specified JSONPath expression: + +`cat {{path/to/file.json}} | ajson '{{$..json[?(@.path)]}}'` + +- Read JSON from a URL and evaluate a specified JSONPath expression: + +`ajson '{{avg($..price)}}' '{{https://example.com/api/}}'` + +- Read some simple JSON and calculate a value: + +`echo '{{3}}' | ajson '{{2 * pi * $}}'` diff --git a/alacritty b/alacritty new file mode 100644 index 00000000..fc59517e --- /dev/null +++ b/alacritty @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# alacritty + +> Cross-platform, GPU-accelerated terminal emulator. +> More information: . + +- Open a new Alacritty window: + +`alacritty` + +- Run in a specific directory: + +`alacritty --working-directory {{path/to/directory}}` + +- [e]xecute a command in a new Alacritty window: + +`alacritty -e {{command}}` + +- Use an alternative configuration file (defaults to `$XDG_CONFIG_HOME/alacritty/alacritty.yml`): + +`alacritty --config-file {{path/to/config.yml}}` + +- Run with live configuration reload enabled (can also be enabled by default in `alacritty.yml`): + +`alacritty --live-config-reload --config-file {{path/to/config.yml}}` diff --git a/alex b/alex new file mode 100644 index 00000000..e36f314f --- /dev/null +++ b/alex @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# alex + +> Catch insensitive, inconsiderate writing. +> It helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing in text. +> More information: . + +- Analyze text from `stdin`: + +`echo {{His network looks good}} | alex --stdin` + +- Analyze all files in the current directory: + +`alex` + +- Analyze a specific file: + +`alex {{path/to/file.md}}` + +- Analyze all Markdown files except `example.md`: + +`alex *.md !{{example.md}}` diff --git a/alias b/alias new file mode 100644 index 00000000..79272c1d --- /dev/null +++ b/alias @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# alias + +> Creates aliases -- words that are replaced by a command string. +> Aliases expire with the current shell session unless defined in the shell's configuration file, e.g. `~/.bashrc`. +> More information: . + +- List all aliases: + +`alias` + +- Create a generic alias: + +`alias {{word}}="{{command}}"` + +- View the command associated to a given alias: + +`alias {{word}}` + +- Remove an aliased command: + +`unalias {{word}}` + +- Turn `rm` into an interactive command: + +`alias {{rm}}="{{rm --interactive}}"` + +- Create `la` as a shortcut for `ls --all`: + +`alias {{la}}="{{ls --all}}"` diff --git a/amass b/amass new file mode 100644 index 00000000..e71d6bc9 --- /dev/null +++ b/amass @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# amass + +> In-depth Attack Surface Mapping and Asset Discovery tool. +> Some subcommands such as `amass db` have their own usage documentation. +> More information: . + +- Execute an Amass subcommand: + +`amass {{subcommand}}` + +- Display help: + +`amass -help` + +- Display help on an Amass subcommand (like `intel`, `enum`, etc.): + +`amass -help {{subcommand}}` + +- Display version: + +`amass -version` diff --git a/amass-db b/amass-db new file mode 100644 index 00000000..c4a64eb8 --- /dev/null +++ b/amass-db @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# amass db + +> Interact with an Amass database. +> More information: . + +- List all performed enumerations in the database: + +`amass db -dir {{path/to/database_directory}} -list` + +- Show results for a specified enumeration index and [d]omain name: + +`amass db -dir {{path/to/database_directory}} -d {{domain_name}} -enum {{index_from_list}} -show` + +- List all found subdomains of a [d]omain within an enumeration: + +`amass db -dir {{path/to/database_directory}} -d {{domain_name}} -enum {{index_from_list}} -names` + +- Show a summary of the found subdomains within an enumeration: + +`amass db -dir {{path/to/database_directory}} -d {{domain_name}} -enum {{index_from_list}} -summary` diff --git a/amass-enum b/amass-enum new file mode 100644 index 00000000..1491e72e --- /dev/null +++ b/amass-enum @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# amass enum + +> Find subdomains of a domain. +> More information: . + +- Passively find subdomains of a [d]omain: + +`amass enum -passive -d {{domain_name}}` + +- Find subdomains of a [d]omain and actively verify them attempting to resolve the found subdomains: + +`amass enum -active -d {{domain_name}} -p {{80,443,8080}}` + +- Do a brute force search for subdomains: + +`amass enum -brute -d {{domain_name}}` + +- Save the results to a text file: + +`amass enum -o {{output_file}} -d {{domain_name}}` + +- Save the results to a database: + +`amass enum -o {{output_file}} -dir {{path/to/database_directory}}` diff --git a/amass-intel b/amass-intel new file mode 100644 index 00000000..46aecac1 --- /dev/null +++ b/amass-intel @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# amass intel + +> Collect open source intel on an organisation like root domains and ASNs. +> More information: . + +- Find root domains in an IP address range: + +`amass intel -addr {{192.168.0.1-254}}` + +- Use active recon methods: + +`amass intel -active -addr {{192.168.0.1-254}}` + +- Find root domains related to a [d]omain: + +`amass intel -whois -d {{domain_name}}` + +- Find ASNs belonging to an organisation: + +`amass intel -org {{organisation_name}}` + +- Find root domains belonging to a given Autonomous System Number: + +`amass intel -asn {{asn}}` + +- Save results to a text file: + +`amass intel -o {{output_file}} -whois -d {{domain_name}}` diff --git a/androguard b/androguard new file mode 100644 index 00000000..63476383 --- /dev/null +++ b/androguard @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# androguard + +> Reverse engineer Android applications. Written in Python. +> More information: . + +- Display Android app manifest: + +`androguard axml {{path/to/app.apk}}` + +- Display app metadata (version and app ID): + +`androguard apkid {{path/to/app.apk}}` + +- Decompile Java code from an app: + +`androguard decompile {{path/to/app.apk}} --output {{path/to/directory}}` diff --git a/android/am b/android/am new file mode 100644 index 00000000..5f036d57 --- /dev/null +++ b/android/am @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# am + +> Android activity manager. +> More information: . + +- Start the activity with a specific component and package [n]ame: + +`am start -n {{com.android.settings/.Settings}}` + +- Start an intent [a]ction and pass [d]ata to it: + +`am start -a {{android.intent.action.VIEW}} -d {{tel:123}}` + +- Start an activity matching a specific action and [c]ategory: + +`am start -a {{android.intent.action.MAIN}} -c {{android.intent.category.HOME}}` + +- Convert an intent to a URI: + +`am to-uri -a {{android.intent.action.VIEW}} -d {{tel:123}}` diff --git a/android/bugreport b/android/bugreport new file mode 100644 index 00000000..dd2501a2 --- /dev/null +++ b/android/bugreport @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# bugreport + +> Show an Android bug report. +> This command can only be used through `adb shell`. +> More information: . + +- Display a complete bug report of an Android device: + +`bugreport` diff --git a/android/bugreportz b/android/bugreportz new file mode 100644 index 00000000..859457bf --- /dev/null +++ b/android/bugreportz @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# bugreportz + +> Generate a zipped Android bug report. +> This command can only be used through `adb shell`. +> More information: . + +- Generate a complete zipped bug report of an Android device: + +`bugreportz` + +- Show the progress of a running `bugreportz` operation: + +`bugreportz -p` + +- Display help: + +`bugreportz -h` + +- Display version: + +`bugreportz -v` diff --git a/android/cmd b/android/cmd new file mode 100644 index 00000000..e901e69a --- /dev/null +++ b/android/cmd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# cmd + +> Android service manager. +> More information: . + +- [l]ist all running services: + +`cmd -l` + +- Call a specific service: + +`cmd {{service}}` + +- Call a service with specific arguments: + +`cmd {{service}} {{argument1 argument2 ...}}` diff --git a/android/dalvikvm b/android/dalvikvm new file mode 100644 index 00000000..6b958b29 --- /dev/null +++ b/android/dalvikvm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# dalvikvm + +> Android Java virtual machine. +> More information: . + +- Start a specific Java program: + +`dalvikvm -classpath {{path/to/file.jar}} {{classname}}` diff --git a/android/dumpsys b/android/dumpsys new file mode 100644 index 00000000..39be944d --- /dev/null +++ b/android/dumpsys @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# dumpsys + +> Provide information about Android system services. +> This command can only be used through `adb shell`. +> More information: . + +- Get diagnostic output for all system services: + +`dumpsys` + +- Get diagnostic output for a specific system service: + +`dumpsys {{service}}` + +- List all services `dumpsys` can give information about: + +`dumpsys -l` + +- List service-specific arguments for a service: + +`dumpsys {{service}} -h` + +- Exclude a specific service from the diagnostic output: + +`dumpsys --skip {{service}}` + +- Specify a [t]imeout period in seconds (defaults to 10s): + +`dumpsys -t {{8}}` diff --git a/android/getprop b/android/getprop new file mode 100644 index 00000000..db1a196b --- /dev/null +++ b/android/getprop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# getprop + +> Show information about Android system properties. +> More information: . + +- Display information about Android system properties: + +`getprop` + +- Display information about a specific property: + +`getprop {{property}}` + +- Display the SDK API level: + +`getprop {{ro.build.version.sdk}}` + +- Display the Android version: + +`getprop {{ro.build.version.release}}` + +- Display the Android device model: + +`getprop {{ro.vendor.product.model}}` + +- Display the OEM unlock status: + +`getprop {{ro.oem_unlock_supported}}` + +- Display the MAC address of the Android's Wi-Fi card: + +`getprop {{ro.boot.wifimacaddr}}` diff --git a/android/input b/android/input new file mode 100644 index 00000000..759ce1ef --- /dev/null +++ b/android/input @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# input + +> Send event codes or touchscreen gestures to an Android device. +> This command can only be used through `adb shell`. +> More information: . + +- Send an event code for a single character to an Android device: + +`input keyevent {{event_code}}` + +- Send a text to an Android device (`%s` represents spaces): + +`input text "{{text}}"` + +- Send a single tap to an Android device: + +`input tap {{x_position}} {{y_position}}` + +- Send a swipe gesture to an Android device: + +`input swipe {{x_start}} {{y_start}} {{x_end}} {{y_end}} {{duration_in_ms}}` + +- Send a long press to an Android device using a swipe gesture: + +`input swipe {{x_position}} {{y_position}} {{x_position}} {{y_position}} {{duration_in_ms}}` diff --git a/android/logcat b/android/logcat new file mode 100644 index 00000000..820c3afe --- /dev/null +++ b/android/logcat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# logcat + +> Dump a log of system messages, including stack traces when an error occurred, and information messages logged by applications. +> More information: . + +- Display system logs: + +`logcat` + +- Write system logs to a [f]ile: + +`logcat -f {{path/to/file}}` + +- Display lines that match a regular expression: + +`logcat --regex {{regular_expression}}` + +- Display logs for a specific PID: + +`logcat --pid={{pid}}` + +- Display logs for the process of a specific package: + +`logcat --pid=$(pidof -s {{package}})` diff --git a/android/pkg b/android/pkg new file mode 100644 index 00000000..4cae9a70 --- /dev/null +++ b/android/pkg @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg + +> Package management utility for Termux. +> More information: . + +- Upgrade all installed packages: + +`pkg upgrade` + +- Install a package: + +`pkg install {{package}}` + +- Uninstall a package: + +`pkg uninstall {{package}}` + +- Reinstall a package: + +`pkg reinstall {{package}}` + +- Search for a package: + +`pkg search {{package}}` diff --git a/android/pm b/android/pm new file mode 100644 index 00000000..11b3ddf8 --- /dev/null +++ b/android/pm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# pm + +> Display information about apps on an Android device. +> More information: . + +- List all installed apps: + +`pm list packages` + +- List all installed [s]ystem apps: + +`pm list packages -s` + +- List all installed [3]rd-party apps: + +`pm list packages -3` + +- List apps matching specific keywords: + +`pm list packages {{keyword1 keyword2 ...}}` + +- Display a path of the APK of a specific app: + +`pm path {{app}}` diff --git a/android/screencap b/android/screencap new file mode 100644 index 00000000..2eb6bdfa --- /dev/null +++ b/android/screencap @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# screencap + +> Take a screenshot of a mobile display. +> This command can only be used through `adb shell`. +> More information: . + +- Take a screenshot: + +`screencap {{path/to/file}}` diff --git a/android/settings b/android/settings new file mode 100644 index 00000000..0d738e1d --- /dev/null +++ b/android/settings @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# settings + +> Get information about the Android OS. +> More information: . + +- List the settings in the `global` namespace: + +`settings list {{global}}` + +- Get a value of a specific setting: + +`settings get {{global}} {{airplane_mode_on}}` + +- Set a specific value of a setting: + +`settings put {{system}} {{screen_brightness}} {{42}}` + +- Delete a specific setting: + +`settings delete {{secure}} {{screensaver_enabled}}` diff --git a/android/wm b/android/wm new file mode 100644 index 00000000..990cf560 --- /dev/null +++ b/android/wm @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, android] +source: https://github.com/tldr-pages/tldr.git +--- +# wm + +> Show information about the screen of an Android device. +> This command can only be used through `adb shell`. +> More information: . + +- Display the physical size of an Android device's screen: + +`wm {{size}}` + +- Display the physical density of an Android device's screen: + +`wm {{density}}` diff --git a/ani-cli b/ani-cli new file mode 100644 index 00000000..371c19fd --- /dev/null +++ b/ani-cli @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ani-cli + +> A cli to browse and watch anime. +> More information: . + +- Search anime by name: + +`ani-cli "{{anime_name}}"` + +- [d]ownload episode: + +`ani-cli -d "{{anime_name}}"` + +- Use [v]LC as the media player: + +`ani-cli -v "{{anime_name}}"` + +- Watch a specific [e]pisode: + +`ani-cli -e {{episode_number}} "{{anime_name}}"` + +- [c]ontinue watching anime from history: + +`ani-cli -c` + +- [U]pdate `ani-cli`: + +`ani-cli -U` diff --git a/anki b/anki new file mode 100644 index 00000000..4a518e64 --- /dev/null +++ b/anki @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# anki + +> Powerful, intelligent flashcard program. +> More information: . + +- Launch the GUI: + +`anki` + +- Use a specific [p]rofile: + +`anki -p {{profile_name}}` + +- Use a specific [l]anguage: + +`anki -l {{language}}` + +- Use a non-default directory (`~/Anki` for default): + +`anki -b {{path/to/directory}}` diff --git a/ansible b/ansible new file mode 100644 index 00000000..a510ba0a --- /dev/null +++ b/ansible @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible + +> Manage groups of computers remotely over SSH. (use the `/etc/ansible/hosts` file to add new groups/hosts). +> Some subcommands such as `ansible galaxy` have their own usage documentation. +> More information: . + +- List hosts belonging to a group: + +`ansible {{group}} --list-hosts` + +- Ping a group of hosts by invoking the ping [m]odule: + +`ansible {{group}} -m ping` + +- Display facts about a group of hosts by invoking the setup [m]odule: + +`ansible {{group}} -m setup` + +- Execute a command on a group of hosts by invoking command module with arguments: + +`ansible {{group}} -m command -a '{{my_command}}'` + +- Execute a command with administrative privileges: + +`ansible {{group}} --become --ask-become-pass -m command -a '{{my_command}}'` + +- Execute a command using a custom inventory file: + +`ansible {{group}} -i {{inventory_file}} -m command -a '{{my_command}}'` + +- List the groups in an inventory: + +`ansible localhost -m debug -a '{{var=groups.keys()}}'` diff --git a/ansible-doc b/ansible-doc new file mode 100644 index 00000000..41bf1060 --- /dev/null +++ b/ansible-doc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-doc + +> Display information on modules installed in Ansible libraries. +> Display a terse listing of plugins and their short descriptions. +> More information: . + +- List available action plugins (modules): + +`ansible-doc --list` + +- List available plugins of a specific type: + +`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} --list` + +- Show information about a specific action plugin (module): + +`ansible-doc {{plugin_name}}` + +- Show information about a plugin with a specific type: + +`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}` + +- Show the playbook snippet for action plugin (modules): + +`ansible-doc --snippet {{plugin_name}}` + +- Show information about an action plugin (module) as JSON: + +`ansible-doc --json {{plugin_name}}` diff --git a/ansible-galaxy b/ansible-galaxy new file mode 100644 index 00000000..b07df3df --- /dev/null +++ b/ansible-galaxy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-galaxy + +> Create and manage Ansible roles. +> More information: . + +- Install a role: + +`ansible-galaxy install {{username}}.{{role_name}}` + +- Remove a role: + +`ansible-galaxy remove {{username}}.{{role_name}}` + +- List installed roles: + +`ansible-galaxy list` + +- Search for a given role: + +`ansible-galaxy search {{role_name}}` + +- Create a new role: + +`ansible-galaxy init {{role_name}}` + +- Get information about a user role: + +`ansible-galaxy role info {{username}}.{{role_name}}` + +- Get information about a collection: + +`ansible-galaxy collection info {{username}}.{{collection_name}}` diff --git a/ansible-inventory b/ansible-inventory new file mode 100644 index 00000000..15e9817e --- /dev/null +++ b/ansible-inventory @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-inventory + +> Display or dump an Ansible inventory. +> See also: `ansible`. +> More information: . + +- Display the default inventory: + +`ansible-inventory --list` + +- Display a custom inventory: + +`ansible-inventory --list --inventory {{path/to/file_or_script_or_directory}}` + +- Display the default inventory in YAML: + +`ansible-inventory --list --yaml` + +- Dump the default inventory to a file: + +`ansible-inventory --list --output {{path/to/file}}` diff --git a/ansible-playbook b/ansible-playbook new file mode 100644 index 00000000..378f1683 --- /dev/null +++ b/ansible-playbook @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-playbook + +> Execute tasks defined in playbook on remote machines over SSH. +> More information: . + +- Run tasks in playbook: + +`ansible-playbook {{playbook}}` + +- Run tasks in playbook with custom host [i]nventory: + +`ansible-playbook {{playbook}} -i {{inventory_file}}` + +- Run tasks in playbook with [e]xtra variables defined via the command-line: + +`ansible-playbook {{playbook}} -e "{{variable1}}={{value1}} {{variable2}}={{value2}}"` + +- Run tasks in playbook with [e]xtra variables defined in a JSON file: + +`ansible-playbook {{playbook}} -e "@{{variables.json}}"` + +- Run tasks in playbook for the given tags: + +`ansible-playbook {{playbook}} --tags {{tag1,tag2}}` + +- Run tasks in a playbook starting at a specific task: + +`ansible-playbook {{playbook}} --start-at {{task_name}}` diff --git a/ansible-pull b/ansible-pull new file mode 100644 index 00000000..da6bc27f --- /dev/null +++ b/ansible-pull @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-pull + +> Pull ansible playbooks from a VCS repo and executes them for the local host. +> More information: . + +- Pull a playbook from a VCS and execute a default local.yml playbook: + +`ansible-pull -U {{repository_url}}` + +- Pull a playbook from a VCS and execute a specific playbook: + +`ansible-pull -U {{repository_url}} {{playbook}}` + +- Pull a playbook from a VCS at a specific branch and execute a specific playbook: + +`ansible-pull -U {{repository_url}} -C {{branch}} {{playbook}}` + +- Pull a playbook from a VCS, specify hosts file and execute a specific playbook: + +`ansible-pull -U {{repository_url}} -i {{hosts_file}} {{playbook}}` diff --git a/ansible-vault b/ansible-vault new file mode 100644 index 00000000..ccdb7a76 --- /dev/null +++ b/ansible-vault @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansible-vault + +> Encrypts & decrypts values, data structures and files within Ansible projects. +> More information: . + +- Create a new encrypted vault file with a prompt for a password: + +`ansible-vault create {{vault_file}}` + +- Create a new encrypted vault file using a vault key file to encrypt it: + +`ansible-vault create --vault-password-file={{password_file}} {{vault_file}}` + +- Encrypt an existing file using an optional password file: + +`ansible-vault encrypt --vault-password-file={{password_file}} {{vault_file}}` + +- Encrypt a string using Ansible's encrypted string format, displaying interactive prompts: + +`ansible-vault encrypt_string` + +- View an encrypted file, using a password file to decrypt: + +`ansible-vault view --vault-password-file={{password_file}} {{vault_file}}` + +- Re-key already encrypted vault file with a new password file: + +`ansible-vault rekey --vault-password-file={{old_password_file}} --new-vault-password-file={{new_password_file}} {{vault_file}}` diff --git a/ansiweather b/ansiweather new file mode 100644 index 00000000..bbc8b2ce --- /dev/null +++ b/ansiweather @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ansiweather + +> A shell script for displaying the current weather conditions in your terminal. +> More information: . + +- Display a [f]orecast using metric [u]nits for the next seven days for a specific [l]ocation: + +`ansiweather -u metric -f 7 -l {{Rzeszow,PL}}` + +- Display a [F]orecast for the next five days showing [s]ymbols and [d]aylight data for your current location: + +`ansiweather -F -s true -d true` + +- Display today's [w]ind and [h]umidity data for your current location: + +`ansiweather -w true -h true` diff --git a/ant b/ant new file mode 100644 index 00000000..4d678665 --- /dev/null +++ b/ant @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ant + +> Apache Ant: build and manage Java-based projects. +> More information: . + +- Build a project with default build file `build.xml`: + +`ant` + +- Build a project using build [f]ile other than `build.xml`: + +`ant -f {{buildfile.xml}}` + +- Print information on possible targets for this project: + +`ant -p` + +- Print debugging information: + +`ant -d` + +- Execute all targets that do not depend on fail target(s): + +`ant -k` diff --git a/antibody b/antibody new file mode 100644 index 00000000..5cbbc70f --- /dev/null +++ b/antibody @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# antibody + +> "The fastest" shell plugin manager. +> More information: . + +- Bundle all plugins for static loading: + +`antibody bundle < {{~/.zsh_plugins.txt}} > {{~/.zsh_plugins.sh}}` + +- Update all bundles: + +`antibody update` + +- List all installed plugins: + +`antibody list` diff --git a/anytopnm b/anytopnm new file mode 100644 index 00000000..3b013bc5 --- /dev/null +++ b/anytopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# anytopnm + +> Converts an arbitrary type of image file to common image formats. +> More information: . + +- Convert an input image to PBM, PGM, or PPM format irrespective of the input type: + +`anytopnm {{path/to/input}} > {{path/to/output.pnm}}` + +- Display version: + +`anytopnm -version` diff --git a/apg b/apg new file mode 100644 index 00000000..f792d256 --- /dev/null +++ b/apg @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# apg + +> Creates arbitrarily complex random passwords. +> More information: . + +- Create random passwords (default password length is 8): + +`apg` + +- Create a password with at least 1 symbol (S), 1 number (N), 1 uppercase (C), 1 lowercase (L): + +`apg -M SNCL` + +- Create a password with 16 characters: + +`apg -m {{16}}` + +- Create a password with maximum length of 16: + +`apg -x {{16}}` + +- Create a password that doesn't appear in a dictionary (the dictionary file has to be provided): + +`apg -r {{path/to/dictionary_file}}` diff --git a/apktool b/apktool new file mode 100644 index 00000000..54b8bab5 --- /dev/null +++ b/apktool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# apktool + +> Reverse engineer APK files. +> More information: . + +- Decode an APK file: + +`apktool d {{path/to/file.apk}}` + +- Build an APK file from a directory: + +`apktool b {{path/to/directory}}` + +- Install and store a framework: + +`apktool if {{path/to/framework.apk}}` diff --git a/apm b/apm new file mode 100644 index 00000000..7ca130ec --- /dev/null +++ b/apm @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# apm + +> Atom editor Package Manager. +> See `atom`. +> More information: . + +- Install a package from or a theme from : + +`apm install {{package}}` + +- Remove a package/theme: + +`apm remove {{package}}` + +- Upgrade a package/theme: + +`apm upgrade {{package}}` diff --git a/apropos b/apropos new file mode 100644 index 00000000..d5b07b8d --- /dev/null +++ b/apropos @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# apropos + +> Search the manual pages for names and descriptions. +> More information: . + +- Search for a keyword using a regular expression: + +`apropos {{regular_expression}}` + +- Search without restricting the output to the terminal width ([l]ong output): + +`apropos -l {{regular_expression}}` + +- Search for pages that match [a]ll the expressions given: + +`apropos {{regular_expression_1}} -a {{regular_expression_2}} -a {{regular_expression_3}}` diff --git a/ar b/ar new file mode 100644 index 00000000..a258c7a7 --- /dev/null +++ b/ar @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ar + +> Create, modify, and extract from Unix archives. Typically used for static libraries (`.a`) and Debian packages (`.deb`). +> See also: `tar`. +> More information: . + +- E[x]tract all members from an archive: + +`ar x {{path/to/file.a}}` + +- Lis[t] contents in a specific archive: + +`ar t {{path/to/file.ar}}` + +- [r]eplace or add specific files to an archive: + +`ar r {{path/to/file.deb}} {{path/to/debian-binary path/to/control.tar.gz path/to/data.tar.xz ...}}` + +- In[s]ert an object file index (equivalent to using `ranlib`): + +`ar s {{path/to/file.a}}` + +- Create an archive with specific files and an accompanying object file index: + +`ar rs {{path/to/file.a}} {{path/to/file1.o path/to/file2.o ...}}` diff --git a/arc b/arc new file mode 100644 index 00000000..98d990d3 --- /dev/null +++ b/arc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arc + +> Arcanist: a CLI for Phabricator. +> More information: . + +- Send the changes to Differential for review: + +`arc diff` + +- Show pending revision information: + +`arc list` + +- Update Git commit messages after review: + +`arc amend` + +- Push Git changes: + +`arc land` diff --git a/arch b/arch new file mode 100644 index 00000000..8d1b6962 --- /dev/null +++ b/arch @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arch + +> Display the name of the system architecture. +> See also `uname`. +> More information: . + +- Display the system's architecture: + +`arch` diff --git a/arduino b/arduino new file mode 100644 index 00000000..b11bb6e3 --- /dev/null +++ b/arduino @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arduino + +> Arduino Studio - Integrated Development Environment for the Arduino platform. +> More information: . + +- Build a sketch: + +`arduino --verify {{path/to/file.ino}}` + +- Build and upload a sketch: + +`arduino --upload {{path/to/file.ino}}` + +- Build and upload a sketch to an Arduino Nano with an Atmega328p CPU, connected on port `/dev/ttyACM0`: + +`arduino --board {{arduino:avr:nano:cpu=atmega328p}} --port {{/dev/ttyACM0}} --upload {{path/to/file.ino}}` + +- Set the preference `name` to a given `value`: + +`arduino --pref {{name}}={{value}}` + +- Build a sketch, put the build results in the build directory, and reuse any previous build results in that directory: + +`arduino --pref build.path={{path/to/build_directory}} --verify {{path/to/file.ino}}` + +- Save any (changed) preferences to `preferences.txt`: + +`arduino --save-prefs` + +- Install the latest SAM board: + +`arduino --install-boards "{{arduino:sam}}"` + +- Install Bridge and Servo libraries: + +`arduino --install-library "{{Bridge:1.0.0,Servo:1.2.0}}"` diff --git a/arduino-builder b/arduino-builder new file mode 100644 index 00000000..549f73a5 --- /dev/null +++ b/arduino-builder @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arduino-builder + +> Compile arduino sketches. +> DEPRECATION WARNING: this tool is being phased out in favor of `arduino`. +> More information: . + +- Compile a sketch: + +`arduino-builder -compile {{path/to/sketch.ino}}` + +- Specify the debug level (default: 5): + +`arduino-builder -debug-level {{1..10}}` + +- Specify a custom build directory: + +`arduino-builder -build-path {{path/to/build_directory}}` + +- Use a build option file, instead of specifying `--hardware`, `--tools`, etc. manually every time: + +`arduino-builder -build-options-file {{path/to/build.options.json}}` + +- Enable verbose mode: + +`arduino-builder -verbose {{true}}` diff --git a/argocd b/argocd new file mode 100644 index 00000000..c37b7295 --- /dev/null +++ b/argocd @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# argocd + +> Command-line interface to control a Argo CD server. +> Some subcommands such as `argocd app` have their own usage documentation. +> More information: . + +- Login to Argo CD server: + +`argocd login --insecure --username {{user}} --password {{password}} {{argocd_server:port}}` + +- List applications: + +`argocd app list` diff --git a/argocd-app b/argocd-app new file mode 100644 index 00000000..e3373ff8 --- /dev/null +++ b/argocd-app @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# argocd app + +> Command-line interface to manage applications by Argo CD. +> More information: . + +- List applications: + +`argocd app list --output {{json|yaml|wide}}` + +- Get application details: + +`argocd app get {{app_name}} --output {{json|yaml|wide}}` + +- Deploy application internally (to the same cluster that Argo CD is running in): + +`argocd app create {{app_name}} --repo {{git_repo_url}} --path {{path/to/repo}} --dest-server https://kubernetes.default.svc --dest-namespace {{ns}}` + +- Delete an application: + +`argocd app delete {{app_name}}` + +- Enable application auto-sync: + +`argocd app set {{app_name}} --sync-policy auto --auto-prune --self-heal` + +- Preview app synchronization without affecting cluster: + +`argocd app sync {{app_name}} --dry-run --prune` + +- Show application deployment history: + +`argocd app history {{app_name}} --output {{wide|id}}` + +- Rollback application to a previous deployed version by history ID (deleting unexpected resources): + +`argocd app rollback {{app_name}} {{history_id}} --prune` diff --git a/argon2 b/argon2 new file mode 100644 index 00000000..4c24a37d --- /dev/null +++ b/argon2 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# argon2 + +> Calculate Argon2 cryptographic hashes. +> More information: . + +- Calculate a hash with a password and a salt with the default parameters: + +`echo "{{password}}" | argon2 "{{salt_text}}"` + +- Calculate a hash with the specified algorithm: + +`echo "{{password}}" | argon2 "{{salt_text}}" -{{d|i|id}}` + +- Display the output hash without additional information: + +`echo "{{password}}" | argon2 "{{salt_text}}" -e` + +- Calculate a hash with given iteration [t]imes, [m]emory usage, and [p]arallelism parameters: + +`echo "{{password}}" | argon2 "{{salt_text}}" -t {{5}} -m {{20}} -p {{7}}` diff --git a/aria2 b/aria2 new file mode 100644 index 00000000..38ce9111 --- /dev/null +++ b/aria2 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aria2 + +> This command is an alias of `aria2c`. + +- View documentation for the updated command: + +`tldr aria2c` diff --git a/aria2c b/aria2c new file mode 100644 index 00000000..075c573f --- /dev/null +++ b/aria2c @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aria2c + +> Fast download utility. +> Supports HTTP(S), FTP, SFTP, BitTorrent, and Metalink. +> More information: . + +- Download a specific URI to a file: + +`aria2c "{{url}}"` + +- Download a file from a URI with a specific output name: + +`aria2c --out={{path/to/file}} "{{url}}"` + +- Download multiple different files in parallel: + +`aria2c --force-sequential {{false}} "{{url1 url2 ...}}"` + +- Download the same file from different mirrors and verify the checksum of the downloaded file: + +`aria2c --checksum={{sha-256}}={{hash}} "{{url1}}" "{{url2}}" "{{urlN}}"` + +- Download the URIs listed in a file with a specific number of parallel downloads: + +`aria2c --input-file={{path/to/file}} --max-concurrent-downloads={{number_of_downloads}}` + +- Download with multiple connections: + +`aria2c --split={{number_of_connections}} "{{url}}"` + +- FTP download with username and password: + +`aria2c --ftp-user={{username}} --ftp-passwd={{password}} "{{url}}"` + +- Limit download speed in bytes/s: + +`aria2c --max-download-limit={{speed}} "{{url}}"` diff --git a/arp b/arp new file mode 100644 index 00000000..25d4d642 --- /dev/null +++ b/arp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arp + +> Show and manipulate your system's ARP cache. +> More information: . + +- Show the current ARP table: + +`arp -a` + +- [d]elete a specific entry: + +`arp -d {{address}}` + +- [s]et up a new entry in the ARP table: + +`arp -s {{address}} {{mac_address}}` diff --git a/arp-scan b/arp-scan new file mode 100644 index 00000000..bc74abe3 --- /dev/null +++ b/arp-scan @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arp-scan + +> Send ARP packets to hosts (specified as IP addresses or hostnames) to scan the local network. +> More information: . + +- Scan the current local network: + +`arp-scan --localnet` + +- Scan an IP network with a custom bitmask: + +`arp-scan {{192.168.1.1}}/{{24}}` + +- Scan an IP network within a custom range: + +`arp-scan {{127.0.0.0}}-{{127.0.0.31}}` + +- Scan an IP network with a custom net mask: + +`arp-scan {{10.0.0.0}}:{{255.255.255.0}}` diff --git a/arping b/arping new file mode 100644 index 00000000..ca19a620 --- /dev/null +++ b/arping @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# arping + +> Discover and probe hosts in a network using the ARP protocol. +> Useful for MAC address discovery. +> More information: . + +- Ping a host by ARP request packets: + +`arping {{host_ip}}` + +- Ping a host on a specific interface: + +`arping -I {{interface}} {{host_ip}}` + +- Ping a host and [f]inish after the first reply: + +`arping -f {{host_ip}}` + +- Ping a host a specific number ([c]ount) of times: + +`arping -c {{count}} {{host_ip}}` + +- Broadcast ARP request packets to update neighbours' ARP caches ([U]nsolicited ARP mode): + +`arping -U {{ip_to_broadcast}}` + +- [D]etect duplicated IP addresses in the network by sending ARP requests with a 3 second timeout: + +`arping -D -w {{3}} {{ip_to_check}}` diff --git a/asar b/asar new file mode 100644 index 00000000..13539797 --- /dev/null +++ b/asar @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# asar + +> A file archiver for the Electron platform. +> More information: . + +- Archive a file or directory: + +`asar pack {{path/to/input_file_or_directory}} {{path/to/output_archive.asar}}` + +- Extract an archive: + +`asar extract {{path/to/archive.asar}}` + +- Extract a specific file from an archive: + +`asar extract-file {{path/to/archive.asar}} {{file}}` + +- List the contents of an archive file: + +`asar list {{path/to/archive.asar}}` diff --git a/asciidoctor b/asciidoctor new file mode 100644 index 00000000..0e834e79 --- /dev/null +++ b/asciidoctor @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# asciidoctor + +> Convert AsciiDoc files to a publishable format. +> More information: . + +- Convert a specific `.adoc` file to HTML (the default output format): + +`asciidoctor {{path/to/file.adoc}}` + +- Convert a specific `.adoc` file to HTML and link a CSS stylesheet: + +`asciidoctor -a stylesheet={{path/to/stylesheet.css}} {{path/to/file.adoc}}` + +- Convert a specific `.adoc` file to embeddable HTML, removing everything except the body: + +`asciidoctor --embedded {{path/to/file.adoc}}` + +- Convert a specific `.adoc` file to a PDF using the `asciidoctor-pdf` library: + +`asciidoctor --backend={{pdf}} --require={{asciidoctor-pdf}} {{path/to/file.adoc}}` diff --git a/asciinema b/asciinema new file mode 100644 index 00000000..b1dc5933 --- /dev/null +++ b/asciinema @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# asciinema + +> Record and replay terminal sessions, and optionally share them on . +> See also: `terminalizer`. +> More information: . + +- Associate the local install of `asciinema` with an asciinema.org account: + +`asciinema auth` + +- Make a new recording (finish it with `Ctrl+D` or type `exit`, and then choose to upload it or save it locally): + +`asciinema rec` + +- Make a new recording and save it to a local file: + +`asciinema rec {{path/to/recording.cast}}` + +- Replay a terminal recording from a local file: + +`asciinema play {{path/to/recording.cast}}` + +- Replay a terminal recording hosted on : + +`asciinema play https://asciinema.org/a/{{cast_id}}` + +- Make a new recording, limiting any [i]dle time to at most 2.5 seconds: + +`asciinema rec -i 2.5` + +- Print the full output of a locally saved recording: + +`asciinema cat {{path/to/recording.cast}}` + +- Upload a locally saved terminal session to asciinema.org: + +`asciinema upload {{path/to/recording.cast}}` diff --git a/asciitopgm b/asciitopgm new file mode 100644 index 00000000..668ff257 --- /dev/null +++ b/asciitopgm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# asciitopgm + +> Convert ASCII graphics into a PGM file. +> More information: . + +- Read ASCII data as input and produce a PGM image with pixel values that are an approximation of the "brightness" of the ASCII characters: + +`asciitopgm {{path/to/input_file}} > {{path/to/output_file.pgm}}` + +- Display version: + +`asciitopgm -version` diff --git a/asdf b/asdf new file mode 100644 index 00000000..2bd7bbaa --- /dev/null +++ b/asdf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# asdf + +> Command-line interface for managing versions of different packages. +> More information: . + +- List all available plugins: + +`asdf plugin list all` + +- Install a plugin: + +`asdf plugin add {{name}}` + +- List all available versions for a package: + +`asdf list all {{name}}` + +- Install a specific version of a package: + +`asdf install {{name}} {{version}}` + +- Set global version for a package: + +`asdf global {{name}} {{version}}` + +- Set local version for a package: + +`asdf local {{name}} {{version}}` diff --git a/assimp b/assimp new file mode 100644 index 00000000..ee2ef0d1 --- /dev/null +++ b/assimp @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# assimp + +> Command-line client for the Open Asset Import Library. +> Supports loading of 40+ 3D file formats, and exporting to several popular 3D formats. +> More information: . + +- List all supported import formats: + +`assimp listext` + +- List all supported export formats: + +`assimp listexport` + +- Convert a file to one of the supported output formats, using the default parameters: + +`assimp export {{input_file.stl}} {{output_file.obj}}` + +- Convert a file using custom parameters (the dox_cmd.h file in assimp's source code lists available parameters): + +`assimp export {{input_file.stl}} {{output_file.obj}} {{parameters}}` + +- Display a summary of a 3D file's contents: + +`assimp info {{path/to/file}}` + +- Display help: + +`assimp help` + +- Display help for a specific subcommand: + +`assimp {{subcommand}} --help` diff --git a/astronomer b/astronomer new file mode 100644 index 00000000..9038f94a --- /dev/null +++ b/astronomer @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# astronomer + +> Detect illegitimate stars from bot accounts on GitHub projects. +> More information: . + +- Scan a repository: + +`astronomer {{tldr-pages/tldr-node-client}}` + +- Scan the maximum amount of stars in the repository: + +`astronomer {{tldr-pages/tldr-node-client}} --stars {{50}}` + +- Scan a repository including comparative reports: + +`astronomer {{tldr-pages/tldr-node-client}} --verbose` diff --git a/astyle b/astyle new file mode 100644 index 00000000..cd0fde92 --- /dev/null +++ b/astyle @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# astyle + +> Source code indenter, formatter, and beautifier for the C, C++, C# and Java programming languages. +> Upon running, a copy of the original file is created with an ".orig" appended to the original file name. +> More information: . + +- Apply the default style of 4 spaces per indent and no formatting changes: + +`astyle {{source_file}}` + +- Apply the Java style with attached braces: + +`astyle --style=java {{path/to/file}}` + +- Apply the allman style with broken braces: + +`astyle --style=allman {{path/to/file}}` + +- Apply a custom indent using spaces. Choose between 2 and 20 spaces: + +`astyle --indent=spaces={{number_of_spaces}} {{path/to/file}}` + +- Apply a custom indent using tabs. Choose between 2 and 20 tabs: + +`astyle --indent=tab={{number_of_tabs}} {{path/to/file}}` diff --git a/at b/at new file mode 100644 index 00000000..25c8329b --- /dev/null +++ b/at @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# at + +> Execute commands once at a later time. +> Service atd (or atrun) should be running for the actual executions. +> More information: . + +- Execute commands from `stdin` in 5 minutes (press `Ctrl + D` when done): + +`at now + 5 minutes` + +- Execute a command from `stdin` at 10:00 AM today: + +`echo "{{./make_db_backup.sh}}" | at 1000` + +- Execute commands from a given file next Tuesday: + +`at -f {{path/to/file}} 9:30 PM Tue` diff --git a/atktopbm b/atktopbm new file mode 100644 index 00000000..9f5b4a1e --- /dev/null +++ b/atktopbm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atktopbm + +> Convert a Andrew Toolkit raster object to a PBM image. +> See also: `pbmtoatk`. +> More information: . + +- Convert a Andrew Toolkit raster object to a PBM image: + +`atktopbm {{path/to/image.atk}} > {{path/to/output.pbm}}` diff --git a/atom b/atom new file mode 100644 index 00000000..9ad02c24 --- /dev/null +++ b/atom @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atom + +> A cross-platform pluggable text editor. +> Plugins are managed by `apm`. +> More information: . + +- Open a file or directory: + +`atom {{path/to/file_or_directory}}` + +- Open a file or directory in a [n]ew window: + +`atom -n {{path/to/file_or_directory}}` + +- Open a file or directory in an existing window: + +`atom --add {{path/to/file_or_directory}}` + +- Open Atom in safe mode (does not load any additional packages): + +`atom --safe` + +- Prevent Atom from forking into the background, keeping Atom attached to the terminal: + +`atom --foreground` + +- Wait for Atom window to close before returning (useful for Git commit editor): + +`atom --wait` diff --git a/atoum b/atoum new file mode 100644 index 00000000..bacf8357 --- /dev/null +++ b/atoum @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atoum + +> A simple, modern and intuitive unit testing framework for PHP. +> More information: . + +- Initialize a configuration file: + +`atoum --init` + +- Run all tests: + +`atoum` + +- Run tests using the specified [c]onfiguration file: + +`atoum -c {{path/to/file}}` + +- Run a specific test [f]ile: + +`atoum -f {{path/to/file}}` + +- Run a specific [d]irectory of tests: + +`atoum -d {{path/to/directory}}` + +- Run all tests under a specific name[s]pace: + +`atoum -ns {{namespace}}` + +- Run all tests with a specific [t]ag: + +`atoum -t {{tag}}` + +- Load a custom bootstrap file before running tests: + +`atoum --bootstrap-file {{path/to/file}}` diff --git a/atq b/atq new file mode 100644 index 00000000..39b8920e --- /dev/null +++ b/atq @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atq + +> Show jobs scheduled by `at` or `batch` commands. +> More information: . + +- Show the current user's scheduled jobs: + +`atq` + +- Show jobs from the 'a' [q]ueue (queues have single-character names): + +`atq -q {{a}}` + +- Show jobs of all users (run as superuser): + +`sudo atq` diff --git a/atrm b/atrm new file mode 100644 index 00000000..e1258d02 --- /dev/null +++ b/atrm @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atrm + +> Remove jobs scheduled by `at` or `batch` commands. +> To find job numbers use `atq`. +> More information: . + +- Remove job number 10: + +`atrm {{10}}` + +- Remove many jobs, separated by spaces: + +`atrm {{15}} {{17}} {{22}}` diff --git a/atuin b/atuin new file mode 100644 index 00000000..e62ef398 --- /dev/null +++ b/atuin @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# atuin + +> Store your shell history in a searchable database. +> Optionally sync your encrypted history between machines. +> More information: . + +- Install atuin into your shell: + +`eval "$(atuin init {{bash|zsh|fish}})"` + +- Import history from the shell default history file: + +`atuin import auto` + +- Search shell history for a specific command: + +`atuin search {{command}}` + +- Register an account on the default sync server using the specified [u]sername, [e]mail and [p]assword: + +`atuin register -u {{username}} -e {{email}} -p {{password}}` + +- Login to the default sync server: + +`atuin login -u {{username}} -p {{password}}` + +- Sync history with the sync server: + +`atuin sync` diff --git a/audacious b/audacious new file mode 100755 index 00000000..7e1d728d --- /dev/null +++ b/audacious @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# audacious + +> An open-source audio player. +> More information: . + +- Launch the program: + +`audacious` + +- Enqueue a specific directory of audio files: + +`audacious --enqueue {{path/to/directory}}` + +- Start or stop playback: + +`audacious --play-pause` + +- Skip forwards or backwards in the playlist: + +`audacious --{{fwd|rew}}` + +- Stop playback: + +`audacious --stop` + +- Start a headless version: + +`audacious --headless` + +- Exit as soon as playback stops or there is nothing to playback: + +`audacious --quit-after-play` diff --git a/auditd b/auditd new file mode 100644 index 00000000..b548f919 --- /dev/null +++ b/auditd @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# auditd + +> This responds to requests from the audit utility and notifications from the kernel. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`auditd` + +- Start the daemon in debug mode: + +`auditd -d` + +- Start the daemon on-demand from launchd: + +`auditd -l` diff --git a/autoconf b/autoconf new file mode 100644 index 00000000..e223938d --- /dev/null +++ b/autoconf @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# autoconf + +> Generate configuration scripts to automatically configure software source code packages. +> More information: . + +- Generate a configuration script from `configure.ac` (if present) or `configure.in` and save this script to `configure`: + +`autoconf` + +- Generate a configuration script from the specified template; output to `stdout`: + +`autoconf {{template-file}}` + +- Generate a configuration script from the specified template (even if the input file has not changed) and write the output to a file: + +`autoconf --force --output={{outfile}} {{template-file}}` diff --git a/autoflake b/autoflake new file mode 100644 index 00000000..56d3ac41 --- /dev/null +++ b/autoflake @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# autoflake + +> Remove unused imports and variables from Python code. +> More information: . + +- Remove unused variables from a single file and display the diff: + +`autoflake --remove-unused-variables {{path/to/file.py}}` + +- Remove unused imports from multiple files and display the diffs: + +`autoflake --remove-all-unused-imports {{path/to/file1.py path/to/file2.py ...}}` + +- Remove unused variables from a file, overwriting the file: + +`autoflake --remove-unused-variables --in-place {{path/to/file.py}}` + +- Remove unused variables recursively from all files in a directory, overwriting each file: + +`autoflake --remove-unused-variables --in-place --recursive {{path/to/directory}}` diff --git a/autojump b/autojump new file mode 100644 index 00000000..f8be090d --- /dev/null +++ b/autojump @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# autojump + +> Quickly jump among the directories you visit the most. +> Aliases like j or jc are provided for even less typing. +> More information: . + +- Jump to a directory that contains the given pattern: + +`j {{pattern}}` + +- Jump to a sub-directory (child) of the current directory that contains the given pattern: + +`jc {{pattern}}` + +- Open a directory that contains the given pattern in the operating system file manager: + +`jo {{pattern}}` + +- Remove non-existing directories from the autojump database: + +`j --purge` + +- Show the entries in the autojump database: + +`j -s` diff --git a/autopep8 b/autopep8 new file mode 100644 index 00000000..7a145289 --- /dev/null +++ b/autopep8 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# autopep8 + +> Format Python code according to the PEP 8 style guide. +> More information: . + +- Format a file to `stdout`, with a custom maximum line length: + +`autopep8 {{path/to/file.py}} --max-line-length {{length}}` + +- Format a file, displaying a diff of the changes: + +`autopep8 --diff {{path/to/file}}` + +- Format a file in-place and save the changes: + +`autopep8 --in-place {{path/to/file.py}}` + +- Recursively format all files in a directory in-place and save changes: + +`autopep8 --in-place --recursive {{path/to/directory}}` diff --git a/autossh b/autossh new file mode 100644 index 00000000..2797e539 --- /dev/null +++ b/autossh @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# autossh + +> Run, monitor and restart SSH connections. +> Auto-reconnects to keep port forwarding tunnels up. Accepts all `ssh` flags. +> More information: . + +- Start an SSH session, restarting when the [M]onitoring port fails to return data: + +`autossh -M {{monitor_port}} "{{ssh_command}}"` + +- Forward a [L]ocal port to a remote one, restarting when necessary: + +`autossh -M {{monitor_port}} -L {{local_port}}:localhost:{{remote_port}} {{user}}@{{host}}` + +- Fork `autossh` into the background before executing `ssh` and do [N]ot open a remote shell: + +`autossh -f -M {{monitor_port}} -N "{{ssh_command}}"` + +- Run in the background, with no monitoring port, and instead send SSH keep-alive packets every 10 seconds to detect failure: + +`autossh -f -M 0 -N -o "ServerAliveInterval 10" -o "ServerAliveCountMax 3" "{{ssh_command}}"` + +- Run in the background, with no monitoring port and no remote shell, exiting if the port forward fails: + +`autossh -f -M 0 -N -o "ServerAliveInterval 10" -o "ServerAliveCountMax 3" -o ExitOnForwardFailure=yes -L {{local_port}}:localhost:{{remote_port}} {{user}}@{{host}}` + +- Run in the background, logging `autossh` debug output and `ssh` verbose output to files: + +`AUTOSSH_DEBUG=1 AUTOSSH_LOGFILE={{path/to/autossh_log_file.log}} autossh -f -M {{monitor_port}} -v -E {{path/to/ssh_log_file.log}} {{ssh_command}}` diff --git a/avo b/avo new file mode 100644 index 00000000..f7f8f533 --- /dev/null +++ b/avo @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# avo + +> The official command-line interface for Avo. +> More information: . + +- Initialize a workspace in the current directory: + +`avo init` + +- Log into the Avo platform: + +`avo login` + +- Switch to an existing Avo branch: + +`avo checkout {{branch_name}}` + +- Pull analytics wrappers for the current path: + +`avo pull` + +- Display the status of the Avo implementation: + +`avo status` + +- Resolve Git conflicts in Avo files: + +`avo conflict` + +- Open the current Avo workspace in the default web browser: + +`avo edit` + +- Display help for a subcommand: + +`avo {{subcommand}} --help` diff --git a/avrdude b/avrdude new file mode 100644 index 00000000..b01880c5 --- /dev/null +++ b/avrdude @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# avrdude + +> Driver program for Atmel AVR microcontrollers programming. +> More information: . + +- [r]ead the flash ROM of a AVR microcontroller with a specific [p]art id: + +`avrdude -p {{part_no}} -c {{programmer_id}} -U flash:r:{{file.hex}}:i` + +- [w]rite to the flash ROM AVR microcontroller: + +`avrdude -p {{part_no}} -c {{programmer}} -U flash:w:{{file.hex}}` + +- List available AVR devices: + +`avrdude -p \?` + +- List available AVR programmers: + +`avrdude -c \?` diff --git a/awk b/awk new file mode 100644 index 00000000..c9086547 --- /dev/null +++ b/awk @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# awk + +> A versatile programming language for working on files. +> More information: . + +- Print the fifth column (a.k.a. field) in a space-separated file: + +`awk '{print $5}' {{path/to/file}}` + +- Print the second column of the lines containing "foo" in a space-separated file: + +`awk '/{{foo}}/ {print $2}' {{path/to/file}}` + +- Print the last column of each line in a file, using a comma (instead of space) as a field separator: + +`awk -F ',' '{print $NF}' {{path/to/file}}` + +- Sum the values in the first column of a file and print the total: + +`awk '{s+=$1} END {print s}' {{path/to/file}}` + +- Print every third line starting from the first line: + +`awk 'NR%3==1' {{path/to/file}}` + +- Print different values based on conditions: + +`awk '{if ($1 == "foo") print "Exact match foo"; else if ($1 ~ "bar") print "Partial match bar"; else print "Baz"}' {{path/to/file}}` + +- Print all lines where the 10th column value equals the specified value: + +`awk '($10 == {{value}})'` + +- Print all the lines which the 10th column value is between a min and a max: + +`awk '($10 >= {{min_value}} && $10 <= {{max_value}})'` diff --git a/aws b/aws new file mode 100644 index 00000000..0ce0fe79 --- /dev/null +++ b/aws @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws + +> The official CLI tool for Amazon Web Services. +> Some subcommands such as `aws s3` have their own usage documentation. +> More information: . + +- Configure the AWS Command-line: + +`aws configure wizard` + +- Configure the AWS Command-line using SSO: + +`aws configure sso` + +- Get the caller identity (used to troubleshoot permissions): + +`aws sts get-caller-identity` + +- List AWS resources in a region and output in YAML: + +`aws dynamodb list-tables --region {{us-east-1}} --output yaml` + +- Use auto prompt to help with a command: + +`aws iam create-user --cli-auto-prompt` + +- Get an interactive wizard for an AWS resource: + +`aws dynamodb wizard {{new_table}}` + +- Generate a JSON CLI Skeleton (useful for infrastructure as code): + +`aws dynamodb update-table --generate-cli-skeleton` + +- Display help for a specific command: + +`aws {{command}} help` diff --git a/aws-backup b/aws-backup new file mode 100644 index 00000000..6f316369 --- /dev/null +++ b/aws-backup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws backup + +> Unified backup service designed to protect Amazon Web Services services and their associated data. +> More information: . + +- Return BackupPlan details for a specific BackupPlanId: + +`aws backup get-backup-plan --backup-plan-id {{id}}` + +- Create a backup plan using a specific backup plan name and backup rules: + +`aws backup create-backup-plan --backup-plan {{plan}}` + +- Delete a specific backup plan: + +`aws backup delete-backup-plan --backup-plan-id {{id}}` + +- List all active backup plans for the current account: + +`aws backup list-backup-plans` + +- Display details about your report jobs: + +`aws backup list-report-jobs` diff --git a/aws-batch b/aws-batch new file mode 100644 index 00000000..a7a62f6f --- /dev/null +++ b/aws-batch @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws batch + +> Run batch computing workloads through the AWS Batch service. +> More information: . + +- List running batch jobs: + +`aws batch list-jobs --job-queue {{queue_name}}` + +- Create compute environment: + +`aws batch create-compute-environment --compute-environment-name {{compute_environment_name}} --type {{type}}` + +- Create batch job queue: + +`aws batch create-job-queue --job-queue-name {{queue_name}} --priority {{priority}} --compute-environment-order {{compute_environment}}` + +- Submit job: + +`aws batch submit-job --job-name {{job_name}} --job-queue {{job_queue}} --job-definition {{job_definition}}` + +- Describe the list of batch jobs: + +`aws batch describe-jobs --jobs {{jobs}}` + +- Cancel job: + +`aws batch cancel-job --job-id {{job_id}} --reason {{reason}}` diff --git a/aws-cloud9 b/aws-cloud9 new file mode 100644 index 00000000..79556f44 --- /dev/null +++ b/aws-cloud9 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws cloud9 + +> Manage Cloud9 - a collection of tools to code, build, run, test, debug, and release software in the cloud. +> More information: . + +- List all Cloud9 development environment identifiers: + +`aws cloud9 list-environments` + +- Create a Cloud9 development environment: + +`aws cloud9 create-environment-ec2 --name {{name}} --instance-type {{instance_type}}` + +- Display information about Cloud9 development environments: + +`aws cloud9 describe-environments --environment-ids {{environment_ids}}` + +- Add an environment member to a Cloud9 development environment: + +`aws cloud9 create-environment-membership --environment-id {{environment_id}} --user-arn {{user_arn}} --permissions {{permissions}}` + +- Display status information for a Cloud9 development environment: + +`aws cloud9 describe-environment-status --environment-id {{environment_id}}` + +- Delete a Cloud9 environment: + +`aws cloud9 delete-environment --environment-id {{environment_id}}` + +- Delete an environment member from a development environment: + +`aws cloud9 delete-environment-membership --environment-id {{environment_id}} --user-arn {{user_arn}}` diff --git a/aws-cloudformation b/aws-cloudformation new file mode 100644 index 00000000..9e81abc6 --- /dev/null +++ b/aws-cloudformation @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws cloudformation + +> Model, provision, and manage AWS and third-party resources by treating infrastructure as code. +> More information: . + +- Create a stack from a template file: + +`aws cloudformation create-stack --stack-name {{stack-name}} --region {{region}} --template-body {{file://path/to/file.yml}} --profile {{profile}}` + +- Delete a stack: + +`aws cloudformation delete-stack --stack-name {{stack-name}} --profile {{profile}}` + +- List all stacks: + +`aws cloudformation list-stacks --profile {{profile}}` + +- List all running stacks: + +`aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE --profile {{profile}}` + +- Check the status of a stack: + +`aws cloudformation describe-stacks --stack-name {{stack-id}} --profile {{profile}}` + +- Initiate drift detection for a stack: + +`aws cloudformation detect-stack-drift --stack-name {{stack-id}} --profile {{profile}}` + +- Check the drift status output of a stack using 'StackDriftDetectionId' from the previous command output: + +`aws cloudformation describe-stack-resource-drifts --stack-name {{stack-drift-detection-id}} --profile {{profile}}` diff --git a/aws-cloudwatch b/aws-cloudwatch new file mode 100644 index 00000000..86e60e3c --- /dev/null +++ b/aws-cloudwatch @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws cloudwatch + +> Monitor AWS resources to gain system-wide visibility into resource utilization, application performance, and operational health. +> More information: . + +- List dashboards for your account: + +`aws cloudwatch list-dashboards` + +- Display details for the specified dashboard: + +`aws cloudwatch get-dashboard --dashboard-name {{dashboard_name}}` + +- List metrics: + +`aws cloudwatch list-metrics` + +- List alarms: + +`aws cloudwatch describe-alarms` + +- Create or update an alarm and associate it with a metric: + +`aws cloudwatch put-metric-alarm --alarm-name {{alarm_name}} --evaluation-periods {{evaluation_periods}} --comparison-operator {{comparison_operator}}` + +- Delete the specified alarms: + +`aws cloudwatch delete-alarms --alarm_names {{alarm_names}}` + +- Delete the specified dashboards: + +`aws cloudwatch delete-dashboards --dashboard-names {{dashboard_names}}` diff --git a/aws-codeartifact b/aws-codeartifact new file mode 100644 index 00000000..26a1d4bc --- /dev/null +++ b/aws-codeartifact @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws codeartifact + +> Manage CodeArtifact repositories, domains, packages, package versions and assets. +> CodeArtifact is an artifact repository compatible with popular package managers and build tools like Maven, Gradle, npm, Yarn, Twine, pip, NuGet, and SwiftPM. +> More information: . + +- List available domains for your AWS account: + +`aws codeartifact list-domains` + +- Generate credentials for a specific package manager: + +`aws codeartifact login --tool {{npm|pip|twine}} --domain {{your_domain}} --repository {{repository_name}}` + +- Get the endpoint URL of a CodeArtifact repository: + +`aws codeartifact get-repository-endpoint --domain {{your_domain}} --repository {{repository_name}} --format {{npm|pypi|maven|nuget|generic}}` + +- Display help: + +`aws codeartifact help` + +- Display help for a specific subcommand: + +`aws codeartifact {{subcommand}} help` diff --git a/aws-codecommit b/aws-codecommit new file mode 100644 index 00000000..07eed558 --- /dev/null +++ b/aws-codecommit @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws codecommit + +> A managed source control service that hosts private Git repositories. +> More information: . + +- Display help: + +`aws codecommit help` + +- Display help for a specific command: + +`aws codecommit {{command}} help` diff --git a/aws-cognito-idp b/aws-cognito-idp new file mode 100644 index 00000000..4ae9c467 --- /dev/null +++ b/aws-cognito-idp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws cognito-idp + +> Manage Amazon Cognito user pool and its users and groups using the CLI. +> More information: . + +- Create a new Cognito user pool: + +`aws cognito-idp create-user-pool --pool-name {{name}}` + +- List all user pools: + +`aws cognito-idp list-user-pools --max-results {{10}}` + +- Delete a specific user pool: + +`aws cognito-idp delete-user-pool --user-pool-id {{user_pool_id}}` + +- Create a user in a specific pool: + +`aws cognito-idp admin-create-user --username {{username}} --user-pool-id {{user_pool_id}}` + +- List the users of a specific pool: + +`aws cognito-idp list-users --user-pool-id {{user_pool_id}}` + +- Delete a user from a specific pool: + +`aws cognito-idp admin-delete-user --username {{username}} --user-pool-id {{user_pool_id}}` diff --git a/aws-configure b/aws-configure new file mode 100644 index 00000000..050f355e --- /dev/null +++ b/aws-configure @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws configure + +> Manage configuration for the AWS CLI. +> More information: . + +- Configure AWS CLI interactively (creates a new configuration or updates the default): + +`aws configure` + +- Configure a named profile for AWS CLI interactively (creates a new profile or updates an existing one): + +`aws configure --profile {{profile_name}}` + +- Display the value from a specific configuration variable: + +`aws configure get {{name}}` + +- Display the value for a configuration variable in a specific profile: + +`aws configure get {{name}} --profile {{profile_name}}` + +- Set the value of a specific configuration variable: + +`aws configure set {{name}} {{value}}` + +- Set the value of a configuration variable in a specific profile: + +`aws configure set {{name}} {{value}} --profile {{profile_name}}` + +- List the configuration entries: + +`aws configure list` + +- List the configuration entries for a specific profile: + +`aws configure list --profile {{profile_name}}` diff --git a/aws-cur b/aws-cur new file mode 100644 index 00000000..6e822af0 --- /dev/null +++ b/aws-cur @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws cur + +> Create, query, and delete AWS usage report definitions. +> More information: . + +- Create an AWS cost and usage report definition from a JSON file: + +`aws cur put-report-definition --report-definition file://{{path/to/report_definition.json}}` + +- List usage report definitions defined for the logged in account: + +`aws cur describe-report-definitions` + +- Delete a usage report definition: + +`aws cur --region {{aws_region}} delete-report-definition --report-name {{report}}` diff --git a/aws-dynamodb b/aws-dynamodb new file mode 100644 index 00000000..3e0ba331 --- /dev/null +++ b/aws-dynamodb @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws dynamodb + +> CLI for AWS dynamodb. +> More information: . + +- Create a table: + +`aws dynamodb create-table --table-name {{table_name}} --attribute-definitions {{AttributeName=S,AttributeType=S}} --key-schema {{AttributeName=S,KeyType=HASH}} --provisioned-throughput {{ReadCapacityUnits=5,WriteCapacityUnits=5}}` + +- List all tables in the DynamoDB: + +`aws dynamodb list-tables` + +- Get details about a specific table: + +`aws dynamodb describe-table --table-name {{table_name}}` + +- Add an item to a table: + +`aws dynamodb put-item --table-name {{table_name}} --item '{{{"AttributeName": {"S": "value"}}}}'` + +- Retrieve an item from a table: + +`aws dynamodb get-item --table-name {{table_name}} --key '{{{"ID": {"N": "1"}}}}'` + +- Update an item in the table: + +`aws dynamodb update-item --table-name {{table_name}} --key '{{{"ID": {"N": "1"}}}}' --update-expression "{{SET Name = :n}}" --expression-attribute-values '{{{":n": {"S": "Jane"}}}}'` + +- Scan items in the table: + +`aws dynamodb scan --table-name {{table_name}}` + +- Delete an item from the table: + +`aws dynamodb delete-item --table-name {{table_name}} --key '{{{"ID": {"N": "1"}}}}'` diff --git a/aws-ec2 b/aws-ec2 new file mode 100644 index 00000000..6e5d8588 --- /dev/null +++ b/aws-ec2 @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws ec2 + +> CLI for AWS EC2. +> Provides secure and resizable computing capacity in the AWS cloud to enable faster development and deployment of applications. +> More information: . + +- Display information about a specific instance: + +`aws ec2 describe-instances --instance-ids {{instance_id}}` + +- Display information about all instances: + +`aws ec2 describe-instances` + +- Display information about all EC2 volumes: + +`aws ec2 describe-volumes` + +- Delete an EC2 volume: + +`aws ec2 delete-volume --volume-id {{volume_id}}` + +- Create a snapshot from an EC2 volume: + +`aws ec2 create-snapshot --volume-id {{volume_id}}` + +- List available AMIs (Amazon Machine Images): + +`aws ec2 describe-images` + +- Show list of all available EC2 commands: + +`aws ec2 help` + +- Display help for specific EC2 subcommand: + +`aws ec2 {{subcommand}} help` diff --git a/aws-ecr b/aws-ecr new file mode 100644 index 00000000..7a7dd2f1 --- /dev/null +++ b/aws-ecr @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws ecr + +> Push, pull, and manage container images. +> More information: . + +- Authenticate Docker with the default registry (username is AWS): + +`aws ecr get-login-password --region {{region}} | {{docker login}} --username AWS --password-stdin {{aws_account_id}}.dkr.ecr.{{region}}.amazonaws.com` + +- Create a repository: + +`aws ecr create-repository --repository-name {{repository}} --image-scanning-configuration scanOnPush={{true|false}} --region {{region}}` + +- Tag a local image for ECR: + +`docker tag {{container_name}}:{{tag}} {{aws_account_id}}.dkr.ecr.{{region}}.amazonaws.com/{{container_name}}:{{tag}}` + +- Push an image to a repository: + +`docker push {{aws_account_id}}.dkr.ecr.{{region}}.amazonaws.com/{{container_name}}:{{tag}}` + +- Pull an image from a repository: + +`docker pull {{aws_account_id}}.dkr.ecr.{{region}}.amazonaws.com/{{container_name}}:{{tag}}` + +- Delete an image from a repository: + +`aws ecr batch-delete-image --repository-name {{repository}} --image-ids imageTag={{latest}}` + +- Delete a repository: + +`aws ecr delete-repository --repository-name {{repository}} --force` + +- List images within a repository: + +`aws ecr list-images --repository-name {{repository}}` diff --git a/aws-eks b/aws-eks new file mode 100644 index 00000000..464a2c5b --- /dev/null +++ b/aws-eks @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws eks + +> CLI for Amazon EKS (Elastic Kubernetes Service). +> More information: . + +- Create an EKS Cluster: + +`aws eks create-cluster --name {{cluster_name}} --role-arn {{eks_service_role_arn}} --resources-vpc-config {{subnetIds={{subnet_ids}},securityGroupIds={{security_group_ids}}}}` + +- Update kubeconfig to connect to the EKS Cluster: + +`aws eks update-kubeconfig --name {{cluster_name}}` + +- List available EKS clusters: + +`aws eks list-clusters` + +- Describe EKS cluster details: + +`aws eks describe-cluster --name {{cluster_name}}` + +- Delete an EKS Cluster: + +`aws eks delete-cluster --name {{cluster_name}}` + +- List nodegroups in an EKS cluster: + +`aws eks list-nodegroups --cluster-name {{cluster_name}}` + +- Describe nodegroup details: + +`aws eks describe-nodegroup --cluster-name {{cluster_name}} --nodegroup-name {{nodegroup_name}}` diff --git a/aws-glue b/aws-glue new file mode 100644 index 00000000..3fecd853 --- /dev/null +++ b/aws-glue @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws glue + +> CLI for AWS Glue. +> Defines the public endpoint for the AWS Glue service. +> More information: . + +- List jobs: + +`aws glue list-jobs` + +- Start a job: + +`aws glue start-job-run --job-name {{job_name}}` + +- Start running a workflow: + +`aws glue start-workflow-run --name {{workflow_name}}` + +- List triggers: + +`aws glue list-triggers` + +- Start a trigger: + +`aws glue start-trigger --name {{trigger_name}}` + +- Create a dev endpoint: + +`aws glue create-dev-endpoint --endpoint-name {{name}} --role-arn {{role_arn_used_by_endpoint}}` diff --git a/aws-google-auth b/aws-google-auth new file mode 100644 index 00000000..074c9f43 --- /dev/null +++ b/aws-google-auth @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws-google-auth + +> Command-line tool to acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On) provider. +> More information: . + +- Log in with Google SSO using the specified [u]sername [I]DP and [S]P identifiers and set the credentials [d]uration to one hour: + +`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}}` + +- Log in [a]sking which role to use (in case of several available SAML roles): + +`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}} -a` + +- Resolve aliases for AWS accounts: + +`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}} -a --resolve-aliases` + +- Display help: + +`aws-google-auth -h` diff --git a/aws-help b/aws-help new file mode 100644 index 00000000..017cafd0 --- /dev/null +++ b/aws-help @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws help + +> Display help information about the AWS CLI. +> More information: . + +- Display help: + +`aws help` + +- List all available topics: + +`aws help topics` + +- Display help about a specific topic: + +`aws help {{topic_name}}` diff --git a/aws-history b/aws-history new file mode 100644 index 00000000..e453b5a2 --- /dev/null +++ b/aws-history @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws history + +> Print the command-line history for AWS CLI commands (the record of history of AWS CLI commands must be enabled). +> More information: . + +- List commands history with command IDs: + +`aws history list` + +- Display events related to a specific command given a command ID: + +`aws history show {{command_id}}` diff --git a/aws-iam b/aws-iam new file mode 100644 index 00000000..2d539496 --- /dev/null +++ b/aws-iam @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws iam + +> CLI for AWS IAM. +> More information: . + +- List users: + +`aws iam list-users` + +- List policies: + +`aws iam list-policies` + +- List groups: + +`aws iam list-groups` + +- Get users in a group: + +`aws iam get-group --group-name {{group_name}}` + +- Describe an IAM policy: + +`aws iam get-policy --policy-arn arn:aws:iam::aws:policy/{{policy_name}}` + +- List access keys: + +`aws iam list-access-keys` + +- List access keys for a specific user: + +`aws iam list-access-keys --user-name {{user_name}}` + +- Display help: + +`aws iam help` diff --git a/aws-kafka b/aws-kafka new file mode 100644 index 00000000..92df6b94 --- /dev/null +++ b/aws-kafka @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws kafka + +> Manage an Amazon MSK (Managed Streaming for Apache Kafka) cluster. +> See also: `aws`. +> More information: . + +- Create a new MSK cluster: + +`aws kafka create-cluster --cluster-name {{cluster_name}} --broker-node-group-info instanceType={{instance_type}},clientSubnets={{subnet_id1 subnet_id2 ...}} --kafka-version {{version}} --number-of-broker-nodes {{number}}` + +- Describe a MSK cluster: + +`aws kafka describe-cluster --cluster-arn {{cluster_arn}}` + +- List all MSK clusters in the current region: + +`aws kafka list-clusters` + +- Create a new MSK configuration: + +`aws kafka create-configuration --name {{configuration_name}} --server-properties file://{{path/to/configuration_file.txt}}` + +- Describe a MSK configuration: + +`aws kafka describe-configuration --arn {{configuration_arn}}` + +- List all MSK configurations in the current region: + +`aws kafka list-configurations` + +- Update the MSK cluster configuration: + +`aws kafka update-cluster-configuration --cluster-arn {{cluster_arn}} --configuration-info arn={{configuration_arn}},revision={{configuration_revision}}` + +- Delete the MSK cluster: + +`aws kafka delete-cluster --cluster-arn {{cluster_arn}}` diff --git a/aws-kinesis b/aws-kinesis new file mode 100644 index 00000000..4c03722b --- /dev/null +++ b/aws-kinesis @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws kinesis + +> Official AWS CLI for Amazon Kinesis streaming data services. +> More information: . + +- Show all streams in the account: + +`aws kinesis list-streams` + +- Write one record to a Kinesis stream: + +`aws kinesis put-record --stream-name {{name}} --partition-key {{key}} --data {{base64_encoded_message}}` + +- Write a record to a Kinesis stream with inline base64 encoding: + +`aws kinesis put-record --stream-name {{name}} --partition-key {{key}} --data "$( echo "{{my raw message}}" | base64 )"` + +- List the shards available on a stream: + +`aws kinesis list-shards --stream-name {{name}}` + +- Get a shard iterator for reading from the oldest message in a stream's shard: + +`aws kinesis get-shard-iterator --shard-iterator-type TRIM_HORIZON --stream-name {{name}} --shard-id {{id}}` + +- Read records from a shard, using a shard iterator: + +`aws kinesis get-records --shard-iterator {{iterator}}` diff --git a/aws-lambda b/aws-lambda new file mode 100644 index 00000000..19325026 --- /dev/null +++ b/aws-lambda @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws lambda + +> CLI for AWS lambda. +> More information: . + +- Run a function: + +`aws lambda invoke --function-name {{name}} {{path/to/response.json}}` + +- Run a function with an input payload in JSON format: + +`aws lambda invoke --function-name {{name}} --payload {{json}} {{path/to/response.json}}` + +- List functions: + +`aws lambda list-functions` + +- Display the configuration of a function: + +`aws lambda get-function-configuration --function-name {{name}}` + +- List function aliases: + +`aws lambda list-aliases --function-name {{name}}` + +- Display the reserved concurrency configuration for a function: + +`aws lambda get-function-concurrency --function-name {{name}}` + +- List which AWS services can invoke the function: + +`aws lambda get-policy --function-name {{name}}` diff --git a/aws-lightsail b/aws-lightsail new file mode 100644 index 00000000..993ca8fa --- /dev/null +++ b/aws-lightsail @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws lightsail + +> Manage Amazon Lightsail resources. +> More information: . + +- List all virtual private servers, or instances: + +`aws lightsail get-instances` + +- List all bundles (instance plans): + +`aws lightsail list-bundles` + +- List all available instance images, or blueprints: + +`aws lightsail list-blueprints` + +- Create an instance: + +`aws lightsail create-instances --instance-names {{name}} --availability-zone {{region}} --bundle-id {{nano_2_0}} --blueprint-id {{blueprint_id}}` + +- Print the state of a specific instance: + +`aws lightsail get-instance-state --instance-name {{name}}` + +- Stop a specific instance: + +`aws lightsail stop-instance --instance-name {{name}}` + +- Delete a specific instance: + +`aws lightsail delete-instance --instance-name {{name}}` diff --git a/aws-pricing b/aws-pricing new file mode 100644 index 00000000..7a9bddd2 --- /dev/null +++ b/aws-pricing @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws pricing + +> Query services, products, and pricing information from Amazon Web Services. +> More information: . + +- List service codes of a specific region: + +`aws pricing describe-services --region {{us-east-1}}` + +- List attributes for a given service code in a specific region: + +`aws pricing describe-services --service-code {{AmazonEC2}} --region {{us-east-1}}` + +- Print pricing information for a service code in a specific region: + +`aws pricing get-products --service-code {{AmazonEC2}} --region {{us-east-1}}` + +- List values for a specific attribute for a service code in a specific region: + +`aws pricing get-attribute-values --service-code {{AmazonEC2}} --attribute-name {{instanceType}} --region {{us-east-1}}` + +- Print pricing information for a service code using filters for instance type and location: + +`aws pricing get-products --service-code {{AmazonEC2}} --filters "{{Type=TERM_MATCH,Field=instanceType,Value=m5.xlarge}}" "{{Type=TERM_MATCH,Field=location,Value=US East (N. Virginia)}}" --region {{us-east-1}}` diff --git a/aws-quicksight b/aws-quicksight new file mode 100644 index 00000000..6e12532e --- /dev/null +++ b/aws-quicksight @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws quicksight + +> Create, delete, list, search and update AWS QuickSight entities. +> More information: . + +- List datasets: + +`aws quicksight list-data-sets --aws-account-id {{aws_account_id}}` + +- List users: + +`aws quicksight list-users --aws-account-id {{aws_account_id}} --namespace default` + +- List groups: + +`aws quicksight list-groups --aws-account-id {{aws_account_id}} --namespace default` + +- List dashboards: + +`aws quicksight list-dashboards --aws-account-id {{aws_account_id}}` + +- Display detailed information about a dataset: + +`aws quicksight describe-data-set --aws-account-id {{aws_account_id}} --data-set-id {{data_set_id}}` + +- Display who has access to the dataset and what kind of actions they can perform on the dataset: + +`aws quicksight describe-data-set-permissions --aws-account-id {{aws_account_id}} --data-set-id {{data_set_id}}` diff --git a/aws-rds b/aws-rds new file mode 100644 index 00000000..49cf189f --- /dev/null +++ b/aws-rds @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws rds + +> CLI for AWS Relational Database Service. +> Create and manage relational databases. +> More information: . + +- Display help for a specific RDS subcommand: + +`aws rds {{subcommand}} help` + +- Stop instance: + +`aws rds stop-db-instance --db-instance-identifier {{instance_identifier}}` + +- Start instance: + +`aws rds start-db-instance --db-instance-identifier {{instance_identifier}}` + +- Modify an RDS instance: + +`aws rds modify-db-instance --db-instance-identifier {{instance_identifier}} {{parameters}} --apply-immediately` + +- Apply updates to an RDS instance: + +`aws rds apply-pending-maintenance-action --resource-identifier {{database_arn}} --apply-action {{system-update}} --opt-in-type {{immediate}}` + +- Change an instance identifier: + +`aws rds modify-db-instance --db-instance-identifier {{old_instance_identifier}} --new-db-instance-identifier {{new_instance_identifier}}` + +- Reboot an instance: + +`aws rds reboot-db-instance --db-instance-identifier {{instance_identifier}}` + +- Delete an instance: + +`aws rds delete-db-instance --db-instance-identifier {{instance_identifier}} --final-db-snapshot-identifier {{snapshot_identifier}} --delete-automated-backups` diff --git a/aws-route53 b/aws-route53 new file mode 100644 index 00000000..b921581b --- /dev/null +++ b/aws-route53 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws route53 + +> CLI for AWS Route53 - Route 53 is a highly available and scalable Domain Name System (DNS) web service. +> More information: . + +- List all hosted zones, private and public: + +`aws route53 list-hosted-zones` + +- Show all records in a zone: + +`aws route53 list-resource-record-sets --hosted-zone-id {{zone_id}}` + +- Create a new, public zone using a request identifier to retry the operation safely: + +`aws route53 create-hosted-zone --name {{name}} --caller-reference {{request_identifier}}` + +- Delete a zone (if the zone has non-defaults SOA and NS records the command will fail): + +`aws route53 delete-hosted-zone --id {{zone_id}}` + +- Test DNS resolving by Amazon servers of a given zone: + +`aws route53 test-dns-answer --hosted-zone-id {{zone_id}} --record-name {{name}} --record-type {{type}}` diff --git a/aws-s3 b/aws-s3 new file mode 100644 index 00000000..442e7aab --- /dev/null +++ b/aws-s3 @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 + +> CLI for AWS S3 - provides storage through web services interfaces. +> Some subcommands such as `aws s3 cp` have their own usage documentation. +> More information: . + +- Show files in a bucket: + +`aws s3 ls {{bucket_name}}` + +- Sync files and directories from local to bucket: + +`aws s3 sync {{path/to/file1 path/to/file2 ...}} s3://{{bucket_name}}` + +- Sync files and directories from bucket to local: + +`aws s3 sync s3://{{bucket_name}} {{path/to/target}}` + +- Sync files and directories with exclusions: + +`aws s3 sync {{path/to/file1 path/to/file2 ...}} s3://{{bucket_name}} --exclude {{path/to/file}} --exclude {{path/to/directory}}/*` + +- Remove file from bucket: + +`aws s3 rm s3://{{bucket}}/{{path/to/file}}` + +- Preview changes only: + +`aws s3 {{any_command}} --dryrun` diff --git a/aws-s3-cp b/aws-s3-cp new file mode 100644 index 00000000..e54ebddd --- /dev/null +++ b/aws-s3-cp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 cp + +> Copy local files or S3 objects to another location locally or in S3. +> More information: . + +- Copy a file from local to a specific bucket: + +`aws s3 cp {{path/to/file}} s3://{{bucket_name}}/{{path/to/remote_file}}` + +- Copy a specific S3 object into another bucket: + +`aws s3 cp s3://{{bucket_name1}}/{{path/to/file}} s3://{{bucket_name2}}/{{path/to/target}}` + +- Copy a specific S3 object into another bucket keeping the original name: + +`aws s3 cp s3://{{bucket_name1}}/{{path/to/file}} s3://{{bucket_name2}}` + +- Copy S3 objects to a local directory recursively: + +`aws s3 cp s3://{{bucket_name}} . --recursive` + +- Display help: + +`aws s3 cp help` diff --git a/aws-s3-ls b/aws-s3-ls new file mode 100644 index 00000000..2149a4eb --- /dev/null +++ b/aws-s3-ls @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 ls + +> List AWS S3 buckets, folders (prefixes), and files (objects). +> More information: . + +- List all buckets: + +`aws s3 ls` + +- List files and folders in the root of a bucket (`s3://` is optional): + +`aws s3 ls s3://{{bucket_name}}` + +- List files and folders directly inside a directory: + +`aws s3 ls {{bucket_name}}/{{path/to/directory}}/` + +- List all files in a bucket: + +`aws s3 ls --recursive {{bucket_name}}` + +- List all files in a path with a given prefix: + +`aws s3 ls --recursive {{bucket_name}}/{{path/to/directory/}}{{prefix}}` + +- Display help: + +`aws s3 ls help` diff --git a/aws-s3-mb b/aws-s3-mb new file mode 100644 index 00000000..99f78d8f --- /dev/null +++ b/aws-s3-mb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 mb + +> Create S3 buckets. +> More information: . + +- Create an S3 bucket: + +`aws s3 mb s3://{{bucket_name}}` + +- Create an S3 bucket in a specific region: + +`aws s3 mb s3://{{bucket_name}} --region {{region}}` + +- Display help: + +`aws s3 mb help` diff --git a/aws-s3-mv b/aws-s3-mv new file mode 100644 index 00000000..5e29fe10 --- /dev/null +++ b/aws-s3-mv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 mv + +> Move local files or S3 objects to another location locally or in S3. +> More information: . + +- Move a file from local to a specified bucket: + +`aws s3 mv {{path/to/local_file}} s3://{{bucket_name}}/{{path/to/remote_file}}` + +- Move a specific S3 object into another bucket: + +`aws s3 mv s3://{{bucket_name1}}/{{path/to/file}} s3://{{bucket_name2}}/{{path/to/target}}` + +- Move a specific S3 object into another bucket keeping the original name: + +`aws s3 mv s3://{{bucket_name1}}/{{path/to/file}} s3://{{bucket_name2}}` + +- Display help: + +`aws s3 mv help` diff --git a/aws-s3-presign b/aws-s3-presign new file mode 100644 index 00000000..42bb0de0 --- /dev/null +++ b/aws-s3-presign @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 presign + +> Generate pre-signed URLs for Amazon S3 objects. +> More information: . + +- Generate a pre-signed URL for a specific S3 object that is valid for one hour: + +`aws s3 presign s3://{{bucket_name}}/{{path/to/file}}` + +- Generate a pre-signed URL valid for a specific lifetime: + +`aws s3 presign s3://{{bucket_name}}/{{path/to/file}} --expires-in {{duration_in_seconds}}` + +- Display help: + +`aws s3 presign help` diff --git a/aws-s3-rb b/aws-s3-rb new file mode 100644 index 00000000..933d4443 --- /dev/null +++ b/aws-s3-rb @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 rb + +> Delete an empty S3 bucket. +> More information: . + +- Delete an empty S3 bucket: + +`aws s3 rb s3://{{bucket_name}}` + +- Force delete an S3 bucket and its non-versioned objects (will crash if versioned objects are present): + +`aws s3 rb s3://{{bucket_name}} --force` diff --git a/aws-s3-rm b/aws-s3-rm new file mode 100644 index 00000000..c9a20d67 --- /dev/null +++ b/aws-s3-rm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 rm + +> Delete S3 objects. +> More information: . + +- Delete a specific S3 object: + +`aws s3 rm s3://{{bucket_name}}/{{path/to/file}}` + +- Preview the deletion of a specific S3 object without deleting it (dry-run): + +`aws s3 rm s3://{{bucket_name}}/{{path/to/file}} --dryrun` + +- Delete an object from a specific S3 access point: + +`aws s3 rm s3://arn:aws:s3:{{region}}:{{account_id}}:{{access_point}}/{{access_point_name}}/{{object_key}}` + +- Display help: + +`aws s3 rm help` diff --git a/aws-s3-website b/aws-s3-website new file mode 100644 index 00000000..a8192cdd --- /dev/null +++ b/aws-s3-website @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 website + +> Set the website configuration for a bucket. +> See also: `aws s3`. +> More information: . + +- Configure a bucket as a static website: + +`aws s3 website {{s3://bucket-name}} --index-document {{index.html}}` + +- Configure an error page for the website: + +`aws s3 website {{s3://bucket-name}} --index-document {{index.html}} --error-document {{error.html}}` diff --git a/aws-s3api b/aws-s3api new file mode 100644 index 00000000..cdd2595f --- /dev/null +++ b/aws-s3api @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3api + +> Create and delete Amazon S3 buckets and edit bucket properties. +> More information: . + +- Create bucket in a specific region: + +`aws s3api create-bucket --bucket {{bucket_name}} --region {{region}} --create-bucket-configuration LocationConstraint={{region}}` + +- Delete a bucket: + +`aws s3api delete-bucket --bucket {{bucket_name}}` + +- List buckets: + +`aws s3api list-buckets` + +- List the objects inside of a bucket and only show each object's key and size: + +`aws s3api list-objects --bucket {{bucket_name}} --query '{{Contents[].{Key: Key, Size: Size}}}'` + +- Add an object to a bucket: + +`aws s3api put-object --bucket {{bucket_name}} --key {{object_key}} --body {{path/to/file}}` + +- Download object from a bucket (The output file is always the last argument): + +`aws s3api get-object --bucket {{bucket_name}} --key {{object_key}} {{path/to/output_file}}` + +- Apply an Amazon S3 bucket policy to a specified bucket: + +`aws s3api put-bucket-policy --bucket {{bucket_name}} --policy file://{{path/to/bucket_policy.json}}` + +- Download the Amazon S3 bucket policy from a specified bucket: + +`aws s3api get-bucket-policy --bucket {{bucket_name}} --query Policy --output {{json|table|text|yaml|yaml-stream}} > {{path/to/bucket_policy}}` diff --git a/aws-secretsmanager b/aws-secretsmanager new file mode 100644 index 00000000..931bba11 --- /dev/null +++ b/aws-secretsmanager @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws secretsmanager + +> Store, manage, and retrieve secrets. +> More information: . + +- Show secrets stored by the secrets manager in the current account: + +`aws secretsmanager list-secrets` + +- Create a secret: + +`aws secretsmanager create-secret --name {{name}} --description "{{secret_description}}" --secret-string {{secret}}` + +- Delete a secret: + +`aws secretsmanager delete-secret --secret-id {{name_or_arn}}` + +- View details of a secret except for secret text: + +`aws secretsmanager describe-secret --secret-id {{name_or_arn}}` + +- Retrieve the value of a secret (to get the latest version of the secret omit `--version-stage`): + +`aws secretsmanager get-secret-value --secret-id {{name_or_arn}} --version-stage {{version_of_secret}}` + +- Rotate the secret immediately using a Lambda function: + +`aws secretsmanager rotate-secret --secret-id {{name_or_arn}} --rotation-lambda-arn {{arn_of_lambda_function}}` + +- Rotate the secret automatically every 30 days using a Lambda function: + +`aws secretsmanager rotate-secret --secret-id {{name_or_arn}} --rotation-lambda-arn {{arn_of_lambda_function}} --rotation-rules AutomaticallyAfterDays={{30}}` diff --git a/aws-ses b/aws-ses new file mode 100644 index 00000000..5b1f412b --- /dev/null +++ b/aws-ses @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws ses + +> CLI for AWS Simple Email Service. +> High-scale inbound and outbound cloud email service. +> More information: . + +- Create a new receipt rule set: + +`aws ses create-receipt-rule-set --rule-set-name {{rule_set_name}} --generate-cli-skeleton` + +- Describe the active receipt rule set: + +`aws ses describe-active-receipt-rule-set --generate-cli-skeletion` + +- Describe a specific receipt rule: + +`aws ses describe-receipt-rule --rule-set-name {{rule_set_name}} --rule-name {{rule_name}} --generate-cli-skeleton` + +- List all receipt rule sets: + +`aws ses list-receipt-rule-sets --starting-token {{token_string}} --max-items {{integer}} --generate-cli-skeleton` + +- Delete a specific receipt rule set (the currently active rule set cannot be deleted): + +`aws ses delete-receipt-rule-set --rule-set-name {{rule_set_name}} --generate-cli-skeleton` + +- Delete a specific receipt rule: + +`aws ses delete-receipt-rule --rule-set-name {{rule_set_name}} --rule-name {{rule_name}} --generate-cli-skeleton` + +- Send an email: + +`aws ses send-email --from {{from_address}} --destination "ToAddresses={{addresses}}" --message "Subject={Data={{subject_text}},Charset=utf8},Body={Text={Data={{body_text}},Charset=utf8},Html={Data={{message_body_containing_html}},Charset=utf8}}"` + +- Display help for a specific SES subcommand: + +`aws ses {{subcommand}} help` diff --git a/aws-sns b/aws-sns new file mode 100644 index 00000000..52cd4354 --- /dev/null +++ b/aws-sns @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws sns + +> Create topics and subscriptions, send and receive messages, and monitor events and logs for the Amazon Simple Notification Service. +> More information: . + +- List all objects of a specific type: + +`aws sns list-{{origination-numbers|phone-numbers-opted-out|platform-applications|sms-sandbox-phone-numbers|subscriptions|topics}}` + +- Create a topic with a specific name and show its Amazon Resource Name (ARN): + +`aws sns create-topic --name {{name}}` + +- Subscribe an email address to the topic with a specific ARN and show the subscription ARN: + +`aws sns subscribe --topic-arn {{topic_ARN}} --protocol email --notification-endpoint {{email}}` + +- Publish a message to a specific topic or phone number and show the message ID: + +`aws sns publish {{--topic-arn "arn:aws:sns:us-west-2:123456789012:topic-name"||--phone-number +1-555-555-0100}} --message file://{{path/to/file}}` + +- Delete the subscription with a specific ARN from its topic: + +`aws sns unsubscribe --subscription-arn {{subscription_ARN}}` + +- Create a platform endpoint: + +`aws sns create-platform-endpoint --platform-application-arn {{platform_application_ARN}} --token {{token}}` + +- Add a statement to a topic's access control policy: + +`aws sns add-permission --topic-arn {{topic_ARN}} --label {{topic_label}} --aws-account-id {{account_id}} --action-name {{AddPermission|CreatePlatformApplication|DeleteEndpoint|GetDataProtectionPolicy|GetEndpointAttributes|Subscribe|...}}` + +- Add a tag to the topic with a specific ARN: + +`aws sns tag-resource --resource-arn {{topic_ARN}} --tags {{Key=tag1_key Key=tag2_key,Value=tag2_value ...}}` diff --git a/aws-sqs b/aws-sqs new file mode 100644 index 00000000..e92ff32d --- /dev/null +++ b/aws-sqs @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws sqs + +> Create, delete, and send messages to queues for the AWS SQS service. +> More information: . + +- List all availables queues: + +`aws sqs list-queues` + +- Display the URL of a specific queue: + +`aws sqs get-queue-url --queue-name {{queue_name}}` + +- Create a queue with specific attributes from a file in JSON format: + +`aws sqs create-queue --queue-name {{queue_name}} --attributes {{file://path/to/attributes_file.json}}` + +- Send a specific message to a queue: + +`aws sqs send-message --queue-url https://sqs.{{region}}.amazonaws.com/{{queue_name}} --message-body "{{message_body}}" --delay-seconds {{delay}} --message-attributes {{file://path/to/attributes_file.json}}` + +- Delete the specified message from a queue: + +`aws sqs delete-message --queue-url {{https://queue_url}} --receipt-handle {{receipt_handle}}` + +- Delete a specific queue: + +`aws sqs delete-queue --queue-url https://sqs.{{region}}.amazonaws.com/{{queue_name}}` + +- Delete all messages from the specified queue: + +`aws sqs purge-queue --queue-url https://sqs.{{region}}.amazonaws.com/{{queue_name}}` + +- Enable a specific AWS account to send messages to queue: + +`aws sqs add-permission --queue-url https://sqs.{{region}}.amazonaws.com/{{queue_name}} --label {{permission_name}} --aws-account-ids {{account_id}} --actions SendMessage` diff --git a/aws-sts b/aws-sts new file mode 100644 index 00000000..f6f838d5 --- /dev/null +++ b/aws-sts @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws sts + +> Security Token Service (STS) allows to request temporary credentials for (IAM) users or federated users. +> More information: . + +- Get temporary security credentials to access specific AWS resources: + +`aws sts assume-role --role-arn {{aws_role_arn}}` + +- Get an IAM user or role whose credentials are used to call the operation: + +`aws sts get-caller-identity` diff --git a/aws-vault b/aws-vault new file mode 100644 index 00000000..07f9a7dc --- /dev/null +++ b/aws-vault @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws-vault + +> A vault for securely storing and accessing AWS credentials in development environments. +> More information: . + +- Add credentials to the secure keystore: + +`aws-vault add {{profile}}` + +- Execute a command with AWS credentials in the environment: + +`aws-vault exec {{profile}} -- {{aws s3 ls}}` + +- Open a browser window and login to the AWS Console: + +`aws-vault login {{profile}}` + +- List profiles, along with their credentials and sessions: + +`aws-vault list` + +- Rotate AWS credentials: + +`aws-vault rotate {{profile}}` + +- Remove credentials from the secure keystore: + +`aws-vault remove {{profile}}` diff --git a/aws-workmail b/aws-workmail new file mode 100644 index 00000000..8644d13a --- /dev/null +++ b/aws-workmail @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws workmail + +> Manage Amazon WorkMail. +> More information: . + +- List all WorkMail organizations: + +`aws workmail list-organizations` + +- List all users of a specific organization: + +`aws workmail list-users --organization-id {{organization_id}}` + +- Create a WorkMail user in a specific organization: + +`aws workmail create-user --name {{username}} --display-name {{name}} --password {{password}} --organization-id {{organization_id}}` + +- Register and enable a group/user to WorkMail: + +`aws workmail register-to-work-mail --entity-id {{entity_id}} --email {{email}} --organization-id {{organization_id}}` + +- Create a WorkMail group in a specific organization: + +`aws workmail create-group --name {{group_name}} --organization-id {{organization_id}}` + +- Associate a member to a specific group: + +`aws workmail associate-member-to-group --group-id {{group_id}} --member-id {{member_id}} --organization-id {{organization_id}}` + +- Deregister and disable a user/group from WorkMail: + +`aws workmail deregister-from-work-mail --entity-id {{entity_id}} --organization-id {{organization_id}}` + +- Delete a user from an organization: + +`aws workmail delete-user --user-id {{user_id}} --organization-id {{organization_id}}` diff --git a/awslogs b/awslogs new file mode 100644 index 00000000..c384c1f3 --- /dev/null +++ b/awslogs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# awslogs + +> Queries groups, streams and events from Amazon CloudWatch logs. +> More information: . + +- List log groups: + +`awslogs groups` + +- List existing streams for the specified group: + +`awslogs streams {{/var/log/syslog}}` + +- Get logs for any streams in the specified group between 1 and 2 hours ago: + +`awslogs get {{/var/log/syslog}} --start='{{2h ago}}' --end='{{1h ago}}'` + +- Get logs that match a specific CloudWatch Logs Filter pattern: + +`awslogs get {{/aws/lambda/my_lambda_group}} --filter-pattern='{{ERROR}}'` + +- Watch logs for any streams in the specified group: + +`awslogs get {{/var/log/syslog}} ALL --watch` diff --git a/axel b/axel new file mode 100644 index 00000000..6315ec99 --- /dev/null +++ b/axel @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# axel + +> Download accelerator. +> Supports HTTP, HTTPS, and FTP. +> More information: . + +- Download a URL to a file: + +`axel {{url}}` + +- Download and specify an [o]utput file: + +`axel {{url}} -o {{path/to/file}}` + +- Download with a specific [n]umber connections: + +`axel -n {{connections_num}} {{url}}` + +- [S]earch for mirrors: + +`axel -S {{mirrors_num}} {{url}}` + +- Limit download [s]peed (bytes per second): + +`axel -s {{speed}} {{url}}` diff --git a/az b/az new file mode 100644 index 00000000..4b8644a0 --- /dev/null +++ b/az @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az + +> The official CLI tool for Microsoft Azure. +> Some subcommands such as `az login` have their own usage documentation. +> More information: . + +- Log in to Azure: + +`az login` + +- Manage azure subscription information: + +`az account` + +- List all Azure Managed Disks: + +`az disk list` + +- List all Azure virtual machines: + +`az vm list` + +- Manage Azure Kubernetes Services: + +`az aks` + +- Manage Azure Network resources: + +`az network` diff --git a/az-account b/az-account new file mode 100644 index 00000000..e1d64126 --- /dev/null +++ b/az-account @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az account + +> Manage Azure subscription information. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List all subscriptions for the logged in account: + +`az account list` + +- Set a `subscription` to be the currently active subscription: + +`az account set --subscription {{subscription_id}}` + +- List supported regions for the currently active subscription: + +`az account list-locations` + +- Print an access token to be used with `MS Graph API`: + +`az account get-access-token --resource-type {{ms-graph}}` + +- Print details of the currently active subscription in a specific format: + +`az account show --output {{json|tsv|table|yaml}}` diff --git a/az-acr b/az-acr new file mode 100644 index 00000000..903688c1 --- /dev/null +++ b/az-acr @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az acr + +> Manage private registries with Azure Container Registries. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a managed container registry: + +`az acr create --name {{registry_name}} --resource-group {{resource_group}} --sku {{sku}}` + +- Login to a registry: + +`az acr login --name {{registry_name}}` + +- Tag a local image for ACR: + +`docker tag {{image_name}} {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Push an image to a registry: + +`docker push {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Pull an image from a registry: + +`docker pull {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Delete an image from a registry: + +`az acr repository delete --name {{registry_name}} --repository {{image_name}}:{{tag}}` + +- Delete a managed container registry: + +`az acr delete --name {{registry_name}} --resource-group {{resource_group}} --yes` + +- List images within a registry: + +`az acr repository list --name {{registry_name}} --output table` diff --git a/az-advisor b/az-advisor new file mode 100644 index 00000000..330e06bc --- /dev/null +++ b/az-advisor @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az advisor + +> Manage Azure subscription information. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List Azure Advisor configuration for the entire subscription: + +`az advisor configuration list` + +- Show Azure Advisor configuration for the given subscription or resource group: + +`az advisor configuration show --resource_group {{resource_group}}` + +- List Azure Advisor recommendations: + +`az advisor recommendation list` + +- Enable Azure Advisor recommendations: + +`az advisor recommendation enable --resource_group {{resource_group}}` + +- Disable Azure Advisor recommendations: + +`az advisor recommendation disable --resource_group {{resource_group}}` diff --git a/az-aks b/az-aks new file mode 100644 index 00000000..9407378d --- /dev/null +++ b/az-aks @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az aks + +> Manage Azure Kubernetes Service (AKS) clusters. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List AKS clusters: + +`az aks list --resource-group {{resource_group}}` + +- Create a new AKS cluster: + +`az aks create --resource-group {{resource_group}} --name {{name}} --node-count {{count}} --node-vm-size {{size}}` + +- Delete an AKS cluster: + +`az aks delete --resource-group {{resource_group}} --name {{name}}` + +- Get the access credentials for an AKS cluster: + +`az aks get-credentials --resource-group {{resource_group}} --name {{name}}` + +- Get the upgrade versions available for an AKS cluster: + +`az aks get-upgrades --resource-group {{resource_group}} --name {{name}}` diff --git a/az-apim b/az-apim new file mode 100644 index 00000000..ec831670 --- /dev/null +++ b/az-apim @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az apim + +> Manage Azure API Management services. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List API Management services within a resource group: + +`az apim list --resource-group {{resource_group}}` + +- Create an API Management service instance: + +`az apim create --name {{name}} --resource-group {{resource_group}} --publisher-email {{email}} --publisher-name {{name}}` + +- Delete an API Management service: + +`az apim delete --name {{name}} --resource-group {{resource_group}}` + +- Show details of an API Management service instance: + +`az apim show --name {{name}} --resource-group {{resource_group}}` + +- Update an API Management service instance: + +`az apim update --name {{name}} --resource-group {{resource_group}}` diff --git a/az-appconfig b/az-appconfig new file mode 100644 index 00000000..d7011788 --- /dev/null +++ b/az-appconfig @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az appconfig + +> Manage App configurations on Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create an App Configuration: + +`az appconfig create --name {{name}} --resource-group {{group_name}} --location {{location}}` + +- Delete a specific App Configuration: + +`az appconfig delete --resource-group {{rg_name}} --name {{appconfig_name}}` + +- List all App Configurations under the current subscription: + +`az appconfig list` + +- List all App Configurations under a specific resource group: + +`az appconfig list --resource-group {{rg_name}}` + +- Show properties of an App Configuration: + +`az appconfig show --name {{appconfig_name}}` + +- Update a specific App Configuration: + +`az appconfig update --resource-group {{rg_name}} --name {{appconfig_name}}` diff --git a/az-bicep b/az-bicep new file mode 100644 index 00000000..dc66ddd7 --- /dev/null +++ b/az-bicep @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az bicep + +> Bicep CLI command group. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Install Bicep CLI: + +`az bicep install` + +- Build a Bicep file: + +`az bicep build --file {{path/to/file.bicep}}` + +- Attempt to decompile an ARM template file to a Bicep file: + +`az bicep decompile --file {{path/to/template_file.json}}` + +- Upgrade Bicep CLI to the latest version: + +`az bicep upgrade` + +- Display the installed version of Bicep CLI: + +`az bicep version` + +- List all available versions of Bicep CLI: + +`az bicep list-versions` + +- Uninstall Bicep CLI: + +`az bicep uninstall` diff --git a/az-config b/az-config new file mode 100644 index 00000000..e37c1196 --- /dev/null +++ b/az-config @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az config + +> Manage Azure CLI configuration. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Print all configurations: + +`az config get` + +- Print configurations for a specific section: + +`az config get {{section_name}}` + +- Set a configuration: + +`az config set {{configuration_name}}={{value}}` + +- Unset a configuration: + +`az config unset {{configuration_name}}` diff --git a/az-devops b/az-devops new file mode 100644 index 00000000..55e32ad9 --- /dev/null +++ b/az-devops @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az devops + +> Manage Azure DevOps organizations. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Set the Personal Access Token (PAT) to login to a particular organization: + +`az devops login --organization {{organization_url}}` + +- Open a project in the browser: + +`az devops project show --project {{project_name}} --open` + +- List members of a specific team working on a particular project: + +`az devops team list-member --project {{project_name}} --team {{team_name}}` + +- Check the Azure DevOps CLI current configuration: + +`az devops configure --list` + +- Configure the Azure DevOps CLI behavior by setting a default project and a default organization: + +`az devops configure --defaults project={{project_name}} organization={{organization_url}}` diff --git a/az-feedback b/az-feedback new file mode 100644 index 00000000..cb74fdeb --- /dev/null +++ b/az-feedback @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az feedback + +> Send feedback to the Azure CLI Team. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Send feedback to the Azure CLI Team: + +`az feedback` diff --git a/az-group b/az-group new file mode 100644 index 00000000..84a1028f --- /dev/null +++ b/az-group @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az group + +> Manage resource groups and template deployments. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a new resource group: + +`az group create --name {{name}} --location {{location}}` + +- Check if a resource group exists: + +`az group exists --name {{name}}` + +- Delete a resource group: + +`az group delete --name {{name}}` + +- Wait until a condition of the resource group is met: + +`az group wait --name {{name}} --{{created|deleted|exists|updated}}` diff --git a/az-lock b/az-lock new file mode 100644 index 00000000..0c37d202 --- /dev/null +++ b/az-lock @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az lock + +> Manage Azure locks. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a read-only subscription level lock: + +`az lock create --name {{lock_name}} --lock-type ReadOnly` + +- Create a read-only resource group level lock: + +`az lock create --name {{lock_name}} --resource-group {{group_name}} --lock-type ReadOnly` + +- Delete a subscription level lock: + +`az lock delete --name {{lock_name}}` + +- Delete a resource group level lock: + +`az lock delete --name {{lock_name}} --resource-group {{group_name}}` + +- List out all locks on the subscription level: + +`az lock list` + +- Show a subscription level lock with a specific [n]ame: + +`az lock show -n {{lock_name}}` diff --git a/az-login b/az-login new file mode 100644 index 00000000..799cfb3f --- /dev/null +++ b/az-login @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az login + +> Log in to Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Log in interactively: + +`az login` + +- Log in with a service principal using a client secret: + +`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{secret}} --tenant {{someone.onmicrosoft.com}}` + +- Log in with a service principal using a client certificate: + +`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{path/to/cert.pem}} --tenant {{someone.onmicrosoft.com}}` + +- Log in using a VM's system assigned identity: + +`az login --identity` + +- Log in using a VM's user assigned identity: + +`az login --identity --username /subscriptions/{{subscription_id}}/resourcegroups/{{my_rg}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{my_id}}` diff --git a/az-logout b/az-logout new file mode 100644 index 00000000..683a494f --- /dev/null +++ b/az-logout @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az logout + +> Log out from an Azure subscription. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Log out from the active account: + +`az logout` + +- Log out a specific username: + +`az logout --username {{alias@somedomain.com}}` diff --git a/az-network b/az-network new file mode 100644 index 00000000..1d89b9de --- /dev/null +++ b/az-network @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az network + +> Manage Azure Network resources. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List network resources in a region that are used against a subscription quota: + +`az network list-usages` + +- List all virtual networks in a subscription: + +`az network vnet list` + +- Create a virtual network: + +`az network vnet create --address-prefixes {{10.0.0.0/16}} --name {{vnet}} --resource_group {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` + +- Enable accelerated networking for a network interface card: + +`az network nic update --accelerated-networking true --name {{nic}} --resource-group {{resource_group}}` diff --git a/az-pipelines b/az-pipelines new file mode 100644 index 00000000..bb2925f1 --- /dev/null +++ b/az-pipelines @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az pipelines + +> Manage Azure Pipelines resources. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a new Azure Pipeline (YAML based): + +`az pipelines create --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --description {{description}} --repository {{repository_name}} --branch {{branch_name}}` + +- Delete a specific pipeline: + +`az pipelines delete --org {{organization_url}} --project {{project_name}} --id {{pipeline_id}}` + +- List pipelines: + +`az pipelines list --org {{organization_url}} --project {{project_name}}` + +- Enqueue a specific pipeline to run: + +`az pipelines run --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` + +- Get the details of a specific pipeline: + +`az pipelines show --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` + +- Update a specific pipeline: + +`az pipelines update --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --new-name {{pipeline_new_name}} --new-folder-path {{user1/production_pipelines}}` + +- List all agents in a pool: + +`az pipelines agent list --org {{organization_url}} --pool-id {{agent_pool}}` diff --git a/az-provider b/az-provider new file mode 100644 index 00000000..76f84d43 --- /dev/null +++ b/az-provider @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az provider + +> Manage resource providers. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Register a provider: + +`az provider register --namespace {{Microsoft.PolicyInsights}}` + +- Unregister a provider: + +`az provider unregister --namespace {{Microsoft.Automation}}` + +- List all providers for a subscription: + +`az provider list` + +- Show information about a specific provider: + +`az provider show --namespace {{Microsoft.Storage}}` + +- List all resource types for a specific provider: + +`az provider list --query "[?namespace=='{{Microsoft.Network}}'].resourceTypes[].resourceType"` diff --git a/az-redis b/az-redis new file mode 100644 index 00000000..eff71e27 --- /dev/null +++ b/az-redis @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az redis + +> Manage Redis caches. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a new Redis cache instance: + +`az redis create --location {{location}} --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` + +- Update a Redis cache: + +`az redis update --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` + +- Export data stored in a Redis cache: + +`az redis export --container {{container}} --file-format {{file-format}} --name {{name}} --prefix {{prefix}} --resource-group {{resource_group}}` + +- Delete a Redis cache: + +`az redis delete --name {{name}} --resource-group {{resource_group}} --yes` diff --git a/az-repos b/az-repos new file mode 100644 index 00000000..f3f18d78 --- /dev/null +++ b/az-repos @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az repos + +> Manage Azure DevOps repos. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List all repos in a specific project: + +`az repos list --project {{project_name}}` + +- Add policy on a specific branch of a specific repository to restrict basic merge: + +`az repos policy merge-strategy create --repository-id {{repository_id_in_repos_list}} --branch {{branch_name}} --blocking --enabled --allow-no-fast-forward false --allow-rebase true --allow-rebase-merge true --allow-squash true` + +- Add build validation on a specific repository, using an existing build pipeline, to be triggered automatically on source update: + +`az repos policy build create --repository-id {{repository_id}} --build-definition-id {{build_pipeline_id}} --branch main --blocking --enabled --queue-on-source-update-only true --display-name {{name}} --valid-duration {{minutes}}` + +- List all active Pull Requests on a specific repository within a specific project: + +`az repos pr list --project {{project_name}} --repository {{repository_name}} --status active` diff --git a/az-sshkey b/az-sshkey new file mode 100644 index 00000000..b75e14cb --- /dev/null +++ b/az-sshkey @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az sshkey + +> Manage ssh public keys with virtual machines. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a new SSH key: + +`az sshkey create --name {{name}} --resource-group {{resource_group}}` + +- Upload an existing SSH key: + +`az sshkey create --name {{name}} --resource-group {{resource_group}} --public-key "{{@path/to/key.pub}}"` + +- List all SSH public keys: + +`az sshkey list` + +- Show information about an SSH public key: + +`az sshkey show --name {{name}} --resource-group {{resource_group}}` diff --git a/az-storage b/az-storage new file mode 100644 index 00000000..73994b5c --- /dev/null +++ b/az-storage @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage + +> Manage Azure Cloud Storage resources. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a storage account specifying a [l]ocation: + +`az storage account create --resource-group {{group_name}} --name {{account_name}} -l {{location}} --sku {{account_sku}}` + +- List all storage accounts in a resource group: + +`az storage account list --resource-group {{group_name}}` + +- List the access keys for a storage account: + +`az storage account keys list --resource-group {{group_name}} --name {{account_name}}` + +- Delete a storage account: + +`az storage account delete --resource-group {{group_name}} --name {{account_name}}` + +- Update the minimum tls version setting for a storage account: + +`az storage account update --min-tls-version {{TLS1_0|TLS1_1|TLS1_2}} --resource-group {{group_name}} --name {{account_name}}` diff --git a/az-storage-account b/az-storage-account new file mode 100644 index 00000000..c8550449 --- /dev/null +++ b/az-storage-account @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage account + +> Manage storage accounts in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create an storage account: + +`az storage account create --name {{storage_account_name}} --resource-group {{azure_resource_group}} --location {{azure_location}} --sku {{storage_account_sku}}` + +- Generate a shared access signature for a specific storage account: + +`az storage account generate-sas --account-name {{storage_account_name}} --name {{account_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --services {{storage_services}} --resource-types {{resource_types}}` + +- List storage accounts: + +`az storage account list --resource-group {{azure_resource_group}}` + +- Delete a specific storage account: + +`az storage account delete --name {{storage_account_name}} --resource-group {{azure_resource_group}}` diff --git a/az-storage-blob b/az-storage-blob new file mode 100644 index 00000000..0ec6978b --- /dev/null +++ b/az-storage-blob @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage blob + +> Manage blob storage containers and objects in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Download a blob to a [f]ile path specifying a [s]ource container: + +`az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} -f {{path/to/local_file}}` + +- [d]ownload blobs from a blob container recursively: + +`az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} -s {{container_name}} -d {{path/to/remote}} --pattern {{filename_regex}} --destination {{path/to/destination}}` + +- Upload a local file to blob storage: + +`az storage blob upload --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} -f {{path/to/local_file}}` + +- Delete a blob object: + +`az storage blob delete --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}}` + +- Generate a shared access signature for a blob: + +`az storage blob generate-sas --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} --permissions {{permission_set}} --expiry {{Y-m-d'T'H:M'Z'}} --https-only` diff --git a/az-storage-container b/az-storage-container new file mode 100644 index 00000000..92710310 --- /dev/null +++ b/az-storage-container @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage container + +> Manage blob storage containers in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a container in a storage account: + +`az storage container create --account-name {{storage_account_name}} --name {{container_name}} --public-access {{access_level}} --fail-on-exist` + +- Generate a shared access signature for the container: + +`az storage container generate-sas --account-name {{storage_account_name}} --name {{container_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` + +- List containers in a storage account: + +`az storage container list --account-name {{storage_account_name}} --prefix {{filter_prefix}}` + +- Mark the specified container for deletion: + +`az storage container delete --account-name {{storage_account_name}} --name {{container_name}} --fail-not-exist` diff --git a/az-storage-entity b/az-storage-entity new file mode 100644 index 00000000..3d53b046 --- /dev/null +++ b/az-storage-entity @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage entity + +> Manage Azure Table storage entities. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Insert an entity into a table: + +`az storage entity insert --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` + +- Delete an existing entity from a table: + +`az storage entity delete --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` + +- Update an existing entity by merging its properties: + +`az storage entity merge --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` + +- List entities which satisfy a query: + +`az storage entity query --filter {{query_filter}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` + +- Get an entity from the specified table: + +`az storage entity show --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` diff --git a/az-storage-queue b/az-storage-queue new file mode 100644 index 00000000..76e78255 --- /dev/null +++ b/az-storage-queue @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage queue + +> Manage storage queues in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a queue: + +`az storage queue create --account-name {{storage_account_name}} --name {{queue_name}} --metadata {{queue_metadata}}` + +- Generate a shared access signature for the queue: + +`az storage queue generate-sas --account-name {{storage_account_name}} --name {{queue_name}} --permissions {{queue_permissions}} --expiry {{expiry_date}} --https-only` + +- List queues in a storage account: + +`az storage queue list --prefix {{filter_prefix}} --account-name {{storage_account_name}}` + +- Delete the specified queue and any messages it contains: + +`az storage queue delete --account-name {{storage_account_name}} --name {{queue_name}} --fail-not-exist` diff --git a/az-storage-table b/az-storage-table new file mode 100644 index 00000000..349e0c63 --- /dev/null +++ b/az-storage-table @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az storage table + +> Manage NoSQL key-value storage in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a new table in the storage account: + +`az storage table create --account-name {{storage_account_name}} --name {{table_name}} --fail-on-exist` + +- Generate a shared access signature for the table: + +`az storage table generate-sas --account-name {{storage_account_name}} --name {{table_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` + +- List tables in a storage account: + +`az storage table list --account-name {{storage_account_name}}` + +- Delete the specified table and any data it contains: + +`az storage table delete --account-name {{storage_account_name}} --name {{table_name}} --fail-not-exist` diff --git a/az-tag b/az-tag new file mode 100644 index 00000000..2ca0107a --- /dev/null +++ b/az-tag @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az tag + +> Manage tags on a resource. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a tag value: + +`az tag add-value --name {{tag_name}} --value {{tag_value}}` + +- Create a tag in the subscription: + +`az tag create --name {{tag_name}}` + +- Delete a tag from the subscription: + +`az tag delete --name {{tag_name}}` + +- List all tags on a subscription: + +`az tag list --resource-id /subscriptions/{{subscription_id}}` + +- Delete a tag value for a specific tag name: + +`az tag remove-value --name {{tag_name}} --value {{tag_value}}` diff --git a/az-term b/az-term new file mode 100644 index 00000000..8e9820b8 --- /dev/null +++ b/az-term @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az term + +> Manage marketplace agreement with marketplaceordering. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Print marketplace terms: + +`az term show --product "{{product_identifier}}" --plan "{{plan_identifier}}" --publisher "{{publisher_identifier}}"` + +- Accept marketplace terms: + +`az term accept --product "{{product_identifier}}" --plan "{{plan_identifier}}" --publisher "{{publisher_identifier}}"` diff --git a/az-upgrade b/az-upgrade new file mode 100644 index 00000000..acaa2d02 --- /dev/null +++ b/az-upgrade @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az upgrade + +> Upgrade Azure CLI and Extensions. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Upgrade Azure CLI: + +`az upgrade` + +- Upgrade Azure CLI and Extensions: + +`az upgrade --all` + +- Upgrade Azure CLI and Extensions without prompting for confirmation: + +`az version --all --yes` diff --git a/az-version b/az-version new file mode 100644 index 00000000..97901280 --- /dev/null +++ b/az-version @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az version + +> Shows the current version of Azure CLI modules and extensions. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Show the current version of Azure CLI modules and extensions in JSON format: + +`az version` + +- Show the current version of Azure CLI modules and extensions in a given format: + +`az version --output {{json|table|tsv}}` diff --git a/az-vm b/az-vm new file mode 100644 index 00000000..9275f9eb --- /dev/null +++ b/az-vm @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az vm + +> Manage virtual machines in Azure. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List details of available Virtual Machines: + +`az vm list` + +- Create a virtual machine using the default Ubuntu image and generate ssh keys: + +`az vm create --resource-group {{rg}} --name {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` + +- Stop a Virtual Machine: + +`az vm stop --resource-group {{rg}} --name {{vm_name}}` + +- Deallocate a Virtual Machine: + +`az vm deallocate --resource-group {{rg}} --name {{vm_name}}` + +- Start a Virtual Machine: + +`az vm start --resource-group {{rg}} --name {{vm_name}}` + +- Restart a Virtual Machine: + +`az vm restart --resource-group {{rg}} --name {{vm_name}}` + +- List VM images available in the Azure Marketplace: + +`az vm image list` diff --git a/az-webapp b/az-webapp new file mode 100644 index 00000000..ace32379 --- /dev/null +++ b/az-webapp @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# az webapp + +> Manage Web Applications hosted in Azure Cloud Services. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List available runtimes for a web application: + +`az webapp list-runtimes --os-type {{windows|linux}}` + +- Create a web application: + +`az webapp up --name {{name}} --location {{location}} --runtime {{runtime}}` + +- List all web applications: + +`az webapp list` + +- Delete a specific web application: + +`az webapp delete --name {{name}} --resource-group {{resource_group}}` diff --git a/azure-cli b/azure-cli new file mode 100644 index 00000000..7c4d4969 --- /dev/null +++ b/azure-cli @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# azure-cli + +> This command is an alias of `az`. +> More information: . + +- View documentation for the original command: + +`tldr az` diff --git a/azurite b/azurite new file mode 100644 index 00000000..feae1e41 --- /dev/null +++ b/azurite @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# azurite + +> Azure Storage API compatible server (emulator) in local environment. +> More information: . + +- Use an existing [l]ocation as workspace path: + +`azurite {{-l|--location}} {{path/to/directory}}` + +- Disable access log displayed in console: + +`azurite {{-s|--silent}}` + +- Enable [d]ebug log by providing a file path as log destination: + +`azurite {{-d|--debug}} {{path/to/debug.log}}` + +- Customize the listening address of Blob/Queue/Table service: + +`azurite {{--blobHost|--queueHost|--tableHost}} {{0.0.0.0}}` + +- Customize the listening port of Blob/Queue/Table service: + +`azurite {{--blobPort|--queuePort|--tablePort}} {{8888}}` diff --git a/b2sum b/b2sum new file mode 100644 index 00000000..ba51e7a6 --- /dev/null +++ b/b2sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# b2sum + +> Calculate BLAKE2 cryptographic checksums. +> More information: . + +- Calculate the BLAKE2 checksum for one or more files: + +`b2sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of BLAKE2 checksums to a file: + +`b2sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.b2}}` + +- Calculate a BLAKE2 checksum from `stdin`: + +`{{command}} | b2sum` + +- Read a file of BLAKE2 sums and filenames and verify all files have matching checksums: + +`b2sum --check {{path/to/file.b2}}` + +- Only show a message for missing files or when verification fails: + +`b2sum --check --quiet {{path/to/file.b2}}` + +- Only show a message when verification fails, ignoring missing files: + +`b2sum --ignore-missing --check --quiet {{path/to/file.b2}}` diff --git a/b3sum b/b3sum new file mode 100644 index 00000000..71ec766e --- /dev/null +++ b/b3sum @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# b3sum + +> Calculate BLAKE3 cryptographic checksums. +> More information: . + +- Calculate the BLAKE3 checksum for one or more files: + +`b3sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of BLAKE3 checksums to a file: + +`b3sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.b3}}` + +- Calculate a BLAKE3 checksum from `stdin`: + +`{{command}} | b3sum` + +- Read a file of BLAKE3 sums and filenames and verify all files have matching checksums: + +`b3sum --check {{path/to/file.b3}}` + +- Only show a message for missing files or when verification fails: + +`b3sum --check --quiet {{path/to/file.b3}}` diff --git a/babel b/babel new file mode 100644 index 00000000..51cdace7 --- /dev/null +++ b/babel @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# babel + +> A transpiler which converts code from JavaScript ES6/ES7 syntax to ES5 syntax. +> More information: . + +- Transpile a specified input file and output to `stdout`: + +`babel {{path/to/file}}` + +- Transpile a specified input file and output to a specific file: + +`babel {{path/to/input_file}} --out-file {{path/to/output_file}}` + +- Transpile the input file every time it is changed: + +`babel {{path/to/input_file}} --watch` + +- Transpile a whole directory of files: + +`babel {{path/to/input_directory}}` + +- Ignore specified comma-separated files in a directory: + +`babel {{path/to/input_directory}} --ignore {{ignored_file1,ignored_file2,...}}` + +- Transpile and output as minified JavaScript: + +`babel {{path/to/input_file}} --minified` + +- Choose a set of presets for output formatting: + +`babel {{path/to/input_file}} --presets {{preset1,preset2,...}}` + +- Display help: + +`babel --help` diff --git a/babeld b/babeld new file mode 100644 index 00000000..3abd7c3c --- /dev/null +++ b/babeld @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# babeld + +> Routing daemon for Babel which uses firewall-style filters. +> More information: . + +- Start the daemon with one or more [c]onfiguration files (read in order): + +`babeld -c {{path/to/ports.conf}} -c {{path/to/filters.conf}} -c {{path/to/interfaces.conf}}` + +- [D]eamonize after startup: + +`babeld -D` + +- Specify a [C]onfiguration command: + +`babeld -C {{'redistribute metric 256'}}` + +- Specify on which interfaces to operate: + +`babeld {{eth0}} {{eth1}} {{wlan0}}` diff --git a/badblocks b/badblocks new file mode 100644 index 00000000..f292f859 --- /dev/null +++ b/badblocks @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# badblocks + +> Search a device for bad blocks. +> Some usages of badblocks can cause destructive actions, such as erasing all data on a disk, including the partition table. +> More information: . + +- Search a disk for bad blocks by using a non-destructive read-only test: + +`sudo badblocks {{/dev/sdX}}` + +- Search an unmounted disk for bad blocks with a [n]on-destructive read-write test: + +`sudo badblocks -n {{/dev/sdX}}` + +- Search an unmounted disk for bad blocks with a destructive [w]rite test: + +`sudo badblocks -w {{/dev/sdX}}` + +- Use the destructive [w]rite test and [s]how [v]erbose progress: + +`sudo badblocks -svw {{/dev/sdX}}` + +- In destructive mode, [o]utput found blocks to a file: + +`sudo badblocks -o {{path/to/file}} -w {{/dev/sdX}}` + +- Use the destructive mode with improved speed using 4K [b]lock size and 64K block [c]ount: + +`sudo badblocks -w -b {{4096}} -c {{65536}} {{/dev/sdX}}` diff --git a/balena b/balena new file mode 100644 index 00000000..f6486565 --- /dev/null +++ b/balena @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# balena + +> Interact with the balenaCloud, openBalena and the balena API. +> More information: . + +- Log in to the balenaCloud account: + +`balena login` + +- Create a balenaCloud or openBalena application: + +`balena app create {{app_name}}` + +- List all balenaCloud or openBalena applications within the account: + +`balena apps` + +- List all devices associated with the balenaCloud or openBalena account: + +`balena devices` + +- Flash a balenaOS image to a local drive: + +`balena local flash {{path/to/balenaos.img}} --drive {{drive_location}}` diff --git a/bandwhich b/bandwhich new file mode 100644 index 00000000..298d7310 --- /dev/null +++ b/bandwhich @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bandwhich + +> Display the current network utilization by process, connection or remote IP/hostname. +> More information: . + +- Show the remote addresses table only: + +`bandwhich --addresses` + +- Show DNS queries: + +`bandwhich --show-dns` + +- Show total (cumulative) usage: + +`bandwhich --total-utilization` + +- Show the network utilization for a specific network interface: + +`bandwhich --interface {{eth0}}` + +- Show DNS queries with a given DNS server: + +`bandwhich --show-dns --dns-server {{dns_server_ip}}` diff --git a/banner b/banner new file mode 100644 index 00000000..4ffae173 --- /dev/null +++ b/banner @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# banner + +> Print the argument as a large ASCII art. +> More information: . + +- Print the text message as a large banner (quotes are optional): + +`banner "{{Hello World}}"` + +- Use a banner [w]idth of 50 characters: + +`banner -w 50 "{{Hello World}}"` + +- Read text from `stdin`: + +`banner` diff --git a/base32 b/base32 new file mode 100644 index 00000000..7eae151b --- /dev/null +++ b/base32 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# base32 + +> Encode or decode file or `stdin` to/from Base32, to `stdout`. +> More information: . + +- Encode a file: + +`base32 {{path/to/file}}` + +- Decode a file: + +`base32 --decode {{path/to/file}}` + +- Encode from `stdin`: + +`{{somecommand}} | base32` + +- Decode from `stdin`: + +`{{somecommand}} | base32 --decode` diff --git a/base64 b/base64 new file mode 100644 index 00000000..b88205fb --- /dev/null +++ b/base64 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# base64 + +> Encode or decode file or `stdin` to/from Base64, to `stdout`. +> More information: . + +- Encode the contents of a file as base64 and write the result to `stdout`: + +`base64 {{path/to/file}}` + +- Decode the base64 contents of a file and write the result to `stdout`: + +`base64 --decode {{path/to/file}}` + +- Encode from `stdin`: + +`{{somecommand}} | base64` + +- Decode from `stdin`: + +`{{somecommand}} | base64 --decode` diff --git a/basename b/basename new file mode 100644 index 00000000..5681ac2b --- /dev/null +++ b/basename @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# basename + +> Remove leading directory portions from a path. +> More information: . + +- Show only the file name from a path: + +`basename {{path/to/file}}` + +- Show only the rightmost directory name from a path: + +`basename {{path/to/directory/}}` + +- Show only the file name from a path, with a suffix removed: + +`basename {{path/to/file}} {{suffix}}` diff --git a/basenc b/basenc new file mode 100644 index 00000000..4d59d750 --- /dev/null +++ b/basenc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# basenc + +> Encode or decode file or `stdin` using a specified encoding, to `stdout`. +> More information: . + +- Encode a file with base64 encoding: + +`basenc --base64 {{path/to/file}}` + +- Decode a file with base64 encoding: + +`basenc --decode --base64 {{path/to/file}}` + +- Encode from `stdin` with base32 encoding with 42 columns: + +`{{command}} | basenc --base32 -w42` + +- Encode from `stdin` with base32 encoding: + +`{{command}} | basenc --base32` diff --git a/bash b/bash new file mode 100644 index 00000000..a0692d7c --- /dev/null +++ b/bash @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bash + +> Bourne-Again SHell, an `sh`-compatible command-line interpreter. +> See also: `zsh`, `histexpand` (history expansion). +> More information: . + +- Start an interactive shell session: + +`bash` + +- Start an interactive shell session without loading startup configs: + +`bash --norc` + +- Execute specific [c]ommands: + +`bash -c "{{echo 'bash is executed'}}"` + +- Execute a specific script: + +`bash {{path/to/script.sh}}` + +- E[x]ecute a specific script, printing each command before executing it: + +`bash -x {{path/to/script.sh}}` + +- Execute a specific script and stop at the first [e]rror: + +`bash -e {{path/to/script.sh}}` + +- Execute specific commands from `stdin`: + +`{{echo "echo 'bash is executed'"}} | bash` + +- Start a [r]estricted shell session: + +`bash -r` diff --git a/bash-it b/bash-it new file mode 100644 index 00000000..93847910 --- /dev/null +++ b/bash-it @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bash-it + +> A collection of community contributed Bash commands and scripts for Bash 3.2+. +> More information: . + +- Update Bash-it to the latest stable/development version: + +`bash-it update {{stable|dev}}` + +- Reload Bash profile (set `BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` to non-empty value for an automatic reload): + +`bash-it reload` + +- Restart Bash: + +`bash-it restart` + +- Reload Bash profile with enabled error and warning logging: + +`bash-it doctor` + +- Reload Bash profile with enabled error/warning/entire logging: + +`bash-it doctor {{errors|warnings|all}}` + +- Search for Bash-it aliases/plugins/completions: + +`bash-it search {{alias|plugin|completion}}` + +- Search for Bash-it aliases/plugins/completions and enable/disable all found items: + +`bash-it search --{{enable|disable}} {{alias|plugin|completion}}` diff --git a/bashmarks b/bashmarks new file mode 100644 index 00000000..726e12f6 --- /dev/null +++ b/bashmarks @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bashmarks + +> Save and jump to commonly used directories using 1 character commands. +> More information: . + +- List available bookmarks: + +`l` + +- Save the current directory as "bookmark_name": + +`s {{bookmark_name}}` + +- Go to a bookmarked directory: + +`g {{bookmark_name}}` + +- Print a bookmarked directory's contents: + +`p {{bookmark_name}}` + +- Delete a bookmark: + +`d {{bookmark_name}}` diff --git a/bastet b/bastet new file mode 100644 index 00000000..71e4707d --- /dev/null +++ b/bastet @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bastet + +> Clone of the game Tetris in the terminal. +> More information: . + +- Start a Tetris game: + +`bastet` + +- Navigate the piece horizontally: + +`{{Left|Right arrow key}}` + +- Rotate the piece clockwise or counterclockwise: + +`{{Spacebar|Up arrow key}}` + +- Soft drop the piece: + +`` + +- Hard drop the piece: + +`` + +- Pause the game: + +`p` + +- Quit the game: + +` + C` diff --git a/bat b/bat new file mode 100644 index 00000000..65f0ecc5 --- /dev/null +++ b/bat @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bat + +> Print and concatenate files. +> A `cat` clone with syntax highlighting and Git integration. +> More information: . + +- Print the contents of one or more files to `stdout`: + +`bat {{path/to/file1 path/to/file2 ...}}` + +- Concatenate several files into the target file: + +`bat {{path/to/file1 path/to/file2 ...}} > {{path/to/target_file}}` + +- Append several files into the target file: + +`bat {{path/to/file1 path/to/file2 ...}} >> {{path/to/target_file}}` + +- Number all output lines: + +`bat --number {{path/to/file}}` + +- Syntax highlight a JSON file: + +`bat --language json {{path/to/file.json}}` + +- Display all supported languages: + +`bat --list-languages` diff --git a/batch b/batch new file mode 100644 index 00000000..8d984ea8 --- /dev/null +++ b/batch @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# batch + +> Execute commands at a later time when the system load levels permit. +> Service atd (or atrun) should be running for the actual executions. +> More information: . + +- Execute commands from `stdin` (press `Ctrl + D` when done): + +`batch` + +- Execute a command from `stdin`: + +`echo "{{./make_db_backup.sh}}" | batch` + +- Execute commands from a given [f]ile: + +`batch -f {{path/to/file}}` diff --git a/bazel b/bazel new file mode 100644 index 00000000..0c53cc9b --- /dev/null +++ b/bazel @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bazel + +> Open-source build and test tool similar to Make, Maven, and Gradle. +> More information: . + +- Build the specified target in the workspace: + +`bazel build {{target}}` + +- Remove output files and stop the server if running: + +`bazel clean` + +- Stop the bazel server: + +`bazel shutdown` + +- Display runtime info about the bazel server: + +`bazel info` + +- Display help: + +`bazel help` + +- Display version: + +`bazel version` diff --git a/bb b/bb new file mode 100644 index 00000000..bce4ab8b --- /dev/null +++ b/bb @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bb + +> Native Clojure interpreter for scripting. +> More information: . + +- [e]valuate an expression: + +`bb -e "(+ 1 2 3)"` + +- Evaluate a script [f]ile: + +`bb -f {{path/to/script.clj}}` + +- Bind [i]nput to a sequence of lines from `stdin`: + +`printf "first +second" | bb -i "(map clojure.string/capitalize *input*)"` + +- Bind [I]nput to a sequence of EDN (Extensible Data Notation) values from `stdin`: + +`echo "{:key 'val}" | bb -I "(:key (first *input*))"` diff --git a/bc b/bc new file mode 100644 index 00000000..39f461f9 --- /dev/null +++ b/bc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bc + +> An arbitrary precision calculator language. +> See also: `dc`. +> More information: . + +- Start an interactive session: + +`bc` + +- Start an interactive session with the standard math library enabled: + +`bc --mathlib` + +- Calculate an expression: + +`echo '{{5 / 3}}' | bc` + +- Execute a script: + +`bc {{path/to/script.bc}}` + +- Calculate an expression with the specified scale: + +`echo 'scale = {{10}}; {{5 / 3}}' | bc` + +- Calculate a sine/cosine/arctangent/natural logarithm/exponential function using `mathlib`: + +`echo '{{s|c|a|l|e}}({{1}})' | bc --mathlib` diff --git a/bcomps b/bcomps new file mode 100644 index 00000000..f2da43b7 --- /dev/null +++ b/bcomps @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bcomps + +> Decompose graphs into their biconnected components. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Decompose one or more graphs into their biconnected components: + +`bcomps {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Print the number of blocks and cutvertices in one or more graphs: + +`bcomps -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}` + +- Write each block and block-cutvertex tree to multiple numbered filenames based on `output.gv`: + +`bcomps -x -o {{path/to/output.gv}} {{path/to/input1.gv path/to/input2.gv ...}}` + +- Display help: + +`bcomps -?` diff --git a/beanstalkd b/beanstalkd new file mode 100644 index 00000000..7b1e8439 --- /dev/null +++ b/beanstalkd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# beanstalkd + +> A simple and generic work-queue server. +> More information: . + +- Start the server, listening on port 11300: + +`beanstalkd` + +- Listen on a specific [p]ort and address: + +`beanstalkd -l {{ip_address}} -p {{port_number}}` + +- Persist work queues by saving them to disk: + +`beanstalkd -b {{path/to/persistence_directory}}` + +- Sync to the persistence directory every 500 milliseconds: + +`beanstalkd -b {{path/to/persistence_directory}} -f {{500}}` diff --git a/bedtools b/bedtools new file mode 100644 index 00000000..2f502311 --- /dev/null +++ b/bedtools @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bedtools + +> A swiss-army knife of tools for genomic-analysis tasks. +> Used to intersect, group, convert and count data in BAM, BED, GFF/GTF, VCF format. +> More information: . + +- Intersect file [a] and file(s) [b] regarding the sequences' [s]trand and save the result to a specific file: + +`bedtools intersect -a {{path/to/file_A}} -b {{path/to/file_B1 path/to/file_B2 ...}} -s > {{path/to/output_file}}` + +- Intersect two files with a [l]eft [o]uter [j]oin, i.e. report each feature from `file1` and NULL if no overlap with `file2`: + +`bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -loj > {{path/to/output_file}}` + +- Using more efficient algorithm to intersect two pre-sorted files: + +`bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -sorted > {{path/to/output_file}}` + +- [g]roup a file based on the first three and the fifth [c]olumn and apply the sum [o]peration on the sixth column: + +`bedtools groupby -i {{path/to/file}} -c 1-3,5 -g 6 -o sum` + +- Convert bam-formatted [i]nput file to a bed-formatted one: + +`bedtools bamtobed -i {{path/to/file.bam}} > {{path/to/file.bed}}` + +- Find for all features in `file1.bed` the closest one in `file2.bed` and write their [d]istance in an extra column (input files must be sorted): + +`bedtools closest -a {{path/to/file1.bed}} -b {{path/to/file2.bed}} -d` diff --git a/behat b/behat new file mode 100644 index 00000000..41c8b847 --- /dev/null +++ b/behat @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# behat + +> A PHP framework for Behaviour-Driven Development. +> More information: . + +- Initialize a new Behat project: + +`behat --init` + +- Run all tests: + +`behat` + +- Run all tests from the specified suite: + +`behat --suite={{suite_name}}` + +- Run tests with a specific output formatter: + +`behat --format {{pretty|progress}}` + +- Run tests and output results to a file: + +`behat --out {{path/to/file}}` + +- List the definitions in your test suites: + +`behat --definitions` diff --git a/berks b/berks new file mode 100644 index 00000000..c4eda9c4 --- /dev/null +++ b/berks @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# berks + +> Chef cookbook dependency manager. +> More information: . + +- Install cookbook dependencies into a local repo: + +`berks install` + +- Update a specific cookbook and its dependencies: + +`berks update {{cookbook}}` + +- Upload a cookbook to the Chef server: + +`berks upload {{cookbook}}` + +- View the dependencies of a cookbook: + +`berks contingent {{cookbook}}` diff --git a/betty b/betty new file mode 100644 index 00000000..bcf7750c --- /dev/null +++ b/betty @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# betty + +> Use natural language to execute commands. +> More information: . + +- Ask Betty something: + +`betty {{what time is it}}` + +- Download a file: + +`betty download {{https://example.com/file.ext}} to {{path/to/output_file.ext}}` + +- Compress a file or directory to one of the support archive formats: + +`betty {{zip}} {{path/to/file_or_directory}}` + +- Extract an archive into the current directory: + +`betty {{unzip}} {{archive.tar.gz}}` + +- Extract an archive into a specific directory: + +`betty unarchive {{archive.tar.gz}} to {{path/to/directory}}` + +- Play Spotify: + +`betty play {{Spotify}}` + +- Drive Betty to madness: + +`betty go crazy` + +- Display version: + +`betty version` diff --git a/bfg b/bfg new file mode 100644 index 00000000..1623e39e --- /dev/null +++ b/bfg @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bfg + +> Remove large files or passwords from Git history like git-filter-branch. +> Note: if your repository is connected to a remote, you will need to force push to it. +> More information: . + +- Remove a file with sensitive data but leave the latest commit untouched: + +`bfg --delete-files {{file_with_sensitive_data}}` + +- Remove all text mentioned in the specified file wherever it can be found in the repository's history: + +`bfg --replace-text {{path/to/file.txt}}` diff --git a/bg b/bg new file mode 100644 index 00000000..234860f2 --- /dev/null +++ b/bg @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bg + +> Resume suspended jobs (e.g. using `Ctrl + Z`), and keeps them running in the background. +> More information: . + +- Resume the most recently suspended job and run it in the background: + +`bg` + +- Resume a specific job (use `jobs -l` to get its ID) and run it in the background: + +`bg %{{job_id}}` diff --git a/bgpgrep b/bgpgrep new file mode 100644 index 00000000..fdf393ce --- /dev/null +++ b/bgpgrep @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bgpgrep + +> Filter and print BGP data within MRT dumps. +> Can read files compressed with `gzip`, `bzip2` and `xz`. +> More information: . + +- List all routes: + +`bgpgrep {{master6.mrt}}` + +- List routes received from a specific peer, determined by the peer's AS number: + +`bgpgrep {{master4.mrt}} -peer {{64498}}` + +- List routes received from a specific peer, determined by the peer's IP address: + +`bgpgrep {{master4.mrt.bz2}} -peer {{2001:db8:dead:cafe:acd::19e}}` + +- List routes which have certain ASNs in their AS path: + +`bgpgrep {{master6.mrt.bz2}} -aspath '{{64498 64510}}'` + +- List routes that lead to a specific address: + +`bgpgrep {{master6.mrt.bz2}} -supernet '{{2001:db8:dead:cafe:aef::5}}'` + +- List routes that have communities from a specific AS: + +`bgpgrep {{master4.mrt}} -communities \( '{{64497}}:*' \)` diff --git a/bindkey b/bindkey new file mode 100644 index 00000000..2b27d7fa --- /dev/null +++ b/bindkey @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bindkey + +> Add keybindings to Z-Shell. +> More information: . + +- Bind a hotkey to a specific command: + +`bindkey "{{^k}}" {{kill-line}}` + +- Bind a hotkey to a specific key [s]equence: + +`bindkey -s '^o' 'cd .. +'` + +- [l]ist keymaps: + +`bindkey -l` + +- View the hotkey in a key[M]ap: + +`bindkey -M main` diff --git a/binwalk b/binwalk new file mode 100644 index 00000000..277f75a3 --- /dev/null +++ b/binwalk @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# binwalk + +> Firmware Analysis Tool. +> More information: . + +- Scan a binary file: + +`binwalk {{path/to/binary}}` + +- Extract files from a binary, specifying the output directory: + +`binwalk --extract --directory {{output_directory}} {{path/to/binary}}` + +- Recursively extract files from a binary limiting the recursion depth to 2: + +`binwalk --extract --matryoshka --depth {{2}} {{path/to/binary}}` + +- Extract files from a binary with the specified file signature: + +`binwalk --dd '{{png image:png}}' {{path/to/binary}}` + +- Analyze the entropy of a binary, saving the plot with the same name as the binary and `.png` extension appended: + +`binwalk --entropy --save {{path/to/binary}}` + +- Combine entropy, signature and opcodes analysis in a single command: + +`binwalk --entropy --signature --opcodes {{path/to/binary}}` diff --git a/bioradtopgm b/bioradtopgm new file mode 100644 index 00000000..29e87834 --- /dev/null +++ b/bioradtopgm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bioradtopgm + +> Convert a Biorad confocal file into a PGM file. +> More information: . + +- Read a Biorad confocal file and store the n'th image contained in it to as a PGM file: + +`bioradtopgm -{{n}} {{path/to/file.pic}} > {{path/to/file.pgm}}` + +- Read a Biorad confocal file and print the number of images it contains: + +`bioradtopgm {{path/to/file.pic}}` + +- Display version: + +`bioradtopgm -version` diff --git a/bird b/bird new file mode 100644 index 00000000..9c322f7b --- /dev/null +++ b/bird @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bird + +> BIRD Internet Routing Daemon. +> Routing daemon with support for BGP, OSPF, Babel and others. +> More information: . + +- Start Bird with a specific configuration file: + +`bird -c {{path/to/bird.conf}}` + +- Start Bird as a specific user and group: + +`bird -u {{username}} -g {{group}}` diff --git a/birdc b/birdc new file mode 100644 index 00000000..bd352aaf --- /dev/null +++ b/birdc @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# birdc + +> BIRD remote control. +> Retrieve information like routes from bird and perform configurations during runtime. +> More information: . + +- Open the remote control console: + +`birdc` + +- Reload the configuration without restarting BIRD: + +`birdc configure` + +- Show the current status of BIRD: + +`birdc show status` + +- Show all configured protocols: + +`birdc show protocols` + +- Show all details about a protocol: + +`birdc show protocols {{upstream1}} all` + +- Show all routes that contain a specific AS number: + +`birdc "show route where bgp_path ~ [{{4242120045}}]"` + +- Show all best routes: + +`birdc show route primary` + +- Show all details of all routes from a given prefix: + +`birdc show route for {{fd00:/8}} all` diff --git a/bison b/bison new file mode 100644 index 00000000..1d172907 --- /dev/null +++ b/bison @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bison + +> GNU parser generator. +> More information: . + +- Compile a bison definition file: + +`bison {{path/to/file.y}}` + +- Compile in debug mode, which causes the resulting parser to write additional information to `stdout`: + +`bison --debug {{path/to/file.y}}` + +- Specify the output filename: + +`bison --output {{path/to/output.c}} {{path/to/file.y}}` + +- Be verbose when compiling: + +`bison --verbose` diff --git a/bitcoin-cli b/bitcoin-cli new file mode 100644 index 00000000..1951da15 --- /dev/null +++ b/bitcoin-cli @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bitcoin-cli + +> Command-line client to interact with the Bitcoin daemon via RPC calls. +> Uses the configuration defined in `bitcoin.conf`. +> More information: . + +- Send a transaction to a given address: + +`bitcoin-cli sendtoaddress "{{address}}" {{amount}}` + +- Generate one or more blocks: + +`bitcoin-cli generate {{num_blocks}}` + +- Print high-level information about the wallet: + +`bitcoin-cli getwalletinfo` + +- List all outputs from previous transactions available to fund outgoing transactions: + +`bitcoin-cli listunspent` + +- Export the wallet information to a text file: + +`bitcoin-cli dumpwallet "{{path/to/file}}"` diff --git a/black b/black new file mode 100644 index 00000000..674855c9 --- /dev/null +++ b/black @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# black + +> A Python auto code formatter. +> More information: . + +- Auto-format a file or entire directory: + +`black {{path/to/file_or_directory}}` + +- Format the [c]ode passed in as a string: + +`black -c "{{code}}"` + +- Show whether a file or a directory would have changes made to them if they were to be formatted: + +`black --check {{path/to/file_or_directory}}` + +- Show changes that would be made to a file or a directory without performing them (dry-run): + +`black --diff {{path/to/file_or_directory}}` + +- Auto-format a file or directory, emitting exclusively error messages to `stderr`: + +`black --quiet {{path/to/file_or_directory}}` + +- Auto-format a file or directory without replacing single quotes with double quotes (adoption helper, avoid using this for new projects): + +`black --skip-string-normalization {{path/to/file_or_directory}}` diff --git a/blackfire b/blackfire new file mode 100644 index 00000000..6219f037 --- /dev/null +++ b/blackfire @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# blackfire + +> A command-line profiling tool for PHP. +> More information: . + +- Initialize and configure the Blackfire client: + +`blackfire config` + +- Launch the Blackfire agent: + +`blackfire agent` + +- Launch the Blackfire agent on a specific socket: + +`blackfire agent --socket="{{tcp://127.0.0.1:8307}}"` + +- Run the profiler on a specific program: + +`blackfire run {{php path/to/file.php}}` + +- Run the profiler and collect 10 samples: + +`blackfire --samples={{10}} run {{php path/to/file.php}}` + +- Run the profiler and output results as JSON: + +`blackfire --json run {{php path/to/file.php}}` + +- Upload a profiler file to the Blackfire web service: + +`blackfire upload {{path/to/file}}` + +- View the status of profiles on the Blackfire web service: + +`blackfire status` diff --git a/blender b/blender new file mode 100644 index 00000000..2d3d33f7 --- /dev/null +++ b/blender @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# blender + +> Command-line interface to the Blender 3D computer graphics application. +> Arguments are executed in the order they are given. +> More information: . + +- Render all frames of an animation in the background, without loading the UI (output is saved to `/tmp`): + +`blender --background {{path/to/file.blend}} --render-anim` + +- Render an animation using a specific image naming pattern, in a path relative (`//`) to the .blend file: + +`blender --background {{path/to/file.blend}} --render-output //{{render/frame_###.png}} --render-anim` + +- Render the 10th frame of an animation as a single image, saved to an existing directory (absolute path): + +`blender --background {{path/to/file.blend}} --render-output {{/path/to/output_directory}} --render-frame {{10}}` + +- Render the second last frame in an animation as a JPEG image, saved to an existing directory (relative path): + +`blender --background {{path/to/file.blend}} --render-output //{{output_directory}} --render-frame {{JPEG}} --render-frame {{-2}}` + +- Render the animation of a specific scene, starting at frame 10 and ending at frame 500: + +`blender --background {{path/to/file.blend}} --scene {{scene_name}} --frame-start {{10}} --frame-end {{500}} --render-anim` + +- Render an animation at a specific resolution, by passing a Python expression: + +`blender --background {{path/to/file.blend}} --python-expr '{{import bpy; bpy.data.scenes[0].render.resolution_percentage = 25}}' --render-anim` + +- Start an interactive Blender session in the terminal with a Python console (do `import bpy` after starting): + +`blender --background --python-console` diff --git a/blockout2 b/blockout2 new file mode 100644 index 00000000..65e2142d --- /dev/null +++ b/blockout2 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# blockout2 + +> Tetris like game in 3D. +> More information: . + +- Start a new game: + +`blockout2` + +- Navigate the current piece on a 2D plane: + +`{{Up|Down|Left|Right arrow key}}` + +- Rotate the piece on its axis: + +`{{Q|W|E|A|S|D}}` + +- Hard drop the current piece: + +`` + +- Pause/unpause the game: + +`p` diff --git a/bmaptool b/bmaptool new file mode 100644 index 00000000..81b4bf75 --- /dev/null +++ b/bmaptool @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bmaptool + +> Create or copy block maps intelligently (designed to be faster than `cp` or `dd`). +> More information: . + +- [o]utput a blockmap file from image file: + +`bmaptool create -o {{blockmap.bmap}} {{source.img}}` + +- Copy an image file into sdb: + +`bmaptool copy --bmap {{blockmap.bmap}} {{source.img}} {{/dev/sdb}}` + +- Copy a compressed image file into sdb: + +`bmaptool copy --bmap {{blockmap.bmap}} {{source.img.gz}} {{/dev/sdb}}` + +- Copy an image file into sdb without using a blockmap: + +`bmaptool copy --nobmap {{source.img}} {{/dev/sdb}}` diff --git a/bmptopnm b/bmptopnm new file mode 100644 index 00000000..8b43cf2b --- /dev/null +++ b/bmptopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bmptopnm + +> Convert a BMP file into a PBM, PGM, or PNM image. +> More information: . + +- Generate the PBM, PGM, or PNM image as output, for Windows or OS/2 BMP file as input: + +`bmptopnm {{path/to/file.bmp}}` + +- Report contents of the BMP header to `stderr`: + +`bmptopnm -verbose {{path/to/file.bmp}}` + +- Display version: + +`bmptopnm -version` diff --git a/bob b/bob new file mode 100644 index 00000000..1429045a --- /dev/null +++ b/bob @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bob + +> Manage and switch between Neovim versions. +> More information: . + +- Install and switch to the specified version of Neovim: + +`bob use {{nightly|stable|latest|version_string|commit_hash}}` + +- List installed and currently used versions of Neovim: + +`bob list` + +- Uninstall the specified version of Neovim: + +`bob uninstall {{nightly|stable|latest|version_string|commit_hash}}` + +- Uninstall Neovim and erase any changes `bob` has made: + +`bob erase` + +- Roll back to a previous nightly version: + +`bob rollback` diff --git a/boot b/boot new file mode 100644 index 00000000..74bdf036 --- /dev/null +++ b/boot @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# boot + +> Build tooling for the Clojure programming language. +> More information: . + +- Start a REPL session either with the project or standalone: + +`boot repl` + +- Build a single `uberjar`: + +`boot jar` + +- Generate scaffolding for a new project based on a template: + +`boot --dependencies boot/new new --template {{template_name}} --name {{project_name}}` + +- Build for development (if using the boot/new template): + +`boot dev` + +- Build for production (if using the boot/new template): + +`boot prod` + +- Display help for a specific task: + +`boot {{task}} --help` diff --git a/borg b/borg new file mode 100644 index 00000000..c7ac3827 --- /dev/null +++ b/borg @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# borg + +> Deduplicating backup tool. +> Creates local or remote backups that are mountable as filesystems. +> More information: . + +- Initialize a (local) repository: + +`borg init {{path/to/repo_directory}}` + +- Backup a directory into the repository, creating an archive called "Monday": + +`borg create --progress {{path/to/repo_directory}}::{{Monday}} {{path/to/source_directory}}` + +- List all archives in a repository: + +`borg list {{path/to/repo_directory}}` + +- Extract a specific directory from the "Monday" archive in a remote repository, excluding all `*.ext` files: + +`borg extract {{user}}@{{host}}:{{path/to/repo_directory}}::{{Monday}} {{path/to/target_directory}} --exclude '{{*.ext}}'` + +- Prune a repository by deleting all archives older than 7 days, listing changes: + +`borg prune --keep-within {{7d}} --list {{path/to/repo_directory}}` + +- Mount a repository as a FUSE filesystem: + +`borg mount {{path/to/repo_directory}}::{{Monday}} {{path/to/mountpoint}}` + +- Display help on creating archives: + +`borg create --help` diff --git a/bosh b/bosh new file mode 100644 index 00000000..315c10f7 --- /dev/null +++ b/bosh @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bosh + +> Deploy and manage the BOSH director. +> More information: . + +- Create local alias for director in a specific [e]nvironment: + +`bosh alias-env {{environment_name}} -e {{ip_address|URL}} --ca-cert {{ca_certificate}}` + +- List environments: + +`bosh environments` + +- Log in to the director: + +`bosh login -e {{environment}}` + +- List deployments: + +`bosh -e {{environment}} deployments` + +- List environment virtual machines in a [d]eployment: + +`bosh -e {{environment}} vms -d {{deployment}}` + +- SSH into virtual machine: + +`bosh -e {{environment}} ssh {{virtual_machine}} -d {{deployment}}` + +- Upload stemcell: + +`bosh -e {{environment}} upload-stemcell {{stemcell_file|url}}` + +- Show current cloud config: + +`bosh -e {{environment}} cloud-config` diff --git a/bower b/bower new file mode 100644 index 00000000..d771574f --- /dev/null +++ b/bower @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bower + +> 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: . + +- Install a project's dependencies, listed in its bower.json: + +`bower install` + +- Install one or more packages to the bower_components directory: + +`bower install {{package}} {{package}}` + +- Uninstall packages locally from the bower_components directory: + +`bower uninstall {{package}} {{package}}` + +- List local packages and possible updates: + +`bower list` + +- Create a `bower.json` file for your package: + +`bower init` + +- Install a specific dependency version, and add it to `bower.json`: + +`bower install {{local_name}}={{package}}#{{version}} --save` + +- Display help for a specific command: + +`bower help {{command}}` diff --git a/box b/box new file mode 100644 index 00000000..4513e862 --- /dev/null +++ b/box @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# box + +> A PHP application for building and managing Phars. +> More information: . + +- Compile a new Phar file: + +`box compile` + +- Compile a new Phar file using a specific [c]onfiguration file: + +`box compile -c {{path/to/config}}` + +- Display information about the PHAR PHP extension: + +`box info` + +- Display information about a specific Phar file: + +`box info {{path/to/phar_file}}` + +- Validate the first found configuration file in the working directory: + +`box validate` + +- Verify the signature of a specific Phar file: + +`box verify {{path/to/phar_file}}` + +- Display help: + +`box help` diff --git a/boxes b/boxes new file mode 100644 index 00000000..6171ae57 --- /dev/null +++ b/boxes @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# boxes + +> Draw, remove, and repair ASCII art boxes. +> More information: . + +- Draw a box around a string: + +`echo "{{string}}" | boxes` + +- [r]emove a box from a string: + +`echo "{{string}}" | boxes -r` + +- Specify the box [d]esign: + +`echo "{{string}}" | boxes -d {{parchment}}` + +- Specify the box [s]ize (in columns by lines): + +`echo "{{string}}" | boxes -s {{10}}x{{5}}` + +- [a]lign the box text [h]orizonally (at [l]eft, [c]enter or [r]ight): + +`echo "{{string}}" | boxes -a h{{l|c|r}}` + +- [a]lign the box text [v]ertically (at [t]op, [c]enter or [b]ottom): + +`echo "{{string}}" | boxes -a v{{t|c|b}}` + +- [j]ustify the box text (at [l]eft, [c]enter or [r]ight): + +`echo "{{string}}" | boxes -a j{{l|c|r}}{{vt}}` diff --git a/bpytop b/bpytop new file mode 100644 index 00000000..98c1aff8 --- /dev/null +++ b/bpytop @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bpytop + +> A resource monitor that shows information about the CPU, memory, disks, network and processes. +> A Python version of `bashtop`. +> More information: . + +- Start `bpytop`: + +`bpytop` + +- Start in minimal mode without memory and networking boxes: + +`bpytop -m` + +- Toggle minimal mode: + +`m` + +- Search for running programs or processes: + +`f` + +- Change settings: + +`M` + +- Display version: + +`bpytop -v` diff --git a/bq b/bq new file mode 100644 index 00000000..12c72902 --- /dev/null +++ b/bq @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bq + +> A Python-based tool for BigQuery, Google Cloud's fully managed and completely serverless enterprise data warehouse. +> More information: . + +- Run query against a BigQuery table using standard SQL, add `--dry_run` flag to estimate the number of bytes read by the query: + +`bq query --nouse_legacy_sql 'SELECT COUNT(*) FROM {{DATASET_NAME}}.{{TABLE_NAME}}'` + +- Run a parameterized query: + +`bq query --use_legacy_sql=false --parameter='ts_value:TIMESTAMP:2016-12-07 08:00:00' 'SELECT TIMESTAMP_ADD(@ts_value, INTERVAL 1 HOUR)'` + +- Create a new dataset or table in the US location: + +`bq mk --location=US {{dataset_name}}.{{table_name}}` + +- List all datasets in a project: + +`bq ls --filter labels.{{key}}:{{value}} --max_results {{integer}} --format=prettyjson --project_id {{project_id}}` + +- Batch load data from a specific file in formats such as CSV, JSON, Parquet, and Avro to a table: + +`bq load --location={{location}} --source_format={{CSV|JSON|PARQUET|AVRO}} {{dataset}}.{{table}} {{path_to_source}}` + +- Copy one table to another: + +`bq cp {{dataset}}.{{OLD_TABLE}} {{dataset}}.{{new_table}}` + +- Display help: + +`bq help` diff --git a/brew b/brew new file mode 100644 index 00000000..a4f3f205 --- /dev/null +++ b/brew @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew + +> Homebrew - a package manager for macOS and Linux. +> Some subcommands such as `install` have their own usage documentation. +> More information: . + +- Install the latest stable version of a formula or cask (use `--devel` for development versions): + +`brew install {{formula}}` + +- List all installed formulae and casks: + +`brew list` + +- Upgrade an installed formula or cask (if none is given, all installed formulae/casks are upgraded): + +`brew upgrade {{formula}}` + +- Fetch the newest version of Homebrew and of all formulae and casks from the Homebrew source repository: + +`brew update` + +- Show formulae and casks that have a more recent version available: + +`brew outdated` + +- Search for available formulae (i.e. packages) and casks (i.e. native macOS `.app` packages): + +`brew search {{text}}` + +- Display information about a formula or a cask (version, installation path, dependencies, etc.): + +`brew info {{formula}}` + +- Check the local Homebrew installation for potential problems: + +`brew doctor` diff --git a/brew-autoremove b/brew-autoremove new file mode 100644 index 00000000..bf998bf1 --- /dev/null +++ b/brew-autoremove @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew autoremove + +> Remove unused formulae previously installed as dependencies. +> More information: . + +- Remove all unused formulae: + +`brew autoremove` + +- Print what would be removed, but don't actually remove anything: + +`brew autoremove --dry-run` diff --git a/brew-bundle b/brew-bundle new file mode 100644 index 00000000..1ed2fd74 --- /dev/null +++ b/brew-bundle @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew bundle + +> Bundler for Homebrew, Homebrew Cask and the Mac App Store. +> More information: . + +- Install packages from a Brewfile at the current path: + +`brew bundle` + +- Install packages from a specific Brewfile at a specific path: + +`brew bundle --file={{path/to/file}}` + +- Create a Brewfile from all installed packages: + +`brew bundle dump` + +- Uninstall all formulae not listed in the Brewfile: + +`brew bundle cleanup --force` + +- Check if there is anything to install or upgrade in the Brewfile: + +`brew bundle check` + +- List all entries in the Brewfile: + +`brew bundle list --all` diff --git a/brew-install b/brew-install new file mode 100644 index 00000000..a31cf206 --- /dev/null +++ b/brew-install @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew install + +> Install a Homebrew formula or cask. +> More information: . + +- Install a formula/cask: + +`brew install {{formula|cask}}` + +- Build and install a formula from source (dependencies will still be installed from bottles): + +`brew install --build-from-source {{formula}}` + +- Download the manifest, print what would be installed but don't actually install anything: + +`brew install --dry-run {{formula|cask}}` diff --git a/brew-list b/brew-list new file mode 100644 index 00000000..9596e0c9 --- /dev/null +++ b/brew-list @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew list + +> List installed formulae/casks or their files. +> More information: . + +- List all installed formulae and casks: + +`brew list` + +- List files belonging to an installed formula: + +`brew list {{formula}}` + +- List artifacts of a cask: + +`brew list {{cask}}` + +- List only formulae: + +`brew list --formula` + +- List only casks: + +`brew list --cask` diff --git a/brew-outdated b/brew-outdated new file mode 100644 index 00000000..93467cb2 --- /dev/null +++ b/brew-outdated @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew outdated + +> List outdated casks and formulae. +> To upgrade everything, use `brew upgrade`. +> More information: . + +- List all outdated casks and formulae: + +`brew outdated` + +- List only outdated formulae: + +`brew outdated --formula` + +- List only outdated casks: + +`brew outdated --cask` diff --git a/brew-search b/brew-search new file mode 100644 index 00000000..0c8682f9 --- /dev/null +++ b/brew-search @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew search + +> Search for casks and formulae. +> More information: . + +- Search for casks and formulae using a keyword: + +`brew search {{keyword}}` + +- Search for casks and formulae using a regular expression: + +`brew search /{{regular_expression}}/` + +- Enable searching through descriptions: + +`brew search --desc {{keyword}}` + +- Only search for formulae: + +`brew search --formula {{keyword}}` + +- Only search for casks: + +`brew search --cask {{keyword}}` diff --git a/brew-uninstall b/brew-uninstall new file mode 100644 index 00000000..be570c2d --- /dev/null +++ b/brew-uninstall @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew uninstall + +> Uninstall a Homebrew formula/cask. +> Use `brew autoremove` to remove unused dependencies afterwards. +> More information: . + +- Uninstall a formula/cask: + +`brew uninstall {{formula|cask}}` + +- Uninstall a cask and remove all associated files: + +`brew uninstall --zap {{cask}}` diff --git a/brew-update b/brew-update new file mode 100644 index 00000000..d637bf28 --- /dev/null +++ b/brew-update @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew update + +> Fetch the newest version of Homebrew and all formulae from GitHub using `git` and perform any necessary migrations. +> To upgrade all installed formulae, use `brew upgrade`. +> More information: . + +- Fetch the newest version of Homebrew and all formulae: + +`brew update` diff --git a/brew-upgrade b/brew-upgrade new file mode 100644 index 00000000..942b44be --- /dev/null +++ b/brew-upgrade @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew upgrade + +> Upgrade outdated formulae and casks. +> More information: . + +- Upgrade all outdated casks and formulae: + +`brew upgrade` + +- Upgrade a specific formula/cask: + +`brew upgrade {{formula|cask}}` + +- Print what would be upgraded, but don't actually upgrade anything: + +`brew upgrade --dry-run` diff --git a/brittany b/brittany new file mode 100644 index 00000000..42deb928 --- /dev/null +++ b/brittany @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brittany + +> Pretty-print Haskell source files. +> More information: . + +- Format a Haskell source file and print the result to `stdout`: + +`brittany {{path/to/file.hs}}` + +- Format all Haskell source files in the current directory in-place: + +`brittany --write-mode=inplace {{*.hs}}` + +- Check whether a Haskell source file needs changes and indicate the result through the programme's exit code: + +`brittany --check-mode {{path/to/file.hs}}` + +- Format a Haskell source file using the specified amount of spaces per indentation level and line length: + +`brittany --indent {{4}} --columns {{100}} {{path/to/file.hs}}` + +- Format a Haskell source file according to the style defined in the specified configuration file: + +`brittany --config-file {{path/to/config.yaml}} {{path/to/file.hs}}` diff --git a/brotli b/brotli new file mode 100644 index 00000000..29a50fd0 --- /dev/null +++ b/brotli @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brotli + +> Compress/uncompress files with Brotli compression. +> More information: . + +- Compress a file, creating a compressed version next to the file: + +`brotli {{path/to/file}}` + +- [d]ecompress a file, creating an uncompressed version next to the file: + +`brotli -d {{path/to/file.br}}` + +- Compress a file specifying the [o]utput filename: + +`brotli {{path/to/file}} -o {{path/to/compressed_output_file.br}}` + +- [d]ecompress a Brotli file specifying the [o]utput filename: + +`brotli -d {{path/to/compressed_file.br}} -o {{path/to/output_file}}` + +- Specify the compression quality (1=fastest (worst), 11=slowest (best)): + +`brotli -q {{11}} {{path/to/file}} -o {{path/to/compressed_output_file.br}}` diff --git a/browser-sync b/browser-sync new file mode 100644 index 00000000..572b8ba0 --- /dev/null +++ b/browser-sync @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# browser-sync + +> A local web server that updates browser on file changes. +> More information: . + +- Start a server from a specific directory: + +`browser-sync start --server {{path/to/directory}} --files {{path/to/directory}}` + +- Start a server from local directory, watching all CSS files in a directory: + +`browser-sync start --server --files '{{path/to/directory/*.css}}'` + +- Create configuration file: + +`browser-sync init` + +- Start Browsersync from configuration file: + +`browser-sync start --config {{config_file}}` diff --git a/bru b/bru new file mode 100644 index 00000000..11a268a3 --- /dev/null +++ b/bru @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bru + +> CLI for Bruno, an Opensource IDE for exploring and testing APIs. +> More information: . + +- Run all request files from the current directory: + +`bru run` + +- Run a single request from the current directory by specifying its filename: + +`bru run {{file.bru}}` + +- Run requests using an environment: + +`bru run --env {{environment_name}}` + +- Run requests using an environment with a variable: + +`bru run --env {{environment_name}} --env-var {{variable_name}}={{variable_value}}` + +- Run request and collect the results in an output file: + +`bru run --output {{path/to/output.json}}` + +- Display help: + +`bru run --help` diff --git a/brushtopbm b/brushtopbm new file mode 100644 index 00000000..d533a0db --- /dev/null +++ b/brushtopbm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brushtopbm + +> Convert a Xerox doodle brush file into a PBM image. +> More information: . + +- Generate a PBM file as output for a Xerox doodle brush file as input: + +`brushtopbm {{path/to/file.brush}}` + +- Display version: + +`brushtopbm -version` diff --git a/bshell b/bshell new file mode 100644 index 00000000..914a833a --- /dev/null +++ b/bshell @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bshell + +> A GUI for browsing for SSH/VNC servers on the local network. +> See also: `bssh` and `bvnc`. +> More information: . + +- Browse for both SSH and VNC servers: + +`bshell` + +- Browse for SSH servers only: + +`bshell --ssh` + +- Browse for VNC servers only: + +`bshell --vnc` + +- Browse for both SSH and VNC servers in a specified domain: + +`bshell --domain={{domain}}` diff --git a/bssh b/bssh new file mode 100644 index 00000000..9c437ec2 --- /dev/null +++ b/bssh @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bssh + +> A GUI tool for browsing for SSH/VNC servers on the local network. +> See also: `bvnc` and `bshell`. +> More information: . + +- Browse for SSH servers: + +`bssh` + +- Browse for VNC servers: + +`bssh --vnc` + +- Browse for both SSH and VNC servers: + +`bssh --shell` + +- Browse for SSH servers in a specified domain: + +`bssh --domain={{domain}}` diff --git a/btm b/btm new file mode 100644 index 00000000..d5cf0580 --- /dev/null +++ b/btm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# btm + +> An alternative to `top`. +> Aims to be lightweight, cross-platform and more graphical than `top`. +> More information: . + +- Show the default layout (CPU, memory, temperatures, disk, network, and processes): + +`btm` + +- Enable basic mode, removing charts and condensing data (similar to `top`): + +`btm --basic` + +- Use big dots instead of small ones in charts: + +`btm --dot_marker` + +- Show also battery charge and health status: + +`btm --battery` + +- Refresh every 250 milliseconds and show the last 30 seconds in the charts: + +`btm --rate 250 --default_time_value 30000` diff --git a/btop b/btop new file mode 100644 index 00000000..7bc442b6 --- /dev/null +++ b/btop @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# btop + +> A resource monitor that shows information about the CPU, memory, disks, network and processes. +> A C++ version of `bpytop`. +> More information: . + +- Start `btop`: + +`btop` + +- Start `btop` with the specified settings preset: + +`btop --preset {{0..9}}` diff --git a/buku b/buku new file mode 100644 index 00000000..61ffa487 --- /dev/null +++ b/buku @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# buku + +> Command-line browser-independent bookmark manager. +> More information: . + +- Display all bookmarks matching "keyword" and with "privacy" tag: + +`buku {{keyword}} --stag {{privacy}}` + +- Add bookmark with tags "search engine" and "privacy": + +`buku --add {{https://example.com}} {{search engine}}, {{privacy}}` + +- Delete a bookmark: + +`buku --delete {{bookmark_id}}` + +- Open editor to edit a bookmark: + +`buku --write {{bookmark_id}}` + +- Remove "search engine" tag from a bookmark: + +`buku --update {{bookmark_id}} --tag {{-}} {{search engine}}` diff --git a/bun b/bun new file mode 100644 index 00000000..5e65dfae --- /dev/null +++ b/bun @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun + +> JavaScript runtime and toolkit. +> Includes a bundler, a test runner, and a package manager. +> More information: . + +- Run a JavaScript file or a `package.json` script: + +`bun run {{path/to/file|script_name}}` + +- Run unit tests: + +`bun test` + +- Download and install all the packages listed as dependencies in `package.json`: + +`bun install` + +- Add a dependency to `package.json`: + +`bun add {{module_name}}` + +- Remove a dependency from `package.json`: + +`bun remove {{module_name}}` + +- Create a new Bun project in the current directory: + +`bun init` + +- Start a REPL (interactive shell): + +`bun repl` + +- Upgrade Bun to the latest version: + +`bun upgrade` diff --git a/bundle b/bundle new file mode 100644 index 00000000..f966cc3c --- /dev/null +++ b/bundle @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bundle + +> Dependency manager for the Ruby programming language. +> More information: . + +- Install all gems defined in the `Gemfile` expected in the working directory: + +`bundle install` + +- Execute a command in the context of the current bundle: + +`bundle exec {{command}} {{arguments}}` + +- Update all gems by the rules defined in the `Gemfile` and regenerate `Gemfile.lock`: + +`bundle update` + +- Update one or more specific gem(s) defined in the `Gemfile`: + +`bundle update {{gem_name1}} {{gem_name2}}` + +- Update one or more specific gems(s) defined in the `Gemfile` but only to the next patch version: + +`bundle update --patch {{gem_name1}} {{gem_name2}}` + +- Update all gems within the given group in the `Gemfile`: + +`bundle update --group {{development}}` + +- List installed gems in the `Gemfile` with newer versions available: + +`bundle outdated` + +- Create a new gem skeleton: + +`bundle gem {{gem_name}}` diff --git a/bundler b/bundler new file mode 100644 index 00000000..d581053a --- /dev/null +++ b/bundler @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bundler + +> Dependency manager for the Ruby programming language. +> `bundler` is a common name for the command `bundle`, but not a command itself. +> More information: . + +- View documentation for the original command: + +`tldr bundle` diff --git a/bundletool b/bundletool new file mode 100644 index 00000000..7a43caff --- /dev/null +++ b/bundletool @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bundletool + +> Manipulate Android Application Bundles. +> Some subcommands such as `bundletool validate` have their own usage documentation. +> More information: . + +- Display help for a subcommand: + +`bundletool help {{subcommand}}` + +- Generate APKs from an application bundle (prompts for keystore password): + +`bundletool build-apks --bundle={{path/to/bundle.aab}} --ks={{path/to/key.keystore}} --ks-key-alias={{key_alias}} --output={{path/to/file.apks}}` + +- Generate APKs from an application bundle giving the keystore password: + +`bundletool build-apks --bundle={{path/to/bundle.aab}} --ks={{path/to/key.keystore}} --ks-key-alias={{key_alias}} –ks-pass={{pass:the_password}} --output={{path/to/file.apks}}` + +- Generate APKs including only one single APK for universal usage: + +`bundletool build-apks --bundle={{path/to/bundle.aab}} --mode={{universal}} --ks={{path/to/key.keystore}} --ks-key-alias={{key_alias}} --output={{path/to/file.apks}}` + +- Install the right combination of APKs to an emulator or device: + +`bundletool install-apks --apks={{path/to/file.apks}}` + +- Estimate the download size of an application: + +`bundletool get-size total --apks={{path/to/file.apks}}` + +- Generate a device specification JSON file for an emulator or device: + +`bundletool get-device-spec --output={{path/to/file.json}}` + +- Verify a bundle and display detailed information about it: + +`bundletool validate --bundle={{path/to/bundle.aab}}` diff --git a/bundletool-dump b/bundletool-dump new file mode 100644 index 00000000..413f2642 --- /dev/null +++ b/bundletool-dump @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bundletool dump + +> Manipulate Android Application Bundles. +> More information: . + +- Display the `AndroidManifest.xml` of the base module: + +`bundletool dump manifest --bundle={{path/to/bundle.aab}}` + +- Display a specific value from the `AndroidManifest.xml` using XPath: + +`bundletool dump manifest --bundle={{path/to/bundle.aab}} --xpath={{/manifest/@android:versionCode}}` + +- Display the `AndroidManifest.xml` of a specific module: + +`bundletool dump manifest --bundle={{path/to/bundle.aab}} --module={{name}}` + +- Display all the resources in the application bundle: + +`bundletool dump resources --bundle={{path/to/bundle.aab}}` + +- Display the configuration for a specific resource: + +`bundletool dump resources --bundle={{path/to/bundle.aab}} --resource={{type/name}}` + +- Display the configuration and values for a specific resource using the ID: + +`bundletool dump resources --bundle={{path/to/bundle.aab}} --resource={{0x7f0e013a}} --values` + +- Display the contents of the bundle configuration file: + +`bundletool dump config --bundle={{path/to/bundle.aab}}` diff --git a/bundletool-validate b/bundletool-validate new file mode 100644 index 00000000..391ab6b5 --- /dev/null +++ b/bundletool-validate @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bundletool validate + +> Manipulate Android Application Bundles. +> More information: . + +- Verify a bundle and display detailed information about it: + +`bundletool validate --bundle={{path/to/bundle.aab}}` diff --git a/bup b/bup new file mode 100644 index 00000000..20d3b6d3 --- /dev/null +++ b/bup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bup + +> Backup system based on the Git packfile format, providing incremental saves and global deduplication. +> More information: . + +- Initialize a backup repository in a given local [d]irectory: + +`bup -d {{path/to/repository}} init` + +- Prepare a given [d]irectory before taking a backup: + +`bup -d {{path/to/repository}} index {{path/to/directory}}` + +- Backup a [d]irectory to the repository specifying its [n]ame: + +`bup -d {{path/to/repository}} save -n {{backup_name}} {{path/to/directory}}` + +- Show the backup snapshots currently stored in the repository: + +`bup -d {{path/to/repository}} ls` + +- Restore a specific backup snapshot to a target dire[C]tory: + +`bup -d {{path/to/repository}} restore -C {{path/to/target_directory}} {{backup_name}}` diff --git a/buzzphrase b/buzzphrase new file mode 100644 index 00000000..9a205e89 --- /dev/null +++ b/buzzphrase @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# buzzphrase + +> Output a random buzzphrase. Written in Node.js. +> More information: . + +- Generate a string of three random phrases containing an adjective, a past tense verb and a plural noun: + +`buzzphrase` + +- Print a phrase formatted as [i]mperative verb + past tense [v]erb + [a]djective + plural [N]oun: + +`buzzphrase {{'{i} {v} {a} {N}'}}` + +- Print `k` phrases formatted as present participle [V]erb + [a]djective + singular [n]oun + [f]inal: + +`buzzphrase {{k}} {{'{V} {a} {n} {f}'}}` diff --git a/bvnc b/bvnc new file mode 100644 index 00000000..4510a78c --- /dev/null +++ b/bvnc @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bvnc + +> A GUI tool for browsing for SSH/VNC servers on the local network. +> See also: `bssh` and `bshell`. +> More information: . + +- Browse for VNC servers: + +`bvnc` + +- Browse for SSH servers: + +`bvnc --ssh` + +- Browse for both VNC and SSH servers: + +`bvnc --shell` + +- Browse for VNC servers in a specified domain: + +`bvnc --domain={{domain}}` diff --git a/bw b/bw new file mode 100644 index 00000000..5c6a3526 --- /dev/null +++ b/bw @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bw + +> Access and manage a Bitwarden vault. +> More information: . + +- Log in to a Bitwarden user account: + +`bw login` + +- Log out of a Bitwarden user account: + +`bw logout` + +- Search and display items from Bitwarden vault: + +`bw list items --search {{github}}` + +- Display a particular item from Bitwarden vault: + +`bw get item {{github}}` + +- Create a folder in Bitwarden vault: + +`{{echo -n '{"name":"My Folder1"}' | base64}} | bw create folder` diff --git a/bzegrep b/bzegrep new file mode 100644 index 00000000..7a89d281 --- /dev/null +++ b/bzegrep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bzegrep + +> Find extended regular expression patterns in `bzip2` compressed files using `egrep`. +> More information: . + +- Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-sensitive): + +`bzegrep "{{search_pattern}}" {{path/to/file}}` + +- Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-insensitive): + +`bzegrep --ignore-case "{{search_pattern}}" {{path/to/file}}` + +- Search for lines that do not match a pattern: + +`bzegrep --invert-match "{{search_pattern}}" {{path/to/file}}` + +- Print file name and line number for each match: + +`bzegrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`bzegrep --only-matching "{{search_pattern}}" {{path/to/file}}` + +- Recursively search files in a `bzip2` compressed `tar` archive for a pattern: + +`bzegrep --recursive "{{search_pattern}}" {{path/to/file}}` diff --git a/bzfgrep b/bzfgrep new file mode 100644 index 00000000..775a0b61 --- /dev/null +++ b/bzfgrep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bzfgrep + +> Find any fixed strings separated by new lines in `bzip2` compressed files using `fgrep`. +> More information: . + +- Search for lines matching the list of search strings separated by new lines in a compressed file (case-sensitive): + +`bzfgrep "{{search_string}}" {{path/to/file}}` + +- Search for lines matching the list of search strings separated by new lines in a compressed file (case-insensitive): + +`bzfgrep --ignore-case "{{search_string}}" {{path/to/file}}` + +- Search for lines that do not match the list of search strings separated by new lines in a compressed file: + +`bzfgrep --invert-match "{{search_string}}" {{path/to/file}}` + +- Print file name and line number for each match: + +`bzfgrep --with-filename --line-number "{{search_string}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`bzfgrep --only-matching "{{search_string}}" {{path/to/file}}` + +- Recursively search files in a `bzip2` compressed `tar` archive for the given list of strings: + +`bzfgrep --recursive "{{search_string}}" {{path/to/file}}` diff --git a/bzgrep b/bzgrep new file mode 100644 index 00000000..ce108746 --- /dev/null +++ b/bzgrep @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bzgrep + +> Find patterns in `bzip2` compressed files using `grep`. +> More information: . + +- Search for a pattern within a compressed file: + +`bzgrep "{{search_pattern}}" {{path/to/file}}` + +- Use extended regular expressions (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: + +`bzgrep --extended-regexp --ignore-case "{{search_pattern}}" {{path/to/file}}` + +- Print 3 lines of context around, before, or after each match: + +`bzgrep --{{context|before-context|after-context}}={{3}} "{{search_pattern}}" {{path/to/file}}` + +- Print file name and line number for each match: + +`bzgrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`bzgrep --only-matching "{{search_pattern}}" {{path/to/file}}` + +- Recursively search files in a `bzip2` compressed `tar` archive for a pattern: + +`bzgrep --recursive "{{search_pattern}}" {{path/to/tar/file}}` + +- Search `stdin` for lines that do not match a pattern: + +`cat {{/path/to/bz/compressed/file}} | bzgrep --invert-match "{{search_pattern}}"` diff --git a/bzip2 b/bzip2 new file mode 100644 index 00000000..f95e4d95 --- /dev/null +++ b/bzip2 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bzip2 + +> A block-sorting file compressor. +> More information: . + +- Compress a file: + +`bzip2 {{path/to/file_to_compress}}` + +- [d]ecompress a file: + +`bzip2 -d {{path/to/compressed_file.bz2}}` + +- [d]ecompress a file to `stdout`: + +`bzip2 -dc {{path/to/compressed_file.bz2}}` + +- Test the integrity of each file inside the archive file: + +`bzip2 --test {{path/to/compressed_file.bz2}}` + +- Show the compression ratio for each file processed with detailed information: + +`bzip2 --verbose {{path/to/compressed_files.bz2}}` + +- Decompress a file overwriting existing files: + +`bzip2 --force {{path/to/compressed_file.bz2}}` + +- Display help: + +`bzip2 -h` diff --git a/bzip3 b/bzip3 new file mode 100644 index 00000000..ed666d42 --- /dev/null +++ b/bzip3 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bzip3 + +> An efficient statistical file compressor. +> More information: . + +- Compress a file: + +`bzip3 {{path/to/file_to_compress}}` + +- [d]ecompress a file: + +`bzip3 -d {{path/to/compressed_file.bz3}}` + +- Decompress a file to `stdout` ([c]): + +`bzip3 -dc {{path/to/compressed_file.bz3}}` + +- Test the integrity of each file inside the archive file: + +`bzip3 --test {{path/to/compressed_file.bz3}}` + +- Show the compression ratio for each file processed with detailed information: + +`bzip3 --verbose {{path/to/compressed_files.bz3}}` + +- Decompress a file overwriting existing files: + +`bzip3 -d --force {{path/to/compressed_file.bz3}}` + +- Display help: + +`bzip3 -h` diff --git a/c99 b/c99 new file mode 100644 index 00000000..19543a07 --- /dev/null +++ b/c99 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# c99 + +> Compiles C programs according to the ISO C standard. +> More information: . + +- Compile source file(s) and create an executable: + +`c99 {{file.c}}` + +- Compile source file(s) and specify the executable [o]utput filename: + +`c99 -o {{executable_name}} {{file.c}}` + +- Compile source file(s) and create object file(s): + +`c99 -c {{file.c}}` + +- Compile source file(s), link with object file(s), and create an executable: + +`c99 {{file.c}} {{file.o}}` diff --git a/cabal b/cabal new file mode 100644 index 00000000..b6cac69a --- /dev/null +++ b/cabal @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cabal + +> Command-line interface to the Haskell package infrastructure (Cabal). +> Manage Haskell projects and Cabal packages from the Hackage package repository. +> More information: . + +- Search and list packages from Hackage: + +`cabal list {{search_string}}` + +- Show information about a package: + +`cabal info {{package}}` + +- Download and install a package: + +`cabal install {{package}}` + +- Create a new Haskell project in the current directory: + +`cabal init` + +- Build the project in the current directory: + +`cabal build` + +- Run tests of the project in the current directory: + +`cabal test` diff --git a/cadaver b/cadaver new file mode 100644 index 00000000..225742ba --- /dev/null +++ b/cadaver @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cadaver + +> WebDAV client for Unix. +> More information: . + +- Connect to the server , open the root collection: + +`cadaver {{http://dav.example.com/}}` + +- Connect to a server using a specific port and open the collection `/foo/bar/`: + +`cadaver {{http://dav.example.com:8022/foo/bar/}}` + +- Connect to a server using SSL: + +`cadaver {{https://davs.example.com/}}` diff --git a/caddy b/caddy new file mode 100644 index 00000000..5903d262 --- /dev/null +++ b/caddy @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# caddy + +> An enterprise-ready open source web server with automatic HTTPS, written in Go. +> More information: . + +- Start Caddy in the foreground: + +`caddy run` + +- Start Caddy with the specified Caddyfile: + +`caddy run --config {{path/to/Caddyfile}}` + +- Start Caddy in the background: + +`caddy start` + +- Stop a background Caddy process: + +`caddy stop` + +- Run a simple file server on the specified port with a browsable interface: + +`caddy file-server --listen :{{8000}} --browse` + +- Run a reverse proxy server: + +`caddy reverse-proxy --from :{{80}} --to localhost:{{8000}}` diff --git a/cake b/cake new file mode 100644 index 00000000..2a5a9081 --- /dev/null +++ b/cake @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cake + +> The command-line processor for the CakePHP framework. +> More information: . + +- Display basic information about the current app and available commands: + +`cake` + +- List available routes: + +`cake routes` + +- Clear configuration caches: + +`cake cache clear_all` + +- Build the metadata cache: + +`cake schema_cache build --connection {{connection}}` + +- Clear the metadata cache: + +`cake schema_cache clear` + +- Clear a single cache table: + +`cake schema_cache clear {{table_name}}` + +- Start a development web server (defaults to port 8765): + +`cake server` + +- Start a REPL (interactive shell): + +`cake console` diff --git a/cal b/cal new file mode 100644 index 00000000..50be4afb --- /dev/null +++ b/cal @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Display a calendar with the current day highlighted. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display a calendar for a specific year: + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` diff --git a/calc b/calc new file mode 100644 index 00000000..6ed03815 --- /dev/null +++ b/calc @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calc + +> An interactive arbitrary-precision calculator in the terminal. +> More information: . + +- Start `calc` in interactive mode: + +`calc` + +- Perform a calculation in non-interactive mode: + +`calc '{{85 * (36 / 4)}}'` + +- Don't format the output (for use with [p]ipes): + +`calc -p '{{4/3 * pi() * 5^3}}'` + +- Perform a calculation and then switch to [i]nteractive mode: + +`calc -i '{{sqrt(2)}}'` + +- Start `calc` in a specific permission [m]ode (0 to 7, defaults to 7): + +`calc -m {{mode}}` + +- View an introduction to `calc`: + +`calc help intro` + +- View an overview of `calc`: + +`calc help overview` + +- Open the `calc` manual: + +`calc help` diff --git a/calendar b/calendar new file mode 100644 index 00000000..dc8f92e3 --- /dev/null +++ b/calendar @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calendar + +> Display upcoming events from a calendar file. +> More information: . + +- Show events for today and tomorrow (or the weekend on Friday) from the default calendar: + +`calendar` + +- Look [A]head, showing events for the next 30 days: + +`calendar -A {{30}}` + +- Look [B]ack, showing events for the previous 7 days: + +`calendar -B {{7}}` + +- Show events from a custom calendar [f]ile: + +`calendar -f {{path/to/file}}` diff --git a/calibre-server b/calibre-server new file mode 100644 index 00000000..f2ebcabf --- /dev/null +++ b/calibre-server @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calibre-server + +> A server application to distribute e-books over a network. +> Note: e-books must already be imported into the library using the GUI or the `calibredb` CLI. +> More information: . + +- Start a server to distribute e-books. Access at : + +`calibre-server` + +- Start server on different port. Access at : + +`calibre-server --port {{port}}` + +- Password protect the server: + +`calibre-server --username {{username}} --password {{password}}` diff --git a/calibredb b/calibredb new file mode 100644 index 00000000..d788d4f5 --- /dev/null +++ b/calibredb @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calibredb + +> Manipulate an e-book database. +> Part of the Calibre e-book library. +> More information: . + +- List e-books in the library with additional information: + +`calibredb list` + +- Search for e-books displaying additional information: + +`calibredb list --search {{search_term}}` + +- Search for just ids of e-books: + +`calibredb search {{search_term}}` + +- Add one or more e-books to the library: + +`calibredb add {{file1 file2 …}}` + +- [r]ecursively add all e-books under a directory to the library: + +`calibredb add -r {{path/to/directory}}` + +- Remove one or more e-books from the library. You need the e-book IDs (see above): + +`calibredb remove {{id1 id2 …}}` diff --git a/calligraflow b/calligraflow new file mode 100644 index 00000000..d8cf87d4 --- /dev/null +++ b/calligraflow @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calligraflow + +> Calligra's flowchart and diagram application. +> See also: `calligrastage`, `calligrawords`, `calligrasheets`. +> More information: . + +- Launch the flowchart and diagram application: + +`calligraflow` + +- Open a specific file: + +`calligraflow {{path/to/file}}` + +- Display help or version: + +`calligraflow --{{help|version}}` diff --git a/calligrasheets b/calligrasheets new file mode 100644 index 00000000..22a13173 --- /dev/null +++ b/calligrasheets @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calligrasheets + +> Calligra's spreadsheet application. +> See also: `calligraflow`, `calligrastage`, `calligrawords`. +> More information: . + +- Launch the spreadsheet application: + +`calligrasheets` + +- Open a specific spreadsheet: + +`calligrasheets {{path/to/spreadsheet}}` + +- Display help or version: + +`calligrasheets --{{help|version}}` diff --git a/calligrastage b/calligrastage new file mode 100644 index 00000000..b8f4bf9b --- /dev/null +++ b/calligrastage @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calligrastage + +> Calligra's presentation application. +> See also: `calligraflow`, `calligrawords`, `calligrasheets`. +> More information: . + +- Launch the presentation application: + +`calligrastage` + +- Open a specific presentation: + +`calligrastage {{path/to/presentation}}` + +- Display help or version: + +`calligrastage --{{help|version}}` diff --git a/calligrawords b/calligrawords new file mode 100644 index 00000000..7067dbb7 --- /dev/null +++ b/calligrawords @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# calligrawords + +> Calligra's word processor application. +> See also: `calligraflow`, `calligrastage`, `calligrasheets`. +> More information: . + +- Launch the word processor application: + +`calligrawords` + +- Open a specific document: + +`calligrawords {{path/to/document}}` + +- Display help or version: + +`calligrawords --{{help|version}}` diff --git a/cancel b/cancel new file mode 100644 index 00000000..d8ba9a82 --- /dev/null +++ b/cancel @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cancel + +> Cancel print jobs. +> See also: `lp`, `lpmove`, `lpstat`. +> More information: . + +- Cancel the current job of the default printer (set with `lpoptions -d {{printer}}`): + +`cancel` + +- Cancel the jobs of the default printer owned by a specific [u]ser: + +`cancel -u {{username}}` + +- Cancel the current job of a specific printer: + +`cancel {{printer}}` + +- Cancel a specific job from a specific printer: + +`cancel {{printer}}-{{job_id}}` + +- Cancel [a]ll jobs of all printers: + +`cancel -a` + +- Cancel [a]ll jobs of a specific printer: + +`cancel -a {{printer}}` + +- Cancel the current job of a specific server and then delete ([x]) job data files: + +`cancel -h {{server}} -x` diff --git a/carbon-now b/carbon-now new file mode 100644 index 00000000..e27f5fd7 --- /dev/null +++ b/carbon-now @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# carbon-now + +> Create beautiful images of code. +> More information: . + +- Create an image from a file using default settings: + +`carbon-now {{path/to/file}}` + +- Create an image from a text in clipboard using default settings: + +`carbon-now --from-clipboard` + +- Create an image from `stdin` using default settings and copy to the clipboard: + +`{{input}} | carbon-now --to-clipboard` + +- Create images [i]nteractively for custom settings and optionally save a preset: + +`carbon-now -i {{path/to/file}}` + +- Create images from a previously saved [p]reset: + +`carbon-now -p {{preset}} {{path/to/file}}` + +- [s]tart at a specified line of text: + +`carbon-now -s {{line}} {{path/to/file}}` + +- [e]nd at a specific line of text: + +`carbon-now -e {{line}} {{path/to/file}}` + +- Open image in a browser instead of saving: + +`carbon-now --open {{path/to/file}}` diff --git a/cargo b/cargo new file mode 100644 index 00000000..8115395c --- /dev/null +++ b/cargo @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo + +> Manage Rust projects and their module dependencies (crates). +> Some subcommands such as `build` have their own usage documentation. +> More information: . + +- Search for crates: + +`cargo search {{search_string}}` + +- Install a binary crate: + +`cargo install {{crate_name}}` + +- List installed binary crates: + +`cargo install --list` + +- Create a new binary or library Rust project in the specified directory (or the current working directory by default): + +`cargo init --{{bin|lib}} {{path/to/directory}}` + +- Add a dependency to `Cargo.toml` in the current directory: + +`cargo add {{dependency}}` + +- Build the Rust project in the current directory using the release profile: + +`cargo build --release` + +- Build the Rust project in the current directory using the nightly compiler (requires `rustup`): + +`cargo +nightly build` + +- Build using a specific number of threads (default is the number of logical CPUs): + +`cargo build --jobs {{number_of_threads}}` diff --git a/cargo-add b/cargo-add new file mode 100644 index 00000000..27f51724 --- /dev/null +++ b/cargo-add @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo add + +> Add dependencies to a Rust project's `Cargo.toml` manifest. +> More information: . + +- Add the latest version of a dependency to the current project: + +`cargo add {{dependency}}` + +- Add a specific version of a dependency: + +`cargo add {{dependency}}@{{version}}` + +- Add a dependency and enable one or more specific features: + +`cargo add {{dependency}} --features {{feature_1}},{{feature_2}}` + +- Add an optional dependency, which then gets exposed as a feature of the crate: + +`cargo add {{dependency}} --optional` + +- Add a local crate as a dependency: + +`cargo add --path {{path/to/crate_directory}}` + +- Add a development or build dependency: + +`cargo add {{dependency}} --{{dev|build}}` + +- Add a dependency with all default features disabled: + +`cargo add {{dependency}} --no-default-features` diff --git a/cargo-bench b/cargo-bench new file mode 100644 index 00000000..2508aba2 --- /dev/null +++ b/cargo-bench @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo bench + +> Compile and execute benchmarks. +> More information: . + +- Execute all benchmarks of a package: + +`cargo bench` + +- Don't stop when a benchmark fails: + +`cargo bench --no-fail-fast` + +- Compile, but don’t run benchmarks: + +`cargo bench --no-run` + +- Benchmark the specified benchmark: + +`cargo bench --bench {{benchmark}}` + +- Benchmark with the given profile (default: `bench`): + +`cargo bench --profile {{profile}}` + +- Benchmark all example targets: + +`cargo bench --examples` + +- Benchmark all binary targets: + +`cargo bench --bins` + +- Benchmark the package’s library: + +`cargo bench --lib` diff --git a/cargo-build b/cargo-build new file mode 100644 index 00000000..a054ad2e --- /dev/null +++ b/cargo-build @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo build + +> Compile a local package and all of its dependencies. +> More information: . + +- Build the package or packages defined by the `Cargo.toml` manifest file in the local path: + +`cargo build` + +- Build artifacts in release mode, with optimizations: + +`cargo build --release` + +- Require that `Cargo.lock` is up to date: + +`cargo build --locked` + +- Build all packages in the workspace: + +`cargo build --workspace` + +- Build a specific package: + +`cargo build --package {{package}}` + +- Build only the specified binary: + +`cargo build --bin {{name}}` + +- Build only the specified test target: + +`cargo build --test {{testname}}` diff --git a/cargo-check b/cargo-check new file mode 100644 index 00000000..cd319f9d --- /dev/null +++ b/cargo-check @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo check + +> Check a local package and all of its dependencies for errors. +> More information: . + +- Check the current package: + +`cargo check` + +- Check all tests: + +`cargo check --tests` + +- Check the integration tests in `tests/integration_test1.rs`: + +`cargo check --test {{integration_test1}}` + +- Check the current package with the features `feature1` and `feature2`: + +`cargo check --features {{feature1,feature2}}` + +- Check the current package with default features disabled: + +`cargo check --no-default-features` diff --git a/cargo-clean b/cargo-clean new file mode 100644 index 00000000..8b732bd4 --- /dev/null +++ b/cargo-clean @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo clean + +> Remove generated artifacts in the `target` directory. +> More information: . + +- Remove the entire `target` directory: + +`cargo clean` + +- Remove documentation artifacts (the `target/doc` directory): + +`cargo clean --doc` + +- Remove release artifacts (the `target/release` directory): + +`cargo clean --release` + +- Remove artifacts in the directory of the given profile (in this case, `target/debug`): + +`cargo clean --profile {{dev}}` diff --git a/cargo-clippy b/cargo-clippy new file mode 100644 index 00000000..c6fea88d --- /dev/null +++ b/cargo-clippy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo clippy + +> A collection of lints to catch common mistakes and improve your Rust code. +> More information: . + +- Run checks over the code in the current directory: + +`cargo clippy` + +- Require that `Cargo.lock` is up to date: + +`cargo clippy --locked` + +- Run checks on all packages in the workspace: + +`cargo clippy --workspace` + +- Run checks for a package: + +`cargo clippy --package {{package}}` + +- Treat warnings as errors: + +`cargo clippy -- --deny warnings` + +- Run checks and ignore warnings: + +`cargo clippy -- --allow warnings` + +- Apply Clippy suggestions automatically: + +`cargo clippy --fix` diff --git a/cargo-doc b/cargo-doc new file mode 100644 index 00000000..ba6b47d0 --- /dev/null +++ b/cargo-doc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo doc + +> Build the documentation of Rust packages. +> More information: . + +- Build the documentation for the current project and all dependencies: + +`cargo doc` + +- Do not build documentation for dependencies: + +`cargo doc --no-deps` + +- Build and open the documentation in a browser: + +`cargo doc --open` + +- Build and view the documentation of a particular package: + +`cargo doc --open --package {{package}}` diff --git a/cargo-fetch b/cargo-fetch new file mode 100644 index 00000000..a0579a83 --- /dev/null +++ b/cargo-fetch @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo fetch + +> Fetch dependencies of a package from the network. +> More information: . + +- Fetch dependencies specified in `Cargo.lock` (for all targets): + +`cargo fetch` + +- Fetch dependencies for the specified target: + +`cargo fetch --target {{target_triple}}` diff --git a/cargo-fix b/cargo-fix new file mode 100644 index 00000000..4207a3a2 --- /dev/null +++ b/cargo-fix @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo fix + +> Automatically fix lint warnings reported by `rustc`. +> More information: . + +- Fix code even if it already has compiler errors: + +`cargo fix --broken-code` + +- Fix code even if the working directory has changes: + +`cargo fix --allow-dirty` + +- Migrate a package to the next Rust edition: + +`cargo fix --edition` + +- Fix the package’s library: + +`cargo fix --lib` + +- Fix the specified integration test: + +`cargo fix --test {{name}}` + +- Fix all members in the workspace: + +`cargo fix --workspace` diff --git a/cargo-fmt b/cargo-fmt new file mode 100644 index 00000000..71c705cc --- /dev/null +++ b/cargo-fmt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo fmt + +> Run `rustfmt` on all source files in a Rust project. +> More information: . + +- Format all source files: + +`cargo fmt` + +- Check for formatting errors without writing to the files: + +`cargo fmt --check` + +- Pass arguments to each `rustfmt` call: + +`cargo fmt -- {{rustfmt_args}}` diff --git a/cargo-generate-lockfile b/cargo-generate-lockfile new file mode 100644 index 00000000..8841f599 --- /dev/null +++ b/cargo-generate-lockfile @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo generate-lockfile + +> Generate the `Cargo.lock` file for the current package. Similar to `cargo update`, but has less options. +> If the lockfile already exists it will be rebuilt with latest version of every package. +> More information: . + +- Generate a `Cargo.lock` file with the latest version of every package: + +`cargo generate-lockfile` diff --git a/cargo-help b/cargo-help new file mode 100644 index 00000000..cdc9c4ee --- /dev/null +++ b/cargo-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo help + +> Display help on `cargo` and its subcommands. +> More information: . + +- Display general help: + +`cargo help` + +- Display help for a subcommand: + +`cargo help {{subcommand}}` diff --git a/cargo-init b/cargo-init new file mode 100644 index 00000000..c662def6 --- /dev/null +++ b/cargo-init @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo init + +> Create a new Cargo package. +> Equivalent of `cargo new`, but specifiying a directory is optional. +> More information: . + +- Initialize a Rust project with a binary target in the current directory: + +`cargo init` + +- Initialize a Rust project with a binary target in the specified directory: + +`cargo init {{path/to/directory}}` + +- Initialize a Rust project with a library target in the current directory: + +`cargo init --lib` + +- Initialize a version control system repository in the project directory (default: `git`): + +`cargo init --vcs {{git|hg|pijul|fossil|none}}` + +- Set the package name (default: directory name): + +`cargo init --name {{name}}` diff --git a/cargo-install b/cargo-install new file mode 100644 index 00000000..45476ff6 --- /dev/null +++ b/cargo-install @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo install + +> Build and install a Rust binary. +> More information: . + +- Install a package from (the version is optional - latest by default): + +`cargo install {{package}}@{{version}}` + +- Install a package from the specified Git repository: + +`cargo install --git {{repo_url}}` + +- Build from the specified branch/tag/commit when installing from a Git repository: + +`cargo install --git {{repo_url}} --{{branch|tag|rev}} {{branch_name|tag|commit_hash}}` + +- List all installed packages and their versions: + +`cargo install --list` diff --git a/cargo-locate-project b/cargo-locate-project new file mode 100644 index 00000000..2aa73b86 --- /dev/null +++ b/cargo-locate-project @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo locate-project + +> Print the full path to the `Cargo.toml` manifest of a project. +> If the project is part of a workspace, the manifest of the project is shown, rather than that of the workspace. +> More information: . + +- Display the JSON object with full path to the `Cargo.toml` manifest: + +`cargo locate-project` + +- Display the project path in the specified format: + +`cargo locate-project --message-format {{plain|json}}` + +- Display the `Cargo.toml` manifest located at the root of the workspace as opposed to the current workspace member: + +`cargo locate-project --workspace` + +- Display the `Cargo.toml` manifest of a specific directory: + +`cargo locate-project --manifest-path {{path/to/Cargo.toml}}` diff --git a/cargo-login b/cargo-login new file mode 100644 index 00000000..9ec2276f --- /dev/null +++ b/cargo-login @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo login + +> Save an API token from the registry locally. +> The token is used to authenticate to a package registry. You can remove it using `cargo logout`. +> More information: . + +- Add an API token to the local credential storage (located in `$CARGO_HOME/credentials.toml`): + +`cargo login` + +- Use the specified registry (registry names can be defined in the configuration - the default is ): + +`cargo login --registry {{name}}` diff --git a/cargo-logout b/cargo-logout new file mode 100644 index 00000000..319de2bc --- /dev/null +++ b/cargo-logout @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo logout + +> Remove an API token from the registry locally. +> The token is used to authenticate to a package registry. You can add it back using `cargo login`. +> More information: . + +- Remove an API token from the local credential storage (located in `$CARGO_HOME/credentials.toml`): + +`cargo logout` + +- Use the specified registry (registry names can be defined in the configuration - the default is ): + +`cargo logout --registry {{name}}` diff --git a/cargo-metadata b/cargo-metadata new file mode 100644 index 00000000..3b93f338 --- /dev/null +++ b/cargo-metadata @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo metadata + +> Output the workspace members and resolved dependencies of current package as JSON. +> Note: The output format is subject to change in future versions of Cargo. +> More information: . + +- Print the workspace members and resolved dependencies of the current package: + +`cargo metadata` + +- Print only the workspace members and do not fetch dependencies: + +`cargo metadata --no-deps` + +- Print metadata in a specific format based on the specified version: + +`cargo metadata --format-version {{version}}` + +- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: the `packages` array will still include the dependencies for all targets): + +`cargo metadata --filter-platform {{target_triple}}` diff --git a/cargo-new b/cargo-new new file mode 100644 index 00000000..0f1d7abd --- /dev/null +++ b/cargo-new @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo new + +> Create a new Cargo package. +> Equivalent of `cargo init`, but specifiying a directory is required. +> More information: . + +- Create a new Rust project with a binary target: + +`cargo new {{path/to/directory}}` diff --git a/cargo-owner b/cargo-owner new file mode 100644 index 00000000..38dec540 --- /dev/null +++ b/cargo-owner @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo owner + +> Manage the owners of a crate on the registry. +> More information: . + +- Invite the given user or team as an owner: + +`cargo owner --add {{username|github:org_name:team_name}} {{crate}}` + +- Remove the given user or team as an owner: + +`cargo owner --remove {{username|github:org_name:team_name}} {{crate}}` + +- List owners of a crate: + +`cargo owner --list {{crate}}` + +- Use the specified registry (registry names can be defined in the configuration - the default is ): + +`cargo owner --registry {{name}}` diff --git a/cargo-package b/cargo-package new file mode 100644 index 00000000..6f0eb303 --- /dev/null +++ b/cargo-package @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo package + +> Assemble a local package into a distributable tarball (a `.crate` file). +> Similar to `cargo publish --dry-run`, but has more options. +> More information: . + +- Perform checks and create a `.crate` file (equivalent of `cargo publish --dry-run`): + +`cargo package` + +- Display what files would be included in the tarball without actually creating it: + +`cargo package --list` diff --git a/cargo-pkgid b/cargo-pkgid new file mode 100644 index 00000000..2d337ea7 --- /dev/null +++ b/cargo-pkgid @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo pkgid + +> Print the fully qualified package ID specifier for a package or dependency in the current workspace. +> More information: . + +- Print the fully qualified package specification for the current project: + +`cargo pkgid` + +- Print the fully qualified package specification for the specified package: + +`cargo pkgid {{partial_pkgspec}}` diff --git a/cargo-publish b/cargo-publish new file mode 100644 index 00000000..cbf88811 --- /dev/null +++ b/cargo-publish @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo publish + +> Upload a package to a registry. +> Note: you have to add an authentication token using `cargo login` before publishing a package. +> More information: . + +- Perform checks, create a `.crate` file and upload it to the registry: + +`cargo publish` + +- Perform checks, create a `.crate` file but don't upload it (equivalent of `cargo package`): + +`cargo publish --dry-run` + +- Use the specified registry (registry names can be defined in the configuration - the default is ): + +`cargo publish --registry {{name}}` diff --git a/cargo-remove b/cargo-remove new file mode 100644 index 00000000..0048b2e5 --- /dev/null +++ b/cargo-remove @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo remove + +> Remove dependencies from a Rust project's `Cargo.toml` manifest. +> More information: . + +- Remove a dependency from the current project: + +`cargo remove {{dependency}}` + +- Remove a development or build dependency: + +`cargo remove --{{dev|build}} {{dependency}}` + +- Remove a dependency of the given target platform: + +`cargo remove --target {{target}} {{dependency}}` diff --git a/cargo-report b/cargo-report new file mode 100644 index 00000000..3de636ce --- /dev/null +++ b/cargo-report @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo report + +> Display various kinds of reports. +> More information: . + +- Display a report: + +`cargo report {{future-incompatibilities|...}}` + +- Display a report with the specified Cargo-generated id: + +`cargo report {{future-incompatibilities|...}} --id {{id}}` + +- Display a report for the specified package: + +`cargo report {{future-incompatibilities|...}} --package {{package}}` diff --git a/cargo-run b/cargo-run new file mode 100644 index 00000000..362aed7f --- /dev/null +++ b/cargo-run @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo run + +> Run the current Cargo package. +> Note: the working directory of the executed binary will be set to the current working directory. +> More information: . + +- Run the default binary target: + +`cargo run` + +- Run the specified binary: + +`cargo run --bin {{name}}` + +- Run the specified example: + +`cargo run --example {{name}}` + +- Activate a space or comma separated list of features: + +`cargo run --features {{feature1 feature2 ...}}` + +- Disable the default features: + +`cargo run --no-default-features` + +- Activate all available features: + +`cargo run --all-features` + +- Run with the given profile: + +`cargo run --profile {{name}}` diff --git a/cargo-rustc b/cargo-rustc new file mode 100644 index 00000000..30d997e4 --- /dev/null +++ b/cargo-rustc @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo rustc + +> Compile a Rust package. Similar to `cargo build`, but you can pass extra options to the compiler. +> See `rustc --help` for all available options. +> More information: . + +- Build the package and pass options to `rustc`: + +`cargo rustc -- {{rustc_options}}` + +- Build artifacts in release mode, with optimizations: + +`cargo rustc --release` + +- Compile with architecture-specific optimizations for the current CPU: + +`cargo rustc --release -- -C target-cpu=native` + +- Compile with speed optimizations: + +`cargo rustc -- -C opt-level {{1|2|3}}` + +- Compile with [s]ize optimizations (`z` also turns off loop vectorization): + +`cargo rustc -- -C opt-level {{s|z}}` + +- Check if your package uses unsafe code: + +`cargo rustc --lib -- -D unsafe-code` + +- Build a specific package: + +`cargo rustc --package {{package}}` + +- Build only the specified binary: + +`cargo --bin {{name}}` diff --git a/cargo-rustdoc b/cargo-rustdoc new file mode 100644 index 00000000..114eb189 --- /dev/null +++ b/cargo-rustdoc @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo rustdoc + +> Build the documentation of Rust packages. +> Similar to `cargo doc`, but you can pass options to `rustdoc`. See `rustdoc --help` for all available options. +> More information: . + +- Pass options to `rustdoc`: + +`cargo rustdoc -- {{rustdoc_options}}` + +- Warn about a documentation lint: + +`cargo rustdoc -- --warn rustdoc::{{lint_name}}` + +- Ignore a documentation lint: + +`cargo rustdoc -- --allow rustdoc::{{lint_name}}` + +- Document the package's library: + +`cargo rustdoc --lib` + +- Document the specified binary: + +`cargo rustdoc --bin {{name}}` + +- Document the specified example: + +`cargo rustdoc --example {{name}}` + +- Document the specified integration test: + +`cargo rustdoc --test {{name}}` diff --git a/cargo-search b/cargo-search new file mode 100644 index 00000000..1af5c102 --- /dev/null +++ b/cargo-search @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo search + +> Search for packages on . +> The crates are displayed along with descriptions in TOML format suitable for copying into `Cargo.toml`. +> More information: . + +- Search for packages: + +`cargo search {{query}}` + +- Show `n` results (default: 10, max: 100): + +`cargo search --limit {{n}} {{query}}` diff --git a/cargo-test b/cargo-test new file mode 100644 index 00000000..43b1a5c2 --- /dev/null +++ b/cargo-test @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo test + +> Execute the unit and integration tests of a Rust package. +> More information: . + +- Only run tests containing a specific string in their names: + +`cargo test {{testname}}` + +- Set the number of simultaneous running test cases: + +`cargo test -- --test-threads {{count}}` + +- Test artifacts in release mode, with optimizations: + +`cargo test --release` + +- Test all packages in the workspace: + +`cargo test --workspace` + +- Run tests for a specific package: + +`cargo test --package {{package}}` + +- Run tests without hiding output from test executions: + +`cargo test -- --nocapture` diff --git a/cargo-tree b/cargo-tree new file mode 100644 index 00000000..1dde10a3 --- /dev/null +++ b/cargo-tree @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo tree + +> Display a tree visualization of a dependency graph. +> Note: in the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated. +> More information: . + +- Show a dependency tree of the current project: + +`cargo tree` + +- Only show dependencies up to the specified depth (e.g. when `n` is 1, display only direct dependencies): + +`cargo tree --depth {{n}}` + +- Do not display the given package (and its dependencies) in the tree: + +`cargo tree --prune {{package_spec}}` + +- Show all occurrences of repeated dependencies: + +`cargo tree --no-dedupe` + +- Only show normal/build/development dependencies: + +`cargo tree --edges {{normal|build|dev}}` diff --git a/cargo-uninstall b/cargo-uninstall new file mode 100644 index 00000000..6f5605de --- /dev/null +++ b/cargo-uninstall @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo uninstall + +> Remove a Rust binary installed using `cargo install`. +> More information: . + +- Remove an installed binary: + +`cargo remove {{package_spec}}` diff --git a/cargo-update b/cargo-update new file mode 100644 index 00000000..c20c855c --- /dev/null +++ b/cargo-update @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo update + +> Update dependencies as recorded in `Cargo.lock`. +> More information: . + +- Update dependencies in `Cargo.lock` to the latest possible version: + +`cargo update` + +- Display what would be updated, but don't actually write the lockfile: + +`cargo update --dry-run` + +- Update only the specified dependencies: + +`cargo update --package {{dependency1}} --package {{dependency2}} --package {{dependency3}}` + +- Set a specific dependency to a specific version: + +`cargo update --package {{dependency}} --precise {{1.2.3}}` diff --git a/cargo-vendor b/cargo-vendor new file mode 100644 index 00000000..858c170c --- /dev/null +++ b/cargo-vendor @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo vendor + +> Vendor all dependencies of a project into the specified directory (default: `vendor`). +> More information: . + +- Vendor dependencies and configure `cargo` to use the vendored sources in the current project: + +`cargo vendor {{path/to/directory}} > .cargo/config.toml` diff --git a/cargo-verify-project b/cargo-verify-project new file mode 100644 index 00000000..218bd6ab --- /dev/null +++ b/cargo-verify-project @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo verify-project + +> Check the correctness of the `Cargo.toml` manifest and print the result as a JSON object. +> More information: . + +- Check the correctness of the current project's manifest: + +`cargo verify-project` + +- Check the correctness of the specified manifest file: + +`cargo verify-project --manifest-path {{path/to/Cargo.toml}}` diff --git a/cargo-version b/cargo-version new file mode 100644 index 00000000..a6f7a239 --- /dev/null +++ b/cargo-version @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo version + +> Display `cargo` version information. +> More information: . + +- Display version: + +`cargo version` + +- Display additional build information: + +`cargo version --verbose` diff --git a/cargo-yank b/cargo-yank new file mode 100644 index 00000000..bb40f5c4 --- /dev/null +++ b/cargo-yank @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cargo yank + +> Remove a pushed crate from the index. This should only be used when you accidentally release a significantly broken crate. +> Note: this does not remove any data. The crate is still present after a yank - this just prevents new projects from using it. +> More information: . + +- Yank the specified version of a crate: + +`cargo yank {{crate}}@{{version}}` + +- Undo a yank (i.e. allow downloading it again): + +`cargo yank --undo {{crate}}@{{version}}` + +- Use the specified registry (registry names can be defined in the configuration - the default is ): + +`cargo yank --registry {{name}} {{crate}}@{{version}}` diff --git a/carp b/carp new file mode 100644 index 00000000..8b8b8a64 --- /dev/null +++ b/carp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# carp + +> REPL and build tool for Carp. +> More information: . + +- Start a REPL (interactive shell): + +`carp` + +- Start a REPL with a custom prompt: + +`carp --prompt "{{> }}"` + +- Build a `carp` file: + +`carp -b {{path/to/file.carp}}` + +- Build and run a file: + +`carp -x {{path/to/file.carp}}` + +- Build a file with optimizations enabled: + +`carp -b --optimize {{path/to/file.carp}}` + +- Transpile a file to C code: + +`carp --generate-only {{path/to/file.carp}}` diff --git a/case b/case new file mode 100644 index 00000000..d022f745 --- /dev/null +++ b/case @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# case + +> Bash builtin construct for creating multi-choice conditional statements. +> More information: . + +- Match a variable against string literals to decide which command to run: + +`case {{$tocount}} in {{words}}) {{wc -w README}}; ;; {{lines}}) {{wc -l README}}; ;; esac` + +- Combine patterns with |, use * as a fallback pattern: + +`case {{$tocount}} in {{[wW]|words}}) {{wc -w README}}; ;; {{[lL]|lines}}) {{wc -l README}}; ;; *) {{echo "what?"}}; ;; esac` diff --git a/cat b/cat new file mode 100644 index 00000000..170039dd --- /dev/null +++ b/cat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cat + +> Print and concatenate files. +> More information: . + +- Print the contents of a file to `stdout`: + +`cat {{path/to/file}}` + +- Concatenate several files into an output file: + +`cat {{path/to/file1 path/to/file2 ...}} > {{path/to/output_file}}` + +- Append several files to an output file: + +`cat {{path/to/file1 path/to/file2 ...}} >> {{path/to/output_file}}` + +- Copy the contents of a file into an output file without buffering: + +`cat -u {{/dev/tty12}} > {{/dev/tty13}}` + +- Write `stdin` to a file: + +`cat - > {{path/to/file}}` diff --git a/catimg b/catimg new file mode 100644 index 00000000..9775a4df --- /dev/null +++ b/catimg @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# catimg + +> Image printing in the terminal. +> See also: `pixterm`, `chafa`. +> More information: . + +- Print a JPEG, PNG, or GIF to the terminal: + +`catimg {{path/to/file}}` + +- Double the [r]esolution of an image: + +`catimg -r 2 {{path/to/file}}` + +- Disable 24-bit color for better [t]erminal support: + +`catimg -t {{path/to/file}}` + +- Specify a custom [w]idth or [H]eight: + +`catimg {{-w|-H}} {{40}} {{path/to/file}}` diff --git a/cavif b/cavif new file mode 100644 index 00000000..dca3fa80 --- /dev/null +++ b/cavif @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cavif + +> Convert PNG/JPEG images to AVIF. Written in Rust. +> See also: `convert`. +> More information: . + +- Convert a JPEG file to AVIF, saving it to `file.avif`: + +`cavif {{path/to/image.jpg}}` + +- Adjust the image quality and convert a PNG file to AVIF: + +`cavif --quality {{1..100}} {{path/to/image.png}}` + +- Specify the output location: + +`cavif {{path/to/image.jpg}} --output {{path/to/output.avif}}` + +- Overwrite the destination file if it already exists: + +`cavif --overwrite {{path/to/image.jpg}}` diff --git a/cb b/cb new file mode 100644 index 00000000..c2d2b20f --- /dev/null +++ b/cb @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cb + +> Cut, copy, and paste anything in the terminal. +> More information: . + +- Show all clipboards: + +`cb` + +- Copy a file to the clipboard: + +`cb copy {{path/to/file}}` + +- Copy some text to the clipboard: + +`cb copy "{{Some example text}}"` + +- Copy piped data to the clipboard: + +`echo "{{Some example text}}" | cb` + +- Paste clipboard content: + +`cb paste` + +- Pipe out clipboard content: + +`cb | cat` + +- Show clipboard history: + +`cb history` + +- Show clipboard information: + +`cb info` diff --git a/cbonsai b/cbonsai new file mode 100644 index 00000000..083083a4 --- /dev/null +++ b/cbonsai @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cbonsai + +> A beautifully random bonsai tree generator. +> More information: . + +- Generate a bonsai in live mode: + +`cbonsai -l` + +- Generate a bonsai in infinite mode: + +`cbonsai -i` + +- Append a message to the bonsai: + +`cbonsai -m "{{message}}"` + +- Display extra information about the bonsai: + +`cbonsai -v` + +- Display help: + +`cbonsai -h` diff --git a/cbt b/cbt new file mode 100644 index 00000000..e3c2f4c1 --- /dev/null +++ b/cbt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cbt + +> Utility for reading data from Google Cloud's Bigtable. +> More information: . + +- List tables in the current project: + +`cbt ls` + +- Print count of rows in a specific table in the current project: + +`cbt count "{{table_name}}"` + +- Display a single row from a specific table with only 1 (most recent) cell revision per column in the current project: + +`cbt lookup "{{table_name}}" "{{row_key}}" cells-per-column={{1}}` + +- Display a single row with only specific column(s) (omit qualifier to return entire family) in the current project: + +`cbt lookup "{{table_name}}" "{{row_key}}" columns="{{family1:qualifier1,family2:qualifier2,...}}"` + +- Search up to 5 rows in the current project by a specific regex pattern and print them: + +`cbt read "{{table_name}}" regex="{{row_key_pattern}}" count={{5}}` + +- Read a specific range of rows and print only returned row keys in the current project: + +`cbt read {{table_name}} start={{start_row_key}} end={{end_row_key}} keys-only=true` diff --git a/ccache b/ccache new file mode 100644 index 00000000..d4144f46 --- /dev/null +++ b/ccache @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ccache + +> C/C++ compiler cache. +> Note: packages usually provide symlinks for compilers in `/usr/lib/ccache/bin`. Prepend this directory to `$PATH` to automatically use `ccache` for them. +> More information: . + +- Show current cache [s]tatistics: + +`ccache --show-stats` + +- [C]lear all cache: + +`ccache --clear` + +- Reset ([z]ero) statistics (but not cache itself): + +`ccache --zero-stats` + +- Compile C code and cache compiled output (to use `ccache` on all `gcc` invocations, see the note above): + +`ccache gcc {{path/to/file.c}}` diff --git a/ccomps b/ccomps new file mode 100644 index 00000000..8d2fe10c --- /dev/null +++ b/ccomps @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ccomps + +> Decompose graphs into their connected components. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Decompose one or more graphs into their connected components: + +`ccomps {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Print the number of nodes, edges, and connected components in one or more graphs: + +`ccomps -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}` + +- Write each connected component to numbered filenames based on `output.gv`: + +`ccomps -x -o {{path/to/output.gv}} {{path/to/input1.gv}} {{path/to/input2.gv ...}}` + +- Display help: + +`ccomps -?` diff --git a/cd b/cd new file mode 100644 index 00000000..c0fbd2e3 --- /dev/null +++ b/cd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cd + +> Change the current working directory. +> More information: . + +- Go to the specified directory: + +`cd {{path/to/directory}}` + +- Go up to the parent of the current directory: + +`cd ..` + +- Go to the home directory of the current user: + +`cd` + +- Go to the home directory of the specified user: + +`cd ~{{username}}` + +- Go to the previously chosen directory: + +`cd -` + +- Go to the root directory: + +`cd /` diff --git a/cdk b/cdk new file mode 100644 index 00000000..6b9233e0 --- /dev/null +++ b/cdk @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cdk + +> A CLI for AWS Cloud Development Kit (CDK). +> More information: . + +- List the stacks in the app: + +`cdk ls` + +- Synthesize and print the CloudFormation template for the specified stack(s): + +`cdk synth {{stack_name}}` + +- Deploy one or more stacks: + +`cdk deploy {{stack_name1 stack_name2 ...}}` + +- Destroy one or more stacks: + +`cdk destroy {{stack_name1 stack_name2 ...}}` + +- Compare the specified stack with the deployed stack or a local CloudFormation template: + +`cdk diff {{stack_name}}` + +- Create a new CDK project in the current directory for a specified [l]anguage: + +`cdk init -l {{language}}` + +- Open the CDK API reference in your browser: + +`cdk docs` diff --git a/certutil b/certutil new file mode 100644 index 00000000..31ee40c3 --- /dev/null +++ b/certutil @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# certutil + +> Manage keys and certificates in both NSS databases and other NSS tokens. +> More information: . + +- Create a [N]ew certificate database in the current [d]irectory: + +`certutil -N -d .` + +- List all certificates in a database: + +`certutil -L -d .` + +- List all private [K]eys in a database specifying the password [f]ile: + +`certutil -K -d . -f {{path/to/password_file.txt}}` + +- [A]dd the signed certificate to the requesters database specifying a [n]ickname, [t]rust attributes and an [i]nput CRT file: + +`certutil -A -n "{{server_certificate}}" -t ",," -i {{path/to/file.crt}} -d .` + +- Add subject alternative names to a given [c]ertificate with a specific key size ([g]): + +`certutil -S -f {{path/to/password_file.txt}} -d . -t ",," -c "{{server_certificate}}" -n "{{server_name}}" -g {{2048}} -s "CN={{common_name}},O={{organization}}"` diff --git a/cf b/cf new file mode 100644 index 00000000..96bfdaf5 --- /dev/null +++ b/cf @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cf + +> Manage apps and services on Cloud Foundry. +> More information: . + +- Log in to the Cloud Foundry API: + +`cf login -a {{api_url}}` + +- Push an app using the default settings: + +`cf push {{app_name}}` + +- View the services available from your organization: + +`cf marketplace` + +- Create a service instance: + +`cf create-service {{service}} {{plan}} {{service_name}}` + +- Connect an application to a service: + +`cf bind-service {{app_name}} {{service_name}}` + +- Run a script whose code is included in the app, but runs independently: + +`cf run-task {{app_name}} "{{script_command}}" --name {{task_name}}` + +- Start an interactive SSH session with a VM hosting an app: + +`cf ssh {{app_name}}` + +- View a dump of recent app logs: + +`cf logs {{app_name}} --recent` diff --git a/chafa b/chafa new file mode 100644 index 00000000..078cc45a --- /dev/null +++ b/chafa @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chafa + +> Image printing in the terminal. +> See also: `catimg`, `pixterm`. +> More information: . + +- Render an image directly in the terminal: + +`chafa {{path/to/file}}` + +- Render an image with 24-bit [c]olor: + +`chafa -c full {{path/to/file}}` + +- Improve image rendering with small color palettes using dithering: + +`chafa -c 16 --dither ordered {{path/to/file}}` + +- Render an image, making it appear pixelated: + +`chafa --symbols vhalf {{path/to/file}}` + +- Render a monochrome image with only braille characters: + +`chafa -c none --symbols braille {{path/to/file}}` diff --git a/charm b/charm new file mode 100644 index 00000000..3d2da76f --- /dev/null +++ b/charm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# charm + +> Set of tools that makes adding a backend to your terminal-based applications, without worrying about user accounts, data storage and encryption. +> More information: . + +- Backup your Charm account keys: + +`charm backup-keys` + +- Backup Charm account keys to a specific location: + +`charm backup-keys -o {{path/to/output_file.tar}}` + +- Import previously backed up Charm account keys: + +`charm import-keys "{{charm-keys-backup.tar}}"` + +- Find where your `cloud.charm.sh` folder resides on your machine: + +`charm where` + +- Start your Charm server: + +`charm serve` + +- Print linked SSH keys: + +`charm keys` + +- Print your Charm ID: + +`charm id` diff --git a/chars b/chars new file mode 100644 index 00000000..4b1a7994 --- /dev/null +++ b/chars @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chars + +> Display names and codes for various ASCII and Unicode characters and code points. +> More information: . + +- Look up a character by its value: + +`chars '{{ß}}'` + +- Look up a character by its Unicode code point: + +`chars {{U+1F63C}}` + +- Look up possible characters given an ambiguous code point: + +`chars {{10}}` + +- Look up a control character: + +`chars "{{^C}}"` diff --git a/cheat b/cheat new file mode 100644 index 00000000..36b41338 --- /dev/null +++ b/cheat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cheat + +> Create and view interactive cheat sheets. +> More information: . + +- Show example usage of a command: + +`cheat {{command}}` + +- Edit the cheat sheet for a command: + +`cheat -e {{command}}` + +- List the available cheat sheets: + +`cheat -l` + +- Search available the cheat sheets for a specified command name: + +`cheat -s {{command}}` + +- Display version: + +`cheat -v` diff --git a/checksec b/checksec new file mode 100644 index 00000000..233e0c94 --- /dev/null +++ b/checksec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# checksec + +> Check security properties of executables. +> More information: . + +- List security properties of an executable binary file: + +`checksec --file={{path/to/binary}}` + +- List security properties recursively of all executable files in a directory: + +`checksec --dir={{path/to/directory}}` + +- List security properties of a process: + +`checksec --proc={{pid}}` + +- List security properties of the running kernel: + +`checksec --kernel` diff --git a/chezmoi b/chezmoi new file mode 100644 index 00000000..dc25e526 --- /dev/null +++ b/chezmoi @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Chezmoi + +> A multi-machine dotfile manager, written in Go. +> More information: . + +- Setup up `chezmoi`, creating a Git repository in `~/.local/share/chezmoi`: + +`chezmoi init` + +- Start tracking one or more dotfiles: + +`chezmoi add {{path/to/dotfile1 path/to/dotfile2 ...}}` + +- Edit the source state of a tracked dotfile: + +`chezmoi edit {{path/to/dotfile_or_symlink}}` + +- See pending changes: + +`chezmoi diff` + +- Apply the changes: + +`chezmoi -v apply` + +- Set up `chezmoi` from existing dotfiles of a Git repository: + +`chezmoi init {{repository_url}}` + +- Pull changes from a remote repository and apply them: + +`chezmoi update` diff --git a/chgrp b/chgrp new file mode 100644 index 00000000..1c8da931 --- /dev/null +++ b/chgrp @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chgrp + +> Change group ownership of files and directories. +> More information: . + +- Change the owner group of a file/directory: + +`chgrp {{group}} {{path/to/file_or_directory}}` + +- Recursively change the owner group of a directory and its contents: + +`chgrp -R {{group}} {{path/to/directory}}` + +- Change the owner group of a symbolic link: + +`chgrp -h {{group}} {{path/to/symlink}}` + +- Change the owner group of a file/directory to match a reference file: + +`chgrp --reference={{path/to/reference_file}} {{path/to/file_or_directory}}` diff --git a/chisel b/chisel new file mode 100644 index 00000000..d0f8b187 --- /dev/null +++ b/chisel @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chisel + +> Create TCP tunnels. Includes both client and server. +> More information: . + +- Run a Chisel server: + +`chisel server` + +- Run a Chisel server listening to a specific port: + +`chisel server -p {{server_port}}` + +- Run a chisel server that accepts authenticated connections using username and password: + +`chisel server --auth {{username}}:{{password}}` + +- Connect to a Chisel server and tunnel a specific port to a remote server and port: + +`chisel client {{server_ip}}:{{server_port}} {{local_port}}:{{remote_server}}:{{remote_port}}` + +- Connect to a Chisel server and tunnel a specific host and port to a remote server and port: + +`chisel client {{server_ip}}:{{server_port}} {{local_host}}:{{local_port}}:{{remote_server}}:{{remote_port}}` + +- Connect to a Chisel server using username and password authentication: + +`chisel client --auth {{username}}:{{password}} {{server_ip}}:{{server_port}} {{local_port}}:{{remote_server}}:{{remote_port}}` diff --git a/chmod b/chmod new file mode 100644 index 00000000..f8233b30 --- /dev/null +++ b/chmod @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chmod + +> Change the access permissions of a file or directory. +> More information: . + +- Give the [u]ser who owns a file the right to e[x]ecute it: + +`chmod u+x {{path/to/file}}` + +- Give the [u]ser rights to [r]ead and [w]rite to a file/directory: + +`chmod u+rw {{path/to/file_or_directory}}` + +- Remove e[x]ecutable rights from the [g]roup: + +`chmod g-x {{path/to/file}}` + +- Give [a]ll users rights to [r]ead and e[x]ecute: + +`chmod a+rx {{path/to/file}}` + +- Give [o]thers (not in the file owner's group) the same rights as the [g]roup: + +`chmod o=g {{path/to/file}}` + +- Remove all rights from [o]thers: + +`chmod o= {{path/to/file}}` + +- Change permissions recursively giving [g]roup and [o]thers the ability to [w]rite: + +`chmod -R g+w,o+w {{path/to/directory}}` + +- Recursively give [a]ll users [r]ead permissions to files and e[X]ecute permissions to sub-directories within a directory: + +`chmod -R a+rX {{path/to/directory}}` diff --git a/choose b/choose new file mode 100644 index 00000000..c5fa3acb --- /dev/null +++ b/choose @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# choose + +> A human-friendly and fast alternative to cut and (sometimes) awk. +> More information: . + +- Print the 5th item from a line (starting from 0): + +`choose {{4}}` + +- Print the first, 3rd, and 5th item from a line, where items are separated by ':' instead of whitespace: + +`choose --field-separator '{{:}}' {{0}} {{2}} {{4}}` + +- Print everything from the 2nd to 5th item on the line, including the 5th: + +`choose {{1}}:{{4}}` + +- Print everything from the 2nd to 5th item on the line, excluding the 5th: + +`choose --exclusive {{1}}:{{4}}` + +- Print the beginning of the line to the 3rd item: + +`choose :{{2}}` + +- Print all items from the beginning of the line until the 3rd item (exclusive): + +`choose --exclusive :{{2}}` + +- Print all items from the 3rd to the end of the line: + +`choose {{2}}:` + +- Print the last item from a line: + +`choose {{-1}}` diff --git a/chown b/chown new file mode 100644 index 00000000..8f73a515 --- /dev/null +++ b/chown @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chown + +> Change user and group ownership of files and directories. +> More information: . + +- Change the owner user of a file/directory: + +`chown {{user}} {{path/to/file_or_directory}}` + +- Change the owner user and group of a file/directory: + +`chown {{user}}:{{group}} {{path/to/file_or_directory}}` + +- Recursively change the owner of a directory and its contents: + +`chown -R {{user}} {{path/to/directory}}` + +- Change the owner of a symbolic link: + +`chown -h {{user}} {{path/to/symlink}}` + +- Change the owner of a file/directory to match a reference file: + +`chown --reference={{path/to/reference_file}} {{path/to/file_or_directory}}` diff --git a/chroma b/chroma new file mode 100644 index 00000000..1693d8b4 --- /dev/null +++ b/chroma @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chroma + +> A general-purpose syntax highlighter. +> The `--lexer` option is usually unnecessary, as it will be automatically determined based on the file extension. +> More information: . + +- Highlight source code from a file with the Python lexer and output to `stdout`: + +`chroma --lexer {{python}} {{path/to/source_file.py}}` + +- Highlight source code from a file with the Go lexer and output to an HTML file: + +`chroma --lexer {{go}} --formatter {{html}} {{path/to/source_file.go}} > {{path/to/target_file.html}}` + +- Highlight source code from `stdin` with the C++ lexer and output to an SVG file, using the Monokai style: + +`{{command}} | chroma --lexer {{c++}} --formatter {{svg}} --style {{monokai}} > {{path/to/target_file.svg}}` + +- List available lexers, styles and formatters: + +`chroma --list` diff --git a/chromium b/chromium new file mode 100644 index 00000000..4e90e12a --- /dev/null +++ b/chromium @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chromium + +> Open-source web browser principally developed and maintained by Google. +> More information: . + +- Open a specific URL or file: + +`chromium {{https://example.com|path/to/file.html}}` + +- Open in incognito mode: + +`chromium --incognito {{example.com}}` + +- Open in a new window: + +`chromium --new-window {{example.com}}` + +- Open in application mode (without toolbars, URL bar, buttons, etc.): + +`chromium --app={{https://example.com}}` + +- Use a proxy server: + +`chromium --proxy-server="{{socks5://hostname:66}}" {{example.com}}` + +- Open with a custom profile directory: + +`chromium --user-data-dir={{path/to/directory}}` + +- Open without CORS validation (useful to test an API): + +`chromium --user-data-dir={{path/to/directory}} --disable-web-security` + +- Open with a DevTools window for each tab opened: + +`chromium --auto-open-devtools-for-tabs` diff --git a/chronic b/chronic new file mode 100644 index 00000000..a11538f5 --- /dev/null +++ b/chronic @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chronic + +> Display `stdout` and `stderr` of a command if and only if it fails. +> More information: . + +- Display `stdout` and `stderr` of the specified command if and only if it produces a non-zero exit code or crashes: + +`chronic {{command options ...}}` + +- Display `stdout` and `stderr` of the specified command if and only if it produces a non-empty `stderr`: + +`chronic -e {{command options ...}}` + +- Enable [v]erbose mode: + +`chronic -v {{command options ...}}` diff --git a/chroot b/chroot new file mode 100644 index 00000000..b764f8c1 --- /dev/null +++ b/chroot @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chroot + +> Run command or interactive shell with special root directory. +> More information: . + +- Run command as new root directory: + +`chroot {{path/to/new/root}} {{command}}` + +- Use a specific user and group: + +`chroot --userspec={{username_or_id:group_name_or_id}}` diff --git a/chsh b/chsh new file mode 100644 index 00000000..90ecdfe9 --- /dev/null +++ b/chsh @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chsh + +> Change user's login shell. +> See platform-specific pages for more options. +> More information: . + +- Set a specific login shell for the current user interactively: + +`chsh` + +- Set a specific login [s]hell for the current user: + +`chsh -s {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`chsh -s {{path/to/shell}} {{username}}` diff --git a/circo b/circo new file mode 100644 index 00000000..9b607030 --- /dev/null +++ b/circo @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# circo + +> Render an image of a `circular` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`circo -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`circo -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`circo -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | circo -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`circo -?` diff --git a/circup b/circup new file mode 100644 index 00000000..34243fa7 --- /dev/null +++ b/circup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# circup + +> The CircuitPython library updater. +> More information: . + +- Interactively update modules on a device: + +`circup update` + +- Install a new library: + +`circup install {{library_name}}` + +- Search for a library: + +`circup show {{partial_name}}` + +- List all libraries on a connected device in `requirements.txt` format: + +`circup freeze` + +- Save all libraries on a connected device in the current directory: + +`circup freeze -r` diff --git a/cksum b/cksum new file mode 100644 index 00000000..6aedc51b --- /dev/null +++ b/cksum @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cksum + +> Calculate CRC checksums and byte counts of a file. +> Note: on old UNIX systems the CRC implementation may differ. +> More information: . + +- Display a 32-bit checksum, size in bytes and filename: + +`cksum {{path/to/file}}` diff --git a/clamav b/clamav new file mode 100644 index 00000000..ec5e6267 --- /dev/null +++ b/clamav @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ClamAV + +> Open-source anti-virus program. +> ClamAV isn't a command, but a set of commands. +> More information: . + +- View documentation for scanning files using the `clamd` daemon: + +`tldr clamdscan` + +- View documentation for scanning files without the `clamd` daemon running: + +`tldr clamscan` + +- View documentation for updating the virus definitions: + +`tldr freshclam` diff --git a/clamdscan b/clamdscan new file mode 100644 index 00000000..f9b9dcd2 --- /dev/null +++ b/clamdscan @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clamdscan + +> A command-line virus scanner using the ClamAV Daemon. +> More information: . + +- Scan a file or directory for vulnerabilities: + +`clamdscan {{path/to/file_or_directory}}` + +- Scan data from `stdin`: + +`{{command}} | clamdscan -` + +- Scan the current directory and output only infected files: + +`clamdscan --infected` + +- Print the scan report to a log file: + +`clamdscan --log {{path/to/log_file}}` + +- Move infected files to a specific directory: + +`clamdscan --move {{path/to/quarantine_directory}}` + +- Remove infected files: + +`clamdscan --remove` + +- Use multiple threads to scan a directory: + +`clamdscan --multiscan` + +- Pass the file descriptor instead of streaming the file to the daemon: + +`clamdscan --fdpass` diff --git a/clamscan b/clamscan new file mode 100644 index 00000000..36afb329 --- /dev/null +++ b/clamscan @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clamscan + +> A command-line virus scanner. +> More information: . + +- Scan a file for vulnerabilities: + +`clamscan {{path/to/file}}` + +- Scan all files recursively in a specific directory: + +`clamscan -r {{path/to/directory}}` + +- Scan data from `stdin`: + +`{{command}} | clamscan -` + +- Specify a virus database file or directory of files: + +`clamscan --database {{path/to/database_file_or_directory}}` + +- Scan the current directory and output only infected files: + +`clamscan --infected` + +- Print the scan report to a log file: + +`clamscan --log {{path/to/log_file}}` + +- Move infected files to a specific directory: + +`clamscan --move {{path/to/quarantine_directory}}` + +- Remove infected files: + +`clamscan --remove yes` diff --git a/clang b/clang new file mode 100644 index 00000000..51731a4a --- /dev/null +++ b/clang @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clang + +> Compiler for C, C++, and Objective-C source files. Can be used as a drop-in replacement for GCC. +> More information: . + +- Compile a source code file into an executable binary: + +`clang {{input_source.c}} -o {{output_executable}}` + +- Activate output of all errors and warnings: + +`clang {{input_source.c}} -Wall -o {{output_executable}}` + +- Include libraries located at a different path than the source file: + +`clang {{input_source.c}} -o {{output_executable}} -I{{header_path}} -L{{library_path}} -l{{library_name}}` + +- Compile source code into LLVM Intermediate Representation (IR): + +`clang -S -emit-llvm {{file.c}} -o {{file.ll}}` + +- Compile source code without linking: + +`clang -c {{input_source.c}}` + +- Optimize the compiled program for performance: + +`clang {{path/to/source.c}} -O{{1|2|3|fast}}` diff --git a/clang++ b/clang++ new file mode 100644 index 00000000..7904ce94 --- /dev/null +++ b/clang++ @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clang++ + +> Compiles C++ source files. +> Part of LLVM. +> More information: . + +- Compile a source code file into an executable binary: + +`clang++ {{path/to/source.cpp}} -o {{path/to/output_executable}}` + +- Display (almost) all errors and warnings: + +`clang++ {{path/to/source.cpp}} -Wall -o {{path/to/output_executable}}` + +- Choose a language standard to compile with: + +`clang++ {{path/to/source.cpp}} -std={{c++20}} -o {{path/to/output_executable}}` + +- Include libraries located at a different path than the source file: + +`clang++ {{path/to/source.cpp}} -o {{path/to/output_executable}} -I{{path/to/header_path}} -L{{path/to/library_path}} -l{{path/to/library_name}}` + +- Compile source code into LLVM Intermediate Representation (IR): + +`clang++ -S -emit-llvm {{path/to/source.cpp}} -o {{path/to/output.ll}}` + +- Optimize the compiled program for performance: + +`clang++ {{path/to/source.cpp}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` diff --git a/clang-cpp b/clang-cpp new file mode 100644 index 00000000..7ae32b78 --- /dev/null +++ b/clang-cpp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clang-cpp + +> This command is an alias of `clang++`. + +- View documentation for the original command: + +`tldr clang++` diff --git a/clang-format b/clang-format new file mode 100644 index 00000000..5ff6b3a8 --- /dev/null +++ b/clang-format @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clang-format + +> Auto-format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code. +> More information: . + +- Format a file and print the result to `stdout`: + +`clang-format {{path/to/file}}` + +- Format a file in-place: + +`clang-format -i {{path/to/file}}` + +- Format a file using a predefined coding style: + +`clang-format --style={{LLVM|GNU|Google|Chromium|Microsoft|Mozilla|WebKit}} {{path/to/file}}` + +- Format a file using the `.clang-format` file in one of the parent directories of the source file: + +`clang-format --style=file {{path/to/file}}` + +- Generate a custom `.clang-format` file: + +`clang-format --style={{LLVM|GNU|Google|Chromium|Microsoft|Mozilla|WebKit}} --dump-config > {{.clang-format}}` diff --git a/clang-tidy b/clang-tidy new file mode 100644 index 00000000..88784a07 --- /dev/null +++ b/clang-tidy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clang-tidy + +> An LLVM-based C/C++ linter to find style violations, bugs and security flaws through static analysis. +> More information: . + +- Run default checks on a source file: + +`clang-tidy {{path/to/file.cpp}}` + +- Don't run any checks other than the `cppcoreguidelines` checks on a file: + +`clang-tidy {{path/to/file.cpp}} -checks={{-*,cppcoreguidelines-*}}` + +- List all available checks: + +`clang-tidy -checks={{*}} -list-checks` + +- Specify defines and includes as compilation options (after `--`): + +`clang-tidy {{path/to/file.cpp}} -- -I{{my_project/include}} -D{{definitions}}` diff --git a/clangd b/clangd new file mode 100644 index 00000000..9fb6a2c5 --- /dev/null +++ b/clangd @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clangd + +> Language server that provides IDE-like features to editors. +> It should be used via an editor plugin rather than invoked directly. +> More information: . + +- Display available options: + +`clangd --help` + +- List of available options: + +`clangd --help-list` + +- Display version: + +`clangd --version` diff --git a/clash b/clash new file mode 100644 index 00000000..ae988682 --- /dev/null +++ b/clash @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clash + +> A rule-based tunnel in Go. +> More information: . + +- Specify a configuration [d]irectory: + +`clash -d {{path/to/directory}}` + +- Specify a configuration [f]ile: + +`clash -f {{path/to/configuration_file}}` diff --git a/clear b/clear new file mode 100644 index 00000000..299c32ca --- /dev/null +++ b/clear @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clear + +> Clears the screen of the terminal. +> More information: . + +- Clear the screen (equivalent to pressing Control-L in Bash shell): + +`clear` + +- Clear the screen but keep the terminal's scrollback buffer: + +`clear -x` + +- Indicate the type of terminal to clean (defaults to the value of the environment variable `TERM`): + +`clear -T {{type_of_terminal}}` + +- Display the version of `ncurses` used by `clear`: + +`clear -V` diff --git a/clementine b/clementine new file mode 100644 index 00000000..968593d8 --- /dev/null +++ b/clementine @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clementine + +> A modern music player and library organizer. +> More information: . + +- Open Clementine: + +`clementine` + +- Start playing a music file: + +`clementine {{url/or/path/to/file.ext}}` + +- Toggle between pausing and playing: + +`clementine --play-pause` + +- Stop playback: + +`clementine --stop` + +- Skip to the next track: + +`clementine --next` + +- Skip to the previous track: + +`clementine --previous` + +- Load a playlist file: + +`clementine --load {{path/to/playlist.ext}}` + +- Play the 5th track in the currently loaded playlist: + +`clementine --play-track {{5}}` diff --git a/cli53 b/cli53 new file mode 100644 index 00000000..d573bda8 --- /dev/null +++ b/cli53 @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cli53 + +> Command line tool for Amazon Route 53. +> More information: . + +- List domains: + +`cli53 list` + +- Create a domain: + +`cli53 create {{mydomain.com}} --comment "{{comment}}"` + +- Export a bind zone file to `stdout`: + +`cli53 export {{mydomain.com}}` + +- Create a `www` subdomain pointing to a relative record in the same zone: + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 CNAME lb'}}` + +- Create a `www` subdomain pointing to an external address (must end with a dot): + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 CNAME lb.externalhost.com.'}}` + +- Create a `www` subdomain pointing to an IP address: + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 A 150.130.110.1'}}` + +- Replace a `www` subdomain pointing to a different IP: + +`cli53 {{rc|rrcreate}} --replace {{'www 300 A 150.130.110.2'}}` + +- Delete a record A: + +`cli53 {{rd|rrdelete}} {{mydomain.com}} {{www}} {{A}}` diff --git a/clido b/clido new file mode 100644 index 00000000..82cebd00 --- /dev/null +++ b/clido @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clido + +> Save-state TODO app for the terminal. +> More information: . + +- Create a list: + +`clido --new {{name}}` + +- Load a list: + +`clido --load {{name}}` + +- Delete a list: + +`clido --remove {{name}}` + +- List all lists: + +`clido --lists` + +- Toggle autowrite: + +`clido toggle-autowrite` + +- Open a list in a text editor: + +`clido edit {{text_editor}}` + +- Display help: + +`clido -h` + +- Display version: + +`clido -v` diff --git a/clifm b/clifm new file mode 100644 index 00000000..a8606e95 --- /dev/null +++ b/clifm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clifm + +> The command-line file manager. +> More information: . + +- Start CliFM: + +`clifm` + +- Open the file or directory whose ELN (entry list number) is 12: + +`12` + +- Create a new file and a new directory: + +`n file dir/` + +- Search for PDF files in the current directory: + +`/*.pdf` + +- Select all PNG files in the current directory: + +`s *.png` + +- Remove the previously selected files (use `t` to send the files to the recycle bin instead): + +`r sel` + +- Display help: + +`?` + +- Exit CliFM: + +`q` diff --git a/clip-view b/clip-view new file mode 100644 index 00000000..b56a43e2 --- /dev/null +++ b/clip-view @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clip-view + +> Command Line Interface Pages render. +> Render for a TlDr-like project with much a more extensive syntax and several render modes. +> More information: . + +- Render specific local pages: + +`clip-view {{path/to/page1.clip path/to/page2.clip ...}}` + +- Render specific remote pages: + +`clip-view {{page_name1 page_name2 ...}}` + +- Render pages by a specific render: + +`clip-view --render {{tldr|tldr-colorful|docopt|docopt-colorful}} {{page_name1 page_name2 ...}}` + +- Render pages with a specific color theme: + +`clip-view --theme {{path/to/local_theme.yaml|remote_theme_name}} {{page_name1 page_name2 ...}}` + +- Clear a page or theme cache: + +`clip-view --clear-{{page|theme}}-cache` + +- Display help: + +`clip-view --help` + +- Display version: + +`clip-view --version` diff --git a/clj b/clj new file mode 100644 index 00000000..d4ce9055 --- /dev/null +++ b/clj @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clj + +> Clojure tool to start a REPL or invoke a function with data. +> All options can be defined in a `deps.edn` file. +> More information: . + +- Start a REPL (interactive shell): + +`clj` + +- Execute a function: + +`clj -X {{namespace/function_name}}` + +- Run the main function of a specified namespace: + +`clj -M -m {{namespace}} {{args}}` + +- Prepare a project by resolving dependencies, downloading libraries, and making/caching classpaths: + +`clj -P` + +- Start an nREPL server with the CIDER middleware: + +`clj -Sdeps '{:deps {nrepl {:mvn/version "0.7.0"} cider/cider-nrepl {:mvn/version "0.25.2"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]' --interactive` + +- Start a REPL for ClojureScript and open a web browser: + +`clj -Sdeps '{:deps {org.clojure/clojurescript {:mvn/version "1.10.758"}}}' --main cljs.main --repl` diff --git a/cloc b/cloc new file mode 100644 index 00000000..8571b5e6 --- /dev/null +++ b/cloc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cloc + +> Count, and compute differences of, lines of source code and comments. +> More information: . + +- Count all the lines of code in a directory: + +`cloc {{path/to/directory}}` + +- Count all the lines of code in a directory, displaying a progress bar during the counting process: + +`cloc --progress=1 {{path/to/directory}}` + +- Compare 2 directory structures and count the differences between them: + +`cloc --diff {{path/to/directory/one}} {{path/to/directory/two}}` + +- Ignore files that are ignored by VCS, such as files specified in `.gitignore`: + +`cloc --vcs git {{path/to/directory}}` + +- Count all the lines of code in a directory, displaying the results for each file instead of each language: + +`cloc --by-file {{path/to/directory}}` diff --git a/clockwork-cli b/clockwork-cli new file mode 100644 index 00000000..fcfa854d --- /dev/null +++ b/clockwork-cli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clockwork-cli + +> A command-line interface for the Clockwork PHP debugging framework. +> More information: . + +- Monitor Clockwork logs for the current project: + +`clockwork-cli` + +- Monitor Clockwork logs for a specific project: + +`clockwork-cli {{path/to/directory}}` + +- Monitor Clockwork logs for multiple projects: + +`clockwork-cli {{path/to/directory1 path/to/directory2 ...}}` diff --git a/clojure b/clojure new file mode 100644 index 00000000..c12d8e03 --- /dev/null +++ b/clojure @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# clojure + +> This command is an alias of `clj`. + +- View documentation for the original command: + +`tldr clj` diff --git a/cloudflared b/cloudflared new file mode 100644 index 00000000..5bfaab7f --- /dev/null +++ b/cloudflared @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cloudflared + +> Create a persistent connection to the Cloudflare network. +> More information: . + +- Authenticate and associate the connection to a domain in the Cloudflare account: + +`cloudflared tunnel login` + +- Create a tunnel with a specific name: + +`cloudflared tunnel create {{name}}` + +- Establish a tunnel to a host in Cloudflare from the local server: + +`cloudflared tunnel --hostname {{hostname}} localhost:{{port_number}}` + +- Establish a tunnel to a host in Cloudflare from the local server, without verifying the local server's certificate: + +`cloudflared tunnel --hostname {{hostname}} localhost:{{port_number}} --no-tls-verify` + +- Save logs to a file: + +`cloudflared tunnel --hostname {{hostname}} http://localhost:{{port_number}} --loglevel {{panic|fatal|error|warn|info|debug}} --logfile {{path/to/file}}` + +- Install cloudflared as a system service: + +`cloudflared service install` diff --git a/cmake b/cmake new file mode 100644 index 00000000..be9f3cbd --- /dev/null +++ b/cmake @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmake + +> Cross-platform build automation system, that generates recipes for native build systems. +> More information: . + +- Generate a build recipe in the current directory with `CMakeLists.txt` from a project directory: + +`cmake {{path/to/project_directory}}` + +- Generate a build recipe, with build type set to `Release` with CMake variable: + +`cmake {{path/to/project_directory}} -D {{CMAKE_BUILD_TYPE=Release}}` + +- Generate a build recipe using `generator_name` as the underlying build system: + +`cmake -G {{generator_name}} {{path/to/project_directory}}` + +- Use a generated recipe in a given directory to build artifacts: + +`cmake --build {{path/to/build_directory}}` + +- Install the build artifacts into `/usr/local/` and strip debugging symbols: + +`cmake --install {{path/to/build_directory}} --strip` + +- Install the build artifacts using the custom prefix for paths: + +`cmake --install {{path/to/build_directory}} --strip --prefix {{path/to/directory}}` + +- Run a custom build target: + +`cmake --build {{path/to/build_directory}} --target {{target_name}}` + +- Display help, obtain a list of generators: + +`cmake --help` diff --git a/cmark b/cmark new file mode 100644 index 00000000..4762c68b --- /dev/null +++ b/cmark @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmark + +> Converts CommonMark Markdown formatted text to other formats. +> More information: . + +- Render a CommonMark Markdown file to HTML: + +`cmark --to html {{filename.md}}` + +- Convert data from `stdin` to LaTeX: + +`cmark --to latex` + +- Convert straight quotes to smart quotes: + +`cmark --smart --to html {{filename.md}}` + +- Validate UTF-8 characters: + +`cmark --validate-utf8 {{filename.md}}` diff --git a/cmatrix b/cmatrix new file mode 100644 index 00000000..727784f3 --- /dev/null +++ b/cmatrix @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmatrix + +> Shows a scrolling Matrix like screen in the terminal. +> More information: . + +- Enable [a]synchronous scrolling: + +`cmatrix -a` + +- Change the text [C]olor (green by default): + +`cmatrix -C {{red}}` + +- Enable [r]ainbow mode: + +`cmatrix -r` + +- Use a screen [u]pdate delay of 100 centiseconds (1 second): + +`cmatrix -u 100` diff --git a/cmctl b/cmctl new file mode 100644 index 00000000..23696e2a --- /dev/null +++ b/cmctl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmctl + +> Manage cert-manager resources inside your cluster. +> Check cert signing status, approve/deny requests, and issue new certificate requests. +> More information: . + +- Check if the cert-manager API is ready: + +`cmctl check api` + +- Check the status of a certificate: + +`cmctl status certificate {{cert_name}}` + +- Create a new certificate request based on an existing certificate: + +`cmctl create certificaterequest my-cr --from-certificate-file {{cert.yaml}}` + +- Create a new certificate request, fetch the signed certificate, and set a maximum wait time: + +`cmctl create certificaterequest my-cr --from-certificate-file {{cert.yaml}} --fetch-certificate --timeout {{20m}}` diff --git a/cmp b/cmp new file mode 100644 index 00000000..f715992b --- /dev/null +++ b/cmp @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmp + +> Compare two files byte by byte. +> More information: . + +- Output char and line number of the first difference between two files: + +`cmp {{path/to/file1}} {{path/to/file2}}` + +- Output info of the first difference: char, line number, bytes, and values: + +`cmp --print-bytes {{path/to/file1}} {{path/to/file2}}` + +- Output the byte numbers and values of every difference: + +`cmp --verbose {{path/to/file1}} {{path/to/file2}}` + +- Compare files but output nothing, yield only the exit status: + +`cmp --quiet {{path/to/file1}} {{path/to/file2}}` diff --git a/cmuwmtopbm b/cmuwmtopbm new file mode 100644 index 00000000..b1ac35aa --- /dev/null +++ b/cmuwmtopbm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cmuwmtopbm + +> Convert a CMU window manager bitmap to a PBM image. +> See also: `pbmtocmuwm`. +> More information: . + +- Convert a CMU window manager bitmap to a PBM image: + +`cmuwmtopbm {{path/to/image.pbm}} > {{path/to/output.bmp}}` diff --git a/code b/code new file mode 100644 index 00000000..0681fcbf --- /dev/null +++ b/code @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# code + +> Cross platform and extensible code editor. +> More information: . + +- Start Visual Studio Code: + +`code` + +- Open specific files/directories: + +`code {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Compare two specific files: + +`code --diff {{path/to/file1}} {{path/to/file2}}` + +- Open specific files/directories in a new window: + +`code --new-window {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Install/uninstall a specific extension: + +`code --{{install|uninstall}}-extension {{publisher.extension}}` + +- Print installed extensions: + +`code --list-extensions` + +- Print installed extensions with their versions: + +`code --list-extensions --show-versions` + +- Start the editor as a superuser (root) while storing user data in a specific directory: + +`sudo code --user-data-dir {{path/to/directory}}` diff --git a/codespell b/codespell new file mode 100644 index 00000000..09b93497 --- /dev/null +++ b/codespell @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# codespell + +> Spellchecker for source code. +> More information: . + +- Check for typos in all text files in the current directory, recursively: + +`codespell` + +- Correct all typos found in-place: + +`codespell --write-changes` + +- Skip files with names that match the specified pattern (accepts a comma-separated list of patterns using wildcards): + +`codespell --skip "{{pattern}}"` + +- Use a custom dictionary file when checking (`--dictionary` can be used multiple times): + +`codespell --dictionary {{path/to/file.txt}}` + +- Do not check words that are listed in the specified file: + +`codespell --ignore-words {{path/to/file.txt}}` + +- Do not check the specified words: + +`codespell --ignore-words-list {{ignored_word1,ignored_word2,...}}` + +- Print 3 lines of context around, before or after each match: + +`codespell --{{context|before-context|after-context}} {{3}}` + +- Check file names for typos, in addition to file contents: + +`codespell --check-filenames` diff --git a/coffee b/coffee new file mode 100644 index 00000000..90a3502b --- /dev/null +++ b/coffee @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# coffee + +> Executes CoffeeScript scripts or compiles them into JavaScript. +> More information: . + +- Run a script: + +`coffee {{path/to/file.coffee}}` + +- Compile to JavaScript and save to a file with the same name: + +`coffee --compile {{path/to/file.coffee}}` + +- Compile to JavaScript and save to a given output file: + +`coffee --compile {{path/to/file.coffee}} --output {{path/to/file.js}}` + +- Start a REPL (interactive shell): + +`coffee --interactive` + +- Watch script for changes and re-run script: + +`coffee --watch {{path/to/file.coffee}}` diff --git a/cola b/cola new file mode 100644 index 00000000..04136b84 --- /dev/null +++ b/cola @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cola + +> This command is an alias of `git-cola`. + +- View documentation for the original command: + +`tldr git-cola` diff --git a/colon b/colon new file mode 100644 index 00000000..09b690fa --- /dev/null +++ b/colon @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# colon + +> Returns a successful exit status code of 0. +> More information: . + +- Return a successful exit code: + +`:` + +- Make a command always exit with 0: + +`{{command}} || :` diff --git a/colordiff b/colordiff new file mode 100644 index 00000000..d7ea8f8b --- /dev/null +++ b/colordiff @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# colordiff + +> A wrapper around `diff` that produces the same output but with pretty syntax highlighting. +> Color schemes can be customized. +> More information: . + +- Compare files: + +`colordiff {{file1}} {{file2}}` + +- Output in two columns: + +`colordiff -y {{file1}} {{file2}}` + +- Ignore case differences in file contents: + +`colordiff -i {{file1}} {{file2}}` + +- Report when two files are the same: + +`colordiff -s {{file1}} {{file2}}` + +- Ignore whitespace: + +`colordiff -w {{file1}} {{file2}}` diff --git a/colorls b/colorls new file mode 100644 index 00000000..eb7a3577 --- /dev/null +++ b/colorls @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# colorls + +> Beautify `ls` command output, with color and font-awesome icons. Available as a Ruby gem. +> More information: . + +- List files one per line: + +`colorls -1` + +- List all files, including hidden files: + +`colorls --all` + +- Long format list (permissions, ownership, size, and modification date) of all files: + +`colorls --long --all` + +- Only list directories: + +`colorls --dirs` diff --git a/colorpicker b/colorpicker new file mode 100644 index 00000000..dff4f3af --- /dev/null +++ b/colorpicker @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# colorpicker + +> A minimalist X11 colorpicker. +> Any mouse gesture except left click will exit the program. +> More information: . + +- Launch colorpicker and print the hexadecimal and RGB value of each clicked pixel to `stdout`: + +`colorpicker` + +- Only print the color of one clicked pixel and then exit: + +`colorpicker --one-shot` + +- Print the color of each clicked pixel and quit when a key is pressed: + +`colorpicker --quit-on-keypress` + +- Only print the RGB value: + +`colorpicker --rgb` + +- Only print the hexadecimal value: + +`colorpicker --hex` diff --git a/column b/column new file mode 100644 index 00000000..80015de3 --- /dev/null +++ b/column @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# column + +> Format `stdin` or a file into multiple columns. +> Columns are filled before rows; the default separator is a whitespace. +> More information: . + +- Format the output of a command for a 30 characters wide display: + +`printf "header1 header2 +bar foo +" | column --output-width {{30}}` + +- Split columns automatically and auto-align them in a tabular format: + +`printf "header1 header2 +bar foo +" | column --table` + +- Specify the column delimiter character for the `--table` option (e.g. "," for CSV) (defaults to whitespace): + +`printf "header1,header2 +bar,foo +" | column --table --separator {{,}}` + +- Fill rows before filling columns: + +`printf "header1 +bar +foobar +" | column --output-width {{30}} --fillrows` diff --git a/combine b/combine new file mode 100644 index 00000000..be7e7e2a --- /dev/null +++ b/combine @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# combine + +> Perform set operations on lines of two files. +> The order of the output lines is determined by the order of the lines in the first file. +> See also: `diff`. +> More information: . + +- Output lines that are in both specified files: + +`combine {{path/to/file1}} and {{path/to/file2}}` + +- Output lines that are in the first but not in the second file: + +`combine {{path/to/file1}} not {{path/to/file2}}` + +- Output lines that in are in either of the specified files: + +`combine {{path/to/file1}} or {{path/to/file2}}` + +- Output lines that are in exactly one of the specified files: + +`combine {{path/to/file1}} xor {{path/to/file2}}` diff --git a/comby b/comby new file mode 100644 index 00000000..3c6d385e --- /dev/null +++ b/comby @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# comby + +> Tool for structural code search and replace that supports many languages. +> More information: . + +- Match and rewrite templates, and print changes: + +`comby '{{assert_eq!(:[a], :[b])}}' '{{assert_eq!(:[b], :[a])}}' {{.rs}}` + +- Match and rewrite with rewrite properties: + +`comby '{{assert_eq!(:[a], :[b])}}' '{{assert_eq!(:[b].Capitalize, :[a])}}' {{.rs}}` + +- Match and rewrite in-place: + +`comby -in-place '{{match_pattern}}' '{{rewrite_pattern}}'` + +- Only perform matching and print matches: + +`comby -match-only '{{match_pattern}}' ""` diff --git a/comm b/comm new file mode 100644 index 00000000..e5f3e9c9 --- /dev/null +++ b/comm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# comm + +> Select or reject lines common to two files. Both files must be sorted. +> More information: . + +- Produce three tab-separated columns: lines only in first file, lines only in second file and common lines: + +`comm {{file1}} {{file2}}` + +- Print only lines common to both files: + +`comm -12 {{file1}} {{file2}}` + +- Print only lines common to both files, reading one file from `stdin`: + +`cat {{file1}} | comm -12 - {{file2}}` + +- Get lines only found in first file, saving the result to a third file: + +`comm -23 {{file1}} {{file2}} > {{file1_only}}` + +- Print lines only found in second file, when the files aren't sorted: + +`comm -13 <(sort {{file1}}) <(sort {{file2}})` diff --git a/command b/command new file mode 100644 index 00000000..4007605c --- /dev/null +++ b/command @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# command + +> Command forces the shell to execute the program and ignore any functions, builtins and aliases with the same name. +> More information: . + +- Execute the `ls` program literally, even if an `ls` alias exists: + +`command {{ls}}` + +- Display the path to the executable or the alias definition of a specific command: + +`command -v {{command_name}}` diff --git a/compare b/compare new file mode 100644 index 00000000..371ee607 --- /dev/null +++ b/compare @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# compare + +> Create a comparison image to visually annotate the difference between two images. +> Part of ImageMagick. +> More information: . + +- Compare two images: + +`compare {{path/to/image1.png}} {{path/to/image2.png}} {{path/to/diff.png}}` + +- Compare two images using the specified metric: + +`compare -verbose -metric {{PSNR}} {{path/to/image1.png}} {{path/to/image2.png}} {{path/to/diff.png}}` diff --git a/compgen b/compgen new file mode 100644 index 00000000..98ac80dc --- /dev/null +++ b/compgen @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# compgen + +> A built-in command for auto-completion in Bash, which is called on pressing TAB key twice. +> More information: . + +- List all commands that you could run: + +`compgen -c` + +- List all aliases: + +`compgen -a` + +- List all functions that you could run: + +`compgen -A function` + +- Show shell reserved keywords: + +`compgen -k` + +- See all available commands/aliases starting with 'ls': + +`compgen -ac {{ls}}` diff --git a/complete b/complete new file mode 100644 index 00000000..f24097cd --- /dev/null +++ b/complete @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# complete + +> Provides argument autocompletion to shell commands. +> More information: . + +- Apply a function that performs autocompletion to a command: + +`complete -F {{function}} {{command}}` + +- Apply a command that performs autocompletion to another command: + +`complete -C {{autocomplete_command}} {{command}}` + +- Apply autocompletion without appending a space to the completed word: + +`complete -o nospace -F {{function}} {{command}}` diff --git a/composer b/composer new file mode 100644 index 00000000..58089d6e --- /dev/null +++ b/composer @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# composer + +> A package-based dependency manager for PHP projects. +> More information: . + +- Interactively create a `composer.json` file: + +`composer init` + +- Add a package as a dependency for this project, adding an entry to `composer.json`: + +`composer require {{user/package}}` + +- Install all the dependencies in this project's `composer.json` and create `composer.lock`: + +`composer install` + +- Uninstall a package from this project, removing it as a dependency from `composer.json` and `composer.lock`: + +`composer remove {{user/package}}` + +- Update all the dependencies in this project's `composer.json` and note new versions in `composer.lock` file: + +`composer update` + +- Update only `composer.lock` after updating `composer.json` manually: + +`composer update --lock` + +- Learn more about why a dependency can't be installed: + +`composer why-not {{user/package}}` + +- Update composer to its latest version: + +`composer self-update` diff --git a/composer-require-checker b/composer-require-checker new file mode 100644 index 00000000..f9438121 --- /dev/null +++ b/composer-require-checker @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# composer-require-checker + +> Analyze Composer dependencies for soft dependencies. +> More information: . + +- Analyze a Composer JSON file: + +`composer-require-checker check {{path/to/composer.json}}` + +- Analyze a Composer JSON file with a specific configuration: + +`composer-require-checker check --config-file {{path/to/config.json}} {{path/to/composer.json}}` diff --git a/conan b/conan new file mode 100644 index 00000000..4c092926 --- /dev/null +++ b/conan @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# conan + +> The open source, decentralized and cross-platform package manager to create and share all your native binaries. +> Some subcommands such as `conan frogarian` have their own usage documentation. +> More information: . + +- Install packages based on `conanfile.txt`: + +`conan install {{.}}` + +- Install packages and create configuration files for a specific generator: + +`conan install -g {{generator}}` + +- Install packages, building from source: + +`conan install {{.}} --build` + +- Search for locally installed packages: + +`conan search {{package}}` + +- Search for remote packages: + +`conan search {{package}} -r {{remote}}` + +- List remotes: + +`conan remote list` diff --git a/conan-frogarian b/conan-frogarian new file mode 100644 index 00000000..2abb9677 --- /dev/null +++ b/conan-frogarian @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# conan frogarian + +> Displays the conan frogarian. +> More information: . + +- Display the conan frogarian: + +`conan frogarian` diff --git a/conda b/conda new file mode 100644 index 00000000..71d33264 --- /dev/null +++ b/conda @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# conda + +> Package, dependency and environment management for any programming language. +> Some subcommands such as `conda create` have their own usage documentation. +> More information: . + +- Create a new environment, installing named packages into it: + +`conda create --name {{environment_name}} {{python=3.9 matplotlib}}` + +- List all environments: + +`conda info --envs` + +- Load an environment: + +`conda activate {{environment_name}}` + +- Unload an environment: + +`conda deactivate` + +- Delete an environment (remove all packages): + +`conda remove --name {{environment_name}} --all` + +- Install packages into the current environment: + +`conda install {{python=3.4 numpy}}` + +- List currently installed packages in current environment: + +`conda list` + +- Delete unused packages and caches: + +`conda clean --all` diff --git a/conda-create b/conda-create new file mode 100644 index 00000000..453e39af --- /dev/null +++ b/conda-create @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# conda create + +> Create new conda environments. +> More information: . + +- Create a new environment named `py39`, and install Python 3.9 and NumPy v1.11 or above in it: + +`conda create --yes --name {{py39}} python={{3.9}} "{{numpy>=1.11}}"` + +- Make exact copy of an environment: + +`conda create --clone {{py39}} --name {{py39-copy}}` + +- Create a new environment with a specified name and install a given package: + +`conda create --name {{env_name}} {{package}}` diff --git a/conda-install b/conda-install new file mode 100644 index 00000000..7630025e --- /dev/null +++ b/conda-install @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# conda install + +> Install packages into an existing conda environment. +> More information: . + +- Install one or more package into the currently active conda environment: + +`conda install {{package1 package2 ...}}` + +- Install a single package into the currently active conda environment using channel conda-forge: + +`conda install -c conda-forge {{package}}` + +- Install a single package into the currently active conda environment using channel conda-forge and ignoring other channels: + +`conda install -c conda-forge --override-channels {{package}}` + +- Install a specific version of a package: + +`conda install {{package}}={{version}}` + +- Install a package into a specific environment: + +`conda install --name {{environment}} {{package}}` + +- Update a package in the current environment: + +`conda install --upgrade {{package}}` + +- Install a package and agree to the transactions without prompting: + +`conda install --yes {{package}}` diff --git a/consul b/consul new file mode 100644 index 00000000..b1427b65 --- /dev/null +++ b/consul @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# consul + +> Distributed key-value store with health checking and service discovery. +> Some subcommands such as `consul kv` have their own usage documentation. +> More information: . + +- Display help: + +`consul --help` + +- Display help for a subcommand: + +`consul {{subcommand}} --help` + +- Display version: + +`consul --version` diff --git a/consul-kv b/consul-kv new file mode 100644 index 00000000..7270d523 --- /dev/null +++ b/consul-kv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# consul-kv + +> Distributed key-value store with health checking and service discovery. +> More information: . + +- Read a value from the key-value store: + +`consul kv get {{key}}` + +- Store a new key-value pair: + +`consul kv put {{key}} {{value}}` + +- Delete a key-value pair: + +`consul kv delete {{key}}` diff --git a/convert b/convert new file mode 100644 index 00000000..95e0878c --- /dev/null +++ b/convert @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# convert + +> Image conversion tool. +> Part of ImageMagick. +> More information: . + +- Convert an image from JPG to PNG: + +`convert {{path/to/input_image.jpg}} {{path/to/output_image.png}}` + +- Scale an image to 50% of its original size: + +`convert {{path/to/input_image.png}} -resize 50% {{path/to/output_image.png}}` + +- Scale an image keeping the original aspect ratio to a maximum dimension of 640x480: + +`convert {{path/to/input_image.png}} -resize 640x480 {{path/to/output_image.png}}` + +- Horizontally append images: + +`convert {{path/to/image1.png path/to/image2.png ...}} +append {{path/to/output_image.png}}` + +- Vertically append images: + +`convert {{path/to/image1.png path/to/image2.png ...}} -append {{path/to/output_image.png}}` + +- Create a GIF from a series of images with 100ms delay between them: + +`convert {{path/to/image1.png path/to/image2.png ...}} -delay {{10}} {{path/to/animation.gif}}` + +- Create an image with nothing but a solid red background: + +`convert -size {{800x600}} "xc:{{#ff0000}}" {{path/to/image.png}}` + +- Create a favicon from several images of different sizes: + +`convert {{path/to/image1.png path/to/image2.png ...}} {{path/to/favicon.ico}}` diff --git a/convmv b/convmv new file mode 100644 index 00000000..7b08c4cb --- /dev/null +++ b/convmv @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# convmv + +> Convert filenames (NOT file content) from one encoding to another. +> More information: . + +- Test filename encoding conversion (don't actually change the filename): + +`convmv -f {{from_encoding}} -t {{to_encoding}} {{input_file}}` + +- Convert filename encoding and rename the file to the new encoding: + +`convmv -f {{from_encoding}} -t {{to_encoding}} --notest {{input_file}}` diff --git a/coproc b/coproc new file mode 100644 index 00000000..397b9a4e --- /dev/null +++ b/coproc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# coproc + +> Bash builtin for creating interactive asynchronous subshells. +> More information: . + +- Run a subshell asynchronously: + +`coproc { {{command1; command2; ...}}; }` + +- Create a coprocess with a specific name: + +`coproc {{name}} { {{command1; command2; ...}}; }` + +- Write to a specific coprocess `stdin`: + +`echo "{{input}}" >&"${{{name}}[1]}"` + +- Read from a specific coprocess `stdout`: + +`read {{variable}} <&"${{{name}}[0]}"` + +- Create a coprocess which repeatedly reads `stdin` and runs some commands on the input: + +`coproc {{name}} { while read line; do {{command1; command2; ...}}; done }` + +- Create and use a coprocess running `bc`: + +`coproc BC { bc --mathlib; }; echo "1/3" >&"${BC[1]}"; read output <&"${BC[0]}"; echo "$output"` diff --git a/copyq b/copyq new file mode 100644 index 00000000..f241ea8a --- /dev/null +++ b/copyq @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# copyq + +> Clipboard manager with advanced features. +> More information: . + +- Launch CopyQ to store clipboard history: + +`copyq` + +- Show current clipboard content: + +`copyq clipboard` + +- Insert raw text into the clipboard history: + +`copyq add -- {{text1}} {{text2}} {{text3}}` + +- Insert text containing escape sequences (' +', ' ') into the clipboard history: + +`copyq add {{firstline +secondline}}` + +- Print the content of the first 3 items in the clipboard history: + +`copyq read 0 1 2` + +- Copy a file's contents into the clipboard: + +`copyq copy < {{path/to/file.txt}}` + +- Copy a JPEG image into the clipboard: + +`copyq copy image/jpeg < {{path/to/image.jpg}}` diff --git a/cordova b/cordova new file mode 100644 index 00000000..e9dc0910 --- /dev/null +++ b/cordova @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cordova + +> Mobile apps with HTML, CSS & JS. +> More information: . + +- Create a Cordova project: + +`cordova create {{path/to/directory}} {{package}} {{project_name}}` + +- Display the current workspace status: + +`cordova info` + +- Add a Cordova platform: + +`cordova platform add {{platform}}` + +- Remove a Cordova platform: + +`cordova platform remove {{platform}}` + +- Add a Cordova plugin: + +`cordova plugin add {{pluginid}}` + +- Remove a Cordova plugin: + +`cordova plugin remove {{pluginid}}` diff --git a/core-validate-commit b/core-validate-commit new file mode 100644 index 00000000..60a7f3a4 --- /dev/null +++ b/core-validate-commit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# core-validate-commit + +> Validate commit messages for Node.js core. +> More information: . + +- Validate the current commit: + +`core-validate-commit` + +- Validate a specific commit: + +`core-validate-commit {{commit_hash}}` + +- Validate a range of commits: + +`git rev-list {{commit_hash}}..HEAD | xargs core-validate-commit` + +- List all validation rules: + +`core-validate-commit --list` + +- List all valid Node.js subsystems: + +`core-validate-commit --list-subsystem` + +- Validate the current commit formatting the output in tap format: + +`core-validate-commit --tap` + +- Display help: + +`core-validate-commit --help` diff --git a/corepack b/corepack new file mode 100644 index 00000000..a24d1b3e --- /dev/null +++ b/corepack @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# corepack + +> Zero-runtime-dependency package acting as bridge between Node projects and their package managers. +> More information: . + +- Add the Corepack shims to the Node.js installation directory to make them available as global commands: + +`corepack enable` + +- Add the Corepack shims to a specific directory: + +`corepack enable --install-directory {{path/to/directory}}` + +- Remove the Corepack shims from the Node.js installation directory: + +`corepack disable` + +- Prepare a specific package manager: + +`corepack prepare {{package_manager}}@{{version}} --activate` + +- Prepare the package manager configured for the project in the current path: + +`corepack prepare` + +- Use a package manager without installing it as a global command: + +`corepack {{npm|pnpm|yarn}} {{package_manager_arguments}}` + +- Install a package manager from the specified archive: + +`corepack hydrate {{path/to/corepack.tgz}}` + +- Display help for a subcommand: + +`corepack {{subcommand}} --help` diff --git a/cosign b/cosign new file mode 100644 index 00000000..5409e1cb --- /dev/null +++ b/cosign @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cosign + +> Container Signing, Verification and Storage in an OCI registry. +> More information: . + +- Generate a key-pair: + +`cosign generate-key-pair` + +- Sign a container and store the signature in the registry: + +`cosign sign -key {{cosign.key}} {{image}}` + +- Sign a container image with a key pair stored in a Kubernetes secret: + +`cosign sign -key k8s://{{namespace}}/{{key}} {{image}}` + +- Sign a blob with a local key pair file: + +`cosign sign-blob --key {{cosign.key}} {{path/to/file}}` + +- Verify a container against a public key: + +`cosign verify -key {{cosign.pub}} {{image}}` + +- Verify images with a public key in a Dockerfile: + +`cosign dockerfile verify -key {{cosign.pub}} {{path/to/Dockerfile}}` + +- Verify an image with a public key stored in a Kubernetes secret: + +`cosign verify -key k8s://{{namespace}}/{{key}} {{image}}` + +- Copy a container image and its signatures: + +`cosign copy {{example.com/src:latest}} {{example.com/dest:latest}}` diff --git a/cotton b/cotton new file mode 100644 index 00000000..4b615d95 --- /dev/null +++ b/cotton @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cotton + +> Markdown test specification runner. +> More information: . + +- Use a specific base URL: + +`cotton -u {{base_url}} {{path/to/file.md}}` + +- Disable certificate verification (insecure mode): + +`cotton -u {{base_url}} -i {{path/to/file.md}}` + +- Stop running when a test fails: + +`cotton -u {{base_url}} -s {{path/to/file.md}}` diff --git a/couchdb b/couchdb new file mode 100644 index 00000000..2c410d5d --- /dev/null +++ b/couchdb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# couchdb + +> Command-line interface for Apache CouchDB database server. +> More information: . + +- Start CouchDB: + +`couchdb` + +- Start CouchDB interactive shell: + +`couchdb -i` + +- Start CouchDB as a background process: + +`couchdb -b` + +- Kill the background process (Note: It will respawn if needed): + +`couchdb -k` + +- Shutdown the background process: + +`couchdb -d` diff --git a/cowsay b/cowsay new file mode 100644 index 00000000..7ad054c1 --- /dev/null +++ b/cowsay @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cowsay + +> Print ASCII art (by default a cow) saying or thinking something. +> More information: . + +- Print an ASCII cow saying "hello, world": + +`cowsay "{{hello, world}}"` + +- Print an ASCII cow saying text from `stdin`: + +`echo "{{hello, world}}" | cowsay` + +- List all available art types: + +`cowsay -l` + +- Print the specified ASCII art saying "hello, world": + +`cowsay -f {{art}} "{{hello, world}}"` + +- Print a dead thinking ASCII cow: + +`cowthink -d "{{I'm just a cow, not a great thinker...}}"` + +- Print an ASCII cow with custom eyes saying "hello, world": + +`cowsay -e {{characters}} "{{hello, world}}"` diff --git a/cp b/cp new file mode 100644 index 00000000..b30124f6 --- /dev/null +++ b/cp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cp + +> Copy files and directories. +> More information: . + +- Copy a file to another location: + +`cp {{path/to/source_file.ext}} {{path/to/target_file.ext}}` + +- Copy a file into another directory, keeping the filename: + +`cp {{path/to/source_file.ext}} {{path/to/target_parent_directory}}` + +- Recursively copy a directory's contents to another location (if the destination exists, the directory is copied inside it): + +`cp -R {{path/to/source_directory}} {{path/to/target_directory}}` + +- Copy a directory recursively, in verbose mode (shows files as they are copied): + +`cp -vR {{path/to/source_directory}} {{path/to/target_directory}}` + +- Copy multiple files at once to a directory: + +`cp -t {{path/to/destination_directory}} {{path/to/file1 path/to/file2 ...}}` + +- Copy text files to another location, in interactive mode (prompts user before overwriting): + +`cp -i {{*.txt}} {{path/to/target_directory}}` + +- Follow symbolic links before copying: + +`cp -L {{link}} {{path/to/target_directory}}` + +- Use the first argument as the destination directory (useful for `xargs ... | cp -t `): + +`cp -t {{path/to/target_directory}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/cpdf b/cpdf new file mode 100644 index 00000000..57750f85 --- /dev/null +++ b/cpdf @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cpdf + +> Manipulate PDF files. +> More information: . + +- Select pages 1, 2, 3 and 6 from a source document and write those to a destination document: + +`cpdf {{path/to/source_document.pdf}} {{1-3,6}} -o {{path/to/destination_document.pdf}}` + +- Merge two documents into a new one: + +`cpdf -merge {{path/to/source_document_one.pdf}} {{path/to/source_document_two.pdf}} -o {{path/to/destination_document.pdf}}` + +- Show the bookmarks of a document: + +`cpdf -list-bookmarks {{path/to/document.pdf}}` + +- Split a document into ten-page chunks, writing them to `chunk001.pdf`, `chunk002.pdf`, etc: + +`cpdf -split {{path/to/document.pdf}} -o {{path/to/chunk%%%.pdf}} -chunk {{10}}` + +- Encrypt a document using 128bit encryption, providing `fred` as owner password and `joe` as user password: + +`cpdf -encrypt {{128bit}} {{fred}} {{joe}} {{path/to/source_document.pdf}} -o {{path/to/encrypted_document.pdf}}` + +- Decrypt a document using the owner password `fred`: + +`cpdf -decrypt {{path/to/encrypted_document.pdf}} owner={{fred}} -o {{path/to/decrypted_document.pdf}}` + +- Show the annotations of a document: + +`cpdf -list-annotations {{path/to/document.pdf}}` + +- Create a new document from an existing one with additional metadata: + +`cpdf -set-metadata {{path/to/metadata.xml}} {{path/to/source_document.pdf}} -o {{path/to/destination_document.pdf}}` diff --git a/cpio b/cpio new file mode 100644 index 00000000..4e2aecbb --- /dev/null +++ b/cpio @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cpio + +> Copies files in and out of archives. +> Supports the following archive formats: cpio's custom binary, old ASCII, new ASCII, crc, HPUX binary, HPUX old ASCII, old tar, and POSIX.1 tar. +> More information: . + +- Take a list of file names from `stdin` and add them [o]nto an archive in cpio's binary format: + +`echo "{{path/to/file1 path/to/file2 ...}}" | cpio -o > {{archive.cpio}}` + +- Copy all files and directories in a directory and add them [o]nto an archive, in [v]erbose mode: + +`find {{path/to/directory}} | cpio -ov > {{archive.cpio}}` + +- P[i]ck all files from an archive, generating [d]irectories where needed, in [v]erbose mode: + +`cpio -idv < {{archive.cpio}}` diff --git a/cppcheck b/cppcheck new file mode 100644 index 00000000..484fcd34 --- /dev/null +++ b/cppcheck @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cppcheck + +> A static analysis tool for C/C++ code. +> Instead of syntax errors, it focuses on the types of bugs that compilers normally do not detect. +> More information: . + +- Recursively check the current directory, showing progress on the screen and logging error messages to a file: + +`cppcheck . 2> cppcheck.log` + +- Recursively check a given directory, and don't print progress messages: + +`cppcheck --quiet {{path/to/directory}}` + +- Check a given file, specifying which tests to perform (by default only errors are shown): + +`cppcheck --enable={{error|warning|style|performance|portability|information|all}} {{path/to/file.cpp}}` + +- List available tests: + +`cppcheck --errorlist` + +- Check a given file, ignoring specific tests: + +`cppcheck --suppress={{test_id1}} --suppress={{test_id2}} {{path/to/file.cpp}}` + +- Check the current directory, providing paths for include files located outside it (e.g. external libraries): + +`cppcheck -I {{include/directory_1}} -I {{include/directory_2}} .` + +- Check a Microsoft Visual Studio project (`*.vcxproj`) or solution (`*.sln`): + +`cppcheck --project={{path/to/project.sln}}` diff --git a/cppclean b/cppclean new file mode 100644 index 00000000..ba0a61dd --- /dev/null +++ b/cppclean @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cppclean + +> Find unused code in C++ projects. +> More information: . + +- Run in a project's directory: + +`cppclean {{path/to/project}}` + +- Run on a project where the headers are in the `inc1/` and `inc2/` directories: + +`cppclean {{path/to/project}} --include-path={{inc1}} --include-path={{inc2}}` + +- Run on a specific file `main.cpp`: + +`cppclean {{main.cpp}}` + +- Run on the current directory, excluding the "build" directory: + +`cppclean {{.}} --exclude={{build}}` diff --git a/cradle b/cradle new file mode 100644 index 00000000..00802a4f --- /dev/null +++ b/cradle @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle + +> The Cradle PHP framework. +> Some subcommands such as `cradle install` have their own usage documentation. +> More information: . + +- Connect to a server: + +`cradle connect {{server_name}}` + +- Execute a Cradle command: + +`cradle {{command}}` + +- Display help: + +`cradle help` + +- Display help for a specific command: + +`cradle {{command}} help` diff --git a/cradle-deploy b/cradle-deploy new file mode 100644 index 00000000..2d8e6a91 --- /dev/null +++ b/cradle-deploy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle deploy + +> Manage Cradle deployments. +> More information: . + +- Deploy Cradle to a server: + +`cradle deploy production` + +- Deploy static assets to Amazon S3: + +`cradle deploy s3` + +- Deploy static assets including the Yarn "components" directory: + +`cradle deploy s3 --include-yarn` + +- Deploy static assets including the "upload" directory: + +`cradle deploy s3 --include-upload` diff --git a/cradle-elastic b/cradle-elastic new file mode 100644 index 00000000..88a08254 --- /dev/null +++ b/cradle-elastic @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle elastic + +> Manage the Elasticsearch instances for a Cradle instance. +> More information: . + +- Truncate the Elasticsearch index: + +`cradle elastic flush` + +- Truncate the Elasticsearch index for a specific package: + +`cradle elastic flush {{package}}` + +- Submit the Elasticsearch schema: + +`cradle elastic map` + +- Submit the Elasticsearch schema for a specific package: + +`cradle elastic map {{package}}` + +- Populate the Elasticsearch indices for all packages: + +`cradle elastic populate` + +- Populate the Elasticsearch indices for a specific package: + +`cradle elastic populate {{package}}` diff --git a/cradle-install b/cradle-install new file mode 100644 index 00000000..cff1dc7b --- /dev/null +++ b/cradle-install @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle install + +> Installs the Cradle PHP framework components. +> More information: . + +- Install Cradle's components (User will be prompted for further details): + +`cradle install` + +- Forcefully overwrite files: + +`cradle install --force` + +- Skip running SQL migrations: + +`cradle install --skip-sql` + +- Skip running package updates: + +`cradle install --skip-versioning` + +- Use specific database details: + +`cradle install -h {{hostname}} -u {{username}} -p {{password}}` diff --git a/cradle-package b/cradle-package new file mode 100644 index 00000000..8b3c427d --- /dev/null +++ b/cradle-package @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle package + +> Manage packages for a Cradle instance. +> More information: . + +- Display a list of available packages: + +`cradle package list` + +- Search for a package: + +`cradle package search {{package}}` + +- Install a package from Packagist: + +`cradle package install {{package}}` + +- Install a specific version of a package: + +`cradle package install {{package}} {{version}}` + +- Update a package: + +`cradle package update {{package}}` + +- Update a package to a specific version: + +`cradle package update {{package}} {{version}}` + +- Remove a specific package: + +`cradle package remove {{package}}` diff --git a/cradle-sql b/cradle-sql new file mode 100644 index 00000000..c30e3de0 --- /dev/null +++ b/cradle-sql @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cradle sql + +> Manage Cradle SQL databases. +> More information: . + +- Rebuild the database schema: + +`cradle sql build` + +- Rebuild the database schema for a specific package: + +`cradle sql build {{package}}` + +- Empty the entire database: + +`cradle sql flush` + +- Empty the database tables for a specific package: + +`cradle sql flush {{package}}` + +- Populate the tables for all packages: + +`cradle sql populate` + +- Populate the tables for a specific package: + +`cradle sql populate {{package}}` diff --git a/createdb b/createdb new file mode 100644 index 00000000..76a58914 --- /dev/null +++ b/createdb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# createdb + +> Create a PostgreSQL database. +> More information: . + +- Create a database owned by the current user: + +`createdb {{database_name}}` + +- Create a database owned by a specific user with a description: + +`createdb --owner={{username}} {{database_name}} '{{description}}'` + +- Create a database from a template: + +`createdb --template={{template_name}} {{database_name}}` diff --git a/crictl b/crictl new file mode 100644 index 00000000..aee6c440 --- /dev/null +++ b/crictl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crictl + +> Command-line for CRI-compatible container runtimes. +> More information: . + +- List all kubernetes pods (Ready and NotReady): + +`crictl pods` + +- List all containers (Running and Exited): + +`crictl ps --all` + +- List all images: + +`crictl images` + +- Print information about specific containers: + +`crictl inspect {{container_id1 container_id2 ...}}` + +- Open a specific shell inside a running container: + +`crictl exec -it {{container_id}} {{sh}}` + +- Pull a specific image from a registry: + +`crictl pull {{image:tag}}` + +- Print and [f]ollow logs of a specific container: + +`crictl logs -f {{container_id}}` + +- Remove one or more images: + +`crictl rmi {{image_id1 image_id2 ...}}` diff --git a/croc b/croc new file mode 100644 index 00000000..eb7d3080 --- /dev/null +++ b/croc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# croc + +> Send and receive files easily and securely over any network. +> More information: . + +- Send a file or directory: + +`croc send {{path/to/file_or_directory}}` + +- Send a file or directory with a specific passphrase: + +`croc send --code {{passphrase}} {{path/to/file_or_directory}}` + +- Receive a file or directory on receiving machine: + +`croc {{passphrase}}` + +- Send and connect over a custom relay: + +`croc --relay {{ip_to_relay}} send {{path/to/file_or_directory}}` + +- Receive and connect over a custom relay: + +`croc --relay {{ip_to_relay}} {{passphrase}}` + +- Host a croc relay on the default ports: + +`croc relay` + +- Display parameters and options for a croc command: + +`croc {{send|relay}} --help` diff --git a/cron b/cron new file mode 100644 index 00000000..c55090d3 --- /dev/null +++ b/cron @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cron + +> A system scheduler for running jobs or tasks unattended. +> The command to submit, edit or delete entries to `cron` is called `crontab`. + +- View documentation for managing `cron` entries: + +`tldr crontab` diff --git a/cronic b/cronic new file mode 100644 index 00000000..0d898c80 --- /dev/null +++ b/cronic @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cronic + +> Bash script for wrapping cron jobs to prevent excess email sending. +> More information: . + +- Call a command and display its output if it returns a non-zero exit code: + +`cronic {{command}}` diff --git a/crontab b/crontab new file mode 100644 index 00000000..9f6d6533 --- /dev/null +++ b/crontab @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crontab + +> Schedule cron jobs to run on a time interval for the current user. +> More information: . + +- Edit the crontab file for the current user: + +`crontab -e` + +- Edit the crontab file for a specific user: + +`sudo crontab -e -u {{user}}` + +- Replace the current crontab with the contents of the given file: + +`crontab {{path/to/file}}` + +- View a list of existing cron jobs for current user: + +`crontab -l` + +- Remove all cron jobs for the current user: + +`crontab -r` + +- Sample job which runs at 10:00 every day (* means any value): + +`0 10 * * * {{command_to_execute}}` + +- Sample crontab entry, which runs a command every 10 minutes: + +`*/10 * * * * {{command_to_execute}}` + +- Sample crontab entry, which runs a certain script at 02:30 every Friday: + +`30 2 * * Fri {{/absolute/path/to/script.sh}}` diff --git a/crunch b/crunch new file mode 100644 index 00000000..a9e34fed --- /dev/null +++ b/crunch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crunch + +> Wordlist generator. +> More information: . + +- Output a list of words of length 1 to 3 with only lowercase characters: + +`crunch {{1}} {{3}}` + +- Output a list of hexadecimal words of length 8: + +`crunch {{8}} {{8}} {{0123456789abcdef}}` + +- Output a list of all permutations of abc (lengths are not processed): + +`crunch {{1}} {{1}} -p {{abc}}` + +- Output a list of all permutations of the given strings (lengths are not processed): + +`crunch {{1}} {{1}} -p {{abc}} {{def}} {{ghi}}` + +- Output a list of words generated according to the given pattern and a maximum number of duplicate letters: + +`crunch {{5}} {{5}} {{abcde123}} -t {{@@@12}} -d 2@` + +- Write a list of words in chunk files of a given size, starting with the given string: + +`crunch {{3}} {{5}} -o {{START}} -b {{10kb}} -s {{abc}}` + +- Write a list of words stopping with the given string and inverting the wordlist: + +`crunch {{1}} {{5}} -o {{START}} -e {{abcde}} -i` + +- Write a list of words in compressed chunk files with a specified number of words: + +`crunch {{1}} {{5}} -o {{START}} -c {{1000}} -z {{gzip|bzip2|lzma|7z}}` diff --git a/cryfs b/cryfs new file mode 100644 index 00000000..a9170328 --- /dev/null +++ b/cryfs @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cryfs + +> A cryptographic filesystem for the cloud. +> More information: . + +- Mount an encrypted filesystem. The initialization wizard will be started on the first execution: + +`cryfs {{path/to/cipher_dir}} {{path/to/mount_point}}` + +- Unmount an encrypted filesystem: + +`cryfs-unmount {{path/to/mount_point}}` + +- Automatically unmount after ten minutes of inactivity: + +`cryfs --unmount-idle {{10}} {{path/to/cipher_dir}} {{path/to/mount_point}}` + +- List supported ciphers: + +`cryfs --show-ciphers` diff --git a/crystal b/crystal new file mode 100644 index 00000000..c63592f0 --- /dev/null +++ b/crystal @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crystal + +> Manage Crystal source code. +> More information: . + +- Run a Crystal file: + +`crystal {{path/to/file.cr}}` + +- Compile a file and all dependencies to a single executable: + +`crystal build {{path/to/file.cr}}` + +- Read Crystal source code from the command line or `stdin`, and execute it: + +`crystal eval '{{code}}'` + +- Generate API documentation from inline docstrings in Crystal files: + +`crystal docs` + +- Compile and run a Crystal specification suite: + +`crystal spec` + +- Start a local interactive server for testing the language: + +`crystal play` + +- Create a project directory for a Crystal application: + +`crystal init app {{application_name}}` + +- Display all help options: + +`crystal help` diff --git a/cs b/cs new file mode 100644 index 00000000..be675bf6 --- /dev/null +++ b/cs @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs + +> Application and artifact manager for the Scala language. +> Installs Scala applications and sets up a Scala development environment. +> Some subcommands such as `install`, `launch`, `java`, `fetch`, `resolve`, `complete-dep`, etc. have their own usage documentation. +> More information: . + +- List installed applications: + +`cs list` + +- Install a specific application: + +`cs install {{application_name}}` + +- Uninstall a specific application: + +`cs uninstall {{application_name}}` + +- Setup machine for the Scala development: + +`cs setup` + +- Update all the installed applications: + +`cs update` + +- Display version: + +`cs version` diff --git a/cs-complete-dep b/cs-complete-dep new file mode 100644 index 00000000..1201149b --- /dev/null +++ b/cs-complete-dep @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs complete dep + +> Search for libraries without doing it directly on the web. +> More information: . + +- Print which artifacts are published under a specific Maven group identifier: + +`cs complete-dep {{group_id}}` + +- List published library versions under a specific Maven group identifier and an artifact one: + +`cs complete-dep {{group_id}}:{{artifact_id}}` + +- Print which artifacts are pubblished under a given Maven groupId searching in the ivy2local: + +`cs complete-dep {{group_id}} --repository ivy2local` + +- List published artifacts under a Maven group identifier searching in a specific repository and credentials: + +`cs complete-dep {{group_id}}:{{artifact_id}} --repository {{repository_url}} --credentials {{user}}:{{password}}` diff --git a/cs-fetch b/cs-fetch new file mode 100644 index 00000000..abf5811e --- /dev/null +++ b/cs-fetch @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs fetch + +> Fetch fetches the JARs of dependencies. +> More information: . + +- Fetch a specific version of a jar: + +`cs fetch {{group_id}}:{{artifact_id}}:{{artifact_version}}` + +- Fetch a package and evaluate the classpath corresponding to the selected package in an env var: + +`CP="$(cs fetch --classpath org.scalameta::scalafmt-cli:latest.release)"` + +- Fetch a source of a specific jar: + +`cs fetch --sources {{group_id}}:{{artifact_id}}:{{artifact_version}}` + +- Fetch the javadoc jars: + +`cs fetch --javadoc {{group_id}}:{{artifact_id}}:{{artifact_version}}` + +- Fetch dependency with javadoc jars and source jars: + +`cs fetch --default={{true}} --sources --javadoc {{group_id}}:{{artifact_id}}:{{artifact_version}}` + +- Fetch jars coming from dependency files: + +`cs fetch {{--dependency-file path/to/file1 --dependency-file path/to/file2 ...}}` diff --git a/cs-install b/cs-install new file mode 100644 index 00000000..e23cf117 --- /dev/null +++ b/cs-install @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs install + +> Install an application in the installation directory onfigured when installing `cs` (to enable the binary to be loaded add to your `.bash_profile` the `$ eval "$(cs install --env)"` command). +> More information: . + +- Install a specific application: + +`cs install {{application_name}}` + +- Install a specific version of an application: + +`cs install {{application_name}}:{{application_version}}` + +- Search an application by a specific name: + +`cs search {{application_partial_name}}` + +- Update a specific application if available: + +`cs update {{application_name}}` + +- Update all the installed applications: + +`cs update` + +- Uninstall a specific application: + +`cs uninstall {{application_name}}` + +- List all installed applications: + +`cs list` + +- Pass specific Java options to an installed application: + +`{{application_name}} {{-Jjava_option_name1=value1 -Jjava_option_name2=value2 ...}}` diff --git a/cs-java b/cs-java new file mode 100644 index 00000000..ba8b81d8 --- /dev/null +++ b/cs-java @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs java + +> The `java` and `java-home` commands fetch and install JVMs. The `java` command runs them too. +> More information: . + +- Display Java version by using coursier: + +`cs java -version` + +- Call a specific Java version with custom properties using coursier: + +`cs java --jvm {{jvm_name}}:{{jvm_version}} -Xmx32m -X{{another_jvm_opt}} -jar {{path/to/jar_name.jar}}` + +- List all the available JVM in the coursier default index: + +`cs java --available` + +- List all the installed JVM in the system with his own location: + +`cs java --installed` + +- Set a specific JVM as one-off default for the shell instance: + +`cs java --jvm {{jvm_name}}:{{jvm_version}} --env` + +- Revert the changes for the default JVM settings: + +`eval "$(cs java --disable)"` + +- Set a specific JVM as default for the whole system: + +`cs java --jvm {{jvm_name}}:{{jvm_version}} --setup` diff --git a/cs-launch b/cs-launch new file mode 100644 index 00000000..cc31e6bb --- /dev/null +++ b/cs-launch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs launch + +> Launch an application from the name directly from Maven dependencies without the need of installing it. +> More information: . + +- Launch a specific application with arguments: + +`cs launch {{application_name}} -- {{argument1 argument2 ...}}` + +- Launch a specific application version with arguments: + +`cs launch {{application_name}}:{{application_version}} -- {{argument1 argument2 ...}}` + +- Launch a specific version of an application specifying which is the main file: + +`cs launch {{group_id}}:{{artifact_id}}:{{artifact_version}} --main-class {{path/to/main_class_file}}` + +- Launch an application with specific Java options and JVM memory ones: + +`cs launch --java-opt {{-Doption_name1:option_value1 -Doption_name2:option_value2 ...}} --java-opt {{-Xjvm_option1 -Xjvm_option2 ...}} {{application_name}}` diff --git a/cs-resolve b/cs-resolve new file mode 100644 index 00000000..54737f7c --- /dev/null +++ b/cs-resolve @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cs resolve + +> Resolve lists the transitive dependencies of other dependencies. +> More information: . + +- Resolve lists of transitive dependencies of two dependencies: + +`cs resolve {{group_id1}}:{{artifact_id1}}:{{artifact_version1}} {{group_id2}}:{{artifact_id2}}:{{artifact_version2}}` + +- Resolve lists of transitive dependencies of a package by the dependency tree: + +`cs resolve --tree {{group_id}}:{{artifact_id}}:{{artifact_version}}` + +- Resolve dependency tree in a reverse order (from a dependency to its dependencies): + +`cs resolve --reverse-tree {{group_id}}:{{artifact_id}}:{{artifact_version}` + +- Print all the libraries that depends on a specific library: + +`cs resolve {{group_id}}:{{artifact_id}}:{{artifact_version}} --what-depends-on {{searched_group_id}}:{{searched_artifact_id}}` + +- Print all the libraries that depends on a specific library version: + +`cs resolve {{group_id}}:{{artifact_id}}:{{artifact_version}} --what-depends-on {{searched_group_id}}:{{searched_artifact_id}}{{searched_artifact_version}}` + +- Print eventual conflicts between a set of packages: + +`cs resolve --conflicts {{group_id1:artifact_id1:artifact_version1 group_id2:artifact_id2:artifact_version2 ...}}` diff --git a/csc b/csc new file mode 100644 index 00000000..e75be185 --- /dev/null +++ b/csc @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csc + +> The Microsoft C# Compiler. +> More information: . + +- Compile one or more C# files to a CIL executable: + +`csc {{path/to/input_file_a.cs}} {{path/to/input_file_b.cs}}` + +- Specify the output filename: + +`csc /out:{{path/to/filename}} {{path/to/input_file.cs}}` + +- Compile into a `.dll` library instead of an executable: + +`csc /target:library {{path/to/input_file.cs}}` + +- Reference another assembly: + +`csc /reference:{{path/to/library.dll}} {{path/to/input_file.cs}}` + +- Embed a resource: + +`csc /resource:{{path/to/resource_file}} {{path/to/input_file.cs}}` + +- Automatically generate XML documentation: + +`csc /doc:{{path/to/output.xml}} {{path/to/input_file.cs}}` + +- Specify an icon: + +`csc /win32icon:{{path/to/icon.ico}} {{path/to/input_file.cs}}` + +- Strongly-name the resulting assembly with a keyfile: + +`csc /keyfile:{{path/to/keyfile}} {{path/to/input_file.cs}}` diff --git a/csh b/csh new file mode 100644 index 00000000..35c66ce4 --- /dev/null +++ b/csh @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csh + +> The shell (command interpreter) with C-like syntax. +> See also: `tcsh`. +> More information: . + +- Start an interactive shell session: + +`csh` + +- Start an interactive shell session without loading startup configs: + +`csh -f` + +- Execute specific [c]ommands: + +`csh -c "{{echo 'csh is executed'}}"` + +- Execute a specific script: + +`csh {{path/to/script.csh}}` diff --git a/csslint b/csslint new file mode 100644 index 00000000..caaedba2 --- /dev/null +++ b/csslint @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csslint + +> A linter for CSS code. +> More information: . + +- Lint a single CSS file: + +`csslint {{file.css}}` + +- Lint multiple CSS files: + +`csslint {{file1.css file2.css ...}}` + +- List all possible style rules: + +`csslint --list-rules` + +- Treat certain rules as errors (which results in a non-zero exit code): + +`csslint --errors={{errors,universal-selector,imports}} {{file.css}}` + +- Treat certain rules as warnings: + +`csslint --warnings={{box-sizing,selector-max,floats}} {{file.css}}` + +- Ignore specific rules: + +`csslint --ignore={{ids,rules-count,shorthand}} {{file.css}}` diff --git a/csv-diff b/csv-diff new file mode 100644 index 00000000..47c88d41 --- /dev/null +++ b/csv-diff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csv-diff + +> View differences between two CSV, TSV or JSON files. +> More information: . + +- Display a human-readable summary of differences between files using a specific column as a unique identifier: + +`csv-diff {{path/to/file1.csv}} {{path/to/file2.csv}} --key={{column_name}}` + +- Display a human-readable summary of differences between files that includes unchanged values in rows with at least one change: + +`csv-diff {{path/to/file1.csv}} {{path/to/file2.csv}} --key={{column_name}} --show-unchanged` + +- Display a summary of differences between files in JSON format using a specific column as a unique identifier: + +`csv-diff {{path/to/file1.csv}} {{path/to/file2.csv}} --key={{column_name}} --json` diff --git a/csv2tsv b/csv2tsv new file mode 100644 index 00000000..7663a707 --- /dev/null +++ b/csv2tsv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csv2tsv + +> Convert CSV (comma-separated) text to TSV (tab-separated) format. +> More information: . + +- Convert from CSV to TSV: + +`csv2tsv {{path/to/input_csv1 path/to/input_csv2 ...}} > {{path/to/output_tsv}}` + +- Convert field delimiter separated CSV to TSV: + +`csv2tsv -c'{{field_delimiter}}' {{path/to/input_csv}}` + +- Convert semicolon separated CSV to TSV: + +`csv2tsv -c';' {{path/to/input_csv}}` diff --git a/csvclean b/csvclean new file mode 100644 index 00000000..ee341adb --- /dev/null +++ b/csvclean @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvclean + +> Finds and cleans common syntax errors in CSV files. +> Included in csvkit. +> More information: . + +- Clean a CSV file: + +`csvclean {{bad.csv}}` + +- List locations of syntax errors in a CSV file: + +`csvclean -n {{bad.csv}}` diff --git a/csvcut b/csvcut new file mode 100644 index 00000000..770d8fd8 --- /dev/null +++ b/csvcut @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvcut + +> Filter and truncate CSV files. Like Unix's `cut` command, but for tabular data. +> Included in csvkit. +> More information: . + +- Print indices and names of all columns: + +`csvcut -n {{data.csv}}` + +- Extract the first and third columns: + +`csvcut -c {{1,3}} {{data.csv}}` + +- Extract all columns except the fourth one: + +`csvcut -C {{4}} {{data.csv}}` + +- Extract the columns named "id" and "first name" (in that order): + +`csvcut -c {{id,"first name"}} {{data.csv}}` diff --git a/csvformat b/csvformat new file mode 100644 index 00000000..e5f984ea --- /dev/null +++ b/csvformat @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvformat + +> Convert a CSV file to a custom output format. +> Included in csvkit. +> More information: . + +- Convert to a tab-delimited file (TSV): + +`csvformat -T {{data.csv}}` + +- Convert delimiters to a custom character: + +`csvformat -D "{{custom_character}}" {{data.csv}}` + +- Convert line endings to carriage return (^M) + line feed: + +`csvformat -M "{{ +}}" {{data.csv}}` + +- Minimize use of quote characters: + +`csvformat -U 0 {{data.csv}}` + +- Maximize use of quote characters: + +`csvformat -U 1 {{data.csv}}` diff --git a/csvgrep b/csvgrep new file mode 100644 index 00000000..95c41ea3 --- /dev/null +++ b/csvgrep @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvgrep + +> Filter CSV rows with string and pattern matching. +> Included in csvkit. +> More information: . + +- Find rows that have a certain string in column 1: + +`csvgrep -c {{1}} -m {{string_to_match}} {{data.csv}}` + +- Find rows in which columns 3 or 4 match a certain regular expression: + +`csvgrep -c {{3,4}} -r {{regular_expression}} {{data.csv}}` + +- Find rows in which the "name" column does NOT include the string "John Doe": + +`csvgrep -i -c {{name}} -m "{{John Doe}}" {{data.csv}}` diff --git a/csvkit b/csvkit new file mode 100644 index 00000000..8e7c8e2f --- /dev/null +++ b/csvkit @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvkit + +> Manipulation toolkit for CSV files. +> See also: `csvclean`, `csvcut`, `csvformat`, `csvgrep`, `csvlook`, `csvpy`, `csvsort`, `csvstat`. +> More information: . + +- Run a command on a CSV file with a custom delimiter: + +`{{command}} -d {{delimiter}} {{path/to/file.csv}}` + +- Run a command on a CSV file with a tab as a delimiter (overrides -d): + +`{{command}} -t {{path/to/file.csv}}` + +- Run a command on a CSV file with a custom quote character: + +`{{command}} -q {{quote_char}} {{path/to/file.csv}}` + +- Run a command on a CSV file with no header row: + +`{{command}} -H {{path/to/file.csv}}` diff --git a/csvlook b/csvlook new file mode 100644 index 00000000..e97a01f5 --- /dev/null +++ b/csvlook @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvlook + +> Render a CSV file in the console as a fixed-width table. +> Included in csvkit. +> More information: . + +- View a CSV file: + +`csvlook {{data.csv}}` diff --git a/csvpy b/csvpy new file mode 100644 index 00000000..5094e7e3 --- /dev/null +++ b/csvpy @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvpy + +> Loads a CSV file into a Python shell. +> Included in csvkit. +> More information: . + +- Load a CSV file into a `CSVKitReader` object: + +`csvpy {{data.csv}}` + +- Load a CSV file into a `CSVKitDictReader` object: + +`csvpy --dict {{data.csv}}` diff --git a/csvsort b/csvsort new file mode 100644 index 00000000..7632722d --- /dev/null +++ b/csvsort @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvsort + +> Sorts CSV files. +> Included in csvkit. +> More information: . + +- Sort a CSV file by column 9: + +`csvsort -c {{9}} {{data.csv}}` + +- Sort a CSV file by the "name" column in descending order: + +`csvsort -r -c {{name}} {{data.csv}}` + +- Sort a CSV file by column 2, then by column 4: + +`csvsort -c {{2,4}} {{data.csv}}` + +- Sort a CSV file without inferring data types: + +`csvsort --no-inference -c {{columns}} {{data.csv}}` diff --git a/csvsql b/csvsql new file mode 100644 index 00000000..f02e8a49 --- /dev/null +++ b/csvsql @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvsql + +> Generate SQL statements for a CSV file or execute those statements directly on a database. +> Included in csvkit. +> More information: . + +- Generate a `CREATE TABLE` SQL statement for a CSV file: + +`csvsql {{path/to/data.csv}}` + +- Import a CSV file into an SQL database: + +`csvsql --insert --db "{{mysql://user:password@host/database}}" {{data.csv}}` + +- Run an SQL query on a CSV file: + +`csvsql --query "{{select * from 'data'}}" {{data.csv}}` diff --git a/csvstat b/csvstat new file mode 100644 index 00000000..3e041d3c --- /dev/null +++ b/csvstat @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvstat + +> Print descriptive statistics for all columns in a CSV file. +> Included in csvkit. +> More information: . + +- Show all stats for all columns: + +`csvstat {{data.csv}}` + +- Show all stats for columns 2 and 4: + +`csvstat -c {{2,4}} {{data.csv}}` + +- Show sums for all columns: + +`csvstat --sum {{data.csv}}` + +- Show the max value length for column 3: + +`csvstat -c {{3}} --len {{data.csv}}` + +- Show the number of unique values in the "name" column: + +`csvstat -c {{name}} --unique {{data.csv}}` diff --git a/csvtool b/csvtool new file mode 100644 index 00000000..f56510c0 --- /dev/null +++ b/csvtool @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# csvtool + +> Utility to filter and extract data from CSV formatted sources. +> More information: . + +- Extract the second column from a CSV file: + +`csvtool --column {{2}} {{path/to/file.csv}}` + +- Extract the second and fourth columns from a CSV file: + +`csvtool --column {{2,4}} {{path/to/file.csv}}` + +- Extract lines from a CSV file where the second column exactly matches 'Foo': + +`csvtool --column {{2}} --search '{{^Foo$}}' {{path/to/file.csv}}` + +- Extract lines from a CSV file where the second column starts with 'Bar': + +`csvtool --column {{2}} --search '{{^Bar}}' {{path/to/file.csv}}` + +- Find lines in a CSV file where the second column ends with 'Baz' and then extract the third and sixth columns: + +`csvtool --column {{2}} --search '{{Baz$}}' {{path/to/file.csv}} | csvtool --no-header --column {{3,6}}` diff --git a/ctags b/ctags new file mode 100644 index 00000000..7691e57a --- /dev/null +++ b/ctags @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ctags + +> Generates an index (or tag) file of language objects found in source files for many popular programming languages. +> 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: + +`ctags {{path/to/file}}` + +- Generate tags for all files in the current directory, and output them to a specific file, overwriting the file if it exists: + +`ctags -f {{path/to/file}} *` + +- Generate tags for all files in the current directory and all subdirectories: + +`ctags --recurse` + +- Generate tags for a single file, and output them with start line number and end line number in JSON format: + +`ctags --fields=+ne --output-format=json {{path/to/file}}` diff --git a/ctest b/ctest new file mode 100644 index 00000000..e5117ec3 --- /dev/null +++ b/ctest @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ctest + +> CMake test driver program. +> More information: . + +- Run all tests defined in the CMake project, executing 4 jobs at a time in parallel: + +`ctest -j{{4}} --output-on-failure` + +- List available tests: + +`ctest -N` + +- Run a single test based on its name, or filter on a regular expression: + +`ctest --output-on-failure -R '^{{test_name}}$'` diff --git a/cups b/cups new file mode 100644 index 00000000..bba27929 --- /dev/null +++ b/cups @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# CUPS + +> Open source printing system. +> CUPS isn't a single command, but a set of commands. +> More information: . + +- View documentation for running the CUPS daemon: + +`tldr cupsd` + +- View documentation for managing printers: + +`tldr lpadmin` + +- View documentation for printing files: + +`tldr lp` + +- View documentation for checking status information about the current classes, jobs, and printers: + +`tldr lpstat` + +- View documentation for cancelling print jobs: + +`tldr lprm` diff --git a/cups-config b/cups-config new file mode 100644 index 00000000..81248706 --- /dev/null +++ b/cups-config @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cups-config + +> Show technical information about your CUPS print server installation. +> More information: . + +- Show where CUPS is currently installed: + +`cups-config --serverbin` + +- Show the location of CUPS' configuration directory: + +`cups-config --serverroot` + +- Show the location of CUPS' data directory: + +`cups-config --datadir` + +- Display help: + +`cups-config --help` + +- Display CUPS version: + +`cups-config --version` diff --git a/cupsaccept b/cupsaccept new file mode 100644 index 00000000..147bc224 --- /dev/null +++ b/cupsaccept @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsaccept + +> Accept jobs sent to destinations. +> Note: destination is referred as a printer or a class of printers. +> See also: `cupsreject`, `cupsenable`, `cupsdisable`, `lpstat`. +> More information: . + +- Accept print jobs to the specified destinations: + +`cupsaccept {{destination1 destination2 ...}}` + +- Specify a different server: + +`cupsaccept -h {{server}} {{destination1 destination2 ...}}` diff --git a/cupsctl b/cupsctl new file mode 100644 index 00000000..7d3eea38 --- /dev/null +++ b/cupsctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsctl + +> Update or query a server's `cupsd.conf`. +> More information: . + +- Display the current configuration values: + +`cupsctl` + +- Display the configuration values of a specific server: + +`cupsctl -h {{server[:port]}}` + +- Enable encryption on the connection to the scheduler: + +`cupsctl -E` + +- Enable or disable debug logging to the `error_log` file: + +`cupsctl {{--debug-logging|--no-debug-logging}}` + +- Enable or disable remote administration: + +`cupsctl {{--remote-admin|--no-remote-admin}}` + +- Parse the current debug logging state: + +`cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'` diff --git a/cupsd b/cupsd new file mode 100644 index 00000000..0b5c0278 --- /dev/null +++ b/cupsd @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsd + +> Server daemon for the CUPS print server. +> More information: . + +- Start `cupsd` in the background, aka. as a daemon: + +`cupsd` + +- Start `cupsd` on the [f]oreground: + +`cupsd -f` + +- [l]aunch `cupsd` on-demand (commonly used by `launchd` or `systemd`): + +`cupsd -l` + +- Start `cupsd` using the specified [`c`]`upsd.conf` configuration file: + +`cupsd -c {{path/to/cupsd.conf}}` + +- Start `cupsd` using the specified `cups-file`[`s`]`.conf` configuration file: + +`cupsd -s {{path/to/cups-files.conf}}` + +- [t]est the [`c`]`upsd.conf` configuration file for errors: + +`cupsd -t -c {{path/to/cupsd.conf}}` + +- [t]est the `cups-file`[`s`]`.conf` configuration file for errors: + +`cupsd -t -s {{path/to/cups-files.conf}}` + +- Display help: + +`cupsd -h` diff --git a/cupsdisable b/cupsdisable new file mode 100644 index 00000000..d279b257 --- /dev/null +++ b/cupsdisable @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsdisable + +> Stop printers and classes. +> Note: destination is referred as a printer or a class of printers. +> See also: `cupsenable`, `cupsaccept`, `cupsreject`, `lpstat`. +> More information: . + +- Stop one or more destination(s): + +`cupsdisable {{destination1 destination2 ...}}` + +- Cancel all jobs of the specified destination(s): + +`cupsdisable -c {{destination1 destination2 ...}}` diff --git a/cupsenable b/cupsenable new file mode 100644 index 00000000..794a943c --- /dev/null +++ b/cupsenable @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsenable + +> Start printers and classes. +> Note: destination is referred as a printer or a class of printers. +> See also: `cupsdisable`, `cupsaccept`, `cupsreject`, `lpstat`. +> More information: . + +- Start one or more destination(s): + +`cupsenable {{destination1 destination2 ...}}` + +- Resume printing of pending jobs of a destination (use after `cupsdisable` with `--hold`): + +`cupsenable --release {{destination}}` + +- Cancel all jobs of the specified destination(s): + +`cupsenable -c {{destination1 destination2 ...}}` diff --git a/cupsreject b/cupsreject new file mode 100644 index 00000000..d737df8c --- /dev/null +++ b/cupsreject @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupsreject + +> Reject jobs sent to printers. +> Note: destination is referred as a printer or a class of printers. +> See also: `cupsaccept`, `cupsenable`, `cupsdisable`, `lpstat`. +> More information: . + +- Reject print jobs to the specified destinations: + +`cupsreject {{destination1 destination2 ...}}` + +- Specify a different server: + +`cupsreject -h {{server}} {{destination1 destination2 ...}}` + +- Specify a reason string ("Reason Unknown" by default): + +`cupsreject -r {{reason}} {{destination1 destination2 ...}}` diff --git a/cupstestppd b/cupstestppd new file mode 100644 index 00000000..8a8641b7 --- /dev/null +++ b/cupstestppd @@ -0,0 +1,24 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cupstestppd + +> Test conformance of PPD files to the version 4.3 of the specification. +> Error codes (1, 2, 3 and 4, respectively): bad CLI arguments, unable to open file, unskippable format errors and non-conformance with PPD specification. +> Note: this command is deprecated. +> See also: `lpadmin`. +> More information: . + +- Test the conformance of one or more files in quiet mode: + +`cupstestppd -q {{path/to/file1.ppd path/to/file2.ppd ...}}` + +- Get the PPD file from `stdin`, showing detailed conformance testing results: + +`cupstestppd -v - < {{path/to/file.ppd}}` + +- Test all PPD files under the current directory, printing the names of each file that does not conform: + +`find . -name \*.ppd \! -execdir cupstestppd -q '{}' \; -print` diff --git a/curl b/curl new file mode 100644 index 00000000..f2eb9790 --- /dev/null +++ b/curl @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# curl + +> Transfers data from or to a server. +> Supports most protocols, including HTTP, FTP, and POP3. +> More information: . + +- Download the contents of a URL to a file: + +`curl {{http://example.com}} --output {{path/to/file}}` + +- Download a file, saving the output under the filename indicated by the URL: + +`curl --remote-name {{http://example.com/filename}}` + +- Download a file, following location redirects, and automatically continuing (resuming) a previous file transfer and return an error on server error: + +`curl --fail --remote-name --location --continue-at - {{http://example.com/filename}}` + +- Send form-encoded data (POST request of type `application/x-www-form-urlencoded`). Use `--data @file_name` or `--data @'-'` to read from STDIN: + +`curl --data {{'name=bob'}} {{http://example.com/form}}` + +- Send a request with an extra header, using a custom HTTP method: + +`curl --header {{'X-My-Header: 123'}} --request {{PUT}} {{http://example.com}}` + +- Send data in JSON format, specifying the appropriate content-type header: + +`curl --data {{'{"name":"bob"}'}} --header {{'Content-Type: application/json'}} {{http://example.com/users/1234}}` + +- Pass a username and prompt for a password to authenticate to the server: + +`curl --user {{username}} {{http://example.com}}` + +- Pass client certificate and key for a resource, skipping certificate validation: + +`curl --cert {{client.pem}} --key {{key.pem}} --insecure {{https://example.com}}` diff --git a/cut b/cut new file mode 100644 index 00000000..09503620 --- /dev/null +++ b/cut @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cut + +> Cut out fields from `stdin` or files. +> More information: . + +- Print a specific character/field range of each line: + +`{{command}} | cut --{{characters|fields}}={{1|1,10|1-10|1-|-10}}` + +- Print a field range of each line with a specific delimiter: + +`{{command}} | cut --delimiter="{{,}}" --fields={{1}}` + +- Print a character range of each line of the specific file: + +`cut --characters={{1}} {{path/to/file}}` diff --git a/cvs b/cvs new file mode 100644 index 00000000..60c1a87d --- /dev/null +++ b/cvs @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cvs + +> Concurrent Versions System, a revision control system. +> More information: . + +- Create a new repository (requires the `CVSROOT` environment variable to be set externally): + +`cvs -d {{path/to/repository}} init` + +- Add a project to the repository: + +`cvs import -m "{{message}}" {{project_name}} {{version}} {{vendor}}` + +- Checkout a project: + +`cvs checkout {{project_name}}` + +- Show changes made to files: + +`cvs diff {{path/to/file}}` + +- Add a file: + +`cvs add {{path/to/file}}` + +- Commit a file: + +`cvs commit -m "{{message}}" {{path/to/file}}` + +- Update the working directory from the remote repository: + +`cvs update` diff --git a/cwebp b/cwebp new file mode 100644 index 00000000..2c692869 --- /dev/null +++ b/cwebp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# cwebp + +> Compress an image file to a WebP file. +> More information: . + +- Compress a WebP file with default settings (q = 75) to the [o]utput file: + +`cwebp {{path/to/image_file}} -o {{path/to/output.webp}}` + +- Compress a WebP file with the best [q]uality and largest file size: + +`cwebp {{path/to/image_file}} -o {{path/to/output.webp}} -q {{100}}` + +- Compress a WebP file with the worst [q]uality and smallest file size: + +`cwebp {{path/to/image_file}} -o {{path/to/output.webp}} -q {{0}}` + +- Compress a WebP file and apply resize to image: + +`cwebp {{path/to/image_file}} -o {{path/to/output.webp}} -resize {{width}} {{height}}` + +- Compress a WebP file and drop alpha channel information: + +`cwebp {{path/to/image_file}} -o {{path/to/output.webp}} -noalpha` diff --git a/czkawka-cli b/czkawka-cli new file mode 100644 index 00000000..9ef0dc40 --- /dev/null +++ b/czkawka-cli @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# czkawka-cli + +> Command-line version of `czkawka` a multi-functional app to find duplicates, empty folders, similar images and much more. +> More information: . + +- List duplicate or similar files in specific directories: + +`czkawka-cli {{dup|image}} --directories {{path/to/directory1 path/to/directory2 ...}}` + +- Find duplicate files in specific directories and delete them (default: `NONE`): + +`czkawka-cli dup --directories {{path/to/directory1 path/to/directory2 ...}} --delete-method {{AEN|AEO|ON|OO|HARD|NONE}}` diff --git a/d8 b/d8 new file mode 100644 index 00000000..6a4d9756 --- /dev/null +++ b/d8 @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# d8 + +> Developer shell for the V8 JavaScript engine. +> More information: . + +- Start a REPL (interactive shell): + +`d8` + +- Run a JavaScript file: + +`d8 {{path/to/file.js}}` + +- Evaluate a JavaScript expression: + +`d8 -e "{{code}}` diff --git a/dalfox b/dalfox new file mode 100644 index 00000000..54ca3779 --- /dev/null +++ b/dalfox @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dalfox + +> A powerful open-source XSS scanner focused on automation. +> More information: . + +- Scan a single URL for XSS vulnerabilities: + +`dalfox url {{http://example.com}}` + +- Scan a URL using a header for authentication: + +`dalfox url {{http://example.com}} -H {{'X-My-Header: 123'}}` + +- Scan a list of URLs from a file: + +`dalfox file {{path/to/file}}` diff --git a/daps b/daps new file mode 100644 index 00000000..cd6a3512 --- /dev/null +++ b/daps @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# daps + +> An open source program for transforming DocBook XML into output formats such as HTML or PDF. +> More information: . + +- Check if a DocBook XML file is valid: + +`daps -d {{path/to/file.xml}} validate` + +- Convert a DocBook XML file into PDF: + +`daps -d {{path/to/file.xml}} pdf` + +- Convert a DocBook XML file into a single HTML file: + +`daps -d {{path/to/file.xml}} html --single` + +- Display help: + +`daps --help` + +- Display version: + +`daps --version` diff --git a/darkhttpd b/darkhttpd new file mode 100644 index 00000000..06ffbb88 --- /dev/null +++ b/darkhttpd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# darkhttpd + +> Darkhttpd web server. +> More information: . + +- Start server serving the specified document root: + +`darkhttpd {{path/to/docroot}}` + +- Start server on specified port (port 8080 by default if running as non-root user): + +`darkhttpd {{path/to/docroot}} --port {{port}}` + +- Listen only on specified IP address (by default, the server listens on all interfaces): + +`darkhttpd {{path/to/docroot}} --addr {{ip_address}}` diff --git a/dart b/dart new file mode 100644 index 00000000..cbd6a36f --- /dev/null +++ b/dart @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dart + +> Manage Dart projects. +> More information: . + +- Initialize a new Dart project in a directory of the same name: + +`dart create {{project_name}}` + +- Run a Dart file: + +`dart run {{path/to/file.dart}}` + +- Download dependencies for the current project: + +`dart pub get` + +- Run unit tests for the current project: + +`dart test` + +- Update an outdated project's dependencies to support null-safety: + +`dart pub upgrade --null-safety` + +- Compile a Dart file to a native binary: + +`dart compile exe {{path/to/file.dart}}` diff --git a/dash b/dash new file mode 100644 index 00000000..406c24c2 --- /dev/null +++ b/dash @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dash + +> Debian Almquist Shell, a modern, POSIX-compliant implementation of `sh` (not Bash-compatible). +> More information: . + +- Start an interactive shell session: + +`dash` + +- Execute specific [c]ommands: + +`dash -c "{{echo 'dash is executed'}}"` + +- Execute a specific script: + +`dash {{path/to/script.sh}}` + +- Check a specific script for syntax errors: + +`dash -n {{path/to/script.sh}}` + +- Execute a specific script while printing each command before executing it: + +`dash -x {{path/to/script.sh}}` + +- Execute a specific script and stop at the first [e]rror: + +`dash -e {{path/to/script.sh}}` + +- Execute specific commands from `stdin`: + +`{{echo "echo 'dash is executed'"}} | dash` diff --git a/datashader_cli b/datashader_cli new file mode 100644 index 00000000..a7ac27ba --- /dev/null +++ b/datashader_cli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# datashader_cli + +> Quick visualization of large datasets using CLI based on datashader. +> More information: . + +- Create a shaded scatter plot of points and save it to a png file and set the background color: + +`datashader_cli points {{path/to/input.parquet}} --x {{pickup_x}} --y {{pickup_y}} {{path/to/output.png}} --background {{black|white|#rrggbb}}` + +- Visualize the geospatial data (supports Geoparquet, shapefile, geojson, geopackage, etc.): + +`datashader_cli points {{path/to/input_data.geo.parquet}} {{path/to/output_data.png}} --geo true` + +- Use matplotlib to render the image: + +`datashader_cli points {{path/to/input_data.geo.parquet}} {{path/to/output_data.png}} --geo {{true}} --matplotlib true` diff --git a/date b/date new file mode 100644 index 00000000..e933dcc2 --- /dev/null +++ b/date @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# date + +> Set or display the system date. +> More information: . + +- Display the current date using the default locale's format: + +`date +%c` + +- Display the current date in UTC, using the ISO 8601 format: + +`date -u +%Y-%m-%dT%H:%M:%S%Z` + +- Display the current date as a Unix timestamp (seconds since the Unix epoch): + +`date +%s` + +- Convert a date specified as a Unix timestamp to the default format: + +`date -d @{{1473305798}}` + +- Convert a given date to the Unix timestamp format: + +`date -d "{{2018-09-01 00:00}}" +%s --utc` + +- Display the current date using the RFC-3339 format (`YYYY-MM-DD hh:mm:ss TZ`): + +`date --rfc-3339=s` + +- Set the current date using the format `MMDDhhmmYYYY.ss` (`YYYY` and `.ss` are optional): + +`date {{093023592021.59}}` + +- Display the current ISO week number: + +`date +%V` diff --git a/dc b/dc new file mode 100644 index 00000000..f8d67492 --- /dev/null +++ b/dc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dc + +> An arbitrary precision calculator. Uses reverse polish notation (RPN). +> See also: `bc`. +> More information: . + +- Start an interactive session: + +`dc` + +- Execute a script: + +`dc {{path/to/script.dc}}` + +- Calculate an expression with the specified scale: + +`dc --expression='{{10}} k {{5 3 /}} p'` + +- Calculate 4 times 5 (4 5 *), subtract 17 (17 -), and [p]rint the output: + +`dc --expression='4 5 * 17 - p'` + +- Specify the number of decimal places to 7 (7 k), calculate 5 divided by -3 (5 _3 /) and [p]rint: + +`dc --expression='7 k 5 _3 / p'` + +- Calculate the golden ratio, phi: set number of decimal places to 100 (100 k), square root of 5 (5 v) plus 1 (1 +), divided by 2 (2 /), and [p]rint result: + +`dc --expression='100 k 5 v 1 + 2 / p'` diff --git a/dcfldd b/dcfldd new file mode 100644 index 00000000..259e4ff2 --- /dev/null +++ b/dcfldd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dcfldd + +> Enhanced version of dd for forensics and security. +> More information: . + +- Copy a disk to a raw image file and hash the image using SHA256: + +`dcfldd if=/dev/{{disk_device}} of={{file.img}} hash=sha256 hashlog={{file.hash}}` + +- Copy a disk to a raw image file, hashing each 1 GB chunk: + +`dcfldd if=/dev/{{disk_device}} of={{file.img}} hash={{sha512|sha384|sha256|sha1|md5}} hashlog={{file.hash}} hashwindow={{1G}}` diff --git a/dcg b/dcg new file mode 100644 index 00000000..f4f5a46f --- /dev/null +++ b/dcg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dcg + +> Drupal code generator. +> More information: . + +- Start a wizard to choose what kind of code (e.g. module, service, form, etc.) to generate: + +`dcg` + +- Directly specify the kind of code to generate: + +`dcg {{service|plugin|theme|module|form}}` + +- Generate the code in a specific directory: + +`dcg --directory {{path/to/directory}}` diff --git a/dcode b/dcode new file mode 100644 index 00000000..19aa6860 --- /dev/null +++ b/dcode @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dcode + +> Recursively detect and decode strings, supporting hex, decimal, binary, base64, URL, FromChar encodings, Caesar ciphers, and MD5, SHA1, and SHA2 hashes. +> Warning: uses 3rd-party web services for MD5, SHA1 and SHA2 hash lookups. For sensitive data, use `-s` to avoid these services. +> More information: . + +- Recursively detect and decode a string: + +`dcode "{{NjM3YTQyNzQ1YTQ0NGUzMg==}}"` + +- Rotate a string by the specified offset: + +`dcode -rot {{11}} "{{spwwz hzcwo}}"` + +- Rotate a string by all 26 possible offsets: + +`dcode -rot {{all}} "{{bpgkta xh qtiitg iwpc sr}}"` + +- Reverse a string: + +`dcode -rev "{{hello world}}"` diff --git a/dd b/dd new file mode 100644 index 00000000..34476033 --- /dev/null +++ b/dd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dd + +> Convert and copy a file. +> More information: . + +- Make a bootable USB drive from an isohybrid file (such like `archlinux-xxx.iso`): + +`dd if={{path/to/file.iso}} of=/dev/{{usb_drive}}` + +- Clone a drive to another drive with 4 MiB block and ignore error: + +`dd if=/dev/{{source_drive}} of=/dev/{{dest_drive}} bs={{4194304}} conv={{noerror}}` + +- Generate a file of 100 random bytes by using kernel random driver: + +`dd if=/dev/urandom of={{path/to/random_file}} bs={{100}} count={{1}}` + +- Benchmark the write performance of a disk: + +`dd if=/dev/zero of={{path/to/file_1GB}} bs={{1024}} count={{1000000}}` + +- Generate a system backup into an IMG file: + +`dd if={{/dev/drive_device}} of={{path/to/file.img}}` + +- Restore a drive from an IMG file: + +`dd if={{path/to/file.img}} of={{/dev/drive_device}}` diff --git a/ddev b/ddev new file mode 100644 index 00000000..edf69af1 --- /dev/null +++ b/ddev @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ddev + +> Container based local development tool for PHP environments. +> More information: . + +- Start up a project: + +`ddev start` + +- Configure a project's type and docroot: + +`ddev config` + +- [f]ollow the log trail: + +`ddev logs -f` + +- Run composer within the container: + +`ddev composer` + +- Install a specific Node.js version: + +`ddev nvm install {{version}}` + +- Export a database: + +`ddev export-db --file={{/tmp/db.sql.gz}}` + +- Run a specific command within a container: + +`ddev exec {{echo 1}}` diff --git a/ddgr b/ddgr new file mode 100644 index 00000000..a836ae29 --- /dev/null +++ b/ddgr @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ddgr + +> Search DuckDuckGo (HTML version) from the terminal. +> More information: . + +- Start in interactive mode: + +`ddgr` + +- Search DuckDuckGo for a keyword: + +`ddgr {{keyword}}` + +- Limit the number of search results to `N`: + +`ddgr -n {{N}} {{keyword}}` + +- Display the complete URL in search results: + +`ddgr -x {{keyword}}` + +- Search DuckDuckGo for a keyword and open the first result in the browser: + +`ddgr !w {{keyword}}` + +- Perform a website-specific search: + +`ddgr -w {{site}} {{keyword}}` + +- Search for a specific file type: + +`ddgr {{keyword}} filetype:{{filetype}}` + +- Display help in interactive mode: + +`?` diff --git a/deb-get b/deb-get new file mode 100644 index 00000000..20e1cf84 --- /dev/null +++ b/deb-get @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deb-get + +> `apt-get` functionality for `.deb` packages published in third party repositories or via direct download. +> Works with Linux distributions which use `apt-get`. +> More information: . + +- Update the list of available packages and versions: + +`sudo deb-get update` + +- Search for a given package: + +`deb-get search {{package}}` + +- Show information about a package: + +`deb-get show {{package}}` + +- Install a package, or update it to the latest available version: + +`sudo deb-get install {{package}}` + +- Remove a package (using `purge` instead also removes its configuration files): + +`sudo deb-get remove {{package}}` + +- Upgrade all installed packages to their newest available versions: + +`sudo deb-get upgrade` + +- List all available packages: + +`deb-get list` diff --git a/decaffeinate b/decaffeinate new file mode 100644 index 00000000..717608cb --- /dev/null +++ b/decaffeinate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# decaffeinate + +> Move your CoffeeScript source to modern JavaScript. +> More information: . + +- Convert a CoffeeScript file to JavaScript: + +`decaffeinate {{path/to/file.coffee}}` + +- Convert a CoffeeScript v2 file to JavaScript: + +`decaffeinate --use-cs2 {{path/to/file.coffee}}` + +- Convert require and `module.exports` to import and export: + +`decaffeinate --use-js-modules {{path/to/file.coffee}}` + +- Convert a CoffeeScript, allowing named exports: + +`decaffeinate --loose-js-modules {{path/to/file.coffee}}` diff --git a/declare b/declare new file mode 100644 index 00000000..6bc180af --- /dev/null +++ b/declare @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# declare + +> Declare variables and give them attributes. +> More information: . + +- Declare a string variable with the specified value: + +`declare {{variable}}="{{value}}"` + +- Declare an integer variable with the specified value: + +`declare -i {{variable}}="{{value}}"` + +- Declare an array variable with the specified value: + +`declare -a {{variable}}=({{item_a item_b item_c}})` + +- Declare an associative array variable with the specified value: + +`declare -A {{variable}}=({{[key_a]=item_a [key_b]=item_b [key_c]=item_c}})` + +- Declare a readonly string variable with the specified value: + +`declare -r {{variable}}="{{value}}"` + +- Declare a global variable within a function with the specified value: + +`declare -g {{variable}}="{{value}}"` diff --git a/deemix b/deemix new file mode 100644 index 00000000..d3843e0b --- /dev/null +++ b/deemix @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deemix + +> A barebone deezer downloader library built from the ashes of Deezloader Remix. +> It can be used as a standalone CLI app or implemented in a UI using the API. +> More information: . + +- Download a track or playlist: + +`deemix {{https://www.deezer.com/us/track/00000000}}` + +- Download track/playlist at a specific bitrate: + +`deemix --bitrate {{FLAC|MP3}} {{url}}` + +- Download to a specific path: + +`deemix --bitrate {{bitrate}} --path {{path}} {{url}}` + +- Create a portable deemix configuration file in the current directory: + +`deemix --portable --bitrate {{bitrate}} --path {{path}} {{url}}` diff --git a/delta b/delta new file mode 100644 index 00000000..449d4f21 --- /dev/null +++ b/delta @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# delta + +> A viewer for Git and diff output. +> More information: . + +- Compare files or directories: + +`delta {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` + +- Compare files or directories, showing the line numbers: + +`delta --line-numbers {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` + +- Compare files or directories, showing the differences side by side: + +`delta --side-by-side {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` + +- Compare files or directories, ignoring any Git configuration settings: + +`delta --no-gitconfig {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` + +- Compare, rendering commit hashes, file names, and line numbers as hyperlinks, according to the hyperlink spec for terminal emulators: + +`delta --hyperlinks {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` + +- Display the current settings: + +`delta --show-config` + +- Display supported languages and associated file extensions: + +`delta --list-languages` diff --git a/deluge b/deluge new file mode 100644 index 00000000..7919f1d0 --- /dev/null +++ b/deluge @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deluge + +> A command-line BitTorrent client. +> More information: . + +- Download a torrent: + +`deluge {{url|magnet|path/to/file}}` + +- Download a torrent using a specific configuration file: + +`deluge -c {{path/to/configuration_file}} {{url|magnet|path/to/file}}` + +- Download a torrent and launch the specified user interface: + +`deluge -u {{gtk|web|console}} {{url|magnet|path/to/file}}` + +- Download a torrent and output the log to a file: + +`deluge -l {{path/to/log_file}} {{url|magnet|path/to/file}}` diff --git a/deluge-console b/deluge-console new file mode 100644 index 00000000..7c72e393 --- /dev/null +++ b/deluge-console @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deluge-console + +> An interactive interface for the Deluge BitTorrent client. +> More information: . + +- Start the interactive console interface: + +`deluge-console` + +- Connect to a Deluge daemon instance: + +`connect {{hostname}}:{{port}}` + +- Add a torrent to the daemon: + +`add {{url|magnet|path/to/file}}` + +- Display information about all torrents: + +`info` + +- Display information about a specific torrent: + +`info {{torrent_id}}` + +- Pause a torrent: + +`pause {{torrent_id}}` + +- Resume a torrent: + +`resume {{torrent_id}}` + +- Remove a torrent from the daemon: + +`rm {{torrent_id}}` diff --git a/deluged b/deluged new file mode 100644 index 00000000..5a2c9f68 --- /dev/null +++ b/deluged @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deluged + +> A daemon process for the Deluge BitTorrent client. +> More information: . + +- Start the Deluge daemon: + +`deluged` + +- Start the Deluge daemon on a specific port: + +`deluged -p {{port}}` + +- Start the Deluge daemon using a specific configuration file: + +`deluged -c {{path/to/configuration_file}}` + +- Start the Deluge daemon and output the log to a file: + +`deluged -l {{path/to/log_file}}` diff --git a/deno b/deno new file mode 100644 index 00000000..33616777 --- /dev/null +++ b/deno @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# deno + +> A secure runtime for JavaScript and TypeScript. +> More information: . + +- Run a JavaScript or TypeScript file: + +`deno run {{path/to/file.ts}}` + +- Start a REPL (interactive shell): + +`deno` + +- Run a file with network access enabled: + +`deno run --allow-net {{path/to/file.ts}}` + +- Run a file from a URL: + +`deno run {{https://deno.land/std/examples/welcome.ts}}` + +- Install an executable script from a URL: + +`deno install {{https://deno.land/std/examples/colors.ts}}` diff --git a/dep b/dep new file mode 100644 index 00000000..933ca209 --- /dev/null +++ b/dep @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dep + +> Deploy PHP applications. +> Note: The Go command `dep` with the same name is deprecated and archived. +> More information: . + +- Interactively initialize deployer in the local path (use a framework template with `--template=template`): + +`dep init` + +- Deploy an application to a remote host: + +`dep deploy {{hostname}}` + +- Rollback to the previous working release: + +`dep rollback` + +- Connect to a remote host via ssh: + +`dep ssh {{hostname}}` + +- List commands: + +`dep list` + +- Run any arbitrary command on the remote hosts: + +`dep run "{{command}}"` + +- Display help for a command: + +`dep help {{command}}` diff --git a/detox b/detox new file mode 100644 index 00000000..4e3f0020 --- /dev/null +++ b/detox @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# detox + +> Renames files to make them easier to work with. +> It removes spaces and other such annoyances like duplicate underline characters. +> More information: . + +- Remove spaces and other undesirable characters from a file's name: + +`detox {{path/to/file}}` + +- Show how detox would rename all the files in a directory tree: + +`detox --dry-run -r {{path/to/directory}}` + +- Remove spaces and other undesirable characters from all files in a directory tree: + +`detox -r {{path/to/directory}}` diff --git a/devcontainer b/devcontainer new file mode 100644 index 00000000..138826e7 --- /dev/null +++ b/devcontainer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# devcontainer + +> Use a Docker container as a development environment. +> More information: . + +- Create and run a Dev Container: + +`devcontainer up` + +- Apply a Dev Container Template to a workspace: + +`devcontainer templates apply --template-id {{template_id}} --template-args {{template_args}} --workspace-folder {{path/to/workspace}}` + +- Execute a command on a running Dev Container in the current workspace: + +`devcontainer exec {{command}}` + +- Build a Dev Container image from `devcontainer.json`: + +`devcontainer build {{path/to/workspace}}` + +- Open a Dev Container in VS Code (the path is optional): + +`devcontainer open {{path/to/workspace}}` + +- Read and print the configuration of a Dev Container from `devcontainer.json`: + +`devcontainer read-configuration` diff --git a/dexdump b/dexdump new file mode 100644 index 00000000..d69b5760 --- /dev/null +++ b/dexdump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dexdump + +> Display information about Android DEX files. +> More information: . + +- Extract classes and methods from an APK file: + +`dexdump {{path/to/file.apk}}` + +- Display header information of DEX files contained in an APK file: + +`dexdump -f {{path/to/file.apk}}` + +- Display the dis-assembled output of executable sections: + +`dexdump -d {{path/to/file.apk}}` + +- Output results to a file: + +`dexdump -o {{path/to/file}} {{path/to/file.apk}}` diff --git a/dexter b/dexter new file mode 100644 index 00000000..dea91a46 --- /dev/null +++ b/dexter @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dexter + +> Authenticate the `kubectl` users with OpenId Connect. +> More information: . + +- Create and authenticate a user with Google OIDC: + +`dexter auth -i {{client_id}} -s {{client_secret}}` + +- Override the default kube configuration file location: + +`dexter auth -i {{client_id}} -s {{client_secret}} --kube-config {{sample/config}}` diff --git a/df b/df new file mode 100644 index 00000000..f920feba --- /dev/null +++ b/df @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage using 512-byte units: + +`df` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Use 1024-byte units when writing space figures: + +`df -k` + +- Display information in a portable way: + +`df -P` diff --git a/dfc b/dfc new file mode 100644 index 00000000..8b23307b --- /dev/null +++ b/dfc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dfc + +> Gives an overview of the filesystem disk space usage with colors and graphs. +> More information: . + +- Display filesystems and their disk usage in human-readable form with colors and graphs: + +`dfc` + +- Display all filesystems including pseudo, duplicate and inaccessible filesystems: + +`dfc -a` + +- Display filesystems without color: + +`dfc -c never` + +- Display filesystems containing "ext" in the filesystem type: + +`dfc -t ext` diff --git a/dhclient b/dhclient new file mode 100644 index 00000000..6b3e427a --- /dev/null +++ b/dhclient @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dhclient + +> DHCP client. +> More information: . + +- Get an IP address for the `eth0` interface: + +`sudo dhclient {{eth0}}` + +- Release an IP address for the `eth0` interface: + +`sudo dhclient -r {{eth0}}` diff --git a/dhcpig b/dhcpig new file mode 100644 index 00000000..0f4d5cb9 --- /dev/null +++ b/dhcpig @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dhcpig + +> Initiates an advanced DHCP exhaustion attack and stress test. +> DHCPig needs to be run with root privileges. +> More information: . + +- Exhaust all of the available DHCP addresses using the specified interface: + +`sudo ./pig.py {{eth0}}` + +- Exhaust IPv6 addresses using eth1 interface: + +`sudo ./pig.py -6 {{eth1}}` + +- Send fuzzed/malformed data packets using the interface: + +`sudo ./pig.py --fuzz {{eth1}}` + +- Enable color output: + +`sudo ./pig.py -c {{eth1}}` + +- Enable minimal verbosity and color output: + +`sudo ./pig.py -c --verbosity=1 {{eth1}}` + +- Use a debug verbosity of 100 and scan network of neighboring devices using ARP packets: + +`sudo ./pig.py -c --verbosity=100 --neighbors-scan-arp {{eth1}}` + +- Enable printing lease information, attempt to scan and release all neighbor IP addresses: + +`sudo ./pig.py --neighbors-scan-arp -r --show-options {{eth1}}` diff --git a/dhcpwn b/dhcpwn new file mode 100644 index 00000000..9a8f9f36 --- /dev/null +++ b/dhcpwn @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dhcpwn + +> Test DHCP IP exhaustion attacks and sniff local DHCP traffic. +> More information: . + +- Flood the network with IP requests: + +`dhcpwn --interface {{network_interface}} flood --count {{number_of_requests}}` + +- Sniff local DHCP traffic: + +`dhcpwn --interface {{network_interface}} sniff` diff --git a/dict b/dict new file mode 100644 index 00000000..bc842c1e --- /dev/null +++ b/dict @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dict + +> Command line dictionary using the DICT protocol. +> More information: . + +- List available databases: + +`dict -D` + +- Get information about a database: + +`dict -i {{database_name}}` + +- Look up a word in a specific database: + +`dict -d {{database_name}} {{word}}` + +- Look up a word in all available databases: + +`dict {{word}}` + +- Show information about the DICT server: + +`dict -I` diff --git a/diff b/diff new file mode 100644 index 00000000..6f4e37e8 --- /dev/null +++ b/diff @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# diff + +> Compare files and directories. +> More information: . + +- Compare files (lists changes to turn `old_file` into `new_file`): + +`diff {{old_file}} {{new_file}}` + +- Compare files, ignoring white spaces: + +`diff --ignore-all-space {{old_file}} {{new_file}}` + +- Compare files, showing the differences side by side: + +`diff --side-by-side {{old_file}} {{new_file}}` + +- Compare files, showing the differences in unified format (as used by `git diff`): + +`diff --unified {{old_file}} {{new_file}}` + +- Compare directories recursively (shows names for differing files/directories as well as changes made to files): + +`diff --recursive {{old_directory}} {{new_directory}}` + +- Compare directories, only showing the names of files that differ: + +`diff --recursive --brief {{old_directory}} {{new_directory}}` + +- Create a patch file for Git from the differences of two text files, treating nonexistent files as empty: + +`diff --text --unified --new-file {{old_file}} {{new_file}} > {{diff.patch}}` diff --git a/diff-pdf b/diff-pdf new file mode 100644 index 00000000..f746a4e3 --- /dev/null +++ b/diff-pdf @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# diff-pdf + +> Compare two PDFs. +> More information: . + +- Compare PDFs, indicating changes using return codes (`0` = no difference, `1` = PDFs differ): + +`diff-pdf {{path/to/a.pdf}} {{path/to/b.pdf}}` + +- Compare PDFs, outputting a PDF with visually highlighted differences: + +`diff-pdf --output-diff={{path/to/diff.pdf}} {{path/to/a.pdf}} {{path/to/b.pdf}}` + +- Compare PDFs, viewing differences in a simple GUI: + +`diff-pdf --view {{path/to/a.pdf}} {{path/to/b.pdf}}` diff --git a/diffoscope b/diffoscope new file mode 100644 index 00000000..51cbf303 --- /dev/null +++ b/diffoscope @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# diffoscope + +> Compare files, archives, and directories. +> More information: . + +- Compare two files: + +`diffoscope {{path/to/file1}} {{path/to/file2}}` + +- Compare two files without displaying a progress bar: + +`diffoscope --no-progress {{path/to/file1}} {{path/to/file2}}` + +- Compare two files and write an HTML-report to a file (use `-` for `stdout`): + +`diffoscope --html {{path/to/outfile|-}} {{path/to/file1}} {{path/to/file2}}` + +- Compare two directories excluding files with a name matching a specified pattern: + +`diffoscope --exclude {{pattern}} {{path/to/directory1}} {{path/to/directory2}}` + +- Compare two directories and control whether directory metadata is considered: + +`diffoscope --exclude-directory-metadata {{auto|yes|no|recursive}} {{path/to/directory1}} {{path/to/directory2}}` diff --git a/diffstat b/diffstat new file mode 100644 index 00000000..005f5a02 --- /dev/null +++ b/diffstat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# diffstat + +> Create a histogram from the output of the `diff` command. +> More information: . + +- Display changes in a histogram: + +`diff {{path/to/file1}} {{path/to/file2}} | diffstat` + +- Display inserted, deleted and modified changes as a table: + +`diff {{path/to/file1}} {{path/to/file2}} | diffstat -t` diff --git a/dig b/dig new file mode 100644 index 00000000..c651c756 --- /dev/null +++ b/dig @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dig + +> DNS lookup utility. +> More information: . + +- Lookup the IP(s) associated with a hostname (A records): + +`dig +short {{example.com}}` + +- Get a detailed answer for a given domain (A records): + +`dig +noall +answer {{example.com}}` + +- Query a specific DNS record type associated with a given domain name: + +`dig +short {{example.com}} {{A|MX|TXT|CNAME|NS}}` + +- Specify an alternate DNS server to query: + +`dig @{{8.8.8.8}} {{example.com}}` + +- Perform a reverse DNS lookup on an IP address (PTR record): + +`dig -x {{8.8.8.8}}` + +- Find authoritative name servers for the zone and display SOA records: + +`dig +nssearch {{example.com}}` + +- Perform iterative queries and display the entire trace path to resolve a domain name: + +`dig +trace {{example.com}}` + +- Query a DNS server over a non-standard [p]ort using the TCP protocol: + +`dig +tcp -p {{port}} @{{dns_server_ip}} {{example.com}}` diff --git a/dillo b/dillo new file mode 100644 index 00000000..1d92a83b --- /dev/null +++ b/dillo @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dillo + +> A lightweight web browser intended for slow computers. +> More information: . + +- Launch Dillo: + +`dillo` + +- Launch Dillo with a specific window size and screen location: + +`dillo --geometry {{width}}x{{height}}+{{x_position}}+{{y_position}}` + +- Launch Dillo and open a specific URL: + +`dillo {{duckduckgo.com}}` + +- Launch Dillo and open a file or directory: + +`dillo {{path/to/file_or_directory}}` + +- Launch Dillo in full-screen mode: + +`dillo --fullwindow` + +- Display version: + +`dillo --version` + +- Display help: + +`dillo --help` diff --git a/dircolors b/dircolors new file mode 100644 index 00000000..5ed739e1 --- /dev/null +++ b/dircolors @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dircolors + +> Output commands to set the LS_COLOR environment variable and style `ls`, `dir`, etc. +> More information: . + +- Output commands to set LS_COLOR using default colors: + +`dircolors` + +- Output commands to set LS_COLOR using colors from a file: + +`dircolors {{path/to/file}}` + +- Output commands for Bourne shell: + +`dircolors --bourne-shell` + +- Output commands for C shell: + +`dircolors --c-shell` + +- View the default colors for file types and extensions: + +`dircolors --print-data` diff --git a/direnv b/direnv new file mode 100644 index 00000000..742e6a80 --- /dev/null +++ b/direnv @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# direnv + +> Shell extension to load and unload environment variables depending on the current directory. +> More information: . + +- Grant direnv permission to load the `.envrc` present in the current directory: + +`direnv allow {{.}}` + +- Revoke the authorization to load the `.envrc` present in the current directory: + +`direnv deny {{.}}` + +- Edit the `.envrc` file in the default text editor and reload the environment on exit: + +`direnv edit {{.}}` + +- Trigger a reload of the environment: + +`direnv reload` + +- Print some debug status information: + +`direnv status` diff --git a/dirname b/dirname new file mode 100644 index 00000000..c1b87742 --- /dev/null +++ b/dirname @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dirname + +> Calculates the parent directory of a file or directory path. +> More information: . + +- Calculate the parent directory of a given path: + +`dirname {{path/to/file_or_directory}}` + +- Calculate the parent directory of multiple paths: + +`dirname {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Delimit output with a NUL character instead of a newline (useful when combining with `xargs`): + +`dirname --zero {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/dirs b/dirs new file mode 100644 index 00000000..efde29a7 --- /dev/null +++ b/dirs @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dirs + +> Displays or manipulates the directory stack. +> The directory stack is a list of recently visited directories that can be manipulated with the `pushd` and `popd` commands. +> More information: . + +- Display the directory stack with a space between each entry: + +`dirs` + +- Display the directory stack with one entry per line: + +`dirs -p` + +- Display only the nth entry in the directory stack, starting at 0: + +`dirs +{{N}}` + +- Clear the directory stack: + +`dirs -c` diff --git a/dirsearch b/dirsearch new file mode 100644 index 00000000..47b5a139 --- /dev/null +++ b/dirsearch @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dirsearch + +> Web path scanner. +> More information: . + +- Scan a web server for common paths with common extensions: + +`dirsearch --url {{url}} --extensions-list` + +- Scan a list of web servers for common paths with the `.php` extension: + +`dirsearch --url-list {{path/to/url-list.txt}} --extensions {{php}}` + +- Scan a web server for user-defined paths with common extensions: + +`dirsearch --url {{url}} --extensions-list --wordlist {{path/to/url-paths.txt}}` + +- Scan a web server using a cookie: + +`dirsearch --url {{url}} --extensions {{php}} --cookie {{cookie}}` + +- Scan a web server using the `HEAD` HTTP method: + +`dirsearch --url {{url}} --extensions {{php}} --http-method {{HEAD}}` + +- Scan a web server, saving the results to a `.json` file: + +`dirsearch --url {{url}} --extensions {{php}} --json-report {{path/to/report.json}}` diff --git a/diskonaut b/diskonaut new file mode 100644 index 00000000..c5d7dee1 --- /dev/null +++ b/diskonaut @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# diskonaut + +> Terminal disk space navigator, written in Rust. +> More information: . + +- Start `diskonaut` in the current directory: + +`diskonaut` + +- Start `diskonaut` in a specific directory: + +`diskonaut {{path/to/directory}}` + +- Show file sizes rather than their block usage on the disk: + +`diskonaut --apparent-size {{path/to/directory}}` + +- Disable deletion confirmation: + +`diskonaut --disable-delete-confirmation` diff --git a/distccd b/distccd new file mode 100644 index 00000000..9b7a2f5c --- /dev/null +++ b/distccd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# distccd + +> Server daemon for the distcc distributed compiler. +> More information: . + +- Start a daemon with the default settings: + +`distccd --daemon` + +- Start a daemon, accepting connections from IPv4 private network ranges: + +`distccd --daemon --allow-private` + +- Start a daemon, accepting connections from a specific network address or address range: + +`distccd --daemon --allow {{ip_address|network_prefix}}` + +- Start a daemon with a lowered priority that can run a maximum of 4 tasks at a time: + +`distccd --daemon --jobs {{4}} --nice {{5}}` + +- Start a daemon and register it via mDNS/DNS-SD (Zeroconf): + +`distccd --daemon --zeroconf` diff --git a/dive b/dive new file mode 100644 index 00000000..95b7046c --- /dev/null +++ b/dive @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dive + +> Explore a Docker image, layer contents, and discover ways to shrink it. +> More information: . + +- Analyze a Docker image: + +`dive {{your_image_tag}}` + +- Build an image and start analyzing it: + +`dive build -t {{some_tag}}` diff --git a/django-admin b/django-admin new file mode 100644 index 00000000..938964fd --- /dev/null +++ b/django-admin @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# django-admin + +> Django’s utility for administrative tasks. +> More information: . + +- Create a new Django project: + +`django-admin startproject {{project_name}}` + +- Create a new app for the current project: + +`django-admin startapp {{app_name}}` + +- Check the current version of Django: + +`django-admin --version` + +- Display help for a specific command: + +`django-admin help {{command}}` diff --git a/dlv b/dlv new file mode 100644 index 00000000..c06365d9 --- /dev/null +++ b/dlv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dlv + +> Debugger for the Go programming language. +> More information: . + +- Compile and begin debugging the main package in the current directory (by default, with no arguments): + +`dlv debug` + +- Compile and begin debugging a specific package: + +`dlv debug {{package}} {{arguments}}` + +- Compile a test binary and begin debugging the compiled program: + +`dlv test` + +- Connect to a headless debug server: + +`dlv connect {{ip_address}}` + +- Attach to a running process and begin debugging: + +`div attach {{pid}}` + +- Compile and begin tracing a program: + +`dlv trace {{package}} --regexp '{{regular_expression}}'` diff --git a/dmd b/dmd new file mode 100644 index 00000000..8045b05e --- /dev/null +++ b/dmd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dmd + +> Official D compiler. +> More information: . + +- Build a D source file: + +`dmd {{path/to/source.d}}` + +- Generate code for all template instantiations: + +`dmd -allinst` + +- Control bounds checking: + +`dmd -boundscheck={{on|safeonly|off}}` + +- List information on all available checks: + +`dmd -check={{h|help|?}}` + +- Turn on colored console output: + +`dmd -color` diff --git a/doas b/doas new file mode 100644 index 00000000..d7b33606 --- /dev/null +++ b/doas @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doas + +> Executes a command as another user. +> More information: . + +- Run a command as root: + +`doas {{command}}` + +- Run a command as another user: + +`doas -u {{user}} {{command}}` + +- Launch the default shell as root: + +`doas -s` + +- Parse a configuration file and check if the execution of a command as another user is allowed: + +`doas -C {{config_file}} {{command}}` + +- Make `doas` request a password even after it was supplied earlier: + +`doas -L` diff --git a/docker b/docker new file mode 100644 index 00000000..1ff4ed2e --- /dev/null +++ b/docker @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker + +> Manage Docker containers and images. +> Some subcommands such as `docker run` have their own usage documentation. +> More information: . + +- List all docker containers (running and stopped): + +`docker ps --all` + +- Start a container from an image, with a custom name: + +`docker run --name {{container_name}} {{image}}` + +- Start or stop an existing container: + +`docker {{start|stop}} {{container_name}}` + +- Pull an image from a docker registry: + +`docker pull {{image}}` + +- Display the list of already downloaded images: + +`docker images` + +- Open a shell inside a running container: + +`docker exec -it {{container_name}} {{sh}}` + +- Remove a stopped container: + +`docker rm {{container_name}}` + +- Fetch and follow the logs of a container: + +`docker logs -f {{container_name}}` diff --git a/docker-build b/docker-build new file mode 100644 index 00000000..8b677c99 --- /dev/null +++ b/docker-build @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker build + +> Build an image from a Dockerfile. +> More information: . + +- Build a docker image using the Dockerfile in the current directory: + +`docker build .` + +- Build a docker image from a Dockerfile at a specified URL: + +`docker build {{github.com/creack/docker-firefox}}` + +- Build a docker image and tag it: + +`docker build --tag {{name:tag}} .` + +- Build a docker image with no build context: + +`docker build --tag {{name:tag}} - < {{Dockerfile}}` + +- Do not use the cache when building the image: + +`docker build --no-cache --tag {{name:tag}} .` + +- Build a docker image using a specific Dockerfile: + +`docker build --file {{Dockerfile}} .` + +- Build with custom build-time variables: + +`docker build --build-arg {{HTTP_PROXY=http://10.20.30.2:1234}} --build-arg {{FTP_PROXY=http://40.50.60.5:4567}} .` diff --git a/docker-commit b/docker-commit new file mode 100644 index 00000000..d667e9f7 --- /dev/null +++ b/docker-commit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker commit + +> Create a new image from a container’s changes. +> More information: . + +- Create an image from a specific container: + +`docker commit {{container}} {{image}}:{{tag}}` + +- Apply a `CMD` Dockerfile instruction to the created image: + +`docker commit --change="CMD {{command}}" {{container}} {{image}}:{{tag}}` + +- Apply an `ENV` Dockerfile instruction to the created image: + +`docker commit --change="ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` + +- Create an image with a specific author in the metadata: + +`docker commit --author="{{author}}" {{container}} {{image}}:{{tag}}` + +- Create an image with a specific comment in the metadata: + +`docker commit --message="{{comment}}" {{container}} {{image}}:{{tag}}` + +- Create an image without pausing the container during commit: + +`docker commit --pause={{false}} {{container}} {{image}}:{{tag}}` + +- Display help: + +`docker commit --help` diff --git a/docker-compose b/docker-compose new file mode 100644 index 00000000..420c95d4 --- /dev/null +++ b/docker-compose @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker compose + +> Run and manage multi container docker applications. +> More information: . + +- List all running containers: + +`docker compose ps` + +- Create and start all containers in the background using a `docker-compose.yml` file from the current directory: + +`docker compose up --detach` + +- Start all containers, rebuild if necessary: + +`docker compose up --build` + +- Start all containers by specifying a project name and using an alternate compose file: + +`docker compose -p {{project_name}} --file {{path/to/file}} up` + +- Stop all running containers: + +`docker compose stop` + +- Stop and remove all containers, networks, images, and volumes: + +`docker compose down --rmi all --volumes` + +- Follow logs for all containers: + +`docker compose logs --follow` + +- Follow logs for a specific container: + +`docker compose logs --follow {{container_name}}` diff --git a/docker-container b/docker-container new file mode 100644 index 00000000..11f6c95c --- /dev/null +++ b/docker-container @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container + +> Manage Docker containers. +> More information: . + +- List currently running Docker containers: + +`docker container ls` + +- Start one or more stopped containers: + +`docker container start {{container1_name}} {{container2_name}}` + +- Kill one or more running containers: + +`docker container kill {{container_name}}` + +- Stop one or more running containers: + +`docker container stop {{container_name}}` + +- Pause all processes within one or more containers: + +`docker container pause {{container_name}}` + +- Display detailed information on one or more containers: + +`docker container inspect {{container_name}}` + +- Export a container's filesystem as a `tar` archive: + +`docker container export {{container_name}}` + +- Create a new image from a container's changes: + +`docker container commit {{container_name}}` diff --git a/docker-container-diff b/docker-container-diff new file mode 100644 index 00000000..552807ee --- /dev/null +++ b/docker-container-diff @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container diff + +> This command is an alias of `docker diff`. +> More information: . + +- View documentation for the original command: + +`tldr docker diff` diff --git a/docker-container-remove b/docker-container-remove new file mode 100644 index 00000000..b5cac415 --- /dev/null +++ b/docker-container-remove @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container remove + +> This command is an alias of `docker rm`. +> More information: . + +- View documentation for the original command: + +`tldr docker rm` diff --git a/docker-container-rename b/docker-container-rename new file mode 100644 index 00000000..9630e8ad --- /dev/null +++ b/docker-container-rename @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container rename + +> This command is an alias of `docker rename`. +> More information: . + +- View documentation for the original command: + +`tldr docker rename` diff --git a/docker-container-rm b/docker-container-rm new file mode 100644 index 00000000..efb14548 --- /dev/null +++ b/docker-container-rm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container rm + +> This command is an alias of `docker rm`. +> More information: . + +- View documentation for the original command: + +`tldr docker rm` diff --git a/docker-container-top b/docker-container-top new file mode 100644 index 00000000..02328b7c --- /dev/null +++ b/docker-container-top @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container top + +> This command is an alias of `docker top`. +> More information: . + +- View documentation for the original command: + +`tldr docker top` diff --git a/docker-cp b/docker-cp new file mode 100644 index 00000000..96058e54 --- /dev/null +++ b/docker-cp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker cp + +> Copy files or directories between host and container filesystems. +> More information: . + +- Copy a file or directory from the host to a container: + +`docker cp {{path/to/file_or_directory_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` + +- Copy a file or directory from a container to the host: + +`docker cp {{container_name}}:{{path/to/file_or_directory_in_container}} {{path/to/file_or_directory_on_host}}` + +- Copy a file or directory from the host to a container, following symlinks (copies the symlinked files directly, not the symlinks themselves): + +`docker cp --follow-link {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` diff --git a/docker-diff b/docker-diff new file mode 100644 index 00000000..456f601d --- /dev/null +++ b/docker-diff @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker diff + +> Inspect changes to files or directories on a container's filesystem. +> More information: . + +- Inspect the changes to a container since it was created: + +`docker diff {{container}}` + +- Display help: + +`docker diff --help` diff --git a/docker-exec b/docker-exec new file mode 100644 index 00000000..0d94e6e4 --- /dev/null +++ b/docker-exec @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker exec + +> Execute a command on an already running Docker container. +> More information: . + +- Enter an interactive shell session on an already-running container: + +`docker exec --interactive --tty {{container_name}} {{/bin/bash}}` + +- Run a command in the background (detached) on a running container: + +`docker exec --detach {{container_name}} {{command}}` + +- Select the working directory for a given command to execute into: + +`docker exec --interactive --tty --workdir {{path/to/directory}} {{container_name}} {{command}}` + +- Run a command in background on existing container but keep `stdin` open: + +`docker exec --interactive --detach {{container_name}} {{command}}` + +- Set an environment variable in a running Bash session: + +`docker exec --interactive --tty --env {{variable_name}}={{value}} {{container_name}} {{/bin/bash}}` + +- Run a command as a specific user: + +`docker exec --user {{user}} {{container_name}} {{command}}` diff --git a/docker-image b/docker-image new file mode 100644 index 00000000..69c8b0c2 --- /dev/null +++ b/docker-image @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker image + +> Manage Docker images. +> See also: `docker build`, `docker import`, and `docker pull`. +> More information: . + +- List local Docker images: + +`docker image ls` + +- Delete unused local Docker images: + +`docker image prune` + +- Delete all unused images (not just those without a tag): + +`docker image prune --all` + +- Show the history of a local Docker image: + +`docker image history {{image}}` diff --git a/docker-images b/docker-images new file mode 100644 index 00000000..44142c44 --- /dev/null +++ b/docker-images @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker images + +> Manage Docker images. +> More information: . + +- List all Docker images: + +`docker images` + +- List all Docker images including intermediates: + +`docker images --all` + +- List the output in quiet mode (only numeric IDs): + +`docker images --quiet` + +- List all Docker images not used by any container: + +`docker images --filter dangling=true` + +- List images that contain a substring in their name: + +`docker images "{{*name*}}"` + +- Sort images by size: + +`docker images --format "{{.ID}} {{.Size}} {{.Repository}}:{{.Tag}}" | sort -k 2 -h` diff --git a/docker-inspect b/docker-inspect new file mode 100644 index 00000000..d2ee9478 --- /dev/null +++ b/docker-inspect @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker inspect + +> Return low-level information on Docker objects. +> More information: . + +- Display help: + +`docker inspect` + +- Display information about a container, image, or volume using a name or ID: + +`docker inspect {{container|image|ID}}` + +- Display a container's IP address: + +`docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` + +- Display the path to the container's log file: + +`docker inspect --format='\{\{.LogPath\}\}' {{container}}` + +- Display the image name of the container: + +`docker inspect --format='\{\{.Config.Image\}\}' {{container}}` + +- Display the configuration information as JSON: + +`docker inspect --format='\{\{json .Config\}\}' {{container}}` + +- Display all port bindings: + +`docker inspect --format='\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` diff --git a/docker-load b/docker-load new file mode 100644 index 00000000..0f6871ba --- /dev/null +++ b/docker-load @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker load + +> Load Docker images from files or `stdin`. +> More information: . + +- Load a Docker image from `stdin`: + +`docker load < {{path/to/image_file.tar}}` + +- Load a Docker image from a specific file: + +`docker load --input {{path/to/image_file.tar}}` + +- Load a Docker image from a specific file in quiet mode: + +`docker load --quiet --input {{path/to/image_file.tar}}` diff --git a/docker-login b/docker-login new file mode 100644 index 00000000..1304b92d --- /dev/null +++ b/docker-login @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker login + +> Log into a docker registry. +> More information: . + +- Interactively log into a registry: + +`docker login` + +- Log into a registry with a specific username (user will be prompted for a password): + +`docker login --username {{username}}` + +- Log into a registry with username and password: + +`docker login --username {{username}} --password {{password}} {{server}}` + +- Log into a registry with password from `stdin`: + +`echo "{{password}}" | docker login --username {{username}} --password-stdin` diff --git a/docker-logs b/docker-logs new file mode 100644 index 00000000..ae40c3ea --- /dev/null +++ b/docker-logs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker logs + +> Print container logs. +> More information: . + +- Print logs from a container: + +`docker logs {{container_name}}` + +- Print logs and follow them: + +`docker logs -f {{container_name}}` + +- Print last 5 lines: + +`docker logs {{container_name}} --tail {{5}}` + +- Print logs and append them with timestamps: + +`docker logs -t {{container_name}}` + +- Print logs from a certain point in time of container execution (i.e. 23m, 10s, 2013-01-02T13:23:37): + +`docker logs {{container_name}} --until {{time}}` diff --git a/docker-machine b/docker-machine new file mode 100644 index 00000000..efb8ade6 --- /dev/null +++ b/docker-machine @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker-machine + +> Create and manage machines running Docker. +> More information: . + +- List currently running docker machines: + +`docker-machine ls` + +- Create a new docker machine with specific name: + +`docker-machine create {{name}}` + +- Get the status of a machine: + +`docker-machine status {{name}}` + +- Start a machine: + +`docker-machine start {{name}}` + +- Stop a machine: + +`docker-machine stop {{name}}` + +- Inspect information about a machine: + +`docker-machine inspect {{name}}` diff --git a/docker-network b/docker-network new file mode 100644 index 00000000..6e5aef2c --- /dev/null +++ b/docker-network @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker network + +> Create and manage docker networks. +> More information: . + +- List all available and configured networks on docker daemon: + +`docker network ls` + +- Create a user-defined network: + +`docker network create --driver {{driver_name}} {{network_name}}` + +- Display detailed information about one or more networks: + +`docker network inspect {{network_name1 network_name2 ...}}` + +- Connect a container to a network using a name or ID: + +`docker network connect {{network_name}} {{container_name|ID}}` + +- Disconnect a container from a network: + +`docker network disconnect {{network_name}} {{container_name|ID}}` + +- Remove all unused (not referenced by any container) networks: + +`docker network prune` + +- Remove one or more unused networks: + +`docker network rm {{network_name1 network_name2 ...}}` diff --git a/docker-ps b/docker-ps new file mode 100644 index 00000000..25049242 --- /dev/null +++ b/docker-ps @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker ps + +> List Docker containers. +> More information: . + +- List currently running docker containers: + +`docker ps` + +- List all docker containers (running and stopped): + +`docker ps --all` + +- Show the latest created container (includes all states): + +`docker ps --latest` + +- Filter containers that contain a substring in their name: + +`docker ps --filter="name={{name}}"` + +- Filter containers that share a given image as an ancestor: + +`docker ps --filter "ancestor={{image}}:{{tag}}"` + +- Filter containers by exit status code: + +`docker ps --all --filter="exited={{code}}"` + +- Filter containers by status (created, running, removing, paused, exited and dead): + +`docker ps --filter="status={{status}}"` + +- Filter containers that mount a specific volume or have a volume mounted in a specific path: + +`docker ps --filter="volume={{path/to/directory}}" --format "table {{.ID}} {{.Image}} {{.Names}} {{.Mounts}}"` diff --git a/docker-pull b/docker-pull new file mode 100644 index 00000000..4435bc82 --- /dev/null +++ b/docker-pull @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker pull + +> Download Docker images from a registry. +> More information: . + +- Download a specific Docker image: + +`docker pull {{image}}:{{tag}}` + +- Download a specific Docker image in quiet mode: + +`docker pull --quiet {{image}}:{{tag}}` + +- Download all tags of a specific Docker image: + +`docker pull --all-tags {{image}}` + +- Download a Docker images for a specific platform, e.g. linux/amd64: + +`docker pull --platform {{linux/amd64}} {{image}}:{{tag}}` + +- Display help: + +`docker pull --help` diff --git a/docker-rename b/docker-rename new file mode 100644 index 00000000..cf577963 --- /dev/null +++ b/docker-rename @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker rename + +> Rename a container. +> More information: . + +- Rename a container: + +`docker rename {{container}} {{new_name}}` + +- Display help: + +`docker rename --help` diff --git a/docker-rm b/docker-rm new file mode 100644 index 00000000..6e090481 --- /dev/null +++ b/docker-rm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker rm + +> Remove containers. +> More information: . + +- Remove containers: + +`docker rm {{container1 container2 ...}}` + +- Force remove a container: + +`docker rm --force {{container1 container2 ...}}` + +- Remove a container and its volumes: + +`docker rm --volumes {{container}}` + +- Display help: + +`docker rm` diff --git a/docker-rmi b/docker-rmi new file mode 100644 index 00000000..99fda005 --- /dev/null +++ b/docker-rmi @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker rmi + +> Remove Docker images. +> More information: . + +- Display help: + +`docker rmi` + +- Remove one or more images given their names: + +`docker rmi {{image1 image2 ...}}` + +- Force remove an image: + +`docker rmi --force {{image}}` + +- Remove an image without deleting untagged parents: + +`docker rmi --no-prune {{image}}` diff --git a/docker-run b/docker-run new file mode 100644 index 00000000..02eaf1af --- /dev/null +++ b/docker-run @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker run + +> Run a command in a new Docker container. +> More information: . + +- Run command in a new container from a tagged image: + +`docker run {{image:tag}} {{command}}` + +- Run command in a new container in background and display its ID: + +`docker run --detach {{image}} {{command}}` + +- Run command in a one-off container in interactive mode and pseudo-TTY: + +`docker run --rm --interactive --tty {{image}} {{command}}` + +- Run command in a new container with passed environment variables: + +`docker run --env '{{variable}}={{value}}' --env {{variable}} {{image}} {{command}}` + +- Run command in a new container with bind mounted volumes: + +`docker run --volume {{/path/to/host_path}}:{{/path/to/container_path}} {{image}} {{command}}` + +- Run command in a new container with published ports: + +`docker run --publish {{host_port}}:{{container_port}} {{image}} {{command}}` + +- Run command in a new container overwriting the entrypoint of the image: + +`docker run --entrypoint {{command}} {{image}}` + +- Run command in a new container connecting it to a network: + +`docker run --network {{network}} {{image}}` diff --git a/docker-save b/docker-save new file mode 100644 index 00000000..4e682230 --- /dev/null +++ b/docker-save @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker save + +> Export Docker images to archive. +> More information: . + +- Save an image by redirecting `stdout` to a `tar` archive: + +`docker save {{image}}:{{tag}} > {{path/to/file.tar}}` + +- Save an image to a `tar` archive: + +`docker save --output {{path/to/file.tar}} {{image}}:{{tag}}` + +- Save all tags of the image: + +`docker save --output {{path/to/file.tar}} {{image_name}}` + +- Cherry-pick particular tags of an image to save: + +`docker save --output {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` diff --git a/docker-secret b/docker-secret new file mode 100644 index 00000000..2245f149 --- /dev/null +++ b/docker-secret @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker secret + +> Manage Docker swarm secrets. +> More information: . + +- Create a new secret from `stdin`: + +`{{command}} | docker secret create {{secret_name}} -` + +- Create a new secret from a file: + +`docker secret create {{secret_name}} {{path/to/file}}` + +- List all secrets: + +`docker secret ls` + +- Display detailed information on one or multiple secrets in a human friendly format: + +`docker secret inspect --pretty {{secret_name1 secret_name2 ...}}` + +- Remove one or more secrets: + +`docker secret rm {{secret_name1 secret_name2 ...}}` diff --git a/docker-service b/docker-service new file mode 100644 index 00000000..e6f93aad --- /dev/null +++ b/docker-service @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker service + +> Manage the services on a docker daemon. +> More information: . + +- List the services on a docker daemon: + +`docker service ls` + +- Create a new service: + +`docker service create --name {{service_name}} {{image}}:{{tag}}` + +- Display detailed information about one or more services: + +`docker service inspect {{service_name_or_ID1 service_name_or_ID2}}` + +- List the tasks of one or more services: + +`docker service ps {{service_name_or_ID1 service_name_or_ID2 ...}}` + +- Scale to a specific number of replicas for a space-separated list of services: + +`docker service scale {{service_name}}={{count_of_replicas}}` + +- Remove one or more services: + +`docker service rm {{service_name_or_ID1 service_name_or_ID2}}` diff --git a/docker-slim b/docker-slim new file mode 100644 index 00000000..28eb72ac --- /dev/null +++ b/docker-slim @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker-slim + +> Analyze and optimize Docker images. +> More information: . + +- Start DockerSlim on interactive mode: + +`docker-slim` + +- Analyze Docker layers from a specific image: + +`docker-slim xray --target {{image:tag}}` + +- Lint a Dockerfile: + +`docker-slim lint --target {{path/to/Dockerfile}}` + +- Analyze and generate an optimized Docker image: + +`docker-slim build {{image:tag}}` + +- Display help for a subcommand: + +`docker-slim {{subcommand}} --help` diff --git a/docker-start b/docker-start new file mode 100644 index 00000000..1a444826 --- /dev/null +++ b/docker-start @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker start + +> Start stopped containers. +> More information: . + +- Display help: + +`docker start` + +- Start a docker container: + +`docker start {{container}}` + +- Start a container, attaching `stdout` and `stderr` and forwarding signals: + +`docker start --attach {{container}}` + +- Start one or more containers: + +`docker start {{container1 container2 ...}}` diff --git a/docker-stats b/docker-stats new file mode 100644 index 00000000..d61f1fa9 --- /dev/null +++ b/docker-stats @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker stats + +> Display a live stream of resource usage statistics for containers. +> More information: . + +- Display a live stream for the statistics of all running containers: + +`docker stats` + +- Display a live stream of statistics for one or more containers: + +`docker stats {{container1 container2 ...}}` + +- Change the columns format to display container's CPU usage percentage: + +`docker stats --format "{{.Name}}: {{.CPUPerc}}"` + +- Display statistics for all containers (both running and stopped): + +`docker stats --all` + +- Disable streaming stats and only pull the current stats: + +`docker stats --no-stream` diff --git a/docker-swarm b/docker-swarm new file mode 100644 index 00000000..1bce6a97 --- /dev/null +++ b/docker-swarm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker swarm + +> A container orchestration tool. +> More information: . + +- Initialize a swarm cluster: + +`docker swarm init` + +- Display the token to join a manager or a worker: + +`docker swarm join-token {{worker|manager}}` + +- Join a new node to the cluster: + +`docker swarm join --token {{token}} {{manager_node_url:2377}}` + +- Remove a worker from the swarm (run inside the worker node): + +`docker swarm leave` + +- Display the current CA certificate in PEM format: + +`docker swarm ca` + +- Rotate the current CA certificate and display the new certificate: + +`docker swarm ca --rotate` + +- Change the valid period for node certificates: + +`docker swarm update --cert-expiry {{hours}}h{{minutes}}m{{seconds}}s` diff --git a/docker-system b/docker-system new file mode 100644 index 00000000..614d8ee2 --- /dev/null +++ b/docker-system @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker system + +> Manage Docker data and display system-wide information. +> More information: . + +- Display help: + +`docker system` + +- Show docker disk usage: + +`docker system df` + +- Show detailed information on disk usage: + +`docker system df --verbose` + +- Remove unused data: + +`docker system prune` + +- Remove unused data created more than a specified amount of time in the past: + +`docker system prune --filter="until={{hours}}h{{minutes}}m"` + +- Display real-time events from the Docker daemon: + +`docker system events` + +- Display real-time events from containers streamed as valid JSON Lines: + +`docker system events --filter 'type=container' --format '{{json .}}'` + +- Display system-wide information: + +`docker system info` diff --git a/docker-tag b/docker-tag new file mode 100644 index 00000000..95a2bcae --- /dev/null +++ b/docker-tag @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker tag + +> Assign tags to existing Docker images. +> More information: . + +- Assign a name and tag to a specific image ID: + +`docker tag {{id}} {{name}}:{{tag}}` + +- Assign a tag to a specific image: + +`docker tag {{image}}:{{current_tag}} {{image}}:{{new_tag}}` + +- Display help: + +`docker tag` diff --git a/docker-top b/docker-top new file mode 100644 index 00000000..3ab71f62 --- /dev/null +++ b/docker-top @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker top + +> Display the running processes of a container. +> More information: . + +- Display the running processes of a container: + +`docker top {{container}}` + +- Display help: + +`docker top --help` diff --git a/docker-update b/docker-update new file mode 100644 index 00000000..35f6145e --- /dev/null +++ b/docker-update @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker update + +> Update configuration of Docker containers. +> This command is not supported for Windows containers. +> More information: . + +- Update restart policy to apply when a specific container exits: + +`docker update --restart={{always|no|on-failure|unless-stopped}} {{container_name}}` + +- Update the policy to restart up to three times a specific container when it exits with non-zero exit status: + +`docker update --restart=on-failure:3 {{container_name}}` + +- Update the number of CPUs available to a specific container: + +`docker update --cpus {{count}} {{container_name}}` + +- Update the memory limit in [M]egabytes for a specific container: + +`docker update --memory {{limit}}M {{container_name}}` + +- Update the maximum number of process IDs allowed inside a specific container (use `-1` for unlimited): + +`docker update --pids-limit {{count}} {{container_name}}` + +- Update the amount of memory in [M]egabytes a specific container can swap to disk (use `-1` for unlimited): + +`docker update --memory-swap {{limit}}M {{container_name}}` diff --git a/docker-volume b/docker-volume new file mode 100644 index 00000000..df2e069d --- /dev/null +++ b/docker-volume @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker volume + +> Manage Docker volumes. +> More information: . + +- Create a volume: + +`docker volume create {{volume_name}}` + +- Create a volume with a specific label: + +`docker volume create --label {{label}} {{volume_name}}` + +- Create a `tmpfs` volume a size of 100 MiB and an uid of 1000: + +`docker volume create --opt {{type}}={{tmpfs}} --opt {{device}}={{tmpfs}} --opt {{o}}={{size=100m,uid=1000}} {{volume_name}}` + +- List all volumes: + +`docker volume ls` + +- Remove a volume: + +`docker volume rm {{volume_name}}` + +- Display information about a volume: + +`docker volume inspect {{volume_name}}` + +- Remove all unused local volumes: + +`docker volume prune` + +- Display help for a subcommand: + +`docker volume {{subcommand}} --help` diff --git a/docsify b/docsify new file mode 100644 index 00000000..3f40c02d --- /dev/null +++ b/docsify @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docsify + +> Initialize and serve markdown documentation. +> More information: . + +- Initialize a new documentation in the current directory: + +`docsify init` + +- Initialize a new documentation in the specified directory: + +`docsify init {{path/to/directory}}` + +- Serve local documentation on `localhost:3000` with live reload: + +`docsify serve {{path/to/directory}}` + +- Serve local documentation on `localhost` at the specified port: + +`docsify serve --port {{80}} {{path/to/directory}}` + +- Generate a sidebar markdown file in the specified directory: + +`docsify generate {{path/to/directory}}` diff --git a/doctl-account b/doctl-account new file mode 100644 index 00000000..a29c1c83 --- /dev/null +++ b/doctl-account @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl account + +> Retrieve information about Digital Ocean accounts. +> More information: . + +- Display account info: + +`doctl account get` + +- Show the hourly API limit, progress towards it, and when the rate limit resets: + +`doctl account ratelimit` + +- Display help: + +`doctl account --help` diff --git a/doctl-apps b/doctl-apps new file mode 100644 index 00000000..8e756fda --- /dev/null +++ b/doctl-apps @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl apps + +> Manage DigitalOcean apps. +> More information: . + +- Create an app: + +`doctl apps create` + +- Create a deployment for a specific app: + +`doctl apps create-deployment {{app_id}}` + +- Delete an app interactively: + +`doctl apps delete {{app_id}}` + +- Get an app: + +`doctl apps get` + +- List all apps: + +`doctl apps list` + +- List all deployments from a specific app: + +`doctl apps list-deployments {{app_id}}` + +- Get logs from a specific app: + +`doctl apps logs {{app_id}}` + +- Update a specific app with a given app spec: + +`doctl apps update {{app_id}} --spec {{path/to/spec.yml}}` diff --git a/doctl-auth b/doctl-auth new file mode 100644 index 00000000..963f4a45 --- /dev/null +++ b/doctl-auth @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl auth + +> Authenticate `doctl` with API tokens. +> More information: . + +- Open a prompt to enter an API token and label its context: + +`doctl auth init --context {{token_label}}` + +- List authentication contexts (API tokens): + +`doctl auth list` + +- Switch contexts (API tokens): + +`doctl auth switch --context {{token_label}}` + +- Remove a stored authentication context (API token): + +`doctl auth remove --context {{token_label}}` + +- Show available commands: + +`doctl auth --help` diff --git a/doctl-balance b/doctl-balance new file mode 100644 index 00000000..5b783ac3 --- /dev/null +++ b/doctl-balance @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl balance + +> Show the balance of a Digital Ocean account. +> More information: . + +- Get balance of the account associated with the current context: + +`doctl balance get` + +- Get the balance of an account associated with an access token: + +`doctl balance get --access-token {{access_token}}` + +- Get the balance of an account associated with a specified context: + +`doctl balance get --context` diff --git a/doctl-compute-droplet b/doctl-compute-droplet new file mode 100644 index 00000000..5da9f634 --- /dev/null +++ b/doctl-compute-droplet @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl compute droplet + +> List, create, and delete virtual machines which are called droplets. +> More information: . + +- Create a droplet: + +`doctl compute droplet create --region {{region}} --image {{os_image}} --size {{vps_type}} {{droplet_name}}` + +- Delete a droplet: + +`doctl compute droplet delete {{droplet_id|droplet_name}}` + +- List droplets: + +`doctl compute droplet list` diff --git a/doctl-databases b/doctl-databases new file mode 100644 index 00000000..1ccde2b6 --- /dev/null +++ b/doctl-databases @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases + +> Manage your MySQL, Redis, PostgreSQL, and MongoDB database services. +> More information: . + +- Run a `doctl databases` command with an access token: + +`doctl databases {{command}} --access-token {{access_token}}` + +- Get details for a database cluster: + +`doctl databases get` + +- List your database clusters: + +`doctl databases list` + +- Create a database cluster: + +`doctl databases create {{database_name}}` + +- Delete a cluster: + +`doctl databases delete {{database_id}}` diff --git a/doctl-databases-db b/doctl-databases-db new file mode 100644 index 00000000..72ab87b5 --- /dev/null +++ b/doctl-databases-db @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases db + +> Manage databases that are served by a database cluster. +> More information: . + +- Run a `doctl databases db` command with an access token: + +`doctl databases db {{command}} --access-token {{access_token}}` + +- Retrieve the name of the given database hosted in the given database cluster: + +`doctl databases db get {{database_id}} {{database_name}}` + +- List existing databases hosted within a given database cluster: + +`doctl databases db list {{database_id}}` + +- Create a database with the given name in the given database cluster: + +`doctl databases db create {{database_id}} {{database_name}}` + +- Delete the database with the given name in the given database cluster: + +`doctl databases db delete {{database_id}} {{database_name}}` diff --git a/doctl-databases-firewalls b/doctl-databases-firewalls new file mode 100644 index 00000000..1a1076b8 --- /dev/null +++ b/doctl-databases-firewalls @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases firewalls + +> Manage firewalls for database clusters. +> More information: . + +- Run a `doctl databases firewalls` command with an access token: + +`doctl databases firewalls {{command}} --access-token {{access_token}}` + +- Retrieve a list of firewall rules for a given database: + +`doctl databases firewalls list` + +- Add a database firewall rule to a given database: + +`doctl databases firewalls append {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}` + +- Remove a firewall rule for a given database: + +`doctl databases firewalls remove {{database_id}} {{rule_uuid}}` diff --git a/doctl-databases-maintenance-window b/doctl-databases-maintenance-window new file mode 100644 index 00000000..270b7cc5 --- /dev/null +++ b/doctl-databases-maintenance-window @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases maintenance-window + +> Schedule, and check the schedule of, maintenance windows for your databases. +> More information: . + +- Run a `doctl databases maintenance-window` command with an access token: + +`doctl databases maintenance-window {{command}} --access-token {{access_token}}` + +- Retrieve details about a database cluster's maintenance windows: + +`doctl databases maintenance-window get {{database_id}}` + +- Update the maintenance window for a database cluster: + +`doctl databases maintenance-window update {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}` diff --git a/doctl-databases-options b/doctl-databases-options new file mode 100644 index 00000000..10653329 --- /dev/null +++ b/doctl-databases-options @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases options + +> Enable the navigation of available options under each database engine. +> More information: . + +- Run a `doctl databases options` command with an access token: + +`doctl databases options {{command}} --access-token {{access_token}}` + +- Retrieve a list of the available database engines: + +`doctl databases options engines` + +- Retrieve a list of the available regions for a given database engine: + +`doctl databases options regions --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available slugs for a given database engine: + +`doctl databases options slugs --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available versions for a given database engine: + +`doctl databases options versions --engine {{pg|mysql|redis|mongodb}}` diff --git a/doctl-databases-pool b/doctl-databases-pool new file mode 100644 index 00000000..015ba609 --- /dev/null +++ b/doctl-databases-pool @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases pool + +> Manage connection pools for your database cluster. +> More information: . + +- Run a `doctl databases pool` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a database connection pool: + +`doctl databases pool get {{database_id}} {{pool_name}}` + +- List connection pools for a database cluster: + +`doctl databases pool list {{database_id}}` + +- Create a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}} --db {{new_pool_name}} --size {{pool_size}}` + +- Delete a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}}` diff --git a/doctl-databases-replica b/doctl-databases-replica new file mode 100644 index 00000000..883bf434 --- /dev/null +++ b/doctl-databases-replica @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases replica + +> Manage read-only replicas associated with a database cluster. +> More information: . + +- Run a `doctl databases replica` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a read-only database replica: + +`doctl databases replica get {{database_id}} {{replica_name}}` + +- Retrieve list of read-only database replicas: + +`doctl databases replica list {{database_id}}` + +- Create a read-only database replica: + +`doctl databases replica create {{database_id}} {{replica_name}}` + +- Delete a read-only database replica: + +`doctl databases replica delete {{database_id}} {{replica_name}}` diff --git a/doctl-databases-sql-mode b/doctl-databases-sql-mode new file mode 100644 index 00000000..f49e7acc --- /dev/null +++ b/doctl-databases-sql-mode @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases sql-mode + +> View and configure a MySQL database cluster’s global SQL modes. +> More information: . + +- Run a `doctl databases sql-mode` command with an access token: + +`doctl databases sql-mode {{command}} --access-token {{access_token}}` + +- Get a MySQL database cluster's SQL modes: + +`doctl databases sql-mode get {{database_id}}` + +- Overwrite a MySQL database cluster's SQL modes to the specified modes: + +`doctl databases sql-mode set {{database_id}} {{sql_mode_1 sql_mode_2 ...}}` diff --git a/doctl-databases-user b/doctl-databases-user new file mode 100644 index 00000000..5693a533 --- /dev/null +++ b/doctl-databases-user @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl databases user + +> View details for, and create, database users. +> More information: . + +- Run a `doctl databases user` command with an access token: + +`doctl databases user {{command}} --access-token {{access_token}}` + +- Retrieve details about a database user: + +`doctl databases user get {{database_id}} {{user_name}}` + +- Retrieve a list of database users for a given database: + +`doctl databases user list {{database_id}}` + +- Reset the auth password for a given user: + +`doctl databases user reset {{database id}} {{user_name}}` + +- Reset the MySQL auth plugn for a given user: + +`doctl databases user reset {{database_id}} {{user_name}} {{caching_sha2_password|mysql_native_password}}` + +- Create a user in the given database with a given username: + +`doctl databases user create {{database_id}} {{user_name}}` + +- Delete a user from the given database with the given username: + +`doctl databases user delete {{database_id}} {{user_name}}` diff --git a/doctl-kubernetes-cluster b/doctl-kubernetes-cluster new file mode 100644 index 00000000..74c48d82 --- /dev/null +++ b/doctl-kubernetes-cluster @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl kubernetes cluster + +> Manage Kubernetes clusters and view configuration options relating to clusters. +> More information: . + +- Create a Kubernetes cluster: + +`doctl kubernetes cluster create --count {{3}} --region {{nyc1}} --size {{s-1vcpu-2gb}} --version {{latest}} {{cluster_name}}` + +- List all Kubernetes clusters: + +`doctl kubernetes cluster list` + +- Fetch and save the kubeconfig: + +`doctl kubernetes cluster kubeconfig save {{cluster_name}}` + +- Check for available upgrades: + +`doctl kubernetes cluster get-upgrades {{cluster_name}}` + +- Upgrade a cluster to a new Kubernetes version: + +`doctl kubernetes cluster upgrade {{cluster_name}}` + +- Delete a cluster: + +`doctl kubernetes cluster delete {{cluster_name}}` diff --git a/doctl-kubernetes-options b/doctl-kubernetes-options new file mode 100644 index 00000000..89ed701b --- /dev/null +++ b/doctl-kubernetes-options @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl kubernetes options + +> Provides values available for use with doctl's Kubernetes commands. +> More information: . + +- List regions that support Kubernetes clusters: + +`doctl kubernetes options regions` + +- List machine sizes that can be used in a Kubernetes cluster: + +`doctl kubernetes options sizes` + +- List Kubernetes versions that can be used with DigitalOcean clusters: + +`doctl kubernetes options versions` diff --git a/doctl-serverless b/doctl-serverless new file mode 100644 index 00000000..4b79a095 --- /dev/null +++ b/doctl-serverless @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctl serverless + +> Manage serverless functions. +> More information: . + +- Connect local serverless support to a functions namespace: + +`doctl serverless connect` + +- Deploy a functions project to your functions namespace: + +`doctl serverless deploy` + +- Obtain metadata of a functions project: + +`doctl serverless get-metadata` + +- Provide information about serverless support: + +`doctl serverless status` diff --git a/doctum b/doctum new file mode 100644 index 00000000..76871354 --- /dev/null +++ b/doctum @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doctum + +> A PHP API documentation generator. +> More information: . + +- Parse a project: + +`doctum parse` + +- Render a project: + +`doctum render` + +- Parse then render a project: + +`doctum update` + +- Parse and render only a specific version of a project: + +`doctum update --only-version={{version}}` + +- Parse and render a project using a specific configuration: + +`doctum update {{path/to/config.php}}` diff --git a/dog b/dog new file mode 100644 index 00000000..d0545634 --- /dev/null +++ b/dog @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dog + +> DNS lookup utility. +> It has colorful output, supports DNS-over-TLS and DNS-over-HTTPS protocols, and can emit JSON. +> More information: . + +- Lookup the IP(s) associated with a hostname (A records): + +`dog {{example.com}}` + +- Query the MX records type associated with a given domain name: + +`dog {{example.com}} MX` + +- Specify a specific DNS server to query (e.g. Cloudflare): + +`dog {{example.com}} MX @{{1.1.1.1}}` + +- Query over TCP rather than UDP: + +`dog {{example.com}} MX @{{1.1.1.1}} --tcp` + +- Query the MX records type associated with a given domain name over TCP using explicit arguments: + +`dog --query {{example.com}} --type MX --nameserver {{1.1.1.1}} --tcp` + +- Lookup the IP(s) associated with a hostname (A records) using DNS over HTTPS (DoH): + +`dog {{example.com}} --https @{{https://cloudflare-dns.com/dns-query}}` diff --git a/dokku b/dokku new file mode 100644 index 00000000..6a9c6190 --- /dev/null +++ b/dokku @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dokku + +> Docker powered mini-Heroku (PaaS). +> Easily deploy multiple apps to your server in different languages using a single `git-push` command. +> More information: . + +- List running apps: + +`dokku apps` + +- Create an app: + +`dokku apps:create {{app_name}}` + +- Remove an app: + +`dokku apps:destroy {{app_name}}` + +- Install plugin: + +`dokku plugin:install {{full_repo_url}}` + +- Link database to an app: + +`dokku {{db}}:link {{db_name}} {{app_name}}` diff --git a/dolt b/dolt new file mode 100644 index 00000000..ef1860f8 --- /dev/null +++ b/dolt @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt + +> An SQL database that you can fork, clone, branch, merge, push and pull just like a Git repository. +> Some subcommands such as `commit` have their own usage documentation. +> More information: . + +- Execute a `dolt` subcommand: + +`dolt {{subcommand}}` + +- List available subcommands: + +`dolt help` diff --git a/dolt-add b/dolt-add new file mode 100644 index 00000000..7cc73133 --- /dev/null +++ b/dolt-add @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt add + +> Add the contents of a table to the list of Dolt staged tables. +> More information: . + +- Add a table to the list of staged tables (stage a table): + +`dolt add {{table}}` + +- Stage all tables: + +`dolt add --all` diff --git a/dolt-blame b/dolt-blame new file mode 100644 index 00000000..e6a9b1ee --- /dev/null +++ b/dolt-blame @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt blame + +> Displays commit information for each row of a Dolt table. +> More information: . + +- Display the latest commit for each row of a table: + +`dolt blame {{table}}` + +- Display the latest commits for each row of a table when the specified commit was made: + +`dolt blame {{commit}} {{table}}` + +- Display help: + +`dolt blame --help` diff --git a/dolt-branch b/dolt-branch new file mode 100644 index 00000000..ab559a17 --- /dev/null +++ b/dolt-branch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt branch + +> Manage Dolt branches. +> More information: . + +- List local branches (current branch is highlighted by `*`): + +`dolt branch` + +- List all local and remote branches: + +`dolt branch --all` + +- Create a new branch based on the current branch: + +`dolt branch {{branch_name}}` + +- Create a new branch with the specified commit as the latest: + +`dolt branch {{branch_name}} {{commit}}` + +- Rename a branch: + +`dolt branch --move {{branch_name1}} {{branch_name2}}` + +- Duplicate a branch: + +`dolt branch --copy {{branch_name1}} {{branch_name2}}` + +- Delete a branch: + +`dolt branch --delete {{branch_name}}` + +- Display the name of the current branch: + +`dolt branch --show-current` diff --git a/dolt-checkout b/dolt-checkout new file mode 100644 index 00000000..5c52a17f --- /dev/null +++ b/dolt-checkout @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt checkout + +> Checkout the work tree or tables to a branch or commit. +> More information: . + +- Switch to a branch: + +`dolt checkout {{branch_name}}` + +- Revert unstaged changes to a table: + +`dolt checkout {{table}}` + +- Create new branch and switch to it: + +`dolt checkout -b {{branch_name}}` + +- Create new branch based on a specified commit and switch to it: + +`dolt checkout -b {{branch_name}} {{commit}}` diff --git a/dolt-clone b/dolt-clone new file mode 100644 index 00000000..c1eeabec --- /dev/null +++ b/dolt-clone @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt clone + +> Clone a repository into a new directory. +> More information: . + +- Clone an existing repository into a specific directory (defaults to the repository name): + +`dolt clone {{repository_url}} {{path/to/directory}}` + +- Clone an existing repository and add a specific remote (defaults to origin): + +`dolt clone --remote {{remote_name}} {{repository_url}}` + +- Clone an existing repository only fetching a specific branch (defaults to all branches): + +`dolt clone --branch {{branch_name}} {{repository_url}}` + +- Clone a repository, using an AWS region (uses the profile's default region if none is provided): + +`dolt clone --aws-region {{region_name}} {{repository_url}}` + +- Clone a repository, using an AWS credentials file: + +`dolt clone --aws-creds-file {{credentials_file}} {{repository_url}}` + +- Clone a repository, using an AWS credentials profile (uses the default profile if none is provided): + +`dolt clone --aws-creds-profile {{profile_name}} {{repository_url}}` + +- Clone a repository, using an AWS credentials type: + +`dolt clone --aws-creds-type {{credentials_type}} {{repository_url}}` diff --git a/dolt-commit b/dolt-commit new file mode 100644 index 00000000..97ca884e --- /dev/null +++ b/dolt-commit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt commit + +> Commit staged changes to tables. +> More information: . + +- Commit all staged changes, opening the editor specified by `$EDITOR` to enter the commit message: + +`dolt commit` + +- Commit all staged changes with the specified message: + +`dolt commit --message "{{commit_message}}"` + +- Stage all unstaged changes to tables before committing: + +`dolt commit --all` + +- Use the specified ISO 8601 commit date (defaults to current date and time): + +`dolt commit --date "{{2021-12-31T00:00:00}}"` + +- Use the specified author for the commit: + +`dolt commit --author "{{author_name}} <{{author_email}}>"` + +- Allow creating an empty commit, with no changes: + +`dolt commit --allow-empty` + +- Ignore foreign key warnings: + +`dolt commit --force` diff --git a/dolt-config b/dolt-config new file mode 100644 index 00000000..aeb34492 --- /dev/null +++ b/dolt-config @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt config + +> Read and write local (per repository) and global (per user) Dolt configuration variables. +> More information: . + +- List all local and global configuration options and their values: + +`dolt config --list` + +- Display the value of a local or global configuration variable: + +`dolt config --get {{name}}` + +- Modify the value of a local configuration variable, creating it if it doesn't exist: + +`dolt config --add {{name}} {{value}}` + +- Modify the value of a global configuration variable, creating it if it doesn't exist: + +`dolt config --global --add {{name}} {{value}}` + +- Delete a local configuration variable: + +`dolt config --unset {{name}}` + +- Delete a global configuration variable: + +`dolt config --global --unset {{name}}` diff --git a/dolt-fetch b/dolt-fetch new file mode 100644 index 00000000..6dcc4562 --- /dev/null +++ b/dolt-fetch @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt fetch + +> Download objects and refs from another repository. +> More information: . + +- Fetch the latest changes from the default remote upstream repository (origin): + +`dolt fetch` + +- Fetch latest changes from a specific remote upstream repository: + +`dolt fetch {{remote_name}}` + +- Update branches with the current state of the remote, overwriting any conflicting history: + +`dolt fetch -f` diff --git a/dolt-init b/dolt-init new file mode 100644 index 00000000..a54de195 --- /dev/null +++ b/dolt-init @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt init + +> Create an empty Dolt data repository. +> More information: . + +- Initialize a new Dolt data repository in the current directory: + +`dolt init` + +- Initialize a new Dolt data repository creating a commit with the specified metadata: + +`dolt init --name "{{name}}" --email "{{email}}" --date "{{2021-12-31T00:00:00}}" -b "{{branch_name}}"` diff --git a/dolt-merge b/dolt-merge new file mode 100644 index 00000000..da76c35d --- /dev/null +++ b/dolt-merge @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt merge + +> Join two or more development histories together. +> More information: . + +- Incorporate changes from the named commits into the current branch: + +`dolt merge {{branch_name}}` + +- Incorporate changes from the named commits into the current branch without updating the commit history: + +`dolt merge --squash {{branch_name}}` + +- Merge a branch and create a merge commit even when the merge resolves as a fast-forward: + +`dolt merge --no-ff {{branch_name}}` + +- Merge a branch and create a merge commit with a specific commit message: + +`dolt merge --no-ff -m "{{message}}" {{branch_name}}` + +- Abort the current conflict resolution process: + +`dolt merge --abort` diff --git a/dolt-sql b/dolt-sql new file mode 100644 index 00000000..91b6271f --- /dev/null +++ b/dolt-sql @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt sql + +> Run a SQL query. Multiple SQL statements must be separated by semicolons. +> More information: . + +- Run a single query: + +`dolt sql --query "{{INSERT INTO t values (1, 3);}}"` + +- List all saved queries: + +`dolt sql --list-saved` diff --git a/dolt-status b/dolt-status new file mode 100644 index 00000000..200a4565 --- /dev/null +++ b/dolt-status @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt status + +> Display the status of the database session. +> More information: . + +- Display the status: + +`dolt status` diff --git a/dolt-version b/dolt-version new file mode 100644 index 00000000..609bfe9f --- /dev/null +++ b/dolt-version @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dolt version + +> Displays the current dolt CLI version. +> More information: . + +- Display version: + +`dolt version` diff --git a/dot b/dot new file mode 100644 index 00000000..38c0dfa7 --- /dev/null +++ b/dot @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dot + +> Render an image of a `linear directed` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`dot -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`dot -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`dot -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | dot -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`dot -?` diff --git a/dotnet b/dotnet new file mode 100644 index 00000000..06cdbaa1 --- /dev/null +++ b/dotnet @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet + +> Cross platform .NET command-line tools for .NET Core. +> Some subcommands such as `dotnet build` have their own usage documentation. +> More information: . + +- Initialize a new .NET project: + +`dotnet new {{template_short_name}}` + +- Restore NuGet packages: + +`dotnet restore` + +- Build and execute the .NET project in the current directory: + +`dotnet run` + +- Run a packaged dotnet application (only needs the runtime, the rest of the commands require the .NET Core SDK installed): + +`dotnet {{path/to/application.dll}}` diff --git a/dotnet-add-package b/dotnet-add-package new file mode 100644 index 00000000..5b164dde --- /dev/null +++ b/dotnet-add-package @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet add package + +> Add or update a .NET package reference in a project file. +> More information: . + +- Add a package to the project in the current directory: + +`dotnet add package {{package}}` + +- Add a package to a specific project: + +`dotnet add {{path/to/file.csproj}} package {{package}}` + +- Add a specific version of a package to the project: + +`dotnet add package {{package}} --version {{1.0.0}}` + +- Add a package using a specific NuGet source: + +`dotnet add package {{package}} --source {{https://api.nuget.org/v3/index.json}}` + +- Add a package only when targeting a specific framework: + +`dotnet add package {{package}} --framework {{net7.0}}` + +- Add and specify the directory where to restore packages (`~/.nuget/packages` by default): + +`dotnet add package {{package}} --package-directory {{path/to/directory}}` diff --git a/dotnet-add-reference b/dotnet-add-reference new file mode 100644 index 00000000..a7a69086 --- /dev/null +++ b/dotnet-add-reference @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet add reference + +> Add .NET project-to-project references. +> More information: . + +- Add a reference to the project in the current directory: + +`dotnet add reference {{path/to/reference.csproj}}` + +- Add a reference to the specific project: + +`dotnet add {{path/to/project.csproj}} reference {{path/to/reference.csproj}}` diff --git a/dotnet-build b/dotnet-build new file mode 100644 index 00000000..eb07ed32 --- /dev/null +++ b/dotnet-build @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet build + +> Builds a .NET application and its dependencies. +> More information: . + +- Compile the project or solution in the current directory: + +`dotnet build` + +- Compile a .NET project or solution in debug mode: + +`dotnet build {{path/to/project_or_solution}}` + +- Compile in release mode: + +`dotnet build --configuration {{Release}}` + +- Compile without restoring dependencies: + +`dotnet build --no-restore` + +- Compile with a specific verbosity level: + +`dotnet build --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` + +- Compile for a specific runtime: + +`dotnet build --runtime {{runtime_identifier}}` + +- Specify the output directory: + +`dotnet build --output {{path/to/directory}}` diff --git a/dotnet-ef b/dotnet-ef new file mode 100644 index 00000000..dc03de90 --- /dev/null +++ b/dotnet-ef @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet ef + +> Perform design-time development tasks for Entity Framework Core. +> More information: . + +- Update the database to a specified migration: + +`dotnet ef database update {{migration}}` + +- Drop the database: + +`dotnet ef database drop` + +- List available `DbContext` types: + +`dotnet ef dbcontext list` + +- Generate code for a `DbContext` and entity types for a database: + +`dotnet ef dbcontext scaffold {{connection_string}} {{provider}}` + +- Add a new migration: + +`dotnet ef migrations add {{name}}` + +- Remove the last migration, rolling back the code changes that were done for the latest migration: + +`dotnet ef migrations remove` + +- List available migrations: + +`dotnet ef migrations list` + +- Generate a SQL script from migrations range: + +`dotnet ef migrations script {{from_migration}} {{to_migration}}` diff --git a/dotnet-publish b/dotnet-publish new file mode 100644 index 00000000..83bd0de2 --- /dev/null +++ b/dotnet-publish @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet publish + +> Publish a .NET application and its dependencies to a directory for deployment to a hosting system. +> More information: . + +- Compile a .NET project in release mode: + +`dotnet publish --configuration Release {{path/to/project_file}}` + +- Publish the .NET Core runtime with your application for the specified runtime: + +`dotnet publish --self-contained true --runtime {{runtime_identifier}} {{path/to/project_file}}` + +- Package the application into a platform-specific single-file executable: + +`dotnet publish --runtime {{runtime_identifier}} -p:PublishSingleFile=true {{path/to/project_file}}` + +- Trim unused libraries to reduce the deployment size of an application: + +`dotnet publish --self-contained true --runtime {{runtime_identifier}} -p:PublishTrimmed=true {{path/to/project_file}}` + +- Compile a .NET project without restoring dependencies: + +`dotnet publish --no-restore {{path/to/project_file}}` + +- Specify the output directory: + +`dotnet publish --output {{path/to/directory}} {{path/to/project_file}}` diff --git a/dotnet-restore b/dotnet-restore new file mode 100644 index 00000000..6602c921 --- /dev/null +++ b/dotnet-restore @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet restore + +> Restores the dependencies and tools of a .NET project. +> More information: . + +- Restore dependencies for a .NET project or solution in the current directory: + +`dotnet restore` + +- Restore dependencies for a .NET project or solution in a specific location: + +`dotnet restore {{path/to/project_or_solution}}` + +- Restore dependencies without caching the HTTP requests: + +`dotnet restore --no-cache` + +- Force all dependencies to be resolved even if the last restore was successful: + +`dotnet restore --force` + +- Restore dependencies using package source failures as warnings: + +`dotnet restore --ignore-failed-sources` + +- Restore dependencies with a specific verbosity level: + +`dotnet restore --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` diff --git a/dotnet-run b/dotnet-run new file mode 100644 index 00000000..56d27c67 --- /dev/null +++ b/dotnet-run @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet run + +> Run a .NET application without explicit compile or launch commands. +> More information: . + +- Run the project in the current directory: + +`dotnet run` + +- Run a specific project: + +`dotnet run --project {{path/to/file.csproj}}` + +- Run the project with specific arguments: + +`dotnet run -- {{arg1=foo arg2=bar ...}}` + +- Run the project using a target framework moniker: + +`dotnet run --framework {{net7.0}}` + +- Specify architecture and OS, available since .NET 6 (Don't use `--runtime` with these options): + +`dotnet run --arch {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` diff --git a/dotnet-tool b/dotnet-tool new file mode 100644 index 00000000..96c9b61a --- /dev/null +++ b/dotnet-tool @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dotnet tool + +> Manage .NET tools and search published tools in NuGet. +> More information: . + +- Install a global tool (don't use `--global` for local tools): + +`dotnet tool install --global {{dotnetsay}}` + +- Install tools defined in the local tool manifest: + +`dotnet tool restore` + +- Update a specific global tool (don't use `--global` for local tools): + +`dotnet tool update --global {{tool_name}}` + +- Uninstall a global tool (don't use `--global` for local tools): + +`dotnet tool uninstall --global {{tool_name}}` + +- List installed global tools (don't use `--global` for local tools): + +`dotnet tool list --global` + +- Search tools in NuGet: + +`dotnet tool search {{search_term}}` + +- Display help: + +`dotnet tool --help` diff --git a/doxygen b/doxygen new file mode 100644 index 00000000..7921ce17 --- /dev/null +++ b/doxygen @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# doxygen + +> A documentation system for various programming languages. +> More information: . + +- Generate a default template configuration file `Doxyfile`: + +`doxygen -g` + +- Generate a template configuration file: + +`doxygen -g {{path/to/config_file}}` + +- Generate documentation using an existing configuration file: + +`doxygen {{path/to/config_file}}` diff --git a/drill b/drill new file mode 100644 index 00000000..3afeb32b --- /dev/null +++ b/drill @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# drill + +> Perform various DNS queries. +> More information: . + +- Lookup the IP(s) associated with a hostname (A records): + +`drill {{example.com}}` + +- Lookup the mail server(s) associated with a given domain name (MX record): + +`drill mx {{example.com}}` + +- Get all types of records for a given domain name: + +`drill any {{example.com}}` + +- Specify an alternate DNS server to query: + +`drill {{example.com}} @{{8.8.8.8}}` + +- Perform a reverse DNS lookup on an IP address (PTR record): + +`drill -x {{8.8.8.8}}` + +- Perform DNSSEC trace from root servers down to a domain name: + +`drill -TD {{example.com}}` + +- Show DNSKEY record(s) for a domain name: + +`drill -s dnskey {{example.com}}` diff --git a/drupal b/drupal new file mode 100644 index 00000000..82f9f997 --- /dev/null +++ b/drupal @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# drupal + +> Generate boilerplate code, interact with and debug Drupal projects. +> Some subcommands such as `drupal check` have their own usage documentation. +> More information: . + +- Install a module: + +`drupal module:install {{module_name}}` + +- Uninstall a module: + +`drupal module:uninstall {{module_name}}` + +- Clear all caches: + +`drupal cache:rebuild` + +- View current Drupal installation status: + +`drupal site:status` diff --git a/drupal-check b/drupal-check new file mode 100644 index 00000000..c3536e5f --- /dev/null +++ b/drupal-check @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# drupal-check + +> Check Drupal PHP code for deprecations. +> More information: . + +- Check the code in a specific directory for deprecations: + +`drupal-check {{path/to/directory}}` + +- Check the code excluding a comma-separated list of directories: + +`drupal-check --exclude-dir {{path/to/excluded_directory}},{{path/to/excluded_files/*.php}} {{path/to/directory}}` + +- Don't show a progress bar: + +`drupal-check --no-progress {{path/to/directory}}` + +- Perform static analysis to detect bad coding practices: + +`drupal-check --analysis {{path/to/directory}}` diff --git a/drush b/drush new file mode 100644 index 00000000..e5daa849 --- /dev/null +++ b/drush @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# drush + +> A command-line shell and scripting interface for Drupal. +> More information: . + +- Enable module "foo": + +`drush en {{foo}}` + +- Uninstall module "foo": + +`drush pmu {{foo}}` + +- Clear all caches: + +`drush cr` + +- Clear CSS and JavaScript caches: + +`drush cc css-js` diff --git a/du b/du new file mode 100644 index 00000000..ac55aa62 --- /dev/null +++ b/du @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# du + +> Disk usage: estimate and summarize file and directory space usage. +> More information: . + +- List the sizes of a directory and any subdirectories, in the given unit (B/KiB/MiB): + +`du -{{b|k|m}} {{path/to/directory}}` + +- List the sizes of a directory and any subdirectories, in human-readable form (i.e. auto-selecting the appropriate unit for each size): + +`du -h {{path/to/directory}}` + +- Show the size of a single directory, in human-readable units: + +`du -sh {{path/to/directory}}` + +- List the human-readable sizes of a directory and of all the files and directories within it: + +`du -ah {{path/to/directory}}` + +- List the human-readable sizes of a directory and any subdirectories, up to N levels deep: + +`du -h --max-depth=N {{path/to/directory}}` + +- List the human-readable size of all `.jpg` files in subdirectories of the current directory, and show a cumulative total at the end: + +`du -ch {{*/*.jpg}}` diff --git a/dua b/dua new file mode 100644 index 00000000..eb76817e --- /dev/null +++ b/dua @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dua + +> Dua (Disk Usage Analyzer): get the disk space usage of a directory. +> More information: . + +- Analyze specific directory: + +`dua {{path/to/directory}}` + +- Display apparent size instead of disk usage: + +`dua --apparent-size` + +- Count hard-linked files each time they are seen: + +`dua --count-hard-links` + +- Aggregate the consumed space of one or more directories or files: + +`dua aggregate` + +- Launch the terminal user interface: + +`dua interactive` + +- Format printing byte counts: + +`dua --format {{metric|binary|bytes|GB|GiB|MB|MiB}}` + +- Use a specific number of threads (defaults to the process number of threads): + +`dua --threads {{count}}` diff --git a/dub b/dub new file mode 100644 index 00000000..f53072b7 --- /dev/null +++ b/dub @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dub + +> Package manager for D packages. +> More information: . + +- Interactively create a new D project: + +`dub init {{project_name}}` + +- Non-interactively create a new D project: + +`dub init {{project_name}} -n` + +- Build and run a D project: + +`dub` + +- Install dependencies specified in a D project's `dub.json` or `dub.sdl` file: + +`dub fetch` + +- Update the dependencies in a D project: + +`dub upgrade` + +- Display help: + +`dub --help` diff --git a/duc b/duc new file mode 100644 index 00000000..3b4eb73c --- /dev/null +++ b/duc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# duc + +> Duc is a collection of tools for indexing, inspecting and visualizing disk usage. Duc maintains a database of accumulated sizes of directories of the file system, allowing queries this database, or create fancy graphs to show where data is. +> More information: . + +- Index the /usr directory, writing to the default database location ~/.duc.db: + +`duc index {{/usr}}` + +- List all files and directories under /usr/local, showing relative file sizes in a [g]raph: + +`duc ls -Fg {{/usr/local}}` + +- List all files and directories under /usr/local using treeview recursively: + +`duc ls -Fg -R {{/usr/local}}` + +- Start the graphical interface to explore the file system using sunburst graphs: + +`duc gui {{/usr}}` + +- Run the ncurses console interface to explore the file system: + +`duc ui {{/usr}}` + +- Dump database info: + +`duc info` diff --git a/duckdb b/duckdb new file mode 100644 index 00000000..6f16e04b --- /dev/null +++ b/duckdb @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# duckdb + +> Command-line client for DuckDB, an in-process analytical SQL engine. +> More information: . + +- Start an interactive shell with a transient in-memory database: + +`duckdb` + +- Start an interactive shell on a database file. If the file does not exist, a new database is created: + +`duckdb {{path/to/dbfile}}` + +- Directly query a CSV, JSON, or Parquet file: + +`duckdb -c "{{SELECT * FROM 'data_source.[csv|csv.gz|json|json.gz|parquet]'}}"` + +- Run a SQL script: + +`duckdb -c ".read {{path/to/script.sql}}"` + +- Run query on database file and keep the interactive shell open: + +`duckdb {{path/to/dbfile}} -cmd "{{SELECT DISTINCT * FROM tbl}}"` + +- Run SQL queries in file on database and keep the interactive shell open: + +`duckdb {{path/to/dbfile}} -init {{path/to/script.sql}}` + +- Read CSV from `stdin` and write CSV to `stdout`: + +`cat {{path/to/source.csv}} | duckdb -c "{{COPY (FROM read_csv_auto('/dev/stdin')) TO '/dev/stdout' WITH (FORMAT CSV, HEADER)}}"` + +- Display help: + +`duckdb -help` diff --git a/duf b/duf new file mode 100644 index 00000000..32aeb9b4 --- /dev/null +++ b/duf @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# duf + +> Disk Usage/Free Utility. +> More information: . + +- List accessible devices: + +`duf` + +- List everything (such as pseudo, duplicate or inaccessible file systems): + +`duf --all` + +- Only show specified devices or mount points: + +`duf {{path/to/directory1 path/to/directory2 ...}}` + +- Sort the output by a specified criteria: + +`duf --sort {{size|used|avail|usage}}` diff --git a/dumpcap b/dumpcap new file mode 100644 index 00000000..4d7b60d5 --- /dev/null +++ b/dumpcap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dumpcap + +> A network traffic dump tool. +> More information: . + +- Display available interfaces: + +`dumpcap --list-interfaces` + +- Capture packets on a specific interface: + +`dumpcap --interface {{1}}` + +- Capture packets to a specific location: + +`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}}` + +- Write to a ring buffer with a specific max file limit of a specific size: + +`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}} --ring-buffer filesize:{{500000}} --ring-buffer files:{{10}}` diff --git a/dune b/dune new file mode 100644 index 00000000..dd490fb6 --- /dev/null +++ b/dune @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dune + +> A build system for OCaml programs. +> More information: . + +- Build all targets: + +`dune build` + +- Clean up the workspace: + +`dune clean` + +- Run all tests: + +`dune runtest` + +- Start the utop REPL with compiled modules automatically loaded into it, to remove the need to load them by hand: + +`dune utop` diff --git a/duplicacy b/duplicacy new file mode 100644 index 00000000..2b22e7a9 --- /dev/null +++ b/duplicacy @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# duplicacy + +> A lock-free deduplication cloud backup tool. +> More information: . + +- Use current directory as the repository, initialize a SFTP storage and encrypt the storage with a password: + +`duplicacy init -e {{snapshot_id}} {{sftp://user@192.168.2.100/path/to/storage/}}` + +- Save a snapshot of the repository to the default storage: + +`duplicacy backup` + +- List snapshots of current repository: + +`duplicacy list` + +- Restore the repository to a previously saved snapshot: + +`duplicacy restore -r {{revision}}` + +- Check the integrity of snapshots: + +`duplicacy check` + +- Add another storage to be used for the existing repository: + +`duplicacy add {{storage_name}} {{snapshot_id}} {{storage_url}}` + +- Prune a specific revision of snapshot: + +`duplicacy prune -r {{revision}}` + +- Prune revisions, keeping one revision every `n` days for all revisions older than `m` days: + +`duplicacy prune -keep {{n:m}}` diff --git a/duplicity b/duplicity new file mode 100644 index 00000000..1b507141 --- /dev/null +++ b/duplicity @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# duplicity + +> Creates incremental, compressed, encrypted and versioned backups. +> Can also upload the backups to a variety of backend services. +> More information: . + +- Backup a directory via FTPS to a remote machine, encrypting it with a password: + +`FTP_PASSWORD={{ftp_login_password}} PASSPHRASE={{encryption_password}} duplicity {{path/to/source/directory}} {{ftps://user@hostname/target/directory/path/}}` + +- Backup a directory to Amazon S3, doing a full backup every month: + +`duplicity --full-if-older-than {{1M}} s3://{{bucket_name[/prefix]}}` + +- Delete versions older than 1 year from a backup stored on a WebDAV share: + +`FTP_PASSWORD={{webdav_login_password}} duplicity remove-older-than {{1Y}} --force {{webdav[s]://user@hostname[:port]/some_dir}}` + +- List the available backups: + +`duplicity collection-status "file://{{absolute/path/to/backup/directory}}"` + +- List the files in a backup stored on a remote machine, via ssh: + +`duplicity list-current-files --time {{YYYY-MM-DD}} scp://{{user@hostname}}/{{path/to/backup/dir}}` + +- Restore a subdirectory from a GnuPG-encrypted local backup to a given location: + +`PASSPHRASE={{gpg_key_password}} duplicity restore --encrypt-key {{gpg_key_id}} --path-to-restore {{relative/path/restoredirectory}} file://{{absolute/path/to/backup/directory}} {{path/to/directory/to/restore/to}}` diff --git a/dust b/dust new file mode 100644 index 00000000..7bab1886 --- /dev/null +++ b/dust @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dust + +> Dust gives an instant overview of which directories are using disk space. +> More information: . + +- Display information for the current directory: + +`dust` + +- Display information about one or more directories: + +`dust {{path/to/directory1 path/to/directory2 ...}}` + +- Display 30 directories (defaults to 21): + +`dust --number-of-lines {{30}}` + +- Display information for the current directory, up to 3 levels deep: + +`dust --depth {{3}}` + +- Display the biggest directories at the top in descending order: + +`dust --reverse` + +- Ignore all files and directories with a specific name: + +`dust --ignore-directory {{file_or_directory_name}}` + +- Do not display percent bars and percentages: + +`dust --no-percent-bars` diff --git a/dvc b/dvc new file mode 100644 index 00000000..97a6ffa6 --- /dev/null +++ b/dvc @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc + +> Data Version Control: like `git` for data. +> Some subcommands such as `dvc commit` have their own usage documentation. +> More information: . + +- Execute a DVC subcommand: + +`dvc {{subcommand}}` + +- Display general help: + +`dvc --help` + +- Display help about a specific subcommand: + +`dvc {{subcommand}} --help` + +- Display version: + +`dvc --version` diff --git a/dvc-add b/dvc-add new file mode 100644 index 00000000..bbe27b70 --- /dev/null +++ b/dvc-add @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc add + +> Add changed files to the index. +> More information: . + +- Add a single target file to the index: + +`dvc add {{path/to/file}}` + +- Add a target directory to the index: + +`dvc add {{path/to/directory}}` + +- Recursively add all the files in a given target directory: + +`dvc add --recursive {{path/to/directory}}` + +- Add a target file with a custom `.dvc` filename: + +`dvc add --file {{custom_name.dvc}} {{path/to/file}}` diff --git a/dvc-checkout b/dvc-checkout new file mode 100644 index 00000000..d7d59878 --- /dev/null +++ b/dvc-checkout @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc checkout + +> Checkout data files and directories from cache. +> More information: . + +- Checkout the latest version of all target files and directories: + +`dvc checkout` + +- Checkout the latest version of a specified target: + +`dvc checkout {{target}}` + +- Checkout a specific version of a target from a different Git commit/tag/branch: + +`git checkout {{commit_hash|tag|branch}} {{target}} && dvc checkout {{target}}` diff --git a/dvc-commit b/dvc-commit new file mode 100644 index 00000000..6dd1fbc7 --- /dev/null +++ b/dvc-commit @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc commit + +> Record changes to DVC-tracked files in the project. +> More information: . + +- Commit changes to all DVC-tracked files and directories: + +`dvc commit` + +- Commit changes to a specified DVC-tracked target: + +`dvc commit {{target}}` + +- Recursively commit all DVC-tracked files in a directory: + +`dvc commit --recursive {{path/to/directory}}` diff --git a/dvc-config b/dvc-config new file mode 100644 index 00000000..75eddac7 --- /dev/null +++ b/dvc-config @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc config + +> Low level command to manage custom configuration options for dvc repositories. +> These configurations can be on project, local, global, or system level. +> More information: . + +- Get the name of the default remote: + +`dvc config core.remote` + +- Set the project's default remote: + +`dvc config core.remote {{remote_name}}` + +- Unset the project's default remote: + +`dvc config --unset core.remote` + +- Get the configuration value for a specified key for the current project: + +`dvc config {{key}}` + +- Set the configuration value for a key on a project level: + +`dvc config {{key}} {{value}}` + +- Unset a project level configuration value for a given key: + +`dvc config --unset {{key}}` + +- Set a local, global, or system level configuration value: + +`dvc config --{{local|global|system}} {{key}} {{value}}` diff --git a/dvc-dag b/dvc-dag new file mode 100644 index 00000000..005d8fe1 --- /dev/null +++ b/dvc-dag @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc dag + +> Visualize the pipeline(s) defined in `dvc.yaml`. +> More information: . + +- Visualize the entire pipeline: + +`dvc dag` + +- Visualize the pipeline stages up to a specified target stage: + +`dvc dag {{target}}` + +- Export the pipeline in the dot format: + +`dvc dag --dot > {{path/to/pipeline.dot}}` diff --git a/dvc-destroy b/dvc-destroy new file mode 100644 index 00000000..4473e1e9 --- /dev/null +++ b/dvc-destroy @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc destroy + +> Remove all DVC files and directories from a DVC project. +> More information: . + +- Destroy the current project: + +`dvc destroy` + +- Force destroy the current project: + +`dvc destroy --force` diff --git a/dvc-diff b/dvc-diff new file mode 100644 index 00000000..0af48bf2 --- /dev/null +++ b/dvc-diff @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc diff + +> Show changes in DVC tracked file and directories. +> More information: . + +- Compare DVC tracked files from different Git commits, tags, and branches w.r.t the current workspace: + +`dvc diff {{commit_hash/tag/branch}}` + +- Compare the changes in DVC tracked files from 1 Git commit to another: + +`dvc diff {{revision1}} {{revision2}}` + +- Compare DVC tracked files, along with their latest hash: + +`dvc diff --show-hash {{commit}}` + +- Compare DVC tracked files, displaying the output as JSON: + +`dvc diff --show-json --show-hash {{commit}}` + +- Compare DVC tracked files, displaying the output as Markdown: + +`dvc diff --show-md --show-hash {{commit}}` diff --git a/dvc-fetch b/dvc-fetch new file mode 100644 index 00000000..125ee4ee --- /dev/null +++ b/dvc-fetch @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc fetch + +> Download DVC tracked files and directories from a remote repository. +> More information: . + +- Fetch the latest changes from the default remote upstream repository (if set): + +`dvc fetch` + +- Fetch changes from a specific remote upstream repository: + +`dvc fetch --remote {{remote_name}}` + +- Fetch the latest changes for a specific target/s: + +`dvc fetch {{target/s}}` + +- Fetch changes for all branch and tags: + +`dvc fetch --all-branches --all-tags` + +- Fetch changes for all commits: + +`dvc fetch --all-commits` diff --git a/dvc-freeze b/dvc-freeze new file mode 100644 index 00000000..7e6c1be5 --- /dev/null +++ b/dvc-freeze @@ -0,0 +1,15 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc freeze + +> Freeze stages in the DVC pipeline. +> This prevents DVC from tracking changes in stage dependencies and re-execution until unfreeze. +> See also `dvs unfreeze`. +> More information: . + +- Freeze one or more specified stages: + +`dvc freeze {{stage_name1 stage_name2 ...}}` diff --git a/dvc-gc b/dvc-gc new file mode 100644 index 00000000..13fd6e42 --- /dev/null +++ b/dvc-gc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc gc + +> Remove unused files and directories from the cache or remote storage. +> More information: . + +- Garbage collect from the cache, keeping only versions referenced by the current workspace: + +`dvc gc --workspace` + +- Garbage collect from the cache, keeping only versions referenced by branch, tags, and commits: + +`dvc gc --all-branches --all-tags --all-commits` + +- Garbage collect from the cache, including the default cloud remote storage (if set): + +`dvc gc --all-commits --cloud` + +- Garbage collect from the cache, including a specific cloud remote storage: + +`dvc gc --all-commits --cloud --remote {{remote_name}}` diff --git a/dvc-init b/dvc-init new file mode 100644 index 00000000..31dc6fab --- /dev/null +++ b/dvc-init @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc init + +> Initialize a new local DVC repository. +> More information: . + +- Initialize a new local repository: + +`dvc init` + +- Initialize DVC without Git: + +`dvc init --no-scm` + +- Initialize DVC in a subdirectory: + +`cd {{path/to/subdir}} && dvc init --sudir` diff --git a/dvc-unfreeze b/dvc-unfreeze new file mode 100644 index 00000000..221b0bf8 --- /dev/null +++ b/dvc-unfreeze @@ -0,0 +1,15 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dvc unfreeze + +> Unfreeze stages in the DVC pipeline. +> This allows DVC to start tracking changes in stage dependencies again after they were frozen. +> See also `dvc freeze`. +> More information: . + +- Unfreeze one or more specified stages: + +`dvc unfreeze {{stage_name1 stage_name2 ...}}` diff --git a/dwebp b/dwebp new file mode 100644 index 00000000..be1aa4f5 --- /dev/null +++ b/dwebp @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# dwebp + +> `dwebp` decompresses WebP files into PNG, PAM, PPM or PGM images. +> Animated WebP files are not supported. +> More information: . + +- Convert a `webp` file into a `png` file: + +`dwebp {{path/to/input.webp}} -o {{path/to/output.png}}` + +- Convert a `webp` file into a specific filetype: + +`dwebp {{path/to/input.webp}} -bmp|-tiff|-pam|-ppm|-pgm|-yuv -o {{path/to/output}}` + +- Convert a `webp` file, using multi-threading if possible: + +`dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -mt` + +- Convert a `webp` file, but also crop and scale at the same time: + +`dwebp {{input.webp}} -o {{output.png}} -crop {{x_pos}} {{y_pos}} {{width}} {{height}} -scale {{width}} {{height}}` + +- Convert a `webp` file and flip the output: + +`dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -flip` + +- Convert a `webp` file and don't use in-loop filtering to speed up the decoding process: + +`dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -nofilter` diff --git a/ebook-convert b/ebook-convert new file mode 100644 index 00000000..e54dc6f7 --- /dev/null +++ b/ebook-convert @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ebook-convert + +> Can be used to convert e-books between common formats, e.g. PDF, EPUB and MOBI. +> Part of the Calibre e-book library tool. +> More information: . + +- Convert an e-book into another format: + +`ebook-convert {{path/to/input_file}} {{output_file}}` + +- Convert Markdown or HTML to e-book with TOC, title and author: + +`ebook-convert {{path/to/input_file}} {{output_file}} --level1-toc="//h:h1" --level2-toc="//h:h2" --level3-toc="//h:h3" --title={{title}} --authors={{author}}` diff --git a/echo b/echo new file mode 100644 index 00000000..47734a03 --- /dev/null +++ b/echo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# echo + +> Print given arguments. +> More information: . + +- Print a text message. Note: quotes are optional: + +`echo "{{Hello World}}"` + +- Print a message with environment variables: + +`echo "{{My path is $PATH}}"` + +- Print a message without the trailing newline: + +`echo -n "{{Hello World}}"` + +- Append a message to the file: + +`echo "{{Hello World}}" >> {{file.txt}}` + +- Enable interpretation of backslash escapes (special characters): + +`echo -e "{{Column 1 Column 2}}"` + +- Print the exit status of the last executed command (Note: In Windows Command Prompt and PowerShell the equivalent commands are `echo %errorlevel%` and `$lastexitcode` respectively): + +`echo $?` diff --git a/ect b/ect new file mode 100644 index 00000000..a0b2ca35 --- /dev/null +++ b/ect @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ect + +> Efficient Compression Tool. +> File optimizer written in C++. It supports `.png`, `.jpg`, `.gzip` and `.zip` files. +> More information: . + +- Compress a file: + +`ect {{path/to/file.png}}` + +- Compress a file with specified compression level and multithreading (1=Fastest (Worst), 9=Slowest (Best), default is 3): + +`ect -{{9}} --mt-deflate {{path/to/file.zip}}` + +- Compress all files in a directory recursively: + +`ect -recurse {{path/to/directory}}` + +- Compress a file, keeping the original modification time: + +`ect -keep {{path/to/file.png}}` + +- Compress a file, stripping metadata: + +`ect -strip {{path/to/file.png}}` diff --git a/ed b/ed new file mode 100644 index 00000000..13a4456b --- /dev/null +++ b/ed @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ed + +> The original Unix text editor. +> See also: `awk`, `sed`. +> More information: . + +- Start an interactive editor session with an empty document: + +`ed` + +- Start an interactive editor session with an empty document and a specific prompt: + +`ed --prompt='> '` + +- Start an interactive editor session with user-friendly errors: + +`ed --verbose` + +- Start an interactive editor session with an empty document and without diagnostics, byte counts and '!' prompt: + +`ed --quiet` + +- Start an interactive editor session without exit status change when command fails: + +`ed --loose-exit-status` + +- Edit a specific file (this shows the byte count of the loaded file): + +`ed {{path/to/file}}` + +- Replace a string with a specific replacement for all lines: + +`,s/{{regular_expression}}/{{replacement}}/g` diff --git a/edgepaint b/edgepaint new file mode 100644 index 00000000..2f2823c2 --- /dev/null +++ b/edgepaint @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# edgepaint + +> Colorize edges of a graph layout to clarify crossing edges. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Colorize edges of one or more graph layouts (that already have layout information) to clarify crossing edges: + +`edgepaint {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Colorize edges using a color scheme. (See ): + +`edgepaint -color-scheme={{accent7}} {{path/to/layout.gv}} > {{path/to/output.gv}}` + +- Lay out a graph and colorize its edges, then convert to a PNG image: + +`dot {{path/to/input.gv}} | edgepaint | dot -T {{png}} > {{path/to/output.png}}` + +- Display help: + +`edgepaint -?` diff --git a/eget b/eget new file mode 100644 index 00000000..a5c91fe5 --- /dev/null +++ b/eget @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eget + +> Easily install prebuilt binaries from GitHub. +> More information: . + +- Download a prebuilt binary for the current system from a repository on GitHub: + +`eget {{zyedidia/micro}}` + +- Download from a URL: + +`eget {{https://go.dev/dl/go1.17.5.linux-amd64.tar.gz}}` + +- Specify the location to place the downloaded files: + +`eget {{zyedidia/micro}} --to={{path/to/directory}}` + +- Specify a Git tag instead of using the latest version: + +`eget {{zyedidia/micro}} --tag={{v2.0.10}}` + +- Install the latest pre-release instead of the latest stable version: + +`eget {{zyedidia/micro}} --pre-release` + +- Only download the asset, skipping extraction: + +`eget {{zyedidia/micro}} --download-only` + +- Only download if there is a newer release then the currently downloaded version: + +`eget {{zyedidia/micro}} --upgrade-only` diff --git a/egrep b/egrep new file mode 100644 index 00000000..334e31ec --- /dev/null +++ b/egrep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# egrep + +> Find patterns in files using extended regular expression (supports `?`, `+`, `{}`, `()` and `|`). +> More information: . + +- Search for a pattern within a file: + +`egrep "{{search_pattern}}" {{path/to/file}}` + +- Search for a pattern within multiple files: + +`egrep "{{search_pattern}}" {{path/to/file1 path/to/file2 ...}}` + +- Search `stdin` for a pattern: + +`cat {{path/to/file}} | egrep {{search_pattern}}` + +- Print file name and line number for each match: + +`egrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` + +- Search for a pattern in all files recursively in a directory, ignoring binary files: + +`egrep --recursive --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` + +- Search for lines that do not match a pattern: + +`egrep --invert-match "{{search_pattern}}" {{path/to/file}}` diff --git a/eksctl b/eksctl new file mode 100644 index 00000000..3cfd95a6 --- /dev/null +++ b/eksctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eksctl + +> The official CLI for Amazon EKS. +> More information: . + +- Create a basic cluster: + +`eksctl create cluster` + +- List the details about a cluster or all of the clusters: + +`eksctl get cluster --name={{name}} --region={{region}}` + +- Create a cluster passing all configuration information in a file: + +`eksctl create cluster --config-file={{path/to/file}}` + +- Create a cluster using a configuration file and skip creating nodegroups until later: + +`eksctl create cluster --config-file= --without-nodegroup` + +- Delete a cluster: + +`eksctl delete cluster --name={{name}} --region={{region}}` + +- Create cluster and write cluster credentials to a file other than the default: + +`eksctl create cluster --name={{name}} --nodes={{4}} --kubeconfig={{path/to/config.yaml}}` + +- Create a cluster and prevent storing cluster credentials locally: + +`eksctl create cluster --name={{name}} --nodes={{4}} --write-kubeconfig=false` + +- Create a cluster and let `eksctl` manage cluster credentials under the `~/.kube/eksctl/clusters` directory: + +`eksctl create cluster --name={{name}} --nodes={{4}} --auto-kubeconfig` diff --git a/electron-packager b/electron-packager new file mode 100644 index 00000000..7a7f004f --- /dev/null +++ b/electron-packager @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# electron-packager + +> Build Electron app executables for Windows, Linux and macOS. +> Requires a valid package.json in the application directory. +> More information: . + +- Package an application for the current architecture and platform: + +`electron-packager "{{path/to/app}}" "{{app_name}}"` + +- Package an application for all architectures and platforms: + +`electron-packager "{{path/to/app}}" "{{app_name}}" --all` + +- Package an application for 64-bit Linux: + +`electron-packager "{{path/to/app}}" "{{app_name}}" --platform="{{linux}}" --arch="{{x64}}"` + +- Package an application for ARM macOS: + +`electron-packager "{{path/to/app}}" "{{app_name}}" --platform="{{darwin}}" --arch="{{arm64}}"` diff --git a/electrum b/electrum new file mode 100644 index 00000000..fb8248ee --- /dev/null +++ b/electrum @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# electrum + +> Ergonomic Bitcoin wallet and private key management. +> More information: . + +- Create a new wallet: + +`electrum -w {{new_wallet.dat}} create` + +- Restore an existing wallet from seed offline: + +`electrum -w {{recovery_wallet.dat}} restore -o` + +- Create a signed transaction offline: + +`electrum mktx {{recipient}} {{amount}} -f 0.0000001 -F {{from}} -o` + +- Display all wallet receiving addresses: + +`electrum listaddresses -a` + +- Sign a message: + +`electrum signmessage {{address}} {{message}}` + +- Verify a message: + +`electrum verifymessage {{address}} {{signature}} {{message}}` + +- Connect only to a specific electrum-server instance: + +`electrum -p socks5:{{127.0.0.1}}:9050 -s {{56ckl5obj37gypcu.onion}}:50001:t -1` diff --git a/elinks b/elinks new file mode 100644 index 00000000..aa59289c --- /dev/null +++ b/elinks @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# elinks + +> A text based browser similar to `lynx`. +> More information: . + +- Start ELinks: + +`elinks` + +- Quit elinks: + +` + C` + +- Dump output of webpage to console, colorizing the text with ANSI control codes: + +`elinks -dump -dump-color-mode {{1}} {{url}}` diff --git a/elixir b/elixir new file mode 100644 index 00000000..1a21df05 --- /dev/null +++ b/elixir @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# elixir + +> Elixir programming language interpreter. +> More information: . + +- Run an Elixir file: + +`elixir {{path/to/file}}` + +- Evaluate Elixir code by passing it as an argument: + +`elixir -e "{{code}}"` diff --git a/elm b/elm new file mode 100644 index 00000000..025017b4 --- /dev/null +++ b/elm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# elm + +> Compile and run Elm source files. +> More information: . + +- Initialize an Elm project, generates an elm.json file: + +`elm init` + +- Start interactive Elm shell: + +`elm repl` + +- Compile an Elm file, output the result to an `index.html` file: + +`elm make {{source}}` + +- Compile an Elm file, output the result to a JavaScript file: + +`elm make {{source}} --output={{destination}}.js` + +- Start local web server that compiles Elm files on page load: + +`elm reactor` + +- Install Elm package from : + +`elm install {{author}}/{{package}}` diff --git a/elvish b/elvish new file mode 100644 index 00000000..23f2c35e --- /dev/null +++ b/elvish @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# elvish + +> Expressive programming language and a versatile interactive shell. +> See also: `nu`. +> More information: . + +- Start an interactive shell session: + +`elvish` + +- Execute specific [c]ommands: + +`elvish -c "{{echo 'elvish is executed'}}"` + +- Execute a specific script: + +`elvish {{path/to/script.elv}}` diff --git a/emacs b/emacs new file mode 100644 index 00000000..3889b371 --- /dev/null +++ b/emacs @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# emacs + +> The extensible, customizable, self-documenting, real-time display editor. +> See also `emacsclient`. +> More information: . + +- Start Emacs and open a file: + +`emacs {{path/to/file}}` + +- Open a file at a specified line number: + +`emacs +{{line_number}} {{path/to/file}}` + +- Run an Emacs Lisp file as a script: + +`emacs --script {{path/to/file.el}}` + +- Start Emacs in console mode (without an X window): + +`emacs --no-window-system` + +- Start an Emacs server in the background (accessible via `emacsclient`): + +`emacs --daemon` + +- Stop a running Emacs server and all its instances, asking for confirmation on unsaved files: + +`emacsclient --eval '(save-buffers-kill-emacs)'` + +- Save a file in Emacs: + +` + X, + S` + +- Quit Emacs: + +` + X, + C` diff --git a/emacsclient b/emacsclient new file mode 100644 index 00000000..fdc809b4 --- /dev/null +++ b/emacsclient @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# emacsclient + +> Open files in an existing Emacs server. +> See also `emacs`. +> More information: . + +- Open a file in an existing Emacs server (using GUI if available): + +`emacsclient {{path/to/file}}` + +- Open a file in console mode (without an X window): + +`emacsclient --no-window-system {{path/to/file}}` + +- Open a file in a new Emacs window: + +`emacsclient --create-frame {{path/to/file}}` + +- Evaluate a command, printing the output to `stdout`, and then quit: + +`emacsclient --eval '({{command}})'` + +- Specify an alternative editor in case no Emacs server is running: + +`emacsclient --alternate-editor {{editor}} {{path/to/file}}` + +- Stop a running Emacs server and all its instances, asking for confirmation on unsaved files: + +`emacsclient --eval '(save-buffers-kill-emacs)'` diff --git a/ember b/ember new file mode 100644 index 00000000..d0c40909 --- /dev/null +++ b/ember @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ember + +> Ember CLI: create and manage Ember.js applications. +> More information: . + +- Create a new Ember application: + +`ember new {{my_new_app}}` + +- Create a new Ember addon: + +`ember addon {{my_new_addon}}` + +- Build the project: + +`ember build` + +- Build the project in production mode: + +`ember build -prod` + +- Run the development server: + +`ember serve` + +- Run the test suite: + +`ember test` + +- Run a blueprint to generate something like a route or component: + +`ember generate {{type}} {{name}}` + +- Install an ember-cli addon: + +`ember install {{name_of_addon}}` diff --git a/emulator b/emulator new file mode 100644 index 00000000..b072b010 --- /dev/null +++ b/emulator @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# emulator + +> Manage Android emulators. +> More information: . + +- Start an Android emulator device: + +`emulator -avd {{name}}` + +- Display the webcams on your development computer that are available for emulation: + +`emulator -avd {{name}} -webcam-list` + +- Start an emulator overriding the facing back camera setting (use `-camera-front` for front camera): + +`emulator -avd {{name}} -camera-back {{none|emulated|webcamN}}` + +- Start an emulator, with a maximum network speed: + +`emulator -avd {{name}} -netspeed {{gsm|hscsd|gprs|edge|hsdpa|lte|evdo|full}}` + +- Start an emulator with network latency: + +`emulator -avd {{name}} -netdelay {{gsm|hscsd|gprs|edge|hsdpa|lte|evdo|none}}` + +- Start an emulator, making all TCP connections through a specified HTTP/HTTPS proxy (port number is required): + +`emulator -avd {{name}} -http-proxy {{http://example.com:80}}` + +- Start an emulator with a given SD card partition image file: + +`emulator -avd {{name}} -sdcard {{path/to/sdcard.img}}` + +- Display help: + +`emulator -help` diff --git a/enca b/enca new file mode 100644 index 00000000..65dd0ee1 --- /dev/null +++ b/enca @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# enca + +> Detect and convert the encoding of text files. +> More information: . + +- Detect file(s) encoding according to the system's locale: + +`enca {{path/to/file1 path/to/file2 ...}}` + +- Detect file(s) encoding specifying a language in the POSIX/C locale format (e.g. zh_CN, en_US): + +`enca -L {{language}} {{path/to/file1 path/to/file2 ...}}` + +- Convert file(s) to a specific encoding: + +`enca -L {{language}} -x {{to_encoding}} {{path/to/file1 path/to/file2 ...}}` + +- Create a copy of an existing file using a different encoding: + +`enca -L {{language}} -x {{to_encoding}} < {{original_file}} > {{new_file}}` diff --git a/encfs b/encfs new file mode 100644 index 00000000..c0cd931d --- /dev/null +++ b/encfs @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# encfs + +> Mounts or creates encrypted virtual filesystems. +> See also `fusermount`, which can unmount filesystems mounted by this command. +> More information: . + +- Initialize or mount an encrypted filesystem: + +`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}}` + +- Run encfs in the foreground instead of spawning a daemon: + +`encfs -f {{/path/to/cipher_dir}} {{/path/to/mount_point}}` + +- Mount an encrypted snapshot of a plain directory: + +`encfs --reverse {{path/to/plain_dir}} {{path/to/cipher_dir}}` diff --git a/enscript b/enscript new file mode 100644 index 00000000..1f66b4fe --- /dev/null +++ b/enscript @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# enscript + +> Convert text files to PostScript, HTML, RTF, ANSI, and overstrikes. +> More information: . + +- Generate a PostScript file from a text file: + +`enscript {{path/to/input_file}} --output={{path/to/output_file}}` + +- Generate a file in a different language than PostScript: + +`enscript {{path/to/input_file}} --language={{html|rtf|...}} --output={{path/to/output_file}}` + +- Generate a PostScript file with a landscape layout, splitting the page into columns (maximum 9): + +`enscript {{path/to/input_file}} --columns={{num}} --landscape --output={{path/to/output_file}}` + +- Display available syntax highlighting languages and file formats: + +`enscript --help-highlight` + +- Generate a PostScript file with syntax highlighting and color for a specified language: + +`enscript {{path/to/input_file}} --color=1 --highlight={{language}} --output={{path/to/output_file}}` diff --git a/entr b/entr new file mode 100644 index 00000000..aedc1ba4 --- /dev/null +++ b/entr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# entr + +> Run arbitrary commands when files change. +> More information: . + +- Rebuild with `make` if any file in any subdirectory changes: + +`{{ag -l}} | entr {{make}}` + +- Rebuild and test with `make` if any `.c` source files in the current directory change: + +`{{ls *.c}} | entr {{'make && make test'}}` + +- Send a `SIGTERM` to any previously spawned ruby subprocesses before executing `ruby main.rb`: + +`{{ls *.rb}} | entr -r {{ruby main.rb}}` + +- Run a command with the changed file (`/_`) as an argument: + +`{{ls *.sql}} | entr {{psql -f}} /_` diff --git a/env b/env new file mode 100644 index 00000000..5af5804c --- /dev/null +++ b/env @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# env + +> Show the environment or run a program in a modified environment. +> More information: . + +- Show the environment: + +`env` + +- Run a program. Often used in scripts after the shebang (#!) for looking up the path to the program: + +`env {{program}}` + +- Clear the environment and run a program: + +`env -i {{program}}` + +- Remove variable from the environment and run a program: + +`env -u {{variable}} {{program}}` + +- Set a variable and run a program: + +`env {{variable}}={{value}} {{program}}` + +- Set one or more variables and run a program: + +`env {{variable1}}={{value}} {{variable2}}={{value}} {{variable3}}={{value}} {{program}}` diff --git a/envoy b/envoy new file mode 100644 index 00000000..c8e6c117 --- /dev/null +++ b/envoy @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# envoy + +> A PHP-based task manager for Laravel remote servers. +> More information: . + +- Initialize a configuration file: + +`envoy init {{host_name}}` + +- Run a task: + +`envoy run {{task_name}}` + +- Run a task from a specific project: + +`envoy run --path {{path/to/directory}} {{task_name}}` + +- Run a task and continue on failure: + +`envoy run --continue {{task_name}}` + +- Dump a task as a Bash script for inspection: + +`envoy run --pretend {{task_name}}` + +- Connect to the specified server via SSH: + +`envoy ssh {{server_name}}` diff --git a/envsubst b/envsubst new file mode 100644 index 00000000..60261bed --- /dev/null +++ b/envsubst @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# envsubst + +> Substitutes environment variables with their value in shell format strings. +> Variables to be replaced should be in either `${var}` or `$var` format. +> More information: . + +- Replace environment variables in `stdin` and output to `stdout`: + +`echo '{{$HOME}}' | envsubst` + +- Replace environment variables in an input file and output to `stdout`: + +`envsubst < {{path/to/input_file}}` + +- Replace environment variables in an input file and output to a file: + +`envsubst < {{path/to/input_file}} > {{path/to/output_file}}` + +- Replace environment variables in an input file from a space-separated list: + +`envsubst '{{$USER $SHELL $HOME}}' < {{path/to/input_file}}` diff --git a/eol b/eol new file mode 100644 index 00000000..fcb16cd1 --- /dev/null +++ b/eol @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eol + +> Show end-of-life dates (EoLs) for a number of products. +> More information: . + +- List all available products: + +`eol` + +- Get EoLs of one or more products: + +`eol {{product1 product2 ...}}` + +- Open the product webpage: + +`eol {{product}} --web` + +- Get EoLs of a one or more products in a specific format: + +`eol {{product1 product2 ...}} --format {{html|json|md|markdown|pretty|rst|csv|tsv|yaml}}` + +- Get EoLs of one or more products as a single markdown file: + +`eol {{product1 product2 ...}} --format {{markdown}} > {{eol_report.md}}` + +- Display help: + +`eol --help` diff --git a/eqn b/eqn new file mode 100644 index 00000000..ab8b3188 --- /dev/null +++ b/eqn @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eqn + +> Equation preprocessor for the groff (GNU Troff) document formatting system. +> See also `troff` and `groff`. +> More information: . + +- Process input with equations, saving the output for future typesetting with groff to PostScript: + +`eqn {{path/to/input.eqn}} > {{path/to/output.roff}}` + +- Typeset an input file with equations to PDF using the [me] macro package: + +`eqn -T {{pdf}} {{path/to/input.eqn}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}` diff --git a/erl b/erl new file mode 100644 index 00000000..49ed8da7 --- /dev/null +++ b/erl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# erl + +> Run and manage programs in the Erlang programming language. +> More information: . + +- Compile and run sequential Erlang program as a common script and then exit: + +`erlc {{path/to/file1 path/to/file2 ...}} && erl -noshell '{{mymodule:myfunction(arguments)}}, init:stop().'` + +- Connect to a running Erlang node: + +`erl -remsh {{nodename}}@{{hostname}} -sname {{custom_shortname}} -hidden -setcookie {{cookie_of_remote_node}}` + +- Tell the Erlang shell to load modules from a directory: + +`erl -pa {{path/to/directory_with_beam_files}}` diff --git a/ern b/ern new file mode 100644 index 00000000..64b85a0b --- /dev/null +++ b/ern @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ern + +> Electrode Native platform command-line client. +> More information: . + +- Create a new `ern` application (`MiniApp`): + +`ern create-miniapp {{application_name}}` + +- Run one or more `MiniApps` in the iOS/Android Runner application: + +`ern run-{{ios|android}}` + +- Create an Electrode Native container: + +`ern create-container --miniapps {{/path/to/miniapp_directory}} --platform {{ios|android}}` + +- Publish an Electrode Native container to a local Maven repository: + +`ern publish-container --publisher {{maven}} --platform {{android}} --extra {{'{"groupId":"com.walmart.ern","artifactId":"quickstart"}'}}` + +- Transform an iOS container into a pre-compiled binary framework: + +`ern transform-container --platform {{ios}} --transformer {{xcframework}}` + +- List all installed versions of Electrode Native: + +`ern platform versions` + +- Set a logging level: + +`ern platform config set logLevel {{trace|debug}}` diff --git a/errno b/errno new file mode 100644 index 00000000..19a059af --- /dev/null +++ b/errno @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# errno + +> Look up errno names and descriptions. +> More information: . + +- Lookup errno description by name or code: + +`errno {{name|code}}` + +- List all errno names, codes, and descriptions: + +`errno --list` + +- Search for code whose description contains all of the given text: + +`errno --search {{text}}` + +- Search for code whose description contains all of the given text (all locales): + +`errno --search-all-locales {{text}}` diff --git a/esbuild b/esbuild new file mode 100644 index 00000000..bf8f2686 --- /dev/null +++ b/esbuild @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# esbuild + +> JavaScript bundler and minifier built for speed. +> More information: . + +- Bundle a JavaScript application and print to `stdout`: + +`esbuild --bundle {{path/to/file.js}}` + +- Bundle a JSX application from `stdin`: + +`esbuild --bundle --outfile={{path/to/out.js}} < {{path/to/file.jsx}}` + +- Bundle and minify a JSX application with source maps in `production` mode: + +`esbuild --bundle --define:{{process.env.NODE_ENV=\"production\"}} --minify --sourcemap {{path/to/file.js}}` + +- Bundle a JSX application for a comma-separated list of browsers: + +`esbuild --bundle --minify --sourcemap --target={{chrome58,firefox57,safari11,edge16}} {{path/to/file.jsx}}` + +- Bundle a JavaScript application for a specific node version: + +`esbuild --bundle --platform={{node}} --target={{node12}} {{path/to/file.js}}` + +- Bundle a JavaScript application enabling JSX syntax in `.js` files: + +`esbuild --bundle app.js --loader:{{.js=jsx}} {{path/to/file.js}}` + +- Bundle and serve a JavaScript application on an HTTP server: + +`esbuild --bundle --serve={{port}} --outfile={{index.js}} {{path/to/file.js}}` + +- Bundle a list of files to an output directory: + +`esbuild --bundle --outdir={{path/to/output_directory}} {{path/to/file1 path/to/file2 ...}}` diff --git a/escp2topbm b/escp2topbm new file mode 100644 index 00000000..46b541f7 --- /dev/null +++ b/escp2topbm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# escp2topbm + +> Convert a PBM image to a ESC/P2 printer file. +> See also: `pbmtoescp2`. +> More information: . + +- Convert a ESC/P2 printer file to a PBM image: + +`escp2topbm {{path/to/image.escp2}} > {{path/to/output.pbm}}` diff --git a/eslint b/eslint new file mode 100644 index 00000000..aa8f6e22 --- /dev/null +++ b/eslint @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eslint + +> A pluggable linting utility for JavaScript and JSX. +> More information: . + +- Create the ESLint configuration file: + +`eslint --init` + +- Lint one or more files: + +`eslint {{path/to/file1.js path/to/file2.js ...}}` + +- Fix lint issues: + +`eslint --fix` + +- Lint using the specified configuration file: + +`eslint -c {{path/to/config_file}} {{path/to/file1.js path/to/file2.js}}` diff --git a/espanso b/espanso new file mode 100644 index 00000000..cb5c8eeb --- /dev/null +++ b/espanso @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# espanso + +> Cross-platform Text Expander written in Rust. +> More information: . + +- Check status: + +`espanso status` + +- Edit the configuration: + +`espanso edit config` + +- Install a package from the hub store (): + +`espanso install {{package}}` + +- Restart (required after installing a package, useful in case of failure): + +`espanso restart` diff --git a/espeak b/espeak new file mode 100644 index 00000000..53f0fd2f --- /dev/null +++ b/espeak @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# espeak + +> Uses text-to-speech to speak through the default sound device. +> More information: . + +- Speak a phrase aloud: + +`espeak "I like to ride my bike."` + +- Speak a file aloud: + +`espeak -f {{path/to/file}}` + +- Save output to a WAV audio file, rather than speaking it directly: + +`espeak -w {{filename.wav}} "It's GNU plus Linux"` + +- Use a different voice: + +`espeak -v {{voice}}` diff --git a/esptool.py b/esptool.py new file mode 100644 index 00000000..664b5f5d --- /dev/null +++ b/esptool.py @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# esptool.py + +> Bootloader utility for Espressif chips (e.g. ESP8266). +> More information: . + +- Flash a firmware file to an ESP chip with a given port and baud rate: + +`sudo esptool.py --port {{port}} --baud {{baud_rate}} write_flash 0x0 {{path/to/firmware.bin}}` + +- Clear the flash of an ESP chip: + +`sudo esptool.py --port {{port}} --baud {{baud_rate}} erase_flash` diff --git a/etcd b/etcd new file mode 100644 index 00000000..dfb977cb --- /dev/null +++ b/etcd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# etcd + +> A distributed, reliable key-value store for the most critical data of a distributed system. +> More information: . + +- Start a single-node etcd cluster: + +`etcd` + +- Start a single-node etcd cluster, listening for client requests on a custom URL: + +`etcd --advertise-client-urls {{http://127.0.0.1:1234}} --listen-client-urls {{http://127.0.0.1:1234}}` + +- Start a single-node etcd cluster with a custom name: + +`etcd --name {{my_etcd_cluster}}` + +- Start a single-node etcd cluster with extensive metrics available at : + +`etcd --enable-pprof --metrics extensive` diff --git a/etcdctl b/etcdctl new file mode 100644 index 00000000..8c2e35a4 --- /dev/null +++ b/etcdctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# etcdctl + +> Interact with `etcd`, a highly-available key-value pair store. +> More information: . + +- Display the value associated with a specified key: + +`etcdctl get {{my/key}}` + +- Store a key-value pair: + +`etcdctl put {{my/key}} {{my_value}}` + +- Delete a key-value pair: + +`etcdctl del {{my/key}}` + +- Store a key-value pair, reading the value from a file: + +`etcdctl put {{my/file}} < {{path/to/file.txt}}` + +- Save a snapshot of the etcd keystore: + +`etcdctl snapshot save {{path/to/snapshot.db}}` + +- Restore a snapshot of an etcd keystore (restart the etcd server afterwards): + +`etcdctl snapshot restore {{path/to/snapshot.db}}` + +- Add a user: + +`etcdctl user add {{my_user}}` + +- Watch a key for changes: + +`etcdctl watch {{my/key}}` diff --git a/eva b/eva new file mode 100644 index 00000000..e937d610 --- /dev/null +++ b/eva @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eva + +> Simple calculator REPL, similar to `bc`, with syntax highlighting and persistent history. +> More information: . + +- Run the calculator in interactive mode: + +`eva` + +- Calculate the result of an expression: + +`eva "{{(1 + 2) * 2 ^ 2}}"` + +- Calculate an expression forcing the number of decimal places to 5: + +`eva --fix {{5}} "{{5 / 3}}"` + +- Calculate an expression with sine and cosine: + +`eva "{{sin(1) + cos(1)}}"` diff --git a/eval b/eval new file mode 100644 index 00000000..0f0b4ccf --- /dev/null +++ b/eval @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eval + +> Execute arguments as a single command in the current shell and return its result. +> More information: . + +- Call `echo` with the "foo" argument: + +`eval "{{echo foo}}"` + +- Set a variable in the current shell: + +`eval "{{foo=bar}}"` diff --git a/evil-winrm b/evil-winrm new file mode 100644 index 00000000..76c73577 --- /dev/null +++ b/evil-winrm @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# evil-winrm + +> Windows Remote Management (WinRM) shell for pentesting. +> Once connected, we get a PowerShell prompt on the target host. +> More information: . + +- Connect to a host: + +`evil-winrm --ip {{ip}} --user {{user}} --password {{password}}` + +- Connect to a host, passing the password hash: + +`evil-winrm --ip {{ip}} --user {{user}} --hash {{nt_hash}}` + +- Connect to a host, specifying directories for scripts and executables: + +`evil-winrm --ip {{ip}} --user {{user}} --password {{password}} --scripts {{path/to/scripts}} --executables {{path/to/executables}}` + +- Connect to a host, using SSL: + +`evil-winrm --ip {{ip}} --user {{user}} --password {{password}} --ssl --pub-key {{path/to/pubkey}} --priv-key {{path/to/privkey}}` + +- Upload a file to the host: + +`PS > upload {{path/to/local/file}} {{path/to/remote/file}}` + +- List all loaded PowerShell functions: + +`PS > menu` + +- Load a PowerShell script from the `--scripts` directory: + +`PS > {{script.ps1}}` + +- Invoke a binary on the host from the `--executables` directory: + +`PS > Invoke-Binary {{binary.exe}}` diff --git a/ex b/ex new file mode 100644 index 00000000..d08d5e73 --- /dev/null +++ b/ex @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ex + +> Command-line text editor. +> See also: `vim`. +> More information: . + +- Open a file: + +`ex {{path/to/file}}` + +- Save and Quit: + +`wq` + +- Undo the last operation: + +`undo` + +- Search for a pattern in the file: + +`/{{search_pattern}}` + +- Perform a regular expression substitution in the whole file: + +`%s/{{regular_expression}}/{{replacement}}/g` + +- Insert text: + +`i{{text}}` + +- Switch to Vim: + +`visual` diff --git a/exa b/exa new file mode 100644 index 00000000..feea15b9 --- /dev/null +++ b/exa @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exa + +> A modern replacement for `ls` (List directory contents). +> More information: . + +- List files one per line: + +`exa --oneline` + +- List all files, including hidden files: + +`exa --all` + +- Long format list (permissions, ownership, size and modification date) of all files: + +`exa --long --all` + +- List files with the largest at the top: + +`exa --reverse --sort={{size}}` + +- Display a tree of files, three levels deep: + +`exa --long --tree --level={{3}}` + +- List files sorted by modification date (oldest first): + +`exa --long --sort={{modified}}` + +- List files with their headers, icons, and Git statuses: + +`exa --long --header --icons --git` + +- Don't list files mentioned in `.gitignore`: + +`exa --git-ignore` diff --git a/exec b/exec new file mode 100644 index 00000000..83e0ecfb --- /dev/null +++ b/exec @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exec + +> Execute a command without creating a child process. +> More information: . + +- Execute a specific command using the current environment variables: + +`exec {{command -with -flags}}` diff --git a/exenv b/exenv new file mode 100644 index 00000000..836640ac --- /dev/null +++ b/exenv @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exenv + +> Easily install Elixir versions and manage application environments. +> More information: . + +- Display a list of installed versions: + +`exenv versions` + +- Use a specific version of Elixir across the whole system: + +`exenv global {{version}}` + +- Use a specific version of Elixir for the current application/project directory: + +`exenv local {{version}}` + +- Show the currently selected Elixir version: + +`exenv {{version}}` + +- Install a version of Elixir (requires `elixir-build` plugin ): + +`exenv install {{version}}` diff --git a/exercism b/exercism new file mode 100644 index 00000000..2a8a2a57 --- /dev/null +++ b/exercism @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exercism + +> Download and solve problems. +> More information: . + +- Configure the application token and the preferred workspace for Exercism: + +`exercism configure --token={{your-application-token}} --workspace={{/path/to/preferred/workspace}}` + +- Download a specific exercise: + +`exercism download --exercise={{exercise_slug}} --track={{track_slug}}` + +- Submit an exercise: + +`exercism submit {{path/to/file}}` + +- Print the path to the solution workspace: + +`exercism workspace` diff --git a/exfatlabel b/exfatlabel new file mode 100644 index 00000000..c0aabf12 --- /dev/null +++ b/exfatlabel @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exfatlabel + +> Get or set an exFAT filesystem label. +> More information: . + +- Display the current filesystem label: + +`exfatlabel {{/dev/sda}}` + +- Set the filesystem label: + +`exfatlabel {{/dev/sda}} {{new_label}}` diff --git a/exiftool b/exiftool new file mode 100644 index 00000000..714bbfb1 --- /dev/null +++ b/exiftool @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exiftool + +> Read and write meta information in files. +> More information: . + +- Print the EXIF metadata for a given file: + +`exiftool {{path/to/file}}` + +- Remove all EXIF metadata from the given files: + +`exiftool -All= {{path/to/file1 path/to/file2 ...}}` + +- Remove GPS EXIF metadata from given image files: + +`exiftool "-gps*=" {{path/to/image1 path/to/image2 ...}}` + +- Remove all EXIF metadata from the given image files, then re-add metadata for color and orientation: + +`exiftool -All= -tagsfromfile @ -colorspacetags -orientation {{path/to/image1 path/to/image2 ...}}` + +- Move the date at which all photos in a directory were taken 1 hour forward: + +`exiftool "-AllDates+=0:0:0 1:0:0" {{path/to/directory}}` + +- Move the date at which all JPEG photos in the current directory were taken 1 day and 2 hours backward: + +`exiftool "-AllDates-=0:0:1 2:0:0" -ext jpg` + +- Only change the `DateTimeOriginal` field subtracting 1.5 hours, without keeping backups: + +`exiftool -DateTimeOriginal-=1.5 -overwrite_original` + +- Recursively rename all JPEG photos in a directory based on the `DateTimeOriginal` field: + +`exiftool '-filename Exit the shell. +> More information: . + +- Exit with the exit status of the most recently executed command: + +`exit` + +- Exit with a specific exit status: + +`exit {{exit_code}}` diff --git a/exiv2 b/exiv2 new file mode 100644 index 00000000..0125e363 --- /dev/null +++ b/exiv2 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exiv2 + +> Image metadata manipulation tool. +> More information: . + +- Print a summary of the image Exif metadata: + +`exiv2 {{path/to/file}}` + +- Print all metadata (Exif, IPTC, XMP) with interpreted values: + +`exiv2 -P kt {{path/to/file}}` + +- Print all metadata with raw values: + +`exiv2 -P kv {{path/to/file}}` + +- Delete all metadata from an image: + +`exiv2 -d a {{path/to/file}}` + +- Delete all metadata, preserving the file timestamp: + +`exiv2 -d a -k {{path/to/file}}` + +- Rename the file, prepending the date and time from metadata (not from the file timestamp): + +`exiv2 -r {{'%Y%m%d_%H%M%S_:basename:'}} {{path/to/file}}` diff --git a/expand b/expand new file mode 100644 index 00000000..2553d565 --- /dev/null +++ b/expand @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# expand + +> Convert tabs to spaces. +> More information: . + +- Convert tabs in each file to spaces, writing to `stdout`: + +`expand {{path/to/file}}` + +- Convert tabs to spaces, reading from `stdin`: + +`expand` + +- Do not convert tabs after non blanks: + +`expand -i {{path/to/file}}` + +- Have tabs a certain number of characters apart, not 8: + +`expand -t={{number}} {{path/to/file}}` + +- Use a comma separated list of explicit tab positions: + +`expand -t={{1,4,6}}` diff --git a/export b/export new file mode 100644 index 00000000..d1000d75 --- /dev/null +++ b/export @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# export + +> Export shell variables to child processes. +> More information: . + +- Set an environment variable: + +`export {{VARIABLE}}={{value}}` + +- Append a pathname to the environment variable `PATH`: + +`export PATH=$PATH:{{path/to/append}}` diff --git a/expose b/expose new file mode 100644 index 00000000..31a4e07f --- /dev/null +++ b/expose @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# expose + +> An open source tunnel application for sharing websites. +> More information: . + +- Register your authentication token: + +`expose token {{token}}` + +- Share the current working directory: + +`expose` + +- Share the current working directory with a specific subdomain: + +`expose --subdomain={{subdomain}}` + +- Share a local URL: + +`expose share {{url}}` + +- Run the Expose server: + +`expose serve` + +- Run the Expose server with a specific hostname: + +`expose serve {{hostname}}` diff --git a/expr b/expr new file mode 100644 index 00000000..f8c8bfd6 --- /dev/null +++ b/expr @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# expr + +> Evaluate expressions and manipulate strings. +> More information: . + +- Get the length of a specific string: + +`expr length "{{string}}"` + +- Get the substring of a string with a specific length: + +`expr substr "{{string}}" {{from}} {{length}}` + +- Match a specific substring against an anchored pattern: + +`expr match "{{string}}" '{{pattern}}'` + +- Get the first char position from a specific set in a string: + +`expr index "{{string}}" "{{chars}}"` + +- Calculate a specific mathematic expression: + +`expr {{expression1}} {{+|-|*|/|%}} {{expression2}}` + +- Get the first expression if its value is non-zero and not null otherwise get the second one: + +`expr {{expression1}} \| {{expression2}}` + +- Get the first expression if both expressions are non-zero and not null otherwise get zero: + +`expr {{expression1}} \& {{expression2}}` diff --git a/exrex b/exrex new file mode 100644 index 00000000..5bed492f --- /dev/null +++ b/exrex @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# exrex + +> Generate all/random matching strings for a regular expression. +> It can also simplify regular expressions. +> More information: . + +- Generate all possible strings that match a regular expression: + +`exrex '{{regular_expression}}'` + +- Generate a random string that matches a regular expression: + +`exrex --random '{{regular_expression}}'` + +- Generate at most 100 strings that match a regular expression: + +`exrex --max-number {{100}} '{{regular_expression}}'` + +- Generate all possible strings that match a regular expression, joined by a custom delimiter string: + +`exrex --delimiter "{{, }}" '{{regular_expression}}'` + +- Print count of all possible strings that match a regular expression: + +`exrex --count '{{regular_expression}}'` + +- Simplify a regular expression: + +`exrex --simplify '{{ab|ac}}'` + +- Print eyes: + +`exrex '{{[oO0](_)[oO0]}}'` + +- Print a boat: + +`exrex '{{( {20}(\| *\|-{22}|\|)|\.={50}| ( ){0,5}\\.| {12}~{39})}}'` diff --git a/eyuvtoppm b/eyuvtoppm new file mode 100644 index 00000000..511d9fce --- /dev/null +++ b/eyuvtoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eyuvtoppm + +> Convert a Berkeley YUV file to PPM. +> More information: . + +- Read a Berkeley YUV file from the specified input file, convert it to a PPM image and store it in the specified output file: + +`eyuvtoppm --width {{width}} --height {{height}} {{path/to/input_file.eyuv}} > {{path/to/output_file.ppm}}` diff --git a/eza b/eza new file mode 100644 index 00000000..0faa1697 --- /dev/null +++ b/eza @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# eza + +> Modern, maintained replacement for `ls`, built on `exa`. +> More information: . + +- List files one per line: + +`eza --oneline` + +- List all files, including hidden files: + +`eza --all` + +- Long format list (permissions, ownership, size and modification date) of all files: + +`eza --long --all` + +- List files with the largest at the top: + +`eza --reverse --sort={{size}}` + +- Display a tree of files, three levels deep: + +`eza --long --tree --level={{3}}` + +- List files sorted by modification date (oldest first): + +`eza --long --sort={{modified}}` + +- List files with their headers, icons, and Git statuses: + +`eza --long --header --icons --git` + +- Don't list files mentioned in `.gitignore`: + +`eza --git-ignore` diff --git a/f3fix b/f3fix new file mode 100644 index 00000000..d7e3aecb --- /dev/null +++ b/f3fix @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# f3fix + +> Edit the partition table of a fake flash drive. +> See also: `f3probe`, `f3write`, `f3read`. +> More information: . + +- Fill a fake flash drive with a single partition that matches its real capacity: + +`sudo f3fix {{/dev/device_name}}` + +- Mark the partition as bootable: + +`sudo f3fix --boot {{/dev/device_name}}` + +- Specify the filesystem: + +`sudo f3fix --fs-type={{filesystem_type}} {{/dev/device_name}}` diff --git a/f3probe b/f3probe new file mode 100644 index 00000000..2a93c417 --- /dev/null +++ b/f3probe @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# f3probe + +> Probe a block device (e.g. a flash drive or a microSD card) for counterfeit flash memory. +> See also: `f3read`, `f3write`, `f3fix`. +> More information: . + +- Probe a block device: + +`sudo f3probe {{path/to/block_device}}` + +- Use the minimum about of RAM possible: + +`sudo f3probe --min-memory {{path/to/block_device}}` + +- Time disk operations: + +`sudo f3probe --time-ops {{path/to/block_device}}` diff --git a/f3read b/f3read new file mode 100644 index 00000000..bf1b6a3f --- /dev/null +++ b/f3read @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# f3read + +> Validate .h2w files to test the real capacity of the drive. +> See also: `f3write`, `f3probe`, `f3fix`. +> More information: . + +- Validate a device by checking the files in a given directory: + +`f3read {{path/to/mount_point}}` diff --git a/f3write b/f3write new file mode 100644 index 00000000..5f303c05 --- /dev/null +++ b/f3write @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# f3write + +> Fill a drive out with .h2w files to test its real capacity. +> See also: `f3read`, `f3probe`, `f3fix`. +> More information: . + +- Write test files to a given directory, filling the drive: + +`f3write {{path/to/mount_point}}` + +- Limit the write speed: + +`f3write --max-write-rate={{kb_per_second}} {{path/to/mount_point}}` diff --git a/factor b/factor new file mode 100644 index 00000000..32debe2c --- /dev/null +++ b/factor @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# factor + +> Prints the prime factorization of a number. +> More information: . + +- Display the prime-factorization of a number: + +`factor {{number}}` + +- Take the input from `stdin` if no argument is specified: + +`echo {{number}} | factor` diff --git a/fakedata b/fakedata new file mode 100644 index 00000000..a7683199 --- /dev/null +++ b/fakedata @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fakedata + +> Generate fake data using a large variety of generators. +> More information: . + +- List all valid generators: + +`fakedata --generators` + +- Generate data using one or more generators: + +`fakedata {{generator1}} {{generator2}}` + +- Generate data with a specific output format: + +`fakedata --format {{csv|tab|sql}} {{generator}}` + +- Generate a given number of data items (defaults to 10): + +`fakedata --limit {{n}} {{generator}}` + +- Generate data using a custom output template (the first letter of generator names must be capitalized): + +`echo "{{\{\{Generator\}\}}}" | fakedata` diff --git a/false b/false new file mode 100644 index 00000000..18354014 --- /dev/null +++ b/false @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# false + +> Returns a non-zero exit code. +> More information: . + +- Return a non-zero exit code: + +`false` diff --git a/fast b/fast new file mode 100644 index 00000000..608e54a9 --- /dev/null +++ b/fast @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fast + +> Test your download and upload speed using fast.com. +> More information: . + +- Measure the current download speed: + +`fast` + +- Measure the current upload speed in addition to download speed: + +`fast --upload` + +- Display results on a single line to reduce spacing: + +`fast --single-line` diff --git a/fastboot b/fastboot new file mode 100644 index 00000000..e9355c54 --- /dev/null +++ b/fastboot @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fastboot + +> Communicate with connected Android devices when in bootloader mode (the one place `adb` doesn't work). +> More information: . + +- Unlock the bootloader: + +`fastboot oem unlock` + +- Relock the bootloader: + +`fastboot oem lock` + +- Reboot the device from fastboot mode into fastboot mode again: + +`fastboot reboot bootloader` + +- Flash a given image: + +`fastboot flash {{path/to/file.img}}` + +- Flash a custom recovery image: + +`fastboot flash recovery {{path/to/file.img}}` + +- Display connected devices: + +`fastboot devices` + +- Display all information of a device: + +`fastboot getvar all` diff --git a/fastd b/fastd new file mode 100644 index 00000000..a8d5433c --- /dev/null +++ b/fastd @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fastd + +> VPN daemon. +> Works on Layer 2 or Layer 3, supports different encryption methods, used by Freifunk. +> More information: . + +- Start `fastd` with a specific configuration file: + +`fastd --config {{path/to/fastd.conf}}` + +- Start a Layer 3 VPN with an MTU of 1400, loading the rest of the configuration parameters from a file: + +`fastd --mode {{tap}} --mtu {{1400}} --config {{path/to/fastd.conf}}` + +- Validate a configuration file: + +`fastd --verify-config --config {{path/to/fastd.conf}}` + +- Generate a new key: + +`fastd --generate-key` + +- Show the public key to a private key in a configuration file: + +`fastd --show-key --config {{path/to/fastd.conf}}` + +- Show the current version: + +`fastd -v` diff --git a/fastfetch b/fastfetch new file mode 100644 index 00000000..1318a369 --- /dev/null +++ b/fastfetch @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fastfetch + +> Display information about your operating system, software and hardware. +> More information: . + +- Display system information: + +`fastfetch` + +- Fetch a specific structure: + +`fastfetch --structure {{structure}}` + +- Load a custom configuration file: + +`fastfetch --load-config {{path/to/config_file}}` + +- Use a specific logo: + +`fastfetch --logo {{logo}}` + +- Use a specific color for the keys and title: + +`fastfetch --color {{blue}}` diff --git a/fastlane b/fastlane new file mode 100644 index 00000000..d5e9dcf1 --- /dev/null +++ b/fastlane @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fastlane + +> Build and release mobile applications. +> More information: . + +- Build and sign the iOS application in the current directory: + +`fastlane run build_app` + +- Run `pod install` for the project in the current directory: + +`fastlane run cocoapods` + +- Delete the derived data from Xcode: + +`fastlane run clear_derived_data` + +- Remove the cache for pods: + +`fastlane run clean_cocoapods_cache` diff --git a/fastmod b/fastmod new file mode 100644 index 00000000..73f018d6 --- /dev/null +++ b/fastmod @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fastmod + +> A fast partial replacement for the codemod tool, replace and replace all in the whole codebase. +> Regexes are matched by Rust regex crate. +> More information: . + +- Replace a regex pattern in all files of the current directory, ignoring files on .ignore and .gitignore: + +`fastmod {{regex_pattern}} {{replacement}}` + +- Replace a regex pattern in case-insensitive mode in specific files or directories: + +`fastmod --ignore-case {{regex_pattern}} {{replacement}} -- {{path/to/file path/to/directory ...}}` + +- Replace a regex pattern in a specific directory in files filtered with a case-insensitive glob pattern: + +`fastmod {{regex}} {{replacement}} --dir {{path/to/directory}} --iglob {{'**/*.{js,json}'}}` + +- Replace for an exact string in .js or .json files: + +`fastmod --fixed-strings {{exact_string}} {{replacement}} --extensions {{json,js}}` + +- Replace for an exact string without prompt for a confirmation (disables regular expressions): + +`fastmod --accept-all --fixed-strings {{exact_string}} {{replacement}}` + +- Replace for an exact string without prompt for a confirmation, printing changed files: + +`fastmod --accept-all --print-changed-files --fixed-strings {{exact_string}} {{replacement}}` diff --git a/fc b/fc new file mode 100644 index 00000000..763c95a3 --- /dev/null +++ b/fc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fc + +> Open the most recent command and edit it. +> More information: . + +- Open in the default system editor: + +`fc` + +- Specify an editor to open with: + +`fc -e {{'emacs'}}` + +- List recent commands from history: + +`fc -l` + +- List recent commands in reverse order: + +`fc -l -r` + +- List commands in a given interval: + +`fc '{{416}}' '{{420}}'` diff --git a/fc-cache b/fc-cache new file mode 100644 index 00000000..3c262140 --- /dev/null +++ b/fc-cache @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fc-cache + +> Scan font directories to build font cache files. +> More information: . + +- Generate font cache files: + +`fc-cache` + +- Force a rebuild of all font cache files, without checking if cache is up-to-date: + +`fc-cache -f` + +- Erase font cache files, then generate new font cache files: + +`fc-cache -r` diff --git a/fc-list b/fc-list new file mode 100644 index 00000000..7978eee3 --- /dev/null +++ b/fc-list @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fc-list + +> List available fonts installed on the system. +> More information: . + +- Return a list of installed fonts in your system: + +`fc-list` + +- Return a list of installed fonts with given name: + +`fc-list | grep '{{DejaVu Serif}}'` + +- Return the number of installed fonts in your system: + +`fc-list | wc -l` diff --git a/fc-match b/fc-match new file mode 100644 index 00000000..5bc4fbe6 --- /dev/null +++ b/fc-match @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fc-match + +> Match available fonts. +> More information: . + +- Return a sorted list of best matching fonts: + +`fc-match -s '{{DejaVu Serif}}'` diff --git a/fc-pattern b/fc-pattern new file mode 100644 index 00000000..b2bc6767 --- /dev/null +++ b/fc-pattern @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fc-pattern + +> Shows information about a font matching a pattern. +> More information: . + +- Display default information about a font: + +`fc-pattern --default '{{DejaVu Serif}}'` + +- Display configuration information about a font: + +`fc-pattern --config '{{DejaVu Serif}}'` diff --git a/fd b/fd new file mode 100644 index 00000000..bfbcd929 --- /dev/null +++ b/fd @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fd + +> An alternative to `find`. +> Aims to be faster and easier to use than `find`. +> More information: . + +- Recursively find files matching a specific pattern in the current directory: + +`fd "{{string|regex}}"` + +- Find files that begin with `foo`: + +`fd "^foo"` + +- Find files with a specific extension: + +`fd --extension txt` + +- Find files in a specific directory: + +`fd "{{string|regex}}" {{path/to/directory}}` + +- Include ignored and hidden files in the search: + +`fd --hidden --no-ignore "{{string|regex}}"` + +- Execute a command on each search result returned: + +`fd "{{string|regex}}" --exec {{command}}` diff --git a/fdp b/fdp new file mode 100644 index 00000000..2cf23331 --- /dev/null +++ b/fdp @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fdp + +> Render an image of a `force-directed` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`fdp -T png -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`fdp -T svg -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in a specific format: + +`fdp -T {{ps|pdf|svg|fig|png|gif|jpg|json|dot}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | fdp -T gif > {{path/to/image.gif}}` + +- Display help: + +`fdp -?` diff --git a/fdroid b/fdroid new file mode 100644 index 00000000..0bcd1792 --- /dev/null +++ b/fdroid @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fdroid + +> F-Droid build tool. +> F-Droid is an installable catalog of FOSS (Free and Open Source Software) applications for the Android platform. +> More information: . + +- Build a specific app: + +`fdroid build {{app_id}}` + +- Build a specific app in a build server VM: + +`fdroid build {{app_id}} --server` + +- Publish the app to the local repository: + +`fdroid publish {{app_id}}` + +- Install the app on every connected device: + +`fdroid install {{app_id}}` + +- Check if the metadata is formatted correctly: + +`fdroid lint --format {{app_id}}` + +- Fix the formatting automatically (if possible): + +`fdroid rewritemeta {{app_id}}` diff --git a/fdroidcl b/fdroidcl new file mode 100644 index 00000000..85ee8f57 --- /dev/null +++ b/fdroidcl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fdroidcl + +> F-Droid CLI client. +> More information: . + +- Fetch the F-Droid index: + +`fdroidcl update` + +- Display info about an app: + +`fdroidcl show {{app_id}}` + +- Download an APK file: + +`fdroidcl download {{app_id}}` + +- Search for an app in the index: + +`fdroidcl search {{search_pattern}}` + +- Install an app on a connected device: + +`fdroidcl install {{app_id}}` diff --git a/fdupes b/fdupes new file mode 100644 index 00000000..68fdb6ed --- /dev/null +++ b/fdupes @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fdupes + +> Finds duplicate files in a set of directories. +> More information: . + +- Search a single directory: + +`fdupes {{path/to/directory}}` + +- Search multiple directories: + +`fdupes {{directory1}} {{directory2}}` + +- Search a directory recursively: + +`fdupes -r {{path/to/directory}}` + +- Search multiple directories, one recursively: + +`fdupes {{directory1}} -R {{directory2}}` + +- Search recursively and replace duplicates with hardlinks: + +`fdupes -rH {{path/to/directory}}` + +- Search recursively for duplicates and display interactive prompt to pick which ones to keep, deleting the others: + +`fdupes -rd {{path/to/directory}}` + +- Search recursively and delete duplicates without prompting: + +`fdupes -rdN {{path/to/directory}}` diff --git a/feh b/feh new file mode 100644 index 00000000..16065684 --- /dev/null +++ b/feh @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# feh + +> Lightweight image viewing utility. +> More information: . + +- View images locally or using a URL: + +`feh {{path/to/images}}` + +- View images recursively: + +`feh --recursive {{path/to/images}}` + +- View images without window borders: + +`feh --borderless {{path/to/images}}` + +- Exit after the last image: + +`feh --cycle-once {{path/to/images}}` + +- Use a specific slideshow cycle delay: + +`feh --slideshow-delay {{seconds}} {{path/to/images}}` + +- Use a specific wallpaper mode (centered, filled, maximized, scaled or tiled): + +`feh --bg-{{center|fill|max|scale|tile}} {{path/to/image}}` + +- Create a montage of all images within a directory, outputting as a new image: + +`feh --montage --thumb-height {{150}} --thumb-width {{150}} --index-info "{{%nn%wx%h}}" --output {{path/to/montage_image.png}}` diff --git a/feroxbuster b/feroxbuster new file mode 100644 index 00000000..8a748365 --- /dev/null +++ b/feroxbuster @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# feroxbuster + +> Simple, fast, recursive content discovery tool written in Rust. +> Used to brute-force hidden paths on web servers and more. +> More information: . + +- Discover specific directories and files that match in the wordlist with extensions and 100 threads and a random user-agent: + +`feroxbuster --url "{{https://example.com}}" --wordlist {{path/to/file}} --threads {{100}} --extensions "{{php,txt}}" --random-agent` + +- Enumerate directories without recursion through a specific proxy: + +`feroxbuster --url "{{https://example.com}}" --wordlist {{path/to/file}} --no-recursion --proxy "{{http://127.0.0.1:8080}}"` + +- Find links in webpages: + +`feroxbuster --url "{{https://example.com}}" --extract-links` + +- Filter by a specific status code and a number of chars: + +`feroxbuster --url "{{https://example.com}}" --filter-status {{301}} --filter-size {{4092}}` diff --git a/ffe b/ffe new file mode 100644 index 00000000..a789578b --- /dev/null +++ b/ffe @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffe + +> Extract fields from a flat database file and write to another format. +> A configuration file is required to interpret the input and format the output. +> More information: . + +- Display all input data using the specified data configuration: + +`ffe --configuration={{path/to/config.ffe}} {{path/to/input}}` + +- Convert an input file to an output file in a new format: + +`ffe --output={{path/to/output}} -c {{path/to/config.ffe}} {{path/to/input}}` + +- Select input structure and print format from definitions in `~/.fferc` configuration file: + +`ffe --structure={{structure}} --print={{format}} {{path/to/input}}` + +- Write only the selected fields: + +`ffe --field-list="{{FirstName,LastName,Age}}" -c {{path/to/config.ffe}} {{path/to/input}}` + +- Write only the records that match an expression: + +`ffe -e "{{LastName=Smith}}" -c {{path/to/config.ffe}} {{path/to/input}}` + +- Display help: + +`ffe --help` diff --git a/ffmpeg b/ffmpeg new file mode 100644 index 00000000..d61172c2 --- /dev/null +++ b/ffmpeg @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffmpeg + +> Video conversion tool. +> More information: . + +- Extract the sound from a video and save it as MP3: + +`ffmpeg -i {{path/to/video.mp4}} -vn {{path/to/sound.mp3}}` + +- Save a video as GIF, scaling the height to 1000px and setting framerate to 15: + +`ffmpeg -i {{path/to/video.mp4}} -vf 'scale=-1:{{1000}}' -r {{15}} {{path/to/output.gif}}` + +- Combine numbered images (`frame_1.jpg`, `frame_2.jpg`, etc) into a video or GIF: + +`ffmpeg -i {{path/to/frame_%d.jpg}} -f image2 {{video.mpg|video.gif}}` + +- Quickly extract a single frame from a video at time mm:ss and save it as a 128x128 resolution image: + +`ffmpeg -ss {{mm:ss}} -i {{path/to/video.mp4}} -frames 1 -s {{128x128}} -f image2 {{path/to/image.png}}` + +- Trim a video from a given start time mm:ss to an end time mm2:ss2 (omit the -to flag to trim till the end): + +`ffmpeg -ss {{mm:ss}} -to {{mm2:ss2}} -i {{path/to/video.mp4}} -codec copy {{path/to/output.mp4}}` + +- Convert AVI video to MP4. AAC Audio @ 128kbit, h264 Video @ CRF 23: + +`ffmpeg -i {{path/to/input_video}}.avi -codec:a aac -b:a 128k -codec:v libx264 -crf 23 {{path/to/output_video}}.mp4` + +- Remux MKV video to MP4 without re-encoding audio or video streams: + +`ffmpeg -i {{path/to/input_video}}.mkv -codec copy {{path/to/output_video}}.mp4` + +- Convert MP4 video to VP9 codec. For the best quality, use a CRF value (recommended range 15-35) and -b:v MUST be 0: + +`ffmpeg -i {{path/to/input_video}}.mp4 -codec:v libvpx-vp9 -crf {{30}} -b:v 0 -codec:a libopus -vbr on -threads {{number_of_threads}} {{path/to/output_video}}.webm` diff --git a/ffplay b/ffplay new file mode 100644 index 00000000..39be4c32 --- /dev/null +++ b/ffplay @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffplay + +> A simple and portable media player using the FFmpeg libraries and the SDL library. +> More information: . + +- Play a media file: + +`ffplay {{path/to/file}}` + +- Play audio from a media file without a GUI: + +`ffplay -nodisp {{path/to/file}}` + +- Play media passed by `ffmpeg` through `stdin`: + +`ffmpeg -i {{path/to/file}} -c {{copy}} -f {{media_format}} - | ffplay -` + +- Play a video and show motion vectors in real time: + +`ffplay -flags2 +export_mvs -vf codecview=mv=pf+bf+bb {{path/to/file}}` + +- Show only video keyframes: + +`ffplay -vf select="{{eq(pict_type\,PICT_TYPE_I)}}" {{path/to/file}}` diff --git a/ffprobe b/ffprobe new file mode 100644 index 00000000..9843825e --- /dev/null +++ b/ffprobe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffprobe + +> Multimedia stream analyzer. +> More information: . + +- Display all available stream info for a media file: + +`ffprobe -v error -show_streams {{input.mp4}}` + +- Display media duration: + +`ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` + +- Display the frame rate of a video: + +`ffprobe -v error -select_streams v:0 -show_entries stream=avg_frame_rate -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` + +- Display the width or height of a video: + +`ffprobe -v error -select_streams v:0 -show_entries stream={{width|height}} -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` + +- Display the average bit rate of a video: + +`ffprobe -v error -select_streams v:0 -show_entries stream=bit_rate -of default=noprint_wrappers=1:nokey=1 {{input.mp4}}` diff --git a/ffsend b/ffsend new file mode 100644 index 00000000..5967f8d2 --- /dev/null +++ b/ffsend @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffsend + +> Easily and securely share files. +> More information: . + +- Upload a file: + +`ffsend upload {{path/to/file}}` + +- Download a file: + +`ffsend download {{url}}` + +- Upload a file with password: + +`ffsend upload {{path/to/file}} -p {{password}}` + +- Download a file protected by password: + +`ffsend download {{path/to/file}} -p {{password}}` + +- Upload a file and allow 4 downloads: + +`ffsend upload {{path/to/file}} -d {{4}}` diff --git a/ffuf b/ffuf new file mode 100644 index 00000000..8de893b7 --- /dev/null +++ b/ffuf @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ffuf + +> A fast web fuzzer written in Go. +> The `FUZZ` keyword is used as a placeholder. `ffuf` will try to hit the URL by replacing the word `FUZZ` with every word in the wordlist. +> More information: . + +- Enumerate directories using [c]olored output and a [w]ordlist specifying a target [u]RL: + +`ffuf -c -w {{path/to/wordlist.txt}} -u {{http://target/FUZZ}}` + +- Enumerate subdomains by changing the position of the keyword: + +`ffuf -w {{path/to/subdomains.txt}} -u {{http://FUZZ.target.com}}` + +- Fuzz with specified [t]hreads (default: 40) and pro[x]ying the traffic and save [o]utput to a file: + +`ffuf -o -w {{path/to/wordlist.txt}} -u {{http://target/FUZZ}} -t {{500}} -x {{http://127.0.0.1:8080}}` + +- Fuzz a specific [H]eader ("Name: Value") and [m]atch HTTP status [c]odes: + +`ffuf -w {{path/to/wordlist.txt}} -u {{http://target.com}} -H "{{Host: FUZZ}}" -mc {{200}}` + +- Fuzz with specified HTTP method and payloa[d], while [f]iltering out comma separated status [c]odes: + +`ffuf -w {{path/to/postdata.txt}} -X {{POST}} -d "{{username=admin\&password=FUZZ}}" -u {{http://target/login.php}} -fc {{401,403}}` diff --git a/fg b/fg new file mode 100644 index 00000000..e96c79e3 --- /dev/null +++ b/fg @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fg + +> Run jobs in foreground. +> More information: . + +- Bring most recently suspended or running background job to foreground: + +`fg` + +- Bring a specific job to foreground: + +`fg %{{job_id}}` diff --git a/fgrep b/fgrep new file mode 100644 index 00000000..3160671f --- /dev/null +++ b/fgrep @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fgrep + +> Matches fixed strings in files. +> Equivalent to `grep -F`. +> More information: . + +- Search for an exact string in a file: + +`fgrep {{search_string}} {{path/to/file}}` + +- Search only lines that match entirely in one or more files: + +`fgrep -x {{search_string}} {{path/to/file1 path/to/file2 ...}}` + +- Count the number of lines that match the given string in a file: + +`fgrep -c {{search_string}} {{path/to/file}}` + +- Show the line number in the file along with the line matched: + +`fgrep -n {{search_string}} {{path/to/file}}` + +- Display all lines except those that contain the search string: + +`fgrep -v {{search_string}} {{path/to/file}}` + +- Display filenames whose content matches the search string at least once: + +`fgrep -l {{search_string}} {{path/to/file1 path/to/file2 ...}}` diff --git a/fiascotopnm b/fiascotopnm new file mode 100644 index 00000000..c4ae7c9e --- /dev/null +++ b/fiascotopnm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fiascotopnm + +> Convert a compressed FIASCO file to a PNM image. +> More information: . + +- Convert a compressed FIASCO file to a PNM file or in the case of video streams multiple PNM files: + +`fiascotopnm {{path/to/file.fiasco}} -o {{output_file_basename}}` + +- Use fast decompression, resulting in a slightly decreased quality of the output file(s): + +`fiascotopnm --fast {{path/to/file.fiasco}} -o {{output_file_basename}}` + +- Load the options to be used from the specified configuration file: + +`fiascotopnm --config {{path/to/fiascorc}} {{path/to/file.fiasco}} -o {{output_file_basename}}` + +- Magnify the decompressed image(s) by a factor of 2^n: + +`fiascotopnm --magnify {{n}} {{path/to/file.fiasco}} -o {{output_file_basename}}` + +- Smooth the decompressed image by the specified amount: + +`fiascotopnm --smooth {{n}} {{path/to/file.fiasco}} -o {{output_file_basename}}` diff --git a/figlet b/figlet new file mode 100644 index 00000000..d2fa121f --- /dev/null +++ b/figlet @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# figlet + +> Generate ASCII banners from user input. +> See also: `showfigfonts`. +> More information: . + +- Generate by directly inputting text: + +`figlet {{input_text}}` + +- Use a custom font file: + +`figlet {{input_text}} -f {{path/to/font_file.flf}}` + +- Use a font from the default font directory (the extension can be omitted): + +`figlet {{input_text}} -f {{font_filename}}` + +- Pipe command output through FIGlet: + +`{{command}} | figlet` + +- Show available FIGlet fonts: + +`showfigfonts {{optional_string_to_display}}` diff --git a/file b/file new file mode 100644 index 00000000..8666b600 --- /dev/null +++ b/file @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# file + +> Determine file type. +> More information: . + +- Give a description of the type of the specified file. Works fine for files with no file extension: + +`file {{path/to/file}}` + +- Look inside a zipped file and determine the file type(s) inside: + +`file -z {{foo.zip}}` + +- Allow file to work with special or device files: + +`file -s {{path/to/file}}` + +- Don't stop at first file type match; keep going until the end of the file: + +`file -k {{path/to/file}}` + +- Determine the MIME encoding type of a file: + +`file -i {{path/to/file}}` diff --git a/fin b/fin new file mode 100644 index 00000000..036f4975 --- /dev/null +++ b/fin @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fin + +> Docksal command-line utility. +> More information: . + +- Start the project in the current directory: + +`fin project start` + +- Stop the project in the current directory: + +`fin project stop` + +- Open a shell into a specific container: + +`fin bash {{container_name}}` + +- Display logs of a specific container: + +`fin logs {{container_name}}` + +- Display logs of a specific container and follow the log: + +`fin logs -f {{container_name}}` diff --git a/find b/find new file mode 100644 index 00000000..dade270a --- /dev/null +++ b/find @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# find + +> Find files or directories under a directory tree, recursively. +> More information: . + +- Find files by extension: + +`find {{root_path}} -name '{{*.ext}}'` + +- Find files matching multiple path/name patterns: + +`find {{root_path}} -path '{{**/path/**/*.ext}}' -or -name '{{*pattern*}}'` + +- Find directories matching a given name, in case-insensitive mode: + +`find {{root_path}} -type d -iname '{{*lib*}}'` + +- Find files matching a given pattern, excluding specific paths: + +`find {{root_path}} -name '{{*.py}}' -not -path '{{*/site-packages/*}}'` + +- Find files matching a given size range, limiting the recursive depth to "1": + +`find {{root_path}} -maxdepth 1 -size {{+500k}} -size {{-10M}}` + +- Run a command for each file (use `{}` within the command to access the filename): + +`find {{root_path}} -name '{{*.ext}}' -exec {{wc -l}} {} \;` + +- Find all files modified today and pass the results to a single command as arguments: + +`find {{root_path}} -daystart -mtime {{-1}} -exec {{tar -cvf archive.tar}} {} \+` + +- Find empty (0 byte) files and delete them: + +`find {{root_path}} -type {{f}} -empty -delete` diff --git a/finger b/finger new file mode 100644 index 00000000..2dc3e1eb --- /dev/null +++ b/finger @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# finger + +> User information lookup program. +> More information: . + +- Display information about currently logged in users: + +`finger` + +- Display information about a specific user: + +`finger {{username}}` + +- Display the user's login name, real name, terminal name, and other information: + +`finger -s` + +- Produce multiline output format displaying same information as `-s` as well as user's home directory, home phone number, login shell, mail status, etc.: + +`finger -l` + +- Prevent matching against user's names and only use login names: + +`finger -m` diff --git a/fio b/fio new file mode 100644 index 00000000..d856221b --- /dev/null +++ b/fio @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fio + +> Flexible I/O tester: do an I/O action spawning multiple threads or processes. +> More information: . + +- Test random reads: + +`fio --filename={{path/to/file}} --direct=1 --rw=randread --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` + +- Test sequential reads: + +`fio --filename={{path/to/file}} --direct=1 --rw=read --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` + +- Test random read/write: + +`fio --filename={{path/to/file}} --direct=1 --rw=randrw --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1` + +- Test with parameters from a job file: + +`fio {{path/to/job_file}}` + +- Convert a specific job file to command-line options: + +`fio --showcmd {{path/to/job_file}}` diff --git a/firebase b/firebase new file mode 100644 index 00000000..c59f8ed7 --- /dev/null +++ b/firebase @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# firebase + +> Test, manage, and deploy Firebase projects. +> More information: . + +- Log in to : + +`firebase login` + +- List existing Firebase projects: + +`firebase projects:list` + +- Start an interactive wizard to create a Firebase project in the current directory: + +`firebase init` + +- Deploy code and assets to the current Firebase project: + +`firebase deploy` + +- Start a local server to statically host the current Firebase project's assets: + +`firebase serve` + +- Start an interactive wizard to open one of many links of the current Firebase project in the default web browser: + +`firebase open` diff --git a/firefox b/firefox new file mode 100644 index 00000000..7601cf7d --- /dev/null +++ b/firefox @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# firefox + +> A free and open source web browser. +> More information: . + +- Launch Firefox and open a web page: + +`firefox {{https://www.duckduckgo.com}}` + +- Open a new window: + +`firefox --new-window {{https://www.duckduckgo.com}}` + +- Open a private (incognito) window: + +`firefox --private-window` + +- Search for "wikipedia" using the default search engine: + +`firefox --search "{{wikipedia}}"` + +- Launch Firefox in safe mode, with all extensions disabled: + +`firefox --safe-mode` + +- Take a screenshot of a web page in headless mode: + +`firefox --headless --screenshot {{path/to/output_file.png}} {{https://example.com/}}` + +- Use a specific profile to allow multiple separate instances of Firefox to run at once: + +`firefox --profile {{path/to/directory}} {{https://example.com/}}` + +- Set Firefox as the default browser: + +`firefox --setDefaultBrowser` diff --git a/fish b/fish new file mode 100644 index 00000000..56342821 --- /dev/null +++ b/fish @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fish + +> The Friendly Interactive SHell, a command-line interpreter designed to be user friendly. +> More information: . + +- Start an interactive shell session: + +`fish` + +- Start an interactive shell session without loading startup configs: + +`fish --no-config` + +- Execute specific commands: + +`fish --command "{{echo 'fish is executed'}}"` + +- Execute a specific script: + +`fish {{path/to/script.fish}}` + +- Check a specific script for syntax errors: + +`fish --no-execute {{path/to/script.fish}}` + +- Execute specific commands from `stdin`: + +`{{echo "echo 'fish is executed'"}} | fish` + +- Start an interactive shell session in private mode, where the shell does not access old history or save new history: + +`fish --private` + +- Define and export an environmental variable that persists across shell restarts (builtin): + +`set --universal --export {{variable_name}} {{variable_value}}` diff --git a/fisher b/fisher new file mode 100644 index 00000000..432ee1cc --- /dev/null +++ b/fisher @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fisher + +> Fisher, a fish-shell plugin manager. +> Install plugins by name or from a managed 'fishfile' for bundled installs. +> More information: . + +- Install one or more plugins: + +`fisher {{plugin1}} {{plugin2}}` + +- Install a plugin from a GitHub gist: + +`fisher {{gist_url}}` + +- Edit 'fishfile' manually with your favorite editor and install multiple plugins: + +`{{editor}} ~/.config/fish/fishfile; fisher` + +- List installed plugins: + +`fisher ls` + +- Update plugins: + +`fisher update` + +- Remove one or more plugins: + +`fisher remove {{plugin1}} {{plugin2}}` diff --git a/fkill b/fkill new file mode 100644 index 00000000..14b43a8b --- /dev/null +++ b/fkill @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fkill + +> Fabulously kill processes. Cross-platform. +> More information: . + +- Run without arguments to use the interactive interface: + +`fkill` + +- Kill the process by PID, name or port: + +`fkill {{pid|name|:port}}` diff --git a/flac b/flac new file mode 100644 index 00000000..e99a0b94 --- /dev/null +++ b/flac @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flac + +> Encodes, decodes and tests FLAC files. +> More information: . + +- Encode a WAV file to FLAC (this will create a FLAC file in the same location as the WAV file): + +`flac {{path/to/file.wav}}` + +- Encode a WAV file to FLAC, specifying the output file: + +`flac -o {{path/to/output.flac}} {{path/to/file.wav}}` + +- Decode a FLAC file to WAV, specifying the output file: + +`flac -d -o {{path/to/output.wav}} {{path/to/file.flac}}` + +- Test a FLAC file for the correct encoding: + +`flac -t {{path/to/file.flac}}` diff --git a/flake8 b/flake8 new file mode 100644 index 00000000..bc4f13ac --- /dev/null +++ b/flake8 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flake8 + +> Check the style and quality of Python code. +> More information: . + +- Lint a file or directory recursively: + +`flake8 {{path/to/file_or_directory}}` + +- Lint a file or directory recursively and show the line on which each error occurred: + +`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): + +`flake8 --ignore {{rule1,rule2}} {{path/to/file_or_directory}}` + +- Lint a file or directory recursively but exclude files matching the given globs or substrings: + +`flake8 --exclude {{substring1,glob2}} {{path/to/file_or_directory}}` diff --git a/flarectl b/flarectl new file mode 100644 index 00000000..7f86330f --- /dev/null +++ b/flarectl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flarectl + +> Official CLI for Cloudflare. +> More information: . + +- Block a specific IP: + +`flarectl firewall rules create --zone="{{example.com}}" --value="{{8.8.8.8}}" --mode="{{block}}" --notes="{{Block bad actor}}"` + +- Add a DNS record: + +`flarectl dns create --zone="{{example.com}}" --name="{{app}}" --type="{{CNAME}}" --content="{{myapp.herokuapp.com}}" --proxy` + +- List all Cloudflare IPv4/IPv6 ranges: + +`flarectl ips --ip-type {{ipv4|ipv6|all}}` + +- Create many new Cloudflare zones automatically with names from `domains.txt`: + +`for domain in $(cat {{domains.txt}}); do flarectl zone info --zone=$domain; done` + +- List all firewall rules: + +`flarectl firewall rules list` diff --git a/flask b/flask new file mode 100644 index 00000000..20784a16 --- /dev/null +++ b/flask @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flask + +> A general utility script for Flask applications. Loads the application defined in the `FLASK_APP` environment variable. +> More information: . + +- Run a development server: + +`flask run` + +- Show the routes for the app: + +`flask routes` + +- Run a Python interactive shell in the app's context: + +`flask shell` diff --git a/flex b/flex new file mode 100644 index 00000000..d05efbc7 --- /dev/null +++ b/flex @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flex + +> Lexical analyzer generator. A rewrite of `lex` with extensions to the POSIX specification. +> Given the specification for a lexical analyzer, generates C code implementing it. +> Note: long options don't work on OpenBSD. +> More information: . + +- Generate an analyzer from a flex file, storing it to the file `lex.yy.c`: + +`lex {{analyzer.l}}` + +- Write analyzer to `stdout`: + +`lex -{{-stdout|t}} {{analyzer.l}}` + +- Specify the output file: + +`lex {{analyzer.l}} -o {{analyzer.c}}` + +- Generate a [B]atch scanner instead of an interactive scanner: + +`lex -B {{analyzer.l}}` + +- Compile a C file generated by Lex: + +`cc {{path/to/lex.yy.c}} --output {{executable}}` diff --git a/flips b/flips new file mode 100644 index 00000000..f9932903 --- /dev/null +++ b/flips @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flips + +> Create and apply patches for IPS and BPS files. +> More information: . + +- Start Flips to create and apply patches interactively: + +`flips` + +- Apply a patch and create a new ROM file: + +`flips --apply {{patch.bps}} {{rom.smc}} {{hack.smc}}` + +- Create a patch from two ROMs: + +`flips --create {{rom.smc}} {{hack.smc}} {{patch.bps}}` diff --git a/flite b/flite new file mode 100644 index 00000000..aa33dadb --- /dev/null +++ b/flite @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flite + +> Speech synthesis engine. +> More information: . + +- List all available voices: + +`flite -lv` + +- Convert a text string to speech: + +`flite -t "{{string}}"` + +- Convert the contents of a file to speech: + +`flite -f {{path/to/file.txt}}` + +- Use the specified voice: + +`flite -voice {{file://path/to/filename.flitevox|url}}` + +- Store output into a wav file: + +`flite -voice {{file://path/to/filename.flitevox|url}} -f {{path/to/file.txt}} -o {{output.wav}}` + +- Display version: + +`flite --version` diff --git a/flock b/flock new file mode 100644 index 00000000..5f946b7b --- /dev/null +++ b/flock @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flock + +> Manage locks from shell scripts. +> It can be used to ensure that only one process of a command is running. +> More information: . + +- Run a command with a file lock as soon as the lock is not required by others: + +`flock {{path/to/lock.lock}} --command "{{command}}"` + +- Run a command with a file lock, and exit if the lock doesn't exist: + +`flock {{path/to/lock.lock}} --nonblock --command "{{command}}"` + +- Run a command with a file lock, and exit with a specific error code if the lock doesn't exist: + +`flock {{path/to/lock.lock}} --nonblock --conflict-exit-code {{error_code}} -c "{{command}}"` diff --git a/flow b/flow new file mode 100644 index 00000000..143a5611 --- /dev/null +++ b/flow @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flow + +> A static type checker for JavaScript. +> More information: . + +- Run a flow check: + +`flow` + +- Check which files are being checked by flow: + +`flow ls` + +- Run a type coverage check on all files in a directory: + +`flow batch-coverage --show-all --strip-root {{path/to/directory}}` + +- Display line-by-line type coverage stats: + +`flow coverage --color {{path/to/file.jsx}}` diff --git a/fls b/fls new file mode 100644 index 00000000..66ea5231 --- /dev/null +++ b/fls @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fls + +> List files and directories in an image file or device. +> More information: . + +- Build a recursive fls list over a device, output paths will start with C: + +`fls -r -m {{C:}} {{/dev/loop1p1}}` + +- Analyze a single partition, providing the sector offset at which the filesystem starts in the image: + +`fls -r -m {{C:}} -o {{sector}} {{path/to/image_file}}` + +- Analyze a single partition, providing the timezone of the original system: + +`fls -r -m {{C:}} -z {{timezone}} {{/dev/loop1p1}}` diff --git a/flutter b/flutter new file mode 100644 index 00000000..90520c50 --- /dev/null +++ b/flutter @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flutter + +> Google's free, open source, and cross-platform mobile app SDK. +> Some subcommands such as `flutter pub` have their own usage documentation. +> More information: . + +- Initialize a new Flutter project in a directory of the same name: + +`flutter create {{project_name}}` + +- Check if all external tools are correctly installed: + +`flutter doctor` + +- List or change Flutter channel: + +`flutter channel {{stable|beta|dev|master}}` + +- Run Flutter on all started emulators and connected devices: + +`flutter run -d all` + +- Run tests in a terminal from the root of the project: + +`flutter test {{test/example_test.dart}}` + +- Build a release APK targeting most modern smartphones: + +`flutter build apk --target-platform {{android-arm}},{{android-arm64}}` + +- Display help about a specific command: + +`flutter help {{command}}` diff --git a/flutter-pub b/flutter-pub new file mode 100644 index 00000000..c4306569 --- /dev/null +++ b/flutter-pub @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flutter pub + +> Flutter's package manager. +> Note: Packages are available on . See also: `flutter`. +> More information: . + +- Download/Update all packages specified in `pubspec.yaml`: + +`flutter pub get` + +- Add a package dependency to an app: + +`flutter pub add {{package1 package2 ...}}` + +- Remove a package dependency from an app: + +`flutter pub remove {{package1 package2 ...}}` + +- Upgrade to the highest version of a package that is allowed by `pubspec.yaml`: + +`flutter pub upgrade {{package}}` diff --git a/fluxctl b/fluxctl new file mode 100644 index 00000000..d2856c14 --- /dev/null +++ b/fluxctl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fluxctl + +> Command-line tool for Flux v1. +> More information: . + +- List workloads currently running in the cluster on specific namespace: + +`fluxctl --k8s-fwd-ns={{namespace}} list-workloads` + +- Show deployed and available images: + +`fluxctl list-images` + +- Synchronize the cluster with the Git repository: + +`fluxctl sync` + +- Turn on automatic deployment for a workload: + +`fluxctl automate` diff --git a/fly b/fly new file mode 100644 index 00000000..817e6eda --- /dev/null +++ b/fly @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fly + +> Command-line tool for concourse-ci. +> More information: . + +- Authenticate with and save concourse target: + +`fly --target {{target_name}} login --team-name {{team_name}} -c {{https://ci.example.com}}` + +- List targets: + +`fly targets` + +- List pipelines: + +`fly -t {{target_name}} pipelines` + +- Upload or update a pipeline: + +`fly -t {{target_name}} set-pipeline --config {{pipeline.yml}} --pipeline {{pipeline_name}}` + +- Unpause pipeline: + +`fly -t {{target_name}} unpause-pipeline --pipeline {{pipeline_name}}` + +- Show pipeline configuration: + +`fly -t {{target_name}} get-pipeline --pipeline {{pipeline_name}}` + +- Update local copy of fly: + +`fly -t {{target_name}} sync` + +- Destroy pipeline: + +`fly -t {{target_name}} destroy-pipeline --pipeline {{pipeline_name}}` diff --git a/flyctl b/flyctl new file mode 100644 index 00000000..a0df1d86 --- /dev/null +++ b/flyctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# flyctl + +> Command-line tool for flyctl.io. +> More information: . + +- Sign into a Fly account: + +`flyctl auth login` + +- Launch an application from a specific Dockerfile (the default path is the current working directory): + +`flyctl launch --dockerfile {{path/to/dockerfile}}` + +- Open the current deployed application in the default web browser: + +`flyctl open` + +- Deploy the Fly applications from a specific Dockerfile: + +`flyctl deploy --dockerfile {{path/to/dockerfile}}` + +- Open the Fly Web UI for the current application in a web browser: + +`flyctl dashboard` + +- List all applications in the logged-in Fly account: + +`flyctl apps list` + +- View the status of a specific running application: + +`flyctl status --app {{app_name}}` + +- Display version information: + +`flyctl version` diff --git a/fmt b/fmt new file mode 100644 index 00000000..fe94b67f --- /dev/null +++ b/fmt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fmt + +> Reformat a text file by joining its paragraphs and limiting the line width to a number of characters (75 by default). +> More information: . + +- Reformat a file: + +`fmt {{path/to/file}}` + +- Reformat a file producing output lines of (at most) `n` characters: + +`fmt -w {{n}} {{path/to/file}}` + +- Reformat a file without joining lines shorter than the given width together: + +`fmt -s {{path/to/file}}` + +- Reformat a file with uniform spacing (1 space between words and 2 spaces between paragraphs): + +`fmt -u {{path/to/file}}` diff --git a/fnm b/fnm new file mode 100644 index 00000000..8d94e73c --- /dev/null +++ b/fnm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fnm + +> Fast Node.js version manager. +> Install, uninstall or switch between Node.js versions. +> More information: . + +- Install a specific version of Node.js: + +`fnm install {{node_version}}` + +- List all available Node.js versions and highlight the default one: + +`fnm list` + +- Use a specific version of Node.js in the current shell: + +`fnm use {{node_version}}` + +- Set the default Node.js version: + +`fnm default {{node_version}}` + +- Uninstall a given Node.js version: + +`fnm uninstall {{node_version}}` diff --git a/fold b/fold new file mode 100644 index 00000000..fbfaac08 --- /dev/null +++ b/fold @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fold + +> Wrap each line in an input file to fit a specified width and print it to `stdout`. +> More information: . + +- Wrap each line to default width (80 characters): + +`fold {{path/to/file}}` + +- Wrap each line to width "30": + +`fold -w30 {{path/to/file}}` + +- Wrap each line to width "5" and break the line at spaces (puts each space separated word in a new line, words with length > 5 are wrapped): + +`fold -w5 -s {{path/to/file}}` diff --git a/for b/for new file mode 100644 index 00000000..15b56418 --- /dev/null +++ b/for @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# for + +> Perform a command several times. +> More information: . + +- Execute the given commands for each of the specified items: + +`for {{variable}} in {{item1 item2 ...}}; do {{echo "Loop is executed"}}; done` + +- Iterate over a given range of numbers: + +`for {{variable}} in {{{from}}..{{to}}..{{step}}}; do {{echo "Loop is executed"}}; done` + +- Iterate over a given list of files: + +`for {{variable}} in {{path/to/file1 path/to/file2 ...}}; do {{echo "Loop is executed"}}; done` + +- Iterate over a given list of directories: + +`for {{variable}} in {{path/to/directory1/ path/to/directory2/ ...}}; do {{echo "Loop is executed"}}; done` + +- Perform a given command in every directory: + +`for {{variable}} in */; do (cd "${{variable}}" || continue; {{echo "Loop is executed"}}) done` diff --git a/forever b/forever new file mode 100644 index 00000000..edbfb956 --- /dev/null +++ b/forever @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# forever + +> Server-side JavaScript application that makes sure Node.js applications run indefinitely (restarts after exit). +> More information: . + +- Start running a file forever (as a daemon): + +`forever {{script}}` + +- List running "forever" processes (along with IDs and other details of "forever" processes): + +`forever list` + +- Stop a running "forever" process: + +`forever stop {{ID|pid|script}}` diff --git a/fortune b/fortune new file mode 100644 index 00000000..fb7fe770 --- /dev/null +++ b/fortune @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fortune + +> Print a random quotation (fortune-cookie style). +> More information: . + +- Print a quotation: + +`fortune` + +- Print an offensive quotation: + +`fortune -o` + +- Print a long quotation: + +`fortune -l` + +- Print a short quotation: + +`fortune -s` + +- List the available quotation database files: + +`fortune -f` + +- Print a quotation from one of the database files listed by `fortune -f`: + +`fortune {{path/to/file}}` diff --git a/fossa b/fossa new file mode 100644 index 00000000..028deb1b --- /dev/null +++ b/fossa @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossa + +> CLI for the Fossa service - Generate realtime license audits, vulnerability scans and reports about dependencies licenses. +> More information: . + +- Initialize a `.fossa.yml` configuration file: + +`fossa init` + +- Run a default project build: + +`fossa build` + +- Analyze built dependencies: + +`fossa analyze` + +- Generate reports: + +`fossa report` + +- Test current revision against the FOSSA scan status and exit with errors if issues are found: + +`fossa test` diff --git a/fossil b/fossil new file mode 100644 index 00000000..527aeae0 --- /dev/null +++ b/fossil @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil + +> Distributed version control system. +> Some subcommands such as `fossil commit` have their own usage documentation. +> More information: . + +- Execute a Fossil subcommand: + +`fossil {{subcommand}}` + +- Display help: + +`fossil help` + +- Display help for a specific subcommand (like `add`, `commit`, etc.): + +`fossil help {{subcommand}}` + +- Display version: + +`fossil version` diff --git a/fossil-add b/fossil-add new file mode 100644 index 00000000..669d5ea6 --- /dev/null +++ b/fossil-add @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil add + +> Put files or directories under Fossil version control. +> More information: . + +- Put a file or directory under version control, so it will be in the current checkout: + +`fossil add {{path/to/file_or_directory}}` + +- Remove all added files from the current checkout: + +`fossil add --reset` diff --git a/fossil-ci b/fossil-ci new file mode 100644 index 00000000..258f3294 --- /dev/null +++ b/fossil-ci @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil ci + +> This command is an alias of `fossil commit`. +> More information: . + +- View documentation for the original command: + +`tldr fossil-commit` diff --git a/fossil-commit b/fossil-commit new file mode 100644 index 00000000..88b95f32 --- /dev/null +++ b/fossil-commit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil commit + +> Commit files to a Fossil repository. +> More information: . + +- Create a new version containing all the changes in the current checkout; user will be prompted for a comment: + +`fossil commit` + +- Create a new version containing all the changes in the current checkout, using the specified comment: + +`fossil commit --comment "{{comment}}"` + +- Create a new version containing all the changes in the current checkout with a comment read from a specific file: + +`fossil commit --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 ...}}` diff --git a/fossil-delete b/fossil-delete new file mode 100644 index 00000000..81241055 --- /dev/null +++ b/fossil-delete @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil delete + +> This command is an alias of `fossil rm`. +> More information: . + +- View documentation for the original command: + +`tldr fossil rm` diff --git a/fossil-forget b/fossil-forget new file mode 100644 index 00000000..c4b8efbb --- /dev/null +++ b/fossil-forget @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil forget + +> This command is an alias of `fossil rm`, with the exception that it never removes files from the disk. +> More information: . + +- View documentation for the original command: + +`tldr fossil rm` diff --git a/fossil-init b/fossil-init new file mode 100644 index 00000000..736c298e --- /dev/null +++ b/fossil-init @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil init + +> Initialize a new repository for a project. +> See also: `fossil clone`. +> More information: . + +- Create a new repository in a named file: + +`fossil init {{path/to/filename}}` diff --git a/fossil-new b/fossil-new new file mode 100644 index 00000000..374dd64d --- /dev/null +++ b/fossil-new @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil new + +> This command is an alias of `fossil init`. +> More information: . + +- View documentation for the original command: + +`tldr fossil-init` diff --git a/fossil-rm b/fossil-rm new file mode 100644 index 00000000..cae93c35 --- /dev/null +++ b/fossil-rm @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fossil rm + +> Remove files or directories from Fossil version control. +> See also: `fossil forget`. +> More information: . + +- Remove a file or directory from Fossil version control: + +`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` diff --git a/fping b/fping new file mode 100644 index 00000000..5d120965 --- /dev/null +++ b/fping @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fping + +> A more powerful ping which can ping multiple hosts. +> More information: . + +- List alive hosts within a subnet generated from a netmask: + +`fping -a -g 192.168.1.0/24` + +- List alive hosts within a subnet generated from an IP range: + +`fping -a -g 192.168.1.1 192.168.1.254` + +- List unreachable hosts within a subnet generated from a netmask: + +`fping -u -g 192.168.1.0/24` diff --git a/freebsd/cal b/freebsd/cal new file mode 100644 index 00000000..e6030f41 --- /dev/null +++ b/freebsd/cal @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Display a calendar with the current day highlighted. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display a calendar for a specific year: + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` + +- Display the whole calendar for the current year: + +`cal -y` + +- Don't [h]ighlight today and display [3] months spanning the date: + +`cal -h -3 {{month}} {{year}}` + +- Display the 2 months [B]efore and 3 [A]fter a specific [m]onth of the current year: + +`cal -A 3 -B 2 {{month}}` + +- Display [j]ulian days (starting from one, numbered from January 1): + +`cal -j` diff --git a/freebsd/chfn b/freebsd/chfn new file mode 100644 index 00000000..1f235072 --- /dev/null +++ b/freebsd/chfn @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chfn + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/freebsd/chpass b/freebsd/chpass new file mode 100644 index 00000000..a602b9e9 --- /dev/null +++ b/freebsd/chpass @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chpass + +> Add or change user database information, including login shell and password. +> See also: `passwd`. +> More information: . + +- Add or change user database information for the current user interactively: + +`su -c chpass` + +- Set a specific login [s]hell for the current user: + +`chpass -s {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`chpass -s {{path/to/shell}} {{username}}` + +- Change the account [e]xpire time (in seconds from the epoch, UTC): + +`su -c 'chpass -e {{time}} {{username}}'` + +- Change a user's password: + +`su -c 'chpass -p {{encrypted_password}} {{username}}'` + +- Specify the [h]ostname or address of an NIS server to query: + +`su -c 'chpass -h {{hostname}} {{username}}'` + +- Specify a particular NIS [d]omain (system domain name by default): + +`su -c 'chpass -d {{domain}} {{username}}'` diff --git a/freebsd/chsh b/freebsd/chsh new file mode 100644 index 00000000..3c0ca04f --- /dev/null +++ b/freebsd/chsh @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chsh + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/freebsd/df b/freebsd/df new file mode 100644 index 00000000..706a78dd --- /dev/null +++ b/freebsd/df @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage using 512-byte units: + +`df` + +- Use [h]uman-readable units (based on powers of 1024) and display a grand total: + +`df -h -c` + +- Use [H]uman-readable units (based on powers of 1000): + +`df -{{-si|H}}` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Include statistics on the number of free and used [i]nodes including the filesystem [T]ypes: + +`df -iT` + +- Use 1024-byte units when writing space figures: + +`df -k` + +- Display information in a [P]ortable way: + +`df -P` diff --git a/freebsd/look b/freebsd/look new file mode 100644 index 00000000..c1e00c89 --- /dev/null +++ b/freebsd/look @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# look + +> Display lines beginning with a prefix in a sorted file. +> See also: `grep`, `sort`. +> More information: . + +- Search for lines beginning with a specific prefix in a specific file: + +`look {{prefix}} {{path/to/file}}` + +- Case-insensitively search only on alphanumeric characters: + +`look -{{f|-ignore-case}} -{{d|-alphanum}} {{prefix}} {{path/to/file}}` + +- Specify a string [t]ermination character (space by default): + +`look -{{t|-terminate}} {{,}}` + +- Search in `/usr/share/dict/words` (`--ignore-case` and `--alphanum` are assumed): + +`look {{prefix}}` diff --git a/freebsd/pkg b/freebsd/pkg new file mode 100644 index 00000000..74a93c9d --- /dev/null +++ b/freebsd/pkg @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg + +> FreeBSD package manager. +> More information: . + +- Install a new package: + +`pkg install {{package}}` + +- Delete a package: + +`pkg delete {{package}}` + +- Upgrade all packages: + +`pkg upgrade` + +- Search for a package: + +`pkg search {{keyword}}` + +- List installed packages: + +`pkg info` + +- Remove unneeded dependencies: + +`pkg autoremove` diff --git a/freebsd/sed b/freebsd/sed new file mode 100644 index 00000000..da3aa477 --- /dev/null +++ b/freebsd/sed @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script.sed}}` + +- Delay opening each file until a command containing the related `w` function or flag is applied to a line of input: + +`{{command}} | sed -fa {{path/to/script.sed}}` + +- Replace all `apple` (extended regex) occurrences with `APPLE` (extended regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed -E 's/(apple)/\U\1/g'` + +- Print just a first line to `stdout`: + +`{{command}} | sed -n '1p'` + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in a specific file and overwrite the original file in place: + +`sed -i 's/apple/mango/g' {{path/to/file}}` diff --git a/freebsd/sockstat b/freebsd/sockstat new file mode 100644 index 00000000..47110f48 --- /dev/null +++ b/freebsd/sockstat @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# sockstat + +> List open Internet or UNIX domain sockets. +> More information: . + +- View which users/processes are [l]istening on which ports: + +`sockstat -l` + +- Show information for IPv[4]/IPv[6] sockets [l]istening on specific [p]orts using a specific [P]rotocol: + +`sockstat -{{4|6}} -l -P {{tcp|udp|sctp|divert}} -p {{port1,port2...}}` + +- Also show [c]onnected sockets, not resolving [n]umeric UIDs to user names and using a [w]ider field size: + +`sockstat -cnw` + +- Only show sockets that belong to a specific [j]ail ID or name in [v]erbose mode: + +`sockstat -jv` + +- Display the protocol [s]tate and the remote [U]DP encapsulation port number, if applicable (these are currently only implemented for SCTP and TCP): + +`sockstat -sU` + +- Display the [C]ongestion control module and the protocol [S]tack, if applicable (these are currently only implemented for TCP): + +`sockstat -CS` + +- Only show Internet sockets if the local and foreign addresses are not in the loopback network prefix 127.0.0.0/8, or do not contain the IPv6 loopback address ::1: + +`sockstat -L` + +- Do not show the header ([q]uiet mode), showing [u]nix sockets and displaying the `inp_gencnt`: + +`sockstat -qui` diff --git a/freebsd/ypchfn b/freebsd/ypchfn new file mode 100644 index 00000000..5e10b9c6 --- /dev/null +++ b/freebsd/ypchfn @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# ypchfn + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/freebsd/ypchpass b/freebsd/ypchpass new file mode 100644 index 00000000..fc4a5d05 --- /dev/null +++ b/freebsd/ypchpass @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# ypchpass + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/freebsd/ypchsh b/freebsd/ypchsh new file mode 100644 index 00000000..5eaca35e --- /dev/null +++ b/freebsd/ypchsh @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, freebsd] +source: https://github.com/tldr-pages/tldr.git +--- +# ypchsh + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/freshclam b/freshclam new file mode 100644 index 00000000..dc1df9e6 --- /dev/null +++ b/freshclam @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# freshclam + +> Update virus definitions for ClamAV antivirus program. +> More information: . + +- Update virus definitions: + +`freshclam` diff --git a/from b/from new file mode 100644 index 00000000..6db26d36 --- /dev/null +++ b/from @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# from + +> Prints mail header lines from the current user's mailbox. +> More information: . + +- List mail: + +`from` + +- Display the number of messages stored: + +`from --count` + +- List mail in the specified mailbox directory: + +`MAIL={{path/to/mailbox}} from` + +- Print the mail from the specified address: + +`from --sender={{me@example.com}}` diff --git a/fselect b/fselect new file mode 100644 index 00000000..c0194b4b --- /dev/null +++ b/fselect @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fselect + +> Find files with SQL-like queries. +> More information: . + +- Select full path and size from temporary or configuration files in a given directory: + +`fselect size, path from {{path/to/directory}} where name = {{'*.cfg'}} or name = {{'*.tmp'}}` + +- Find square images: + +`fselect path from {{path/to/directory}} where width = height` + +- Find old-school rap 320kbps MP3 files: + +`fselect path from {{path/to/directory}} where genre = {{Rap}} and bitrate = {{320}} and mp3_year lt {{2000}}` + +- Select only the first 5 results and output as JSON: + +`fselect size, path from {{path/to/directory}} limit {{5}} into json` + +- Use SQL aggregate functions to calculate minimum, maximum and average size of files in a directory: + +`fselect "{{MIN(size), MAX(size), AVG(size), SUM(size), COUNT(*)}} from {{path/to/directory}}"` diff --git a/fstopgm b/fstopgm new file mode 100644 index 00000000..0dfd8147 --- /dev/null +++ b/fstopgm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fstopgm + +> Convert a Usenix FaceSaver file into a PGM image. +> See also: `pgmtofs`. +> More information: . + +- Convert the specified Usenix FaceSaver file into a PGM image: + +`fstopgm {{path/to/input.fs}} > {{path/to/output.pgm}}` diff --git a/fswatch b/fswatch new file mode 100644 index 00000000..1a7cddee --- /dev/null +++ b/fswatch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fswatch + +> A cross-platform file change monitor. +> More information: . + +- Run a Bash command on file creation, update or deletion: + +`fswatch {{path/to/file}} | xargs -n 1 {{bash_command}}` + +- Watch one or more files and/or directories: + +`fswatch {{path/to/file}} {{path/to/directory}} {{path/to/another_directory/**/*.js}} | xargs -n 1 {{bash_command}}` + +- Print the absolute paths of the changed files: + +`fswatch {{path/to/directory}} | xargs -n 1 -I {} echo {}` + +- Filter by event type: + +`fswatch --event {{Updated|Deleted|Created}} {{path/to/directory}} | xargs -n 1 {{bash_command}}` diff --git a/fswebcam b/fswebcam new file mode 100644 index 00000000..0ab03c7e --- /dev/null +++ b/fswebcam @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fswebcam + +> Small and simple webcam for *nix. +> More information: . + +- Take a picture: + +`fswebcam {{filename}}` + +- Take a picture with custom resolution: + +`fswebcam -r {{width}}x{{height}} {{filename}}` + +- Take a picture from selected device(Default is `/dev/video0`): + +`fswebcam -d {{device}} {{filename}}` + +- Take a picture with timestamp(timestamp string is formatted by strftime): + +`fswebcam --timestamp {{timestamp}} {{filename}}` diff --git a/ftp b/ftp new file mode 100644 index 00000000..762753bd --- /dev/null +++ b/ftp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ftp + +> Tools to interact with a server via File Transfer Protocol. +> More information: . + +- Connect to an FTP server: + +`ftp {{ftp.example.com}}` + +- Connect to an FTP server specifying its IP address and port: + +`ftp {{ip_address}} {{port}}` + +- Switch to binary transfer mode (graphics, compressed files, etc): + +`binary` + +- Transfer multiple files without prompting for confirmation on every file: + +`prompt off` + +- Download multiple files (glob expression): + +`mget {{*.png}}` + +- Upload multiple files (glob expression): + +`mput {{*.zip}}` + +- Delete multiple files on the remote server: + +`mdelete {{*.txt}}` + +- Rename a file on the remote server: + +`rename {{original_filename}} {{new_filename}}` diff --git a/fuck b/fuck new file mode 100644 index 00000000..424a3307 --- /dev/null +++ b/fuck @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fuck + +> Corrects your previous console command. +> More information: . + +- Set the `fuck` alias to `thefuck` tool: + +`eval "$(thefuck --alias)"` + +- Try to match a rule for the previous command: + +`fuck` + +- Confirm the first choice immediately (correct argument depends on level of annoyance): + +`fuck --{{yes|yeah|hard}}` diff --git a/func b/func new file mode 100644 index 00000000..f14d28b0 --- /dev/null +++ b/func @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# func + +> Azure Functions Core Tools: develop and test Azure Functions locally. +> Local functions can connect to live Azure services, and can deploy a function app to an Azure subscription. +> More information: . + +- Create a new functions project: + +`func init {{project}}` + +- Create a new function: + +`func new` + +- Run functions locally: + +`func start` + +- Publish your code to a function app in Azure: + +`func azure functionapp publish {{function}}` + +- Download all settings from an existing function app: + +`func azure functionapp fetch-app-settings {{function}}` + +- Get the connection string for a specific storage account: + +`func azure storage fetch-connection-string {{storage_account}}` diff --git a/funzip b/funzip new file mode 100644 index 00000000..16365a01 --- /dev/null +++ b/funzip @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# funzip + +> Print the content of the first (non-directory) member in an archive without extraction. +> More information: . + +- Print the content of the first member in a `.zip` archive: + +`funzip {{path/to/archive.zip}}` + +- Print the content in a `.gz` archive: + +`funzip {{path/to/archive.gz}}` + +- Decrypt a `.zip` or `.gz` archive and print the content: + +`funzip -password {{password}} {{path/to/archive}}` diff --git a/fusermount b/fusermount new file mode 100644 index 00000000..1a5098e8 --- /dev/null +++ b/fusermount @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fusermount + +> Mount and unmount FUSE filesystems. +> More information: . + +- Unmount a FUSE filesystem: + +`fusermount -u {{path/to/mount_point}}` + +- Unmount a FUSE filesystem as soon as it becomes unused: + +`fusermount -z {{path/to/mount_point}}` + +- Display version: + +`fusermount --version` diff --git a/fzf b/fzf new file mode 100644 index 00000000..16550f1e --- /dev/null +++ b/fzf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# fzf + +> Command-line fuzzy finder. +> Similar to `sk`. +> More information: . + +- Start `fzf` on all files in the specified directory: + +`find {{path/to/directory}} -type f | fzf` + +- Start `fzf` for running processes: + +`ps aux | fzf` + +- Select multiple files with `Shift + Tab` and write to a file: + +`find {{path/to/directory}} -type f | fzf --multi > {{path/to/file}}` + +- Start `fzf` with a specified query: + +`fzf --query "{{query}}"` + +- Start `fzf` on entries that start with core and end with either go, rb, or py: + +`fzf --query "^core go$ | rb$ | py$"` + +- Start `fzf` on entries that not match pyc and match exactly travis: + +`fzf --query "!pyc 'travis"` diff --git a/g++ b/g++ new file mode 100644 index 00000000..18d61b49 --- /dev/null +++ b/g++ @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# g++ + +> Compiles C++ source files. +> Part of GCC (GNU Compiler Collection). +> More information: . + +- Compile a source code file into an executable binary: + +`g++ {{path/to/source.cpp}} -o {{path/to/output_executable}}` + +- Display common warnings: + +`g++ {{path/to/source.cpp}} -Wall -o {{path/to/output_executable}}` + +- Choose a language standard to compile for (C++98/C++11/C++14/C++17): + +`g++ {{path/to/source.cpp}} -std={{c++98|c++11|c++14|c++17}} -o {{path/to/output_executable}}` + +- Include libraries located at a different path than the source file: + +`g++ {{path/to/source.cpp}} -o {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` + +- Compile and link multiple source code files into an executable binary: + +`g++ -c {{path/to/source1.cpp path/to/source2.cpp ...}} && g++ -o {{path/to/output_executable}} {{path/to/source1.o path/to/source2.o ...}}` + +- Optimize the compiled program for performance: + +`g++ {{path/to/source.cpp}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` + +- Display version: + +`g++ --version` diff --git a/gacutil b/gacutil new file mode 100644 index 00000000..528f64cb --- /dev/null +++ b/gacutil @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gacutil + +> Global Assembly Cache (CAG) management utility. +> More information: . + +- Install the specified assembly into GAC: + +`gacutil -i {{path/to/assembly.dll}}` + +- Uninstall the specified assembly from GAC: + +`gacutil -i {{assembly_display_name}}` + +- Print the content of GAC: + +`gacutil -l` diff --git a/gallery-dl b/gallery-dl new file mode 100644 index 00000000..c95ff32e --- /dev/null +++ b/gallery-dl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gallery-dl + +> Download image galleries and collections from several image hosting sites. +> More information: . + +- Download images from the specified URL: + +`gallery-dl "{{url}}"` + +- Retrieve pre-existing cookies from your web browser (useful for sites that require login): + +`gallery-dl --cookies-from-browser {{browser}} "{{url}}"` + +- Get the direct URL of an image from a site supporting authentication with username and password: + +`gallery-dl --get-urls --username {{username}} --password {{password}} "{{url}}"` + +- Filter manga chapters by chapter number and language: + +`gallery-dl --chapter-filter "{{10 <= chapter < 20}}" --option "lang={{language_code}}" "{{url}}"` diff --git a/gammastep b/gammastep new file mode 100644 index 00000000..3fdd4329 --- /dev/null +++ b/gammastep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Gammastep + +> Adjust the screen's color temperature according to the time of day. +> More information: . + +- Turn on Gammastep with a specific [t]emperature during the day (e.g. 5700k) and at night (e.g. 3600k): + +`gammastep -t {{5700}}:{{3600}}` + +- Turn on Gammastep with a manually specified custom [l]ocation: + +`gammastep -l {{latitude}}:{{longitude}}` + +- Turn on Gammastep with a specific screen [b]rightness during the day (e.g. 70%) and at night (e.g. 40%), with minimum brightness 10% and maximum brightness 100%: + +`gammastep -b {{0.7}}:{{0.4}}` + +- Turn on Gammastep with custom [g]amma levels (between 0 and 1): + +`gammastep -g {{red}}:{{green}}:{{blue}}` + +- Turn on Gammastep with a c[O]nstant unchanging color temperature: + +`gammastep -O {{temperature}}` + +- Reset temperature adjustments applied by Gammastep: + +`gammastep -x` diff --git a/ganache-cli b/ganache-cli new file mode 100644 index 00000000..2064dd65 --- /dev/null +++ b/ganache-cli @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ganache-cli + +> Command-line version of Ganache, your personal blockchain for Ethereum development. +> More information: . + +- Run Ganache: + +`ganache-cli` + +- Run Ganache with a specific number of accounts: + +`ganache-cli --accounts={{number_of_accounts}}` + +- Run Ganache and lock available accounts by default: + +`ganache-cli --secure` + +- Run Ganache server and unlock specific accounts: + +`ganache-cli --secure --unlock "{{account_private_key1}}" --unlock "{{account_private_key2}}"` + +- Run Ganache with a specific account and balance: + +`ganache-cli --account="{{account_private_key}},{{account_balance}}"` + +- Run Ganache with accounts with a default balance: + +`ganache-cli --defaultBalanceEther={{default_balance}}` + +- Run Ganache and log all requests to `stdout`: + +`ganache-cli --verbose` diff --git a/gatsby b/gatsby new file mode 100644 index 00000000..88bda4e9 --- /dev/null +++ b/gatsby @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gatsby + +> Static site generator for React. +> More information: . + +- Create a new site: + +`gatsby new {{site_name}}` + +- Create a new site with a Gatsby 'starter': + +`gatsby new {{site_name}} {{url_of_starter_github_repo}}` + +- Start a live-reloading local development server: + +`gatsby develop` + +- Perform a production build and generate static HTML: + +`gatsby build` + +- Start a local server which serves the production build: + +`gatsby serve` diff --git a/gcal b/gcal new file mode 100644 index 00000000..9ef4aec2 --- /dev/null +++ b/gcal @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcal + +> Displays calendar. +> More information: . + +- Display calendar for the current month: + +`gcal` + +- Display calendar for the month of February of the year 2010: + +`gcal {{2}} {{2010}}` + +- Provide calendar sheet with week numbers: + +`gcal --with-week-number` + +- Change starting day of week to 1st day of the week (Monday): + +`gcal --starting-day={{1}}` + +- Display the previous, current and next month surrounding today: + +`gcal .` diff --git a/gcalcli b/gcalcli new file mode 100644 index 00000000..dbaa863c --- /dev/null +++ b/gcalcli @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcalcli + +> Interact with Google Calendar. +> Requests Google API authorization upon first launch. +> More information: . + +- List your events for all your calendars over the next 7 days: + +`gcalcli agenda` + +- Show events starting from or between specific dates (also takes relative dates e.g. "tomorrow"): + +`gcalcli agenda {{mm/dd}} [{{mm/dd}}]` + +- List events from a specific calendar: + +`gcalcli --calendar {{calendar_name}} agenda` + +- Display an ASCII calendar of events by week: + +`gcalcli calw` + +- Display an ASCII calendar of events for a month: + +`gcalcli calm` + +- Quick-add an event to your calendar: + +`gcalcli --calendar {{calendar_name}} quick "{{mm/dd}} {{HH:MM}} {{event_name}}"` + +- Add an event to calendar. Triggers interactive prompt: + +`gcalcli --calendar "{{calendar_name}}" add` diff --git a/gcc b/gcc new file mode 100644 index 00000000..de13201a --- /dev/null +++ b/gcc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcc + +> Preprocess and compile C and C++ source files, then assemble and link them together. +> More information: . + +- Compile multiple source files into an executable: + +`gcc {{path/to/source1.c path/to/source2.c ...}} -o {{path/to/output_executable}}` + +- Show common warnings, debug symbols in output, and optimize without affecting debugging: + +`gcc {{path/to/source.c}} -Wall -g -Og -o {{path/to/output_executable}}` + +- Include libraries from a different path: + +`gcc {{path/to/source.c}} -o {{path/to/output_executable}} -I{{path/to/header}} -L{{path/to/library}} -l{{library_name}}` + +- Compile source code into Assembler instructions: + +`gcc -S {{path/to/source.c}}` + +- Compile source code into an object file without linking: + +`gcc -c {{path/to/source.c}}` + +- Optimize the compiled program for performance: + +`gcc {{path/to/source.c}} -O{{1|2|3|fast}} -o {{path/to/output_executable}}` diff --git a/gcloud b/gcloud new file mode 100644 index 00000000..a7621bf9 --- /dev/null +++ b/gcloud @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud + +> The official CLI tool for Google Cloud Platform. +> Note: `gcloud` subcommands have their own usage documentation. +> More information: . + +- List all properties in one's active configuration: + +`gcloud config list` + +- Login to a Google account: + +`gcloud auth login` + +- Set the active project: + +`gcloud config set project {{project_name}}` + +- SSH into a virtual machine instance: + +`gcloud compute ssh {{user}}@{{instance}}` + +- Display all Google Compute Engine instances in a project (by default instances from all zones are listed): + +`gcloud compute instances list` + +- Update a kubeconfig file with the appropriate credentials to point `kubectl` to a specific cluster in Google Kubernetes Engine (GKE): + +`gcloud container clusters get-credentials {{cluster_name}}` + +- Update all `gcloud` components: + +`gcloud components update` + +- Display help for a given command: + +`gcloud help {{command}}` diff --git a/gcloud-app b/gcloud-app new file mode 100644 index 00000000..c0b5a1cb --- /dev/null +++ b/gcloud-app @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud app + +> Build scalable applications on a managed serverless platform. +> See also: `gcloud`. +> More information: . + +- Deploy an app's code and configuration to the App Engine server: + +`gcloud app deploy {{deployables}}` + +- List all versions of all services deployed to the App Engine server: + +`gcloud app versions list` + +- Open the current app in a web browser: + +`gcloud app browse` + +- Create an App Engine app within the current project: + +`gcloud app create` + +- Display the latest App Engine app logs: + +`gcloud app logs read` diff --git a/gcloud-auth b/gcloud-auth new file mode 100644 index 00000000..df288201 --- /dev/null +++ b/gcloud-auth @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud auth + +> Grant and revoke authorization to `gcloud` and manage credentials. +> See also: `gcloud`. +> More information: . + +- Authorize Google Cloud access for the `gcloud` CLI with Google Cloud user credentials and set the current account as active: + +`gcloud auth login` + +- Authorize Google Cloud access similar to `gcloud auth login` but with service account credentials: + +`gcloud auth activate-service-account` + +- Manage Application Default Credentials (ADC) for Cloud Client Libraries: + +`gcloud auth application-default` + +- Display a list of Google Cloud accounts currently authenticated on your system: + +`gcloud auth list` + +- Display the current account's access token: + +`gcloud auth print-access-token` + +- Remove access credentials for an account: + +`gcloud auth revoke` diff --git a/gcloud-components-install b/gcloud-components-install new file mode 100644 index 00000000..60da5e71 --- /dev/null +++ b/gcloud-components-install @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud components install + +> Install components of the Google Cloud CLI, along with their dependencies. +> Installs components at the current version of the Google Cloud CLI without upgrading the existing installation. +> More information: . + +- View available components for installation: + +`gcloud components list` + +- Install one or more components (installs any dependencies as well): + +`gcloud components install {{component_id1 component_id2 ...}}` + +- Check the current version of Google Cloud CLI: + +`gcloud version` + +- Update Google Cloud CLI to the latest version: + +`gcloud components update` diff --git a/gcloud-components-update b/gcloud-components-update new file mode 100644 index 00000000..781c9f1b --- /dev/null +++ b/gcloud-components-update @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud components update + +> Update all your installed Google Cloud CLI components to the latest version. +> See also: `gcloud`. +> More information: . + +- Update all components to the latest version: + +`gcloud components update` + +- Update all components to a specific version: + +`gcloud components update --version={{1.2.3}}` + +- Update components without confirmation (useful for automation scripts): + +`gcloud components update --quiet` diff --git a/gcloud-compute b/gcloud-compute new file mode 100644 index 00000000..d7fabe1f --- /dev/null +++ b/gcloud-compute @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud compute + +> Create, run, and manage VMs on Google Cloud infrastructure. +> See also: `gcloud`. +> More information: . + +- List Compute Engine zones: + +`gcloud compute zones list` + +- Create a VM instance: + +`gcloud compute instances create {{instance_name}}` + +- Display a VM instance's details: + +`gcloud compute instances describe {{instance_name}}` + +- List all VM instances in a project: + +`gcloud compute instances list` + +- Create a snapshot of a persistent disk: + +`gcloud compute disks snapshot {{disk_name}} --snapshot-names {{snapshot_name}}` + +- Display a snapshot's details: + +`gcloud compute snapshots describe {{snapshot_name}}` + +- Delete a snapshot: + +`gcloud compute snapshots delete {{snapshot_name}}` + +- Connect to a VM instance using SSH: + +`gcloud compute ssh {{instance_name}}` diff --git a/gcloud-config b/gcloud-config new file mode 100644 index 00000000..fbdac006 --- /dev/null +++ b/gcloud-config @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud config + +> Manage different configurations of `gcloud`. +> See also: `gcloud`. +> More information: . + +- Define a property (like compute/zone) for the current configuration: + +`gcloud config set {{property}} {{value}}` + +- Fetch the value of a `gcloud` property: + +`gcloud config get {{property}}` + +- Display all the properties for the current configuration: + +`gcloud config list` + +- Create a new configuration with a given name: + +`gcloud config configurations create {{configuration_name}}` + +- Display a list of all available configurations: + +`gcloud config configurations list` + +- Switch to an existing configuration with a given name: + +`gcloud config configurations activate {{configuration_name}}` diff --git a/gcloud-config-set b/gcloud-config-set new file mode 100644 index 00000000..c607dac1 --- /dev/null +++ b/gcloud-config-set @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud config set + +> Set a property in the Google Cloud CLI configuration. +> Properties control various aspects of Google Cloud CLI behavior. +> More information: . + +- Set the project property in the core section: + +`gcloud config set project {{project_id}}` + +- Set the compute zone for future operations: + +`gcloud config set compute/zone {{zone_name}}` + +- Disable prompting to make gcloud suitable for scripting: + +`gcloud config set disable_prompts true` + +- View the list of properties currently in use: + +`gcloud config list` + +- Unset a previously set property: + +`gcloud config unset {{property_name}}` + +- Create a new configuration profile: + +`gcloud config configurations create {{configuration_name}}` + +- Switch between different configuration profiles: + +`gcloud config configurations activate {{configuration_name}}` diff --git a/gcloud-container b/gcloud-container new file mode 100644 index 00000000..0f0ca433 --- /dev/null +++ b/gcloud-container @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud container + +> Manage containerized applications on Kubernetes and clusters. +> See also: `gcloud`. +> More information: . + +- Register `gcloud` as a Docker credential helper: + +`gcloud auth configure-docker` + +- Create a cluster to run GKE containers: + +`gcloud container clusters create {{cluster_name}}` + +- List clusters for running GKE containers: + +`gcloud container clusters list` + +- Update kubeconfig to get `kubectl` to use a GKE cluster: + +`gcloud container clusters get-credentials {{cluster_name}}` + +- List tag and digest metadata for a container image: + +`gcloud container images list-tags {{image}}` diff --git a/gcloud-feedback b/gcloud-feedback new file mode 100644 index 00000000..f304c25b --- /dev/null +++ b/gcloud-feedback @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud feedback + +> Provide feedback to the Google Cloud team. +> See also: `gcloud`. +> More information: . + +- Provide feedback to the `gcloud` team: + +`gcloud feedback` + +- Provide feedback to the `gcloud` team and attach a log file: + +`gcloud feedback --log-file {{log_file}}` diff --git a/gcloud-help b/gcloud-help new file mode 100644 index 00000000..e2a9e324 --- /dev/null +++ b/gcloud-help @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud help + +> Display help and reference information for `gcloud`. +> For supplementary help for topics not directly associated with individual commands, see also `tldr gcloud topic`. +> More information: . + +- Search the `gcloud` CLI reference documents for specific terms: + +`gcloud help` diff --git a/gcloud-iam b/gcloud-iam new file mode 100644 index 00000000..968eb5ff --- /dev/null +++ b/gcloud-iam @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud iam + +> Configure Identity and Access Management (IAM) preferences and service accounts. +> See also: `gcloud`. +> More information: . + +- List IAM grantable roles for a resource: + +`gcloud iam list-grantable-roles {{resource}}` + +- Create a custom role for a organization or project: + +`gcloud iam roles create {{role_name}} --{{organization|project}} {{organization|project_id}} --file {{path/to/role.yaml}}` + +- Create a service account for a project: + +`gcloud iam service-accounts create {{name}}` + +- Add an IAM policy binding to a service account: + +`gcloud iam service-accounts add-iam-policy-binding {{service_account_email}} --member {{member}} --role {{role}}` + +- Replace existing IAM policy binding: + +`gcloud iam service-accounts set-iam-policy {{service_account_email}} {{policy_file}}` + +- List a service account's keys: + +`gcloud iam service-accounts keys list --iam-account {{service_account_email}}` diff --git a/gcloud-info b/gcloud-info new file mode 100644 index 00000000..7febb8b0 --- /dev/null +++ b/gcloud-info @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud info + +> Display information about the current `gcloud` environment. +> More information: . + +- Display `gcloud` environment information: + +`gcloud info` + +- Check network connectivity and hidden properties: + +`gcloud info --run-diagnostics` + +- Print the contents of the most recent log file: + +`gcloud info --show-log` diff --git a/gcloud-init b/gcloud-init new file mode 100644 index 00000000..da9a5849 --- /dev/null +++ b/gcloud-init @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud init + +> Launch an interactive workflow to setup `gcloud` or reinitialize configurations. +> More information: . + +- Launch a "Getting Started" workflow: + +`gcloud init` + +- Launch a workflow without diagnostics: + +`gcloud init --skip-diagnostics` + +- Use the console for authentication: + +`gcloud init --console-only` diff --git a/gcloud-kms-decrypt b/gcloud-kms-decrypt new file mode 100644 index 00000000..59a03b55 --- /dev/null +++ b/gcloud-kms-decrypt @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud kms decrypt + +> Decrypt a ciphertext file using a Cloud KMS key. +> See also: `gcloud`. +> More information: . + +- Decrypt a file using a specified key, key ring, and location: + +`gcloud kms decrypt --key={{key_name}} --keyring={{keyring_name}} --location={{global}} --ciphertext-file={{path/to/ciphertext}} --plaintext-file={{path/to/plaintext}}` + +- Decrypt a file with additional authenticated data (AAD) and write the decrypted plaintext to `stdout`: + +`gcloud kms decrypt --key={{key_name}} --keyring={{keyring_name}} --location={{global}} --additional-authenticated-data-file={{path/to/file.aad}} --ciphertext-file={{path/to/ciphertext}} --plaintext-file=-` diff --git a/gcloud-logging-logs-list b/gcloud-logging-logs-list new file mode 100644 index 00000000..ebb1fe72 --- /dev/null +++ b/gcloud-logging-logs-list @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud logging logs list + +> List logs in a Google Cloud project. +> Useful for identifying available logs for monitoring and analysis. See also: `gcloud`. +> More information: . + +- List all logs in the current project: + +`gcloud logging logs list` + +- List all logs for a specific log bucket and location: + +`gcloud logging logs list --bucket={{bucket_id}} --location={{location}}` + +- List all logs for a specific view in a log bucket: + +`gcloud logging logs list --bucket={{bucket_id}} --location={{location}} --view={{view_id}}` + +- List logs with a filter expression: + +`gcloud logging logs list --filter="{{expression}}"` + +- List a specified number of logs: + +`gcloud logging logs list --limit={{number}}` + +- List logs sorted by a specific field in ascending or descending order (`~` for descending): + +`gcloud logging logs list --sort-by="{{field_name}}"` + +- List logs sorted by multiple fields: + +`gcloud logging logs list --sort-by="{{field1}},~{{field2}}"` + +- List logs with verbose output, showing additional details: + +`gcloud logging logs list --verbosity=debug` diff --git a/gcloud-projects b/gcloud-projects new file mode 100644 index 00000000..258caede --- /dev/null +++ b/gcloud-projects @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud projects + +> Manage project access policies in Google Cloud. +> See also: `gcloud`. +> More information: . + +- Create a new project: + +`gcloud projects create {{project_id|project_number}}` + +- List all active projects: + +`gcloud projects list` + +- Display metadata for a project: + +`gcloud projects describe {{project_id}}` + +- Delete a project: + +`gcloud projects delete {{project_id|project_number}}` + +- Add an IAM policy binding to a specified project: + +`gcloud projects add-iam-policy-binding {{project_id}} --member {{principal}} --role {{role}}` diff --git a/gcloud-sql-backups-describe b/gcloud-sql-backups-describe new file mode 100644 index 00000000..f6d9f2f1 --- /dev/null +++ b/gcloud-sql-backups-describe @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud sql backups describe + +> Retrieve information about a backup. +> See also: `gcloud`. +> More information: . + +- Retrieve information about a backup: + +`gcloud sql backups describe {{backup_id}} --instance={{instance_id}}` diff --git a/gcloud-sql-export-sql b/gcloud-sql-export-sql new file mode 100644 index 00000000..d750efd8 --- /dev/null +++ b/gcloud-sql-export-sql @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud sql export sql + +> Export data from a Cloud SQL instance to a SQL file in Google Cloud Storage. +> Useful for creating backups or migrating data. See also: `gcloud`. +> More information: . + +- Export data from a specific Cloud SQL instance to a Google Cloud Storage bucket as a SQL dump file: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}}` + +- Export data asynchronously, returning immediately without waiting for the operation to complete: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}} --async` + +- Export data from specific databases within the Cloud SQL instance: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}} --database={{database1,database2,...}}` + +- Export specific tables from a specified database within the Cloud SQL instance: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}} --database={{database}} --table={{table1,table2,...}}` + +- Export data while offloading the operation to a temporary instance to reduce strain on the source instance: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}} --offload` + +- Export data and compress the output with `gzip`: + +`gcloud sql export sql {{instance}} gs://{{bucket_name}}/{{file_name}}.gz` diff --git a/gcloud-topic b/gcloud-topic new file mode 100644 index 00000000..bc528dfe --- /dev/null +++ b/gcloud-topic @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud topic + +> Provides supplementary help for topics not directly associated with individual commands. See also `gcloud`. +> For general help, see `tldr gcloud help`. +> More information: . + +- View supplementary help material for non-command topics like accessibility, filtering, and formatting: + +`gcloud topic {{topic_name}}` + +- List all available topics: + +`gcloud topic --help` diff --git a/gcloud-version b/gcloud-version new file mode 100644 index 00000000..400cb226 --- /dev/null +++ b/gcloud-version @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcloud-version + +> Print version information for Google Cloud CLI components. +> More information: . + +- Display version information for all installed components, along with available updates to them: + +`gcloud version` + +- Display help: + +`gcloud version --help` diff --git a/gcpdiag b/gcpdiag new file mode 100644 index 00000000..8d413d86 --- /dev/null +++ b/gcpdiag @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcpdiag + +> Google Cloud Platform troubleshooting and diagnostics tool. +> Run in a docker container or in GCP Cloudshell. +> More information: . + +- Run `gcpdiag` on your project, returning all rules: + +`gcpdiag lint --project={{gcp_project_id}}` + +- Hide rules that are ok: + +`gcpdiag lint --project={{gcp_project_id}} --hide-ok` + +- Authenticate using a service account private key file: + +`gcpdiag lint --project={{gcp_project_id}} --auth-key {{path/to/private_key}}` + +- Search logs and metrics from a number of days back (default: 3 days): + +`gcpdiag lint --project={{gcp_project_id}} --within-days {{number}}` + +- Display help: + +`gcpdiag lint --help` diff --git a/gdal2tiles.py b/gdal2tiles.py new file mode 100644 index 00000000..8f39176d --- /dev/null +++ b/gdal2tiles.py @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdal2tiles.py + +> Generate TMS or XYZ tiles for a raster dataset. +> More information: . + +- Generate TMS tiles for the zoom levels 2 to 5 of a raster dataset: + +`gdal2tiles.py --zoom 2-5 {{path/to/input.tif}} {{path/to/output_directory}}` + +- Generate XYZ tiles for the zoom levels 2 to 5 of a raster dataset: + +`gdal2tiles.py --zoom 2-5 --xyz {{path/to/input.tif}} {{path/to/output_directory}}` diff --git a/gdal_contour b/gdal_contour new file mode 100644 index 00000000..31971a01 --- /dev/null +++ b/gdal_contour @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdal_contour + +> Create contour lines and polygons from a digital elevation model. +> More information: . + +- Create a vector dataset with contour lines spread over an 100-meter [i]nterval while [a]ttributing the elevation property as "ele": + +`gdal_contour -a {{ele}} -i {{100.0}} {{path/to/input.tif}} {{path/to/output.gpkg}}` + +- Create a vector dataset with [p]olygons spread over an 100-meter [i]nterval: + +`gdal_contour -i {{100.0}} -p {{path/to/input.tif}} {{path/to/output.gpkg}}` diff --git a/gdal_translate b/gdal_translate new file mode 100644 index 00000000..fc4596db --- /dev/null +++ b/gdal_translate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdal_translate + +> Convert raster data between different formats. +> More information: . + +- Convert a raster dataset to JPEG format: + +`gdal_translate -of {{JPEG}} {{path/to/input.tif}} {{path/to/output.jpeg}}` + +- Assign a projection to a raster dataset: + +`gdal_translate -a_srs {{EPSG:4326}} {{path/to/input.tif}} {{path/to/output.tif}}` + +- Reduce the size of a raster dataset to a specific fraction: + +`gdal_translate -outsize {{40%}} {{40%}} {{path/to/input.tif}} {{path/to/output.tif}}` + +- Convert a GeoTiff to a Cloud Optimized GeoTiff: + +`gdal_translate {{path/to/input.tif}} {{path/to/output.tif}} -of COG -co COMPRESS=LZW` diff --git a/gdaladdo b/gdaladdo new file mode 100644 index 00000000..69d40d0d --- /dev/null +++ b/gdaladdo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdaladdo + +> Build overview images of raster datasets. +> More information: . + +- Build overview images of a raster dataset using the "average" [r]esampling method: + +`gdaladdo -r average {{path/to/input.tif}}` diff --git a/gdalbuildvrt b/gdalbuildvrt new file mode 100644 index 00000000..3c331ad1 --- /dev/null +++ b/gdalbuildvrt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdalbuildvrt + +> Build Virtual Datasets from a list of existing datasets. +> More information: . + +- Make a virtual mosaic from all TIFF files contained in a directory: + +`gdalbuildvrt {{path/to/output.vrt}} {{path/to/input_directory/*.tif}}` + +- Make a virtual mosaic from files whose name is specified in a text file: + +`gdalbuildvrt -input_file_list {{path/to/list.txt}} {{path/to/output.vrt}}` + +- Make an RGB virtual mosaic from 3 single-band input files: + +`gdalbuildvrt -separate {{path/to/rgb.vrt}} {{path/to/red.tif}} {{path/to/green.tif}} {{path/to/blue.tif}}` + +- Make a virtual mosaic with blue background color (RGB: 0 0 255): + +`gdalbuildvrt -hidenodata -vrtnodata "{{0 0 255}}" {{path/to/output.vrt}} {{path/to/input_directory/*.tif}}` diff --git a/gdaldem b/gdaldem new file mode 100644 index 00000000..305f73af --- /dev/null +++ b/gdaldem @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdaldem + +> Analyze and visualize digital elevation models (DEM). +> More information: . + +- Compute the hillshade of a DEM: + +`gdaldem hillshade {{path/to/input.tif}} {{path/to/output.tif}}` + +- Compute the slope of a DEM: + +`gdaldem slope {{path/to/input.tif}} {{path/to/output.tif}}` + +- Compute the aspect of a DEM: + +`gdaldem aspect {{path/to/input.tif}} {{path/to/output.tif}}` diff --git a/gdalinfo b/gdalinfo new file mode 100644 index 00000000..afbd084e --- /dev/null +++ b/gdalinfo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdalinfo + +> List various information about a GDAL supported raster dataset. +> More information: . + +- List all supported raster formats: + +`gdalinfo --formats` + +- List information about a specific raster dataset: + +`gdalinfo {{path/to/input.tif}}` + +- List information about a specific raster dataset in JSON format: + +`gdalinfo -json {{path/to/input.tif}}` + +- Show histogram values of a specific raster dataset: + +`gdalinfo -hist {{path/to/input.tif}}` + +- List information about a Web Map Service (WMS): + +`gdalinfo WMS:{{https://services.meggsimum.de/geoserver/ows}}` + +- List information about a specific dataset of a Web Map Service (WMS): + +`gdalinfo WMS:{{https://services.meggsimum.de/geoserver/ows}} -sd {{4}}` diff --git a/gdalwarp b/gdalwarp new file mode 100644 index 00000000..4357f758 --- /dev/null +++ b/gdalwarp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdalwarp + +> Image reprojection and warping utility. +> More information: . + +- Reproject a raster dataset: + +`gdalwarp -t_srs {{EPSG:4326}} {{path/to/input.tif}} {{path/to/output.tif}}` + +- Crop a raster dataset by using specific coordinates: + +`gdalwarp -te {{min_x}} {{min_y}} {{max_x}} {{max_y}} -te_srs {{EPSG:4326}} {{path/to/input.tif}} {{path/to/output.tif}}` + +- Crop a raster dataset using a vector layer: + +`gdalwarp -cutline {{path/to/area_to_cut.geojson}} -crop_to_cutline {{path/to/input.tif}} {{path/to/output.tif}}` diff --git a/gdb b/gdb new file mode 100644 index 00000000..d9790b7e --- /dev/null +++ b/gdb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdb + +> The GNU Debugger. +> More information: . + +- Debug an executable: + +`gdb {{executable}}` + +- Attach a process to gdb: + +`gdb -p {{procID}}` + +- Debug with a core file: + +`gdb -c {{core}} {{executable}}` + +- Execute given GDB commands upon start: + +`gdb -ex "{{commands}}" {{executable}}` + +- Start `gdb` and pass arguments to the executable: + +`gdb --args {{executable}} {{argument1}} {{argument2}}` diff --git a/gdc b/gdc new file mode 100644 index 00000000..25d64007 --- /dev/null +++ b/gdc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdc + +> D compiler using GCC as a backend. +> More information: . + +- Create an executable: + +`gdc {{path/to/source.d}} -o {{path/to/output_executable}}` + +- Print information about module dependencies: + +`gdc -fdeps` + +- Generate Ddoc documentation: + +`gdc -fdoc` + +- Generate D interface files: + +`gdc -fintfc` + +- Do not link the standard GCC libraries in the compilation: + +`gdc -nostdlib` diff --git a/gdrive b/gdrive new file mode 100644 index 00000000..7552a294 --- /dev/null +++ b/gdrive @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdrive + +> Interact with Google Drive. +> Folder/file ID can be obtained from the Google Drive folder or ID URL. +> More information: . + +- Upload a local path to the parent folder with the specified ID: + +`gdrive upload -p {{id}} {{path/to/file_or_folder}}` + +- Download file or directory by ID to current directory: + +`gdrive download {{id}}` + +- Download to a given local path by its ID: + +`gdrive download --path {{path/to/folder}} {{id}}` + +- Create a new revision of an ID using a given file or folder: + +`gdrive update {{id}} {{path/to/file_or_folder}}` diff --git a/gdu b/gdu new file mode 100644 index 00000000..841717de --- /dev/null +++ b/gdu @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gdu + +> Disk usage analyzer with console interface. +> More information: . + +- Interactively show the disk usage of the current directory: + +`gdu` + +- Interactively show the disk usage of a given directory: + +`gdu {{path/to/directory}}` + +- Interactively show the disk usage of all mounted disks: + +`gdu --show-disks` + +- Interactively show the disk usage of the current directory but ignore some sub-directories: + +`gdu --ignore-dirs {{path/to/directory1,path/to/directory2,...}}` + +- Ignore paths by regular expression: + +`gdu --ignore-dirs-pattern '{{.*[abc]+}}'` + +- Ignore hidden directories: + +`gdu --no-hidden` + +- Only print the result, do not enter interactive mode: + +`gdu --non-interactive {{path/to/directory}}` + +- Do not show the progress in non-interactive mode (useful in scripts): + +`gdu --no-progress {{path/to/directory}}` diff --git a/gem b/gem new file mode 100644 index 00000000..cc72bf5b --- /dev/null +++ b/gem @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gem + +> A package manager for the Ruby programming language. +> More information: . + +- Search for remote gem(s) and show all available versions: + +`gem search {{regular_expression}} --all` + +- Install the latest version of a gem: + +`gem install {{gem_name}}` + +- Install a specific version of a gem: + +`gem install {{gem_name}} --version {{1.0.0}}` + +- Install the latest matching (SemVer) version of a gem: + +`gem install {{gem_name}} --version '~> {{1.0}}'` + +- Update a gem: + +`gem update {{gem_name}}` + +- List all local gems: + +`gem list` + +- Uninstall a gem: + +`gem uninstall {{gem_name}}` + +- Uninstall a specific version of a gem: + +`gem uninstall {{gem_name}} --version {{1.0.0}}` diff --git a/gemtopbm b/gemtopbm new file mode 100644 index 00000000..11e70c14 --- /dev/null +++ b/gemtopbm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gemtopbm + +> This command is superseded by `gemtopnm`. +> More information: . + +- View documentation for the current command: + +`tldr gemtopnm` diff --git a/gemtopnm b/gemtopnm new file mode 100644 index 00000000..6f6a138a --- /dev/null +++ b/gemtopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gemtopnm + +> Convert a GEM image file into a PNM image. +> More information: . + +- Convert a GEM image file to a PNM image: + +`gemtopnm {{path/to/file.img}} > {{path/to/output.pnm}}` + +- Describe the contents of the specified GEM image: + +`gemtopnm -d {{path/to/file.img}}` + +- Display version: + +`gemtopnm -version` diff --git a/get-nodeinstalllocation b/get-nodeinstalllocation new file mode 100644 index 00000000..d84b20bf --- /dev/null +++ b/get-nodeinstalllocation @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-NodeInstallLocation + +> Get the current Node.js installation directory for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Get the current Node.js installation directory: + +`Get-NodeInstallLocation` diff --git a/get-nodeversions b/get-nodeversions new file mode 100644 index 00000000..64eba7f7 --- /dev/null +++ b/get-nodeversions @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-NodeVersions + +> List installed and available Node.js versions for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- List all installed Node.js versions: + +`Get-NodeVersions` + +- List all available Node.js versions: + +`Get-NodeVersions -Remote` + +- List all available Node.js 20.x versions: + +`Get-NodeVersions -Remote -Filter ">=20.0.0 <21.0.0"` diff --git a/geth b/geth new file mode 100644 index 00000000..5374e1f1 --- /dev/null +++ b/geth @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# geth + +> The go-ethereum command-line interface. +> More information: . + +- Connect to the main Ethereum network and automatically download the full node: + +`geth` + +- Connect to the Ropsten test network: + +`geth --testnet` + +- Create a new account: + +`geth account new` + +- Enable mining: + +`geth --mine` diff --git a/gfortran b/gfortran new file mode 100644 index 00000000..760a51b7 --- /dev/null +++ b/gfortran @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gfortran + +> Preprocess and compile Fortran source files, then assemble and link them together. +> More information: . + +- Compile multiple source files into an executable: + +`gfortran {{path/to/source1.f90 path/to/source2.f90 ...}} -o {{path/to/output_executable}}` + +- Show common warnings, debug symbols in output, and optimize without affecting debugging: + +`gfortran {{path/to/source.f90}} -Wall -g -Og -o {{path/to/output_executable}}` + +- Include libraries from a different path: + +`gfortran {{path/to/source.f90}} -o {{path/to/output_executable}} -I{{path/to/mod_and_include}} -L{{path/to/library}} -l{{library_name}}` + +- Compile source code into Assembler instructions: + +`gfortran -S {{path/to/source.f90}}` + +- Compile source code into an object file without linking: + +`gfortran -c {{path/to/source.f90}}` diff --git a/gh b/gh new file mode 100644 index 00000000..afcfc2da --- /dev/null +++ b/gh @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh + +> Work seamlessly with GitHub. +> Some subcommands such as `gh config` have their own usage documentation. +> More information: . + +- Clone a GitHub repository locally: + +`gh repo clone {{owner}}/{{repository}}` + +- Create a new issue: + +`gh issue create` + +- View and filter the open issues of the current repository: + +`gh issue list` + +- View an issue in the default web browser: + +`gh issue view --web {{issue_number}}` + +- Create a pull request: + +`gh pr create` + +- View a pull request in the default web browser: + +`gh pr view --web {{pr_number}}` + +- Check out a specific pull request locally: + +`gh pr checkout {{pr_number}}` + +- Check the status of a repository's pull requests: + +`gh pr status` diff --git a/gh-alias b/gh-alias new file mode 100644 index 00000000..a0d30f65 --- /dev/null +++ b/gh-alias @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh alias + +> Manage GitHub CLI command aliases. +> More information: . + +- List all the aliases `gh` is configured to use: + +`gh alias list` + +- Create a `gh` subcommand alias: + +`gh alias set {{pv}} '{{pr view}}'` + +- Set a shell command as a `gh` subcommand: + +`gh alias set --shell {{alias_name}} {{command}}` + +- Delete a command shortcut: + +`gh alias delete {{alias_name}}` + +- Display the subcommand help: + +`gh alias` diff --git a/gh-api b/gh-api new file mode 100644 index 00000000..9886a7cb --- /dev/null +++ b/gh-api @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh api + +> Makes authenticated HTTP requests to the GitHub API and prints the response. +> More information: . + +- Display the releases for the current repository in JSON format: + +`gh api repos/:owner/:repo/releases` + +- Create a reaction for a specific issue: + +`gh api --header {{Accept:application/vnd.github.squirrel-girl-preview+json}} --raw-field '{{content=+1}}' {{repos/:owner/:repo/issues/123/reactions}}` + +- Display the result of a GraphQL query in JSON format: + +`gh api graphql --field {{name=':repo'}} --raw-field '{{query}}'` + +- Send a request using a custom HTTP method: + +`gh api --method {{POST}} {{endpoint}}` + +- Include the HTTP response headers in the output: + +`gh api --include {{endpoint}}` + +- Do not print the response body: + +`gh api --silent {{endpoint}}` + +- Send a request to a specific GitHub Enterprise Server: + +`gh api --hostname {{github.example.com}} {{endpoint}}` + +- Display the subcommand help: + +`gh api --help` diff --git a/gh-auth b/gh-auth new file mode 100644 index 00000000..ca097f5a --- /dev/null +++ b/gh-auth @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh auth + +> Authenticate with a GitHub host. +> More information: . + +- Log in with interactive prompt: + +`gh auth login` + +- Log in with a token from `stdin` (created in ): + +`echo {{your_token}} | gh auth login --with-token` + +- Check if you are logged in: + +`gh auth status` + +- Log out: + +`gh auth logout` + +- Log in with a specific GitHub Enterprise Server: + +`gh auth login --hostname {{github.example.com}}` + +- Refresh the session to ensure authentication credentials have the correct minimum scopes (removes additional scopes requested previously): + +`gh auth refresh` + +- Expand the permission scopes: + +`gh auth refresh --scopes {{repo,admin:repo_hook,admin:org,admin:public_key,admin:org_hook,...}}` diff --git a/gh-browse b/gh-browse new file mode 100644 index 00000000..22e8a78d --- /dev/null +++ b/gh-browse @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh browse + +> Open a GitHub repository in the browser or print the URL. +> More information: . + +- Open the homepage of the current repository in the default web browser: + +`gh browse` + +- Open the homepage of a specific repository in the default web browser: + +`gh browse {{owner}}/{{repository}}` + +- Open the settings page of the current repository in the default web browser: + +`gh browse --settings` + +- Open the wiki of the current repository in the default web browser: + +`gh browse --wiki` + +- Open a specific issue or pull request in the web browser: + +`gh browse {{issue_number|pull_request_number}}` + +- Open a specific branch in the web browser: + +`gh browse --branch {{branch_name}}` + +- Open a specific file or directory of the current repository in the web browser: + +`gh browse {{path/to/file_or_directory}}` + +- Print the destination URL without open the web browser: + +`gh browse --no-browser` diff --git a/gh-codespace b/gh-codespace new file mode 100644 index 00000000..1da5341a --- /dev/null +++ b/gh-codespace @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh codespace + +> Connect and manage your codespaces in GitHub. +> More information: . + +- Create a codespace in GitHub interactively: + +`gh codespace create` + +- List all available codespaces: + +`gh codespace list` + +- Connect to a codespace via SSH interactively: + +`gh codespace ssh` + +- Transfer a specific file to a codespace interactively: + +`gh codespace cp {{path/to/source_file}} remote:{{path/to/remote_file}}` + +- List the ports of a codespace interactively: + +`gh codespace ports` + +- Display the logs from a codespace interactively: + +`gh codespace logs` + +- Delete a codespace interactively: + +`gh codespace delete` + +- Display help for a subcommand: + +`gh codespace {{code|cp|create|delete|edit|...}} --help` diff --git a/gh-completion b/gh-completion new file mode 100644 index 00000000..6e975365 --- /dev/null +++ b/gh-completion @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh completion + +> Generate shell completion scripts for GitHub CLI commands. +> More information: . + +- Print a completion script: + +`gh completion --shell {{bash|zsh|fish|powershell}}` + +- Append the `gh` completion script to `~/.bashrc`: + +`gh completion --shell {{bash}} >> {{~/.bashrc}}` + +- Append the `gh` completion script to `~/.zshrc`: + +`gh completion --shell {{zsh}} >> {{~/.zshrc}}` + +- Display the subcommand help: + +`gh completion` diff --git a/gh-config b/gh-config new file mode 100644 index 00000000..14f10f43 --- /dev/null +++ b/gh-config @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh config + +> Change configuration for GitHub cli. +> More information: . + +- Display what Git protocol is being used: + +`gh config get git_protocol` + +- Set protocol to SSH: + +`gh config set git_protocol {{ssh}}` + +- Use `delta` in side-by-side mode as the default pager for all `gh` commands: + +`gh config set pager '{{delta --side-by-side}}'` + +- Set text editor to Vim: + +`gh config set editor {{vim}}` + +- Reset to default text editor: + +`gh config set editor {{""}}` + +- Disable interactive prompts: + +`gh config set prompt {{disabled}}` + +- Set a specific configuration value: + +`gh config set {{key}} {{value}}` diff --git a/gh-cs b/gh-cs new file mode 100644 index 00000000..a6ce65a0 --- /dev/null +++ b/gh-cs @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh cs + +> This command is an alias of `gh codespace`. +> More information: . + +- View documentation for the original command: + +`tldr gh-codespace` diff --git a/gh-environment b/gh-environment new file mode 100644 index 00000000..e682cda6 --- /dev/null +++ b/gh-environment @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh environment + +> Display help about environment variables for the GitHub CLI command. +> More information: . + +- Display help about environment variables that can be used with `gh`: + +`gh environment` diff --git a/gh-extension b/gh-extension new file mode 100644 index 00000000..db7d9814 --- /dev/null +++ b/gh-extension @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh extension + +> Manage extensions for the GitHub CLI. +> More information: . + +- Initialize a new GitHub CLI extension project in a directory of the same name: + +`gh extension create {{extension_name}}` + +- Install an extension from a GitHub repository: + +`gh extension install {{owner}}/{{repository}}` + +- List installed extensions: + +`gh extension list` + +- Upgrade a specific extension: + +`gh extension upgrade {{extension_name}}` + +- Upgrade all extensions: + +`gh extension upgrade --all` + +- List installed extensions: + +`gh extension list` + +- Remove an extension: + +`gh extension remove {{extension_name}}` + +- Display help about a subcommand: + +`gh extension {{subcommand}} --help` diff --git a/gh-formatting b/gh-formatting new file mode 100644 index 00000000..3972a767 --- /dev/null +++ b/gh-formatting @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh formatting + +> Formatting options for JSON data exported from gh GitHub CLI command. +> More information: . + +- Display help about formatting JSON output from `gh` using `jq`: + +`gh formatting` diff --git a/gh-gist b/gh-gist new file mode 100644 index 00000000..a4bed42a --- /dev/null +++ b/gh-gist @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh gist + +> Work with GitHub Gists. +> More information: . + +- Create a new Gist from one or more files: + +`gh gist create {{path/to/file1 path/to/file2 ...}}` + +- Create a new Gist with a specific [desc]ription: + +`gh gist create {{path/to/file1 path/to/file2 ...}} --desc "{{description}}"` + +- Edit a Gist: + +`gh gist edit {{id|url}}` + +- List up to 42 Gists owned by the currently logged in user: + +`gh gist list --limit {{42}}` + +- View a Gist in the default browser without rendering Markdown: + +`gh gist view {{id|url}} --web --raw` diff --git a/gh-help b/gh-help new file mode 100644 index 00000000..4dfe7881 --- /dev/null +++ b/gh-help @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh help + +> Display help about the GitHub CLI command. +> More information: . + +- Display general help: + +`gh help` + +- Display help for the `gh help` subcommand: + +`gh help --help` + +- Display help about environment variables that can be used with `gh`: + +`gh help environment` + +- Display a markdown reference of all `gh` commands: + +`gh help reference` + +- Display help about formatting JSON output from `gh` using `jq`: + +`gh help formatting` + +- Display help about using `gh` with MinTTY: + +`gh help mintty` + +- Display help for a subcommand: + +`gh help {{subcommand}}` + +- Display help for a subcommand action: + +`gh help {{pr}} {{create}}` diff --git a/gh-issue b/gh-issue new file mode 100644 index 00000000..d8d97a33 --- /dev/null +++ b/gh-issue @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh issue + +> Manage GitHub issues. +> More information: . + +- Display a specific issue: + +`gh issue view {{issue_number}}` + +- Display a specific issue in the default web browser: + +`gh issue view {{issue_number}} --web` + +- Create a new issue in the default web browser: + +`gh issue create --web` + +- List the last 10 issues with the `bug` label: + +`gh issue list --limit {{10}} --label "{{bug}}"` + +- List closed issues made by a specific user: + +`gh issue list --state closed --author {{username}}` + +- Display the status of issues relevant to the user, in a specific repository: + +`gh issue status --repo {{owner}}/{{repository}}` + +- Reopen a specific issue: + +`gh issue reopen {{issue_number}}` diff --git a/gh-issue-create b/gh-issue-create new file mode 100644 index 00000000..c77c9b84 --- /dev/null +++ b/gh-issue-create @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh issue create + +> Create GitHub issues on a repository. +> More information: . + +- Create a new issue against the current repository interactively: + +`gh issue create` + +- Create a new issue with the `bug` label interactively: + +`gh issue create --label "{{bug}}"` + +- Create a new issue interactively and assign it to the specified users: + +`gh issue create --assignee {{user1,user2,...}}` + +- Create a new issue with a title, body and assign it to the current user: + +`gh issue create --title "{{title}}" --body "{{body}}" --assignee "{{@me}}"` + +- Create a new issue interactively, reading the body text from a file: + +`gh issue create --body-file {{path/to/file}}` + +- Create a new issue in the default web browser: + +`gh issue create --web` + +- Display the help: + +`gh issue create --help` diff --git a/gh-label b/gh-label new file mode 100644 index 00000000..ecd508b7 --- /dev/null +++ b/gh-label @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh label + +> Work with GitHub labels. +> More information: . + +- List labels for the repository in the current directory: + +`gh label list` + +- View labels for the repository in the current directory in the default web browser: + +`gh label list --web` + +- Create a label with a specific name, description and color in hexadecimal format for the repository in the current directory: + +`gh label create {{name}} --description "{{description}}" --color {{color_hex}}` + +- Delete a label for the repository in the current directory, prompting for confirmation: + +`gh label delete {{name}}` + +- Update the name and description for a specific label for the repository in the current directory: + +`gh label edit {{name}} --name {{new_name}} --description "{{description}}"` + +- Clone labels from a specific repository into the repository in the current directory: + +`gh label clone {{owner}}/{{repository}}` + +- Display help for a subcommand: + +`gh label {{subcommand}} --help` diff --git a/gh-mintty b/gh-mintty new file mode 100644 index 00000000..a6b3629c --- /dev/null +++ b/gh-mintty @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh mintty + +> Display help about MinTTY integration for the GitHub CLI command. +> More information: . + +- Display help about using `gh` with MinTTY: + +`gh mintty` diff --git a/gh-pr b/gh-pr new file mode 100644 index 00000000..7e200a85 --- /dev/null +++ b/gh-pr @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh pr + +> Manage GitHub pull requests. +> Some subcommands such as `gh pr create` have their own usage documentation. +> More information: . + +- Create a pull request: + +`gh pr create` + +- Check out a specific pull request locally: + +`gh pr checkout {{pr_number}}` + +- View the changes made in the pull request for the current branch: + +`gh pr diff` + +- Approve the pull request for the current branch: + +`gh pr review --approve` + +- Merge the pull request associated with the current branch interactively: + +`gh pr merge` + +- Edit a pull request interactively: + +`gh pr edit` + +- Edit the base branch of a pull request: + +`gh pr edit --base {{branch_name}}` + +- Check the status of the current repository's pull requests: + +`gh pr status` diff --git a/gh-pr-create b/gh-pr-create new file mode 100644 index 00000000..4fdba227 --- /dev/null +++ b/gh-pr-create @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh pr create + +> Manage GitHub pull requests. +> More information: . + +- Interactively create a pull request: + +`gh pr create` + +- Create a pull request, determining the title and description from the commit messages of the current branch: + +`gh pr create --fill` + +- Create a draft pull request: + +`gh pr create --draft` + +- Create a pull request specifying the base branch, title, and description: + +`gh pr create --base {{base_branch}} --title "{{title}}" --body "{{body}}"` + +- Start opening a pull request in the default web browser: + +`gh pr create --web` diff --git a/gh-pr-merge b/gh-pr-merge new file mode 100644 index 00000000..559634ad --- /dev/null +++ b/gh-pr-merge @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh pr merge + +> Merge GitHub pull requests. +> More information: . + +- Merge the pull request associated with the current branch interactively: + +`gh pr merge` + +- Merge the specified pull request, interactively: + +`gh pr merge {{pr_number}}` + +- Merge the pull request, removing the branch on both the local and the remote: + +`gh pr merge --delete-branch` + +- Merge the current pull request with the specified merge strategy: + +`gh pr merge --{{merge|squash|rebase}}` + +- Merge the current pull request with the specified merge strategy and commit message: + +`gh pr merge --{{merge|squash|rebase}} --subject {{commit_message}}` + +- Squash the current pull request into one commit with the message body and merge: + +`gh pr merge --squash --body="{{commit_message_body}}"` + +- Display help: + +`gh pr merge --help` diff --git a/gh-reference b/gh-reference new file mode 100644 index 00000000..2bd2ade8 --- /dev/null +++ b/gh-reference @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh reference + +> Display a reference about the GitHub CLI command. +> More information: . + +- Display a markdown reference of all `gh` commands: + +`gh reference` diff --git a/gh-release b/gh-release new file mode 100644 index 00000000..1eac85a7 --- /dev/null +++ b/gh-release @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh release + +> Manage GitHub releases. +> More information: . + +- List releases in a GitHub repository, limited to 30 items: + +`gh release list` + +- Display information about a specific release: + +`gh release view {{tag}}` + +- Create a new release: + +`gh release create {{tag}}` + +- Delete a specific release: + +`gh release delete {{tag}}` + +- Download assets from a specific release: + +`gh release download {{tag}}` + +- Upload assets to a specific release: + +`gh release upload {{tag}} {{path/to/file1 path/to/file2 ...}}` diff --git a/gh-repo b/gh-repo new file mode 100644 index 00000000..6a2cff93 --- /dev/null +++ b/gh-repo @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh repo + +> Work with GitHub repositories. +> More information: . + +- Create a new repository (if the repository name is not set, the default name will be the name of the current directory): + +`gh repo create {{name}}` + +- Clone a repository: + +`gh repo clone {{owner}}/{{repository}}` + +- Fork and clone a repository: + +`gh repo fork {{owner}}/{{repository}} --clone` + +- View a repository in the default web browser: + +`gh repo view {{repository}} --web` + +- List repositories owned by a specific user or organization (if the owner is not set, the default owner will be the currently logged in user): + +`gh repo list {{owner}}` + +- List only non-forks repositories and limit the number of repositories to list (default: 30): + +`gh repo list {{owner}} --source -L {{limit}}` + +- List repositories with a specific primary coding language: + +`gh repo list {{owner}} --language {{language_name}}` diff --git a/gh-run b/gh-run new file mode 100644 index 00000000..da95b5cb --- /dev/null +++ b/gh-run @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh run + +> View, run and watch recent GitHub Actions workflow runs. +> More information: . + +- Interactively select a run to see information about the jobs: + +`gh run view` + +- Display information about a specific run: + +`gh run view {{workflow_run_number}}` + +- Display information about the steps of a job: + +`gh run view --job={{job_number}}` + +- Display the log of a job: + +`gh run view --job={{job_number}} --log` + +- Check a specific workflow and exit with a non-zero status if the run failed: + +`gh run view {{workflow_run_number}} --exit-status && {{echo "run pending or passed"}}` + +- Interactively select an active run and wait until it's done: + +`gh run watch` + +- Display the jobs for a run and wait until it's done: + +`gh run watch {{workflow_run_number}}` + +- Re-run a specific workflow: + +`gh run rerun {{workflow_run_number}}` diff --git a/gh-screensaver b/gh-screensaver new file mode 100644 index 00000000..07a0b206 --- /dev/null +++ b/gh-screensaver @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh screensaver + +> Extension for GitHub CLI that runs animated terminal screensavers. +> See also: `gh extension`. +> More information: . + +- Run a random screensaver: + +`gh screensaver` + +- Run a specific screensaver: + +`gh screensaver --saver {{fireworks|life|marquee|pipes|pollock|starfield}}` + +- Run the "marquee" screensaver with a specific text and font: + +`gh screensaver --saver {{marquee}} -- --message="{{message}}" --font={{font_name}}` + +- Run the "starfield" screensaver with a specific density and speed: + +`gh screensaver --saver {{starfield}} -- --density {{500}} --speed {{10}}` + +- List available screensavers: + +`gh screensaver --list` diff --git a/gh-secret b/gh-secret new file mode 100644 index 00000000..986afb88 --- /dev/null +++ b/gh-secret @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh secret + +> Manage GitHub secrets. +> More information: . + +- List secret keys for the current repository: + +`gh secret list` + +- List secret keys for a specific organization: + +`gh secret list --org {{organization}}` + +- List secret keys for a specific repository: + +`gh secret list --repo {{owner}}/{{repository}}` + +- Set a secret for the current repository (user will be prompted for the value): + +`gh secret set {{name}}` + +- Set a secret from a file for the current repository: + +`gh secret set {{name}} < {{path/to/file}}` + +- Set an organization secret for specific repositories: + +`gh secret set {{name}} --org {{organization}} --repos {{repository1,repository2}}` + +- Remove a secret for the current repository: + +`gh secret remove {{name}}` + +- Remove a secret for a specific organization: + +`gh secret remove {{name}} --org {{organization}}` diff --git a/gh-secret-set b/gh-secret-set new file mode 100644 index 00000000..0efb16ad --- /dev/null +++ b/gh-secret-set @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh secret set + +> Create or update GitHub secrets. +> More information: . + +- Set a secret for the current repository (user will be prompted for the value): + +`gh secret set {{name}}` + +- Set a secret from a file for the current repository: + +`gh secret set {{name}} < {{path/to/file}}` + +- Set a secret for a specific repository: + +`gh secret set {{name}} --body {{value}} --repo {{owner}}/{{repository}}` + +- Set an organization secret for specific repositories: + +`gh secret set {{name}} --org {{organization}} --repos "{{repository1,repository2,...}}"` + +- Set an organization secret with a specific visibility: + +`gh secret set {{name}} --org {{organization}} --visibility {{all|private|selected}}` diff --git a/gh-ssh-key b/gh-ssh-key new file mode 100644 index 00000000..326bb860 --- /dev/null +++ b/gh-ssh-key @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh ssh-key + +> Manage GitHub SSH keys. +> More information: . + +- Display help: + +`gh ssh-key` + +- List SSH keys for the currently authenticated user: + +`gh ssh-key list` + +- Add an SSH key to the currently authenticated user's account: + +`gh ssh-key add {{path/to/key.pub}}` + +- Add an SSH key to the currently authenticated user's account with a specific title: + +`gh ssh-key add --title {{title}} {{path/to/key.pub}}` diff --git a/gh-workflow b/gh-workflow new file mode 100644 index 00000000..2e4ca70f --- /dev/null +++ b/gh-workflow @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gh workflow + +> List, view, and run GitHub Actions workflows. +> More information: . + +- Interactively select a workflow to view the latest jobs for: + +`gh workflow view` + +- View a specific workflow in the default browser: + +`gh workflow view {{id|workflow_name|filename.yml}} --web` + +- Display the YAML definition of a specific workflow: + +`gh workflow view {{id|workflow_name|filename.yml}} --yaml` + +- Display the YAML definition for a specific Git branch or tag: + +`gh workflow view {{id|workflow_name|filename.yml}} --ref {{branch|tag_name}} --yaml` + +- List workflow files (use `--all` to include disabled workflows): + +`gh workflow list` + +- Run a manual workflow with parameters: + +`gh workflow run {{id|workflow_name|filename.yml}} {{--raw-field param1=value1 --raw-field param2=value2 ...}}` + +- Run a manual workflow using a specific branch or tag with JSON parameters from `stdin`: + +`echo '{{{"param1": "value1", "param2": "value2", ...}}}' | gh workflow run {{id|workflow_name|filename.yml}} --ref {{branch|tag_name}}` + +- Enable or disable a specific workflow: + +`gh workflow {{enable|disable}} {{id|workflow_name|filename.yml}}` diff --git a/ghc b/ghc new file mode 100644 index 00000000..f7242a5b --- /dev/null +++ b/ghc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ghc + +> The Glasgow Haskell Compiler. +> Compiles and links Haskell source files. +> More information: . + +- Find and compile all modules in the current directory: + +`ghc Main` + +- Compile a single file: + +`ghc {{path/to/file.hs}}` + +- Compile using extra optimization: + +`ghc -O {{path/to/file.hs}}` + +- Stop compilation after generating object files (.o): + +`ghc -c {{path/to/file.hs}}` + +- Start a REPL (interactive shell): + +`ghci` + +- Evaluate a single expression: + +`ghc -e {{expression}}` diff --git a/ghci b/ghci new file mode 100644 index 00000000..1b78e0ae --- /dev/null +++ b/ghci @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ghci + +> The Glasgow Haskell Compiler's interactive environment. +> More information: . + +- Start a REPL (interactive shell): + +`ghci` + +- Start a REPL and load the specified Haskell source file: + +`ghci {{source_file.hs}}` + +- Start a REPL and enable a language option: + +`ghci -X{{language_option}}` + +- Start a REPL and enable some level of compiler warnings (e.g. `all` or `compact`): + +`ghci -W{{warning_level}}` + +- Start a REPL with a colon-separated list of directories for finding source files: + +`ghci -i{{path/to/directory1:path/to/directory2:...}}` diff --git a/ghcup b/ghcup new file mode 100644 index 00000000..0b4e5d95 --- /dev/null +++ b/ghcup @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ghcup + +> Haskell toolchain installer. +> Install, manage, and update Haskell toolchains. +> More information: . + +- Start the interactive TUI: + +`ghcup tui` + +- List available GHC/cabal versions: + +`ghcup list` + +- Install the recommended GHC version: + +`ghcup install ghc` + +- Install a specific GHC version: + +`ghcup install ghc {{version}}` + +- Set the currently "active" GHC version: + +`ghcup set ghc {{version}}` + +- Install cabal-install: + +`ghcup install cabal` + +- Update `ghcup` itself: + +`ghcup upgrade` diff --git a/ghdl b/ghdl new file mode 100644 index 00000000..267cc8c3 --- /dev/null +++ b/ghdl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ghdl + +> Open-source simulator for the VHDL language. +> More information: . + +- Analyze a VHDL source file and produce an object file: + +`ghdl -a {{filename.vhdl}}` + +- Elaborate a design (where `design` is the name of a configuration unit, entity unit or architecture unit): + +`ghdl -e {{design}}` + +- Run an elaborated design: + +`ghdl -r {{design}}` + +- Run an elaborated design and dump output to a waveform file: + +`ghdl -r {{design}} --wave={{output.ghw}}` + +- Check the syntax of a VHDL source file: + +`ghdl -s {{filename.vhdl}}` + +- Display help: + +`ghdl --help` diff --git a/ghost b/ghost new file mode 100644 index 00000000..bedc77d8 --- /dev/null +++ b/ghost @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ghost + +> A blogging platform and headless CMS. +> More information: . + +- Install Ghost in the current directory: + +`ghost install` + +- Start an instance of Ghost: + +`ghost start` + +- Restart the Ghost instance: + +`ghost restart` + +- Check the system for any potential hiccups while installing or updating Ghost: + +`ghost doctor` + +- View the logs of a Ghost instance: + +`ghost log {{name}}` + +- Run a Ghost instance directly (used by process managers and for debugging): + +`ghost run` + +- View running Ghost processes: + +`ghost ls` + +- View or edit Ghost configuration: + +`ghost config {{key}} {{value}}` diff --git a/gibo b/gibo new file mode 100644 index 00000000..e0c42d10 --- /dev/null +++ b/gibo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gibo + +> Fetch gitignore boilerplates. +> More information: . + +- List available boilerplates: + +`gibo list` + +- Write a boilerplate to `stdout`: + +`gibo dump {{boilerplate}}` + +- Write a boilerplate to .gitignore: + +`gibo dump {{boilerplate}} >>{{.gitignore}}` + +- Search for boilerplates containing a given string: + +`gibo search {{string}}` + +- Update available local boilerplates: + +`gibo update` diff --git a/gifdiff b/gifdiff new file mode 100644 index 00000000..4b3dac3b --- /dev/null +++ b/gifdiff @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gifdiff + +> Compare two GIFs for identical visual appearance. +> See also: `gifsicle`. +> More information: . + +- Check how GIFs differ: + +`gifdiff {{path/to/first.gif}} {{path/to/second.gif}}` + +- Check if GIFs differ: + +`gifdiff --brief {{path/to/first.gif}} {{path/to/second.gif}}` diff --git a/gifsicle b/gifsicle new file mode 100644 index 00000000..99c29c92 --- /dev/null +++ b/gifsicle @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gifsicle + +> Create, edit, manipulate, and get information about GIF files. +> More information: . + +- Optimize a GIF as a new file: + +`gifsicle {{path/to/input.gif}} --optimize=3 -o {{path/to/output.gif}}` + +- Use [b]atch mode (modify each given file in place) and unoptimize a GIF: + +`gifsicle -b {{path/to/input.gif}} --unoptimize` + +- Extract a frame from a GIF: + +`gifsicle {{path/to/input.gif}} '#{{0}}' > {{path/to/first_frame.gif}}` + +- Make a GIF animation from selected GIFs: + +`gifsicle {{*.gif}} --delay={{10}} --loop > {{path/to/output.gif}}` + +- Reduce file size using lossy compression: + +`gifsicle -b {{path/to/input.gif}} --optimize=3 --lossy={{100}} --colors={{16}} --dither` + +- Delete the first 10 frames and all frames after frame 20 from a GIF: + +`gifsicle -b {{path/to/input.gif}} --delete '#{{0-9}}' '#{{20-}}'` + +- Modify all frames by cropping them to a rectangle, changing their scale, flipping them, and rotating them: + +`gifsicle -b --crop {{starting_x}},{{starting_y}}+{{rect_width}}x{{rect_height}} --scale {{0.25}} --flip-horizontal --rotate-{{90|180|270}} {{path/to/input.gif}}` diff --git a/giftopnm b/giftopnm new file mode 100644 index 00000000..10466128 --- /dev/null +++ b/giftopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# giftopnm + +> Convert a GIF file into a PNM image. +> More information: . + +- Convert a GIF image to a Netpbm image pixel-for-pixel: + +`giftopnm {{path/to/input.gif}} > {{path/to/output.pnm}}` + +- Display version: + +`giftopnm -version` diff --git a/gimp b/gimp new file mode 100644 index 00000000..ccb9d984 --- /dev/null +++ b/gimp @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gimp + +> GNU image manipulation program. +> See also: `krita`. +> More information: . + +- Start GIMP: + +`gimp` + +- Open specific files: + +`gimp {{path/to/image1 path/to/image2 ...}}` + +- Open specific files in a new window: + +`gimp --new-instance {{path/to/image1 path/to/image2 ...}}` + +- Start without a splash screen: + +`gimp --no-splash` + +- Print errors and warnings to the console instead of showing them in a dialog box: + +`gimp --console-messages` + +- Enable debugging signal handlers: + +`gimp --debug-handlers` diff --git a/gist b/gist new file mode 100644 index 00000000..93fa0bee --- /dev/null +++ b/gist @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gist + +> Upload code to https://gist.github.com. +> More information: . + +- Log in in gist on this computer: + +`gist --login` + +- Create a gist from any number of text files: + +`gist {{file.txt}} {{file2.txt}}` + +- Create a private gist with a description: + +`gist --private --description "{{A meaningful description}}" {{file.txt}}` + +- Read contents from `stdin` and create a gist from it: + +`{{echo "hello world"}} | gist` + +- List your public and private gists: + +`gist --list` + +- List all public gists for any user: + +`gist --list {{username}}` + +- Update a gist using the ID from URL: + +`gist --update {{GIST_ID}} {{file.txt}}` diff --git a/git b/git new file mode 100644 index 00000000..48134df8 --- /dev/null +++ b/git @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git + +> Distributed version control system. +> Some subcommands such as `commit`, `add`, `branch`, `checkout`, `push`, etc. have their own usage documentation. +> More information: . + +- Execute a Git subcommand: + +`git {{subcommand}}` + +- Execute a Git subcommand on a custom repository root path: + +`git -C {{path/to/repo}} {{subcommand}}` + +- Execute a Git subcommand with a given configuration set: + +`git -c '{{config.key}}={{value}}' {{subcommand}}` + +- Display help: + +`git --help` + +- Display help for a specific subcommand (like `clone`, `add`, `push`, `log`, etc.): + +`git help {{subcommand}}` + +- Display version: + +`git --version` diff --git a/git-abort b/git-abort new file mode 100644 index 00000000..5d7d79df --- /dev/null +++ b/git-abort @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git abort + +> Abort an ongoing rebase, merge, or cherry-pick. +> Part of `git-extras`. +> More information: . + +- Abort a Git rebase, merge, or cherry-pick: + +`git abort` diff --git a/git-add b/git-add new file mode 100644 index 00000000..e5999f20 --- /dev/null +++ b/git-add @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git add + +> Adds changed files to the index. +> More information: . + +- Add a file to the index: + +`git add {{path/to/file}}` + +- Add all files (tracked and untracked): + +`git add -A` + +- Only add already tracked files: + +`git add -u` + +- Also add ignored files: + +`git add -f` + +- Interactively stage parts of files: + +`git add -p` + +- Interactively stage parts of a given file: + +`git add -p {{path/to/file}}` + +- Interactively stage a file: + +`git add -i` diff --git a/git-alias b/git-alias new file mode 100644 index 00000000..8a5de36e --- /dev/null +++ b/git-alias @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git alias + +> Create shortcuts for Git commands. +> Part of `git-extras`. +> More information: . + +- List all aliases: + +`git alias` + +- Create a new alias: + +`git alias "{{name}}" "{{command}}"` + +- Search for an existing alias: + +`git alias ^{{name}}` diff --git a/git-am b/git-am new file mode 100644 index 00000000..d0a10ce6 --- /dev/null +++ b/git-am @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git am + +> Apply patch files and create a commit. Useful when receiving commits via email. +> See also `git format-patch`, which can generate patch files. +> More information: . + +- Apply and commit changes following a local patch file: + +`git am {{path/to/file.patch}}` + +- Apply and commit changes following a remote patch file: + +`curl -L {{https://example.com/file.patch}} | git apply` + +- Abort the process of applying a patch file: + +`git am --abort` + +- Apply as much of a patch file as possible, saving failed hunks to reject files: + +`git am --reject {{path/to/file.patch}}` diff --git a/git-annex b/git-annex new file mode 100644 index 00000000..7a10ab65 --- /dev/null +++ b/git-annex @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git annex + +> Manage files with Git, without checking their contents in. +> When a file is annexed, its content is moved into a key-value store, and a symlink is made that points to the content. +> More information: . + +- Initialize a repo with Git annex: + +`git annex init` + +- Add a file: + +`git annex add {{path/to/file_or_directory}}` + +- Show the current status of a file or directory: + +`git annex status {{path/to/file_or_directory}}` + +- Synchronize a local repository with a remote: + +`git annex {{remote}}` + +- Get a file or directory: + +`git annex get {{path/to/file_or_directory}}` + +- Display help: + +`git annex help` diff --git a/git-annotate b/git-annotate new file mode 100644 index 00000000..54deb1e4 --- /dev/null +++ b/git-annotate @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git annotate + +> Show commit hash and last author on each line of a file. +> See `git blame`, which is preferred over `git annotate`. +> `git annotate` is provided for those familiar with other version control systems. +> More information: . + +- Print a file with the author name and commit hash prepended to each line: + +`git annotate {{path/to/file}}` + +- Print a file with the author [e]mail and commit hash prepended to each line: + +`git annotate -e {{path/to/file}}` + +- Print only rows that match a regular expression: + +`git annotate -L :{{regexp}} {{path/to/file}}` diff --git a/git-apply b/git-apply new file mode 100644 index 00000000..8683193f --- /dev/null +++ b/git-apply @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git apply + +> Apply a patch to files and/or to the index without creating a commit. +> See also `git am`, which applies a patch and also creates a commit. +> More information: . + +- Print messages about the patched files: + +`git apply --verbose {{path/to/file}}` + +- Apply and add the patched files to the index: + +`git apply --index {{path/to/file}}` + +- Apply a remote patch file: + +`curl -L {{https://example.com/file.patch}} | git apply` + +- Output diffstat for the input and apply the patch: + +`git apply --stat --apply {{path/to/file}}` + +- Apply the patch in reverse: + +`git apply --reverse {{path/to/file}}` + +- Store the patch result in the index without modifying the working tree: + +`git apply --cache {{path/to/file}}` diff --git a/git-archive b/git-archive new file mode 100644 index 00000000..40d05017 --- /dev/null +++ b/git-archive @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git archive + +> Create an archive of files from a named tree. +> More information: . + +- Create a tar archive from the contents of the current HEAD and print it to `stdout`: + +`git archive --verbose HEAD` + +- Create a zip archive from the current HEAD and print it to `stdout`: + +`git archive --verbose --format zip HEAD` + +- Same as above, but write the zip archive to file: + +`git archive --verbose --output {{path/to/file.zip}} HEAD` + +- Create a tar archive from the contents of the latest commit on a specific branch: + +`git archive --output {{path/to/file.tar}} {{branch_name}}` + +- Create a tar archive from the contents of a specific directory: + +`git archive --output {{path/to/file.tar}} HEAD:{{path/to/directory}}` + +- Prepend a path to each file to archive it inside a specific directory: + +`git archive --output {{path/to/file.tar}} --prefix {{path/to/prepend}}/ HEAD` diff --git a/git-archive-file b/git-archive-file new file mode 100644 index 00000000..a5efda76 --- /dev/null +++ b/git-archive-file @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git archive-file + +> Export all the files of the current Git branch into a `zip` archive. +> Part of `git-extras`. +> More information: . + +- Pack the currently checked out commit into a `zip` archive: + +`git archive-file` diff --git a/git-authors b/git-authors new file mode 100644 index 00000000..a5ab506c --- /dev/null +++ b/git-authors @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git authors + +> Generate a list of committers of a Git repository. +> Part of `git-extras`. +> More information: . + +- Print a full list of committers to `stdout` instead of to the `AUTHORS` file: + +`git authors --list` + +- Append the list of committers to the `AUTHORS` file and open it in the default editor: + +`git authors` + +- Append the list of committers, excluding emails, to the `AUTHORS` file and open it in the default editor: + +`git authors --no-email` diff --git a/git-bisect b/git-bisect new file mode 100644 index 00000000..68303f17 --- /dev/null +++ b/git-bisect @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git bisect + +> Use binary search to find the commit that introduced a bug. +> Git automatically jumps back and forth in the commit graph to progressively narrow down the faulty commit. +> More information: . + +- Start a bisect session on a commit range bounded by a known buggy commit, and a known clean (typically older) one: + +`git bisect start {{bad_commit}} {{good_commit}}` + +- For each commit that `git bisect` selects, mark it as "bad" or "good" after testing it for the issue: + +`git bisect {{good|bad}}` + +- After `git bisect` pinpoints the faulty commit, end the bisect session and return to the previous branch: + +`git bisect reset` + +- Skip a commit during a bisect (e.g. one that fails the tests due to a different issue): + +`git bisect skip` + +- Display a log of what has been done so far: + +`git bisect log` diff --git a/git-blame b/git-blame new file mode 100644 index 00000000..818e4fba --- /dev/null +++ b/git-blame @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git blame + +> Show commit hash and last author on each line of a file. +> More information: . + +- Print file with author name and commit hash on each line: + +`git blame {{path/to/file}}` + +- Print file with author email and commit hash on each line: + +`git blame -e {{path/to/file}}` + +- Print file with author name and commit hash on each line at a specific commit: + +`git blame {{commit}} {{path/to/file}}` + +- Print file with author name and commit hash on each line before a specific commit: + +`git blame {{commit}}~ {{path/to/file}}` diff --git a/git-blame-someone-else b/git-blame-someone-else new file mode 100644 index 00000000..14ce1e08 --- /dev/null +++ b/git-blame-someone-else @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git blame-someone-else + +> Blame someone else for your bad code. +> More information: . + +- Change the committer and author of a commit: + +`git blame-someone-else "{{author }}" {{commit}}` diff --git a/git-branch b/git-branch new file mode 100644 index 00000000..1af9e006 --- /dev/null +++ b/git-branch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git branch + +> Main Git command for working with branches. +> More information: . + +- List all branches (local and remote; the current branch is highlighted by `*`): + +`git branch --all` + +- List which branches include a specific Git commit in their history: + +`git branch --all --contains {{commit_hash}}` + +- Show the name of the current branch: + +`git branch --show-current` + +- Create new branch based on the current commit: + +`git branch {{branch_name}}` + +- Create new branch based on a specific commit: + +`git branch {{branch_name}} {{commit_hash}}` + +- Rename a branch (must not have it checked out to do this): + +`git branch -m {{old_branch_name}} {{new_branch_name}}` + +- Delete a local branch (must not have it checked out to do this): + +`git branch -d {{branch_name}}` + +- Delete a remote branch: + +`git push {{remote_name}} --delete {{remote_branch_name}}` diff --git a/git-browse b/git-browse new file mode 100644 index 00000000..d4bd183a --- /dev/null +++ b/git-browse @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git browse + +> View an upstream repository in the default browser. +> Part of `git-extras`. +> More information: . + +- Open the first upstream in the default browser: + +`git browse` + +- Open a specific upstream in the default browser: + +`git browse {{upstream}}` diff --git a/git-browse-ci b/git-browse-ci new file mode 100644 index 00000000..92227e8b --- /dev/null +++ b/git-browse-ci @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git browse-ci + +> Open the current `git` repository's CI website in the default web browser. +> Part of `git-extras`. +> More information: . + +- Open the current repository's CI configuration on its upstream website: + +`git browse-ci` + +- Open the current repository's CI configuration on its upstream website for a specific remote: + +`git browse-ci {{remote}}` diff --git a/git-brv b/git-brv new file mode 100644 index 00000000..ad621a83 --- /dev/null +++ b/git-brv @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git brv + +> Print a list of branches, sorted by last commit date. +> Part of `git-extras`. +> More information: . + +- List each branch showing date, latest commit hash and message: + +`git brv` diff --git a/git-bug b/git-bug new file mode 100644 index 00000000..c6fff968 --- /dev/null +++ b/git-bug @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git bug + +> A distributed bug tracker that uses Git's internal storage, so no files are added in your project. +> You may submit your problems to the same Git remote you use to interact with others, much like commits and branches. +> More information: . + +- Create a new identity: + +`git bug user create` + +- Create a new bug: + +`git bug add` + +- You can push your new entry to a remote: + +`git bug push` + +- You can pull for updates: + +`git bug pull` + +- List existing bugs: + +`git bug ls` + +- Filter and sort bugs using a query: + +`git bug ls "{{status}}:{{open}} {{sort}}:{{edit}}"` + +- Search for bugs by text content: + +`git bug ls "{{search_query}}" baz` diff --git a/git-bugreport b/git-bugreport new file mode 100644 index 00000000..0b20cbf0 --- /dev/null +++ b/git-bugreport @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git bugreport + +> Captures debug information from the system and user, generating a text file to aid in the reporting of a bug in Git. +> More information: . + +- Create a new bug report file in the current directory: + +`git bugreport` + +- Create a new bug report file in the specified directory, creating it if it does not exist: + +`git bugreport --output-directory {{path/to/directory}}` + +- Create a new bug report file with the specified filename suffix in `strftime` format: + +`git bugreport --suffix {{%m%d%y}}` diff --git a/git-bulk b/git-bulk new file mode 100644 index 00000000..31113088 --- /dev/null +++ b/git-bulk @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git bulk + +> Execute operations on multiple Git repositories. +> Part of `git-extras`. +> More information: . + +- Register the current directory as a workspace: + +`git bulk --addcurrent {{workspace_name}}` + +- Register a workspace for bulk operations: + +`git bulk --addworkspace {{workspace_name}} {{/absolute/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}}` + +- 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}}` + +- List all registered workspaces: + +`git bulk --listall` + +- Run a Git command on the repositories of the current workspace: + +`git bulk {{command}} {{command_arguments}}` + +- Remove a specific workspace: + +`git bulk --removeworkspace {{workspace_name}}` + +- Remove all workspaces: + +`git bulk --purge` diff --git a/git-bundle b/git-bundle new file mode 100644 index 00000000..0da7ed9f --- /dev/null +++ b/git-bundle @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git bundle + +> Package objects and references into an archive. +> More information: . + +- Create a bundle file that contains all objects and references of a specific branch: + +`git bundle create {{path/to/file.bundle}} {{branch_name}}` + +- Create a bundle file of all branches: + +`git bundle create {{path/to/file.bundle}} --all` + +- Create a bundle file of the last 5 commits of the current branch: + +`git bundle create {{path/to/file.bundle}} -{{5}} {{HEAD}}` + +- Create a bundle file of the latest 7 days: + +`git bundle create {{path/to/file.bundle}} --since={{7.days}} {{HEAD}}` + +- Verify that a bundle file is valid and can be applied to the current repository: + +`git bundle verify {{path/to/file.bundle}}` + +- Print to `stdout` the list of references contained in a bundle: + +`git bundle unbundle {{path/to/file.bundle}}` + +- Unbundle a specific branch from a bundle file into the current repository: + +`git pull {{path/to/file.bundle}} {{branch_name}}` diff --git a/git-cat-file b/git-cat-file new file mode 100644 index 00000000..0fe663e9 --- /dev/null +++ b/git-cat-file @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cat-file + +> Provide content or type and size information for Git repository objects. +> More information: . + +- Get the [s]ize of the HEAD commit in bytes: + +`git cat-file -s HEAD` + +- Get the [t]ype (blob, tree, commit, tag) of a given Git object: + +`git cat-file -t {{8c442dc3}}` + +- Pretty-[p]rint the contents of a given Git object based on its type: + +`git cat-file -p {{HEAD~2}}` diff --git a/git-changelog b/git-changelog new file mode 100644 index 00000000..5f4215e0 --- /dev/null +++ b/git-changelog @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git changelog + +> Generate a changelog report from repository commits and tags. +> Part of `git-extras`. +> More information: . + +- Update existing file or create a new `History.md` file with the commit messages since the latest Git tag: + +`git changelog` + +- List commits from the current version: + +`git changelog --list` + +- List a range of commits from the tag named `2.1.0` to now: + +`git changelog --list --start-tag {{2.1.0}}` + +- List pretty formatted range of commits between the tag `0.5.0` and the tag `1.0.0`: + +`git changelog --start-tag {{0.5.0}} --final-tag {{1.0.0}}` + +- List pretty formatted range of commits between the commit `0b97430` and the tag `1.0.0`: + +`git changelog --start-commit {{0b97430}} --final-tag {{1.0.0}}` + +- Specify `CHANGELOG.md` as the output file: + +`git changelog {{CHANGELOG.md}}` + +- Replace contents of current changelog file entirely: + +`git changelog --prune-old` diff --git a/git-check-attr b/git-check-attr new file mode 100644 index 00000000..56d3cddc --- /dev/null +++ b/git-check-attr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git check-attr + +> For every pathname, list if each attribute is unspecified, set, or unset as a gitattribute on that pathname. +> More information: . + +- Check the values of all attributes on a file: + +`git check-attr --all {{path/to/file}}` + +- Check the value of a specific attribute on a file: + +`git check-attr {{attribute}} {{path/to/file}}` + +- Check the values of all attributes on specific files: + +`git check-attr --all {{path/to/file1 path/to/file2 ...}}` + +- Check the value of a specific attribute on one or more files: + +`git check-attr {{attribute}} {{path/to/file1 path/to/file2 ...}}` diff --git a/git-check-ignore b/git-check-ignore new file mode 100644 index 00000000..ae691953 --- /dev/null +++ b/git-check-ignore @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git check-ignore + +> Analyze and debug Git ignore/exclude (".gitignore") files. +> More information: . + +- Check whether a file or directory is ignored: + +`git check-ignore {{path/to/file_or_directory}}` + +- Check whether multiple files or directories are ignored: + +`git check-ignore {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Use pathnames, one per line, from `stdin`: + +`git check-ignore --stdin < {{path/to/file_list}}` + +- Do not check the index (used to debug why paths were tracked and not ignored): + +`git check-ignore --no-index {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Include details about the matching pattern for each path: + +`git check-ignore --verbose {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/git-check-mailmap b/git-check-mailmap new file mode 100644 index 00000000..49a01288 --- /dev/null +++ b/git-check-mailmap @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git check-mailmap + +> Show canonical names and email addresses of contacts. +> More information: . + +- Look up the canonical name associated with an email address: + +`git check-mailmap "<{{email@example.com}}>"` diff --git a/git-check-ref-format b/git-check-ref-format new file mode 100644 index 00000000..af01b0c7 --- /dev/null +++ b/git-check-ref-format @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git check-ref-format + +> Check if a reference name is acceptable, and exit with a non-zero status if it is not. +> More information: . + +- Check the format of the specified reference name: + +`git check-ref-format {{refs/head/refname}}` + +- Print the name of the last branch checked out: + +`git check-ref-format --branch @{-1}` + +- Normalize a refname: + +`git check-ref-format --normalize {{refs/head/refname}}` diff --git a/git-checkout b/git-checkout new file mode 100644 index 00000000..57055df1 --- /dev/null +++ b/git-checkout @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git checkout + +> Checkout a branch or paths to the working tree. +> More information: . + +- Create and switch to a new branch: + +`git checkout -b {{branch_name}}` + +- Create and switch to a new branch based on a specific reference (branch, remote/branch, tag are examples of valid references): + +`git checkout -b {{branch_name}} {{reference}}` + +- Switch to an existing local branch: + +`git checkout {{branch_name}}` + +- Switch to the previously checked out branch: + +`git checkout -` + +- Switch to an existing remote branch: + +`git checkout --track {{remote_name}}/{{branch_name}}` + +- Discard all unstaged changes in the current directory (see `git reset` for more undo-like commands): + +`git checkout .` + +- Discard unstaged changes to a given file: + +`git checkout {{path/to/file}}` + +- Replace a file in the current directory with the version of it committed in a given branch: + +`git checkout {{branch_name}} -- {{path/to/file}}` diff --git a/git-checkout-index b/git-checkout-index new file mode 100644 index 00000000..5355c136 --- /dev/null +++ b/git-checkout-index @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git checkout-index + +> Copy files from the index to the working tree. +> More information: . + +- Restore any files deleted since the last commit: + +`git checkout-index --all` + +- Restore any files deleted or changed since the last commit: + +`git checkout-index --all --force` + +- Restore any files changed since the last commit, ignoring any files that were deleted: + +`git checkout-index --all --force --no-create` + +- Export a copy of the entire tree at the last commit to the specified directory (the trailing slash is important): + +`git checkout-index --all --force --prefix={{path/to/export_directory/}}` diff --git a/git-cherry b/git-cherry new file mode 100644 index 00000000..2285fa37 --- /dev/null +++ b/git-cherry @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cherry + +> Find commits that have yet to be applied upstream. +> More information: . + +- Show commits (and their messages) with equivalent commits upstream: + +`git cherry -v` + +- Specify a different upstream and topic branch: + +`git cherry {{origin}} {{topic}}` + +- Limit commits to those within a given limit: + +`git cherry {{origin}} {{topic}} {{base}}` diff --git a/git-cherry-pick b/git-cherry-pick new file mode 100644 index 00000000..8b25c1a1 --- /dev/null +++ b/git-cherry-pick @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cherry-pick + +> Apply the changes introduced by existing commits to the current branch. +> To apply changes to another branch, first use `git checkout` to switch to the desired branch. +> More information: . + +- Apply a commit to the current branch: + +`git cherry-pick {{commit}}` + +- Apply a range of commits to the current branch (see also `git rebase --onto`): + +`git cherry-pick {{start_commit}}~..{{end_commit}}` + +- Apply multiple (non-sequential) commits to the current branch: + +`git cherry-pick {{commit1 commit2 ...}}` + +- Add the changes of a commit to the working directory, without creating a commit: + +`git cherry-pick --no-commit {{commit}}` diff --git a/git-clean b/git-clean new file mode 100644 index 00000000..86bc8835 --- /dev/null +++ b/git-clean @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git clean + +> Remove untracked files from the working tree. +> More information: . + +- Delete files that are not tracked by Git: + +`git clean` + +- Interactively delete files that are not tracked by Git: + +`git clean -i` + +- Show what files would be deleted without actually deleting them: + +`git clean --dry-run` + +- Forcefully delete files that are not tracked by Git: + +`git clean -f` + +- Forcefully delete directories that are not tracked by Git: + +`git clean -fd` + +- Delete untracked files, including ignored files in `.gitignore` and `.git/info/exclude`: + +`git clean -x` diff --git a/git-clear b/git-clear new file mode 100644 index 00000000..51032195 --- /dev/null +++ b/git-clear @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git clear + +> Clear a Git working directory as if it was freshly cloned with the current branch including files in `.gitignore`. +> Part of `git-extras`. +> More information: . + +- Reset all tracked files and delete all untracked files even if they are included in the `.gitignore`: + +`git clear` diff --git a/git-clear-soft b/git-clear-soft new file mode 100644 index 00000000..1653219e --- /dev/null +++ b/git-clear-soft @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git clear-soft + +> Clear a Git working directory as if it was freshly cloned with the current branch excluding files in `.gitignore`. +> Part of `git-extras`. +> More information: . + +- Reset all tracked files and delete all untracked files: + +`git clear-soft` diff --git a/git-clone b/git-clone new file mode 100644 index 00000000..08934029 --- /dev/null +++ b/git-clone @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git clone + +> Clone an existing repository. +> More information: . + +- Clone an existing repository into a new directory (the default directory is the repository name): + +`git clone {{remote_repository_location}} {{path/to/directory}}` + +- Clone an existing repository and its submodules: + +`git clone --recursive {{remote_repository_location}}` + +- Clone only the `.git` directory of an existing repository: + +`git clone --no-checkout {{remote_repository_location}}` + +- Clone a local repository: + +`git clone --local {{path/to/local/repository}}` + +- Clone quietly: + +`git clone --quiet {{remote_repository_location}}` + +- Clone an existing repository only fetching the 10 most recent commits on the default branch (useful to save time): + +`git clone --depth {{10}} {{remote_repository_location}}` + +- Clone an existing repository only fetching a specific branch: + +`git clone --branch {{name}} --single-branch {{remote_repository_location}}` + +- Clone an existing repository using a specific SSH command: + +`git clone --config core.sshCommand="{{ssh -i path/to/private_ssh_key}}" {{remote_repository_location}}` diff --git a/git-coauthor b/git-coauthor new file mode 100644 index 00000000..ccfab47e --- /dev/null +++ b/git-coauthor @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git coauthor + +> Add another author to the latest commit. Since this command rewrites the Git history, `--force` will be needed when pushing next time. +> Part of `git-extras`. +> More information: . + +- Insert an additional author to the last Git commit: + +`git coauthor {{name}} {{name@example.com}}` diff --git a/git-cola b/git-cola new file mode 100644 index 00000000..538a411f --- /dev/null +++ b/git-cola @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cola + +> A powerful Git GUI with a slick and intuitive user interface. +> More information: . + +- Start the GUI: + +`git cola` + +- Start the GUI in amend mode: + +`git cola --amend` + +- Prompt for a Git repository. Defaults to the current directory: + +`git cola --prompt` + +- Open the Git repository at mentioned path: + +`git cola --repo {{path/to/git-repository}}` + +- Apply the path filter to the status widget: + +`git cola --status-filter {{filter}}` diff --git a/git-column b/git-column new file mode 100644 index 00000000..1ab41f77 --- /dev/null +++ b/git-column @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git column + +> Display data in columns. +> More information: . + +- Format `stdin` as multiple columns: + +`ls | git column --mode={{column}}` + +- Format `stdin` as multiple columns with a maximum width of `100`: + +`ls | git column --mode=column --width={{100}}` + +- Format `stdin` as multiple columns with a maximum padding of `30`: + +`ls | git column --mode=column --padding={{30}}` diff --git a/git-commit b/git-commit new file mode 100644 index 00000000..b01af49b --- /dev/null +++ b/git-commit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git commit + +> Commit files to the repository. +> More information: . + +- Commit staged files to the repository with a message: + +`git commit --message "{{message}}"` + +- Commit staged files with a message read from a file: + +`git commit --file {{path/to/commit_message_file}}` + +- Auto stage all modified and deleted files and commit with a message: + +`git commit --all --message "{{message}}"` + +- Commit staged files and sign them with the specified GPG key (or the one defined in the configuration file if no argument is specified): + +`git commit --gpg-sign {{key_id}} --message "{{message}}"` + +- Update the last commit by adding the currently staged changes, changing the commit's hash: + +`git commit --amend` + +- Commit only specific (already staged) files: + +`git commit {{path/to/file1}} {{path/to/file2}}` + +- Create a commit, even if there are no staged files: + +`git commit --message "{{message}}" --allow-empty` diff --git a/git-commit-graph b/git-commit-graph new file mode 100644 index 00000000..d6d69b3c --- /dev/null +++ b/git-commit-graph @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git commit-graph + +> Write and verify Git commit-graph files. +> More information: . + +- Write a commit-graph file for the packed commits in the repository's local `.git` directory: + +`git commit-graph write` + +- Write a commit-graph file containing all reachable commits: + +`git show-ref --hash | git commit-graph write --stdin-commits` + +- Write a commit-graph file containing all commits in the current commit-graph file along with those reachable from `HEAD`: + +`git rev-parse {{HEAD}} | git commit-graph write --stdin-commits --append` diff --git a/git-commit-tree b/git-commit-tree new file mode 100644 index 00000000..72bc3979 --- /dev/null +++ b/git-commit-tree @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git commit-tree + +> Low level utility to create commit objects. +> See also: `git commit`. +> More information: . + +- Create a commit object with the specified message: + +`git commit-tree {{tree}} -m "{{message}}"` + +- Create a commit object reading the message from a file (use `-` for `stdin`): + +`git commit-tree {{tree}} -F {{path/to/file}}` + +- Create a GPG-signed commit object: + +`git commit-tree {{tree}} -m "{{message}}" --gpg-sign` + +- Create a commit object with the specified parent commit object: + +`git commit-tree {{tree}} -m "{{message}}" -p {{parent_commit_sha}}` diff --git a/git-commits-since b/git-commits-since new file mode 100644 index 00000000..e797ff59 --- /dev/null +++ b/git-commits-since @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git commits-since + +> Display commits since a time or date. +> Part of `git-extras`. +> More information: . + +- Display commits since yesterday: + +`git commits-since {{yesterday}}` + +- Display commits since last week: + +`git commits-since {{last week}}` + +- Display commits since last month: + +`git commits-since {{last month}}` + +- Display commits since yesterday 2pm: + +`git commits-since {{yesterday 2pm}}` diff --git a/git-config b/git-config new file mode 100644 index 00000000..3cf9d42a --- /dev/null +++ b/git-config @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git config + +> Manage custom configuration options for Git repositories. +> These configurations can be local (for the current repository) or global (for the current user). +> More information: . + +- List only local configuration entries (stored in `.git/config` in the current repository): + +`git config --list --local` + +- List only global configuration entries (stored in `~/.gitconfig` by default or in `$XDG_CONFIG_HOME/git/config` if such a file exists): + +`git config --list --global` + +- List only system configuration entries (stored in `/etc/gitconfig`), and show their file location: + +`git config --list --system --show-origin` + +- Get the value of a given configuration entry: + +`git config alias.unstage` + +- Set the global value of a given configuration entry: + +`git config --global alias.unstage "reset HEAD --"` + +- Revert a global configuration entry to its default value: + +`git config --global --unset alias.unstage` + +- Edit the Git configuration for the current repository in the default editor: + +`git config --edit` + +- Edit the global Git configuration in the default editor: + +`git config --global --edit` diff --git a/git-contrib b/git-contrib new file mode 100644 index 00000000..5113cc53 --- /dev/null +++ b/git-contrib @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git contrib + +> Display commits from a author. +> Part of `git-extras`. +> More information: . + +- Display all commit hashes and their corresponding commit messages from a specific author: + +`git contrib {{author}}` diff --git a/git-count b/git-count new file mode 100644 index 00000000..36c388dd --- /dev/null +++ b/git-count @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git count + +> Print the total number of commits. +> Part of `git-extras`. +> More information: . + +- Print the total number of commits: + +`git count` + +- Print the number of commits per contributor and the total number of commits: + +`git count --all` diff --git a/git-count-objects b/git-count-objects new file mode 100644 index 00000000..ef468f35 --- /dev/null +++ b/git-count-objects @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git count-objects + +> Count the number of unpacked objects and their disk consumption. +> More information: . + +- Count all objects and display the total disk usage: + +`git count-objects` + +- Display a count of all objects and their total disk usage, displaying sizes in human-readable units: + +`git count-objects --human-readable` + +- Display more verbose information: + +`git count-objects --verbose` + +- Display more verbose information, displaying sizes in human-readable units: + +`git count-objects --human-readable --verbose` diff --git a/git-cp b/git-cp new file mode 100644 index 00000000..bd7c26e9 --- /dev/null +++ b/git-cp @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cp + +> Copy an existing file to a new location, preserving history. +> Part of `git-extras`. +> More information: . + +- Copy an existing file in a Git repo, staying in the same directory: + +`git cp {{file}} {{new_file}}` + +- Copy an existing file in a Git repo and place it elsewhere: + +`git cp {{path/to/file}} {{path/to/new_file}}` diff --git a/git-create-branch b/git-create-branch new file mode 100644 index 00000000..98785458 --- /dev/null +++ b/git-create-branch @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git create-branch + +> Create a Git branch in a repository. +> Part of `git-extras`. +> More information: . + +- Create a local branch: + +`git create-branch {{branch_name}}` + +- Create a branch locally and on origin: + +`git create-branch --remote {{branch_name}}` + +- Create a branch locally and on upstream (through forks): + +`git create-branch --remote upstream {{branch_name}}` diff --git a/git-credential b/git-credential new file mode 100644 index 00000000..df020896 --- /dev/null +++ b/git-credential @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git credential + +> Retrieve and store user credentials. +> More information: . + +- Display credential information, retrieving the username and password from configuration files: + +`echo "{{url=http://example.com}}" | git credential fill` + +- Send credential information to all configured credential helpers to store for later use: + +`echo "{{url=http://example.com}}" | git credential approve` + +- Erase the specified credential information from all the configured credential helpers: + +`echo "{{url=http://example.com}}" | git credential reject` diff --git a/git-credential-cache b/git-credential-cache new file mode 100644 index 00000000..36f17adf --- /dev/null +++ b/git-credential-cache @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git credential-cache + +> Git helper to temporarily store passwords in memory. +> More information: . + +- Store Git credentials for a specific amount of time: + +`git config credential.helper 'cache --timeout={{time_in_seconds}}'` diff --git a/git-credential-store b/git-credential-store new file mode 100644 index 00000000..92586409 --- /dev/null +++ b/git-credential-store @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git credential-store + +> `git` helper to store passwords on disk. +> More information: . + +- Store Git credentials in a specific file: + +`git config credential.helper 'store --file={{path/to/file}}'` diff --git a/git-cvsexportcommit b/git-cvsexportcommit new file mode 100644 index 00000000..1a6ea7a0 --- /dev/null +++ b/git-cvsexportcommit @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git cvsexportcommit + +> Export a single `Git` commit to a CVS checkout. +> More information: . + +- Merge a specific patch into CVS: + +`git cvsexportcommit -v -c -w {{path/to/project_cvs_checkout}} {{commit_sha1}}` diff --git a/git-daemon b/git-daemon new file mode 100644 index 00000000..1f4955ac --- /dev/null +++ b/git-daemon @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git daemon + +> A really simple server for Git repositories. +> More information: . + +- Launch a Git daemon with a whitelisted set of directories: + +`git daemon --export-all {{path/to/directory1}} {{path/to/directory2}}` + +- Launch a Git daemon with a specific base directory and allow pulling from all sub-directories that look like Git repositories: + +`git daemon --base-path={{path/to/directory}} --export-all --reuseaddr` + +- Launch a Git daemon for the specified directory, verbosely printing log messages and allowing Git clients to write to it: + +`git daemon {{path/to/directory}} --enable=receive-pack --informative-errors --verbose` diff --git a/git-delete-branch b/git-delete-branch new file mode 100644 index 00000000..00bf6eea --- /dev/null +++ b/git-delete-branch @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delete-branch + +> Delete local and remote Git branches. +> Part of `git-extras`. If deleting the checked out branch, only the remote branch will be deleted. +> More information: . + +- Delete one or more local and remote Git branches: + +`git delete-branch {{branch_name1 branch_name2 ...}}` diff --git a/git-delete-merged-branches b/git-delete-merged-branches new file mode 100644 index 00000000..0ed0618a --- /dev/null +++ b/git-delete-merged-branches @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delete-merged-branches + +> Delete branches that are listed in `git branch --merged` excluding master. +> Part of `git-extras`. +> More information: . + +- Delete merged branches: + +`git delete-merged-branches` diff --git a/git-delete-squashed-branches b/git-delete-squashed-branches new file mode 100644 index 00000000..c10ad451 --- /dev/null +++ b/git-delete-squashed-branches @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delete-squashed-branches + +> Delete branches that have been "squashed-merged" into a specified branch and checkout. If no branch is specified, default to the currently checked out branch. +> Part of `git-extras`. +> More information: . + +- Delete all branches that were "squash-merged" into the current checked out branch: + +`git delete-squashed-branches` + +- Delete all branches that were "squash-merged" into a specific branch: + +`git delete-squashed-branches {{branch_name}}` diff --git a/git-delete-submodule b/git-delete-submodule new file mode 100644 index 00000000..ceb44264 --- /dev/null +++ b/git-delete-submodule @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delete-submodule + +> Delete a submodule from a `git` repository. +> Part of `git-extras`. +> More information: . + +- Delete a specific submodule: + +`git delete-submodule {{path/to/submodule}}` diff --git a/git-delete-tag b/git-delete-tag new file mode 100644 index 00000000..50536787 --- /dev/null +++ b/git-delete-tag @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delete-tag + +> Delete existing local and remote tags. +> Part of `git-extras`. +> More information: . + +- Delete a tag: + +`git delete-tag {{tag_version}}` diff --git a/git-delta b/git-delta new file mode 100644 index 00000000..948748a7 --- /dev/null +++ b/git-delta @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git delta + +> List files that differ from another branch. +> Part of `git-extras`. +> More information: . + +- List files from the current checked out branch that differ from the `main` branch: + +`git delta {{main}}` + +- List files from a specific branch that differ from another specific branch: + +`git delta {{branch_1}} {{branch_2}}` diff --git a/git-describe b/git-describe new file mode 100644 index 00000000..2854b00d --- /dev/null +++ b/git-describe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git describe + +> Give an object a human-readable name based on an available ref. +> More information: . + +- Create a unique name for the current commit (the name contains the most recent annotated tag, the number of additional commits, and the abbreviated commit hash): + +`git describe` + +- Create a name with 4 digits for the abbreviated commit hash: + +`git describe --abbrev={{4}}` + +- Generate a name with the tag reference path: + +`git describe --all` + +- Describe a Git tag: + +`git describe {{v1.0.0}}` + +- Create a name for the last commit of a given branch: + +`git describe {{branch_name}}` diff --git a/git-diff b/git-diff new file mode 100644 index 00000000..8c0aca4c --- /dev/null +++ b/git-diff @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git diff + +> Show changes to tracked files. +> More information: . + +- Show unstaged changes: + +`git diff` + +- Show all uncommitted changes (including staged ones): + +`git diff HEAD` + +- Show only staged (added, but not yet committed) changes: + +`git diff --staged` + +- Show changes from all commits since a given date/time (a date expression, e.g. "1 week 2 days" or an ISO date): + +`git diff 'HEAD@{3 months|weeks|days|hours|seconds ago}'` + +- Show only names of changed files since a given commit: + +`git diff --name-only {{commit}}` + +- Output a summary of file creations, renames and mode changes since a given commit: + +`git diff --summary {{commit}}` + +- Compare a single file between two branches or commits: + +`git diff {{branch_1}}..{{branch_2}} [--] {{path/to/file}}` + +- Compare different files from the current branch to other branch: + +`git diff {{branch}}:{{path/to/file2}} {{path/to/file}}` diff --git a/git-diff-files b/git-diff-files new file mode 100644 index 00000000..d762b15d --- /dev/null +++ b/git-diff-files @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git diff-files + +> Compare files using their sha1 hashes and modes. +> More information: . + +- Compare all changed files: + +`git diff-files` + +- Compare only specified files: + +`git diff-files {{path/to/file}}` + +- Show only the names of changed files: + +`git diff-files --name-only` + +- Output a summary of extended header information: + +`git diff-files --summary` diff --git a/git-diff-index b/git-diff-index new file mode 100644 index 00000000..8c7c40bc --- /dev/null +++ b/git-diff-index @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git diff-index + +> Compare the working directory with a commit or tree object. +> More information: . + +- Compare the working directory with a specific commit: + +`git diff-index {{commit}}` + +- Compare a specific file or directory in working directory with a commit: + +`git diff-index {{commit}} {{path/to/file_or_directory}}` + +- Compare the working directory with the index (staging area) to check for staged changes: + +`git diff-index --cached {{commit}}` + +- Suppress output and return an exit status to check for differences: + +`git diff-index --quiet {{commit}}` diff --git a/git-diff-tree b/git-diff-tree new file mode 100644 index 00000000..26b01c77 --- /dev/null +++ b/git-diff-tree @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git diff-tree + +> Compares the content and mode of blobs found via two tree objects. +> More information: . + +- Compare two tree objects: + +`git diff-tree {{tree-ish1}} {{tree-ish2}}` + +- Show changes between two specific commits: + +`git diff-tree -r {{commit1}} {{commit2}}` + +- Display changes in patch format: + +`git diff-tree -p {{tree-ish1}} {{tree-ish2}}` + +- Filter changes by a specific path: + +`git diff-tree {{tree-ish1}} {{tree-ish2}} -- {{path/to/file_or_directory}}` diff --git a/git-difftool b/git-difftool new file mode 100644 index 00000000..fe463884 --- /dev/null +++ b/git-difftool @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git difftool + +> Show file changes using external diff tools. Accepts the same options and arguments as `git diff`. +> See also: `git diff`. +> More information: . + +- List available diff tools: + +`git difftool --tool-help` + +- Set the default diff tool to meld: + +`git config --global diff.tool "{{meld}}"` + +- Use the default diff tool to show staged changes: + +`git difftool --staged` + +- Use a specific tool (opendiff) to show changes since a given commit: + +`git difftool --tool={{opendiff}} {{commit}}` diff --git a/git-effort b/git-effort new file mode 100644 index 00000000..33ac24b5 --- /dev/null +++ b/git-effort @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git effort + +> Display how much activity a file has had, showing commits per file and "active days" i.e. total number of days that contributed to the file. +> Part of `git-extras`. +> More information: . + +- Display each file in the repository, showing commits and active days: + +`git effort` + +- Display files modified by a specific number of commits or more, showing commits and active days: + +`git effort --above {{5}}` + +- Display files modified by a specific author, showing commits and active days: + +`git effort -- --author="{{username}}"` + +- Display files modified since a specific time/date, showing commits and active days: + +`git effort -- --since="{{last month}}"` + +- Display only the specified files or directories, showing commits and active days: + +`git effort {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Display all files in a specific directory, showing commits and active days: + +`git effort {{path/to/directory/*}}` diff --git a/git-extras b/git-extras new file mode 100644 index 00000000..b5957f72 --- /dev/null +++ b/git-extras @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git extras + +> Git extension pack. +> More information: . + +- Install or upgrade `git-extras` commands: + +`git extras update` + +- Display help: + +`git extras --help` + +- Display version: + +`git extras --version` diff --git a/git-fame b/git-fame new file mode 100644 index 00000000..e8c2e813 --- /dev/null +++ b/git-fame @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git fame + +> Pretty-print Git repository contributions. +> More information: . + +- Calculate contributions for the current Git repository: + +`git fame` + +- Exclude files/directories that match the specified regular expression: + +`git fame --excl "{{regular_expression}}"` + +- Calculate contributions made after the specified date: + +`git fame --since "{{3 weeks ago|2021-05-13}}"` + +- Display contributions in the specified format: + +`git fame --format {{pipe|yaml|json|csv|tsv}}` + +- Display contributions per file extension: + +`git fame --bytype` + +- Ignore whitespace changes: + +`git fame --ignore-whitespace` + +- Detect inter-file line moves and copies: + +`git fame -C` + +- Detect intra-file line moves and copies: + +`git fame -M` diff --git a/git-feature b/git-feature new file mode 100644 index 00000000..90d63a51 --- /dev/null +++ b/git-feature @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git feature + +> Create or merge feature branches. +> Feature branches obey the format feature/. +> More information: . + +- Create and switch to a new feature branch: + +`git feature {{feature_branch}}` + +- Merge a feature branch into the current branch creating a merge commit: + +`git feature finish {{feature_branch}}` + +- Merge a feature branch into the current branch squashing the changes into one commit: + +`git feature finish --squash {{feature_branch}}` + +- Send changes from a specific feature branch to its remote counterpart: + +`git feature {{feature_branch}} --remote {{remote_name}}` diff --git a/git-fetch b/git-fetch new file mode 100644 index 00000000..a2949115 --- /dev/null +++ b/git-fetch @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git fetch + +> Download objects and refs from a remote repository. +> More information: . + +- Fetch the latest changes from the default remote upstream repository (if set): + +`git fetch` + +- Fetch new branches from a specific remote upstream repository: + +`git fetch {{remote_name}}` + +- Fetch the latest changes from all remote upstream repositories: + +`git fetch --all` + +- Also fetch tags from the remote upstream repository: + +`git fetch --tags` + +- Delete local references to remote branches that have been deleted upstream: + +`git fetch --prune` diff --git a/git-filter-repo b/git-filter-repo new file mode 100644 index 00000000..6d47cd37 --- /dev/null +++ b/git-filter-repo @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git filter-repo + +> A versatile tool for rewriting Git history. +> See also: `bfg`. +> More information: . + +- Replace a sensitive string in all files: + +`git filter-repo --replace-text <(echo '{{find}}==>{{replacement}}')` + +- Extract a single folder, keeping history: + +`git filter-repo --path {{path/to/folder}}` + +- Remove a single folder, keeping history: + +`git filter-repo --path {{path/to/folder}} --invert-paths` + +- Move everything from sub-folder one level up: + +`git filter-repo --path-rename {{path/to/folder/:}}` diff --git a/git-flow b/git-flow new file mode 100644 index 00000000..2b7133c2 --- /dev/null +++ b/git-flow @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git flow + +> A collection of Git extensions to provide high-level repository operations. +> More information: . + +- Initialize it inside an existing Git repository: + +`git flow init` + +- Start developing on a feature branch based on `develop`: + +`git flow feature start {{feature}}` + +- Finish development on a feature branch, merging it into the `develop` branch and deleting it: + +`git flow feature finish {{feature}}` + +- Publish a feature to the remote server: + +`git flow feature publish {{feature}}` + +- Get a feature published by another user: + +`git flow feature pull origin {{feature}}` diff --git a/git-for-each-repo b/git-for-each-repo new file mode 100644 index 00000000..403d96a4 --- /dev/null +++ b/git-for-each-repo @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git for-each-repo + +> Run a Git command on a list of repositories. +> Note: this command is experimental and may change. +> More information: . + +- Run maintenance on each of a list of repositories stored in the `maintenance.repo` user configuration variable: + +`git for-each-repo --config={{maintenance.repo}} {{maintenance run}}` + +- Run `git pull` on each repository listed in a global configuration variable: + +`git for-each-repo --config={{global_configuration_variable}} {{pull}}` diff --git a/git-force-clone b/git-force-clone new file mode 100644 index 00000000..bc7c79cb --- /dev/null +++ b/git-force-clone @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git force-clone + +> Provides the basic functionality of `git clone`, but if the destination Git repository already exists it will force-reset it to resemble a clone of the remote. +> Part of `git-extras`. +> More information: . + +- Clone a Git repository into a new directory: + +`git force-clone {{remote_repository_location}} {{path/to/directory}}` + +- Clone a Git repository into a new directory, checking out an specific branch: + +`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` + +- Clone a Git repository into an existing directory of a Git repository, performing a force-reset to resemble it to the remote and checking out an specific branch: + +`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` diff --git a/git-fork b/git-fork new file mode 100644 index 00000000..ba1efe45 --- /dev/null +++ b/git-fork @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git fork + +> Fork a GitHub repo. Like `git clone` but forks first. +> Part of `git-extras`. +> More information: . + +- Fork and clone a GitHub repository by its URL: + +`git fork {{https://github.com/tldr-pages/tldr}}` + +- Fork and clone a GitHub repository by its slug: + +`git fork {{tldr-pages/tldr}}` diff --git a/git-format-patch b/git-format-patch new file mode 100644 index 00000000..2ec9caee --- /dev/null +++ b/git-format-patch @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git format-patch + +> Prepare .patch files. Useful when emailing commits elsewhere. +> See also `git am`, which can apply generated .patch files. +> More information: . + +- Create an auto-named `.patch` file for all the unpushed commits: + +`git format-patch {{origin}}` + +- Write a `.patch` file for all the commits between 2 revisions to `stdout`: + +`git format-patch {{revision_1}}..{{revision_2}}` + +- Write a `.patch` file for the 3 latest commits: + +`git format-patch -{{3}}` diff --git a/git-fresh-branch b/git-fresh-branch new file mode 100644 index 00000000..6f678d31 --- /dev/null +++ b/git-fresh-branch @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git fresh-branch + +> Create an empty local branch. +> Part of `git-extras`. +> More information: . + +- Create an empty local branch: + +`git fresh-branch {{branch_name}}` diff --git a/git-fsck b/git-fsck new file mode 100644 index 00000000..a5a74dc9 --- /dev/null +++ b/git-fsck @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git fsck + +> Verify the validity and connectivity of nodes in a Git repository index. +> Does not make any modifications. See `git gc` for cleaning up dangling blobs. +> More information: . + +- Check the current repository: + +`git fsck` + +- List all tags found: + +`git fsck --tags` + +- List all root nodes found: + +`git fsck --root` diff --git a/git-gc b/git-gc new file mode 100644 index 00000000..1c512e8c --- /dev/null +++ b/git-gc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git gc + +> Optimise the local repository by cleaning unnecessary files. +> More information: . + +- Optimise the repository: + +`git gc` + +- Aggressively optimise, takes more time: + +`git gc --aggressive` + +- Do not prune loose objects (prunes by default): + +`git gc --no-prune` + +- Suppress all output: + +`git gc --quiet` + +- Display help: + +`git gc --help` diff --git a/git-gh-pages b/git-gh-pages new file mode 100644 index 00000000..df781d92 --- /dev/null +++ b/git-gh-pages @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git gh-pages + +> Create a new branch inside the current repository called `gh-pages`. +> Part of `git-extras`. +> More information: . + +- Create the GitHub pages branch inside the repository in the current directory: + +`git gh-pages` diff --git a/git-graft b/git-graft new file mode 100644 index 00000000..1f9b2a0c --- /dev/null +++ b/git-graft @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git graft + +> Merge commits from a branch into another branch and delete the source branch. +> Part of `git-extras`. +> More information: . + +- Merge all commits not present on the target branch from the source branch to target branch, and delete the source branch: + +`git graft {{source_branch}} {{target_branch}}` diff --git a/git-grep b/git-grep new file mode 100644 index 00000000..efcfad59 --- /dev/null +++ b/git-grep @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git-grep + +> Find strings inside files anywhere in a repository's history. +> Accepts a lot of the same flags as regular `grep`. +> More information: . + +- Search for a string in tracked files: + +`git grep {{search_string}}` + +- Search for a string in files matching a pattern in tracked files: + +`git grep {{search_string}} -- {{file_glob_pattern}}` + +- Search for a string in tracked files, including submodules: + +`git grep --recurse-submodules {{search_string}}` + +- Search for a string at a specific point in history: + +`git grep {{search_string}} {{HEAD~2}}` + +- Search for a string across all branches: + +`git grep {{search_string}} $(git rev-list --all)` diff --git a/git-gui b/git-gui new file mode 100644 index 00000000..3739f551 --- /dev/null +++ b/git-gui @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git gui + +> A GUI for Git to manage branches, commits, and remotes, and perform local merges. +> See also: `git-cola`, `gitk`. +> More information: . + +- Launch the GUI: + +`git gui` + +- Show a specific file with author name and commit hash on each line: + +`git gui blame {{path/to/file}}` + +- Open `git gui blame` in a specific revision: + +`git gui blame {{revision}} {{path/to/file}}` + +- Open `git gui blame` and scroll the view to center on a specific line: + +`git gui blame --line={{line}} {{path/to/file}}` + +- Open a window to make one commit and return to the shell when it is complete: + +`git gui citool` + +- Open `git gui citool` in the "Amend Last Commit" mode: + +`git gui citool --amend` + +- Open `git gui citool` in a read-only mode: + +`git gui citool --nocommit` + +- Show a browser for the tree of a specific branch, opening the blame tool when clicking on the files: + +`git gui browser maint` diff --git a/git-guilt b/git-guilt new file mode 100644 index 00000000..c2c41c09 --- /dev/null +++ b/git-guilt @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git guilt + +> Show total blame count for files with unstaged changes or calculate the change in blame between two revisions. +> Part of `git-extras`. +> More information: . + +- Show total blame count: + +`git guilt` + +- Calculate the change in blame between two revisions: + +`git guilt {{first_revision}} {{last_revision}}` + +- Show author emails instead of names: + +`git guilt --email` + +- Ignore whitespace only changes when attributing blame: + +`git guilt --ignore-whitespace` + +- Find blame delta over the last three weeks: + +`git guilt 'git log --until="3 weeks ago" --format="%H" -n 1'` + +- Find blame delta over the last three weeks (git 1.8.5+): + +`git guilt @{3.weeks.ago}` diff --git a/git-hash-object b/git-hash-object new file mode 100644 index 00000000..7d45060d --- /dev/null +++ b/git-hash-object @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git hash-object + +> Computes the unique hash key of content and optionally creates an object with specified type. +> More information: . + +- Compute the object ID without storing it: + +`git hash-object {{path/to/file}}` + +- Compute the object ID and store it in the Git database: + +`git hash-object -w {{path/to/file}}` + +- Compute the object ID specifying the object type: + +`git hash-object -t {{blob|commit|tag|tree}} {{path/to/file}}` + +- Compute the object ID from `stdin`: + +`cat {{path/to/file}} | git hash-object --stdin` diff --git a/git-help b/git-help new file mode 100644 index 00000000..11cbfd90 --- /dev/null +++ b/git-help @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git help + +> Display help information about Git. +> More information: . + +- Display help about a specific Git subcommand: + +`git help {{subcommand}}` + +- Display help about a specific Git subcommand in a web browser: + +`git help --web {{subcommand}}` + +- Display a list of all available Git subcommands: + +`git help --all` + +- List the available guides: + +`git help --guide` + +- List all possible configuration variables: + +`git help --config` diff --git a/git-ignore b/git-ignore new file mode 100644 index 00000000..f1119eb6 --- /dev/null +++ b/git-ignore @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git ignore + +> Show/update `.gitignore` files. +> Part of `git-extras`. See also `git ignore-io`. +> More information: . + +- Show the content of all global and local `.gitignore` files: + +`git ignore` + +- Ignore file(s) privately, updating `.git/info/exclude` file: + +`git ignore {{file_pattern}} --private` + +- Ignore file(s) locally, updating local `.gitignore` file: + +`git ignore {{file_pattern}}` + +- Ignore file(s) globally, updating global `.gitignore` file: + +`git ignore {{file_pattern}} --global` diff --git a/git-ignore-io b/git-ignore-io new file mode 100644 index 00000000..bc452f7f --- /dev/null +++ b/git-ignore-io @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git ignore-io + +> Generate .gitignore files from predefined templates. +> More information: . + +- List available templates: + +`git ignore-io list` + +- Generate a .gitignore template: + +`git ignore-io {{item_a,item_b,item_n}}` diff --git a/git-imerge b/git-imerge new file mode 100644 index 00000000..46e8d3c1 --- /dev/null +++ b/git-imerge @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git-imerge + +> Perform a merge or rebase between two Git branches incrementally. +> Conflicts between branches are tracked down to pairs of individual commits, to simplify conflict resolution. +> More information: . + +- Start imerge-based rebase (checkout the branch to be rebased, first): + +`git imerge rebase {{branch_to_rebase_onto}}` + +- Start imerge-based merge (checkout the branch to merge into, first): + +`git imerge merge {{branch_to_be_merged}}` + +- Show ASCII diagram of in-progress merge or rebase: + +`git imerge diagram` + +- Continue imerge operation after resolving conflicts (`git add` the conflicted files, first): + +`git imerge continue --no-edit` + +- Wrap up imerge operation, after all conflicts are resolved: + +`git imerge finish` + +- Abort imerge operation, and return to the previous branch: + +`git-imerge remove && git checkout {{previous_branch}}` diff --git a/git-info b/git-info new file mode 100644 index 00000000..d5d95a0e --- /dev/null +++ b/git-info @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git info + +> Display Git repository information. +> Part of `git-extras`. +> More information: . + +- Display remote locations, remote and local branches, most recent commit data and `.git/config` settings: + +`git info` + +- Display remote locations, remote and local branches and most recent commit data: + +`git info --no-config` diff --git a/git-init b/git-init new file mode 100644 index 00000000..171d9923 --- /dev/null +++ b/git-init @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git init + +> Initializes a new local Git repository. +> More information: . + +- Initialize a new local repository: + +`git init` + +- Initialize a repository with the specified name for the initial branch: + +`git init --initial-branch={{branch_name}}` + +- Initialize a repository using SHA256 for object hashes (requires Git version 2.29+): + +`git init --object-format={{sha256}}` + +- Initialize a barebones repository, suitable for use as a remote over ssh: + +`git init --bare` diff --git a/git-instaweb b/git-instaweb new file mode 100644 index 00000000..ceda36dd --- /dev/null +++ b/git-instaweb @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git instaweb + +> Helper to launch a GitWeb server. +> More information: . + +- Launch a GitWeb server for the current Git repository: + +`git instaweb --start` + +- Listen only on localhost: + +`git instaweb --start --local` + +- Listen on a specific port: + +`git instaweb --start --port {{1234}}` + +- Use a specified HTTP daemon: + +`git instaweb --start --httpd {{lighttpd|apache2|mongoose|plackup|webrick}}` + +- Also auto-launch a web browser: + +`git instaweb --start --browser` + +- Stop the currently running GitWeb server: + +`git instaweb --stop` + +- Restart the currently running GitWeb server: + +`git instaweb --restart` diff --git a/git-lfs b/git-lfs new file mode 100644 index 00000000..5e8ef85e --- /dev/null +++ b/git-lfs @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git lfs + +> Work with large files in Git repositories. +> More information: . + +- Initialize Git LFS: + +`git lfs install` + +- Track files that match a glob: + +`git lfs track '{{*.bin}}'` + +- Change the Git LFS endpoint URL (useful if the LFS server is separate from the Git server): + +`git config -f .lfsconfig lfs.url {{lfs_endpoint_url}}` + +- List tracked patterns: + +`git lfs track` + +- List tracked files that have been committed: + +`git lfs ls-files` + +- Push all Git LFS objects to the remote server (useful if errors are encountered): + +`git lfs push --all {{remote_name}} {{branch_name}}` + +- Fetch all Git LFS objects: + +`git lfs fetch` + +- Checkout all Git LFS objects: + +`git lfs checkout` diff --git a/git-local-commits b/git-local-commits new file mode 100644 index 00000000..0f4a6a3f --- /dev/null +++ b/git-local-commits @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git local-commits + +> Show local commits that haven't been pushed to origin. Any additional arguments will be passed directly to `git log`. +> Part of `git-extras. +> More information: . + +- Show commits that haven't been pushed: + +`git local-commits` diff --git a/git-lock b/git-lock new file mode 100644 index 00000000..334172b9 --- /dev/null +++ b/git-lock @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git lock + +> Lock a file in a Git repository from being modified by a commit. +> Part of `git-extras`. See also `git-unlock`. +> More information: . + +- Disable the ability to commit changes of a local file: + +`git lock {{path/to/file}}` diff --git a/git-locked b/git-locked new file mode 100644 index 00000000..fb34b2ce --- /dev/null +++ b/git-locked @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git locked + +> List locked files in a Git repository. +> Part of `git-extras`. +> More information: . + +- List all local locked files: + +`git locked` diff --git a/git-log b/git-log new file mode 100644 index 00000000..f9aec768 --- /dev/null +++ b/git-log @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git log + +> Show a history of commits. +> More information: . + +- Show the sequence of commits starting from the current one, in reverse chronological order of the Git repository in the current working directory: + +`git log` + +- Show the history of a particular file or directory, including differences: + +`git log -p {{path/to/file_or_directory}}` + +- Show an overview of which file(s) changed in each commit: + +`git log --stat` + +- Show a graph of commits in the current branch using only the first line of each commit message: + +`git log --oneline --graph` + +- Show a graph of all commits, tags and branches in the entire repo: + +`git log --oneline --decorate --all --graph` + +- Show only commits whose messages include a given string (case-insensitively): + +`git log -i --grep {{search_string}}` + +- Show the last N commits from a certain author: + +`git log -n {{number}} --author={{author}}` + +- Show commits between two dates (yyyy-mm-dd): + +`git log --before="{{2017-01-29}}" --after="{{2017-01-17}}"` diff --git a/git-ls-files b/git-ls-files new file mode 100644 index 00000000..66390a16 --- /dev/null +++ b/git-ls-files @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git ls-files + +> Show information about files in the index and the working tree. +> More information: . + +- Show deleted files: + +`git ls-files --deleted` + +- Show modified and deleted files: + +`git ls-files --modified` + +- Show ignored and untracked files: + +`git ls-files --others` + +- Show untracked files, not ignored: + +`git ls-files --others --exclude-standard` diff --git a/git-ls-remote b/git-ls-remote new file mode 100644 index 00000000..32f181d8 --- /dev/null +++ b/git-ls-remote @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git ls-remote + +> Git command for listing references in a remote repository based on name or URL. +> If no name or URL are given, then the configured upstream branch will be used, or remote origin if the former is not configured. +> More information: . + +- Show all references in the default remote repository: + +`git ls-remote` + +- Show only heads references in the default remote repository: + +`git ls-remote --heads` + +- Show only tags references in the default remote repository: + +`git ls-remote --tags` + +- Show all references from a remote repository based on name or URL: + +`git ls-remote {{repository_url}}` + +- Show references from a remote repository filtered by a pattern: + +`git ls-remote {{repository_name}} "{{pattern}}"` diff --git a/git-ls-tree b/git-ls-tree new file mode 100644 index 00000000..3448415f --- /dev/null +++ b/git-ls-tree @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git ls-tree + +> List the contents of a tree object. +> More information: . + +- List the contents of the tree on a branch: + +`git ls-tree {{branch_name}}` + +- List the contents of the tree on a commit, recursing into subtrees: + +`git ls-tree -r {{commit_hash}}` + +- List only the filenames of the tree on a commit: + +`git ls-tree --name-only {{commit_hash}}` + +- Print the filenames of the current branch head in a tree structure (Note: `tree --fromfile` is not supported on Windows): + +`git ls-tree -r --name-only HEAD | tree --fromfile` diff --git a/git-magic b/git-magic new file mode 100644 index 00000000..a771c087 --- /dev/null +++ b/git-magic @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git magic + +> Automate add, commit, and push routines. +> Part of `git-extras`. +> More information: . + +- Commit changes with a generated message: + +`git magic` + +- [a]dd untracked files and commit changes with a generated message: + +`git magic -a` + +- Commit changes with a custom [m]essage: + +`git magic -m "{{custom_commit_message}}"` + +- [e]dit the commit [m]essage before committing: + +`git magic -em "{{custom_commit_message}}"` + +- Commit changes and [p]ush to remote: + +`git magic -p` + +- Commit changes with a [f]orce [p]ush to remote: + +`git magic -fp` diff --git a/git-mailinfo b/git-mailinfo new file mode 100644 index 00000000..48ab78b0 --- /dev/null +++ b/git-mailinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git mailinfo + +> Extract patch and authorship information from a single email message. +> More information: . + +- Extract the patch and author data from an email message: + +`git mailinfo {{message|patch}}` + +- Extract but remove leading and trailing whitespace: + +`git mailinfo -k {{message|patch}}` + +- Remove everything from the body before a scissors line (e.g. "-->* --") and retrieve the message or patch: + +`git mailinfo --scissors {{message|patch}}` diff --git a/git-maintenance b/git-maintenance new file mode 100644 index 00000000..3ee96c46 --- /dev/null +++ b/git-maintenance @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git-maintenance + +> Run tasks to optimize Git repository data. +> More information: . + +- Register the current repository in the user's list of repositories to daily have maintenance run: + +`git maintenance register` + +- Start running maintenance on the current repository: + +`git maintenance start` + +- Halt the background maintenance schedule for the current repository: + +`git maintenance stop` + +- Remove the current repository from the user's maintenance repository list: + +`git maintenance unregister` + +- Run a specific maintenance task on the current repository: + +`git maintenance run --task={{commit-graph|gc|incremental-repack|loose-objects|pack-refs|prefetch}}` diff --git a/git-merge b/git-merge new file mode 100644 index 00000000..de6ed1ac --- /dev/null +++ b/git-merge @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git merge + +> Merge branches. +> More information: . + +- Merge a branch into your current branch: + +`git merge {{branch_name}}` + +- Edit the merge message: + +`git merge --edit {{branch_name}}` + +- Merge a branch and create a merge commit: + +`git merge --no-ff {{branch_name}}` + +- Abort a merge in case of conflicts: + +`git merge --abort` + +- Merge using a specific strategy: + +`git merge --strategy {{strategy}} --strategy-option {{strategy_option}} {{branch_name}}` diff --git a/git-merge-base b/git-merge-base new file mode 100644 index 00000000..d1fbfcfc --- /dev/null +++ b/git-merge-base @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git merge-base + +> Find a common ancestor of two commits. +> More information: . + +- Print the best common ancestor of two commits: + +`git merge-base {{commit_1}} {{commit_2}}` + +- Print all best common ancestors of two commits: + +`git merge-base --all {{commit_1}} {{commit_2}}` + +- Check if a commit is an ancestor of a specific commit: + +`git merge-base --is-ancestor {{ancestor_commit}} {{commit}}` diff --git a/git-merge-into b/git-merge-into new file mode 100644 index 00000000..3801f8da --- /dev/null +++ b/git-merge-into @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git merge-into + +> Merge one branch into another branch. +> Part of `git-extras`. +> More information: . + +- Merge a source branch into a specific destination branch: + +`git merge-into {{source_branch}} {{destination_branch}}` + +- Merge current branch into a specific destination branch: + +`git merge-into {{destination_branch}}` diff --git a/git-merge-repo b/git-merge-repo new file mode 100644 index 00000000..a19c52b3 --- /dev/null +++ b/git-merge-repo @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git merge-repo + +> Merge two repository histories. +> Part of `git-extras`. +> More information: . + +- Merge a repository's branch into the current repository's directory: + +`git merge-repo {{path/to/repo}} {{branch_name}} {{path/to/directory}}` + +- Merge a remote repository's branch into the current repository's directory, not preserving history: + +`git merge-repo {{path/to/remote_repo}} {{branch_name}} .` diff --git a/git-mergetool b/git-mergetool new file mode 100644 index 00000000..a728f197 --- /dev/null +++ b/git-mergetool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git mergetool + +> Run merge conflict resolution tools to resolve merge conflicts. +> More information: . + +- Launch the default merge tool to resolve conflicts: + +`git mergetool` + +- List valid merge tools: + +`git mergetool --tool-help` + +- Launch the merge tool identified by a name: + +`git mergetool --tool {{tool_name}}` + +- Don't prompt before each invocation of the merge tool: + +`git mergetool --no-prompt` + +- Explicitly use the GUI merge tool (see the `merge.guitool` configuration variable): + +`git mergetool --gui` + +- Explicitly use the regular merge tool (see the `merge.tool` configuration variable): + +`git mergetool --no-gui` diff --git a/git-missing b/git-missing new file mode 100644 index 00000000..5f8d16eb --- /dev/null +++ b/git-missing @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git missing + +> Show commits which aren't shared between two branches. +> Part of `git-extras`. +> More information: . + +- Show commits which aren't shared between the currently checked-out branch and another branch: + +`git missing {{branch}}` + +- Show commits which aren't shared between two branches: + +`git missing {{branch_1}} {{branch_2}}` diff --git a/git-mr b/git-mr new file mode 100644 index 00000000..5eb9381c --- /dev/null +++ b/git-mr @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git mr + +> Check out GitLab merge requests locally. +> Part of `git-extras`. +> More information: . + +- Check out a specific merge request: + +`git mr {{mr_number}}` + +- Check out a merge request from a specific remote: + +`git mr {{mr_number}} {{remote}}` + +- Checkout a merge request from its URL: + +`git mr {{url}}` + +- Clean up old merge request branches: + +`git mr clean` diff --git a/git-mv b/git-mv new file mode 100644 index 00000000..16ae3df2 --- /dev/null +++ b/git-mv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git mv + +> Move or rename files and update the Git index. +> More information: . + +- Move a file inside the repo and add the movement to the next commit: + +`git mv {{path/to/file}} {{new/path/to/file}}` + +- Rename a file or directory and add the renaming to the next commit: + +`git mv {{path/to/file_or_directory}} {{path/to/destination}}` + +- Overwrite the file or directory in the target path if it exists: + +`git mv --force {{path/to/file_or_directory}} {{path/to/destination}}` diff --git a/git-notes b/git-notes new file mode 100644 index 00000000..21f65854 --- /dev/null +++ b/git-notes @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git notes + +> Add or inspect object notes. +> More information: . + +- List all notes and the objects they are attached to: + +`git notes list` + +- List all notes attached to a given object (defaults to HEAD): + +`git notes list [{{object}}]` + +- Show the notes attached to a given object (defaults to HEAD): + +`git notes show [{{object}}]` + +- Append a note to a specified object (opens the default text editor): + +`git notes append {{object}}` + +- Append a note to a specified object, specifying the message: + +`git notes append --message="{{message_text}}"` + +- Edit an existing note (defaults to HEAD): + +`git notes edit [{{object}}]` + +- Copy a note from one object to another: + +`git notes copy {{source_object}} {{target_object}}` + +- Remove all the notes added to a specified object: + +`git notes remove {{object}}` diff --git a/git-obliterate b/git-obliterate new file mode 100644 index 00000000..d32d759a --- /dev/null +++ b/git-obliterate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git obliterate + +> Delete files and erase their history from a Git repository. +> Part of `git-extras`. +> More information: . + +- Erase the existence of specific files: + +`git obliterate {{file_1 file_2 ...}}` + +- Erase the existence of specific files between 2 commits: + +`git obliterate {{file_1 file_2 ...}} -- {{commit_hash_1}}..{{commit_hash_2}}` diff --git a/git-paste b/git-paste new file mode 100644 index 00000000..853a4bb5 --- /dev/null +++ b/git-paste @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git paste + +> Send commits to a pastebin site using `pastebinit`. +> Part of `git-extras`. +> More information: . + +- Send the patches between the current branch and its upstream to a pastebin using `pastebinit`: + +`git paste` + +- Pass options to `git format-patch` in order to select a different set of commits (`@^` selects the parent of HEAD, and so the currently checked out commit is sent): + +`git paste {{@^}}` diff --git a/git-pr b/git-pr new file mode 100644 index 00000000..eb519fba --- /dev/null +++ b/git-pr @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git pr + +> Check out GitHub pull requests locally. +> Part of `git-extras`. +> More information: . + +- Check out a specific pull request: + +`git pr {{pr_number}}` + +- Check out a pull request from a specific remote: + +`git pr {{pr_number}} {{remote}}` + +- Check out a pull request from its URL: + +`git pr {{url}}` + +- Clean up old pull request branches: + +`git pr clean` diff --git a/git-prune b/git-prune new file mode 100644 index 00000000..b92a17d5 --- /dev/null +++ b/git-prune @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git prune + +> Git command for pruning all unreachable objects from the object database. +> This command is often not used directly but as an internal command that is used by Git gc. +> More information: . + +- Report what would be removed by Git prune without removing it: + +`git prune --dry-run` + +- Prune unreachable objects and display what has been pruned to `stdout`: + +`git prune --verbose` + +- Prune unreachable objects while showing progress: + +`git prune --progress` diff --git a/git-psykorebase b/git-psykorebase new file mode 100644 index 00000000..77d52b03 --- /dev/null +++ b/git-psykorebase @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git psykorebase + +> Rebase a branch on top of another using a merge commit and only one conflict handling. +> Part of `git-extras`. +> More information: . + +- Rebase the current branch on top of another using a merge commit and only one conflict handling: + +`git psykorebase {{upstream_branch}}` + +- Continue after conflicts have been handled: + +`git psykorebase --continue` + +- Specify the branch to rebase: + +`git psykorebase {{upstream_branch}} {{target_branch}}` diff --git a/git-pull b/git-pull new file mode 100644 index 00000000..383a21ee --- /dev/null +++ b/git-pull @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git pull + +> Fetch branch from a remote repository and merge it to local repository. +> More information: . + +- Download changes from default remote repository and merge it: + +`git pull` + +- Download changes from default remote repository and use fast-forward: + +`git pull --rebase` + +- Download changes from given remote repository and branch, then merge them into HEAD: + +`git pull {{remote_name}} {{branch}}` diff --git a/git-pull-request b/git-pull-request new file mode 100644 index 00000000..e280ebe7 --- /dev/null +++ b/git-pull-request @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git pull-request + +> Create a pull request for a project on GitHub. +> Part of `git-extras`. +> More information: . + +- Create a pull request for a project on GitHub: + +`git pull-request {{target_branch}}` diff --git a/git-push b/git-push new file mode 100644 index 00000000..a4309199 --- /dev/null +++ b/git-push @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git push + +> Push commits to a remote repository. +> More information: . + +- Send local changes in the current branch to its default remote counterpart: + +`git push` + +- Send changes from a specific local branch to its remote counterpart: + +`git push {{remote_name}} {{local_branch}}` + +- Send changes from a specific local branch to its remote counterpart, and set the remote one as the default push/pull target of the local one: + +`git push -u {{remote_name}} {{local_branch}}` + +- Send changes from a specific local branch to a specific remote branch: + +`git push {{remote_name}} {{local_branch}}:{{remote_branch}}` + +- Send changes on all local branches to their counterparts in a given remote repository: + +`git push --all {{remote_name}}` + +- Delete a branch in a remote repository: + +`git push {{remote_name}} --delete {{remote_branch}}` + +- Remove remote branches that don't have a local counterpart: + +`git push --prune {{remote_name}}` + +- Publish tags that aren't yet in the remote repository: + +`git push --tags` diff --git a/git-range-diff b/git-range-diff new file mode 100644 index 00000000..791f35c0 --- /dev/null +++ b/git-range-diff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git range-diff + +> Compare two commit ranges (e.g. two versions of a branch). +> More information: . + +- Diff the changes of two individual commits: + +`git range-diff {{commit_1}}^! {{commit_2}}^!` + +- Diff the changes of ours and theirs from their common ancestor, e.g. after an interactive rebase: + +`git range-diff {{theirs}}...{{ours}}` + +- Diff the changes of two commit ranges, e.g. to check whether conflicts have been resolved appropriately when rebasing commits from `base1` to `base2`: + +`git range-diff {{base1}}..{{rev1}} {{base2}}..{{rev2}}` diff --git a/git-reauthor b/git-reauthor new file mode 100644 index 00000000..7e752a67 --- /dev/null +++ b/git-reauthor @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git reauthor + +> Change details about an author identity. Since this command rewrites the Git history, `--force` will be needed when pushing next time. +> Part of `git-extras`. +> More information: . + +- Change an author's email and name across the whole Git repository: + +`git reauthor --old-email {{old@example.com}} --correct-email {{new@example.com}} --correct-name "{{name}}"` + +- Change the email and name to the ones defined in the Git config: + +`git reauthor --old-email {{old@example.com}} --use-config` + +- Change the email and name of all commits, regardless of their original author: + +`git reauthor --all --correct-email {{name@example.com}} --correct-name {{name}}` diff --git a/git-rebase b/git-rebase new file mode 100644 index 00000000..7299cebe --- /dev/null +++ b/git-rebase @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rebase + +> Reapply commits from one branch on top of another branch. +> Commonly used to "move" an entire branch to another base, creating copies of the commits in the new location. +> More information: . + +- Rebase the current branch on top of another specified branch: + +`git rebase {{new_base_branch}}` + +- Start an interactive rebase, which allows the commits to be reordered, omitted, combined or modified: + +`git rebase -i {{target_base_branch_or_commit_hash}}` + +- Continue a rebase that was interrupted by a merge failure, after editing conflicting files: + +`git rebase --continue` + +- Continue a rebase that was paused due to merge conflicts, by skipping the conflicted commit: + +`git rebase --skip` + +- Abort a rebase in progress (e.g. if it is interrupted by a merge conflict): + +`git rebase --abort` + +- Move part of the current branch onto a new base, providing the old base to start from: + +`git rebase --onto {{new_base}} {{old_base}}` + +- Reapply the last 5 commits in-place, stopping to allow them to be reordered, omitted, combined or modified: + +`git rebase -i {{HEAD~5}}` + +- Auto-resolve any conflicts by favoring the working branch version (`theirs` keyword has reversed meaning in this case): + +`git rebase -X theirs {{branch_name}}` diff --git a/git-rebase-patch b/git-rebase-patch new file mode 100644 index 00000000..a541032a --- /dev/null +++ b/git-rebase-patch @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rebase-patch + +> Find the commit the patch applies to and do a rebase. +> Part of `git-extras`. +> More information: . + +- Find the commit the patch applies to and do a rebase: + +`git rebase-patch {{patch_file}}` diff --git a/git-reflog b/git-reflog new file mode 100644 index 00000000..255ccc46 --- /dev/null +++ b/git-reflog @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git reflog + +> Show a log of changes to local references like HEAD, branches or tags. +> More information: . + +- Show the reflog for HEAD: + +`git reflog` + +- Show the reflog for a given branch: + +`git reflog {{branch_name}}` + +- Show only the 5 latest entries in the reflog: + +`git reflog -n {{5}}` diff --git a/git-release b/git-release new file mode 100644 index 00000000..fbbfac54 --- /dev/null +++ b/git-release @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git release + +> Create a Git tag for a release. +> Part of `git-extras`. +> More information: . + +- Create and push a release: + +`git release {{tag_name}}` + +- Create and push a signed release: + +`git release {{tag_name}} -s` + +- Create and push a release with a message: + +`git release {{tag_name}} -m "{{message}}"` diff --git a/git-remote b/git-remote new file mode 100644 index 00000000..08cecfbc --- /dev/null +++ b/git-remote @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git remote + +> Manage set of tracked repositories ("remotes"). +> More information: . + +- List existing remotes with their names and URLs: + +`git remote -v` + +- Show information about a remote: + +`git remote show {{remote_name}}` + +- Add a remote: + +`git remote add {{remote_name}} {{remote_url}}` + +- Change the URL of a remote (use `--add` to keep the existing URL): + +`git remote set-url {{remote_name}} {{new_url}}` + +- Show the URL of a remote: + +`git remote get-url {{remote_name}}` + +- Remove a remote: + +`git remote remove {{remote_name}}` + +- Rename a remote: + +`git remote rename {{old_name}} {{new_name}}` diff --git a/git-rename-branch b/git-rename-branch new file mode 100644 index 00000000..3b611e5c --- /dev/null +++ b/git-rename-branch @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rename-branch + +> Rename a Git branch. +> Part of `git-extras`. +> More information: . + +- Rename the branch you are currently on: + +`git rename-branch {{new_branch_name}}` + +- Rename a specific branch: + +`git rename-branch {{old_branch_name}} {{new_branch_name}}` diff --git a/git-rename-remote b/git-rename-remote new file mode 100644 index 00000000..7d09a64a --- /dev/null +++ b/git-rename-remote @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rename-remote + +> Change remote for pulling and pushing. +> Part of `git-extras`. +> More information: . + +- Change the upstream remote to origin: + +`git rename-remote {{upstream}} {{origin}}` diff --git a/git-rename-tag b/git-rename-tag new file mode 100644 index 00000000..1f54bba2 --- /dev/null +++ b/git-rename-tag @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rename-tag + +> Rename a Git tag. +> Part of `git-extras`. +> More information: . + +- Rename an existing Git tag locally and remotely: + +`git rename-tag {{old_tag_name}} {{new_tag_name}}` diff --git a/git-repack b/git-repack new file mode 100644 index 00000000..bb433cb2 --- /dev/null +++ b/git-repack @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git repack + +> Pack unpacked objects in a Git repository. +> More information: . + +- Pack unpacked objects in the current directory: + +`git repack` + +- Also remove redundant objects after packing: + +`git repack -d` diff --git a/git-repl b/git-repl new file mode 100644 index 00000000..e8d5b4ef --- /dev/null +++ b/git-repl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git repl + +> Git REPL (read-evaluate-print-loop) - an interactive Git shell. +> Part of `git-extras`. +> More information: . + +- Start an interactive Git shell: + +`git repl` + +- Run a Git command while in the interactive Git shell: + +`{{git_subcommand}} {{command_arguments}}` + +- Run an external (non-Git) command while in the interactive Git shell: + +`!{{command}} {{command_arguments}}` + +- Exit the interactive Git shell (or press Ctrl + D): + +`exit` diff --git a/git-replace b/git-replace new file mode 100644 index 00000000..af5d2d8c --- /dev/null +++ b/git-replace @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git replace + +> Create, list, and delete refs to replace objects. +> More information: . + +- Replace any commit with a different one, leaving other commits unchanged: + +`git replace {{object}} {{replacement}}` + +- Delete existing replace refs for the given objects: + +`git replace --delete {{object}}` + +- Edit an object’s content interactively: + +`git replace --edit {{object}}` diff --git a/git-request-pull b/git-request-pull new file mode 100644 index 00000000..bdba93fc --- /dev/null +++ b/git-request-pull @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git request-pull + +> Generate a request asking the upstream project to pull changes into its tree. +> More information: . + +- Produce a request summarizing the changes between the v1.1 release and a specified branch: + +`git request-pull {{v1.1}} {{https://example.com/project}} {{branch_name}}` + +- Produce a request summarizing the changes between the v0.1 release on the `foo` branch and the local `bar` branch: + +`git request-pull {{v0.1}} {{https://example.com/project}} {{foo:bar}}` diff --git a/git-reset b/git-reset new file mode 100644 index 00000000..8c4c194e --- /dev/null +++ b/git-reset @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git reset + +> Undo commits or unstage changes, by resetting the current Git HEAD to the specified state. +> If a path is passed, it works as "unstage"; if a commit hash or branch is passed, it works as "uncommit". +> More information: . + +- Unstage everything: + +`git reset` + +- Unstage specific file(s): + +`git reset {{path/to/file1 path/to/file2 ...}}` + +- Interactively unstage portions of a file: + +`git reset --patch {{path/to/file}}` + +- Undo the last commit, keeping its changes (and any further uncommitted changes) in the filesystem: + +`git reset HEAD~` + +- Undo the last two commits, adding their changes to the index, i.e. staged for commit: + +`git reset --soft HEAD~2` + +- Discard any uncommitted changes, staged or not (for only unstaged changes, use `git checkout`): + +`git reset --hard` + +- Reset the repository to a given commit, discarding committed, staged and uncommitted changes since then: + +`git reset --hard {{commit}}` diff --git a/git-reset-file b/git-reset-file new file mode 100644 index 00000000..583de82c --- /dev/null +++ b/git-reset-file @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git reset-file + +> Revert a file to HEAD or a commit. +> Part of `git-extras`. +> More information: . + +- Reset a file to HEAD: + +`git reset-file {{path/to/file}}` + +- Reset a file to a specific commit: + +`git reset-file {{path/to/file}} {{commit_hash}}` diff --git a/git-restore b/git-restore new file mode 100644 index 00000000..75c5683f --- /dev/null +++ b/git-restore @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git restore + +> Restore working tree files. Requires Git version 2.23+. +> See also `git checkout` and `git reset`. +> More information: . + +- Restore an unstaged file to the version of the current commit (HEAD): + +`git restore {{path/to/file}}` + +- Restore an unstaged file to the version of a specific commit: + +`git restore --source {{commit}} {{path/to/file}}` + +- Discard all unstaged changes to tracked files: + +`git restore :/` + +- Unstage a file: + +`git restore --staged {{path/to/file}}` + +- Unstage all files: + +`git restore --staged :/` + +- Discard all changes to files, both staged and unstaged: + +`git restore --worktree --staged :/` + +- Interactively select sections of files to restore: + +`git restore --patch` diff --git a/git-rev-list b/git-rev-list new file mode 100644 index 00000000..60371a58 --- /dev/null +++ b/git-rev-list @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rev-list + +> List revisions (commits) in reverse chronological order. +> More information: . + +- List all commits on the current branch: + +`git rev-list {{HEAD}}` + +- Print the latest commit that changed (add/edit/remove) a specific file on the current branch: + +`git rev-list -n 1 HEAD -- {{path/to/file}}` + +- List commits more recent than a specific date, on a specific branch: + +`git rev-list --since={{'2019-12-01 00:00:00'}} {{branch_name}}` + +- List all merge commits on a specific commit: + +`git rev-list --merges {{commit}}` + +- Print the number of commits since a specific tag: + +`git rev-list {{tag_name}}..HEAD --count` diff --git a/git-rev-parse b/git-rev-parse new file mode 100644 index 00000000..f4383a7e --- /dev/null +++ b/git-rev-parse @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rev-parse + +> Display metadata related to revisions. +> More information: . + +- Get the commit hash of a branch: + +`git rev-parse {{branch_name}}` + +- Get the current branch name: + +`git rev-parse --abbrev-ref {{HEAD}}` + +- Get the absolute path to the root directory: + +`git rev-parse --show-toplevel` diff --git a/git-revert b/git-revert new file mode 100644 index 00000000..c289e290 --- /dev/null +++ b/git-revert @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git revert + +> Create new commits which reverse the effect of earlier ones. +> More information: . + +- Revert the most recent commit: + +`git revert {{HEAD}}` + +- Revert the 5th last commit: + +`git revert HEAD~{{4}}` + +- Revert a specific commit: + +`git revert {{0c01a9}}` + +- Revert multiple commits: + +`git revert {{branch_name~5..branch_name~2}}` + +- Don't create new commits, just change the working tree: + +`git revert -n {{0c01a9..9a1743}}` diff --git a/git-rm b/git-rm new file mode 100644 index 00000000..38d3be19 --- /dev/null +++ b/git-rm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rm + +> Remove files from repository index and local filesystem. +> More information: . + +- Remove file from repository index and filesystem: + +`git rm {{path/to/file}}` + +- Remove directory: + +`git rm -r {{path/to/directory}}` + +- Remove file from repository index but keep it untouched locally: + +`git rm --cached {{path/to/file}}` diff --git a/git-root b/git-root new file mode 100644 index 00000000..fdec95ce --- /dev/null +++ b/git-root @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git root + +> Print the root directory of the current Git repository. +> Part of `git-extras`. +> More information: . + +- Print the absolute path of the current Git repository: + +`git root` + +- Print the current working directory relative to the root of the current Git repository: + +`git root --relative` diff --git a/git-rscp b/git-rscp new file mode 100644 index 00000000..73f977c2 --- /dev/null +++ b/git-rscp @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git rscp + +> Reverse `git scp` - copy files from the working directory of a remote repository to the current working tree. +> Part of `git-extras`. +> More information: . + +- Copy specific files from a remote: + +`git rscp {{remote_name}} {{path/to/file1 path/to/file2 ...}}` + +- Copy a specific directory from a remote: + +`git rscp {{remote_name}} {{path/to/directory}}` diff --git a/git-scp b/git-scp new file mode 100644 index 00000000..3babb5b6 --- /dev/null +++ b/git-scp @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git scp + +> Copy files from the current working tree to the working directory of a remote repository. +> Part of `git-extras`. Uses `rsync` to transfer files. +> More information: . + +- Copy unstaged files to a specific remote: + +`git scp {{remote_name}}` + +- Copy staged and unstaged files to a remote: + +`git scp {{remote_name}} HEAD` + +- Copy files that has been changed in the last commit and any staged or unstaged files to a remote: + +`git scp {{remote_name}} HEAD~1` + +- Copy specific files to a remote: + +`git scp {{remote_name}} {{path/to/file1 path/to/file2 ...}}` + +- Copy a specific directory to a remote: + +`git scp {{remote_name}} {{path/to/directory}}` diff --git a/git-secret b/git-secret new file mode 100644 index 00000000..0115ef02 --- /dev/null +++ b/git-secret @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git secret + +> Bash tool which stores private data inside a Git repository. +> More information: . + +- Initialize `git-secret` in a local repository: + +`git secret init` + +- Grant access to the current Git user's email: + +`git secret tell -m` + +- Grant access by email: + +`git secret tell {{email}}` + +- Revoke access by email: + +`git secret killperson {{email}}` + +- List emails with access to secrets: + +`git secret whoknows` + +- Register a secret file: + +`git secret add {{path/to/file}}` + +- Encrypt secrets: + +`git secret hide` + +- Decrypt secret files: + +`git secret reveal` diff --git a/git-sed b/git-sed new file mode 100644 index 00000000..6b864120 --- /dev/null +++ b/git-sed @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git sed + +> Replace patterns in git-controlled files using sed. +> Part of `git-extras`. +> More information: . + +- Replace the specified text in the current repository: + +`git sed '{{find_text}}' '{{replace_text}}'` + +- Replace the specified text and then commit the resulting changes with a standard commit message: + +`git sed -c '{{find_text}}' '{{replace_text}}'` + +- Replace the specified text, using regular expressions: + +`git sed -f g '{{find_text}}' '{{replace_text}}'` + +- Replace a specific text in all files under a given directory: + +`git sed '{{find_text}}' '{{replace_text}}' -- {{path/to/directory}}` diff --git a/git-send-email b/git-send-email new file mode 100644 index 00000000..64fe8acf --- /dev/null +++ b/git-send-email @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git send-email + +> Send a collection of patches as emails. +> Patches can be specified as files, directions, or a revision list. +> More information: . + +- Send the last commit in the current branch: + +`git send-email -1` + +- Send a given commit: + +`git send-email -1 {{commit}}` + +- Send multiple (e.g. 10) commits in the current branch: + +`git send-email {{-10}}` + +- Send an introductory email message for the patch series: + +`git send-email -{{number_of_commits}} --compose` + +- Review and edit the email message for each patch you're about to send: + +`git send-email -{{number_of_commits}} --annotate` diff --git a/git-setup b/git-setup new file mode 100644 index 00000000..5bbe1031 --- /dev/null +++ b/git-setup @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git setup + +> Create a Git repository in a directory and commit all files. +> Part of `git-extras`. +> More information: . + +- Create a Git repository in the current directory and commit all files: + +`git setup` + +- Create a Git repository in a specific directory and commit all files: + +`git setup {{path/to/directory}}` diff --git a/git-shortlog b/git-shortlog new file mode 100644 index 00000000..a72b1407 --- /dev/null +++ b/git-shortlog @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git shortlog + +> Summarizes the `git log` output. +> More information: . + +- View a summary of all the commits made, grouped alphabetically by author name: + +`git shortlog` + +- View a summary of all the commits made, sorted by the number of commits made: + +`git shortlog -n` + +- View a summary of all the commits made, grouped by the committer identities (name and email): + +`git shortlog -c` + +- View a summary of the last 5 commits (i.e. specify a revision range): + +`git shortlog HEAD~{{5}}..HEAD` + +- View all users, emails and the number of commits in the current branch: + +`git shortlog -sne` + +- View all users, emails and the number of commits in all branches: + +`git shortlog -sne --all` diff --git a/git-show b/git-show new file mode 100644 index 00000000..e3a04cb3 --- /dev/null +++ b/git-show @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show + +> Show various types of Git objects (commits, tags, etc.). +> More information: . + +- Show information about the latest commit (hash, message, changes, and other metadata): + +`git show` + +- Show information about a given commit: + +`git show {{commit}}` + +- Show information about the commit associated with a given tag: + +`git show {{tag}}` + +- Show information about the 3rd commit from the HEAD of a branch: + +`git show {{branch}}~{{3}}` + +- Show a commit's message in a single line, suppressing the diff output: + +`git show --oneline -s {{commit}}` + +- Show only statistics (added/removed characters) about the changed files: + +`git show --stat {{commit}}` + +- Show only the list of added, renamed or deleted files: + +`git show --summary {{commit}}` + +- Show the contents of a file as it was at a given revision (e.g. branch, tag or commit): + +`git show {{revision}}:{{path/to/file}}` diff --git a/git-show-branch b/git-show-branch new file mode 100644 index 00000000..be68d5c2 --- /dev/null +++ b/git-show-branch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-branch + +> Show branches and their commits. +> More information: . + +- Show a summary of the latest commit on a branch: + +`git show-branch {{branch_name|ref|commit}}` + +- Compare commits in the history of multiple commits or branches: + +`git show-branch {{branch_name1|ref1|commit1 branch_name2|ref2|commit2 ...}}` + +- Compare all remote tracking branches: + +`git show-branch --remotes` + +- Compare both local and remote tracking branches: + +`git show-branch --all` + +- List the latest commits in all branches: + +`git show-branch --all --list` + +- Compare a given branch with the current branch: + +`git show-branch --current {{commit|branch_name|ref}}` + +- Display the commit name instead of the relative name: + +`git show-branch --sha1-name --current {{current|branch_name|ref}}` + +- Keep going a given number of commits past the common ancestor: + +`git show-branch --more {{5}} {{commit|branch_name|ref}} {{commit|branch_name|ref}} {{...}}` diff --git a/git-show-index b/git-show-index new file mode 100644 index 00000000..4646c70f --- /dev/null +++ b/git-show-index @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-index + +> Show the packed archive index of a Git repository. +> More information: . + +- Read an IDX file for a Git packfile and dump its contents to `stdout`: + +`git show-index {{path/to/file.idx}}` + +- Specify the hash algorithm for the index file (experimental): + +`git show-index --object-format={{sha1|sha256}} {{path/to/file}}` diff --git a/git-show-merged-branches b/git-show-merged-branches new file mode 100644 index 00000000..5b8eadb7 --- /dev/null +++ b/git-show-merged-branches @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-merged-branches + +> Print all branches which are merged into the current head. +> More information: . + +- Print all branches which are merged into the current head: + +`git show-merged-branches` diff --git a/git-show-ref b/git-show-ref new file mode 100644 index 00000000..a9f7b488 --- /dev/null +++ b/git-show-ref @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-ref + +> Git command for listing references. +> More information: . + +- Show all refs in the repository: + +`git show-ref` + +- Show only heads references: + +`git show-ref --heads` + +- Show only tags references: + +`git show-ref --tags` + +- Verify that a given reference exists: + +`git show-ref --verify {{path/to/ref}}` diff --git a/git-show-tree b/git-show-tree new file mode 100644 index 00000000..328c8a50 --- /dev/null +++ b/git-show-tree @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-tree + +> Show a decorated tree graph with all branches of a Git repository, showing annotations. +> Part of `git-extras`. +> More information: . + +- Show a decorated tree graph for all branches annotated with tags and branch names: + +`git show-tree` diff --git a/git-show-unmerged-branches b/git-show-unmerged-branches new file mode 100644 index 00000000..0f2c46e9 --- /dev/null +++ b/git-show-unmerged-branches @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git show-unmerged-branches + +> Print all branches which are not merged into the current HEAD. +> More information: . + +- Print all branches which are not merged into the current HEAD: + +`git show-unmerged-branches` diff --git a/git-sizer b/git-sizer new file mode 100644 index 00000000..144c6f1c --- /dev/null +++ b/git-sizer @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git sizer + +> Computes various Git repository size metrics and alerts you to any that might cause problems or inconvenience. +> More information: . + +- Report only statistics that have a level of concern greater than 0: + +`git sizer` + +- Report all statistics: + +`git sizer -v` + +- See additional options: + +`git sizer -h` diff --git a/git-squash b/git-squash new file mode 100644 index 00000000..0143a142 --- /dev/null +++ b/git-squash @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git squash + +> Squash multiple commits into a single commit. +> Part of `git-extras`. +> More information: . + +- Merge all commits from a specific branch into the current branch as a single commit: + +`git squash {{source_branch}}` + +- Squash all commits starting with a specific commit on the current branch: + +`git squash {{commit}}` + +- Squash the `n` latest commits and commit with a message: + +`git squash HEAD~{{n}} "{{message}}"` + +- Squash the `n` latest commits and commit concatenating all individual messages: + +`git squash --squash-msg HEAD~{{n}}` diff --git a/git-stage b/git-stage new file mode 100644 index 00000000..a190047d --- /dev/null +++ b/git-stage @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git stage + +> This command is an alias of `git add`. +> More information: . + +- View documentation for the original command: + +`tldr git add` diff --git a/git-stamp b/git-stamp new file mode 100644 index 00000000..a7813430 --- /dev/null +++ b/git-stamp @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git stamp + +> Stamp the last commit message, with the possibility to reference the issues numbers from your bug tracker or link to its review page. +> Part of `git-extras`. +> More information: . + +- Stamp the last commit message referencing it with the issue number from your bug tracker: + +`git stamp {{issue_number}}` + +- Stamp the last commit message linking it to its review page: + +`git stamp {{Review https://example.org/path/to/review}}` + +- Stamp the last commit message replacing previous issues with a new one: + +`git stamp --replace {{issue_number}}` diff --git a/git-standup b/git-standup new file mode 100644 index 00000000..42954ddb --- /dev/null +++ b/git-standup @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git standup + +> See commits from a specified user. +> Part of `git-extras`. +> More information: . + +- Show a given author's commits from the last 10 days: + +`git standup -a {{name|email}} -d {{10}}` + +- Show a given author's commits from the last 10 days and whether they are GPG signed: + +`git standup -a {[name|email}} -d {{10}} -g` + +- Show all the commits from all contributors for the last 10 days: + +`git standup -a all -d {{10}}` + +- Display help: + +`git standup -h` diff --git a/git-stash b/git-stash new file mode 100644 index 00000000..d4f05748 --- /dev/null +++ b/git-stash @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git stash + +> Stash local Git changes in a temporary area. +> More information: . + +- Stash current changes, except new (untracked) files: + +`git stash push -m {{optional_stash_message}}` + +- Stash current changes, including new (untracked) files: + +`git stash -u` + +- Interactively select parts of changed files for stashing: + +`git stash -p` + +- List all stashes (shows stash name, related branch and message): + +`git stash list` + +- Show the changes as a patch between the stash (default is `stash@{0}`) and the commit back when stash entry was first created: + +`git stash show -p {{stash@{0}}}` + +- Apply a stash (default is the latest, named stash@{0}): + +`git stash apply {{optional_stash_name_or_commit}}` + +- Drop or apply a stash (default is stash@{0}) and remove it from the stash list if applying doesn't cause conflicts: + +`git stash pop {{optional_stash_name}}` + +- Drop all stashes: + +`git stash clear` diff --git a/git-status b/git-status new file mode 100644 index 00000000..329a983e --- /dev/null +++ b/git-status @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git status + +> Show the changes to files in a Git repository. +> Lists changed, added and deleted files compared to the currently checked-out commit. +> More information: . + +- Show changed files which are not yet added for commit: + +`git status` + +- Give output in [s]hort format: + +`git status --short` + +- Show the [b]ranch and tracking info: + +`git status --branch` + +- Show output in [s]hort format along with [b]ranch info: + +`git status --short --branch` + +- Show the number of entries currently stashed away: + +`git status --show-stash` + +- Don't show untracked files in the output: + +`git status --untracked-files=no` diff --git a/git-stripspace b/git-stripspace new file mode 100644 index 00000000..559e0b79 --- /dev/null +++ b/git-stripspace @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git stripspace + +> Read text (e.g. commit messages, notes, tags, and branch descriptions) from `stdin` and clean it into the manner used by Git. +> More information: . + +- Trim whitespace from a file: + +`cat {{path/to/file}} | git stripspace` + +- Trim whitespace and Git comments from a file: + +`cat {{path/to/file}} | git stripspace --strip-comments` + +- Convert all lines in a file into Git comments: + +`git stripspace --comment-lines < {{path/to/file}}` diff --git a/git-submodule b/git-submodule new file mode 100644 index 00000000..f121b789 --- /dev/null +++ b/git-submodule @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git submodule + +> Inspects, updates and manages submodules. +> More information: . + +- Install a repository's specified submodules: + +`git submodule update --init --recursive` + +- Add a Git repository as a submodule: + +`git submodule add {{repository_url}}` + +- Add a Git repository as a submodule at the specified directory: + +`git submodule add {{repository_url}} {{path/to/directory}}` + +- Update every submodule to its latest commit: + +`git submodule foreach git pull` diff --git a/git-subtree b/git-subtree new file mode 100644 index 00000000..a6d423c6 --- /dev/null +++ b/git-subtree @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git subtree + +> Manage project dependencies as subprojects. +> More information: . + +- Add a Git repository as a subtree: + +`git subtree add --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` + +- Update subtree repository to its latest commit: + +`git subtree pull --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` + +- Merge recent changes up to the latest subtree commit into the subtree: + +`git subtree merge --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` + +- Push commits to a subtree repository: + +`git subtree push --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` + +- Extract a new project history from the history of a subtree: + +`git subtree split --prefix={{path/to/directory/}} {{repository_url}} -b {{branch_name}}` diff --git a/git-summary b/git-summary new file mode 100644 index 00000000..9ebf3e63 --- /dev/null +++ b/git-summary @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git summary + +> Display information about a Git repository. +> Part of `git-extras`. +> More information: . + +- Display data about a Git repository: + +`git summary` + +- Display data about a Git repository since a commit-ish: + +`git summary {{commit|branch_name|tag_name}}` + +- Display data about a Git repository, merging committers using different emails into 1 statistic for each author: + +`git summary --dedup-by-email` + +- Display data about a Git repository, showing the number of lines modified by each contributor: + +`git summary --line` diff --git a/git-svn b/git-svn new file mode 100644 index 00000000..3d33ae96 --- /dev/null +++ b/git-svn @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git svn + +> Bidirectional operation between a Subversion repository and Git. +> More information: . + +- Clone an SVN repository: + +`git svn clone {{https://example.com/subversion_repo}} {{local_dir}}` + +- Clone an SVN repository starting at a given revision number: + +`git svn clone -r{{1234}}:HEAD {{https://svn.example.net/subversion/repo}} {{local_dir}}` + +- Update local clone from the remote SVN repository: + +`git svn rebase` + +- Fetch updates from the remote SVN repository without changing the Git HEAD: + +`git svn fetch` + +- Commit back to the SVN repository: + +`git svn commit` diff --git a/git-switch b/git-switch new file mode 100644 index 00000000..6dd81b8d --- /dev/null +++ b/git-switch @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git switch + +> Switch between Git branches. Requires Git version 2.23+. +> See also `git checkout`. +> More information: . + +- Switch to an existing branch: + +`git switch {{branch_name}}` + +- Create a new branch and switch to it: + +`git switch --create {{branch_name}}` + +- Create a new branch based on an existing commit and switch to it: + +`git switch --create {{branch_name}} {{commit}}` + +- Switch to the previous branch: + +`git switch -` + +- Switch to a branch and update all submodules to match: + +`git switch --recurse-submodules {{branch_name}}` + +- Switch to a branch and automatically merge the current branch and any uncommitted changes into it: + +`git switch --merge {{branch_name}}` diff --git a/git-symbolic-ref b/git-symbolic-ref new file mode 100644 index 00000000..8f411e16 --- /dev/null +++ b/git-symbolic-ref @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git symbolic-ref + +> Read, change, or delete files that store references. +> More information: . + +- Store a reference by a name: + +`git symbolic-ref refs/{{name}} {{ref}}` + +- Store a reference by name, including a message with a reason for the update: + +`git symbolic-ref -m "{{message}}" refs/{{name}} refs/heads/{{branch_name}}` + +- Read a reference by name: + +`git symbolic-ref refs/{{name}}` + +- Delete a reference by name: + +`git symbolic-ref --delete refs/{{name}}` + +- For scripting, hide errors with `--quiet` and use `--short` to simplify ("refs/heads/X" prints as "X"): + +`git symbolic-ref --quiet --short refs/{{name}}` diff --git a/git-sync b/git-sync new file mode 100644 index 00000000..c50ec180 --- /dev/null +++ b/git-sync @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git sync + +> Sync local branches with remote branches. +> Part of `git-extras`. +> More information: . + +- Sync the current local branch with its remote branch: + +`git sync` + +- Sync the current local branch with the remote main branch: + +`git sync origin main` + +- Sync without cleaning untracked files: + +`git sync -s {{remote_name}} {{branch_name}}` diff --git a/git-tag b/git-tag new file mode 100644 index 00000000..947dbe78 --- /dev/null +++ b/git-tag @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git tag + +> Create, list, delete or verify tags. +> A tag is a static reference to a commit. +> More information: . + +- List all tags: + +`git tag` + +- Create a tag with the given name pointing to the current commit: + +`git tag {{tag_name}}` + +- Create a tag with the given name pointing to a given commit: + +`git tag {{tag_name}} {{commit}}` + +- Create an annotated tag with the given message: + +`git tag {{tag_name}} -m {{tag_message}}` + +- Delete the tag with the given name: + +`git tag -d {{tag_name}}` + +- Get updated tags from upstream: + +`git fetch --tags` + +- List all tags whose ancestors include a given commit: + +`git tag --contains {{commit}}` diff --git a/git-touch b/git-touch new file mode 100644 index 00000000..2feb5916 --- /dev/null +++ b/git-touch @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git touch + +> Create new files and add them to the index. +> Part of `git-extras`. +> More information: . + +- Create new files and add them to the index: + +`git touch {{path/to/file1 path/to/file2 ...}}` diff --git a/git-undo b/git-undo new file mode 100644 index 00000000..d0f8a268 --- /dev/null +++ b/git-undo @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git undo + +> Undo recent commits. +> Part of `git-extras`. +> More information: . + +- Remove the most recent commit: + +`git undo` + +- Remove a specific number of the most recent commits: + +`git undo {{3}}` diff --git a/git-unlock b/git-unlock new file mode 100644 index 00000000..9c15e13f --- /dev/null +++ b/git-unlock @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git unlock + +> Unlock a file in a Git repository so it can be modified by a commit. +> Part of `git-extras`. See also `git lock`. +> More information: . + +- Enable the ability to commit changes of a previously-locked local file: + +`git unlock {{path/to/file}}` diff --git a/git-unpack-file b/git-unpack-file new file mode 100644 index 00000000..1900130b --- /dev/null +++ b/git-unpack-file @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git unpack-file + +> Create a temporary file with a blob's contents. +> More information: . + +- Create a file holding the contents of the blob specified by its ID then print the name of the temporary file: + +`git unpack-file {{blob_id}}` diff --git a/git-update-index b/git-update-index new file mode 100644 index 00000000..2477b5d5 --- /dev/null +++ b/git-update-index @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git update-index + +> Git command for manipulating the index. +> More information: . + +- Pretend that a modified file is unchanged (`git status` will not show this as changed): + +`git update-index --skip-worktree {{path/to/modified_file}}` diff --git a/git-update-ref b/git-update-ref new file mode 100644 index 00000000..e585819e --- /dev/null +++ b/git-update-ref @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git update-ref + +> Git command for creating, updating, and deleting Git refs. +> More information: . + +- Delete a ref, useful for soft resetting the first commit: + +`git update-ref -d {{HEAD}}` + +- Update ref with a message: + +`git update-ref -m {{message}} {{HEAD}} {{4e95e05}}` diff --git a/git-utimes b/git-utimes new file mode 100644 index 00000000..c4f3675c --- /dev/null +++ b/git-utimes @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git utimes + +> Change files modification time to their last commit date. Does not touch files that are in the working tree or index. +> Part of `git-extras`. +> More information: . + +- Change all files modification time to their last commit date: + +`git utimes` + +- Change files modification time that are newer than their last commit date, preserving original modification time of files that were committed from the local repository: + +`git utimes --newer` diff --git a/git-var b/git-var new file mode 100644 index 00000000..28c22e13 --- /dev/null +++ b/git-var @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git var + +> Prints a Git logical variable's value. +> See `git config`, which is preferred over `git var`. +> More information: . + +- Print the value of a Git logical variable: + +`git var {{GIT_AUTHOR_IDENT|GIT_COMMITTER_IDENT|GIT_EDITOR|GIT_PAGER}}` + +- [l]ist all Git logical variables: + +`git var -l` diff --git a/git-verify-commit b/git-verify-commit new file mode 100644 index 00000000..f0085bf1 --- /dev/null +++ b/git-verify-commit @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git verify-commit + +> Check for GPG verification of commits. +> If no commits are verified, nothing will be printed, regardless of options specified. +> More information: . + +- Check commits for a GPG signature: + +`git verify-commit {{commit_hash1 optional_commit_hash2 ...}}` + +- Check commits for a GPG signature and show details of each commit: + +`git verify-commit {{commit_hash1 optional_commit_hash2 ...}} --verbose` + +- Check commits for a GPG signature and print the raw details: + +`git verify-commit {{commit_hash1 optional_commit_hash2 ...}} --raw` diff --git a/git-verify-tag b/git-verify-tag new file mode 100644 index 00000000..a68a531a --- /dev/null +++ b/git-verify-tag @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git verify-tag + +> Check for GPG verification of tags. +> If a tag wasn't signed, an error will occur. +> More information: . + +- Check tags for a GPG signature: + +`git verify-tag {{tag1 optional_tag2 ...}}` + +- Check tags for a GPG signature and show details for each tag: + +`git verify-tag {{tag1 optional_tag2 ...}} --verbose` + +- Check tags for a GPG signature and print the raw details: + +`git verify-tag {{tag1 optional_tag2 ...}} --raw` diff --git a/git-whatchanged b/git-whatchanged new file mode 100644 index 00000000..b2d11a43 --- /dev/null +++ b/git-whatchanged @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git whatchanged + +> Show what has changed with recent commits or files. +> See also `git log`. +> More information: . + +- Display logs and changes for recent commits: + +`git whatchanged` + +- Display logs and changes for recent commits within the specified time frame: + +`git whatchanged --since="{{2 hours ago}}"` + +- Display logs and changes for recent commits for specific files or directories: + +`git whatchanged {{path/to/file_or_directory}}` diff --git a/git-worktree b/git-worktree new file mode 100644 index 00000000..7eb2a372 --- /dev/null +++ b/git-worktree @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git worktree + +> Manage multiple working trees attached to the same repository. +> More information: . + +- Create a new directory with the specified branch checked out into it: + +`git worktree add {{path/to/directory}} {{branch}}` + +- Create a new directory with a new branch checked out into it: + +`git worktree add {{path/to/directory}} -b {{new_branch}}` + +- List all the working directories attached to this repository: + +`git worktree list` + +- Remove a worktree (after deleting worktree directory): + +`git worktree prune` diff --git a/git-write-tree b/git-write-tree new file mode 100644 index 00000000..e159dcd2 --- /dev/null +++ b/git-write-tree @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git write-tree + +> Low level utility to create a tree object from the current index. +> More information: . + +- Create a tree object from the current index: + +`git write-tree` + +- Create a tree object without checking whether objects referenced by the directory exist in the object database: + +`git write-tree --missing-ok` + +- Create a tree object that represents a subdirectory (used to write the tree object for a subproject in the named subdirectory): + +`git write-tree --prefix {{subdirectory}}/` diff --git a/github-label-sync b/github-label-sync new file mode 100644 index 00000000..061f99b4 --- /dev/null +++ b/github-label-sync @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# github-label-sync + +> A command-line interface for synchronizing GitHub labels. +> More information: . + +- Synchronize labels using a local `labels.json` file: + +`github-label-sync --access-token {{token}} {{repository_name}}` + +- Synchronize labels using a specific labels JSON file: + +`github-label-sync --access-token {{token}} --labels {{url|path/to/json_file}} {{repository_name}}` + +- Perform a dry run instead of actually synchronizing labels: + +`github-label-sync --access-token {{token}} --dry-run {{repository_name}}` + +- Keep labels that aren't in `labels.json`: + +`github-label-sync --access-token {{token}} --allow-added-labels {{repository_name}}` + +- Synchronize using the `GITHUB_ACCESS_TOKEN` environment variable: + +`github-label-sync {{repository_name}}` diff --git a/gitk b/gitk new file mode 100644 index 00000000..0d270ef1 --- /dev/null +++ b/gitk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitk + +> A graphical Git repository browser. +> More information: . + +- Show the repository browser for the current Git repository: + +`gitk` + +- Show repository browser for a specific file or directory: + +`gitk {{path/to/file_or_directory}}` + +- Show commits made since 1 week ago: + +`gitk --since="{{1 week ago}}"` + +- Show commits older than 1/1/2016: + +`gitk --until="{{1/1/2015}}"` + +- Show at most 100 changes in all branches: + +` gitk --max-count={{100}} --all` diff --git a/gitlab b/gitlab new file mode 100644 index 00000000..4201b0dd --- /dev/null +++ b/gitlab @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitlab + +> Ruby wrapper for the GitLab API. +> Some subcommands such as `gitlab ctl` have their own usage documentation. +> More information: . + +- Create a new project: + +`gitlab create_project {{project_name}}` + +- Get info about a specific commit: + +`gitlab commit {{project_name}} {{commit_hash}}` + +- Get info about jobs in a CI pipeline: + +`gitlab pipeline_jobs {{project_name}} {{pipeline_id}}` + +- Start a specific CI job: + +`gitlab job_play {{project_name}} {{job_id}}` diff --git a/gitlab-ctl b/gitlab-ctl new file mode 100644 index 00000000..1390546b --- /dev/null +++ b/gitlab-ctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitlab-ctl + +> Manage the GitLab omnibus. +> More information: . + +- Display the status of every service: + +`sudo gitlab-ctl status` + +- Display the status of a specific service: + +`sudo gitlab-ctl status {{nginx}}` + +- Restart every service: + +`sudo gitlab-ctl restart` + +- Restart a specific service: + +`sudo gitlab-ctl restart {{nginx}}` + +- Display the logs of every service and keep reading until `Ctrl + C` is pressed: + +`sudo gitlab-ctl tail` + +- Display the logs of a specific service: + +`sudo gitlab-ctl tail {{nginx}}` diff --git a/gitlab-runner b/gitlab-runner new file mode 100644 index 00000000..87c70b97 --- /dev/null +++ b/gitlab-runner @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitlab-runner + +> Manage GitLab runners. +> More information: . + +- Register a runner: + +`sudo gitlab-runner register --url {{https://gitlab.example.com}} --registration-token {{token}} --name {{name}}` + +- Register a runner with a Docker executor: + +`sudo gitlab-runner register --url {{https://gitlab.example.com}} --registration-token {{token}} --name {{name}} --executor {{docker}}` + +- Unregister a runner: + +`sudo gitlab-runner unregister --name {{name}}` + +- Display the status of the runner service: + +`sudo gitlab-runner status` + +- Restart the runner service: + +`sudo gitlab-runner restart` + +- Check if the registered runners can connect to GitLab: + +`sudo gitlab-runner verify` diff --git a/gitlint b/gitlint new file mode 100644 index 00000000..cefcb8e2 --- /dev/null +++ b/gitlint @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitlint + +> Git commit message linter checks your commit messages for style. +> More information: . + +- Check the last commit message: + +`gitlint` + +- The range of commits to lint: + +`gitlint --commits {{single_refspec_argument}}` + +- Path to a directory or Python module with extra user-defined rules: + +`gitlint --extra-path {{path/to/directory}}` + +- Start a specific CI job: + +`gitlint --target {{path/to/target_directory}}` + +- Path to a file containing a commit-msg: + +`gitlint --msg-filename {{path/to/filename}}` + +- Read staged commit meta-info from the local repository: + +`gitlint --staged` diff --git a/gitmoji b/gitmoji new file mode 100644 index 00000000..ea602002 --- /dev/null +++ b/gitmoji @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitmoji + +> Interactively insert emojis on commits. +> More information: . + +- Start the commit wizard: + +`gitmoji --commit` + +- Initialize the Git hook (so `gitmoji` will be run every time `git commit` is run): + +`gitmoji --init` + +- Remove the Git hook: + +`gitmoji --remove` + +- List all available emojis and their descriptions: + +`gitmoji --list` + +- Search emoji list for a list of keywords: + +`gitmoji --search {{keyword1}} {{keyword2}}` + +- Update cached list of emojis from main repository: + +`gitmoji --update` + +- Configure global preferences: + +`gitmoji --config` diff --git a/gitsome b/gitsome new file mode 100644 index 00000000..36b5d18f --- /dev/null +++ b/gitsome @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitsome + +> A terminal-based interface for GitHub, accessed via the `gh` command. +> It also provides menu-style autocomplete suggestions for `git` commands. +> More information: . + +- Enter the gitsome shell (optional), to enable autocompletion and interactive help for Git (and gh) commands: + +`gitsome` + +- Setup GitHub integration with the current account: + +`gh configure` + +- List notifications for the current account (as would be seen in ): + +`gh notifications` + +- List the current account's starred repos, filtered by a given search string: + +`gh starred "{{python 3}}"` + +- View the recent activity feed of a given GitHub repository: + +`gh feed {{tldr-pages/tldr}}` + +- View the recent activity feed for a given GitHub user, using the default pager (e.g. `less`): + +`gh feed {{torvalds}} -p` diff --git a/gitui b/gitui new file mode 100644 index 00000000..67912617 --- /dev/null +++ b/gitui @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitui + +> Terminal UI for Git. +> More information: . + +- Specify the color theme (defaults to `theme.ron`): + +`gitui --theme {{theme}}` + +- Store logging output into a cache directory: + +`gitui --logging` + +- Use notify-based file system watcher instead of tick-based update: + +`gitui --watcher` + +- Generate a bug report: + +`gitui --bugreport` + +- Use a specific Git directory: + +`gitui --directory {{path/to/directory}}` + +- Use a specific working directory: + +`gitui --workdir {{path/to/directory}}` + +- Display help: + +`gitui --help` + +- Display version: + +`gitui --version` diff --git a/gitwatch b/gitwatch new file mode 100644 index 00000000..6891125c --- /dev/null +++ b/gitwatch @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gitwatch + +> Automatically commit file or directory changes to a Git repository. +> More information: . + +- Automatically commit any changes made to a file or directory: + +`gitwatch {{path/to/file_or_directory}}` + +- Automatically commit changes and push them to a remote repository: + +`gitwatch -r {{remote_name}} {{path/to/file_or_directory}}` + +- Automatically commit changes and push them to a specific branch of a remote repository: + +`gitwatch -r {{remote_name}} -b {{branch_name}} {{path/to/file_or_directory}}` diff --git a/gixy b/gixy new file mode 100644 index 00000000..cc7c6ca4 --- /dev/null +++ b/gixy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gixy + +> Analyze nginx configuration files. +> More information: . + +- Analyze nginx configuration (default path: `/etc/nginx/nginx.conf`): + +`gixy` + +- Analyze nginx configuration but skip specific tests: + +`gixy --skips {{http_splitting}}` + +- Analyze nginx configuration with the specific severity level: + +`gixy {{-l|-ll|-lll}}` + +- Analyze nginx configuration files on the specific path: + +`gixy {{path/to/configuration_file_1}} {{path/to/configuration_file_2}}` diff --git a/glab b/glab new file mode 100644 index 00000000..40942623 --- /dev/null +++ b/glab @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab + +> Work seamlessly with GitLab. +> Some subcommands such as `glab config` have their own usage documentation. +> More information: . + +- Clone a GitLab repository locally: + +`glab repo clone {{owner}}/{{repository}}` + +- Create a new issue: + +`glab issue create` + +- View and filter the open issues of the current repository: + +`glab issue list` + +- View an issue in the default browser: + +`glab issue view --web {{issue_number}}` + +- Create a merge request: + +`glab mr create` + +- View a pull request in the default web browser: + +`glab mr view --web {{pr_number}}` + +- Check out a specific pull request locally: + +`glab mr checkout {{pr_number}}` diff --git a/glab-alias b/glab-alias new file mode 100644 index 00000000..44a88f3a --- /dev/null +++ b/glab-alias @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab alias + +> Manage GitLab CLI command aliases. +> More information: . + +- Display the subcommand help: + +`glab alias` + +- List all the aliases `glab` is configured to use: + +`glab alias list` + +- Create a `glab` subcommand alias: + +`glab alias set {{mrv}} '{{mr view}}'` + +- Set a shell command as a `glab` subcommand: + +`glab alias set --shell {{alias_name}} {{command}}` + +- Delete a command shortcut: + +`glab alias delete {{alias_name}}` diff --git a/glab-auth b/glab-auth new file mode 100644 index 00000000..bf833f53 --- /dev/null +++ b/glab-auth @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab auth + +> Authenticate with a GitLab host. +> More information: . + +- Log in with interactive prompt: + +`glab auth login` + +- Log in with a token: + +`glab auth login --token {{token}}` + +- Check authentication status: + +`glab auth status` + +- Log in to a specific GitLab instance: + +`glab auth login --hostname {{gitlab.example.com}}` diff --git a/glab-issue b/glab-issue new file mode 100644 index 00000000..7f898442 --- /dev/null +++ b/glab-issue @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab issue + +> Manage GitLab issues. +> More information: . + +- Display a specific issue: + +`glab issue view {{issue_number}}` + +- Display a specific issue in the default web browser: + +`glab issue view {{issue_number}} --web` + +- Create a new issue in the default web browser: + +`glab issue create --web` + +- List the last 10 issues with the `bug` label: + +`glab issue list --per-page {{10}} --label "{{bug}}"` + +- List closed issues made by a specific user: + +`glab issue list --closed --author {{username}}` + +- Reopen a specific issue: + +`glab issue reopen {{issue_number}}` diff --git a/glab-mr b/glab-mr new file mode 100644 index 00000000..70a77b58 --- /dev/null +++ b/glab-mr @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab mr + +> Manage GitLab merge requests. +> Some subcommands such as `glab mr create` have their own usage documentation. +> More information: . + +- Create a merge request: + +`glab mr create` + +- Check out a specific merge request locally: + +`glab mr checkout {{mr_number}}` + +- View the changes made in the merge request: + +`glab mr diff` + +- Approve the merge request for the current branch: + +`glab mr approve` + +- Merge the merge request associated with the current branch interactively: + +`glab mr merge` + +- Edit a merge request interactively: + +`glab mr update` + +- Edit the target branch of a merge request: + +`glab mr update --target-branch {{branch_name}}` diff --git a/glab-mr-create b/glab-mr-create new file mode 100644 index 00000000..6caf567b --- /dev/null +++ b/glab-mr-create @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab mr create + +> Manage GitLab merge requests. +> More information: . + +- Interactively create a merge request: + +`glab mr create` + +- Create a merge request, determining the title and description from the commit messages of the current branch: + +`glab mr create --fill` + +- Create a draft merge request: + +`glab mr create --draft` + +- Create a merge request specifying the target branch, title, and description: + +`glab mr create --target-branch {{target_branch}} --title "{{title}}" --description "{{description}}"` + +- Start opening a merge request in the default web browser: + +`glab mr create --web` diff --git a/glab-mr-merge b/glab-mr-merge new file mode 100644 index 00000000..dc5c58b2 --- /dev/null +++ b/glab-mr-merge @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab mr merge + +> Merge GitLab merge requests. +> More information: . + +- Merge the merge request associated with the current branch interactively: + +`glab mr merge` + +- Merge the specified merge request, interactively: + +`glab mr merge {{mr_number}}` + +- Merge the merge request, removing the branch on both the local and the remote: + +`glab mr merge --remove-source-branch` + +- Squash the current merge request into one commit with the message body and merge: + +`glab mr merge --squash --message="{{commit_message_body}}"` + +- Display help: + +`glab mr merge --help` diff --git a/glab-pipeline b/glab-pipeline new file mode 100644 index 00000000..a0a9d1ec --- /dev/null +++ b/glab-pipeline @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab pipeline + +> List, view, and run GitLab CI/CD pipelines. +> More information: . + +- View a running pipeline on the current branch: + +`glab pipeline status` + +- View a running pipeline on a specific branch: + +`glab pipeline status --branch {{branch_name}}` + +- Get the list of pipelines: + +`glab pipeline list` + +- Run a manual pipeline on the current branch: + +`glab pipeline run` + +- Run a manual pipeline on a specific branch: + +`glab pipeline run --branch {{branch_name}}` diff --git a/glab-release b/glab-release new file mode 100644 index 00000000..ed77c598 --- /dev/null +++ b/glab-release @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab release + +> Manage GitLab releases. +> More information: . + +- List releases in a Gitlab repository, limited to 30 items: + +`glab release list` + +- Display information about a specific release: + +`glab release view {{tag}}` + +- Create a new release: + +`glab release create {{tag}}` + +- Delete a specific release: + +`glab release delete {{tag}}` + +- Download assets from a specific release: + +`glab release download {{tag}}` + +- Upload assets to a specific release: + +`glab release upload {{tag}} {{path/to/file1 path/to/file2 ...}}` diff --git a/glab-repo b/glab-repo new file mode 100644 index 00000000..66a36299 --- /dev/null +++ b/glab-repo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glab repo + +> Work with GitLab repositories. +> More information: . + +- Create a new repository (if the repository name is not set, the default name will be the name of the current directory): + +`glab repo create {{name}}` + +- Clone a repository: + +`glab repo clone {{owner}}/{{repository}}` + +- Fork and clone a repository: + +`glab repo fork {{owner}}/{{repository}} --clone` + +- View a repository in the default web browser: + +`glab repo view {{owner}}/{{repository}} --web` + +- Search some repositories in the GitLab instance: + +`glab repo search -s {{search_string}}` diff --git a/gladtex b/gladtex new file mode 100644 index 00000000..2426e855 --- /dev/null +++ b/gladtex @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gladtex + +> A LaTeX formula preprocessor for HTML files. +> It converts LaTeX formulas to images. +> More information: . + +- Convert to HTML: + +`gladtex {{path/to/input.htex}}` + +- Save the converted file to a specific location: + +`gladtex {{path/to/input.htex}} -o {{path/to/output.html}}` + +- Save the generated images to a specific [d]irectory: + +`gladtex {{path/to/input.htex}} -d {{path/to/image_output_directory}}` + +- Set image [r]esolution (in dpi, default is 100): + +`gladtex {{path/to/input.htex}} -r {{resolution}}` + +- [k]eep LaTeX files after conversion: + +`gladtex {{path/to/input.htex}} -k` + +- Set [b]ackground and [f]oreground color of the images: + +`gladtex {{path/to/input.htex}} -b {{background_color}} -f {{foreground_color}}` + +- Convert Markdown to HTML using `pandoc` and `gladtex`: + +`pandoc -s -t html --gladtex {{path/to/input.md}} | gladtex -o {{path/to/output.html}}` diff --git a/glances b/glances new file mode 100644 index 00000000..ab1c6849 --- /dev/null +++ b/glances @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glances + +> A cross-platform system monitoring tool. +> More information: . + +- Run in terminal: + +`glances` + +- Run in web server mode to show results in browser: + +`glances -w` + +- Run in server mode to allow connections from other Glances clients: + +`glances -s` + +- Connect to a Glances server: + +`glances -c {{hostname}}` + +- Require a password in (web) server mode: + +`glances -s --password` diff --git a/glib-compile-resources b/glib-compile-resources new file mode 100644 index 00000000..54749b68 --- /dev/null +++ b/glib-compile-resources @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glib-compile-resources + +> Compiles resource files (e.g. images) into a binary resource bundle. +> These may be linked into GTK applications using the GResource API. +> More information: . + +- Compile resources referenced in `file.gresource.xml` to a .gresource binary: + +`glib-compile-resources {{file.gresource.xml}}` + +- Compile resources referenced in `file.gresource.xml` to a C source file: + +`glib-compile-resources --generate-source {{file.gresource.xml}}` + +- Compile resources in `file.gresource.xml` to a chosen target file, with `.c`, `.h` or `.gresource` extension: + +`glib-compile-resources --generate --target={{file.ext}} {{file.gresource.xml}}` + +- Print a list of resource files referenced in `file.gresource.xml`: + +`glib-compile-resources --generate-dependencies {{file.gresource.xml}}` diff --git a/glow b/glow new file mode 100644 index 00000000..3dd740a4 --- /dev/null +++ b/glow @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# glow + +> Render Markdown in the terminal. +> More information: . + +- Run glow and select a file to view: + +`glow` + +- Render a Markdown file to the terminal: + +`glow {{path/to/file}}` + +- View a Markdown file using a paginator: + +`glow -p {{path/to/file}}` + +- View a file from a URL: + +`glow {{https://example.com/file.md}}` + +- View a GitHub/GitLab README: + +`glow {{github.com/owner/repository}}` diff --git a/gml2gv b/gml2gv new file mode 100644 index 00000000..0bbd5b7f --- /dev/null +++ b/gml2gv @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gml2gv + +> Convert a graph from `gml` to `gv` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `gml` to `gv` format: + +`gml2gv -o {{output.gv}} {{input.gml}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.gml}} | gml2gv > {{output.gv}}` + +- Display help: + +`gml2gv -?` diff --git a/gmssl b/gmssl new file mode 100644 index 00000000..8a8ee19b --- /dev/null +++ b/gmssl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gmssl + +> GmSSL is a crypto toolkit supporting SM1, SM2, SM3, SM4, SM9, and ZUC/ZUC256. +> More information: . + +- Generate an SM3 hash for a file: + +`gmssl sm3 {{path/to/file}}` + +- Encrypt a file using the SM4 cipher: + +`gmssl sms4 -e -in {{path/to/file}} -out {{path/to/file.sms4}}` + +- Decrypt a file using the SM4 cipher: + +`gmssl sms4 -d -in {{path/to/file.sms4}}` + +- Generate an SM2 private key: + +`gmssl sm2 -genkey -out {{path/to/file.pem}}` + +- Generate an SM2 public key from an existing private key: + +`gmssl sm2 -pubout -in {{path/to/file.pem}} -out {{path/to/file.pem.pub}}` + +- Encrypt a file using the ZUC cipher: + +`gmssl zuc -e -in {{path/to/file}} -out {{path/to/file.zuc}}` + +- Decrypt a file using the ZUC cipher: + +`gmssl zuc -d -in {{path/to/file.zuc}}` + +- Display version: + +`gmssl version` diff --git a/gnatmake b/gnatmake new file mode 100644 index 00000000..058de948 --- /dev/null +++ b/gnatmake @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnatmake + +> A low-level build tool for Ada programs (part of the GNAT toolchain). +> More information: . + +- Compile an executable: + +`gnatmake {{source_file1.adb source_file2.adb ...}}` + +- Set a custom executable name: + +`gnatmake -o {{executable_name}} {{source_file.adb}}` + +- [f]orce recompilation: + +`gnatmake -f {{source_file.adb}}` diff --git a/gnatprep b/gnatprep new file mode 100644 index 00000000..030aad13 --- /dev/null +++ b/gnatprep @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnatprep + +> Preprocessor for Ada source code files (part of the GNAT toolchain). +> More information: . + +- Use symbol definitions from a file: + +`gnatprep {{source_file}} {{target_file}} {{definitions_file}}` + +- Specify symbol values in the command-line: + +`gnatprep -D{{name}}={{value}} {{source_file}} {{target_file}}` diff --git a/gnmic b/gnmic new file mode 100644 index 00000000..162418c2 --- /dev/null +++ b/gnmic @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnmic + +> A gNMI command-line client. +> Manage gNMI network device configuration and view operational data. +> More information: . + +- Request device capabilities: + +`gnmic --address {{ip:port}} capabilities` + +- Provide a username and password to fetch device capabilities: + +`gnmic --address {{ip:port}} --username {{username}} --password {{password}} capabilities` + +- Get a snapshot of the device state at a specific path: + +`gnmic -a {{ip:port}} get --path {{path}}` + +- Update device state at a specific path: + +`gnmic -a {{ip:port}} set --update-path {{path}} --update-value {{value}}` + +- Subscribe to target state updates under the subtree at a specific path: + +`gnmic -a {{ip:port}} subscribe --path {{path}}` diff --git a/gnmic-get b/gnmic-get new file mode 100644 index 00000000..415d5dab --- /dev/null +++ b/gnmic-get @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnmic get + +> Get a snapshot of a gnmi network device operation data. +> More information: . + +- Get a snapshot of the device state at a specific path: + +`gnmic --address {{ip:port}} get --path {{path}}` + +- Query the device state at multiple paths: + +`gnmic -a {{ip:port}} get --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` + +- Query the device state at multiple paths with a common prefix: + +`gnmic -a {{ip:port}} get --prefix {{prefix}} --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` + +- Query the device state and specify response encoding (json_ietf): + +`gnmic -a {{ip:port}} get --path {{path}} --encoding json_ietf` diff --git a/gnmic-set b/gnmic-set new file mode 100644 index 00000000..20170ad2 --- /dev/null +++ b/gnmic-set @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnmic set + +> Modify gnmi network device configuration. +> More information: . + +- Update the value of a path: + +`gnmic --address {{ip:port}} set --update-path {{path}} --update-value {{value}}` + +- Update the value of a path to match the contents of a JSON file: + +`gnmic -a {{ip:port}} set --update-path {{path}} --update-file {{filepath}}` + +- Replace the value of a path to match the contents of a JSON file: + +`gnmic -a {{ip:port}} set --replace-path {{path}} --replace-file {{filepath}}` + +- Delete the node at a given path: + +`gnmic -a {{ip:port}} set --delete {{path}}` diff --git a/gnmic-sub b/gnmic-sub new file mode 100644 index 00000000..251b7796 --- /dev/null +++ b/gnmic-sub @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnmic sub + +> This command is an alias of `gnmic subscribe`. +> More information: . + +- View documentation for the original command: + +`tldr gnmic subscribe` diff --git a/gnmic-subscribe b/gnmic-subscribe new file mode 100644 index 00000000..7b92c575 --- /dev/null +++ b/gnmic-subscribe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnmic subscribe + +> Subscribe to a gnmic network device state updates. +> More information: . + +- Subscribe to target state updates under the subtree of a specific path: + +`gnmic --address {{ip:port}} subscribe --path {{path}}` + +- Subscribe to a target with a sample interval of 30s (default is 10s): + +`gnmic -a {{ip:port}} subscribe --path {{path}} --sample-interval 30s` + +- Subscribe to a target with sample interval and updates only on change: + +`gnmic -a {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval 1m` + +- Subscribe to a target for only one update: + +`gnmic -a {{ip:port}} subscribe --path {{path}} --mode once` + +- Subscribe to a target and specify response encoding (json_ietf): + +`gnmic -a {{ip:port}} subscribe --path {{path}} --encoding json_ietf` diff --git a/gnomon b/gnomon new file mode 100644 index 00000000..8947e2e9 --- /dev/null +++ b/gnomon @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnomon + +> Utility to annotate console logging statements with timestamps and find slow processes. +> More information: . + +- Use UNIX (or DOS) pipes to pipe `stdout` of any command through gnomon: + +`{{npm test}} | gnomon` + +- Show number of seconds since the start of the process: + +`{{npm test}} | gnomon --type=elapsed-total` + +- Show an absolute timestamp in UTC: + +`{{npm test}} | gnomon --type=absolute` + +- Use a high threshold of 0.5 seconds, exceeding which the timestamp will be colored bright red: + +`{{npm test}} | gnomon --high 0.5` + +- Use a medium threshold of 0.2 seconds, exceeding which the timestamp will be colored bright yellow: + +`{{npm test}} | gnomon --medium {{0.2}}` diff --git a/gnucash b/gnucash new file mode 100644 index 00000000..62cf0091 --- /dev/null +++ b/gnucash @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnucash + +> Personal and small-business financial-accounting software. +> More information: . + +- Launch GnuCash and load the previously opened file: + +`gnucash` + +- Launch GnuCash and load the specified file: + +`gnucash {{path/to/file.gnucash}}` + +- Launch GnuCash and load an empty file: + +`gnucash --nofile` diff --git a/gnucash-cli b/gnucash-cli new file mode 100644 index 00000000..26927123 --- /dev/null +++ b/gnucash-cli @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnucash-cli + +> A command-line version of GnuCash. +> More information: . + +- Get quotes for currencies and stocks specified in a file and print them: + +`gnucash-cli --quotes get {{path/to/file.gnucash}}` + +- Generate a financial report of a specific type, specified by `--name`: + +`gnucash-cli --report run --name "{{Balance Sheet}}" {{path/to/file.gnucash}}` diff --git a/gnuplot b/gnuplot new file mode 100644 index 00000000..50d8d0aa --- /dev/null +++ b/gnuplot @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gnuplot + +> A graph plotter that outputs in several formats. +> More information: . + +- Start the interactive graph plotting shell: + +`gnuplot` + +- Plot the graph for the specified graph definition file: + +`gnuplot {{path/to/definition.plt}}` + +- Set the output format by executing a command before loading the definition file: + +`gnuplot -e "{{set output "path/to/filename.png" size 1024,768}}" {{path/to/definition.plt}}` + +- Persist the graph plot preview window after gnuplot exits: + +`gnuplot --persist {{path/to/definition.plt}}` diff --git a/go b/go new file mode 100644 index 00000000..30344d01 --- /dev/null +++ b/go @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go + +> Manage Go source code. +> Some subcommands such as `go build` have their own usage documentation. +> More information: . + +- Download and install a package, specified by its import path: + +`go get {{package_path}}` + +- Compile and run a source file (it has to contain a `main` package): + +`go run {{file}}.go` + +- Compile a source file into a named executable: + +`go build -o {{executable}} {{file}}.go` + +- Compile the package present in the current directory: + +`go build` + +- Execute all test cases of the current package (files have to end with `_test.go`): + +`go test` + +- Compile and install the current package: + +`go install` + +- Initialize a new module in the current directory: + +`go mod init {{module_name}}` diff --git a/go-bug b/go-bug new file mode 100644 index 00000000..45d544bb --- /dev/null +++ b/go-bug @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go bug + +> Report a bug. +> More information: . + +- Open a web page to start a bug report: + +`go bug` diff --git a/go-build b/go-build new file mode 100644 index 00000000..f969ad98 --- /dev/null +++ b/go-build @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go build + +> Compile Go sources. +> More information: . + +- Compile a 'package main' file (output will be the filename without extension): + +`go build {{path/to/main.go}}` + +- Compile, specifying the output filename: + +`go build -o {{path/to/binary}} {{path/to/source.go}}` + +- Compile a package: + +`go build -o {{path/to/binary}} {{path/to/package}}` + +- Compile a main package into an executable, enabling data race detection: + +`go build -race -o {{path/to/executable}} {{path/to/main/package}}` diff --git a/go-clean b/go-clean new file mode 100644 index 00000000..f71fcdb4 --- /dev/null +++ b/go-clean @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go clean + +> Remove object files and cached files. +> More information: . + +- Print the remove commands instead of actually removing anything: + +`go clean -n` + +- Delete the build cache: + +`go clean -cache` + +- Delete all cached test results: + +`go clean -testcache` + +- Delete the module cache: + +`go clean -modcache` diff --git a/go-doc b/go-doc new file mode 100644 index 00000000..715598ff --- /dev/null +++ b/go-doc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go doc + +> View documentation for a package or symbol. +> More information: . + +- View documentation for the current package: + +`go doc` + +- Show package documentation and exported symbols: + +`go doc {{encoding/json}}` + +- Show also documentation of symbols: + +`go doc -all {{encoding/json}}` + +- Show also sources: + +`go doc -all -src {{encoding/json}}` + +- Show a specific symbol: + +`go doc -all -src {{encoding/json.Number}}` diff --git a/go-env b/go-env new file mode 100644 index 00000000..8bb5cff2 --- /dev/null +++ b/go-env @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go env + +> Manage environment variables used by the Go toolchain. +> More information: . + +- Show all environment variables: + +`go env` + +- Show a specific environment variable: + +`go env {{GOPATH}}` + +- Set an environment variable to a value: + +`go env -w {{GOBIN}}={{path/to/directory}}` + +- Reset an environment variable's value: + +`go env -u {{GOBIN}}` diff --git a/go-fix b/go-fix new file mode 100644 index 00000000..7b0bdef1 --- /dev/null +++ b/go-fix @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go fix + +> Update packages to use new APIs. +> More information: . + +- Update packages to use new APIs: + +`go fix {{packages}}` diff --git a/go-fmt b/go-fmt new file mode 100644 index 00000000..374e1474 --- /dev/null +++ b/go-fmt @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go fmt + +> Format Go source files. +> Prints the filenames that are changed. +> More information: . + +- Format Go source files in the current directory: + +`go fmt` + +- Format a specific Go package in your import path (`$GOPATH/src`): + +`go fmt {{path/to/package}}` + +- Format the package in the current directory and all subdirectories (note the `...`): + +`go fmt {{./...}}` + +- Print what format commands would've been run, without modifying anything: + +`go fmt -n` + +- Print which format commands are run as they are run: + +`go fmt -x` diff --git a/go-generate b/go-generate new file mode 100644 index 00000000..5580e4aa --- /dev/null +++ b/go-generate @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go generate + +> Generate Go files by running commands within source files. +> More information: . + +- Generate Go files by running commands within source files: + +`go generate` diff --git a/go-get b/go-get new file mode 100644 index 00000000..e92e9088 --- /dev/null +++ b/go-get @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go get + +> Add a dependency package, or download packages in legacy GOPATH mode. +> More information: . + +- Add a specified package to `go.mod` in module-mode or install the package in GOPATH-mode: + +`go get {{example.com/pkg}}` + +- Modify the package with a given version in module-aware mode: + +`go get {{example.com/pkg}}@{{v1.2.3}}` + +- Remove a specified package: + +`go get {{example.com/pkg}}@{{none}}` diff --git a/go-install b/go-install new file mode 100644 index 00000000..a3cc2766 --- /dev/null +++ b/go-install @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go install + +> Compile and install packages named by the import paths. +> More information: . + +- Compile and install the current package: + +`go install` + +- Compile and install a specific local package: + +`go install {{path/to/package}}` + +- Install the latest version of a program, ignoring `go.mod` in the current directory: + +`go install {{golang.org/x/tools/gopls}}@{{latest}}` + +- Install a program at the version selected by `go.mod` in the current directory: + +`go install {{golang.org/x/tools/gopls}}` diff --git a/go-list b/go-list new file mode 100644 index 00000000..7d5878fe --- /dev/null +++ b/go-list @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go list + +> List packages or modules. +> More information: . + +- List packages: + +`go list ./...` + +- List standard packages: + +`go list std` + +- List packages in JSON format: + +`go list -json time net/http` + +- List module dependencies and available updates: + +`go list -m -u all` diff --git a/go-mod b/go-mod new file mode 100644 index 00000000..7f478d01 --- /dev/null +++ b/go-mod @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go mod + +> Module maintenance. +> More information: . + +- Initialize new module in current directory: + +`go mod init {{moduleName}}` + +- Download modules to local cache: + +`go mod download` + +- Add missing and remove unused modules: + +`go mod tidy` + +- Verify dependencies have expected content: + +`go mod verify` + +- Copy sources of all dependencies into the vendor directory: + +`go mod vendor` diff --git a/go-run b/go-run new file mode 100644 index 00000000..700bc0ec --- /dev/null +++ b/go-run @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go run + +> Compile and run Go code without saving a binary. +> More information: . + +- Run a Go file: + +`go run {{path/to/file.go}}` + +- Run a main Go package: + +`go run {{path/to/package}}` diff --git a/go-test b/go-test new file mode 100644 index 00000000..a9a82d6b --- /dev/null +++ b/go-test @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go test + +> Tests Go packages (files have to end with `_test.go`). +> More information: . + +- Test the package found in the current directory: + +`go test` + +- [v]erbosely test the package in the current directory: + +`go test -v` + +- Test the packages in the current directory and all subdirectories (note the `...`): + +`go test -v ./...` + +- Test the package in the current directory and run all benchmarks: + +`go test -v -bench .` + +- Test the package in the current directory and run all benchmarks for 50 seconds: + +`go test -v -bench . -benchtime {{50s}}` + +- Test the package with coverage analysis: + +`go test -cover` diff --git a/go-tool b/go-tool new file mode 100644 index 00000000..f28293e8 --- /dev/null +++ b/go-tool @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go tool + +> Run a Go tool or command. +> Execute a Go command as a stand-alone binary, typically for debugging. +> More information: . + +- List available tools: + +`go tool` + +- Run the go link tool: + +`go tool link {{path/to/main.o}}` + +- Print the command that would be executed, but do not execute it (similar to `whereis`): + +`go tool -n {{command}} {{arguments}}` + +- View documentation for a specified tool: + +`go tool {{command}} --help` diff --git a/go-version b/go-version new file mode 100644 index 00000000..90745c83 --- /dev/null +++ b/go-version @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go version + +> Display Go version. +> More information: . + +- Display version: + +`go version` + +- Display the Go version used to build a specific executable file: + +`go version {{path/to/executable}}` diff --git a/go-vet b/go-vet new file mode 100644 index 00000000..ef9195dc --- /dev/null +++ b/go-vet @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# go vet + +> Check Go source code and report suspicious constructs (e.g. lint your Go source files). +> Go vet returns a non-zero exit code if problems are found; returns a zero exit code if no problems are found. +> More information: . + +- Check the Go package in the current directory: + +`go vet` + +- Check the Go package in the specified path: + +`go vet {{path/to/file_or_directory}}` + +- List available checks that can be run with go vet: + +`go tool vet help` + +- View details and flags for a particular check: + +`go tool vet help {{check_name}}` + +- Display offending lines plus N lines of surrounding context: + +`go vet -c={{N}}` + +- Output analysis and errors in JSON format: + +`go vet -json` diff --git a/gobuster b/gobuster new file mode 100644 index 00000000..d5d25483 --- /dev/null +++ b/gobuster @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gobuster + +> Brute-forces hidden paths on web servers and more. +> More information: . + +- Discover directories and files that match in the wordlist: + +`gobuster dir --url {{https://example.com/}} --wordlist {{path/to/file}}` + +- Discover subdomains: + +`gobuster dns --domain {{example.com}} --wordlist {{path/to/file}}` + +- Discover Amazon S3 buckets: + +`gobuster s3 --wordlist {{path/to/file}}` + +- Discover other virtual hosts on the server: + +`gobuster vhost --url {{https://example.com/}} --wordlist {{path/to/file}}` + +- Fuzz the value of a parameter: + +`gobuster fuzz --url {{https://example.com/?parameter=FUZZ}} --wordlist {{path/to/file}}` + +- Fuzz the name of a parameter: + +`gobuster fuzz --url {{https://example.com/?FUZZ=value}} --wordlist {{path/to/file}}` diff --git a/gocr b/gocr new file mode 100644 index 00000000..3b3f125e --- /dev/null +++ b/gocr @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gocr + +> Optical Character Recognition tool. +> Recognize characters using its engine, and prompt the user for unknown patterns to store them in a database. +> More information: . + +- Recognize characters in the [i]nput image and [o]utput it in the given file. Put the database ([p]) in `path/to/db_directory` (verify that the folder exists or DB usage will silently be skipped). [m]ode 130 means create + use + extend database: + +`gocr -m 130 -p {{path/to/db_directory}} -i {{path/to/input_image.png}} -o {{path/to/output_file.txt}}` + +- Recognize characters and assume all [C]haracters are numbers: + +`gocr -m 130 -p {{path/to/db_directory}} -i {{path/to/input_image.png}} -o {{path/to/output_file.txt}} -C "{{0..9}}"` + +- Recognize characters with a cert[a]inty of 100% (characters have a higher chance to be treated as unknown): + +`gocr -m 130 -p {{path/to/db_directory}} -i {{path/to/input_image.png}} -o {{path/to/output_file.txt}} -a 100` diff --git a/gocryptfs b/gocryptfs new file mode 100644 index 00000000..6d40a447 --- /dev/null +++ b/gocryptfs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gocryptfs + +> Encrypted overlay filesystem written in Go. +> More information: . + +- Initialize an encrypted filesystem: + +`gocryptfs -init {{path/to/cipher_dir}}` + +- Mount an encrypted filesystem: + +`gocryptfs {{path/to/cipher_dir}} {{path/to/mount_point}}` + +- Mount with the explicit master key instead of password: + +`gocryptfs --masterkey {{path/to/cipher_dir}} {{path/to/mount_point}}` + +- Change the password: + +`gocryptfs --passwd {{path/to/cipher_dir}}` + +- Make an encrypted snapshot of a plain directory: + +`gocryptfs --reverse {{path/to/plain_dir}} {{path/to/cipher_dir}}` diff --git a/godoc b/godoc new file mode 100644 index 00000000..5cb93d8e --- /dev/null +++ b/godoc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# godoc + +> View documentation for go packages. +> More information: . + +- Display help for a specific package: + +`godoc {{fmt}}` + +- Display help for the function "Printf" of "fmt" package: + +`godoc {{fmt}} {{Printf}}` + +- Serve documentation as a web server on port 6060: + +`godoc -http=:{{6060}}` + +- Create an index file: + +`godoc -write_index -index_files={{path/to/file}}` + +- Use the given index file to search the docs: + +`godoc -http=:{{6060}} -index -index_files={{path/to/file}}` diff --git a/godot b/godot new file mode 100644 index 00000000..60828251 --- /dev/null +++ b/godot @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# godot + +> An open source 2D and 3D game engine. +> More information: . + +- Run a project if the current directory contains a `project.godot` file, otherwise open the project manager: + +`godot` + +- Edit a project (the current directory must contain a `project.godot` file): + +`godot -e` + +- Open the project manager even if the current directory contains a `project.godot` file: + +`godot -p` + +- Export a project for a given export preset (the preset must be defined in the project): + +`godot --export {{preset}} {{output_path}}` + +- Execute a standalone GDScript file (the script must inherit from `SceneTree` or `MainLoop`): + +`godot -s {{script.gd}}` diff --git a/gofmt b/gofmt new file mode 100644 index 00000000..be636358 --- /dev/null +++ b/gofmt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gofmt + +> Format Go source code. +> More information: . + +- Format a file and display the result to the console: + +`gofmt {{source.go}}` + +- Format a file, overwriting the original file in-place: + +`gofmt -w {{source.go}}` + +- Format a file, and then simplify the code, overwriting the original file: + +`gofmt -s -w {{source.go}}` + +- Print all (including spurious) errors: + +`gofmt -e {{source.go}}` diff --git a/goimports b/goimports new file mode 100644 index 00000000..9c8cb6f9 --- /dev/null +++ b/goimports @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# goimports + +> Updates Go import lines, adding missing ones and removing unreferenced ones. +> More information: . + +- Display the completed import source file: + +`goimports {{path/to/file.go}}` + +- Write the result back to the source file instead of `stdout`: + +`goimports -w {{path/to/file.go}}` + +- Display diffs and write the result back to the source file: + +`goimports -w -d {{path/to/file.go}}` + +- Set the import prefix string after 3rd-party packages (comma-separated list): + +`goimports -local {{path/to/package1,path/to/package2,...}} {{path/to/file.go}}` diff --git a/golangci-lint b/golangci-lint new file mode 100644 index 00000000..2d51eaa4 --- /dev/null +++ b/golangci-lint @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# golangci-lint + +> Parallelized, smart and fast Go linters runner that integrates with all major IDEs and supports YAML configuration. +> More information: . + +- Run linters in the current folder: + +`golangci-lint run` + +- List enabled and disabled linters (Note: disabled linters are shown last, do not mistake them for enabled ones): + +`golangci-lint linters` + +- [E]nable a specific linter for this run: + +`golangci-lint run --enable {{linter}}` diff --git a/google-chrome b/google-chrome new file mode 100644 index 00000000..2858687c --- /dev/null +++ b/google-chrome @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# google-chrome + +> This command is an alias of `chromium`. +> More information: . + +- View documentation for the original command: + +`tldr chromium` diff --git a/googler b/googler new file mode 100644 index 00000000..57b2f6c1 --- /dev/null +++ b/googler @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# googler + +> Search Google from command-line. +> More information: . + +- Search Google for a keyword: + +`googler {{keyword}}` + +- Search Google and open the first result in web browser: + +`googler -j {{keyword}}` + +- Show N search results (default 10): + +`googler -n {{N}} {{keyword}}` + +- Disable automatic spelling correction: + +`googler -x {{keyword}}` + +- Search one site for a keyword: + +`googler -w {{site}} {{keyword}}` + +- Show Google search result in JSON format: + +`googler --json {{keyword}}` + +- Perform in-place self-upgrade: + +`googler -u` + +- Display help in interactive mode: + +`?` diff --git a/gopass b/gopass new file mode 100644 index 00000000..e490101f --- /dev/null +++ b/gopass @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gopass + +> Standard Unix Password Manager for Teams. Written in Go. +> More information: . + +- Initialize the configuration settings: + +`gopass init` + +- Create a new entry: + +`gopass new` + +- Show all stores: + +`gopass mounts` + +- Mount a shared Git store: + +`gopass mounts add {{store_name}} {{git_repo_url}}` + +- Search interactively using a keyword: + +`gopass show {{keyword}}` + +- Search using a keyword: + +`gopass find {{keyword}}` + +- Sync all mounted stores: + +`gopass sync` + +- Show a particular password entry: + +`gopass {{store_name|path/to/directory|email@email.com}}` diff --git a/gops b/gops new file mode 100644 index 00000000..358a9c9c --- /dev/null +++ b/gops @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gops + +> List and diagnose Go processes currently running on your system. +> More information: . + +- Print all go processes running locally: + +`gops` + +- Print more information about a process: + +`gops {{pid}}` + +- Display a process tree: + +`gops tree` + +- Print the current stack trace from a target program: + +`gops stack {{pid|addr}}` + +- Print the current runtime memory statistics: + +`gops memstats {{pid|addr}}` diff --git a/goreload b/goreload new file mode 100644 index 00000000..8508e398 --- /dev/null +++ b/goreload @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# goreload + +> Live reload utility for Go programs. +> More information: . + +- Watch a binary file (defaults to `.goreload`): + +`goreload -b {{path/to/binary}} {{path/to/file.go}}` + +- Set a custom log prefix (defaults to `goreload`): + +`goreload --logPrefix {{prefix}} {{path/to/file.go}}` + +- Reload whenever any file changes: + +`goreload --all` diff --git a/gotelemetry b/gotelemetry new file mode 100644 index 00000000..a791842f --- /dev/null +++ b/gotelemetry @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gotelemetry + +> Manage Go telemetry data and settings. +> More information: . + +- Enable telemetry uploading: + +`gotelemetry on` + +- Disable telemetry uploading: + +`gotelemetry off` + +- Run a Web Viewer for local telemetry data: + +`gotelemetry view` + +- Print the current telemetry environment: + +`gotelemetry env` + +- Display help for a specific subcommand: + +`gotelemetry help {{subcommand}}` diff --git a/gotty b/gotty new file mode 100644 index 00000000..359da9e7 --- /dev/null +++ b/gotty @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gotty + +> Share your terminal as a web application. +> More information: . + +- Share result of command: + +`gotty {{command}}` + +- Share with write permission: + +`gotty -w {{shell}}` + +- Share with credential (Basic Auth): + +`gotty -w -c {{username}}:{{password}} {{shell}}` diff --git a/gouldtoppm b/gouldtoppm new file mode 100644 index 00000000..cbbb9512 --- /dev/null +++ b/gouldtoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gouldtoppm + +> Convert a Gould scanner file to a PPM image. +> More information: . + +- Convert a Gould scanner file to a PPM image: + +`gouldtoppm {{path/to/file.gould}} > {{path/to/output.ppm}}` diff --git a/gource b/gource new file mode 100644 index 00000000..9dec8ba4 --- /dev/null +++ b/gource @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gource + +> Renders an animated tree diagram of Git, SVN, Mercurial and Bazaar repositories. +> It shows files and directories being created, modified or removed over time. +> More information: . + +- Run gource in a directory (if it isn't the repository's root directory, the root is sought up from there): + +`gource {{path/to/repository}}` + +- Run gource in the current directory, with a custom output resolution: + +`gource -{{width}}x{{height}}` + +- Specify the timescale for the animation: + +`gource -c {{time_scale_multiplier}}` + +- Specify how long each day should be in the animation (this combines with -c, if provided): + +`gource -s {{seconds}}` + +- Use fullscreen mode and a custom background color: + +`gource -f -b {{hex_color_code}}` + +- Specify the animation title: + +`gource --title {{title}}` diff --git a/gow b/gow new file mode 100644 index 00000000..0f751f8f --- /dev/null +++ b/gow @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gow + +> Watches Go files and restarts the app on changes. +> More information: . + +- Start and watch the current directory: + +`gow run .` + +- Start the application with the specified arguments: + +`gow run . {{argument1 argument2 ...}}` + +- Watch subdirectories in verbose mode: + +`gow -v -w={{path/to/directory1,path/to/directory2,...}} run .` + +- Watch the specified file extensions: + +`gow -e={{go,html}} run .` + +- Display help: + +`gow -h` diff --git a/gox b/gox new file mode 100644 index 00000000..c55c54a5 --- /dev/null +++ b/gox @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gox + +> Cross-compile Go programs. +> More information: . + +- Compile Go program in the current directory for all operating systems and architecture combinations: + +`gox` + +- Download and compile a Go program from a remote URL: + +`gox {{url_1}} {{url_2}}` + +- Compile current directory for a particular operating system: + +`gox -os="{{os}}"` + +- Compile current directory for a single operating system and architecture combination: + +`gox -osarch="{{os}}/{{arch}}"` diff --git a/gpg b/gpg new file mode 100644 index 00000000..36b0d325 --- /dev/null +++ b/gpg @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpg + +> GNU Privacy Guard. +> See `gpg2` for GNU Privacy Guard 2. Most operating systems symlink `gpg` to `gpg2`. +> More information: . + +- Create a GPG public and private key interactively: + +`gpg --full-generate-key` + +- Sign `doc.txt` without encryption (writes output to `doc.txt.asc`): + +`gpg --clearsign {{doc.txt}}` + +- Encrypt and sign `doc.txt` for alice@example.com and bob@example.com (output to `doc.txt.gpg`): + +`gpg --encrypt --sign --recipient {{alice@example.com}} --recipient {{bob@example.com}} {{doc.txt}}` + +- Encrypt `doc.txt` with only a passphrase (output to `doc.txt.gpg`): + +`gpg --symmetric {{doc.txt}}` + +- Decrypt `doc.txt.gpg` (output to `stdout`): + +`gpg --decrypt {{doc.txt.gpg}}` + +- Import a public key: + +`gpg --import {{public.gpg}}` + +- Export public key for alice@example.com (output to `stdout`): + +`gpg --export --armor {{alice@example.com}}` + +- Export private key for alice@example.com (output to `stdout`): + +`gpg --export-secret-keys --armor {{alice@example.com}}` diff --git a/gpg-card b/gpg-card new file mode 100644 index 00000000..ca3ac621 --- /dev/null +++ b/gpg-card @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpg-card + +> Administrate OpenPGP and PIV smart cards. +> Similar to `gpg --card-edit`. +> More information: . + +- Start in interactive mode: + +`gpg-card` + +- Invoke one or more commands non-interactively: + +`gpg-card {{command1}} -- {{command2}} -- {{command3}}` + +- Show information about a smart card: + +`gpg-card list` + +- Retrieve the public key using the URL stored on an OpenPGP card: + +`gpg-card fetch` + +- Set the URL used by the `fetch` command: + +`gpg-card url` + +- Change or unblock PINs (uses the default action for the card in non-interactive mode): + +`gpg-card passwd` + +- Toggle the forcesig flag of an OpenPGP card (i.e. require entering the user PIN for signing): + +`gpg-card forcesig` + +- Factory reset a smart card (i.e. delete all data and reset PINs): + +`gpg-card factory-reset` diff --git a/gpg-tui b/gpg-tui new file mode 100644 index 00000000..d2a40412 --- /dev/null +++ b/gpg-tui @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpg-tui + +> Terminal user interface for GNU Public Guard. +> More information: . + +- Start `gpg-tui`: + +`gpg-tui` + +- Start `gpg-tui` with color and ASCII armored output: + +`gpg-tui --style {{colored}} --armor` + +- Quit `gpg-tui`: + +`q` + +- Interactively generate a new key: + +`g` + +- Export the selected key: + +`x` + +- Set the detail level for the selected key: + +`1|2|3` + +- Refresh `gpg-tui`: + +`r` + +- Display help in `gpg-tui`: + +`?` diff --git a/gpg-zip b/gpg-zip new file mode 100644 index 00000000..8ba606db --- /dev/null +++ b/gpg-zip @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpg-zip + +> Encrypt files and directories in an archive using GPG. +> More information: . + +- Encrypt a directory into `archive.gpg` using a passphrase: + +`gpg-zip --symmetric --output {{archive.gpg}} {{path/to/directory}}` + +- Decrypt `archive.gpg` into a directory of the same name: + +`gpg-zip --decrypt {{path/to/archive.gpg}}` + +- List the contents of the encrypted `archive.gpg`: + +`gpg-zip --list-archive {{path/to/archive.gpg}}` diff --git a/gpg2 b/gpg2 new file mode 100644 index 00000000..3230f72a --- /dev/null +++ b/gpg2 @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpg2 + +> GNU Privacy Guard 2. +> See `gpg` for GNU Privacy Guard 1. +> More information: . + +- List imported keys: + +`gpg2 --list-keys` + +- Encrypt a specified file for a specified recipient, writing the output to a new file with `.gpg` appended: + +`gpg2 --encrypt --recipient {{alice@example.com}} {{path/to/doc.txt}}` + +- Encrypt a specified file with only a passphrase, writing the output to a new file with `.gpg` appended: + +`gpg2 --symmetric {{path/to/doc.txt}}` + +- Decrypt a specified file, writing the result to `stdout`: + +`gpg2 --decrypt {{path/to/doc.txt.gpg}}` + +- Import a public key: + +`gpg2 --import {{path/to/public_key.gpg}}` + +- Export the public key of a specified email address to `stdout`: + +`gpg2 --export --armor {{alice@example.com}}` + +- Export the private key with a specified email address to `stdout`: + +`gpg2 --export-secret-keys --armor {{alice@example.com}}` diff --git a/gpgconf b/gpgconf new file mode 100644 index 00000000..cbcef3f9 --- /dev/null +++ b/gpgconf @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpgconf + +> Modify .gnupg home directories. +> More information: . + +- List all components: + +`gpgconf --list-components` + +- List the directories used by gpgconf: + +`gpgconf --list-dirs` + +- List all options of a component: + +`gpgconf --list-options {{component}}` + +- List programs and test whether they are runnable: + +`gpgconf --check-programs` + +- Reload a component: + +`gpgconf --reload {{component}}` diff --git a/gpgv b/gpgv new file mode 100644 index 00000000..a65091dd --- /dev/null +++ b/gpgv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gpgv + +> Verify OpenPGP signatures. +> More information: . + +- Verify a signed file: + +`gpgv {{path/to/file}}` + +- Verify a signed file using a detached signature: + +`gpgv {{path/to/signature}} {{path/to/file}}` + +- Add a file to the list of keyrings (a single exported key also counts as a keyring): + +`gpgv --keyring {{./alice.keyring}} {{path/to/signature}} {{path/to/file}}` diff --git a/gprbuild b/gprbuild new file mode 100644 index 00000000..940a2866 --- /dev/null +++ b/gprbuild @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gprbuild + +> A high-level build tool for projects written in Ada and other languages (C/C++/Fortran). +> More information: . + +- Build a project (assuming only one `*.gpr` file exists in the current directory): + +`gprbuild` + +- Build a specific [P]roject file: + +`gprbuild -P{{project_name}}` + +- Clean up the build workspace: + +`gprclean` + +- Install compiled binaries: + +`gprinstall --prefix {{path/to/installation/dir}}` diff --git a/gprof b/gprof new file mode 100644 index 00000000..e2330657 --- /dev/null +++ b/gprof @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gprof + +> Performance analysis tool for many programming languages. +> It profiles the function executions of a program. +> More information: . + +- Compile binary with gprof information and run it to get `gmon.out`: + +`gcc -pg {{program.c}} && {{./a.out}}` + +- Run gprof to obtain profile output: + +`gprof` + +- Suppress profile field's description: + +`gprof -b` + +- Display routines that have zero usage: + +`gprof -bz` diff --git a/gradle b/gradle new file mode 100644 index 00000000..4c809c25 --- /dev/null +++ b/gradle @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gradle + +> An open source build automation system. +> More information: . + +- Compile a package: + +`gradle build` + +- Exclude test task: + +`gradle build -x {{test}}` + +- Run in offline mode to prevent Gradle from accessing the network during builds: + +`gradle build --offline` + +- Clear the build directory: + +`gradle clean` + +- Build an Android Package (APK) in release mode: + +`gradle assembleRelease` + +- List the main tasks: + +`gradle tasks` + +- List all the tasks: + +`gradle tasks --all` diff --git a/grafana-cli b/grafana-cli new file mode 100644 index 00000000..da427866 --- /dev/null +++ b/grafana-cli @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grafana-cli + +> A small executable that is bundled with Grafana serve. +> More information: . + +- Install, update, or remove specific plugins: + +`grafana-cli plugins {{install|update|remove}} {{plugin_id1 plugin_id2 ...}}` + +- List all installed plugins: + +`grafana-cli plugins ls` diff --git a/grap b/grap new file mode 100644 index 00000000..2aa5e99a --- /dev/null +++ b/grap @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grap + +> A charting preprocessor for the groff (GNU Troff) document formatting system. +> See also `pic` and `groff`. +> More information: . + +- Process a `grap` file and save the output file for future processing with `pic` and `groff`: + +`grap {{path/to/input.grap}} > {{path/to/output.pic}}` + +- Typeset a `grap` file to PDF using the [me] macro package, saving the output to a file: + +`grap {{path/to/input.grap}} | pic -T {{pdf}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}` diff --git a/graphml2gv b/graphml2gv new file mode 100644 index 00000000..6167c697 --- /dev/null +++ b/graphml2gv @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# graphml2gv + +> Convert a graph from `graphml` to `gv` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `gml` to `gv` format: + +`graphml2gv -o {{output.gv}} {{input.gml}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.gml}} | graphml2gv > {{output.gv}}` + +- Display help: + +`graphml2gv -?` diff --git a/grep b/grep new file mode 100644 index 00000000..101fd19e --- /dev/null +++ b/grep @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grep + +> Find patterns in files using regular expressions. +> More information: . + +- Search for a pattern within a file: + +`grep "{{search_pattern}}" {{path/to/file}}` + +- Search for an exact string (disables regular expressions): + +`grep --fixed-strings "{{exact_string}}" {{path/to/file}}` + +- Search for a pattern in all files recursively in a directory, showing line numbers of matches, ignoring binary files: + +`grep --recursive --line-number --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` + +- Use extended regular expressions (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: + +`grep --extended-regexp --ignore-case "{{search_pattern}}" {{path/to/file}}` + +- Print 3 lines of context around, before, or after each match: + +`grep --{{context|before-context|after-context}}={{3}} "{{search_pattern}}" {{path/to/file}}` + +- Print file name and line number for each match with color output: + +`grep --with-filename --line-number --color=always "{{search_pattern}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`grep --only-matching "{{search_pattern}}" {{path/to/file}}` + +- Search `stdin` for lines that do not match a pattern: + +`cat {{path/to/file}} | grep --invert-match "{{search_pattern}}"` diff --git a/grex b/grex new file mode 100644 index 00000000..8fb8d108 --- /dev/null +++ b/grex @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grex + +> Generate regular expressions. +> More information: . + +- Generate a simple regular expression: + +`grex {{space_separated_strings}}` + +- Generate a case-insensitive regular expression: + +`grex -i {{space_separated_strings}}` + +- Replace digits with '\d': + +`grex -d {{space_separated_strings}}` + +- Replace Unicode word character with '\w': + +`grex -w {{space_separated_strings}}` + +- Replace spaces with '\s': + +`grex -s {{space_separated_strings}}` + +- Add {min, max} quantifier representation for repeating sub-strings: + +`grex -r {{space_separated_strings}}` diff --git a/grip b/grip new file mode 100644 index 00000000..a3e3fe64 --- /dev/null +++ b/grip @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grip + +> Preview GitHub-flavoured Markdown files locally. +> More information: . + +- Start the server and serve the rendered `README` file of a current directory: + +`grip` + +- Start the server and serve a specific Markdown file: + +`grip {{path/to/file.md}}` + +- Start the server and open the `README` file of the current directory in the browser: + +`grip --browser` + +- Start the server in the specified port and serve the rendered `README` file of the current directory: + +`grip {{port}}` diff --git a/groff b/groff new file mode 100644 index 00000000..fcff8317 --- /dev/null +++ b/groff @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# groff + +> GNU replacement for the `troff` and `nroff` typesetting utilities. +> More information: . + +- Format output for a PostScript printer, saving the output to a file: + +`groff {{path/to/input.roff}} > {{path/to/output.ps}}` + +- Render a man page using the ASCII output device, and display it using a pager: + +`groff -man -T ascii {{path/to/manpage.1}} | less --RAW-CONTROL-CHARS` + +- Render a man page into an HTML file: + +`groff -man -T html {{path/to/manpage.1}} > {{path/to/manpage.html}}` + +- Typeset a roff file containing [t]ables and [p]ictures, using the [me] macro set, to PDF, saving the output: + +`groff {{-t}} {{-p}} -{{me}} -T {{pdf}} {{path/to/input.me}} > {{path/to/output.pdf}}` + +- Run a `groff` command with preprocessor and macro options guessed by the `grog` utility: + +`eval "$(grog -T utf8 {{path/to/input.me}})"` diff --git a/groups b/groups new file mode 100644 index 00000000..42549808 --- /dev/null +++ b/groups @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# groups + +> Print group memberships for a user. +> See also: `groupadd`, `groupdel`, `groupmod`. +> More information: . + +- Print group memberships for the current user: + +`groups` + +- Print group memberships for a list of users: + +`groups {{username1 username2 ...}}` diff --git a/grpcurl b/grpcurl new file mode 100644 index 00000000..37baff25 --- /dev/null +++ b/grpcurl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grpcurl + +> Interact with gRPC servers. +> Like `curl`, but for gRPC. +> More information: . + +- Send an empty request: + +`grpcurl {{grpc.server.com:443}} {{my.custom.server.Service/Method}}` + +- Send a request with a header and a body: + +`grpcurl -H "{{Authorization: Bearer $token}}" -d {{'{"foo": "bar"}'}} {{grpc.server.com:443}} {{my.custom.server.Service/Method}}` + +- List all services exposed by a server: + +`grpcurl {{grpc.server.com:443}} list` + +- List all methods in a particular service: + +`grpcurl {{grpc.server.com:443}} list {{my.custom.server.Service}}` diff --git a/grumphp b/grumphp new file mode 100644 index 00000000..1dd4bdc8 --- /dev/null +++ b/grumphp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grumphp + +> A PHP Composer plugin that enables source code quality checks. +> More information: . + +- Register the Git hooks: + +`grumphp git:init` + +- Trigger the pre-commit hook manually: + +`grumphp git:pre-commit` + +- Check every versioned file: + +`grumphp run` diff --git a/grunt b/grunt new file mode 100644 index 00000000..6e2f8780 --- /dev/null +++ b/grunt @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# grunt + +> A JavaScript task runner for automating processes. +> More information: . + +- Run the default task process: + +`grunt` + +- Run one or more tasks: + +`grunt {{task1 task2 ...}}` + +- Specify an alternative configuration file: + +`grunt --gruntfile {{path/to/file}}` + +- Specify an alternative base path for relative files: + +`grunt --base {{path/to/directory}}` + +- Specify an additional directory to scan for tasks in: + +`grunt --tasks {{path/to/directory}}` + +- Perform a dry-run without writing any files: + +`grunt --no-write` + +- Display help: + +`grunt --help` diff --git a/gst-inspect-1.0 b/gst-inspect-1.0 new file mode 100644 index 00000000..f4b1a9cc --- /dev/null +++ b/gst-inspect-1.0 @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gst-inspect-1.0 + +> Print information on GStreamer plugins. +> More information: . + +- Print information on a plugin: + +`gst-inspect-1.0 {{plugin}}` + +- List hardware transcoding capabilities of your device: + +`gst-inspect-1.0 {{vaapi|nvcodec}}` diff --git a/gst-launch-1.0 b/gst-launch-1.0 new file mode 100644 index 00000000..a0a501db --- /dev/null +++ b/gst-launch-1.0 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gst-launch-1.0 + +> Build and run a GStreamer pipeline. +> More information: . + +- Play test video in a window: + +`gst-launch-1.0 videotestsrc ! xvimagesink` + +- Play a media file in a window: + +`gst-launch-1.0 playbin uri={{protocol}}://{{host}}/{{path/to/file}}` + +- Re-encode a media file: + +`gst-launch-1.0 filesrc location={{path/to/file}} ! {{file_type}}demux ! {{codec_type}}dec ! {{codec_type}}enc ! {{file_type}}mux ! filesink location={{path/to/file}}` + +- Stream a file to an RTSP server: + +`gst-launch-1.0 filesrc location={{path/to/file}} ! rtspclientsink location=rtsp://{{host_IP}}/{{path/to/file}}` diff --git a/gsutil b/gsutil new file mode 100644 index 00000000..bb8f6f3b --- /dev/null +++ b/gsutil @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gsutil + +> Access Google Cloud Storage. +> You can use `gsutil` to do a wide range of bucket and object management tasks. +> More information: . + +- List all buckets in a project you are logged into: + +`gsutil ls` + +- List the objects in a bucket: + +`gsutil ls -r 'gs://{{bucket_name}}/{{prefix}}**'` + +- Download an object from a bucket: + +`gsutil cp gs://{{bucket_name}}/{{object_name}} {{path/to/save_location}}` + +- Upload an object to a bucket: + +`gsutil cp {{object_location}} gs://{{destination_bucket_name}}/` + +- Rename or move objects in a bucket: + +`gsutil mv gs://{{bucket_name}}/{{old_object_name}} gs://{{bucket_name}}/{{new_object_name}}` + +- Create a new bucket in the project you are logged into: + +`gsutil mb gs://{{bucket_name}}` + +- Delete a bucket and remove all the objects in it: + +`gsutil rm -r gs://{{bucket_name}}` diff --git a/gt b/gt new file mode 100644 index 00000000..d42c6ffb --- /dev/null +++ b/gt @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gt + +> Create and manage sequences of dependent code changes (stacks) for Git and GitHub. +> More information: . + +- Authenticate the CLI with Graphite's API: + +`gt auth --token {{graphite_cli_auth_token}}` + +- Initialise `gt` for the repository in the current directory: + +`gt repo init` + +- Create a new branch stacked on top of the current branch and commit staged changes: + +`gt branch create {{branch_name}}` + +- Create a new commit and fix upstack branches: + +`gt commit create -m {{commit_message}}` + +- Force push all branches in the current stack to GitHub and create or update PRs: + +`gt stack submit` + +- Log all tracked stacks: + +`gt log short` + +- Display help for a specified subcommand: + +`gt {{subcommand}} --help` diff --git a/gtop b/gtop new file mode 100644 index 00000000..13a9844b --- /dev/null +++ b/gtop @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gtop + +> System monitoring dashboard for the terminal. +> More information: . + +- Show the system stats dashboard: + +`gtop` + +- Sort by CPU usage: + +`c` + +- Sort by memory usage: + +`m` diff --git a/guacd b/guacd new file mode 100644 index 00000000..f84dfe20 --- /dev/null +++ b/guacd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# guacd + +> Apache Guacamole proxy daemon. +> Support loader for client plugins to interface between the Guacamole protocol and any arbitrary remote desktop protocol (e.g. RDP, VNC, Other). +> More information: . + +- Bind to a specific port on localhost: + +`guacd -b {{127.0.0.1}} -l {{4823}}` + +- Start in debug mode, keeping the process in the foreground: + +`guacd -f -L {{debug}}` + +- Start with TLS support: + +`guacd -C {{my-cert.crt}} -K {{my-key.pem}}` + +- Write the PID to a file: + +`guacd -p {{path/to/file.pid}}` diff --git a/guetzli b/guetzli new file mode 100644 index 00000000..c274b0c6 --- /dev/null +++ b/guetzli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# guetzli + +> JPEG image compression utility. +> More information: . + +- Compress a JPEG image: + +`guetzli {{input.jpg}} {{output.jpg}}` + +- Create a compressed JPEG from a PNG: + +`guetzli {{input.png}} {{output.jpg}}` + +- Compress a JPEG with the desired visual quality (84-100): + +`guetzli --quality {{quality_value}} {{input.jpg}} {{output.jpg}}` diff --git a/guile b/guile new file mode 100644 index 00000000..09fe57a8 --- /dev/null +++ b/guile @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# guile + +> Guile Scheme interpreter. +> More information: . + +- Start a REPL (interactive shell): + +`guile` + +- Execute the script in a given Scheme file: + +`guile {{script.scm}}` + +- Execute a Scheme expression: + +`guile -c "{{expression}}"` + +- Listen on a port or a Unix domain socket (the default is port 37146) for remote REPL connections: + +`guile --listen={{port_or_socket}}` diff --git a/gulp b/gulp new file mode 100644 index 00000000..371a629b --- /dev/null +++ b/gulp @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gulp + +> JavaScript task runner and streaming build system. +> Tasks are defined within `gulpfile.js` at the project root. +> More information: . + +- Run the default task: + +`gulp` + +- Run individual tasks: + +`gulp {{task}} {{othertask}}` + +- Print the task dependency tree for the loaded gulpfile: + +`gulp --tasks` diff --git a/gum b/gum new file mode 100644 index 00000000..ff953b99 --- /dev/null +++ b/gum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gum + +> Make glamorous shell scripts. +> More information: . + +- Interactively pick a specific option to print to `stdout`: + +`gum choose "{{option_1}}" "{{option_2}}" "{{option_3}}"` + +- Open an interactive prompt for the user to input a string with a specific placeholder: + +`gum input --placeholder "{{value}}"` + +- Open an interactive confirmation prompt and exit with either `0` or `1`: + +`gum confirm "{{Continue?}}" --default=false --affirmative "{{Yes}}" --negative "{{No}}" {{&& echo "Yes selected" || echo "No selected"}}` + +- Show a spinner while a command is taking place with text alongside: + +`gum spin --spinner {{dot|line|minidot|jump|pulse|points|globe|moon|monkey|meter|hamburger}} --title "{{loading...}}" -- {{command}}` + +- Format text to include emojis: + +`gum format -t {{emoji}} "{{:smile: :heart: hello}}"` + +- Interactively prompt for multi-line text (CTRL + D to save) and write to `data.txt`: + +`gum write > {{data.txt}}` diff --git a/gunicorn b/gunicorn new file mode 100644 index 00000000..994bd4a2 --- /dev/null +++ b/gunicorn @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gunicorn + +> Python WSGI HTTP Server. +> More information: . + +- Run Python web app: + +`gunicorn {{import.path:app_object}}` + +- Listen on port 8080 on localhost: + +`gunicorn --bind {{localhost}}:{{8080}} {{import.path:app_object}}` + +- Turn on live reload: + +`gunicorn --reload {{import.path:app_object}}` + +- Use 4 worker processes for handling requests: + +`gunicorn --workers {{4}} {{import.path:app_object}}` + +- Use 4 worker threads for handling requests: + +`gunicorn --threads {{4}} {{import.path:app_object}}` + +- Run app over HTTPS: + +`gunicorn --certfile {{cert.pem}} --keyfile {{key.pem}} {{import.path:app_object}}` diff --git a/gunzip b/gunzip new file mode 100644 index 00000000..9302cada --- /dev/null +++ b/gunzip @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gunzip + +> Extract files from a `gzip` (`.gz`) archive. +> More information: . + +- Extract a file from an archive, replacing the original file if it exists: + +`gunzip {{archive.tar.gz}}` + +- Extract a file to a target destination: + +`gunzip --stdout {{archive.tar.gz}} > {{archive.tar}}` + +- Extract a file and keep the archive file: + +`gunzip --keep {{archive.tar.gz}}` + +- List the contents of a compressed file: + +`gunzip --list {{file.txt.gz}}` + +- Decompress an archive from `stdin`: + +`cat {{path/to/archive.gz}} | gunzip` diff --git a/gv2gml b/gv2gml new file mode 100644 index 00000000..36f9af10 --- /dev/null +++ b/gv2gml @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gv2gml + +> Convert a graph from `gv` to `gml` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `gv` to `gml` format: + +`gv2gml -o {{output.gml}} {{input.gv}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.gv}} | gv2gml > {{output.gml}}` + +- Display help: + +`gv2gml -?` diff --git a/gv2gxl b/gv2gxl new file mode 100644 index 00000000..c029a8b6 --- /dev/null +++ b/gv2gxl @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gv2gxl + +> Convert a graph from `gv` to `gxl` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `gv` to `gxl` format: + +`gv2gxl -o {{output.gxl}} {{input.gv}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.gv}} | gv2gxl > {{output.gxl}}` + +- Display help: + +`gv2gxl -?` diff --git a/gvcolor b/gvcolor new file mode 100644 index 00000000..a1b8ebde --- /dev/null +++ b/gvcolor @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gvcolor + +> Colorize a ranked digraph with a range of colors. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Colorize one or more ranked digraph (that were already processed by `dot`): + +`gvcolor {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Lay out a graph and colorize it, then convert to a PNG image: + +`dot {{path/to/input.gv}} | gvcolor | dot -T {{png}} > {{path/to/output.png}}` + +- Display help: + +`gvcolor -?` diff --git a/gvpack b/gvpack new file mode 100644 index 00000000..1e2aadff --- /dev/null +++ b/gvpack @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gvpack + +> Combine several graph layouts (that already have layout information). +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Combine several graph layouts (that already have layout information): + +`gvpack {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Combine several graph layouts at the graph level, keeping graphs separate: + +`gvpack -g {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Combine several graph layouts at the node level, ignoring clusters: + +`gvpack -n {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Combine several graph layouts without packing: + +`gvpack -u {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Display help: + +`gvpack -?` diff --git a/gxl2gv b/gxl2gv new file mode 100644 index 00000000..85206ee9 --- /dev/null +++ b/gxl2gv @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gxl2gv + +> Convert a graph from `gxl` to `gv` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `gxl` to `gv` format: + +`gxl2gv -o {{output.gv}} {{input.gxl}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.gxl}} | gxl2gv > {{output.gv}}` + +- Display help: + +`gxl2gv -?` diff --git a/gyb b/gyb new file mode 100644 index 00000000..8ac67bbe --- /dev/null +++ b/gyb @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gyb + +> Command line tool for locally backing up Gmail messages using Gmail's API over HTTPS. +> More information: . + +- Estimate the number and the size of all emails on your Gmail account: + +`gyb --email {{email@gmail.com}} --action estimate` + +- Backup a Gmail account to a specific directory: + +`gyb --email {{email@gmail.com}} --action backup --local-folder {{path/to/directory}}` + +- Backup only important or starred emails from a Gmail account to the default local folder: + +`gyb --email {{email@gmail.com}} --search "{{is:important OR is:starred}}"` + +- Restore from a local folder to a Gmail account: + +`gyb --email {{email@gmail.com}} --action restore --local-folder {{path/to/directory}}` diff --git a/gzip b/gzip new file mode 100644 index 00000000..f05e630e --- /dev/null +++ b/gzip @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gzip + +> Compress/uncompress files with `gzip` compression (LZ77). +> More information: . + +- Compress a file, replacing it with a `gzip` archive: + +`gzip {{file.ext}}` + +- Decompress a file, replacing it with the original uncompressed version: + +`gzip -d {{file.ext}}.gz` + +- Compress a file, keeping the original file: + +`gzip --keep {{file.ext}}` + +- Compress a file specifying the output filename: + +`gzip -c {{file.ext}} > {{compressed_file.ext.gz}}` + +- Decompress a `gzip` archive specifying the output filename: + +`gzip -c -d {{file.ext}}.gz > {{uncompressed_file.ext}}` + +- Specify the compression level. 1=Fastest (Worst), 9=Slowest (Best), Default level is 6: + +`gzip -9 -c {{file.ext}} > {{compressed_file.ext.gz}}` diff --git a/hadolint b/hadolint new file mode 100644 index 00000000..1f35b321 --- /dev/null +++ b/hadolint @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hadolint + +> Dockerfile linter. +> More information: . + +- Lint a Dockerfile: + +`hadolint {{path/to/Dockerfile}}` + +- Lint a Dockerfile, displaying the output in JSON format: + +`hadolint --format {{json}} {{path/to/Dockerfile}}` + +- Lint a Dockerfile, displaying the output in a specific format: + +`hadolint --format {{tty|json|checkstyle|codeclimate|codacy}} {{path/to/Dockerfile}}` + +- Lint a Dockerfile ignoring specific rules: + +`hadolint --ignore {{DL3006}} --ignore {{DL3008}} {{path/to/Dockerfile}}` + +- Lint multiple Dockerfiles using specific trusted registries: + +`hadolint --trusted-registry {{docker.io}} --trusted-registry {{example.com}}:{{5000}} {{path/to/Dockerfile1 path/to/Dockerfile2 ...}}` diff --git a/hakyll-init b/hakyll-init new file mode 100644 index 00000000..0d3df7f0 --- /dev/null +++ b/hakyll-init @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hakyll-init + +> Generate a new Hakyll sample blog. +> More information: . + +- Generate a new Hakyll sample blog: + +`hakyll-init {{path/to/directory}}` + +- Display help: + +`hakyll-init --help` diff --git a/handbrakecli b/handbrakecli new file mode 100644 index 00000000..17108c5b --- /dev/null +++ b/handbrakecli @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# handbrakecli + +> Command-line interface to the HandBrake video conversion and DVD ripping tool. +> More information: . + +- Convert a video file to MKV (AAC 160kbit audio and x264 CRF20 video): + +`handbrakecli --input {{input.avi}} --output {{output.mkv}} --encoder x264 --quality 20 --ab 160` + +- Resize a video file to 320x240: + +`handbrakecli --input {{input.mp4}} --output {{output.mp4}} --width 320 --height 240` + +- List available presets: + +`handbrakecli --preset-list` + +- Convert an AVI video to MP4 using the Android preset: + +`handbrakecli --preset="Android" --input {{input.ext}} --output {{output.mp4}}` + +- Print the content of a DVD, getting the CSS keys in the process: + +`handbrakecli --input {{/dev/sr0}} --title 0` + +- Rip the first track of a DVD in the specified device. Audiotracks and subtitle languages are specified as lists: + +`handbrakecli --input {{/dev/sr0}} --title 1 --output {{out.mkv}} --format av_mkv --encoder x264 --subtitle {{1,4,5}} --audio {{1,2}} --aencoder copy --quality {{23}}` diff --git a/hangups b/hangups new file mode 100644 index 00000000..0916f664 --- /dev/null +++ b/hangups @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hangups + +> Third party command-line client for Google Hangouts. +> More information: . + +- Start `hangups`: + +`hangups` + +- Display troubleshooting information and help: + +`hangups -h` + +- Set a refresh token for hangups: + +`hangups --token-path {{path/to/token}}` diff --git a/hardhat b/hardhat new file mode 100644 index 00000000..7a3fe7bc --- /dev/null +++ b/hardhat @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hardhat + +> A development environment for Ethereum software. +> More information: . + +- List available subcommands (or create a new project if no configuration exists): + +`hardhat` + +- Compile the current project and build all artifacts: + +`hardhat compile` + +- Run a user-defined script after compiling the project: + +`hardhat run {{path/to/script.js}}` + +- Run Mocha tests: + +`hardhat test` + +- Run all given test files: + +`hardhat test {{path/to/file1.js}} {{path/to/file2.js}}` + +- Start a local Ethereum JSON-RPC node for development: + +`hardhat node` + +- Start a local Ethereum JSON-RPC node with a specific hostname and port: + +`hardhat node --hostname {{hostname}} --port {{port}}` + +- Clean the cache and all artifacts: + +`hardhat clean` diff --git a/hashcat b/hashcat new file mode 100644 index 00000000..7f03b346 --- /dev/null +++ b/hashcat @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hashcat + +> Fast and advanced password recovery tool. +> More information: . + +- Perform a brute-force attack (mode 3) with the default hashcat mask: + +`hashcat --hash-type {{hash_type_id}} --attack-mode {{3}} {{hash_value}}` + +- Perform a brute-force attack (mode 3) with a known pattern of 4 digits: + +`hashcat --hash-type {{hash_type_id}} --attack-mode {{3}} {{hash_value}} "{{?d?d?d?d}}"` + +- Perform a brute-force attack (mode 3) using at most 8 of all printable ASCII characters: + +`hashcat --hash-type {{hash_type_id}} --attack-mode {{3}} --increment {{hash_value}} "{{?a?a?a?a?a?a?a?a}}"` + +- Perform a dictionary attack (mode 0) using the RockYou wordlist of a Kali Linux box: + +`hashcat --hash-type {{hash_type_id}} --attack-mode {{0}} {{hash_value}} {{/usr/share/wordlists/rockyou.txt}}` + +- Perform a rule-based dictionary attack (mode 0) using the RockYou wordlist mutated with common password variations: + +`hashcat --hash-type {{hash_type_id}} --attack-mode {{0}} --rules-file {{/usr/share/hashcat/rules/best64.rule}} {{hash_value}} {{/usr/share/wordlists/rockyou.txt}}` + +- 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}}` + +- Show result of an already cracked hash: + +`hashcat --show {{hash_value}}` diff --git a/hashid b/hashid new file mode 100644 index 00000000..9a3644ac --- /dev/null +++ b/hashid @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hashid + +> Python3 program that identifies data and password hashes. +> More information: . + +- Identify hashes from `stdin` (through typing, copying and pasting, or piping the hash into the program): + +`hashid` + +- Identify one or more hashes: + +`hashid {{hash1 hash2 ...}}` + +- Identify hashes on a file (one hash per line): + +`hashid {{path/to/hashes.txt}}` + +- Show all possible hash types (including salted hashes): + +`hashid --extended {{hash}}` + +- Show `hashcat`'s mode number and `john`'s format string of the hash types: + +`hashid --mode --john {{hash}}` + +- Save output to a file instead of printing to `stdout`: + +`hashid --outfile {{path/to/output.txt}} {{hash}}` diff --git a/haxelib b/haxelib new file mode 100644 index 00000000..32eccb20 --- /dev/null +++ b/haxelib @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# haxelib + +> Haxe Library Manager. +> More information: . + +- Search for a Haxe library: + +`haxelib search {{keyword}}` + +- Install a Haxe library: + +`haxelib install {{libname}}` + +- Install a specific version of a Haxe library: + +`haxelib install {{libname}} {{version}}` + +- Upgrade all installed Haxe libraries: + +`haxelib upgrade` + +- Install the development version of a library from a Git repository: + +`haxelib git {{libname}} {{git_url}}` + +- Uninstall a Haxe library: + +`haxelib remove {{libname}}` + +- Print a tree of locally installed Haxe libraries: + +`haxelib list` diff --git a/hcloud b/hcloud new file mode 100644 index 00000000..1b13f477 --- /dev/null +++ b/hcloud @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hcloud + +> Show how to use the CLI for Hetzner Cloud. +> More information: . + +- Show available commands and flags: + +`hcloud` + +- Display help: + +`hcloud -h` + +- Show available commands and flags for `hcloud` contexts: + +`hcloud context` diff --git a/hd b/hd new file mode 100644 index 00000000..cda67ba1 --- /dev/null +++ b/hd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hd + +> This command is an alias of `hexdump`. +> More information: . + +- View documentation for the original command: + +`tldr hexdump` diff --git a/head b/head new file mode 100644 index 00000000..970f1916 --- /dev/null +++ b/head @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# head + +> Output the first part of files. +> More information: . + +- Output the first few lines of a file: + +`head -n {{count}} {{path/to/file}}` diff --git a/helix b/helix new file mode 100644 index 00000000..5ea57e5d --- /dev/null +++ b/helix @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# helix + +> Helix, A post-modern text editor, provides several modes for different kinds of text manipulation. +> Pressing `i` enters insert mode. `` enters normal mode, which enables the use of Helix commands. +> More information: . + +- Open a file: + +`helix {{path/to/file}}` + +- Change the Helix theme: + +`:theme {{theme_name}}` + +- Save and Quit: + +`:wq` + +- Force-quit without saving: + +`:q!` + +- Undo the last operation: + +`u` + +- Search for a pattern in the file (press `n`/`N` to go to next/previous match): + +`/{{search_pattern}}` + +- Format the file: + +`:format` diff --git a/hello b/hello new file mode 100644 index 00000000..ef5b756f --- /dev/null +++ b/hello @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hello + +> Print "Hello, world!", "hello, world" or a customizable text. +> More information: . + +- Print "Hello, world!": + +`hello` + +- Print "hello, world", the traditional type: + +`hello --traditional` + +- Print a text message: + +`hello --greeting="{{greeting_text}}"` diff --git a/helm b/helm new file mode 100644 index 00000000..257e51b7 --- /dev/null +++ b/helm @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# helm + +> A package manager for Kubernetes. +> Some subcommands such as `install` have their own usage documentation. +> More information: . + +- Create a helm chart: + +`helm create {{chart_name}}` + +- Add a new helm repository: + +`helm repo add {{repository_name}}` + +- List helm repositories: + +`helm repo list` + +- Update helm repositories: + +`helm repo update` + +- Delete a helm repository: + +`helm repo remove {{repository_name}}` + +- Install a helm chart: + +`helm install {{name}} {{repository_name}}/{{chart_name}}` + +- Download helm chart as a `tar` archive: + +`helm get {{chart_release_name}}` + +- Update helm dependencies: + +`helm dependency update` diff --git a/helm-install b/helm-install new file mode 100644 index 00000000..86ae32a7 --- /dev/null +++ b/helm-install @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# helm install + +> Install a helm chart. +> More information: . + +- Install a helm chart: + +`helm install {{name}} {{repository_name}}/{{chart_name}}` + +- Install a helm chart from an unpacked chart directory: + +`helm install {{name}} {{path/to/source_directory}}` + +- Install a helm chart from a URL: + +`helm install {{package_name}} {{https://example.com/charts/packagename-1.2.3.tgz}}` + +- Install a helm chart and generate a name: + +`helm install {{repository_name}}/{{chart_name}} --generate-name` + +- Perform a dry run: + +`helm install {{name}} {{repository_name}}/{{chart_name}} --dry-run` + +- Install a helm chart with custom values: + +`helm install {{name}} {{repository_name}}/{{chart_name}} --set {{parameter1}}={{value1}},{{parameter2}}={{value2}}` + +- Install a helm chart passing a custom values file: + +`helm install {{name}} {{repository_name}}/{{chart_name}} --values {{path/to/values.yaml}}` diff --git a/help2man b/help2man new file mode 100644 index 00000000..90755646 --- /dev/null +++ b/help2man @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# help2man + +> Produce simple man pages from an executable's `--help` and `--version` output. +> More information: . + +- Generate a man page for an executable: + +`help2man {{executable}}` + +- Specify the "name" paragraph in the man page: + +`help2man {{executable}} --name {{name}}` + +- Specify the section for the man page (defaults to 1): + +`help2man {{executable}} --section {{section}}` + +- Output to a file instead of `stdout`: + +`help2man {{executable}} --output {{path/to/file}}` + +- Display help: + +`help2man --help` diff --git a/heroku b/heroku new file mode 100644 index 00000000..25030cab --- /dev/null +++ b/heroku @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# heroku + +> Create and manage Heroku apps. +> More information: . + +- Log in to your Heroku account: + +`heroku login` + +- Create a Heroku app: + +`heroku create` + +- Show logs for an app: + +`heroku logs --app {{app_name}}` + +- Run a one-off process inside a dyno (Heroku virtual machine): + +`heroku run {{process_name}} --app {{app_name}}` + +- List dynos (Heroku virtual machines) for an app: + +`heroku ps --app {{app_name}}` + +- Permanently destroy an app: + +`heroku destroy --app {{app_name}}` diff --git a/hexdump b/hexdump new file mode 100644 index 00000000..c0a762e9 --- /dev/null +++ b/hexdump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hexdump + +> An ASCII, decimal, hexadecimal, octal dump. +> More information: . + +- Print the hexadecimal representation of a file, replacing duplicate lines by '*': + +`hexdump {{path/to/file}}` + +- Display the input offset in hexadecimal and its ASCII representation in two columns: + +`hexdump -C {{path/to/file}}` + +- Display the hexadecimal representation of a file, but interpret only n bytes of the input: + +`hexdump -C -n{{number_of_bytes}} {{path/to/file}}` + +- Don't replace duplicate lines with '*': + +`hexdump --no-squeezing {{path/to/file}}` diff --git a/hexo b/hexo new file mode 100644 index 00000000..b99d5c2c --- /dev/null +++ b/hexo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hexo + +> A fast, simple & powerful blog framework. +> More information: . + +- Initialize a website: + +`hexo init {{path/to/directory}}` + +- Create a new article: + +`hexo new {{layout}} {{title}}` + +- Generate static files: + +`hexo generate` + +- Start a local server: + +`hexo server` + +- Deploy the website: + +`hexo deploy` + +- Clean the cache file (`db.json`) and generated files (`public/`): + +`hexo clean` diff --git a/hexyl b/hexyl new file mode 100644 index 00000000..3211fe8c --- /dev/null +++ b/hexyl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hexyl + +> A simple hex viewer for the terminal. Uses colored output to distinguish different categories of bytes. +> More information: . + +- Print the hexadecimal representation of a file: + +`hexyl {{path/to/file}}` + +- Print the hexadecimal representation of the first n bytes of a file: + +`hexyl -n {{n}} {{path/to/file}}` + +- Print bytes 512 through 1024 of a file: + +`hexyl -r {{512}}:{{1024}} {{path/to/file}}` + +- Print 512 bytes starting at the 1024th byte: + +`hexyl -r {{1024}}:+{{512}} {{path/to/file}}` diff --git a/hg b/hg new file mode 100644 index 00000000..fba3308d --- /dev/null +++ b/hg @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg + +> Mercurial - a distributed source control management system. +> Some subcommands such as `hg commit` have their own usage documentation. +> More information: . + +- Execute a Mercurial command: + +`hg {{command}}` + +- Display help: + +`hg help` + +- Display help for a specific command: + +`hg help {{command}}` + +- Check the Mercurial version: + +`hg --version` diff --git a/hg-add b/hg-add new file mode 100644 index 00000000..2e48592f --- /dev/null +++ b/hg-add @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg add + +> Adds specified files to the staging area for the next commit in Mercurial. +> More information: . + +- Add files or directories to the staging area: + +`hg add {{path/to/file}}` + +- Add all unstaged files matching a specified pattern: + +`hg add --include {{pattern}}` + +- Add all unstaged files, excluding those that match a specified pattern: + +`hg add --exclude {{pattern}}` + +- Recursively add sub-repositories: + +`hg add --subrepos` + +- Perform a test-run without performing any actions: + +`hg add --dry-run` diff --git a/hg-branch b/hg-branch new file mode 100644 index 00000000..8210a346 --- /dev/null +++ b/hg-branch @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg branch + +> Create or show a branch name. +> More information: . + +- Show the name of the currently active branch: + +`hg branch` + +- Create a new branch for the next commit: + +`hg branch {{branch_name}}` diff --git a/hg-clone b/hg-clone new file mode 100644 index 00000000..5fe629dc --- /dev/null +++ b/hg-clone @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg clone + +> Create a copy of an existing repository in a new directory. +> More information: . + +- Clone a repository to a specified directory: + +`hg clone {{remote_repository_source}} {{destination_path}}` + +- Clone a repository to the head of a specific branch, ignoring later commits: + +`hg clone --branch {{branch}} {{remote_repository_source}}` + +- Clone a repository with only the `.hg` directory, without checking out files: + +`hg clone --noupdate {{remote_repository_source}}` + +- Clone a repository to a specific revision, tag or branch, keeping the entire history: + +`hg clone --updaterev {{revision}} {{remote_repository_source}}` + +- Clone a repository up to a specific revision without any newer history: + +`hg clone --rev {{revision}} {{remote_repository_source}}` diff --git a/hg-commit b/hg-commit new file mode 100644 index 00000000..1fe17c59 --- /dev/null +++ b/hg-commit @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg commit + +> Commit all staged or specified files to the repository. +> More information: . + +- Commit staged files to the repository: + +`hg commit` + +- Commit a specific file or directory: + +`hg commit {{path/to/file_or_directory}}` + +- Commit with a specific message: + +`hg commit --message {{message}}` + +- Commit all files matching a specified pattern: + +`hg commit --include {{pattern}}` + +- Commit all files, excluding those that match a specified pattern: + +`hg commit --exclude {{pattern}}` + +- Commit using the interactive mode: + +`hg commit --interactive` diff --git a/hg-init b/hg-init new file mode 100644 index 00000000..66e8ae74 --- /dev/null +++ b/hg-init @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg init + +> Create a new repository in the specified directory. +> More information: . + +- Initialize a new repository in the current directory: + +`hg init` + +- Initialize a new repository in the specified directory: + +`hg init {{path/to/directory}}` diff --git a/hg-log b/hg-log new file mode 100644 index 00000000..a329a0d7 --- /dev/null +++ b/hg-log @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg log + +> Display the revision history of the repository. +> More information: . + +- Display the entire revision history of the repository: + +`hg log` + +- Display the revision history with an ASCII graph: + +`hg log --graph` + +- Display the revision history with file names matching a specified pattern: + +`hg log --include {{pattern}}` + +- Display the revision history, excluding file names that match a specified pattern: + +`hg log --exclude {{pattern}}` + +- Display the log information for a specific revision: + +`hg log --rev {{revision}}` + +- Display the revision history for a specific branch: + +`hg log --branch {{branch}}` + +- Display the revision history for a specific date: + +`hg log --date {{date}}` + +- Display revisions committed by a specific user: + +`hg log --user {{user}}` diff --git a/hg-pull b/hg-pull new file mode 100644 index 00000000..bffbe4c1 --- /dev/null +++ b/hg-pull @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg pull + +> Pull changes from a specified repository to the local repository. +> More information: . + +- Pull from the "default" source path: + +`hg pull` + +- Pull from a specified source repository: + +`hg pull {{path/to/source_repository}}` + +- Update the local repository to the head of the remote: + +`hg pull --update` + +- Pull changes even when the remote repository is unrelated: + +`hg pull --force` + +- Specify a specific revision changeset to pull up to: + +`hg pull --rev {{revision}}` + +- Specify a specific branch to pull: + +`hg pull --branch {{branch}}` + +- Specify a specific bookmark to pull: + +`hg pull --bookmark {{bookmark}}` diff --git a/hg-push b/hg-push new file mode 100644 index 00000000..8876d1db --- /dev/null +++ b/hg-push @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg push + +> Push changes from the local repository to a specified destination. +> More information: . + +- Push changes to the "default" remote path: + +`hg push` + +- Push changes to a specified remote repository: + +`hg push {{path/to/destination_repository}}` + +- Push a new branch if it does not exist (disabled by default): + +`hg push --new-branch` + +- Specify a specific revision changeset to push: + +`hg push --rev {{revision}}` + +- Specify a specific branch to push: + +`hg push --branch {{branch}}` + +- Specify a specific bookmark to push: + +`hg push --bookmark {{bookmark}}` diff --git a/hg-remove b/hg-remove new file mode 100644 index 00000000..81ffe73f --- /dev/null +++ b/hg-remove @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg remove + +> Remove specified files from the staging area. +> More information: . + +- Remove files or directories from the staging area: + +`hg remove {{path/to/file}}` + +- Remove all staged files matching a specified pattern: + +`hg remove --include {{pattern}}` + +- Remove all staged files, excluding those that match a specified pattern: + +`hg remove --exclude {{pattern}}` + +- Recursively remove sub-repositories: + +`hg remove --subrepos` + +- Remove files from the repository that have been physically removed: + +`hg remove --after` diff --git a/hg-root b/hg-root new file mode 100644 index 00000000..2b902753 --- /dev/null +++ b/hg-root @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg root + +> Display the root location of a Hg repository. +> More information: . + +- Display the root location of the current repository: + +`hg root` + +- Display the root location of the specified repository: + +`hg root --cwd {{path/to/directory}}` diff --git a/hg-serve b/hg-serve new file mode 100644 index 00000000..36d39987 --- /dev/null +++ b/hg-serve @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg serve + +> Start a standalone Mercurial web server for browsing repositories. +> More information: . + +- Start a web server instance: + +`hg serve` + +- Start a web server instance on the specified port: + +`hg serve --port {{port}}` + +- Start a web server instance on the specified listening address: + +`hg serve --address {{address}}` + +- Start a web server instance with a specific identifier: + +`hg serve --name {{name}}` + +- Start a web server instance using the specified theme (see the templates directory): + +`hg serve --style {{style}}` + +- Start a web server instance using the specified SSL certificate bundle: + +`hg serve --certificate {{path/to/certificate}}` diff --git a/hg-status b/hg-status new file mode 100644 index 00000000..925f5b57 --- /dev/null +++ b/hg-status @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg status + +> Show files that have changed in the working directory. +> More information: . + +- Display the status of changed files: + +`hg status` + +- Display only modified files: + +`hg status --modified` + +- Display only added files: + +`hg status --added` + +- Display only removed files: + +`hg status --removed` + +- Display only deleted (but tracked) files: + +`hg status --deleted` + +- Display changes in the working directory compared to a specified changeset: + +`hg status --rev {{revision}}` + +- Display only files matching a specified glob pattern: + +`hg status --include {{pattern}}` + +- Display files, excluding those that match a specified glob pattern: + +`hg status --exclude {{pattern}}` diff --git a/hg-update b/hg-update new file mode 100644 index 00000000..d6c55f5c --- /dev/null +++ b/hg-update @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hg update + +> Update the working directory to a specified changeset. +> More information: . + +- Update to the tip of the current branch: + +`hg update` + +- Update to the specified revision: + +`hg update --rev {{revision}}` + +- Update and discard uncommitted changes: + +`hg update --clean` + +- Update to the last commit matching a specified date: + +`hg update --date {{dd-mm-yyyy}}` diff --git a/highlight b/highlight new file mode 100644 index 00000000..ec7d2308 --- /dev/null +++ b/highlight @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# highlight + +> Outputs syntax-highlighted source code to a variety of formats. +> More information: . + +- Produce a complete HTML document from a source code file: + +`highlight --out-format={{html}} --style {{theme_name}} --syntax {{language}} {{path/to/source_code}}` + +- Produce an HTML fragment, suitable for inclusion in a larger document: + +`highlight --out-format={{html}} --fragment --syntax {{language}} {{source_file}}` + +- Inline the CSS styling in every tag: + +`highlight --out-format={{html}} --inline-css --syntax {{language}} {{source_file}}` + +- List all supported languages, themes, or plugins: + +`highlight --list-scripts {{langs|themes|plugins}}` + +- Print a CSS stylesheet for a theme: + +`highlight --out-format={{html}} --print-style --style {{theme_name}} --syntax {{language}}] --stdout` diff --git a/hipstopgm b/hipstopgm new file mode 100644 index 00000000..8cf8f475 --- /dev/null +++ b/hipstopgm @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hipstopgm + +> Read a HIPS file as input and return a PGM image as output. +> If the HIPS file contains more than one frame in sequence, `hipstopgm` will concatenate all the frames vertically. +> More information: . + +- Convert a HIPS file into a PGM image: + +`hipstopgm {{path/to/file.hips}}` + +- Suppress all informational messages: + +`hipstopgm -quiet` + +- Display version: + +`hipstopgm -version` diff --git a/histexpand b/histexpand new file mode 100644 index 00000000..c8dbe60b --- /dev/null +++ b/histexpand @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# history expansion + +> Reuse and expand the shell history in `sh`, `bash`, `zsh`, `rbash` and `ksh`. +> More information: . + +- Run the previous command as root (`!!` is replaced by the previous command): + +`sudo !!` + +- Run a command with the last argument of the previous command: + +`{{command}} !$` + +- Run a command with the first argument of the previous command: + +`{{command}} !^` + +- Run the Nth command of the history: + +`!{{n}}` + +- Run the command `n` lines back in the history: + +`!-{{n}}` + +- Run the most recent command containing `string`: + +`!?{{string}}?` + +- Run the previous command, replacing `string1` with `string2`: + +`^{{string1}}^{{string2}}^` + +- Perform a history expansion, but print the command that would be run instead of actually running it: + +`{{!-n}}:p` diff --git a/history b/history new file mode 100644 index 00000000..0838da24 --- /dev/null +++ b/history @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# history + +> Command-line history. +> More information: . + +- Display the commands history list with line numbers: + +`history` + +- Display the last 20 commands (in `zsh` it displays all commands starting from the 20th): + +`history {{20}}` + +- Clear the commands history list (only for current `bash` shell): + +`history -c` + +- Overwrite history file with history of current `bash` shell (often combined with `history -c` to purge history): + +`history -w` + +- Delete the history entry at the specified offset: + +`history -d {{offset}}` diff --git a/hive b/hive new file mode 100644 index 00000000..19014e37 --- /dev/null +++ b/hive @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hive + +> CLI tool for Apache Hive. +> More information: . + +- Start a Hive interactive shell: + +`hive` + +- Run HiveQL: + +`hive -e "{{hiveql_query}}"` + +- Run a HiveQL file with a variable substitution: + +`hive --define {{key}}={{value}} -f {{path/to/file.sql}}` + +- Run a HiveQL with HiveConfig (e.g. `mapred.reduce.tasks=32`): + +`hive --hiveconf {{conf_name}}={{conf_value}}` diff --git a/hledger b/hledger new file mode 100644 index 00000000..aaa3f03c --- /dev/null +++ b/hledger @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hledger + +> A plain text accounting software for the command-line. +> More information: . + +- Add transactions to your journal interactively: + +`hledger add` + +- Show the account hierarchy, using a specific journal file: + +`hledger --file {{path/to/file.journal}} accounts --tree` + +- Show a monthly income statement: + +`hledger incomestatement --monthly --depth 2` + +- Print the amount of cash spent on food: + +`hledger print assets:cash | hledger -f- -I balance expenses:food --depth 2` diff --git a/hn b/hn new file mode 100644 index 00000000..e4c4c8c4 --- /dev/null +++ b/hn @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hn + +> Command-line interface for Hacker News. +> More information: . + +- View stories on Hacker News: + +`hn` + +- View _number_ of stories on Hacker News: + +`hn --limit {{number}}` + +- View stories on Hacker News, and keep the list open after selecting a link: + +`hn --keep-open` + +- View stories on Hacker News sorted by submission date: + +`hn --latest` diff --git a/holehe b/holehe new file mode 100644 index 00000000..3b5aceb1 --- /dev/null +++ b/holehe @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# holehe + +> Check if an email is attached to an account on sites like Twitter, Instagram, Imgur and over 120 others. +> More information: . + +- Show status across all supported websites for the specified email address: + +`holehe {{username@example.org}}` + +- Show status for only sites where the specified email address is in use: + +`holehe {{username@example.org}} --only-used` diff --git a/home-manager b/home-manager new file mode 100644 index 00000000..195bc761 --- /dev/null +++ b/home-manager @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# home-manager + +> Manage a user environment using Nix. +> More information: . + +- Activate the configuration defined in `~/.config/nixpkgs/home.nix`: + +`home-manager build` + +- Activate the configuration and switch to it: + +`home-manager switch` diff --git a/host b/host new file mode 100644 index 00000000..ec1eb1e6 --- /dev/null +++ b/host @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# host + +> Lookup Domain Name Server. +> More information: . + +- Lookup A, AAAA, and MX records of a domain: + +`host {{domain}}` + +- Lookup a field (CNAME, TXT,...) of a domain: + +`host -t {{field}} {{domain}}` + +- Reverse lookup an IP: + +`host {{ip_address}}` + +- Specify an alternate DNS server to query: + +`host {{domain}} {{8.8.8.8}}` diff --git a/hostapd b/hostapd new file mode 100644 index 00000000..23fde5e9 --- /dev/null +++ b/hostapd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hostapd + +> Start an access point using a wireless interface. +> More information: . + +- Start an access point: + +`sudo hostapd {{path/to/hostapd.conf}}` + +- Start an access point, forking into the background: + +`sudo hostapd -B {{path/to/hostapd.conf}}` diff --git a/hostess b/hostess new file mode 100644 index 00000000..224870a4 --- /dev/null +++ b/hostess @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hostess + +> Manage the `/etc/hosts` file. +> More information: . + +- List domains, target IP addresses and on/off status: + +`hostess list` + +- Add a domain pointing to your machine to your hosts file: + +`hostess add {{local.example.com}} {{127.0.0.1}}` + +- Remove a domain from your hosts file: + +`hostess del {{local.example.com}}` + +- Disable a domain (but don't remove it): + +`hostess off {{local.example.com}}` diff --git a/hostid b/hostid new file mode 100644 index 00000000..29766508 --- /dev/null +++ b/hostid @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hostid + +> Prints the numeric identifier for the current host (not necessarily the IP address). +> More information: . + +- Display the numeric identifier for the current host in hexadecimal: + +`hostid` diff --git a/hostname b/hostname new file mode 100644 index 00000000..eabe05d5 --- /dev/null +++ b/hostname @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hostname + +> Show or set the system's host name. +> More information: . + +- Show current host name: + +`hostname` + +- Show the network address of the host name: + +`hostname -i` + +- Show all network addresses of the host: + +`hostname -I` + +- Show the FQDN (Fully Qualified Domain Name): + +`hostname --fqdn` + +- Set current host name: + +`hostname {{new_hostname}}` diff --git a/hping b/hping new file mode 100644 index 00000000..6bbb484a --- /dev/null +++ b/hping @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hping + +> This command is an alias of `hping3`. +> More information: . + +- View documentation for the original command: + +`tldr hping3` diff --git a/hping3 b/hping3 new file mode 100644 index 00000000..022f387e --- /dev/null +++ b/hping3 @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hping3 + +> Advanced ping utility which supports protocols such TCP, UDP, and raw IP. +> Best run with elevated privileges. +> More information: . + +- Ping a destination with 4 ICMP ping requests: + +`hping3 --icmp --count {{4}} {{ip_or_hostname}}` + +- Ping an IP address over UDP on port 80: + +`hping3 --udp --destport {{80}} --syn {{ip_or_hostname}}` + +- Scan TCP port 80, scanning from the specific local source port 5090: + +`hping3 --verbose --syn --destport {{80}} --baseport {{5090}} {{ip_or_hostname}}` + +- Traceroute using a TCP scan to a specific destination port: + +`hping3 --traceroute --verbose --syn --destport {{80}} {{ip_or_hostname}}` + +- Scan a set of TCP ports on a specific IP address: + +`hping3 --scan {{80,3000,9000}} --syn {{ip_or_hostname}}` + +- Perform a TCP ACK scan to check if a given host is alive: + +`hping3 --count {{2}} --verbose --destport {{80}} --ack {{ip_or_hostname}}` + +- Perform a charge test on port 80: + +`hping3 --flood --destport {{80}} --syn {{ip_or_hostname}}` diff --git a/hr b/hr new file mode 100644 index 00000000..bf09d6c6 --- /dev/null +++ b/hr @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hr + +> Print a horizontal rule in the terminal. +> More information: . + +- Print a horizontal rule: + +`hr` + +- Print a horizontal rule with a custom string: + +`hr {{string}}` + +- Print a multiline horizontal rule: + +`hr {{string1 string2 ...}}` diff --git a/hsd-cli b/hsd-cli new file mode 100644 index 00000000..d7bf99d9 --- /dev/null +++ b/hsd-cli @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hsd-cli + +> The command-line REST tool for the Handshake blockchain. +> More information: . + +- Retrieve information about the current server: + +`hsd-cli info` + +- Broadcast a local transaction: + +`hsd-cli broadcast {{transaction_hex}}` + +- Retrieve a mempool snapshot: + +`hsd-cli mempool` + +- View a transaction by address or hash: + +`hsd-cli tx {{address_or_hash}}` + +- View a coin by its hash index or address: + +`hsd-cli coin {{hash_index_or_address}}` + +- View a block by height or hash: + +`hsd-cli block {{height_or_hash}}` + +- Reset the chain to the specified block: + +`hsd-cli reset {{height_or_hash}}` + +- Execute an RPC command: + +`hsd-cli rpc {{command}} {{args}}` diff --git a/hsw-cli b/hsw-cli new file mode 100644 index 00000000..5ca9779c --- /dev/null +++ b/hsw-cli @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hsw-cli + +> The command-line REST tool for the Handshake wallet. +> More information: . + +- Unlock the current wallet (timeout in seconds): + +`hsw-cli unlock {{passphrase}} {{timeout}}` + +- Lock the current wallet: + +`hsw-cli lock` + +- View the current wallet's details: + +`hsw-cli get` + +- View the current wallet's balance: + +`hsw-cli balance` + +- View the current wallet's transaction history: + +`hsw-cli history` + +- Send a transaction with the specified coin amount to an address: + +`hsw-cli send {{address}} {{1.05}}` + +- View the current wallet's pending transactions: + +`hsw-cli pending` + +- View details about a transaction: + +`hsw-cli tx {{transaction_hash}}` diff --git a/html5validator b/html5validator new file mode 100644 index 00000000..c5d5fd07 --- /dev/null +++ b/html5validator @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# html5validator + +> Validate HTML5. +> More information: . + +- Validate a specific file: + +`html5validator {{path/to/file}}` + +- Validate all HTML files in a specific directory: + +`html5validator --root {{path/to/directory}}` + +- Show warnings as well as errors: + +`html5validator --show-warnings {{path/to/file}}` + +- Match multiple files using a glob pattern: + +`html5validator --root {{path/to/directory}} --match "{{*.html *.php}}"` + +- Ignore specific directory names: + +`html5validator --root {{path/to/directory}} --blacklist "{{node_modules vendor}}"` + +- Output the results in a specific format: + +`html5validator --format {{gnu|xml|json|text}} {{path/to/file}}` + +- Output the log at a specific verbosity level: + +`html5validator --root {{path/to/directory}} --log {{debug|info|warning}}` diff --git a/htop b/htop new file mode 100644 index 00000000..a915061d --- /dev/null +++ b/htop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# htop + +> Display dynamic real-time information about running processes. An enhanced version of `top`. +> More information: . + +- Start `htop`: + +`htop` + +- Start `htop` displaying processes owned by a specific user: + +`htop --user {{username}}` + +- Sort processes by a specified `sort_item` (use `htop --sort help` for available options): + +`htop --sort {{sort_item}}` + +- Start `htop` with the specified delay between updates, in tenths of a second (i.e. 50 = 5 seconds): + +`htop --delay {{50}}` + +- See interactive commands while running htop: + +`?` + +- Switch to a different tab: + +`tab` + +- Display help: + +`htop --help` diff --git a/htpasswd b/htpasswd new file mode 100644 index 00000000..51bbb477 --- /dev/null +++ b/htpasswd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# htpasswd + +> Create and manage htpasswd files to protect web server directories using basic authentication. +> More information: . + +- Create/overwrite htpasswd file: + +`htpasswd -c {{path/to/file}} {{username}}` + +- Add user to htpasswd file or update existing user: + +`htpasswd {{path/to/file}} {{username}}` + +- Add user to htpasswd file in batch mode without an interactive password prompt (for script usage): + +`htpasswd -b {{path/to/file}} {{username}} {{password}}` + +- Delete user from htpasswd file: + +`htpasswd -D {{path/to/file}} {{username}}` + +- Verify user password: + +`htpasswd -v {{path/to/file}} {{username}}` + +- Display a string with username (plain text) and password (md5): + +`htpasswd -nbm {{username}} {{password}}` diff --git a/http b/http new file mode 100644 index 00000000..a536e1dc --- /dev/null +++ b/http @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# http + +> HTTPie: HTTP client, aims to be easier to use than cURL. +> More information: . + +- Download a URL to a file: + +`http --download {{example.org}}` + +- Send form-encoded data: + +`http --form {{example.org}} {{name='bob'}} {{profile_picture@'bob.png'}}` + +- Send JSON object: + +`http {{example.org}} {{name='bob'}}` + +- Specify an HTTP method: + +`http {{HEAD}} {{example.org}}` + +- Include an extra header: + +`http {{example.org}} {{X-MyHeader:123}}` + +- Pass a username and password for server authentication: + +`http --auth {{username:password}} {{example.org}}` + +- Specify raw request body via `stdin`: + +`cat {{data.txt}} | http PUT {{example.org}}` diff --git a/http-server b/http-server new file mode 100644 index 00000000..df4c9349 --- /dev/null +++ b/http-server @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# http-server + +> Simple static HTTP server to serve static files. +> More information: . + +- Start an HTTP server listening on the default port to serve the current directory: + +`http-server` + +- Start an HTTP server on a specific port to serve a specific directory: + +`http-server {{path/to/directory}} --port {{port}}` + +- Start an HTTP server using basic authentication: + +`http-server --username {{username}} --password {{password}}` + +- Start an HTTP server with directory listings disabled: + +`http-server -d {{false}}` + +- Start an HTTPS server on the default port using the specified certificate: + +`http-server --ssl --cert {{path/to/cert.pem}} --key {{path/to/key.pem}}` + +- Start an HTTP server and include the client's IP address in the output logging: + +`http-server --log-ip` + +- Start an HTTP server with CORS enabled by including the `Access-Control-Allow-Origin: *` header in all responses: + +`http-server --cors` + +- Start an HTTP server with logging disabled: + +`http-server --silent` diff --git a/http-server-upload b/http-server-upload new file mode 100644 index 00000000..88de2f13 --- /dev/null +++ b/http-server-upload @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# http-server-upload + +> Zero-configuration command-line HTTP server which provides a lightweight interface to upload files. +> More information: . + +- Start an HTTP server on the default port to upload files to the current directory: + +`http-server-upload` + +- Start an HTTP server with the specified maximum allowed file size for uploads in MiB (defaults to 200 MiB): + +`MAX_FILE_SIZE={{size_in_megabytes}} http-server-upload` + +- Start an HTTP server on a specific port to upload files to the current directory: + +`PORT={{port}} http-server-upload` + +- Start an HTTP server, storing the uploaded files in a specific directory: + +`UPLOAD_DIR={{path/to/directory}} http-server-upload` + +- Start an HTTP server using a specific directory to temporarily store files during the upload process: + +`UPLOAD_TMP_DIR={{path/to/directory}} http-server-upload` + +- Start an HTTP server accepting uploads with a specific token field in the HTTP post: + +`TOKEN={{secret}} http-server-upload` diff --git a/httpflow b/httpflow new file mode 100644 index 00000000..363b57a2 --- /dev/null +++ b/httpflow @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# httpflow + +> A command-line utility to capture and dump HTTP streams. +> More information: . + +- Capture traffic on all interfaces: + +`httpflow -i {{any}}` + +- Use a bpf-style capture to filter the results: + +`httpflow {{host httpbin.org or host baidu.com}}` + +- Use a regular expression to filter requests by URLs: + +`httpflow -u '{{regular_expression}}'` + +- Read packets from pcap format binary file: + +`httpflow -r {{out.cap}}` + +- Write the output to a directory: + +`httpflow -w {{path/to/directory}}` diff --git a/httping b/httping new file mode 100644 index 00000000..d8aba754 --- /dev/null +++ b/httping @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# httping + +> Measure the latency and throughput of a web server. +> More information: . + +- Ping the specified URL: + +`httping -g {{url}}` + +- Ping the web server on `host` and `port`: + +`httping -h {{host}} -p {{port}}` + +- Ping the web server on `host` using a TLS connection: + +`httping -l -g https://{{host}}` + +- Ping the web server on `host` using HTTP basic authentication: + +`httping -g http://{{host}} -U {{username}} -P {{password}}` diff --git a/httprobe b/httprobe new file mode 100644 index 00000000..01957703 --- /dev/null +++ b/httprobe @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# httprobe + +> Take a list of domains and probe for working HTTP and HTTPS servers. +> More information: . + +- Probe a list of domains from a text file: + +`cat {{input_file}} | httprobe` + +- Only check for HTTP if HTTPS is not working: + +`cat {{input_file}} | httprobe --prefer-https` + +- Probe additional ports with a given protocol: + +`cat {{input_file}} | httprobe -p {{https:2222}}` + +- Display help: + +`httprobe --help` diff --git a/httpry b/httpry new file mode 100644 index 00000000..6d33d296 --- /dev/null +++ b/httpry @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# httpry + +> A lightweight packet sniffer for displaying and logging HTTP traffic. +> It can be run in real-time displaying the traffic as it is parsed, or as a daemon process that logs to an output file. +> More information: . + +- Save output to a file: + +`httpry -o {{path/to/file.log}}` + +- Listen on a specific interface and save output to a binary pcap format file: + +`httpry {{eth0}} -b {{path/to/file.pcap}}` + +- Filter output by a comma-separated list of HTTP verbs: + +`httpry -m {{get|post|put|head|options|delete|trace|connect|patch}}` + +- Read from an input capture file and filter by IP: + +`httpry -r {{path/to/file.log}} '{{host 192.168.5.25}}'` + +- Run as daemon process: + +`httpry -d -o {{path/to/file.log}}` diff --git a/httpx b/httpx new file mode 100644 index 00000000..0ec52e26 --- /dev/null +++ b/httpx @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# httpx + +> A fast and multi-purpose HTTP toolkit written in Go to run multiple probes at once. +> Note: not to be confused with the unrelated Python's HTTPX which has the same command name. +> More information: . + +- Run a probe against a [u]RL, host, IP Address or subnet (CIDR notation) showing probe status: + +`httpx -probe -u {{url|host|ipaddress|subnet_with_cidr}}` + +- Run a probe against multiple hosts showing [s]tatus [c]ode with input from `subfinder`: + +`subfinder -d {{example.com}} | httpx -sc` + +- Run a [r]ate [l]imited probe against a [l]ist of hosts from a file showing [t]echnology [d]etected and [r]esponse [t]ime: + +`httpx -rl {{150}} -l {{path/to/newline_separated_hosts_list}} -td -rt` + +- Run a probe against a [u]RL showing its webpage title, CDN/WAF in use, and page content hash: + +`httpx -u {{url}} -title -cdn -hash {{sha256}}` + +- Run a probe against a list of hosts with custom defined [p]orts and timeout after certain seconds: + +`httpx -probe -u {{host1,host2,...}} -p http:{{80,8000-8080}},https:{{443,8443}} -timeout {{10}}` + +- Run a probe against a list of hosts [f]iltering out [c]odes of certain responses: + +`httpx -u {{host1,host2,...}} -fc {{400,401,404}}` + +- Run a probe against a list of hosts [m]atching [c]odes of certain responses: + +`httpx -u {{host1,host2,...}} -mc {{200,301,304}}` + +- Run a probe against a URL [s]aving [s]creenshots of certain paths, with [s]creenshot [t]imeouts (assets are saved in `./output`): + +`httpx -u {{https://www.github.com}} -path {{/tldr-pages/tldr,/projectdiscovery/httpx}} -ss -st {{10}}` diff --git a/hub b/hub new file mode 100644 index 00000000..4a7b83fb --- /dev/null +++ b/hub @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub + +> A wrapper for Git that adds commands for working with GitHub-based projects. +> If set up as instructed by `hub alias`, one can use `git` to run `hub` commands. +> More information: . + +- Clone a repository using its slug (owners can omit the username): + +`hub clone {{username}}/{{repo_name}}` + +- Create a fork of the current repository (cloned from another user) under your GitHub profile: + +`hub fork` + +- Push the current local branch to GitHub and create a PR for it in the original repository: + +`hub push {{remote_name}} && hub pull-request` + +- Create a PR of the current (already pushed) branch, reusing the message from the first commit: + +`hub pull-request --no-edit` + +- Create a new branch with the contents of a pull request and switch to it: + +`hub pr checkout {{pr_number}}` + +- Upload the current (local-only) repository to your GitHub account: + +`hub create` + +- Fetch Git objects from upstream and update local branches: + +`hub sync` diff --git a/hub-branch b/hub-branch new file mode 100644 index 00000000..dd77805d --- /dev/null +++ b/hub-branch @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub branch + +> Create a branch or show current branch. +> See also `git branch`. + +- Show the name of the currently active branch: + +`hub branch` + +- Create a new branch: + +`hub branch {{branch_name}}` diff --git a/hub-browse b/hub-browse new file mode 100644 index 00000000..c01fbf38 --- /dev/null +++ b/hub-browse @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub browse + +> Open a GitHub repository in the browser or print the URL. +> More information: . + +- Open the homepage of the current repository in the default web browser: + +`hub browse` + +- Open the homepage of a specific repository in the default web browser: + +`hub browse {{owner}}/{{repository}}` + +- Open the subpage of a specific repository in the default web browser, subpage can be "wiki", "commits", "issues", or other (default: "tree"): + +`hub browse {{owner}}/{{repository}} {{subpage}}` diff --git a/hub-ci-status b/hub-ci-status new file mode 100644 index 00000000..018c6ceb --- /dev/null +++ b/hub-ci-status @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub ci-status + +> Display status of GitHub checks. +> More information: . + +- Check the CI status for this branch: + +`hub ci-status --verbose` + +- Display status of GitHub checks for a commit: + +`hub ci-status --verbose {{commit_SHA}}` diff --git a/hub-clone b/hub-clone new file mode 100644 index 00000000..8f2cd4c0 --- /dev/null +++ b/hub-clone @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub clone + +> Clone an existing repository. +> More information: . + +- Clone an existing repository to current directory (If run into authentication problem, try full ssh path): + +`hub clone {{remote_repository_location}}` diff --git a/hub-create b/hub-create new file mode 100644 index 00000000..20d0f693 --- /dev/null +++ b/hub-create @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub create + +> Create a new repository on GitHub. +> More information: . + +- Upload the current (local-only) repository to your GitHub account as public: + +`hub create` + +- Create a private repository and open the new repository in a web browser: + +`hub create --private --browse` diff --git a/hub-delete b/hub-delete new file mode 100644 index 00000000..b63062e1 --- /dev/null +++ b/hub-delete @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub delete + +> Delete an existing repository on GitHub. +> More information: . + +- Delete personal repo on GitHub: + +`hub delete {{repo}}` diff --git a/hub-fork b/hub-fork new file mode 100644 index 00000000..374c1dcb --- /dev/null +++ b/hub-fork @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub fork + +> Fork a GitHub repo. Like `git fork` from `git-extras`. +> More information: . + +- Fork a GitHub repository by its slug: + +`hub fork {{tldr-pages/tldr}}` + +- Fork a GitHub repository by its URL: + +`hub fork {{https://github.com/tldr-pages/tldr}}` + +- Fork current GitHub repository, set remote name to origin: + +`hub fork --remote-name {{origin}}` diff --git a/hub-init b/hub-init new file mode 100644 index 00000000..06014275 --- /dev/null +++ b/hub-init @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub init + +> Initializes a new local Git repository. +> More information: . + +- Initialize a new local repository: + +`hub init` diff --git a/hub-issue b/hub-issue new file mode 100644 index 00000000..63014748 --- /dev/null +++ b/hub-issue @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hub issue + +> Manage Github issues. +> More information: . + +- List the last 10 issues with the `bug` label: + +`hub issue list --limit {{10}} --labels "{{bug}}"` + +- Display a specific issue: + +`hub issue show {{issue_number}}` + +- List 10 closed issues assigneed to a specific user: + +`hub issue --state {{closed}} --assignee {{username}} --limit {{10}}` diff --git a/hugo b/hugo new file mode 100644 index 00000000..292c981c --- /dev/null +++ b/hugo @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hugo + +> Template-based static site generator. Uses modules, components, and themes. +> More information: . + +- Create a new Hugo site: + +`hugo new site {{path/to/site}}` + +- Create a new Hugo theme (themes may also be downloaded from ): + +`hugo new theme {{theme_name}}` + +- Create a new page: + +`hugo new {{section_name}}/{{page_name}}` + +- Build a site to the `./public/` directory: + +`hugo` + +- Build a site including pages that are marked as a "draft": + +`hugo --buildDrafts` + +- Build a site on your local IP: + +`hugo server --bind {{local-ip}} --baseURL {{http://local-ip}}` + +- Build a site to a given directory: + +`hugo --destination {{path/to/destination}}` + +- Build a site, start up a webserver to serve it, and automatically reload when pages are edited: + +`hugo server` diff --git a/hunspell b/hunspell new file mode 100644 index 00000000..b80be67c --- /dev/null +++ b/hunspell @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hunspell + +> Check spelling. +> More information: . + +- Check the spelling of a file: + +`hunspell {{path/to/file}}` + +- Check the spelling of a file with the en_US dictionary: + +`hunspell -d {{en_US}} {{path/to/file}}` + +- List misspelled words in a file: + +`hunspell -l {{path/to/file}}` diff --git a/husky b/husky new file mode 100644 index 00000000..ff0936e1 --- /dev/null +++ b/husky @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# husky + +> Native Git hooks made easy. +> More information: . + +- Install Husky in the current directory: + +`husky install` + +- Install Husky into a specific directory: + +`husky install {{path/to/directory}}` + +- Set a specific command as a `pre-push` hook for Git: + +`husky set {{.husky/pre-push}} "{{command}} {{command_arguments}}"` + +- Add a specific command to the current `pre-commit` hook: + +`husky add {{.husky/pre-commit}} "{{command}} {{command_arguments}}"` + +- Uninstall Husky hooks from the current directory: + +`husky uninstall` + +- Display help: + +`husky` diff --git a/hut b/hut new file mode 100644 index 00000000..2caeb93e --- /dev/null +++ b/hut @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hut + +> A CLI tool for sourcehut. +> More information: . + +- Initialize `hut`'s configuration file (this will prompt for an OAuth2 access token, which is required to use `hut`): + +`hut init` + +- List Git/Mercurial repositories: + +`hut {{git|hg}} list` + +- Create a public Git/Mercurial repository: + +`hut {{git|hg}} create {{name}}` + +- List jobs on : + +`hut builds list` + +- Show the status of a job: + +`hut builds show {{job_id}}` + +- SSH into a job container: + +`hut ssh {{job_id}}` diff --git a/hx b/hx new file mode 100644 index 00000000..71790ecf --- /dev/null +++ b/hx @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hx + +> This command is an alias of `helix`. + +- View documentation for the original command: + +`tldr helix` diff --git a/hydra b/hydra new file mode 100644 index 00000000..17321c1b --- /dev/null +++ b/hydra @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hydra + +> Online password guessing tool. +> Protocols supported include FTP, HTTP(S), SMTP, SNMP, XMPP, SSH, and more. +> More information: . + +- Start Hydra's wizard: + +`hydra-wizard` + +- Guess SSH credentials using a given username and a list of passwords: + +`hydra -l {{username}} -P {{path/to/wordlist.txt}} {{host_ip}} {{ssh}}` + +- Guess HTTPS webform credentials using two specific lists of usernames and passwords ("https_post_request" can be like "username=^USER^&password=^PASS^"): + +`hydra -L {{path/to/usernames.txt}} -P {{path/to/wordlist.txt}} {{host_ip}} {{https-post-form}} "{{url_without_host}}:{{https_post_request}}:{{login_failed_string}}"` + +- Guess FTP credentials using usernames and passwords lists, specifying the number of threads: + +`hydra -L {{path/to/usernames.txt}} -P {{path/to/wordlist.txt}} -t {{n_tasks}} {{host_ip}} {{ftp}}` + +- Guess MySQL credentials using a username and a passwords list, exiting when a username/password pair is found: + +`hydra -l {{username}} -P {{path/to/wordlist.txt}} -f {{host_ip}} {{mysql}}` + +- Guess RDP credentials using a username and a passwords list, showing each attempt: + +`hydra -l {{username}} -P {{path/to/wordlist.txt}} -V {{rdp://host_ip}}` + +- Guess IMAP credentials on a range of hosts using a list of colon-separated username/password pairs: + +`hydra -C {{path/to/username_password_pairs.txt}} {{imap://[host_range_cidr]}}` + +- Guess POP3 credentials on a list of hosts using usernames and passwords lists, exiting when a username/password pair is found: + +`hydra -L {{path/to/usernames.txt}} -P {{path/to/wordlist.txt}} -M {{path/to/hosts.txt}} -F {{pop3}}` diff --git a/hyperfine b/hyperfine new file mode 100644 index 00000000..54bd98f2 --- /dev/null +++ b/hyperfine @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# hyperfine + +> A command-line benchmarking tool. +> More information: . + +- Run a basic benchmark, performing at least 10 runs: + +`hyperfine '{{make}}'` + +- Run a comparative benchmark: + +`hyperfine '{{make target1}}' '{{make target2}}'` + +- Change minimum number of benchmarking runs: + +`hyperfine --min-runs {{7}} '{{make}}'` + +- Perform benchmark with warmup: + +`hyperfine --warmup {{5}} '{{make}}'` + +- Run a command before each benchmark run (to clear caches, etc.): + +`hyperfine --prepare '{{make clean}}' '{{make}}'` + +- Run a benchmark where a single parameter changes for each run: + +`hyperfine --prepare '{{make clean}}' --parameter-scan {{num_threads}} {{1}} {{10}} '{{make -j {num_threads}}}'` diff --git a/ia b/ia new file mode 100644 index 00000000..8ae51c96 --- /dev/null +++ b/ia @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ia + +> Command-line tool to interact with `archive.org`. +> More information: . + +- Configure `ia` with API keys (some functions won't work without this step): + +`ia configure` + +- Upload one or more items to `archive.org`: + +`ia upload {{identifier}} {{path/to/file}} --metadata="{{mediatype:data}}" --metadata="{{title:example}}"` + +- Download one or more items from `archive.org`: + +`ia download {{item}}` + +- Delete one or more items from `archive.org`: + +`ia delete {{identifier}} {{file}}` + +- Search on `archive.org`, returning results as JSON: + +`ia search '{{subject:"subject" collection:collection}}'` diff --git a/ibmcloud b/ibmcloud new file mode 100644 index 00000000..58f7414a --- /dev/null +++ b/ibmcloud @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ibmcloud + +> A command-line tool for managing IBM Cloud apps and services. +> More information: . + +- Update `ibmcloud` to the latest version: + +`ibmcloud update` + +- Install the Cloud Foundry module for accessing Cloud Foundry services: + +`ibmcloud cf install` + +- List all available IBM Cloud regions: + +`ibmcloud regions` + +- Display help: + +`ibmcloud help` + +- Display help for a subcommand: + +`ibmcloud help {{subcommand}}` + +- Display version: + +`ibmcloud version` diff --git a/ibmcloud-login b/ibmcloud-login new file mode 100644 index 00000000..a0079590 --- /dev/null +++ b/ibmcloud-login @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ibmcloud login + +> Log in to the IBM Cloud. +> More information: . + +- Log in by using an interactive prompt: + +`ibmcloud login` + +- Log in to a specific API endpoint (default is `cloud.ibm.com`): + +`ibmcloud login -a {{api_endpoint}}` + +- Log in by providing username, password and the targeted region as parameters: + +`ibmcloud login -u {{username}} -p {{password}} -r {{us-south}}` + +- Log in with an API key, passing it as an argument: + +`ibmcloud login --apikey {{api_key_string}}` + +- Log in with an API key, passing it as a file: + +`ibmcloud login --apikey @{{path/to/api_key_file}}` + +- Log in with a federated ID (single sign-on): + +`ibmcloud login --sso` diff --git a/ical b/ical new file mode 100644 index 00000000..1b76b3cf --- /dev/null +++ b/ical @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ical + +> A Hirji/Islamic calendar and converter for the terminal. +> More information: . + +- Display the current month's calendar: + +`ical` + +- Convert a Gregorian date to a Hijri date: + +`ical --gregorian {{yyyymmdd}}` + +- Convert a Hirji date to a Gregorian date: + +`ical --hijri {{yyyymmdd}}` diff --git a/iconv b/iconv new file mode 100644 index 00000000..f2008f57 --- /dev/null +++ b/iconv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iconv + +> Converts text from one encoding to another. +> More information: . + +- Convert file to a specific encoding, and print to `stdout`: + +`iconv -f {{from_encoding}} -t {{to_encoding}} {{input_file}}` + +- Convert file to the current locale's encoding, and output to a file: + +`iconv -f {{from_encoding}} {{input_file}} > {{output_file}}` + +- List supported encodings: + +`iconv -l` diff --git a/id b/id new file mode 100644 index 00000000..29278891 --- /dev/null +++ b/id @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# id + +> Display current user and group identity. +> More information: . + +- Display current user's ID (UID), group ID (GID) and groups to which they belong: + +`id` + +- Display the current user identity as a number: + +`id -u` + +- Display the current group identity as a number: + +`id -g` + +- Display an arbitrary user's ID (UID), group ID (GID) and groups to which they belong: + +`id {{username}}` diff --git a/id3tag b/id3tag new file mode 100644 index 00000000..76eec2e1 --- /dev/null +++ b/id3tag @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# id3tag + +> Read, write, and manipulate ID3v1 and ID3v2 tags of MP3 files. +> More information: . + +- Set artist and song title tag of an MP3 file: + +`id3tag --artist {{artist}} --song {{song_title}} {{path/to/file.mp3}}` + +- Set album title of all MP3 files in the current directory: + +`id3tag --album={{album}} {{*.mp3}}` + +- Display help: + +`id3tag --help` diff --git a/idea b/idea new file mode 100644 index 00000000..61aa66f6 --- /dev/null +++ b/idea @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# idea + +> JetBrains Java and Kotlin IDE. +> More information: . + +- Open the current directory in IntelliJ IDEA: + +`idea {{path/to/directory}}` + +- Open a specific file or directory in IntelliJ IDEA: + +`idea {{path/to/file_or_directory}}` + +- Open the diff viewer to compare up to 3 files: + +`idea diff {{path/to/file1 path/to/file2 path/to/optional_file3}}` + +- Open the merge dialog to perform a two-way file merge: + +`idea merge {{path/to/file1}} {{path/to/file2}} {{path/to/output}}` + +- Run code inspections on a project: + +`idea inspect {{path/to/project_directory}} {{path/to/inspection_profile}} {{path/to/output}}` diff --git a/identify b/identify new file mode 100644 index 00000000..ee91f678 --- /dev/null +++ b/identify @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# identify + +> Describe the format and characteristics of image files. +> Part of ImageMagick. +> More information: . + +- Describe the format and basic characteristics of an image: + +`identify {{path/to/image}}` + +- Describe the format and verbose characteristics of an image: + +`identify -verbose {{path/to/image}}` + +- Collect dimensions of all JPEG files in the current directory and save them into a CSV file: + +`identify -format "{{%f,%w,%h +}}" {{*.jpg}} > {{path/to/filelist.csv}}` diff --git a/idnits b/idnits new file mode 100644 index 00000000..70ace0d8 --- /dev/null +++ b/idnits @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# idnits + +> Check internet-drafts for submission nits. +> Looks for violations of Section 2.1 and 2.2 of the requirements listed on . +> More information: . + +- Check a file for nits: + +`idnits {{path/to/file.txt}}` + +- Count nits without displaying them: + +`idnits --nitcount {{path/to/file.txt}}` + +- Show extra information about offending lines: + +`idnits --verbose {{path/to/file.txt}}` + +- Expect the specified year in the boilerplate instead of the current year: + +`idnits --year {{2021}} {{path/to/file.txt}}` + +- Assume the document is of the specified status: + +`idnits --doctype {{standard|informational|experimental|bcp|ps|ds}} {{path/to/file.txt}}` diff --git a/iex b/iex new file mode 100644 index 00000000..f53ba85b --- /dev/null +++ b/iex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iex + +> IEx is the interactive shell for Elixir. +> More information: . + +- Start an interactive session: + +`iex` + +- Start a session that remembers history: + +`iex --erl "-kernel shell_history enabled"` + +- Start and load Mix project files: + +`iex -S mix` diff --git a/if b/if new file mode 100644 index 00000000..3c495490 --- /dev/null +++ b/if @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# if + +> Performs conditional processing in shell scripts. +> See also: `test`, `[`. +> More information: . + +- Execute the specified commands if the condition command's exit status is zero: + +`if {{condition_command}}; then {{echo "Condition is true"}}; fi` + +- Execute the specified commands if the condition command's exit status is not zero: + +`if ! {{condition_command}}; then {{echo "Condition is true"}}; fi` + +- Execute the first specified commands if the condition command's exit status is zero otherwise execute the second specified commands: + +`if {{condition_command}}; then {{echo "Condition is true"}}; else {{echo "Condition is false"}}; fi` + +- Check whether a [f]ile exists: + +`if [[ -f {{path/to/file}} ]]; then {{echo "Condition is true"}}; fi` + +- Check whether a [d]irectory exists: + +`if [[ -d {{path/to/directory}} ]]; then {{echo "Condition is true"}}; fi` + +- Check whether a file or directory [e]xists: + +`if [[ -e {{path/to/file_or_directory}} ]]; then {{echo "Condition is true"}}; fi` + +- Check whether a variable is defined: + +`if [[ -n "${{variable}}" ]]; then {{echo "Condition is true"}}; fi` + +- List all possible conditions (`test` is an alias to `[`; both are commonly used with `if`): + +`man [` diff --git a/ifconfig b/ifconfig new file mode 100644 index 00000000..e29b66ab --- /dev/null +++ b/ifconfig @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ifconfig + +> Network Interface Configurator. +> More information: . + +- View network settings of an Ethernet adapter: + +`ifconfig eth0` + +- Display details of all interfaces, including disabled interfaces: + +`ifconfig -a` + +- Disable eth0 interface: + +`ifconfig eth0 down` + +- Enable eth0 interface: + +`ifconfig eth0 up` + +- Assign IP address to eth0 interface: + +`ifconfig eth0 {{ip_address}}` diff --git a/ifdata b/ifdata new file mode 100644 index 00000000..0da67839 --- /dev/null +++ b/ifdata @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ifdata + +> Display information about a network interface. +> More information: . + +- Display the whole configuration of the specified interface: + +`ifdata -p {{eth0}}` + +- Indicate the [e]xistence of the specified interface via the exit code: + +`ifdata -e {{eth0}}` + +- Display the IPv4 [a]dress and the [n]etmask of the specified interface: + +`ifdata -pa -pn {{eth0}}` + +- Display the [N]etwork adress, the [b]roadcast adress, and the MTU of the specified interface: + +`ifdata -pN -pb -pm {{eth0}}` + +- Display help: + +`ifdata` diff --git a/ifne b/ifne new file mode 100644 index 00000000..a76aabd7 --- /dev/null +++ b/ifne @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ifne + +> Run a command depending on the emptyness of `stdin`. +> More information: . + +- Run the specified command if and only if `stdin` is not empty: + +`ifne {{command options ...}}` + +- Run the specified command if and only if `stdin` is empty, otherwise pass `stdin` to `stdout`: + +`ifne -n {{command options ...}}` diff --git a/ifs b/ifs new file mode 100644 index 00000000..5feb64ae --- /dev/null +++ b/ifs @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# IFS + +> 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: . + +- View the current IFS value: + +`echo "$IFS"` + +- Change the IFS value: + +`IFS="{{:}}"` + +- Reset IFS to default: + +`IFS=$' +'` + +- Temporarily change the IFS value in a subshell: + +`(IFS="{{:}}"; echo "{{one:two:three}}")` diff --git a/ignite b/ignite new file mode 100644 index 00000000..e66ff9fe --- /dev/null +++ b/ignite @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ignite + +> A CLI for React Native boilerplates, plugins, generators, and more. +> More information: . + +- Create a new React Native project: + +`ignite new {{project_name}}` + +- Generate file from a plugin: + +`ignite generate {{plugin_name}} {{path/to/file}}` + +- Add an Ignite plugin to the project: + +`ignite add {{plugin_name}}` + +- Remove an Ignite plugin from the project: + +`ignite remove {{plugin_name}}` diff --git a/ilbmtoppm b/ilbmtoppm new file mode 100644 index 00000000..98846ad4 --- /dev/null +++ b/ilbmtoppm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ilbmtoppm + +> Convert an ILBM file to a PPM image. +> More information: . + +- Convert an ILBM file to a PPM image: + +`ilbmtoppm {{path/to/file.ilbm}} > {{path/to/file.ppm}}` + +- Use the specified color to "show through" where the image is transparent: + +`ilbmtoppm -transparent {{color}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` + +- Ignore the chunk with the specified chunk ID: + +`ilbmtoppm -ignore {{chunkID}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` + +- Store the input's transparency information to the specified PBM file: + +`ilbmtoppm -maskfile {{path/to/maskfile.pbm}} {{path/to/file.ilbm}} > {{path/to/file.ppm}}` diff --git a/imapsync b/imapsync new file mode 100644 index 00000000..9590c9cd --- /dev/null +++ b/imapsync @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# imapsync + +> Email IMAP tool for syncing, copying and migrating email mailboxes between two IMAP servers, one way, and without duplicates. +> More information: . + +- Synchronize IMAP account between host1 and host2: + +`imapsync --host1 {{host1}} --user1 {{user1}} --password1 {{secret1}} --host2 {{host2}} --user2 {{user2}} --password2 {{secret2}}` diff --git a/img2pdf b/img2pdf new file mode 100644 index 00000000..9171890d --- /dev/null +++ b/img2pdf @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# img2pdf + +> Losslessly convert raster images to a PDF file. +> Some supported image formats are: GIF, JPEG, JPEG2000, PNG, GIF and TIFF. +> More information: . + +- Convert one or more images to a single PDF, each image being on its own page: + +`img2pdf {{path/to/image1.ext path/to/image2.ext ...}} --output {{path/to/file.pdf}}` + +- Convert only the first frame of a multi-frame image to PDF: + +`img2pdf {{path/to/file.gif}} --first-frame-only --output {{path/to/file.pdf}}` + +- Auto orient the image, use a specific page size in landscape mode, and set a border of specific sizes horizontally and vertically: + +`img2pdf {{path/to/image.ext}} --auto-orient --pagesize {{A4^T}} --border {{2cm}}:{{5.1cm}} --output {{path/to/file.pdf}}` + +- Shrink only larger images to a rectangle of specified dimensions inside a page with a specific size: + +`img2pdf {{path/to/image.ext}} --pagesize {{30cm}}x{{20cm}} --imgsize {{10cm}}x{{15cm}} --fit {{shrink}} --output {{path/to/file.pdf}}` + +- Convert an image to PDF, and specify metadata for the resulting file: + +`img2pdf {{path/to/image.ext}} --title {{title}} --author {{author}} --creationdate {{1970-01-31}} --keywords {{keyword1 keyword2}} --subject {{subject}} --output {{path/to/file.pdf}}` diff --git a/imgcat b/imgcat new file mode 100644 index 00000000..5c3b056c --- /dev/null +++ b/imgcat @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# imgcat + +> Display images on the command-line. +> Requires a compatible terminal such as iTerm2. +> More information: . + +- Display an image on the command-line: + +`imgcat {{path/to/file}}` diff --git a/imgtoppm b/imgtoppm new file mode 100644 index 00000000..99bf7734 --- /dev/null +++ b/imgtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# imgtoppm + +> Converts various image file formats to the PPM (Portable Pixmap) format. +> More information: . + +- Convert an input image to PPM format: + +`imgtoppm {{path/to/input}} > {{path/to/output.ppm}}` + +- Display version: + +`imgtoppm -version` diff --git a/import b/import new file mode 100644 index 00000000..3609ecaa --- /dev/null +++ b/import @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# import + +> Capture some or all of an X server screen, and save the image to a file. +> Part of ImageMagick. +> More information: . + +- Capture the entire X server screen into a PostScript file: + +`import -window root {{path/to/output.ps}}` + +- Capture contents of a remote X server screen into a PNG image: + +`import -window root -display {{remote_host}}:{{screen}}.{{display}} {{path/to/output.png}}` + +- Capture a specific window given its ID as displayed by `xwininfo` into a JPEG image: + +`import -window {{window_id}} {{path/to/output.jpg}}` diff --git a/in-toto-record b/in-toto-record new file mode 100644 index 00000000..d225724d --- /dev/null +++ b/in-toto-record @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# in-toto-record + +> Create a signed link metadata file to provide evidence for supply chain steps. +> More information: . + +- Start the record (creates a preliminary link file): + +`in-toto-record start -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -m {{.}}` + +- Stop the record (expects a preliminary link file): + +`in-toto-record stop -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -p {{.}}` diff --git a/in-toto-run b/in-toto-run new file mode 100644 index 00000000..8e522e8a --- /dev/null +++ b/in-toto-run @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# in-toto-run + +> Generating link metadata while carrying out a supply chain step. +> More information: . + +- Tag a Git repo and signing the resulting link file: + +`in-toto-run -n {{tag}} --products {{.}} -k {{key_file}} -- {{git tag v1.0}}` + +- Create a tarball, storing files as materials and the tarball as product: + +`in-toto-run -n {{package}} -m {{project}} -p {{project.tar.gz}} -- {{tar czf project.tar.gz project}}` + +- Generate signed attestations for review work: + +`in-toto-run -n {{review}} -k {{key_file}} -m {{document.pdf}} -x` + +- Scan the image using Trivy and generate link file: + +`in-toto-run -n {{scan}} -k {{key_file}} -p {{report.json}} -- {{/bin/sh -c "trivy -o report.json -f json "}}` diff --git a/in-toto-sign b/in-toto-sign new file mode 100644 index 00000000..876c902a --- /dev/null +++ b/in-toto-sign @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# in-toto-sign + +> Sign in-toto link or layout metadata or verify their signatures. +> More information: . + +- Sign 'unsigned.layout' with two keys and write it to 'root.layout': + +`in-toto-sign -f {{unsigned.layout}} -k {{priv_key1}} {{priv_key2}} -o {{root.layout}}` + +- Replace signature in link file and write to default filename: + +`in-toto-sign -f {{package.2f89b927.link}} -k {{priv_key}}` + +- Verify a layout signed with 3 keys: + +`in-toto-sign -f {{root.layout}} -k {{pub_key0}} {{pub_key1}} {{pub_key2}} --verify` + +- Sign a layout with the default GPG key in default GPG keyring: + +`in-toto-sign -f {{root.layout}} --gpg` + +- Verify a layout with a GPG key identified by keyid '...439F3C2': + +`in-toto-sign -f {{root.layout}} --verify --gpg {{...439F3C2}}` diff --git a/in2csv b/in2csv new file mode 100644 index 00000000..45929006 --- /dev/null +++ b/in2csv @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# in2csv + +> Converts various tabular data formats into CSV. +> Included in csvkit. +> More information: . + +- Convert an XLS file to CSV: + +`in2csv {{data.xls}}` + +- Convert a DBF file to a CSV file: + +`in2csv {{data.dbf}} > {{data.csv}}` + +- Convert a specific sheet from an XLSX file to CSV: + +`in2csv --sheet={{sheet_name}} {{data.xlsx}}` + +- Pipe a JSON file to in2csv: + +`cat {{data.json}} | in2csv -f json > {{data.csv}}` diff --git a/indent b/indent new file mode 100644 index 00000000..c5ebde92 --- /dev/null +++ b/indent @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# indent + +> Change the appearance of a C/C++ program by inserting or deleting whitespace. +> More information: . + +- Format C/C++ source according to the Linux style guide, automatically back up the original files, and replace with the indented versions: + +`indent --linux-style {{path/to/source.c}} {{path/to/another_source.c}}` + +- Format C/C++ source according to the GNU style, saving the indented version to a different file: + +`indent --gnu-style {{path/to/source.c}} -o {{path/to/indented_source.c}}` + +- Format C/C++ source according to the style of Kernighan & Ritchie (K&R), no tabs, 3 spaces per indent, and wrap lines at 120 characters: + +`indent --k-and-r-style --indent-level3 --no-tabs --line-length120 {{path/to/source.c}} -o {{path/to/indented_source.c}}` diff --git a/infection b/infection new file mode 100644 index 00000000..f0977ea4 --- /dev/null +++ b/infection @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# infection + +> A mutation testing framework for PHP. +> More information: . + +- Analyze code using the configuration file (or create one if it does not exist): + +`infection` + +- Use a specific number of threads: + +`infection --threads {{number_of_threads}}` + +- Specify a minimum Mutation Score Indicator (MSI): + +`infection --min-msi {{percentage}}` + +- Specify a minimum covered code MSI: + +`infection --min-covered-msi {{percentage}}` + +- Use a specific test framework (defaults to PHPUnit): + +`infection --test-framework {{phpunit|phpspec}}` + +- Only mutate lines of code that are covered by tests: + +`infection --only-covered` + +- Display the mutation code that has been applied: + +`infection --show-mutations` + +- Specify the log verbosity: + +`infection --log-verbosity {{default|all|none}}` diff --git a/influx b/influx new file mode 100644 index 00000000..66781a0f --- /dev/null +++ b/influx @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# influx + +> InfluxDB command-line client. +> More information: . + +- Connect to an InfluxDB running on localhost with no credentials: + +`influx` + +- Connect with a specific username (will prompt for a password): + +`influx -username {{username}} -password ""` + +- Connect to a specific host: + +`influx -host {{hostname}}` + +- Use a specific database: + +`influx -database {{database_name}}` + +- Execute a given command: + +`influx -execute "{{influxql_command}}"` + +- Return output in a specific format: + +`influx -execute "{{influxql_command}}" -format {{json|csv|column}}` diff --git a/info b/info new file mode 100644 index 00000000..d8fa2548 --- /dev/null +++ b/info @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# info + +> Reads documentation stored in the info format. +> More information: . + +- Start reading top-level directory menu: + +`info` + +- Start reading at given menu item node from top-level directory: + +`info {{menu_item}}` + +- Start reading at second menu item within first menu item manual: + +`info {{first_menu_item}} {{second_menu_item}}` diff --git a/initdb b/initdb new file mode 100644 index 00000000..29cb8be2 --- /dev/null +++ b/initdb @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# initdb + +> Create a PostgreSQL database on disk. +> More information: . + +- Create a database at `/usr/local/var/postgres`: + +`initdb -D /usr/local/var/postgres` diff --git a/inkmake b/inkmake new file mode 100644 index 00000000..ffee30ec --- /dev/null +++ b/inkmake @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# inkmake + +> GNU Makefile-style SVG exporting using Inkscape's backend. +> More information: . + +- Export an SVG file executing the specified Inkfile: + +`inkmake {{path/to/Inkfile}}` + +- Execute an Inkfile and show detailed information: + +`inkmake --verbose {{path/to/Inkfile}}` + +- Execute an Inkfile, specifying SVG input file(s) and an output file: + +`inkmake --svg {{path/to/file.svg}} --out {{path/to/output_image}} {{path/to/Inkfile}}` + +- Use a custom Inkscape binary as the backend: + +`inkmake --inkscape {{/Applications/Inkscape.app/Contents/Resources/bin/inkscape}} {{path/to/Inkfile}}` + +- Display help: + +`inkmake --help` diff --git a/inkscape b/inkscape new file mode 100644 index 00000000..76ceac19 --- /dev/null +++ b/inkscape @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# inkscape + +> An SVG (Scalable Vector Graphics) editing program. +> For Inkscape versions up to 0.92.x, use -e instead of -o. +> More information: . + +- Open an SVG file in the Inkscape GUI: + +`inkscape {{path/to/filename.svg}}` + +- Export an SVG file into a bitmap with the default format (PNG) and the default resolution (96 DPI): + +`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}}` + +- Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur): + +`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -w {{600}} -h {{400}}` + +- Export the drawing (bounding box of all objects) of an SVG file into a bitmap: + +`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -D` + +- Export a single object, given its ID, into a bitmap: + +`inkscape {{path/to/filename.svg}} -i {{id}} -o {{object.png}}` + +- Export an SVG document to PDF, converting all texts to paths: + +`inkscape {{path/to/filename.svg}} -o {{path/to/filename.pdf}} --export-text-to-path` + +- Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape: + +`inkscape {{path/to/filename.svg}} --select=path123 --verb="{{EditDuplicate;ObjectRotate90;FileSave;FileQuit}}"` diff --git a/inkview b/inkview new file mode 100644 index 00000000..aba42d34 --- /dev/null +++ b/inkview @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# inkview + +> Inkscape graphical SVG previewer. +> Also functions as a slideshow viewer. +> More information: . + +- Preview an SVG: + +`inkview {{path/to/file.svg}}` + +- Preview multiple SVGs (use arrow keys to navigate): + +`inkview {{path/to/file1.svg path/to/file2.svg ...}}` diff --git a/install b/install new file mode 100644 index 00000000..f5e9d00b --- /dev/null +++ b/install @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# install + +> Copy files and set attributes. +> Copy files (often executable) to a system location like `/usr/local/bin`, give them the appropriate permissions/ownership. +> More information: . + +- Copy files to the destination: + +`install {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` + +- Copy files to the destination, setting their ownership: + +`install --owner {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` + +- Copy files to the destination, setting their group ownership: + +`install --group {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` + +- Copy files to the destination, setting their `mode`: + +`install --mode {{+x}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` + +- Copy files and apply access/modification times of source to the destination: + +`install --preserve-timestamps {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` + +- Copy files and create the directories at the destination if they don't exist: + +`install -D {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` diff --git a/install-nodeversion b/install-nodeversion new file mode 100644 index 00000000..8721c96f --- /dev/null +++ b/install-nodeversion @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Install-NodeVersion + +> Install Node.js runtime versions for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Install a specific Node.js version: + +`Install-NodeVersion {{node_version}}` + +- Install multiple Node.js versions: + +`Install-NodeVersion {{node_version1 , node_version2 , ...}}` + +- Install latest available version of Node.js 20: + +`Install-NodeVersion ^20` + +- Install the x86 (x86 32-bit) / x64 (x86 64-bit) / arm64 (ARM 64-bit) version of Node.js: + +`Install-NodeVersion {{node_version}} -Architecture {{x86|x64|arm64}}` + +- Use a HTTP proxy to download Node.js: + +`Install-NodeVersion {{node-version}} -Proxy {{http://example.com}}` diff --git a/install-tl b/install-tl new file mode 100644 index 00000000..136ed2eb --- /dev/null +++ b/install-tl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# install-tl + +> TeX Live cross-platform installer. +> More information: . + +- Start the text-based installer (default on Unix systems): + +`install-tl -no-gui` + +- Start the GUI installer (default on macOS and Windows, requires Tcl/Tk): + +`install-tl -gui` + +- Install TeX Live as defined in a specific profile file: + +`install-tl -profile {{path/to/texlive.profile}}` + +- Start the installer with the settings from a specific profile file: + +`install-tl -init-from-file {{path/to/texlive.profile}}` + +- Start the installer for installation on a portable device, like a USB stick: + +`install-tl -portable` + +- Display help: + +`install-tl -help` diff --git a/interdiff b/interdiff new file mode 100644 index 00000000..a1656ca4 --- /dev/null +++ b/interdiff @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# interdiff + +> Show differences between two diff files. +> More information: . + +- Compare diff files: + +`interdiff {{old_file}} {{new_file}}` + +- Compare diff files, ignoring whitespace: + +`interdiff -w {{old_file}} {{new_file}}` diff --git a/ionic b/ionic new file mode 100644 index 00000000..d2a5e9e3 --- /dev/null +++ b/ionic @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ionic + +> A framework to build hybrid mobile apps. +> More information: . + +- Create a new project: + +`ionic start` + +- Start a local dev server for app dev/testing: + +`ionic serve` + +- Generate new app component, directive, page, pipe, provider or tabs: + +`ionic g {{page}}` + +- Run app on an Android/iOS device: + +`ionic cordova run {{android|ios}} --device` + +- Check the health of an Ionic app: + +`ionic doctor {{check}}` + +- Display versions of Ionic, Cordova, environment, etc.: + +`ionic info` diff --git a/ioping b/ioping new file mode 100644 index 00000000..85592af5 --- /dev/null +++ b/ioping @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ioping + +> Monitor I/O latency in real time. +> More information: . + +- Show disk I/O latency using the default values and the current directory: + +`ioping .` + +- Measure latency on /tmp using 10 requests of 1 megabyte each: + +`ioping -c 10 -s 1M /tmp` + +- Measure disk seek rate on `/dev/sdX`: + +`ioping -R {{/dev/sdX}}` + +- Measure disk sequential speed on `/dev/sdX`: + +`ioping -RL {{/dev/sdX}}` diff --git a/iotop b/iotop new file mode 100644 index 00000000..a517c0da --- /dev/null +++ b/iotop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iotop + +> Display a table of current I/O usage by processes or threads. +> More information: . + +- Start top-like I/O monitor: + +`sudo iotop` + +- Show only processes or threads actually doing I/O: + +`sudo iotop --only` + +- Show I/O usage in non-interactive mode: + +`sudo iotop --batch` + +- Show only I/O usage of processes (default is to show all threads): + +`sudo iotop --processes` + +- Show I/O usage of given PID(s): + +`sudo iotop --pid={{PID}}` + +- Show I/O usage of a given user: + +`sudo iotop --user={{user}}` + +- Show accumulated I/O instead of bandwidth: + +`sudo iotop --accumulated` diff --git a/ipaggcreate b/ipaggcreate new file mode 100644 index 00000000..97260f85 --- /dev/null +++ b/ipaggcreate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipaggcreate + +> Produce aggregate statistics of TCP/IP dumps. +> More information: . + +- Count the number of packets sent from each source address appearing in a pcap file: + +`ipaggcreate --src {{path/to/file.pcap}}` + +- Group and count packets read from a network interface by IP packet length: + +`ipaggcreate --interface {{eth0}} --length` + +- Count the number of bytes sent between each address pair appearing in a pcap file: + +`ipaggcreate --address-pairs --bytes {{path/to/file.pcap}}` diff --git a/ipaggmanip b/ipaggmanip new file mode 100644 index 00000000..ab565dd1 --- /dev/null +++ b/ipaggmanip @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipaggmanip + +> Manipulate aggregate statistics produced by `ipaggcreate`. +> More information: . + +- Combine labels equal in their high-order bits: + +`ipaggmanip --prefix {{16}} {{path/to/file}}` + +- Remove labels with a count smaller than a given number of bytes and output a random sample of such labels: + +`ipaggmanip --cut-smaller {{100}} --cull-labels {{5}} {{path/to/file}}` + +- Replace each label's count with 1 if it is non-zero: + +`ipaggmanip --posterize {{path/to/file}}` diff --git a/ipcs b/ipcs new file mode 100644 index 00000000..cb4dadd1 --- /dev/null +++ b/ipcs @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipcs + +> Display information about resources used in IPC (Inter-process Communication). +> More information: . + +- Specific information about the Message Queue which has the ID 32768: + +`ipcs -qi 32768` + +- General information about all the IPC: + +`ipcs -a` diff --git a/iperf b/iperf new file mode 100644 index 00000000..9d41a796 --- /dev/null +++ b/iperf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iperf + +> Measure network bandwidth between computers. +> More information: . + +- Run on server: + +`iperf -s` + +- Run on server using UDP mode and set server port to listen on 5001: + +`iperf -u -s -p {{5001}}` + +- Run on client: + +`iperf -c {{server_address}}` + +- Run on client every 2 seconds: + +`iperf -c {{server_address}} -i {{2}}` + +- Run on client with 5 parallel threads: + +`iperf -c {{server_address}} -P {{5}}` + +- Run on client using UDP mode: + +`iperf -u -c {{server_address}} -p {{5001}}` diff --git a/iperf3 b/iperf3 new file mode 100644 index 00000000..851fb8e4 --- /dev/null +++ b/iperf3 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iperf3 + +> Traffic generator for testing network bandwidth. +> More information: . + +- Run iperf3 as a server: + +`iperf3 -s` + +- Run an iperf3 server on a specific port: + +`iperf3 -s -p {{port}}` + +- Start bandwidth test: + +`iperf3 -c {{server}}` + +- Run iperf3 in multiple parallel streams: + +`iperf3 -c {{server}} -P {{streams}}` + +- Reverse direction of the test. Server sends data to the client: + +`iperf3 -c {{server}} -R` diff --git a/ipfs b/ipfs new file mode 100644 index 00000000..b0140022 --- /dev/null +++ b/ipfs @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipfs + +> Inter Planetary File System. +> A peer-to-peer hypermedia protocol. Aims to make the web more open. +> More information: . + +- Add a file from local to the filesystem, pin it and print the relative hash: + +`ipfs add {{path/to/file}}` + +- Add a directory and its files recursively from local to the filesystem and print the relative hash: + +`ipfs add -r {{path/to/directory}}` + +- Save a remote file and give it a name but not pin it: + +`ipfs get {{hash}} -o {{path/to/file}}` + +- Pin a remote file locally: + +`ipfs pin add {{hash}}` + +- Display pinned files: + +`ipfs pin ls` + +- Unpin a file from the local storage: + +`ipfs pin rm {{hash}}` + +- Remove unpinned files from local storage: + +`ipfs repo gc` diff --git a/ippevepcl b/ippevepcl new file mode 100644 index 00000000..6da7d1ac --- /dev/null +++ b/ippevepcl @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ippevepcl + +> Print to B&W HP PCL laser printers. +> Supports HP PCL, PWG Raster and Apple Raster files. +> See also: `ippevepcl`, `ippeveprinter`. +> More information: . + +- Print a file to `stdout` (status and progress messages are sent to `stderr`): + +`ippeveps {{path/to/file}}` + +- Print a file from `stdin` to `stdout`: + +`{{wget -O - https://examplewebsite.com/file}} | ippeveps` diff --git a/ippeveprinter b/ippeveprinter new file mode 100644 index 00000000..dcabbe2c --- /dev/null +++ b/ippeveprinter @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ippeveprinter + +> A simple IPP Everywhere printer server. +> See also: `ippeveps`, `ippevepcl`. +> More information: . + +- Run the server with a specific service name: + +`ippeveprinter "{{service_name}}"` + +- Load printer attributes from a PPD file: + +`ippeveprinter -P {{path/to/file.ppd}} "{{service_name}}"` + +- Run the `file` command whenever a job is sent to the server: + +`ippeveprinter -c {{/usr/bin/file}} "{{service_name}}"` + +- Specify the directory that will hold the print files (by default, a directory under the user's temporary directory): + +`ippeveprinter -d {{spool_directory}} "{{service_name}}"` + +- Keep the print documents in the spool directory rather than deleting them: + +`ippeveprinter -k "{{service_name}}"` + +- Specify the printer speed in pages/minute unit (10 by default): + +`ippeveprinter -s {{speed}} "{{service_name}}"` diff --git a/ippeveps b/ippeveps new file mode 100644 index 00000000..5ab4ae88 --- /dev/null +++ b/ippeveps @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ippeveps + +> Print to Adobe PostScript printers. +> Supports PDF, PostScript, JPEG, PWG Raster or Apple Raster files. +> See also: `ippevepcl`, `ippeveprinter`. +> More information: . + +- Print a file to `stdout` (status and progress messages are sent to `stderr`): + +`ippeveps {{path/to/file}}` + +- Print a file from `stdin` to `stdout`: + +`{{wget -O - https://examplewebsite.com/file}} | ippeveps` diff --git a/ippfind b/ippfind new file mode 100644 index 00000000..bb3f6a1b --- /dev/null +++ b/ippfind @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ippfind + +> Find services registered with a DNS server or available through local devices. +> See also: `ipptool`, `ippeveprinter`. +> More information: . + +- List IPP printers registered on the network with their status: + +`ippfind --ls` + +- Send a specific PostScript document to every PostScript printer on the network: + +`ippfind --txt-pdl application/postscript --exec ipptool -f {{path/to/document.ps}} '{}' print-job.test \;` + +- Send a PostScript test document to every PostScript printer on the network: + +`ippfind --txt-pdl application/postscript --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` + +- Send a PostScript test document to every PostScript printer on the network, whose name matches a regular expression: + +`ippfind --txt-pdl application/postscript --host {{regex}} --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` diff --git a/ipptool b/ipptool new file mode 100644 index 00000000..e0a6cfa3 --- /dev/null +++ b/ipptool @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipptool + +> Issue IPP requests and receive printer's/server's responses. +> See also: `ippfind`, `ippeveprinter`. +> More information: . + +- Get all attributes and their values supported by a printer: + +`ipptool ipp://{{printer_uri}} get-completed-jobs.test` + +- Get the list of completed jobs of a printer: + +`ipptool ipp://{{printer_uri}} get-completed-jobs.test` + +- Send an email notification when a printer changes: + +`ipptool -d recipient=mailto:{{email}} ipp://{{printer_uri}} create-printer-subscription.test` diff --git a/ipsumdump b/ipsumdump new file mode 100644 index 00000000..afc9d3a9 --- /dev/null +++ b/ipsumdump @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipsumdump + +> Summarise TCP/IP dumps into a human and machine readable ASCII format. +> More information: . + +- Print the source and destination IP addresses of all packets in a pcap file: + +`ipsumdump --src --dst {{path/to/file.pcap}}` + +- Print the timestamps, source address, source port, destination address, destination port and protocol of all packets read from a given network interface: + +`ipsumdump --interface {{eth0}} -tsSdDp` + +- Print the anonymised source address, anonymised destination address, and IP packet length of all packets in a pcap file: + +`ipsumdump --src --dst --length --anonymize {{path/to/file.pcap}}` diff --git a/ipython b/ipython new file mode 100644 index 00000000..5abd776c --- /dev/null +++ b/ipython @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# IPython + +> A Python shell with automatic history, dynamic object introspection, easier configuration, command completion, access to the system shell and more. +> More information: . + +- Start a REPL (interactive shell): + +`ipython` + +- Enter an interactive IPython session after running a Python script: + +`ipython -i {{script.py}}` + +- Create default IPython profile: + +`ipython profile create` + +- Print the path to the directory for the default IPython profile: + +`ipython locate profile` + +- Clear the IPython history database, deleting all entries: + +`ipython history clear` diff --git a/irb b/irb new file mode 100644 index 00000000..9eae88da --- /dev/null +++ b/irb @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# irb + +> Interactive Ruby shell. +> Evaluate Ruby code read from `stdin`. +> More information: . + +- Start the interactive shell: + +`irb` diff --git a/irssi b/irssi new file mode 100644 index 00000000..5eee6a33 --- /dev/null +++ b/irssi @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# irssi + +> Text based IRC client. +> More information: . + +- Open Irssi and connect to a server with a nickname: + +`irssi -n {{nickname}} -c {{irc.example.com}}` + +- Open Irssi and connect with a specific server on a given port: + +`irssi -c {{irc.example.com}} -p {{port}}` + +- Display help: + +`irssi --help` + +- Join a channel: + +`/join {{#channelname}}` + +- Change active window (starts at 1): + +`/win {{window_number}}` + +- Exit the application cleanly and quitting any server(s): + +`/quit` diff --git a/is-up b/is-up new file mode 100644 index 00000000..bd8ebdf1 --- /dev/null +++ b/is-up @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# is-up + +> Check whether a website is up or down. +> More information: . + +- Check the status of the specified website: + +`is-up {{example.com}}` diff --git a/isisdl b/isisdl new file mode 100644 index 00000000..bf7fb0d5 --- /dev/null +++ b/isisdl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# isisdl + +> A downloading utility for ISIS of TU-Berlin. Download all your files and videos from ISIS. +> More information: . + +- Start the synchronization process: + +`isisdl` + +- Limit the download rate to 20 MiB/s and download with 5 threads: + +`isisdl --download-rate {{20}} --max-num-threads {{5}}` + +- Run the initialization configuration wizard: + +`isisdl --init` + +- Run the additional configuration wizard: + +`isisdl --config` + +- Initiate a full synchronization of the database and compute the checksum of every file: + +`isisdl --sync` + +- Start ffmpeg to compress downloaded videos: + +`isisdl --compress` diff --git a/isutf8 b/isutf8 new file mode 100644 index 00000000..14c69218 --- /dev/null +++ b/isutf8 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# isutf8 + +> Check whether text files contain valid UTF-8. +> More information: . + +- Check whether the specified files contain valid UTF-8: + +`isutf8 {{path/to/file1 path/to/file2 ...}}` + +- Print errors using multiple lines: + +`isutf8 --verbose {{path/to/file1 path/to/file2 ...}}` + +- Do not print anything to `stdout`, indicate the result merely with the exit code: + +`isutf8 --quiet {{path/to/file1 path/to/file2 ...}}` + +- Only print the names of the files containing invalid UTF-8: + +`isutf8 --list {{path/to/file1 path/to/file2 ...}}` + +- Same as `--list` but inverted, i.e., only print the names of the files containing valid UTF-8: + +`isutf8 --invert {{path/to/file1 path/to/file2 ...}}` diff --git a/iverilog b/iverilog new file mode 100644 index 00000000..b552dfca --- /dev/null +++ b/iverilog @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# iverilog + +> Preprocesses and compiles Verilog HDL (IEEE-1364) code into executable programs for simulation. +> More information: . + +- Compile a source file into an executable: + +`iverilog {{path/to/source.v}} -o {{path/to/executable}}` + +- Compile a source file into an executable while displaying all warnings: + +`iverilog {{path/to/source.v}} -Wall -o {{path/to/executable}}` + +- Compile and run explicitly using the VVP runtime: + +`iverilog -o {{path/to/executable}} -tvvp {{path/to/source.v}}` + +- Compile using Verilog library files from a different path: + +`iverilog {{path/to/source.v}} -o {{path/to/executable}} -I{{path/to/library_directory}}` + +- Preprocess Verilog code without compiling: + +`iverilog -E {{path/to/source.v}}` diff --git a/ivpn b/ivpn new file mode 100644 index 00000000..07e0de83 --- /dev/null +++ b/ivpn @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ivpn + +> Command-line interface for the IVPN client. +> More information: . + +- Print the current state of IVPN, including the connection and firewall status: + +`ivpn status` + +- List available servers to connect to: + +`ivpn servers` diff --git a/jadx b/jadx new file mode 100644 index 00000000..407e821c --- /dev/null +++ b/jadx @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jadx + +> Dex to Java decompiler. +> Produces Java source code from Android Dex and APK files. +> More information: . + +- Decompile a Dex file into a directory: + +`jadx {{path/to/file}}` + +- Decompile a Dex file into a specific directory: + +`jadx --output-dir {{path/to/directory}} {{path/to/file}}` diff --git a/jar b/jar new file mode 100644 index 00000000..d602027d --- /dev/null +++ b/jar @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jar + +> Java applications/libraries packager. +> More information: . + +- Recursively archive all files in the current directory into a .jar file: + +`jar cf {{file.jar}} *` + +- Unzip .jar/.war file to the current directory: + +`jar -xvf {{file.jar}}` + +- List a .jar/.war file content: + +`jar tf {{path/to/file.jar}}` + +- List a .jar/.war file content with verbose output: + +`jar tvf {{path/to/file.jar}}` diff --git a/jarsigner b/jarsigner new file mode 100644 index 00000000..ef1c6686 --- /dev/null +++ b/jarsigner @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jarsigner + +> Sign and verify Java archive (JAR) files. +> More information: . + +- Sign a JAR file: + +`jarsigner {{path/to/file.jar}} {{keystore_alias}}` + +- Sign a JAR file with a specific algorithm: + +`jarsigner -sigalg {{algorithm}} {{path/to/file.jar}} {{keystore_alias}}` + +- Verify the signature of a JAR file: + +`jarsigner -verify {{path/to/file.jar}}` diff --git a/java b/java new file mode 100644 index 00000000..563df2be --- /dev/null +++ b/java @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# java + +> Java application launcher. +> More information: . + +- Execute a Java `.class` file that contains a main method by using just the class name: + +`java {{classname}}` + +- Execute a Java program and use additional third-party or user-defined classes: + +`java -classpath {{path/to/classes1}}:{{path/to/classes2}}:. {{classname}}` + +- Execute a `.jar` program: + +`java -jar {{filename.jar}}` + +- Execute a `.jar` program with debug waiting to connect on port 5005: + +`java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005 -jar {{filename.jar}}` + +- Display JDK, JRE and HotSpot versions: + +`java -version` + +- Display help: + +`java -help` diff --git a/javac b/javac new file mode 100644 index 00000000..1fdebcaa --- /dev/null +++ b/javac @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# javac + +> Java application compiler. +> More information: . + +- Compile a `.java` file: + +`javac {{path/to/file.java}}` + +- Compile several `.java` files: + +`javac {{path/to/file1.java path/to/file2.java ...}}` + +- Compile all `.java` files in current directory: + +`javac {{*.java}}` + +- Compile a `.java` file and place the resulting class file in a specific directory: + +`javac -d {{path/to/directory}} {{path/to/file.java}}` diff --git a/javadoc b/javadoc new file mode 100644 index 00000000..acb30573 --- /dev/null +++ b/javadoc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# javadoc + +> Generate Java API documentation in HTML format from source code. +> More information: . + +- Generate documentation for Java source code and save the result in a directory: + +`javadoc -d {{path/to/directory/}} {{path/to/java_source_code}}` + +- Generate documentation with a specific encoding: + +`javadoc -docencoding {{UTF-8}} {{path/to/java_source_code}}` + +- Generate documentation excluding some packages: + +`javadoc -exclude {{package_list}} {{path/to/java_source_code}}` diff --git a/javap b/javap new file mode 100644 index 00000000..ddf90ae9 --- /dev/null +++ b/javap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# javap + +> Disassemble class files and list them. +> More information: . + +- Disassemble and list one or more `.class` files: + +`javap {{path/to/file1.class path/to/file2.class ...}}` + +- Disassemble and list a built-in class file: + +`javap java.{{package}}.{{class}}` + +- Display help: + +`javap -help` + +- Display version: + +`javap -version` diff --git a/jbang b/jbang new file mode 100644 index 00000000..5b25b81a --- /dev/null +++ b/jbang @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jbang + +> Easily create, edit and run self-contained source-only Java programs. +> See also: `java`. +> More information: . + +- Initialize a simple Java class: + +`jbang init {{path/to/file.java}}` + +- Initialize a Java class (useful for scripting): + +`jbang init --template={{cli}} {{path/to/file.java}}` + +- Use `jshell` to explore and use a script and any dependencies in a REPL editor: + +`jbang run --interactive` + +- Setup a temporary project to edit a script in an IDE: + +`jbang edit --open={{codium|code|eclipse|idea|netbeans|gitpod}} {{path/to/script.java}}` + +- Run a Java code snippet (Java 9 and later): + +`{{echo 'Files.list(Paths.get("/etc")).forEach(System.out::println);'}} | jbang -` + +- Run command line application: + +`jbang {{path/to/file.java}} {{command}} {{arg1 arg2 ...}}` + +- Install a script on the user's `$PATH`: + +`jbang app install --name {{command_name}} {{path/to/script.java}}` + +- Install a specific version of JDK to be used with `jbang`: + +`jbang jdk install {{version}}` diff --git a/jc b/jc new file mode 100644 index 00000000..26c1813b --- /dev/null +++ b/jc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jc + +> A utility to convert the output of multiple commands to JSON. +> More information: . + +- Convert command output to JSON via pipe: + +`{{ifconfig}} | jc {{--ifconfig}}` + +- Convert command output to JSON via magic syntax: + +`jc {{ifconfig}}` + +- Output pretty JSON via pipe: + +`{{ifconfig}} | jc {{--ifconfig}} -p` + +- Output pretty JSON via magic syntax: + +`jc -p {{ifconfig}}` diff --git a/jcal b/jcal new file mode 100644 index 00000000..7f1bddfb --- /dev/null +++ b/jcal @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jcal + +> Display calendar information in the Jalali format, with the current day highlighted. +> More information: . + +- Display a calendar for the current month: + +`jcal` + +- Display the previous, current, and next months: + +`jcal -3` + +- Display a calendar for a specific year (4 digits): + +`jcal {{year}}` + +- Display a calendar for a specific month and year: + +`jcal {{year}} {{month}}` diff --git a/jdeps b/jdeps new file mode 100644 index 00000000..4713c7c7 --- /dev/null +++ b/jdeps @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jdeps + +> Java class dependency analyzer. +> More information: . + +- Analyze the dependencies of a `.jar` or `.class` file: + +`jdeps {{path/to/filename.class}}` + +- Print a summary of all dependencies of a specific `.jar` file: + +`jdeps {{path/to/filename.jar}} -summary` + +- Print all class-level dependencies of a `.jar` file: + +`jdeps {{path/to/filename.jar}} -verbose` + +- Output the results of the analysis in a DOT file into a specific directory: + +`jdeps {{path/to/filename.jar}} -dotoutput {{path/to/directory}}` + +- Display help: + +`jdeps --help` diff --git a/jdupes b/jdupes new file mode 100644 index 00000000..65c74102 --- /dev/null +++ b/jdupes @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jdupes + +> A powerful duplicate file finder and an enhanced fork of fdupes. +> More information: . + +- Search a single directory: + +`jdupes {{path/to/directory}}` + +- Search multiple directories: + +`jdupes {{directory1}} {{directory2}}` + +- Search all directories recursively: + +`jdupes --recurse {{path/to/directory}}` + +- Search directory recursively and let user choose files to preserve: + +`jdupes --delete --recurse {{path/to/directory}}` + +- Search multiple directories and follow subdirectores under directory2, not directory1: + +`jdupes {{directory1}} --recurse: {{directory2}}` + +- Search multiple directories and keep the directory order in result: + +`jdupes -O {{directory1}} {{directory2}} {{directory3}}` diff --git a/jekyll b/jekyll new file mode 100644 index 00000000..3d6f0825 --- /dev/null +++ b/jekyll @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jekyll + +> A simple, blog-aware, static site generator. +> More information: . + +- Generate a development server that will run at http://localhost:4000/: + +`jekyll serve` + +- Enable incremental regeneration: + +`jekyll serve --incremental` + +- Enable verbose output: + +`jekyll serve --verbose` + +- Generate the current directory into `./_site`: + +`jekyll build` + +- Clean the site (removes site output and `cache` directory) without building: + +`jekyll clean` diff --git a/jello b/jello new file mode 100644 index 00000000..a9729840 --- /dev/null +++ b/jello @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jello + +> A command-line JSON processor using Python syntax. +> More information: . + +- Pretty-print JSON or JSON-Lines data from `stdin` to `stdout`: + +`cat {{file.json}} | jello` + +- Output a schema of JSON or JSON Lines data from `stdin` to `stdout` (useful for grep): + +`cat {{file.json}} | jello -s` + +- Output all elements from arrays (or all the values from objects) in JSON or JSON-Lines data from `stdin` to `stdout`: + +`cat {{file.json}} | jello -l` + +- Output the first element in JSON or JSON-Lines data from `stdin` to `stdout`: + +`cat {{file.json}} | jello _[0]` + +- Output the value of a given key of each element in JSON or JSON-Lines data from `stdin` to `stdout`: + +`cat {{file.json}} | jello '[i.{{key_name}} for i in _]'` + +- Output the value of multiple keys as a new JSON object (assuming the input JSON has the keys `key_name1` and `key_name2`): + +`cat {{file.json}} | jello '{"{{key1}}": _.{{key_name1}}, "{{key_name}}": _.{{key_name2}}}'` + +- Output the value of a given key to a string (and disable JSON output): + +`cat {{file.json}} | jello -r '"{{some text}}: " + _.{{key_name}}'` diff --git a/jenv b/jenv new file mode 100644 index 00000000..a4f65e50 --- /dev/null +++ b/jenv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jenv + +> Command-line tool to manage the "JAVA_HOME" environment variable. +> More information: . + +- Add a Java version to jEnv: + +`jenv add {{path/to/jdk_home}}` + +- Display the current JDK version used: + +`jenv version` + +- Display all managed JDKs: + +`jenv versions` + +- Set the global JDK version: + +`jenv global {{java_version}}` + +- Set the JDK version for the current shell session: + +`jenv shell {{java_version}}` + +- Enable a jEnv plugin: + +`jenv enable-plugin {{plugin_name}}` diff --git a/jest b/jest new file mode 100644 index 00000000..6927adeb --- /dev/null +++ b/jest @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jest + +> A zero-configuration JavaScript testing platform. +> More information: . + +- Run all available tests: + +`jest` + +- Run the test suites from the given files: + +`jest {{path/to/file1 path/to/file2 ...}}` + +- Run the test suites from files within the current and subdirectories, whose paths match the given regular expression: + +`jest {{regular_expression1}} {{regular_expression2}}` + +- Run the tests whose names match the given regular expression: + +`jest --testNamePattern {{regular_expression}}` + +- Run test suites related to a given source file: + +`jest --findRelatedTests {{path/to/source_file.js}}` + +- Run test suites related to all uncommitted files: + +`jest --onlyChanged` + +- Watch files for changes and automatically re-run related tests: + +`jest --watch` + +- Display help: + +`jest --help` diff --git a/jetifier b/jetifier new file mode 100644 index 00000000..2adb8570 --- /dev/null +++ b/jetifier @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jetifier + +> Jetifier AndroidX transition tool in npm format, with a react-native compatible style. +> More information: . + +- Migrate project dependencies to the AndroidX format: + +`jetifier` + +- Migrate project dependencies from the AndroidX format: + +`jetifier reverse` diff --git a/jf b/jf new file mode 100644 index 00000000..8810f79b --- /dev/null +++ b/jf @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jf + +> Interact with JFrog products like Artifactory, Xray, Distribution, Pipelines and Mission Control. +> More information: . + +- Add a new configuration: + +`jf config add` + +- Show the current configuration: + +`jf config show` + +- Search for artifacts within the given repository and directory: + +`jf rt search --recursive {{repostiory_name}}/{{path}}/` diff --git a/jfrog b/jfrog new file mode 100644 index 00000000..4c02326e --- /dev/null +++ b/jfrog @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jfrog + +> This command is an alias of `jf`. + +- View documentation for the original command: + +`tldr jf` diff --git a/jhat b/jhat new file mode 100644 index 00000000..d3d0d614 --- /dev/null +++ b/jhat @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jhat + +> Java heap analysis tool. +> More information: . + +- Analyze a heap dump (from `jmap`), view via HTTP on port 7000: + +`jhat {{dump_file.bin}}` + +- Analyze a heap dump, specifying an alternate port for the http server: + +`jhat -p {{port}} {{dump_file.bin}}` + +- Analyze a dump letting `jhat` use up to 8 GB RAM (2-4x dump size recommended): + +`jhat -J-mx8G {{dump_file.bin}}` diff --git a/jhipster b/jhipster new file mode 100644 index 00000000..49143f15 --- /dev/null +++ b/jhipster @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jhipster + +> Web application generator using either monolithic or microservices architecture. +> More information: . + +- Generate a simple full-stack project (monolithic or microservices): + +`jhipster` + +- Generate a simple frontend project: + +`jhipster --skip-server` + +- Generate a simple backend project: + +`jhipster --skip-client` + +- Apply latest JHipster updates to the project: + +`jhipster upgrade` + +- Add a new entity to a generated project: + +`jhipster entity {{entity_name}}` + +- Import a JDL file to configure your application (see: ): + +`jhipster import-jdl {{first_file.jh second_file.jh ... n_file.jh}}` + +- Generate a CI/CD pipeline for your application: + +`jhipster ci-cd` + +- Generate a Kubernetes configuration for your application: + +`jhipster kubernetes` diff --git a/jhsdb b/jhsdb new file mode 100644 index 00000000..2f87ca60 --- /dev/null +++ b/jhsdb @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jhsdb + +> Attach to a Java process or launch a postmortem debugger to analyze the core dump from a crashed Java Virtual Machine. +> More information: . + +- Print stack and locks information of a Java process: + +`jhsdb jstack --pid {{pid}}` + +- Open a core dump in interactive debug mode: + +`jhsdb clhsdb --core {{path/to/core_dump}} --exe {{path/to/jdk/bin/java}}` + +- Start a remote debug server: + +`jhsdb debugd --pid {{pid}} --serverid {{optional_unique_id}}` + +- Connect to a process in interactive debug mode: + +`jhsdb clhsdb --pid {{pid}}` diff --git a/jigsaw b/jigsaw new file mode 100644 index 00000000..322635c5 --- /dev/null +++ b/jigsaw @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jigsaw + +> A Laravel-based static site builder for PHP. +> More information: . + +- Initialize a project: + +`jigsaw init` + +- Initialize a project using a starter template: + +`jigsaw init {{template_name}}` + +- Build the site for development: + +`jigsaw build` + +- Preview the site from the "build_local" directory: + +`jigsaw serve` + +- Build the site for production: + +`jigsaw build production` + +- Preview the site from the "build_production" directory: + +`jigsaw serve {{build_production}}` diff --git a/jmap b/jmap new file mode 100644 index 00000000..35407b2c --- /dev/null +++ b/jmap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jmap + +> Java memory map tool. +> More information: . + +- Print shared object mappings for a Java process (output like pmap): + +`jmap {{java_pid}}` + +- Print heap summary information: + +`jmap -heap {{filename.jar}} {{java_pid}}` + +- Print histogram of heap usage by type: + +`jmap -histo {{java_pid}}` + +- Dump contents of the heap into a binary file for analysis with jhat: + +`jmap -dump:format=b,file={{path/to/file}} {{java_pid}}` + +- Dump live objects of the heap into a binary file for analysis with jhat: + +`jmap -dump:live,format=b,file={{path/to/file}} {{java_pid}}` diff --git a/jmeter b/jmeter new file mode 100644 index 00000000..56e5c74d --- /dev/null +++ b/jmeter @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jmeter + +> Open source Java application designed for load testing functional behavior and measure performance. +> More information: . + +- Run a specific test plan in nongui mode: + +`jmeter --nongui --testfile {{path/to/file.jmx}}` + +- Run a test plan in nongui mode using a specific log file: + +`jmeter --nogui --testfile {{path/to/file.jmx}} --logfile {{path/to/logfile.jtl}}` + +- Run a test plan in nongui mode using a specific proxy: + +`jmeter --nongui --testfile {{path/to/file.jmx}} --proxyHost {{127.0.0.1}} --proxyPort {{8888}}` + +- Run a test plan in nongui mode using a specific JMeter property: + +`jmeter --jmeterproperty {{key}}='{{value}}' --nongui --testfile {{path/to/file.jmx}}` diff --git a/jmtpfs b/jmtpfs new file mode 100644 index 00000000..49d177be --- /dev/null +++ b/jmtpfs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jmtpfs + +> FUSE-based filesystem for accessing MTP devices. +> More information: . + +- Mount an MTP device to a directory: + +`jmtpfs {{path/to/directory}}` + +- Set mount options: + +`jmtpfs -o {{allow_other,auto_unmount}} {{path/to/directory}}` + +- List available MTP devices: + +`jmtpfs --listDevices` + +- If multiple devices are present, mount a specific device: + +`jmtpfs -device={{bus_id}},{{device_id}} {{path/to/directory}}` + +- Unmount MTP device: + +`fusermount -u {{path/to/directory}}` diff --git a/jobs b/jobs new file mode 100644 index 00000000..a87a4a8d --- /dev/null +++ b/jobs @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jobs + +> Display status of jobs in the current session. +> More information: . + +- Show status of all jobs: + +`jobs` + +- Show status of a particular job: + +`jobs %{{job_id}}` + +- Show status and process IDs of all jobs: + +`jobs -l` + +- Show process IDs of all jobs: + +`jobs -p` diff --git a/joe b/joe new file mode 100644 index 00000000..9b2e1e5d --- /dev/null +++ b/joe @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# joe + +> Joe's own text editor. +> More information: . + +- Open a new file in JOE: + +`joe` + +- Open a specific file: + +`joe {{path/to/file}}` + +- Open a specific file, positioning the cursor at the specified line: + +`joe +{{line}} {{path/to/file}}` + +- Open a specific file in read-only mode: + +`joe -rdonly {{path/to/file}}` diff --git a/john b/john new file mode 100644 index 00000000..bedc7764 --- /dev/null +++ b/john @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# john + +> Password cracker. +> More information: . + +- Crack password hashes: + +`john {{path/to/hashes.txt}}` + +- Show passwords cracked: + +`john --show {{path/to/hashes.txt}}` + +- Display users' cracked passwords by user identifier from multiple files: + +`john --show --users={{user_ids}} {{path/to/hashes1.txt path/to/hashes2.txt ...}}` + +- Crack password hashes, using a custom wordlist: + +`john --wordlist={{path/to/wordlist.txt}} {{path/to/hashes.txt}}` + +- List available hash formats: + +`john --list=formats` + +- Crack password hashes, using a specific hash format: + +`john --format={{md5crypt}} {{path/to/hashes.txt}}` + +- Crack password hashes, enabling word mangling rules: + +`john --rules {{path/to/hashes.txt}}` + +- Restore an interrupted cracking session from a state file, e.g. `mycrack.rec`: + +`john --restore={{path/to/mycrack.rec}}` diff --git a/join b/join new file mode 100644 index 00000000..6e31c942 --- /dev/null +++ b/join @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# join + +> Join lines of two sorted files on a common field. +> More information: . + +- Join two files on the first (default) field: + +`join {{path/to/file1}} {{path/to/file2}}` + +- Join two files using a comma (instead of a space) as the field separator: + +`join -t {{','}} {{path/to/file1}} {{path/to/file2}}` + +- Join field3 of file1 with field1 of file2: + +`join -1 {{3}} -2 {{1}} {{path/to/file1}} {{path/to/file2}}` + +- Produce a line for each unpairable line for file1: + +`join -a {{1}} {{path/to/file1}} {{path/to/file2}}` + +- Join a file from `stdin`: + +`cat {{path/to/file1}} | join - {{path/to/file2}}` diff --git a/josm b/josm new file mode 100644 index 00000000..934d2686 --- /dev/null +++ b/josm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# josm + +> Extensible OpenStreetMap editor for Java 8+. +> More information: . + +- Launch JOSM: + +`josm` + +- Launch JOSM in maximized mode: + +`josm --maximize` + +- Launch JOSM and set a specific language: + +`josm --language {{de}}` + +- Launch JOSM and reset all preferences to their default values: + +`josm --reset-preferences` + +- Launch JOSM and download a specific bounding box: + +`josm --download {{minlat,minlon,maxlat,maxlon}}` + +- Launch JOSM and download a specific bounding box as raw GPS: + +`josm --downloadgps {{minlat,minlon,maxlat,maxlon}}` + +- Launch JOSM without plugins: + +`josm --skip-plugins` diff --git a/jp2a b/jp2a new file mode 100644 index 00000000..2ed28eb8 --- /dev/null +++ b/jp2a @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jp2a + +> Convert JPEG images to ASCII. +> More information: . + +- Read JPEG image from a file and print in ASCII: + +`jp2a {{path/to/image.jpeg}}` + +- Read JPEG image from a URL and print in ASCII: + +`jp2a {{www.example.com/image.jpeg}}` + +- Colorize the ASCII output: + +`jp2a --colors {{path/to/image.jpeg}}` + +- Specify characters to be used for the ASCII output: + +`jp2a --chars='{{..-ooxx@@}}' {{path/to/image.jpeg}}` + +- Write the ASCII output into a file: + +`jp2a --output={{path/to/output_file.txt}} {{path/to/image.jpeg}}` + +- Write the ASCII output in HTML file format, suitable for viewing in web browsers: + +`jp2a --html --output={{path/to/output_file.html}} {{path/to/image.jpeg}}` diff --git a/jpegoptim b/jpegoptim new file mode 100644 index 00000000..d9400f55 --- /dev/null +++ b/jpegoptim @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jpegoptim + +> Optimise JPEG images. +> More information: . + +- Optimise a set of JPEG images, retaining all associated data: + +`jpegoptim {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` + +- Optimise JPEG images, stripping all non-essential data: + +`jpegoptim --strip-all {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` + +- Force the output images to be progressive: + +`jpegoptim --all-progressive {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` + +- Force the output images to have a fixed maximum filesize: + +`jpegoptim --size={{250k}} {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` diff --git a/jpegtopnm b/jpegtopnm new file mode 100644 index 00000000..1da24292 --- /dev/null +++ b/jpegtopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jpegtopnm + +> Converts a JPEG/JFIF file to the PPM or PGM format. +> More information: . + +- Convert JPEG/JFIF image to a PPM or PGM image: + +`jpegtopnm {{path/to/file.jpg}} > {{path/to/file.pnm}}` + +- Display version: + +`jpegtopnm -version` diff --git a/jps b/jps new file mode 100644 index 00000000..620c4529 --- /dev/null +++ b/jps @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jps + +> Show JVM process status of current user. +> More information: . + +- List all JVM processes: + +`jps` + +- List all JVM processes with only PID: + +`jps -q` + +- Display the arguments passed to the processes: + +`jps -m` + +- Display the full package name of all processes: + +`jps -l` + +- Display the arguments passed to the JVM: + +`jps -v` diff --git a/jq b/jq new file mode 100644 index 00000000..50ab0462 --- /dev/null +++ b/jq @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jq + +> A command-line JSON processor that uses a domain-specific language (DSL). +> More information: . + +- Execute a specific expression (print a colored and formatted JSON output): + +`{{cat path/to/file.json}} | jq '.'` + +- Execute a specific script: + +`{{cat path/to/file.json}} | jq --from-file {{path/to/script.jq}}` + +- Pass specific arguments: + +`{{cat path/to/file.json}} | jq {{--arg "name1" "value1" --arg "name2" "value2" ...}} '{{. + $ARGS.named}}'` + +- Print specific keys: + +`{{cat path/to/file.json}} | jq '{{.key1, .key2, ...}}'` + +- Print specific array items: + +`{{cat path/to/file.json}} | jq '{{.[index1], .[index2], ...}}'` + +- Print all array items/object keys: + +`{{cat path/to/file.json}} | jq '.[]'` + +- Add/remove specific keys: + +`{{cat path/to/file.json}} | jq '. {{+|-}} {{{"key1": "value1", "key2": "value2", ...}}}'` diff --git a/jrnl b/jrnl new file mode 100644 index 00000000..3a439711 --- /dev/null +++ b/jrnl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jrnl + +> A simple journal application for your command-line. +> More information: . + +- Insert a new entry with your editor: + +`jrnl` + +- Quickly insert a new entry: + +`jrnl {{today at 3am}}: {{title}}. {{content}}` + +- View the last ten entries: + +`jrnl -n {{10}}` + +- View everything that happened from the start of last year to the start of last march: + +`jrnl -from "{{last year}}" -until {{march}}` + +- Edit all entries tagged with "texas" and "history": + +`jrnl {{@texas}} -and {{@history}} --edit` diff --git a/json5 b/json5 new file mode 100644 index 00000000..76da67bb --- /dev/null +++ b/json5 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# json5 + +> A command-line tool for converting JSON5 files to JSON. +> More information: . + +- Convert JSON5 `stdin` to JSON `stdout`: + +`echo {{input}} | json5` + +- Convert a JSON5 file to JSON and output to `stdout`: + +`json5 {{path/to/input_file.json5}}` + +- Convert a JSON5 file to the specified JSON file: + +`json5 {{path/to/input_file.json5}} --out-file {{path/to/output_file.json}}` + +- Validate a JSON5 file: + +`json5 {{path/to/input_file.json5}} --validate` + +- Specify the number of spaces to indent by (or "t" for tabs): + +`json5 --space {{indent_amount}}` + +- Display help: + +`json5 --help` diff --git a/jstack b/jstack new file mode 100644 index 00000000..59dc0960 --- /dev/null +++ b/jstack @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jstack + +> Java stack trace tool. +> More information: . + +- Print Java stack traces for all threads in a Java process: + +`jstack {{java_pid}}` + +- Print mixed mode (Java/C++) stack traces for all threads in a Java process: + +`jstack -m {{java_pid}}` + +- Print stack traces from Java core dump: + +`jstack {{/usr/bin/java}} {{file.core}}` diff --git a/jtbl b/jtbl new file mode 100644 index 00000000..600a5b94 --- /dev/null +++ b/jtbl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jtbl + +> Utility to print JSON and JSON Lines data as a table in the terminal. +> More information: . + +- Print a table from JSON or JSON Lines input: + +`cat {{file.json}} | jtbl` + +- Print a table and specify the column width for wrapping: + +`cat {{file.json}} | jtbl --cols={{width}}` + +- Print a table and truncate rows instead of wrapping: + +`cat {{file.json}} | jtbl -t` + +- Print a table and don't wrap or truncate rows: + +`cat {{file.json}} | jtbl -n` diff --git a/julia b/julia new file mode 100644 index 00000000..bcf2031d --- /dev/null +++ b/julia @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# julia + +> A high-level, high-performance dynamic programming language for technical computing. +> More information: . + +- Start a REPL (interactive shell): + +`julia` + +- Execute a Julia program and exit: + +`julia {{program.jl}}` + +- Execute a Julia program that takes arguments: + +`julia {{program.jl}} {{arguments}}` + +- Evaluate a string containing Julia code: + +`julia -e '{{julia_code}}'` + +- Evaluate a string of Julia code, passing arguments to it: + +`julia -e '{{for x in ARGS; println(x); end}}' {{arguments}}` + +- Evaluate an expression and print the result: + +`julia -E '{{(1 - cos(pi/4))/2}}'` + +- Start Julia in parallel mode, using N worker processes: + +`julia -p {{N}}` diff --git a/jupyter b/jupyter new file mode 100644 index 00000000..ba6bb113 --- /dev/null +++ b/jupyter @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jupyter + +> Web application to create and share documents that contain code, visualizations and notes. +> Primarily used for data analysis, scientific computing and machine learning. +> More information: . + +- Start a Jupyter notebook server in the current directory: + +`jupyter notebook` + +- Open a specific Jupyter notebook: + +`jupyter notebook {{example.ipynb}}` + +- Export a specific Jupyter notebook into another format: + +`jupyter nbconvert --to {{html|markdown|pdf|script}} {{example.ipynb}}` + +- Start a server on a specific port: + +`jupyter notebook --port={{port}}` + +- List currently running notebook servers: + +`jupyter notebook list` + +- Stop the currently running server: + +`jupyter notebook stop` + +- Start JupyterLab, if installed, in the current directory: + +`jupyter lab` diff --git a/jupytext b/jupytext new file mode 100644 index 00000000..a8601021 --- /dev/null +++ b/jupytext @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jupytext + +> Convert Jupyter notebooks to plain text documents, and back again. +> More information: . + +- Turn a notebook into a paired `.ipynb`/`.py` notebook: + +`jupytext --set-formats ipynb,py {{notebook.ipynb}}` + +- Convert a notebook to a `.py` file: + +`jupytext --to py {{notebook.ipynb}}` + +- Convert a `.py` file to a notebook with no outputs: + +`jupytext --to notebook {{notebook.py}}` + +- Convert a `.md` file to a notebook and run it: + +`jupytext --to notebook --execute {{notebook.md}}` + +- Update the input cells in a notebook and preserve outputs and metadata: + +`jupytext --update --to notebook {{notebook.py}}` + +- Update all paired representations of a notebook: + +`jupytext --sync {{notebook.ipynb}}` diff --git a/just b/just new file mode 100644 index 00000000..3a68cc92 --- /dev/null +++ b/just @@ -0,0 +1,16 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# just + +> `just` can refer to multiple commands with the same name. + +- View documentation for the command runner: + +`tldr just.1` + +- View documentation for the V8 JavaScript runtime: + +`tldr just.js` diff --git a/just.1 b/just.1 new file mode 100644 index 00000000..ad09ac31 --- /dev/null +++ b/just.1 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# just + +> Save and run project-specific commands. +> More information: . + +- Run a recipe specified in the justfile: + +`just {{recipe}}` + +- Initialize new justfile in project root: + +`just --init` + +- Edit justfile in the default editor: + +`just -e` + +- List available recipes in the justfile: + +`just -l` + +- Print justfile: + +`just --dump` diff --git a/jwt b/jwt new file mode 100644 index 00000000..84082815 --- /dev/null +++ b/jwt @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jwt + +> Work with JSON Web Tokens (JWTs). +> Encryption algorithms available are HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384. +> More information: . + +- Decode a JWT: + +`jwt decode {{jwt_string}}` + +- Decode a JWT as a JSON string: + +`jwt decode -j {{jwt_string}}` + +- Encode a JSON string to a JWT: + +`jwt encode --alg {{HS256}} --secret {{1234567890}} '{{json_string}}'` + +- Encode key pair payload to JWT: + +`jwt encode --alg {{HS256}} --secret {{1234567890}} -P {{key=value}}` diff --git a/k3d b/k3d new file mode 100644 index 00000000..4c383848 --- /dev/null +++ b/k3d @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# k3d + +> A wrapper to easily create k3s clusters inside Docker. +> More information: . + +- Create a cluster: + +`k3d cluster create {{cluster_name}}` + +- Delete a cluster: + +`k3d cluster delete {{cluster_name}}` + +- Create a new containerized k3s node: + +`k3d node create {{node_name}}` + +- Import an image from Docker into a k3d cluster: + +`k3d image import {{image_name}} --cluster {{cluster_name}}` + +- Create a new registry: + +`k3d registry create {{registry_name}}` diff --git a/k6 b/k6 new file mode 100644 index 00000000..b28a9f2c --- /dev/null +++ b/k6 @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# k6 + +> Open source load testing tool and SaaS for engineering teams. +> More information: . + +- Run load test locally: + +`k6 run {{script.js}}` + +- Run load test locally with a given number of virtual users and duration: + +`k6 run --vus {{10}} --duration {{30s}} {{script.js}}` + +- Run load test locally with a given environment variable: + +`k6 run -e {{HOSTNAME=example.com}} {{script.js}}` + +- Run load test locally using InfluxDB to store results: + +`k6 run --out influxdb={{http://localhost:8086/k6db}} {{script.js}}` + +- Run load test locally and discard response bodies (significantly faster): + +`k6 run --discard-response-bodies {{script.js}}` + +- Run load test locally using the base JavaScript compatibility mode (significantly faster): + +`k6 run --compatibility-mode=base {{script.js}}` + +- Log in to cloud service using secret token: + +`k6 login cloud --token {{secret}}` + +- Run load test on cloud infrastructure: + +`k6 cloud {{script.js}}` diff --git a/k8s-unused-secret-detector b/k8s-unused-secret-detector new file mode 100644 index 00000000..e326191b --- /dev/null +++ b/k8s-unused-secret-detector @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# k8s-unused-secret-detector + +> Command-line interface tool for detecting unused Kubernetes secrets. +> More information: . + +- Detect unused secrets: + +`k8s-unused-secret-detector` + +- Detect unused secrets in a specific namespace: + +`k8s-unused-secret-detector -n {{namespace}}` + +- Delete unused secrets in a specific namespace: + +`k8s-unused-secret-detector -n {{namespace}} | kubectl delete secret -n {{namespace}}` diff --git a/k8sec b/k8sec new file mode 100644 index 00000000..93e9c888 --- /dev/null +++ b/k8sec @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# k8sec + +> Command-line interface tool to manage Kubernetes secrets. +> More information: . + +- List all secrets: + +`k8sec list` + +- List a specific secret as a base64-encoded string: + +`k8sec list {{secret_name}} --base64` + +- Set a secret's value: + +`k8sec set {{secret_name}} {{key=value}}` + +- Set a base64-encoded value: + +`k8sec set --base64 {{secret_name}} {{key=encoded_value}}` + +- Unset a secret: + +`k8sec unset {{secret_name}}` + +- Load secrets from a file: + +`k8sec load -f {{path/to/file}} {{secret_name}}` + +- Dump secrets to a file: + +`k8sec dump -f {{path/to/file}} {{secret_name}}` diff --git a/k9s b/k9s new file mode 100644 index 00000000..40f025e3 --- /dev/null +++ b/k9s @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# k9s + +> View and manage Kubernetes clusters. +> More information: . + +- Manage a cluster using a kubeconfig context: + +`k9s --context {{kubeconfig_context_name}}` + +- Manage a cluster in read-only mode (disabling all commands that may cause modifications): + +`k9s --readonly --cluster {{cluster_name}}` + +- Manage a cluster using a given kubernetes namespace: + +`k9s --namespace {{kubernetes_namespace}} --cluster {{cluster_name}}` + +- Manage a cluster launching k9s in the pod view and enable debug logging: + +`k9s --command {{pod}} --logLevel debug --cluster {{cluster_name}}` diff --git a/kafkacat b/kafkacat new file mode 100644 index 00000000..b8b93a24 --- /dev/null +++ b/kafkacat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kafkacat + +> This command is an alias of `kcat`. + +- View documentation for the original command: + +`tldr kcat` diff --git a/kaggle b/kaggle new file mode 100644 index 00000000..b86adfdc --- /dev/null +++ b/kaggle @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kaggle + +> Official CLI for Kaggle implemented in Python 3. +> More information: . + +- View current configuration values: + +`kaggle config view` + +- Download a specific file from a competition dataset: + +`kaggle competitions download {{competition}} -f {{filename}}` diff --git a/kahlan b/kahlan new file mode 100644 index 00000000..b1252d15 --- /dev/null +++ b/kahlan @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kahlan + +> A unit and Behaviour Driven Development test framework for PHP. +> More information: . + +- Run all specifications in the "spec" directory: + +`kahlan` + +- Run specifications using a specific configuration file: + +`kahlan --config={{path/to/configuration_file}}` + +- Run specifications and output using a reporter: + +`kahlan --reporter={{dot|bar|json|tap|verbose}}` + +- Run specifications with code coverage (detail can be between 0 and 4): + +`kahlan --coverage={{detail_level}}` diff --git a/kak b/kak new file mode 100644 index 00000000..c320b50d --- /dev/null +++ b/kak @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kak + +> Kakoune is a mode-based code editor implementing the "multiple selections" paradigm. +> Data can be selected and simultaneously edited in different locations, using multiple selections; users can also connect to the same session for collaborative editing. +> More information: . + +- Open a file and enter normal mode, to execute commands: + +`kak {{path/to/file}}` + +- Enter insert mode from normal mode, to write text into the file: + +`i` + +- Escape insert mode, to go back to normal mode: + +`` + +- Replace all instances of "foo" in the current file with "bar": + +`%s{{foo}}c{{bar}}` + +- Unselect all secondary selections, and keep only the main one: + +`` + +- Search for numbers and select the first two: + +`/\d+N` + +- Insert the contents of a file: + +`!cat {{path/to/file}}` + +- Save the current file: + +`:w` diff --git a/kate b/kate new file mode 100644 index 00000000..dfe9acb6 --- /dev/null +++ b/kate @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kate + +> KDE's advanced text editor. +> More information: . + +- Open specific files: + +`kate {{path/to/file1 path/to/file2 ...}}` + +- Open specific remote files: + +`kate {{https://example.com/path/to/file1 https://example.com/path/to/file2 ...}}` + +- Create a new editor instance even if one is already open: + +`kate --new` + +- Open a file with the cursor at the specific line: + +`kate --line {{line_number}} {{path/to/file}}` + +- Open a file with the cursor at the specific line and column: + +`kate --line {{line_number}} --column {{column_number}} {{path/to/file}}` + +- Create a file from `stdin`: + +`cat {{path/to/file}} | kate --stdin` + +- Display help: + +`kate --help` diff --git a/kcadm.sh b/kcadm.sh new file mode 100644 index 00000000..35bc110a --- /dev/null +++ b/kcadm.sh @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kcadm.sh + +> Perform administration tasks. +> More information: . + +- Start an authenticated session: + +`kcadm.sh config credentials --server {{host}} --realm {{realm_name}} --user {{username}} --password {{password}}` + +- Create a user: + +`kcadm.sh create users -s username={{username}} -r {{realm_name}}` + +- List all realms: + +`kcadm.sh get realms` + +- Update a realm with JSON config: + +`kcadm.sh update realms/{{realm_name}} -f {{path/to/file.json}}` diff --git a/kcat b/kcat new file mode 100644 index 00000000..2193e303 --- /dev/null +++ b/kcat @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kcat + +> Apache Kafka producer and consumer tool. +> More information: . + +- Consume messages starting with the newest offset: + +`kcat -C -t {{topic}} -b {{brokers}}` + +- Consume messages starting with the oldest offset and exit after the last message is received: + +`kcat -C -t {{topic}} -b {{brokers}} -o beginning -e` + +- Consume messages as a Kafka consumer group: + +`kcat -G {{group_id}} {{topic}} -b {{brokers}}` + +- Publish message by reading from `stdin`: + +`echo {{message}} | kcat -P -t {{topic}} -b {{brokers}}` + +- Publish messages by reading from a file: + +`kcat -P -t {{topic}} -b {{brokers}} {{path/to/file}}` + +- List metadata for all topics and brokers: + +`kcat -L -b {{brokers}}` + +- List metadata for a specific topic: + +`kcat -L -t {{topic}} -b {{brokers}}` + +- Get offset for a topic/partition for a specific point in time: + +`kcat -Q -t {{topic}}:{{partition}}:{{unix_timestamp}} -b {{brokers}}` diff --git a/kdeconnect-cli b/kdeconnect-cli new file mode 100644 index 00000000..62bd5af2 --- /dev/null +++ b/kdeconnect-cli @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kdeconnect-cli + +> KDE's Connect CLI. +> More information: . + +- List all devices: + +`kdeconnect-cli --list-devices` + +- List available (paired and reachable) devices: + +`kdeconnect-cli --list-available` + +- Request pairing with a specific device, specifying its ID: + +`kdeconnect-cli --pair --device {{device_id}}` + +- Ring a device, specifying its name: + +`kdeconnect-cli --ring --name "{{device_name}}"` + +- Share an URL or file with a paired device, specifying its ID: + +`kdeconnect-cli --share {{url|path/to/file}} --device {{device_id}}` + +- Send an SMS with an optional attachment to a specific number: + +`kdeconnect-cli --name "{{device_name}}" --send-sms "{{message}}" --destination {{phone_number}} --attachment {{path/to/file}}` + +- Unlock a specific device: + +`kdeconnect-cli --name "{{device_name}}" --unlock` + +- Simulate a key press on a specific device: + +`kdeconnect-cli --name "{{device_name}}" --send-keys {{key}}` diff --git a/kdenlive b/kdenlive new file mode 100644 index 00000000..2a088458 --- /dev/null +++ b/kdenlive @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kdenlive + +> KDE's non-linear video editor. +> More information: . + +- Start the video editor: + +`kdenlive` + +- Open a specific file: + +`kdenlive {{path/to/file.kdenlive}}` + +- Use a specific path for an MLT environment: + +`kdenlive --mlt-path {{path/to/directory}}` + +- Use a specific log level for an MLT environment: + +`kdenlive --mlt-log {{verbose|debug}}` + +- Display help: + +`kdenlive --help` + +- Display version: + +`kdenlive --version` diff --git a/kdig b/kdig new file mode 100644 index 00000000..3a59cb60 --- /dev/null +++ b/kdig @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kdig + +> Advanced DNS lookup utility. +> More information: . + +- Lookup the IP(s) associated with a hostname (A records): + +`kdig {{example.com}}` + +- Specify a specific DNS server to query (e.g. Google DNS): + +`kdig {{example.com}} @{{8.8.8.8}}` + +- Query a specific DNS record type associated with a given domain name: + +`kdig {{example.com}} {{A|AAAA|NS|SOA|DNSKEY|ANY}}` + +- Lookup the IP(s) associated with a hostname (A records) using DNS over TLS (DoT): + +`kdig -d @{{8.8.8.8}} +tls-ca +tls-host={{dns.google}} {{example.com}}` + +- Lookup the IP(s) associated with a hostname (A records) using DNS over HTTPS (DoH): + +`kdig -d @{{1.1.1.1}} +https +tls-hostname={{1dot1dot1dot1.cloudflare-dns.com}} {{example.com}}` diff --git a/keep-header b/keep-header new file mode 100644 index 00000000..17b19d24 --- /dev/null +++ b/keep-header @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keep-header + +> Keep first line untouched by a command, passing it directly to `stdout`. +> More information: . + +- Sort a file and keep the first line at the top: + +`keep-header {{path/to/file}} -- sort` + +- Output first line directly to `stdout`, passing the remainder of the file through the specified command: + +`keep-header {{path/to/file}} -- {{command}}` + +- Read from `stdin`, sorting all except the first line: + +`cat {{path/to/file}} | keep-header -- {{command}}` + +- Grep a file, keeping the first line regardless of the search pattern: + +`keep-header {{path/to/file}} -- grep {{pattern}}` diff --git a/keepass2 b/keepass2 new file mode 100644 index 00000000..4a6aa11e --- /dev/null +++ b/keepass2 @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keepass2 + +> A light-weight password manager. +> More information: . + +- Start KeePass 2, opening the most recently opened password database: + +`keepass2` + +- Start KeePass 2, opening a specific password database: + +`keepass2 {{path/to/database.kbdx}}` + +- Use a specific key file to open a password database: + +`keepass2 {{path/to/database.kbdx}} -keyfile:{{path/to/key/file.key}}` diff --git a/keepassxc-cli b/keepassxc-cli new file mode 100644 index 00000000..f6810bb8 --- /dev/null +++ b/keepassxc-cli @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keepassxc-cli + +> Command-line interface for KeepassXC. +> More information: . + +- Search entries: + +`keepassxc-cli search {{path/to/database_file}} {{name}}` + +- List the contents of a folder: + +`keepassxc-cli ls {{path/to/database_file}} {{/path/to/directory}}` + +- Add an entry with an auto-generated password: + +`keepassxc-cli add --generate {{path/to/database_file}} {{entry_name}}` + +- Delete an entry: + +`keepassxc-cli rm {{path/to/database_file}} {{entry_name}}` + +- Copy an entry's password to the clipboard: + +`keepassxc-cli clip {{path/to/database_file}} {{entry_name}}` + +- Copy a TOTP code to the clipboard: + +`keepassxc-cli clip --totp {{path/to/database_file}} {{entry_name}}` + +- Generate a passphrase with 7 words: + +`keepassxc-cli diceware --words {{7}}` + +- Generate a password with 16 printable ASCII characters: + +`keepassxc-cli generate --lower --upper --numeric --special --length {{16}}` diff --git a/keybase b/keybase new file mode 100644 index 00000000..8d22f540 --- /dev/null +++ b/keybase @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keybase + +> Key directory that maps social media identities to encryption keys in a publicly auditable manner. +> More information: . + +- Follow another user: + +`keybase follow {{username}}` + +- Add a new proof: + +`keybase prove {{service}} {{service_username}}` + +- Sign a file: + +`keybase sign --infile {{input_file}} --outfile {{output_file}}` + +- Verify a signed file: + +`keybase verify --infile {{input_file}} --outfile {{output_file}}` + +- Encrypt a file: + +`keybase encrypt --infile {{input_file}} --outfile {{output_file}} {{receiver}}` + +- Decrypt a file: + +`keybase decrypt --infile {{input_file}} --outfile {{output_file}}` + +- Revoke current device, log out, and delete local data: + +`keybase deprovision` diff --git a/keychain b/keychain new file mode 100644 index 00000000..2c8d25fa --- /dev/null +++ b/keychain @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keychain + +> Re-use ssh-agent and/or gpg-agent between logins. +> More information: . + +- Check for a running ssh-agent, and start one if needed: + +`keychain` + +- Also check for gpg-agent: + +`keychain --agents "{{gpg,ssh}}"` + +- List signatures of all active keys: + +`keychain --list` + +- List fingerprints of all active keys: + +`keychain --list-fp` + +- Add a timeout for identities added to the agent, in minutes: + +`keychain --timeout {{minutes}}` diff --git a/keytool b/keytool new file mode 100644 index 00000000..226adb49 --- /dev/null +++ b/keytool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# keytool + +> A certificate management utility included with Java. +> More information: . + +- Create a keystore: + +`keytool -genkeypair -v -keystore {{path/to/file.keystore}} -alias {{key_name}}` + +- Change a keystore password: + +`keytool -storepasswd -keystore {{path/to/file.keystore}}` + +- Change a key's password inside a specific keystore: + +`keytool -keypasswd -alias {{key_name}} -keystore {{path/to/file.keystore}}` diff --git a/khal b/khal new file mode 100644 index 00000000..7f656139 --- /dev/null +++ b/khal @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# khal + +> A text-based calendar and scheduling application for the command-line. +> More information: . + +- Start Khal on interactive mode: + +`ikhal` + +- Print all events scheduled in personal calendar for the next seven days: + +`khal list -a {{personal}} {{today}} {{7d}}` + +- Print all events scheduled not in personal calendar for tomorrow at 10:00: + +`khal at -d {{personal}} {{tomorrow}} {{10:00}}` + +- Print a calendar with a list of events for the next three months: + +`khal calendar` + +- Add new event to personal calendar: + +`khal new -a {{personal}} {{2020-09-08}} {{18:00}} {{18:30}} "{{Dentist appointment}}"` diff --git a/kill b/kill new file mode 100644 index 00000000..b0727dfd --- /dev/null +++ b/kill @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kill + +> Sends a signal to a process, usually related to stopping the process. +> All signals except for SIGKILL and SIGSTOP can be intercepted by the process to perform a clean exit. +> More information: . + +- Terminate a program using the default SIGTERM (terminate) signal: + +`kill {{process_id}}` + +- List available signal names (to be used without the `SIG` prefix): + +`kill -l` + +- Terminate a program using the SIGHUP (hang up) signal. Many daemons will reload instead of terminating: + +`kill -{{1|HUP}} {{process_id}}` + +- Terminate a program using the SIGINT (interrupt) signal. This is typically initiated by the user pressing `Ctrl + C`: + +`kill -{{2|INT}} {{process_id}}` + +- Signal the operating system to immediately terminate a program (which gets no chance to capture the signal): + +`kill -{{9|KILL}} {{process_id}}` + +- Signal the operating system to pause a program until a SIGCONT ("continue") signal is received: + +`kill -{{17|STOP}} {{process_id}}` + +- Send a `SIGUSR1` signal to all processes with the given GID (group id): + +`kill -{{SIGUSR1}} -{{group_id}}` diff --git a/killall b/killall new file mode 100644 index 00000000..3126c7b2 --- /dev/null +++ b/killall @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# killall + +> Send kill signal to all instances of a process by name (must be exact name). +> All signals except SIGKILL and SIGSTOP can be intercepted by the process, allowing a clean exit. +> More information: . + +- Terminate a process using the default SIGTERM (terminate) signal: + +`killall {{process_name}}` + +- [l]ist available signal names (to be used without the 'SIG' prefix): + +`killall -l` + +- Interactively ask for confirmation before termination: + +`killall -i {{process_name}}` + +- Terminate a process using the SIGINT (interrupt) signal, which is the same signal sent by pressing `Ctrl + C`: + +`killall -INT {{process_name}}` + +- Force kill a process: + +`killall -KILL {{process_name}}` diff --git a/kind b/kind new file mode 100644 index 00000000..9365f258 --- /dev/null +++ b/kind @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kind + +> Run local Kubernetes clusters using Docker container "nodes". +> Designed for testing Kubernetes itself, but may be used for local development or continuous integration. +> More information: . + +- Create a local Kubernetes cluster: + +`kind create cluster --name {{cluster_name}}` + +- Delete one or more clusters: + +`kind delete clusters {{cluster_name}}` + +- Get details about clusters, nodes, or the kubeconfig: + +`kind get {{clusters|nodes|kubeconfig}}` + +- Export the kubeconfig or the logs: + +`kind export {{kubeconfig|logs}}` diff --git a/kinit b/kinit new file mode 100644 index 00000000..d0b474e1 --- /dev/null +++ b/kinit @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kinit + +> Authenticate a principal with a Kerberos server to gain and cache a ticket. +> Note: A Kerberos principal can be either a user, service, or application. +> More information: . + +- Authenticate a user and obtain a ticket-granting ticket: + +`kinit {{username}}` + +- Renew a ticket-granting ticket: + +`kinit -R` + +- Specify a lifetime for the ticket: + +`kinit -l {{5h}}` + +- Specify a total renewable lifetime for the ticket: + +`kinit -r {{1w}}` + +- Specify a different principal name to authenticate as: + +`kinit -p {{principal@REALM}}` + +- Specify a different keytab file to authenticate with: + +`kinit -t {{path/to/keytab}}` diff --git a/kismet b/kismet new file mode 100644 index 00000000..be2e8e2e --- /dev/null +++ b/kismet @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +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: . + +- Capture packets from a specific wireless interface: + +`sudo kismet -c {{wlan0}}` + +- Monitor multiple channels on a wireless interface: + +`sudo kismet -c {{wlan0,wlan1}} -m` + +- Capture packets and save them to a specific directory: + +`sudo kismet -c {{wlan0}} -d {{path/to/output}}` + +- Start Kismet with a specific configuration file: + +`sudo kismet -c {{wlan0}} -f {{path/to/config.conf}}` + +- Monitor and log data to an SQLite database: + +`sudo kismet -c {{wlan0}} --log-to-db` + +- Monitor using a specific data source: + +`sudo kismet -c {{wlan0}} --data-source={{rtl433}}` + +- Enable alerts for specific events: + +`sudo kismet -c {{wlan0}} --enable-alert={{new_ap}}` + +- Display detailed information about a specific AP's packets: + +`sudo kismet -c {{wlan0}} --info {{BSSID}}` diff --git a/kitex b/kitex new file mode 100644 index 00000000..51be1e82 --- /dev/null +++ b/kitex @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kitex + +> Code generation tool provided by the Go RPC framework Kitex. +> Kitex accepts both thrift and protobuf IDLs, and supports generating a skeleton of a server side project. +> More information: . + +- Generate client codes when a project is in `$GOPATH`: + +`kitex {{path/to/IDL_file.thrift}}` + +- Generate client codes when a project is not in `$GOPATH`: + +` kitex -module {{github.com/xx-org/xx-name}} {{path/to/IDL_file.thrift}}` + +- Generate client codes with protobuf IDL: + +`kitex -type protobuf {{path/to/IDL_file.proto}}` + +- Generate server codes: + +`kitex -service {{svc_name}} {{path/to/IDL_file.thrift}}` diff --git a/kitty b/kitty new file mode 100644 index 00000000..6fc1d418 --- /dev/null +++ b/kitty @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kitty + +> A fast, feature-rich, GPU based terminal emulator. +> More information: . + +- Open a new terminal: + +`kitty` + +- Open a terminal with the specified title for the window: + +`kitty --title "{{title}}"` + +- Start the theme-chooser builtin: + +`kitty +kitten themes` + +- Display an image in the terminal: + +`kitty +kitten icat {{path/to/image}}` + +- Copy the contents of `stdin` to the clipboard: + +`echo {{example}} | kitty +kitten clipboard` diff --git a/kiwi-ng b/kiwi-ng new file mode 100644 index 00000000..96de81de --- /dev/null +++ b/kiwi-ng @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kiwi-ng + +> An OS image and appliance builder. +> More information: . + +- Build an appliance: + +`kiwi-ng system build --description={{path/to/directory}} --target-dir={{path/to/directory}}` + +- Show build result of built appliance: + +`kiwi-ng result list --target-dir={{path/to/directory}}` + +- Display help: + +`kiwi-ng help` + +- Display version: + +`kiwi-ng -v` diff --git a/knife b/knife new file mode 100644 index 00000000..71d09933 --- /dev/null +++ b/knife @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# knife + +> Interact with a Chef server from a local Chef repo. +> More information: . + +- Bootstrap a new node: + +`knife bootstrap {{fqdn_or_ip}}` + +- List all registered nodes: + +`knife node list` + +- Show a node: + +`knife node show {{node_name}}` + +- Edit a node: + +`knife node edit {{node_name}}` + +- Edit a role: + +`knife role edit {{role_name}}` + +- View a data bag: + +`knife data bag show {{data_bag_name}} {{data_bag_item}}` + +- Upload a local cookbook to the Chef server: + +`knife cookbook upload {{cookbook_name}}` diff --git a/kompose b/kompose new file mode 100644 index 00000000..300469d5 --- /dev/null +++ b/kompose @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kompose + +> Convert docker-compose applications to Kubernetes. +> More information: . + +- Deploy a dockerized application to Kubernetes: + +`kompose up -f {{docker-compose.yml}}` + +- Delete instantiated services/deployments from Kubernetes: + +`kompose down -f {{docker-compose.yml}}` + +- Convert a docker-compose file into Kubernetes resources file: + +`kompose convert -f {{docker-compose.yml}}` diff --git a/kool b/kool new file mode 100644 index 00000000..1a813d8e --- /dev/null +++ b/kool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kool + +> Build software development environments. +> More information: . + +- Create a project using a specific preset: + +`kool create {{preset}} {{project_name}}` + +- Run a specific script defined in the `kool.yml` file in the current directory: + +`kool run {{script}}` + +- Start/stop services in the current directory: + +`kool {{start|stop}}` + +- Display status of the services in the current directory: + +`kool status` + +- Update to the latest version: + +`kool self-update` + +- Print the completion script for the specified shell: + +`kool completion {{bash|fish|powershell|zsh}}` diff --git a/kopia b/kopia new file mode 100644 index 00000000..126274d0 --- /dev/null +++ b/kopia @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kopia + +> Fast, secure open-source backup tool. +> Supports encryption, compression, deduplication, and incremental snapshots. +> More information: . + +- Create a repository in the local filesystem: + +`kopia repository create filesystem --path {{path/to/local_repository}}` + +- Create a repository on Amazon S3: + +`kopia repository create s3 --bucket {{bucket_name}} --access-key {{AWS_access_key_id}} --secret-access-key {{AWS_secret_access_key}}` + +- Connect to a repository: + +`kopia repository connect {{repository_type}} --path {{path/to/repository}}` + +- Create a snapshot of a directory: + +`kopia snapshot create {{path/to/directory}}` + +- List snapshots: + +`kopia snapshot list` + +- Restore a snapshot to a specific directory: + +`kopia snapshot restore {{snapshot_id}} {{path/to/target_directory}}` + +- Create a new policy: + +`kopia policy set --global --keep-latest {{number_of_snapshots_to_keep}} --compression {{compression_algorithm}}` + +- Ignore a specific file or folder from backups: + +`kopia policy set --global --add-ignore {{path/to/file_or_folder}}` diff --git a/kops b/kops new file mode 100644 index 00000000..b3de2b7b --- /dev/null +++ b/kops @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kops + +> Create, destroy, upgrade and maintain Kubernetes clusters. +> More information: . + +- Create a cluster from the configuration specification: + +`kops create cluster -f {{cluster_name.yaml}}` + +- Create a new ssh public key: + +`kops create secret sshpublickey {{key_name}} -i {{~/.ssh/id_rsa.pub}}` + +- Export the cluster configuration to the `~/.kube/config` file: + +`kops export kubecfg {{cluster_name}}` + +- Get the cluster configuration as YAML: + +`kops get cluster {{cluster_name}} -o yaml` + +- Delete a cluster: + +`kops delete cluster {{cluster_name}} --yes` + +- Validate a cluster: + +`kops validate cluster {{cluster_name}} --wait {{wait_time_until_ready}} --count {{num_required_validations}}` diff --git a/kosmorro b/kosmorro new file mode 100644 index 00000000..f19565b8 --- /dev/null +++ b/kosmorro @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kosmorro + +> Compute the ephemerides and the events for a date at a position on Earth. +> More information: . + +- Get ephemerides for Paris, France: + +`kosmorro --latitude={{48.7996}} --longitude={{2.3511}}` + +- Get ephemerides for Paris, France, in the UTC+2 timezone: + +`kosmorro --latitude={{48.7996}} --longitude={{2.3511}} --timezone={{2}}` + +- Get ephemerides for Paris, France, on June 9th, 2020: + +`kosmorro --latitude={{48.7996}} --longitude={{2.3511}} --date={{2020-06-09}}` + +- Generate a PDF (Note: TeXLive must be installed): + +`kosmorro --format={{pdf}} --output={{path/to/file.pdf}}` diff --git a/kotlin b/kotlin new file mode 100644 index 00000000..42365379 --- /dev/null +++ b/kotlin @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kotlin + +> Kotlin application launcher. +> More information: . + +- Run a jar file: + +`kotlin {{filename.jar}}` + +- Display Kotlin and JVM version: + +`kotlin -version` diff --git a/kotlinc b/kotlinc new file mode 100644 index 00000000..2b286190 --- /dev/null +++ b/kotlinc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kotlinc + +> Kotlin compiler. +> More information: . + +- Start a REPL (interactive shell): + +`kotlinc` + +- Compile a Kotlin file: + +`kotlinc {{path/to/file.kt}}` + +- Compile several Kotlin files: + +`kotlinc {{path/to/file1.kt path/to/file2.kt ...}}` + +- Execute a specific Kotlin Script file: + +`kotlinc -script {{path/to/file.kts}}` + +- Compile a Kotlin file into a self contained jar file with the Kotlin runtime library included: + +`kotlinc {{path/to/file.kt}} -include-runtime -d {{path/to/file.jar}}` diff --git a/krita b/krita new file mode 100644 index 00000000..b9fa5a1f --- /dev/null +++ b/krita @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# krita + +> A sketching and painting program designed for digital artists. +> See also: `gimp`. +> More information: . + +- Start Krita: + +`krita` + +- Open specific files: + +`krita {{path/to/image1 path/to/image2 ...}}` + +- Start without a splash screen: + +`krita --nosplash` + +- Start with a specific workspace: + +`krita --workspace {{Animation}}` + +- Start in fullscreen mode: + +`krita --fullscreen` diff --git a/krunvm b/krunvm new file mode 100644 index 00000000..17b48f94 --- /dev/null +++ b/krunvm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# krunvm + +> Create MicroVMs from OCI images. +> More information: . + +- Create MicroVM based on Fedora: + +`krunvm create {{docker.io/fedora}} --cpus {{number_of_vcpus}} --mem {{memory_in_megabytes}} --name "{{name}}"` + +- Start a specific image: + +`krunvm start "{{image_name}}"` + +- List images: + +`krunvm list` + +- Change a specific image: + +`krunvm changevm --cpus {{number_of_vcpus}} --mem {{memory_in_megabytes}} --name "{{new_vm_name}}" "{{current_vm_name}}"` + +- Delete a specific image: + +`krunvm delete "{{image_name}}"` diff --git a/ksh b/ksh new file mode 100644 index 00000000..7f88ac49 --- /dev/null +++ b/ksh @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ksh + +> Korn Shell, a Bash-compatible command-line interpreter. +> See also: `histexpand`. +> More information: . + +- Start an interactive shell session: + +`ksh` + +- Execute specific [c]ommands: + +`ksh -c "{{echo 'ksh is executed'}}"` + +- Execute a specific script: + +`ksh {{path/to/script.ksh}}` + +- Check a specific script for syntax errors without executing it: + +`ksh -n {{path/to/script.ksh}}` + +- Execute a specific script, printing each command in the script before executing it: + +`ksh -x {{path/to/script.ksh}}` diff --git a/kube-capacity b/kube-capacity new file mode 100644 index 00000000..a1300cde --- /dev/null +++ b/kube-capacity @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kube-capacity + +> Provide an overview of resource requests, limits, and utilization in a Kubernetes cluster. +> Combine the best parts of `kubectl top` and `kubectl describe` into a CLI focused on cluster resources. +> More information: . + +- List nodes including the total CPU and Memory resource requests and limits: + +`kube-capacity` + +- Include pods: + +`kube-capacity -p` + +- Include utilization: + +`kube-capacity -u` diff --git a/kube-fzf b/kube-fzf new file mode 100644 index 00000000..9bfbb2d0 --- /dev/null +++ b/kube-fzf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kube-fzf + +> Shell commands for command-line fuzzy searching of Kubernetes Pods. +> See also `kubectl` for related commands. +> More information: . + +- Get pod details (from current namespace): + +`findpod` + +- Get pod details (from all namespaces): + +`findpod -a` + +- Describe a pod: + +`describepod` + +- Tail pod logs: + +`tailpod` + +- Exec into a pod's container: + +`execpod {{shell_command}}` + +- Port-forward a pod: + +`pfpod {{port_number}}` diff --git a/kubeadm b/kubeadm new file mode 100644 index 00000000..ad93de85 --- /dev/null +++ b/kubeadm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubeadm + +> Command-line interface for creating and managing Kubernetes clusters. +> More information: . + +- Create a Kubernetes master node: + +`kubeadm init` + +- Bootstrap a Kubernetes worker node and join it to a cluster: + +`kubeadm join --token {{token}}` + +- Create a new bootstrap token with a TTL of 12 hours: + +`kubeadm token create --ttl {{12h0m0s}}` + +- Check if the Kubernetes cluster is upgradeable and which versions are available: + +`kubeadm upgrade plan` + +- Upgrade Kubernetes cluster to a specified version: + +`kubeadm upgrade apply {{version}}` + +- View the kubeadm ConfigMap containing the cluster's configuration: + +`kubeadm config view` + +- Revert changes made to the host by 'kubeadm init' or 'kubeadm join': + +`kubeadm reset` diff --git a/kubectl b/kubectl new file mode 100644 index 00000000..348107c8 --- /dev/null +++ b/kubectl @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl + +> Command-line interface for running commands against Kubernetes clusters. +> Some subcommands such as `kubectl run` have their own usage documentation. +> More information: . + +- List information about a resource with more details: + +`kubectl get {{pod|service|deployment|ingress|...}} -o wide` + +- Update specified pod with the label 'unhealthy' and the value 'true': + +`kubectl label pods {{name}} unhealthy=true` + +- List all resources with different types: + +`kubectl get all` + +- Display resource (CPU/Memory/Storage) usage of nodes or pods: + +`kubectl top {{pod|node}}` + +- Print the address of the master and cluster services: + +`kubectl cluster-info` + +- Display an explanation of a specific field: + +`kubectl explain {{pods.spec.containers}}` + +- Print the logs for a container in a pod or specified resource: + +`kubectl logs {{pod_name}}` + +- Run command in an existing pod: + +`kubectl exec {{pod_name}} -- {{ls /}}` diff --git a/kubectl-apply b/kubectl-apply new file mode 100644 index 00000000..e1d23185 --- /dev/null +++ b/kubectl-apply @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl apply + +> Manages applications through files defining Kubernetes resources. It creates and updates resources in a cluster. +> More information: . + +- Apply a configuration to a resource by file name or `stdin`: + +`kubectl apply -f {{resource_filename}}` + +- Edit the latest last-applied-configuration annotations of resources from the default editor: + +`kubectl apply edit-last-applied -f {{resource_filename}}` + +- Set the latest last-applied-configuration annotations by setting it to match the contents of a file: + +`kubectl apply set-last-applied -f {{resource_filename}}` + +- View the latest last-applied-configuration annotations by type/name or file: + +`kubectl apply view-last-applied -f {{resource_filename}}` diff --git a/kubectl-create b/kubectl-create new file mode 100644 index 00000000..5aed4a28 --- /dev/null +++ b/kubectl-create @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl create + +> Create a resource from a file or from `stdin`. +> More information: . + +- Create a resource using the resource definition file: + +`kubectl create -f {{path/to/file.yml}}` + +- Create a resource from `stdin`: + +`kubectl create -f -` + +- Create a deployment: + +`kubectl create deployment {{deployment_name}} --image={{image}}` + +- Create a deployment with replicas: + +`kubectl create deployment {{deployment_name}} --image={{image}} --replicas={{number_of_replicas}}` + +- Create a service: + +`kubectl create service {{service_type}} {{service_name}} --tcp={{port}}:{{target_port}}` + +- Create a namespace: + +`kubectl create namespace {{namespace_name}}` diff --git a/kubectl-delete b/kubectl-delete new file mode 100644 index 00000000..a7daaa04 --- /dev/null +++ b/kubectl-delete @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl delete + +> Delete Kubernetes resources. +> More information: . + +- Delete a specific pod: + +`kubectl delete pod {{pod_name}}` + +- Delete a specific deployment: + +`kubectl delete deployment {{deployment_name}}` + +- Delete a specific node: + +`kubectl delete node {{node_name}}` + +- Delete all pods in a specified namespace: + +`kubectl delete pods --all --namespace {{namespace}}` + +- Delete all deployments and services in a specified namespace: + +`kubectl delete deployments,services --all --namespace {{namespace}}` + +- Delete all nodes: + +`kubectl delete nodes --all` + +- Delete resources defined in a YAML manifest: + +`kubectl delete --filename {{path/to/manifest.yaml}}` diff --git a/kubectl-describe b/kubectl-describe new file mode 100644 index 00000000..ea81bbe4 --- /dev/null +++ b/kubectl-describe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl describe + +> Show details of Kubernetes objects and resources. +> More information: . + +- Show details of pods in a [n]amespace: + +`kubectl describe pods --namespace {{namespace}}` + +- Show details of nodes in a [n]amespace: + +`kubectl describe nodes --namespace {{namespace}}` + +- Show the details of a specific pod in a [n]amespace: + +`kubectl describe pods {{pod_name}} --namespace {{namespace}}` + +- Show the details of a specific node in a [n]amespace: + +`kubectl describe nodes {{node_name}} --namespace {{namespace}}` + +- Show details of Kubernetes objects defined in a YAML manifest [f]ile: + +`kubectl describe --file {{path/to/manifest.yaml}}` diff --git a/kubectl-edit b/kubectl-edit new file mode 100644 index 00000000..6d94589f --- /dev/null +++ b/kubectl-edit @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl edit + +> Edit Kubernetes resources. +> More information: . + +- Edit a pod: + +`kubectl edit pod/{{pod_name}}` + +- Edit a deployment: + +`kubectl edit deployment/{{deployment_name}}` + +- Edit a service: + +`kubectl edit svc/{{service_name}}` + +- Edit a resource using a specific editor: + +`KUBE_EDITOR={{nano}} kubectl edit {{resource}}/{{resource_name}}` + +- Edit a resource in JSON format: + +`kubectl edit {{resource}}/{{resource_name}} --output json` diff --git a/kubectl-expose b/kubectl-expose new file mode 100644 index 00000000..890d673f --- /dev/null +++ b/kubectl-expose @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl expose + +> Expose a resource as a new Kubernetes service. +> More information: . + +- Create a service for a resource, which will be served from container port to node port: + +`kubectl expose {{resource_type}} {{resource_name}} --port={{node_port}} --target-port={{container_port}}` + +- Create a service for a resource identified by a file: + +`kubectl expose -f {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` + +- Create a service with a name, to serve to a node port which will be same for container port: + +`kubectl expose {{resource_type}} {{resource_name}} --port={{node_port}} --name={{service_name}}` diff --git a/kubectl-get b/kubectl-get new file mode 100644 index 00000000..9ed5765b --- /dev/null +++ b/kubectl-get @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl get + +> Get Kubernetes objects and resources. +> More information: . + +- Get all namespaces in the current cluster: + +`kubectl get namespaces` + +- Get nodes in a specified [n]amespace: + +`kubectl get nodes --namespace {{namespace}}` + +- Get pods in a specified [n]amespace: + +`kubectl get pods --namespace {{namespace}}` + +- Get deployments in a specified [n]amespace: + +`kubectl get deployments --namespace {{namespace}}` + +- Get services in a specified [n]amespace: + +`kubectl get services --namespace {{namespace}}` + +- Get all resources in a specified [n]amespace: + +`kubectl get all --namespace {{namespace}}` + +- Get Kubernetes objects defined in a YAML manifest [f]ile: + +`kubectl get --file {{path/to/manifest.yaml}}` diff --git a/kubectl-label b/kubectl-label new file mode 100644 index 00000000..d7525c3a --- /dev/null +++ b/kubectl-label @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl label + +> Label Kubernetes resources. +> More information: . + +- Label a pod: + +`kubectl label pod {{pod_name}} {{key}}={{value}}` + +- Update a pod label by overwriting the existing value: + +`kubectl label --overwrite {{pod_name}} {{key}}={{value}}` + +- Label all pods in the namespace: + +`kubectl label pods --all {{key}}={{value}}` + +- Label pod identified by pod definition file: + +`kubectl label -f {{pod_defination_file}} {{key}}={{value}}` + +- Remove the label from a pod: + +`kubectl label pod {{pod_name}} {{key}}-` diff --git a/kubectl-logs b/kubectl-logs new file mode 100644 index 00000000..01f772bd --- /dev/null +++ b/kubectl-logs @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl logs + +> Show logs for containers in a pod. +> More information: . + +- Show logs for a single-container pod: + +`kubectl logs {{pod_name}}` + +- Show logs for a specified container in a pod: + +`kubectl logs --container {{container_name}} {{pod_name}}` + +- Show logs for all containers in a pod: + +`kubectl logs --all-containers={{true}} {{pod_name}}` + +- Stream pod logs: + +`kubectl logs --follow {{pod_name}}` + +- Stream logs for a specified container in a pod: + +`kubectl logs --follow --container {{container_name}} {{pod_name}}` + +- Show pod logs newer than a relative time like `10s`, `5m`, or `1h`: + +`kubectl logs --since={{relative_time}} {{pod_name}}` + +- Show the 10 most recent logs in a pod: + +`kubectl logs --tail={{10}} {{pod_name}}` diff --git a/kubectl-replace b/kubectl-replace new file mode 100644 index 00000000..6f693a80 --- /dev/null +++ b/kubectl-replace @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl replace + +> Replace a resource by file or `stdin`. +> More information: . + +- Replace the resource using the resource definition file: + +`kubectl replace -f {{path/to/file.yml}}` + +- Replace the resource using the input passed into `stdin`: + +`kubectl replace -f -` + +- Force replace, delete and then re-create the resource: + +`kubectl replace --force -f {{path/to/file.yml}}` diff --git a/kubectl-rollout b/kubectl-rollout new file mode 100644 index 00000000..ab45ae6a --- /dev/null +++ b/kubectl-rollout @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl rollout + +> Manage the rollout of a Kubernetes resource (deployments, daemonsets, and statefulsets). +> More information: . + +- Start a rolling restart of a resource: + +`kubectl rollout restart {{resource_type}}/{{resource_name}}` + +- Watch the rolling update status of a resource: + +`kubectl rollout status {{resource_type}}/{{resource_name}}` + +- Roll back a resource to the previous revision: + +`kubectl rollout undo {{resource_type}}/{{resource_name}}` + +- View the rollout history of a resource: + +`kubectl rollout history {{resource_type}}/{{resource_name}}` diff --git a/kubectl-run b/kubectl-run new file mode 100644 index 00000000..67a84137 --- /dev/null +++ b/kubectl-run @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl run + +> Run pods in Kubernetes. Specifies pod generator to avoid deprecation error in some K8S versions. +> More information: . + +- Run an nginx pod and expose port 80: + +`kubectl run {{nginx-dev}} --image=nginx --port 80` + +- Run an nginx pod, setting the TEST_VAR environment variable: + +`kubectl run {{nginx-dev}} --image=nginx --env="{{TEST_VAR}}={{testing}}"` + +- Show API calls that would be made to create an nginx container: + +`kubectl run {{nginx-dev}} --image=nginx --dry-run={{none|server|client}}` + +- Run an Ubuntu pod interactively, never restart it, and remove it when it exits: + +`kubectl run {{temp-ubuntu}} --image=ubuntu:22.04 --restart=Never --rm -- /bin/bash` + +- Run an Ubuntu pod, overriding the default command with echo, and specifying custom arguments: + +`kubectl run {{temp-ubuntu}} --image=ubuntu:22.04 --command -- echo {{argument1 argument2 ...}}` diff --git a/kubectl-scale b/kubectl-scale new file mode 100644 index 00000000..75037396 --- /dev/null +++ b/kubectl-scale @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl scale + +> Set a new size for a deployment, replica set, replication controller, or stateful set. +> More information: . + +- Scale a replica set: + +`kubectl scale --replicas={{number_of_replicas}} rs/{{replica_name}}` + +- Scale a resource identified by a file: + +`kubectl scale --replicas={{number_of_replicas}} -f {{path/to/file.yml}}` + +- Scale a deployment based on current number of replicas: + +`kubectl scale --current-replicas={{current_replicas}} --replicas={{number_of_replicas}} deployment/{{deployment_name}}` diff --git a/kubectl-taint b/kubectl-taint new file mode 100644 index 00000000..4f6339b7 --- /dev/null +++ b/kubectl-taint @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl taint + +> Update the taints on nodes. +> More information: . + +- Apply taint to a node: + +`kubectl taint nodes {{node_name}} {{label_key}}={{label_value}}:{{effect}}` + +- Remove taint from a node: + +`kubectl taint nodes {{node_name}} {{label_key}}:{{effect}}-` + +- Remove all taints from a node: + +`kubectl taint nodes {{node_name}} {{label_key}}-` diff --git a/kubectx b/kubectx new file mode 100644 index 00000000..0607376a --- /dev/null +++ b/kubectx @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectx + +> Utility to manage and switch between `kubectl` contexts. +> More information: . + +- List the contexts: + +`kubectx` + +- Switch to a named context: + +`kubectx {{name}}` + +- Switch to the previous context: + +`kubectx -` + +- Delete a named context: + +`kubectx -d {{name}}` diff --git a/kubens b/kubens new file mode 100644 index 00000000..ed68c8b1 --- /dev/null +++ b/kubens @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubens + +> Utility to switch between Kubernetes namespaces. +> More information: . + +- List the namespaces: + +`kubens` + +- Change the active namespace: + +`kubens {{name}}` + +- Switch to the previous namespace: + +`kubens -` diff --git a/kubetail b/kubetail new file mode 100644 index 00000000..c8d0d64a --- /dev/null +++ b/kubetail @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubetail + +> Utility to tail multiple Kubernetes pod logs at the same time. +> More information: . + +- Tail the logs of multiple pods (whose name starts with "my_app") in one go: + +`kubetail {{my_app}}` + +- Tail only a specific container from multiple pods: + +`kubetail {{my_app}} -c {{my_container}}` + +- To tail multiple containers from multiple pods: + +`kubetail {{my_app}} -c {{my_container_1}} -c {{my_container_2}}` + +- To tail multiple applications at the same time separate them by comma: + +`kubetail {{my_app_1}},{{my_app_2}}` diff --git a/kustomize b/kustomize new file mode 100644 index 00000000..d4ee555b --- /dev/null +++ b/kustomize @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kustomize + +> Easily deploy resources for Kubernetes. +> More information: . + +- Create a kustomization file with resources and namespace: + +`kustomize create --resources {{deployment.yaml,service.yaml}} --namespace {{staging}}` + +- Build a kustomization file and deploy it with `kubectl`: + +`kustomize build . | kubectl apply -f -` + +- Set an image in the kustomization file: + +`kustomize edit set image {{busybox=alpine:3.6}}` + +- Search for Kubernetes resources in the current directory to be added to the kustomization file: + +`kustomize create --autodetect` diff --git a/l2ping b/l2ping new file mode 100644 index 00000000..e20afd2d --- /dev/null +++ b/l2ping @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# l2ping + +> Send an L2CAP echo request and receive an answer. +> More information: . + +- Ping a Bluetooth device: + +`sudo l2ping {{mac_address}}` + +- Reverse ping a Bluetooth device: + +`sudo l2ping -r {{mac_address}}` + +- Ping a Bluetooth device from a specified interface: + +`sudo l2ping -i {{hci0}} {{mac_address}}` + +- Ping Bluetooth device with a specified sized data package: + +`sudo l2ping -s {{byte_count}} {{mac_address}}` + +- Ping flood a Bluetooth device: + +`sudo l2ping -f {{mac_address}}` + +- Ping a Bluetooth device a specified amount of times: + +`sudo l2ping -c {{amount}} {{mac_address}}` + +- Ping a Bluetooth device with a specified delay between requests: + +`sudo l2ping -d {{seconds}} {{mac_address}}` diff --git a/lambo b/lambo new file mode 100644 index 00000000..6a46ae9d --- /dev/null +++ b/lambo @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lambo + +> A super-powered `laravel new` for Laravel and Valet. +> See also `lambo new` for additional command flags. +> More information: . + +- Create a new Laravel application: + +`lambo new {{app_name}}` + +- Open the configuration in your default editor: + +`lambo edit-config` + +- Open the configuration in a specific editor: + +`lambo edit-config --editor="{{path/to/editor}}"` + +- Open the configuration file that is run after new applications have been scaffolded: + +`lambo edit-after` diff --git a/lambo-new b/lambo-new new file mode 100644 index 00000000..59bb165d --- /dev/null +++ b/lambo-new @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lambo new + +> A super-powered `laravel new` for Laravel and Valet. +> More information: . + +- Create a new Laravel application: + +`lambo new {{app_name}}` + +- Install the application in a specific path: + +`lambo new --path={{path/to/directory}} {{app_name}}` + +- Include authentication scaffolding: + +`lambo new --auth {{app_name}}` + +- Include a specific frontend: + +`lambo new --{{vue|bootstrap|react}} {{app_name}}` + +- Install npm dependencies after the project has been created: + +`lambo new --node {{app_name}}` + +- Create a Valet site after the project has been created: + +`lambo new --link {{app_name}}` + +- Create a new MySQL database with the same name as the project: + +`lambo new --create-db --dbuser={{user}} --dbpassword={{password}} {{app_name}}` + +- Open a specific editor after the project has been created: + +`lambo new --editor="{{editor}}" {{app_name}}` diff --git a/lando b/lando new file mode 100644 index 00000000..fabc8500 --- /dev/null +++ b/lando @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lando + +> Local development environment and DevOps tool built on Docker. +> More information: . + +- Initialize code for use with `lando`: + +`lando init` + +- Print information about your app: + +`lando info` + +- Start your app: + +`lando start` + +- Stop your app: + +`lando stop` + +- Restart your app: + +`lando restart` + +- Rebuild your app from scratch, preserving data: + +`lando rebuild` + +- Display logs for your app: + +`lando logs` + +- Destroy your app: + +`lando destroy` diff --git a/laravel b/laravel new file mode 100644 index 00000000..5bdaafa5 --- /dev/null +++ b/laravel @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# laravel + +> A command-line installer for the Laravel framework. +> More information: . + +- Create a new Laravel application: + +`laravel new {{name}}` + +- Use the latest development release: + +`laravel new {{name}} --dev` + +- Overwrite if the directory already exists: + +`laravel new {{name}} --force` + +- Install the Laravel Jetstream scaffolding: + +`laravel new {{name}} --jet` + +- Install the Laravel Jetstream scaffolding with a specific stack: + +`laravel new {{name}} --jet --stack {{livewire|inertia}}` + +- Install the Laravel Jetstream scaffolding with support for teams: + +`laravel new {{name}} --jet --teams` + +- List the available installer commands: + +`laravel list` diff --git a/laravel-zero b/laravel-zero new file mode 100644 index 00000000..9bf26b50 --- /dev/null +++ b/laravel-zero @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# laravel-zero + +> A command-line installer for the Laravel Zero framework. +> More information: . + +- Create a new Laravel Zero application: + +`laravel-zero new {{name}}` + +- Update the installer to the latest version: + +`laravel-zero self-update` + +- List the available installer commands: + +`laravel-zero list` diff --git a/last b/last new file mode 100644 index 00000000..d6e8d1fe --- /dev/null +++ b/last @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# last + +> View the last logged in users. +> More information: . + +- View last logins, their duration and other information as read from `/var/log/wtmp`: + +`last` + +- Specify how many of the last logins to show: + +`last -n {{login_count}}` + +- Print the full date and time for entries and then display the hostname column last to prevent truncation: + +`last -F -a` + +- View all logins by a specific user and show the IP address instead of the hostname: + +`last {{username}} -i` + +- View all recorded reboots (i.e., the last logins of the pseudo user "reboot"): + +`last reboot` + +- View all recorded shutdowns (i.e., the last logins of the pseudo user "shutdown"): + +`last shutdown` diff --git a/latex b/latex new file mode 100644 index 00000000..83b95aaa --- /dev/null +++ b/latex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# latex + +> Compile a DVI document from LaTeX source files. +> More information: . + +- Compile a DVI document: + +`latex {{source.tex}}` + +- Compile a DVI document, specifying an output directory: + +`latex -output-directory={{path/to/directory}} {{source.tex}}` + +- Compile a DVI document, exiting on each error: + +`latex -halt-on-error {{source.tex}}` diff --git a/latexdiff b/latexdiff new file mode 100644 index 00000000..a83f4529 --- /dev/null +++ b/latexdiff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# latexdiff + +> Determine differences between two LaTeX files. +> More information: . + +- Determine changes between different versions of a LaTeX file (the resulting LaTeX file can be compiled to show differences underlined): + +`latexdiff {{old.tex}} {{new.tex}} > {{diff.tex}}` + +- Determine changes between different versions of a LaTeX file by highlighting differences in boldface: + +`latexdiff --type=BOLD {{old.tex}} {{new.tex}} > {{diff.tex}}` + +- Determine changes between different versions of a LaTeX file, and display minor changes in equations with both added and deleted graphics: + +`latexdiff --math-markup=fine --graphics-markup=both {{old.tex}} {{new.tex}} > {{diff.tex}}` diff --git a/latexmk b/latexmk new file mode 100644 index 00000000..b563bda9 --- /dev/null +++ b/latexmk @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# latexmk + +> Compile LaTeX source files into finished documents. +> Automatically does multiple runs when needed. +> More information: . + +- Compile a DVI (Device Independent file) document from every source: + +`latexmk` + +- Compile a DVI document from a specific source file: + +`latexmk {{source.tex}}` + +- Compile a PDF document: + +`latexmk -pdf {{source.tex}}` + +- Force the generation of a document even if there are errors: + +`latexmk -f {{source.tex}}` + +- Clean up temporary TEX files created for a specific TEX file: + +`latexmk -c {{source.tex}}` + +- Clean up all temporary TEX files in the current directory: + +`latexmk -c` diff --git a/laydown b/laydown new file mode 100644 index 00000000..28154622 --- /dev/null +++ b/laydown @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# laydown + +> Command line application to prepare for Daily Standup. +> More information: . + +- Add an item to DID section: + +`laydown did {{item}}` + +- Add an item to DOING section: + +`laydown doing {{item}}` + +- Clear all items: + +`laydown clear` + +- Use an editor to edit current data: + +`laydown edit` + +- Archive and clear current data: + +`laydown archive` diff --git a/lb b/lb new file mode 100644 index 00000000..e3419a33 --- /dev/null +++ b/lb @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lb + +> Manage a blog contained in the current directory. +> Drafts and posts to operate on are selected interactively when running the commands. +> More information: . + +- Make a new draft: + +`lb new` + +- Edit a draft: + +`lb edit` + +- Delete a draft: + +`lb trash` + +- Publish a draft: + +`lb publish` + +- Delete a published post: + +`lb delete` + +- Unpublish a published post to edit it as a draft again: + +`lb revise` diff --git a/lckdo b/lckdo new file mode 100644 index 00000000..130b8aaf --- /dev/null +++ b/lckdo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lckdo + +> This command is deprecated and superseded by `flock`. +> More information: . + +- View documentation for the recommended replacement: + +`tldr flock` diff --git a/ld b/ld new file mode 100644 index 00000000..7beebac2 --- /dev/null +++ b/ld @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ld + +> Link object files together. +> More information: . + +- Link a specific object file with no dependencies into an executable: + +`ld {{path/to/file.o}} --output {{path/to/output_executable}}` + +- Link two object files together: + +`ld {{path/to/file1.o}} {{path/to/file2.o}} --output {{path/to/output_executable}}` + +- Dynamically link an x86_64 program to glibc (file paths change depending on the system): + +`ld --output {{path/to/output_executable}} --dynamic-linker /lib/ld-linux-x86-64.so.2 /lib/crt1.o /lib/crti.o -lc {{path/to/file.o}} /lib/crtn.o` diff --git a/ldapsearch b/ldapsearch new file mode 100644 index 00000000..e83e6f0b --- /dev/null +++ b/ldapsearch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ldapsearch + +> Query an LDAP directory. +> More information: . + +- Query an LDAP server for all items that are a member of the given group and return the object's displayName value: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` + +- Query an LDAP server with a no-newline password file for all items that are a member of the given group and return the object's displayName value: + +`ldapsearch -D '{{admin_DN}}' -y '{{password_file}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` + +- Return 5 items that match the given filter: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -z 5 displayName` + +- Wait up to 7 seconds for a response: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -l 7 displayName` + +- Invert the filter: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '(!(memberOf={{group1}}))' displayName` + +- Return all items that are part of multiple groups, returning the display name for each item: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})({{memberOf=group3}}))' "displayName"` + +- Return all items that are members of at least 1 of the specified groups: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(|({{memberOf=group1}})({{memberOf=group1}})({{memberOf=group3}}))' displayName` + +- Combine multiple boolean logic filters: + +`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})(!({{memberOf=group3}})))' displayName` diff --git a/ldc b/ldc new file mode 100644 index 00000000..e4bd0ff1 --- /dev/null +++ b/ldc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ldc + +> D compiler using LLVM as a backend. +> More information: . + +- Compile a source code file into an executable binary: + +`ldc2 {{path/to/source.d}} -of={{path/to/output_executable}}` + +- Compile the source code file without linking: + +`ldc2 -c {{path/to/source.d}}` + +- Select the target architecture and OS: + +`ldc -mtriple={{architecture_OS}} -c {{path/to/source.d}}` + +- Display help: + +`ldc2 -h` + +- Display complete help: + +`ldc2 -help-hidden` diff --git a/leaftoppm b/leaftoppm new file mode 100644 index 00000000..002a1e62 --- /dev/null +++ b/leaftoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# leaftoppm + +> Convert an Interleaf image to a PPM image. +> More information: . + +- Generate a PPM image file as output for an Interleaf image file as input: + +`leaftoppm {{path/to/file.pl}}` + +- Display version: + +`leaftoppm -version` diff --git a/leave b/leave new file mode 100644 index 00000000..f17b89cf --- /dev/null +++ b/leave @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# leave + +> Set a reminder for when it's time to leave. +> To remove reminders use `kill $(pidof leave)`. +> More information: . + +- Set a reminder at a given time: + +`leave {{time_to_leave}}` + +- Set a reminder to leave at noon: + +`leave {{1200}}` + +- Set a reminder in a specific amount of time: + +`leave +{{amount_of_time}}` + +- Set a reminder to leave in 4 hours and 4 minutes: + +`leave +{{0404}}` diff --git a/lebab b/lebab new file mode 100644 index 00000000..5894dd87 --- /dev/null +++ b/lebab @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lebab + +> A JavaScript modernizer for transpiling code to ES6/ES7. +> Transformations must be provided for all examples. +> More information: . + +- Transpile using one or more comma-separated transformations: + +`lebab --transform {{transformation1,transformation2,...}}` + +- Transpile a file to `stdout`: + +`lebab {{path/to/input_file}}` + +- Transpile a file to the specified output file: + +`lebab {{path/to/input_file}} --out-file {{path/to/output_file}}` + +- Replace all `.js` files in-place in the specified directory, glob or file: + +`lebab --replace {{directory|glob|file}}` + +- Display help: + +`lebab --help` diff --git a/ledger b/ledger new file mode 100644 index 00000000..7b30a058 --- /dev/null +++ b/ledger @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ledger + +> A powerful, double-entry accounting system. +> More information: . + +- Print a balance report showing totals: + +`ledger balance --file {{path/to/ledger.journal}}` + +- List all postings in Expenses ordered by amount: + +`ledger register {{expenses}} --sorted {{amount}}` + +- Print total Expenses other than Drinks and Food: + +`ledger balance {{Expenses}} and not ({{Drinks}} or {{Food}})` + +- Print a budget report: + +`ledger budget` + +- Print summary information about all the postings: + +`ledger stats` diff --git a/lein b/lein new file mode 100644 index 00000000..d36c7d0d --- /dev/null +++ b/lein @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lein + +> Manage Clojure projects with declarative configuration. +> More information: . + +- Generate scaffolding for a new project based on a template: + +`lein new {{template_name}} {{project_name}}` + +- Start a REPL session either with the project or standalone: + +`lein repl` + +- Run the project's `-main` function with optional args: + +`lein run {{args}}` + +- Run the project's tests: + +`lein test` + +- Package up the project files and all its dependencies into a jar file: + +`lein uberjar` diff --git a/lerna b/lerna new file mode 100644 index 00000000..29a9f9cb --- /dev/null +++ b/lerna @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lerna + +> Manage JavaScript projects with multiple packages. +> More information: . + +- Initialize project files (`lerna.json`, `package.json`, `.git`, etc.): + +`lerna init` + +- Install all external dependencies of each package and symlink together local dependencies: + +`lerna bootstrap` + +- Run a specific script for every package that contains it in its `package.json`: + +`lerna run {{script}}` + +- Execute an arbitrary shell command in every package: + +`lerna exec -- {{ls}}` + +- Publish all packages that have changed since the last release: + +`lerna publish` diff --git a/less b/less new file mode 100644 index 00000000..eaf0b0d1 --- /dev/null +++ b/less @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# less + +> Open a file for interactive reading, allowing scrolling and search. +> More information: . + +- Open a file: + +`less {{source_file}}` + +- Page down/up: + +` (down), b (up)` + +- Go to end/start of file: + +`G (end), g (start)` + +- Forward search for a string (press `n`/`N` to go to next/previous match): + +`/{{something}}` + +- Backward search for a string (press `n`/`N` to go to next/previous match): + +`?{{something}}` + +- Follow the output of the currently opened file: + +`F` + +- Open the current file in an editor: + +`v` + +- Exit: + +`q` diff --git a/lex b/lex new file mode 100644 index 00000000..69726f0f --- /dev/null +++ b/lex @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lex + +> Lexical analyzer generator. +> Given the specification for a lexical analyzer, generates C code implementing it. +> Note: on most major OSes, this command is an alias for `flex`. +> More information: . + +- Generate an analyzer from a Lex file, storing it to the file `lex.yy.c`: + +`lex {{analyzer.l}}` + +- Specify the output file: + +`lex -t {{analyzer.l}} > {{analyzer.c}}` + +- Compile a C file generated by Lex: + +`c99 {{path/to/lex.yy.c}} -o {{executable}}` diff --git a/license b/license new file mode 100644 index 00000000..28f14ddc --- /dev/null +++ b/license @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# license + +> Create license files for open-source projects. +> More information: . + +- Print a license to `stdout`, using the defaults (auto-detected author name, and current year): + +`license {{license_name}}` + +- Generate a license and save it to a file: + +`license -o {{path/to/file}} {{license_name}}` + +- List all available licenses: + +`license ls` + +- Generate a license with custom author name and year: + +`license --name {{author}} --year {{release_year}} {{license_name}}` diff --git a/licensor b/licensor new file mode 100644 index 00000000..8216a9c8 --- /dev/null +++ b/licensor @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# licensor + +> Write licenses to `stdout`. +> More information: . + +- Write the MIT license to a file named `LICENSE`: + +`licensor {{MIT}} > {{LICENSE}}` + +- Write the MIT license with a [p]laceholder copyright notice to a file named `LICENSE`: + +`licensor -p {{MIT}} > {{LICENSE}}` + +- Specify a copyright holder named Bobby Tables: + +`licensor {{MIT}} {{"Bobby Tables"}} > {{LICENSE}}` + +- Specify licence exceptions with a WITH expression: + +`licensor "{{Apache-2.0 WITH LLVM-exception}}" > {{LICENSE}}` + +- List all available licenses: + +`licensor --licenses` + +- List all available exceptions: + +`licensor --exceptions` diff --git a/light-arionum-cli b/light-arionum-cli new file mode 100644 index 00000000..d11274c2 --- /dev/null +++ b/light-arionum-cli @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# light-arionum-cli + +> The PHP light wallet for the Arionum cryptocurrency. +> More information: . + +- Generate a new public/private key pair: + +`light-arionum-cli` + +- Display the balance of the current address: + +`light-arionum-cli balance` + +- Display the balance of the specified address: + +`light-arionum-cli balance {{address}}` + +- Send a transaction with an optional message: + +`light-arionum-cli send {{address}} {{value}} {{optional_message}}` + +- Export the current wallet information: + +`light-arionum-cli export` + +- Display information about the current block: + +`light-arionum-cli block` + +- Display information about the current address' transactions: + +`light-arionum-cli transactions` + +- Display information about a specific transaction: + +`light-arionum-cli transaction {{transaction_id}}` diff --git a/lighthouse b/lighthouse new file mode 100644 index 00000000..94148b9b --- /dev/null +++ b/lighthouse @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lighthouse + +> Analyzes web applications and web pages, collecting modern performance metrics and insights on developer best practices. +> More information: . + +- Generate an HTML report for a specific website and save it to a file in the current directory: + +`lighthouse {{https://example.com}}` + +- Generate a JSON report and print it: + +`lighthouse --output {{json}} {{https://example.com}}` + +- Generate a JSON report and save it to a specific file: + +`lighthouse --output {{json}} --output-path {{path/to/file.json}} {{https://example.com}}` + +- Generate a report using the browser in headless mode without logging to `stdout`: + +`lighthouse --quiet --chrome-flags="{{--headless}}" {{https://example.com}}` + +- Generate a report, using the HTTP header key/value pairs in the specified JSON file for all requests: + +`lighthouse --extra-headers={{path/to/file.json}} {{https://example.com}}` + +- Generate a report for specific categories only: + +`lighthouse --only-categories={{performance,accessibility,best-practices,seo,pwa}} {{https://example.com}}` + +- Generate a report with device emulation and all throttling disabled: + +`lighthouse --screenEmulation.disabled --throttling-method={{provided}} --no-emulatedUserAgent {{https://example.com}}` + +- Display help: + +`lighthouse --help` diff --git a/lilypond b/lilypond new file mode 100644 index 00000000..32b57948 --- /dev/null +++ b/lilypond @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lilypond + +> Typeset music and/or produce MIDI from file. +> More information: . + +- Compile a lilypond file into a PDF: + +`lilypond {{path/to/file}}` + +- Compile into the specified format: + +`lilypond --formats={{format_dump}} {{path/to/file}}` + +- Compile the specified file, suppressing progress updates: + +`lilypond -s {{path/to/file}}` + +- Compile the specified file, and also specify the output filename: + +`lilypond --output={{path/to/output_file}} {{path/to/input_file}}` + +- Show the current version of lilypond: + +`lilypond --version` diff --git a/lima b/lima new file mode 100644 index 00000000..2a62e6b6 --- /dev/null +++ b/lima @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lima + +> This command is an alias of `limactl shell` for the default VM instance. +> You can also set the `$LIMA_INSTANCE` environment variable to work on a different instance. +> More information: . + +- View documentation for the original command: + +`tldr limactl` diff --git a/limactl b/limactl new file mode 100644 index 00000000..f62a014e --- /dev/null +++ b/limactl @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# limactl + +> Virtual machine manager for Linux guests, with multiple VM templates available. +> Can be used to run containers on macOS, but also for generic virtual machine use cases on macOS and Linux hosts. +> More information: . + +- List VMs: + +`limactl list` + +- Create a VM using the default settings and optionally provide a name and/or a template (see `limactl create --list-templates` for available templates): + +`limactl create --name {{vm_name}} template://{{debian|fedora|ubuntu|…}}` + +- Start a VM (this might install some dependencies in it and take a few minutes): + +`limactl start {{vm_name}}` + +- Open a remote shell inside a VM: + +`limactl shell {{vm_name}}` + +- Run a command inside a VM: + +`limactl shell {{vm_name}} {{command}}` + +- Stop/shutdown a VM: + +`limactl stop {{vm_name}}` + +- Delete a VM: + +`limactl remove {{vm_name}}` diff --git a/link b/link new file mode 100644 index 00000000..b516474c --- /dev/null +++ b/link @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# link + +> Create a hard link to an existing file. +> For more options, see the `ln` command. +> More information: . + +- Create a hard link from a new file to an existing file: + +`link {{path/to/existing_file}} {{path/to/new_file}}` diff --git a/linkchecker b/linkchecker new file mode 100644 index 00000000..c8a27877 --- /dev/null +++ b/linkchecker @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linkchecker + +> Command-line client to check HTML documents and websites for broken links. +> More information: . + +- Find broken links on : + +`linkchecker {{https://example.com/}}` + +- Also check URLs that point to external domains: + +`linkchecker --check-extern {{https://example.com/}}` + +- Ignore URLs that match a specific regular expression: + +`linkchecker --ignore-url {{regular_expression}} {{https://example.com/}}` + +- Output results to a CSV file: + +`linkchecker --file-output {{csv}}/{{path/to/file}} {{https://example.com/}}` diff --git a/linode-cli b/linode-cli new file mode 100644 index 00000000..803967b8 --- /dev/null +++ b/linode-cli @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli + +> Manage Linode cloud services. +> Some subcommands such as `events` have their own usage documentation. +> More information: . + +- List all Linodes: + +`linode-cli linodes list` + +- View documentation for managing Linode accounts: + +`tldr linode-cli account` + +- View documentation for managing Linodes: + +`tldr linode-cli linodes` + +- View documentation for managing Linode Kubernetes Engine (LKE) clusters: + +`tldr linode-cli lke` + +- View documentation for managing NodeBalancers: + +`tldr linode-cli nodebalancers` + +- View documentation for managing Object Storage: + +`tldr linode-cli object-storage` + +- View documentation for managing domains and DNS configuration: + +`tldr linode-cli domains` + +- View documentation for managing Linode Volumes: + +`tldr linode-cli volumes` diff --git a/linode-cli-account b/linode-cli-account new file mode 100644 index 00000000..bf9ef6a7 --- /dev/null +++ b/linode-cli-account @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli account + +> Manage Linode accounts. +> See also: `linode-cli`. +> More information: . + +- View account: + +`linode-cli account view` + +- View account settings: + +`linode-cli account settings` + +- Make a payment: + +`linode-cli account payment-create --cvv {{cvv}} --usd {{amount_in_dollars}}` + +- View account notifications: + +`linode-cli account notifications-list` diff --git a/linode-cli-domains b/linode-cli-domains new file mode 100644 index 00000000..733302ab --- /dev/null +++ b/linode-cli-domains @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli domains + +> Manage Linode Domains and DNS configuration. +> See also: `linode-cli`. +> More information: . + +- List all managed domains: + +`linode-cli domains list` + +- Create a new managed domain: + +`linode-cli domains create --domain {{domain_name}} --type {{master|slave}} --soa-email {{email}}` + +- View details of a specific domain: + +`linode-cli domains view {{domain_id}}` + +- Delete a managed domain: + +`linode-cli domains delete {{domain_id}}` + +- List records for a specific domain: + +`linode-cli domains records-list {{domain_id}}` + +- Add a DNS record to a domain: + +`linode-cli domains records-create {{domain_id}} --type {{A|AAAA|CNAME|MX|...}} --name {{subdomain}} --target {{target_value}}` + +- Update a DNS record for a domain: + +`linode-cli domains records-update {{domain_id}} {{record_id}} --target {{new_target_value}}` + +- Delete a DNS record from a domain: + +`linode-cli domains records-delete {{domain_id}} {{record_id}}` diff --git a/linode-cli-events b/linode-cli-events new file mode 100644 index 00000000..c5cce51a --- /dev/null +++ b/linode-cli-events @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli events + +> Manage Linode events. +> See also: `linode-cli`. +> More information: . + +- List the events on your account: + +`linode-cli events list` + +- View details about a specific event: + +`linode-cli events view {{event_id}}` + +- Mark an event as read: + +`linode-cli events mark-read {{event_id}}` diff --git a/linode-cli-linodes b/linode-cli-linodes new file mode 100644 index 00000000..3d9256ae --- /dev/null +++ b/linode-cli-linodes @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli linodes + +> Manage Linode instances. +> See also: `linode-cli`. +> More information: . + +- List all Linodes: + +`linode-cli linodes list` + +- Create a new Linode: + +`linode-cli linodes create --type {{linode_type}} --region {{region}} --image {{image_id}}` + +- View details of a specific Linode: + +`linode-cli linodes view {{linode_id}}` + +- Update settings for a Linode: + +`linode-cli linodes update {{linode_id}} --label {{[new_label}}` + +- Delete a Linode: + +`linode-cli linodes delete {{linode_id}}` + +- Perform a power management operation on a Linode: + +`linode-cli linodes {{boot|reboot|shutdown}} {{linode_id}}` + +- List available backups for a Linode: + +`linode-cli linodes backups-list {{linode_id}}` + +- Restore a backup to a Linode: + +`linode-cli linodes backups-restore {{linode_id}} --backup-id {{backup_id}}` diff --git a/linode-cli-lke b/linode-cli-lke new file mode 100644 index 00000000..6412f175 --- /dev/null +++ b/linode-cli-lke @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli lke + +> Manage Linode Kubernetes Engine (LKE) clusters. +> See also: `linode-cli`. +> More information: . + +- List all LKE clusters: + +`linode-cli lke clusters list` + +- Create a new LKE cluster: + +`linode-cli lke clusters create --region {{region}} --type {{type}} --node-type {{node_type}} --nodes-count {{count}}` + +- View details of a specific LKE cluster: + +`linode-cli lke clusters view {{cluster_id}}` + +- Update an existing LKE cluster: + +`linode-cli lke clusters update {{cluster_id}} --node-type {{new_node_type}}` + +- Delete an LKE cluster: + +`linode-cli lke clusters delete {{cluster_id}}` diff --git a/linode-cli-nodebalancers b/linode-cli-nodebalancers new file mode 100644 index 00000000..8d3e874f --- /dev/null +++ b/linode-cli-nodebalancers @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli nodebalancers + +> Manage Linode NodeBalancers. +> See also: `linode-cli`. +> More information: . + +- List all NodeBalancers: + +`linode-cli nodebalancers list` + +- Create a new NodeBalancer: + +`linode-cli nodebalancers create --region {{region}}` + +- View details of a specific NodeBalancer: + +`linode-cli nodebalancers view {{nodebalancer_id}}` + +- Update an existing NodeBalancer: + +`linode-cli nodebalancers update {{nodebalancer_id}} --label {{new_label}}` + +- Delete a NodeBalancer: + +`linode-cli nodebalancers delete {{nodebalancer_id}}` + +- List configurations for a NodeBalancer: + +`linode-cli nodebalancers configs list {{nodebalancer_id}}` + +- Add a new configuration to a NodeBalancer: + +`linode-cli nodebalancers configs create {{nodebalancer_id}} --port {{port}} --protocol {{protocol}}` diff --git a/linode-cli-object-storage b/linode-cli-object-storage new file mode 100644 index 00000000..fb8fba8c --- /dev/null +++ b/linode-cli-object-storage @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli object-storage + +> Manage Linode Object Storage. +> See also: `linode-cli`. +> More information: . + +- List all Object Storage buckets: + +`linode-cli object-storage buckets list` + +- Create a new Object Storage bucket: + +`linode-cli object-storage buckets create --cluster {{cluster_id}} --label {{bucket_label}}` + +- Delete an Object Storage bucket: + +`linode-cli object-storage buckets delete {{cluster_id}} {{bucket_label}}` + +- List Object Storage cluster regions: + +`linode-cli object-storage clusters list` + +- List access keys for Object Storage: + +`linode-cli object-storage keys list` + +- Create a new access key for Object Storage: + +`linode-cli object-storage keys create --label {{label}}` + +- Revoke an access key for Object Storage: + +`linode-cli object-storage keys revoke {{access_key_id}}` diff --git a/linode-cli-tickets b/linode-cli-tickets new file mode 100644 index 00000000..8a752e00 --- /dev/null +++ b/linode-cli-tickets @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli tickets + +> Manage Linode Support Tickets. +> See also: `linode-cli`. +> More information: . + +- List your Support Tickets: + +`linode-cli tickets list` + +- Open a new Ticket: + +`linode-cli tickets create --summary "{{Summary or quick title for the Ticket}}" --description "{{Detailed description of the issue}}"` + +- List replies to a Ticket: + +`linode-cli tickets replies {{ticket_id}}` + +- Reply to a specific Ticket: + +`linode-cli tickets reply {{ticket_id}} --description "{{The content of your reply}}"` diff --git a/linode-cli-volumes b/linode-cli-volumes new file mode 100644 index 00000000..0fc85a66 --- /dev/null +++ b/linode-cli-volumes @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# linode-cli volumes + +> Manage Linode Volumes. +> See also: `linode-cli`. +> More information: . + +- List current Volumes: + +`linode-cli volumes list` + +- Create a new Volume and attach it to a specific Linode: + +`linode-cli volumes create --label {{volume_label}} --size {{size_in_GB}} --linode-id {{linode_id}}` + +- Attach a Volume to a specific Linode: + +`linode-cli volumes attach {{volume_id}} --linode-id {{linode_id}}` + +- Detach a Volume from a Linode: + +`linode-cli volumes detach {{volume_id}}` + +- Resize a Volume (Note: size can only be increased): + +`linode-cli volumes resize {{volume_id}} --size {{new_size_in_GB}}` + +- Delete a Volume: + +`linode-cli volumes delete {{volume_id}}` diff --git a/linux/a2disconf b/linux/a2disconf new file mode 100644 index 00000000..70add053 --- /dev/null +++ b/linux/a2disconf @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2disconf + +> Disable an Apache configuration file on Debian-based OSes. +> More information: . + +- Disable a configuration file: + +`sudo a2disconf {{configuration_file}}` + +- Don't show informative messages: + +`sudo a2disconf --quiet {{configuration_file}}` diff --git a/linux/a2dismod b/linux/a2dismod new file mode 100644 index 00000000..253f32bf --- /dev/null +++ b/linux/a2dismod @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2dismod + +> Disable an Apache module on Debian-based OSes. +> More information: . + +- Disable a module: + +`sudo a2dismod {{module}}` + +- Don't show informative messages: + +`sudo a2dismod --quiet {{module}}` diff --git a/linux/a2dissite b/linux/a2dissite new file mode 100644 index 00000000..666905ca --- /dev/null +++ b/linux/a2dissite @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2dissite + +> Disable an Apache virtual host on Debian-based OSes. +> More information: . + +- Disable a virtual host: + +`sudo a2dissite {{virtual_host}}` + +- Don't show informative messages: + +`sudo a2dissite --quiet {{virtual_host}}` diff --git a/linux/a2enconf b/linux/a2enconf new file mode 100644 index 00000000..153fb413 --- /dev/null +++ b/linux/a2enconf @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2enconf + +> Enable an Apache configuration file on Debian-based OSes. +> More information: . + +- Enable a configuration file: + +`sudo a2enconf {{configuration_file}}` + +- Don't show informative messages: + +`sudo a2enconf --quiet {{configuration_file}}` diff --git a/linux/a2enmod b/linux/a2enmod new file mode 100644 index 00000000..e914dec7 --- /dev/null +++ b/linux/a2enmod @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2enmod + +> Enable an Apache module on Debian-based OSes. +> More information: . + +- Enable a module: + +`sudo a2enmod {{module}}` + +- Don't show informative messages: + +`sudo a2enmod --quiet {{module}}` diff --git a/linux/a2ensite b/linux/a2ensite new file mode 100644 index 00000000..a3a2c759 --- /dev/null +++ b/linux/a2ensite @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2ensite + +> Enable an Apache virtual host on Debian-based OSes. +> More information: . + +- Enable a virtual host: + +`sudo a2ensite {{virtual_host}}` + +- Don't show informative messages: + +`sudo a2ensite --quiet {{virtual_host}}` diff --git a/linux/a2query b/linux/a2query new file mode 100644 index 00000000..9d4b211c --- /dev/null +++ b/linux/a2query @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# a2query + +> Retrieve runtime configuration from Apache on Debian-based OSes. +> More information: . + +- List enabled Apache modules: + +`sudo a2query -m` + +- Check if a specific module is installed: + +`sudo a2query -m {{module_name}}` + +- List enabled virtual hosts: + +`sudo a2query -s` + +- Display the currently enabled Multi Processing Module: + +`sudo a2query -M` + +- Display Apache version: + +`sudo a2query -v` diff --git a/linux/aa-complain b/linux/aa-complain new file mode 100644 index 00000000..f28eaae8 --- /dev/null +++ b/linux/aa-complain @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aa-complain + +> Set an AppArmor policy to complain mode. +> See also: `aa-disable`, `aa-enforce`, `aa-status`. +> More information: . + +- Set policy to complain mode: + +`sudo aa-complain {{path/to/profile1 path/to/profile2 ...}}` + +- Set policies to complain mode: + +`sudo aa-complain --dir {{path/to/profiles}}` diff --git a/linux/aa-disable b/linux/aa-disable new file mode 100644 index 00000000..216915ee --- /dev/null +++ b/linux/aa-disable @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aa-disable + +> Disable AppArmor security policies. +> See also: `aa-complain`, `aa-enforce`, `aa-status`. +> More information: . + +- Disable profile: + +`sudo aa-disable {{path/to/profile1 path/to/profile2 ...}}` + +- Disable profiles (defaults to `/etc/apparmor.d`): + +`sudo aa-disable --dir {{path/to/profiles}}` diff --git a/linux/aa-enforce b/linux/aa-enforce new file mode 100644 index 00000000..a45aeca5 --- /dev/null +++ b/linux/aa-enforce @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aa-enforce + +> Set an AppArmor profile to enforce mode. +> See also: `aa-complain`, `aa-disable`, `aa-status`. +> More information: . + +- Enable profile: + +`sudo aa-enforce {{path/to/profile1 path/to/profile2 ...}}` + +- Enable profiles: + +`sudo aa-enforce --dir {{path/to/profile}}` diff --git a/linux/aa-status b/linux/aa-status new file mode 100644 index 00000000..7ba24fc8 --- /dev/null +++ b/linux/aa-status @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aa-status + +> List currently loaded AppArmor modules. +> See also: `aa-complain`, `aa-disable`, `aa-enforce`. +> More information: . + +- Check status: + +`sudo aa-status` + +- Display the number of loaded policies: + +`sudo aa-status --profiled` + +- Display the number of loaded enforicing policies: + +`sudo aa-status --enforced` + +- Display the number of loaded non-enforcing policies: + +`sudo aa-status --complaining` + +- Display the number of loaded enforcing policies that kill tasks: + +`sudo aa-status --kill` diff --git a/linux/abbr b/linux/abbr new file mode 100644 index 00000000..ce69d736 --- /dev/null +++ b/linux/abbr @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# abbr + +> Manage abbreviations for the fish shell. +> User-defined words are replaced with longer phrases after they are entered. +> More information: . + +- Add a new abbreviation: + +`abbr --add {{abbreviation_name}} {{command}} {{command_arguments}}` + +- Rename an existing abbreviation: + +`abbr --rename {{old_name}} {{new_name}}` + +- Erase an existing abbreviation: + +`abbr --erase {{abbreviation_name}}` + +- Import the abbreviations defined on another host over SSH: + +`ssh {{host_name}} abbr --show | source` diff --git a/linux/abroot b/linux/abroot new file mode 100644 index 00000000..7d99e930 --- /dev/null +++ b/linux/abroot @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# abroot + +> Utility providing full immutability and atomicity by transacting between 2 root partition states (A⟺B). +> Updates are performed using OCI images, to ensure that the system is always in a consistent state. +> More information: . + +- Add packages to the local image (Note: after executing this command, you need to apply these changes.): + +`sudo abroot pkg add {{package}}` + +- Remove packages from the local image (Note: after executing this command, you need to apply these changes.): + +`sudo abroot pkg remove {{package}}` + +- List packages in the local image: + +`sudo abroot pkg list` + +- Apply changes in the local image (Note: you need to reboot your system for these changes to be applied): + +`sudo abroot pkg apply` + +- Rollback your system to previous state: + +`sudo abroot rollback` + +- Edit/View kernel parameters: + +`sudo abroot kargs {{edit|show}}` + +- Display status: + +`sudo abroot status` + +- Display help: + +`abroot --help` diff --git a/linux/ac b/linux/ac new file mode 100644 index 00000000..6539dd7c --- /dev/null +++ b/linux/ac @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ac + +> Print statistics on how long users have been connected. +> More information: . + +- Print how long the current user has been connected in hours: + +`ac` + +- Print how long users have been connected in hours: + +`ac --individual-totals` + +- Print how long a particular user has been connected in hours: + +`ac --individual-totals {{username}}` + +- Print how long a particular user has been connected in hours per day (with total): + +`ac --daily-totals --individual-totals {{username}}` + +- Also display additional details: + +`ac --compatibility` diff --git a/linux/acountry b/linux/acountry new file mode 100644 index 00000000..c3a2b2be --- /dev/null +++ b/linux/acountry @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# acountry + +> Print the country where an IPv4 address or hostname is located. +> More information: . + +- Print a country where an IPv4 address or host is located: + +`acountry {{example.com}}` + +- Print extra [d]ebugging output: + +`acountry -d {{example.com}}` + +- Print more [v]erbose information: + +`acountry -v {{example.com}}` diff --git a/linux/acpi b/linux/acpi new file mode 100644 index 00000000..d9b08057 --- /dev/null +++ b/linux/acpi @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# acpi + +> Shows battery status or thermal information. +> More information: . + +- Show battery information: + +`acpi` + +- Show thermal information: + +`acpi -t` + +- Show cooling device information: + +`acpi -c` + +- Show thermal information in Fahrenheit: + +`acpi -tf` + +- Show all information: + +`acpi -V` + +- Extract information from `/proc` instead of `/sys`: + +`acpi -p` diff --git a/linux/add-apt-repository b/linux/add-apt-repository new file mode 100644 index 00000000..a9e922fb --- /dev/null +++ b/linux/add-apt-repository @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# add-apt-repository + +> Manages `apt` repository definitions. +> More information: . + +- Add a new `apt` repository: + +`add-apt-repository {{repository_spec}}` + +- Remove an `apt` repository: + +`add-apt-repository --remove {{repository_spec}}` + +- Update the package cache after adding a repository: + +`add-apt-repository --update {{repository_spec}}` + +- Allow source packages to be downloaded from the repository: + +`add-apt-repository --enable-source {{repository_spec}}` diff --git a/linux/addpart b/linux/addpart new file mode 100644 index 00000000..fa8507ba --- /dev/null +++ b/linux/addpart @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# addpart + +> Tell the Linux kernel about the existence of the specified partition. +> A simple wrapper around the `add partition` ioctl. +> More information: . + +- Tell the kernel about the existence of the specified partition: + +`addpart {{device}} {{partition}} {{start}} {{length}}` diff --git a/linux/addr2line b/linux/addr2line new file mode 100644 index 00000000..70ffd4ae --- /dev/null +++ b/linux/addr2line @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# addr2line + +> Convert addresses of a binary into file names and line numbers. +> More information: . + +- Display the filename and line number of the source code from an instruction address of an executable: + +`addr2line --exe={{path/to/executable}} {{address}}` + +- Display the function name, filename and line number: + +`addr2line --exe={{path/to/executable}} --functions {{address}}` + +- Demangle the function name for C++ code: + +`addr2line --exe={{path/to/executable}} --functions --demangle {{address}}` diff --git a/linux/adduser b/linux/adduser new file mode 100644 index 00000000..f9ed98fa --- /dev/null +++ b/linux/adduser @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# adduser + +> User addition utility. +> More information: . + +- Create a new user with a default home directory and prompt the user to set a password: + +`adduser {{username}}` + +- Create a new user without a home directory: + +`adduser --no-create-home {{username}}` + +- Create a new user with a home directory at the specified path: + +`adduser --home {{path/to/home}} {{username}}` + +- Create a new user with the specified shell set as the login shell: + +`adduser --shell {{path/to/shell}} {{username}}` + +- Create a new user belonging to the specified group: + +`adduser --ingroup {{group}} {{username}}` diff --git a/linux/adig b/linux/adig new file mode 100644 index 00000000..1866fa60 --- /dev/null +++ b/linux/adig @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# adig + +> Print information received from Domain Name System (DNS) servers. +> More information: . + +- Display A (default) record from DNS for hostname(s): + +`adig {{example.com}}` + +- Display extra [d]ebugging output: + +`adig -d {{example.com}}` + +- Connect to a specific DNS [s]erver: + +`adig -s {{1.2.3.4}} {{example.com}}` + +- Use a specific TCP port to connect to a DNS server: + +`adig -T {{port}} {{example.com}}` + +- Use a specific UDP port to connect to a DNS server: + +`adig -U {{port}} {{example.com}}` diff --git a/linux/ahost b/linux/ahost new file mode 100644 index 00000000..48d38077 --- /dev/null +++ b/linux/ahost @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ahost + +> DNS lookup utility to display the A or AAAA record linked with a hostname or IP address. +> More information: . + +- Print an `A` or `AAAA` record associated with a hostname or IP address: + +`ahost {{example.com}}` + +- Display some extra debugging output: + +`ahost -d {{example.com}}` + +- Display the record with a specified type: + +`ahost -t {{a|aaaa|u}} {{example.com}}` diff --git a/linux/alien b/linux/alien new file mode 100644 index 00000000..06de2514 --- /dev/null +++ b/linux/alien @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# alien + +> Convert different installation packages to other formats. +> See also: `debtap`, for `.deb` conversion on Arch Linux. +> More information: . + +- Convert a specific installation file to Debian format (`.deb` extension): + +`sudo alien --to-deb {{path/to/file}}` + +- Convert a specific installation file to Red Hat format (`.rpm` extension): + +`sudo alien --to-rpm {{path/to/file}}` + +- Convert a specific installation file to a Slackware installation file (`.tgz` extension): + +`sudo alien --to-tgz {{path/to/file}}` + +- Convert a specific installation file to Debian format and install on the system: + +`sudo alien --to-deb --install {{path/to/file}}` diff --git a/linux/alpine b/linux/alpine new file mode 100644 index 00000000..e1f88f3b --- /dev/null +++ b/linux/alpine @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# alpine + +> An email client and Usenet newsgroup program with a pico/nano-inspired interface. +> Supports most modern email services through IMAP. +> More information: . + +- Open alpine normally: + +`alpine` + +- Open alpine directly to the message composition screen to send an email to a given email address: + +`alpine {{email@example.net}}` + +- Quit alpine: + +`q + y` diff --git a/linux/alternatives b/linux/alternatives new file mode 100644 index 00000000..d358cdc5 --- /dev/null +++ b/linux/alternatives @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# alternatives + +> This command is an alias of `update-alternatives`. +> More information: . + +- View documentation for the original command: + +`tldr update-alternatives` diff --git a/linux/amixer b/linux/amixer new file mode 100644 index 00000000..1fd8feb6 --- /dev/null +++ b/linux/amixer @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# amixer + +> Mixer for ALSA soundcard driver. +> More information: . + +- Turn up the master volume by 10%: + +`amixer -D pulse sset Master {{10%+}}` + +- Turn down the master volume by 10%: + +`amixer -D pulse sset Master {{10%-}}` diff --git a/linux/anbox b/linux/anbox new file mode 100644 index 00000000..e09cfd2a --- /dev/null +++ b/linux/anbox @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# anbox + +> Run Android applications on any Linux operating system. +> More information: . + +- Launch Anbox into the app manager: + +`anbox launch --package={{org.anbox.appmgr}} --component={{org.anbox.appmgr.AppViewActivity}}` diff --git a/linux/apache2ctl b/linux/apache2ctl new file mode 100644 index 00000000..6a8b4ca5 --- /dev/null +++ b/linux/apache2ctl @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apache2ctl + +> Administrate the Apache HTTP web server. +> This command comes with Debian based OSes, for RHEL based ones see `httpd`. +> More information: . + +- Start the Apache daemon. Throw a message if it is already running: + +`sudo apache2ctl start` + +- Stop the Apache daemon: + +`sudo apache2ctl stop` + +- Restart the Apache daemon: + +`sudo apache2ctl restart` + +- Test syntax of the configuration file: + +`sudo apache2ctl -t` + +- List loaded modules: + +`sudo apache2ctl -M` diff --git a/linux/apk b/linux/apk new file mode 100644 index 00000000..21ca218c --- /dev/null +++ b/linux/apk @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apk + +> Alpine Linux package management tool. +> More information: . + +- Update repository indexes from all remote repositories: + +`apk update` + +- Install a new package: + +`apk add {{package}}` + +- Remove a package: + +`apk del {{package}}` + +- Repair a package or upgrade it without modifying main dependencies: + +`apk fix {{package}}` + +- Search for a package via keywords: + +`apk search {{keywords}}` + +- Display information about a specific package: + +`apk info {{package}}` diff --git a/linux/aplay b/linux/aplay new file mode 100644 index 00000000..9b0a82ed --- /dev/null +++ b/linux/aplay @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aplay + +> Command-line sound player for ALSA soundcard driver. +> More information: . + +- Play a specific file (sampling rate, bit depth, etc. will be automatically determined for the file format): + +`aplay {{path/to/file}}` + +- Play the first 10 seconds of a specific file at 2500 Hz: + +`aplay --duration={{10}} --rate={{2500}} {{path/to/file}}` + +- Play the raw file as a 22050 Hz, mono, 8-bit, Mu-Law `.au` file: + +`aplay --channels={{1}} --file-type {{raw}} --rate={{22050}} --format={{mu_law}} {{path/to/file}}` diff --git a/linux/apport-bug b/linux/apport-bug new file mode 100644 index 00000000..a8c9e4a3 --- /dev/null +++ b/linux/apport-bug @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apport-bug + +> File a bug report on Ubuntu. +> More information: . + +- Report a bug about the whole system: + +`apport-bug` + +- Report a bug about a specific package: + +`apport-bug {{package}}` + +- Report a bug about a specific executable: + +`apport-bug {{path/to/executable}}` + +- Report a bug about a specific process: + +`apport-bug {{PID}}` diff --git a/linux/apt b/linux/apt new file mode 100644 index 00000000..96afabe5 --- /dev/null +++ b/linux/apt @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt + +> Package management utility for Debian based distributions. +> Recommended replacement for `apt-get` when used interactively in Ubuntu versions 16.04 and later. +> For equivalent commands in other package managers, see . +> More information: . + +- Update the list of available packages and versions (it's recommended to run this before other `apt` commands): + +`sudo apt update` + +- Search for a given package: + +`apt search {{package}}` + +- Show information for a package: + +`apt show {{package}}` + +- Install a package, or update it to the latest available version: + +`sudo apt install {{package}}` + +- Remove a package (using `purge` instead also removes its configuration files): + +`sudo apt remove {{package}}` + +- Upgrade all installed packages to their newest available versions: + +`sudo apt upgrade` + +- List all packages: + +`apt list` + +- List installed packages: + +`apt list --installed` diff --git a/linux/apt-add-repository b/linux/apt-add-repository new file mode 100644 index 00000000..f449282a --- /dev/null +++ b/linux/apt-add-repository @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-add-repository + +> Manages `apt` repository definitions. +> More information: . + +- Add a new `apt` repository: + +`apt-add-repository {{repository_spec}}` + +- Remove an `apt` repository: + +`apt-add-repository --remove {{repository_spec}}` + +- Update the package cache after adding a repository: + +`apt-add-repository --update {{repository_spec}}` + +- Enable source packages: + +`apt-add-repository --enable-source {{repository_spec}}` diff --git a/linux/apt-cache b/linux/apt-cache new file mode 100644 index 00000000..a175b3bc --- /dev/null +++ b/linux/apt-cache @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-cache + +> Debian and Ubuntu package query tool. +> More information: . + +- Search for a package in your current sources: + +`apt-cache search {{query}}` + +- Show information about a package: + +`apt-cache show {{package}}` + +- Show whether a package is installed and up to date: + +`apt-cache policy {{package}}` + +- Show dependencies for a package: + +`apt-cache depends {{package}}` + +- Show packages that depend on a particular package: + +`apt-cache rdepends {{package}}` diff --git a/linux/apt-file b/linux/apt-file new file mode 100644 index 00000000..3d893e0c --- /dev/null +++ b/linux/apt-file @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-file + +> Search for files in `apt` packages, including ones not yet installed. +> More information: . + +- Update the metadata database: + +`sudo apt update` + +- Search for packages that contain the specified file or path: + +`apt-file {{search|find}} {{partial_path/to/file}}` + +- List the contents of a specific package: + +`apt-file {{show|list}} {{package}}` + +- Search for packages that match the `regular_expression`: + +`apt-file {{search|find}} --regexp {{regular_expression}}` diff --git a/linux/apt-get b/linux/apt-get new file mode 100644 index 00000000..b08be899 --- /dev/null +++ b/linux/apt-get @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-get + +> Debian and Ubuntu package management utility. +> Search for packages using `apt-cache`. +> More information: . + +- Update the list of available packages and versions (it's recommended to run this before other `apt-get` commands): + +`apt-get update` + +- Install a package, or update it to the latest available version: + +`apt-get install {{package}}` + +- Remove a package: + +`apt-get remove {{package}}` + +- Remove a package and its configuration files: + +`apt-get purge {{package}}` + +- Upgrade all installed packages to their newest available versions: + +`apt-get upgrade` + +- Clean the local repository - removing package files (`.deb`) from interrupted downloads that can no longer be downloaded: + +`apt-get autoclean` + +- Remove all packages that are no longer needed: + +`apt-get autoremove` + +- Upgrade installed packages (like `upgrade`), but remove obsolete packages and install additional packages to meet new dependencies: + +`apt-get dist-upgrade` diff --git a/linux/apt-key b/linux/apt-key new file mode 100644 index 00000000..f1c48567 --- /dev/null +++ b/linux/apt-key @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-key + +> Key management utility for the APT Package Manager on Debian and Ubuntu. +> Note: `apt-key` is now deprecated (except for the use of `apt-key del` in maintainer scripts). +> More information: . + +- List trusted keys: + +`apt-key list` + +- Add a key to the trusted keystore: + +`apt-key add {{public_key_file.asc}}` + +- Delete a key from the trusted keystore: + +`apt-key del {{key_id}}` + +- Add a remote key to the trusted keystore: + +`wget -qO - {{https://host.tld/filename.key}} | apt-key add -` + +- Add a key from keyserver with only key id: + +`apt-key adv --keyserver {{pgp.mit.edu}} --recv {{KEYID}}` diff --git a/linux/apt-mark b/linux/apt-mark new file mode 100644 index 00000000..0687cb1e --- /dev/null +++ b/linux/apt-mark @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt-mark + +> Utility to change the status of installed packages. +> More information: . + +- Mark a package as automatically installed: + +`sudo apt-mark auto {{package}}` + +- Hold a package at its current version and prevent updates to it: + +`sudo apt-mark hold {{package}}` + +- Allow a package to be updated again: + +`sudo apt-mark unhold {{package}}` + +- Show manually installed packages: + +`apt-mark showmanual` + +- Show held packages that aren't being updated: + +`apt-mark showhold` diff --git a/linux/apt-moo b/linux/apt-moo new file mode 100644 index 00000000..61ce439a --- /dev/null +++ b/linux/apt-moo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apt moo + +> An `APT` easter egg. +> More information: . + +- Print a cow easter egg: + +`apt moo` diff --git a/linux/aptitude b/linux/aptitude new file mode 100644 index 00000000..89ac132a --- /dev/null +++ b/linux/aptitude @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aptitude + +> Debian and Ubuntu package management utility. +> More information: . + +- Synchronize list of packages and versions available. This should be run first, before running subsequent `aptitude` commands: + +`aptitude update` + +- Install a new package and its dependencies: + +`aptitude install {{package}}` + +- Search for a package: + +`aptitude search {{package}}` + +- Search for an installed package (`?installed` is an `aptitude` search term): + +`aptitude search '?installed({{package}})'` + +- Remove a package and all packages depending on it: + +`aptitude remove {{package}}` + +- Upgrade installed packages to the newest available versions: + +`aptitude upgrade` + +- Upgrade installed packages (like `aptitude upgrade`) including removing obsolete packages and installing additional packages to meet new package dependencies: + +`aptitude full-upgrade` + +- Put an installed package on hold to prevent it from being automatically upgraded: + +`aptitude hold '?installed({{package}})'` diff --git a/linux/apx b/linux/apx new file mode 100644 index 00000000..f5a87e42 --- /dev/null +++ b/linux/apx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apx + +> Package management utility with support for multiple sources, allowing you to install packages in subsystems. +> More information: . + +- View documentation for managing package managers: + +`tldr apx pkgmanagers` + +- View documentation for managing stacks: + +`tldr apx stacks` + +- View documentation for managing subsystems: + +`tldr apx subsystems` diff --git a/linux/apx-pkgmanagers b/linux/apx-pkgmanagers new file mode 100644 index 00000000..1bd4e464 --- /dev/null +++ b/linux/apx-pkgmanagers @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apx pkgmanagers + +> Manage package managers in `apx`. +> Note: user-created package manager configurations are stored in `~/.local/share/apx/pkgmanagers`. +> More information: . + +- Interactively create a new package manager configuration: + +`apx pkgmanagers create` + +- List all available package manager confirgurations: + +`apx pkgmanagers list` + +- Remove a package manager configuration: + +`apx pkgmanagers rm --name {{string}}` + +- Display information about a specific package manager: + +`apx pkgmanagers show {{name}}` diff --git a/linux/apx-stacks b/linux/apx-stacks new file mode 100644 index 00000000..33b82859 --- /dev/null +++ b/linux/apx-stacks @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apx stacks + +> Manage stacks in `apx`. +> Note: user-created stack configurations are stored in `~/.local/share/apx/stacks`. +> More information: . + +- Interactively create a new stack configuration: + +`apx stacks new` + +- Interactively update a stack configuration: + +`apx stacks update {{name}}` + +- List all available stack configurations: + +`apx stacks list` + +- Remove a specified stack configuration: + +`apx stacks rm --name {{string}}` + +- Import a stack configuration: + +`apx stacks import --input {{path/to/stack.yml}}` + +- Export the stack configuration (Note: the output flag is optional, it is exported to the current working directory by default): + +`apx stacks export --name {{string}} --output {{path/to/output_file}}` diff --git a/linux/apx-subsystems b/linux/apx-subsystems new file mode 100644 index 00000000..5d706c05 --- /dev/null +++ b/linux/apx-subsystems @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# apx subsystems + +> Manage subsystems in `apx`. +> Subsystems are containers that can be created based on pre-existing stacks. +> More information: . + +- Interactively create a new subsystem: + +`apx subsystems new` + +- List all available subsystems: + +`apx subsystems list` + +- Reset a specific subsystem to its initial state: + +`apx subsystems reset --name {{string}}` + +- [f]orce reset a specific subsystem: + +`apx subsystems reset --name {{string}} --force` + +- Remove a specific subsystem: + +`apx subsystems rm --name {{string}}` + +- [f]orce remove a specific subsystem: + +`apx subsystems rm --name {{string}} --force` diff --git a/linux/arch-chroot b/linux/arch-chroot new file mode 100644 index 00000000..cb1c831a --- /dev/null +++ b/linux/arch-chroot @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arch-chroot + +> Enhanced `chroot` command to help in the Arch Linux installation process. +> More information: . + +- Start an interactive shell (`bash`, by default) in a new root directory: + +`arch-chroot {{path/to/new/root}}` + +- Specify the user (other than the current user) to run the shell as: + +`arch-chroot -u {{user}} {{path/to/new/root}}` + +- Run a custom command (instead of the default `bash`) in the new root directory: + +`arch-chroot {{path/to/new/root}} {{command}} {{command_arguments}}` + +- Specify the shell, other than the default `bash` (in this case, the `zsh` package should have been installed in the target system): + +`arch-chroot {{path/to/new/root}} {{zsh}}` diff --git a/linux/archey b/linux/archey new file mode 100644 index 00000000..f206614d --- /dev/null +++ b/linux/archey @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# archey + +> Simple tool for stylishly displaying system information. +> More information: . + +- Show system information: + +`archey` diff --git a/linux/archinstall b/linux/archinstall new file mode 100644 index 00000000..5458dabb --- /dev/null +++ b/linux/archinstall @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# archinstall + +> Guided Arch Linux installer with a twist. +> More information: . + +- Start the interactive installer: + +`archinstall` + +- Start a preset installer: + +`archinstall {{minimal|unattended}}` diff --git a/linux/archivemount b/linux/archivemount new file mode 100644 index 00000000..0d6615d7 --- /dev/null +++ b/linux/archivemount @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# archivemount + +> Mount an archive for access as a filesystem. +> More information: . + +- Mount an archive to a specific mountpoint: + +`archivemount {{path/to/archive}} {{path/to/mount_point}}` diff --git a/linux/archlinux-java b/linux/archlinux-java new file mode 100644 index 00000000..0001dcc5 --- /dev/null +++ b/linux/archlinux-java @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# archlinux-java + +> Switch between installed Java environments. +> More information: . + +- List installed Java environments: + +`archlinux-java status` + +- Return the short name of the current default Java environment: + +`archlinux-java get` + +- Set the default Java environment: + +`archlinux-java set {{java_environment}}` + +- Unset the default Java environment: + +`archlinux-java unset` + +- Fix an invalid/broken default Java environment configuration: + +`archlinux-java fix` diff --git a/linux/arecord b/linux/arecord new file mode 100644 index 00000000..b2ddd418 --- /dev/null +++ b/linux/arecord @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arecord + +> Sound recorder for ALSA soundcard driver. +> More information: . + +- Record a snippet in "CD" quality (finish with Ctrl-C when done): + +`arecord -vv --format=cd {{path/to/file.wav}}` + +- Record a snippet in "CD" quality, with a fixed duration of 10 seconds: + +`arecord -vv --format=cd --duration={{10}} {{path/to/file.wav}}` + +- Record a snippet and save it as an MP3 (finish with Ctrl-C when done): + +`arecord -vv --format=cd --file-type raw | lame -r - {{path/to/file.mp3}}` + +- List all sound cards and digital audio devices: + +`arecord --list-devices` + +- Allow interactive interface (e.g. use space-bar or enter to play or pause): + +`arecord --interactive` diff --git a/linux/arithmetic b/linux/arithmetic new file mode 100644 index 00000000..6227f1f6 --- /dev/null +++ b/linux/arithmetic @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arithmetic + +> Quiz on simple arithmetic problems. +> More information: . + +- Start an arithmetic quiz: + +`arithmetic` + +- Specify one or more arithmetic [o]peration symbols to get problems on them: + +`arithmetic -o {{+|-|x|/}}` + +- Specify a range. Addition and multiplication problems would feature numbers between 0 and range, inclusive. Subtraction and division problems would have required result and number to be operated on, between 0 and range: + +`arithmetic -r {{7}}` diff --git a/linux/ark b/linux/ark new file mode 100644 index 00000000..e5d22872 --- /dev/null +++ b/linux/ark @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ark + +> KDE's archiving tool. +> More information: . + +- Extract a specific archive into the current directory: + +`ark --batch {{path/to/archive}}` + +- Extract an archive into a specific directory: + +`ark --batch --destination {{path/to/directory}} {{path/to/archive}}` + +- Create an archive if it does not exist and add specific files to it: + +`ark --add-to {{path/to/archive}} {{path/to/file1 path/to/file2 ...}}` diff --git a/linux/arpaname b/linux/arpaname new file mode 100644 index 00000000..0fd5fe5a --- /dev/null +++ b/linux/arpaname @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arpaname + +> Provides corresponding ARPA name for IP addresses. +> More information: . + +- Translate IP addresses (IPv4 and IPv6) to the corresponding ARPA name: + +`arpaname {{ip_address}}` diff --git a/linux/arpspoof b/linux/arpspoof new file mode 100644 index 00000000..511a1192 --- /dev/null +++ b/linux/arpspoof @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# arpspoof + +> Forge ARP replies to intercept packets. +> More information: . + +- Poison all hosts to intercept packets on [i]nterface for the host: + +`sudo arpspoof -i {{wlan0}} {{host_ip}}` + +- Poison [t]arget to intercept packets on [i]nterface for the host: + +`sudo arpspoof -i {{wlan0}} -t {{target_ip}} {{host_ip}}` + +- Poison both [t]arget and host to intercept packets on [i]nterface for the host: + +`sudo arpspoof -i {{wlan0}} -r -t {{target_ip}} {{host_ip}}` diff --git a/linux/as b/linux/as new file mode 100644 index 00000000..dd342019 --- /dev/null +++ b/linux/as @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# as + +> Portable GNU assembler. +> Primarily intended to assemble output from `gcc` to be used by `ld`. +> More information: . + +- Assemble a file, writing the output to `a.out`: + +`as {{file.s}}` + +- Assemble the output to a given file: + +`as {{file.s}} -o {{out.o}}` + +- Generate output faster by skipping whitespace and comment preprocessing. (Should only be used for trusted compilers): + +`as -f {{file.s}}` + +- Include a given path to the list of directories to search for files specified in `.include` directives: + +`as -I {{path/to/directory}} {{file.s}}` diff --git a/linux/ascii b/linux/ascii new file mode 100644 index 00000000..2b5ff360 --- /dev/null +++ b/linux/ascii @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ascii + +> Show ASCII character aliases. +> More information: . + +- Show ASCII aliases of a character: + +`ascii {{a}}` + +- Show ASCII aliases in short, script-friendly mode: + +`ascii -t {{a}}` + +- Show ASCII aliases of multiple characters: + +`ascii -s {{tldr}}` + +- Show ASCII table in decimal: + +`ascii -d` + +- Show ASCII table in hexadecimal: + +`ascii -x` + +- Show ASCII table in octal: + +`ascii -o` + +- Show ASCII table in binary: + +`ascii -b` + +- Show options summary and complete ASCII table: + +`ascii` diff --git a/linux/asciiart b/linux/asciiart new file mode 100644 index 00000000..1d496c62 --- /dev/null +++ b/linux/asciiart @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# asciiart + +> Convert images to ASCII. +> More information: . + +- Read an image from a file and print in ASCII: + +`asciiart {{path/to/image.jpg}}` + +- Read an image from a URL and print in ASCII: + +`asciiart {{www.example.com/image.jpg}}` + +- Choose the output width (default is 100): + +`asciiart --width {{50}} {{path/to/image.jpg}}` + +- Colorize the ASCII output: + +`asciiart --color {{path/to/image.jpg}}` + +- Choose the output format (default format is text): + +`asciiart --format {{text|html}} {{path/to/image.jpg}}` + +- Invert the character map: + +`asciiart --invert-chars {{path/to/image.jpg}}` diff --git a/linux/aspell b/linux/aspell new file mode 100644 index 00000000..3217beae --- /dev/null +++ b/linux/aspell @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aspell + +> Interactive spell checker. +> More information: . + +- Spell check a single file: + +`aspell check {{path/to/file}}` + +- List misspelled words from `stdin`: + +`cat {{path/to/file}} | aspell list` + +- Show available dictionary languages: + +`aspell dicts` + +- Run `aspell` with a different language (takes two-letter ISO 639 language code): + +`aspell --lang={{cs}}` + +- List misspelled words from `stdin` and ignore words from personal word list: + +`cat {{path/to/file}} | aspell --personal={{personal-word-list.pws}} list` diff --git a/linux/asterisk b/linux/asterisk new file mode 100644 index 00000000..a41304c9 --- /dev/null +++ b/linux/asterisk @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# asterisk + +> Run and manage telephone and exchange (phone) server instances. +> More information: . + +- [R]econnect to a running server, and turn on logging 3 levels of [v]erbosity: + +`asterisk -r -vvv` + +- [R]econnect to a running server, run a single command, and return: + +`asterisk -r -x "{{command}}"` + +- Show chan_SIP clients (phones): + +`asterisk -r -x "sip show peers"` + +- Show active calls and channels: + +`asterisk -r -x "core show channels"` + +- Show voicemail mailboxes: + +`asterisk -r -x "voicemail show users"` + +- Terminate a channel: + +`asterisk -r -x "hangup request {{channel_ID}}"` + +- Reload chan_SIP configuration: + +`asterisk -r -x "sip reload"` diff --git a/linux/at b/linux/at new file mode 100644 index 00000000..84a727e2 --- /dev/null +++ b/linux/at @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# at + +> Executes commands at a specified time. +> More information: . + +- Open an `at` prompt to create a new set of scheduled commands, press `Ctrl + D` to save and exit: + +`at {{hh:mm}}` + +- Execute the commands and email the result using a local mailing program such as Sendmail: + +`at {{hh:mm}} -m` + +- Execute a script at the given time: + +`at {{hh:mm}} -f {{path/to/file}}` + +- Display a system notification at 11pm on February 18th: + +`echo "notify-send '{{Wake up!}}'" | at {{11pm}} {{Feb 18}}` diff --git a/linux/atool b/linux/atool new file mode 100644 index 00000000..116de307 --- /dev/null +++ b/linux/atool @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# atool + +> Manage archives of various formats. +> More information: . + +- List files in a `zip` archive: + +`atool --list {{path/to/archive.zip}}` + +- Unpack a tar.gz archive into a new subdirectory (or current directory if it contains only one file): + +`atool --extract {{path/to/archive.tar.gz}}` + +- Create a new `7z` archive with two files: + +`atool --add {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` + +- Extract all `zip` and rar archives in the current directory: + +`atool --each --extract {{*.zip *.rar}}` diff --git a/linux/atop b/linux/atop new file mode 100644 index 00000000..22db796c --- /dev/null +++ b/linux/atop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# atop + +> Linux system and process monitor. +> More information: . + +- Start: + +`atop` + +- Start and display memory consumption for each process: + +`atop -m` + +- Start and display disk information: + +`atop -d` + +- Start and display background process information: + +`atop -c` + +- Start and display thread-specific resource utilization information: + +`atop -y` + +- Start and display the number of processes for each user: + +`atop -au` + +- Display help about interactive commands: + +`?` diff --git a/linux/aura b/linux/aura new file mode 100644 index 00000000..8632fe82 --- /dev/null +++ b/linux/aura @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aura + +> The Aura Package Manager: a secure, multilingual package manager for Arch Linux and the AUR. +> More information: . + +- Search for packages from the official repositories and AUR: + +`aura --aursync --both --search {{keyword|regular_expression}}` + +- Install a package from the AUR: + +`aura --aursync {{package}}` + +- Update all AUR packages in a verbose mode and remove all make dependencies: + +`aura --aursync --diff --sysupgrade --delmakedeps --unsuppress` + +- Install a package from the official repositories: + +`aura --sync {{package}}` + +- Synchronize and update all packages from the official repositories: + +`aura --sync --refresh --sysupgrade` + +- Downgrade a package using the package cache: + +`aura --downgrade {{package}}` + +- Remove a package and its dependencies: + +`aura --remove --recursive --unneeded {{package}}` + +- Remove orphan packages (installed as dependencies but not required by any package): + +`aura --orphans --abandon` diff --git a/linux/auracle b/linux/auracle new file mode 100644 index 00000000..9fb65463 --- /dev/null +++ b/linux/auracle @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# auracle + +> Command-line tool used to interact with Arch Linux's User Repository, commonly referred to as the AUR. +> More information: . + +- Display AUR packages that match a regular expression: + +`auracle search '{{regular_expression}}'` + +- Display information about one or more AUR packages: + +`auracle info {{package1 package2 ...}}` + +- Display the `PKGBUILD` file (build information) of one or more AUR packages: + +`auracle show {{package1 package2 ...}}` + +- Display updates for installed AUR packages: + +`auracle outdated` diff --git a/linux/aurman b/linux/aurman new file mode 100644 index 00000000..e2f25274 --- /dev/null +++ b/linux/aurman @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aurman + +> An Arch Linux utility to build and install packages from the Arch User Repository. +> See also `pacman`. +> More information: . + +- Synchronize and update all packages: + +`aurman --sync --refresh --sysupgrade` + +- Synchronize and update all packages without show changes of `PKGBUILD` files: + +`aurman --sync --refresh --sysupgrade --noedit` + +- Install a new package: + +`aurman --sync {{package}}` + +- Install a new package without show changes of `PKGBUILD` files: + +`aurman --sync --noedit {{package}}` + +- Install a new package without prompting: + +`aurman --sync --noedit --noconfirm {{package}}` + +- Search the package database for a keyword from the official repositories and AUR: + +`aurman --sync --search {{keyword}}` + +- Remove a package and its dependencies: + +`aurman --remove --recursive --nosave {{package}}` + +- Clear the package cache (use two `--clean` flags to clean all packages): + +`aurman --sync --clean` diff --git a/linux/aurvote b/linux/aurvote new file mode 100644 index 00000000..667a74af --- /dev/null +++ b/linux/aurvote @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# aurvote + +> Vote for packages in the Arch User Repository. +> To be able to vote, the file `~/.config/aurvote` must exist and contain your AUR credentials. +> More information: . + +- Interactively create the file `~/.config/aurvote` containing your AUR username and password: + +`aurvote --configure` + +- Vote for one or more AUR packages: + +`aurvote {{package1 package2 ...}}` + +- Unvote one or more AUR packages: + +`aurvote --unvote {{package1 package2 ...}}` + +- Check if one or more AUR packages have already been voted: + +`aurvote --check {{package1 package2 ...}}` + +- Display help: + +`aurvote --help` diff --git a/linux/ausyscall b/linux/ausyscall new file mode 100644 index 00000000..cfd96670 --- /dev/null +++ b/linux/ausyscall @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ausyscall + +> Program that allows mapping syscall names and numbers. +> More information: . + +- Display syscall number of a specific system call: + +`ausyscall {{search_pattern}}` + +- Display name of a specific system call number: + +`ausyscall {{system_call_number}}` + +- Display all system calls for a specific architecture: + +`ausyscall {{architecture}} --dump` diff --git a/linux/authconfig b/linux/authconfig new file mode 100644 index 00000000..b43861b6 --- /dev/null +++ b/linux/authconfig @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# authconfig + +> Configure system authentication resources. +> More information: . + +- Display the current configuration (or dry run): + +`authconfig --test` + +- Configure the server to use a different password hashing algorithm: + +`authconfig --update --passalgo={{algorithm}}` + +- Enable LDAP authentication: + +`authconfig --update --enableldapauth` + +- Disable LDAP authentication: + +`authconfig --update --disableldapauth` + +- Enable Network Information Service (NIS): + +`authconfig --update --enablenis` + +- Enable Kerberos: + +`authconfig --update --enablekrb5` + +- Enable Winbind (Active Directory) authentication: + +`authconfig --update --enablewinbindauth` + +- Enable local authorization: + +`authconfig --update --enablelocauthorize` diff --git a/linux/auto-cpufreq b/linux/auto-cpufreq new file mode 100644 index 00000000..73d15462 --- /dev/null +++ b/linux/auto-cpufreq @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# auto-cpufreq + +> Automatic CPU speed & power optimizer. +> More information: . + +- Run `auto-cpufreq` in a specific mode: + +`sudo auto-cpufreq --{{monitor|live|update|remove|stats|force=governor}}` diff --git a/linux/autopkgtest b/linux/autopkgtest new file mode 100644 index 00000000..72644db4 --- /dev/null +++ b/linux/autopkgtest @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# autopkgtest + +> Run tests on Debian packages. +> More information: . + +- Build the package in the current directory and run all tests directly on the system: + +`autopkgtest -- {{null}}` + +- Run a specific test for the package in the current directory: + +`autopkgtest --test-name={{test_name}} -- {{null}}` + +- Download and build a specific package with `apt-get`, then run all tests: + +`autopkgtest {{package}} -- {{null}}` + +- Test the package in the current directory using a new root directory: + +`autopkgtest -- {{chroot}} {{path/to/new/root}}` + +- Test the package in the current directory without rebuilding it: + +`autopkgtest --no-built-binaries -- {{null}}` diff --git a/linux/autorandr b/linux/autorandr new file mode 100644 index 00000000..b06b0cdf --- /dev/null +++ b/linux/autorandr @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# autorandr + +> Automatically change screen layout. +> More information: . + +- Save the current screen layout: + +`autorandr --save {{profile_name}}` + +- Show the saved profiles: + +`autorandr` + +- Load the first detected profile: + +`autorandr --change` + +- Load a specific profile: + +`autorandr --load {{profile_name}}` + +- Set the default profile: + +`autorandr --default {{profile_name}}` diff --git a/linux/avahi-browse b/linux/avahi-browse new file mode 100644 index 00000000..9a50ec6b --- /dev/null +++ b/linux/avahi-browse @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# avahi-browse + +> Displays services and hosts exposed on the local network via mDNS/DNS-SD. +> Avahi is compatible with Bonjour (Zeroconf) found in Apple devices. +> More information: . + +- List services available on the local network along with their addresses and ports, ignoring ones on the local machine: + +`avahi-browse --all --resolve --ignore-local` + +- Quickly list services in the local network in SSV format for scripts: + +`avahi-browse --all --terminate --parsable` + +- List domains in the neighbourhood: + +`avahi-browse --browse-domains` + +- Limit the search to a particular domain: + +`avahi-browse --all --domain={{domain}}` diff --git a/linux/avahi-resolve b/linux/avahi-resolve new file mode 100644 index 00000000..1cdf39c2 --- /dev/null +++ b/linux/avahi-resolve @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# avahi-resolve + +> Translate between host names and IP Addresses. +> More information: . + +- Resolve a local service to its IPv4: + +`avahi-resolve -4 --name {{service.local}}` + +- Resolve an IP to a hostname, verbosely: + +`avahi-resolve --verbose --address {{IP}}` diff --git a/linux/avifenc b/linux/avifenc new file mode 100644 index 00000000..e5b216f9 --- /dev/null +++ b/linux/avifenc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# avifenc + +> AV1 Image File Format (AVIF) encoder. +> More information: . + +- Convert a specific PNG image to AVIF: + +`avifenc {{path/to/input.png}} {{path/to/output.avif}}` + +- Encode with a specific speed (6=default, 0=slowest and 10=fastest): + +`avifenc --speed {{2}} {{path/to/input.png}} {{path/to/output.avif}}` diff --git a/linux/backlight_control b/linux/backlight_control new file mode 100644 index 00000000..244f3d7e --- /dev/null +++ b/linux/backlight_control @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# backlight_control + +> Control a linux machine's backlight using percentage values. +> More information: . + +- Increase/decrease the backlight by a specific percent count: + +`backlight_control {{+|-}}{{5}}` + +- Set the backlight strength to a specific percent count: + +`backlight_control {{90}}` + +- Display help: + +`backlight_control` diff --git a/linux/balooctl b/linux/balooctl new file mode 100644 index 00000000..af0f978d --- /dev/null +++ b/linux/balooctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# balooctl + +> File indexing and searching framework for KDE Plasma. +> More information: . + +- Display the status of the indexer: + +`balooctl status` + +- Enable/Disable the file indexer: + +`balooctl {{enable|disable}}` + +- Clean the index database: + +`balooctl purge` + +- Suspend the file indexer: + +`balooctl suspend` + +- Resume the file indexer: + +`balooctl resume` + +- Display the disk space used by Baloo: + +`balooctl indexSize` + +- Check for any unindexed files and index them: + +`balooctl check` + +- Display help: + +`balooctl --help` diff --git a/linux/batcat b/linux/batcat new file mode 100644 index 00000000..abb76f4d --- /dev/null +++ b/linux/batcat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# batcat + +> This command is an alias of `bat`. +> More information: . + +- View documentation for the original command: + +`tldr bat` diff --git a/linux/battop b/linux/battop new file mode 100644 index 00000000..549238d7 --- /dev/null +++ b/linux/battop @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# battop + +> An interactive viewer for the batteries installed in your notebook. +> More information: . + +- Display battery information: + +`battop` + +- Change battery information measurement [u]nit (default: human): + +`battop -u {{human|si}}` diff --git a/linux/bcachefs b/linux/bcachefs new file mode 100644 index 00000000..093270a9 --- /dev/null +++ b/linux/bcachefs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bcachefs + +> Manage `bcachefs` filesystems/devices. +> More information: . + +- Format a partition with `bcachefs`: + +`sudo bcachefs format {{path/to/partition}}` + +- Mount a `bcachefs` filesystem: + +`sudo bcachefs mount {{path/to/partition}} {{path/to/mountpoint}}` + +- Create a RAID 0 filesystem where an SSD acts as a cache and an HDD acts as a long-term storage: + +`sudo bcachefs format --label=ssd.ssd1 {{path/to/ssd/partition}} --label=hdd.hdd1 {{path/to/hdd/partition}} --replicas=1 --foreground_target=ssd --promote_target=ssd --background_target=hdd` + +- Mount a multidevice filesystem: + +`sudo bcachefs mount {{path/to/partition1}}:{{path/to/partition2}} {{path/to/mountpoint}}` + +- Display disk usage: + +`bcachefs fs usage --human-readable {{path/to/mountpoint}}` + +- Display help: + +`bcachefs` diff --git a/linux/bchunk b/linux/bchunk new file mode 100644 index 00000000..b932f7fd --- /dev/null +++ b/linux/bchunk @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bchunk + +> Convert CD images to a set of `.iso` and `.cdr` tracks. +> More information: . + +- Convert binary CD into a standard iso9960 image file: + +`bchunk {{path/to/image.bin}} {{path/to/image.cue}} {{path/to/output}}` + +- Convert with verbose mode: + +`bchunk -v {{path/to/image.bin}} {{path/to/image.cue}} {{path/to/output}}` + +- Output audio files in WAV format: + +`bchunk -w {{path/to/image.bin}} {{path/to/image.cue}} {{path/to/output}}` diff --git a/linux/beep b/linux/beep new file mode 100644 index 00000000..c6dd4d1e --- /dev/null +++ b/linux/beep @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# beep + +> A utility to beep the PC speaker. +> More information: . + +- Play a beep: + +`beep` + +- Play a beep that repeats: + +`beep -r {{repetitions}}` + +- Play a beep at a specified frequency (Hz) and duration (milliseconds): + +`beep -f {{frequency}} -l {{duration}}` + +- Play each new frequency and duration as a distinct beep: + +`beep -f {{frequency}} -l {{duration}} -n -f {{frequency}} -l {{duration}}` + +- Play the C major scale: + +`beep -f {{262}} -n -f {{294}} -n -f {{330}} -n -f {{349}} -n -f {{392}} -n -f {{440}} -n -f {{494}} -n -f {{523}}` diff --git a/linux/betterdiscordctl b/linux/betterdiscordctl new file mode 100644 index 00000000..1c4f2a24 --- /dev/null +++ b/linux/betterdiscordctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# betterdiscordctl + +> A program for managing BetterDiscord on Linux. +> More information: . + +- Install BetterDiscord on Discord Stable: + +`sudo betterdiscordctl install` + +- Install BetterDiscord on Discord Canary: + +`sudo betterdiscordctl --d-flavors canary install` + +- Install BetterDiscord on Discord PTB: + +`sudo betterdiscordctl --d-flavors ptb install` + +- Install BetterDiscord on Discord installed with Flatpak: + +`sudo betterdiscordctl --d-install flatpak install` + +- Install BetterDiscord on Discord installed with Snap: + +`sudo betterdiscordctl --d-install snap install` diff --git a/linux/betterlockscreen b/linux/betterlockscreen new file mode 100644 index 00000000..6f8b4d5b --- /dev/null +++ b/linux/betterlockscreen @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# betterlockscreen + +> Simple, minimal lock screen. +> More information: . + +- Lock the screen: + +`betterlockscreen --lock` + +- Change the lock screen background: + +`betterlockscreen -u {{path/to/image.png}}` + +- Lock the screen, showing some custom text: + +`betterlockscreen -l pixel -t "{{custom lock screen text}}"` + +- Lock the screen, with a custom monitor off timeout in seconds: + +`betterlockscreen --off {{5}} -l` diff --git a/linux/bitwise b/linux/bitwise new file mode 100644 index 00000000..bccf2d71 --- /dev/null +++ b/linux/bitwise @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bitwise + +> Multi base interactive calculator supporting dynamic base conversion and bit manipulation. +> More information: . + +- Run using interactive mode: + +`bitwise` + +- Convert from decimal: + +`bitwise {{12345}}` + +- Convert from hexadecimal: + +`bitwise {{0x563d}}` + +- Convert a C-style calculation: + +`bitwise "{{0x123 + 0x20 - 30 / 50}}"` diff --git a/linux/blastn b/linux/blastn new file mode 100644 index 00000000..e2d0154b --- /dev/null +++ b/linux/blastn @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blastn + +> Nucleotide-Nucleotide BLAST. +> More information: . + +- Align two or more sequences using megablast (default), with the e-value threshold of 1e-9, pairwise output format (default): + +`blastn -query {{query.fa}} -subject {{subject.fa}} -evalue {{1e-9}}` + +- Align two or more sequences using blastn: + +`blastn -task blastn -query {{query.fa}} -subject {{subject.fa}}` + +- Align two or more sequences, custom tabular output format, output to file: + +`blastn -query {{query.fa}} -subject {{subject.fa}} -outfmt {{'6 qseqid qlen qstart qend sseqid slen sstart send bitscore evalue pident'}} -out {{output.tsv}}` + +- Search nucleotide databases using a nucleotide query, 16 threads (CPUs) to use in the BLAST search, with a maximum number of 10 aligned sequences to keep: + +`blastn -query {{query.fa}} -db {{path/to/blast_db}} -num_threads {{16}} -max_target_seqs {{10}}` + +- Search the remote non-redundant nucleotide database using a nucleotide query: + +`blastn -query {{query.fa}} -db {{nt}} -remote` + +- Display help (use `-help` for detailed help): + +`blastn -h` diff --git a/linux/blastp b/linux/blastp new file mode 100644 index 00000000..677ae229 --- /dev/null +++ b/linux/blastp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blastp + +> Protein-Protein BLAST. +> More information: . + +- Align two or more sequences using blastp, with the e-value threshold of 1e-9, pairwise output format, output to screen: + +`blastp -query {{query.fa}} -subject {{subject.fa}} -evalue {{1e-9}}` + +- Align two or more sequences using blastp-fast: + +`blastp -task blastp-fast -query {{query.fa}} -subject {{subject.fa}}` + +- Align two or more sequences, custom tabular output format, output to file: + +`blastp -query {{query.fa}} -subject {{subject.fa}} -outfmt '{{6 qseqid qlen qstart qend sseqid slen sstart send bitscore evalue pident}}' -out {{output.tsv}}` + +- Search protein databases using a protein query, 16 threads to use in the BLAST search, with a maximum number of 10 aligned sequences to keep: + +`blastp -query {{query.fa}} -db {{blast_database_name}} -num_threads {{16}} -max_target_seqs {{10}}` + +- Search the remote non-redundant protein database using a protein query: + +`blastp -query {{query.fa}} -db {{nr}} -remote` + +- Display help (use `-help` for detailed help): + +`blastp -h` diff --git a/linux/blight b/linux/blight new file mode 100644 index 00000000..07e0e078 --- /dev/null +++ b/linux/blight @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blight + +> Utility for changing the display brightness. +> More information: . + +- Set display brightness to 50%: + +`blight set {{50}} -r` + +- Show current display brightness: + +`blight show` + +- Print maximum display brightness: + +`blight max` + +- Increase display brightness in %: + +`blight inc {{number}} -r` + +- Decrease display brightness with internal units: + +`blight dec {{number}}` diff --git a/linux/blkdiscard b/linux/blkdiscard new file mode 100644 index 00000000..bf727479 --- /dev/null +++ b/linux/blkdiscard @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blkdiscard + +> Discards device sectors on storage devices. Useful for SSDs. +> More information: . + +- Discard all sectors on a device, removing all data: + +`blkdiscard /dev/{{device}}` + +- Securely discard all blocks on a device, removing all data: + +`blkdiscard --secure /dev/{{device}}` + +- Discard the first 100 MB of a device: + +`blkdiscard --length {{100MB}} /dev/{{device}}` diff --git a/linux/blkid b/linux/blkid new file mode 100644 index 00000000..a7c4f35a --- /dev/null +++ b/linux/blkid @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blkid + +> Lists all recognized partitions and their Universally Unique Identifier (UUID). +> More information: . + +- List all partitions: + +`sudo blkid` + +- List all partitions in a table, including current mountpoints: + +`sudo blkid -o list` diff --git a/linux/bluetoothctl b/linux/bluetoothctl new file mode 100644 index 00000000..5e5516fa --- /dev/null +++ b/linux/bluetoothctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bluetoothctl + +> Manage Bluetooth devices. +> More information: . + +- Enter the `bluetoothctl` shell: + +`bluetoothctl` + +- List all known devices: + +`bluetoothctl devices` + +- Power the Bluetooth controller on or off: + +`bluetoothctl power {{on|off}}` + +- Pair with a device: + +`bluetoothctl pair {{mac_address}}` + +- Remove a device: + +`bluetoothctl remove {{mac_address}}` + +- Connect to a paired device: + +`bluetoothctl connect {{mac_address}}` + +- Disconnect from a paired device: + +`bluetoothctl disconnect {{mac_address}}` + +- Display help: + +`bluetoothctl help` diff --git a/linux/bluetoothd b/linux/bluetoothd new file mode 100644 index 00000000..6101962d --- /dev/null +++ b/linux/bluetoothd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bluetoothd + +> Daemon to manage bluetooth devices. +> More information: . + +- Start the daemon: + +`bluetoothd` + +- Start the daemon, logging to `stdout`: + +`bluetoothd --nodetach` + +- Start the daemon with a specific configuration file (defaults to `/etc/bluetooth/main.conf`): + +`bluetoothd --configfile {{path/to/file}}` + +- Start the daemon with verbose output to `stderr`: + +`bluetoothd --debug` + +- Start the daemon with verbose output coming from specific files in the bluetoothd or plugins source: + +`bluetoothd --debug={{path/to/file1:path/to/file2:...}}` diff --git a/linux/blurlock b/linux/blurlock new file mode 100644 index 00000000..c681a3b0 --- /dev/null +++ b/linux/blurlock @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# blurlock + +> A simple wrapper around the i3 screen locker `i3lock`, which blurs the screen. +> See also: `i3lock`. +> More information: . + +- Lock the screen to a blurred screenshot of the current screen: + +`blurlock` + +- Lock the screen and disable the unlock indicator (removes feedback on keypress): + +`blurlock --no-unlock-indicator` + +- Lock the screen and don't hide the mouse pointer: + +`blurlock --pointer {{default}}` + +- Lock the screen and show the number of failed login attempts: + +`blurlock --show-failed-attempts` diff --git a/linux/bmon b/linux/bmon new file mode 100644 index 00000000..a1eeffe6 --- /dev/null +++ b/linux/bmon @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bmon + +> Monitor bandwidth and capture network related statistics. +> More information: . + +- Display the list of all the interfaces: + +`bmon -a` + +- Display data transfer rates in bits per second: + +`bmon -b` + +- Specify the policy to define which network interface(s) is/are displayed: + +`bmon -p {{interface_1,interface_2,interface_3}}` + +- Specify the interval (in seconds) in which rate per counter is calculated: + +`bmon -R {{2.0}}` diff --git a/linux/boltctl b/linux/boltctl new file mode 100644 index 00000000..00380e89 --- /dev/null +++ b/linux/boltctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# boltctl + +> Control thunderbolt devices. +> More information: . + +- List connected (and authorized) devices: + +`boltctl` + +- List connected devices, including unauthorized ones: + +`boltctl list` + +- Authorize a device temporarily: + +`boltctl authorize {{device_uuid}}` + +- Authorize and remember a device: + +`boltctl enroll {{device_uuid}}` + +- Revoke a previously authorized device: + +`boltctl forget {{device_uuid}}` + +- Show more information about a device: + +`boltctl info {{device_uuid}}` diff --git a/linux/bootctl b/linux/bootctl new file mode 100644 index 00000000..f694c9ee --- /dev/null +++ b/linux/bootctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bootctl + +> Control EFI firmware boot settings and manage boot loader. +> More information: . + +- Show information about the system firmware and the bootloaders: + +`bootctl status` + +- Show all available bootloader entries: + +`bootctl list` + +- Set a flag to boot into the system firmware on the next boot (similar to `sudo systemctl reboot --firmware-setup`): + +`sudo bootctl reboot-to-firmware true` + +- Specify the path to the EFI system partition (defaults to `/efi/`, `/boot/` or `/boot/efi`): + +`bootctl --esp-path={{/path/to/efi_system_partition/}}` + +- Install `systemd-boot` into the EFI system partition: + +`sudo bootctl install` + +- Remove all installed versions of `systemd-boot` from the EFI system partition: + +`sudo bootctl remove` diff --git a/linux/bpftool b/linux/bpftool new file mode 100644 index 00000000..05ab4486 --- /dev/null +++ b/linux/bpftool @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bpftool + +> Inspect and manipulate eBPF programs and maps in a simple way. +> Some subcommands such as `bpftool prog` have their own usage documentation. +> More information: . + +- List information about loaded `eBPF` programs: + +`bpftool prog list` + +- List `eBPF` program attachments in the kernel networking subsystem: + +`bpftool net list` + +- List all active links: + +`bpftool link list` + +- List all `raw_tracepoint`, `tracepoint`, `kprobe` attachments in the system: + +`bpftool perf list` + +- List `BPF Type Format (BTF)` data: + +`bpftool btf list` + +- List information about loaded maps: + +`bpftool map list` + +- Probe a network device "eth0" for supported `eBPF` features: + +`bpftool feature probe dev {{eth0}}` + +- Run commands in batch mode from a file: + +`bpftool batch file {{myfile}}` diff --git a/linux/bpftrace b/linux/bpftrace new file mode 100644 index 00000000..241ac510 --- /dev/null +++ b/linux/bpftrace @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bpftrace + +> High-level tracing language for Linux eBPF. +> More information: . + +- Display bpftrace version: + +`bpftrace -V` + +- List all available probes: + +`sudo bpftrace -l` + +- Run a one-liner program (e.g. syscall count by program): + +`sudo bpftrace -e '{{tracepoint:raw_syscalls:sys_enter { @[comm] = count(); }}}'` + +- Run a program from a file: + +`sudo bpftrace {{path/to/file}}` + +- Trace a program by PID: + +`sudo bpftrace -e '{{tracepoint:raw_syscalls:sys_enter /pid == 123/ { @[comm] = count(); }}}'` + +- Do a dry run and display the output in eBPF format: + +`sudo bpftrace -d -e '{{one_line_program}}'` diff --git a/linux/br b/linux/br new file mode 100644 index 00000000..41b38d15 --- /dev/null +++ b/linux/br @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# br + +> Navigate directory trees interactively. +> See also: `broot`. +> More information: . + +- Start and navigate the current directory tree interactively: + +`br` + +- Start displaying the size of files and directories: + +`br --sizes` + +- Start displaying permissions: + +`br --permissions` + +- Start displaying directories only: + +`br --only-folders` + +- Start displaying hidden files and directories: + +`br --hidden` diff --git a/linux/braa b/linux/braa new file mode 100644 index 00000000..549dcba5 --- /dev/null +++ b/linux/braa @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# braa + +> Ultra-fast mass SNMP scanner allowing multiple hosts simultaneously. +> More information: . + +- Walk the SNMP tree of host with public string querying all OIDs under `.1.3.6`: + +`braa public@{{ip}}:{{.1.3.6.*}}` + +- Query the whole subnet `ip_range` for `system.sysLocation.0`: + +`braa public@{{ip_range}}:{{.1.3.6.1.2.1.1.6.0}}` + +- Attempt to set the value of `system.sysLocation.0` to a specific workgroup: + +`braa private@{{ip}}:{{.1.3.6.1.2.1.1.6.0}}=s'{{workgroup}}'` diff --git a/linux/brctl b/linux/brctl new file mode 100644 index 00000000..7641bdae --- /dev/null +++ b/linux/brctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# brctl + +> Ethernet bridge administration. +> More information: . + +- Show a list with information about currently existing Ethernet bridges: + +`sudo brctl show` + +- Create a new Ethernet bridge interface: + +`sudo brctl add {{bridge_name}}` + +- Delete an existing Ethernet bridge interface: + +`sudo brctl del {{bridge_name}}` + +- Add an interface to an existing bridge: + +`sudo brctl addif {{bridge_name}} {{interface_name}}` + +- Remove an interface from an existing bridge: + +`sudo brctl delif {{bridge_name}} {{interface_name}}` diff --git a/linux/brightnessctl b/linux/brightnessctl new file mode 100644 index 00000000..5f561859 --- /dev/null +++ b/linux/brightnessctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# brightnessctl + +> Utility for reading and controlling device brightness for Linux operating systems. +> More information: . + +- List devices with changeable brightness: + +`brightnessctl --list` + +- Print the current brightness of the display backlight: + +`brightnessctl get` + +- Set the brightness of the display backlight to a specified percentage within range: + +`brightnessctl set {{50%}}` + +- Increase brightness by a specified increment: + +`brightnessctl set {{+10%}}` + +- Decrease brightness by a specified decrement: + +`brightnessctl set {{10%-}}` diff --git a/linux/broot b/linux/broot new file mode 100644 index 00000000..58d2c4c6 --- /dev/null +++ b/linux/broot @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# broot + +> Navigate directory trees interactively. +> See also: `br`. +> More information: . + +- Install or reinstall the `br` shell function: + +`broot --install` diff --git a/linux/bspc b/linux/bspc new file mode 100644 index 00000000..2efa1be8 --- /dev/null +++ b/linux/bspc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bspc + +> A tool to control `bspwm`. +> More information: . + +- Define two virtual desktop: + +`bspc monitor --reset-desktops {{1}} {{2}}` + +- Focus the given desktop: + +`bspc desktop --focus {{number}}` + +- Close the windows rooted at the selected node: + +`bspc node --close` + +- Send the selected node to the given desktop: + +`bspc node --to-desktop {{number}}` + +- Toggle full screen mode for the selected node: + +`bspc node --state ~fullscreen` diff --git a/linux/bspwm b/linux/bspwm new file mode 100644 index 00000000..8a162d4d --- /dev/null +++ b/linux/bspwm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bspwm + +> A tiling window manager based on binary space partitioning. +> More information: . + +- Start `bspwm` (note that a pre-existing window manager must not be open when this command is run): + +`bspwm -c {{path/to/config}}` + +- View documentation for `bspc`: + +`tldr bspc` diff --git a/linux/btrbk b/linux/btrbk new file mode 100644 index 00000000..b1704835 --- /dev/null +++ b/linux/btrbk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrbk + +> A tool for creating snapshots and remote backups of btrfs subvolumes. +> More information: . + +- Print statistics about configured subvolumes and snapshots: + +`sudo btrbk stats` + +- List configured subvolumes and snapshots: + +`sudo btrbk list` + +- Print what would happen in a run without making the displayed changes: + +`sudo btrbk --verbose dryrun` + +- Run backup routines verbosely, show progress bar: + +`sudo btrbk --progress --verbose run` + +- Only create snapshots for configured subvolumes: + +`sudo btrbk snapshot` diff --git a/linux/btrfs b/linux/btrfs new file mode 100644 index 00000000..e091b902 --- /dev/null +++ b/linux/btrfs @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs + +> A filesystem based on the copy-on-write (COW) principle for Linux. +> Some subcommands such as `btrfs device` have their own usage documentation. +> More information: . + +- Create subvolume: + +`sudo btrfs subvolume create {{path/to/subvolume}}` + +- List subvolumes: + +`sudo btrfs subvolume list {{path/to/mount_point}}` + +- Show space usage information: + +`sudo btrfs filesystem df {{path/to/mount_point}}` + +- Enable quota: + +`sudo btrfs quota enable {{path/to/subvolume}}` + +- Show quota: + +`sudo btrfs qgroup show {{path/to/subvolume}}` diff --git a/linux/btrfs-balance b/linux/btrfs-balance new file mode 100644 index 00000000..8b623539 --- /dev/null +++ b/linux/btrfs-balance @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs balance + +> Balance block groups on a btrfs filesystem. +> More information: . + +- Show the status of a running or paused balance operation: + +`sudo btrfs balance status {{path/to/btrfs_filesystem}}` + +- Balance all block groups (slow; rewrites all blocks in filesystem): + +`sudo btrfs balance start {{path/to/btrfs_filesystem}}` + +- Balance data block groups which are less than 15% utilized, running the operation in the background: + +`sudo btrfs balance start --bg -dusage={{15}} {{path/to/btrfs_filesystem}}` + +- Balance a max of 10 metadata chunks with less than 20% utilization and at least 1 chunk on a given device `devid` (see `btrfs filesystem show`): + +`sudo btrfs balance start -musage={{20}},limit={{10}},devid={{devid}} {{path/to/btrfs_filesystem}}` + +- Convert data blocks to the raid6 and metadata to raid1c3 (see mkfs.btrfs(8) for profiles): + +`sudo btrfs balance start -dconvert={{raid6}} -mconvert={{raid1c3}} {{path/to/btrfs_filesystem}}` + +- Convert data blocks to raid1, skipping already converted chunks (e.g. after a previous cancelled conversion operation): + +`sudo btrfs balance start -dconvert={{raid1}},soft {{path/to/btrfs_filesystem}}` + +- Cancel, pause, or resume a running or paused balance operation: + +`sudo btrfs balance {{cancel|pause|resume}} {{path/to/btrfs_filesystem}}` diff --git a/linux/btrfs-check b/linux/btrfs-check new file mode 100644 index 00000000..5403e211 --- /dev/null +++ b/linux/btrfs-check @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs check + +> Check or repair a btrfs filesystem. +> More information: . + +- Check a btrfs filesystem: + +`sudo btrfs check {{path/to/partition}}` + +- Check and repair a btrfs filesystem (dangerous): + +`sudo btrfs check --repair {{path/to/partition}}` + +- Show the progress of the check: + +`sudo btrfs check --progress {{path/to/partition}}` + +- Verify the checksum of each data block (if the filesystem is good): + +`sudo btrfs check --check-data-csum {{path/to/partition}}` + +- Use the `n`-th superblock (`n` can be 0, 1 or 2): + +`sudo btrfs check --super {{n}} {{path/to/partition}}` + +- Rebuild the checksum tree: + +`sudo btrfs check --repair --init-csum-tree {{path/to/partition}}` + +- Rebuild the extent tree: + +`sudo btrfs check --repair --init-extent-tree {{path/to/partition}}` diff --git a/linux/btrfs-device b/linux/btrfs-device new file mode 100644 index 00000000..a97a55e2 --- /dev/null +++ b/linux/btrfs-device @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs device + +> Manage devices in a btrfs filesystem. +> More information: . + +- Add one or more devices to a btrfs filesystem: + +`sudo btrfs device add {{path/to/block_device1}} [{{path/to/block_device2}}] {{path/to/btrfs_filesystem}}` + +- Remove a device from a btrfs filesystem: + +`sudo btrfs device remove {{path/to/device|device_id}} [{{...}}]` + +- Display error statistics: + +`sudo btrfs device stats {{path/to/btrfs_filesystem}}` + +- Scan all disks and inform the kernel of all detected btrfs filesystems: + +`sudo btrfs device scan --all-devices` + +- Display detailed per-disk allocation statistics: + +`sudo btrfs device usage {{path/to/btrfs_filesystem}}` diff --git a/linux/btrfs-filesystem b/linux/btrfs-filesystem new file mode 100644 index 00000000..93291884 --- /dev/null +++ b/linux/btrfs-filesystem @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs filesystem + +> Manage btrfs filesystems. +> More information: . + +- Show filesystem usage (optionally run as root to show detailed information): + +`btrfs filesystem usage {{path/to/btrfs_mount}}` + +- Show usage by individual devices: + +`sudo btrfs filesystem show {{path/to/btrfs_mount}}` + +- Defragment a single file on a btrfs filesystem (avoid while a deduplication agent is running): + +`sudo btrfs filesystem defragment -v {{path/to/file}}` + +- Defragment a directory recursively (does not cross subvolume boundaries): + +`sudo btrfs filesystem defragment -v -r {{path/to/directory}}` + +- Force syncing unwritten data blocks to disk(s): + +`sudo btrfs filesystem sync {{path/to/btrfs_mount}}` + +- Summarize disk usage for the files in a directory recursively: + +`sudo btrfs filesystem du --summarize {{path/to/directory}}` diff --git a/linux/btrfs-inspect-internal b/linux/btrfs-inspect-internal new file mode 100644 index 00000000..eea2bfe3 --- /dev/null +++ b/linux/btrfs-inspect-internal @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs inspect-internal + +> Query internal information of a btrfs filesystem. +> More information: . + +- Print superblock's information: + +`sudo btrfs inspect-internal dump-super {{path/to/partition}}` + +- Print superblock's and all of its copies' information: + +`sudo btrfs inspect-internal dump-super --all {{path/to/partition}}` + +- Print filesystem's metadata information: + +`sudo btrfs inspect-internal dump-tree {{path/to/partition}}` + +- Print list of files in inode `n`-th: + +`sudo btrfs inspect-internal inode-resolve {{n}} {{path/to/btrfs_mount}}` + +- Print list of files at a given logical address: + +`sudo btrfs inspect-internal logical-resolve {{logical_address}} {{path/to/btrfs_mount}}` + +- Print stats of root, extent, csum and fs trees: + +`sudo btrfs inspect-internal tree-stats {{path/to/partition}}` diff --git a/linux/btrfs-property b/linux/btrfs-property new file mode 100644 index 00000000..1c2184ca --- /dev/null +++ b/linux/btrfs-property @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs property + +> Get, set, or list properties for a BTRFS filesystem object (files, directories, subvolumes, filesystems, or devices). +> More information: . + +- List available properties (and descriptions) for the given btrfs object: + +`sudo btrfs property list {{path/to/btrfs_object}}` + +- Get all properties for the given btrfs object: + +`sudo btrfs property get {{path/to/btrfs_object}}` + +- Get the `label` property for the given btrfs filesystem or device: + +`sudo btrfs property get {{path/to/btrfs_filesystem}} label` + +- Get all object type-specific properties for the given btrfs filesystem or device: + +`sudo btrfs property get -t {{subvol|filesystem|inode|device}} {{path/to/btrfs_filesystem}}` + +- Set the `compression` property for a given btrfs inode (either a file or directory): + +`sudo btrfs property set {{path/to/btrfs_inode}} compression {{zstd|zlib|lzo|none}}` diff --git a/linux/btrfs-rescue b/linux/btrfs-rescue new file mode 100644 index 00000000..a45d2869 --- /dev/null +++ b/linux/btrfs-rescue @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs rescue + +> Try to recover a damaged btrfs filesystem. +> More information: . + +- Rebuild the filesystem metadata tree (very slow): + +`sudo btrfs rescue chunk-recover {{path/to/partition}}` + +- Fix device size alignment related problems (e.g. unable to mount the filesystem with super total bytes mismatch): + +`sudo btrfs rescue fix-device-size {{path/to/partition}}` + +- Recover a corrupted superblock from correct copies (recover the root of filesystem tree): + +`sudo btrfs rescue super-recover {{path/to/partition}}` + +- Recover from an interrupted transactions (fixes log replay problems): + +`sudo btrfs rescue zero-log {{path/to/partition}}` + +- Create a `/dev/btrfs-control` control device when `mknod` is not installed: + +`sudo btrfs rescue create-control-device` diff --git a/linux/btrfs-restore b/linux/btrfs-restore new file mode 100644 index 00000000..0096d8a7 --- /dev/null +++ b/linux/btrfs-restore @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs restore + +> Try to salvage files from a damaged btrfs filesystem. +> More information: . + +- Restore all files from a btrfs filesystem to a given directory: + +`sudo btrfs restore {{path/to/btrfs_device}} {{path/to/target_directory}}` + +- List (don't write) files to be restored from a btrfs filesystem: + +`sudo btrfs restore --dry-run {{path/to/btrfs_device}} {{path/to/target_directory}}` + +- Restore files matching a given regex ([c]ase-insensitive) files to be restored from a btrfs filesystem (all parent directories of target file(s) must match as well): + +`sudo btrfs restore --path-regex {{regex}} -c {{path/to/btrfs_device}} {{path/to/target_directory}}` + +- Restore files from a btrfs filesystem using a specific root tree `bytenr` (see `btrfs-find-root`): + +`sudo btrfs restore -t {{bytenr}} {{path/to/btrfs_device}} {{path/to/target_directory}}` + +- Restore files from a btrfs filesystem (along with metadata, extended attributes, and Symlinks), overwriting files in the target: + +`sudo btrfs restore --metadata --xattr --symlinks --overwrite {{path/to/btrfs_device}} {{path/to/target_directory}}` diff --git a/linux/btrfs-scrub b/linux/btrfs-scrub new file mode 100644 index 00000000..c811334c --- /dev/null +++ b/linux/btrfs-scrub @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs scrub + +> Scrub btrfs filesystems to verify data integrity. +> It is recommended to run a scrub once a month. +> More information: . + +- Start a scrub: + +`sudo btrfs scrub start {{path/to/btrfs_mount}}` + +- Show the status of an ongoing or last completed scrub: + +`sudo btrfs scrub status {{path/to/btrfs_mount}}` + +- Cancel an ongoing scrub: + +`sudo btrfs scrub cancel {{path/to/btrfs_mount}}` + +- Resume a previously cancelled scrub: + +`sudo btrfs scrub resume {{path/to/btrfs_mount}}` + +- Start a scrub, but wait until the scrub finishes before exiting: + +`sudo btrfs scrub start -B {{path/to/btrfs_mount}}` + +- Start a scrub in quiet mode (does not print errors or statistics): + +`sudo btrfs scrub start -q {{path/to/btrfs_mount}}` diff --git a/linux/btrfs-subvolume b/linux/btrfs-subvolume new file mode 100644 index 00000000..75865d07 --- /dev/null +++ b/linux/btrfs-subvolume @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs subvolume + +> Manage btrfs subvolumes and snapshots. +> More information: . + +- Create a new empty subvolume: + +`sudo btrfs subvolume create {{path/to/new_subvolume}}` + +- List all subvolumes and snapshots in the specified filesystem: + +`sudo btrfs subvolume list {{path/to/btrfs_filesystem}}` + +- Delete a subvolume: + +`sudo btrfs subvolume delete {{path/to/subvolume}}` + +- Create a read-only snapshot of an existing subvolume: + +`sudo btrfs subvolume snapshot -r {{path/to/source_subvolume}} {{path/to/target}}` + +- Create a read-write snapshot of an existing subvolume: + +`sudo btrfs subvolume snapshot {{path/to/source_subvolume}} {{path/to/target}}` + +- Show detailed information about a subvolume: + +`sudo btrfs subvolume show {{path/to/subvolume}}` diff --git a/linux/btrfs-version b/linux/btrfs-version new file mode 100644 index 00000000..3da643ef --- /dev/null +++ b/linux/btrfs-version @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# btrfs version + +> Display btrfs-progs version. +> More information: . + +- Display help: + +`btrfs version --help` + +- Display btrfs-progs version: + +`btrfs version` diff --git a/linux/bully b/linux/bully new file mode 100644 index 00000000..c6c64d27 --- /dev/null +++ b/linux/bully @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# bully + +> Brute-force the WPS pin of a wireless access point. +> Necessary information must be gathered with `airmon-ng` and `airodump-ng` before using `bully`. +> More information: . + +- Crack the password: + +`bully --bssid "{{mac}}" --channel "{{channel}}" --bruteforce "{{interface}}"` + +- Display help: + +`bully --help` diff --git a/linux/burpsuite b/linux/burpsuite new file mode 100644 index 00000000..7038be80 --- /dev/null +++ b/linux/burpsuite @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# burpsuite + +> A GUI based application mainly used in web application penetration testing. +> More information: . + +- Start Burp Suite: + +`burpsuite` + +- Start Burp Suite using the default configuration: + +`burpsuite --use-defaults` + +- Open a specific project file: + +`burpsuite --project-file={{path/to/file}}` + +- Load a specific configuration file: + +`burpsuite --config-file={{path/to/file}}` + +- Start without extensions: + +`burpsuite --disable-extensions` diff --git a/linux/busctl b/linux/busctl new file mode 100644 index 00000000..5ea287ce --- /dev/null +++ b/linux/busctl @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# busctl + +> Introspect and monitor the D-Bus bus. +> More information: . + +- Show all peers on the bus, by their service names: + +`busctl list` + +- Show process information and credentials of a bus service, a process, or the owner of the bus (if no parameter is specified): + +`busctl status {{service|pid}}` + +- Dump messages being exchanged. If no service is specified, show all messages on the bus: + +`busctl monitor {{service1 service2 ...}}` + +- Show an object tree of one or more services (or all services if no service is specified): + +`busctl tree {{service1 service2 ...}}` + +- Show interfaces, methods, properties and signals of the specified object on the specified service: + +`busctl introspect {{service}} {{path/to/object}}` + +- Retrieve the current value of one or more object properties: + +`busctl get-property {{service}} {{path/to/object}} {{interface_name}} {{property_name}}` + +- Invoke a method and show the response: + +`busctl call {{service}} {{path/to/object}} {{interface_name}} {{method_name}}` diff --git a/linux/byzanz-record b/linux/byzanz-record new file mode 100644 index 00000000..c63ddace --- /dev/null +++ b/linux/byzanz-record @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# byzanz-record + +> Record the screen. +> More information: . + +- Record the screen and write the recording to a file (by default, `byzanz-record` will only record for 10 seconds): + +`byzanz-record {{path/to/file.[byzanz|flv|gif|ogg|ogv|webm]}}` + +- Show information while and after recording: + +`byzanz-record --verbose {{path/to/file.[byzanz|flv|gif|ogg|ogv|webm]}}` + +- Record the screen for a minute: + +`byzanz-record --duration 60 {{path/to/file.[byzanz|flv|gif|ogg|ogv|webm]}}` + +- Delay recording for 10 seconds: + +`byzanz-record --delay 10 {{path/to/file.[byzanz|flv|gif|ogg|ogv|webm]}}` diff --git a/linux/caffeinate b/linux/caffeinate new file mode 100644 index 00000000..ad6a8f8e --- /dev/null +++ b/linux/caffeinate @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# caffeinate + +> Prevent desktop from sleeping. +> More information: . + +- Prevent desktop from sleeping (use `Ctrl + C` to exit): + +`caffeinate` diff --git a/linux/caffeine b/linux/caffeine new file mode 100644 index 00000000..e4003b07 --- /dev/null +++ b/linux/caffeine @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# caffeine + +> Prevent desktop idleness in full-screen mode. +> More information: . + +- Start a caffeine server: + +`caffeine` + +- Display help: + +`caffeine --help` + +- Display version: + +`caffeine --version` diff --git a/linux/caffeine-indicator b/linux/caffeine-indicator new file mode 100644 index 00000000..2d05dc50 --- /dev/null +++ b/linux/caffeine-indicator @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# caffeine-indicator + +> Manually inhibit desktop idleness with a toggle. +> More information: . + +- Manually inhibit desktop idleness with a toggle: + +`caffeine-indicator` diff --git a/linux/caja b/linux/caja new file mode 100644 index 00000000..fda383ec --- /dev/null +++ b/linux/caja @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# caja + +> Manages files and directories in MATE desktop environment. +> More information: . + +- Open the current user home directory: + +`caja` + +- Open specific directories in separate windows: + +`caja {{path/to/directory1 path/to/directory2 ...}}` + +- Open specific directories in tabs: + +`caja --tabs {{path/to/directory1 path/to/directory2 ...}}` + +- Open a directory with a specific window size: + +`caja --geometry={{600}}x{{400}} {{path/to/directory}}` + +- Close all windows: + +`caja --quit` diff --git a/linux/cal b/linux/cal new file mode 100644 index 00000000..0085fffd --- /dev/null +++ b/linux/cal @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Display a calendar with the current day highlighted. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display [3] months spanning the date: + +`cal -3` + +- Display the whole calendar for the current [y]ear: + +`cal --year` + +- Display the next twelve months: + +`cal --twelve` + +- Use Monday as the first day of the week: + +`cal --monday` + +- Display a calendar for a specific year (4 digits): + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` diff --git a/linux/calcurse b/linux/calcurse new file mode 100644 index 00000000..8ade84c0 --- /dev/null +++ b/linux/calcurse @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# calcurse + +> A text-based calendar and scheduling application for the command-line. +> More information: . + +- Start `calcurse` on interactive mode: + +`calcurse` + +- Print the appointments and events for the current day and exit: + +`calcurse --appointment` + +- Remove all local calcurse items and import remote objects: + +`calcurse-caldav --init=keep-remote` + +- Remove all remote objects and push local calcurse items: + +`calcurse-caldav --init=keep-local` + +- Copy local objects to the CalDAV server and vice versa: + +`calcurse-caldav --init=two-way` diff --git a/linux/cam b/linux/cam new file mode 100644 index 00000000..0df3af91 --- /dev/null +++ b/linux/cam @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cam + +> Frontend tool for `libcamera`. +> More information: . + +- List available cameras: + +`cam --list` + +- List controls of a camera: + +`cam --camera {{camera_index}} --list-controls` + +- Write frames to a folder: + +`cam --camera {{camera_index}} --capture={{frames_to_capture}} --file` + +- Display camera feed in a window: + +`cam --camera {{camera_index}} --capture --sdl` diff --git a/linux/cat b/linux/cat new file mode 100644 index 00000000..ae3aecbd --- /dev/null +++ b/linux/cat @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cat + +> Print and concatenate files. +> More information: . + +- Print the contents of a file to `stdout`: + +`cat {{path/to/file}}` + +- Concatenate several files into an output file: + +`cat {{path/to/file1 path/to/file2 ...}} > {{path/to/output_file}}` + +- Append several files to an output file: + +`cat {{path/to/file1 path/to/file2 ...}} >> {{path/to/output_file}}` + +- Write `stdin` to a file: + +`cat - > {{path/to/file}}` + +- [n]umber all output lines: + +`cat -n {{path/to/file}}` + +- Display non-printable and whitespace characters (with `M-` prefix if non-ASCII): + +`cat -v -t -e {{path/to/file}}` diff --git a/linux/cbatticon b/linux/cbatticon new file mode 100644 index 00000000..f86abbc4 --- /dev/null +++ b/linux/cbatticon @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cbatticon + +> A lightweight and fast battery icon that sits in your system tray. +> More information: . + +- Show the battery icon in the system tray: + +`cbatticon` + +- Show the battery icon and set the update interval to 20 seconds: + +`cbatticon --update-interval {{20}}` + +- List available icon types: + +`cbatticon --list-icon-types` + +- Show the battery icon with a specific icon type: + +`cbatticon --icon-type {{standard|notification|symbolic}}` + +- List available power supplies: + +`cbatticon --list-power-supplies` + +- Show the battery icon for a specific battery: + +`cbatticon {{BAT0}}` + +- Show the battery icon and which command to execute when the battery level reaches the set critical level: + +`cbatticon --critical-level {{5}} --command-critical-level {{poweroff}}` diff --git a/linux/cc b/linux/cc new file mode 100644 index 00000000..40da89c3 --- /dev/null +++ b/linux/cc @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cc + +> This command is an alias of `gcc`. +> More information: . + +- View documentation for the original command: + +`tldr gcc` diff --git a/linux/ceph b/linux/ceph new file mode 100644 index 00000000..6ac01a5d --- /dev/null +++ b/linux/ceph @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ceph + +> A unified storage system. +> More information: . + +- Check cluster health status: + +`ceph status` + +- Check cluster usage stats: + +`ceph df` + +- Get the statistics for the placement groups in a cluster: + +`ceph pg dump --format {{plain}}` + +- Create a storage pool: + +`ceph osd pool create {{pool_name}} {{page_number}}` + +- Delete a storage pool: + +`ceph osd pool delete {{pool_name}}` + +- Rename a storage pool: + +`ceph osd pool rename {{current_name}} {{new_name}}` + +- Self-repair pool storage: + +`ceph pg repair {{pool_name}}` diff --git a/linux/certbot b/linux/certbot new file mode 100644 index 00000000..353da6c9 --- /dev/null +++ b/linux/certbot @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# certbot + +> The Let's Encrypt Agent for automatically obtaining and renewing TLS certificates. +> Successor to `letsencrypt`. +> More information: . + +- Obtain a new certificate via webroot authorization, but do not install it automatically: + +`sudo certbot certonly --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}}` + +- Obtain a new certificate via nginx authorization, installing the new certificate automatically: + +`sudo certbot --nginx --domain {{subdomain.example.com}}` + +- Obtain a new certificate via apache authorization, installing the new certificate automatically: + +`sudo certbot --apache --domain {{subdomain.example.com}}` + +- Renew all Let's Encrypt certificates that expire in 30 days or less (don't forget to restart any servers that use them afterwards): + +`sudo certbot renew` + +- Simulate the obtaining of a new certificate, but don't actually save any new certificates to disk: + +`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --dry-run` + +- Obtain an untrusted test certificate instead: + +`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --test-cert` diff --git a/linux/cewl b/linux/cewl new file mode 100644 index 00000000..decbdd8c --- /dev/null +++ b/linux/cewl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cewl + +> URL spidering tool for making a cracking wordlist from web content. +> More information: . + +- Create a wordlist file from the given URL up to 2 links depth: + +`cewl --depth {{2}} --write {{path/to/wordlist.txt}} {{url}}` + +- Output an alphanumeric wordlist from the given URL with words of minimum 5 characters: + +`cewl --with-numbers --min_word_length {{5}} {{url}}` + +- Output a wordlist from the given URL in debug mode including email addresses: + +`cewl --debug --email {{url}}` + +- Output a wordlist from the given URL using HTTP Basic or Digest authentication: + +`cewl --auth_type {{basic|digest}} --auth_user {{username}} --auth_pass {{password}} {{url}}` + +- Output a wordlist from the given URL through a proxy: + +`cewl --proxy_host {{host}} --proxy_port {{port}} {{url}}` diff --git a/linux/cfdisk b/linux/cfdisk new file mode 100644 index 00000000..f7922cbf --- /dev/null +++ b/linux/cfdisk @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cfdisk + +> A program for managing partition tables and partitions on a hard disk using a curses UI. +> More information: . + +- Start the partition manipulator with a specific device: + +`cfdisk {{/dev/sdX}}` + +- Create a new partition table for a specific device and manage it: + +`cfdisk --zero {{/dev/sdX}}` diff --git a/linux/cgclassify b/linux/cgclassify new file mode 100644 index 00000000..a9761d0c --- /dev/null +++ b/linux/cgclassify @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cgclassify + +> Move running tasks to `cgroups`. +> More information: . + +- Move the process with a specific PID to the control group student in the CPU hierarchy: + +`cgclassify -g {{cpu:student}} {{1234}}` + +- Move the process with a specific PID to control groups based on the `/etc/cgrules.conf` configuration file: + +`cgclassify {{1234}}` + +- Move the process with a specific PID to the control group student in the CPU hierarchy. Note: The daemon of the service `cgred` does not change `cgroups` of the specific PID and its children (based on `/etc/cgrules.conf`): + +`cgclassify --sticky -g {{cpu:/student}} {{1234}}` diff --git a/linux/cgcreate b/linux/cgcreate new file mode 100644 index 00000000..da01f971 --- /dev/null +++ b/linux/cgcreate @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cgcreate + +> Create cgroups, used to limit, measure, and control resources used by processes. +> `cgroups` types can be `memory`, `cpu`, `net_cls`, etc. +> More information: . + +- Create a new group: + +`cgcreate -g {{group_type}}:{{group_name}}` + +- Create a new group with multiple cgroup types: + +`cgcreate -g {{group_type1}},{{group_type2}}:{{group_name}}` + +- Create a subgroup: + +`mkdir /sys/fs/cgroup/{{group_type}}/{{group_name}}/{{subgroup_name}}` diff --git a/linux/cgexec b/linux/cgexec new file mode 100644 index 00000000..00f55553 --- /dev/null +++ b/linux/cgexec @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cgexec + +> Limit, measure, and control resources used by processes. +> Multiple cgroup types (aka controllers) exist, such as `cpu`, `memory`, etc. +> More information: . + +- Execute a process in a given cgroup with given controller: + +`cgexec -g {{controller}}:{{cgroup_name}} {{process_name}}` diff --git a/linux/cgroups b/linux/cgroups new file mode 100644 index 00000000..0e5c33ba --- /dev/null +++ b/linux/cgroups @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cgroups + +> Cgroups aka control groups is a Linux kernel feature for limiting, measuring, and controlling resource usage by processes. +> Cgroups however is not a command, but rather a collection of commands, see the relevant pages below. +> More information: . + +- View documentation for `cgclassify`: + +`tldr cgclassify` + +- View documentation for `cgcreate`: + +`tldr cgcreate` + +- View documentation for `cgexec`: + +`tldr cgexec` diff --git a/linux/chage b/linux/chage new file mode 100644 index 00000000..9d8b43bb --- /dev/null +++ b/linux/chage @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chage + +> Change user account and password expiry information. +> More information: . + +- List password information for the user: + +`chage --list {{username}}` + +- Enable password expiration in 10 days: + +`sudo chage --maxdays {{10}} {{username}}` + +- Disable password expiration: + +`sudo chage --maxdays {{-1}} {{username}}` + +- Set account expiration date: + +`sudo chage --expiredate {{YYYY-MM-DD}} {{username}}` + +- Force user to change password on next log in: + +`sudo chage --lastday {{0}} {{username}}` diff --git a/linux/chatgpt b/linux/chatgpt new file mode 100644 index 00000000..54a35ffe --- /dev/null +++ b/linux/chatgpt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chatgpt + +> Shell script to use OpenAI's ChatGPT and DALL-E from the terminal. +> More information: . + +- Start in chat mode: + +`chatgpt` + +- Give a [p]rompt to answer to: + +`chatgpt --prompt "{{What is the regex to match an email address?}}"` + +- Start in chat mode using a specific [m]odel (default is `gpt-3.5-turbo`): + +`chatgpt --model {{gpt-4}}` + +- Start in chat mode with an [i]nitial prompt: + +`chatgpt --init-prompt "{{You are Rick, from Rick and Morty. Respond to questions using his mannerism and include insulting jokes.}}"` + +- Pipe the result of a command to `chatgpt` as a prompt: + +`echo "{{How to view running processes on Ubuntu?}}" | chatgpt` + +- Generate an image using DALL-E: + +`chatgpt --prompt "{{image: A white cat}}"` diff --git a/linux/chattr b/linux/chattr new file mode 100644 index 00000000..6c2c252d --- /dev/null +++ b/linux/chattr @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chattr + +> Change attributes of files or directories. +> More information: . + +- Make a file or directory immutable to changes and deletion, even by superuser: + +`chattr +i {{path/to/file_or_directory}}` + +- Make a file or directory mutable: + +`chattr -i {{path/to/file_or_directory}}` + +- Recursively make an entire directory and contents immutable: + +`chattr -R +i {{path/to/directory}}` diff --git a/linux/chcon b/linux/chcon new file mode 100644 index 00000000..d59c44c8 --- /dev/null +++ b/linux/chcon @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chcon + +> Change SELinux security context of a file or files/directories. +> More information: . + +- View security context of a file: + +`ls -lZ {{path/to/file}}` + +- Change the security context of a target file, using a reference file: + +`chcon --reference={{reference_file}} {{target_file}}` + +- Change the full SELinux security context of a file: + +`chcon {{user}}:{{role}}:{{type}}:{{range/level}} {{filename}}` + +- Change only the user part of SELinux security context: + +`chcon -u {{user}} {{filename}}` + +- Change only the role part of SELinux security context: + +`chcon -r {{role}} {{filename}}` + +- Change only the type part of SELinux security context: + +`chcon -t {{type}} {{filename}}` + +- Change only the range/level part of SELinux security context: + +`chcon -l {{range/level}} {{filename}}` diff --git a/linux/chcpu b/linux/chcpu new file mode 100644 index 00000000..71231dde --- /dev/null +++ b/linux/chcpu @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chcpu + +> Enable/disable a system's CPUs. +> More information: . + +- Disable one or more CPUs by their IDs: + +`chcpu -d {{1,3}}` + +- Enable one or more ranges of CPUs by their IDs: + +`chcpu -e {{1-3,5-7}}` diff --git a/linux/check-language-support b/linux/check-language-support new file mode 100644 index 00000000..ff0296f7 --- /dev/null +++ b/linux/check-language-support @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# check-language-support + +> Display a list of missing language packages on Ubuntu. +> More information: . + +- Display a list of missing language packages based on installed software and enabled locales: + +`check-language-support` + +- List packages for a specific locale: + +`check-language-support --language {{en}}` + +- Display installed packages as well as missing ones: + +`check-language-support --show-installed` diff --git a/linux/check-support-status b/linux/check-support-status new file mode 100644 index 00000000..3b841596 --- /dev/null +++ b/linux/check-support-status @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# check-support-status + +> Identify installed Debian packages for which support has had to be limited or prematurely ended. +> More information: . + +- Display packages whose support is limited, has already ended or will end earlier than the distribution's end of life: + +`check-support-status` + +- Display only packages whose support has ended: + +`check-support-status --type {{ended}}` + +- Skip printing a headline: + +`check-support-status --no-heading` diff --git a/linux/checkinstall b/linux/checkinstall new file mode 100644 index 00000000..26e2a802 --- /dev/null +++ b/linux/checkinstall @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# checkinstall + +> Track the local installation of a software package, and produce a binary package which can be used with a system's native package manager. +> More information: . + +- Create and install a package with default settings: + +`sudo checkinstall --default` + +- Create a package but don't install it: + +`sudo checkinstall --install={{no}}` + +- Create a package without documentation: + +`sudo checkinstall --nodoc` + +- Create a package and set the name: + +`sudo checkinstall --pkgname {{package}}` + +- Create a package and specify where to save it: + +`sudo checkinstall --pakdir {{path/to/directory}}` diff --git a/linux/checkupdates b/linux/checkupdates new file mode 100644 index 00000000..535b9aa9 --- /dev/null +++ b/linux/checkupdates @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# checkupdates + +> Check pending updates in Arch Linux. +> More information: . + +- List pending updates: + +`checkupdates` + +- List pending updates and download the packages to the `pacman` cache: + +`checkupdates --download` + +- List pending updates using a specific `pacman` database: + +`CHECKUPDATES_DB={{path/to/directory}} checkupdates` + +- Display help: + +`checkupdates --help` diff --git a/linux/checkupdates-aur b/linux/checkupdates-aur new file mode 100644 index 00000000..4c395e07 --- /dev/null +++ b/linux/checkupdates-aur @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# checkupdates-aur + +> Check pending updates from the Arch User Repository (AUR). +> More information: . + +- List pending updates for AUR packages: + +`checkupdates-aur` + +- List pending updates for AUR packages in debug mode: + +`CHECKUPDATES_DEBUG=1 checkupdates-aur` + +- Display help: + +`checkupdates-aur --help` diff --git a/linux/chfn b/linux/chfn new file mode 100644 index 00000000..8c565f7a --- /dev/null +++ b/linux/chfn @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chfn + +> Update `finger` info for a user. +> More information: . + +- Update a user's "Name" field in the output of `finger`: + +`chfn -f {{new_display_name}} {{username}}` + +- Update a user's "Office Room Number" field for the output of `finger`: + +`chfn -o {{new_office_room_number}} {{username}}` + +- Update a user's "Office Phone Number" field for the output of `finger`: + +`chfn -p {{new_office_telephone_number}} {{username}}` + +- Update a user's "Home Phone Number" field for the output of `finger`: + +`chfn -h {{new_home_telephone_number}} {{username}}` diff --git a/linux/chkconfig b/linux/chkconfig new file mode 100644 index 00000000..d5f429f1 --- /dev/null +++ b/linux/chkconfig @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chkconfig + +> Manage the runlevel of services on CentOS 6. +> More information: . + +- List services with runlevel: + +`chkconfig --list` + +- Show a service's runlevel: + +`chkconfig --list {{ntpd}}` + +- Enable service at boot: + +`chkconfig {{sshd}} on` + +- Enable service at boot for runlevels 2, 3, 4, and 5: + +`chkconfig --level {{2345}} {{sshd}} on` + +- Disable service at boot: + +`chkconfig {{ntpd}} off` + +- Disable service at boot for runlevel 3: + +`chkconfig --level {{3}} {{ntpd}} off` diff --git a/linux/chntpw b/linux/chntpw new file mode 100644 index 00000000..b9982cee --- /dev/null +++ b/linux/chntpw @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chntpw + +> A utility that can edit windows registry, reset user password, promote users to administrator by modifying the Windows SAM. +> Boot target machine with live cd like Kali Linux and run with elevated privileges. +> More information: . + +- List all users in the SAM file: + +`chntpw -l {{path/to/sam_file}}` + +- Edit [u]ser interactively: + +`chntpw -u {{username}} {{path/to/sam_file}}` + +- Use chntpw [i]nteractively: + +`chntpw -i {{path/to/sam_file}}` diff --git a/linux/chpasswd b/linux/chpasswd new file mode 100644 index 00000000..483fad67 --- /dev/null +++ b/linux/chpasswd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chpasswd + +> Change the passwords for multiple users by using `stdin`. +> More information: . + +- Change the password for a specific user: + +`printf "{{username}}:{{new_password}}" | sudo chpasswd` + +- Change the passwords for multiple users (The input text must not contain any spaces.): + +`printf "{{username_1}}:{{new_password_1}} +{{username_2}}:{{new_password_2}}" | sudo chpasswd` + +- Change the password for a specific user, and specify it in encrypted form: + +`printf "{{username}}:{{new_encrypted_password}}" | sudo chpasswd --encrypted` + +- Change the password for a specific user, and use a specific encryption for the stored password: + +`printf "{{username}}:{{new_password}}" | sudo chpasswd --crypt-method {{NONE|DES|MD5|SHA256|SHA512}}` diff --git a/linux/chronyc b/linux/chronyc new file mode 100644 index 00000000..8d330dcf --- /dev/null +++ b/linux/chronyc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chronyc + +> Query the Chrony NTP daemon. +> More information: . + +- Start `chronyc` in interactive mode: + +`chronyc` + +- Display tracking stats for the Chrony daemon: + +`chronyc tracking` + +- Print the time sources that Chrony is currently using: + +`chronyc sources` + +- Display stats for sources currently used by chrony daemon as a time source: + +`chronyc sourcestats` + +- Step the system clock immediately, bypassing any slewing: + +`chronyc makestep` + +- Display verbose information about each NTP source: + +`chronyc ntpdata` diff --git a/linux/chrt b/linux/chrt new file mode 100644 index 00000000..0e6a7183 --- /dev/null +++ b/linux/chrt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chrt + +> Manipulate the real-time attributes of a process. +> More information: . + +- Display attributes of a process: + +`chrt --pid {{PID}}` + +- Display attributes of all threads of a process: + +`chrt --all-tasks --pid {{PID}}` + +- Display the min/max priority values that can be used with `chrt`: + +`chrt --max` + +- Set the scheduling policy for a process: + +`chrt --pid {{PID}} --{{deadline|idle|batch|rr|fifo|other}}` diff --git a/linux/chsh b/linux/chsh new file mode 100644 index 00000000..4f6d493f --- /dev/null +++ b/linux/chsh @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# chsh + +> Change user's login shell. +> Part of `util-linux`. +> More information: . + +- Set a specific login shell for the current user interactively: + +`sudo chsh` + +- Set a specific login [s]hell for the current user: + +`sudo chsh --shell {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`sudo chsh --shell {{path/to/shell}} {{username}}` + +- [l]ist available shells: + +`sudo chsh --list-shells` diff --git a/linux/cloud-init b/linux/cloud-init new file mode 100644 index 00000000..ac68d2be --- /dev/null +++ b/linux/cloud-init @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cloud-init + +> Command line tool for managing cloud instance initialization. +> More information: . + +- Display the status of the most recent cloud-init run: + +`cloud-init status` + +- Wait for cloud-init to finish running and then report status: + +`cloud-init status --wait` + +- List available top-level metadata keys to query: + +`cloud-init query --list-keys` + +- Query cached instance metadata for data: + +`cloud-init query {{dot_delimited_variable_path}}` + +- Clean logs and artifacts to allow cloud-init to rerun: + +`cloud-init clean` diff --git a/linux/cmus b/linux/cmus new file mode 100644 index 00000000..cced229b --- /dev/null +++ b/linux/cmus @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cmus + +> Command-line Music Player. +> Use arrow keys to navigate, `` to select, and numbers 1-8 switch between different views. +> More information: . + +- Open cmus into the specified directory (this will become your new working directory): + +`cmus {{path/to/directory}}` + +- Add file/directory to library: + +`:add {{path/to/file_or_directory}}` + +- Pause/unpause current song: + +`c` + +- Toggle shuffle mode on/off: + +`s` + +- Quit cmus: + +`q` diff --git a/linux/cockpit-bridge b/linux/cockpit-bridge new file mode 100644 index 00000000..945c7502 --- /dev/null +++ b/linux/cockpit-bridge @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cockpit-bridge + +> Relay messages and commands between the front end and server in the cockpit suite. +> More information: . + +- List all cockpit packages: + +`cockpit-bridge --packages` + +- Display help: + +`cockpit-bridge --help` diff --git a/linux/cockpit-desktop b/linux/cockpit-desktop new file mode 100644 index 00000000..0763ad40 --- /dev/null +++ b/linux/cockpit-desktop @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cockpit-desktop + +> Provides secure access to Cockpit pages in an already running session. +> It starts `cockpit-ws` and a web browser in an isolated network space and a `cockpit-bridge` in a running user session. +> More information: . + +- Open a page: + +`cockpit-desktop {{url}} {{SSH_host}}` + +- Open storage page: + +`cockpit-desktop {{/cockpit/@localhost/storage/index.html}}` diff --git a/linux/cockpit-tls b/linux/cockpit-tls new file mode 100644 index 00000000..d249521b --- /dev/null +++ b/linux/cockpit-tls @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cockpit-tls + +> TLS terminating HTTP proxy to encrypt traffic between a client and `cockpit-ws`. +> More information: . + +- Serve HTTP requests to a specific port instead of port `9090`: + +`cockpit-tls --port {{port}}` + +- Display help: + +`cockpit-tls --help` diff --git a/linux/cockpit-ws b/linux/cockpit-ws new file mode 100644 index 00000000..844a9fef --- /dev/null +++ b/linux/cockpit-ws @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cockpit-ws + +> Communicate between the browser application and various configuration tools and services like `cockpit-bridge`. +> More information: . + +- Start with authentication via SSH at `127.0.0.1` with port `22` enabled: + +`cockpit-ws --local-ssh` + +- Start an HTTP server on a specific port: + +`cockpit-ws --port {{port}}` + +- Start and bind to a specific IP address (defaults to `0.0.0.0`): + +`cockpit-ws --address {{ip_address}}` + +- Start without TLS: + +`cockpit-ws --no-tls` + +- Display help: + +`cockpit-ws --help` diff --git a/linux/collectd b/linux/collectd new file mode 100644 index 00000000..663d331a --- /dev/null +++ b/linux/collectd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# collectd + +> System statistics collection daemon. +> More information: . + +- Test the configuration file and then exit: + +`collectd -t` + +- Test plugin data collection functionality and then exit: + +`collectd -T` + +- Start `collectd`: + +`collectd` + +- Specify a custom configuration file location: + +`collectd -C {{path/to/file}}` + +- Specify a custom PID file location: + +`collectd -P {{path/to/file}}` + +- Don't fork into the background: + +`collectd -f` + +- Display help and version: + +`collectd -h` diff --git a/linux/colrm b/linux/colrm new file mode 100644 index 00000000..89441e2c --- /dev/null +++ b/linux/colrm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# colrm + +> Remove columns from `stdin`. +> More information: . + +- Remove first column of `stdin`: + +`colrm {{1 1}}` + +- Remove from 3rd column till the end of each line: + +`colrm {{3}}` + +- Remove from the 3rd column till the 5th column of each line: + +`colrm {{3 5}}` diff --git a/linux/compopt b/linux/compopt new file mode 100644 index 00000000..9aeef926 --- /dev/null +++ b/linux/compopt @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# compopt + +> Print or change the completion options for a command. +> More information: . + +- Print the options for the currently executing completion: + +`compopt` + +- Print the completion options for given command: + +`compopt {{command}}` diff --git a/linux/compose b/linux/compose new file mode 100644 index 00000000..eb71c654 --- /dev/null +++ b/linux/compose @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# compose + +> An alias to a `run-mailcap`'s action compose. +> Originally `run-mailcap` is used to mime-type/file. +> More information: . + +- Compose action can be used to compose any existing file or new on default mailcap edit tool: + +`compose {{filename}}` + +- With `run-mailcap`: + +`run-mailcap --action=compose {{filename}}` diff --git a/linux/compress b/linux/compress new file mode 100644 index 00000000..ef53f736 --- /dev/null +++ b/linux/compress @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# compress + +> Compress files using the Unix `compress` command. +> More information: . + +- Compress specific files: + +`compress {{path/to/file1 path/to/file2 ...}}` + +- Compress specific files, ignore non-existent ones: + +`compress -f {{path/to/file1 path/to/file2 ...}}` + +- Specify the maximum compression bits (9-16 bits): + +`compress -b {{bits}}` + +- Write to `stdout` (no files are changed): + +`compress -c {{path/to/file}}` + +- Decompress files (functions like `uncompress`): + +`compress -d {{path/to/file}}` + +- Display compression percentage: + +`compress -v {{path/to/file}}` diff --git a/linux/compsize b/linux/compsize new file mode 100644 index 00000000..f2d5daa0 --- /dev/null +++ b/linux/compsize @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# compsize + +> Calculate the compression ratio of a set of files on a btrfs filesystem. +> See also `btrfs filesystem` for recompressing a file by defragmenting it. +> More information: . + +- Calculate the current compression ratio for a file or directory: + +`sudo compsize {{path/to/file_or_directory}}` + +- Don't traverse filesystem boundaries: + +`sudo compsize --one-file-system {{path/to/file_or_directory}}` + +- Show raw byte counts instead of human-readable sizes: + +`sudo compsize --bytes {{path/to/file_or_directory}}` diff --git a/linux/conky b/linux/conky new file mode 100644 index 00000000..83c3063b --- /dev/null +++ b/linux/conky @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# conky + +> Light-weight system monitor for X. +> More information: . + +- Launch with default, built-in config: + +`conky` + +- Create a new default config: + +`conky -C > ~/.conkyrc` + +- Launch Conky with a given configuration file: + +`conky -c {{path/to/config}}` + +- Start in the background (daemonize): + +`conky -d` + +- Align Conky on the desktop: + +`conky -a {{top|bottom|middle}}_{{left|right|middle}}` + +- Pause for 5 seconds at startup before launching: + +`conky -p {{5}}` diff --git a/linux/conntrack b/linux/conntrack new file mode 100644 index 00000000..100a7857 --- /dev/null +++ b/linux/conntrack @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# conntrack + +> Interact with the Netfilter connection tracking system. +> Search, list, inspect, modify, and delete connection flows. +> More information: . + +- List all currently tracked connections: + +`conntrack --dump` + +- Display a real-time event log of connection changes: + +`conntrack --event` + +- Display a real-time event log of connection changes and associated timestamps: + +`conntrack --event -o timestamp` + +- Display a real-time event log of connection changes for a specific IP address: + +`conntrack --event --orig-src {{ip_address}}` + +- Delete all flows for a specific source IP address: + +`conntrack --delete --orig-src {{ip_address}}` diff --git a/linux/coproc b/linux/coproc new file mode 100644 index 00000000..5b7656c4 --- /dev/null +++ b/linux/coproc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# coproc + +> Bash builtin for creating interactive asynchronous subshells. +> More information: . + +- Run a subshell asynchronously: + +`coproc { {{command1; command2; ...}}; }` + +- Create a coprocess with a specific name: + +`coproc {{name}} { {{command1; command2; ...}}; }` + +- Write to a specific coprocess `stdin`: + +`echo "{{input}}" >&"${{{name}}[1]}"` + +- Read from a specific coprocess `stdout`: + +`read {{variable}} <&"${{{name}}[0]}"` + +- Create a coprocess which repeatedly reads `stdin` and runs some commands on the input: + +`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 }` + +- Create and use a coprocess running `bc`: + +`coproc BC { bc --mathlib; }; echo "1/3" >&"${BC[1]}"; read output <&"${BC[0]}"; echo "$output"` diff --git a/linux/coredumpctl b/linux/coredumpctl new file mode 100644 index 00000000..cfe7cd92 --- /dev/null +++ b/linux/coredumpctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# coredumpctl + +> Retrieve and process saved core dumps and metadata. +> More information: . + +- List all captured core dumps: + +`coredumpctl list` + +- List captured core dumps for a program: + +`coredumpctl list {{program}}` + +- Show information about the core dumps matching a program with `PID`: + +`coredumpctl info {{PID}}` + +- Invoke debugger using the last core dump of a program: + +`coredumpctl debug {{program}}` + +- Extract the last core dump of a program to a file: + +`coredumpctl --output={{path/to/file}} dump {{program}}` diff --git a/linux/cp b/linux/cp new file mode 100644 index 00000000..eaa5b7a9 --- /dev/null +++ b/linux/cp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cp + +> Copy files and directories. +> More information: . + +- Copy a file to another location: + +`cp {{path/to/source_file.ext}} {{path/to/target_file.ext}}` + +- Copy a file into another directory, keeping the filename: + +`cp {{path/to/source_file.ext}} {{path/to/target_parent_directory}}` + +- Recursively copy a directory's contents to another location (if the destination exists, the directory is copied inside it): + +`cp -r {{path/to/source_directory}} {{path/to/target_directory}}` + +- Copy a directory recursively, in verbose mode (shows files as they are copied): + +`cp -vr {{path/to/source_directory}} {{path/to/target_directory}}` + +- Copy multiple files at once to a directory: + +`cp -t {{path/to/destination_directory}} {{path/to/file1 path/to/file2 ...}}` + +- Copy all files with a specific extension to another location, in interactive mode (prompts user before overwriting): + +`cp -i {{*.ext}} {{path/to/target_directory}}` + +- Follow symbolic links before copying: + +`cp -L {{link}} {{path/to/target_directory}}` + +- Use the full path of source files, creating any missing intermediate directories when copying: + +`cp --parents {{source/path/to/file}} {{path/to/target_file}}` diff --git a/linux/cpufreq-aperf b/linux/cpufreq-aperf new file mode 100644 index 00000000..9a6fa16f --- /dev/null +++ b/linux/cpufreq-aperf @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpufreq-aperf + +> Calculate the average CPU frequency over a time period. +> Requires root privileges. +> More information: . + +- Start calculating, defaulting to all CPU cores and 1 second refresh interval: + +`sudo cpufreq-aperf` + +- Start calculating for CPU 1 only: + +`sudo cpufreq-aperf -c {{1}}` + +- Start calculating with a 3 second refresh interval for all CPU cores: + +`sudo cpufreq-aperf -i {{3}}` + +- Calculate only once: + +`sudo cpufreq-aperf -o` diff --git a/linux/cpufreq-info b/linux/cpufreq-info new file mode 100644 index 00000000..1ebcd8b4 --- /dev/null +++ b/linux/cpufreq-info @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpufreq-info + +> A tool to show CPU frequency information. +> More information: . + +- Show CPU frequency information for all CPUs: + +`cpufreq-info` + +- Show CPU frequency information for the specified CPU: + +`cpufreq-info -c {{cpu_number}}` + +- Show the allowed minimum and maximum CPU frequency: + +`cpufreq-info -l` + +- Show the current minimum and maximum CPU frequency and policy in table format: + +`cpufreq-info -o` + +- Show available CPU frequency policies: + +`cpufreq-info -g` + +- Show current CPU work frequency in a human-readable format, according to the cpufreq kernel module: + +`cpufreq-info -f -m` + +- Show current CPU work frequency in a human-readable format, by reading it from hardware (only available to root): + +`sudo cpufreq-info -w -m` diff --git a/linux/cpufreq-set b/linux/cpufreq-set new file mode 100644 index 00000000..3e0af385 --- /dev/null +++ b/linux/cpufreq-set @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpufreq-set + +> A tool to modify CPU frequency settings. +> The frequency value should range between the output of command `cpufreq-info -l`. +> More information: . + +- Set the CPU frequency policy of CPU 1 to "userspace": + +`sudo cpufreq-set -c {{1}} -g {{userspace}}` + +- Set the current minimum CPU frequency of CPU 1: + +`sudo cpufreq-set -c {{1}} --min {{min_frequency}}` + +- Set the current maximum CPU frequency of CPU 1: + +`sudo cpufreq-set -c {{1}} --max {{max_frequency}}` + +- Set the current work frequency of CPU 1: + +`sudo cpufreq-set -c {{1}} -f {{work_frequency}}` diff --git a/linux/cpuid b/linux/cpuid new file mode 100644 index 00000000..bbc6e827 --- /dev/null +++ b/linux/cpuid @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpuid + +> Display detailed information about all CPUs. +> More information: . + +- Display information for all CPUs: + +`cpuid` + +- Display information only for the current CPU: + +`cpuid -1` + +- Display raw hex information with no decoding: + +`cpuid -r` diff --git a/linux/cpulimit b/linux/cpulimit new file mode 100644 index 00000000..2595a117 --- /dev/null +++ b/linux/cpulimit @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpulimit + +> A tool to throttle the CPU usage of other processes. +> More information: . + +- Limit an existing process with PID 1234 to only use 25% of the CPU: + +`cpulimit --pid {{1234}} --limit {{25%}}` + +- Limit an existing program by its executable name: + +`cpulimit --exe {{program}} --limit {{25}}` + +- Launch a given program and limit it to only use 50% of the CPU: + +`cpulimit --limit {{50}} -- {{program argument1 argument2 ...}}` + +- Launch a program, limit its CPU usage to 50% and run cpulimit in the background: + +`cpulimit --limit {{50}} --background -- {{program}}` + +- Kill its process if the program's CPU usage goes over 50%: + +`cpulimit --limit 50 --kill -- {{program}}` + +- Throttle both it and its child processes so that none go about 25% CPU: + +`cpulimit --limit {{25}} --monitor-forks -- {{program}}` diff --git a/linux/cpupower b/linux/cpupower new file mode 100644 index 00000000..342942d9 --- /dev/null +++ b/linux/cpupower @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cpupower + +> Tools regarding CPU power and tuning options. +> More information: . + +- List CPUs: + +`sudo cpupower --cpu {{all}} info` + +- Print information about all cores: + +`sudo cpupower --cpu {{all}} info` + +- Set all CPUs to a power-saving frequency governor: + +`sudo cpupower --cpu {{all}} frequency-set --governor {{powersave}}` + +- Print CPU 0's available frequency [g]overnors: + +`sudo cpupower --cpu {{0}} frequency-info g | grep "analyzing\|governors"` + +- Print CPU 4's frequency from the hardware, in a human-readable format: + +`sudo cpupower --cpu {{4}} frequency-info --hwfreq --human` diff --git a/linux/create_ap b/linux/create_ap new file mode 100644 index 00000000..aa565439 --- /dev/null +++ b/linux/create_ap @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# create_ap + +> Create an AP (Access Point) at any channel. +> More information: . + +- Create an open network with no passphrase: + +`create_ap {{wlan0}} {{eth0}} {{access_point_ssid}}` + +- Use a WPA + WPA2 passphrase: + +`create_ap {{wlan0}} {{eth0}} {{access_point_ssid}} {{passphrase}}` + +- Create an access point without Internet sharing: + +`create_ap -n {{wlan0}} {{access_point_ssid}} {{passphrase}}` + +- Create a bridged network with Internet sharing: + +`create_ap -m bridge {{wlan0}} {{eth0}} {{access_point_ssid}} {{passphrase}}` + +- Create a bridged network with Internet sharing and a pre-configured bridge interface: + +`create_ap -m bridge {{wlan0}} {{br0}} {{access_point_ssid}} {{passphrase}}` + +- Create an access port for Internet sharing from the same Wi-Fi interface: + +`create_ap {{wlan0}} {{wlan0}} {{access_point_ssid}} {{passphrase}}` + +- Choose a different Wi-Fi adapter driver: + +`create_ap --driver {{wifi_adapter}} {{wlan0}} {{eth0}} {{access_point_ssid}} {{passphrase}}` diff --git a/linux/createrepo b/linux/createrepo new file mode 100644 index 00000000..53ddb129 --- /dev/null +++ b/linux/createrepo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# createrepo + +> Initializes an RPM repository in a directory, including all XML and SQLite files. +> More information: . + +- Initialize a basic repository in a directory: + +`createrepo {{path/to/directory}}` + +- Initialize a repository, exclude test RPMs and display verbose logs: + +`createrepo -v -x {{test_*.rpm}} {{path/to/directory}}` + +- Initialize a repository, using SHA1 as the checksum algorithm, and ignoring symbolic links: + +`createrepo -S -s {{sha1}} {{path/to/directory}}` diff --git a/linux/cryptcat b/linux/cryptcat new file mode 100644 index 00000000..4d223846 --- /dev/null +++ b/linux/cryptcat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cryptcat + +> Cryptcat is netcat with encryption capabilities. +> More information: . + +- [l]isten on a specified [p]ort and print any data received: + +`cryptcat -k {{password}} -l -p {{port}}` + +- Connect to a certain port: + +`cryptcat -k {{password}} {{ip_address}} {{port}}` + +- Specify the timeout ([w]): + +`cryptcat -k {{password}} -w {{timeout_in_seconds}} {{ip_address}} {{port}}` + +- Scan ([z]) the open ports of a specified host: + +`cryptcat -v -z {{ip_address}} {{port}}` + +- Act as proxy and forward data from a local TCP port to the given remote host: + +`cryptcat -k {{password}} -l -p {{local_port}} | cryptcat -k {{password}} {{hostname}} {{remote_port}}` diff --git a/linux/cryptsetup b/linux/cryptsetup new file mode 100644 index 00000000..350138a1 --- /dev/null +++ b/linux/cryptsetup @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cryptsetup + +> Manage plain dm-crypt and LUKS (Linux Unified Key Setup) encrypted volumes. +> More information: . + +- Initialize a LUKS volume (overwrites all data on the partition): + +`cryptsetup luksFormat {{/dev/sda1}}` + +- Open a LUKS volume and create a decrypted mapping at `/dev/mapper/target`: + +`cryptsetup luksOpen {{/dev/sda1}} {{target}}` + +- Remove an existing mapping: + +`cryptsetup luksClose {{target}}` + +- Change the LUKS volume's passphrase: + +`cryptsetup luksChangeKey {{/dev/sda1}}` diff --git a/linux/csplit b/linux/csplit new file mode 100644 index 00000000..83e6e366 --- /dev/null +++ b/linux/csplit @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# csplit + +> Split a file into pieces. +> This generates files named "xx00", "xx01", and so on. +> More information: . + +- Split a file at lines 5 and 23: + +`csplit {{path/to/file}} 5 23` + +- Split a file every 5 lines (this will fail if the total number of lines is not divisible by 5): + +`csplit {{path/to/file}} 5 {*}` + +- Split a file every 5 lines, ignoring exact-division error: + +`csplit -k {{path/to/file}} 5 {*}` + +- Split a file at line 5 and use a custom prefix for the output files: + +`csplit {{path/to/file}} 5 -f {{prefix}}` + +- Split a file at a line matching a regular expression: + +`csplit {{path/to/file}} /{{regular_expression}}/` diff --git a/linux/ctr b/linux/ctr new file mode 100644 index 00000000..c9b8fcd5 --- /dev/null +++ b/linux/ctr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ctr + +> Manage `containerd` containers and images. +> More information: . + +- List all containers (running and stopped): + +`ctr containers list` + +- List all images: + +`ctr images list` + +- Pull an image: + +`ctr images pull {{image}}` + +- Tag an image: + +`ctr images tag {{source_image}}:{{source_tag}} {{target_image}}:{{target_tag}}` diff --git a/linux/ctrlaltdel b/linux/ctrlaltdel new file mode 100644 index 00000000..8cb747f1 --- /dev/null +++ b/linux/ctrlaltdel @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ctrlaltdel + +> Utility to control what happens when CTRL+ALT+DEL is pressed. +> More information: . + +- Get current setting: + +`ctrlaltdel` + +- Set CTRL+ALT+DEL to reboot immediately, without any preparation: + +`sudo ctrlaltdel hard` + +- Set CTRL+ALT+DEL to reboot "normally", giving processes a chance to exit first (send SIGINT to PID1): + +`sudo ctrlaltdel soft` diff --git a/linux/curlie b/linux/curlie new file mode 100644 index 00000000..80418dc9 --- /dev/null +++ b/linux/curlie @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# curlie + +> A frontend to `curl` that adds the ease of use of `httpie`. +> More information: . + +- Send a GET request: + +`curlie {{httpbin.org/get}}` + +- Send a POST request: + +`curlie post {{httpbin.org/post}} {{name=john}} {{age:=25}}` + +- Send a GET request with query parameters (e.g. `first_param=5&second_param=true`): + +`curlie get {{httpbin.org/get}} {{first_param==5}} {{second_param==true}}` + +- Send a GET request with a custom header: + +`curlie get {{httpbin.org/get}} {{header-name:header-value}}` diff --git a/linux/cuyo b/linux/cuyo new file mode 100644 index 00000000..8589fec9 --- /dev/null +++ b/linux/cuyo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# cuyo + +> Tetris like game. +> More information: . + +- Start a new game: + +`cuyo` + +- Navigate the piece horizontally: + +`{{A|D|Left arrow key|Right arrow key}}` + +- Turn the piece: + +`{{W|Up arrow key}}` + +- Hard drop the piece: + +`{{S|Down arrow key}}` diff --git a/linux/daemon b/linux/daemon new file mode 100644 index 00000000..d7d9500c --- /dev/null +++ b/linux/daemon @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# daemon + +> Run processes into daemons. +> More information: . + +- Run a command as a daemon: + +`daemon --name="{{name}}" {{command}}` + +- Run a command as a daemon which will restart if the command crashes: + +`daemon --name="{{name}}" --respawn {{command}}` + +- Run a command as a daemon which will restart if it crashes, with two attempts every 10 seconds: + +`daemon --name="{{name}}" --respawn --attempts=2 --delay=10 {{command}}` + +- Run a command as a daemon, writing logs to a specific file: + +`daemon --name="{{name}}" --errlog={{path/to/file.log}} {{command}}` + +- Kill a daemon (SIGTERM): + +`daemon --name="{{name}}" --stop` + +- List daemons: + +`daemon --list` diff --git a/linux/daemonize b/linux/daemonize new file mode 100644 index 00000000..f36121cd --- /dev/null +++ b/linux/daemonize @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# daemonize + +> Run a command (that does not daemonize itself) as a Unix daemon. +> More information: . + +- Run a command as a daemon: + +`daemonize {{command}} {{command_arguments}}` + +- Write the PID to the specified file: + +`daemonize -p {{path/to/pidfile}} {{command}} {{command_arguments}}` + +- Use a lock file to ensure that only one instance runs at a time: + +`daemonize -l {{path/to/lockfile}} {{command}} {{command_arguments}}` + +- Use the specified user account: + +`sudo daemonize -u {{user}} {{command}} {{command_arguments}}` diff --git a/linux/datamash b/linux/datamash new file mode 100644 index 00000000..fe795c78 --- /dev/null +++ b/linux/datamash @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# datamash + +> Perform basic numeric, textual and statistical operations on input textual data files. +> More information: . + +- Get max, min, mean and median of a single column of numbers: + +`seq 3 | datamash max 1 min 1 mean 1 median 1` + +- Get the mean of a single column of float numbers (floats must use "," and not "."): + +`echo -e '1.0 +2.5 +3.1 +4.3 +5.6 +5.7' | tr '.' ',' | datamash mean 1` + +- Get the mean of a single column of numbers with a given decimal precision: + +`echo -e '1 +2 +3 +4 +5 +5' | datamash -R {{number_of_decimals_wanted}} mean 1` + +- Get the mean of a single column of numbers ignoring "Na" and "NaN" (literal) strings: + +`echo -e '1 +2 +Na +3 +NaN' | datamash --narm mean 1` diff --git a/linux/dbclient b/linux/dbclient new file mode 100644 index 00000000..54465194 --- /dev/null +++ b/linux/dbclient @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dbclient + +> Lightweight Dropbear Secure Shell client. +> More information: . + +- Connect to a remote host: + +`dbclient {{user}}@{{host}}` + +- Connect to a remote host on [p]ort 2222: + +`dbclient {{user}}@{{host}} -p 2222` + +- Connect to a remote host using a specific [i]dentity key in dropbear format: + +`dbclient -i {{path/to/key_file}} {{user}}@{{host}}` + +- Run a command on the remote host with a [t]ty allocation allowing interaction with the remote command: + +`dbclient {{user}}@{{host}} -t {{command}} {{argument1 argument2 ...}}` + +- Connect and forward [A]gent connections to remote host: + +`dbclient -A {{user}}@{{host}}` diff --git a/linux/dbus-daemon b/linux/dbus-daemon new file mode 100644 index 00000000..a91e6177 --- /dev/null +++ b/linux/dbus-daemon @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dbus-daemon + +> The D-Bus message daemon, allowing multiple programs to exchange messages. +> More information: . + +- Run the daemon with a configuration file: + +`dbus-daemon --config-file {{path/to/file}}` + +- Run the daemon with the standard per-login-session message bus configuration: + +`dbus-daemon --session` + +- Run the daemon with the standard systemwide message bus configuration: + +`dbus-daemon --system` + +- Set the address to listen on and override the configuration value for it: + +`dbus-daemon --address {{address}}` + +- Output the process ID to `stdout`: + +`dbus-daemon --print-pid` + +- Force the message bus to write to the system log for messages: + +`dbus-daemon --syslog` diff --git a/linux/dconf b/linux/dconf new file mode 100644 index 00000000..4c3d2e37 --- /dev/null +++ b/linux/dconf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dconf + +> Manage dconf databases. +> See also: `dconf-read`, `dconf-reset`, `dconf-write`, `gsettings`. +> More information: . + +- Print a specific key value: + +`dconf read {{/path/to/key}}` + +- Print a specific path sub-directories and sub-keys: + +`dconf list {{/path/to/directory/}}` + +- Write a specific key value: + +`dconf write {{/path/to/key}} "{{value}}"` + +- Reset a specific key value: + +`dconf reset {{/path/to/key}}` + +- Watch a specific key/directory for changes: + +`dconf watch {{/path/to/key|/path/to/directory/}}` + +- Dump a specific directory in INI file format: + +`dconf dump {{/path/to/directory/}}` diff --git a/linux/dconf-read b/linux/dconf-read new file mode 100644 index 00000000..91432ba8 --- /dev/null +++ b/linux/dconf-read @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dconf read + +> Read key values from dconf databases. +> See also: `dconf`. +> More information: . + +- Print a specific key value: + +`dconf read {{/path/to/key}}` + +- Print a specific key [d]efault value: + +`dconf read -d {{/path/to/key}}` diff --git a/linux/dconf-reset b/linux/dconf-reset new file mode 100644 index 00000000..d01b1a68 --- /dev/null +++ b/linux/dconf-reset @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dconf reset + +> Reset key values in dconf databases. +> See also: `dconf`. +> More information: . + +- Reset a specific key value: + +`dconf read {{/path/to/key}}` + +- Reset a specific directory: + +`dconf read -d {{/path/to/directory/}}` diff --git a/linux/dconf-write b/linux/dconf-write new file mode 100644 index 00000000..af63dd91 --- /dev/null +++ b/linux/dconf-write @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dconf write + +> Write key values in dconf databases. +> See also: `dconf`. +> More information: . + +- Write a specific key value: + +`dconf write {{/path/to/key}} "{{value}}"` + +- Write a specific string key value: + +`dconf write {{/path/to/key}} "'{{string}}'"` + +- Write a specific integer key value: + +`dconf write {{/path/to/key}} "{{5}}"` + +- Write a specific boolean key value: + +`dconf write {{/path/to/key}} "{{true|false}}"` + +- Write a specific array key value: + +`dconf write {{/path/to/key}} "[{{'first', 'second', ...}}]"` + +- Write a specific empty array key value: + +`dconf write {{/path/to/key}} "@as []"` diff --git a/linux/dd b/linux/dd new file mode 100644 index 00000000..199e688a --- /dev/null +++ b/linux/dd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dd + +> Convert and copy a file. +> More information: . + +- Make a bootable USB drive from an isohybrid file (such like `archlinux-xxx.iso`) and show the progress: + +`dd if={{path/to/file.iso}} of={{/dev/usb_drive}} status=progress` + +- Clone a drive to another drive with 4 MiB block, ignore error and show the progress: + +`dd if={{/dev/source_drive}} of={{/dev/dest_drive}} bs={{4M}} conv={{noerror}} status=progress` + +- Generate a file of 100 random bytes by using kernel random driver: + +`dd if=/dev/urandom of={{path/to/random_file}} bs={{100}} count={{1}}` + +- Benchmark the write performance of a disk: + +`dd if=/dev/zero of={{path/to/file_1GB}} bs={{1024}} count={{1000000}}` + +- Generate a system backup into an IMG file and show the progress: + +`dd if={{/dev/drive_device}} of={{path/to/file.img}} status=progress` + +- Restore a drive from an IMG file and show the progress: + +`dd if={{path/to/file.img}} of={{/dev/drive_device}} status=progress` + +- Check the progress of an ongoing dd operation (run this command from another shell): + +`kill -USR1 $(pgrep -x dd)` diff --git a/linux/ddcutil b/linux/ddcutil new file mode 100644 index 00000000..0e4d167e --- /dev/null +++ b/linux/ddcutil @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ddcutil + +> Control the settings of connected displays via DDC/CI. +> This command requires the kernel module `i2c-dev` to be loaded. See also: `modprobe`. +> More information: . + +- List all compatible displays: + +`ddcutil detect` + +- Change the brightness (option 0x10) of display 1 to 50%: + +`ddcutil --display {{1}} setvcp {{10}} {{50}}` + +- Increase the contrast (option 0x12) of display 1 by 5%: + +`ddcutil -d {{1}} setvcp {{12}} {{+}} {{5}}` + +- Read the settings of display 1: + +`ddcutil -d {{1}} getvcp {{ALL}}` diff --git a/linux/ddrescue b/linux/ddrescue new file mode 100644 index 00000000..6fd7d260 --- /dev/null +++ b/linux/ddrescue @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ddrescue + +> Data recovery tool that reads data from damaged block devices. +> More information: . + +- Take an image of a device, creating a log file: + +`sudo ddrescue {{/dev/sdb}} {{path/to/image.dd}} {{path/to/log.txt}}` + +- Clone Disk A to Disk B, creating a log file: + +`sudo ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}} {{path/to/log.txt}}` diff --git a/linux/debchange b/linux/debchange new file mode 100644 index 00000000..86847608 --- /dev/null +++ b/linux/debchange @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debchange + +> Mantain the debian/changelog file of a Debian source package. +> More information: . + +- Add a new version for a non-maintainer upload to the changelog: + +`debchange --nmu` + +- Add a changelog entry to the current version: + +`debchange --append` + +- Add a changelog entry to close the bug with specified ID: + +`debchange --closes {{bug_id}}` diff --git a/linux/debman b/linux/debman new file mode 100644 index 00000000..6d405c87 --- /dev/null +++ b/linux/debman @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debman + +> Read man pages from uninstalled packages. +> More information: . + +- Read a man page for a command that is provided by a specified package: + +`debman -p {{package}} {{command}}` + +- Specify a package version to download: + +`debman -p {{package}}={{version}} {{command}}` + +- Read a man page in a `.deb` file: + +`debman -f {{path/to/filename.deb}} {{command}}` diff --git a/linux/debootstrap b/linux/debootstrap new file mode 100644 index 00000000..a947c268 --- /dev/null +++ b/linux/debootstrap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debootstrap + +> Create a basic Debian system. +> More information: . + +- Create a Debian stable release system inside the `debian-root` directory: + +`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/}}` + +- 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/}}` + +- Switch to a bootstrapped system: + +`sudo chroot {{path/to/root}}` + +- List available releases: + +`ls /usr/share/debootstrap/scripts/` diff --git a/linux/deborphan b/linux/deborphan new file mode 100644 index 00000000..e6ea3079 --- /dev/null +++ b/linux/deborphan @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# deborphan + +> Display orphan packages on operating systems using the APT package manager. +> More information: . + +- Display library packages (from the "libs" section of the package repository) which are not required by another package: + +`deborphan` + +- List orphan packages from the "libs" section as well as orphan packages that have a name that looks like a library name: + +`deborphan --guess-all` + +- Find packages which are only recommended or suggested (but not required) by another package: + +`deborphan --nice-mode` diff --git a/linux/debsecan b/linux/debsecan new file mode 100644 index 00000000..96e2a808 --- /dev/null +++ b/linux/debsecan @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debsecan + +> Debian Security Analyzer, a tool to list vulnerabilities on a particular Debian installation. +> More information: . + +- List vulnerable installed packages on the current host: + +`debsecan` + +- List vulnerable installed packages of a specific suite: + +`debsecan --suite {{release_code_name}}` + +- List only fixed vulnerabilities: + +`debsecan --suite {{release_code_name}} --only-fixed` + +- List only fixed vulnerabilities of unstable ("sid") and mail to root: + +`debsecan --suite {{sid}} --only-fixed --format {{report}} --mailto {{root}} --update-history` + +- Upgrade vulnerable installed packages: + +`sudo apt upgrade $(debsecan --only-fixed --format {{packages}})` diff --git a/linux/debtap b/linux/debtap new file mode 100644 index 00000000..c8506b8b --- /dev/null +++ b/linux/debtap @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debtap + +> Convert Debian packages into Arch Linux packages. +> See also: `pacman-upgrade`. +> More information: . + +- Update debtap database (before the first run): + +`sudo debtap --update` + +- Convert the specified package: + +`debtap {{path/to/package.deb}}` + +- Convert the specified package bypassing all questions, except for editing metadata files: + +`debtap --quiet {{path/to/package.deb}}` + +- Generate a PKGBUILD file: + +`debtap --pkgbuild {{path/to/package.deb}}` diff --git a/linux/debugfs b/linux/debugfs new file mode 100644 index 00000000..887744b8 --- /dev/null +++ b/linux/debugfs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debugfs + +> An interactive ext2/ext3/ext4 filesystem debugger. +> More information: . + +- Open the filesystem in read only mode: + +`debugfs {{/dev/sdXN}}` + +- Open the filesystem in read write mode: + +`debugfs -w {{/dev/sdXN}}` + +- Read commands from a specified file, execute them and then exit: + +`debugfs -f {{path/to/cmd_file}} {{/dev/sdXN}}` + +- View the filesystem stats in debugfs console: + +`stats` + +- Close the filesystem: + +`close -a` + +- List all available commands: + +`lr` diff --git a/linux/debuild b/linux/debuild new file mode 100644 index 00000000..c161eb01 --- /dev/null +++ b/linux/debuild @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# debuild + +> Build a Debian package from source. +> More information: . + +- Build the package in the current directory: + +`debuild` + +- Build a binary package only: + +`debuild -b` + +- Do not run lintian after building the package: + +`debuild --no-lintian` diff --git a/linux/delpart b/linux/delpart new file mode 100644 index 00000000..2eb7b1c4 --- /dev/null +++ b/linux/delpart @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# delpart + +> Ask the Linux kernel to forget about a partition. +> More information: . + +- Tell the kernel to forget about the first partition of `/dev/sda`: + +`sudo delpart {{/dev/sda}} {{1}}` diff --git a/linux/deluser b/linux/deluser new file mode 100644 index 00000000..eb17df32 --- /dev/null +++ b/linux/deluser @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# deluser + +> Delete a user from the system. +> More information: . + +- Remove a user: + +`sudo deluser {{username}}` + +- Remove a user and their home directory: + +`sudo deluser --remove-home {{username}}` + +- Remove a user and their home, but backup their files into a `.tar.gz` file in the specified directory: + +`sudo deluser --backup-to {{path/to/backup_directory}} --remove-home {{username}}` + +- Remove a user, and all files owned by them: + +`sudo deluser --remove-all-files {{username}}` diff --git a/linux/dex b/linux/dex new file mode 100644 index 00000000..55bcfdb2 --- /dev/null +++ b/linux/dex @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dex + +> DesktopEntry Execution is a program to generate and execute DesktopEntry files of the Application type. +> More information: . + +- Execute all programs in the autostart folders: + +`dex --autostart` + +- Execute all programs in the specified folders: + +`dex --autostart --search-paths {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` + +- Preview the programs would be executed in a GNOME specific autostart: + +`dex --autostart --environment {{GNOME}}` + +- Preview the programs would be executed in a regular autostart: + +`dex --autostart --dry-run` + +- Preview the value of the DesktopEntry property `Name`: + +`dex --property {{Name}} {{path/to/file.desktop}}` + +- Create a DesktopEntry for a program in the current directory: + +`dex --create {{path/to/file.desktop}}` + +- Execute a single program (with `Terminal=true` in the desktop file) in the given terminal: + +`dex --term {{terminal}} {{path/to/file.desktop}}` diff --git a/linux/df b/linux/df new file mode 100644 index 00000000..a70dbf23 --- /dev/null +++ b/linux/df @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage: + +`df` + +- Display all filesystems and their disk usage in human-readable form: + +`df -h` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Include statistics on the number of free inodes: + +`df -i` + +- Display filesystems but exclude the specified types: + +`df -x {{squashfs}} -x {{tmpfs}}` diff --git a/linux/dget b/linux/dget new file mode 100644 index 00000000..50e44b0f --- /dev/null +++ b/linux/dget @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dget + +> Download Debian packages. +> More information: . + +- Download a binary package: + +`dget {{package}}` + +- Download and extract a package source from its `.dsc` file: + +`dget {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` + +- Download a package source tarball from its `.dsc` file but don't extract it: + +`dget -d {{http://deb.debian.org/debian/pool/main/h/haskell-tldr/haskell-tldr_0.4.0-2.dsc}}` diff --git a/linux/diff3 b/linux/diff3 new file mode 100644 index 00000000..c799d425 --- /dev/null +++ b/linux/diff3 @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# diff3 + +> Compare three files line by line. +> More information: . + +- Compare files: + +`diff3 {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` + +- Show all changes, outlining conflicts: + +`diff3 --show-all {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` diff --git a/linux/dir b/linux/dir new file mode 100644 index 00000000..f328a5c4 --- /dev/null +++ b/linux/dir @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dir + +> List directory contents using one line per file, special characters are represented by backslash escape sequences. +> Works as `ls -C --escape`. +> More information: . + +- List all files, including hidden files: + +`dir -all` + +- List files including their author (`-l` is required): + +`dir -l --author` + +- List files excluding those that match a specified blob pattern: + +`dir --hide={{pattern}}` + +- List subdirectories recursively: + +`dir --recursive` + +- Display help: + +`dir --help` diff --git a/linux/dirb b/linux/dirb new file mode 100644 index 00000000..f00053f5 --- /dev/null +++ b/linux/dirb @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dirb + +> Scan HTTP-based webservers for directories and files. +> More information: . + +- Scan a webserver using the default wordlist: + +`dirb {{https://example.org}}` + +- Scan a webserver using a custom wordlist: + +`dirb {{https://example.org}} {{path/to/wordlist.txt}}` + +- Scan a webserver non-recursively: + +`dirb {{https://example.org}} -r` + +- Scan a webserver using a specified user-agent and cookie for HTTP-requests: + +`dirb {{https://example.org}} -a {{user_agent_string}} -c {{cookie_string}}` diff --git a/linux/dirbuster b/linux/dirbuster new file mode 100644 index 00000000..5203d4d7 --- /dev/null +++ b/linux/dirbuster @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dirbuster + +> Brute force directories and filenames on servers. +> More information: . + +- Start in GUI mode: + +`dirbuster -u {{http://example.com}}` + +- Start in headless (no GUI) mode: + +`dirbuster -H -u {{http://example.com}}` + +- Set the file extension list: + +`dirbuster -e {{txt,html}}` + +- Enable verbose output: + +`dirbuster -v` + +- Set the report location: + +`dirbuster -r {{path/to/report.txt}}` diff --git a/linux/disown b/linux/disown new file mode 100644 index 00000000..5dd8a5c5 --- /dev/null +++ b/linux/disown @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# disown + +> Allow sub-processes to live beyond the shell that they are attached to. +> See also the `jobs` command. +> More information: . + +- Disown the current job: + +`disown` + +- Disown a specific job: + +`disown %{{job_number}}` + +- Disown all jobs: + +`disown -a` + +- Keep job (do not disown it), but mark it so that no future SIGHUP is received on shell exit: + +`disown -h %{{job_number}}` diff --git a/linux/distrobox b/linux/distrobox new file mode 100644 index 00000000..a562190a --- /dev/null +++ b/linux/distrobox @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox + +> Use any Linux distribution inside your terminal in a container. Install & use packages inside it while tightly integrating with the host OS, sharing storage (`home` directory) and hardware. +> Note: It uses Podman or Docker to create your containers. +> More information: . + +- View documentation for creating containers: + +`tldr distrobox-create` + +- View documentation for listing container's information: + +`tldr distrobox-list` + +- View documentation for entering the container: + +`tldr distrobox-enter` + +- View documentation for executing a command on the host from inside a container: + +`tldr distrobox-host-exec` + +- View documentation for exporting app/service/binary from the container to the host: + +`tldr distrobox-export` + +- View documentation for upgrading containers: + +`tldr distrobox-upgrade` + +- View documentation for stopping the containers: + +`tldr distrobox-stop` + +- View documentation for removing the containers: + +`tldr distrobox-rm` diff --git a/linux/distrobox-create b/linux/distrobox-create new file mode 100644 index 00000000..d8c42793 --- /dev/null +++ b/linux/distrobox-create @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-create + +> Create a Distrobox container. See also: `tldr distrobox`. +> The container created will be tightly integrated with the host, allowing sharing of the user's HOME directory, external storage, external USB devices, graphical apps (X11/Wayland), and audio. +> More information: . + +- Create a Distrobox container using the Ubuntu image: + +`distrobox-create {{container_name}} --image {{ubuntu:latest}}` + +- Clone a Distrobox container: + +`distrobox-create --clone {{container_name}} {{cloned_container_name}}` diff --git a/linux/distrobox-enter b/linux/distrobox-enter new file mode 100644 index 00000000..35548dc6 --- /dev/null +++ b/linux/distrobox-enter @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-enter + +> Enter a Distrobox container. See also: `tldr distrobox`. +> Default command executed is your SHELL, but you can specify different shells or entire commands to execute. If used inside a script, an application, or a service, you can use the `--headless` mode to disable the tty and interactivity. +> More information: . + +- Enter a Distrobox container: + +`distrobox-enter {{container_name}}` + +- Enter a Distrobox container and run a command at login: + +`distrobox-enter {{container_name}} -- {{sh -l}}` + +- Enter a Distrobox container without instantiating a tty: + +`distrobox-enter --name {{container_name}} -- {{uptime -p}}` diff --git a/linux/distrobox-export b/linux/distrobox-export new file mode 100644 index 00000000..f901f50d --- /dev/null +++ b/linux/distrobox-export @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-export + +> Export app/service/binary from container to host OS. See also: `tldr distrobox`. +> More information: . + +- Export an app from the container to the host (the desktop entry/icon will show up in your host system's application list): + +`distrobox-export --app {{package}} --extra-flags "--foreground"` + +- Export a binary from the container to the host: + +`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/binary_on_host}}` + +- Export a binary from the container to the host (i.e.`$HOME/.local/bin`) : + +`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/export}}` + +- Export a service from the container to the host (`--sudo` will run the service as root inside the container): + +`distrobox-export --service {{package}} --extra-flags "--allow-newer-config" --sudo` + +- Unexport/delete an exported application: + +`distrobox-export --app {{package}} --delete` diff --git a/linux/distrobox-host-exec b/linux/distrobox-host-exec new file mode 100644 index 00000000..75cfb7e6 --- /dev/null +++ b/linux/distrobox-host-exec @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-host-exec + +> Execute a command on the host from inside a Distrobox container. See also: `tldr distrobox`. +> More information: . + +- Execute command on the host system from inside the Distrobox container: + +`distrobox-host-exec "{{command}}"` + +- Execute the `ls` command on the host system from inside the container: + +`distrobox-host-exec ls` diff --git a/linux/distrobox-list b/linux/distrobox-list new file mode 100644 index 00000000..15d066cd --- /dev/null +++ b/linux/distrobox-list @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-list + +> List all Distrobox containers. See also: `tldr distrobox`. +> Distrobox containers are listed separately from the rest of normal podman or Docker containers. +> More information: . + +- List all Distrobox containers: + +`distrobox-list` + +- List all Distrobox containers with verbose information: + +`distrobox-list --verbose` diff --git a/linux/distrobox-rm b/linux/distrobox-rm new file mode 100644 index 00000000..d144e50f --- /dev/null +++ b/linux/distrobox-rm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-rm + +> Remove a Distrobox container. See also: `tldr distrobox`. +> More information: . + +- Remove a Distrobox container (Tip: Stop the container before removing it): + +`distrobox-rm {{container_name}}` + +- Remove a Distrobox container forcefully: + +`distrobox-rm {{container_name}} --force` diff --git a/linux/distrobox-stop b/linux/distrobox-stop new file mode 100644 index 00000000..3b30b4ba --- /dev/null +++ b/linux/distrobox-stop @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-stop + +> Stop a Distrobox container. See also: `tldr distrobox`. +> More information: . + +- Stop a Distrobox container: + +`distrobox-stop {{container_name}}` + +- Stop a Distrobox container non-interactively (without confirmation): + +`distrobox-stop --name {{container_name}} --yes` diff --git a/linux/distrobox-upgrade b/linux/distrobox-upgrade new file mode 100644 index 00000000..5a5f6482 --- /dev/null +++ b/linux/distrobox-upgrade @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# distrobox-upgrade + +> Upgrade one or multiple Distrobox containers. See also: `tldr distrobox`. +> More information: . + +- Upgrade a container using the container's native package manager: + +`distrobox-upgrade {{container_name}}` + +- Upgrade all containers using the container's native package managers: + +`distrobox-upgrade --all` + +- Upgrade specific containers via the container's native package manager: + +`distrobox-upgrade {{container1 container2 ...}}` diff --git a/linux/dkms b/linux/dkms new file mode 100644 index 00000000..75fd4788 --- /dev/null +++ b/linux/dkms @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dkms + +> A framework that allows for dynamic building of kernel modules. +> More information: . + +- List currently installed modules: + +`dkms status` + +- Rebuild all modules for the currently running kernel: + +`dkms autoinstall` + +- Install version 1.2.1 of the acpi_call module for the currently running kernel: + +`dkms install -m {{acpi_call}} -v {{1.2.1}}` + +- Remove version 1.2.1 of the acpi_call module from all kernels: + +`dkms remove -m {{acpi_call}} -v {{1.2.1}} --all` diff --git a/linux/dm-tool b/linux/dm-tool new file mode 100644 index 00000000..5a622d47 --- /dev/null +++ b/linux/dm-tool @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dm-tool + +> A tool to communicate with the display manager. +> More information: . + +- Show the greeter while keeping current desktop session open and waiting to be restored upon authentication by logged in user: + +`dm-tool switch-to-greeter` + +- Lock the current session: + +`dm-tool lock` + +- Switch to a specific user, showing an authentication prompt if required: + +`dm-tool switch-to-user {{username}} {{session}}` + +- Add a dynamic seat from within a running LightDM session: + +`dm-tool add-seat {{xlocal}} {{name}}={{value}}` diff --git a/linux/dmenu b/linux/dmenu new file mode 100644 index 00000000..5c00e7e1 --- /dev/null +++ b/linux/dmenu @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dmenu + +> Dynamic menu. +> Creates a menu from a text input with each item on a new line. +> More information: . + +- Display a menu of the output of the `ls` command: + +`{{ls}} | dmenu` + +- Display a menu with custom items separated by a new line (` +`): + +`echo -e "{{red}} +{{green}} +{{blue}}" | dmenu` + +- Let the user choose between multiple items and save the selected one to a file: + +`echo -e "{{red}} +{{green}} +{{blue}}" | dmenu > {{color.txt}}` + +- Launch dmenu on a specific monitor: + +`ls | dmenu -m {{1}}` + +- Display dmenu at the bottom of the screen: + +`ls | dmenu -b` diff --git a/linux/dmesg b/linux/dmesg new file mode 100644 index 00000000..dd08db80 --- /dev/null +++ b/linux/dmesg @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dmesg + +> Write the kernel messages to `stdout`. +> More information: . + +- Show kernel messages: + +`dmesg` + +- Show kernel error messages: + +`dmesg --level err` + +- Show kernel messages and keep reading new ones, similar to `tail -f` (available in kernels 3.5.0 and newer): + +`dmesg -w` + +- Show how much physical memory is available on this system: + +`dmesg | grep -i memory` + +- Show kernel messages 1 page at a time: + +`dmesg | less` + +- Show kernel messages with a timestamp (available in kernels 3.5.0 and newer): + +`dmesg -T` + +- Show kernel messages in human-readable form (available in kernels 3.5.0 and newer): + +`dmesg -H` + +- Colorize output (available in kernels 3.5.0 and newer): + +`dmesg -L` diff --git a/linux/dmidecode b/linux/dmidecode new file mode 100644 index 00000000..566c6256 --- /dev/null +++ b/linux/dmidecode @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dmidecode + +> Display the DMI (alternatively known as SMBIOS) table contents in a human-readable format. +> Requires root privileges. +> More information: . + +- Show all DMI table contents: + +`sudo dmidecode` + +- Show the BIOS version: + +`sudo dmidecode -s bios-version` + +- Show the system's serial number: + +`sudo dmidecode -s system-serial-number` + +- Show BIOS information: + +`sudo dmidecode -t bios` + +- Show CPU information: + +`sudo dmidecode -t processor` + +- Show memory information: + +`sudo dmidecode -t memory` diff --git a/linux/dnf b/linux/dnf new file mode 100644 index 00000000..3ceaf5f6 --- /dev/null +++ b/linux/dnf @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnf + +> Package management utility for RHEL, Fedora, and CentOS (replaces yum). +> For equivalent commands in other package managers, see . +> More information: . + +- Upgrade installed packages to the newest available versions: + +`sudo dnf upgrade` + +- Search packages via keywords: + +`dnf search {{keyword1 keyword2 ...}}` + +- Display details about a package: + +`dnf info {{package}}` + +- Install a new package (use `-y` to confirm all prompts automatically): + +`sudo dnf install {{package1 package2 ...}}` + +- Remove a package: + +`sudo dnf remove {{package1 package2 ...}}` + +- List installed packages: + +`dnf list --installed` + +- Find which packages provide a given command: + +`dnf provides {{command}}` + +- View all past operations: + +`dnf history` diff --git a/linux/dnsdomainname b/linux/dnsdomainname new file mode 100644 index 00000000..8b1dc198 --- /dev/null +++ b/linux/dnsdomainname @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnsdomainname + +> 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: . + +- Show the system's DNS domain name: + +`dnsdomainname` diff --git a/linux/dnsmap b/linux/dnsmap new file mode 100644 index 00000000..8001ead0 --- /dev/null +++ b/linux/dnsmap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnsmap + +> The dnsmap command scans a domain for common subdomains e.g. smtp.domain.org. +> More information: . + +- Scan for subdomains using the internal wordlist: + +`dnsmap {{example.com}}` + +- Specify a list of subdomains to check for: + +`dnsmap {{example.com}} -w {{path/to/wordlist.txt}}` + +- Store results to a CSV file: + +`dnsmap {{example.com}} -c {{path/to/file.csv}}` + +- Ignore 2 IPs that are false positives (up to 5 possible): + +`dnsmap {{example.com}} -i {{123.45.67.89,98.76.54.32}}` diff --git a/linux/dnsrecon b/linux/dnsrecon new file mode 100644 index 00000000..b62a51e3 --- /dev/null +++ b/linux/dnsrecon @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnsrecon + +> DNS enumeration tool. +> More information: . + +- Scan a domain and save the results to a SQLite database: + +`dnsrecon --domain {{example.com}} --db {{path/to/database.sqlite}}` + +- Scan a domain, specifying the nameserver and performing a zone transfer: + +`dnsrecon --domain {{example.com}} --name_server {{nameserver.example.com}} --type axfr` + +- Scan a domain, using a brute-force attack and a dictionary of subdomains and hostnames: + +`dnsrecon --domain {{example.com}} --dictionary {{path/to/dictionary.txt}} --type brt` + +- Scan a domain, performing a reverse lookup of IP ranges from the SPF record and saving the results to a JSON file: + +`dnsrecon --domain {{example.com}} -s --json` + +- Scan a domain, performing a Google enumeration and saving the results to a CSV file: + +`dnsrecon --domain {{example.com}} -g --csv` + +- Scan a domain, performing DNS cache snooping: + +`dnsrecon --domain {{example.com}} --type snoop --name_server {{nameserver.example.com}} --dictionary {{path/to/dictionary.txt}}` + +- Scan a domain, performing zone walking: + +`dnsrecon --domain {{example.com}} --type zonewalk` diff --git a/linux/dnstracer b/linux/dnstracer new file mode 100644 index 00000000..f350fe46 --- /dev/null +++ b/linux/dnstracer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnstracer + +> The dnstracer command determines where a DNS gets its information from. +> More information: . + +- Find out where your local DNS got the information on www.example.com: + +`dnstracer {{www.example.com}}` + +- Start with a [s]pecific DNS that you already know: + +`dnstracer -s {{dns.example.org}} {{www.example.com}}` + +- Only query IPv4 servers: + +`dnstracer -4 {{www.example.com}}` + +- Retry each request 5 times on failure: + +`dnstracer -r {{5}} {{www.example.com}}` + +- Display all steps during execution: + +`dnstracer -v {{www.example.com}}` + +- Display an [o]verview of all received answers after execution: + +`dnstracer -o {{www.example.com}}` diff --git a/linux/do-release-upgrade b/linux/do-release-upgrade new file mode 100644 index 00000000..45ba1226 --- /dev/null +++ b/linux/do-release-upgrade @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# do-release-upgrade + +> The Ubuntu release upgrader. +> More information: . + +- Upgrade to the latest release: + +`sudo do-release-upgrade` + +- Upgrade to the latest development release: + +`sudo do-release-upgrade --devel-release` + +- Upgrade to the latest proposed release: + +`sudo do-release-upgrade --proposed` diff --git a/linux/dockerd b/linux/dockerd new file mode 100644 index 00000000..9e711227 --- /dev/null +++ b/linux/dockerd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dockerd + +> A persistent process to start and manage docker containers. +> More information: . + +- Run docker daemon: + +`dockerd` + +- Run docker daemon and configure it to listen to specific sockets (UNIX and TCP): + +`dockerd --host unix://{{path/to/tmp.sock}} --host tcp://{{ip}}` + +- Run with specific daemon PID file: + +`dockerd --pidfile {{path/to/pid_file}}` + +- Run in debug mode: + +`dockerd --debug` + +- Run and set a specific log level: + +`dockerd --log-level={{debug|info|warn|error|fatal}}` diff --git a/linux/dolphin b/linux/dolphin new file mode 100644 index 00000000..324ec349 --- /dev/null +++ b/linux/dolphin @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dolphin + +> KDE's file manager to manage files and directories. +> More information: . + +- Launch the file manager: + +`dolphin` + +- Open specific directories: + +`dolphin {{path/to/directory1 path/to/directory2 ...}}` + +- Open with specific files or directories selected: + +`dolphin --select {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Open a new window: + +`dolphin --new-window` + +- Open specific directories in split view: + +`dolphin --split {{path/to/directory1}} {{path/to/directory2}}` + +- Launch the daemon (only required to use the DBus interface): + +`dolphin --daemon` + +- Display help: + +`dolphin --help` diff --git a/linux/dos2unix b/linux/dos2unix new file mode 100644 index 00000000..22abc473 --- /dev/null +++ b/linux/dos2unix @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dos2unix + +> Change DOS-style line endings to Unix-style. +> Replaces CRLF with LF. +> More information: . + +- Change the line endings of a file: + +`dos2unix {{filename}}` + +- Create a copy with Unix-style line endings: + +`dos2unix -n {{filename}} {{new_filename}}` diff --git a/linux/dphys-swapfile b/linux/dphys-swapfile new file mode 100644 index 00000000..22220738 --- /dev/null +++ b/linux/dphys-swapfile @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dphys-swapfile + +> Manage the swap file on Debian-based Linux systems. +> More information: . + +- Disable the swap file: + +`dphys-swapfile swapoff` + +- Enable the swap file: + +`dphys-swapfile swapon` + +- Create a new swap file: + +`dphys-swapfile setup` diff --git a/linux/dpkg b/linux/dpkg new file mode 100644 index 00000000..52d17d6e --- /dev/null +++ b/linux/dpkg @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dpkg + +> Debian package manager. +> Some subcommands such as `dpkg deb` have their own usage documentation. +> For equivalent commands in other package managers, see . +> More information: . + +- Install a package: + +`dpkg -i {{path/to/file.deb}}` + +- Remove a package: + +`dpkg -r {{package}}` + +- List installed packages: + +`dpkg -l {{pattern}}` + +- List a package's contents: + +`dpkg -L {{package}}` + +- List contents of a local package file: + +`dpkg -c {{path/to/file.deb}}` + +- Find out which package owns a file: + +`dpkg -S {{path/to/file}}` diff --git a/linux/dpkg-deb b/linux/dpkg-deb new file mode 100644 index 00000000..8cd07f6b --- /dev/null +++ b/linux/dpkg-deb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dpkg-deb + +> Pack, unpack and provide information about Debian archives. +> More information: . + +- Display information about a package: + +`dpkg-deb --info {{path/to/file.deb}}` + +- Display the package's name and version on one line: + +`dpkg-deb --show {{path/to/file.deb}}` + +- List the package's contents: + +`dpkg-deb --contents {{path/to/file.deb}}` + +- Extract package's contents into a directory: + +`dpkg-deb --extract {{path/to/file.deb}} {{path/to/directory}}` + +- Create a package from a specified directory: + +`dpkg-deb --build {{path/to/directory}}` diff --git a/linux/dpkg-query b/linux/dpkg-query new file mode 100644 index 00000000..86587629 --- /dev/null +++ b/linux/dpkg-query @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dpkg-query + +> A tool that shows information about installed packages. +> More information: . + +- List all installed packages: + +`dpkg-query --list` + +- List installed packages matching a pattern: + +`dpkg-query --list '{{libc6*}}'` + +- List all files installed by a package: + +`dpkg-query --listfiles {{libc6}}` + +- Show information about a package: + +`dpkg-query --status {{libc6}}` + +- Search for packages that own files matching a pattern: + +`dpkg-query --search {{/etc/ld.so.conf.d}}` diff --git a/linux/dpkg-reconfigure b/linux/dpkg-reconfigure new file mode 100644 index 00000000..3e980b33 --- /dev/null +++ b/linux/dpkg-reconfigure @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dpkg-reconfigure + +> Reconfigure an already installed package. +> More information: . + +- Reconfigure one or more packages: + +`dpkg-reconfigure {{package1 package2 ...}}` diff --git a/linux/dracut b/linux/dracut new file mode 100644 index 00000000..c4d4fb7b --- /dev/null +++ b/linux/dracut @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dracut + +> Generate initramfs images to boot the Linux kernel. +> Dracut uses options from configuration files in `/etc/dracut.conf`, `/etc/dracut.conf.d/*.conf` and `/usr/lib/dracut/dracut.conf.d/*.conf` by default. +> More information: . + +- Generate an initramfs image for the current kernel without overriding any options: + +`dracut` + +- Generate an initramfs image for the current kernel and overwrite the existing one: + +`dracut --force` + +- Generate an initramfs image for a specific kernel: + +`dracut --kver {{kernel_version}}` + +- List available modules: + +`dracut --list-modules` diff --git a/linux/drawing b/linux/drawing new file mode 100644 index 00000000..5e0fb0b6 --- /dev/null +++ b/linux/drawing @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# drawing + +> Free basic raster image editor in GNOME desktop environment. +> More information: . + +- Start Drawing: + +`drawing` + +- Open specific files: + +`drawing {{path/to/image1 path/to/image2 ...}}` + +- Open specific files in a new window: + +`drawing --new-window {{path/to/image1 path/to/image2 ...}}` diff --git a/linux/dropbearconvert b/linux/dropbearconvert new file mode 100644 index 00000000..e4e37609 --- /dev/null +++ b/linux/dropbearconvert @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dropbearconvert + +> Convert between Dropbear and OpenSSH private key formats. +> More information: . + +- Convert an OpenSSH private key to the Dropbear format: + +`dropbearconvert openssh dropbear {{path/to/input_key}} {{path/to/output_key}}` + +- Convert a Dropbear private key to the OpenSSH format: + +`dropbearconvert dropbear openssh {{path/to/input_key}} {{path/to/output_key}}` diff --git a/linux/dropbearkey b/linux/dropbearkey new file mode 100644 index 00000000..20b20264 --- /dev/null +++ b/linux/dropbearkey @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dropbearkey + +> Generate SSH keys in Dropbear format. +> More information: . + +- Generate an SSH key of [t]ype ed25519 and write it to key [f]ile: + +`dropbearkey -t {{ed25519}} -f {{path/to/key_file}}` + +- Generate an SSH key of [t]ype ecdsa and write it to key [f]ile: + +`dropbearkey -t {{ecdsa}} -f {{path/to/key_file}}` + +- Generate an SSH key of [t]ype RSA with 4096-bit key [s]ize and write it to key [f]ile: + +`dropbearkey -t {{rsa}} -s {{4096}} -f {{path/to/key_file}}` + +- Print the private key fingerprint and public key in key [f]ile: + +`dropbearkey -y -f {{path/to/key_file}}` diff --git a/linux/dstat b/linux/dstat new file mode 100644 index 00000000..40bb94b0 --- /dev/null +++ b/linux/dstat @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dstat + +> Versatile tool for generating system resource statistics. +> More information: . + +- Display CPU, disk, net, paging and system statistics: + +`dstat` + +- Display statistics every 5 seconds and 4 updates only: + +`dstat {{5}} {{4}}` + +- Display CPU and memory statistics only: + +`dstat --cpu --mem` + +- List all available dstat plugins: + +`dstat --list` + +- Display the process using the most memory and most CPU: + +`dstat --top-mem --top-cpu` + +- Display battery percentage and remaining battery time: + +`dstat --battery --battery-remain` diff --git a/linux/duc b/linux/duc new file mode 100644 index 00000000..073e0038 --- /dev/null +++ b/linux/duc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# duc + +> A collection of tools for indexing, inspecting and visualizing disk usage. +> Duc maintains a database of accumulated sizes of directories in the file system, allowing to query this database, or creating fancy graphs to show where data is. +> More information: . + +- Index the `/usr` directory, writing to the default database location `~/.duc.db`: + +`duc index {{/usr}}` + +- List all files and directories under `/usr/local`, showing relative file sizes in a [g]raph: + +`duc ls --classify --graph {{/usr/local}}` + +- List all files and directories under `/usr/local` using treeview recursively: + +`duc ls --classify --graph --recursive {{/usr/local}}` + +- Start the graphical interface to explore the file system using sunburst graphs: + +`duc gui {{/usr}}` + +- Run the ncurses console interface to explore the file system: + +`duc ui {{/usr}}` + +- Dump database info: + +`duc info` diff --git a/linux/dumpe2fs b/linux/dumpe2fs new file mode 100644 index 00000000..2ebe0885 --- /dev/null +++ b/linux/dumpe2fs @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dumpe2fs + +> Print the super block and blocks group information for ext2/ext3/ext4 filesystems. +> Unmount the partition before running this command using `umount {{device}}`. +> More information: . + +- Display ext2, ext3 and ext4 filesystem information: + +`dumpe2fs {{/dev/sdXN}}` + +- Display the blocks which are reserved as bad in the filesystem: + +`dumpe2fs -b {{/dev/sdXN}}` + +- Force display filesystem information even with unrecognizable feature flags: + +`dumpe2fs -f {{/dev/sdXN}}` + +- Only display the superblock information and not any of the block group descriptor detail information: + +`dumpe2fs -h {{/dev/sdXN}}` + +- Print the detailed group information block numbers in hexadecimal format: + +`dumpe2fs -x {{/dev/sdXN}}` diff --git a/linux/dunstctl b/linux/dunstctl new file mode 100644 index 00000000..85f994fb --- /dev/null +++ b/linux/dunstctl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dunstctl + +> Control command for `dunst`. +> More information: . + +- Pause notifications: + +`dunstctl set-paused true` + +- Un-pause notifications: + +`dunstctl set-paused false` + +- Close all notifications: + +`dunstctl close-all` + +- Display help: + +`dunstctl --help` diff --git a/linux/dunstify b/linux/dunstify new file mode 100644 index 00000000..85cf3f21 --- /dev/null +++ b/linux/dunstify @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dunstify + +> A notification tool that is an extension of `notify-send`, but has more features based around `dunst`. +> Accepts all options of `notify-send`. +> More information: . + +- Show a notification with a given title and message: + +`dunstify "{{Title}}" "{{Message}}"` + +- Show a notification with specified urgency: + +`dunstify "{{Title}}" "{{Message}}" -u {{low|normal|critical}}` + +- Specify a message ID (overwrites any previous messages with the same ID): + +`dunstify "{{Title}}" "{{Message}}" -r {{123}}` + +- Display help: + +`notify-send --help` diff --git a/linux/duperemove b/linux/duperemove new file mode 100644 index 00000000..5a2da567 --- /dev/null +++ b/linux/duperemove @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# duperemove + +> Finds duplicate filesystem extents and optionally schedule them for deduplication. +> An extent is small part of a file inside the filesystem. +> On some filesystems one extent can be referenced multiple times, when parts of the content of the files are identical. +> More information: . + +- Search for duplicate extents in a directory and show them: + +`duperemove -r {{path/to/directory}}` + +- Deduplicate duplicate extents on a Btrfs or XFS (experimental) filesystem: + +`duperemove -r -d {{path/to/directory}}` + +- Use a hash file to store extent hashes (less memory usage and can be reused on subsequent runs): + +`duperemove -r -d --hashfile={{path/to/hashfile}} {{path/to/directory}}` + +- Limit I/O threads (for hashing and dedupe stage) and CPU threads (for duplicate extent finding stage): + +`duperemove -r -d --hashfile={{path/to/hashfile}} --io-threads={{N}} --cpu-threads={{N}} {{path/to/directory}}` diff --git a/linux/e2freefrag b/linux/e2freefrag new file mode 100644 index 00000000..fdff3bdc --- /dev/null +++ b/linux/e2freefrag @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e2freefrag + +> Print the free space fragmentation information for ext2/ext3/ext4 filesystems. +> More information: . + +- Check how many free blocks are present as contiguous and aligned free space: + +`e2freefrag {{/dev/sdXN}}` + +- Specify chunk size in kilobytes to print how many free chunks are available: + +`e2freefrag -c {{chunk_size_in_kb}} {{/dev/sdXN}}` diff --git a/linux/e2fsck b/linux/e2fsck new file mode 100644 index 00000000..6e236308 --- /dev/null +++ b/linux/e2fsck @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e2fsck + +> Check a Linux ext2/ext3/ext4 filesystem. The partition should be unmounted. +> More information: . + +- Check filesystem, reporting any damaged blocks: + +`sudo e2fsck {{/dev/sdXN}}` + +- Check filesystem and automatically repair any damaged blocks: + +`sudo e2fsck -p {{/dev/sdXN}}` + +- Check filesystem in read only mode: + +`sudo e2fsck -c {{/dev/sdXN}}` + +- Perform an exhaustive, non-destructive read-write test for bad blocks and blacklist them: + +`sudo e2fsck -fccky {{/dev/sdXN}}` diff --git a/linux/e2image b/linux/e2image new file mode 100644 index 00000000..9c0b99b6 --- /dev/null +++ b/linux/e2image @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e2image + +> Save critical ext2/ext3/ext4 filesystem metadata to a file. +> More information: . + +- Write metadata located on device to a specific file: + +`e2image {{/dev/sdXN}} {{path/to/image_file}}` + +- Print metadata located on device to `stdout`: + +`e2image {{/dev/sdXN}} -` + +- Restore the filesystem metadata back to the device: + +`e2image -I {{/dev/sdXN}} {{path/to/image_file}}` + +- Create a large raw sparse file with metadata at proper offsets: + +`e2image -r {{/dev/sdXN}} {{path/to/image_file}}` + +- Create a QCOW2 image file instead of a normal or raw image file: + +`e2image -Q {{/dev/sdXN}} {{path/to/image_file}}` diff --git a/linux/e2label b/linux/e2label new file mode 100644 index 00000000..c80b087d --- /dev/null +++ b/linux/e2label @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e2label + +> Change the label on an ext2/ext3/ext4 filesystem. +> More information: . + +- Change the volume label on a specific ext partition: + +`e2label {{/dev/sda1}} "{{label_name}}"` diff --git a/linux/e2undo b/linux/e2undo new file mode 100644 index 00000000..d4f15989 --- /dev/null +++ b/linux/e2undo @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e2undo + +> Replay undo logs for an ext2/ext3/ext4 filesystem. +> This can be used to undo a failed operation by an e2fsprogs program. +> More information: . + +- Display information about a specific undo file: + +`e2undo -h {{path/to/undo_file}} {{/dev/sdXN}}` + +- Perform a dry-run and display the candidate blocks for replaying: + +`e2undo -nv {{path/to/undo_file}} {{/dev/sdXN}}` + +- Perform an undo operation: + +`e2undo {{path/to/undo_file}} {{/dev/sdXN}}` + +- Perform an undo operation and display verbose information: + +`e2undo -v {{path/to/undo_file}} {{/dev/sdXN}}` + +- Write the old contents of the block to an undo file before overwriting a file system block: + +`e2undo -z {{path/to/file.e2undo}} {{path/to/undo_file}} {{/dev/sdXN}}` diff --git a/linux/e4defrag b/linux/e4defrag new file mode 100644 index 00000000..56f975aa --- /dev/null +++ b/linux/e4defrag @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# e4defrag + +> Defragment an ext4 filesystem. +> More information: . + +- Defragment the filesystem: + +`e4defrag {{/dev/sdXN}}` + +- See how fragmented a filesystem is: + +`e4defrag -c {{/dev/sdXN}}` + +- Print errors and the fragmentation count before and after each file: + +`e4defrag -v {{/dev/sdXN}}` diff --git a/linux/ebuild b/linux/ebuild new file mode 100644 index 00000000..0a0327ec --- /dev/null +++ b/linux/ebuild @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ebuild + +> A low level interface to the Gentoo Portage system. +> More information: . + +- Create or update the package manifest: + +`ebuild {{path/to/file.ebuild}} manifest` + +- Clean the temporary build directories for the build file: + +`ebuild {{path/to/file.ebuild}} clean` + +- Fetch sources if they do not exist: + +`ebuild {{path/to/file.ebuild}} fetch` + +- Extract the sources to a temporary build directory: + +`ebuild {{path/to/file.ebuild}} unpack` + +- Compile the extracted sources: + +`ebuild {{path/to/file.ebuild}} compile` + +- Install the package to a temporary install directory: + +`ebuild {{path/to/file.ebuild}} install` + +- Install the temporary files to the live filesystem: + +`ebuild {{path/to/file.ebuild}} qmerge` + +- Fetch, unpack, compile, install and qmerge the specified ebuild file: + +`ebuild {{path/to/file.ebuild}} merge` diff --git a/linux/edit b/linux/edit new file mode 100644 index 00000000..64563cdd --- /dev/null +++ b/linux/edit @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# edit + +> An alias to a `run-mailcap`'s action edit. +> Originally `run-mailcap` is used to process/edit mime-type/file. +> More information: . + +- Edit action can be used to view any file on default mailcap explorer: + +`edit {{filename}}` + +- With `run-mailcap`: + +`run-mailcap --action=edit {{filename}}` diff --git a/linux/edquota b/linux/edquota new file mode 100644 index 00000000..8df490af --- /dev/null +++ b/linux/edquota @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# edquota + +> Edit quotas for a user or group. By default it operates on all filesystems with quotas. +> Quota information is stored permanently in the `quota.user` and `quota.group` files in the root of the filesystem. +> More information: . + +- Edit quota of the current user: + +`edquota --user $(whoami)` + +- Edit quota of a specific user: + +`sudo edquota --user {{username}}` + +- Edit quota for a group: + +`sudo edquota --group {{group}}` + +- Restrict operations to a given filesystem (by default edquota operates on all filesystems with quotas): + +`sudo edquota --file-system {{filesystem}}` + +- Edit the default grace period: + +`sudo edquota -t` + +- Duplicate a quota to other users: + +`sudo edquota -p {{reference_user}} {{destination_user1}} {{destination_user2}}` diff --git a/linux/efibootmgr b/linux/efibootmgr new file mode 100644 index 00000000..9691fdd2 --- /dev/null +++ b/linux/efibootmgr @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# efibootmgr + +> Manipulate the UEFI Boot Manager. +> More information: . + +- List the current settings then bootnums with their name: + +`efibootmgr` + +- List the filepaths: + +`efibootmgr -v` + +- Add UEFI Shell v2 as a boot option: + +`sudo efibootmgr -c -d {{/dev/sda1}} -l {{FI ools\Shell.efi}} -L "{{UEFI Shell}}"` + +- Change the current boot order: + +`sudo efibootmgr -o {{0002,0008,0001,0005}}` + +- Delete a boot option: + +`sudo efibootmgr -b {{0008}} --delete-bootnum` diff --git a/linux/ego b/linux/ego new file mode 100644 index 00000000..dcf8eb5b --- /dev/null +++ b/linux/ego @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ego + +> Funtoo's official system personality management tool. +> More information: . + +- Synchronize the Portage tree: + +`ego sync` + +- Update the bootloader configuration: + +`ego boot update` + +- Read a Funtoo wiki page by name: + +`ego doc {{wiki_page}}` + +- Print current profile: + +`ego profile show` + +- Enable/Disable mix-ins: + +`ego profile mix-in +{{gnome}} -{{kde-plasma-5}}` + +- Query Funtoo bugs, related to a specified package: + +`ego query bug {{package}}` diff --git a/linux/einfo b/linux/einfo new file mode 100644 index 00000000..bcf1a82d --- /dev/null +++ b/linux/einfo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# einfo + +> Provides the number of records indexed in each database field, the last update date of the database, and the available links from the database to other Entrez databases. +> More information: . + +- Print all database names: + +`einfo -dbs` + +- Print all information of the protein database in XML format: + +`einfo -db {{protein}}` + +- Print all fields of the nuccore database: + +`einfo -db {{nuccore}} -fields` + +- Print all links of the protein database: + +`einfo -db {{protein}} -links` diff --git a/linux/eix b/linux/eix new file mode 100644 index 00000000..52ae4f3b --- /dev/null +++ b/linux/eix @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eix + +> Utilities for searching local Gentoo packages. +> Update local package cache using `eix-update`. +> More information: . + +- Search for a package: + +`eix {{query}}` + +- Search for installed packages: + +`eix --installed {{query}}` + +- Search in package descriptions: + +`eix --description "{{description}}"` + +- Search by package license: + +`eix --license {{license}}` + +- Exclude results from search: + +`eix --not --license {{license}}` diff --git a/linux/eject b/linux/eject new file mode 100644 index 00000000..771e2abb --- /dev/null +++ b/linux/eject @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eject + +> Eject cds, floppy disks and tape drives. +> More information: . + +- Display the default device: + +`eject -d` + +- Eject the default device: + +`eject` + +- Eject a specific device (the default order is cd-rom, scsi, floppy and tape): + +`eject {{/dev/cdrom}}` + +- Toggle whether a device's tray is open or closed: + +`eject -T {{/dev/cdrom}}` + +- Eject a cd drive: + +`eject -r {{/dev/cdrom}}` + +- Eject a floppy drive: + +`eject -f {{/mnt/floppy}}` + +- Eject a tape drive: + +`eject -q {{/mnt/tape}}` diff --git a/linux/elink b/linux/elink new file mode 100644 index 00000000..66bbcf38 --- /dev/null +++ b/linux/elink @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# elink + +> Look up precomputed neighbors within a database, or find associated records in other databases. +> It is part of the `edirect` package. +> More information: . + +- Search pubmed then find related sequences: + +`esearch -db pubmed -query "{{selective serotonin reuptake inhibitor}}" | elink -target nuccore` + +- Search nucleotide then find related biosamples: + +`esearch -db nuccore -query "{{insulin [PROT] AND rodents [ORGN]}}" | elink -target biosample` diff --git a/linux/emerge b/linux/emerge new file mode 100644 index 00000000..5204f8d5 --- /dev/null +++ b/linux/emerge @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# emerge + +> Gentoo Linux package manager utility. +> For equivalent commands in other package managers, see . +> More information: . + +- Synchronize all packages: + +`emerge --sync` + +- Update all packages, including dependencies: + +`emerge -uDNav @world` + +- Resume a failed updated, skipping the failing package: + +`emerge --resume --skipfirst` + +- Install a new package, with confirmation: + +`emerge -av {{package}}` + +- Remove a package, with confirmation: + +`emerge -Cav {{package}}` + +- Remove orphaned packages (that were installed only as dependencies): + +`emerge -avc` + +- Search the package database for a keyword: + +`emerge -S {{keyword}}` diff --git a/linux/engrampa b/linux/engrampa new file mode 100644 index 00000000..87fbc84b --- /dev/null +++ b/linux/engrampa @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# engrampa + +> Package files into zip/tar file in MATE desktop environment. +> See also: `zip`, `tar`. +> More information: . + +- Start Engrampa: + +`engrampa` + +- Open specific archives: + +`engrampa {{path/to/archive1.tar path/to/archive2.tar ...}}` + +- Archive specific files and/or directories recursively: + +`engrampa --add-to={{path/to/compressed.tar}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Extract files and/or directories from archives to a specific path: + +`engrampa --extract-to={{path/to/directory}} {{path/to/archive1.tar path/to/archive2.tar ...}}` diff --git a/linux/enum4linux b/linux/enum4linux new file mode 100644 index 00000000..a81b13d5 --- /dev/null +++ b/linux/enum4linux @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# enum4linux + +> Enumerate Windows and Samba information from remote systems. +> More information: . + +- Try to enumerate using all methods: + +`enum4linux -a {{remote_host}}` + +- Enumerate using given login credentials: + +`enum4linux -u {{user_name}} -p {{password}} {{remote_host}}` + +- List usernames from a given host: + +`enum4linux -U {{remote_host}}` + +- List shares: + +`enum4linux -S {{remote_host}}` + +- Get OS information: + +`enum4linux -o {{remote_host}}` diff --git a/linux/envycontrol b/linux/envycontrol new file mode 100644 index 00000000..f6b9a250 --- /dev/null +++ b/linux/envycontrol @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# envycontrol + +> GPU switching utility for Nvidia Optimus laptops. +> More information: . + +- Switch between different GPU modes: + +`sudo envycontrol -s {{nvidia|integrated|hybrid}}` + +- Specify your display manager manually: + +`envycontrol --dm` + +- Check current GPU mode: + +`sudo envycontrol --query` + +- Reset settings: + +`sudo envycontrol --reset` + +- Display help: + +`envycontrol --help` + +- Display version: + +`envycontrol --version` diff --git a/linux/eopkg b/linux/eopkg new file mode 100644 index 00000000..6fa82da7 --- /dev/null +++ b/linux/eopkg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eopkg + +> Package manager for Solus. +> More information: . + +- Install a specific package: + +`sudo eopkg install {{package}}` + +- Update all packages: + +`sudo eopkg upgrade` + +- Search for packages: + +`sudo eopkg search {{search_term}}` diff --git a/linux/equery b/linux/equery new file mode 100644 index 00000000..3bde5dfc --- /dev/null +++ b/linux/equery @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# equery + +> View information about Portage packages. +> More information: . + +- List all installed packages: + +`equery list '*'` + +- Search for installed packages in the Portage tree and in overlays: + +`equery list -po {{package1 package2 ...}}` + +- List all packages that depend on a given package: + +`equery depends {{package}}` + +- List all packages that a given package depends on: + +`equery depgraph {{package}}` + +- List all files installed by a package: + +`equery files --tree {{package}}` diff --git a/linux/esa-snap b/linux/esa-snap new file mode 100644 index 00000000..2cf55f21 --- /dev/null +++ b/linux/esa-snap @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# esa snap + +> Sentinel Application Platform (SNAP) for processing satellite data from the European Space Agency (ESA). +> More information: . + +- Display all updates: + +`snap --nosplash --nogui --modules --list --refresh` + +- Display help: + +`snap --help` diff --git a/linux/esearch b/linux/esearch new file mode 100644 index 00000000..f1f4974f --- /dev/null +++ b/linux/esearch @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# esearch + +> Perform a new Entrez search using terms in indexed fields. +> It is part of the `edirect` package. +> More information: . + +- Search the pubmed database for selective serotonin reuptake inhibitor: + +`esearch -db pubmed -query "{{selective serotonin reuptake inhibitor}}"` + +- Search the protein database using a query and regexp: + +`esearch -db {{protein}} -query {{'Escherichia*'}}` + +- Search the nucleotide database for sequences whose metadata contain insulin and rodents: + +`esearch -db nuccore -query "{{insulin [PROT] AND rodents [ORGN]}}"` + +- Display [h]elp: + +`esearch -h` diff --git a/linux/etckeeper b/linux/etckeeper new file mode 100644 index 00000000..765e7f31 --- /dev/null +++ b/linux/etckeeper @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# etckeeper + +> Track system configuration files in Git. +> More information: . + +- Set up a Git repo and perform various setup tasks (run from `/etc`): + +`sudo etckeeper init` + +- Commit all changes in `/etc`: + +`sudo etckeeper commit {{message}}` + +- Run arbitrary Git commands: + +`sudo etckeeper vcs {{status}}` + +- Check if there are uncommitted changes (only returns an exit code): + +`sudo etckeeper unclean` + +- Destroy existing repo and stop tracking changes: + +`sudo etckeeper uninit` diff --git a/linux/ethtool b/linux/ethtool new file mode 100644 index 00000000..84fd0027 --- /dev/null +++ b/linux/ethtool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ethtool + +> Display and modify Network Interface Controller (NIC) parameters. +> More information: . + +- Display the current settings for an interface: + +`ethtool {{eth0}}` + +- Display the driver information for an interface: + +`ethtool --driver {{eth0}}` + +- Display all supported features for an interface: + +`ethtool --show-features {{eth0}}` + +- Display the network usage statistics for an interface: + +`ethtool --statistics {{eth0}}` + +- Blink one or more LEDs on an interface for 10 seconds: + +`ethtool --identify {{eth0}} {{10}}` + +- Set the link speed, duplex mode, and parameter auto-negotiation for a given interface: + +`ethtool -s {{eth0}} speed {{10|100|1000}} duplex {{half|full}} autoneg {{on|off}}` diff --git a/linux/exec b/linux/exec new file mode 100644 index 00000000..2f6923af --- /dev/null +++ b/linux/exec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# exec + +> Execute a command without creating a child process. +> More information: . + +- Execute a specific command: + +`exec {{command -with -flags}}` + +- Execute a command with a (mostly) empty environment: + +`exec -c {{command -with -flags}}` + +- Execute a command as a login shell: + +`exec -l {{command -with -flags}}` + +- Execute a command with a different name: + +`exec -a {{name}} {{command -with -flags}}` diff --git a/linux/exif b/linux/exif new file mode 100644 index 00000000..06853894 --- /dev/null +++ b/linux/exif @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# exif + +> Show and change EXIF information in JPEG files. +> More information: . + +- Show all recognized EXIF information in an image: + +`exif {{path/to/image.jpg}}` + +- Show a table listing known EXIF tags and whether each one exists in an image: + +`exif --list-tags --no-fixup {{image.jpg}}` + +- Extract the image thumbnail into the file `thumbnail.jpg`: + +`exif --extract-thumbnail --output={{thumbnail.jpg}} {{image.jpg}}` + +- Show the raw contents of the "Model" tag in the given image: + +`exif --ifd={{0}} --tag={{Model}} --machine-readable {{image.jpg}}` + +- Change the value of the "Artist" tag to John Smith and save to `new.jpg`: + +`exif --output={{new.jpg}} --ifd={{0}} --tag="{{Artist}}" --set-value="{{John Smith}}" --no-fixup {{image.jpg}}` diff --git a/linux/exiqgrep b/linux/exiqgrep new file mode 100644 index 00000000..f2ad95e1 --- /dev/null +++ b/linux/exiqgrep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# exiqgrep + +> Perl script offering possibilities to `grep` in the Exim queue output. +> More information: . + +- Match the sender address using a case-insensitive search: + +`exiqgrep -f '<{{email@somedomain.com}}>'` + +- Match the sender address and display message IDs only: + +`exiqgrep -i -f '<{{email@somedomain.com}}>'` + +- Match the recipient address: + +`exiqgrep -r '{{email@somedomain.com}}'` + +- Remove all messages matching the sender address from the queue: + +`exiqgrep -i -f '<{{email@somedomain.com}}>' | xargs exim -Mrm` + +- Test for bounced messages: + +`exiqgrep -f '^<>$'` + +- Display the count of bounced messages: + +`exiqgrep -c -f '^<>$'` diff --git a/linux/expect b/linux/expect new file mode 100644 index 00000000..d92179c4 --- /dev/null +++ b/linux/expect @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# expect + +> Script executor that interacts with other programs that require user input. +> More information: . + +- Execute an expect script from a file: + +`expect {{path/to/file}}` + +- Execute a specified expect script: + +`expect -c "{{commands}}"` + +- Enter an interactive REPL (use `exit` or Ctrl + D to exit): + +`expect -i` diff --git a/linux/export b/linux/export new file mode 100644 index 00000000..9f0e4c16 --- /dev/null +++ b/linux/export @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# export + +> Export shell variables to child processes. +> More information: . + +- Set an environment variable: + +`export {{VARIABLE}}={{value}}` + +- Unset an environment variable: + +`export -n {{VARIABLE}}` + +- Export a function to child processes: + +`export -f {{FUNCTION_NAME}}` + +- Append a pathname to the environment variable `PATH`: + +`export PATH=$PATH:{{path/to/append}}` diff --git a/linux/extrace b/linux/extrace new file mode 100644 index 00000000..c4a915d3 --- /dev/null +++ b/linux/extrace @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# extrace + +> Trace exec() calls. +> More information: . + +- Trace all program executions occurring on the system: + +`sudo extrace` + +- Run a command and only trace descendants of this command: + +`sudo extrace {{command}}` + +- Print the current working directory of each process: + +`sudo extrace -d` + +- Resolve the full path of each executable: + +`sudo extrace -l` + +- Display the user running each process: + +`sudo extrace -u` diff --git a/linux/extrepo b/linux/extrepo new file mode 100644 index 00000000..308542f5 --- /dev/null +++ b/linux/extrepo @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# extrepo + +> Manage external Debian repositories. +> It is used to manage external repositories in Debian. +> More information: . + +- Search for a given package: + +`extrepo search {{package}}` + +- Enable the repository: + +`sudo extrepo enable {{repository_name}}` + +- Disable the repository: + +`sudo extrepo disable {{repository_name}}` + +- Update the repository: + +`sudo extrepo update {{repository_name}}` diff --git a/linux/extundelete b/linux/extundelete new file mode 100644 index 00000000..6330b5e9 --- /dev/null +++ b/linux/extundelete @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# extundelete + +> Recover deleted files from ext3 or ext4 partitions by parsing the journal. +> See also `date` for Unix time information and `umount` for unmounting partitions. +> More information: . + +- Restore all deleted files inside partition N on device X: + +`sudo extundelete {{/dev/sdXN}} --restore-all` + +- Restore a file from a path relative to root (Do not start the path with `/`): + +`extundelete {{/dev/sdXN}} --restore-file {{path/to/file}}` + +- Restore a directory from a path relative to root (Do not start the path with `/`): + +`extundelete {{/dev/sdXN}} --restore-directory {{path/to/directory}}` + +- Restore all files deleted after January 1st, 2020 (in Unix time): + +`extundelete {{/dev/sdXN}} --restore-all --after {{1577840400}}` diff --git a/linux/eyed3 b/linux/eyed3 new file mode 100644 index 00000000..daf3d0d3 --- /dev/null +++ b/linux/eyed3 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eyeD3 + +> Read and manipulate metadata of MP3 files. +> More information: . + +- View information about an MP3 file: + +`eyeD3 {{filename.mp3}}` + +- Set the title of an MP3 file: + +`eyeD3 --title "{{A Title}}" {{filename.mp3}}` + +- Set the album of all the MP3 files in a directory: + +`eyeD3 --album "{{Album Name}}" {{*.mp3}}` + +- Set the front cover art for an MP3 file: + +`eyeD3 --add-image {{front_cover.jpeg}}:FRONT_COVER: {{filename.mp3}}` diff --git a/linux/f5fpc b/linux/f5fpc new file mode 100644 index 00000000..9114a514 --- /dev/null +++ b/linux/f5fpc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# f5fpc + +> A proprietary commercial SSL VPN client by BIG-IP Edge. +> More information: . + +- Open a new VPN connection: + +`sudo f5fpc --start` + +- Open a new VPN connection to a specific host: + +`sudo f5fpc --start --host {{host.example.com}}` + +- Specify a username (user will be prompted for a password): + +`sudo f5fpc --start --host {{host.example.com}} --username {{user}}` + +- Show the current VPN status: + +`sudo f5fpc --info` + +- Shutdown the VPN connection: + +`sudo f5fpc --stop` diff --git a/linux/fail2ban-client b/linux/fail2ban-client new file mode 100644 index 00000000..434b6f05 --- /dev/null +++ b/linux/fail2ban-client @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fail2ban-client + +> Configure and control fail2ban server. +> More information: . + +- Retrieve current status of the jail service: + +`fail2ban-client status {{jail}}` + +- Remove the specified IP from the jail service's ban list: + +`fail2ban-client set {{jail}} unbanip {{ip}}` + +- Verify fail2ban server is alive: + +`fail2ban-client ping` diff --git a/linux/faillock b/linux/faillock new file mode 100644 index 00000000..22e5931c --- /dev/null +++ b/linux/faillock @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# faillock + +> Display and modify authentication failure record files. +> More information: . + +- List login failures of all users: + +`sudo faillock` + +- List login failures of the specified user: + +`sudo faillock --user {{user}}` + +- Reset the failure records of the specified user: + +`sudo faillock --user {{user}} --reset` diff --git a/linux/fakeroot b/linux/fakeroot new file mode 100644 index 00000000..2ab5f6aa --- /dev/null +++ b/linux/fakeroot @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fakeroot + +> Run a command in an environment faking root privileges for file manipulation. +> More information: . + +- Start the default shell as fakeroot: + +`fakeroot` + +- Run a command as fakeroot: + +`fakeroot -- {{command}} {{command_arguments}}` + +- Run a command as fakeroot and save the environment to a file on exit: + +`fakeroot -s {{path/to/file}} -- {{command}} {{command_arguments}}` + +- Load a fakeroot environment and run a command as fakeroot: + +`fakeroot -i {{path/to/file}} -- {{command}} {{command_arguments}}` + +- Run a command keeping the real ownership of files instead of pretending they are owned by root: + +`fakeroot --unknown-is-real -- {{command}} {{command_arguments}}` + +- Display help: + +`fakeroot --help` diff --git a/linux/faketime b/linux/faketime new file mode 100644 index 00000000..205fe56d --- /dev/null +++ b/linux/faketime @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# faketime + +> Fake the system time for a command. +> More information: . + +- Fake the time to this evening, before printing the result of `date`: + +`faketime '{{today 23:30}}' {{date}}` + +- Open a new `bash` shell, which uses yesterday as the current date: + +`faketime '{{yesterday}}' {{bash}}` + +- Simulate how a program would act next Friday night: + +`faketime '{{next Friday 1 am}}' {{path/to/program}}` diff --git a/linux/fallocate b/linux/fallocate new file mode 100644 index 00000000..34ab3a5f --- /dev/null +++ b/linux/fallocate @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fallocate + +> Reserve or deallocate disk space to files. +> The utility allocates space without zeroing. +> More information: . + +- Reserve a file taking up 700 MiB of disk space: + +`fallocate --length {{700M}} {{path/to/file}}` + +- Shrink an already allocated file by 200 MiB: + +`fallocate --collapse-range --length {{200M}} {{path/to/file}}` + +- Shrink 20 MB of space after 100 MiB in a file: + +`fallocate --collapse-range --offset {{100M}} --length {{20M}} {{path/to/file}}` diff --git a/linux/farge b/linux/farge new file mode 100644 index 00000000..c7857091 --- /dev/null +++ b/linux/farge @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# farge + +> Display the color of a specific pixel on the screen in either hexadecimal or RGB formats. +> More information: . + +- Display a small preview window of a pixel's color with it's hexadecimal value, and copy this value to the clipboard: + +`farge` + +- Copy a pixel's hexadecimal value to the clipboard without displaying a preview window: + +`farge --no-preview` + +- Output a pixel's hexadecimal value to `stdout`, and copy this value to the clipboard: + +`farge --stdout` + +- Output a pixel's RGB value to `stdout`, and copy this value to the clipboard: + +`farge --rgb --stdout` + +- Display a pixel's hexadecimal value as a notification which expires in 5000 milliseconds, and copy this value to the clipboard: + +`farge --notify --expire-time 5000` diff --git a/linux/fatlabel b/linux/fatlabel new file mode 100644 index 00000000..f15ac4f8 --- /dev/null +++ b/linux/fatlabel @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fatlabel + +> Sets or gets the label of a FAT32 partition. +> More information: . + +- Get the label of a FAT32 partition: + +`fatlabel {{/dev/sda1}}` + +- Set the label of a FAT32 partition: + +`fatlabel {{/dev/sdc3}} "{{new_label}}"` diff --git a/linux/fcrackzip b/linux/fcrackzip new file mode 100644 index 00000000..2ece95cb --- /dev/null +++ b/linux/fcrackzip @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fcrackzip + +> ZIP archive password cracking utility. +> More information: . + +- Brute-force a password with a length of 4 to 8 characters, and contains only alphanumeric characters (order matters): + +`fcrackzip --brute-force --length 4-8 --charset aA1 {{archive}}` + +- Brute-force a password in verbose mode with a length of 3 characters that only contains lowercase characters, `$` and `%`: + +`fcrackzip -v --brute-force --length 3 --charset a:$% {{archive}}` + +- Brute-force a password that contains only lowercase and special characters: + +`fcrackzip --brute-force --length 4 --charset a! {{archive}}` + +- Brute-force a password containing only digits, starting from the password `12345`: + +`fcrackzip --brute-force --length 5 --charset 1 --init-password 12345 {{archive}}` + +- Crack a password using a wordlist: + +`fcrackzip --use-unzip --dictionary --init-password {{wordlist}} {{archive}}` + +- Benchmark cracking performance: + +`fcrackzip --benchmark` diff --git a/linux/fdisk b/linux/fdisk new file mode 100644 index 00000000..de6165d8 --- /dev/null +++ b/linux/fdisk @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fdisk + +> A program for managing partition tables and partitions on a hard disk. +> See also: `partprobe`. +> More information: . + +- List partitions: + +`sudo fdisk -l` + +- Start the partition manipulator: + +`sudo fdisk {{/dev/sdX}}` + +- Once partitioning a disk, create a partition: + +`n` + +- Once partitioning a disk, select a partition to delete: + +`d` + +- Once partitioning a disk, view the partition table: + +`p` + +- Once partitioning a disk, write the changes made: + +`w` + +- Once partitioning a disk, discard the changes made: + +`q` + +- Once partitioning a disk, open a help menu: + +`m` diff --git a/linux/feedreader b/linux/feedreader new file mode 100644 index 00000000..d2455554 --- /dev/null +++ b/linux/feedreader @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# feedreader + +> A GUI desktop RSS client. +> More information: . + +- Print the count of unread articles: + +`feedreader --unreadCount` + +- Add a URL for a feed to follow: + +`feedreader --addFeed={{feed_url}}` + +- Grab a specific article using its URL: + +`feedreader --grabArticle={{article_url}}` + +- Download all images from a specific article: + +`feedreader --url={{feed_url}} --grabImages={{article_path}}` + +- Play media from a URL: + +`feedreader --playMedia={{article_url}}` diff --git a/linux/ffuf b/linux/ffuf new file mode 100644 index 00000000..9381c560 --- /dev/null +++ b/linux/ffuf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ffuf + +> Subdomain and directory discovery tool. +> More information: . + +- Discover directories using a [w]ordlist on a target [u]rl with [c]olorized and [v]erbose output: + +`ffuf -w {{path/to/wordlist}} -u {{https://target/FUZZ}} -c -v` + +- Fuzz host-[H]eaders with a host file on a target website and [m]atch HTTP 200 [c]ode responses: + +`ffuf -w {{hosts.txt}} -u {{https://example.org}} -H "{{Host: FUZZ}}" -mc {{200}}` + +- Discover directories using a [w]ordlist on a target website with a max individual job time of 60 seconds and recursion discovery depth of 2 levels: + +`ffuf -w {{path/to/wordlist}} -u {{https://target/FUZZ}} -maxtime-job {{60}} -recursion -recursion-depth {{2}}` + +- Fuzz GET parameter on a target website and [f]ilter out message [s]ize response of 4242 bytes: + +`ffuf -w {{path/to/param_names.txt}} -u {{https://target/script.php?FUZZ=test_value}} -fs {{4242}}` + +- Fuzz POST method with POST [d]ata of password on a target website and [f]ilter out HTTP response [c]ode 401: + +`ffuf -w {{path/to/postdata.txt}} -X {{POST}} -d "{{username=admin\&password=FUZZ}}" -u {{https://target/login.php}} -fc {{401}}` + +- Discover subdomains using a subdomain list on a target website: + +`ffuf -w {{subdomains.txt}} -u {{https://website.com}} -H "{{Host: FUZZ.website.com}}"` diff --git a/linux/file-rename b/linux/file-rename new file mode 100644 index 00000000..2e7de773 --- /dev/null +++ b/linux/file-rename @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rename + +> Rename multiple files. +> Note: this page refers to the command from the `rename` Debian package. +> More information: . + +- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): + +`rename {{'s/foo/bar/'}} {{*}}` + +- Dry-run - display which renames would occur without performing them: + +`rename -n {{'s/foo/bar/'}} {{*}}` + +- Force renaming even if the operation would remove existing destination files: + +`rename -f {{'s/foo/bar/'}} {{*}}` + +- Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): + +`rename 'y/A-Z/a-z/' {{*}}` + +- Replace whitespace with underscores: + +`rename 's/\s+/_/g' {{*}}` diff --git a/linux/filefrag b/linux/filefrag new file mode 100644 index 00000000..c66752d7 --- /dev/null +++ b/linux/filefrag @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# filefrag + +> Report how badly fragmented a particular file might be. +> More information: . + +- Display a report for one or more files: + +`filefrag {{path/to/file1 path/to/file2 ...}}` + +- Display a report using a 1024 byte blocksize: + +`filefrag -b {{path/to/file}}` + +- Sync the file before requesting the mapping: + +`filefrag -s {{path/to/file1 path/to/file2 ...}}` + +- Display mapping of extended attributes: + +`filefrag -x {{path/to/file1 path/to/file2 ...}}` + +- Display a report with verbose information: + +`filefrag -v {{path/to/file1 path/to/file2 ...}}` diff --git a/linux/finch b/linux/finch new file mode 100644 index 00000000..0323e3f0 --- /dev/null +++ b/linux/finch @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# finch + +> Console-based modular messaging client. +> More information: . + +- Launch finch: + +`finch` + +- Quit: + +` + q OR + c` + +- Show actions menu: + +` + a` + +- Jump to n-th window: + +` + {{number_key}}` + +- Close current window: + +` + c` + +- Start moving a window, use arrow keys to move, press escape when done: + +` + m` + +- Start resizing a window, use arrow keys to resize, press escape when done: + +` + r` diff --git a/linux/findfs b/linux/findfs new file mode 100644 index 00000000..c1b18127 --- /dev/null +++ b/linux/findfs @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# findfs + +> Finds a filesystem by label or UUID. +> More information: . + +- Search block devices by filesystem label: + +`findfs LABEL={{label}}` + +- Search by filesystem UUID: + +`findfs UUID={{uuid}}` + +- Search by partition label (GPT or MAC partition table): + +`findfs PARTLABEL={{partition_label}}` + +- Search by partition UUID (GPT partition table only): + +`findfs PARTUUID={{partition_uuid}}` diff --git a/linux/findmnt b/linux/findmnt new file mode 100644 index 00000000..e7589905 --- /dev/null +++ b/linux/findmnt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# findmnt + +> Find your filesystem. +> More information: . + +- List all mounted filesystems: + +`findmnt` + +- Search for a device: + +`findmnt {{/dev/sdb1}}` + +- Search for a mountpoint: + +`findmnt {{/}}` + +- Find filesystems in specific type: + +`findmnt -t {{ext4}}` + +- Find filesystems with specific label: + +`findmnt LABEL={{BigStorage}}` diff --git a/linux/firejail b/linux/firejail new file mode 100644 index 00000000..d02828ec --- /dev/null +++ b/linux/firejail @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# firejail + +> Securely sandboxes processes to containers using built-in Linux capabilities. +> More information: . + +- Integrate firejail with your desktop environment: + +`sudo firecfg` + +- Open a restricted Mozilla Firefox: + +`firejail {{firefox}}` + +- Start a restricted Apache server on a known interface and address: + +`firejail --net={{eth0}} --ip={{192.168.1.244}} {{/etc/init.d/apache2}} {{start}}` + +- List running sandboxes: + +`firejail --list` + +- List network activity from running sandboxes: + +`firejail --netstats` + +- Shutdown a running sandbox: + +`firejail --shutdown={{7777}}` diff --git a/linux/firewall-cmd b/linux/firewall-cmd new file mode 100644 index 00000000..24e3a8fe --- /dev/null +++ b/linux/firewall-cmd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# firewall-cmd + +> The firewalld command-line client. +> More information: . + +- View the available firewall zones: + +`firewall-cmd --get-active-zones` + +- View the rules which are currently applied: + +`firewall-cmd --list-all` + +- Permanently move the interface into the block zone, effectively blocking all communication: + +`firewall-cmd --permanent --zone={{block}} --change-interface={{enp1s0}}` + +- Permanently open the port for a service in the specified zone (like port 443 when in the `public` zone): + +`firewall-cmd --permanent --zone={{public}} --add-service={{https}}` + +- Permanently close the port for a service in the specified zone (like port 80 when in the `public` zone): + +`firewall-cmd --permanent --zone={{public}} --remove-service={{http}}` + +- Permanently open two arbitrary ports in the specified zone: + +`firewall-cmd --permanent --zone={{public}} --add-port={{25565/tcp}} --add-port={{19132/udp}}` + +- Reload firewalld to force rule changes to take effect: + +`firewall-cmd --reload` diff --git a/linux/fixfiles b/linux/fixfiles new file mode 100644 index 00000000..b9e752d3 --- /dev/null +++ b/linux/fixfiles @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fixfiles + +> Fix file SELinux security contexts. +> More information: . + +- If specified with onboot, this fixfiles will record the current date in the `/.autorelabel` file, so that it can be used later to speed up labeling. If used with restore, the restore will only affect files that were modified today: + +`fixfiles -B` + +- [F]orce reset of context to match `file_context` for customizable files: + +`fixfiles -F` + +- Clear `/tmp` directory without confirmation: + +`fixfiles -f` + +- Use the [R]pm database to discover all files within specific packages and restore the file contexts: + +`fixfiles -R {{rpm_package1,rpm_package2 ...}}` + +- Run a diff on the `PREVIOUS_FILECONTEXT` file to the [C]urrently installed one, and restore the context of all affected files: + +`fixfiles -C PREVIOUS_FILECONTEXT` + +- Only act on files created after a specific date which will be passed to find `--newermt` command: + +`fixfiles -N {{YYYY-MM-DD HH:MM}}` + +- Bind [M]ount filesystems before relabeling them, this allows fixing the context of files or directories that have been mounted over: + +`fixfiles -M` + +- Modify [v]erbosity from progress to verbose and run `restorecon` with `-v` instead of `-p`: + +`fixfiles -v` diff --git a/linux/flameshot b/linux/flameshot new file mode 100644 index 00000000..6946332a --- /dev/null +++ b/linux/flameshot @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flameshot + +> Screenshot utility with a GUI. +> Supports basic image editing, such as text, shapes, colors, and imgur. +> More information: . + +- Create a fullscreen screenshot: + +`flameshot full` + +- Create a screenshot interactively: + +`flameshot gui` + +- Create a screenshot and save it to a specific path: + +`flameshot gui --path {{path/to/directory}}` + +- Create a screenshot interactively in a simplified mode: + +`flameshot launcher` + +- Create a screenshot from a specific monitor: + +`flameshot screen --number {{2}}` + +- Create a screenshot and print it to `stdout`: + +`flameshot gui --raw` + +- Create a screenshot and copy it to the clipboard: + +`flameshot gui --clipboard` + +- Create a screenshot with a specific delay in milliseconds: + +`flameshot full --delay {{5000}}` diff --git a/linux/flash b/linux/flash new file mode 100644 index 00000000..3b27ed49 --- /dev/null +++ b/linux/flash @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flash + +> Flash cards in the terminal. +> More information: . + +- Open a menu of available flashcard decks for selection: + +`flash` + +- Display information about the flashcard system: + +`flash -i` + +- Change the previewer from default `bat` to `cat`: + +`flash -p {{cat}}` + +- Display help: + +`flash -h` + +- Display version: + +`flash -v` diff --git a/linux/flashrom b/linux/flashrom new file mode 100644 index 00000000..3cb131b9 --- /dev/null +++ b/linux/flashrom @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flashrom + +> Read, write, verify and erase flash chips. +> More information: . + +- Probe the chip, ensuring the wiring is correct: + +`flashrom --programmer {{programmer}}` + +- Read flash and save it to a file: + +`flashrom -p {{programmer}} --read {{path/to/file}}` + +- Write a file to the flash: + +`flashrom -p {{programmer}} --write {{path/to/file}}` + +- Verify the flash against a file: + +`flashrom -p {{programmer}} --verify {{path/to/file}}` + +- Probe the chip using Raspberry Pi: + +`flashrom -p {{linux_spi:dev=/dev/spidev0.0}}` diff --git a/linux/flatpak b/linux/flatpak new file mode 100644 index 00000000..0fd654b6 --- /dev/null +++ b/linux/flatpak @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flatpak + +> Build, install and run flatpak applications and runtimes. +> More information: . + +- Run an installed application: + +`flatpak run {{name}}` + +- Install an application from a remote source: + +`flatpak install {{remote}} {{name}}` + +- List installed applications, ignoring runtimes: + +`flatpak list --app` + +- Update all installed applications and runtimes: + +`flatpak update` + +- Add a remote source: + +`flatpak remote-add --if-not-exists {{remote_name}} {{remote_url}}` + +- Remove an installed application: + +`flatpak remove {{name}}` + +- Remove all unused applications: + +`flatpak remove --unused` + +- Show information about an installed application: + +`flatpak info {{name}}` diff --git a/linux/flatpak-builder b/linux/flatpak-builder new file mode 100644 index 00000000..f800a04f --- /dev/null +++ b/linux/flatpak-builder @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flatpak-builder + +> Help build application dependencies. +> More information: . + +- Build a Flatpak and export it to a new repository: + +`flatpak-builder {{path/to/build_directory}} {{path/to/manifest}}` + +- Build a Flatpak and export it to the specified repository: + +`flatpak-builder --repo={{repository_name}} {{path/to/build_directory}} {{path/to/manifest}}` + +- Build a Flatpak and install it locally: + +`flatpak-builder --install {{path/to/build_directory}} {{path/to/manifest}}` + +- Build and sign a Flatpak and export it to the specified repository: + +`flatpak-builder --gpg-sign={{key_id}} --repo={{repository_name}} {{path/to/manifest}}` + +- Run a shell inside of an application sandbox without installing it: + +`flatpak-builder --run {{path/to/build_directory}} {{path/to/manifest}} {{sh}}` diff --git a/linux/fluidsynth b/linux/fluidsynth new file mode 100644 index 00000000..6bc3e442 --- /dev/null +++ b/linux/fluidsynth @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fluidsynth + +> Synthesize audio from MIDI files. +> More information: . + +- Play a MIDI file: + +`fluidsynth --audio-driver={{pipewire|pulseaudio}} {{path/to/soundfont.sf2}} {{path/to/file.midi}}` diff --git a/linux/fold b/linux/fold new file mode 100644 index 00000000..96e457ae --- /dev/null +++ b/linux/fold @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fold + +> Folds long lines for fixed-width output devices. +> More information: . + +- Fold lines in a fixed width: + +`fold --width {{width}} {{path/to/file}}` + +- Count width in bytes (the default is to count in columns): + +`fold --bytes --width {{width_in_bytes}} {{path/to/file}}` + +- Break the line after the rightmost blank within the width limit: + +`fold --spaces --width {{width}} {{path/to/file}}` diff --git a/linux/foreman b/linux/foreman new file mode 100644 index 00000000..dbfd1074 --- /dev/null +++ b/linux/foreman @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# foreman + +> Manage Procfile-based applications. +> More information: . + +- Start an application with the Procfile in the current directory: + +`foreman start` + +- Start an application with a specified Procfile: + +`foreman start -f {{Procfile}}` + +- Start a specific application: + +`foreman start {{process}}` + +- Validate Procfile format: + +`foreman check` + +- Run one-off commands with the process's environment: + +`foreman run {{command}}` + +- Start all processes except the one named "worker": + +`foreman start -m all=1,{{worker}}=0` diff --git a/linux/fprintd b/linux/fprintd new file mode 100644 index 00000000..ee09ec4b --- /dev/null +++ b/linux/fprintd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fprintd + +> Fingerprint management daemon. +> More information: . + +- Display the man page for `fprintd`: + +`man fprintd` diff --git a/linux/fprintd-delete b/linux/fprintd-delete new file mode 100644 index 00000000..1b99bee8 --- /dev/null +++ b/linux/fprintd-delete @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fprintd-delete + +> Remove fingerprints from the database. +> More information: . + +- Remove all fingerprints for a specific user: + +`fprintd-delete {{username}}` + +- Remove a specific fingerprints for a specific user: + +`fprintd-delete {{username}} --finger {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|right-index-finger|right-middle-finger|right-ring-finger|right-little-finger}}` + +- Display help: + +`fprintd-delete` diff --git a/linux/fprintd-enroll b/linux/fprintd-enroll new file mode 100644 index 00000000..a34e3aad --- /dev/null +++ b/linux/fprintd-enroll @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fprintd-enroll + +> Enroll fingerprints into the database. +> More information: . + +- Enroll the right index finger for the current user: + +`fprintd-enroll` + +- Enroll a specific finger for the current user: + +`fprintd-enroll --finger {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|right-index-finger|right-middle-finger|right-ring-finger|right-little-finger}}` + +- Enroll the right index finger for a specific user: + +`fprintd-enroll {{username}}` + +- Enroll a specific finger for a specific user: + +`fprintd-enroll --finger {{finger_name}} {{username}}` + +- Display help: + +`fprintd-enroll --help` diff --git a/linux/fprintd-list b/linux/fprintd-list new file mode 100644 index 00000000..2a521f73 --- /dev/null +++ b/linux/fprintd-list @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fprintd-list + +> List enrolled fingerprints. +> More information: . + +- List enrolled fingerprints for a specific user: + +`fprintd-list {{username}}` + +- List enrolled fingerprints for one or more users: + +`fprintd-list {{username1 username2 ...}}` + +- Display help: + +`fprintd-list` diff --git a/linux/fprintd-verify b/linux/fprintd-verify new file mode 100644 index 00000000..d1335454 --- /dev/null +++ b/linux/fprintd-verify @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fprintd-verify + +> Verify fingerprints against the database. +> More information: . + +- Verify all stored fingerprints for the current user: + +`fprintd-verify` + +- Verify a specific fingerprint for the current user: + +`fprintd-verify --finger {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|right-index-finger|right-middle-finger|right-ring-finger|right-little-finger}}` + +- Verify fingerprints for a specific user: + +`fprint-verify {{username}}` + +- Verify a specific fingerprint for a specific user: + +`fprintd-verify --finger {{finger_name}} {{username}}` + +- Fail the process if a fingerprint doesn't match with ones stored in the database for the current user: + +`fprint-verify --g-fatal-warnings` + +- Display help: + +`fprintd-verify --help` diff --git a/linux/free b/linux/free new file mode 100644 index 00000000..64540166 --- /dev/null +++ b/linux/free @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# free + +> Display amount of free and used memory in the system. +> More information: . + +- Display system memory: + +`free` + +- Display memory in Bytes/KB/MB/GB: + +`free -{{b|k|m|g}}` + +- Display memory in human-readable units: + +`free -h` + +- Refresh the output every 2 seconds: + +`free -s {{2}}` diff --git a/linux/fsck b/linux/fsck new file mode 100644 index 00000000..d450e22f --- /dev/null +++ b/linux/fsck @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fsck + +> Check the integrity of a filesystem or repair it. The filesystem should be unmounted at the time the command is run. +> More information: . + +- Check filesystem `/dev/sdXN`, reporting any damaged blocks: + +`sudo fsck {{/dev/sdXN}}` + +- Check filesystem `/dev/sdXN`, reporting any damaged blocks and interactively letting the user choose to repair each one: + +`sudo fsck -r {{/dev/sdXN}}` + +- Check filesystem `/dev/sdXN`, reporting any damaged blocks and automatically repairing them: + +`sudo fsck -a {{/dev/sdXN}}` diff --git a/linux/fscrypt b/linux/fscrypt new file mode 100644 index 00000000..2230aba3 --- /dev/null +++ b/linux/fscrypt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fscrypt + +> Go tool for managing Linux filesystem encryption. +> More information: . + +- Prepare the root filesystem for use with fscrypt: + +`fscrypt setup` + +- Enable filesystem encryption for a directory: + +`fscrypt encrypt {{path/to/directory}}` + +- Unlock an encrypted directory: + +`fscrypt unlock {{path/to/encrypted_directory}}` + +- Lock an encrypted directory: + +`fscrypt lock {{path/to/encrypted_directory}}` diff --git a/linux/fstrim b/linux/fstrim new file mode 100644 index 00000000..077ac269 --- /dev/null +++ b/linux/fstrim @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fstrim + +> Discard unused blocks on a mounted filesystem. +> Only supported by flash memory devices such as SSDs and microSD cards. +> More information: . + +- Trim unused blocks on all mounted partitions that support it: + +`sudo fstrim --all` + +- Trim unused blocks on a specified partition: + +`sudo fstrim {{/}}` + +- Display statistics after trimming: + +`sudo fstrim --verbose {{/}}` diff --git a/linux/fuser b/linux/fuser new file mode 100644 index 00000000..ad52e200 --- /dev/null +++ b/linux/fuser @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fuser + +> Display process IDs currently using files or sockets. +> More information: . + +- Find which processes are accessing a file or directory: + +`fuser {{path/to/file_or_directory}}` + +- Show more fields (`USER`, `PID`, `ACCESS` and `COMMAND`): + +`fuser --verbose {{path/to/file_or_directory}}` + +- Identify processes using a TCP socket: + +`fuser --namespace tcp {{port}}` + +- Kill all processes accessing a file or directory (sends the `SIGKILL` signal): + +`fuser --kill {{path/to/file_or_directory}}` + +- Find which processes are accessing the filesystem containing a specific file or directory: + +`fuser --mount {{path/to/file_or_directory}}` + +- Kill all processes with a TCP connection on a specific port: + +`fuser --kill {{port}}/tcp` diff --git a/linux/fwupdmgr b/linux/fwupdmgr new file mode 100644 index 00000000..bfa28295 --- /dev/null +++ b/linux/fwupdmgr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# fwupdmgr + +> A tool for updating device firmware, including UEFI, using `fwupd`. +> More information: . + +- Display all devices detected by fwupd: + +`fwupdmgr get-devices` + +- Download the latest firmware metadata from LVFS: + +`fwupdmgr refresh` + +- List the updates available for devices on your system: + +`fwupdmgr get-updates` + +- Install firmware updates: + +`fwupdmgr update` diff --git a/linux/gbp b/linux/gbp new file mode 100644 index 00000000..bb90ff5e --- /dev/null +++ b/linux/gbp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gbp + +> A system to integrate the Debian package build system with Git. +> More information: . + +- Convert an existing Debian package to gbp: + +`gbp import-dsc {{path/to/package.dsc}}` + +- Build the package in the current directory using the default builder (`debuild`): + +`gbp buildpackage -jauto -us -uc` + +- Build a package in a `pbuilder` environment for Debian Bullseye: + +`DIST={{bullseye}} ARCH={{amd64}} gbp buildpackage -jauto -us -uc --git-builder={{git-pbuilder}}` + +- Specify a package to be a source-only upload in the `.changes` file (see ): + +`gbp buildpackage -jauto -us -uc --changes-options={{-S}}` + +- Import a new upstream release: + +`gbp import-orig --pristine-tar {{path/to/package.tar.gz}}` diff --git a/linux/gcov b/linux/gcov new file mode 100644 index 00000000..2891780b --- /dev/null +++ b/linux/gcov @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gcov + +> Code coverage analysis and profiling tool that discovers untested parts of a program. +> Also displays a copy of source code annotated with execution frequencies of code segments. +> More information: . + +- Generate a coverage report named `file.cpp.gcov`: + +`gcov {{path/to/file.cpp}}` + +- Write individual execution counts for every basic block: + +`gcov --all-blocks {{path/to/file.cpp}}` + +- Write branch frequencies to the output file and print summary information to `stdout` as a percentage: + +`gcov --branch-probabilities {{path/to/file.cpp}}` + +- Write branch frequencies as the number of branches taken, rather than the percentage: + +`gcov --branch-counts {{path/to/file.cpp}}` + +- Do not create a `gcov` output file: + +`gcov --no-output {{path/to/file.cpp}}` + +- Write file level as well as function level summaries: + +`gcov --function-summaries {{path/to/file.cpp}}` diff --git a/linux/gdebi b/linux/gdebi new file mode 100644 index 00000000..db282f2e --- /dev/null +++ b/linux/gdebi @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gdebi + +> Simple tool to install `.deb` files. +> More information: . + +- Install local `.deb` packages resolving and installing its dependencies: + +`gdebi {{path/to/package.deb}}` + +- Do not show progress information: + +`gdebi {{path/to/package.deb}} --quiet` + +- Set an APT configuration option: + +`gdebi {{path/to/package.deb}} --option={{APT_OPTS}}` + +- Use alternative root dir: + +`gdebi {{path/to/package.deb}} --root={{path/to/root_dir}}` + +- Display version: + +`gdebi --version` diff --git a/linux/gedit b/linux/gedit new file mode 100644 index 00000000..cfea381d --- /dev/null +++ b/linux/gedit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gedit + +> Text editor of the GNOME Desktop project. +> More information: . + +- Open a text file: + +`gedit {{path/to/file}}` + +- Open multiple text files: + +`gedit {{file1 file2 ...}}` + +- Open a text file with a specific encoding: + +`gedit --encoding={{UTF-8}} {{path/to/file}}` + +- Display a list of supported encodings: + +`gedit --list-encodings` diff --git a/linux/genfstab b/linux/genfstab new file mode 100644 index 00000000..03c16fed --- /dev/null +++ b/linux/genfstab @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# genfstab + +> Arch Linux install script to generate output suitable for addition to an fstab file. +> More information: . + +- Display an fstab compatible output based on a volume label: + +`genfstab -L {{path/to/mount_point}}` + +- Display an fstab compatible output based on a volume UUID: + +`genfstab -U {{path/to/mount_point}}` + +- A usual way to generate an fstab file, requires root permissions: + +`genfstab -U {{/mnt}} >> {{/mnt/etc/fstab}}` + +- Append a volume into an fstab file to mount it automatically: + +`genfstab -U {{path/to/mount_point}} | sudo tee -a /etc/fstab` diff --git a/linux/genid b/linux/genid new file mode 100644 index 00000000..f9624067 --- /dev/null +++ b/linux/genid @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# genid + +> Generate IDs, such as snowflakes, UUIDs, and a new GAID. +> More information: . + +- Generate a UUIDv4: + +`genid uuid` + +- Generate a UUIDv5 using a namespace UUID and a specific name: + +`genid uuidv5 {{ce598faa-8dd0-49ee-8525-9e24fff71dca}} {{name}}` + +- Generate a Discord Snowflake, without a trailing newline (useful in shell scripts): + +`genid --script snowflake` + +- Generate a Generic Anonymous ID with a specific "real ID": + +`genid gaid {{real_id}}` + +- Generate a Snowflake with the epoch set to a specific date: + +`genid snowflake --epoch={{unix_epoch_time}}` diff --git a/linux/genie b/linux/genie new file mode 100644 index 00000000..feafb474 --- /dev/null +++ b/linux/genie @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# genie + +> Set up and use a "bottle" namespace to run systemd under WSL (Windows Subsystem for Linux). +> To run these from Windows rather than an already-running distribution, precede them with `wsl`. +> More information: . + +- Initialize the bottle (run once, at start): + +`genie -i` + +- Run a login shell inside the bottle: + +`genie -s` + +- Run a specified command inside the bottle: + +`genie -c {{command}}` diff --git a/linux/genisoimage b/linux/genisoimage new file mode 100644 index 00000000..76e91cc1 --- /dev/null +++ b/linux/genisoimage @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# genisoimage + +> Pre-mastering program to generate ISO9660/Joliet/HFS hybrid filesystems. +> More information: . + +- Create an ISO image from the given source directory: + +`genisoimage -o {{myimage.iso}} {{path/to/source_directory}}` + +- Create an ISO image with files larger than 2GiB by reporting a smaller apparent size for ISO9660 filesystems: + +`genisoimage -o -allow-limited-size {{myimage.iso}} {{path/to/source_directory}}` diff --git a/linux/genkernel b/linux/genkernel new file mode 100644 index 00000000..eee82371 --- /dev/null +++ b/linux/genkernel @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# genkernel + +> Gentoo Linux utility to compile and install kernels. +> More information: . + +- Automatically compile and install a generic kernel: + +`sudo genkernel all` + +- Build and install the bzImage|initramfs|kernel|ramdisk only: + +`sudo genkernel {{bzImage|initramfs|kernel|ramdisk}}` + +- Apply changes to the kernel configuration before compiling and installing: + +`sudo genkernel --menuconfig all` + +- Generate a kernel with a custom name: + +`sudo genkernel --kernname={{custom_name}} all` + +- Use a kernel source outside the default directory `/usr/src/linux`: + +`sudo genkernel --kerneldir={{path/to/directory}} all` diff --git a/linux/getcap b/linux/getcap new file mode 100644 index 00000000..f4b97e66 --- /dev/null +++ b/linux/getcap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# getcap + +> Command to display the name and capabilities of each specified file. +> More information: . + +- Get capabilities for the given files: + +`getcap {{path/to/file1 path/to/file2 ...}}` + +- Get capabilities for all the files recursively under the given directories: + +`getcap -r {{path/to/directory1 path/to/directory2 ...}}` + +- Displays all searched entries even if no capabilities are set: + +`getcap -v {{path/to/file1 path/to/file2 ...}}` diff --git a/linux/getconf b/linux/getconf new file mode 100644 index 00000000..9beaa7de --- /dev/null +++ b/linux/getconf @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# getconf + +> Get configuration values from your Linux system. +> More information: . + +- List [a]ll configuration values available: + +`getconf -a` + +- List the configuration values for a specific directory: + +`getconf -a {{path/to/directory}}` + +- Check if the system is 32-bit or 64-bit: + +`getconf LONG_BIT` + +- Check how many processes the current user can run at once: + +`getconf CHILD_MAX` + +- List every configuration value and then find patterns with the `grep` command (i.e every value with MAX in it): + +`getconf -a | grep MAX` diff --git a/linux/getent b/linux/getent new file mode 100644 index 00000000..711fda75 --- /dev/null +++ b/linux/getent @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# getent + +> Get entries from Name Service Switch libraries. +> More information: . + +- Get list of all groups: + +`getent group` + +- See the members of a group: + +`getent group {{group_name}}` + +- Get list of all services: + +`getent services` + +- Find a username by UID: + +`getent passwd 1000` + +- Perform a reverse DNS lookup: + +`getent hosts {{host}}` diff --git a/linux/getfacl b/linux/getfacl new file mode 100644 index 00000000..f2c515c0 --- /dev/null +++ b/linux/getfacl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# getfacl + +> Get file access control lists (ACL). +> More information: . + +- Display the file access control list: + +`getfacl {{path/to/file_or_directory}}` + +- Display the file access control list with [n]umeric user and group IDs: + +`getfacl --numeric {{path/to/file_or_directory}}` + +- Display the file access control list with [t]abular output format: + +`getfacl --tabular {{path/to/file_or_directory}}` diff --git a/linux/getopt b/linux/getopt new file mode 100644 index 00000000..a8a1b552 --- /dev/null +++ b/linux/getopt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# getopt + +> Parse command-line arguments. +> More information: . + +- Parse optional `verbose`/`version` flags with shorthands: + +`getopt --options vV --longoptions verbose,version -- --version --verbose` + +- Add a `--file` option with a required argument with shorthand `-f`: + +`getopt --options f: --longoptions file: -- --file=somefile` + +- Add a `--verbose` option with an optional argument with shorthand `-v`, and pass a non-option parameter `arg`: + +`getopt --options v:: --longoptions verbose:: -- --verbose arg` + +- Accept a `-r` and `--verbose` flag, a `--accept` option with an optional argument and add a `--target` with a required argument option with shorthands: + +`getopt --options rv::s::t: --longoptions verbose,source::,target: -- -v --target target` diff --git a/linux/gio-trash b/linux/gio-trash new file mode 100644 index 00000000..727869a7 --- /dev/null +++ b/linux/gio-trash @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gio trash + +> Move files to the trash bin. +> Used by GNOME to handle trash. +> More information: . + +- Move specific files to the trash bin: + +`gio trash {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- List trash bin items: + +`gio trash --list` + +- Restore a specific item from trash using its ID: + +`gio trash trash://{{id}}` diff --git a/linux/gnome-calculator b/linux/gnome-calculator new file mode 100644 index 00000000..de3912f7 --- /dev/null +++ b/linux/gnome-calculator @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gnome-calculator + +> The official calculator for the GNOME desktop environment. +> More information: . + +- Launch the GNOME Calculator GUI: + +`gnome-calculator` + +- Solve the specified equation without launching the desktop application: + +`gnome-calculator --solve {{2^5 * 2 + 5}}` + +- Display version: + +`gnome-calculator --version` diff --git a/linux/gnome-extensions b/linux/gnome-extensions new file mode 100644 index 00000000..d5646cf8 --- /dev/null +++ b/linux/gnome-extensions @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gnome-extensions + +> Manage gnome extensions from the terminal. +> More information: . + +- List all the installed extensions: + +`gnome-extensions list` + +- Display information about a specific extension: + +`gnome-extensions info "{{extension_id}}"` + +- Enable a specific extension: + +`gnome-extensions enable "{{extension_id}}"` + +- Disable a specific extension: + +`gnome-extension disable "{{extension_id}}"` + +- Uninstall a specific extension: + +`gnome-extension uninstall "{{extension_id}}"` + +- Display help for a specific subcommand (like `list`): + +`gnome-extensions help {{subcommand}}` + +- Display version: + +`gnome-extensions version` diff --git a/linux/gnome-screenshot b/linux/gnome-screenshot new file mode 100644 index 00000000..a3eb4534 --- /dev/null +++ b/linux/gnome-screenshot @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gnome-screenshot + +> Capture the screen, a window, or a user-defined area and save the image to a file. +> More information: . + +- Take a screenshot and save it to the default location, normally `~/Pictures`: + +`gnome-screenshot` + +- Take a screenshot and save it to the named file location: + +`gnome-screenshot --file {{path/to/file}}` + +- Take a screenshot and save it to the clipboard: + +`gnome-screenshot --clipboard` + +- Take a screenshot after the specified number of seconds: + +`gnome-screenshot --delay {{5}}` + +- Launch the GNOME Screenshot GUI: + +`gnome-screenshot --interactive` + +- Take a screenshot of the current window and save it to the specified file location: + +`gnome-screenshot --window --file {{path/to/file}}` + +- Take a screenshot after the specified number of seconds and save it to the clipboard: + +`gnome-screenshot --delay {{10}} --clipboard` + +- Display the version: + +`gnome-screenshot --version` diff --git a/linux/gnome-software b/linux/gnome-software new file mode 100644 index 00000000..3b4b65f1 --- /dev/null +++ b/linux/gnome-software @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gnome-software + +> Add and remove applications and update your system. +> More information: . + +- Launch the GNOME Software GUI if it's not already running: + +`gnome-software` + +- Launch the GNOME Software GUI if it's not open, and navigate to the specified page: + +`gnome-software --mode {{updates|updated|installed|overview}}` + +- Launch the GNOME Software GUI if it's not open and view the details of the specified package: + +`gnome-software --details {{package}}` + +- Display the version: + +`gnome-software --version` diff --git a/linux/gnome-terminal b/linux/gnome-terminal new file mode 100644 index 00000000..ab1d1c9d --- /dev/null +++ b/linux/gnome-terminal @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gnome-terminal + +> The GNOME Terminal emulator. +> More information: . + +- Open a new GNOME terminal window: + +`gnome-terminal` + +- Run a specific command in a new terminal window: + +`gnome-terminal -- {{command}}` + +- Open a new tab in the last opened window instead: + +`gnome-terminal --tab` + +- Set the title of the new tab: + +`gnome-terminal --tab --title "{{title}}"` diff --git a/linux/goaccess b/linux/goaccess new file mode 100644 index 00000000..11650d2b --- /dev/null +++ b/linux/goaccess @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# goaccess + +> An open source real-time web log analyzer. +> More information: . + +- Analyze one or more log files in interactive mode: + +`goaccess {{path/to/logfile1 path/to/file2 ...}}` + +- Use a specific log-format (or pre-defined formats like "combined"): + +`goaccess {{path/to/logfile}} --log-format={{format}}` + +- Analyze a log from `stdin`: + +`tail -f {{path/to/logfile}} | goaccess -` + +- Analyze a log and write it to an HTML file in real-time: + +`goaccess {{path/to/logfile}} --output {{path/to/file.html}} --real-time-html` diff --git a/linux/goldeneye.py b/linux/goldeneye.py new file mode 100644 index 00000000..81605cd6 --- /dev/null +++ b/linux/goldeneye.py @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# goldeneye.py + +> A HTTP DoS test tool. +> More information: . + +- Test a specific website: + +`./goldeneye.py {{url}}` + +- Test a specific website with 100 user agents and 200 concurrent sockets: + +`./goldeneye.py {{url}} --useragents 100 --sockets 200` + +- Test a specific website without verifying the SSL certificate: + +`./goldeneye.py {{url}} --nosslcheck` + +- Test a specific website in debug mode: + +`./goldeneye.py {{url}} --debug` + +- Display help: + +`./goldeneye.py --help` diff --git a/linux/goobook b/linux/goobook new file mode 100644 index 00000000..b28930bb --- /dev/null +++ b/linux/goobook @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# goobook + +> Access Google contacts from `mutt` or the command-line. +> More information: . + +- Allow `goobook` to access Google contacts using OAuth2: + +`goobook authenticate` + +- Dump all contacts to XML (`stdout`): + +`goobook dump_contacts` diff --git a/linux/gpasswd b/linux/gpasswd new file mode 100644 index 00000000..d0a606eb --- /dev/null +++ b/linux/gpasswd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gpasswd + +> Administer `/etc/group` and `/etc/gshadow`. +> More information: . + +- Define group administrators: + +`sudo gpasswd -A {{user1,user2}} {{group}}` + +- Set the list of group members: + +`sudo gpasswd -M {{user1,user2}} {{group}}` + +- Create a password for the named group: + +`gpasswd {{group}}` + +- Add a user to the named group: + +`gpasswd -a {{user}} {{group}}` + +- Remove a user from the named group: + +`gpasswd -d {{user}} {{group}}` diff --git a/linux/grim b/linux/grim new file mode 100644 index 00000000..080e2c8e --- /dev/null +++ b/linux/grim @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grim + +> Grab images (Screenshots) from a Wayland compositor. +> More information: . + +- Screenshot all outputs: + +`grim` + +- Screenshot a specific output: + +`grim -o {{path/to/output_file}}` + +- Screenshot a specific region: + +`grim -g "{{, x}}"` + +- Select a specific region and screenshot it, (using slurp): + +`grim -g "{{$(slurp)}}"` + +- Use a custom filename: + +`grim "{{path/to/file.png}}"` + +- Screenshot and copy to clipboard: + +`grim - | {{clipboard_manager}}` diff --git a/linux/groupadd b/linux/groupadd new file mode 100644 index 00000000..32f0c49e --- /dev/null +++ b/linux/groupadd @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# groupadd + +> Add user groups to the system. +> See also: `groups`, `groupdel`, `groupmod`. +> More information: . + +- Create a new group: + +`sudo groupadd {{group_name}}` + +- Create a new system group: + +`sudo groupadd --system {{group_name}}` + +- Create a new group with the specific groupid: + +`sudo groupadd --gid {{id}} {{group_name}}` diff --git a/linux/groupdel b/linux/groupdel new file mode 100644 index 00000000..58cd3fa2 --- /dev/null +++ b/linux/groupdel @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# groupdel + +> Delete existing user groups from the system. +> See also: `groups`, `groupadd`, `groupmod`. +> More information: . + +- Delete an existing group: + +`sudo groupdel {{group_name}}` diff --git a/linux/groupmod b/linux/groupmod new file mode 100644 index 00000000..5b7a403c --- /dev/null +++ b/linux/groupmod @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# groupmod + +> Modify existing user groups in the system. +> See also: `groups`, `groupadd`, `groupdel`. +> More information: . + +- Change the group name: + +`sudo groupmod --new-name {{new_group}} {{group_name}}` + +- Change the group id: + +`sudo groupmod --gid {{new_id}} {{group_name}}` diff --git a/linux/grub-bios-setup b/linux/grub-bios-setup new file mode 100644 index 00000000..d1d96a36 --- /dev/null +++ b/linux/grub-bios-setup @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-bios-setup + +> Set up a device to use GRUB with a BIOS configuration. +> You should use `grub-install` instead of `grub-bios-setup` in most cases. +> More information: . + +- Set up a device to boot with GRUB: + +`grub-bios-setup {{/dev/sdX}}` + +- Install even if problems are detected: + +`grub-bios-setup --force {{/dev/sdX}}` + +- Install GRUB in a specific directory: + +`grub-bios-setup --directory={{/boot/grub}} {{/dev/sdX}}` diff --git a/linux/grub-editenv b/linux/grub-editenv new file mode 100644 index 00000000..4c17691e --- /dev/null +++ b/linux/grub-editenv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-editenv + +> Edit GRUB environment variables. +> More information: . + +- Set a default boot entry (Assuming the boot entry already exists): + +`grub-editenv /boot/grub/grubenv set default={{Ubuntu}}` + +- Display the current value of the `timeout` variable: + +`grub-editenv /boot/grub/grubenv list timeout` + +- Reset the `saved_entry` variable to the default: + +`grub-editenv /boot/grub/grubenv unset saved_entry` + +- Append "quiet splash" to the kernel command line: + +`grub-editenv /boot/grub/grubenv list kernel_cmdline` diff --git a/linux/grub-file b/linux/grub-file new file mode 100644 index 00000000..98cc46c2 --- /dev/null +++ b/linux/grub-file @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-file + +> Check if a file is of a bootable image type. +> More information: . + +- Check if a file is an ARM EFI image: + +`grub-file --is-arm-efi {{path/to/file}}` + +- Check if a file is an i386 EFI image: + +`grub-file --is-i386-efi {{path/to/file}}` + +- Check if a file is an x86_64 EFI image: + +`grub-file --is-x86_64-efi {{path/to/file}}` + +- Check if a file is an ARM image (Linux kernel): + +`grub-file --is-arm-linux {{path/to/file}}` + +- Check if a file is an x86 image (Linux kernel): + +`grub-file --is-x86-linux {{path/to/file}}` + +- Check if a file is an x86_64 XNU image (macOS kernel): + +`grub-file --is-x86_64-xnu {{path/to/file}}` diff --git a/linux/grub-install b/linux/grub-install new file mode 100644 index 00000000..b60d5030 --- /dev/null +++ b/linux/grub-install @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-install + +> Install GRUB to a device. +> More information: . + +- Install GRUB on a BIOS system: + +`grub-install --target={{i386-pc}} {{path/to/device}}` + +- Install GRUB on an UEFI system: + +`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --bootloader-id={{GRUB}}` + +- Install GRUB pre-loading specific modules: + +`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --modules="{{part_gpt part_msdos}}"` diff --git a/linux/grub-mkconfig b/linux/grub-mkconfig new file mode 100644 index 00000000..29d88320 --- /dev/null +++ b/linux/grub-mkconfig @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-mkconfig + +> Generate a GRUB configuration file. +> More information: . + +- Do a dry run and print the configuration to `stdout`: + +`sudo grub-mkconfig` + +- Generate the configuration file: + +`sudo grub-mkconfig --output={{/boot/grub/grub.cfg}}` + +- Display help: + +`grub-mkconfig --help` diff --git a/linux/grub-reboot b/linux/grub-reboot new file mode 100644 index 00000000..b34bc00f --- /dev/null +++ b/linux/grub-reboot @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-reboot + +> Set the default boot entry for GRUB, for the next boot only. +> More information: . + +- Set the default boot entry to an entry number, name or identifier for the next boot: + +`sudo grub-reboot {{entry_number}}` + +- 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}}` diff --git a/linux/grub-script-check b/linux/grub-script-check new file mode 100644 index 00000000..c0c1e362 --- /dev/null +++ b/linux/grub-script-check @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-script-check + +> 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: . + +- Check a specific script file for syntax errors: + +`grub-script-check {{path/to/grub_config_file}}` + +- Display each line of input after reading it: + +`grub-script-check --verbose` + +- Display help: + +`grub-script-check --help` + +- Display version: + +`grub-script-check --version` diff --git a/linux/grub-set-default b/linux/grub-set-default new file mode 100644 index 00000000..ab8b83bb --- /dev/null +++ b/linux/grub-set-default @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# grub-set-default + +> Set the default boot entry for GRUB. +> More information: . + +- Set the default boot entry to an entry number, name or identifier: + +`sudo grub-set-default {{entry_number}}` + +- 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}}` diff --git a/linux/gs b/linux/gs new file mode 100644 index 00000000..6a48b2e1 --- /dev/null +++ b/linux/gs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gs + +> GhostScript is a PDF and PostScript interpreter. +> More information: . + +- To view a file: + +`gs -dQUIET -dBATCH {{file.pdf}}` + +- Reduce PDF file size to 150 dpi images for reading on a e-book device: + +`gs -dNOPAUSE -dQUIET -dBATCH -sDEVICE=pdfwrite -dPDFSETTINGS=/ebook -sOutputFile={{output.pdf}} {{input.pdf}}` + +- Convert PDF file (pages 1 through 3) to an image with 150 dpi resolution: + +`gs -dQUIET -dBATCH -dNOPAUSE -sDEVICE=jpeg -r150 -dFirstPage={{1}} -dLastPage={{3}} -sOutputFile={{output_%d.jpg}} {{input.pdf}}` + +- Extract pages from a PDF file: + +`gs -dQUIET -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile={{output.pdf}} {{input.pdf}}` + +- Merge PDF files: + +`gs -dQUIET -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile={{output.pdf}} {{input1.pdf}} {{input2.pdf}}` + +- Convert from PostScript file to PDF file: + +`gs -dQUIET -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile={{output.pdf}} {{input.ps}}` diff --git a/linux/gsettings b/linux/gsettings new file mode 100644 index 00000000..8b7cb924 --- /dev/null +++ b/linux/gsettings @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gsettings + +> Query and modify dconf settings with schema validation. +> More information: . + +- Set the value of a key. Fails if the key doesn't exist or the value is out of range: + +`gsettings set {{org.example.schema}} {{example-key}} {{value}}` + +- Print the value of a key or the schema-provided default if the key has not been set in `dconf`: + +`gsettings get {{org.example.schema}} {{example-key}}` + +- Unset a key, so that its schema default value will be used: + +`gsettings reset {{org.example.schema}} {{example-key}}` + +- Display all (non-relocatable) schemas, keys, and values: + +`gsettings list-recursively` + +- Display all keys and values (default if not set) from one schema: + +`gsettings list-recursively {{org.example.schema}}` + +- Display schema-allowed values for a key (helpful with enum keys): + +`gsettings range {{org.example.schema}} {{example-key}}` + +- Display the human-readable description of a key: + +`gsettings describe {{org.example.schema}} {{example-key}}` diff --git a/linux/guake b/linux/guake new file mode 100644 index 00000000..925adc69 --- /dev/null +++ b/linux/guake @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# guake + +> A drop-down terminal for GNOME. +> More information: . + +- Toggle Guake visibility: + +`F12` + +- Toggle fullscreen mode: + +`F11` + +- Open a new tab: + +` + +T` + +- Close the terminal: + +` + X` + +- Go to the previous tab: + +` + ` + +- Search the selected text in the browser: + +` + + L` diff --git a/linux/guix-package b/linux/guix-package new file mode 100644 index 00000000..9092ea16 --- /dev/null +++ b/linux/guix-package @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# guix package + +> Install, upgrade and remove Guix packages, or rollback to previous configurations. +> More information: . + +- Install a new package: + +`guix package -i {{package}}` + +- Remove a package: + +`guix package -r {{package}}` + +- Search the package database for a regular expression: + +`guix package -s "{{search_pattern}}"` + +- List installed packages: + +`guix package -I` + +- List generations: + +`guix package -l` + +- Roll back to the previous generation: + +`guix package --roll-back` diff --git a/linux/gummy b/linux/gummy new file mode 100644 index 00000000..e8f77ea3 --- /dev/null +++ b/linux/gummy @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gummy + +> Screen brightness/temperature manager for Linux/X11. +> More information: . + +- Set the screen temperature to 3000K: + +`gummy --temperature {{3000}}` + +- Set the screen backlight to 50%: + +`gummy --backlight {{50}}` + +- Set the screen pixel brightness to 45%: + +`gummy --brightness {{45}}` + +- Increase current screen pixel brightness by 10%: + +`gummy --brightness {{+10}}` + +- Decrease current screen pixel brightness by 10%: + +`gummy --brightness {{-10}}` + +- Set the temperature and pixel brightness for the second screen: + +`gummy --screen {{1}} --temperature {{3800}} --brightness {{65}}` diff --git a/linux/gzexe b/linux/gzexe new file mode 100644 index 00000000..67a18307 --- /dev/null +++ b/linux/gzexe @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gzexe + +> Compress executable files while keeping them executable. +> Back up the original file, appending `~` to its name and create a shell script that uncompresses and executes the binary inside it. +> More information: . + +- Compress an executable file in-place: + +`gzexe {{path/to/executable}}` + +- Decompress a compressed executable in-place (i.e. convert the shell script back to an uncompressed binary): + +`gzexe -d {{path/to/compressed_executable}}` diff --git a/linux/halt b/linux/halt new file mode 100644 index 00000000..9b3c8da7 --- /dev/null +++ b/linux/halt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# halt + +> Halt the system. +> More information: . + +- Halt the system: + +`halt` + +- Power off the system (same as `poweroff`): + +`halt --poweroff` + +- Reboot the system (same as `reboot`): + +`halt --reboot` + +- Halt immediately without contacting the system manager: + +`halt --force` + +- Write the wtmp shutdown entry without halting the system: + +`halt --wtmp-only` diff --git a/linux/handlr b/linux/handlr new file mode 100644 index 00000000..c44a47c8 --- /dev/null +++ b/linux/handlr @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# handlr + +> Manage your default applications. +> More information: . + +- Open a URL in the default application: + +`handlr open {{https://example.com}}` + +- Open a PDF in the default PDF viewer: + +`handlr open {{path/to/file.pdf}}` + +- Set `imv` as the default application for PNG files: + +`handlr set {{.png}} {{imv.desktop}}` + +- Set MPV as the default application for all audio files: + +`handlr set {{'audio/*'}} {{mpv.desktop}}` + +- List all default apps: + +`handlr list` + +- Print the default application for PNG files: + +`handlr get {{.png}}` diff --git a/linux/hardinfo b/linux/hardinfo new file mode 100644 index 00000000..c701a197 --- /dev/null +++ b/linux/hardinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hardinfo + +> Show hardware information in GUI window. +> More information: . + +- Start `hardinfo`: + +`hardinfo` + +- Print report to `stdout`: + +`hardinfo -r` + +- Save report to HTML file: + +`hardinfo -r -f html > hardinfo.html` diff --git a/linux/hcitool b/linux/hcitool new file mode 100644 index 00000000..4679bf28 --- /dev/null +++ b/linux/hcitool @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hcitool + +> Monitor, configure connections, and send special commands to Bluetooth devices. +> More information: . + +- Scan for Bluetooth devices: + +`hcitool scan` + +- Output the name of a device, returning its MAC address: + +`hcitool name {{bdaddr}}` + +- Fetch information about a remote Bluetooth device: + +`hcitool info {{bdaddr}}` + +- Check the link quality to a Bluetooth device: + +`hcitool lq {{bdaddr}}` + +- Modify the transmit power level: + +`hcitool tpl {{bdaddr}} {{0|1}}` + +- Display the link policy: + +`hcitool lp` + +- Request authentication with a specific device: + +`hcitool auth {{bdaddr}}` + +- Display local devices: + +`hcitool dev` diff --git a/linux/hdparm b/linux/hdparm new file mode 100644 index 00000000..6f34832f --- /dev/null +++ b/linux/hdparm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hdparm + +> Get and set SATA and IDE hard drive parameters. +> More information: . + +- Request the identification info of a given device: + +`sudo hdparm -I /dev/{{device}}` + +- Get the Advanced Power Management level: + +`sudo hdparm -B /dev/{{device}}` + +- Set the Advanced Power Management value (values 1-127 permit spin-down, and values 128-254 do not): + +`sudo hdparm -B {{1}} /dev/{{device}}` + +- Display the device's current power mode status: + +`sudo hdparm -C /dev/{{device}}` + +- Force a drive to immediately enter standby mode (usually causes a drive to spin down): + +`sudo hdparm -y /dev/{{device}}` + +- Put the drive into idle (low-power) mode, also setting its standby timeout: + +`sudo hdparm -S {{standby_timeout}} {{device}}` + +- Test the read speed of a specific device: + +`sudo hdparm -tT {{device}}` diff --git a/linux/head b/linux/head new file mode 100644 index 00000000..bc808dec --- /dev/null +++ b/linux/head @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# head + +> Output the first part of files. +> More information: . + +- Output the first few lines of a file: + +`head --lines {{count}} {{path/to/file}}` + +- Output the first few bytes of a file: + +`head --bytes {{count}} {{path/to/file}}` + +- Output everything but the last few lines of a file: + +`head --lines -{{count}} {{path/to/file}}` + +- Output everything but the last few bytes of a file: + +`head --bytes -{{count}} {{path/to/file}}` diff --git a/linux/help b/linux/help new file mode 100644 index 00000000..ea3065e6 --- /dev/null +++ b/linux/help @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# help + +> Display information about Bash builtin commands. +> More information: . + +- Display the full list of builtin commands: + +`help` + +- Print instructions on how to use the `while` loop construct: + +`help while` + +- Print instructions on how to use the `for` loop construct: + +`help for` + +- Print instructions on how to use `[[ ]]` for conditional commands: + +`help [[ ]]` + +- Print instruction on how to use `(( ))` to evaluate arithmetic expressions: + +`help \( \)` + +- Print instructions on how to use the `cd` command: + +`help cd` diff --git a/linux/hlint b/linux/hlint new file mode 100644 index 00000000..142dd805 --- /dev/null +++ b/linux/hlint @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hlint + +> Suggest improvements to Haskell code. +> More information: . + +- Display suggestions for a given file: + +`hlint {{path/to/file}} options` + +- Check all Haskell files and generate a report: + +`hlint {{path/to/directory}} --report` + +- Automatically apply most suggestions: + +`hlint {{path/to/file}} --refactor` + +- Display additional options: + +`hlint {{path/to/file}} --refactor-options` + +- Generate a settings file ignoring all outstanding hints: + +`hlint {{path/to/file}} --default > {{.hlint.yaml}}` diff --git a/linux/homectl b/linux/homectl new file mode 100644 index 00000000..6ae5f3f1 --- /dev/null +++ b/linux/homectl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# homectl + +> Create, remove, change or inspect home directories using the systemd-homed service. +> More information: . + +- List user accounts and their associated home directories: + +`homectl list` + +- Create a user account and their associated home directory: + +`sudo homectl create {{username}}` + +- Remove a specific user and the associated home directory: + +`sudo homectl remove {{username}}` + +- Change the password for a specific user: + +`sudo homectl passwd {{username}}` + +- Run a shell or a command with access to a specific home directory: + +`sudo homectl with {{username}} -- {{command}} {{command_arguments}}` + +- Lock or unlock a specific home directory: + +`sudo homectl {{lock|unlock}} {{username}}` + +- Change the disk space assigned to a specific home directory to 100 GiB: + +`sudo homectl resize {{username}} {{100G}}` + +- Display help: + +`homectl --help` diff --git a/linux/homeshick b/linux/homeshick new file mode 100644 index 00000000..c6a93864 --- /dev/null +++ b/linux/homeshick @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# homeshick + +> Synchronize Git dotfiles. +> More information: . + +- Create a new castle: + +`homeshick generate {{castle_name}}` + +- Add a file to your castle: + +`homeshick track {{castle_name}} {{path/to/file}}` + +- Go to a castle: + +`homeshick cd {{castle_name}}` + +- Clone a castle: + +`homeshick clone {{github_username}}/{{repository_name}}` + +- Symlink all files from a castle: + +`homeshick link {{castle_name}}` diff --git a/linux/hostnamectl b/linux/hostnamectl new file mode 100644 index 00000000..ec2cd707 --- /dev/null +++ b/linux/hostnamectl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hostnamectl + +> Get or set the hostname of the computer. +> More information: . + +- Get the hostname of the computer: + +`hostnamectl` + +- Set the hostname of the computer: + +`sudo hostnamectl set-hostname "{{hostname}}"` + +- Set a pretty hostname for the computer: + +`sudo hostnamectl set-hostname --static "{{hostname.example.com}}" && sudo hostnamectl set-hostname --pretty "{{hostname}}"` + +- Reset hostname to its default value: + +`sudo hostnamectl set-hostname --pretty ""` diff --git a/linux/htpdate b/linux/htpdate new file mode 100644 index 00000000..cd13d4b7 --- /dev/null +++ b/linux/htpdate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# htpdate + +> Synchronize local date and time via HTTP headers from web servers. +> More information: . + +- Synchronize date and time: + +`sudo htpdate {{host}}` + +- Perform simulation of synchronization, without any action: + +`htpdate -q {{host}}` + +- Compensate the systematic clock drift: + +`sudo htpdate -x {{host}}` + +- Set time immediate after the synchronization: + +`sudo htpdate -s {{host}}` diff --git a/linux/http-prompt b/linux/http-prompt new file mode 100644 index 00000000..aef1400a --- /dev/null +++ b/linux/http-prompt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# http-prompt + +> An interactive command-line HTTP client featuring autocomplete and syntax highlighting. +> More information: . + +- Launch a session targeting the default URL of or the previous session: + +`http-prompt` + +- Launch a session with a given URL: + +`http-prompt {{http://example.com}}` + +- Launch a session with some initial options: + +`http-prompt {{localhost:8000/api}} --auth {{username:password}}` diff --git a/linux/http_load b/linux/http_load new file mode 100644 index 00000000..724f4ee6 --- /dev/null +++ b/linux/http_load @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# http_load + +> An HTTP benchmarking tool. +> Runs multiple HTTP fetches in parallel to test the throughput of a web server. +> More information: . + +- Emulate 20 requests based on a given URL list file per second for 60 seconds: + +`http_load -rate {{20}} -seconds {{60}} {{path/to/urls.txt}}` + +- Emulate 5 concurrent requests based on a given URL list file for 60 seconds: + +`http_load -parallel {{5}} -seconds {{60}} {{path/to/urls.txt}}` + +- Emulate 1000 requests at 20 requests per second, based on a given URL list file: + +`http_load -rate {{20}} -fetches {{1000}} {{path/to/urls.txt}}` + +- Emulate 1000 requests at 5 concurrent requests at a time, based on a given URL list file: + +`http_load -parallel {{5}} -fetches {{1000}} {{path/to/urls.txt}}` diff --git a/linux/httpie b/linux/httpie new file mode 100644 index 00000000..356d7567 --- /dev/null +++ b/linux/httpie @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# httpie + +> A user friendly HTTP tool. +> More information: . + +- Send a GET request (default method with no request data): + +`http {{https://example.com}}` + +- Send a POST request (default method with request data): + +`http {{https://example.com}} {{hello=World}}` + +- Send a POST request with redirected input: + +`http {{https://example.com}} < {{file.json}}` + +- Send a PUT request with a given JSON body: + +`http PUT {{https://example.com/todos/7}} {{hello=world}}` + +- Send a DELETE request with a given request header: + +`http DELETE {{https://example.com/todos/7}} {{API-Key:foo}}` + +- Show the whole HTTP exchange (both request and response): + +`http -v {{https://example.com}}` + +- Download a file: + +`http --download {{https://example.com}}` + +- Follow redirects and show intermediary requests and responses: + +`http --follow --all {{https://example.com}}` diff --git a/linux/hwclock b/linux/hwclock new file mode 100644 index 00000000..b1edbff2 --- /dev/null +++ b/linux/hwclock @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hwclock + +> Read or change the hardware clock. Usually requires root. +> More information: . + +- Display the current time as reported by the hardware clock: + +`hwclock` + +- Write the current software clock time to the hardware clock (sometimes used during system setup): + +`hwclock --systohc` + +- Write the current hardware clock time to the software clock: + +`hwclock --hctosys` diff --git a/linux/hwinfo b/linux/hwinfo new file mode 100644 index 00000000..5401c70f --- /dev/null +++ b/linux/hwinfo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hwinfo + +> Probe for the hardware present in the system. +> More information: . + +- Get graphics card information: + +`hwinfo --gfxcard` + +- Get network device information: + +`hwinfo --network` + +- List disks and CD-ROM drives, abbreviating the output: + +`hwinfo --short --disk --cdrom` + +- Write all hardware information to a file: + +`hwinfo --all --log {{path/to/file}}` + +- Display help: + +`hwinfo --help` diff --git a/linux/i3 b/linux/i3 new file mode 100644 index 00000000..8ee67bdc --- /dev/null +++ b/linux/i3 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i3 + +> A dynamic tiling window manager. +> More information: . + +- Start i3 (Note that a pre-existing window manager must not be open when this command is run): + +`i3` + +- Open a new terminal window: + +` + ` + +- Create a new workspace: + +` + + {{number}}` + +- Switch to workspace number `n`: + +` + {{n}}` + +- Open new window horizontally: + +` + h` + +- Open new window vertically: + +` + v` + +- Open application (type out application name after executing command): + +` + D` diff --git a/linux/i3-scrot b/linux/i3-scrot new file mode 100644 index 00000000..cf145788 --- /dev/null +++ b/linux/i3-scrot @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i3-scrot + +> Wrapper script around the screenshot utility `scrot` for the i3 window manager. +> The default save location is `~/Pictures` and can be changed in `~/.config/i3-scrot.conf`. +> More information: . + +- Capture a screenshot of the whole screen and save it to the default directory: + +`i3-scrot` + +- Capture a screenshot of the active window: + +`i3-scrot --window` + +- Capture a screenshot of a specific rectangular selection: + +`i3-scrot --select` + +- Capture a screenshot of the whole screen and copy it to the clipboard: + +`i3-scrot --desk-to-clipboard` + +- Capture a screenshot of the active window and copy it to the clipboard: + +`i3-scrot --window-to-clipboard` + +- Capture a screenshot of a specific selection and copy it to the clipboard: + +`i3-scrot --select-to-clipboard` + +- Capture a screenshot of the active window after a delay of 5 seconds: + +`i3-scrot --window {{5}}` diff --git a/linux/i3exit b/linux/i3exit new file mode 100644 index 00000000..5d0b037b --- /dev/null +++ b/linux/i3exit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i3exit + +> Exit the i3 window manager. +> More information: . + +- Log out of i3: + +`i3exit logout` + +- Lock i3: + +`i3exit lock` + +- Shut down the system: + +`i3exit shutdown` + +- Suspend the system: + +`i3exit suspend` + +- Switch to the login screen to log in as a different user: + +`i3exit switch_user` + +- Hibernate the system: + +`i3exit hibernate` + +- Reboot the system: + +`i3exit reboot` diff --git a/linux/i3lock b/linux/i3lock new file mode 100644 index 00000000..ee9a7edf --- /dev/null +++ b/linux/i3lock @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i3lock + +> Simple screen locker built for the i3 window manager. +> More information: . + +- Lock the screen showing a white background: + +`i3lock` + +- Lock the screen with a simple color background (rrggbb format): + +`i3lock --color {{0000ff}}` + +- Lock the screen to a PNG background: + +`i3lock --image {{path/to/file.png}}` + +- Lock the screen and disable the unlock indicator (removes feedback on keypress): + +`i3lock --no-unlock-indicator` + +- Lock the screen and don't hide the mouse pointer: + +`i3lock --pointer {{default}}` + +- Lock the screen to a PNG background tiled over all monitors: + +`i3lock --image {{path/to/file.png}} --tiling` + +- Lock the screen and show the number of failed login attempts: + +`i3lock --show-failed-attempts` diff --git a/linux/i3status b/linux/i3status new file mode 100644 index 00000000..6f651890 --- /dev/null +++ b/linux/i3status @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i3status + +> Status line for the i3 window manager. +> This command is usually called from the i3 configuration file. +> More information: . + +- Print the status line to `stdout` periodically, using the default configuration: + +`i3status` + +- Print the status line to `stdout` periodically, using a specific configuration: + +`i3status -c {{path/to/i3status.conf}}` + +- Display help and version: + +`i3status -h` diff --git a/linux/i7z b/linux/i7z new file mode 100644 index 00000000..5945b807 --- /dev/null +++ b/linux/i7z @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# i7z + +> An Intel CPU (only i3, i5 and i7) realtime reporting tool. +> More information: . + +- Start i7z (needs to be run in superuser mode): + +`sudo i7z` diff --git a/linux/ico b/linux/ico new file mode 100644 index 00000000..0dce9107 --- /dev/null +++ b/linux/ico @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ico + +> Displays an animation of a polyhedron. +> More information: . + +- Display the wireframe of an icosahedron that changes its position every 0.1 seconds: + +`ico -sleep {{0.1}}` + +- Display a solid icosahedron with red faces on a blue background: + +`ico -faces -noedges -colors {{red}} -bg {{blue}}` + +- Display the wireframe of a cube with size 100x100 that moves by +1+2 per frame: + +`ico -obj {{cube}} -size {{100x100}} -delta {{+1+2}}` + +- Display the inverted wireframe of an icosahedron with line width 10 using 5 threads: + +`ico -i -lw {{10}} -threads {{5}}` diff --git a/linux/id3v2 b/linux/id3v2 new file mode 100644 index 00000000..df6368e6 --- /dev/null +++ b/linux/id3v2 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# id3v2 + +> Manages id3v2 tags, converts and lists id3v1. +> More information: . + +- List all genres: + +`id3v2 --list-genres` + +- List all tags of specific files: + +`id3v2 --list-tags {{path/to/file1 path/to/file2 ...}}` + +- Delete all `id3v2` or `id3v1` tags of specific files: + +`id3v2 {{--delete-v2|--delete-v1}} {{path/to/file1 path/to/file2 ...}}` + +- Display help: + +`id3v2 --help` + +- Display version: + +`id3v2 --version` diff --git a/linux/ifdown b/linux/ifdown new file mode 100644 index 00000000..5f73d690 --- /dev/null +++ b/linux/ifdown @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ifdown + +> Disable network interfaces. +> More information: . + +- Disable interface eth0: + +`ifdown {{eth0}}` + +- Disable all interfaces which are enabled: + +`ifdown -a` diff --git a/linux/ifmetric b/linux/ifmetric new file mode 100644 index 00000000..91d99850 --- /dev/null +++ b/linux/ifmetric @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ifmetric + +> An IPv4 route metrics manipulation tool. +> More information: . + +- Set the priority of the specified network interface (a higher number indicates lower priority): + +`sudo ifmetric {{interface}} {{value}}` + +- Reset the priority of the specified network interface: + +`sudo ifmetric {{interface}} {{0}}` diff --git a/linux/iftop b/linux/iftop new file mode 100644 index 00000000..a12b6363 --- /dev/null +++ b/linux/iftop @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iftop + +> Show bandwidth usage on an interface by host. +> More information: . + +- Show the bandwidth usage: + +`sudo iftop` + +- Show the bandwidth usage of a given interface: + +`sudo iftop -i {{interface}}` + +- Show the bandwidth usage with port information: + +`sudo iftop -P` + +- Do not show bar graphs of traffic: + +`sudo iftop -b` + +- Do not look up hostnames: + +`sudo iftop -n` + +- Display help: + +`?` diff --git a/linux/ifup b/linux/ifup new file mode 100644 index 00000000..19caf157 --- /dev/null +++ b/linux/ifup @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ifup + +> Enable network interfaces. +> More information: . + +- Enable interface eth0: + +`ifup {{eth0}}` + +- Enable all the interfaces defined with "auto" in `/etc/network/interfaces`: + +`ifup -a` diff --git a/linux/ikaros b/linux/ikaros new file mode 100644 index 00000000..1988eea1 --- /dev/null +++ b/linux/ikaros @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ikaros + +> Vanilla OS Tool for managing drivers for your device. +> More information: . + +- Interactively install drivers for your device: + +`ikaros install {{device}}` + +- Automatically install the recommended drivers for your device: + +`ikaros auto-install {{device}}` + +- List devices: + +`ikaros list-devices` diff --git a/linux/img2txt b/linux/img2txt new file mode 100644 index 00000000..f1a48e91 --- /dev/null +++ b/linux/img2txt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# img2txt + +> Convert images to colour ASCII characters and output them to text-based coloured files. +> More information: . + +- Set output column count to a specific value: + +`img2txt --width={{10}}` + +- Set output line count to a specific value: + +`img2txt --height={{5}}` + +- Set output font width to a specific value: + +`img2txt --font-width={{12}}` + +- Set output font height to a specific value: + +`img2txt --font-height={{14}}` + +- Set image brightness to a specific value: + +`img2txt --brightness={{2}}` diff --git a/linux/imgp b/linux/imgp new file mode 100644 index 00000000..a0c00f05 --- /dev/null +++ b/linux/imgp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# imgp + +> Command-line image resizer and rotator for JPEG and PNG images. +> More information: . + +- Convert single images and/or whole directories containing valid image formats: + +`imgp -x {{1366x1000}} {{path/to/directory}} {{path/to/file}}` + +- Scale an image by 75% and overwrite the source image to a target resolution: + +`imgp -x {{75}} -w {{path/to/file}}` + +- Rotate an image clockwise by 90 degrees: + +`imgp -o {{90}} {{path/to/file}}` diff --git a/linux/inotifywait b/linux/inotifywait new file mode 100644 index 00000000..7ad0302d --- /dev/null +++ b/linux/inotifywait @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# inotifywait + +> Waits for changes to files. +> More information: . + +- Watch a specific file for events, exiting after the first one: + +`inotifywait {{path/to/file}}` + +- Continuously watch a specific file for events without exiting: + +`inotifywait --monitor {{path/to/file}}` + +- Watch a directory recursively for events: + +`inotifywait --monitor --recursive {{path/to/directory}}` + +- Watch a directory for changes, excluding files, whose names match a regular expression: + +`inotifywait --monitor --recursive --exclude "{{regular_expression}}" {{path/to/directory}}` + +- Watch a file for changes, exiting when no event occurs for 30 seconds: + +`inotifywait --monitor --timeout {{30}} {{path/to/file}}` + +- Only watch a file for file modification events: + +`inotifywait --event {{modify}} {{path/to/file}}` + +- Watch a file printing only events, and no status messages: + +`inotifywait --quiet {{path/to/file}}` + +- Run a command when a file is accessed: + +`inotifywait --event {{access}} {{path/to/file}} && {{command}}` diff --git a/linux/insmod b/linux/insmod new file mode 100644 index 00000000..0d5bc592 --- /dev/null +++ b/linux/insmod @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# insmod + +> Dynamically load modules into the Linux Kernel. +> More information: . + +- Insert a kernel module into the Linux kernel: + +`insmod {{path/to/module.ko}}` diff --git a/linux/instaloader b/linux/instaloader new file mode 100644 index 00000000..83d310ee --- /dev/null +++ b/linux/instaloader @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# instaloader + +> Download pictures, videos, captions, and other metadata from Instagram. +> Note: You will need to provide Instagram login information if you want high-quality media downloads. +> More information: . + +- Download a profile: + +`instaloader {{profile_name}}` + +- Download highlights: + +`instaloader --highlights {{profile_name}}` + +- Download posts with geotags (if available), suppressing any user interaction: + +`instaloader --quiet --geotags {{profile_name}}` + +- Specify a user agent for HTTP requests: + +`instaloader --user-agent {{user_agent}} {{profile_name}}` + +- Specify login info and download posts (useful for private profiles): + +`instaloader --login {{username}} --password {{password}} {{profile_name}}` + +- Skip a target if the first downloaded file has been found (useful for updating Instagram archives): + +`instaloader --fast-update {{profile_name}}` + +- Download stories and IGTV videos (login required): + +`instaloader --login {{username}} --password {{password}} --stories --igtv {{profile_name}}` + +- Download all types of posts (login required): + +`instaloader --login {{username}} --password {{password}} --stories --igtv --highlights {{profile_name}}` diff --git a/linux/inxi b/linux/inxi new file mode 100644 index 00000000..9f60945d --- /dev/null +++ b/linux/inxi @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# inxi + +> Print a summary of system information and resources for debugging purposes. +> More information: . + +- Print a summary of CPU, memory, hard drive and kernel information: + +`inxi` + +- Print a full description of CPU, memory, disk, network and process information: + +`inxi -Fz` + +- Print information about the distribution's repository: + +`inxi -r` diff --git a/linux/ionice b/linux/ionice new file mode 100644 index 00000000..bfeb62e4 --- /dev/null +++ b/linux/ionice @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ionice + +> Get or set program I/O scheduling class and priority. +> Scheduling classes: 1 (realtime), 2 (best-effort), 3 (idle). +> Priority levels: 0 (the highest) - 7 (the lowest). +> More information: . + +- Run a command with the given scheduling class and priority: + +`ionice -c {{scheduling_class}} -n {{priority}} {{command}}` + +- Set I/O scheduling [c]lass of a running process with a specific [p]id, [P]gid or [u]id: + +`ionice -c {{scheduling_class}} -{{p|P|u}} {{id}}` + +- Run a command with custom I/O scheduling [c]lass and priority: + +`ionice -c {{scheduling_class}} -n {{priority}} {{command}}` + +- Ignore failure to set the requested priority: + +`ionice -t -n {{priority}} -p {{pid}}` + +- Run the command even in case it was not possible to set the desired priority (this can happen due to insufficient privileges or an old kernel version): + +`ionice -t -n {{priority}} -p {{pid}}` + +- Print the I/O scheduling class and priority of a running process: + +`ionice -p {{pid}}` diff --git a/linux/iostat b/linux/iostat new file mode 100644 index 00000000..d440bfc4 --- /dev/null +++ b/linux/iostat @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iostat + +> Report statistics for devices and partitions. +> More information: . + +- Display a report of CPU and disk statistics since system startup: + +`iostat` + +- Display a report of CPU and disk statistics with units converted to megabytes: + +`iostat -m` + +- Display CPU statistics: + +`iostat -c` + +- Display disk statistics with disk names (including LVM): + +`iostat -N` + +- Display extended disk statistics with disk names for device "sda": + +`iostat -xN {{sda}}` + +- Display incremental reports of CPU and disk statistics every 2 seconds: + +`iostat {{2}}` diff --git a/linux/ip b/linux/ip new file mode 100644 index 00000000..a8e0a46d --- /dev/null +++ b/linux/ip @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip + +> Show/manipulate routing, devices, policy routing and tunnels. +> Some subcommands such as `ip address` have their own usage documentation. +> More information: . + +- List interfaces with detailed info: + +`ip address` + +- List interfaces with brief network layer info: + +`ip -brief address` + +- List interfaces with brief link layer info: + +`ip -brief link` + +- Display the routing table: + +`ip route` + +- Show neighbors (ARP table): + +`ip neighbour` + +- Make an interface up/down: + +`ip link set {{interface}} {{up|down}}` + +- Add/Delete an IP address to an interface: + +`ip addr add/del {{ip}}/{{mask}} dev {{interface}}` + +- Add a default route: + +`ip route add default via {{ip}} dev {{interface}}` diff --git a/linux/ip-address b/linux/ip-address new file mode 100644 index 00000000..994b0539 --- /dev/null +++ b/linux/ip-address @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip address + +> IP Address management subcommand. +> More information: . + +- List network interfaces and their associated IP addresses: + +`ip address` + +- Filter to show only active network interfaces: + +`ip address show up` + +- Display information about a specific network interface: + +`ip address show dev {{eth0}}` + +- Add an IP address to a network interface: + +`ip address add {{ip_address}} dev {{eth0}}` + +- Remove an IP address from a network interface: + +`ip address delete {{ip_address}} dev {{eth0}}` + +- Delete all IP addresses in a given scope from a network interface: + +`ip address flush dev {{eth0}} scope {{global|host|link}}` diff --git a/linux/ip-link b/linux/ip-link new file mode 100644 index 00000000..d46d4a31 --- /dev/null +++ b/linux/ip-link @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip link + +> Manage network interfaces. +> More information: . + +- Show information about all network interfaces: + +`ip link` + +- Show information about a specific network interface: + +`ip link show {{ethN}}` + +- Bring a network interface up or down: + +`ip link set {{ethN}} {{up|down}}` + +- Give a meaningful name to a network interface: + +`ip link set {{ethN}} alias "{{LAN Interface}}"` + +- Change the MAC address of a network interface: + +`ip link set {{ethN}} address {{ff:ff:ff:ff:ff:ff}}` + +- Change the MTU size for a network interface to use jumbo frames: + +`ip link set {{ethN}} mtu {{9000}}` diff --git a/linux/ip-neighbour b/linux/ip-neighbour new file mode 100644 index 00000000..cfdb88d5 --- /dev/null +++ b/linux/ip-neighbour @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip neighbour + +> Neighbour/ARP tables management IP subcommand. +> More information: . + +- Display the neighbour/ARP table entries: + +`ip neighbour` + +- Remove entries in the neighbour table on device `eth0`: + +`sudo ip neighbour flush dev {{eth0}}` + +- Perform a neighbour lookup and return a neighbour entry: + +`ip neighbour get {{lookup_ip}} dev {{eth0}}` + +- Add or delete an ARP entry for the neighbour IP address to `eth0`: + +`sudo ip neighbour {{add|del}} {{ip_address}} lladdr {{mac_address}} dev {{eth0}} nud reachable` + +- Change or replace an ARP entry for the neighbour IP address to `eth0`: + +`sudo ip neighbour {{change|replace}} {{ip_address}} lladdr {{new_mac_address}} dev {{eth0}}` diff --git a/linux/ip-route b/linux/ip-route new file mode 100644 index 00000000..235aab97 --- /dev/null +++ b/linux/ip-route @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip route + +> IP Routing table management subcommand. +> More information: . + +- Display the routing table: + +`ip route {{show|list}}` + +- Add a default route using gateway forwarding: + +`sudo ip route add default via {{gateway_ip}}` + +- Add a default route using `eth0`: + +`sudo ip route add default dev {{eth0}}` + +- Add a static route: + +`sudo ip route add {{destination_ip}} via {{gateway_ip}} dev {{eth0}}` + +- Delete a static route: + +`sudo ip route del {{destination_ip}} dev {{eth0}}` + +- Change or replace a static route: + +`sudo ip route {{change|replace}} {{destination_ip}} via {{gateway_ip}} dev {{eth0}}` + +- Show which route will be used by the kernel to reach an IP address: + +`ip route get {{destination_ip}}` diff --git a/linux/ip-route-list b/linux/ip-route-list new file mode 100644 index 00000000..d686c5f9 --- /dev/null +++ b/linux/ip-route-list @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip route list + +> This command is an alias of `ip route show`. + +- View documentation for the original command: + +`tldr ip-route-show` diff --git a/linux/ip-route-show b/linux/ip-route-show new file mode 100644 index 00000000..dfc2deb2 --- /dev/null +++ b/linux/ip-route-show @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip route show + +> Display subcommand for IP Routing table management. +> More information: . + +- Display the routing table: + +`ip route show` + +- Display the main routing table (same as first example): + +`ip route show {{main|254}}` + +- Display the local routing table: + +`ip route show table {{local|255}}` + +- Display all routing tables: + +`ip route show table {{all|unspec|0}}` + +- List routes from a given device only: + +`ip route show dev {{eth0}}` + +- List routes within a given scope: + +`ip route show scope link` + +- Display the routing cache: + +`ip route show cache` + +- Display only IPv6 or IPv4 routes: + +`ip {{-6|-4}} route show` diff --git a/linux/ip-rule b/linux/ip-rule new file mode 100644 index 00000000..f0d87743 --- /dev/null +++ b/linux/ip-rule @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip rule + +> IP routing policy database management. +> More information: . + +- Display the routing policy: + +`ip rule {{show|list}}` + +- Add a new rule based on packet source addresses: + +`sudo ip rule add from {{192.168.178.2/32}}` + +- Add a new rule based on packet destination addresses: + +`sudo ip rule add to {{192.168.178.2/32}}` + +- Delete a rule based on packet source addresses: + +`sudo ip rule delete from {{192.168.178.2/32}}` + +- Delete a rule based on packet destination addresses: + +`sudo ip rule delete to {{192.168.178.2/32}}` + +- Flush all deleted rules: + +`ip rule flush` + +- Save all rules to a file: + +`ip rule save > {{path/to/ip_rules.dat}}` + +- Restore all rules from a file: + +`ip rule restore < {{path/to/ip_rules.dat}}` diff --git a/linux/ip6tables b/linux/ip6tables new file mode 100644 index 00000000..a3ebbff0 --- /dev/null +++ b/linux/ip6tables @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip6tables + +> This command is an alias of `iptables` for the IPv6 firewall. + +- View documentation for the original command: + +`tldr iptables` diff --git a/linux/ip6tables-restore b/linux/ip6tables-restore new file mode 100644 index 00000000..bf1c4e8a --- /dev/null +++ b/linux/ip6tables-restore @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip6tables-restore + +> This command is an alias of `iptables-restore` for the IPv6 firewall. + +- View documentation for the original command: + +`tldr iptables-restore` diff --git a/linux/ip6tables-save b/linux/ip6tables-save new file mode 100644 index 00000000..b692372f --- /dev/null +++ b/linux/ip6tables-save @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ip6tables-save + +> This command is an alias of `iptables-save` for the IPv6 firewall. + +- View documentation for the original command: + +`tldr iptables-save` diff --git a/linux/ipcalc b/linux/ipcalc new file mode 100644 index 00000000..74820258 --- /dev/null +++ b/linux/ipcalc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ipcalc + +> Perform simple operations and calculations on IP addresses and networks. +> More information: . + +- Show information about an address or network with a given subnet mask: + +`ipcalc {{1.2.3.4}} {{255.255.255.0}}` + +- Show information about an address or network in CIDR notation: + +`ipcalc {{1.2.3.4}}/{{24}}` + +- Show the broadcast address of an address or network: + +`ipcalc -b {{1.2.3.4}}/{{30}}` + +- Show the network address of provided IP address and netmask: + +`ipcalc -n {{1.2.3.4}}/{{24}}` + +- Display geographic information about a given IP address: + +`ipcalc -g {{1.2.3.4}}` diff --git a/linux/ipcmk b/linux/ipcmk new file mode 100644 index 00000000..ea61ece7 --- /dev/null +++ b/linux/ipcmk @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ipcmk + +> Create IPC (Inter-process Communication) resources. +> More information: . + +- Create a shared memory segment: + +`ipcmk --shmem {{segment_size_in_bytes}}` + +- Create a semaphore: + +`ipcmk --semaphore {{element_size}}` + +- Create a message queue: + +`ipcmk --queue` + +- Create a shared memory segment with specific permissions (default is 0644): + +`ipcmk --shmem {{segment_size_in_bytes}} {{octal_permissions}}` diff --git a/linux/ipcrm b/linux/ipcrm new file mode 100644 index 00000000..8325e371 --- /dev/null +++ b/linux/ipcrm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ipcrm + +> Delete IPC (Inter-process Communication) resources. +> More information: . + +- Delete a shared memory segment by ID: + +`ipcrm --shmem-id {{shmem_id}}` + +- Delete a shared memory segment by key: + +`ipcrm --shmem-key {{shmem_key}}` + +- Delete an IPC queue by ID: + +`ipcrm --queue-id {{ipc_queue_id}}` + +- Delete an IPC queue by key: + +`ipcrm --queue-key {{ipc_queue_key}}` + +- Delete a semaphore by ID: + +`ipcrm --semaphore-id {{semaphore_id}}` + +- Delete a semaphore by key: + +`ipcrm --semaphore-key {{semaphore_key}}` + +- Delete all IPC resources: + +`ipcrm --all` diff --git a/linux/ipset b/linux/ipset new file mode 100644 index 00000000..703ea79a --- /dev/null +++ b/linux/ipset @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ipset + +> A tool to create IP sets for firewall rules. +> More information: . + +- Create an empty IP set which will contain IP addresses: + +`ipset create {{set_name}} hash:ip` + +- Destroy a specific IP set: + +`ipset destroy {{set_name}}` + +- Add an IP address to a specific set: + +`ipset add {{set_name}} {{192.168.1.25}}` + +- Delete a specific IP address from a set: + +`ipset del {{set_name}} {{192.168.1.25}}` + +- Save an IP set: + +`ipset save {{set_name}} > {{path/to/ip_set}}` diff --git a/linux/iptables b/linux/iptables new file mode 100644 index 00000000..c1a6b81f --- /dev/null +++ b/linux/iptables @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iptables + +> Configure tables, chains and rules of the Linux kernel IPv4 firewall. +> Use `ip6tables` to set rules for IPv6 traffic. See also: `iptables-save`, `iptables-restore`. +> More information: . + +- View chains, rules, packet/byte counters and line numbers for the filter table: + +`sudo iptables --verbose --numeric --list --line-numbers` + +- Set chain [P]olicy rule: + +`sudo iptables --policy {{chain}} {{rule}}` + +- [A]ppend rule to chain policy for IP: + +`sudo iptables --append {{chain}} --source {{ip}} --jump {{rule}}` + +- [A]ppend rule to chain policy for IP considering [p]rotocol and port: + +`sudo iptables --append {{chain}} --source {{ip}} --protocol {{tcp|udp|icmp|...}} --dport {{port}} --jump {{rule}}` + +- Add a NAT rule to translate all traffic from the `192.168.0.0/24` subnet to the host's public IP: + +`sudo iptables --table {{nat}} --append {{POSTROUTING}} --source {{192.168.0.0/24}} --jump {{MASQUERADE}}` + +- [D]elete chain rule: + +`sudo iptables --delete {{chain}} {{rule_line_number}}` diff --git a/linux/iptables-restore b/linux/iptables-restore new file mode 100644 index 00000000..ad5bda23 --- /dev/null +++ b/linux/iptables-restore @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iptables-restore + +> Restore the `iptables` IPv4 configuration. +> Use `ip6tables-restore` to do the same for IPv6. +> More information: . + +- Restore the `iptables` configuration from a file: + +`sudo iptables-restore {{path/to/file}}` diff --git a/linux/iptables-save b/linux/iptables-save new file mode 100644 index 00000000..42f5487e --- /dev/null +++ b/linux/iptables-save @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iptables-save + +> Save the `iptables` IPv4 configuration. +> Use `ip6tables-save` to to the same for IPv6. +> More information: . + +- Print the `iptables` configuration: + +`sudo iptables-save` + +- Print the `iptables` configuration of a specific [t]able: + +`sudo iptables-save --table {{table}}` + +- Save the `iptables` configuration to a [f]ile: + +`sudo iptables-save --file {{path/to/file}}` diff --git a/linux/isoinfo b/linux/isoinfo new file mode 100644 index 00000000..fcfeb555 --- /dev/null +++ b/linux/isoinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# isoinfo + +> Utility programs for dumping and verifying ISO disk images. +> More information: . + +- List all the files included in an ISO image: + +`isoinfo -f -i {{path/to/image.iso}}` + +- E[x]tract a specific file from an ISO image and send it out `stdout`: + +`isoinfo -i {{path/to/image.iso}} -x {{/PATH/TO/FILE/INSIDE/ISO.EXT}}` + +- Show header information for an ISO disk image: + +`isoinfo -d -i {{path/to/image.iso}}` diff --git a/linux/isosize b/linux/isosize new file mode 100644 index 00000000..74d1c35c --- /dev/null +++ b/linux/isosize @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# isosize + +> Display the size of an ISO file. +> More information: . + +- Display the size of an ISO file: + +`isosize {{path/to/file.iso}}` + +- Display the block count and block size of an ISO file: + +`isosize --sectors {{path/to/file.iso}}` + +- Display the size of an ISO file divided by a given number (only usable when --sectors is not given): + +`isosize --divisor={{number}} {{path/to/file.iso}}` diff --git a/linux/ispell b/linux/ispell new file mode 100644 index 00000000..ba4fa257 --- /dev/null +++ b/linux/ispell @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ispell + +> Interactive spell checking. +> More information: . + +- Start an interactive session: + +`ispell` + +- Check for typos in the specified file and interactively apply suggestions: + +`ispell {{path/to/file}}` + +- Display version: + +`ispell -v` diff --git a/linux/iw b/linux/iw new file mode 100644 index 00000000..6df15181 --- /dev/null +++ b/linux/iw @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iw + +> Show and manipulate wireless devices. +> More information: . + +- Scan for available wireless networks: + +`iw dev {{wlp}} scan` + +- Join an open wireless network: + +`iw dev {{wlp}} connect {{SSID}}` + +- Close the current connection: + +`iw dev {{wlp}} disconnect` + +- Show information about the current connection: + +`iw dev {{wlp}} link` diff --git a/linux/iwconfig b/linux/iwconfig new file mode 100644 index 00000000..5fdab57d --- /dev/null +++ b/linux/iwconfig @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iwconfig + +> Configure and show the parameters of a wireless network interface. +> More information: . + +- Show the parameters and statistics of all the interfaces: + +`iwconfig` + +- Show the parameters and statistics of the specified interface: + +`iwconfig {{interface}}` + +- Set the ESSID (network name) of the specified interface (e.g. eth0 or wlp2s0): + +`iwconfig {{interface}} {{new_network_name}}` + +- Set the operating mode of the specified interface: + +`iwconfig {{interface}} mode {{ad hoc|Managed|Master|Repeater|Secondary|Monitor|Auto}}` diff --git a/linux/iwctl b/linux/iwctl new file mode 100644 index 00000000..70bb8094 --- /dev/null +++ b/linux/iwctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# iwctl + +> Control the `iwd` network supplicant. +> More information: . + +- Start the interactive mode, in this mode you can enter the commands directly, with autocompletion: + +`iwctl` + +- Call general help: + +`iwctl --help` + +- Display your Wi-Fi stations: + +`iwctl station list` + +- Start looking for networks with a station: + +`iwctl station {{station}} scan` + +- Display the networks found by a station: + +`iwctl station {{station}} get-networks` + +- Connect to a network with a station, if credentials are needed they will be asked: + +`iwctl station {{station}} connect {{network_name}}` diff --git a/linux/jhead b/linux/jhead new file mode 100644 index 00000000..39d89b38 --- /dev/null +++ b/linux/jhead @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# jhead + +> Image timestamp and EXIF data manipulation. +> More information: . + +- Show all EXIF data: + +`jhead {{path/to/image.jpg}}` + +- Set the file's date and time to the EXIF create date (file creation date will be changed): + +`jhead -ft {{path/to/image.jpg}}` + +- Set the EXIF time to the file's date and time (EXIF data will be changed): + +`jhead -dsft {{path/to/image.jpg}}` + +- Rename all JPEG files based on the EXIF create date to `YYYY_MM_DD-HH_MM_SS.jpg`: + +`jhead -n%Y_%m_%d-%H_%M_%S *.jpg` + +- Rotate losslessly all JPEG images by 90, 180 or 270 based on the EXIF orientation tag: + +`jhead -autorot *.jpg` + +- Update all EXIF timestamps (Format: +- hour:minute:seconds) (example: forgot to change the camera's time zone - removing 1 hour from timestamps): + +`jhead -ta-1:00:00 *.jpg` + +- Remove all EXIF data (including thumbnails): + +`jhead -purejpg {{path/to/image.jpg}}` diff --git a/linux/jobs b/linux/jobs new file mode 100644 index 00000000..20f4fc08 --- /dev/null +++ b/linux/jobs @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# jobs + +> Shell builtin for viewing information about processes spawned by the current shell. +> Options other than `-l` and `-p` are exclusive to `bash`. +> More information: . + +- View jobs spawned by the current shell: + +`jobs` + +- List jobs and their process IDs: + +`jobs -l` + +- Display information about jobs with changed status: + +`jobs -n` + +- Display only process IDs: + +`jobs -p` + +- Display running processes: + +`jobs -r` + +- Display stopped processes: + +`jobs -s` diff --git a/linux/journalctl b/linux/journalctl new file mode 100644 index 00000000..ed0f4885 --- /dev/null +++ b/linux/journalctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# journalctl + +> Query the systemd journal. +> More information: . + +- Show all messages with priority level 3 (errors) from this [b]oot: + +`journalctl -b --priority={{3}}` + +- Delete journal logs which are older than 2 days: + +`journalctl --vacuum-time={{2d}}` + +- [f]ollow new messages (like `tail -f` for traditional syslog): + +`journalctl -f` + +- Show all messages by a specific [u]nit: + +`journalctl -u {{unit}}` + +- Show logs for a given unit since the last time it started: + +`journalctl _SYSTEMD_INVOCATION_ID=$(systemctl show --value --property=InvocationID {{unit}})` + +- Filter messages within a time range (either timestamp or placeholders like "yesterday"): + +`journalctl --since {{now|today|yesterday|tomorrow}} --until {{YYYY-MM-DD HH:MM:SS}}` + +- Show all messages by a specific process: + +`journalctl _PID={{pid}}` + +- Show all messages by a specific executable: + +`journalctl {{path/to/executable}}` diff --git a/linux/jpegtran b/linux/jpegtran new file mode 100644 index 00000000..a1d5affd --- /dev/null +++ b/linux/jpegtran @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# jpegtran + +> Perform lossless transformation of JPEG files. +> More information: . + +- Mirror an image horizontally or vertically: + +`jpegtran -flip {{horizontal|vertical}} {{path/to/image.jpg}} > {{path/to/output.jpg}}` + +- Rotate an image 90, 180 or 270 degrees clockwise: + +`jpegtran -rotate {{90|180|270}} {{path/to/image.jpg}} > {{path/to/output.jpg}}` + +- Transpose the image across the upper-left to lower right axis: + +`jpegtran -transpose {{path/to/image.jpg}} > {{path/to/output.jpg}}` + +- Transverse the image across the upper right to lower left axis: + +`jpegtran -transverse {{path/to/image.jpg}} > {{path/to/output.jpg}}` + +- Convert the image to grayscale: + +`jpegtran -grayscale {{path/to/image.jpg}} > {{path/to/output.jpg}}` + +- Crop the image to a rectangular region of width `W` and height `H` from the upper-left corner, saving the output to a specific file: + +`jpegtran -crop {{W}}x{{H}} -outfile {{path/to/output.jpg}} {{path/to/image.jpg}}` + +- Crop the image to a rectangular region of width `W` and height `H`, starting at point `X` and `Y` from the upper-left corner: + +`jpegtran -crop {{W}}x{{H}}+{{X}}+{{Y}} {{path/to/image.jpg}} > {{path/to/output.jpg}}` diff --git a/linux/just.js b/linux/just.js new file mode 100644 index 00000000..777bd8d3 --- /dev/null +++ b/linux/just.js @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# just + +> A V8 JavaScript runtime for Linux. +> More information: . + +- Start a REPL (interactive shell): + +`just` + +- Run a JavaScript file: + +`just {{path/to/file.js}}` + +- Evaluate JavaScript code by passing it as an argument: + +`just eval "{{code}}"` + +- Initialize a new project in a directory of the same name: + +`just init {{project_name}}` + +- Build a JavaScript application into an executable: + +`just build {{path/to/file.js}} --static` diff --git a/linux/kde-inhibit b/linux/kde-inhibit new file mode 100644 index 00000000..8d4673c6 --- /dev/null +++ b/linux/kde-inhibit @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kde-inhibit + +> Inhibit various desktop functions while a command runs. +> More information: . + +- Inhibit power management: + +`kde-inhibit --power {{command}} {{command_arguments}}` + +- Inhibit screen saver: + +`kde-inhibit --screenSaver {{command}} {{command_arguments}}` + +- Launch VLC, and inhibit color correction (night mode) while it's running: + +`kde-inhibit --colorCorrect {{vlc}}` diff --git a/linux/kdesrc-build b/linux/kdesrc-build new file mode 100644 index 00000000..eb5cd244 --- /dev/null +++ b/linux/kdesrc-build @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kdesrc-build + +> Easily build KDE components from its source repositories. +> More information: . + +- Initialize `kdesrc-build`: + +`kdesrc-build --initial-setup` + +- Compile a KDE component and its dependencies from source: + +`kdesrc-build {{component_name}}` + +- Compile a component without updating its local code and without compiling its dependencies: + +`kdesrc-build --no-src --no-include-dependencies {{component_name}}` + +- Refresh the build directories before compiling: + +`kdesrc-build --refresh-build {{component_name}}` + +- Resume compilation from a specific dependency: + +`kdesrc-build --resume-from={{dependency_component}} {{component_name}}` + +- Print full compilation info: + +`kdesrc-build --debug {{component_name}}` + +- Build all configured components: + +`kdesrc-build` + +- Use system libraries in place of a component if it fails to build: + +`kdesrc-build --no-stop-on-failure {{component_name}}` diff --git a/linux/kdesrc-run b/linux/kdesrc-run new file mode 100644 index 00000000..4d1d8bb1 --- /dev/null +++ b/linux/kdesrc-run @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kdesrc-run + +> Run KDE components that have been built with `kdesrc-build`. +> More information: . + +- Run a component: + +`kdesrc-run {{component_name}}` diff --git a/linux/kdialog b/linux/kdialog new file mode 100644 index 00000000..c68783b1 --- /dev/null +++ b/linux/kdialog @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kdialog + +> Show KDE dialog boxes from within shell scripts. +> More information: . + +- Open a dialog box displaying a specific message: + +`kdialog --msgbox "{{message}}" "{{optional_detailed_message}}"` + +- Open a question dialog with a `yes` and `no` button, returning `0` and `1`, respectively: + +`kdialog --yesno "{{message}}"` + +- Open a warning dialog with a `yes`, `no`, and `cancel` button, returning `0`, `1`, or `2` respectively: + +`kdialog --warningyesnocancel "{{message}}"` + +- Open an input dialog box and print the input to `stdout` when `OK` is pressed: + +`kdialog --inputbox "{{message}}" "{{optional_default_text}}"` + +- Open a dialog to prompt for a specific password and print it to `stdout`: + +`kdialog --password "{{message}}"` + +- Open a dialog containing a specific dropdown menu and print the selected item to `stdout`: + +`kdialog --combobx "{{message}}" "{{item1}}" "{{item2}}" "{{...}}"` + +- Open a file chooser dialog and print the selected file's path to `stdout`: + +`kdialog --getopenfilename` + +- Open a progressbar dialog and print a DBUS reference for communication to `stdout`: + +`kdialog --progressbar "{{message}}"` diff --git a/linux/kdocker b/linux/kdocker new file mode 100644 index 00000000..8476a88a --- /dev/null +++ b/linux/kdocker @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kdocker + +> Easily dock applications to the system tray. +> More information: . + +- Display a cursor to send a window to the system tray when pressing the left mouse button (press any other mouse button to cancel): + +`kdocker` + +- Open an application and send it to the system tray: + +`kdocker {{application}}` + +- Send focused window to the system tray: + +`kdocker -f` + +- 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}}` + +- Open an application, send it to the system tray and if focus is lost, minimize it: + +`kdocker -l {{application}}` + +- Display version: + +`kdocker --version` diff --git a/linux/kernel-install b/linux/kernel-install new file mode 100644 index 00000000..62658fdc --- /dev/null +++ b/linux/kernel-install @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kernel-install + +> Add and remove kernel and initrd images to and from `/boot`. +> More information: . + +- Add kernel and initramfs images to bootloader partition: + +`sudo kernel-install add {{kernel-version}} {{kernel-image}} {{path/to/initrd-file ...}}` + +- Remove kernel from the bootloader partition: + +`sudo kernel-install remove {{kernel-version}}` + +- Show various paths and parameters that have been configured or auto-detected: + +`sudo kernel-install inspect {{kernel-image}}` diff --git a/linux/kexec b/linux/kexec new file mode 100644 index 00000000..3c7240f2 --- /dev/null +++ b/linux/kexec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kexec + +> Directly reboot into a new kernel. +> More information: . + +- Load a new kernel: + +`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --command-line={{arguments}}` + +- Load a new kernel with current boot parameters: + +`kexec -l {{path/to/kernel}} --initrd={{path/to/initrd}} --reuse-cmdline` + +- Execute a currently loaded kernel: + +`kexec -e` + +- Unload current kexec target kernel: + +`kexec -u` diff --git a/linux/keyctl b/linux/keyctl new file mode 100644 index 00000000..1a87b77f --- /dev/null +++ b/linux/keyctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# keyctl + +> Manipulate the Linux kernel keyring. +> More information: . + +- List keys in a specific keyring: + +`keyctl list {{target_keyring}}` + +- List current keys in the user default session: + +`keyctl list {{@us}}` + +- Store a key in a specific keyring: + +`keyctl add {{type_keyring}} {{key_name}} {{key_value}} {{target_keyring}}` + +- Store a key with its value from `stdin`: + +`echo -n {{key_value}} | keyctl padd {{type_keyring}} {{key_name}} {{target_keyring}}` + +- Put a timeout on a key: + +`keyctl timeout {{key_name}} {{timeout_in_seconds}}` + +- Read a key and format it as a hex-dump if not printable: + +`keyctl read {{key_name}}` + +- Read a key and format as-is: + +`keyctl pipe {{key_name}}` + +- Revoke a key and prevent any further action on it: + +`keyctl revoke {{key_name}}` diff --git a/linux/kill b/linux/kill new file mode 100644 index 00000000..0d2105ad --- /dev/null +++ b/linux/kill @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kill + +> Sends a signal to a process, usually related to stopping the process. +> All signals except for SIGKILL and SIGSTOP can be intercepted by the process to perform a clean exit. +> More information: . + +- Terminate a program using the default SIGTERM (terminate) signal: + +`kill {{process_id}}` + +- List signal values and their corresponding names (to be used without the `SIG` prefix): + +`kill -{{L|-table}}` + +- Terminate a background job: + +`kill %{{job_id}}` + +- Terminate a program using the SIGHUP (hang up) signal. Many daemons will reload instead of terminating: + +`kill -{{1|HUP}} {{process_id}}` + +- Terminate a program using the SIGINT (interrupt) signal. This is typically initiated by the user pressing `Ctrl + C`: + +`kill -{{2|INT}} {{process_id}}` + +- Signal the operating system to immediately terminate a program (which gets no chance to capture the signal): + +`kill -{{9|KILL}} {{process_id}}` + +- Signal the operating system to pause a program until a SIGCONT ("continue") signal is received: + +`kill -{{17|STOP}} {{process_id}}` + +- Send a `SIGUSR1` signal to all processes with the given GID (group id): + +`kill -{{SIGUSR1}} -{{group_id}}` diff --git a/linux/killall b/linux/killall new file mode 100644 index 00000000..93db22bd --- /dev/null +++ b/linux/killall @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# killall + +> Send kill signal to all instances of a process by name (must be exact name). +> All signals except SIGKILL and SIGSTOP can be intercepted by the process, allowing a clean exit. +> More information: . + +- Terminate a process using the default SIGTERM (terminate) signal: + +`killall {{process_name}}` + +- List available signal names (to be used without the 'SIG' prefix): + +`killall --list` + +- Interactively ask for confirmation before termination: + +`killall -i {{process_name}}` + +- Terminate a process using the SIGINT (interrupt) signal, which is the same signal sent by pressing `Ctrl + C`: + +`killall -INT {{process_name}}` + +- Force kill a process: + +`killall -KILL {{process_name}}` diff --git a/linux/kjv b/linux/kjv new file mode 100644 index 00000000..966a3272 --- /dev/null +++ b/linux/kjv @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kjv + +> The word of God available right on your desktop. +> More information: . + +- Display books: + +`kjv -l` + +- Open a specific book: + +`kjv {{Genesis}}` + +- Open a specific chapter of a book: + +`kjv {{Genesis}} {{2}}` + +- Open a specific verse of a specific chapter of a book: + +`kjv {{John}} {{3}}:{{16}}` + +- Open a specific range of verses of a book's chapter: + +`kjv {{Proverbs}} {{3}}:{{1-6}}` + +- Display a specific range of verses of a book from different chapters: + +`kjv {{Matthew}} {{1}}:{{7}}-{{2}}:{{6}}` + +- Display all verses that match a pattern: + +`kjv /{{Plagues}}` + +- Display all verses that match a pattern in a specific book: + +`kjv {{1Jn}}/{{antichrist}}` diff --git a/linux/konsave b/linux/konsave new file mode 100644 index 00000000..e6519b13 --- /dev/null +++ b/linux/konsave @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# konsave + +> Save and apply your Linux customizations with just one command. +> More information: . + +- Save the current configuration as a profile: + +`konsave --save {{profile_name}}` + +- Apply a profile: + +`konsave --apply {{profile_name}}` + +- Save the current configuration as a profile, overwriting existing profiles if they exist with the same name: + +`konsave -s {{profile_name}} --force` + +- List all profiles: + +`konsave --list` + +- Remove a profile: + +`konsave --remove {{profile_name}}` + +- Export a profile as a `.knsv` to the home directory: + +`konsave --export-profile {{profile_name}}` + +- Import a `.knsv` profile: + +`konsave --import-profile {{path/to/profile_name.knsv}}` diff --git a/linux/konsole b/linux/konsole new file mode 100644 index 00000000..1f0d3290 --- /dev/null +++ b/linux/konsole @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# konsole + +> KDE's terminal emulator. +> More information: . + +- Open the terminal in a specific directory: + +`konsole --workdir {{path/to/directory}}` + +- [e]xecute a specific command and don't close the window after it exits: + +`konsole --noclose -e "{{command}}"` + +- Open a new tab: + +`konsole --new-tab` + +- Open the terminal in the background and bring to the front when `Ctrl+Shift+F12` is pressed: + +`konsole --background-mode` diff --git a/linux/kpackagetool5 b/linux/kpackagetool5 new file mode 100644 index 00000000..7e133d53 --- /dev/null +++ b/linux/kpackagetool5 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kpackagetool5 + +> KPackage Manager: install, list, remove Plasma packages. +> More information: . + +- List all known package types that can be installed: + +`kpackagetool5 --list-types` + +- Install the package from a directory: + +`kpackagetool5 --type {{package_type}} --install {{path/to/directory}}` + +- Update installed package from a directory: + +`kpackagetool5 --type {{package_type}} --upgrade {{path/to/directory}}` + +- List installed plasmoids (--global for all users): + +`kpackagetool5 --type Plasma/Applet --list --global` + +- Remove a plasmoid by name: + +`kpackagetool5 --type Plasma/Applet --remove "{{name}}"` diff --git a/linux/kpartx b/linux/kpartx new file mode 100644 index 00000000..27557058 --- /dev/null +++ b/linux/kpartx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kpartx + +> Create device maps from partition tables. +> More information: . + +- Add partition mappings: + +`kpartx -a {{whole_disk.img}}` + +- Delete partition mappings: + +`kpartx -d {{whole_disk.img}}` + +- List partition mappings: + +`kpartx -l {{whole_disk.img}}` diff --git a/linux/kreadconfig5 b/linux/kreadconfig5 new file mode 100644 index 00000000..68c37dc3 --- /dev/null +++ b/linux/kreadconfig5 @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kreadconfig5 + +> Read KConfig entries for KDE Plasma. +> More information: . + +- Read a key from the global configuration: + +`kreadconfig5 --group {{group_name}} --key {{key_name}}` + +- Read a key from a specific configuration file: + +`kwriteconfig5 --file {{path/to/file}} --group {{group_name}} --key {{key_name}}` + +- Check if systemd is used to start the Plasma session: + +`kreadconfig5 --file {{startkderc}} --group {{General}} --key {{systemdBoot}}` diff --git a/linux/kscreen-console b/linux/kscreen-console new file mode 100644 index 00000000..e2d14932 --- /dev/null +++ b/linux/kscreen-console @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kscreen-console + +> Command-line tool to query KScreen's status. +> More information: . + +- Show all outputs and configuration files to attach to a bug report: + +`kscreen-console bug` + +- Show paths to KScreen configuration files: + +`kscreen-console config` + +- Show KScreen output information and configuration: + +`kscreen-console outputs` + +- Monitor for changes: + +`kscreen-console monitor` + +- Show the current KScreen configuration as JSON: + +`kscreen-console json` + +- Display help: + +`kscreen-console --help` + +- Display help including Qt specific command-line options: + +`kscreen-console --help-all` diff --git a/linux/kscreen-doctor b/linux/kscreen-doctor new file mode 100644 index 00000000..64ae0d7a --- /dev/null +++ b/linux/kscreen-doctor @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kscreen-doctor + +> Change and manipulate the screen setup. +> More information: . + +- Show display output information: + +`kscreen-doctor --outputs` + +- Set the rotation of a display output with an ID of 1 to the right: + +`kscreen-doctor {{output.1.rotation.right}}` + +- Set the scale of a display output with an ID of `HDMI-2` to 2 (200%): + +`kscreen-doctor {{output.HDMI-2.scale.2}}` diff --git a/linux/ksvgtopng5 b/linux/ksvgtopng5 new file mode 100644 index 00000000..466e0eb1 --- /dev/null +++ b/linux/ksvgtopng5 @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ksvgtopng5 + +> Convert SVG files to PNG format. +> More information: . + +- Convert an SVG file (should be an absolute path) to PNG: + +`ksvgtopng5 {{width}} {{height}} {{path/to/file.svg}} {{output_filename.png}}` diff --git a/linux/kwrite b/linux/kwrite new file mode 100644 index 00000000..f713c61f --- /dev/null +++ b/linux/kwrite @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kwrite + +> Text editor of the KDE Desktop project. +> See also `kate`. +> More information: . + +- Open a text file: + +`kwrite {{path/to/file}}` + +- Open multiple text files: + +`kwrite {{file1 file2 ...}}` + +- Open a text file with a specific encoding: + +`kwrite --encoding={{UTF-8}} {{path/to/file}}` + +- Open a text file and navigate to a specific line and column: + +`kwrite --line {{line_number}} --column {{column_number}} {{path/to/file}}` diff --git a/linux/kwriteconfig5 b/linux/kwriteconfig5 new file mode 100644 index 00000000..6e34f83e --- /dev/null +++ b/linux/kwriteconfig5 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# kwriteconfig5 + +> Write KConfig entries for KDE Plasma. +> More information: . + +- Display help: + +`kwriteconfig5 --help` + +- Set a global configuration key: + +`kwriteconfig5 --group {{group_name}} --key {{key}} {{value}}` + +- Set a key in a specific configuration file: + +`kwriteconfig5 --file {{path/to/file}} --group {{group_name}} --key {{key}} {{value}}` + +- Delete a key: + +`kwriteconfig5 --group {{group_name}} --key {{key}} --delete` + +- Use systemd to start the Plasma session when available: + +`kwriteconfig5 --file {{startkderc}} --group {{General}} --key {{systemdBoot}} {{true}}` + +- Hide the title bar when a window is maximized (like Ubuntu): + +`kwriteconfig5 --file {{~/.config/kwinrc}} --group {{Windows}} --key {{BorderlessMaximizedWindows}} {{true}}` + +- Configure KRunner to open with the Meta (Command/Windows) global hotkey: + +`kwriteconfig5 --file {{~/.config/kwinrc}} --group {{ModifierOnlyShortcuts}} --key {{Meta}} {{"org.kde.kglobalaccel,/component/krunner_desktop,org.kde.kglobalaccel.Component,invokeShortcut,_launch"}}` diff --git a/linux/laptop-detect b/linux/laptop-detect new file mode 100644 index 00000000..979b0442 --- /dev/null +++ b/linux/laptop-detect @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# laptop-detect + +> Attempt to determine if the script is running on a laptop or desktop. +> More information: . + +- Return an exit status of 0 if the current device is likely a laptop, else returns 1: + +`laptop-detect` + +- Print the type of device that the current system is detected as: + +`laptop-detect --verbose` + +- Display version: + +`laptop-detect --version` diff --git a/linux/larasail b/linux/larasail new file mode 100644 index 00000000..4e6627c5 --- /dev/null +++ b/linux/larasail @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# larasail + +> Manage Laravel on Digital Ocean servers. +> More information: . + +- Set up the server with Laravel dependencies using the default PHP version: + +`larasail setup` + +- Set up the server with Laravel dependencies using a specific PHP version: + +`larasail setup {{php71}}` + +- Add a new Laravel site: + +`larasail host {{domain}} {{path/to/site_directory}}` + +- Retrieve the Larasail user password: + +`larasail pass` + +- Retrieve the Larasail MySQL password: + +`larasail mysqlpass` diff --git a/linux/lastb b/linux/lastb new file mode 100644 index 00000000..7ec400e7 --- /dev/null +++ b/linux/lastb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lastb + +> List last logged in users. +> More information: . + +- List last logged in users: + +`sudo lastb` + +- List all last logged in users since a given time: + +`sudo lastb --since {{YYYY-MM-DD}}` + +- List all last logged in users until a given time: + +`sudo lastb --until {{YYYY-MM-DD}}` + +- List all logged in users at a specific time: + +`sudo lastb --present {{hh:mm}}` + +- List all last logged in users and translate the IP into a hostname: + +`sudo lastb --dns` diff --git a/linux/lastcomm b/linux/lastcomm new file mode 100644 index 00000000..aac4ca7e --- /dev/null +++ b/linux/lastcomm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lastcomm + +> Show last commands executed. +> More information: . + +- Print information about all the commands in the acct (record file): + +`lastcomm` + +- Display commands executed by a given user: + +`lastcomm --user {{user}}` + +- Display information about a given command executed on the system: + +`lastcomm --command {{command}}` + +- Display information about commands executed on a given terminal: + +`lastcomm --tty {{terminal_name}}` diff --git a/linux/lastlog b/linux/lastlog new file mode 100644 index 00000000..868a939b --- /dev/null +++ b/linux/lastlog @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lastlog + +> Show the most recent login of all users or of a user. +> More information: . + +- Display the most recent login of all users: + +`lastlog` + +- Display the lastlog record of the specified user: + +`lastlog --user {{username}}` + +- Display records older than 7 days: + +`lastlog --before 7` + +- Display records more recent than 3 days: + +`lastlog --time 3` diff --git a/linux/latte-dock b/linux/latte-dock new file mode 100644 index 00000000..82ca362b --- /dev/null +++ b/linux/latte-dock @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# latte-dock + +> Replacement dock for Plasma desktop. +> More information: . + +- Clear QML cache: + +`latte-dock --clear-cache` + +- Import and load default layout on startup: + +`latte-dock --default-layout` + +- Load a specific layout on startup: + +`latte-dock --layout {{layout_name}}` + +- Import and load a specific layout: + +`latte-dock --import-layout {{path/to/file}}` diff --git a/linux/lchage b/linux/lchage new file mode 100644 index 00000000..da294b9d --- /dev/null +++ b/linux/lchage @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lchage + +> Display or change user password policy. +> More information: . + +- Disable password expiration for the user: + +`sudo lchage --date -1 {{username}}` + +- Display the password policy for the user: + +`sudo lchage --list {{username}}` + +- Require password change for the user a certain number of days after the last password change: + +`sudo lchage --maxdays {{number_of_days}} {{username}}` + +- Start warning the user a certain number of days before the password expires: + +`sudo lchage --warndays {{number_of_days}} {{username}}` diff --git a/linux/lci b/linux/lci new file mode 100644 index 00000000..a62b6b13 --- /dev/null +++ b/linux/lci @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lci + +> LOLCODE interpreter written in C. +> More information: . + +- Run a LOLCODE file: + +`lci {{path/to/file}}` + +- Display help: + +`lci -h` + +- Display version: + +`lci -v` diff --git a/linux/ldapdomaindump b/linux/ldapdomaindump new file mode 100644 index 00000000..35a24f7d --- /dev/null +++ b/linux/ldapdomaindump @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ldapdomaindump + +> Dump users, computers, groups, OS and membership information via LDAP to HTML, JSON and greppable output. +> See also `ldapsearch`. +> More information: . + +- Dump all information using the given LDAP account: + +`ldapdomaindump --user {{domain}}\{{administrator}} --password {{password|ntlm_hash}} {{hostname|ip}}` + +- Dump all information, resolving computer hostnames: + +`ldapdomaindump --resolve --user {{domain}}\{{administrator}} --password {{password}} {{hostname|ip}}` + +- Dump all information, resolving computer hostnames with the selected DNS server: + +`ldapdomaindump --resolve --dns-server {{domain_controller_ip}} --user {{domain}}\{{administrator}} --password {{password}} {{hostname|ip}}` + +- Dump all information to the given directory without JSON output: + +`ldapdomaindump --no-json --outdir {{path/to/directory}} --user {{domain}}\{{administrator}} --password {{password}} {{hostname|ip}}` diff --git a/linux/ldconfig b/linux/ldconfig new file mode 100644 index 00000000..5cb56396 --- /dev/null +++ b/linux/ldconfig @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ldconfig + +> Configure symlinks and cache for shared library dependencies. +> More information: . + +- Update symlinks and rebuild the cache (usually run when a new library is installed): + +`sudo ldconfig` + +- Update the symlinks for a given directory: + +`sudo ldconfig -n {{path/to/directory}}` + +- Print the libraries in the cache and check whether a given library is present: + +`ldconfig -p | grep {{library_name}}` diff --git a/linux/ldd b/linux/ldd new file mode 100644 index 00000000..aa526a0a --- /dev/null +++ b/linux/ldd @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ldd + +> Display shared library dependencies of a binary. +> Do not use on an untrusted binary, use objdump for that instead. +> More information: . + +- Display shared library dependencies of a binary: + +`ldd {{path/to/binary}}` + +- Display all information about dependencies: + +`ldd --verbose {{path/to/binary}}` + +- Display unused direct dependencies: + +`ldd --unused {{path/to/binary}}` + +- Report missing data objects and perform data relocations: + +`ldd --data-relocs {{path/to/binary}}` + +- Report missing data objects and functions, and perform relocations for both: + +`ldd --function-relocs {{path/to/binary}}` diff --git a/linux/lddd b/linux/lddd new file mode 100644 index 00000000..e265fdcd --- /dev/null +++ b/linux/lddd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lddd + +> Find broken library links on the system. +> This tool is only available on Arch Linux. +> More information: . + +- Scan directories to find and list packages with broken library links that need to be rebuilt: + +`lddd` diff --git a/linux/ledctl b/linux/ledctl new file mode 100644 index 00000000..3760e6b9 --- /dev/null +++ b/linux/ledctl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ledctl + +> Intel(R) Enclosure LED Control Application. +> More information: . + +- Turn on the "Locate" LED for specified device(s): + +`sudo ledctl locate={{/dev/sda,/dev/sdb,...}}` + +- Turn off the "Locate" LED for specified device(s): + +`sudo ledctl locate_off={{/dev/sda,/dev/sdb,...}}` + +- Turn off the "Status" LED and "Failure" LED for specified device(s): + +`sudo ledctl off={{/dev/sda,/dev/sdb,...}}` + +- Turn off the "Status" LED, "Failure" LED and "Locate" LED for specified device(s): + +`sudo ledctl normal={{/dev/sda,/dev/sdb,...}}` diff --git a/linux/legit b/linux/legit new file mode 100644 index 00000000..5f77720d --- /dev/null +++ b/linux/legit @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# legit + +> Complementary command-line interface for Git. +> More information: . + +- Switch to a specified branch, stashing and restoring unstaged changes: + +`git switch {{target_branch}}` + +- Synchronize current branch, automatically merging or rebasing, and stashing and unstashing: + +`git sync` + +- Publish a specified branch to the remote server: + +`git publish {{branch_name}}` + +- Remove a branch from the remote server: + +`git unpublish {{branch_name}}` + +- List all branches and their publication status: + +`git branches {{glob_pattern}}` + +- Remove the last commit from the history: + +`git undo {{--hard}}` diff --git a/linux/lex b/linux/lex new file mode 100644 index 00000000..44725c71 --- /dev/null +++ b/linux/lex @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lex + +> Lexical analyzer generator. +> Given the specification for a lexical analyzer, generates C code implementing it. +> More information: . + +- Generate an analyzer from a Lex file, storing it to the file `lex.yy.c`: + +`lex {{analyzer.l}}` + +- Write analyzer to `stdout`: + +`lex -{{-stdout|t}} {{analyzer.l}}` + +- Specify the output file: + +`lex {{analyzer.l}} --outfile {{analyzer.c}}` + +- Generate a [B]atch scanner instead of an interactive scanner: + +`lex -B {{analyzer.l}}` + +- Compile a C file generated by Lex: + +`cc {{path/to/lex.yy.c}} --output {{executable}}` diff --git a/linux/lftp b/linux/lftp new file mode 100644 index 00000000..2affe00a --- /dev/null +++ b/linux/lftp @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lftp + +> Sophisticated file transfer program. +> More information: . + +- Connect to an FTP server: + +`lftp --user {{username}} {{ftp.example.com}}` + +- Download multiple files (glob expression): + +`mget {{path/to/*.png}}` + +- Upload multiple files (glob expression): + +`mput {{path/to/*.zip}}` + +- Delete multiple files on the remote server: + +`mrm {{path/to/*.txt}}` + +- Rename a file on the remote server: + +`mv {{original_filename}} {{new_filename}}` + +- Download or update an entire directory: + +`mirror {{path/to/remote_dir}} {{path/to/local_output_dir}}` + +- Upload or update an entire directory: + +`mirror -R {{path/to/local_dir}} {{path/to/remote_output_dir}}` diff --git a/linux/libreoffice b/linux/libreoffice new file mode 100644 index 00000000..d591391d --- /dev/null +++ b/linux/libreoffice @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# libreoffice + +> CLI for the powerful and free office suite LibreOffice. +> More information: . + +- Open one or more files in read-only mode: + +`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}}` diff --git a/linux/libtool b/linux/libtool new file mode 100644 index 00000000..4b234051 --- /dev/null +++ b/linux/libtool @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# libtool + +> A generic library support script that hides the complexity of using shared libraries behind a consistent, portable interface. +> More information: . + +- Compile a source file into a `libtool` object: + +`libtool --mode=compile gcc -c {{path/to/source.c}} -o {{path/to/source.lo}}` + +- Create a library or an executable: + +`libtool --mode=link gcc -o {{path/to/library.lo}} {{path/to/source.lo}}` + +- Automatically set the library path so that another program can use uninstalled `libtool` generated programs or libraries: + +`libtool --mode=execute gdb {{path/to/program}}` + +- Install a shared library: + +`libtool --mode=install cp {{path/to/library.la}} {{path/to/installation_directory}}` + +- Complete the installation of `libtool` libraries on the system: + +`libtool --mode=finish {{path/to/installation_dir}}` + +- Delete installed libraries or executables: + +`libtool --mode=uninstall {{path/to/installed_library.la}}` + +- Delete uninstalled libraries or executables: + +`libtool --mode=clean rm {{path/to/source.lo}} {{path/to/library.la}}` diff --git a/linux/libtoolize b/linux/libtoolize new file mode 100644 index 00000000..f28533fd --- /dev/null +++ b/linux/libtoolize @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# libtoolize + +> An `autotools` tool to prepare a package for using `libtool`. +> It performs various tasks, including generating necessary files and directories to integrate `libtool` seamlessly into a project. +> More information: . + +- Initialize a project for `libtool` by copying necessary files (avoiding symbolic links) and overwriting existing files if needed: + +`libtoolize --copy --force` diff --git a/linux/libuser-lid b/linux/libuser-lid new file mode 100644 index 00000000..b2bdf4ea --- /dev/null +++ b/linux/libuser-lid @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# libuser-lid + +> Display a user's groups or a group's users. +> On Fedora and Arch Linux, this program is installed as `lid`. +> More information: . + +- List primary and secondary groups of a specific user: + +`sudo lid {{username}}` + +- List users of a specific group: + +`sudo lid --group {{name}}` diff --git a/linux/lid b/linux/lid new file mode 100644 index 00000000..fa3acc3b --- /dev/null +++ b/linux/lid @@ -0,0 +1,15 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lid + +> Note: This page is currently a redirection stub. If you are familiar with this program, please open a pull request. +> Query ID database and report results. +> On Fedora and Arch Linux, the binary name `lid` is taken by another program. See `tldr libuser-lid`. +> More information: . + +- View documentation for `libuser-lid`: + +`tldr libuser-lid` diff --git a/linux/light b/linux/light new file mode 100644 index 00000000..f7e4bb5d --- /dev/null +++ b/linux/light @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# light + +> Control the backlight of your screen. +> More information: . + +- Get the current backlight value in percent: + +`light` + +- Set the backlight value to 50 percent: + +`light -S {{50}}` + +- Reduce 20 percent from the current backlight value: + +`light -U {{20}}` + +- Add 20 percent to the current backlight value: + +`light -A {{20}}` diff --git a/linux/line b/linux/line new file mode 100644 index 00000000..b0d657dd --- /dev/null +++ b/linux/line @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# line + +> Read a single line of input. +> More information: . + +- Read input: + +`line` diff --git a/linux/links b/linux/links new file mode 100644 index 00000000..585d0236 --- /dev/null +++ b/linux/links @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# links + +> Command-line web browser. +> More information: . + +- Visit a website: + +`links {{https://example.com}}` + +- Apply restrictions for anonymous account: + +`links -anonymous {{https://example.com}}` + +- Enable Cookies (`1` to enable): + +`links -enable-cookies {{0|1}} {{https://example.com}}` + +- Navigate forwards and backwards through the links on a page: + +`{{Up arrow key|Down arrow key}}` + +- Go forwards and backwards one page: + +`{{Left arrow key|Right arrow key}}` + +- Exit: + +`q + y` diff --git a/linux/lnav b/linux/lnav new file mode 100644 index 00000000..6d170359 --- /dev/null +++ b/linux/lnav @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lnav + +> Advanced log file viewer to analyze logs with little to no setup. +> More information: . + +- View logs of a program, specifying log files, directories or URLs: + +`lnav {{path/to/log_or_directory|url}}` + +- View logs of a specific remote host (SSH passwordless login required): + +`lnav {{ssh}} {{user}}@{{host1.example.com}}:{{/var/log/syslog.log}}` + +- Validate the format of log files against the configuration and report any errors: + +`lnav -C {{path/to/log_directory}}` diff --git a/linux/loadkeys b/linux/loadkeys new file mode 100644 index 00000000..c02f9681 --- /dev/null +++ b/linux/loadkeys @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# loadkeys + +> Load the kernel keymap for the console. +> More information: . + +- Load a default keymap: + +`loadkeys --default` + +- Load default keymap when an unusual keymap is loaded and `-` sign cannot be found: + +`loadkeys defmap` + +- Create a kernel source table: + +`loadkeys --mktable` + +- Create a binary keymap: + +`loadkeys --bkeymap` + +- Search and parse keymap without action: + +`loadkeys --parse` + +- Load the keymap suppressing all output: + +`loadkeys --quiet` + +- Load a keymap from the specified file for the console: + +`loadkeys --console {{/dev/ttyN}} {{/path/to/file}}` + +- Use standard names for keymaps of different locales: + +`loadkeys --console {{/dev/ttyN}} {{uk}}` diff --git a/linux/locale b/linux/locale new file mode 100644 index 00000000..fb303935 --- /dev/null +++ b/linux/locale @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# locale + +> Get locale-specific information. +> More information: . + +- List all global environment variables describing the user's locale: + +`locale` + +- List all available locales: + +`locale --all-locales` + +- Display all available locales and the associated metadata: + +`locale --all-locales --verbose` + +- Display the current date format: + +`locale date_fmt` diff --git a/linux/localectl b/linux/localectl new file mode 100644 index 00000000..b9cf6b21 --- /dev/null +++ b/linux/localectl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# localectl + +> Control the system locale and keyboard layout settings. +> More information: . + +- Show the current settings of the system locale and keyboard mapping: + +`localectl` + +- List available locales: + +`localectl list-locales` + +- Set a system locale variable: + +`localectl set-locale {{LANG}}={{en_US.UTF-8}}` + +- List available keymaps: + +`localectl list-keymaps` + +- Set the system keyboard mapping for the console and X11: + +`localectl set-keymap {{us}}` diff --git a/linux/locate b/linux/locate new file mode 100644 index 00000000..4a780276 --- /dev/null +++ b/linux/locate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# locate + +> Find filenames quickly. +> More information: . + +- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily): + +`locate {{pattern}}` + +- Look for a file by its exact filename (a pattern containing no globbing characters is interpreted as `*pattern*`): + +`locate '*/{{filename}}'` + +- Recompute the database. You need to do it if you want to find recently added files: + +`sudo updatedb` diff --git a/linux/login b/linux/login new file mode 100644 index 00000000..fac8b77f --- /dev/null +++ b/linux/login @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# login + +> Initiates a session for a user. +> More information: . + +- Log in as a user: + +`login {{user}}` + +- Log in as user without authentication if user is preauthenticated: + +`login -f {{user}}` + +- Log in as user and preserve environment: + +`login -p {{user}}` + +- Log in as a user on a remote host: + +`login -h {{host}} {{user}}` diff --git a/linux/loginctl b/linux/loginctl new file mode 100644 index 00000000..91b7f305 --- /dev/null +++ b/linux/loginctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# loginctl + +> Manage the systemd login manager. +> More information: . + +- Print all current sessions: + +`loginctl list-sessions` + +- Print all properties of a specific session: + +`loginctl show-session {{session_id}} --all` + +- Print all properties of a specific user: + +`loginctl show-user {{username}}` + +- Print a specific property of a user: + +`loginctl show-user {{username}} --property={{property_name}}` + +- Execute a `loginctl` operation on a remote host: + +`loginctl list-users -H {{hostname}}` diff --git a/linux/logrotate b/linux/logrotate new file mode 100644 index 00000000..d87c1cc8 --- /dev/null +++ b/linux/logrotate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# logrotate + +> Rotates, compresses, and mails system logs. +> More information: . + +- Trigger a run manually: + +`logrotate {{path/to/logrotate.conf}} --force` + +- Run using a specific command to mail reports: + +`logrotate {{path/to/logrotate.conf}} --mail {{/usr/bin/mail_command}}` + +- Run without using a state (lock) file: + +`logrotate {{path/to/logrotate.conf}} --state /dev/null` + +- Run and skip the state (lock) file check: + +`logrotate {{path/to/logrotate.conf}} --skip-state-lock` + +- Tell `logrotate` to log verbose output into the log file: + +`logrotate {{path/to/logrotate.conf}} --log {{path/to/log_file}}` diff --git a/linux/logsave b/linux/logsave new file mode 100644 index 00000000..07e5f38a --- /dev/null +++ b/linux/logsave @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# logsave + +> Save the output of a command in a logfile. +> More information: . + +- Execute command with specified argument(s) and save its output to log file: + +`logsave {{path/to/logfile}} {{command}}` + +- Take input from `stdin` and save it in a log file: + +`logsave {{logfile}} -` + +- Append the output to a log file, instead of replacing its current contents: + +`logsave -a {{logfile}} {{command}}` + +- Show verbose output: + +`logsave -v {{logfile}} {{command}}` diff --git a/linux/logwatch b/linux/logwatch new file mode 100644 index 00000000..0b76f020 --- /dev/null +++ b/linux/logwatch @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# logwatch + +> Summarizes many different logs for common services (e.g. apache, pam_unix, sshd, etc.) in a single report. +> More information: . + +- Analyze logs for a range of dates at a certain level of detail: + +`logwatch --range {{yesterday|today|all|help}} --detail {{low|medium|others}}'` + +- Restrict report to only include information for a selected service: + +`logwatch --range {{all}} --service {{apache|pam_unix|etc}}` diff --git a/linux/look b/linux/look new file mode 100644 index 00000000..425e94fa --- /dev/null +++ b/linux/look @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# look + +> Display lines beginning with a prefix in a file. +> Note: the lines in the file must be sorted. +> See also: `grep`, `sort`. +> More information: . + +- Search for lines beginning with a specific prefix in a specific file: + +`look {{prefix}} {{path/to/file}}` + +- Case-insensitively search only on blank and alphanumeric characters: + +`look -{{f|-ignore-case}} -{{d|-alphanum}} {{prefix}} {{path/to/file}}` + +- Specify a string [t]ermination character (space by default): + +`look -{t|-terminate} {{,}}` + +- Search in `/usr/share/dict/words` (`--ignore-case` and `--alphanum` are assumed): + +`look {{prefix}}` + +- Search in `/usr/share/dict/web2` (`--ignore-case` and `--alphanum` are assumed): + +`look -{{a|-alternative}} {{prefix}}` diff --git a/linux/losetup b/linux/losetup new file mode 100644 index 00000000..03a68820 --- /dev/null +++ b/linux/losetup @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# losetup + +> Set up and control loop devices. +> More information: . + +- List loop devices with detailed info: + +`losetup -a` + +- Attach a file to a given loop device: + +`sudo losetup /dev/{{loop}} /{{path/to/file}}` + +- Attach a file to a new free loop device and scan the device for partitions: + +`sudo losetup --show --partscan -f /{{path/to/file}}` + +- Attach a file to a read-only loop device: + +`sudo losetup --read-only /dev/{{loop}} /{{path/to/file}}` + +- Detach all loop devices: + +`sudo losetup -D` + +- Detach a given loop device: + +`sudo losetup -d /dev/{{loop}}` diff --git a/linux/lrunzip b/linux/lrunzip new file mode 100644 index 00000000..7fa4268d --- /dev/null +++ b/linux/lrunzip @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lrunzip + +> A large file decompression program. +> See also: `lrzip`, `lrztar`, `lrzuntar`. +> More information: . + +- Decompress a file: + +`lrunzip {{filename.lrz}}` + +- Decompress a file using a specific number of processor threads: + +`lrunzip -p {{8}} {{filename.lrz}}` + +- Decompress a file and silently overwrite files if they exist: + +`lrunzip -f {{filename.lrz}}` + +- Keep broken or damaged files instead of deleting them when decompressing: + +`lrunzip -K {{filename.lrz}}` + +- Specify output file name and/or path: + +`lrunzip -o {{outfilename}} {{filename.lrz}}` diff --git a/linux/lrzip b/linux/lrzip new file mode 100644 index 00000000..9361b168 --- /dev/null +++ b/linux/lrzip @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lrzip + +> A large file compression program. +> See also: `lrunzip`, `lrztar`, `lrzuntar`. +> More information: . + +- Compress a file with LZMA - slow compression, fast decompression: + +`lrzip {{path/to/file}}` + +- Compress a file with BZIP2 - good middle ground for compression/speed: + +`lrzip -b {{path/to/file}}` + +- Compress with ZPAQ - extreme compression, but very slow: + +`lrzip -z {{path/to/file}}` + +- Compress with LZO - light compression, extremely fast decompression: + +`lrzip -l {{path/to/file}}` + +- Compress a file and password protect/encrypt it: + +`lrzip -e {{path/to/file}}` + +- Override the number of processor threads to use: + +`lrzip -p {{8}} {{path/to/file}}` diff --git a/linux/lrztar b/linux/lrztar new file mode 100644 index 00000000..404c31c3 --- /dev/null +++ b/linux/lrztar @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lrztar + +> A wrapper for `lrzip` to simplify compression of directories. +> See also: `tar`, `lrzuntar`, `lrunzip`. +> More information: . + +- Archive a directory with `tar`, then compress: + +`lrztar {{path/to/directory}}` + +- Same as above, with ZPAQ - extreme compression, but very slow: + +`lrztar -z {{path/to/directory}}` + +- Specify the output file: + +`lrztar -o {{path/to/file}} {{path/to/directory}}` + +- Override the number of processor threads to use: + +`lrztar -p {{8}} {{path/to/directory}}` + +- Force overwriting of existing files: + +`lrztar -f {{path/to/directory}}` diff --git a/linux/lrzuntar b/linux/lrzuntar new file mode 100644 index 00000000..9e637af0 --- /dev/null +++ b/linux/lrzuntar @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lrzuntar + +> A wrapper for `lrunzip` to simplify decompression of directories. +> See also: `lrztar`, `lrzip`. +> More information: . + +- Decompress from a file to the current directory: + +`lrzuntar {{path/to/archive.tar.lrz}}` + +- Decompress from a file to the current directory using a specific number of processor threads: + +`lrzuntar -p {{8}} {{path/to/archive.tar.lrz}}` + +- Decompress from a file to the current directory and silently overwrite items that already exist: + +`lrzuntar -f {{archive.tar.lrz}}` + +- Specify the output path: + +`lrzuntar -O {{path/to/directory}} {{archive.tar.lrz}}` + +- Delete the compressed file after decompression: + +`lrzuntar -D {{path/to/archive.tar.lrz}}` diff --git a/linux/lsattr b/linux/lsattr new file mode 100644 index 00000000..f3e2379d --- /dev/null +++ b/linux/lsattr @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsattr + +> List file attributes on a Linux filesystem. +> More information: . + +- Display the attributes of the files in the current directory: + +`lsattr` + +- List the attributes of files in a particular path: + +`lsattr {{path}}` + +- List file attributes recursively in the current and subsequent directories: + +`lsattr -R` + +- Show attributes of all the files in the current directory, including hidden ones: + +`lsattr -a` + +- Display attributes of directories in the current directory: + +`lsattr -d` diff --git a/linux/lsb_release b/linux/lsb_release new file mode 100644 index 00000000..a1c9729d --- /dev/null +++ b/linux/lsb_release @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsb_release + +> Provides certain LSB (Linux Standard Base) and distribution-specific information. +> More information: . + +- Print all available information: + +`lsb_release -a` + +- Print a description (usually the full name) of the operating system: + +`lsb_release -d` + +- Print only the operating system name (ID), suppressing the field name: + +`lsb_release -i -s` + +- Print the release number and codename of the distribution, suppressing the field names: + +`lsb_release -rcs` diff --git a/linux/lsblk b/linux/lsblk new file mode 100644 index 00000000..7bf9cccc --- /dev/null +++ b/linux/lsblk @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsblk + +> Lists information about devices. +> More information: . + +- List all storage devices in a tree-like format: + +`lsblk` + +- Also list empty devices: + +`lsblk -a` + +- Print the SIZE column in bytes rather than in a human-readable format: + +`lsblk -b` + +- Output info about filesystems: + +`lsblk -f` + +- Use ASCII characters for tree formatting: + +`lsblk -i` + +- Output info about block-device topology: + +`lsblk -t` + +- Exclude the devices specified by the comma-separated list of major device numbers: + +`lsblk -e {{1,7,...}}` + +- Display a customized summary using a comma-separated list of columns: + +`lsblk --output {{NAME,SERIAL,MODEL,TRAN,TYPE,SIZE,FSTYPE,MOUNTPOINT,...}}` diff --git a/linux/lscpu b/linux/lscpu new file mode 100644 index 00000000..852e778c --- /dev/null +++ b/linux/lscpu @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lscpu + +> Displays information about the CPU architecture. +> More information: . + +- Display information about all CPUs: + +`lscpu` + +- Display information in a table: + +`lscpu --extended` + +- Display only information about offline CPUs in a table: + +`lscpu --extended --offline` diff --git a/linux/lshw b/linux/lshw new file mode 100644 index 00000000..f7b85bc2 --- /dev/null +++ b/linux/lshw @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lshw + +> List detailed information about hardware configurations as root user. +> More information: . + +- Launch the GUI: + +`sudo lshw -X` + +- List all hardware in tabular format: + +`sudo lshw -short` + +- List all disks and storage controllers in tabular format: + +`sudo lshw -class disk -class storage -short` + +- Save all network interfaces to an HTML file: + +`sudo lshw -class network -html > {{interfaces.html}}` diff --git a/linux/lsinitrd b/linux/lsinitrd new file mode 100644 index 00000000..9f5f3831 --- /dev/null +++ b/linux/lsinitrd @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsinitrd + +> Show the contents of an initramfs image. +> See also: `dracut`. +> More information: . + +- Show the contents of the initramfs image for the current kernel: + +`lsinitrd` + +- Show the contents of the initramfs image for the specified kernel: + +`lsinitrd --kver {{kernel_version}}` + +- Show the contents of the specified initramfs image: + +`lsinitrd {{path/to/initramfs.img}}` + +- List modules included in the initramfs image: + +`lsinitrd --mod` + +- Unpack the initramfs to the current directory: + +`lsinitrd --unpack` diff --git a/linux/lslocks b/linux/lslocks new file mode 100644 index 00000000..3a4e898c --- /dev/null +++ b/linux/lslocks @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lslocks + +> List local system locks. +> More information: . + +- List all local system locks: + +`lslocks` + +- List locks with defined column headers: + +`lslocks --output {{PID}},{{COMMAND}},{{PATH}}` + +- List locks producing a raw output (no columns), and without column headers: + +`lslocks --raw --noheadings` + +- List locks by PID input: + +`lslocks --pid {{PID}}` + +- List locks with JSON output to `stdout`: + +`lslocks --json` diff --git a/linux/lslogins b/linux/lslogins new file mode 100644 index 00000000..b23a8c86 --- /dev/null +++ b/linux/lslogins @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lslogins + +> Show information about users on a Linux system. +> More information: . + +- Display users in the system: + +`lslogins` + +- Display users belonging to a specific group: + +`lslogins --groups={{groups}}` + +- Display user accounts: + +`lslogins --user-accs` + +- Display last logins: + +`lslogins --last` + +- Display system accounts: + +`lslogins --system-accs` + +- Display supplementary groups: + +`lslogins --supp-groups` diff --git a/linux/lsmod b/linux/lsmod new file mode 100644 index 00000000..15d626dd --- /dev/null +++ b/linux/lsmod @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsmod + +> Shows the status of Linux kernel modules. +> See also `modprobe`, which loads kernel modules. +> More information: . + +- List all currently loaded kernel modules: + +`lsmod` diff --git a/linux/lsns b/linux/lsns new file mode 100644 index 00000000..d97f45ae --- /dev/null +++ b/linux/lsns @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsns + +> List information about all namespaces or about the specified namespace. +> More information: . + +- List all namespaces: + +`lsns` + +- List namespaces in JSON format: + +`lsns --json` + +- List namespaces associated with the specified process: + +`lsns --task {{pid}}` + +- List the specified type of namespaces only: + +`lsns --type {{mnt|net|ipc|user|pid|uts|cgroup|time}}` + +- List namespaces, only showing the namespace ID, type, PID, and command: + +`lsns --output {{NS,TYPE,PID,COMMAND}}` diff --git a/linux/lspci b/linux/lspci new file mode 100644 index 00000000..90677a6c --- /dev/null +++ b/linux/lspci @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lspci + +> List all PCI devices. +> More information: . + +- Show a brief list of devices: + +`lspci` + +- Display additional info: + +`lspci -v` + +- Display drivers and modules handling each device: + +`lspci -k` + +- Show a specific device: + +`lspci -s {{00:18.3}}` + +- Dump info in a readable form: + +`lspci -vm` diff --git a/linux/lsscsi b/linux/lsscsi new file mode 100644 index 00000000..398c493d --- /dev/null +++ b/linux/lsscsi @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsscsi + +> List SCSI devices (or hosts) and their attributes. +> More information: . + +- List all SCSI devices: + +`lsscsi` + +- List all SCSI devices with detailed attributes: + +`lsscsi -L` + +- List all SCSI devices with human-readable disk capacity: + +`lsscsi -s` diff --git a/linux/lsusb b/linux/lsusb new file mode 100644 index 00000000..86a32ab1 --- /dev/null +++ b/linux/lsusb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lsusb + +> Display information about USB buses and devices connected to them. +> More information: . + +- List all the USB devices available: + +`lsusb` + +- List the USB hierarchy as a tree: + +`lsusb -t` + +- List verbose information about USB devices: + +`lsusb --verbose` + +- List detailed information about a USB device: + +`lsusb --verbose -s {{bus}}:{{device number}}` + +- List devices with a specified vendor and product ID only: + +`lsusb -d {{vendor}}:{{product}}` diff --git a/linux/ltrace b/linux/ltrace new file mode 100644 index 00000000..2f92ac83 --- /dev/null +++ b/linux/ltrace @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ltrace + +> Display dynamic library calls of a process. +> More information: . + +- Print (trace) library calls of a program binary: + +`ltrace ./{{program}}` + +- Count library calls. Print a handy summary at the bottom: + +`ltrace -c {{path/to/program}}` + +- Trace calls to malloc and free, omit those done by libc: + +`ltrace -e malloc+free-@libc.so* {{path/to/program}}` + +- Write to file instead of terminal: + +`ltrace -o {{file}} {{path/to/program}}` diff --git a/linux/lvcreate b/linux/lvcreate new file mode 100644 index 00000000..fce3047f --- /dev/null +++ b/linux/lvcreate @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvcreate + +> Create a logical volume in an existing volume group. A volume group is a collection of logical and physical volumes. +> See also: `lvm`. +> More information: . + +- Create a logical volume of 10 gigabytes in the volume group vg1: + +`lvcreate -L {{10G}} {{vg1}}` + +- Create a 1500 megabyte linear logical volume named mylv in the volume group vg1: + +`lvcreate -L {{1500}} -n {{mylv}} {{vg1}}` + +- Create a logical volume called mylv that uses 60% of the total space in volume group vg1: + +`lvcreate -l {{60%VG}} -n {{mylv}} {{vg1}}` + +- Create a logical volume called mylv that uses all the unallocated space in the volume group vg1: + +`lvcreate -l {{100%FREE}} -n {{mylv}} {{vg1}}` diff --git a/linux/lvdisplay b/linux/lvdisplay new file mode 100644 index 00000000..d392fd47 --- /dev/null +++ b/linux/lvdisplay @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvdisplay + +> Display information about Logical Volume Manager (LVM) logical volumes. +> See also: `lvm`. +> More information: . + +- Display information about all logical volumes: + +`sudo lvdisplay` + +- Display information about all logical volumes in volume group vg1: + +`sudo lvdisplay {{vg1}}` + +- Display information about logical volume lv1 in volume group vg1: + +`sudo lvdisplay {{vg1/lv1}}` diff --git a/linux/lvextend b/linux/lvextend new file mode 100644 index 00000000..1c783c84 --- /dev/null +++ b/linux/lvextend @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvextend + +> Increase the size of a logical volume. +> See also: `lvm`. +> More information: . + +- Increase a volume's size to 120 GB: + +`lvextend --size {{120G}} {{logical_volume}}` + +- Increase a volume's size by 40 GB as well as the underlying filesystem: + +`lvextend --size +{{40G}} -r {{logical_volume}}` + +- Increase a volume's size to 100% of the free physical volume space: + +`lvextend --size +{{100}}%FREE {{logical_volume}}` diff --git a/linux/lvm b/linux/lvm new file mode 100644 index 00000000..d570ab69 --- /dev/null +++ b/linux/lvm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvm + +> Manage physical volumes, volume groups, and logical volumes using the Logical Volume Manager (LVM) interactive shell. +> More information: . + +- Start the Logical Volume Manager interactive shell: + +`sudo lvm` + +- Initialize a drive or partition to be used as a physical volume: + +`sudo lvm pvcreate {{/dev/sdXY}}` + +- Display information about physical volumes: + +`sudo lvm pvdisplay` + +- Create a volume group called vg1 from the physical volume on `/dev/sdXY`: + +`sudo lvm vgcreate {{vg1}} {{/dev/sdXY}}` + +- Display information about volume groups: + +`sudo lvm vgdisplay` + +- Create a logical volume with size 10G from volume group vg1: + +`sudo lvm lvcreate -L {{10G}} {{vg1}}` + +- Display information about logical volumes: + +`sudo lvm lvdisplay` + +- Display help for a specific command: + +`lvm help {{command}}` diff --git a/linux/lvreduce b/linux/lvreduce new file mode 100644 index 00000000..ebf4ae6b --- /dev/null +++ b/linux/lvreduce @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvreduce + +> Reduce the size of a logical volume. +> See also: `lvm`. +> More information: . + +- Reduce a volume's size to 120 GB: + +`lvreduce --size {{120G}} {{logical_volume}}` + +- Reduce a volume's size by 40 GB as well as the underlying filesystem: + +`lvreduce --size -{{40G}} -r {{logical_volume}}` diff --git a/linux/lvremove b/linux/lvremove new file mode 100644 index 00000000..46871de1 --- /dev/null +++ b/linux/lvremove @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvremove + +> Remove logical volumes. +> See also: `lvm`. +> More information: . + +- Remove a logical volume in a volume group: + +`sudo lvremove {{volume_group}}/{{logical_volume}}` + +- Remove all logical volumes in a volume group: + +`sudo lvremove {{volume_group}}` diff --git a/linux/lvresize b/linux/lvresize new file mode 100644 index 00000000..4e9ef45e --- /dev/null +++ b/linux/lvresize @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvresize + +> Change the size of a logical volume. +> See also: `lvm`. +> More information: . + +- Change the size of a logical volume to 120 GB: + +`lvresize --size {{120G}} {{volume_group}}/{{logical_volume}}` + +- Extend the size of a logical volume as well as the underlying filesystem by 120 GB: + +`lvresize --size +{{120G}} --resizefs {{volume_group}}/{{logical_volume}}` + +- Extend the size of a logical volume to 100% of the free physical volume space: + +`lvresize --size {{100}}%FREE {{volume_group}}/{{logical_volume}}` + +- Reduce the size of a logical volume as well as the underlying filesystem by 120 GB: + +`lvresize --size -{{120G}} --resizefs {{volume_group}}/{{logical_volume}}` diff --git a/linux/lvs b/linux/lvs new file mode 100644 index 00000000..4a1c950b --- /dev/null +++ b/linux/lvs @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lvs + +> Display information about logical volumes. +> See also: `lvm`. +> More information: . + +- Display information about logical volumes: + +`lvs` + +- Display all logical volumes: + +`lvs -a` + +- Change default display to show more details: + +`lvs -v` + +- Display only specific fields: + +`lvs -o {{field_name_1}},{{field_name_2}}` + +- Append field to default display: + +`lvs -o +{{field_name}}` + +- Suppress heading line: + +`lvs --noheadings` + +- Use a separator to separate fields: + +`lvs --separator {{=}}` diff --git a/linux/lxc b/linux/lxc new file mode 100644 index 00000000..da25f419 --- /dev/null +++ b/linux/lxc @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxc + +> Manage Linux containers using the lxd REST API. +> Any container names or patterns can be prefixed with the name of a remote server. +> More information: . + +- List local containers matching a string. Omit the string to list all local containers: + +`lxc list {{match_string}}` + +- List images matching a string. Omit the string to list all images: + +`lxc image list [{{remote}}:]{{match_string}}` + +- Create a new container from an image: + +`lxc init [{{remote}}:]{{image}} {{container}}` + +- Start a container: + +`lxc start [{{remote}}:]{{container}}` + +- Stop a container: + +`lxc stop [{{remote}}:]{{container}}` + +- Show detailed info about a container: + +`lxc info [{{remote}}:]{{container}}` + +- Take a snapshot of a container: + +`lxc snapshot [{{remote}}:]{{container}} {{snapshot}}` + +- Execute a specific command inside a container: + +`lxc exec [{{remote}}:]{{container}} {{command}}` diff --git a/linux/lxc-network b/linux/lxc-network new file mode 100644 index 00000000..2804ea05 --- /dev/null +++ b/linux/lxc-network @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxc network + +> Manage networks for LXD containers. +> More information: . + +- List all available networks: + +`lxc network list` + +- Show the configuration of a specific network: + +`lxc network show {{network_name}}` + +- Add a running instance to a specific network: + +`lxc network attach {{network_name}} {{container_name}}` + +- Create a new managed network: + +`lxc network create {{network_name}}` + +- Set a bridge interface of a specific network: + +`lxc network set {{network_name}} bridge.external_interfaces {{eth0}}` + +- Disable NAT for a specific network: + +`lxc network set {{network_name}} ipv{{4}}.nat false` diff --git a/linux/lxc-profile b/linux/lxc-profile new file mode 100644 index 00000000..8e2d1221 --- /dev/null +++ b/linux/lxc-profile @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxc profile + +> Manage profiles for LXD containers. +> More information: . + +- List all available profiles: + +`lxc profile list` + +- Show the configuration of a specific profile: + +`lxc profile show {{profile_name}}` + +- Edit a specific profile in the default editor: + +`lxc profile edit {{profile_name}}` + +- Edit a specific profile importing the configuration values from a file: + +`lxc profile edit {{profile_name}} < {{config.yaml}}` + +- Launch a new container with specific profiles: + +`lxc launch {{container_image}} {{container_name}} --profile {{profile1}} --profile {{profile2}}` + +- Change the profiles of a running container: + +`lxc profile assign {{container_name}} {{profile1,profile2}}` diff --git a/linux/lxi b/linux/lxi new file mode 100644 index 00000000..1c9ca656 --- /dev/null +++ b/linux/lxi @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxi + +> Control LXI compatible instruments such as oscilloscopes. +> More information: . + +- Discover LXI devices on available networks: + +`lxi discover` + +- Capture a screenshot, detecting a plugin automatically: + +`lxi screenshot --address {{ip_address}}` + +- Capture a screenshot using a specified plugin: + +`lxi screenshot --address {{ip_address}} --plugin {{rigol-1000z}}` + +- Send an SCPI command to an instrument: + +`lxi scpi --address {{ip_address}} "{{*IDN?}}"` + +- Run a benchmark for request and response performance: + +`lxi benchmark --address {{ip_address}}` diff --git a/linux/lxterminal b/linux/lxterminal new file mode 100644 index 00000000..659c60d3 --- /dev/null +++ b/linux/lxterminal @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxterminal + +> Terminal emulator for LXDE. +> More information: . + +- Open an LXTerminal window: + +`lxterminal` + +- Open an LXTerminal window, run a command, and then exit: + +`lxterminal -e "{{command}}"` + +- Open an LXTerminal window with multiple tabs: + +`lxterminal --tabs={{tab_name1,tab_name2,...}}` + +- Open an LXTerminal window with a specific title: + +`lxterminal --title={{title_name}}` + +- Open an LXTerminal window with a specific working directory: + +`lxterminal --working-directory={{path/to/directory}}` diff --git a/linux/lynis b/linux/lynis new file mode 100644 index 00000000..1826d28d --- /dev/null +++ b/linux/lynis @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lynis + +> System and security auditing tool. +> More information: . + +- Check that Lynis is up-to-date: + +`sudo lynis update info` + +- Run a security audit of the system: + +`sudo lynis audit system` + +- Run a security audit of a Dockerfile: + +`sudo lynis audit dockerfile {{path/to/dockerfile}}` diff --git a/linux/lz b/linux/lz new file mode 100644 index 00000000..e34deb16 --- /dev/null +++ b/linux/lz @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lz + +> List all files inside a '.tar.gz' compressed archive. +> More information: . + +- List all files inside a compressed archive: + +`lz {{path/to/file.tar.gz}}` diff --git a/linux/mac2unix b/linux/mac2unix new file mode 100644 index 00000000..7189ab48 --- /dev/null +++ b/linux/mac2unix @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mac2unix + +> Change macOS-style line endings to Unix-style. +> Replaces CR with LF. +> More information: . + +- Change the line endings of a file: + +`mac2unix {{filename}}` + +- Create a copy with Unix-style line endings: + +`mac2unix -n {{filename}} {{new_filename}}` diff --git a/linux/macchanger b/linux/macchanger new file mode 100644 index 00000000..06e5cf59 --- /dev/null +++ b/linux/macchanger @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# macchanger + +> Command-line utility for manipulating network interface MAC addresses. +> More information: . + +- View the current and permanent MAC addresses of a interface: + +`macchanger --show {{interface}}` + +- Set interface to a random MAC: + +`macchanger --random {{interface}}` + +- Set interface to a specific MAC: + +`macchanger --mac {{XX:XX:XX:XX:XX:XX}} {{interface}}` + +- Reset interface to its permanent hardware MAC: + +`macchanger --permanent {{interface}}` diff --git a/linux/machinectl b/linux/machinectl new file mode 100644 index 00000000..f665d0ee --- /dev/null +++ b/linux/machinectl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# machinectl + +> Control the systemd machine manager. +> Execute operations on virtual machines, containers and images. +> More information: . + +- Start a machine as a service using `systemd-nspawn`: + +`sudo machinectl start {{machine_name}}` + +- Stop a running machine: + +`sudo machinectl stop {{machine_name}}` + +- Display a list of running machines: + +`machinectl list` + +- Open an interactive shell inside the machine: + +`sudo machinectl shell {{machine_name}}` diff --git a/linux/maim b/linux/maim new file mode 100644 index 00000000..17ad0366 --- /dev/null +++ b/linux/maim @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# maim + +> Screenshot utility. +> More information: . + +- Capture a screenshot and save it to the given path: + +`maim {{path/to/screenshot.png}}` + +- Capture a screenshot of the selected region: + +`maim --select {{path/to/screenshot.png}}` + +- Capture a screenshot of the selected region and save it in the clipboard (requires `xclip`): + +`maim --select | xclip -selection clipboard -target image/png` + +- Capture a screenshot of the current active window (requires `xdotool`): + +`maim --window $(xdotool getactivewindow) {{path/to/screenshot.png}}` diff --git a/linux/makepkg b/linux/makepkg new file mode 100644 index 00000000..e337a211 --- /dev/null +++ b/linux/makepkg @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# makepkg + +> Create a package which can be used with `pacman`. +> Uses the `PKGBUILD` file in the current working directory by default. +> More information: . + +- Make a package: + +`makepkg` + +- Make a package and install its dependencies: + +`makepkg --syncdeps` + +- Make a package, install its dependencies then install it to the system: + +`makepkg --syncdeps --install` + +- Make a package, but skip checking the source's hashes: + +`makepkg --skipchecksums` + +- Clean up work directories after a successful build: + +`makepkg --clean` + +- Verify the hashes of the sources: + +`makepkg --verifysource` + +- Generate and save the source information into `.SRCINFO`: + +`makepkg --printsrcinfo > .SRCINFO` diff --git a/linux/man b/linux/man new file mode 100644 index 00000000..d8818372 --- /dev/null +++ b/linux/man @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# man + +> Format and display manual pages. +> More information: . + +- Display the man page for a command: + +`man {{command}}` + +- Open the man page for a command in a browser: + +`man --html {{command}}` + +- Display the man page for a command from section 7: + +`man {{7}} {{command}}` + +- List all available sections for a command: + +`man --whatis {{command}}` + +- Display the path searched for manpages: + +`man --path` + +- Display the location of a manpage rather than the manpage itself: + +`man --where {{command}}` + +- Display the man page using a specific locale: + +`man --locale={{locale}} {{command}}` + +- Search for manpages containing a search string: + +`man --apropos "{{search_string}}"` diff --git a/linux/mandb b/linux/mandb new file mode 100644 index 00000000..ccaaaffb --- /dev/null +++ b/linux/mandb @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mandb + +> Manage the pre-formatted manual page database. +> More information: . + +- Purge and process manual pages: + +`mandb` + +- Update a single entry: + +`mandb --filename {{path/to/file}}` + +- Create entries from scratch instead of updating: + +`mandb --create` + +- Only process user databases: + +`mandb --user-db` + +- Do not purge obsolete entries: + +`mandb --no-purge` + +- Check the validity of manual pages: + +`mandb --test` diff --git a/linux/manpath b/linux/manpath new file mode 100644 index 00000000..ddaf3e98 --- /dev/null +++ b/linux/manpath @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# manpath + +> Determine the search path for manual pages. +> More information: . + +- Display the search path used to find man pages: + +`manpath` + +- Show the entire global manpath: + +`manpath --global` diff --git a/linux/mashtree b/linux/mashtree new file mode 100644 index 00000000..f85fa995 --- /dev/null +++ b/linux/mashtree @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mashtree + +> Makes a fast tree from genomes. +> Does not make a phylogeny. +> More information: . + +- Fastest method in mashtree to create a tree from fastq and/or fasta files using multiple threads, piping into a newick file: + +`mashtree --numcpus {{12}} {{*.fastq.gz}} {{*.fasta}} > {{mashtree.dnd}}` + +- Most accurate method in mashtree to create a tree from fastq and/or fasta files using multiple threads, piping into a newick file: + +`mashtree --mindepth {{0}} --numcpus {{12}} {{*.fastq.gz}} {{*.fasta}} > {{mashtree.dnd}}` + +- Most accurate method to create a tree with confidence values (note that any options for `mashtree` itself has to be on the right side of the `--`): + +`mashtree_bootstrap.pl --reps {{100}} --numcpus {{12}} {{*.fastq.gz}} -- --min-depth {{0}} > {{mashtree.bootstrap.dnd}}` diff --git a/linux/mate-about b/linux/mate-about new file mode 100644 index 00000000..37e91ef0 --- /dev/null +++ b/linux/mate-about @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-about + +> Show information about MATE desktop environment. +> More information: . + +- Display MATE version: + +`mate-about --version` diff --git a/linux/mate-calc b/linux/mate-calc new file mode 100644 index 00000000..343a2788 --- /dev/null +++ b/linux/mate-calc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-calc + +> Calculate mathematic expressions in MATE desktop environment. +> More information: . + +- Start the calculator: + +`mate-calc` + +- Calculate a specific mathematic expression: + +`mate-calc --solve {{2 + 5}}` diff --git a/linux/mate-calc-cmd b/linux/mate-calc-cmd new file mode 100644 index 00000000..75878ea8 --- /dev/null +++ b/linux/mate-calc-cmd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-calc-cmd + +> Calculate mathematic expressions in MATE desktop environment in terminal. +> More information: . + +- Start an interactive calculator session: + +`mate-calc-cmd` + +- Calculate a specific mathematic expression: + +`{{2 + 5}}` diff --git a/linux/mate-screenshot b/linux/mate-screenshot new file mode 100644 index 00000000..a7c9b5a4 --- /dev/null +++ b/linux/mate-screenshot @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-screenshot + +> Make screenshots in MATE desktop environment. +> More information: . + +- Create a fullscreen screenshot: + +`mate-screenshot` + +- Create an active window screenshot: + +`mate-screenshot --window` + +- Create a specific area screenshot: + +`mate-screenshot --area` + +- Create a screenshot interactively: + +`mate-screenshot --interactive` + +- Create a screenshot without borders: + +`mate-screenshot --window --remove-border` + +- Create a screenshot with a specific effect: + +`mate-screenshot --effect={{shadow|border|none}}` + +- Create a screenshot with a specific delay in seconds: + +`mate-screenshot --delay={{5}}` diff --git a/linux/mate-search-tool b/linux/mate-search-tool new file mode 100644 index 00000000..1080bca6 --- /dev/null +++ b/linux/mate-search-tool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-search-tool + +> Search files in MATE desktop environment. +> More information: . + +- Search files containing a specific string in their name in a specific directory: + +`mate-search-tool --named={{string}} --path={{path/to/directory}}` + +- Search files without waiting a user confirmation: + +`mate-search-tool --start --named={{string}} --path={{path/to/directory}}` + +- Search files with name matching a specific regular expression: + +`mate-search-tool --start --regex={{string}} --path={{path/to/directory}}` + +- Set a sorting order in search results: + +`mate-search-tool --start --named={{string}} --path={{path/to/directory}} --sortby={{name|folder|size|type|date}}` + +- Set a descending sorting order: + +`mate-search-tool --start --named={{string}} --path={{path/to/directory}} --descending` + +- Search files owned by a specific user/group: + +`mate-search-tool --start --{{user|group}}={{value}} --path={{path/to/directory}}` diff --git a/linux/mcookie b/linux/mcookie new file mode 100644 index 00000000..1ba8f982 --- /dev/null +++ b/linux/mcookie @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mcookie + +> Generates random 128-bit hexadecimal numbers. +> More information: . + +- Generate a random number: + +`mcookie` + +- Generate a random number, using the contents of a file as a seed for the randomness: + +`mcookie --file {{path/to/file}}` + +- Generate a random number, using a specific number of bytes from a file as a seed for the randomness: + +`mcookie --file {{path/to/file}} --max-size {{number_of_bytes}}` + +- Print the details of the randomness used, such as the origin and seed for each source: + +`mcookie --verbose` diff --git a/linux/mdadm b/linux/mdadm new file mode 100644 index 00000000..b42130b2 --- /dev/null +++ b/linux/mdadm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mdadm + +> RAID management utility. +> More information: . + +- Create array: + +`sudo mdadm --create {{/dev/md/MyRAID}} --level {{raid_level}} --raid-devices {{number_of_disks}} {{/dev/sdXN}}` + +- Stop array: + +`sudo mdadm --stop {{/dev/md0}}` + +- Mark disk as failed: + +`sudo mdadm --fail {{/dev/md0}} {{/dev/sdXN}}` + +- Remove disk: + +`sudo mdadm --remove {{/dev/md0}} {{/dev/sdXN}}` + +- Add disk to array: + +`sudo mdadm --assemble {{/dev/md0}} {{/dev/sdXN}}` + +- Show RAID info: + +`sudo mdadm --detail {{/dev/md0}}` + +- Reset disk by deleting RAID metadata: + +`sudo mdadm --zero-superblock {{/dev/sdXN}}` diff --git a/linux/mdbook b/linux/mdbook new file mode 100644 index 00000000..2d67b8bf --- /dev/null +++ b/linux/mdbook @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mdbook + +> Create online books by writing Markdown files. +> More information: . + +- Create an mdbook project in the current directory: + +`mdbook init` + +- Create an mdbook project in a specific directory: + +`mdbook init {{path/to/directory}}` + +- Clean the directory with the generated book: + +`mdbook clean` + +- Serve a book at , auto build when file changes: + +`mdbook serve` + +- Watch a set of Markdown files and automatically build when a file is changed: + +`mdbook watch` diff --git a/linux/mediamtx b/linux/mediamtx new file mode 100644 index 00000000..1e2576d7 --- /dev/null +++ b/linux/mediamtx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mediamtx + +> Real-time media server and proxy. +> More information: . + +- Run MediaMTX: + +`mediamtx` + +- Run MediaMTX with a custom configuration location: + +`mediamtx {{path/to/config.yml}}` + +- Start MediaMTX as a daemon: + +`systemctl start mediamtx` diff --git a/linux/medusa b/linux/medusa new file mode 100644 index 00000000..74caea16 --- /dev/null +++ b/linux/medusa @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# Medusa + +> A modular and parallel login brute-forcer for a variety of protocols. +> More information: . + +- Execute brute force against an FTP server using a file containing usernames and a file containing passwords: + +`medusa -M ftp -h host -U {{path/to/username_file}} -P {{path/to/password_file}}` + +- Execute a login attempt against an HTTP server using the username, password and user-agent specified: + +`medusa -M HTTP -h host -u {{username}} -p {{password}} -m USER-AGENT:"{{Agent}}"` + +- Execute a brute force against a MySQL server using a file containing usernames and a hash: + +`medusa -M mysql -h host -U {{path/to/username_file}} -p {{hash}} -m PASS:HASH` + +- Execute a brute force against a list of SMB servers using a username and a pwdump file: + +`medusa -M smbnt -H {{path/to/hosts_file}} -C {{path/to/pwdump_file}} -u {{username}} -m PASS:HASH` diff --git a/linux/megadl b/linux/megadl new file mode 100644 index 00000000..826dcc31 --- /dev/null +++ b/linux/megadl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# megadl + +> This command is an alias of `megatools-dl`. +> More information: . + +- View documentation for the original command: + +`tldr megatools-dl` diff --git a/linux/megatools-dl b/linux/megatools-dl new file mode 100644 index 00000000..219441f4 --- /dev/null +++ b/linux/megatools-dl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# megatools-dl + +> Download files from `mega.nz`. +> Part of the `megatools` suite. +> More information: . + +- Download files from a `mega.nz` link into the current directory: + +`megatools-dl {{https://mega.nz/...}}` + +- Download files from a `mega.nz` link into a specific directory: + +`megatools-dl --path {{path/to/directory}} {{https://mega.nz/...}}` + +- Interactively choose which files to download: + +`megatools-dl --choose-files {{https://mega.nz/...}}` + +- Limit the download speed in KiB/s: + +`megatools-dl --limit-speed {{speed}} {{https://mega.nz/...}}` diff --git a/linux/mesg b/linux/mesg new file mode 100644 index 00000000..8c7762fc --- /dev/null +++ b/linux/mesg @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mesg + +> Check or set a terminal's ability to receive messages from other users, usually from the `write` command. +> See also `write`, `talk`. +> More information: . + +- Check terminal's openness to write messages: + +`mesg` + +- Disallow receiving messages from other users: + +`mesg n` + +- Allow receiving messages from other users: + +`mesg y` + +- Enable [v]erbose mode, printing a warning if the command is not executed from a terminal: + +`mesg --verbose` diff --git a/linux/microcom b/linux/microcom new file mode 100644 index 00000000..f52de1f7 --- /dev/null +++ b/linux/microcom @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# microcom + +> A minimalistic terminal program, used to access remote devices via a serial, CAN or telnet connection from the console. +> More information: . + +- Open a serial port using the specified baud rate: + +`microcom --port {{path/to/serial_port}} --speed {{baud_rate}}` + +- Establish a telnet connection to the specified host: + +`microcom --telnet {{hostname}}:{{port}}` diff --git a/linux/mimetype b/linux/mimetype new file mode 100644 index 00000000..72c3a7dd --- /dev/null +++ b/linux/mimetype @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mimetype + +> Automatically determine the MIME type of a file. +> More information: . + +- Print the MIME type of a given file: + +`mimetype {{path/to/file}}` + +- Display only the MIME type, and not the filename: + +`mimetype --brief {{path/to/file}}` + +- Display a description of the MIME type: + +`mimetype --describe {{path/to/file}}` + +- Determine the MIME type of `stdin` (does not check a filename): + +`{{command}} | mimetype --stdin` + +- Display debug information about how the MIME type was determined: + +`mimetype --debug {{path/to/file}}` + +- Display all the possible MIME types of a given file in confidence order: + +`mimetype --all {{path/to/file}}` + +- Explicitly specify the 2-letter language code of the output: + +`mimetype --language {{path/to/file}}` diff --git a/linux/minicom b/linux/minicom new file mode 100644 index 00000000..f19c032e --- /dev/null +++ b/linux/minicom @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# minicom + +> A program to communicate with the serial interface of a device. +> More information: . + +- Open a given serial port: + +`sudo minicom --device {{/dev/ttyUSB0}}` + +- Open a given serial port with a given baud rate: + +`sudo minicom --device {{/dev/ttyUSB0}} --baudrate {{115200}}` + +- Enter the configuration menu before communicating with a given serial port: + +`sudo minicom --device {{/dev/ttyUSB0}} --setup` diff --git a/linux/mke2fs b/linux/mke2fs new file mode 100644 index 00000000..6753949d --- /dev/null +++ b/linux/mke2fs @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mke2fs + +> Creates a Linux filesystem inside a partition. +> More information: . + +- Create an ext2 filesystem in partition 1 of device b (`sdb1`): + +`mkfs.ext2 {{/dev/sdb1}}` + +- Create an ext3 filesystem in partition 1 of device b (`sdb1`): + +`mkfs.ext3 {{/dev/sdb1}}` + +- Create an ext4 filesystem in partition 1 of device b (`sdb1`): + +`mkfs.ext4 {{/dev/sdb1}}` diff --git a/linux/mkfs b/linux/mkfs new file mode 100644 index 00000000..0e117eb5 --- /dev/null +++ b/linux/mkfs @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs + +> Build a Linux filesystem on a hard disk partition. +> This command is deprecated in favor of filesystem specific mkfs. utils. +> More information: . + +- Build a Linux ext2 filesystem on a partition: + +`mkfs {{path/to/partition}}` + +- Build a filesystem of a specified type: + +`mkfs -t {{ext4}} {{path/to/partition}}` + +- Build a filesystem of a specified type and check for bad blocks: + +`mkfs -c -t {{ntfs}} {{path/to/partition}}` diff --git a/linux/mkfs.btrfs b/linux/mkfs.btrfs new file mode 100644 index 00000000..3e4c464e --- /dev/null +++ b/linux/mkfs.btrfs @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.btrfs + +> Create a BTRFS filesystem. +> Defaults to `raid1`, which specifies 2 copies of a data block spread across 2 different devices. +> More information: . + +- Create a btrfs filesystem on a single device: + +`sudo mkfs.btrfs --metadata single --data single {{/dev/sda}}` + +- Create a btrfs filesystem on multiple devices with raid1: + +`sudo mkfs.btrfs --metadata raid1 --data raid1 {{/dev/sda}} {{/dev/sdb}} {{/dev/sdN}}` + +- Set a label for the filesystem: + +`sudo mkfs.btrfs --label "{{label}}" {{/dev/sda}} [{{/dev/sdN}}]` diff --git a/linux/mkfs.cramfs b/linux/mkfs.cramfs new file mode 100644 index 00000000..aad7d3b2 --- /dev/null +++ b/linux/mkfs.cramfs @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.cramfs + +> Creates a ROM filesystem inside a partition. +> More information: . + +- Create a ROM filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.cramfs {{/dev/sdb1}}` + +- Create a ROM filesystem with a volume-name: + +`mkfs.cramfs -n {{volume_name}} {{/dev/sdb1}}` diff --git a/linux/mkfs.exfat b/linux/mkfs.exfat new file mode 100644 index 00000000..1c3e82f9 --- /dev/null +++ b/linux/mkfs.exfat @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.exfat + +> Creates an exfat filesystem inside a partition. +> More information: . + +- Create an exfat filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.exfat {{/dev/sdb1}}` + +- Create filesystem with a volume-name: + +`mkfs.exfat -n {{volume_name}} {{/dev/sdb1}}` + +- Create filesystem with a volume-id: + +`mkfs.exfat -i {{volume_id}} {{/dev/sdb1}}` diff --git a/linux/mkfs.ext4 b/linux/mkfs.ext4 new file mode 100644 index 00000000..5914ae97 --- /dev/null +++ b/linux/mkfs.ext4 @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.ext4 + +> Creates an ext4 filesystem inside a partition. +> More information: . + +- Create an ext4 filesystem inside partition 1 on device b (`sdb1`): + +`sudo mkfs.ext4 {{/dev/sdb1}}` + +- Create an ext4 filesystem with a volume-label: + +`sudo mkfs.ext4 -L {{volume_label}} {{/dev/sdb1}}` diff --git a/linux/mkfs.fat b/linux/mkfs.fat new file mode 100644 index 00000000..93428b1f --- /dev/null +++ b/linux/mkfs.fat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.fat + +> Creates an MS-DOS filesystem inside a partition. +> More information: . + +- Create a fat filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.fat {{/dev/sdb1}}` + +- Create filesystem with a volume-name: + +`mkfs.fat -n {{volume_name}} {{/dev/sdb1}}` + +- Create filesystem with a volume-id: + +`mkfs.fat -i {{volume_id}} {{/dev/sdb1}}` + +- Use 5 instead of 2 file allocation tables: + +`mkfs.fat -f 5 {{/dev/sdb1}}` diff --git a/linux/mkfs.minix b/linux/mkfs.minix new file mode 100644 index 00000000..c0965772 --- /dev/null +++ b/linux/mkfs.minix @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.minix + +> Creates a Minix filesystem inside a partition. +> More information: . + +- Create a Minix filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.minix {{/dev/sdb1}}` diff --git a/linux/mkfs.ntfs b/linux/mkfs.ntfs new file mode 100644 index 00000000..95ba1a93 --- /dev/null +++ b/linux/mkfs.ntfs @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.ntfs + +> Creates a NTFS filesystem inside a partition. +> More information: . + +- Create a NTFS filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.ntfs {{/dev/sdb1}}` + +- Create filesystem with a volume-label: + +`mkfs.ntfs -L {{volume_label}} {{/dev/sdb1}}` + +- Create filesystem with specific UUID: + +`mkfs.ntfs -U {{UUID}} {{/dev/sdb1}}` diff --git a/linux/mkfs.vfat b/linux/mkfs.vfat new file mode 100644 index 00000000..7b68876e --- /dev/null +++ b/linux/mkfs.vfat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfs.vfat + +> Creates an MS-DOS filesystem inside a partition. +> More information: . + +- Create a vfat filesystem inside partition 1 on device b (`sdb1`): + +`mkfs.vfat {{/dev/sdb1}}` + +- Create filesystem with a volume-name: + +`mkfs.vfat -n {{volume_name}} {{/dev/sdb1}}` + +- Create filesystem with a volume-id: + +`mkfs.vfat -i {{volume_id}} {{/dev/sdb1}}` + +- Use 5 instead of 2 file allocation tables: + +`mkfs.vfat -f 5 {{/dev/sdb1}}` diff --git a/linux/mkhomedir_helper b/linux/mkhomedir_helper new file mode 100644 index 00000000..7a39f081 --- /dev/null +++ b/linux/mkhomedir_helper @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkhomedir_helper + +> Create the user's home directory after creating the user. +> More information: . + +- Create a home directory for a user based on `/etc/skel` with umask 022: + +`sudo mkhomedir_helper {{username}}` + +- Create a home directory for a user based on `/etc/skel` with all permissions for owner (0) and read permission for group (3): + +`sudo mkhomedir_helper {{username}} {{037}}` + +- Create a home directory for a user based on a custom skeleton: + +`sudo mkhomedir_helper {{username}} {{umask}} {{path/to/skeleton_directory}}` diff --git a/linux/mkinitcpio b/linux/mkinitcpio new file mode 100644 index 00000000..7b0c2856 --- /dev/null +++ b/linux/mkinitcpio @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkinitcpio + +> Generates initial ramdisk environments for booting the Linux kernel based on the specified preset(s). +> More information: . + +- Perform a dry run (print what would be done without actually doing it): + +`mkinitcpio` + +- Generate a ramdisk environment based on the `linux` preset: + +`mkinitcpio --preset {{linux}}` + +- Generate a ramdisk environment based on the `linux-lts` preset: + +`mkinitcpio --preset {{linux-lts}}` + +- Generate ramdisk environments based on all existing presets (used to regenerate all the initramfs images after a change in `/etc/mkinitcpio.conf`): + +`mkinitcpio --allpresets` + +- Generate an initramfs image using an alternative configuration file: + +`mkinitcpio --config {{path/to/mkinitcpio.conf}} --generate {{path/to/initramfs.img}}` + +- Generate an initramfs image for a kernel other than the one currently running (the installed kernel releases can be found in `/usr/lib/modules/`): + +`mkinitcpio --kernel {{kernel_version}} --generate {{path/to/initramfs.img}}` + +- List all available hooks: + +`mkinitcpio --listhooks` + +- Display help for a specific hook: + +`mkinitcpio --hookhelp {{hook_name}}` diff --git a/linux/mkisofs b/linux/mkisofs new file mode 100644 index 00000000..5e86adcd --- /dev/null +++ b/linux/mkisofs @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkisofs + +> Create ISO files from directories. +> Also aliased as `genisoimage`. +> More information: . + +- Create an ISO from a directory: + +`mkisofs -o {{filename.iso}} {{path/to/source_directory}}` + +- Set the disc label when creating an ISO: + +`mkisofs -o {{filename.iso}} -V "{{label_name}}" {{path/to/source_directory}}` diff --git a/linux/mklost+found b/linux/mklost+found new file mode 100644 index 00000000..10a5e527 --- /dev/null +++ b/linux/mklost+found @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mklost+found + +> Create a lost+found directory. +> More information: . + +- Create a `lost+found` directory in the current directory: + +`mklost+found` diff --git a/linux/mknod b/linux/mknod new file mode 100644 index 00000000..75ccd99a --- /dev/null +++ b/linux/mknod @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mknod + +> Create block or character device special files. +> More information: . + +- Create a block device: + +`sudo mknod {{path/to/device_file}} b {{major_device_number}} {{minor_device_number}}` + +- Create a character device: + +`sudo mknod {{path/to/device_file}} c {{major_device_number}} {{minor_device_number}}` + +- Create a FIFO (queue) device: + +`sudo mknod {{path/to/device_file}} p` + +- Create a device file with default SELinux security context: + +`sudo mknod -Z {{path/to/device_file}} {{type}} {{major_device_number}} {{minor_device_number}}` diff --git a/linux/mkosi b/linux/mkosi new file mode 100644 index 00000000..08733131 --- /dev/null +++ b/linux/mkosi @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkosi + +> Build modern, legacy-free Linux images. +> Part of `systemd`. +> More information: . + +- Show current build configuration to verify what would be built: + +`mkosi summary` + +- Build an image with default settings (if no distribution is selected, the distribution of the host system is used): + +`mkosi build --distribution {{fedora|debian|ubuntu|arch|opensuse|...}}` + +- Build an image and run an interactive shell in a systemd-nspawn container of the image: + +`mkosi shell` + +- Boot an image in a virtual machine using QEMU (only supported for disk images or CPIO images when a kernel is provided): + +`mkosi qemu` + +- Display help: + +`mkosi help` diff --git a/linux/mksquashfs b/linux/mksquashfs new file mode 100644 index 00000000..499335f7 --- /dev/null +++ b/linux/mksquashfs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mksquashfs + +> Create or append files and directories to squashfs filesystems. +> More information: . + +- Create or append files and directories to a squashfs filesystem (compressed using `gzip` by default): + +`mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}}` + +- Create or append files and directories to a squashfs filesystem, using a specific [comp]ression algorithm: + +`mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -comp {{gzip|lzo|lz4|xz|zstd|lzma}}` + +- Create or append files and directories to a squashfs filesystem, [e]xcluding some of them: + +`mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -e {{file|directory1 file|directory2 ...}}` + +- Create or append files and directories to a squashfs filesystem, [e]xcluding those ending with `.gz`: + +`mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -wildcards -e "{{*.gz}}"` + +- Create or append files and directories to a squashfs filesystem, [e]xcluding those matching a regular expression: + +`mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -regex -e "{{regular_expression}}"` diff --git a/linux/mkswap b/linux/mkswap new file mode 100644 index 00000000..bfc3b2a8 --- /dev/null +++ b/linux/mkswap @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mkswap + +> Set up a Linux swap area on a device or in a file. +> Note: `path/to/file` can either point to a regular file or a swap partition. +> More information: . + +- Set up a given swap area: + +`sudo mkswap {{path/to/file}}` + +- Check a partition for bad blocks before creating the swap area: + +`sudo mkswap -c {{path/to/file}}` + +- Specify a label for the partition (to allow `swapon` to use the label): + +`sudo mkswap -L {{label}} {{/dev/sda1}}` diff --git a/linux/mktemp b/linux/mktemp new file mode 100644 index 00000000..17ffc747 --- /dev/null +++ b/linux/mktemp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mktemp + +> Create a temporary file or directory. +> More information: . + +- Create an empty temporary file and print its absolute path: + +`mktemp` + +- Use a custom directory (defaults to `$TMPDIR`, or `/tmp`): + +`mktemp --tmpdir={{/path/to/tempdir}}` + +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` + +- Use a custom file name template: + +`mktemp -t {{example.XXXXXXXX}}` + +- Create an empty temporary file with the given suffix and print its absolute path: + +`mktemp --suffix {{.ext}}` + +- Create an empty temporary directory and print its absolute path: + +`mktemp --directory` diff --git a/linux/mlabel b/linux/mlabel new file mode 100644 index 00000000..d80f14d8 --- /dev/null +++ b/linux/mlabel @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mlabel + +> Set an MS-DOS volume label for FAT and VFAT filesystems. +> More information: . + +- Set a filesystem label: + +`mlabel -i /dev/{{sda}} ::"{{new_label}}"` diff --git a/linux/mmcli b/linux/mmcli new file mode 100644 index 00000000..1643f6ad --- /dev/null +++ b/linux/mmcli @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mmcli + +> Control and monitor the ModemManager. +> More information: . + +- List available modems: + +`mmcli --list-modems` + +- Print information about a modem: + +`mmcli --modem={{modem}}` + +- Enable a modem: + +`mmcli --modem={{modem}} --enable` + +- List SMS messages available on the modem: + +`sudo mmcli --modem={{modem}} --messaging-list-sms` + +- Delete a message from the modem, specifying its path: + +`sudo mmcli --modem={{modem}} --messaging-delete-sms={{path/to/message_file}}` diff --git a/linux/mmdebstrap b/linux/mmdebstrap new file mode 100644 index 00000000..2fd41fed --- /dev/null +++ b/linux/mmdebstrap @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mmdebstrap + +> Create a Debian chroot. +> Alternative to `debootstrap`. +> More information: . + +- Create a Debian Stable directory chroot: + +`sudo mmdebstrap stable {{path/to/debian-root/}}` + +- Create a Debian Bookworm tarball chroot using a mirror: + +`mmdebstrap bookworm {{path/to/debian-bookworm.tar}} {{http://mirror.example.org/debian}}` + +- Create a Debian Sid tarball chroot with additional packages: + +`mmdebstrap sid {{path/to/debian-sid.tar}} --include={{pkg1,pkg2}}` diff --git a/linux/mocp b/linux/mocp new file mode 100644 index 00000000..a9828e58 --- /dev/null +++ b/linux/mocp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mocp + +> Music on Console (MOC) audio player. +> More information: . + +- Launch the MOC terminal UI: + +`mocp` + +- Launch the MOC terminal UI in a specific directory: + +`mocp {{path/to/directory}}` + +- Start the MOC server in the background, without launching the MOC terminal UI: + +`mocp --server` + +- Add a specific song to the play queue while MOC is in the background: + +`mocp --enqueue {{path/to/audio_file}}` + +- Add songs recursively to the play queue while MOC is in the background: + +`mocp --append {{path/to/directory}}` + +- Clear the play queue while MOC is in the background: + +`mocp --clear` + +- Play or stop the currently queued song while MOC is in the background: + +`mocp --{{play|stop}}` + +- Stop the MOC server while it's in the background: + +`mocp --exit` diff --git a/linux/modinfo b/linux/modinfo new file mode 100644 index 00000000..f7cb4dc9 --- /dev/null +++ b/linux/modinfo @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# modinfo + +> Extract information about a Linux kernel module. +> More information: . + +- List all attributes of a kernel module: + +`modinfo {{kernel_module}}` + +- List the specified attribute only: + +`modinfo -F {{author|description|license|parm|filename}} {{kernel_module}}` diff --git a/linux/modprobe b/linux/modprobe new file mode 100644 index 00000000..c65dcf4f --- /dev/null +++ b/linux/modprobe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# modprobe + +> Add or remove modules from the Linux kernel. +> More information: . + +- Pretend to load a module into the kernel, but don't actually do it: + +`sudo modprobe --dry-run {{module_name}}` + +- Load a module into the kernel: + +`sudo modprobe {{module_name}}` + +- Remove a module from the kernel: + +`sudo modprobe --remove {{module_name}}` + +- Remove a module and those that depend on it from the kernel: + +`sudo modprobe --remove-dependencies {{module_name}}` + +- Show a kernel module's dependencies: + +`sudo modprobe --show-depends {{module_name}}` diff --git a/linux/module b/linux/module new file mode 100644 index 00000000..b86822bf --- /dev/null +++ b/linux/module @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# module + +> Modify a users' environment using the module command. +> More information: . + +- Display available modules: + +`module avail` + +- Search for a module by name: + +`module avail {{module_name}}` + +- Load a module: + +`module load {{module_name}}` + +- Display loaded modules: + +`module list` + +- Unload a specific loaded module: + +`module unload {{module_name}}` + +- Unload all loaded modules: + +`module purge` + +- Specify user-created modules: + +`module use {{path/to/module_file1 path/to/module_file2 ...}}` diff --git a/linux/mokutil b/linux/mokutil new file mode 100644 index 00000000..21eb474e --- /dev/null +++ b/linux/mokutil @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mokutil + +> Configure Secure Boot Machine Owner Keys (MOK). +> Some operations, such as enabling and disabling Secure Boot or enrolling keys require a reboot. +> More information: . + +- Show if Secure Boot is enabled: + +`mokutil --sb-state` + +- Enable Secure Boot: + +`mokutil --enable-validation` + +- Disable Secure Boot: + +`mokutil --disable-validation` + +- List enrolled keys: + +`mokutil --list-enrolled` + +- Enroll a new key: + +`mokutil --import {{path/to/key.der}}` + +- List the keys to be enrolled: + +`mokutil --list-new` + +- Set shim verbosity: + +`mokutil --set-verbosity true` diff --git a/linux/mono b/linux/mono new file mode 100644 index 00000000..0bdd45cc --- /dev/null +++ b/linux/mono @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mono + +> Runtime for the .NET Framework. +> More information: . + +- Run a .NET assembly in debug mode: + +`mono --debug {{path/to/program.exe}}` + +- Run a .NET assembly: + +`mono {{path/to/program.exe}}` diff --git a/linux/mons b/linux/mons new file mode 100644 index 00000000..fa04a54f --- /dev/null +++ b/linux/mons @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mons + +> Quickly manage two displays. +> More information: . + +- Enable only the primary monitor: + +`mons -o` + +- Enable only the secondary monitor: + +`mons -s` + +- Duplicate the primary monitor onto the secondary monitor, using the resolution of the primary monitor: + +`mons -d` + +- Mirror the primary monitor onto the secondary monitor, using the resolution of the secondary monitor: + +`mons -m` diff --git a/linux/more b/linux/more new file mode 100644 index 00000000..faa92dba --- /dev/null +++ b/linux/more @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# more + +> Interactively display a file, allowing scrolling and searching. +> See also: `less`. +> More information: . + +- Open a file: + +`more {{path/to/file}}` + +- Display a specific line: + +`more +{{line_number}} {{path/to/file}}` + +- Go to the next page: + +`` + +- Search for a string (press `n` to go to the next match): + +`/{{something}}` + +- Exit: + +`q` + +- Display help about interactive commands: + +`h` diff --git a/linux/mount.cifs b/linux/mount.cifs new file mode 100644 index 00000000..83a94a13 --- /dev/null +++ b/linux/mount.cifs @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mount.cifs + +> Mount SMB (Server Message Block) or CIFS (Common Internet File System) shares. +> Note: you can also do the same thing by passing the `-t cifs` option to `mount`. +> More information: . + +- Connect using the specified username or `$USER` by default (you will be prompted for a password): + +`mount.cifs -o user={{username}} //{{server}}/{{share_name}} {{mountpoint}}` + +- Connect as the guest user (without a password): + +`mount.cifs -o guest //{{server}}/{{share_name}} {{mountpoint}}` + +- Set ownership information for the mounted directory: + +`mount.cifs -o uid={{user_id|username}},gid={{group_id|groupname}} //{{server}}/{{share_name}} {{mountpoint}}` diff --git a/linux/mount.ddi b/linux/mount.ddi new file mode 100644 index 00000000..548b0234 --- /dev/null +++ b/linux/mount.ddi @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mount.ddi + +> Mount Discoverable Disk Images. +> See `tldr systemd-dissect` for other commands relevant to DDIs. +> More information: . + +- Mount an OS image: + +`mount.ddi {{path/to/image.raw}} {{/mnt/image}}` diff --git a/linux/mount.smb3 b/linux/mount.smb3 new file mode 100644 index 00000000..52c5581a --- /dev/null +++ b/linux/mount.smb3 @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mount.smb3 + +> This command is an alias of `mount.cifs`. +> Note: for SMB versions before 3 you have to use `mount.cifs` instead. + +- View documentation for the original command: + +`tldr mount.cifs` diff --git a/linux/mountpoint b/linux/mountpoint new file mode 100644 index 00000000..c25bc326 --- /dev/null +++ b/linux/mountpoint @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mountpoint + +> Test if a directory is a filesystem mountpoint. +> More information: . + +- Check if a directory is a mountpoint: + +`mountpoint {{path/to/directory}}` + +- Check if a directory is a mountpoint without showing any output: + +`mountpoint -q {{path/to/directory}}` + +- Show major/minor numbers of a mountpoint's filesystem: + +`mountpoint --fs-devno {{path/to/directory}}` diff --git a/linux/mpg123 b/linux/mpg123 new file mode 100644 index 00000000..fcd1092a --- /dev/null +++ b/linux/mpg123 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mpg123 + +> Console MPEG audio player. +> More information: . + +- Play the specified mp3 files: + +`mpg123 {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- Play the mp3 from `stdin`: + +`cat {{file.mp3}} | mpg123 -` + +- Jump forward to the next song: + +`f` + +- Jump back to the beginning for the song: + +`b` + +- Stop or replay the current file: + +`s` + +- Fast forward: + +`.` + +- Quit: + +`q` diff --git a/linux/mpicc b/linux/mpicc new file mode 100644 index 00000000..b7cef32f --- /dev/null +++ b/linux/mpicc @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mpicc + +> Open MPI C wrapper compiler. +> The wrappers are simply thin shells on top of a C compiler, they add the relevant compiler and linker flags to the command-line that are necessary to compile/link Open MPI programs, and then invoke the underlying C compiler to actually perform the command. +> More information: . + +- Compile a source code file into an object file: + +`mpicc -c {{path/to/file.c}}` + +- Link an object file and make an executable: + +`mpicc -o {{executable}} {{path/to/object_file.o}}` + +- Compile and link source code in a single command: + +`mpicc -o {{executable}} {{path/to/file.c}}` diff --git a/linux/mpstat b/linux/mpstat new file mode 100644 index 00000000..43b91c2c --- /dev/null +++ b/linux/mpstat @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mpstat + +> Report CPU statistics. +> More information: . + +- Display CPU statistics every 2 seconds: + +`mpstat {{2}}` + +- Display 5 reports, one by one, at 2 second intervals: + +`mpstat {{2}} {{5}}` + +- Display 5 reports, one by one, from a given processor, at 2 second intervals: + +`mpstat -P {{0}} {{2}} {{5}}` diff --git a/linux/mssh b/linux/mssh new file mode 100644 index 00000000..27d13f64 --- /dev/null +++ b/linux/mssh @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mssh + +> GTK+ based SSH client for interacting with multiple SSH servers at once. +> More information: . + +- Open a new window and connect to multiple SSH servers: + +`mssh {{user@host1}} {{user@host2}} {{...}}` + +- Open a new window and connect to a group of servers predefined in `~/.mssh_clusters`: + +`mssh --alias {{alias_name}}` diff --git a/linux/mt b/linux/mt new file mode 100644 index 00000000..e1ef29c8 --- /dev/null +++ b/linux/mt @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mt + +> Control magnetic tape drive operation (commonly LTO tape). +> More information: . + +- Check the status of a tape drive: + +`mt -f {{/dev/nstX}} status` + +- Rewind the tape to beginning: + +`mt -f {{/dev/nstX}} rewind` + +- Move forward a given files, then position the tape on first block of next file: + +`mt -f {{/dev/nstX}} fsf {{count}}` + +- Rewind the tape, then position the tape at beginning of the given file: + +`mt -f {{/dev/nstX}} asf {{count}}` + +- Position the tape at the end of valid data: + +`mt -f {{/dev/nstX}} eod` + +- Rewind the tape and unload/eject it: + +`mt -f {{/dev/nstX}} eject` + +- Write EOF (End-of-file) mark at the current position: + +`mt -f {{/dev/nstX} eof` diff --git a/linux/mycli b/linux/mycli new file mode 100644 index 00000000..4ac7c98f --- /dev/null +++ b/linux/mycli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mycli + +> A CLI for MySQL, MariaDB, and Percona with auto-completion and syntax highlighting. +> More information: . + +- Connect to a database with the currently logged in user: + +`mycli {{database_name}}` + +- Connect to a database with the specified user: + +`mycli -u {{user}} {{database_name}}` + +- Connect to a database on the specified host with the specified user: + +`mycli -u {{user}} -h {{host}} {{database_name}}` diff --git a/linux/nala b/linux/nala new file mode 100644 index 00000000..30c612fd --- /dev/null +++ b/linux/nala @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nala + +> Package management utility with better formatting. +> Front-end for the `python-apt` API. +> More information: . + +- Install a package, or update it to the latest available version: + +`sudo nala install {{package}}` + +- Remove a package: + +`sudo nala remove {{package}}` + +- Remove a package and its configuration files: + +`nala purge {{package}}` + +- Search package names and descriptions using a word, regex (default) or glob: + +`nala search "{{pattern}}"` + +- Update the list of available packages and upgrade the system: + +`sudo nala upgrade` + +- Remove all unused packages and dependencies from your system: + +`sudo nala autoremove` + +- Fetch fast mirrors to improve download speeds: + +`sudo nala fetch` + +- Display the history of all transactions: + +`nala history` diff --git a/linux/namcap b/linux/namcap new file mode 100644 index 00000000..d26b51d7 --- /dev/null +++ b/linux/namcap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# namcap + +> Check binary packages and source `PKGBUILD`s for common packaging mistakes. +> More information: . + +- Check a specific `PKGBUILD` file: + +`namcap {{path/to/pkgbuild}}` + +- Check a specific package file: + +`namcap {{path/to/package.pkg.tar.zst}}` + +- Check a file, printing extra [i]nformational messages: + +`namcap -i {{path/to/file}}` diff --git a/linux/named b/linux/named new file mode 100644 index 00000000..8bef4762 --- /dev/null +++ b/linux/named @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# named + +> Execute the DNS (Dynamic Name Service) server daemon that converts host names to IP addresses and vice versa. +> More information: . + +- Read the default configuration file `/etc/named.conf`, read any initial data and listen for queries: + +`named` + +- Read a custom configuration file: + +`named -c {{path/to/named.conf}}` + +- Use IPv4 or IPv6 only, even if the host machine is capable of utilising other protocols: + +`named {{-4|-6}}` + +- Listen for queries on a specific port instead of the default port 53: + +`named -p {{port}}` + +- Run the server in the foreground and do not daemonize: + +`named -f` diff --git a/linux/namei b/linux/namei new file mode 100644 index 00000000..9afb060b --- /dev/null +++ b/linux/namei @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# namei + +> Follows a pathname (which can be a symbolic link) until a terminal point is found (a file/directory/char device etc). +> This program is useful for finding "too many levels of symbolic links" problems. +> More information: . + +- Resolve the pathnames specified as the argument parameters: + +`namei {{path/to/a}} {{path/to/b}} {{path/to/c}}` + +- Display the results in a long-listing format: + +`namei --long {{path/to/a}} {{path/to/b}} {{path/to/c}}` + +- Show the mode bits of each file type in the style of `ls`: + +`namei --modes {{path/to/a}} {{path/to/b}} {{path/to/c}}` + +- Show owner and group name of each file: + +`namei --owners {{path/to/a}} {{path/to/b}} {{path/to/c}}` + +- Don't follow symlinks while resolving: + +`namei --nosymlinks {{path/to/a}} {{path/to/b}} {{path/to/c}}` diff --git a/linux/nautilus b/linux/nautilus new file mode 100644 index 00000000..bca4c3fe --- /dev/null +++ b/linux/nautilus @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nautilus + +> Default file explorer for GNOME desktop environment. +> Also known as GNOME Files. +> More information: . + +- Launch Nautilus: + +`nautilus` + +- Launch Nautilus as root user: + +`sudo nautilus` + +- Launch Nautilus and display a specific directory: + +`nautilus {{path/to/directory}}` + +- Launch Nautilus with a specific file or directory selected: + +`nautilus --select {{path/to/file_or_directory}}` + +- Launch Nautilus in a separated window: + +`nautilus --new-window` + +- Close all Nautilus instances: + +`nautilus --quit` + +- Display help: + +`nautilus --help` diff --git a/linux/ncal b/linux/ncal new file mode 100644 index 00000000..24357c8f --- /dev/null +++ b/linux/ncal @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ncal + +> This command is an alias of `cal`. +> More information: . + +- View documentation for the original command: + +`tldr cal` diff --git a/linux/ncat b/linux/ncat new file mode 100644 index 00000000..3d471149 --- /dev/null +++ b/linux/ncat @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ncat + +> Read, write, redirect, and encrypt data across a network. +> An alternative implementation of a similar utility called `netcat`/`nc`. +> More information: . + +- Listen for input on the specified port and write it to the specified file: + +`ncat -l {{port}} > {{path/to/file}}` + +- Accept multiple connections and keep ncat open after they have been closed: + +`ncat -lk {{port}}` + +- Write output of specified file to the specified host on the specified port: + +`ncat {{address}} {{port}} < {{path/to/file}}` + +- Accept multiple incoming connections on an encrypted channel evading detection of traffic content: + +`ncat --ssl -k -l {{port}}` + +- Connect to an open `ncat` connection over SSL: + +`ncat --ssl {{host}} {{port}}` + +- Check connectivity to a remote host on a particular port with timeout: + +`ncat -w {{seconds}} -vz {{host}} {{port}}` diff --git a/linux/ndctl b/linux/ndctl new file mode 100644 index 00000000..f563df0a --- /dev/null +++ b/linux/ndctl @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ndctl + +> Utility for managing Non-Volatile DIMMs. +> More information: . + +- Create an 'fsdax' mode namespace: + +`ndctl create-namespace --mode={{fsdax}}` + +- Change the mode of a namespace to 'raw': + +`ndctl create-namespace --reconfigure={{namespaceX.Y}} --mode={{raw}}` + +- Check a sector mode namespace for consistency, and repair if needed: + +`ndctl check-namespace --repair {{namespaceX.Y}}` + +- List all namespaces, regions, and buses (including disabled ones): + +`ndctl list --namespaces --regions --buses --idle` + +- List a specific namespace and include lots of additional information: + +`ndctl list -vvv --namespace={{namespaceX.Y}}` + +- Run a monitor to watch for SMART health events for NVDIMMs on the 'ACPI.NFIT' bus: + +`ndctl monitor --bus={{ACPI.NFIT}}` + +- Remove a namespace (when applicable) or reset it to an initial state: + +`ndctl destroy-namespace --force {{namespaceX.Y}}` diff --git a/linux/needrestart b/linux/needrestart new file mode 100644 index 00000000..c44bbcf3 --- /dev/null +++ b/linux/needrestart @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# needrestart + +> Check which daemons need to be restarted after library upgrades. +> More information: . + +- List outdated processes: + +`needrestart` + +- Interactively restart services: + +`sudo needrestart` + +- List outdated processes in [v]erbose or [q]uiet mode: + +`needrestart -{{v|q}}` + +- Check if the [k]ernel is outdated: + +`needrestart -k` + +- Check if the CPU microcode is outdated: + +`needrestart -w` + +- List outdated processes in [b]atch mode: + +`needrestart -b` + +- List outdated processed using a specific [c]onfiguration file: + +`needrestart -c {{path/to/config}}` + +- Display help: + +`needrestart --help` diff --git a/linux/nemo b/linux/nemo new file mode 100644 index 00000000..794ad4c0 --- /dev/null +++ b/linux/nemo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nemo + +> Manages files and directories in Cinnamon desktop environment. +> More information: . + +- Open the current user home directory: + +`nemo` + +- Open specific directories in separate windows: + +`nemo {{path/to/directory1 path/to/directory2 ...}}` + +- Open specific directories in tabs: + +`nemo --tabs {{path/to/directory1 path/to/directory2 ...}}` + +- Open a directory with a specific window size: + +`nemo --geometry={{600}}x{{400}} {{path/to/directory}}` + +- Close all windows: + +`nemo --quit` diff --git a/linux/nethogs b/linux/nethogs new file mode 100644 index 00000000..4c2094d7 --- /dev/null +++ b/linux/nethogs @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nethogs + +> Monitor bandwidth usage per process. +> More information: . + +- Start NetHogs as root (default device is `eth0`): + +`sudo nethogs` + +- Monitor bandwidth on specific device: + +`sudo nethogs {{device}}` + +- Monitor bandwidth on multiple devices: + +`sudo nethogs {{device1}} {{device2}}` + +- Specify refresh rate: + +`sudo nethogs -t {{seconds}}` diff --git a/linux/netselect b/linux/netselect new file mode 100644 index 00000000..e025f0d5 --- /dev/null +++ b/linux/netselect @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# netselect + +> Speed test for choosing a fast network server. +> More information: . + +- Choose the server with the lowest latency: + +`sudo netselect {{host_1}} {{host_2}}` + +- Display nameserver resolution and statistics: + +`sudo netselect -vv {{host_1}} {{host_2}}` + +- Define maximum TTL (time to live): + +`sudo netselect -m {{10}} {{host_1}} {{host_2}}` + +- Print fastest N servers among the hosts: + +`sudo netselect -s {{N}} {{host_1}} {{host_2}} {{host_3}}` + +- Display help: + +`netselect` diff --git a/linux/netselect-apt b/linux/netselect-apt new file mode 100644 index 00000000..2be479db --- /dev/null +++ b/linux/netselect-apt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# netselect-apt + +> Create a `sources.list` file for a Debian mirror with the lowest latency. +> More information: . + +- Create `sources.list` using the lowest latency server: + +`sudo netselect-apt` + +- Specify Debian branch, stable is used by default: + +`sudo netselect-apt {{testing}}` + +- Include non-free section: + +`sudo netselect-apt --non-free` + +- Specify a country for the mirror list lookup: + +`sudo netselect-apt -c {{India}}` diff --git a/linux/networkctl b/linux/networkctl new file mode 100644 index 00000000..0a59964f --- /dev/null +++ b/linux/networkctl @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# networkctl + +> Query the status of network links. +> Manage the network configuration using `systemd-networkd`. +> More information: . + +- List existing links with their status: + +`networkctl list` + +- Show an overall network status: + +`networkctl status` + +- Bring network devices up: + +`networkctl up {{interface1 interface2 ...}}` + +- Bring network devices down: + +`networkctl down {{interface1 interface2 ...}}` + +- Renew dynamic configurations (e.g. IP addresses received from a DHCP server): + +`networkctl renew {{interface1 interface2 ...}}` + +- Reload configuration files (.netdev and .network): + +`networkctl reload` + +- Reconfigure network interfaces (if you edited the config, you need to call `networkctl reload` first): + +`networkctl reconfigure {{interface1 interface2 ...}}` diff --git a/linux/newgrp b/linux/newgrp new file mode 100644 index 00000000..68b3af95 --- /dev/null +++ b/linux/newgrp @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# newgrp + +> Switch primary group membership. +> More information: . + +- Change user's primary group membership: + +`newgrp {{group_name}}` + +- Reset primary group membership to user's default group in `/etc/passwd`: + +`newgrp` diff --git a/linux/nft b/linux/nft new file mode 100644 index 00000000..3c980f61 --- /dev/null +++ b/linux/nft @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nft + +> Allows configuration of tables, chains and rules provided by the Linux kernel firewall. +> Nftables replaces iptables. +> More information: . + +- View current configuration: + +`sudo nft list ruleset` + +- Add a new table with family "inet" and table "filter": + +`sudo nft add table {{inet}} {{filter}}` + +- Add a new chain to accept all inbound traffic: + +`sudo nft add chain {{inet}} {{filter}} {{input}} \{ type {{filter}} hook {{input}} priority {{0}} \; policy {{accept}} \}` + +- Add a new rule to accept several TCP ports: + +`sudo nft add rule {{inet}} {{filter}} {{input}} {{tcp}} {{dport \{ telnet, ssh, http, https \} accept}}` + +- Add a NAT rule to translate all traffic from the `192.168.0.0/24` subnet to the host's public IP: + +`sudo nft add rule {{nat}} {{postrouting}} ip saddr {{192.168.0.0/24}} {{masquerade}}` + +- Show rule handles: + +`sudo nft --handle --numeric list chain {{family}} {{table}} {{chain}}` + +- Delete a rule: + +`sudo nft delete rule {{inet}} {{filter}} {{input}} handle {{3}}` + +- Save current configuration: + +`sudo nft list ruleset > {{/etc/nftables.conf}}` diff --git a/linux/nitch b/linux/nitch new file mode 100644 index 00000000..b2f6671a --- /dev/null +++ b/linux/nitch @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nitch + +> A small and incredibly fast system fetch written fully in Nim. +> More information: . + +- Display system information (hostname, kernel, uptime, etc.): + +`nitch` + +- Display [h]elp: + +`nitch --help` + +- Display [v]ersion: + +`nitch --version` diff --git a/linux/nitrogen b/linux/nitrogen new file mode 100644 index 00000000..942d021a --- /dev/null +++ b/linux/nitrogen @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nitrogen + +> Desktop background browser and setter for X Window. +> More information: . + +- View and set the wallpapers from a specific directory: + +`nitrogen {{path/to/directory}}` + +- Set the wallpaper with automatic size settings: + +`nitrogen --set-auto {{path/to/file}}` + +- Restore the previous wallpaper: + +`nitrogen --restore` diff --git a/linux/nixos-container b/linux/nixos-container new file mode 100644 index 00000000..47c4889f --- /dev/null +++ b/linux/nixos-container @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nixos-container + +> Starts NixOS containers using Linux containers. +> More information: . + +- List running containers: + +`sudo nixos-container list` + +- Create a NixOS container with a specific configuration file: + +`sudo nixos-container create {{container_name}} --config-file {{nix_config_file_path}}` + +- Start, stop, terminate, or destroy a specific container: + +`sudo nixos-container {{start|stop|terminate|destroy|status}} {{container_name}}` + +- Run a command in a running container: + +`sudo nixos-container run {{container_name}} -- {{command}} {{command_arguments}}` + +- Update a container configuration: + +`sudo $EDITOR /var/lib/container/{{container_name}}/etc/nixos/configuration.nix && sudo nixos-container update {{container_name}}` + +- Enter an interactive shell session on an already-running container: + +`sudo nixos-container root-login {{container_name}}` diff --git a/linux/nixos-option b/linux/nixos-option new file mode 100644 index 00000000..48292d0c --- /dev/null +++ b/linux/nixos-option @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nixos-option + +> Inspect a NixOS configuration. +> More information: . + +- List all subkeys of a given option key: + +`nixos-option {{option_key}}` + +- List current boot kernel modules: + +`nixos-option boot.kernelModules` + +- List authorized keys for a specific user: + +`nixos-option users.users.{{username}}.openssh.authorizedKeys.{{keyFiles|keys}}` + +- List all remote builders: + +`nixos-option nix.buildMachines` + +- List all subkeys of a given key on another NixOS configuration: + +`NIXOS_CONFIG={{path_to_configuration.nix}} nixos-option {{option_key}}` + +- Show recursively all values of a user: + +`nixos-option -r users.users.{{user}}` diff --git a/linux/nixos-rebuild b/linux/nixos-rebuild new file mode 100644 index 00000000..bb6b2a17 --- /dev/null +++ b/linux/nixos-rebuild @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nixos-rebuild + +> Reconfigure a NixOS machine. +> More information: . + +- Build and switch to the new configuration, making it the boot default: + +`sudo nixos-rebuild switch` + +- Build and switch to the new configuration, making it the boot default and naming the boot entry: + +`sudo nixos-rebuild switch -p {{name}}` + +- Build and switch to the new configuration, making it the boot default and installing updates: + +`sudo nixos-rebuild switch --upgrade` + +- Rollback changes to the configuration, switching to the previous generation: + +`sudo nixos-rebuild switch --rollback` + +- Build the new configuration and make it the boot default without switching to it: + +`sudo nixos-rebuild boot` + +- Build and activate the new configuration, but don't make a boot entry (for testing purposes): + +`sudo nixos-rebuild test` + +- Build the configuration and open it in a virtual machine: + +`sudo nixos-rebuild build-vm` diff --git a/linux/nl b/linux/nl new file mode 100644 index 00000000..dd639d05 --- /dev/null +++ b/linux/nl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nl + +> Number lines from a file or from `stdin`. +> More information: . + +- Number non-blank lines in a file: + +`nl {{path/to/file}}` + +- Read from `stdin`: + +`{{command}} | nl -` + +- Number [a]ll [b]ody lines including blank lines or do not [n]umber [b]ody lines: + +`nl --body-numbering {{a|n}} {{path/to/file}}` + +- Number only the [b]ody lines that match a basic regular expression (BRE) [p]attern: + +`nl --body-numbering p'FooBar[0-9]' {{path/to/file}}` + +- Use a specific [i]ncrement for line numbering: + +`nl --line-increment {{increment}} {{path/to/file}}` + +- Specify the line numbering format to [r]ight or [l]eft justified, keeping leading [z]eros or [n]ot: + +`nl --number-format {{rz|ln|rn}}` + +- Specify the line numbering's width (6 by default): + +`nl --number-width {{col_width}} {{path/to/file}}` + +- Use a specific string to separate the line numbers from the lines (TAB by default): + +`nl --number-separator {{separator}} {{path/to/file}}` diff --git a/linux/nm-online b/linux/nm-online new file mode 100644 index 00000000..abbccac1 --- /dev/null +++ b/linux/nm-online @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nm-online + +> Ask NetworkManager whether the network is connected. +> More information: . + +- Find out whether the network is connected and print the result to `stdout`: + +`nm-online` + +- Wait `n` seconds for a connection (30 by default): + +`nm-online --timeout {{n}}` diff --git a/linux/nmcli b/linux/nmcli new file mode 100644 index 00000000..56e0a6da --- /dev/null +++ b/linux/nmcli @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli + +> Manage the network configuration using NetworkManager. +> More information: . + +- View documentation for running `nmcli` as a NetworkManager secret/polkit agent: + +`tldr nmcli agent` + +- View documentation for managing network connections: + +`tldr nmcli connection` + +- View documentation for managing network interfaces and establishing new Wi-Fi connections: + +`tldr nmcli device` + +- View documentation for managing general settings of NetworkManager: + +`tldr nmcli general` + +- View documentation for NetworkManager's activity monitor: + +`tldr nmcli monitor` + +- View documentation for enabling/disabling and checking the status of networking: + +`tldr nmcli networking` + +- View documentation for managing radio switches: + +`tldr nmcli radio` diff --git a/linux/nmcli-agent b/linux/nmcli-agent new file mode 100644 index 00000000..42023c4c --- /dev/null +++ b/linux/nmcli-agent @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli agent + +> Run `nmcli` as a NetworkManager secret agent or polkit agent. +> This subcommand can also be called with `nmcli a`. +> More information: . + +- Register `nmcli` as a secret agent and listen for secret requests: + +`nmcli agent secret` + +- Register `nmcli` as a polkit agent and listen for authorization requests: + +`nmcli agent polkit` + +- Register `nmcli` as a secret agent and a polkit agent: + +`nmcli agent all` diff --git a/linux/nmcli-connection b/linux/nmcli-connection new file mode 100644 index 00000000..f272a859 --- /dev/null +++ b/linux/nmcli-connection @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli connection + +> Manage connections with NetworkManager. +> This subcommand can also be called with `nmcli c`. +> More information: . + +- List all NetworkManager connections (shows name, UUID, type and device): + +`nmcli connection` + +- Activate a connection: + +`nmcli connection up uuid {{uuid}}` + +- Deactivate a connection: + +`nmcli connection down uuid {{uuid}}` + +- Create an auto-configured dual stack connection: + +`nmcli connection add ifname {{interface_name}} type {{ethernet}} ipv4.method {{auto}} ipv6.method {{auto}}` + +- Create a static IPv6-only connection: + +`nmcli connection add ifname {{interface_name}} type {{ethernet}} ip6 {{2001:db8::2/64}} gw6 {{2001:db8::1}} ipv6.dns {{2001:db8::1}} ipv4.method {{ignore}}` + +- Create a static IPv4-only connection: + +`nmcli connection add ifname {{interface_name}} type {{ethernet}} ip4 {{10.0.0.7/8}} gw4 {{10.0.0.1}} ipv4.dns {{10.0.0.1}} ipv6.method {{ignore}}` + +- Create a VPN connection using OpenVPN from an OVPN file: + +`nmcli connection import type {{openvpn}} file {{path/to/vpn_config.ovpn}}` diff --git a/linux/nmcli-device b/linux/nmcli-device new file mode 100644 index 00000000..9a6dd211 --- /dev/null +++ b/linux/nmcli-device @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli device + +> Manage network interfaces and establish new Wi-Fi connections using NetworkManager. +> This subcommand can also be called with `nmcli d`. +> More information: . + +- Print the statuses of all network interfaces: + +`nmcli device status` + +- Print the available Wi-Fi access points: + +`nmcli device wifi` + +- Connect to a Wi-Fi network with the specified SSID (you will be prompted for a password): + +`nmcli --ask device wifi connect {{ssid}}` + +- Print the password and QR code for the current Wi-Fi network: + +`nmcli device wifi show-password` diff --git a/linux/nmcli-general b/linux/nmcli-general new file mode 100644 index 00000000..e7254649 --- /dev/null +++ b/linux/nmcli-general @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli general + +> Manage general settings of NetworkManager. +> This subcommand can also be called with `nmcli g`. +> More information: . + +- Show the general status of NetworkManager: + +`nmcli general` + +- Show the hostname of the current device: + +`nmcli general hostname` + +- Change the hostname of the current device: + +`sudo nmcli general hostname {{new_hostname}}` + +- Show the permissions of NetworkManager: + +`nmcli general permissions` + +- Show the current logging level and domains: + +`nmcli general logging` + +- Set the logging level and/or domains (see `man NetworkManager.conf` for all available domains): + +`nmcli general logging level {{INFO|OFF|ERR|WARN|DEBUG|TRACE}} domain {{domain_1,domain_2,...}}` diff --git a/linux/nmcli-monitor b/linux/nmcli-monitor new file mode 100644 index 00000000..97645ead --- /dev/null +++ b/linux/nmcli-monitor @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli monitor + +> Monitor changes to the NetworkManager connection status. +> This subcommand can also be called with `nmcli m`. +> More information: . + +- Start monitoring NetworkManager changes: + +`nmcli monitor` diff --git a/linux/nmcli-networking b/linux/nmcli-networking new file mode 100644 index 00000000..2d05a347 --- /dev/null +++ b/linux/nmcli-networking @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli networking + +> Manage the networking status of NetworkManager. +> This subcommand can also be called with `nmcli n`. +> More information: . + +- Show the networking status of NetworkManager: + +`nmcli networking` + +- Enable or disable networking and all interfaces managed by NetworkManager: + +`nmcli networking {{on|off}}` + +- Show the last known connectivity state: + +`nmcli networking connectivity` + +- Show the current connectivity state: + +`nmcli networking connectivity check` diff --git a/linux/nmcli-radio b/linux/nmcli-radio new file mode 100644 index 00000000..784d7fea --- /dev/null +++ b/linux/nmcli-radio @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmcli radio + +> Show the status of radio switches or enable/disable them using NetworkManager. +> This subcommand can also be called with `nmcli r`. +> More information: . + +- Show status of Wi-Fi: + +`nmcli radio wifi` + +- Turn Wi-Fi on or off: + +`nmcli radio wifi {{on|off}}` + +- Show status of WWAN: + +`nmcli radio wwan` + +- Turn WWAN on or off: + +`nmcli radio wwan {{on|off}}` + +- Show status of both switches: + +`nmcli radio all` + +- Turn both switches on or off: + +`nmcli radio all {{on|off}}` diff --git a/linux/nmon b/linux/nmon new file mode 100644 index 00000000..50063902 --- /dev/null +++ b/linux/nmon @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmon + +> A system administrator, tuner, and benchmark tool. +> More information: . + +- Start `nmon`: + +`nmon` + +- Save records to file ("-s 300 -c 288" by default): + +`nmon -f` + +- Save records to file with a total of 240 measurements, by taking 30 seconds between each measurement: + +`nmon -f -s {{30}} -c {{240}}` diff --git a/linux/nmtui b/linux/nmtui new file mode 100644 index 00000000..002202de --- /dev/null +++ b/linux/nmtui @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmtui + +> Text user interface for controlling NetworkManager. +> Use arrow keys to navigate, enter to select an option. +> More information: . + +- Open the user interface: + +`nmtui` + +- List available connections, with the option to activate or deactivate them: + +`nmtui connect` + +- Connect to a given network: + +`nmtui connect {{name|uuid|device|SSID}}` + +- Edit/Add/Delete a given network: + +`nmtui edit {{name|id}}` + +- Set the system hostname: + +`nmtui hostname` diff --git a/linux/nmtui-connect b/linux/nmtui-connect new file mode 100644 index 00000000..5801398d --- /dev/null +++ b/linux/nmtui-connect @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmtui-connect + +> This command is an alias of `nmtui connect`. + +- View documentation for the original command: + +`tldr nmtui` diff --git a/linux/nmtui-edit b/linux/nmtui-edit new file mode 100644 index 00000000..407c2bae --- /dev/null +++ b/linux/nmtui-edit @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmtui-edit + +> This command is an alias of `nmtui edit`. + +- View documentation for the original command: + +`tldr nmtui` diff --git a/linux/nmtui-hostname b/linux/nmtui-hostname new file mode 100644 index 00000000..41c0ad3b --- /dev/null +++ b/linux/nmtui-hostname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nmtui-hostname + +> This command is an alias of `nmtui hostname`. + +- View documentation for the original command: + +`tldr nmtui` diff --git a/linux/nologin b/linux/nologin new file mode 100644 index 00000000..b5244b49 --- /dev/null +++ b/linux/nologin @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nologin + +> Alternative shell that prevents a user from logging in. +> More information: . + +- Set a user's login shell to `nologin` to prevent the user from logging in: + +`chsh -s {{user}} nologin` + +- Customize message for users with the login shell of `nologin`: + +`echo "{{declined_login_message}}" > /etc/nologin.txt` diff --git a/linux/nordvpn b/linux/nordvpn new file mode 100644 index 00000000..8e5a91db --- /dev/null +++ b/linux/nordvpn @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nordvpn + +> Command-line interface for NordVPN. +> More information: . + +- Interactively log into a NordVPN account: + +`nordvpn login` + +- Display the connection status: + +`nordvpn status` + +- Connect to the nearest NordVPN server: + +`nordvpn connect` + +- List all available countries: + +`nordvpn countries` + +- Connect to a NordVPN server in a specific country: + +`nordvpn connect {{Germany}}` + +- Connect to a NordVPN server in a specific country and city: + +`nordvpn connect {{Germany}} {{Berlin}}` + +- Set autoconnect option: + +`nordvpn set autoconnect on` diff --git a/linux/notify-send b/linux/notify-send new file mode 100644 index 00000000..6a935830 --- /dev/null +++ b/linux/notify-send @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# notify-send + +> Uses the current desktop environment's notification system to create a notification. +> More information: . + +- Show a notification with the title "Test" and the content "This is a test": + +`notify-send "{{Test}}" "{{This is a test}}"` + +- Show a notification with a custom icon: + +`notify-send -i {{icon.png}} "{{Test}}" "{{This is a test}}"` + +- Show a notification for 5 seconds: + +`notify-send -t 5000 "{{Test}}" "{{This is a test}}"` + +- Show a notification with an app's icon and name: + +`notify-send "{{Test}}" --icon={{google-chrome}} --app-name="{{Google Chrome}}"` diff --git a/linux/nova b/linux/nova new file mode 100644 index 00000000..d1c816f3 --- /dev/null +++ b/linux/nova @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nova + +> The OpenStack project that provides a way to provision compute instances. +> More information: . + +- List VMs on current tenant: + +`nova list` + +- List VMs of all tenants (admin user only): + +`nova list --all-tenants` + +- Boot a VM on a specific host: + +`nova boot --nic net-id={{net_id}} --image {{image_id}} --flavor {{flavor}} --availability-zone nova:{{host_name}} {{vm_name}}` + +- Start a server: + +`nova start {{server}}` + +- Stop a server: + +`nova stop {{server}}` + +- Attach a network interface to a specific VM: + +`nova interface-attach --net-id {{net_id}} {{server}}` diff --git a/linux/nsenter b/linux/nsenter new file mode 100644 index 00000000..299f704d --- /dev/null +++ b/linux/nsenter @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nsenter + +> Run a new command in a running process' namespace. +> Particularly useful for docker images or chroot jails. +> More information: . + +- Run a specific command using the same namespaces as an existing process: + +`nsenter --target {{pid}} --all {{command}} {{command_arguments}}` + +- Run a specific command in an existing process's network namespace: + +`nsenter --target {{pid}} --net {{command}} {{command_arguments}}` + +- Run a specific command in an existing process's PID namespace: + +`nsenter --target {{pid}} --pid {{command}} {{command_arguments}}` + +- Run a specific command in an existing process's IPC namespace: + +`nsenter --target {{pid}} --ipc {{command}} {{command_arguments}}` + +- Run a specific command in an existing process's UTS, time, and IPC namespaces: + +`nsenter --target {{pid}} --uts --time --ipc -- {{command}} {{command_arguments}}` + +- Run a specific command in an existing process's namespace by referencing procfs: + +`nsenter --pid=/proc/{{pid}}/pid/net -- {{command}} {{command_arguments}}` diff --git a/linux/nsnake b/linux/nsnake new file mode 100644 index 00000000..f5450327 --- /dev/null +++ b/linux/nsnake @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nsnake + +> Snake game in the terminal. +> More information: . + +- Start a snake game: + +`nsnake` + +- Navigate the snake: + +`{{Up|Down|Left|Right arrow key}}` + +- Pause/unpause the game: + +`p` + +- Quit the game: + +`q` + +- Display help during the game: + +`h` diff --git a/linux/nsxiv b/linux/nsxiv new file mode 100644 index 00000000..3b8c6318 --- /dev/null +++ b/linux/nsxiv @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# nsxiv + +> Neo Simple X Image Viewer. +> More information: . + +- Open images: + +`nsxiv {{path/to/file1 path/to/file2 ...}}` + +- Open images from directories in image mode: + +`nsxiv {{path/to/directory1 path/to/directory2 ...}}` + +- Search directories recursively for images to view: + +`nsxiv -r {{path/to/directory1 path/to/directory2 ...}}` + +- Quit nsxiv: + +`q` + +- Switch to thumbnail mode or open selected image in image mode: + +`` + +- Count images forward in image mode: + +`n` + +- Count images backward in image mode: + +`p` diff --git a/linux/ntfsfix b/linux/ntfsfix new file mode 100644 index 00000000..a92ff2cd --- /dev/null +++ b/linux/ntfsfix @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ntfsfix + +> Fix common problems on an NTFS partition. +> More information: . + +- Fix a given NTFS partition: + +`sudo ntfsfix {{/dev/sdXN}}` diff --git a/linux/ntpdate b/linux/ntpdate new file mode 100644 index 00000000..38e85223 --- /dev/null +++ b/linux/ntpdate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ntpdate + +> Synchronize and set the date and time via NTP. +> More information: . + +- Synchronize and set date and time: + +`sudo ntpdate {{host}}` + +- Query the host without setting the time: + +`ntpdate -q {{host}}` + +- Use an unprivileged port in case a firewall is blocking privileged ports: + +`sudo ntpdate -u {{host}}` + +- Force time to be stepped using `settimeofday` instead of `slewed`: + +`sudo ntpdate -b {{host}}` diff --git a/linux/ntpq b/linux/ntpq new file mode 100644 index 00000000..61559c84 --- /dev/null +++ b/linux/ntpq @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ntpq + +> Query the Network Time Protocol (NTP) daemon. +> More information: . + +- Start `ntpq` in interactive mode: + +`ntpq --interactive` + +- Print a list of NTP peers: + +`ntpq --peers` + +- Print a list of NTP peers without resolving hostnames from IP addresses: + +`ntpq --numeric --peers` + +- Use `ntpq` in debugging mode: + +`ntpq --debug-level` + +- Print NTP system variables values: + +`ntpq --command={{rv}}` diff --git a/linux/numactl b/linux/numactl new file mode 100644 index 00000000..d47887fd --- /dev/null +++ b/linux/numactl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# numactl + +> Control NUMA policy for processes or shared memory. +> More information: . + +- Run a command on node 0 with memory allocated on node 0 and 1: + +`numactl --cpunodebind={{0}} --membind={{0,1}} -- {{command}} {{command_arguments}}` + +- Run a command on CPUs (cores) 0-4 and 8-12 of the current cpuset: + +`numactl --physcpubind={{+0-4,8-12}} -- {{command}} {{command_arguments}}` + +- Run a command with its memory interleaved on all CPUs: + +`numactl --interleave={{all}} -- {{command}} {{command_arguments}}` diff --git a/linux/numlockx b/linux/numlockx new file mode 100644 index 00000000..63bb1174 --- /dev/null +++ b/linux/numlockx @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# numlockx + +> Control the number lock key status in X11 sessions. +> More information: . + +- Show the current number lock status: + +`numlockx status` + +- Turn the number lock on: + +`numlockx on` + +- Turn the number lock off: + +`numlockx off` + +- Toggle the current state: + +`numlockx toggle` diff --git a/linux/obabel b/linux/obabel new file mode 100644 index 00000000..9a45ae26 --- /dev/null +++ b/linux/obabel @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# obabel + +> Translate chemistry-related data. +> More information: . + +- Convert a .mol file to XYZ coordinates: + +`obabel {{path/to/file.mol}} -O {{path/to/output_file.xyz}}` + +- Convert a SMILES string to a 500x500 picture: + +`obabel -:"{{SMILES}} -O {{path/to/output_file.png}} -xp 500` + +- Convert a file of SMILES string to separate 3D .mol files: + +`obabel {{path/to/file.smi}} -O {{path/to/output_file.mol}} --gen3D -m` + +- Render multiple inputs into one picture: + +`obabel {{path/to/file1 path/to/file2 ...}} -O {{path/to/output_file.png}}` diff --git a/linux/oomctl b/linux/oomctl new file mode 100644 index 00000000..4df53660 --- /dev/null +++ b/linux/oomctl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# oomctl + +> Analyze the state stored in `systemd-oomd`. +> More information: . + +- Show the current state of the cgroups and system contexts stored by `systemd-oomd`: + +`oomctl dump` diff --git a/linux/openfortivpn b/linux/openfortivpn new file mode 100644 index 00000000..75a5f745 --- /dev/null +++ b/linux/openfortivpn @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# openfortivpn + +> A VPN client, for Fortinet's proprietary PPP+SSL VPN solution. +> More information: . + +- Connect to a VPN with a username and password: + +`openfortivpn --username={{username}} --password={{password}}` + +- Connect to a VPN using a specific configuration file (defaults to `/etc/openfortivpn/config`): + +`sudo openfortivpn --config={{path/to/config}}` + +- Connect to a VPN by specifying the host and port: + +`openfortivpn {{host}}:{{port}}` + +- Trust a given gateway by passing in its certificate's sha256 sum: + +`openfortivpn --trusted-cert={{sha256_sum}}` diff --git a/linux/openrc b/linux/openrc new file mode 100644 index 00000000..290d012f --- /dev/null +++ b/linux/openrc @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# openrc + +> The OpenRC service manager. +> See also: `rc-status`, `rc-update`, and `rc-service`. +> More information: . + +- Change to a specific runlevel: + +`sudo openrc {{runlevel_name}}` + +- Change to a specific runlevel, but don't stop any existing services: + +`sudo openrc --no-stop {{runlevel_name}}` diff --git a/linux/openvpn3 b/linux/openvpn3 new file mode 100644 index 00000000..1ee872c1 --- /dev/null +++ b/linux/openvpn3 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# openvpn3 + +> OpenVPN 3 Linux client. +> More information: . + +- Start a new VPN session: + +`openvpn3 session-start --config {{path/to/config.conf}}` + +- List established sessions: + +`openvpn3 sessions-list` + +- Disconnect the currently established session started with given configuration: + +`openvpn3 session-manage --config {{path/to/config.conf}} --disconnect` + +- Import VPN configuration: + +`openvpn3 config-import --config {{path/to/config.conf}}` + +- List imported configurations: + +`openvpn3 configs-list` diff --git a/linux/opkg b/linux/opkg new file mode 100644 index 00000000..292d6c94 --- /dev/null +++ b/linux/opkg @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# opkg + +> A lightweight package manager used to install OpenWrt packages. +> More information: . + +- Install a package: + +`opkg install {{package}}` + +- Remove a package: + +`opkg remove {{package}}` + +- Update the list of available packages: + +`opkg update` + +- Upgrade all the installed packages: + +`opkg upgrade` + +- Upgrade one or more specific package(s): + +`opkg upgrade {{package(s)}}` + +- Display information for a specific package: + +`opkg info {{package}}` + +- List all the available packages: + +`opkg list` diff --git a/linux/optimus-manager b/linux/optimus-manager new file mode 100644 index 00000000..121a7136 --- /dev/null +++ b/linux/optimus-manager @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# optimus-manager + +> GPU switching utility for Nvidia Optimus laptops. +> More information: . + +- Switch between different GPU modes: + +`optimus-manager --switch {{nvidia|integrated|hybrid}}` + +- Clean up: + +`optimus-manager --cleanup` diff --git a/linux/ostree b/linux/ostree new file mode 100644 index 00000000..93902bcf --- /dev/null +++ b/linux/ostree @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ostree + +> Version control for binary files similar to `git` but optimized for operating system root filesystems. +> OSTree is the foundation for immutable image-based operating systems such as Fedora Silverblue, Fedora IoT or Fedora CoreOS. +> More information: . + +- Initialize a repository of the files in `$PWD` with metadata in `$PWD/path/to/repo`: + +`ostree init --repo {{path/to/repo}}` + +- Create a commit (snapshot) of the files: + +`ostree commit --repo {{path/to/repo}} --branch {{branch_name}}` + +- Show files in commit: + +`ostree ls --repo {{path/to/repo}} {{commit_id}}` + +- Show metadata of commit: + +`ostree show --repo {{path/to/repo}} {{commit_id}}` + +- Show list of commits: + +`ostree log --repo {{path/to/repo}} {{branch_name}}` + +- Show repo summary: + +`ostree summary --repo {{path/to/repo}} --view` + +- Show available refs (branches): + +`ostree refs --repo {{path/to/repo}}` diff --git a/linux/pacaur b/linux/pacaur new file mode 100644 index 00000000..0a12f8ce --- /dev/null +++ b/linux/pacaur @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacaur + +> A utility for Arch Linux to build and install packages from the Arch User Repository. +> More information: . + +- Synchronize and update all packages (includes AUR): + +`pacaur -Syu` + +- Synchronize and update only AUR packages: + +`pacaur -Syua` + +- Install a new package (includes AUR): + +`pacaur -S {{package}}` + +- Remove a package and its dependencies (includes AUR packages): + +`pacaur -Rs {{package}}` + +- Search the package database for a keyword (includes AUR): + +`pacaur -Ss {{keyword}}` + +- List all currently installed packages (includes AUR packages): + +`pacaur -Qs` diff --git a/linux/paccache b/linux/paccache new file mode 100644 index 00000000..ffd77e06 --- /dev/null +++ b/linux/paccache @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# paccache + +> A `pacman` cache cleaning utility. +> More information: . + +- Remove all but the 3 most recent package versions from the `pacman` cache: + +`paccache -r` + +- Set the number of package versions to keep: + +`paccache -rk {{num_versions}}` + +- Perform a dry-run and show the number of candidate packages for deletion: + +`paccache -d` + +- Move candidate packages to a directory instead of deleting them: + +`paccache -m {{path/to/directory}}` diff --git a/linux/pacdiff b/linux/pacdiff new file mode 100644 index 00000000..d784da24 --- /dev/null +++ b/linux/pacdiff @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacdiff + +> Maintenance utility for `.pacorig`, `.pacnew` and `.pacsave` files created by `pacman`. +> More information: . + +- Review files that need maintenance in interactive mode: + +`pacdiff` + +- Use sudo and sudoedit to remove and merge files: + +`pacdiff --sudo` + +- Review files needing maintenance, creating `.bak`ups of the original if you `(O)verwrite`: + +`pacdiff --sudo --backup` + +- Use a specific editor to view and merge configuration files (default is `vim -d`): + +`DIFFPROG={{editor}} pacdiff` + +- Scan for configuration files with `locate` instead of using `pacman` database: + +`pacdiff --locate` + +- Display help: + +`pacdiff --help` diff --git a/linux/pacman b/linux/pacman new file mode 100644 index 00000000..c3e31963 --- /dev/null +++ b/linux/pacman @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman + +> Arch Linux package manager utility. +> See also: `pacman-database`, `pacman-deptest`, `pacman-files`, `pacman-key`, `pacman-mirrors`, `pacman-query`, `pacman-remove`, `pacman-sync`, `pacman-upgrade`. +> For equivalent commands in other package managers, see . +> More information: . + +- Synchronize and update all packages: + +`sudo pacman -Syu` + +- Install a new package: + +`sudo pacman -S {{package}}` + +- Remove a package and its dependencies: + +`sudo pacman -Rs {{package}}` + +- Search the database for packages containing a specific file: + +`pacman -F "{{file_name}}"` + +- List installed packages and versions: + +`pacman -Q` + +- List only the explicitly installed packages and versions: + +`pacman -Qe` + +- List orphan packages (installed as dependencies but not actually required by any package): + +`pacman -Qtdq` + +- Empty the entire `pacman` cache: + +`sudo pacman -Scc` diff --git a/linux/pacman-database b/linux/pacman-database new file mode 100644 index 00000000..35fbc3b3 --- /dev/null +++ b/linux/pacman-database @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --database + +> Operate on the Arch Linux package database. +> Modify certain attributes of the installed packages. +> See also: `pacman`. +> More information: . + +- Mark a package as implicitly installed: + +`sudo pacman --database --asdeps {{package}}` + +- Mark a package as explicitly installed: + +`sudo pacman --database --asexplicit {{package}}` + +- Check that all the package dependencies are installed: + +`pacman --database --check` + +- Check the repositories to ensure all specified dependencies are available: + +`pacman --database --check --check` + +- Display only error messages: + +`pacman --database --check --quiet` + +- Display help: + +`pacman --database --help` diff --git a/linux/pacman-deptest b/linux/pacman-deptest new file mode 100644 index 00000000..10f59fd1 --- /dev/null +++ b/linux/pacman-deptest @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --deptest + +> Check each dependency specified and return a list of dependencies that are not currently satisfied on the system. +> See also: `pacman`. +> More information: . + +- Print the package names of the dependencies that aren't installed: + +`pacman --deptest {{package1 package2 ...}}` + +- Check if the installed package satisfies the given minimum version: + +`pacman --deptest "{{bash>=5}}"` + +- Check if a later version of a package is installed: + +`pacman --deptest "{{bash>5}}"` + +- Display help: + +`pacman --deptest --help` diff --git a/linux/pacman-files b/linux/pacman-files new file mode 100644 index 00000000..9c803fa6 --- /dev/null +++ b/linux/pacman-files @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --files + +> Arch Linux package manager utility. +> See also: `pacman`, `pkgfile`. +> More information: . + +- Update the package database: + +`sudo pacman --files --refresh` + +- Find the package that owns a specific file: + +`pacman --files {{filename}}` + +- Find the package that owns a specific file, using a regular expression: + +`pacman --files --regex '{{regular_expression}}'` + +- List only the package names: + +`pacman --files --quiet {{filename}}` + +- List the files owned by a specific package: + +`pacman --files --list {{package}}` + +- Display help: + +`pacman --files --help` diff --git a/linux/pacman-key b/linux/pacman-key new file mode 100644 index 00000000..7769026a --- /dev/null +++ b/linux/pacman-key @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman-key + +> Wrapper script for GnuPG used to manage pacman's keyring. +> See also: `pacman`. +> More information: . + +- Initialize the `pacman` keyring: + +`sudo pacman-key --init` + +- Add the default Arch Linux keys: + +`sudo pacman-key --populate {{archlinux}}` + +- List keys from the public keyring: + +`pacman-key --list-keys` + +- Add the specified keys: + +`sudo pacman-key --add {{path/to/keyfile.gpg}}` + +- Receive a key from a key server: + +`sudo pacman-key --recv-keys "{{uid|name|email}}"` + +- Print the fingerprint of a specific key: + +`pacman-key --finger "{{uid|name|email}}"` + +- Sign an imported key locally: + +`sudo pacman-key --lsign-key "{{uid|name|email}}"` + +- Remove a specific key: + +`sudo pacman-key --delete "{{uid|name|email}}"` diff --git a/linux/pacman-mirrors b/linux/pacman-mirrors new file mode 100644 index 00000000..2225a0af --- /dev/null +++ b/linux/pacman-mirrors @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman-mirrors + +> Generate a `pacman` mirrorlist for Manjaro Linux. +> Every run of `pacman-mirrors` requires you to synchronize your database and update your system using `sudo pacman -Syyu`. +> See also: `pacman`. +> More information: . + +- Generate a mirrorlist using the default settings: + +`sudo pacman-mirrors --fasttrack` + +- Get the status of the current mirrors: + +`pacman-mirrors --status` + +- Display the current branch: + +`pacman-mirrors --get-branch` + +- Switch to a different branch: + +`sudo pacman-mirrors --api --set-branch {{stable|unstable|testing}}` + +- Generate a mirrorlist, only using mirrors in your country: + +`sudo pacman-mirrors --geoip` diff --git a/linux/pacman-query b/linux/pacman-query new file mode 100644 index 00000000..8066cac5 --- /dev/null +++ b/linux/pacman-query @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --query + +> Arch Linux package manager utility. +> See also: `pacman`. +> More information: . + +- List installed packages and versions: + +`pacman --query` + +- List only packages and versions that were explicitly installed: + +`pacman --query --explicit` + +- Find which package owns a file: + +`pacman --query --owns {{filename}}` + +- Display information about an installed package: + +`pacman --query --info {{package}}` + +- List files owned by a package: + +`pacman --query --list {{package}}` + +- List orphan packages (installed as dependencies but not required by any package): + +`pacman --query --unrequired --deps --quiet` + +- List installed packages not found in the repositories: + +`pacman --query --foreign` + +- List outdated packages: + +`pacman --query --upgrades` diff --git a/linux/pacman-remove b/linux/pacman-remove new file mode 100644 index 00000000..466b59dd --- /dev/null +++ b/linux/pacman-remove @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --remove + +> Arch Linux package manager utility. +> See also: `pacman`. +> More information: . + +- Remove a package and its dependencies: + +`sudo pacman --remove --recursive {{package}}` + +- Remove a package and both its dependencies and configuration files: + +`sudo pacman --remove --recursive --nosave {{package}}` + +- Remove a package without prompting: + +`sudo pacman --remove --noconfirm {{package}}` + +- Remove orphan packages (installed as dependencies but not required by any package): + +`sudo pacman --remove --recursive --nosave $(pacman --query --unrequired --deps --quiet)` + +- Remove a package and all packages that depend on it: + +`sudo pacman --remove --cascade {{package}}` + +- List packages that would be affected (does not remove any packages): + +`pacman --remove --print {{package}}` + +- Display help: + +`pacman --remove --help` diff --git a/linux/pacman-sync b/linux/pacman-sync new file mode 100644 index 00000000..a8dc2897 --- /dev/null +++ b/linux/pacman-sync @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --sync + +> Arch Linux package manager utility. +> See also: `pacman`. +> More information: . + +- Install a new package: + +`sudo pacman --sync {{package}}` + +- Synchronize and update all packages (add `--downloadonly` to download the packages and not update them): + +`sudo pacman --sync --refresh --sysupgrade` + +- Update all packages and install a new one without prompting: + +`sudo pacman --sync --refresh --sysupgrade --noconfirm {{package}}` + +- Search the package database for a regular expression or keyword: + +`pacman --sync --search "{{search_pattern}}"` + +- Display information about a package: + +`pacman --sync --info {{package}}` + +- Overwrite conflicting files during a package update: + +`sudo pacman --sync --refresh --sysupgrade --overwrite {{path/to/file}}` + +- Synchronize and update all packages, but ignore a specific package (can be used more than once): + +`sudo pacman --sync --refresh --sysupgrade --ignore {{package}}` + +- Remove not installed packages and unused repositories from the cache (use two `--clean` flags to clean all packages): + +`sudo pacman --sync --clean` diff --git a/linux/pacman-upgrade b/linux/pacman-upgrade new file mode 100644 index 00000000..4fdc2fd5 --- /dev/null +++ b/linux/pacman-upgrade @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman --upgrade + +> Arch Linux package manager utility. +> See also: `pacman`. +> More information: . + +- Install one or more packages from files: + +`sudo pacman --upgrade {{path/to/package1.pkg.tar.zst}} {{path/to/package2.pkg.tar.zst}}` + +- Install a package without prompting: + +`sudo pacman --upgrade --noconfirm {{path/to/package.pkg.tar.zst}}` + +- Overwrite conflicting files during a package installation: + +`sudo pacman --upgrade --overwrite {{path/to/file}} {{path/to/package.pkg.tar.zst}}` + +- Install a package, skipping the dependency version checks: + +`sudo pacman --upgrade --nodeps {{path/to/package.pkg.tar.zst}}` + +- List packages that would be affected (does not install any packages): + +`pacman --upgrade --print {{path/to/package.pkg.tar.zst}}` + +- Display help: + +`pacman --upgrade --help` diff --git a/linux/pacman4console b/linux/pacman4console new file mode 100644 index 00000000..65f77b38 --- /dev/null +++ b/linux/pacman4console @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacman4console + +> A text-based console game inspired by the original Pacman. +> More information: . + +- Start a game at Level 1: + +`pacman4console` + +- Start a game on a certain level (there are nine official levels): + +`pacman4console --level={{level_number}}` + +- Start the pacman4console level editor, saving to a specified text file: + +`pacman4consoleedit {{path/to/level_file}}` + +- Play a custom level: + +`pacman4console --level={{path/to/level_file}}` diff --git a/linux/pacstall b/linux/pacstall new file mode 100644 index 00000000..9404819e --- /dev/null +++ b/linux/pacstall @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacstall + +> An AUR package manager for Ubuntu. +> More information: . + +- Search the package database for a package name: + +`pacstall --search {{query}}` + +- Install a package: + +`pacstall --install {{package}}` + +- Remove a package: + +`pacstall --remove {{package}}` + +- Add a repository to the database (only GitHub and GitLab are supported): + +`pacstall --add-repo {{remote_repository_location}}` + +- Update pacstall's scripts: + +`pacstall --update` + +- Update all packages: + +`pacstall --upgrade` + +- Display information about a package: + +`pacstall --query-info {{package}}` + +- List all installed packages: + +`pacstall --list` diff --git a/linux/pacstrap b/linux/pacstrap new file mode 100644 index 00000000..dd8ec154 --- /dev/null +++ b/linux/pacstrap @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacstrap + +> Arch Linux install script to install packages to the specified new root directory. +> More information: . + +- Install the `base` package, Linux kernel and firmware for common hardware: + +`pacstrap {{path/to/new/root}} {{base}} {{linux}} {{linux-firmware}}` + +- Install the `base` package, Linux LTS kernel and `base-devel` build tools: + +`pacstrap {{path/to/new/root}} {{base}} {{base-devel}} {{linux-lts}}` + +- Install packages without copy the host's mirrorlist to the target: + +`pacstrap -M {{path/to/new/root}} {{packages}}` + +- Use an alternate configuration file for Pacman: + +`pacstrap -C {{path/to/pacman.conf}} {{path/to/new/root}} {{packages}}` + +- Install packages using the package cache on the host instead of on the target: + +`pacstrap -c {{path/to/new/root}} {{packages}}` + +- Initialize an empty `pacman` keyring in the target without copying it from the host: + +`pacstrap -K {{path/to/new/root}} {{packages}}` + +- Install packages in interactive mode (prompts for confirmation): + +`pacstrap -i {{path/to/new/root}} {{packages}}` + +- Install packages using package files: + +`pacstrap -U {{path/to/new/root}} {{path/to/package1}} {{path/to/package2}}` diff --git a/linux/pactree b/linux/pactree new file mode 100644 index 00000000..17830a8e --- /dev/null +++ b/linux/pactree @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pactree + +> Package dependency tree viewer for pacman. +> More information: . + +- Print the dependency tree of a specific package: + +`pactree {{package}}` + +- Print what packages depend on a specific package: + +`pactree --reverse {{package}}` + +- Dump dependencies one per line, skipping duplicates: + +`pactree --unique {{package}}` + +- Include optional dependencies of a specific package and colorize the output: + +`pactree --optional --color {{package}}` + +- Display help: + +`pactree` diff --git a/linux/pamac b/linux/pamac new file mode 100644 index 00000000..e9150e82 --- /dev/null +++ b/linux/pamac @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pamac + +> A command-line utility for the GUI package manager pamac. +> If you can't see the AUR packages, enable it in `/etc/pamac.conf` or in the GUI. +> More information: . + +- Install a new package: + +`pamac install {{package_name}}` + +- Remove a package and its no longer required dependencies (orphans): + +`pamac remove --orphans {{package_name}}` + +- Search the package database for a package: + +`pamac search {{package_name}}` + +- List installed packages: + +`pamac list --installed` + +- Check for package updates: + +`pamac checkupdates` + +- Upgrade all packages: + +`pamac upgrade` diff --git a/linux/parted b/linux/parted new file mode 100644 index 00000000..89b40ce9 --- /dev/null +++ b/linux/parted @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# parted + +> A partition manipulation program. +> See also: `partprobe`. +> More information: . + +- List partitions on all block devices: + +`sudo parted --list` + +- Start interactive mode with the specified disk selected: + +`sudo parted {{/dev/sdX}}` + +- Create a new partition table of the specified label-type: + +`sudo parted --script {{/dev/sdX}} mklabel {{aix|amiga|bsd|dvh|gpt|loop|mac|msdos|pc98|sun}}` + +- Show partition information in interactive mode: + +`print` + +- Select a disk in interactive mode: + +`select {{/dev/sdX}}` + +- Create a 16 GB partition with the specified filesystem in interactive mode: + +`mkpart {{primary|logical|extended}} {{btrfs|ext2|ext3|ext4|fat16|fat32|hfs|hfs+|linux-swap|ntfs|reiserfs|udf|xfs}} {{0%}} {{16G}}` + +- Resize a partition in interactive mode: + +`resizepart {{/dev/sdXN}} {{end_position_of_partition}}` + +- Remove a partition in interactive mode: + +`rm {{/dev/sdXN}}` diff --git a/linux/partprobe b/linux/partprobe new file mode 100644 index 00000000..357f13b1 --- /dev/null +++ b/linux/partprobe @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# partprobe + +> Notify the operating system kernel of partition table changes. +> More information: . + +- Notify the operating system kernel of partition table changes: + +`sudo partprobe` + +- Notify the kernel of partition table changes and show a summary of devices and their partitions: + +`sudo partprobe --summary` + +- Show a summary of devices and their partitions but don't notify the kernel: + +`sudo partprobe --summary --dry-run` diff --git a/linux/partx b/linux/partx new file mode 100644 index 00000000..62fc6e90 --- /dev/null +++ b/linux/partx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# partx + +> Parse a partition table and tell the kernel about it. +> More information: . + +- List the partitions on a block device or disk image: + +`sudo partx --list {{path/to/device_or_disk_image}}` + +- Add all the partitions found in a given block device to the kernel: + +`sudo partx --add --verbose {{path/to/device_or_disk_image}}` + +- Delete all the partitions found from the kernel (does not alter partitions on disk): + +`sudo partx --delete {{path/to/device_or_disk_image}}` diff --git a/linux/paru b/linux/paru new file mode 100644 index 00000000..4b930928 --- /dev/null +++ b/linux/paru @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# paru + +> An AUR helper and pacman wrapper. +> More information: . + +- Interactively search for and install a package: + +`paru {{package_name_or_search_term}}` + +- Synchronize and update all packages: + +`paru` + +- Upgrade AUR packages: + +`paru -Sua` + +- Get information about a package: + +`paru -Si {{package}}` + +- Download `PKGBUILD` and other package source files from the AUR or ABS: + +`paru --getpkgbuild {{package}}` + +- Display the `PKGBUILD` file of a package: + +`paru --getpkgbuild --print {{package}}` diff --git a/linux/pasuspender b/linux/pasuspender new file mode 100644 index 00000000..ed9319c7 --- /dev/null +++ b/linux/pasuspender @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pasuspender + +> Temporarily suspends `pulseaudio` while another command is running to allow access to alsa. +> More information: . + +- Suspend PulseAudio while running `jackd`: + +`pasuspender -- {{jackd -d alsa --device hw:0}}` diff --git a/linux/pdbedit b/linux/pdbedit new file mode 100644 index 00000000..78b7415b --- /dev/null +++ b/linux/pdbedit @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pdbedit + +> Edit the Samba user database. +> For simple user add/remove/password, you can also use `smbpasswd`. +> More information: . + +- List all Samba users (use verbose flag to show their settings): + +`sudo pdbedit --list --verbose` + +- Add an existing Unix user to Samba (will prompt for password): + +`sudo pdbedit --user {{username}} --create` + +- Remove a Samba user: + +`sudo pdbedit --user {{username}} --delete` + +- Reset a Samba user's failed password counter: + +`sudo pdbedit --user {{username}} --bad-password-count-reset` diff --git a/linux/pdfcrop b/linux/pdfcrop new file mode 100644 index 00000000..54cc9457 --- /dev/null +++ b/linux/pdfcrop @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfcrop + +> Detect and remove margins in each page in a PDF file. +> More information: . + +- Automatically detect and remove the margin for each page in a PDF file: + +`pdfcrop {{path/to/input_file.pdf}} {{path/to/output_file.pdf}}` + +- Set the margins of each page to a specific value: + +`pdfcrop {{path/to/input_file.pdf}} --margins '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Set the margins of each page to a specific value, using the same value for left, top, right and bottom: + +`pdfcrop {{path/to/input_file.pdf}} --margins {{300}} {{path/to/output_file.pdf}}` + +- Use a user-defined bounding box for cropping instead of automatically detecting it: + +`pdfcrop {{path/to/input_file.pdf}} --bbox '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Use different user-defined bounding boxes for odd and even pages: + +`pdfcrop {{path/to/input_file.pdf}} --bbox-odd '{{left}} {{top}} {{right}} {{bottom}}' --bbox-even '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Automatically detect margins using a lower resolution for improved performance: + +`pdfcrop {{path/to/input_file.pdf}} --resolution {{72}} {{path/to/output_file.pdf}}` diff --git a/linux/pdftohtml b/linux/pdftohtml new file mode 100644 index 00000000..551f5314 --- /dev/null +++ b/linux/pdftohtml @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftohtml + +> Convert PDF files into HTML, XML and PNG images. +> More information: . + +- Convert a PDF file to an HTML file: + +`pdftohtml {{path/to/file.pdf}} {{path/to/output_file.html}}` + +- Ignore images in the PDF file: + +`pdftohtml -i {{path/to/file.pdf}} {{path/to/output_file.html}}` + +- Generate a single HTML file that includes all PDF pages: + +`pdftohtml -s {{path/to/file.pdf}} {{path/to/output_file.html}}` + +- Convert a PDF file to an XML file: + +`pdftohtml -xml {{path/to/file.pdf}} {{path/to/output_file.xml}}` diff --git a/linux/pdftoppm b/linux/pdftoppm new file mode 100644 index 00000000..916c3a1a --- /dev/null +++ b/linux/pdftoppm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftoppm + +> Convert PDF document pages to portable Pixmap (image formats). +> More information: . + +- Specify the range of pages to convert (N-first page, M-last page): + +`pdftoppm -f {{N}} -l {{M}} {{path/to/file.pdf}} {{image_name_prefix}}` + +- Convert only the first page of a PDF: + +`pdftoppm -singlefile {{path/to/file.pdf}} {{image_name_prefix}}` + +- Generate a monochrome PBM file (instead of a color PPM file): + +`pdftoppm -mono {{path/to/file.pdf}} {{image_name_prefix}}` + +- Generate a grayscale PGM file (instead of a color PPM file): + +`pdftoppm -gray {{path/to/file.pdf}} {{image_name_prefix}}` + +- Generate a PNG file instead a PPM file: + +`pdftoppm -png {{path/to/file.pdf}} {{image_name_prefix}}` diff --git a/linux/pdfxup b/linux/pdfxup new file mode 100644 index 00000000..f410bde3 --- /dev/null +++ b/linux/pdfxup @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfxup + +> N-up PDF pages. +> N-upping means putting multiple pages onto one page by scaling and rotating them into a grid. +> More information: . + +- Create a 2-up PDF: + +`pdfxup -o {{path/to/output.pdf}} {{path/to/input.pdf}}` + +- Create a PDF with 3 columns and 2 lines per page: + +`pdfxup -x {{3}} -y {{2}} -o {{path/to/output.pdf}} {{path/to/input.pdf}}` + +- Create a PDF in booklet mode (2-up, and pages are sorted to form a book when folded): + +`pdfxup -b -o {{path/to/output.pdf}} {{path/to/input.pdf}}` diff --git a/linux/perf b/linux/perf new file mode 100644 index 00000000..30197945 --- /dev/null +++ b/linux/perf @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# perf + +> Framework for Linux performance counter measurements. +> More information: . + +- Display basic performance counter stats for a command: + +`perf stat {{gcc hello.c}}` + +- Display system-wide real-time performance counter profile: + +`sudo perf top` + +- Run a command and record its profile into `perf.data`: + +`sudo perf record {{command}}` + +- Record the profile of an existing process into `perf.data`: + +`sudo perf record -p {{pid}}` + +- Read `perf.data` (created by `perf record`) and display the profile: + +`sudo perf report` diff --git a/linux/perl-rename b/linux/perl-rename new file mode 100644 index 00000000..6089247b --- /dev/null +++ b/linux/perl-rename @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rename + +> Rename multiple files. +> Note: this page refers to the command from the `perl-rename` Arch Linux package. +> More information: . + +- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): + +`rename {{'s/foo/bar/'}} {{*}}` + +- Dry-run - display which renames would occur without performing them: + +`rename -n {{'s/foo/bar/'}} {{*}}` + +- Force renaming even if the operation would remove existing destination files: + +`rename -f {{'s/foo/bar/'}} {{*}}` + +- Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): + +`rename 'y/A-Z/a-z/' {{*}}` + +- Replace whitespace with underscores: + +`rename 's/\s+/_/g' {{*}}` diff --git a/linux/phar b/linux/phar new file mode 100644 index 00000000..05c3c5df --- /dev/null +++ b/linux/phar @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# phar + +> Create, update or extract PHP archives (PHAR). +> More information: . + +- Add one or more files or directories to a Phar file: + +`phar add -f {{path/to/phar_file}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Display the contents of a Phar file: + +`phar list -f {{path/to/phar_file}}` + +- Delete the specified file or directory from a Phar file: + +`phar delete -f {{path/to/phar_file}} -e {{file_or_directory}}` + +- Compress or uncompress files and directories in a Phar file: + +`phar compress -f {{path/to/phar_file}} -c {{algorithm}}` + +- Get information about a Phar file: + +`phar info -f {{path/to/phar_file}}` + +- Sign a Phar file with a specific hash algorithm: + +`phar sign -f {{path/to/phar_file}} -h {{algorithm}}` + +- Sign a Phar file with an OpenSSL private key: + +`phar sign -f {{path/to/phar_file}} -h openssl -y {{path/to/private_key}}` + +- Display help and available hashing/compression algorithms: + +`phar help` diff --git a/linux/photorec b/linux/photorec new file mode 100644 index 00000000..70d5dade --- /dev/null +++ b/linux/photorec @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# photorec + +> Deleted file recovery tool. +> It is recommended to write recovered files to a disk separate to the one being recovered from. +> More information: . + +- Run PhotoRec on a specific device: + +`sudo photorec {{/dev/sdb}}` + +- Run PhotoRec on a disk image (`image.dd`): + +`sudo photorec {{path/to/image.dd}}` diff --git a/linux/phpdismod b/linux/phpdismod new file mode 100644 index 00000000..19d0db96 --- /dev/null +++ b/linux/phpdismod @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# phpdismod + +> Disable PHP extensions on Debian-based OSes. +> More information: . + +- Disable the JSON extension for every SAPI of every PHP version: + +`sudo phpdismod {{json}}` + +- Disable the JSON extension for PHP 7.3 with the cli SAPI: + +`sudo phpdismod -v {{7.3}} -s {{cli}} {{json}}` diff --git a/linux/phpenmod b/linux/phpenmod new file mode 100644 index 00000000..a519938a --- /dev/null +++ b/linux/phpenmod @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# phpenmod + +> Enable PHP extensions on Debian-based OSes. +> More information: . + +- Enable the JSON extension for every SAPI of every PHP version: + +`sudo phpenmod {{json}}` + +- Enable the JSON extension for PHP 7.3 with the cli SAPI: + +`sudo phpenmod -v {{7.3}} -s {{cli}} {{json}}` diff --git a/linux/phpquery b/linux/phpquery new file mode 100644 index 00000000..059628a0 --- /dev/null +++ b/linux/phpquery @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# phpquery + +> PHP extension manager for Debian-based OSes. +> More information: . + +- List available PHP versions: + +`sudo phpquery -V` + +- List available SAPIs for PHP 7.3: + +`sudo phpquery -v {{7.3}} -S` + +- List enabled extensions for PHP 7.3 with the cli SAPI: + +`sudo phpquery -v {{7.3}} -s {{cli}} -M` + +- Check if the JSON extension is enabled for PHP 7.3 with the apache2 SAPI: + +`sudo phpquery -v {{7.3}} -s {{apache2}} -m {{json}}` diff --git a/linux/physlock b/linux/physlock new file mode 100644 index 00000000..b1b2eafe --- /dev/null +++ b/linux/physlock @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# physlock + +> Lock all consoles and virtual terminals. +> More information: . + +- Lock every console (require current user or root to unlock): + +`physlock` + +- Mute kernel messages on console while locked: + +`physlock -m` + +- Disable SysRq mechanism while locked: + +`physlock -s` + +- Display a message before the password prompt: + +`physlock -p "{{Locked!}}"` + +- Fork and detach physlock (useful for suspend or hibernate scripts): + +`physlock -d` diff --git a/linux/pi b/linux/pi new file mode 100644 index 00000000..ab9c421a --- /dev/null +++ b/linux/pi @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pi + +> Compute decimal Archimedes' constant Pi. +> More information: . + +- Display 100 decimal digits of Archimedes' constant Pi: + +`pi` + +- Display a specified number of decimal digits of Archimedes' constant Pi: + +`pi {{number}}` + +- Display recommended readings: + +`pi --bibliography` + +- Display help: + +`pi --help` + +- Display version: + +`pi --version` diff --git a/linux/picom b/linux/picom new file mode 100644 index 00000000..c24ef58e --- /dev/null +++ b/linux/picom @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# picom + +> Standalone compositor for Xorg. +> More information: . + +- Enable `picom` during a session: + +`picom &` + +- Start `picom` as a background process: + +`picom -b` + +- Use a custom configuration file: + +`picom --config {{path/to/config_file}}` diff --git a/linux/pidof b/linux/pidof new file mode 100644 index 00000000..21f6b533 --- /dev/null +++ b/linux/pidof @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pidof + +> Gets the ID of a process using its name. +> More information: . + +- List all process IDs with given name: + +`pidof {{bash}}` + +- List a single process ID with given name: + +`pidof -s {{bash}}` + +- List process IDs including scripts with given name: + +`pidof -x {{script.py}}` + +- Kill all processes with given name: + +`kill $(pidof {{name}})` diff --git a/linux/pidstat b/linux/pidstat new file mode 100644 index 00000000..acbe55d2 --- /dev/null +++ b/linux/pidstat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pidstat + +> Show system resource usage, including CPU, memory, IO etc. +> More information: . + +- Show CPU statistics at a 2 second interval for 10 times: + +`pidstat {{2}} {{10}}` + +- Show page faults and memory utilization: + +`pidstat -r` + +- Show input/output usage per process id: + +`pidstat -d` + +- Show information on a specific PID: + +`pidstat -p {{PID}}` + +- Show memory statistics for all processes whose command name include "fox" or "bird": + +`pidstat -C "{{fox|bird}}" -r -p ALL` diff --git a/linux/pihole b/linux/pihole new file mode 100644 index 00000000..695cc646 --- /dev/null +++ b/linux/pihole @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pihole + +> Terminal interface for the Pi-hole ad-blocking DNS server. +> More information: . + +- Check the Pi-hole daemon's status: + +`pihole status` + +- Update Pi-hole and Gravity: + +`pihole -up` + +- Monitor detailed system status: + +`pihole chronometer` + +- Start or stop the daemon: + +`pihole {{enable|disable}}` + +- Restart the daemon (not the server itself): + +`pihole restartdns` + +- Whitelist or blacklist a domain: + +`pihole {{whitelist|blacklist}} {{example.com}}` + +- Search the lists for a domain: + +`pihole query {{example.com}}` + +- Open a real-time log of connections: + +`pihole tail` diff --git a/linux/pinout b/linux/pinout new file mode 100644 index 00000000..5901d7c7 --- /dev/null +++ b/linux/pinout @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pinout + +> View the current Raspberry Pi's GPIO pin-out information on the terminal with an ASCII diagram. +> More information: . + +- View the pinout information and GPIO header diagram for the current Raspberry Pi: + +`pinout` + +- Open in the default browser: + +`pinout -x` diff --git a/linux/pipewire b/linux/pipewire new file mode 100644 index 00000000..354c7520 --- /dev/null +++ b/linux/pipewire @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pipewire + +> Start the PipeWire daemon. +> More information: . + +- Start the PipeWire daemon: + +`pipewire` + +- Use a different configuration file: + +`pipewire --config {{path/to/file.conf}}` + +- Set the verbosity level (error, warn, info, debug or trace): + +`pipewire -{{v|vv|...|vvvvv}}` + +- Display help: + +`pipewire --help` diff --git a/linux/pivpn b/linux/pivpn new file mode 100644 index 00000000..6451adf2 --- /dev/null +++ b/linux/pivpn @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pivpn + +> Easy security-hardened OpenVPN setup and manager. +> Originally designed for the Raspberry Pi, but works on other Linux devices too. +> More information: . + +- Add a new client device: + +`sudo pivpn add` + +- List all client devices: + +`sudo pivpn list` + +- List currently connected devices and their statistics: + +`sudo pivpn clients` + +- Revoke a previously authenticated device: + +`sudo pivpn revoke` + +- Uninstall PiVPN: + +`sudo pivpn uninstall` diff --git a/linux/pkcon b/linux/pkcon new file mode 100644 index 00000000..bc69ff6a --- /dev/null +++ b/linux/pkcon @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkcon + +> Command line client for PackageKit console program used by Discover and Gnome software and alternative to 'apt'. +> More information: . + +- Install a package: + +`pkcon install {{package}}` + +- Remove a package: + +`pkcon remove {{package}}` + +- Refresh the package cache: + +`pkcon refresh` + +- Update packages: + +`pkcon update` + +- Search for a specific package: + +`pkcon search {{package}}` + +- List all available packages: + +`pkcon get-packages` diff --git a/linux/pkgadd b/linux/pkgadd new file mode 100644 index 00000000..0ed7b9a9 --- /dev/null +++ b/linux/pkgadd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgadd + +> Add a package to a CRUX system. +> More information: . + +- Install a local software package: + +`pkgadd {{package}}` + +- Update an already installed package from a local package: + +`pkgadd -u {{package}}` diff --git a/linux/pkgctl b/linux/pkgctl new file mode 100644 index 00000000..e1424802 --- /dev/null +++ b/linux/pkgctl @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl + +> Unified command-line frontend for Arch Linux devtools. +> More information: . + +- View documentation for authenticating `pkgctl` with services like GitLab: + +`tldr pkgctl auth` + +- View documentation for building packages inside a clean `chroot`: + +`tldr pkgctl build` + +- View documentation for updating the binary repository as final release step: + +`tldr pkgctl db update` + +- View documentation for comparing package files using different modes: + +`tldr pkgctl diff` + +- View documentation for releasing build artifacts: + +`tldr pkgctl release` + +- View documentation for managing Git packaging repositories and their configuration: + +`tldr pkgctl repo` + +- Display version: + +`pkgctl version` diff --git a/linux/pkgctl-auth b/linux/pkgctl-auth new file mode 100644 index 00000000..6162cd42 --- /dev/null +++ b/linux/pkgctl-auth @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl auth + +> Authenticate `pkgctl` with services like GitLab. +> More information: . + +- Authenticate `pkgctl` with the GitLab instance: + +`pkgctl auth login` + +- View authentication status: + +`pkgctl auth status` diff --git a/linux/pkgctl-build b/linux/pkgctl-build new file mode 100644 index 00000000..35123c8a --- /dev/null +++ b/linux/pkgctl-build @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl build + +> Build packages inside a clean `chroot`. +> More information: . + +- Automatically choose the right build script to build packages in a clean `chroot`: + +`pkgctl build` + +- Manually build packages in a clean `chroot`: + +`pkgctl build --arch {{architecture}} --repo {{repository}} --clean` diff --git a/linux/pkgctl-db-update b/linux/pkgctl-db-update new file mode 100644 index 00000000..25506bbf --- /dev/null +++ b/linux/pkgctl-db-update @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl db update + +> Update the `pacman` database as final release step for packages that have been transfered and staged on . +> More information: . + +- Update the binary repository as final release step: + +`pkgctl db update` diff --git a/linux/pkgctl-diff b/linux/pkgctl-diff new file mode 100644 index 00000000..7b4fbf76 --- /dev/null +++ b/linux/pkgctl-diff @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl diff + +> Compare package files using different modes. +> See also: `pkgctl`. +> More information: . + +- Compare package files in tar content [l]ist different mode (default): + +`pkgctl diff --list {{path/to/file|pkgname}}` + +- Compare package files in [d]iffoscope different mode: + +`pkgctl diff --diffoscope {{path/to/file|pkgname}}` + +- Compare package files in `.PKGINFO` different mode: + +`pkgctl diff --pkginfo {{path/to/file|pkgname}}` + +- Compare package files in `.BUILDINFO` different mode: + +`pkgctl diff --buildinfo {{path/to/file|pkgname}}` diff --git a/linux/pkgctl-release b/linux/pkgctl-release new file mode 100644 index 00000000..0d5ee604 --- /dev/null +++ b/linux/pkgctl-release @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl release + +> Release step to commit, tag and upload build artifacts. +> More information: . + +- Release a build artifact: + +`pkgctl release --repo {{repository}} --message {{commit_message}}` diff --git a/linux/pkgctl-repo b/linux/pkgctl-repo new file mode 100644 index 00000000..d35868b8 --- /dev/null +++ b/linux/pkgctl-repo @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgctl repo + +> Manage Git packaging repositories and their configuration for Arch Linux. +> See also: `pkgctl`. +> More information: . + +- Clone a package repository (requires setting an SSH key in your Arch Linux GitLab account): + +`pkgctl repo clone {{pkgname}}` + +- Clone a package repository over HTTPS: + +`pkgctl repo clone --protocol=https {{pkgname}}` + +- Create a new GitLab package repository and clone it after creation (requires valid GitLab API authentication): + +`pkgctl repo create {{pkgbase}}` + +- Switch a package repository to a specified version: + +`pkgctl repo switch {{version}} {{pkgbase}}` + +- Open a package repository's website: + +`pkgctl repo web {{pkgbase}}` diff --git a/linux/pkgfile b/linux/pkgfile new file mode 100644 index 00000000..ac4bc00e --- /dev/null +++ b/linux/pkgfile @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgfile + +> Search files from packages in the official repositories on Arch-based systems. +> See also: `pacman files`, describing the usage of `pacman --files`. +> More information: . + +- Synchronize the pkgfile database: + +`sudo pkgfile --update` + +- Search for a package that owns a specific file: + +`pkgfile {{filename}}` + +- List all files provided by a package: + +`pkgfile --list {{package}}` + +- List executables provided by a package: + +`pkgfile --list --binaries {{package}}` + +- Search for a package that owns a specific file using case-insensitive matching: + +`pkgfile --ignorecase {{filename}}` + +- Search for a package that owns a specific file in the `bin` or `sbin` directory: + +`pkgfile --binaries {{filename}}` + +- Search for a package that owns a specific file, displaying the package version: + +`pkgfile --verbose {{filename}}` + +- Search for a package that owns a specific file in a specific repository: + +`pkgfile --repo {{repository_name}} {{filename}}` diff --git a/linux/pkginfo b/linux/pkginfo new file mode 100644 index 00000000..5dff2072 --- /dev/null +++ b/linux/pkginfo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkginfo + +> Query the package database on a CRUX system. +> More information: . + +- List installed packages and their versions: + +`pkginfo -i` + +- List files owned by a package: + +`pkginfo -l {{package}}` + +- List the owner(s) of files matching a pattern: + +`pkginfo -o {{pattern}}` + +- Print the footprint of a file: + +`pkginfo -f {{path/to/file}}` diff --git a/linux/pkgmk b/linux/pkgmk new file mode 100644 index 00000000..56baf622 --- /dev/null +++ b/linux/pkgmk @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgmk + +> Make a binary package for use with pkgadd on CRUX. +> More information: . + +- Make and download a package: + +`pkgmk -d` + +- Install the package after making it: + +`pkgmk -d -i` + +- Upgrade the package after making it: + +`pkgmk -d -u` + +- Ignore the footprint when making a package: + +`pkgmk -d -if` + +- Ignore the MD5 sum when making a package: + +`pkgmk -d -im` + +- Update the package's footprint: + +`pkgmk -uf` diff --git a/linux/pkgrm b/linux/pkgrm new file mode 100644 index 00000000..1783ff20 --- /dev/null +++ b/linux/pkgrm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgrm + +> Remove a package from a CRUX system. +> More information: . + +- Remove an installed package: + +`pkgrm {{package}}` diff --git a/linux/playerctl b/linux/playerctl new file mode 100644 index 00000000..d4d39be2 --- /dev/null +++ b/linux/playerctl @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# playerctl + +> Control media players via MPRIS. +> More information: . + +- Toggle play: + +`playerctl play-pause` + +- Skip to the next track: + +`playerctl next` + +- Go back to the previous track: + +`playerctl previous` + +- List all players: + +`playerctl --list-all` + +- Send a command to a specific player: + +`playerctl --player {{player_name}} {{play-pause|next|previous|...}}` + +- Send a command to all players: + +`playerctl --all-players {{play-pause|next|previous|...}}` + +- Display metadata about the current track: + +`playerctl metadata --format "{{Now playing: \{\{artist\}\} - \{\{album\}\} - \{\{title\}\}}}"` diff --git a/linux/pluma b/linux/pluma new file mode 100644 index 00000000..60a41504 --- /dev/null +++ b/linux/pluma @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pluma + +> Edit files in MATE desktop environment. +> More information: . + +- Start the editor: + +`pluma` + +- Open specific documents: + +`pluma {{path/to/file1 path/to/file2 ...}}` + +- Open documents using a specific encoding: + +`pluma --encoding {{WINDOWS-1252}} {{path/to/file1 path/to/file2 ...}}` + +- Print all supported encodings: + +`pluma --list-encodings` + +- Open document and go to a specific line: + +`pluma +{{10}} {{path/to/file}}` diff --git a/linux/pmap b/linux/pmap new file mode 100644 index 00000000..04ad6ace --- /dev/null +++ b/linux/pmap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pmap + +> Report memory map of a process or processes. +> More information: . + +- Print memory map for a specific process id (PID): + +`pmap {{pid}}` + +- Show the extended format: + +`pmap --extended {{pid}}` + +- Show the device format: + +`pmap --device {{pid}}` + +- Limit results to a memory address range specified by `low` and `high`: + +`pmap --range {{low}},{{high}}` + +- Print memory maps for multiple processes: + +`pmap {{pid1 pid2 ...}}` diff --git a/linux/pmount b/linux/pmount new file mode 100644 index 00000000..6d8299bd --- /dev/null +++ b/linux/pmount @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pmount + +> Mount arbitrary hotpluggable devices as a normal user. +> More information: . + +- Mount a device below `/media/` (using device as mount point): + +`pmount {{/dev/to/block/device}}` + +- Mount a device with a specific filesystem type to `/media/label`: + +`pmount --type {{filesystem}} {{/dev/to/block/device}} {{label}}` + +- Mount a CD-ROM (filesystem type ISO9660) in read-only mode: + +`pmount --type {{iso9660}} --read-only {{/dev/cdrom}}` + +- Mount an NTFS-formatted disk, forcing read-write access: + +`pmount --type {{ntfs}} --read-write {{/dev/sdX}}` + +- Display all mounted removable devices: + +`pmount` diff --git a/linux/pngcheck b/linux/pngcheck new file mode 100644 index 00000000..5304f21d --- /dev/null +++ b/linux/pngcheck @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pngcheck + +> Forensics tool for validating the integrity of PNG based (`.png`, `.jng`, `.mng`) image files. +> Can also extract embedded images and text from a file. +> More information: . + +- Verify the integrity of an image file: + +`pngcheck {{path/to/file.png}}` + +- Check the file with [v]erbose and [c]olorized output: + +`pngcheck -vc {{path/to/file.png}}` + +- Display contents of [t]ext chunks and [s]earch for PNGs within a specific file: + +`pngcheck -ts {{path/to/file.png}}` + +- Search for, and e[x]tract embedded PNGs within a specific file: + +`pngcheck -x {{path/to/file.png}}` diff --git a/linux/po4a b/linux/po4a new file mode 100644 index 00000000..224f3415 --- /dev/null +++ b/linux/po4a @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# po4a + +> Update both PO files and translated documents. +> More information: . + +- Update PO files and documents according to the specified configuration file: + +`po4a {{path/to/config_file}}` diff --git a/linux/po4a-gettextize b/linux/po4a-gettextize new file mode 100644 index 00000000..4a212f6b --- /dev/null +++ b/linux/po4a-gettextize @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# po4a-gettextize + +> Convert a file to a PO file. +> More information: . + +- Convert a text file to PO file: + +`po4a-gettextize --format {{text}} --master {{path/to/master.txt}} --po {{path/to/result.po}}` + +- List all available formats: + +`po4a-gettextize --help-format` + +- Convert a text file along with a translated document to a PO file (`-l` option can be provided multiple times): + +`po4a-gettextize --format {{text}} --master {{path/to/master.txt}} --localized {{path/to/translated.txt}} --po {{path/to/result.po}}` diff --git a/linux/po4a-translate b/linux/po4a-translate new file mode 100644 index 00000000..a65e8d65 --- /dev/null +++ b/linux/po4a-translate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# po4a-translate + +> Convert a PO file back to documentation format. +> The provided PO file should be the translation of the POT file which was produced by `po4a-gettextize`. +> More information: . + +- Convert a translated PO file back to a document: + +`po4a-translate --format {{text}} --master {{path/to/master.doc}} --po {{path/to/result.po}} --localized {{path/to/translated.txt}}` + +- List all available formats: + +`po4a-translate --help-format` diff --git a/linux/po4a-updatepo b/linux/po4a-updatepo new file mode 100644 index 00000000..92e5e8e2 --- /dev/null +++ b/linux/po4a-updatepo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# po4a-updatepo + +> Update the translation (in PO format) of a documentation. +> More information: . + +- Update a PO file according to the modification of its origin file: + +`po4a-updatepo --format {{text}} --master {{path/to/master.txt}} --po {{path/to/result.po}}` + +- List available formats: + +`po4a-updatepo --help-format` + +- Update several PO files according to the modification of their origin file: + +`po4a-updatepo --format {{text}} --master {{path/to/master.txt}} --po {{path/to/po1.po}} --po {{path/to/po2.po}}` diff --git a/linux/portablectl b/linux/portablectl new file mode 100644 index 00000000..99bfdcb2 --- /dev/null +++ b/linux/portablectl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# portablectl + +> A systemd utility for managing and deploying portable service images on Linux systems. +> More information: . + +- List available portable service images discovered in the portable image search paths: + +`portablectl list` + +- Attach a portable service image to the host system: + +`portablectl attach {{path/to/image}}` + +- Detach a portable service image from the host system: + +`portablectl detach {{path/to/image|image_name}}` + +- Display details and metadata about a specified portable service image: + +`portablectl inspect {{path/to/image}}` + +- Check if a portable service image is attached to the host system: + +`portablectl is-attached {{path/to/image|image_name}}` diff --git a/linux/ports b/linux/ports new file mode 100644 index 00000000..fc1870ce --- /dev/null +++ b/linux/ports @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ports + +> Update/list the ports tree on a CRUX system. +> More information: . + +- Update the ports tree: + +`ports -u` + +- List the ports in the current tree: + +`ports -l` + +- Check the differences between installed packages and the ports tree: + +`ports -d` diff --git a/linux/postconf b/linux/postconf new file mode 100644 index 00000000..72bcdd9d --- /dev/null +++ b/linux/postconf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# postconf + +> Postfix configuration utility. +> This command displays the values of the `main.cf` configuration parameters by default and warns about possible mistyped parameter names. It can also change the `main.cf` configuration parameter values. +> More information: . + +- Specify the directory of the `main.cf` configuration file instead of the default configuration directory: + +`postconf -c {{path/to/configuration_directory}}` + +- Edit the `main.cf` configuration file and update parameter settings with the "name=value" pairs: + +`postconf -e` + +- Print the default parameter settings of the `main.cf` instead of the actual settings: + +`postconf -d` + +- Display parameters only from the specified class. The class can be one of builtin, service, user or all: + +`postconf -C {{class}}` + +- List available SASL plug-in types for the Postfix SMTP server. The plug-in type is selected with the `smtpd_sasl_type` configuration parameter by specifying `cyrus` or `dovecot` as the name: + +`postconf -a` + +- List the names of all supported lookup table types. Lookup tables are specified as `type:name` in configuration files where the type can be `btree`, `cdb`, `hash`, `mysql`, etc: + +`postconf -m` diff --git a/linux/postfix b/linux/postfix new file mode 100644 index 00000000..a79b8b2f --- /dev/null +++ b/linux/postfix @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# postfix + +> Postfix mail transfer agent (MTA) control program. +> See also `dovecot`, a mail delivery agent (MDA) that integrates with Postfix. +> More information: . + +- Check the configuration: + +`sudo postfix check` + +- Check the status of the Postfix daemon: + +`sudo postfix status` + +- Start Postfix: + +`sudo postfix start` + +- Gracefully stop Postfix: + +`sudo postfix stop` + +- Flush the mail queue: + +`sudo postfix flush` + +- Reload the configuration files: + +`sudo postfix reload` diff --git a/linux/poweroff b/linux/poweroff new file mode 100644 index 00000000..d278c8dc --- /dev/null +++ b/linux/poweroff @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# poweroff + +> Power off the system. +> More information: . + +- Power off the system: + +`poweroff` + +- Halt the system (same as `halt`): + +`poweroff --halt` + +- Reboot the system (same as `reboot`): + +`poweroff --reboot` + +- Shut down immediately without contacting the system manager: + +`poweroff --force --force` + +- Write the wtmp shutdown entry without shutting down the system: + +`poweroff --wtmp-only` diff --git a/linux/powerprofilesctl b/linux/powerprofilesctl new file mode 100644 index 00000000..54929f23 --- /dev/null +++ b/linux/powerprofilesctl @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# powerprofilesctl + +> Make power profiles handling available over D-Bus. +> More information: . + +- List available power profiles: + +`powerprofilesctl list` + +- Set a specific power profile: + +`powerprofilesctl set {{profile_name}}` diff --git a/linux/powerstat b/linux/powerstat new file mode 100644 index 00000000..eb7e5ad3 --- /dev/null +++ b/linux/powerstat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# powerstat + +> Measures the power consumption of a computer that has a battery power source or supports the RAPL interface. +> More information: . + +- Measure power with the default of 10 samples with an interval of 10 seconds: + +`powerstat` + +- Measure power with custom number of samples and interval duration: + +`powerstat {{interval}} {{number_of_samples}}` + +- Measure power using Intel's RAPL interface: + +`powerstat -R {{interval}} {{number_of_samples}}` + +- Show a histogram of the power measurements: + +`powerstat -H {{interval}} {{number_of_samples}}` + +- Enable all statistics gathering options: + +`powerstat -a {{interval}} {{number_of_samples}}` diff --git a/linux/powertop b/linux/powertop new file mode 100644 index 00000000..3f851f84 --- /dev/null +++ b/linux/powertop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# powertop + +> Optimize battery power usage. +> More information: . + +- Calibrate power usage measurements: + +`sudo powertop --calibrate` + +- Generate HTML power usage report in the current directory: + +`sudo powertop --html={{power_report.html}}` + +- Tune to optimal settings: + +`sudo powertop --auto-tune` + +- Generate a report for a specified number of seconds (instead of 20 by default): + +`sudo powertop --time={{5}}` diff --git a/linux/prename b/linux/prename new file mode 100644 index 00000000..01f929ea --- /dev/null +++ b/linux/prename @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rename + +> Rename multiple files. +> Note: this page refers to the command from the `prename` Fedora package. +> More information: . + +- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): + +`rename {{'s/foo/bar/'}} {{*}}` + +- Dry-run - display which renames would occur without performing them: + +`rename -n {{'s/foo/bar/'}} {{*}}` + +- Force renaming even if the operation would remove existing destination files: + +`rename -f {{'s/foo/bar/'}} {{*}}` + +- Convert filenames to lower case (use `-f` in case-insensitive filesystems to prevent "already exists" errors): + +`rename 'y/A-Z/a-z/' {{*}}` + +- Replace whitespace with underscores: + +`rename 's/\s+/_/g' {{*}}` diff --git a/linux/pridecat b/linux/pridecat new file mode 100644 index 00000000..8c14a83d --- /dev/null +++ b/linux/pridecat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pridecat + +> Like cat but more colorful :). +> More information: . + +- Print the contents of a file in pride colors to `stdout`: + +`pridecat {{path/to/file}}` + +- Print contents of a file in trans colors: + +`pridecat {{path/to/file}} --{{transgender|trans}}` + +- Alternate between lesbian and bisexual pride flags: + +`pridecat {{path/to/file}} --lesbian --bi` + +- Print contents of a file with the background colors changed: + +`pridecat {{path/to/file}} -b` + +- List directory contents in pride flag colors: + +`ls | pridecat --{{flag}}` diff --git a/linux/print b/linux/print new file mode 100644 index 00000000..4de65d18 --- /dev/null +++ b/linux/print @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# print + +> An alias to a `run-mailcap`'s action print. +> Originally `run-mailcap` is used to process mime-type/file. +> More information: . + +- Print action can be used to print any file on default run-mailcap tool: + +`print {{filename}}` + +- With `run-mailcap`: + +`run-mailcap --action=print {{filename}}` diff --git a/linux/prlimit b/linux/prlimit new file mode 100644 index 00000000..66add5a8 --- /dev/null +++ b/linux/prlimit @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# prlimit + +> Get or set process resource soft and hard limits. +> Given a process ID and one or more resources, prlimit tries to retrieve and/or modify the limits. +> More information: . + +- Display limit values for all current resources for the running parent process: + +`prlimit` + +- Display limit values for all current resources of a specified process: + +`prlimit --pid {{pid_number}}` + +- Run a command with a custom number of open files limit: + +`prlimit --nofile={{10}} {{command}}` diff --git a/linux/pro b/linux/pro new file mode 100644 index 00000000..98861206 --- /dev/null +++ b/linux/pro @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pro + +> Manage Ubuntu Pro services. +> More information: . + +- Connect your system to the Ubuntu Pro support contract: + +`sudo pro attach` + +- Display the status of Ubuntu Pro services: + +`pro status` + +- Check if the system is affected by a specific vulnerability (and apply a fix if possible): + +`pro fix {{CVE-number}}` + +- Display the number of unsupported packages: + +`pro security-status` + +- List packages that are no longer available for download: + +`pro security-status --unavailable` + +- List third-party packages: + +`pro security-status --thirdparty` diff --git a/linux/protontricks b/linux/protontricks new file mode 100644 index 00000000..d83fe4f9 --- /dev/null +++ b/linux/protontricks @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# protontricks + +> A simple wrapper that runs Winetricks commands for Proton enabled games. +> More information: . + +- Run the protontricks GUI: + +`protontricks --gui` + +- Run Winetricks for a specific game: + +`protontricks {{appid}} {{winetricks_args}}` + +- Run a command within a game's installation directory: + +`protontricks -c {{command}} {{appid}}` + +- [l]ist all installed games: + +`protontricks -l` + +- [s]earch for a game's App ID by name: + +`protontricks -s {{game_name}}` + +- Display help: + +`protontricks --help` diff --git a/linux/protonvpn-cli b/linux/protonvpn-cli new file mode 100644 index 00000000..9eea9dbe --- /dev/null +++ b/linux/protonvpn-cli @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# protonvpn-cli + +> Official ProtonVPN client. +> See also: `protonvpn-cli-connect`. +> More information: . + +- Log in to the ProtonVPN account: + +`protonvpn-cli login {{username}}` + +- Start a kill switch upon connecting to ProtonVPN: + +`protonvpn-cli killswitch --on` + +- Connect to ProtonVPN interactively: + +`protonvpn-cli connect` + +- Display connection status: + +`protonvpn-cli status` + +- Block malware using ProtonVPN NetShield: + +`protonvpn-cli netshield --malware` + +- Disconnect from ProtonVPN: + +`protonvpn-cli disconnect` + +- Display the current ProtonVPN configuration: + +`protonvpn-cli config --list` + +- Display help for a subcommand: + +`protonvpn-cli {{subcommand}} --help` diff --git a/linux/protonvpn-cli-connect b/linux/protonvpn-cli-connect new file mode 100644 index 00000000..30b6a6b4 --- /dev/null +++ b/linux/protonvpn-cli-connect @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# protonvpn-cli connect + +> Connect to ProtonVPN. +> More information: . + +- Connect to ProtonVPN interactively: + +`protonvpn-cli connect` + +- Connect to ProtonVPN using the fastest server available: + +`protonvpn-cli connect --fastest` + +- Connect to ProtonVPN using a specific server with a specific protocol: + +`protonvpn-cli connect {{server_name}} --protocol {{udp|tcp}}` + +- Connect to ProtonVPN using a random server with a specific protocol: + +`protonvpn-cli connect --random --protocol {{udp|tcp}}` + +- Connect to ProtonVPN using the fastest Tor-supporting server: + +`protonvpn-cli connect --tor` + +- Display help: + +`protonvpn-cli connect --help` diff --git a/linux/prt-get b/linux/prt-get new file mode 100644 index 00000000..f19b2de5 --- /dev/null +++ b/linux/prt-get @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# prt-get + +> The CRUX package manager. +> More information: . + +- Install a package: + +`prt-get install {{package}}` + +- Install a package with dependency handling: + +`prt-get depinst {{package}}` + +- Update a package manually: + +`prt-get upgrade {{package}}` + +- Remove a package: + +`prt-get remove {{package}}` + +- Upgrade the system from the local ports tree: + +`prt-get sysup` + +- Search the ports tree: + +`prt-get search {{query}}` + +- Search for a file in a package: + +`prt-get fsearch {{file}}` diff --git a/linux/pstoedit b/linux/pstoedit new file mode 100644 index 00000000..02c544a4 --- /dev/null +++ b/linux/pstoedit @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pstoedit + +> Convert PDF files into various image formats. +> More information: . + +- Convert a PDF page to PNG or JPEG format: + +`pstoedit -page {{page_number}} -f magick {{path/to/file.pdf}} {{page.png|page.jpg]}}` + +- Convert multiple PDF pages to numbered images: + +`pstoedit -f magick {{path/to/file}} {{page%d.png|page%d.jpg}}` diff --git a/linux/pstree b/linux/pstree new file mode 100644 index 00000000..04706931 --- /dev/null +++ b/linux/pstree @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pstree + +> A convenient tool to show running processes as a tree. +> More information: . + +- Display a tree of processes: + +`pstree` + +- Display a tree of processes with PIDs: + +`pstree -p` + +- Display all process trees rooted at processes owned by specified user: + +`pstree {{user}}` diff --git a/linux/ptx b/linux/ptx new file mode 100644 index 00000000..0120ca62 --- /dev/null +++ b/linux/ptx @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ptx + +> Generate a permuted index of words from text files. +> More information: . + +- Generate a permuted index where the first field of each line is an index reference: + +`ptx --references {{path/to/file}}` + +- Generate a permuted index with automatically generated index references: + +`ptx --auto-reference {{path/to/file}}` + +- Generate a permuted index with a fixed width: + +`ptx --width={{width_in_columns}} {{path/to/file}}` + +- Generate a permuted index with a list of filtered words: + +`ptx --only-file={{path/to/filter}} {{path/to/file}}` + +- Generate a permuted index with SYSV-style behaviors: + +`ptx --traditional {{path/to/file}}` diff --git a/linux/pulseaudio b/linux/pulseaudio new file mode 100644 index 00000000..8cfefe35 --- /dev/null +++ b/linux/pulseaudio @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pulseaudio + +> The PulseAudio sound system daemon and manager. +> More information: . + +- Check if PulseAudio is running (a non-zero exit code means it is not running): + +`pulseaudio --check` + +- Start the PulseAudio daemon in the background: + +`pulseaudio --start` + +- Kill the running PulseAudio daemon: + +`pulseaudio --kill` + +- List available modules: + +`pulseaudio --dump-modules` + +- Load a module into the currently running daemon with the specified arguments: + +`pulseaudio --load="{{module_name}} {{arguments}}"` diff --git a/linux/pvcreate b/linux/pvcreate new file mode 100644 index 00000000..fc5742ea --- /dev/null +++ b/linux/pvcreate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pvcreate + +> Initialize a disk or partition for use as a physical volume. +> See also: `lvm`. +> More information: . + +- Initialize the `/dev/sda1` volume for use by LVM: + +`pvcreate {{/dev/sda1}}` + +- Force the creation without any confirmation prompts: + +`pvcreate --force {{/dev/sda1}}` diff --git a/linux/pvdisplay b/linux/pvdisplay new file mode 100644 index 00000000..941b2b87 --- /dev/null +++ b/linux/pvdisplay @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pvdisplay + +> Display information about Logical Volume Manager (LVM) physical volumes. +> See also: `lvm`. +> More information: . + +- Display information about all physical volumes: + +`sudo pvdisplay` + +- Display information about the physical volume on drive `/dev/sdXY`: + +`sudo pvdisplay {{/dev/sdXY}}` diff --git a/linux/pvs b/linux/pvs new file mode 100644 index 00000000..ba51e68a --- /dev/null +++ b/linux/pvs @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pvs + +> Display information about physical volumes. +> See also: `lvm`. +> More information: . + +- Display information about physical volumes: + +`pvs` + +- Display non-physical volumes: + +`pvs -a` + +- Change default display to show more details: + +`pvs -v` + +- Display only specific fields: + +`pvs -o {{field_name_1}},{{field_name_2}}` + +- Append field to default display: + +`pvs -o +{{field_name}}` + +- Suppress heading line: + +`pvs --noheadings` + +- Use separator to separate fields: + +`pvs --separator {{special_character}}` diff --git a/linux/pw-cat b/linux/pw-cat new file mode 100644 index 00000000..9505c001 --- /dev/null +++ b/linux/pw-cat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-cat + +> Play and record audio files through pipewire. +> More information: . + +- Play a WAV file over the default target: + +`pw-cat --playback {{path/to/file.wav}}` + +- Play a WAV file with a specified resampler quality (4 by default): + +`pw-cat --quality {{0..15}} --playback {{path/to/file.wav}}` + +- Record a sample recording at a volume level of 125%: + +`pw-cat --record --volume {{1.25}} {{path/to/file.wav}}` + +- Record a sample recording using a different sample rate: + +`pw-cat --record --rate {{6000}} {{path/to/file.wav}}` diff --git a/linux/pw-cli b/linux/pw-cli new file mode 100644 index 00000000..a5e6c19b --- /dev/null +++ b/linux/pw-cli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-cli + +> Manage a PipeWire instance's modules, objects, nodes, devices, links and much more. +> More information: . + +- Print all nodes (sinks and sources) along with their IDs: + +`pw-cli list-objects Node` + +- Print information about an object with a specific ID: + +`pw-cli info {{4}}` + +- Print all objects' information: + +`pw-cli info all` diff --git a/linux/pw-dot b/linux/pw-dot new file mode 100644 index 00000000..e6a070d6 --- /dev/null +++ b/linux/pw-dot @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-dot + +> Create `.dot` files of the PipeWire graph. +> See also: `dot`, for rendering graph. +> More information: . + +- Generate a graph to `pw.dot` file: + +`pw-dot` + +- Specify an output file, showing all object types: + +`pw-dot --output {{path/to/file.dot}} --all` + +- Print `.dot` graph to `stdout`, showing all object properties: + +`pw-dot --output - --detail` + +- Generate a graph from a remote instance, showing only linked objects: + +`pw-dot --remote {{remote_name}} --smart` + +- Lay the graph from left to right, instead of dot's default top to bottom: + +`pw-dot --lr` + +- Lay the graph using 90-degree angles in edges: + +`pw-dot --90` diff --git a/linux/pw-dump b/linux/pw-dump new file mode 100644 index 00000000..fc1b47f2 --- /dev/null +++ b/linux/pw-dump @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-dump + +> Dump PipeWire's current state as JSON, including the information on nodes, devices, modules, ports, and other objects. +> See also: `pw-mon`. +> More information: . + +- Print a JSON representation of the default PipeWire instance's current state: + +`pw-dump` + +- Dump the current state [m]onitoring changes, printing it again: + +`pw-dump --monitor` + +- Dump the current state of a [r]emote instance to a file: + +`pw-dump --remote {{remote_name}} > {{path/to/dump_file.json}}` + +- Set a [C]olor configuration: + +`pw-dump --color {{never|always|auto}}` + +- Display help: + +`pw-dump --help` diff --git a/linux/pw-link b/linux/pw-link new file mode 100644 index 00000000..b66d3c39 --- /dev/null +++ b/linux/pw-link @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-link + +> Manage links between ports in PipeWire. +> More information: . + +- List all audio output and input ports with their IDs: + +`pw-link --output --input --ids` + +- Create a link between an output and an input port: + +`pw-link {{output_port_name}} {{input_port_name}}` + +- Disconnect two ports: + +`pw-link --disconnect {{output_port_name}} {{input_port_name}}` + +- List all links with their IDs: + +`pw-link --links --ids` + +- Display help: + +`pw-link -h` diff --git a/linux/pw-loopback b/linux/pw-loopback new file mode 100644 index 00000000..f4c078a8 --- /dev/null +++ b/linux/pw-loopback @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-loopback + +> Create loopback devices in PipeWire. +> More information: . + +- Create a loopback device with the default loopback behavior: + +`pw-loopback` + +- Create a loopback device that automatically connects to the speakers: + +`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}'` + +- Create a loopback device that automatically connects to the microphone: + +`pw-loopback -m '{{[FL FR]}}' --playback-props='{{media.class=Audio/Source}}'` + +- Create a dummy loopback device that doesn't automatically connect to anything: + +`pw-loopback -m '{{[FL FR]}}' --capture-props='{{media.class=Audio/Sink}}' --playback-props='{{media.class=Audio/Source}}'` + +- Create a loopback device that automatically connects to the speakers and swaps the left and right channels between the sink and source: + +`pw-loopback --capture-props='{{media.class=Audio/Sink audio.position=[FL FR]}}' --playback-props='{{audio.position=[FR FL]}}'` + +- Create a loopback device that automatically connects to the microphone and swaps the left and right channels between the sink and source: + +`pw-loopback --capture-props='{{audio.position=[FR FL]}}' --playback-props='{{media.class=Audio/Source audio.position=[FL FR]}}'` diff --git a/linux/pw-mon b/linux/pw-mon new file mode 100644 index 00000000..cab28d0d --- /dev/null +++ b/linux/pw-mon @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-mon + +> Monitor objects on the PipeWire instance. +> More information: . + +- Monitor the default PipeWire instance: + +`pw-mon` + +- Monitor a specific remote instance: + +`pw-mon --remote={{remote_name}}` + +- Monitor the default instance specifying a color configuration: + +`pw-mon --color={{never|always|auto}}` + +- Display help: + +`pw-mon --help` diff --git a/linux/pw-play b/linux/pw-play new file mode 100644 index 00000000..d69bab7c --- /dev/null +++ b/linux/pw-play @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-play + +> Play audio files through `pipewire`. +> Shorthand for `pw-cat --playback`. +> More information: . + +- Play a WAV sound file over the default target: + +`pw-play {{path/to/file.wav}}` + +- Play a WAV sound file at a different volume level: + +`pw-play --volume={{0.1}} {{path/to/file.wav}}` diff --git a/linux/pw-profiler b/linux/pw-profiler new file mode 100644 index 00000000..f46cb971 --- /dev/null +++ b/linux/pw-profiler @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-profiler + +> Profile a local or remote instance. +> More information: . + +- Profile the default instance, logging to `profile.log` (`gnuplot` files and a `.html` file for result visualizing are also generated): + +`pw-profiler` + +- Change the log output file: + +`pw-profiler --output {{path/to/file.log}}` + +- Profile a remote instance: + +`pw-profiler --remote {{remote_name}}` + +- Display help: + +`pw-profiler --help` diff --git a/linux/pw-record b/linux/pw-record new file mode 100644 index 00000000..8c24fe12 --- /dev/null +++ b/linux/pw-record @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-record + +> Record audio files through pipewire. +> Shorthand for pw-cat --record. +> More information: . + +- Record a sample recording using the default target: + +`pw-record {{path/to/file.wav}}` + +- Record a sample recording at a different volume level: + +`pw-record --volume={{0.1}} {{path/to/file.wav}}` + +- Record a sample recording using a different sample rate: + +`pw-record --rate={{6000}} {{path/to/file.wav}}` diff --git a/linux/pw-top b/linux/pw-top new file mode 100644 index 00000000..d982cb07 --- /dev/null +++ b/linux/pw-top @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-top + +> View the PipeWire nodes and devices statistics in real-time. +> See also: `pipewire`, `pw-dump`, `pw-cli`, `pw-profiler`. +> More information: . + +- Display an interactive view of PipeWire nodes and devices: + +`pw-top` + +- Monitor a remote instance: + +`pw-top --remote {{remote_name}}` + +- Print information periodically instead of running in interactive mode: + +`pw-top --batch-mode` + +- Print information periodically for a specific number of times: + +`pw-top --batch-mode --iterations {{3}}` diff --git a/linux/pwd b/linux/pwd new file mode 100644 index 00000000..2ead4662 --- /dev/null +++ b/linux/pwd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pwd + +> Print name of current/working directory. +> More information: . + +- Print the current directory: + +`pwd` + +- Print the current directory, and resolve all symlinks (i.e. show the "physical" path): + +`pwd --physical` + +- Print the current logical directory: + +`pwd --logical` diff --git a/linux/pwdx b/linux/pwdx new file mode 100644 index 00000000..3283aa76 --- /dev/null +++ b/linux/pwdx @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pwdx + +> Print working directory of a process. +> More information: . + +- Print current working directory of a process: + +`pwdx {{process_id}}` diff --git a/linux/pyrit b/linux/pyrit new file mode 100644 index 00000000..8009a51c --- /dev/null +++ b/linux/pyrit @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pyrit + +> WPA/WPA2 cracking tool using computational power. +> More information: . + +- Display system cracking speed: + +`pyrit benchmark` + +- List available cores: + +`pyrit list_cores` + +- Set [e]SSID: + +`pyrit -e "{{ESSID}}" create_essid` + +- [r]ead and analyze a specific packet capture file: + +`pyrit -r {{path/to/file.cap|path/to/file.pcap}} analyze` + +- Read and [i]mport passwords to the current database: + +`pyrit -i {{path/to/file}} {{import_unique_passwords|unique_passwords|import_passwords}}` + +- Exp[o]rt passwords from database to a specific file: + +`pyrit -o {{path/to/file}} export_passwords` + +- Translate passwords with Pired Master Keys: + +`pyrit batch` + +- [r]ead the capture file and crack the password: + +`pyrit -r {{path/to/file}} attack_db` diff --git a/linux/qjoypad b/linux/qjoypad new file mode 100644 index 00000000..477e2d7a --- /dev/null +++ b/linux/qjoypad @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qjoypad + +> Translate input from gamepads or joysticks into keyboard strokes or mouse actions. +> More information: . + +- Start QJoyPad: + +`qjoypad` + +- Start QJoyPad and look for devices in a specific directory: + +`qjoypad --device={{path/to/directory}}` + +- Start QJoyPad but don't show a system tray icon: + +`qjoypad --notray` + +- Start QJoyPad and force the window manager to use a system tray icon: + +`qjoypad --force-tray` + +- Force a running instance of QJoyPad to update its list of devices and layouts: + +`qjoypad --update` + +- Load the given layout in an already running instance of QJoyPad, or start QJoyPad using the given layout: + +`qjoypad "{{layout}}"` diff --git a/linux/qm b/linux/qm new file mode 100644 index 00000000..ce2f0da4 --- /dev/null +++ b/linux/qm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm + +> QEMU/KVM Virtual Machine Manager. +> More information: . + +- List all virtual machines: + +`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: + +`qm create {{100}} -ide0 {{local-lvm:4}} -net0 {{e1000}} -cdrom {{local:iso/proxmox-mailgateway_2.1.iso}}` + +- Show the configuration of a virtual machine, specifying its ID: + +`qm config {{100}}` + +- Start a specific virtual machine: + +`qm start {{100}}` + +- Send a shutdown request, then wait until the virtual machine is stopped: + +`qm shutdown {{100}} && qm wait {{100}}` + +- Destroy a virtual machine and remove all related resources: + +`qm destroy {{100}} --purge` diff --git a/linux/qm-cleanup b/linux/qm-cleanup new file mode 100644 index 00000000..0058a3fd --- /dev/null +++ b/linux/qm-cleanup @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm cleanup + +> Clean up resources on QEMU/KVM Virtual Machine Manager like tap devices, VGPUs, etc. +> Called after a VM shuts down, crashes, etc. +> More information: . + +- Clean up resources: + +`qm cleanup {{vm_id}} {{clean-shutdown}} {{guest-requested}}` diff --git a/linux/qm-clone b/linux/qm-clone new file mode 100644 index 00000000..898d826e --- /dev/null +++ b/linux/qm-clone @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm clone + +> Create a copy of virtual machine on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Copy a virtual machine: + +`qm copy {{vm_id}} {{new_vm_id}}` + +- Copy a virtual machine using a specific name: + +`qm copy {{vm_id}} {{new_vm_id}} --name {{name}}` + +- Copy a virtual machine using a specific descriptionn: + +`qm copy {{vm_id}} {{new_vm_id}} --description {{description}}` + +- Copy a virtual machine creating a full copy of all disks: + +`qm copy {{vm_id}} {{new_vm_id}} --full` + +- Copy a virtual machine using a specific format for file storage (requires `--full`): + +`qm copy {{vm_id}} {{new_vm_id}} --full --format {{qcow2|raw|vmdk}}` + +- Copy a virtual machine then add it to a specific pool: + +`qm copy {{vm_id}} {{new_vm_id}} --pool {{pool_name}}` diff --git a/linux/qm-cloud-init b/linux/qm-cloud-init new file mode 100644 index 00000000..059379fa --- /dev/null +++ b/linux/qm-cloud-init @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm cloud init + +> Configure cloudinit settings for virtual machines managed by Proxmox Virtual Environment (PVE). +> More information: . + +- Configure cloudinit settings for a specific user and set password for the user: + +`qm cloud-init {{vm_id}} -user={{user}} -password={{password}}` + +- Configure cloudinit settings for a specific user and set password for the user with a specific SSH key: + +`qm cloud-init {{vm_id}} -user={{user}} -password={{password}} -sshkey={{ssh_key}}` + +- Set the hostname for a specific virtual machine: + +`qm cloud-init {{vm_id}} -hostname={{hostname}}` + +- Configure the network interface settings for a specific virtual machine: + +`qm cloud-init {{vm_id}} -ipconfig {{ipconfig}}` + +- Configure a shell script to execute before `cloud-ini` is run on a virtual machine: + +`qm cloud-init {{vm_id}} -pre {{script}}` diff --git a/linux/qm-cloudinit-dump b/linux/qm-cloudinit-dump new file mode 100644 index 00000000..6b4a8638 --- /dev/null +++ b/linux/qm-cloudinit-dump @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm cloudinit dump + +> Generate cloudinit configuration files. +> More information: . + +- Generate a cloudinit file for a specific configuration type: + +`qm cloudinit dump {{virtual_machine_id}} {{meta|network|user}}` diff --git a/linux/qm-config b/linux/qm-config new file mode 100644 index 00000000..eb01e91f --- /dev/null +++ b/linux/qm-config @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm config + +> Display the virtual machine configuration with pending configuration changes applied. +> More information: . + +- Display the virtual machine configuration: + +`qm config {{vm_id}}` + +- Display the current configuration values instead of pending values for the virtual machine: + +`qm config --current {{true}} {{vm_id}}` + +- Fetch the configuration values from the given snapshot: + +`qm config --snapshot {{snapshot_name}} {{vm_id}}` diff --git a/linux/qm-create b/linux/qm-create new file mode 100644 index 00000000..1dea1c40 --- /dev/null +++ b/linux/qm-create @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm create + +> Create or restore a virtual machine on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Create a virtual machine: + +`qm create {{100}}` + +- Automatically start the machine after creation: + +`qm create {{100}} --start 1` + +- Specify the type of operating system on the machine: + +`qm create {{100}} --ostype {{win10}}` + +- Replace an existing machine (requires archiving it): + +`qm create {{100}} --archive {{path/to/backup_file.tar}} --force 1` + +- Specify a script that is executed automatically depending on the state of the virtual machine: + +`qm create {{100}} --hookscript {{path/to/script.pl}}` diff --git a/linux/qm-delsnapshot b/linux/qm-delsnapshot new file mode 100644 index 00000000..f52a18c9 --- /dev/null +++ b/linux/qm-delsnapshot @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm delsnapshot + +> Delete virtual machine snapshots. +> More information: . + +- Delete a snapshot: + +`qm delsnapshot {{vm_id}} {{snapshot_name}}` + +- Delete a snapshot from a configuration file (even if removing the disk snapshot fails): + +`qm delsnapshot {{vm_id}} {{snapshot_name}} --force 1` diff --git a/linux/qm-destroy b/linux/qm-destroy new file mode 100644 index 00000000..6e755a7d --- /dev/null +++ b/linux/qm-destroy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm destroy + +> Destroy a virtual machine in QEMU/KVM Virtual Machine Manager. +> More information: . + +- Destroy a specific virtual machine: + +`qm destroy {{vm_id}}` + +- Destroy all disks that are not explicitly referenced in a specific virtual machine's configuration: + +`qm destroy {{vm_id}} --destroy-unreferenced-disks` + +- Destroy a virtual machine and remove from all locations (inventory, backup jobs, high availability managers, etc.): + +`qm destroy {{vm_id}} --purge` + +- Destroy a specific virtual machine ignoring locks and forcing destroy: + +`sudo qm destroy {{vm_id}} --skiplock` diff --git a/linux/qm-disk-import b/linux/qm-disk-import new file mode 100644 index 00000000..94dd9d3d --- /dev/null +++ b/linux/qm-disk-import @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm disk import + +> Import a disk image to a virtual machine as an unused disk. +> The supported image formats for `qemu-img`, such as raw, qcow2, qed, vdi, vmdk, and vhd must be used. +> More information: . + +- Import a VMDK/qcow2/raw disk image using a specific storage name: + +`qm importdisk {{vm_id}} {{path/to/disk}} {{storage_name}} --format {{qcow2|raw|vmdk}}` diff --git a/linux/qm-disk-move b/linux/qm-disk-move new file mode 100644 index 00000000..cebe5526 --- /dev/null +++ b/linux/qm-disk-move @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm disk move + +> Move a virtual disk from one storage to another within the same Proxmox cluster. +> More information: . + +- Move a virtual disk: + +`qm disk move {{vm_id}} {{destination}} {{index}}` + +- Delete the previous copy of the virtual disk: + +`qm disk move -delete {{vm_id}} {{destination}} {{index}}` diff --git a/linux/qm-disk-resize b/linux/qm-disk-resize new file mode 100644 index 00000000..53825321 --- /dev/null +++ b/linux/qm-disk-resize @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm disk resize + +> Resize a virtual machine disk in the Proxmox Virtual Environment (PVE). +> More information: . + +- Add `n` gigabytes to a virtual disk: + +`qm disk resize {{vm_id}} {{disk_name}} +{{n}}G` diff --git a/linux/qm-guest-cmd b/linux/qm-guest-cmd new file mode 100644 index 00000000..dd078158 --- /dev/null +++ b/linux/qm-guest-cmd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm guest cmd + +> Execute QEMU Guest Agent commands. +> More information: . + +- Execute a specific QEMU Guest Agent command: + +`qm guest cmd {{virtual_machine_id}} {{fsfreeze-freeze|fsfreeze-status|fsfreeze-thaw|fstrim|get-fsinfo|...}}` diff --git a/linux/qm-guest-exec b/linux/qm-guest-exec new file mode 100644 index 00000000..d4daa333 --- /dev/null +++ b/linux/qm-guest-exec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm guest exec + +> Execute a specific command via a guest agent. +> More information: . + +- Execute a specific command via a guest agent: + +`qm guest exec {{vm_id}} {{command}} {{argument1 argument2 ...}}` + +- Execute a specific command via a guest agent asynchronously: + +`qm guest exec {{vm_id}} {{argument1 argument2 ...}} --synchronous 0` + +- Execute a specific command via a guest agent with a specified timeout of 10 seconds: + +`qm guest exec {{vm_id}} {{argument1 argument2...}} --timeout {{10}}` + +- Execute a specific command via a guest agent and forward input from STDIN until EOF to the guest agent: + +`qm guest exec {{vm_id}} {{argument1 argument2 ...}} --pass-stdin 1` diff --git a/linux/qm-guest-exec-status b/linux/qm-guest-exec-status new file mode 100644 index 00000000..34da91a9 --- /dev/null +++ b/linux/qm-guest-exec-status @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm guest exec-status + +> Print the status of a pid started by the guest-agent on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Print the status of a specific PID: + +`qm guest exec-status {{vm_id}} {{pid}}` diff --git a/linux/qm-guest-passwd b/linux/qm-guest-passwd new file mode 100644 index 00000000..be55e2f6 --- /dev/null +++ b/linux/qm-guest-passwd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm guest passwd + +> Set the password for a user on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Set a password for a specific user in a virtual machine interactively: + +`qm guest passwd {{vm_id}} {{username}}` + +- Set an already hashed password for a specific user in a virtual machine interactively: + +`qm guest passwd {{vm_id}} {{username}} --crypted 1` diff --git a/linux/qm-help b/linux/qm-help new file mode 100644 index 00000000..03d76f7c --- /dev/null +++ b/linux/qm-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm help + +> Display help for a command. +> More information: . + +- Display help for a specific command: + +`qm help {{command}}` + +- Display help for a specific command with detailed information: + +`qm help {{command}} --verbose {{true|false}}` diff --git a/linux/qm-import-disk b/linux/qm-import-disk new file mode 100644 index 00000000..872e5bb8 --- /dev/null +++ b/linux/qm-import-disk @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm import disk + +> This command is an alias of `qm disk import`. + +- View documentation for the original command: + +`tldr qm disk import` diff --git a/linux/qm-list b/linux/qm-list new file mode 100644 index 00000000..0238a052 --- /dev/null +++ b/linux/qm-list @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm list + +> List all virtual machines. +> More information: . + +- List all virtual machines: + +`qm list` + +- List all virtual machines with a full status about the ones which are currently running: + +`qm list --full 1` diff --git a/linux/qm-listsnapshot b/linux/qm-listsnapshot new file mode 100644 index 00000000..410dd84a --- /dev/null +++ b/linux/qm-listsnapshot @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm listsnapshot + +> List snapshots of virtual machines. +> More information: . + +- List all snapshots of a specific virtual machine: + +`qm listsnapshot {{vm_id}}` diff --git a/linux/qm-migrate b/linux/qm-migrate new file mode 100644 index 00000000..9f9e084a --- /dev/null +++ b/linux/qm-migrate @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm migrate + +> Migrate a virtual machine. +> Used to create a new migration task. +> More information: . + +- Migrate a specific virtual machine: + +`qm migrate {{vm_id}} {{target}}` + +- Override the current I/O bandwidth limit with 10 KiB/s: + +`qm migrate {{vm_id}} {{target}} --bwlimit 10` + +- Allow migration of virtual machines using local devices (root only): + +`qm migrate {{vm_id}} {{target}} --force true` + +- Use online/live migration if a virtual machine is running: + +`qm migrate {{vm_id}} {{target}} --online true` + +- Enable live storage migration for local disks: + +`qm migrate {{vm_id}} {{target}} --with-local-disks true` diff --git a/linux/qm-monitor b/linux/qm-monitor new file mode 100644 index 00000000..b39a745c --- /dev/null +++ b/linux/qm-monitor @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm monitor + +> Enter the QEMU Monitor interface. +> More information: . + +- Enter the QEMU Monitor interface of a specific virtual machine: + +`qm monitor {{vm_id}}` diff --git a/linux/qm-move-disk b/linux/qm-move-disk new file mode 100644 index 00000000..dcf6fb19 --- /dev/null +++ b/linux/qm-move-disk @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm move disk + +> This command is an alias of `qm disk move`. +> More information: . + +- View documentation for the original command: + +`tldr qm disk move` diff --git a/linux/qm-move_disk b/linux/qm-move_disk new file mode 100644 index 00000000..dcf6fb19 --- /dev/null +++ b/linux/qm-move_disk @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm move disk + +> This command is an alias of `qm disk move`. +> More information: . + +- View documentation for the original command: + +`tldr qm disk move` diff --git a/linux/qm-mtunnel b/linux/qm-mtunnel new file mode 100644 index 00000000..e2acb85e --- /dev/null +++ b/linux/qm-mtunnel @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm mtunnel + +> Used by `qmigrate`. +> It should not be invoked manually. +> More information: . + +- Command used by `qmigrate` during data migration from a VM to another host: + +`qm mtunnel` diff --git a/linux/qm-pending b/linux/qm-pending new file mode 100644 index 00000000..8c3a3479 --- /dev/null +++ b/linux/qm-pending @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm pending + +> Get the virtual machine configuration with both current and pending values. +> More information: . + +- Get the virtual machine configuration of a specific virtual machine: + +`qm pending {{vm_id}}` diff --git a/linux/qm-reboot b/linux/qm-reboot new file mode 100644 index 00000000..f0e350ba --- /dev/null +++ b/linux/qm-reboot @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm reboot + +> Reboot a virtual machine by shutting it down, and starting it again after applying pending changes. +> More information: . + +- Reboot a virtual machine: + +`qm reboot {{vm_id}}` + +- Reboot a virtual machine after wait for at most 10 seconds: + +`qm reboot --timeout {{10}} {{vm_id}}` diff --git a/linux/qm-rescan b/linux/qm-rescan new file mode 100644 index 00000000..61b59530 --- /dev/null +++ b/linux/qm-rescan @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm rescan + +> Rescan all storages and update disk sizes and unused disk images of a virtual machine. +> More information: . + +- Rescan all storages and update disk sizes and unused disk images of a specific virtual machine: + +`qm rescan {{vm_id}}` + +- Perform a dry-run of rescan on a specific virtual machine and do not write any changes to configurations: + +`qm rescan --dryrun {{true}} {{vm_id}}` diff --git a/linux/qm-reset b/linux/qm-reset new file mode 100644 index 00000000..fdbae85d --- /dev/null +++ b/linux/qm-reset @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm reset + +> Reset a virtual machine on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Reset a virtual machine: + +`qm reset {{vm_id}}` + +- Reset a virtual machine and skip lock (only root can use this option): + +`qm reset --skiplock {{true}} {{vm_id}}` diff --git a/linux/qm-resize b/linux/qm-resize new file mode 100644 index 00000000..18b317bd --- /dev/null +++ b/linux/qm-resize @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm resize + +> This command is an alias of `qm-disk-resize`. +> More information: . + +- View documentation for the original command: + +`tldr qm-disk-resize` diff --git a/linux/qm-resume b/linux/qm-resume new file mode 100644 index 00000000..2e76642b --- /dev/null +++ b/linux/qm-resume @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm resume + +> Resume a virtual machine. +> More information: . + +- Resume a specific virtual machine: + +`qm resume {{vm_id}}` + +- Resume a specific virtual machine ignoring locks (requires root): + +`sudo qm resume {{vm_id}} --skiplock true` diff --git a/linux/qm-rollback b/linux/qm-rollback new file mode 100644 index 00000000..e2a91558 --- /dev/null +++ b/linux/qm-rollback @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm rollback + +> Rollback the VM state to a specified snapshot. +> More information: . + +- Rollback the state of a specific VM to a specified snapshot: + +`qm rollback {{vm_id}} {{snap_name}}` diff --git a/linux/qm-sendkey b/linux/qm-sendkey new file mode 100644 index 00000000..e10b44a9 --- /dev/null +++ b/linux/qm-sendkey @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm sendkey + +> Send QEMU monitor encoding key event to a virtual machine. +> More information: . + +- Send the specified key event to a specific virtual machine: + +`qm sendkey {{vm_id}} {{key}}` + +- Allow root user to send key event and ignore locks: + +`qm sendkey --skiplock {{true}} {{vm_id}} {{key}}` diff --git a/linux/qm-showcmd b/linux/qm-showcmd new file mode 100644 index 00000000..c4fd373b --- /dev/null +++ b/linux/qm-showcmd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm showcmd + +> Show command-line which is used to start the VM (debug info). +> More information: . + +- Show command-line for a specific virtual machine: + +`qm showcmd {{vm_id}}` + +- Put each option on a new line to enhance human readability: + +`qm showcmd --pretty {{true}} {{vm_id}}` + +- Fetch configuration values from a specific snapshot: + +`qm showcmd --snapshot {{string}} {{vm_id}}` diff --git a/linux/qm-shutdown b/linux/qm-shutdown new file mode 100644 index 00000000..83285f41 --- /dev/null +++ b/linux/qm-shutdown @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm shutdown + +> Shutdown a virtual machine on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Shutdown a virtual machine: + +`qm shutdown {{VM_ID}}` + +- Shutdown a virtual machine after wait for at most 10 seconds: + +`qm shutdown --timeout {{10}} {{VM_ID}}` + +- Shutdown a virtual machine and do not deactivate storage volumes: + +`qm shutdown --keepActive {{true}} {{VM_ID}}` + +- Shutdown a virtual machine and skip lock (only root can use this option): + +`qm shutdown --skiplock {{true}} {{VM_ID}}` + +- Stop and shutdown a virtual machine: + +`qm shutdown --forceStop {{true}} {{VM_ID}}` diff --git a/linux/qm-snapshot b/linux/qm-snapshot new file mode 100644 index 00000000..935e3b30 --- /dev/null +++ b/linux/qm-snapshot @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm snapshot + +> Create virtual machine snapshots. +> More information: . + +- Create a snapshot of a specific virtual machine: + +`qm snapshot {{vm_id}} {{snapshot_name}}` + +- Create a snapshot with a specific description: + +`qm snapshot {{vm_id}} {{snapshot_name}} --description {{description}}` + +- Create a snapshot including the vmstate: + +`qm snapshot {{vm_id}} {{snapshot_name}} --description {{description}} --vmstate 1` diff --git a/linux/qm-start b/linux/qm-start new file mode 100644 index 00000000..9228c9f6 --- /dev/null +++ b/linux/qm-start @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm start + +> Start a virtual machine on QEMU/KVM Virtual Machine Manager. +> More information: . + +- Start a specific virtual machine: + +`qm start {{100}}` + +- Specify the QEMU machine type (i.e. the CPU to emulate): + +`qm start {{100}} --machine {{q35}}` + +- Start a specific virtual machine with a timeout in 60 seconds: + +`qm start {{100}} --timeout {{60}}` diff --git a/linux/qm-status b/linux/qm-status new file mode 100644 index 00000000..168b025c --- /dev/null +++ b/linux/qm-status @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm status + +> Show virtual machine status. +> More information: . + +- Display the status of a specific virtual machine: + +`qm status {{vm_id}}` + +- Display detailed status of a specific virtual machine: + +`qm status --verbose {{true}} {{vm_id}}` diff --git a/linux/qm-suspend b/linux/qm-suspend new file mode 100644 index 00000000..d641e882 --- /dev/null +++ b/linux/qm-suspend @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm suspend + +> Suspends a virtual machine (VM) in the Proxmox Virtual Environment (PVE). +> Use `--skiplock` and `--skiplockstorage` flags with caution, as they may lead to data corruption in certain situations. +> More information: . + +- Suspend a virtual machine by id: + +`qm suspend {{vm_id}} {{integer}}` + +- Skip the lock check when suspending the VM: + +`qm suspend {{vm_id}} {{integer}} --skiplock` + +- Skip the lock check for storage when suspending the VM: + +`qm suspend {{vm_id}} {{integer}} --skiplockstorage` diff --git a/linux/qm-template b/linux/qm-template new file mode 100644 index 00000000..4f6a6a6f --- /dev/null +++ b/linux/qm-template @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm template + +> Create a Proxmox VM template. +> More information: . + +- Create a template out of a specific virtual machine: + +`qm template {{vm_id}}` diff --git a/linux/qm-unlock b/linux/qm-unlock new file mode 100644 index 00000000..59df2d3b --- /dev/null +++ b/linux/qm-unlock @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm unlock + +> Unlock a virtual machine in QEMU/KVM Virtual Machine Manager. +> More information: . + +- Unlock a specific virtual machine: + +`qm unlock {{vm_id}}` diff --git a/linux/qm-vncproxy b/linux/qm-vncproxy new file mode 100644 index 00000000..d4752b78 --- /dev/null +++ b/linux/qm-vncproxy @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm vncproxy + +> Proxy Virtual Machine VNC (Virtual network computing) traffic to `stdin` or `stdout`. +> More information: . + +- Proxy a specific virtual machine: + +`qm vncproxy {{vm_id}}` diff --git a/linux/qm-wait b/linux/qm-wait new file mode 100644 index 00000000..10c18ccf --- /dev/null +++ b/linux/qm-wait @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qm wait + +> Wait until the virtual machine is stopped. +> More information: . + +- Wait until the virtual machine is stopped: + +`qm wait {{vm_id}}` + +- Wait until the virtual machine is stopped with a 10 second timeout: + +`qm wait --timeout {{10}} {{vm_id}}` + +- Send a shutdown request, then wait until the virtual machine is stopped with a 10 second timeout: + +`qm shutdown {{vm_id}} && qm wait --timeout {{10}} {{vm_id}}` diff --git a/linux/qmrestore b/linux/qmrestore new file mode 100644 index 00000000..cdcffc13 --- /dev/null +++ b/linux/qmrestore @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qmrestore + +> Restore QemuServer vzdump backups. +> More information: . + +- Restore virtual machine from given backup file on the original storage: + +`qmrestore {{path/to/vzdump-qemu-100.vma.lzo}} {{100}}` + +- Overwrite existing virtual machine from a given backup file on the original storage: + +`qmrestore {{path/to/vzdump-qemu-100.vma.lzo}} {{100}} --force true` + +- Restore the virtual machine from a given backup file on specific storage: + +`qmrestore {{path/to/vzdump-qemu-100.vma.lzo}} {{100}} --storage {{local}}` + +- Start virtual machine immediately from the backup while restoring in the background (only on Proxmox Backup Server): + +`qmrestore {{path/to/vzdump-qemu-100.vma.lzo}} {{100}} --live-restore true` diff --git a/linux/qrcp b/linux/qrcp new file mode 100644 index 00000000..554ccff9 --- /dev/null +++ b/linux/qrcp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qrcp + +> A file transfer tool. +> More information: . + +- Send a file or directories: + +`qrcp send {{path/to/file_or_directory path/to/file_directory ...}}` + +- Receive files: + +`qrcp receive` + +- Compress content before transferring: + +`qrcp send --zip {{path/to/file_or_directory}}` + +- Use a specific [p]ort: + +`qrcp {{send|receive}} --port {{port_number}}` + +- Use a specific network [i]nterface: + +`qrcp {{send|receive}} --interface interface` + +- Keep the server alive: + +`qrcp {{send|receive}} --keep-alive` diff --git a/linux/qsub b/linux/qsub new file mode 100644 index 00000000..b6a208e5 --- /dev/null +++ b/linux/qsub @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qsub + +> Submits a script to the queue management system TORQUE. +> More information: . + +- Submit a script with default settings (depends on TORQUE settings): + +`qsub {{script.sh}}` + +- Submit a script with a specified wallclock runtime limit of 1 hour, 2 minutes and 3 seconds: + +`qsub -l walltime={{1}}:{{2}}:{{3}} {{script.sh}}` + +- Submit a script that is executed on 2 nodes using 4 cores per node: + +`qsub -l nodes={{2}}:ppn={{4}} {{script.sh}}` + +- Submit a script to a specific queue. Note that different queues can have different maximum and minimum runtime limits: + +`qsub -q {{queue_name}} {{script.sh}}` diff --git a/linux/qtchooser b/linux/qtchooser new file mode 100644 index 00000000..b23dd481 --- /dev/null +++ b/linux/qtchooser @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qtchooser + +> A wrapper used to select between Qt development binary versions. +> More information: . + +- List available Qt versions from the configuration files: + +`qtchooser --list-versions` + +- Print environment information: + +`qtchooser --print-env` + +- Run the specified tool using the specified Qt version: + +`qtchooser --run-tool={{tool}} --qt={{version_name}}` + +- Add a Qt version entry to be able to choose from: + +`qtchooser --install {{version_name}} {{path/to/qmake}}` + +- Display help: + +`qtchooser --help` diff --git a/linux/qtile b/linux/qtile new file mode 100644 index 00000000..6745f404 --- /dev/null +++ b/linux/qtile @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# qtile + +> A full-featured, hackable tiling window manager written and configured in Python. +> More information: . + +- Start the window manager, if it is not running already (should ideally be run from `.xsession` or similar): + +`qtile start` + +- Check the configuration file for any compilation errors (default location is `~/.config/qtile/config.py`): + +`qtile check` + +- Show current resource usage information: + +`qtile top --force` + +- Open the program `xterm` as a floating window on the group named `test-group`: + +`qtile run-cmd --group {{test-group}} --float {{xterm}}` + +- Restart the window manager: + +`qtile cmd-obj --object cmd --function restart` diff --git a/linux/quickemu b/linux/quickemu new file mode 100644 index 00000000..b18074d8 --- /dev/null +++ b/linux/quickemu @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# quickemu + +> Build and manage highly optimised desktop virtual machines quickly. +> See also: `quickget`, for preparing VM configurations. +> More information: . + +- Create and run a virtual machine from a configuration file: + +`quickemu --vm {{path/to/file.conf}}` + +- Do not commit any changes to disk/snapshot but write any changes to temporary files: + +`quickemu --status-quo --vm {{path/to/file.conf}}` + +- Start the virtual machine in full-screen mode ( + + f to exit) and select the display backend (`sdl` by default): + +`quickemu --fullscreen --display {{sdl|gtk|spice|spice-app|none}} --vm {{path/to/file.conf}}` + +- Select a virtual audio device to emulate and create a desktop shortcut: + +`quickemu --sound-card {{intel-hda|ac97|es1370|sb16|none}} --shortcut --vm {{path/to/file.conf}}` + +- Create a snapshot: + +`quickemu --snapshot create {{tag}} --vm {{path/to/file.conf}}` + +- Restore a snapshot: + +`quickemu --snapshot apply {{tag}} --vm {{path/to/file.conf}}` + +- Delete a snapshot: + +`quickemu --snapshot delete {{tag}} --vm {{path/to/file.conf}}` diff --git a/linux/quickget b/linux/quickget new file mode 100644 index 00000000..b66ed354 --- /dev/null +++ b/linux/quickget @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# quickget + +> Download and prepare materials for building a Quickemu virtual machine. +> Note: the parameter "edition" is always optional. +> See also: `quickemu`. +> More information: . + +- Display the list of all supported guest operating systems, versions and variants: + +`quickget list` + +- Download and create the virtual machine configuration for building a Quickemu virtual machine for an OS: + +`quickget {{os}} {{release}} {{edition}}` + +- Download configuration for a Windows 11 VM with VirtIO drivers for Windows: + +`quickget windows 11` + +- Download a macOS recovery image and creates a virtual machine configuration: + +`quickget macos {{high-sierra|mojave|catalina|big-sur|monterey|ventura}}` + +- Show an ISO URL for an operating system (Note: it does not work for Windows): + +`quickget --show-iso-url fedora {{release}} {{edition}}` + +- Test if an ISO file is available for an operating system: + +`quickget --test-iso-url nixos {{edition}} {{plasma5}}` + +- Open an operating system distribution's homepage in a browser (Note: it does not work for Windows): + +`quickget --open-distro-homepage {{os}}` diff --git a/linux/quotacheck b/linux/quotacheck new file mode 100644 index 00000000..9f8f35b2 --- /dev/null +++ b/linux/quotacheck @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# quotacheck + +> Scan a filesystem for disk usage; create, check and repair quota files. +> It is best to run quota check with quotas turned off to prevent damage or loss to quota files. +> More information: . + +- Check quotas on all mounted non-NFS filesystems: + +`sudo quotacheck --all` + +- Force check even if quotas are enabled (this can cause damage or loss to quota files): + +`sudo quotacheck --force {{mountpoint}}` + +- Check quotas on a given filesystem in debug mode: + +`sudo quotacheck --debug {{mountpoint}}` + +- Check quotas on a given filesystem, displaying the progress: + +`sudo quotacheck --verbose {{mountpoint}}` + +- Check user quotas: + +`sudo quotacheck --user {{user}} {{mountpoint}}` + +- Check group quotas: + +`sudo quotacheck --group {{group}} {{mountpoint}}` diff --git a/linux/radeontop b/linux/radeontop new file mode 100644 index 00000000..c4de0fdc --- /dev/null +++ b/linux/radeontop @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# radeontop + +> Show utilization of AMD GPUs. +> May require root privileges depending on your system. +> More information: . + +- Show the utilization of the default AMD GPU: + +`radeontop` + +- Enable colored output: + +`radeontop --color` + +- Select a specific GPU (the bus number is the first number in the output of `lspci`): + +`radeontop --bus {{bus_number}}` + +- Specify the display refresh rate (higher means more GPU overhead): + +`radeontop --ticks {{samples_per_second}}` diff --git a/linux/rankmirrors b/linux/rankmirrors new file mode 100644 index 00000000..7afee051 --- /dev/null +++ b/linux/rankmirrors @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rankmirrors + +> Rank a list of Pacman mirrors by connection and opening speed. +> Writes the new mirrorlist to `stdout`. +> More information: . + +- Rank a mirror list: + +`rankmirrors {{/etc/pacman.d/mirrorlist}}` + +- Output only a given number of the top ranking servers: + +`rankmirrors -n {{number}} {{/etc/pacman.d/mirrorlist}}` + +- Be verbose when generating the mirrorlist: + +`rankmirrors -v {{/etc/pacman.d/mirrorlist}}` + +- Test only a specific URL: + +`rankmirrors --url {{url}}` + +- Output only the response times instead of a full mirrorlist: + +`rankmirrors --times {{/etc/pacman.d/mirrorlist}}` diff --git a/linux/raspi-config b/linux/raspi-config new file mode 100644 index 00000000..ca99a841 --- /dev/null +++ b/linux/raspi-config @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# raspi-config + +> An `ncurses` terminal GUI to config a Raspberry Pi. +> More information: . + +- Start `raspi-config`: + +`sudo raspi-config` diff --git a/linux/raspinfo b/linux/raspinfo new file mode 100644 index 00000000..a1e318d6 --- /dev/null +++ b/linux/raspinfo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# raspinfo + +> Display Raspberry Pi system information. +> More information: . + +- Display system information: + +`raspinfo` diff --git a/linux/raw b/linux/raw new file mode 100644 index 00000000..d9c227bb --- /dev/null +++ b/linux/raw @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# raw + +> Bind a Unix raw character device. +> More information: . + +- Bind a raw character device to a block device: + +`raw /dev/raw/raw{{1}} {{/dev/block_device}}` + +- Query an existing binding instead of setting a new one: + +`raw /dev/raw/raw{{1}}` + +- Query all bound raw devices: + +`raw -qa` diff --git a/linux/rc-service b/linux/rc-service new file mode 100644 index 00000000..59db5c87 --- /dev/null +++ b/linux/rc-service @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rc-service + +> Locate and run OpenRC services with arguments. +> See also `openrc`. +> More information: . + +- Show a service's status: + +`rc-service {{service_name}} status` + +- Start a service: + +`sudo rc-service {{service_name}} start` + +- Stop a service: + +`sudo rc-service {{service_name}} stop` + +- Restart a service: + +`sudo rc-service {{service_name}} restart` + +- Simulate running a service's custom command: + +`sudo rc-service --dry-run {{service_name}} {{command_name}}` + +- Actually run a service's custom command: + +`sudo rc-service {{service_name}} {{command_name}}` + +- Resolve the location of a service definition on disk: + +`sudo rc-service --resolve {{service_name}}` diff --git a/linux/rc-status b/linux/rc-status new file mode 100644 index 00000000..e096ded6 --- /dev/null +++ b/linux/rc-status @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rc-status + +> Show status info about runlevels. +> See also `openrc`. +> More information: . + +- Show a summary of services and their status: + +`rc-status` + +- Include services in all runlevels in the summary: + +`rc-status --all` + +- List services that have crashed: + +`rc-status --crashed` + +- List manually started services: + +`rc-status --manual` + +- List supervised services: + +`rc-status --supervised` + +- Get the current runlevel: + +`rc-status --runlevel` + +- List all runlevels: + +`rc-status --list` diff --git a/linux/rc-update b/linux/rc-update new file mode 100644 index 00000000..e8df61c5 --- /dev/null +++ b/linux/rc-update @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rc-update + +> Add and remove OpenRC services to and from runlevels. +> See also `openrc`. +> More information: . + +- List all services and the runlevels they are added to: + +`rc-update show` + +- Add a service to a runlevel: + +`sudo rc-update add {{service_name}} {{runlevel}}` + +- Delete a service from a runlevel: + +`sudo rc-update delete {{service_name}} {{runlevel}}` + +- Delete a service from all runlevels: + +`sudo rc-update --all delete {{service_name}}` diff --git a/linux/rcp b/linux/rcp new file mode 100644 index 00000000..f56df08f --- /dev/null +++ b/linux/rcp @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rcp + +> Copy files between local and remote systems. +> It mimics the behavior of the `cp` command but operates across different machines. +> More information: . + +- Copy a file to a remote host: + +`rcp {{path/to/local_file}} {{username}}@{{remotehost}}:{{/path/to/destination/}}` + +- Copy a directory recursively: + +`rcp -r {{path/to/local_directory}} {{username}}@{{remotehost}}:{{/path/to/destination/}}` + +- Preserve the file attributes: + +`rcp -p {{path/to/local_file}} {{username}}@{{remotehost}}:{{/path/to/destination/}}` + +- Force copy without a confirmation: + +`rcp -f {{path/to/local_file}} {{username}}@{{remotehost}}:{{/path/to/destination/}}` diff --git a/linux/rdesktop b/linux/rdesktop new file mode 100644 index 00000000..fe3c2523 --- /dev/null +++ b/linux/rdesktop @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rdesktop + +> Remote Desktop Protocol client. +> It can be used to connect the remote computer using the RDP protocol. +> More information: . + +- Connect to a remote computer (default port is 3389): + +`rdesktop -u {{username}} -p {{password}} {{host:port}}` + +- Simple Examples: + +`rdesktop -u Administrator -p passwd123 192.168.1.111:3389` + +- Connect to a remote computer with full screen (press `Ctrl + Alt + Enter` to exist): + +`rdesktop -u {{username}} -p {{password}} -f {{host:port}}` + +- Use the customed resolution (use the letter 'x' between the number): + +`rdesktop -u {{username}} -p {{password}} -g 1366x768 {{host:port}}` + +- Connect to a remote computer using domain user: + +`rdesktop -u {{username}} -p {{password}} -d {{domainname}} {{host:port}}` + +- Use the 16-bit color (speed up): + +`rdesktop -u {{username}} -p {{password}} -a 16 {{host:port}}` diff --git a/linux/read b/linux/read new file mode 100644 index 00000000..8898e317 --- /dev/null +++ b/linux/read @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# read + +> Shell builtin for retrieving data from `stdin`. +> More information: . + +- Store data that you type from the keyboard: + +`read {{variable}}` + +- Store each of the next lines you enter as values of an array: + +`read -a {{array}}` + +- Specify the number of maximum characters to be read: + +`read -n {{character_count}} {{variable}}` + +- Use a specific character as a delimiter instead of a new line: + +`read -d {{new_delimiter}} {{variable}}` + +- Do not let backslash (\) act as an escape character: + +`read -r {{variable}}` + +- Display a prompt before the input: + +`read -p "{{Enter your input here: }}" {{variable}}` + +- Do not echo typed characters (silent mode): + +`read -s {{variable}}` + +- Read `stdin` and perform an action on every line: + +`while read line; do echo "$line"; done` diff --git a/linux/readelf b/linux/readelf new file mode 100644 index 00000000..cd4ed382 --- /dev/null +++ b/linux/readelf @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# readelf + +> Displays information about ELF files. +> More information: . + +- Display all information about the ELF file: + +`readelf -all {{path/to/binary}}` + +- Display all the headers present in the ELF file: + +`readelf --headers {{path/to/binary}}` + +- Display the entries in symbol table section of the ELF file, if it has one: + +`readelf --symbols {{path/to/binary}}` + +- Display the information contained in the ELF header at the start of the file: + +`readelf --file-header {{path/to/binary}}` diff --git a/linux/readpe b/linux/readpe new file mode 100644 index 00000000..e1799269 --- /dev/null +++ b/linux/readpe @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# readpe + +> Displays information about PE files. +> More information: . + +- Display all information about a PE file: + +`readpe {{path/to/executable}}` + +- Display all the headers present in a PE file: + +`readpe --all-headers {{path/to/executable}}` + +- Display all the sections present in a PE file: + +`readpe --all-sections {{path/to/executable}}` + +- Display a specific header from a PE file: + +`readpe --header {{dos|coff|optional}} {{path/to/executable}}` + +- List all imported functions: + +`readpe --imports {{path/to/executable}}` + +- List all exported functions: + +`readpe --exports {{path/to/executable}}` diff --git a/linux/reboot b/linux/reboot new file mode 100644 index 00000000..db1c5693 --- /dev/null +++ b/linux/reboot @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# reboot + +> Reboot the system. +> More information: . + +- Reboot the system: + +`reboot` + +- Power off the system (same as `poweroff`): + +`reboot --poweroff` + +- Halt (terminates all processes and shuts down the CPU) the system (same as `halt`): + +`reboot --halt` + +- Reboot immediately without contacting the system manager: + +`reboot --force` + +- Write the wtmp shutdown entry without rebooting the system: + +`reboot --wtmp-only` diff --git a/linux/reflector b/linux/reflector new file mode 100644 index 00000000..78836504 --- /dev/null +++ b/linux/reflector @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# reflector + +> Arch script to fetch and sort mirrorlists. +> More information: . + +- Get all mirrors, sort for download speed and save them: + +`sudo reflector --sort {{rate}} --save {{/etc/pacman.d/mirrorlist}}` + +- Only get German HTTPS mirrors: + +`reflector --country {{Germany}} --protocol {{https}}` + +- Only get the 10 recently sync'd mirrors: + +`reflector --latest {{10}}` diff --git a/linux/register_new_matrix_user b/linux/register_new_matrix_user new file mode 100644 index 00000000..49b201ad --- /dev/null +++ b/linux/register_new_matrix_user @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# register_new_matrix_user + +> Register new users in a home server when registration has been disabled. +> More information: . + +- Create a user interactively: + +`register_new_matrix_user --config {{path/to/homeserver.yaml}}` + +- Create an admin user interactively: + +`register_new_matrix_user --config {{path/to/homeserver.yaml}} --admin` + +- Create an admin user non-interactively (not recommended): + +`register_new_matrix_user --config {{path/to/homeserver.yaml}} --user {{username}} --password {{password}} --admin` diff --git a/linux/rename b/linux/rename new file mode 100644 index 00000000..66d201e6 --- /dev/null +++ b/linux/rename @@ -0,0 +1,36 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rename + +> Rename multiple files. +> Note: this page refers to the command from the `util-linux` package. +> For the Perl version, see `file-rename` or `perl-rename`. +> Warning: This command has no safeguards and will overwrite files without prompting. +> More information: . + +- Rename files using simple substitutions (substitute 'foo' with 'bar' wherever found): + +`rename {{foo}} {{bar}} {{*}}` + +- Dry-run - display which renames would occur without performing them: + +`rename -vn {{foo}} {{bar}} {{*}}` + +- Do not overwrite existing files: + +`rename -o {{foo}} {{bar}} {{*}}` + +- Change file extensions: + +`rename {{.ext}} {{.bak}} {{*.ext}}` + +- Prepend "foo" to all filenames in the current directory: + +`rename {{''}} {{'foo'}} {{*}}` + +- Rename a group of increasingly numbered files zero-padding the numbers up to 3 digits: + +`rename {{foo}} {{foo00}} {{foo?}} && rename {{foo}} {{foo0}} {{foo??}}` diff --git a/linux/renice b/linux/renice new file mode 100644 index 00000000..de63aa0a --- /dev/null +++ b/linux/renice @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# renice + +> Alter the scheduling priority/niceness of running processes. +> Niceness values range from -20 (most favorable to the process) to 19 (least favorable to the process). +> See also: `nice`. +> More information: . + +- Set the absolute priority of a running [p]rocess: + +`renice {{+3}} -p {{pid}}` + +- Increase/decrease the priority of all processes owned by a [u]ser: + +`renice --relative {{-4}} -u {{uid|user}}` + +- Set the priority of all processes that belong to a process [g]roup: + +`renice --absolute {{5}} -g {{process_group}}` diff --git a/linux/repo-add b/linux/repo-add new file mode 100644 index 00000000..b90ef1f4 --- /dev/null +++ b/linux/repo-add @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# repo-add + +> Package database maintenance utility which enables installation of said package via Pacman. +> More information: . + +- Add all package binaries in the current directory and remove the old database file: + +`repo-add --remove {{path/to/database.db.tar.gz}} {{*.pkg.tar.zst}}` + +- Add all package binaries in the current directory in silent mode except for warning and error messages: + +`repo-add --quiet {{path/to/database.db.tar.gz}} {{*.pkg.tar.zst}}` + +- Add all package binaries in the current directory without showing color: + +`repo-add --nocolor {{path/to/database.db.tar.gz}} {{*.pkg.tar.zst}}` diff --git a/linux/reportbug b/linux/reportbug new file mode 100644 index 00000000..e6f0a6f0 --- /dev/null +++ b/linux/reportbug @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# reportbug + +> Bug report tool of Debian distribution. +> More information: . + +- Generate a bug report about a specific package, then send it by e-mail: + +`reportbug {{package}}` + +- Report a bug that is not about a specific package (general problem, infrastructure, etc.): + +`reportbug other` + +- Write the bug report to a file instead of sending it by e-mail: + +`reportbug -o {{filename}} {{package}}` diff --git a/linux/repquota b/linux/repquota new file mode 100644 index 00000000..852e75bf --- /dev/null +++ b/linux/repquota @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# repquota + +> Display a summary of existing file quotas for a filesystem. +> More information: . + +- Report stats for all quotas in use: + +`sudo repquota -all` + +- Report quota stats for all users, even those who aren't using any of their quota: + +`sudo repquota -v {{filesystem}}` + +- Report on quotas for users only: + +`repquota --user {{filesystem}}` + +- Report on quotas for groups only: + +`sudo repquota --group {{filesystem}}` + +- Report on used quota and limits in a human-readable format: + +`sudo repquota --human-readable {{filesystem}}` + +- Report on all quotas for users and groups in a human-readable format: + +`sudo repquota -augs` diff --git a/linux/reptyr b/linux/reptyr new file mode 100644 index 00000000..31edf529 --- /dev/null +++ b/linux/reptyr @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# reptyr + +> Move a running process to a new terminal. +> Best used when you forget to start a long running task in `screen`. +> More information: . + +- Move a running process to your current terminal: + +`reptyr {{pid}}` diff --git a/linux/reset b/linux/reset new file mode 100644 index 00000000..55ad485e --- /dev/null +++ b/linux/reset @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# reset + +> Reinitializes the current terminal. Clears the entire terminal screen. +> More information: . + +- Reinitialize the current terminal: + +`reset` + +- Display the terminal type instead: + +`reset -q` diff --git a/linux/resize2fs b/linux/resize2fs new file mode 100644 index 00000000..4778da26 --- /dev/null +++ b/linux/resize2fs @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# resize2fs + +> Resize an ext2, ext3 or ext4 filesystem. +> Does not resize the underlying partition. The filesystem may have to be unmounted first, read the man page for more details. +> More information: . + +- Automatically resize a filesystem: + +`resize2fs {{/dev/sdXN}}` + +- Resize the filesystem to a size of 40G, displaying a progress bar: + +`resize2fs -p {{/dev/sdXN}} {{40G}}` + +- Shrink the filesystem to its minimum possible size: + +`resize2fs -M {{/dev/sdXN}}` diff --git a/linux/resolvectl b/linux/resolvectl new file mode 100644 index 00000000..f39dd89d --- /dev/null +++ b/linux/resolvectl @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# resolvectl + +> Resolve domain names, IPv4 and IPv6 addresses, DNS resource records, and services. +> Introspect and reconfigure the DNS resolver. +> More information: . + +- Show DNS settings: + +`resolvectl status` + +- Resolve the IPv4 and IPv6 addresses for one or more domains: + +`resolvectl query {{domain1 domain2 ...}}` + +- Retrieve the domain of a specified IP address: + +`resolvectl query {{ip_address}}` + +- Flush all local DNS caches: + +`resolvectl flush-caches` + +- Display DNS statistics (transactions, cache, and DNSSEC verdicts): + +`resolvectl statistics` + +- Retrieve an MX record of a domain: + +`resolvectl --legend={{no}} --type={{MX}} query {{domain}}` + +- Resolve an SRV record, for example _xmpp-server._tcp gmail.com: + +`resolvectl service _{{service}}._{{protocol}} {{name}}` + +- Retrieve a TLS key: + +`resolvectl tlsa tcp {{domain}}:443` diff --git a/linux/resolveip b/linux/resolveip new file mode 100644 index 00000000..b6c55e81 --- /dev/null +++ b/linux/resolveip @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# resolveip + +> Resolve hostnames to their IP addresses and vice versa. +> More information: . + +- Resolve a hostname to an IP address: + +`resolveip {{example.org}}` + +- Resolve an IP address to a hostname: + +`resolveip {{1.1.1.1}}` + +- Silent mode. Produces less output: + +`resolveip --silent {{example.org}}` diff --git a/linux/restorecon b/linux/restorecon new file mode 100644 index 00000000..7420895d --- /dev/null +++ b/linux/restorecon @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# restorecon + +> Restore SELinux security context on files/directories according to persistent rules. +> See also: `semanage-fcontext`. +> More information: . + +- View the current security context of a file or directory: + +`ls -dlZ {{path/to/file_or_directory}}` + +- Restore the security context of a file or directory: + +`restorecon {{path/to/file_or_directory}}` + +- Restore the security context of a directory recursively, and show all changed labels: + +`restorecon -R -v {{path/to/directory}}` + +- Restore the security context of a directory recursively, using all available threads, and show progress: + +`restorecon -R -T {{0}} -p {{path/to/directory}}` + +- Preview the label changes that would happen without applying them: + +`restorecon -R -n -v {{path/to/directory}}` diff --git a/linux/retroarch b/linux/retroarch new file mode 100644 index 00000000..4ffc4c43 --- /dev/null +++ b/linux/retroarch @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# retroarch + +> A frontend for emulators, game engines and media players. +> The reference implementation of the libretro API. +> More information: . + +- Start in the menu mode: + +`retroarch` + +- Start in full screen mode: + +`retroarch --fullscreen` + +- List all compiled features: + +`retroarch --features` + +- Set the path of a configuration file: + +`retroarch --config={{path/to/config_file}}` + +- Display help: + +`retroarch --help` + +- Display version: + +`retroarch --version` diff --git a/linux/rexec b/linux/rexec new file mode 100644 index 00000000..48d15104 --- /dev/null +++ b/linux/rexec @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rexec + +> 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: . + +- Execute a command on a remote [h]ost: + +`rexec -h={{remote_host}} {{ls -l}}` + +- Specify the remote [u]sername on a remote [h]ost: + +`rexec -username={{username}} -h={{remote_host}} {{ps aux}}` + +- Redirect `stdin` from `/dev/null` on a remote [h]ost: + +`rexec --no-err -h={{remote_host}} {{ls -l}}` + +- Specify the remote [P]ort on a remote [h]ost: + +`rexec -P={{1234}} -h={{remote_host}} {{ls -l}}` diff --git a/linux/rfkill b/linux/rfkill new file mode 100644 index 00000000..b0982d5d --- /dev/null +++ b/linux/rfkill @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rfkill + +> Enable and disable wireless devices. +> More information: . + +- List devices: + +`rfkill` + +- Filter by columns: + +`rfkill -o {{ID,TYPE,DEVICE}}` + +- Block devices by type (e.g. bluetooth, wlan): + +`rfkill block {{bluetooth}}` + +- Unblock devices by type (e.g. bluetooth, wlan): + +`rfkill unblock {{wlan}}` + +- Output in JSON format: + +`rfkill -J` diff --git a/linux/rig b/linux/rig new file mode 100644 index 00000000..ece63e1d --- /dev/null +++ b/linux/rig @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rig + +> Utility to piece together a random first name, last name, street number and address, along with a geographically consistent (ie, they all match the same area) city, state, ZIP code, and area code. +> More information: . + +- Display a random name (male or female) and address: + +`rig` + +- Display a [m]ale (or [f]emale) random name and address: + +`rig -{{m|f}}` + +- Use data files from a specific directory (default is `/usr/share/rig`): + +`rig -d {{path/to/directory}}` + +- Display a specific number of identities: + +`rig -c {{number}}` + +- Display a specific number of female identities: + +`rig -f -c {{number}}` diff --git a/linux/ripmime b/linux/ripmime new file mode 100644 index 00000000..1ffcaa76 --- /dev/null +++ b/linux/ripmime @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ripmime + +> Extract attachments out of a MIME encoded email package. +> More information: . + +- Extract file contents in the current directory: + +`ripmime -i {{path/to/file}}` + +- Extract file contents in a specific directory: + +`ripmime -i {{path/to/file}} -d {{path/to/directory}}` + +- Extract file contents and print verbose output: + +`ripmime -i {{path/to/file}} -v` + +- Get detailed information about the whole decoding process: + +`ripmime -i {{path/to/file}} --debug` diff --git a/linux/rkhunter b/linux/rkhunter new file mode 100644 index 00000000..1c9f9087 --- /dev/null +++ b/linux/rkhunter @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rkhunter + +> Searches for rootkits and malware. +> More information: . + +- Check a system for rootkits and malware: + +`sudo rkhunter --check` + +- Update rkhunter: + +`sudo rkhunter --update` + +- Print all available tests: + +`sudo rkhunter --list` + +- Display version: + +`sudo rkhunter --versioncheck` + +- Display help: + +`sudo rkhunter --help` diff --git a/linux/rlogin b/linux/rlogin new file mode 100644 index 00000000..b5f0fd51 --- /dev/null +++ b/linux/rlogin @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rlogin + +> Log in to a remote host. +> More information: . + +- Log in to a remote host: + +`rlogin {{remote_host}}` + +- Log in to a remote host with a specific username: + +`rlogin -l {{username}} {{remote_host}}` diff --git a/linux/rm b/linux/rm new file mode 100644 index 00000000..b2adea29 --- /dev/null +++ b/linux/rm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rm + +> Remove files or directories. +> See also: `rmdir`. +> More information: . + +- Remove specific files: + +`rm {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files ignoring nonexistent ones: + +`rm --force {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files interactively prompting before each removal: + +`rm --interactive {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files printing info about each removal: + +`rm --verbose {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files and directories recursively: + +`rm --recursive {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/linux/rmdir b/linux/rmdir new file mode 100644 index 00000000..18d40cf5 --- /dev/null +++ b/linux/rmdir @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rmdir + +> Remove directories without files. +> See also: `rm`. +> More information: . + +- Remove specific directories: + +`rmdir {{path/to/directory1 path/to/directory2 ...}}` + +- Remove specific nested directories recursively: + +`rmdir --parents {{path/to/directory1 path/to/directory2 ...}}` diff --git a/linux/rmmod b/linux/rmmod new file mode 100644 index 00000000..8ac67bc6 --- /dev/null +++ b/linux/rmmod @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rmmod + +> Remove modules from the Linux kernel. +> More information: . + +- Remove a module from the kernel: + +`sudo rmmod {{module_name}}` + +- Remove a module from the kernel and display verbose information: + +`sudo rmmod --verbose {{module_name}}` + +- Remove a module from the kernel and send errors to syslog instead of `stderr`: + +`sudo rmmod --syslog {{module_name}}` + +- Display help: + +`rmmod --help` + +- Display version: + +`rmmod --version` diff --git a/linux/rofi b/linux/rofi new file mode 100644 index 00000000..e3ba1a18 --- /dev/null +++ b/linux/rofi @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rofi + +> An application launcher and window switcher. +> More information: . + +- Show the list of apps: + +`rofi -show drun` + +- Show the list of all commands: + +`rofi -show run` + +- Switch between windows: + +`rofi -show window` + +- Pipe a list of items to `stdin` and print the selected item to `stdout`: + +`printf "{{Choice1 +Choice2 +Choice3}}" | rofi -dmenu` diff --git a/linux/rolldice b/linux/rolldice new file mode 100644 index 00000000..8b3bf60f --- /dev/null +++ b/linux/rolldice @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rolldice + +> Roll virtual dice. +> More information: . + +- Roll a single 20 sided dice: + +`rolldice d{{20}}` + +- Roll two six sided dice and drop the lowest roll: + +`rolldice {{2}}d{{6}}s{{1}}` + +- Roll two 20 sided dice and add a modifier value: + +`rolldice {{2}}d{{20}}{{+5}}` + +- Roll a 20 sided dice two times: + +`rolldice {{2}}xd{{20}}` diff --git a/linux/rpcclient b/linux/rpcclient new file mode 100644 index 00000000..fe669688 --- /dev/null +++ b/linux/rpcclient @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpcclient + +> MS-RPC client tool (part of the samba suite). +> More information: . + +- Connect to a remote host: + +`rpcclient --user {{domain}}\{{username}}%{{password}} {{ip}}` + +- Connect to a remote host on a domain without a password: + +`rpcclient --user {{username}} --workgroup {{domain}} --no-pass {{ip}}` + +- Connect to a remote host, passing the password hash: + +`rpcclient --user {{domain}}\{{username}} --pw-nt-hash {{ip}}` + +- Execute shell commands on a remote host: + +`rpcclient --user {{domain}}\{{username}}%{{password}} --command {{semicolon_separated_commands}} {{ip}}` + +- Display domain users: + +`rpcclient $> enumdomusers` + +- Display privileges: + +`rpcclient $> enumprivs` + +- Display information about a specific user: + +`rpcclient $> queryuser {{username|rid}}` + +- Create a new user in the domain: + +`rpcclient $> createdomuser {{username}}` diff --git a/linux/rpcinfo b/linux/rpcinfo new file mode 100644 index 00000000..024da7cd --- /dev/null +++ b/linux/rpcinfo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpcinfo + +> Makes an RPC call to an RPC server and reports what it finds. +> More information: . + +- Show full table of all RPC services registered on localhost: + +`rpcinfo` + +- Show concise table of all RPC services registered on localhost: + +`rpcinfo -s {{localhost}}` + +- Display table of statistics of rpcbind operations on localhost: + +`rpcinfo -m` + +- Display list of entries of given service name (mountd) and version number (2) on a remote nfs share: + +`rpcinfo -l {{remote_nfs_server_ip}} {{mountd}} {{2}}` + +- Delete the registration for version 1 of the mountd service for all transports: + +`rpcinfo -d {{mountd}} {{1}}` diff --git a/linux/rpi-eeprom-update b/linux/rpi-eeprom-update new file mode 100644 index 00000000..87b1a905 --- /dev/null +++ b/linux/rpi-eeprom-update @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpi-eeprom-update + +> Update EEPROM and view other EEPROM information. +> More information: . + +- Print information about the current raspberry pi EEPROM installed: + +`sudo rpi-eeprom-update` + +- Update a raspberry pi EEPROM: + +`sudo rpi-eeprom-update -a` + +- Cancel the pending update: + +`sudo rpi-eeprom-update -r` + +- Display help: + +`rpi-eeprom-update -h` diff --git a/linux/rpicam-hello b/linux/rpicam-hello new file mode 100644 index 00000000..7d4482af --- /dev/null +++ b/linux/rpicam-hello @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpicam-hello + +> View a live camera stream using a Raspberry Pi camera. +> More information: . + +- Display a camera preview stream for a specific amount of time (in milliseconds): + +`rpicam-hello -t {{time}}` + +- Tune the configuration for a particular camera sensor: + +`rpicam-hello --tuning-file {{/usr/share/libcamera/ipa/rpi/path/to/config.json}}` diff --git a/linux/rpicam-jpeg b/linux/rpicam-jpeg new file mode 100644 index 00000000..80e7432f --- /dev/null +++ b/linux/rpicam-jpeg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpicam-jpeg + +> Capture and store a JPEG image using a Raspberry Pi camera. +> More information: . + +- Capture an image and name the file: + +`rpicam-jpeg -o {{path/to/file.jpg}}` + +- Capture an image with set dimensions: + +`rpicam-jpeg -o {{path/to/file.jpg}} --width {{1920}} --height {{1080}}` + +- Capture an image with an exposure of 20 seconds and a gain of 150%: + +`rpicam-jpeg -o {{path/to/file.jpg}} --shutter 20000 --gain 1.5` diff --git a/linux/rpicam-raw b/linux/rpicam-raw new file mode 100644 index 00000000..01850a9a --- /dev/null +++ b/linux/rpicam-raw @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpicam-raw + +> Capture a raw video on a Raspberry Pi camera. +> More information: . + +- Capture a video for a specific amount of seconds: + +`rpicam-raw -t {{2000}}} -o {{path/to/file.raw}}` + +- Change video dimensions and framerate: + +`rpicam-raw -t {{5000}} --width {{4056}} --height {{3040}} -o {{path/to/file.raw}} --framerate {{8}}` diff --git a/linux/rpicam-still b/linux/rpicam-still new file mode 100644 index 00000000..b63a4a2f --- /dev/null +++ b/linux/rpicam-still @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpicam-still + +> Capture and store a photo using a Raspberry Pi camera with legacy features missing from `rpicam-jpeg`. +> More information: . + +- Capture a photo with different encoding: + +`rpicam-still -e {{bmp|png|rgb|yuv420}} -o {{path/to/file.{{bmp|png|rgb|yuv420}}}}` + +- Capture a raw image: + +`rpicam-still -r -o {{path/to/file.jpg}}` + +- Capture a 100 second exposure image: + +`rpicam-still -o {{path/to/file.jpg}} --shutter 100000` diff --git a/linux/rpicam-vid b/linux/rpicam-vid new file mode 100644 index 00000000..9a4c5c1b --- /dev/null +++ b/linux/rpicam-vid @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpicam-vid + +> Capture a video using a Raspberry Pi camera. +> Some subcommands such as `vlc` have their own usage documentation. +> More information: . + +- Capture a 10 second video: + +`rpicam-vid -t 10000 -o {{path/to/file.h264}}` + +- Play the video using `vlc`: + +`vlc {{path/to/file.h264}}` diff --git a/linux/rpm b/linux/rpm new file mode 100644 index 00000000..a6ca9b28 --- /dev/null +++ b/linux/rpm @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpm + +> RPM Package Manager. +> For equivalent commands in other package managers, see . +> More information: . + +- Show version of httpd package: + +`rpm --query {{httpd}}` + +- List versions of all matching packages: + +`rpm --query --all '{{mariadb*}}'` + +- Forcibly install a package regardless of currently installed versions: + +`rpm --upgrade {{path/to/package.rpm}} --force` + +- Identify owner of a file and show version of the package: + +`rpm --query --file {{/etc/postfix/main.cf}}` + +- List package-owned files: + +`rpm --query --list {{kernel}}` + +- Show scriptlets from an RPM file: + +`rpm --query --package --scripts {{package.rpm}}` + +- Show changed, missing and/or incorrectly installed files of matching packages: + +`rpm --verify --all '{{php-*}}'` + +- Display the changelog of a specific package: + +`rpm --query --changelog {{package}}` diff --git a/linux/rpm-ostree b/linux/rpm-ostree new file mode 100644 index 00000000..7e13ad2f --- /dev/null +++ b/linux/rpm-ostree @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpm-ostree + +> A hybrid image/package system. +> Manage ostree deployments, package layers, filesystem overlays, and boot configuration. +> More information: . + +- Show rpm-ostree deployments in the order they will appear in the bootloader: + +`rpm-ostree status` + +- Show packages which are outdated and can be updated: + +`rpm-ostree upgrade --preview` + +- Prepare a new ostree deployment with upgraded packages and reboot into it: + +`rpm-ostree upgrade --reboot` + +- Reboot into the previous ostree deployment: + +`rpm-ostree rollback --reboot` + +- Install a package into a new ostree deployment and reboot into it: + +`rpm-ostree install {{package}} --reboot` diff --git a/linux/rpm2cpio b/linux/rpm2cpio new file mode 100644 index 00000000..cb1a0fc0 --- /dev/null +++ b/linux/rpm2cpio @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpm2cpio + +> Convert an RPM package to a `cpio` archive. +> More information: . + +- Convert an RPM package to a `cpio` archive and save it as `file.cpio` in the current directory: + +`rpm2cpio {{path/to/file.rpm}}` diff --git a/linux/rpmbuild b/linux/rpmbuild new file mode 100644 index 00000000..38876088 --- /dev/null +++ b/linux/rpmbuild @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpmbuild + +> RPM Package Build tool. +> More information: . + +- Build binary and source packages: + +`rpmbuild -ba {{path/to/spec_file}}` + +- Build a binary package without source package: + +`rpmbuild -bb {{path/to/spec_file}}` + +- Specify additional variables when building a package: + +`rpmbuild -bb {{path/to/spec_file}} --define "{{variable1}} {{value1}}" --define "{{variable2}} {{value2}}"` diff --git a/linux/rpmconf b/linux/rpmconf new file mode 100644 index 00000000..c251df52 --- /dev/null +++ b/linux/rpmconf @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpmconf + +> Handle RPMNEW, RPMSAVE and RPMORIG files left over by package upgrades. +> See also: `rpm`. +> More information: . + +- List leftover files and interactively choose what to do with each of them: + +`sudo rpmconf --all` + +- Delete orphaned RPMNEW and RPMSAVE files: + +`sudo rpmconf --all --clean` diff --git a/linux/rpmspec b/linux/rpmspec new file mode 100644 index 00000000..f8e30719 --- /dev/null +++ b/linux/rpmspec @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rpmspec + +> Query a RPM spec file. +> More information: . + +- List binary packages which would be generated from a RPM spec file: + +`rpmspec --query {{path/to/rpm.spec}}` + +- List all options for `--queryformat`: + +`rpmspec --querytags` + +- Get summary information for single binary packages generated from a RPM spec file: + +`rpmspec --query --queryformat "{{%{name}: %{summary} +}}" {{path/to/rpm.spec}}` + +- Get the source package which would be generated from a RPM spec file: + +`rpmspec --query --srpm {{path/to/rpm.spec}}` + +- Parse a RPM spec file to `stdout`: + +`rpmspec --parse {{path/to/rpm.spec}}` diff --git a/linux/rsh b/linux/rsh new file mode 100644 index 00000000..a94dedd6 --- /dev/null +++ b/linux/rsh @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rsh + +> Execute commands on a remote host. +> More information: . + +- Execute a command on a remote host: + +`rsh {{remote_host}} {{ls -l}}` + +- Execute a command on a remote host with a specific username: + +`rsh {{remote_host}} -l {{username}} {{ls -l}}` + +- Redirect `stdin` to `/dev/null` when executing a command on a remote host: + +`rsh {{remote_host}} --no-err {{ls -l}}` diff --git a/linux/rspamc b/linux/rspamc new file mode 100644 index 00000000..680abd53 --- /dev/null +++ b/linux/rspamc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rspamc + +> Command-line client for rspamd servers. +> More information: . + +- Train the bayesian filter to recognise an email as spam: + +`rspamc learn_spam {{path/to/email_file}}` + +- Train the bayesian filter to recognise an email as ham: + +`rspamc learn_ham {{path/to/email_file}}` + +- Generate a manual report on an email: + +`rspamc symbols {{path/to/email_file}}` + +- Show server statistics: + +`rspamc stat` diff --git a/linux/rtcwake b/linux/rtcwake new file mode 100644 index 00000000..421e00cf --- /dev/null +++ b/linux/rtcwake @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rtcwake + +> Enter a system sleep state until specified wakeup time relative to your BIOS clock. +> More information: . + +- Show whether an alarm is set or not: + +`sudo rtcwake -m show -v` + +- Suspend to RAM and wakeup after 10 seconds: + +`sudo rtcwake -m mem -s {{10}}` + +- Suspend to disk (higher power saving) and wakeup 15 minutes later: + +`sudo rtcwake -m disk --date +{{15}}min` + +- Freeze the system (more efficient than suspend-to-RAM but version 3.9 or newer of the Linux kernel is required) and wakeup at a given date and time: + +`sudo rtcwake -m freeze --date {{YYYYMMDDhhmm}}` + +- Disable a previously set alarm: + +`sudo rtcwake -m disable` + +- Perform a dry run to wakeup the computer at a given time. (Press Ctrl + C to abort): + +`sudo rtcwake -m on --date {{hh:ss}}` diff --git a/linux/rtorrent b/linux/rtorrent new file mode 100644 index 00000000..c72b9f10 --- /dev/null +++ b/linux/rtorrent @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rtorrent + +> Download torrents. +> More information: . + +- Add a torrent file or magnet to be downloaded: + +`rtorrent {{torrent_or_magnet}}` + +- Start the download: + +`S` + +- View details about downloading torrent: + +`->` + +- Close rtorrent safely: + +`Q` diff --git a/linux/ruget b/linux/ruget new file mode 100644 index 00000000..23a652f8 --- /dev/null +++ b/linux/ruget @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ruget + +> Alternative to wget written in Rust. +> More information: . + +- Download the contents of a URL to a file: + +`ruget {{https://example.com/file}}` + +- Download the contents of a URL to a specified [o]utput file: + +`ruget --output {{file_name}} {{https://example.com/file}}` diff --git a/linux/run-mailcap b/linux/run-mailcap new file mode 100644 index 00000000..79ac7275 --- /dev/null +++ b/linux/run-mailcap @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# run-mailcap + +> Run MailCap Programs. +> Run mailcap view, see, edit, compose, print - execute programs via entries in the mailcap file (or any of its aliases) will use the given action to process each mime-type/file. +> More information: . + +- Individual actions/programs on run-mailcap can be invoked with action flag: + +`run-mailcap --action=ACTION [--option[=value]]` + +- In simple language: + +`run-mailcap --action=ACTION {{filename}}` + +- Turn on extra information: + +`run-mailcap --action=ACTION --debug {{filename}}` + +- Ignore any "copiousoutput" directive and forward output to `stdout`: + +`run-mailcap --action=ACTION --nopager {{filename}}` + +- Display the found command without actually executing it: + +`run-mailcap --action=ACTION --norun {{filename}}` diff --git a/linux/runcon b/linux/runcon new file mode 100644 index 00000000..613fbd93 --- /dev/null +++ b/linux/runcon @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# runcon + +> Run a program in a different SELinux security context. +> With neither context nor command, print the current security context. +> More information: . + +- Determine the current domain: + +`runcon` + +- Specify the domain to run a command in: + +`runcon -t {{domain}}_t {{command}}` + +- Specify the context role to run a command with: + +`runcon -r {{role}}_r {{command}}` + +- Specify the full context to run a command with: + +`runcon {{user}}_u:{{role}}_r:{{domain}}_t {{command}}` diff --git a/linux/runlim b/linux/runlim new file mode 100644 index 00000000..0bba5166 --- /dev/null +++ b/linux/runlim @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# runlim + +> Sample and limit time and memory usage of a program and its child processes using the proc file system on Linux. +> More information: . + +- Print the time and memory usage of a command: + +`runlim {{command}} {{command_arguments}}` + +- Log statistics to a file instead of `stdout`: + +`runlim --output-file={{path/to/file}} {{command}} {{command_arguments}}` + +- Limit time to an upper bound (in seconds): + +`runlim --time-limit={{number}} {{command}} {{command_arguments}}` + +- Limit real-time to an upper bound (in seconds): + +`runlim --real-time-limit={{number}} {{command}} {{command_arguments}}` + +- Limit space to an upper bound (in MB): + +`runlim --space-limit={{number}} {{command}} {{command_arguments}}` diff --git a/linux/runuser b/linux/runuser new file mode 100644 index 00000000..84d5f5b0 --- /dev/null +++ b/linux/runuser @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# runuser + +> Run commands as a user and group without asking for password (needs root privileges). +> More information: . + +- Run command as a different user: + +`runuser {{user}} -c '{{command}}'` + +- Run command as a different user and group: + +`runuser {{user}} -g {{group}} -c '{{command}}'` + +- Start a login shell as a specific user: + +`runuser {{user}} -l` + +- Specify a shell for running instead of the default shell (also works for login): + +`runuser {{user}} -s {{/bin/sh}}` + +- Preserve the entire environment of root (only if `--login` is not specified): + +`runuser {{user}} --preserve-environment -c '{{command}}'` diff --git a/linux/rusnapshot b/linux/rusnapshot new file mode 100644 index 00000000..c03b5b4e --- /dev/null +++ b/linux/rusnapshot @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# rusnapshot + +> BTRFS snapshotting utility written in Rust. +> More information: . + +- Create a snapshot using a configuration file: + +`sudo rusnapshot --config {{path/to/config.toml}} --cr` + +- List created snapshots: + +`sudo rusnapshot -c {{path/to/config.toml}} --list` + +- Delete a snapshot by ID or the name of the snapshot: + +`sudo rusnapshot -c {{path/to/config.toml}} --del --id {{snapshot_id}}` + +- Delete all `hourly` snapshots: + +`sudo rusnapshot -c {{path/to/config.toml}} --list --keep {{0}} --clean --kind {{hourly}}` + +- Create a read-write snapshot: + +`sudo rusnapshot -c {{path/to/config.toml}} --cr --rw` + +- Restore a snapshot: + +`sudo rusnapshot -c {{path/to/config.toml}} --id {{snapshot_id}} --restore` diff --git a/linux/sa b/linux/sa new file mode 100644 index 00000000..b2a3df4c --- /dev/null +++ b/linux/sa @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sa + +> Summarizes accounting information. Part of the acct package. +> Shows commands called by users, including basic info on CPU time spent processing and I/O rates. +> More information: . + +- Display executable invocations per user (username not displayed): + +`sudo sa` + +- Display executable invocations per user, showing responsible usernames: + +`sudo sa --print-users` + +- List resources used recently per user: + +`sudo sa --user-summary` diff --git a/linux/sacct b/linux/sacct new file mode 100644 index 00000000..19eef79a --- /dev/null +++ b/linux/sacct @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sacct + +> Display accounting data from the Slurm service. +> More information: . + +- Display job id, job name, partition, account, number of allocated cpus, job state, and job exit codes for recent jobs: + +`sacct` + +- Display job id, job state, job exit code for recent jobs: + +`sacct --brief` + +- Display the allocations of a job: + +`sacct --jobs {{job_id}} --allocations` + +- Display elapsed time, job name, number of requested CPUs, and memory requested of a job: + +`sacct --jobs {{job_id}} --format=Elapsed,JobName,ReqCPUS,ReqMem` + +- Display recent jobs that occurred from one week ago up to the present day: + +`sacct --starttime=$(date -d "1 week ago" +'%F')` + +- Output a larger number of characters for an attribute: + +`sacct --format=JobID,JobName%100` diff --git a/linux/sacctmgr b/linux/sacctmgr new file mode 100644 index 00000000..ff13e30e --- /dev/null +++ b/linux/sacctmgr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sacctmgr + +> View, setup, and manage Slurm accounts. +> More information: . + +- Show current configuration: + +`sacctmgr show configuration` + +- Add a cluster to the slurm database: + +`sacctmgr add cluster {{cluster_name}}` + +- Add an account to the slurm database: + +`sacctmgr add account {{account_name}} cluster={{cluster_of_account}}` + +- Show details of user/association/cluster/account using a specific format: + +`sacctmgr show {{user|association|cluster|account}} format="Account%10" format="GrpTRES%30"` diff --git a/linux/salloc b/linux/salloc new file mode 100644 index 00000000..ed4dd537 --- /dev/null +++ b/linux/salloc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# salloc + +> Start an interactive shell session or execute a command by allocating one or more nodes in a cluster. +> More information: . + +- Start an interactive shell session on a node in the cluster: + +`salloc` + +- Execute the specified command synchronously on a node in the cluster: + +`salloc {{ls -a}}` + +- Only allocate nodes fulfilling the specified constraints: + +`salloc --constraint={{(amd|intel)&gpu}}` diff --git a/linux/sam b/linux/sam new file mode 100644 index 00000000..15a5a1f3 --- /dev/null +++ b/linux/sam @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sam + +> AWS Serverless Application Model (SAM) CLI. +> More information: . + +- Initialize a serverless application: + +`sam init` + +- Initialize a serverless application with a specific runtime: + +`sam init --runtime {{python3.7}}` + +- Package a SAM application: + +`sam package` + +- Build your Lambda function code: + +`sam build` + +- Run your serverless application locally: + +`sam local start-api` + +- Deploy an AWS SAM application: + +`sam deploy` diff --git a/linux/sar b/linux/sar new file mode 100644 index 00000000..33b4add4 --- /dev/null +++ b/linux/sar @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sar + +> Monitor performance of various Linux subsystems. +> More information: . + +- Report I/O and transfer rate issued to physical devices, one per second (press CTRL+C to quit): + +`sar -b {{1}}` + +- Report a total of 10 network device statistics, one per 2 seconds: + +`sar -n DEV {{2}} {{10}}` + +- Report CPU utilization, one per 2 seconds: + +`sar -u ALL {{2}}` + +- Report a total of 20 memory utilization statistics, one per second: + +`sar -r ALL {{1}} {{20}}` + +- Report the run queue length and load averages, one per second: + +`sar -q {{1}}` + +- Report paging statistics, one per 5 seconds: + +`sar -B {{5}}` diff --git a/linux/sattach b/linux/sattach new file mode 100644 index 00000000..39c960cc --- /dev/null +++ b/linux/sattach @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sattach + +> Attach to a Slurm job step. +> More information: . + +- Redirect the IO streams (`stdout`, `stderr`, and `stdin`) of a Slurm job step to the current terminal: + +`sattach {{jobid}}.{{stepid}}` + +- Use the current console's input as `stdin` to the specified task: + +`sattach --input-filter {{task_number}}` + +- Only redirect `stdin`/`stderr` of the specified task: + +`sattach --{{output|error}}-filter {{task_number}}` diff --git a/linux/sbatch b/linux/sbatch new file mode 100644 index 00000000..1ba014a8 --- /dev/null +++ b/linux/sbatch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sbatch + +> Submit a batch job to the SLURM scheduler. +> More information: . + +- Submit a batch job: + +`sbatch {{path/to/job.sh}}` + +- Submit a batch job with a custom name: + +`sbatch --job-name={{myjob}} {{path/to/job.sh}}` + +- Submit a batch job with a time limit of 30 minutes: + +`sbatch --time={{00:30:00}} {{path/to/job.sh}}` + +- Submit a job and request multiple nodes: + +`sbatch --nodes={{3}} {{path/to/job.sh}}` diff --git a/linux/sbcast b/linux/sbcast new file mode 100644 index 00000000..6195a186 --- /dev/null +++ b/linux/sbcast @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sbcast + +> Send a file to a job's allocated nodes. +> This command should only be used from within a Slurm batch job. +> More information: . + +- Send a file to all nodes allocated to the current job: + +`sbcast {{path/to/file}} {{path/to/destination}}` + +- Autodetect shared libraries the transmitted file depends upon and transmit them as well: + +`sbcast --send-libs={{yes}} {{path/to/executable}} {{path/to/destination}}` diff --git a/linux/scancel b/linux/scancel new file mode 100644 index 00000000..b80f462f --- /dev/null +++ b/linux/scancel @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scancel + +> Cancel a Slurm job. +> More information: . + +- Cancel a job using its ID: + +`scancel {{job_id}}` + +- Cancel all jobs from a user: + +`scancel {{user_name}}` diff --git a/linux/scanimage b/linux/scanimage new file mode 100644 index 00000000..2ca999b8 --- /dev/null +++ b/linux/scanimage @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scanimage + +> Scan images with the Scanner Access Now Easy API. +> More information: . + +- List available scanners to ensure the target device is connected and recognized: + +`scanimage -L` + +- Scan an image and save it to a file: + +`scanimage --format={{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` diff --git a/linux/schroot b/linux/schroot new file mode 100644 index 00000000..0bbba094 --- /dev/null +++ b/linux/schroot @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# schroot + +> Run a command or start an interactive shell with a different root directory. More customizable than `chroot`. +> More information: . + +- List available chroots: + +`schroot --list` + +- Run a command in a specific chroot: + +`schroot --chroot {{chroot}} {{command}}` + +- Run a command with options in a specific chroot: + +`schroot --chroot {{chroot}} {{command}} -- {{command_options}}` + +- Run a command in all available chroots: + +`schroot --all {{command}}` + +- Start an interactive shell within a specific chroot as a specific user: + +`schroot --chroot {{chroot}} --user {{user}}` + +- Begin a new session (a unique session ID is returned on `stdout`): + +`schroot --begin-session --chroot {{chroot}}` + +- Connect to an existing session: + +`schroot --run-session --chroot {{session_id}}` + +- End an existing session: + +`schroot --end-session --chroot {{session_id}}` diff --git a/linux/scontrol b/linux/scontrol new file mode 100644 index 00000000..18a3a443 --- /dev/null +++ b/linux/scontrol @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scontrol + +> View information about and modify jobs. +> More information: . + +- Show information for job: + +`scontrol show job {{job_id}}` + +- Suspend a comma-separated list of running jobs: + +`scontrol suspend {{job_id1,job_id2,...}}` + +- Resume a comma-separated list of suspended jobs: + +`scontrol resume {{job_id1,job_id2,...}}` + +- Hold a comma-separated list of queued jobs (Use `release` command to permit the jobs to be scheduled): + +`scontrol hold {{job_id1,job_id2,...}}` + +- Release a comma-separated list of suspended job: + +`scontrol release {{job_id1,job_id2,...}}` diff --git a/linux/screenkey b/linux/screenkey new file mode 100644 index 00000000..a3e90f8d --- /dev/null +++ b/linux/screenkey @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# screenkey + +> A screencast tool to display keys pressed. +> More information: . + +- Display keys which are currently being pressed on the screen: + +`screenkey` + +- Display keys and mouse buttons which are currently being pressed on the screen: + +`screenkey --mouse` + +- Launch the settings menu of screenkey: + +`screenkey --show-settings` + +- Launch screenkey at a specific position: + +`screenkey --position {{top|center|bottom|fixed}}` + +- Change the format of the key modifiers displayed on screen: + +`screenkey --mods-mode {{normal|emacs|mac|win|tux}}` + +- Change the appearance of screenkey: + +`screenkey --bg-color "{{#a1b2c3}}" --font {{Hack}} --font-color {{yellow}} --opacity {{0.8}}` + +- Drag and select a window on screen to display screenkey: + +`screenkey --position fixed --geometry {{$(slop -n -f '%g')}}` diff --git a/linux/script b/linux/script new file mode 100644 index 00000000..91b41ab3 --- /dev/null +++ b/linux/script @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# script + +> Record all terminal output to file. +> More information: . + +- Record a new session to a file named `typescript` in the current directory: + +`script` + +- Record a new session to a custom filepath: + +`script {{path/to/session.out}}` + +- Record a new session, appending to an existing file: + +`script -a {{path/to/session.out}}` + +- Record timing information (data is outputted to `stderr`): + +`script -t 2> {{path/to/timingfile}}` diff --git a/linux/scriptreplay b/linux/scriptreplay new file mode 100644 index 00000000..4dedc5e8 --- /dev/null +++ b/linux/scriptreplay @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scriptreplay + +> Replay a typescript created by the `script` command to `stdout`. +> More information: . + +- Replay a typescript at the speed it was recorded: + +`scriptreplay {{path/to/timing_file}} {{path/to/typescript}}` + +- Replay a typescript at double the original speed: + +`scriptreplay {{path/to/timingfile}} {{path/to/typescript}} 2` + +- Replay a typescript at half the original speed: + +`scriptreplay {{path/to/timingfile}} {{path/to/typescript}} 0.5` diff --git a/linux/scrontab b/linux/scrontab new file mode 100644 index 00000000..968c9a69 --- /dev/null +++ b/linux/scrontab @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scrontab + +> Manage Slurm crontab files. +> More information: . + +- Install a new crontab from the specified file: + +`scrontab {{path/to/file}}` + +- [e]dit the crontab of the current user: + +`scrontab -e` + +- [e]dit the crontab of the specified user: + +`scrontab --user={{user_id}} -e` + +- [r]emove the current crontab: + +`scrontab -r` + +- Print the crontab of the current user to `stdout`: + +`scrontab -l` diff --git a/linux/scrot b/linux/scrot new file mode 100644 index 00000000..ba959c5f --- /dev/null +++ b/linux/scrot @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# scrot + +> Screen capture utility. +> More information: . + +- Capture a screenshot and save it to the current directory with the current date as the filename: + +`scrot` + +- Capture a screenshot and save it as `capture.png`: + +`scrot {{capture.png}}` + +- Capture a screenshot interactively: + +`scrot --select` + +- Capture a screenshot interactively without exiting on keyboard input, press `ESC` to exit: + +`scrot --select --ignorekeyboard` + +- Capture a screenshot interactively delimiting the region with a colored line: + +`scrot --select --line color={{x11_color|rgb_color}}` + +- Capture a screenshot from the currently focused window: + +`scrot --focused` + +- Display a countdown of 10 seconds before taking a screenshot: + +`scrot --count --delay {{10}}` diff --git a/linux/sdiag b/linux/sdiag new file mode 100644 index 00000000..5be72f98 --- /dev/null +++ b/linux/sdiag @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sdiag + +> Show information about the execution of `slurmctld`. +> More information: . + +- Show all performance counters related to the execution of `slurmctld`: + +`sdiag --all` + +- Reset performance counters related to the execution of `slurmctld`: + +`sdiag --reset` + +- Specify the output format: + +`sdiag --all --{{json|yaml}}` + +- Specify the cluster to send commands to: + +`sdiag --all --cluster={{cluster_name}}` diff --git a/linux/sed b/linux/sed new file mode 100644 index 00000000..909ec216 --- /dev/null +++ b/linux/sed @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Replace all `apple` (extended regex) occurrences with `APPLE` (extended regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed -E 's/(apple)/\U\1/g'` + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in a specific file and overwrite the original file in place: + +`sed -i 's/apple/mango/g' {{path/to/file}}` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script.sed}}` + +- Print just the first line to `stdout`: + +`{{command}} | sed -n '1p'` + +- [d]elete the first line of a file: + +`sed -i 1d {{path/to/file}}` + +- [i]nsert a new line at the first line of a file: + +`sed -i '1i\your new line text\' {{path/to/file}}` diff --git a/linux/see b/linux/see new file mode 100644 index 00000000..fdc33c81 --- /dev/null +++ b/linux/see @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# see + +> Alias to `run-mailcap`'s view. +> An alias to a `run-mailcap`'s action print. +> More information: . + +- See action can be used to view any file (usually image) on default mailcap explorer: + +`see {{filename}}` + +- Using with `run-mailcap`: + +`run-mailcap --action=view {{filename}}` diff --git a/linux/select b/linux/select new file mode 100644 index 00000000..c0b10cfc --- /dev/null +++ b/linux/select @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# select + +> Bash builtin construct for creating menus. +> More information: . + +- Create a menu out of individual words: + +`select {{word}} in {{apple}} {{orange}} {{pear}} {{banana}}; do echo ${{word}}; done` + +- Create a menu for picking a file or folder from the current directory: + +`select {{file}} in *; do echo ${{file}}; done` + +- Create a menu from a Bash array: + +`{{fruits}}=({{apple}} {{orange}} {{pear}} {{banana}}); select {{word}} in ${{{fruits}}[@]}; do echo ${{word}}; done` diff --git a/linux/semanage b/linux/semanage new file mode 100644 index 00000000..4df572de --- /dev/null +++ b/linux/semanage @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# semanage + +> SELinux Policy Management tool. +> More information: . + +- Output local customizations: + +`semanage -S {{store}} -o {{path/to/output_file}}` + +- Take a set of commands from a specified file and load them in a single transaction: + +`semanage -S {{store}} -i {{path/to/input_file}}` + +- Manage booleans. Booleans allow the administrator to modify the confinement of processes based on the current configuration: + +`semanage boolean -S {{store}} {{--delete|--modify|--list|--noheading|--deleteall}} {{-on|-off}} -F {{boolean|boolean_file}}` + +- Manage policy modules: + +`semanage module -S {{store}} {{--add|--delete|--list|--modify}} {{--enable|--disable}} {{module_name}}` + +- Disable/Enable dontaudit rules in policy: + +`semanage dontaudit -S {{store}} {{on|off}}` diff --git a/linux/semanage-fcontext b/linux/semanage-fcontext new file mode 100644 index 00000000..dbab8db1 --- /dev/null +++ b/linux/semanage-fcontext @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# semanage fcontext + +> Manage persistent SELinux security context rules on files/directories. +> See also: `semanage`, `restorecon`. +> More information: . + +- List all file labelling rules: + +`sudo semanage fcontext --list` + +- List all user-defined file labelling rules without headings: + +`sudo semanage fcontext --list --locallist --noheading` + +- Add a user-defined rule that labels any path which matches a PCRE regex: + +`sudo semanage fcontext --add --type {{samba_share_t}} {{'/mnt/share(/.*)?'}}` + +- Delete a user-defined rule using its PCRE regex: + +`sudo semanage fcontext --delete {{'/mnt/share(/.*)?'}}` + +- Relabel a directory recursively by applying the new rules: + +`restorecon -R -v {{path/to/directory}}` diff --git a/linux/sensible-browser b/linux/sensible-browser new file mode 100644 index 00000000..2725fbb9 --- /dev/null +++ b/linux/sensible-browser @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sensible-browser + +> Open the default browser. +> More information: . + +- Open a new window of the default browser: + +`sensible-browser` + +- Open a URL in the default browser: + +`sensible-browser {{url}}` diff --git a/linux/sensible-editor b/linux/sensible-editor new file mode 100644 index 00000000..8011bcf2 --- /dev/null +++ b/linux/sensible-editor @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sensible-editor + +> Open the default editor. +> More information: . + +- Open a file in the default editor: + +`sensible-editor {{path/to/file}}` + +- Open a file in the default editor, with the cursor at the end of the file: + +`sensible-editor + {{path/to/file}}` + +- Open a file in the default editor, with the cursor at the beginning of line 10: + +`sensible-editor +10 {{path/to/file}}` + +- Open 3 files in vertically split editor windows at the same time: + +`sensible-editor -O3 {{path/to/file1 path/to/file2 path/to/file3}}` diff --git a/linux/sensors b/linux/sensors new file mode 100644 index 00000000..4fca123c --- /dev/null +++ b/linux/sensors @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sensors + +> Report sensors information. +> More information: . + +- Show the current readings of all sensor chips: + +`sensors` + +- Show temperatures in degrees Fahrenheit: + +`sensors --fahrenheit` diff --git a/linux/service b/linux/service new file mode 100644 index 00000000..d921d52f --- /dev/null +++ b/linux/service @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# service + +> Manage services by running init scripts. +> The full script path should be omitted (`/etc/init.d/` is assumed). +> More information: . + +- List the name and status of all services: + +`service --status-all` + +- Start/Stop/Restart/Reload service (start/stop should always be available): + +`service {{service_name}} {{start|stop|restart|reload}}` + +- Do a full restart (runs script twice with start and stop): + +`service {{service_name}} --full-restart` + +- Show the current status of a service: + +`service {{service_name}} status` diff --git a/linux/setcap b/linux/setcap new file mode 100644 index 00000000..837f3d8b --- /dev/null +++ b/linux/setcap @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setcap + +> Set capabilities of specified file. +> See also: `tldr getcap`. +> More information: . + +- Set capability `cap_net_raw` (to use RAW and PACKET sockets) for a given file: + +`setcap '{{cap_net_raw}}' {{path/to/file}}` + +- Set multiple capabilities on a file (`ep` behind the capability means "effective permitted"): + +`setcap '{{cap_dac_read_search,cap_sys_tty_config+ep}}' {{path/to/file}}` + +- Remove all capabilities from a file: + +`setcap -r {{path/to/file}}` + +- Verify that the specified capabilities are currently associated with the specified file: + +`setcap -v '{{cap_net_raw}}' {{path/to/file}}` + +- The optional `-n root_uid` argument can be used to set the file capability for use only in a user namespace with this root user ID owner: + +`setcap -n {{root_uid}} '{{cap_net_admin}}' {{path/to/file}}` diff --git a/linux/setfacl b/linux/setfacl new file mode 100644 index 00000000..8cf07aee --- /dev/null +++ b/linux/setfacl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setfacl + +> Set file access control lists (ACL). +> More information: . + +- [M]odify ACL of a file for user with read and write access: + +`setfacl --modify u:{{username}}:rw {{path/to/file_or_directory}}` + +- [M]odify [d]efault ACL of a file for all users: + +`setfacl --modify --default u::rw {{path/to/file_or_directory}}` + +- Remove ACL of a file for a user: + +`setfacl --remove u:{{username}} {{path/to/file_or_directory}}` + +- Remove all ACL entries of a file: + +`setfacl --remove-all {{path/to/file_or_directory}}` diff --git a/linux/setserial b/linux/setserial new file mode 100644 index 00000000..c9f48e77 --- /dev/null +++ b/linux/setserial @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setserial + +> Read and modify serial port information. +> More information: . + +- Print all information about a specific serial device: + +`setserial -a {{/dev/cuaN}}` + +- Print the configuration summary of a specific serial device (useful for printing during bootup process): + +`setserial -b {{device}}` + +- Set a specific configuration parameter to a device: + +`sudo setserial {{device}} {{parameter}}` + +- Print the configuration of a list of devices: + +`setserial -g {{device1 device2 ...}}` diff --git a/linux/setsid b/linux/setsid new file mode 100644 index 00000000..af9c9aef --- /dev/null +++ b/linux/setsid @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setsid + +> Run a program in a new session if the calling process is not a process group leader. +> The created session is by default not controlled by the current terminal. +> More information: . + +- Run a program in a new session: + +`setsid {{program}}` + +- Run a program in a new session discarding the resulting output and error: + +`setsid {{program}} > /dev/null 2>&1` + +- Run a program creating a new process: + +`setsid --fork {{program}}` + +- Return the exit code of a program as the exit code of setsid when the program exits: + +`setsid --wait {{program}}` + +- Run a program in a new session setting the current terminal as the controlling terminal: + +`setsid --ctty {{program}}` diff --git a/linux/setxkbmap b/linux/setxkbmap new file mode 100644 index 00000000..9848d655 --- /dev/null +++ b/linux/setxkbmap @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setxkbmap + +> Set the keyboard using the X Keyboard Extension. +> More information: . + +- Set the keyboard in French AZERTY: + +`setxkbmap {{fr}}` + +- Set multiple keyboard layouts, their variants and switching option: + +`setxkbmap -layout {{us,de}} -variant {{,qwerty}} -option {{'grp:alt_caps_toggle'}}` + +- Get help: + +`setxkbmap -help` + +- List all layouts: + +`localectl list-x11-keymap-layouts` + +- List variants for the layout: + +`localectl list-x11-keymap-variants {{de}}` + +- List available switching options: + +`localectl list-x11-keymap-options | grep grp:` diff --git a/linux/sfill b/linux/sfill new file mode 100644 index 00000000..a9c97dbd --- /dev/null +++ b/linux/sfill @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sfill + +> Securely overwrite the free space and inodes of the partition where the specified directory resides. +> More information: . + +- Overwrite free space and inodes of a disk with 38 writes (slow but secure): + +`sfill {{/path/to/mounted_disk_directory}}` + +- Overwrite free space and inodes of a disk with 6 writes (fast but less secure) and show status: + +`sfill -l -v {{/path/to/mounted_disk_directory}}` + +- Overwrite free space and inodes of a disk with 1 write (very fast but insecure) and show status: + +`sfill -ll -v {{/path/to/mounted_disk_directory}}` + +- Overwrite only free space of a disk: + +`sfill -I {{/path/to/mounted_disk_directory}}` + +- Overwrite only free inodes of a disk: + +`sfill -i {{/path/to/mounted_disk_directory}}` diff --git a/linux/sh5util b/linux/sh5util new file mode 100644 index 00000000..32e2790d --- /dev/null +++ b/linux/sh5util @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sh5util + +> Merge HDF5 files produced by the `sacct_gather_profile` plugin. +> More information: . + +- Merge HDF5 files produced on each allocated node for the specified job or step: + +`sh5util --jobs={{job_id|job_id.step_id}}` + +- Extract one or more data series from a merged job file: + +`sh5util --jobs={{job_id|job_id.step_id}} --extract -i {{path/to/file.h5}} --series={{Energy|Filesystem|Network|Task}}` + +- Extract one data item from all nodes in a merged job file: + +`sh5util --jobs={{job_id|job_id.step_id}} --item-extract --series={{Energy|Filesystem|Network|Task}} --data={{data_item}}` diff --git a/linux/shar b/linux/shar new file mode 100644 index 00000000..dffd76f8 --- /dev/null +++ b/linux/shar @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# shar + +> Create a shell archive. +> More information: . + +- Create a shell script that when executed extracts the given files from itself: + +`shar --vanilla-operation {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` + +- Compress the files in the archive: + +`shar --compactor {{xz}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` + +- Treat all files as binary (i.e. `uuencode` everything): + +`shar --uuencode {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` + +- Treat all files as text (i.e. `uuencode` nothing): + +`shar --text-files {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` + +- Include a name and cut mark in the header comment of the archive: + +`shar --archive-name "{{My files}}" --cut-mark {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` diff --git a/linux/sherlock b/linux/sherlock new file mode 100644 index 00000000..adda36e3 --- /dev/null +++ b/linux/sherlock @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sherlock + +> Find usernames across social networks. +> More information: . + +- Search for a specific username on social networks saving the results to a file: + +`sherlock {{username}} --output {{path/to/file}}` + +- Search for specific usernames on social networks saving the results into a directory: + +`sherlock {{username1 username2 ...}} --folderoutput {{path/to/directory}}` + +- Search for a specific username on social networks using the Tor network: + +`sherlock --tor {{username}}` + +- Make requests over Tor with a new Tor circuit after each request: + +`sherlock --unique-tor {{username}}` + +- Search for a specific username on social networks using a proxy: + +`sherlock {{username}} --proxy {{proxy_url}}` + +- Search for a specific username on social networks and open results in the default web browser: + +`sherlock {{username}} --browse` + +- Display help: + +`sherlock --help` diff --git a/linux/shiny-mirrors b/linux/shiny-mirrors new file mode 100644 index 00000000..91397eb1 --- /dev/null +++ b/linux/shiny-mirrors @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# shiny-mirrors + +> Generate a `pacman` mirror list for Manjaro Linux. +> Every run of shiny-mirrors requires you to synchronize your database and update your system using `sudo pacman -Syyu`. +> More information: . + +- Get the status of the current mirrors: + +`shiny-mirrors status` + +- Generate a mirror list using the default behavior: + +`sudo shiny-mirrors refresh` + +- Display the current configuration file: + +`shiny-mirrors config show` + +- Switch to a different branch interactively: + +`sudo shiny-mirrors config --branch` diff --git a/linux/shnsplit b/linux/shnsplit new file mode 100644 index 00000000..a9603706 --- /dev/null +++ b/linux/shnsplit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# shnsplit + +> Splits audio files according to a `.cue` file. +> More information: . + +- Split a `.wav` + `.cue` file into multiple files: + +`shnsplit -f {{path/to/file.cue}} {{path/to/file.wav}}` + +- Show supported formats: + +`shnsplit -a` + +- Split a `.flac` file into multiple files: + +`shnsplit -f {{path/to/file.cue}} -o flac {{path/to/file.flac}}` + +- Split a `.wav` file into files of the form "track-number - album - title": + +`shnsplit -f {{path/to/file.cue}} {{path/to/file.wav}} -t "%n - %a - %t` diff --git a/linux/shntool-split b/linux/shntool-split new file mode 100644 index 00000000..9bebd441 --- /dev/null +++ b/linux/shntool-split @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# shntool split + +> This command is an alias of `shnsplit`. + +- View documentation for the original command: + +`tldr shnsplit` diff --git a/linux/shutdown b/linux/shutdown new file mode 100644 index 00000000..9f01072d --- /dev/null +++ b/linux/shutdown @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# shutdown + +> Shutdown and reboot the system. +> More information: . + +- Power off ([h]alt) immediately: + +`shutdown -h now` + +- [r]eboot immediately: + +`shutdown -r now` + +- [r]eboot in 5 minutes: + +`shutdown -r +{{5}} &` + +- Shutdown at 1:00 pm (Uses 24[h] clock): + +`shutdown -h 13:00` + +- [c]ancel a pending shutdown/reboot operation: + +`shutdown -c` diff --git a/linux/sic b/linux/sic new file mode 100644 index 00000000..dd1309f3 --- /dev/null +++ b/linux/sic @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sic + +> Simple IRC client. +> Part of the suckless tools. +> More information: . + +- Connect to the default host (irc.ofct.net) with the nickname set in the `$USER` environment variable: + +`sic` + +- Connect to a given host, using a given nickname: + +`sic -h {{host}} -n {{nickname}}` + +- Connect to a given host, using a given nickname and password: + +`sic -h {{host}} -n {{nickname}} -k {{password}}` + +- Join a channel: + +`:j #{{channel}}` + +- Send a message to a channel or user: + +`:m #{{channel|user}}` + +- Set default channel or user: + +`:s #{{channel|user}}` diff --git a/linux/silentcast b/linux/silentcast new file mode 100644 index 00000000..d90aa5a4 --- /dev/null +++ b/linux/silentcast @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# silentcast + +> Silent screencast creator. Saves in `.mkv` and animated GIF formats. +> More information: . + +- Launch silentcast: + +`silentcast` + +- Launch silentcast on a specific display: + +`silentcast --display={{display}}` diff --git a/linux/sinfo b/linux/sinfo new file mode 100644 index 00000000..fd9c5303 --- /dev/null +++ b/linux/sinfo @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sinfo + +> View information about Slurm nodes and partitions. +> See also `squeue` and `sbatch`, which are also part of the Slurm workload manager. +> More information: . + +- Show a quick summary overview of the cluster: + +`sinfo --summarize` + +- View the detailed status of all partitions across the entire cluster: + +`sinfo` + +- View the detailed status of a specific partition: + +`sinfo --partition {{partition_name}}` + +- View information about idle nodes: + +`sinfo --states {{idle}}` + +- Summarise dead nodes: + +`sinfo --dead` + +- List dead nodes and the reasons why: + +`sinfo --list-reasons` diff --git a/linux/size b/linux/size new file mode 100644 index 00000000..9d9d9b78 --- /dev/null +++ b/linux/size @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# size + +> Displays the sizes of sections inside binary files. +> More information: . + +- Display the size of sections in a given object or executable file: + +`size {{path/to/file}}` + +- Display the size of sections in a given object or executable file in [o]ctal: + +`size {{-o|--radix=8}} {{path/to/file}}` + +- Display the size of sections in a given object or executable file in [d]ecimal: + +`size {{-d|--radix=10}} {{path/to/file}}` + +- Display the size of sections in a given object or executable file in he[x]adecimal: + +`size {{-x|--radix=16}} {{path/to/file}}` diff --git a/linux/slapt-get b/linux/slapt-get new file mode 100644 index 00000000..56c41995 --- /dev/null +++ b/linux/slapt-get @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slapt-get + +> An `apt` like system for Slackware package management. +> Package sources need to be configured in the slapt-getrc file. +> More information: . + +- Update the list of available packages and versions: + +`slapt-get --update` + +- Install a package, or update it to the latest available version: + +`slapt-get --install {{package}}` + +- Remove a package: + +`slapt-get --remove {{package}}` + +- Upgrade all installed packages to their latest available versions: + +`slapt-get --upgrade` + +- Locate packages by the package name, disk set, or version: + +`slapt-get --search {{query}}` + +- Show information about a package: + +`slapt-get --show {{package}}` diff --git a/linux/slapt-src b/linux/slapt-src new file mode 100644 index 00000000..7c2a20b5 --- /dev/null +++ b/linux/slapt-src @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slapt-src + +> A utility to automate building of slackbuilds. +> SlackBuild sources need to be configured in the slapt-srcrc file. +> More information: . + +- Update the list of available slackbuilds and versions: + +`slapt-src --update` + +- List all available slackbuilds: + +`slapt-src --list` + +- Fetch, build and install the specified slackbuild(s): + +`slapt-src --install {{slackbuild_name}}` + +- Locate slackbuilds by their name or description: + +`slapt-src --search {{search_term}}` + +- Display information about a slackbuild: + +`slapt-src --show {{slackbuild_name}}` diff --git a/linux/sleep b/linux/sleep new file mode 100644 index 00000000..08d46c2f --- /dev/null +++ b/linux/sleep @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sleep + +> Delay for a specified amount of time. +> More information: . + +- Delay in seconds: + +`sleep {{seconds}}` + +- Delay in [m]inutes. (Other units [d]ay, [h]our, [s]econd, [inf]inity can also be used): + +`sleep {{minutes}}m` + +- Delay for 1 [d]ay 3 [h]ours: + +`sleep 1d 3h` + +- Execute a specific command after 20 [m]inutes delay: + +`sleep 20m && {{command}}` diff --git a/linux/slop b/linux/slop new file mode 100644 index 00000000..15ad5a34 --- /dev/null +++ b/linux/slop @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slop + +> Get a selection of the screen. +> More information: . + +- Wait for the user to make a selection and output its geometry to `stdout`: + +`slop` + +- Double click, rather than click and drag, to draw a selection: + +`slop -D` + +- Highlight the selection rather than outlining it: + +`slop -l` + +- Specify the output format: + +`slop -f {{format_string}}` + +- Specify the selection rectangle's color: + +`slop -c {{red}},{{green}},{{blue}},{{alpha}}` diff --git a/linux/slurmctld b/linux/slurmctld new file mode 100644 index 00000000..5611026d --- /dev/null +++ b/linux/slurmctld @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slurmctld + +> Monitor all other Slurm daemons and resources, accept work (jobs), and allocate resources to those jobs. +> More information: . + +- Clear all previous `slurmctld` states from its last checkpoint: + +`slurmctld -c` + +- Set the daemon's nice value to the specified value, typically a negative number: + +`slurmctld -n {{value}}` + +- Write log messages to the specified file: + +`slurmctld -L {{path/to/output_file}}` + +- Display help: + +`slurmctld -h` + +- Display version: + +`slurmctld -V` diff --git a/linux/slurmd b/linux/slurmd new file mode 100644 index 00000000..4a12fc11 --- /dev/null +++ b/linux/slurmd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slurmd + +> Monitors all tasks running on the compute node, accepts tasks, launches tasks, and kills running tasks upon request. +> More information: . + +- Report node rebooted when daemon restarted (Used for testing purposes): + +`slurmd -b` + +- Run the daemon with the given nodename: + +`slurmd -N {{nodename}}` + +- Write log messages to the specified file: + +`slurmd -L {{path/to/output_file}}` + +- Read configuration from the specified file: + +`slurmd -f {{path/to/file}}` + +- Display help: + +`slurmd -h` diff --git a/linux/slurmdbd b/linux/slurmdbd new file mode 100644 index 00000000..49a25bf4 --- /dev/null +++ b/linux/slurmdbd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slurmdbd + +> Provides a secure enterprise-wide interface to a database for Slurm. +> More information: . + +- Set the daemon's nice value to the specified value, typically a negative number: + +`slurmdbd -n {{value}}` + +- Change the working directory of `slurmdbd` to the LogFile path or to `/var/tmp`: + +`slurmdbd -s` + +- Display help: + +`slurmdbd -h` + +- Display version: + +`slurmdbd -V` diff --git a/linux/slurmrestd b/linux/slurmrestd new file mode 100644 index 00000000..c7aa63e9 --- /dev/null +++ b/linux/slurmrestd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slurmrestd + +> Interface to Slurm via REST API. It can be used in two modes: *Inetd Mode* & *Listen Mode*. +> More information: . + +- Change the group ID (and drop supplemental groups) before processing client requests: + +`slurmrestd --g {{group_id}} {{[host]:port | unix:/path/to/socket}}` + +- Comma-delimited list of authentication plugins to load: + +`slurmrestd -a {{authentication_plugins}} {{[host]:port | unix:/path/to/socket}}` + +- Read Slurm configuration from the specified file: + +`slurmrestd -f {{path/to/file}}` + +- Change user ID before processing client request: + +`slurmrestd -u {{user_id}}` + +- Display help: + +`slurmrestd -h` + +- Display version: + +`slurmrestd -V` diff --git a/linux/slurmstepd b/linux/slurmstepd new file mode 100644 index 00000000..78fd19c4 --- /dev/null +++ b/linux/slurmstepd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# slurmstepd + +> Slurm daemon for managing and monitoring individual job steps within a multi-step job. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`slurmstepd` diff --git a/linux/sm b/linux/sm new file mode 100644 index 00000000..d76b43ba --- /dev/null +++ b/linux/sm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sm + +> Displays a short message fullscreen. +> More information: . + +- Display a message in full-screen: + +`sm "{{Hello World!}}"` + +- Display a message with inverted colors: + +`sm -i "{{Hello World!}}"` + +- Display a message with a custom foreground color: + +`sm -f {{blue}} "{{Hello World!}}"` + +- Display a message with a custom background color: + +`sm -b {{#008888}} "{{Hello World!}}"` + +- Display a message rotated 3 times (in steps of 90 degrees, counterclockwise): + +`sm -r {{3}} "{{Hello World!}}"` + +- Display a message using the output from another command: + +`{{echo "Hello World!"}} | sm -` diff --git a/linux/smbclient b/linux/smbclient new file mode 100644 index 00000000..b4d88bbf --- /dev/null +++ b/linux/smbclient @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smbclient + +> FTP-like client to access SMB/CIFS resources on servers. +> More information: . + +- Connect to a share (user will be prompted for password; `exit` to quit the session): + +`smbclient {{//server/share}}` + +- Connect with a different username: + +`smbclient {{//server/share}} --user {{username}}` + +- Connect with a different workgroup: + +`smbclient {{//server/share}} --workgroup {{domain}} --user {{username}}` + +- Connect with a username and password: + +`smbclient {{//server/share}} --user {{username%password}}` + +- Download a file from the server: + +`smbclient {{//server/share}} --directory {{path/to/directory}} --command "get {{file.txt}}"` + +- Upload a file to the server: + +`smbclient {{//server/share}} --directory {{path/to/directory}} --command "put {{file.txt}}"` + +- List the shares from a server anonymously: + +`smbclient --list={{server}} --no-pass` diff --git a/linux/smbget b/linux/smbget new file mode 100644 index 00000000..0a7a1424 --- /dev/null +++ b/linux/smbget @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smbget + +> `wget`-like utility for downloading files from SMB servers. +> More information: . + +- Download a file from a server: + +`smbget {{smb://server/share/file}}` + +- Download a share or directory recursively: + +`smbget --recursive {{smb://server/share}}` + +- Connect with a username and password: + +`smbget {{smb://server/share/file}} --user {{username%password}}` + +- Require encrypted transfers: + +`smbget {{smb://server/share/file}} --encrypt` diff --git a/linux/smbmap b/linux/smbmap new file mode 100644 index 00000000..52f4b56b --- /dev/null +++ b/linux/smbmap @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smbmap + +> SMB enumeration tool. +> More information: . + +- Display SMB shares and permissions on a host, prompting for user's password or NTLM hash: + +`smbmap -u {{username}} --prompt -H {{ip}}` + +- Display SMB shares and permissions on a host, specifying the domain and passing the password NTLM hash: + +`smbmap -u {{username}} --prompt -d {{domain}} -H {{ip}}` + +- Display SMB shares and list a single level of directories and files: + +`smbmap -u {{username}} --prompt -H {{ip}} -r` + +- Display SMB shares and recursively list a defined number of levels of directories and files: + +`smbmap -u {{username}} --prompt -H {{ip}} -R --depth {{3}}` + +- Display SMB shares and recursively list directories and files, downloading the files matching a regular expression: + +`smbmap -u {{username}} --prompt -H {{ip}} -R -A {{pattern}}` + +- Display SMB shares and recursively list directories and files, searching for file content matching a regular expression: + +`smbmap -u {{username}} --prompt -H {{ip}} -R -F {{pattern}}` + +- Execute a shell command on a remote system: + +`smbmap -u {{username}} --prompt -H {{ip}} -x {{command}}` + +- Upload a file to a remote system: + +`smbmap -u {{username}} --prompt -H {{ip}} --upload {{source}} {{destination}}` diff --git a/linux/smbnetfs b/linux/smbnetfs new file mode 100644 index 00000000..1f2da8a5 --- /dev/null +++ b/linux/smbnetfs @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smbnetfs + +> Mount SMB shares interactively. +> More information: . + +- Make shares available at `mountpoint`: + +`smbnetfs {{mountpoint}}` diff --git a/linux/smbpasswd b/linux/smbpasswd new file mode 100644 index 00000000..b2e05eae --- /dev/null +++ b/linux/smbpasswd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smbpasswd + +> Add/remove a Samba user or change its password. +> Samba users must have an existing local Unix account. +> More information: . + +- Change the current user's SMB password: + +`smbpasswd` + +- Add a specified user to Samba and set password (user should already exist in system): + +`sudo smbpasswd -a {{username}}` + +- Modify an existing Samba user's password: + +`sudo smbpasswd {{username}}` + +- Delete a Samba user (use `pdbedit` instead if the Unix account has been deleted): + +`sudo smbpasswd -x {{username}}` diff --git a/linux/smem b/linux/smem new file mode 100644 index 00000000..a0bde872 --- /dev/null +++ b/linux/smem @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# smem + +> Print memory usage for programs. +> More information: . + +- Print memory usage for current processes: + +`smem` + +- Print memory usage for current processes for a every user on a system: + +`smem --users` + +- Print memory usage for current processes for a specified user: + +`smem --userfilter {{username}}` + +- Print system memory information: + +`smem --system` diff --git a/linux/snake4 b/linux/snake4 new file mode 100644 index 00000000..72d5aa49 --- /dev/null +++ b/linux/snake4 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# snake4 + +> Snake game in the terminal. +> More information: . + +- Start a snake game: + +`snake4` + +- Choose level: + +`{{1|2|3|4|5}}` + +- Navigate the snake: + +`{{Up|Down|Left|Right arrow key}}` + +- Pause game: + +`` + +- Quit game: + +`q` + +- Show the high scores: + +`snake4 --highscores` diff --git a/linux/snake4scores b/linux/snake4scores new file mode 100644 index 00000000..29ec7954 --- /dev/null +++ b/linux/snake4scores @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# snake4scores + +> Show the high scores from the snake4 game. +> More information: . + +- Show the highscores: + +`snake4scores` diff --git a/linux/snap b/linux/snap new file mode 100644 index 00000000..71298cfd --- /dev/null +++ b/linux/snap @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# snap + +> Manage the "snap" self-contained software packages. +> Similar to what `apt` is for `.deb`. +> More information: . + +- Search for a package: + +`snap find {{query}}` + +- Install a package: + +`snap install {{package}}` + +- Update a package: + +`snap refresh {{package}}` + +- Update a package to another channel (track, risk, or branch): + +`snap refresh {{package}} --channel={{channel}}` + +- Update all packages: + +`snap refresh` + +- Display basic information about installed snap software: + +`snap list` + +- Uninstall a package: + +`snap remove {{package}}` + +- Check for recent snap changes in the system: + +`snap changes` diff --git a/linux/snapper b/linux/snapper new file mode 100644 index 00000000..f8685b75 --- /dev/null +++ b/linux/snapper @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# snapper + +> Filesystem snapshot management tool. +> More information: . + +- List snapshot configs: + +`snapper list-configs` + +- Create snapper config: + +`snapper -c {{config}} create-config {{path/to/directory}}` + +- Create a snapshot with a description: + +`snapper -c {{config}} create -d "{{snapshot_description}}"` + +- List snapshots for a config: + +`snapper -c {{config}} list` + +- Delete a snapshot: + +`snapper -c {{config}} delete {{snapshot_number}}` + +- Delete a range of snapshots: + +`snapper -c {{config}} delete {{snapshot1}}-{{snapshot2}}` diff --git a/linux/snmpwalk b/linux/snmpwalk new file mode 100644 index 00000000..a36a813a --- /dev/null +++ b/linux/snmpwalk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# snmpwalk + +> SNMP query tool. +> More information: . + +- Query the system information of a remote host using SNMPv1 and a community string: + +`snmpwalk -v1 -c {{community}} {{ip}}` + +- Query system information on a remote host by OID using SNMPv2 on a specified port: + +`snmpwalk -v2c -c {{community}} {{ip}}:{{port}} {{oid}}` + +- Query system information on a remote host by OID using SNMPv3 and authentication without encryption: + +`snmpwalk -v3 -l {{authNoPriv}} -u {{username}} -a {{MD5|SHA}} -A {{passphrase}} {{ip}} {{oid}}` + +- Query system information on a remote host by OID using SNMPv3, authentication, and encryption: + +`snmpwalk -v3 -l {{authPriv}} -u {{username}} -a {{MD5|SHA}} -A {{auth_passphrase}} -x {{DES|AES}} -X {{enc_passphrase}} {{ip}} {{oid}}` + +- Query system information on a remote host by OID using SNMPv3 without authentication or encryption: + +`snmpwalk -v3 -l {{noAuthNoPriv}} -u {{username}} {{ip}} {{oid}}` diff --git a/linux/sockstat b/linux/sockstat new file mode 100644 index 00000000..ae0fa887 --- /dev/null +++ b/linux/sockstat @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sockstat + +> List open Internet or UNIX domain sockets. +> See also: `netstat`. +> More information: . + +- Show information for IPv4 and IPv6 sockets for both listening and connected sockets: + +`sockstat` + +- Show information for IPv[4]/IPv[6] sockets [l]istening on specific [p]orts using a specific p[R]otocol: + +`sockstat -{{4|6}} -l -R {{tcp|udp|raw|unix}} -p {{port1,port2...}}` + +- Also show [c]onnected sockets and [u]nix sockets: + +`sockstat -cu` + +- Only show sockets of the specified `pid` or process: + +`sockstat -P {{pid|process}}` + +- Only show sockets of the specified `uid` or user: + +`sockstat -U {{uid|user}}` + +- Only show sockets of the specified `gid` or group: + +`sockstat -G {{gid|group}}` diff --git a/linux/spectre-meltdown-checker b/linux/spectre-meltdown-checker new file mode 100644 index 00000000..0100948d --- /dev/null +++ b/linux/spectre-meltdown-checker @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# spectre-meltdown-checker + +> Spectre and Meltdown mitigation detection tool. +> More information: . + +- Check the currently running kernel for Spectre or Meltdown: + +`sudo spectre-meltdown-checker` + +- Check the currently running kernel and show an explanation of the actions to take to mitigate a vulnerability: + +`sudo spectre-meltdown-checker --explain` + +- Check for specific variants (defaults to all): + +`sudo spectre-meltdown-checker --variant {{1|2|3|3a|4|l1tf|msbds|mfbds|mlpds|mdsum|taa|mcespc|srbds}}` + +- Display output using a specific output format: + +`sudo spectre-meltdown-checker --batch {{text|json|nrpe|prometheus|short}}` + +- Don't use the `/sys` interface even if present: + +`sudo spectre-meltdown-checker --no-sysfs` + +- Check a non-running kernel: + +`sudo spectre-meltdown-checker --kernel {{path/to/kernel_file}}` diff --git a/linux/speedometer b/linux/speedometer new file mode 100644 index 00000000..5e513e7a --- /dev/null +++ b/linux/speedometer @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# speedometer + +> Python script that shows a network traffic graph in the terminal. +> More information: . + +- Show graph for a specific interface: + +`speedometer -r {{eth0}} -t {{eth0}}` diff --git a/linux/speedread b/linux/speedread new file mode 100644 index 00000000..ee74d7ac --- /dev/null +++ b/linux/speedread @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# speedread + +> A simple terminal-based open source Spritz-alike. +> Shows input text as a per-word RSVP (rapid serial visual presentation) aligned on optimal reading points, which allows reading text at a much more rapid pace than usual as the eye can stay fixed on a single place. +> More information: . + +- Read a text file at a specific speed: + +`cat {{path/to/file.txt}} | speedread -wpm {{250}}` + +- Resume from a specific line: + +`cat {{path/to/file.txt}} | speedread -resume {{5}}` + +- Show multiple words at a time: + +`cat {{path/to/file.txt}} | speedread -multiword` + +- Slow down by 10% during the reading session: + +`[` + +- Speed up by 10% during the reading session: + +`]` + +- Pause, and show the last few lines as context: + +`` diff --git a/linux/spi b/linux/spi new file mode 100644 index 00000000..eb94fac5 --- /dev/null +++ b/linux/spi @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# spi + +> A meta package manager that handles both packages and slackbuilds. +> More information: . + +- Update the list of available packages and slackbuilds: + +`spi --update` + +- Install a package or slackbuild: + +`spi --install {{package/slackbuild_name}}` + +- Upgrade all installed packages to the latest versions available: + +`spi --upgrade` + +- Locate packages or slackbuilds by package name or description: + +`spi {{search_terms}}` + +- Display information about a package or slackbuild: + +`spi --show {{package/slackbuild_name}}` + +- Purge the local package and slackbuild caches: + +`spi --clean` diff --git a/linux/sport b/linux/sport new file mode 100644 index 00000000..3f4c66d2 --- /dev/null +++ b/linux/sport @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sport + +> Search and install SlackBuilds. +> More information: . + +- Pull the list of SlackBuilds to run `sport` for the first time: + +`sudo mkdir -p /usr/ports && sudo rsync -av rsync://slackbuilds.org /slackbuilds/$(awk '{print $2}' /etc/slackware-version)/ /usr/ports/` + +- Pull in any updates to the system's tree via `rsync`: + +`sudo sport rsync` + +- Search for a package by name: + +`sport search "{{keyword}}"` + +- Check if a package is installed: + +`sport check {{package}}` + +- Display README and `.info` files of a package: + +`sport cat {{package}}` + +- Install a package once the dependencies are resolved: + +`sudo sport install {{package}}` + +- Install a list of packages from a file (format: packages separated by spaces): + +`sudo sport install $(< {{path/to/list}})` diff --git a/linux/sprio b/linux/sprio new file mode 100644 index 00000000..bd6a2492 --- /dev/null +++ b/linux/sprio @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sprio + +> View the factors determining a job's scheduling priority. +> More information: . + +- View the factors determining the scheduling priority of all jobs: + +`sprio` + +- View the factors determining the specified job's scheduling priority: + +`sprio --jobs={{job_id_1,job_id_2,...}}` + +- Output additional information: + +`sprio --long` + +- View information for the jobs of specified users: + +`sprio --user={{user_name_1,user_name_2,...}}` + +- Print the weights for each factor determining job scheduling priority: + +`sprio --weights` diff --git a/linux/sqfscat b/linux/sqfscat new file mode 100644 index 00000000..cd18ca01 --- /dev/null +++ b/linux/sqfscat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sqfscat + +> Concatenate files from a squashfs filesystem and print them to `stdout`. +> More information: . + +- Display the contents of one or more files from a squashfs filesystem: + +`sqfscat {{filesystem.squashfs}} {{file1 file2 ...}}` diff --git a/linux/sqfstar b/linux/sqfstar new file mode 100644 index 00000000..77180879 --- /dev/null +++ b/linux/sqfstar @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sqfstar + +> Create a squashfs filesystem from a tar archive. +> More information: . + +- Create a squashfs filesystem (compressed using `gzip` by default) from an uncompressed `tar` archive: + +`sqfstar {{filesystem.squashfs}} < {{archive.tar}}` + +- Create a squashfs filesystem from a `tar` archive compressed with `gzip`, and [comp]ress the filesystem using a specific algorithm: + +`zcat {{archive.tar.gz}} | sqfstar -comp {{gzip|lzo|lz4|xz|zstd|lzma}} {{filesystem.squashfs}}` + +- Create a squashfs filesystem from a `tar` archive compressed with `xz`, excluding some of the files: + +`xzcat {{archive.tar.xz}} | sqfstar {{filesystem.squashfs}} {{file1 file2 ...}}` + +- Create a squashfs filesystem from a `tar` archive compressed with `zstd`, excluding files ending with `.gz`: + +`zstdcat {{archive.tar.zst}} | sqfstar {{filesystem.squashfs}} "{{*.gz}}"` + +- Create a squashfs filesystem from a `tar` archive compressed with `lz4`, excluding files matching a regular expression: + +`lz4cat {{archive.tar.lz4}} | sqfstar {{filesystem.squashfs}} -regex "{{regular_expression}}"` diff --git a/linux/squeue b/linux/squeue new file mode 100644 index 00000000..e8b61e4b --- /dev/null +++ b/linux/squeue @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# squeue + +> View the jobs queued in the SLURM scheduler. +> More information: . + +- View the queue: + +`squeue` + +- View jobs queued by a specific user: + +`squeue -u {{username}}` + +- View the queue and refresh every 5 seconds: + +`squeue -i {{5}}` + +- View the queue with expected start times: + +`squeue --start` diff --git a/linux/sreport b/linux/sreport new file mode 100644 index 00000000..d3516072 --- /dev/null +++ b/linux/sreport @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sreport + +> Generate reports on jobs, users, and clusters from accounting data. +> More information: . + +- Show pipe delimited cluster utilization data: + +`sreport --parsable cluster utilization` + +- Show number of jobs run: + +`sreport job sizes printjobcount` + +- Show users with the highest CPU time use: + +`sreport user topuser` diff --git a/linux/srun b/linux/srun new file mode 100644 index 00000000..513c4541 --- /dev/null +++ b/linux/srun @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# srun + +> Create an interactive slurm job or connect to an existing job. +> More information: . + +- Submit a basic interactive job: + +`srun --pty /bin/bash` + +- Submit an interactive job with different attributes: + +`srun --ntasks-per-node={{num_cores}} --mem-per-cpu={{memory_MB}} --pty /bin/bash` + +- Connect to a worker node with a job running: + +`srun --jobid={{job_id}} --pty /bin/bash` diff --git a/linux/ss b/linux/ss new file mode 100644 index 00000000..05f21be2 --- /dev/null +++ b/linux/ss @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ss + +> Utility to investigate sockets. +> More information: . + +- Show all TCP/UDP/RAW/UNIX sockets: + +`ss -a {{-t|-u|-w|-x}}` + +- Filter TCP sockets by states, only/exclude: + +`ss {{state/exclude}} {{bucket/big/connected/synchronized/...}}` + +- Show all TCP sockets connected to the local HTTPS port (443): + +`ss -t src :{{443}}` + +- Show all TCP sockets listening on the local 8080 port: + +`ss -lt src :{{8080}}` + +- Show all TCP sockets along with processes connected to a remote ssh port: + +`ss -pt dst :{{ssh}}` + +- Show all UDP sockets connected on specific source and destination ports: + +`ss -u 'sport == :{{source_port}} and dport == :{{destination_port}}'` + +- Show all TCP IPv4 sockets locally connected on the subnet 192.168.0.0/16: + +`ss -4t src {{192.168/16}}` + +- Kill IPv4 or IPv6 Socket Connection with destination IP 192.168.1.17 and destination port 8080: + +`ss --kill dst {{192.168.1.17}} dport = {{8080}}` diff --git a/linux/sshare b/linux/sshare new file mode 100644 index 00000000..9e905e40 --- /dev/null +++ b/linux/sshare @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sshare + +> List the shares of associations to a cluster. +> More information: . + +- List Slurm share information: + +`sshare` + +- Control the output format: + +`sshare --{{parsable|parsable2|json|yaml}}` + +- Control the fields to display: + +`sshare --format={{format_string}}` + +- Display information for the specified users only: + +`sshare --users={{user_id_1,user_id_2,...}}` diff --git a/linux/sstat b/linux/sstat new file mode 100644 index 00000000..b6bbecad --- /dev/null +++ b/linux/sstat @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sstat + +> View information about running jobs. +> More information: . + +- Display status information of a comma-separated list of jobs: + +`sstat --jobs={{job_id}}` + +- Display job ID, average CPU and average virtual memory size of a comma-separated list of jobs, with pipes as column delimiters: + +`sstat --parsable --jobs={{job_id}} --format={{JobID,AveCPU,AveVMSize}}` + +- Display list of fields available: + +`sstat --helpformat` diff --git a/linux/st b/linux/st new file mode 100644 index 00000000..2b91edb3 --- /dev/null +++ b/linux/st @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# st + +> A simple terminal emulator for the X Window System. +> More information: . + +- Open a terminal: + +`st` + +- Open a terminal with a specific title: + +`st -T {{title}}` + +- Open a terminal, execute a given command, and write the output to a file: + +`st -o {{path/to/file}} -e {{command argument1 argument2}}` + +- Increase/decrease the font size: + +` + + {{Page Up|Page Down}}` + +- Copy/paste from the clipboard: + +` + + {{C|V}}` diff --git a/linux/startx b/linux/startx new file mode 100644 index 00000000..2786bde6 --- /dev/null +++ b/linux/startx @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# startx + +> A front-end to `xinit` that provides a nice user interface for running a single session of the X Window System. +> More information: . + +- Start an X session: + +`startx` + +- Start an X session with a predefined depth value: + +`startx -- -depth {{value}}` + +- Start an X session with a predefined dpi value: + +`startx -- -dpi {{value}}` + +- Override the settings in the `.xinitrc` file and start a new X session: + +`startx /{{path/to/window_manager_or_desktop_environment}}` diff --git a/linux/steghide b/linux/steghide new file mode 100644 index 00000000..fd81561f --- /dev/null +++ b/linux/steghide @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# steghide + +> Steganography tool for JPEG, BMP, WAV and AU file formats. +> More information: . + +- Embed data in a PNG, prompting for a passphrase: + +`steghide embed --coverfile {{path/to/image.png}} --embedfile {{path/to/data.txt}}` + +- Extract data from a WAV audio file: + +`steghide extract --stegofile {{path/to/sound.wav}}` + +- Display file information, trying to detect an embedded file: + +`steghide info {{path/to/file.jpg}}` + +- Embed data in a JPEG image, using maximum compression: + +`steghide embed --coverfile {{path/to/image.jpg}} --embedfile {{path/to/data.txt}} --compress {{9}}` + +- Get the list of supported encryption algorithms and modes: + +`steghide encinfo` + +- Embed encrypted data in a JPEG image, e.g. with Blowfish in CBC mode: + +`steghide embed --coverfile {{path/to/image.jpg}} --embedfile {{path/to/data.txt}} --encryption {{blowfish|...}} {{cbc|...}}` diff --git a/linux/stegsnow b/linux/stegsnow new file mode 100644 index 00000000..adf85a70 --- /dev/null +++ b/linux/stegsnow @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# stegsnow + +> Steganography tool for concealing and extracting messages in text files encoded as tabs and spaces. +> More information: . + +- Extract [m]essage from file: + +`stegsnow {{path/to/file.txt}}` + +- Extract [C]ompressed and [p]assword protected [m]essage from file: + +`stegsnow -C -p {{password}} {{path/to/file.txt}}` + +- Determine approximate [S]torage capacity with line [l]ength less than 72 for file: + +`stegsnow -S -l 72 {{path/to/file.txt}}` + +- Conceal [m]essage in text from file and save to result: + +`stegsnow -m '{{message}}' {{path/to/file.txt}} {{path/to/result.txt}}` + +- Conceal message [f]ile content [C]ompressed in text from file and save to result: + +`stegsnow -C -f '{{path/to/message.txt}}' {{path/to/file.txt}} {{path/to/result.txt}}` + +- Conceal [m]essage [C]ompressed and [p]assword protected in text from file and save to result: + +`stegsnow -C -p {{password}} -m '{{message}}' {{path/to/file.txt}} {{path/to/result.txt}}` diff --git a/linux/strace b/linux/strace new file mode 100644 index 00000000..10bdb5ee --- /dev/null +++ b/linux/strace @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# strace + +> Troubleshooting tool for tracing system calls. +> More information: . + +- Start tracing a specific [p]rocess by its PID: + +`strace -p {{pid}}` + +- Trace a [p]rocess and filt[e]r output by system call: + +`strace -p {{pid}} -e {{system_call,system_call2,...}}` + +- Count time, calls, and errors for each system call and report a summary on program exit: + +`strace -p {{pid}} -c` + +- Show the [T]ime spent in every system call: + +`strace -p {{pid}} -T` + +- Start tracing a program by executing it: + +`strace {{program}}` + +- Start tracing file operations of a program: + +`strace -e trace=file {{program}}` + +- Start tracing network operations of a program as well as all its [f]orked and child processes, saving the [o]utput to a file: + +`strace -f -e trace=network -o {{trace.txt}} {{program}}` diff --git a/linux/stress b/linux/stress new file mode 100644 index 00000000..92d9dc83 --- /dev/null +++ b/linux/stress @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# stress + +> Stress test CPU, memory, and IO on a Linux system. +> More information: . + +- Spawn 4 workers to stress test CPU: + +`stress -c {{4}}` + +- Spawn 2 workers to stress test IO and timeout after 5 seconds: + +`stress -i {{2}} -t {{5}}` + +- Spawn 2 workers to stress test memory (each worker allocates 256M bytes): + +`stress -m {{2}} --vm-bytes {{256M}}` + +- Spawn 2 workers spinning on write()/unlink() (each worker writes 1G bytes): + +`stress -d {{2}} --hdd-bytes {{1GB}}` diff --git a/linux/strigger b/linux/strigger new file mode 100644 index 00000000..9db3667a --- /dev/null +++ b/linux/strigger @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# strigger + +> View or modify Slurm trigger information. +> Triggers are actions that are automatically run when an event occurs on a Slurm cluster. +> More information: . + +- Register a new trigger. Execute the specified program when the specified event occurs: + +`strigger --set --{{primary_database_failure|primary_slurmdbd_failure|primary_slurmctld_acct_buffer_full|primary_slurmctld_failure|...}} --program={{path/to/executable}}` + +- Execute the specified program when the specified job terminated: + +`strigger --set --jobid={{job_id}} --fini --program="{{path/to/executable}} {{argument1 argument2 ...}}"` + +- View active triggers: + +`strigger --get` + +- View active triggers regarding the specified job: + +`strigger --get --jobid={{job_id}}` + +- Clear the specified trigger: + +`strigger --clear {{trigger_id}}` diff --git a/linux/strip b/linux/strip new file mode 100644 index 00000000..32baf55f --- /dev/null +++ b/linux/strip @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# strip + +> Discard symbols from executables or object files. +> More information: . + +- Replace the input file with its stripped version: + +`strip {{path/to/file}}` + +- Strip symbols from a file, saving the output to a specific file: + +`strip {{path/to/input_file}} -o {{path/to/output_file}}` + +- Strip debug symbols only: + +`strip --strip-debug {{path/to/file.o}}` diff --git a/linux/sview b/linux/sview new file mode 100644 index 00000000..6e53a0d5 --- /dev/null +++ b/linux/sview @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sview + +> Start a GUI to view and modify the state of Slurm. +> More information: . + +- Start a GUI to view and modify the state of Slurm: + +`sview` diff --git a/linux/swaks b/linux/swaks new file mode 100644 index 00000000..ab45741a --- /dev/null +++ b/linux/swaks @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swaks + +> Swiss Army Knife SMTP, the all-purpose SMTP transaction tester. +> More information: . + +- Deliver a standard test email to `user@example.com` on port 25 of `test-server.example.net`: + +`swaks --to {{user@example.com}} --server {{test-server.example.net}}` + +- Deliver a standard test email, requiring CRAM-MD5 authentication as user `me@example.com`. An "X-Test" header will be added to the email body: + +`swaks --to {{user@example.com}} --from {{me@example.com}} --auth {{CRAM-MD5}} --auth-user {{me@example.com}} --header-X-Test "{{test_email}}"` + +- Test a virus scanner using EICAR in an attachment. Don't show the message DATA part: + +`swaks -t {{user@example.com}} --attach - --server {{test-server.example.com}} --suppress-data {{path/to/eicar.txt}}` + +- Test a spam scanner using GTUBE in the body of an email, routed via the MX records for `example.com`: + +`swaks --to {{user@example.com}} --body {{path/to/gtube_file}}` + +- Deliver a standard test email to `user@example.com` using the LMTP protocol via a UNIX domain socket file: + +`swaks --to {{user@example.com}} --socket {{/var/lda.sock}} --protocol {{LMTP}}` diff --git a/linux/swaplabel b/linux/swaplabel new file mode 100644 index 00000000..31d5cf55 --- /dev/null +++ b/linux/swaplabel @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swaplabel + +> Print or change the label or UUID of a swap area. +> Note: `path/to/file` can either point to a regular file or a swap partition. +> More information: . + +- Display the current label and UUID of a swap area: + +`swaplabel {{path/to/file}}` + +- Set the label of a swap area: + +`swaplabel --label {{new_label}} {{path/to/file}}` + +- Set the UUID of a swap area (you can generate a UUID using `uuidgen`): + +`swaplabel --uuid {{new_uuid}} {{path/to/file}}` diff --git a/linux/swapoff b/linux/swapoff new file mode 100644 index 00000000..7bc1c871 --- /dev/null +++ b/linux/swapoff @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swapoff + +> Disable devices and files for swapping. +> Note: `path/to/file` can either point to a regular file or a swap partition. +> More information: . + +- Disable a given swap area: + +`swapoff {{path/to/file}}` + +- Disable all swap areas in `/proc/swaps`: + +`swapoff --all` + +- Disable a swap partition by its label: + +`swapoff -L {{label}}` diff --git a/linux/swapon b/linux/swapon new file mode 100644 index 00000000..78f09a4f --- /dev/null +++ b/linux/swapon @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swapon + +> Enable devices and files for swapping. +> Note: `path/to/file` can either point to a regular file or a swap partition. +> More information: . + +- Show swap information: + +`swapon` + +- Enable a given swap area: + +`swapon {{path/to/file}}` + +- Enable all swap areas specified in `/etc/fstab` except those with the `noauto` option: + +`swapon --all` + +- Enable a swap partition by its label: + +`swapon -L {{label}}` diff --git a/linux/swaybg b/linux/swaybg new file mode 100644 index 00000000..87815dd8 --- /dev/null +++ b/linux/swaybg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swaybg + +> Wallpaper tool for Wayland compositors. +> More information: . + +- Set the wallpaper to an [i]mage: + +`swaybg --image {{path/to/image}}` + +- Set the wallpaper [m]ode: + +`swaybg --image {{path/to/image}} --mode {{stretch|fit|fill|center|tile|solid_color}}` + +- Set the wallpaper to a static [c]olor: + +`swaybg --color {{"#rrggbb"}}` diff --git a/linux/swayidle b/linux/swayidle new file mode 100644 index 00000000..59059aea --- /dev/null +++ b/linux/swayidle @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swayidle + +> Idle management daemon for Wayland. +> Note: the configuration options are documented in its man page. +> More information: . + +- Listen for idle activity using the configuration in `$XDG_CONFIG_HOME/swayidle/config` or `$HOME/swayidle/config`: + +`swayidle` + +- Specify an alternative path to the configuration file: + +`swayidle -C {{path/to/file}}` diff --git a/linux/swaylock b/linux/swaylock new file mode 100644 index 00000000..93f4df18 --- /dev/null +++ b/linux/swaylock @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swaylock + +> Screen locking utility for Wayland compositors. +> More information: . + +- Lock the screen showing a white background: + +`swaylock` + +- Lock the screen with a simple color background (rrggbb format): + +`swaylock --color {{0000ff}}` + +- Lock the screen to a PNG background: + +`swaylock --image {{path/to/file.png}}` + +- Lock the screen and disable the unlock indicator (removes feedback on keypress): + +`swaylock --no-unlock-indicator` + +- Lock the screen and don't hide the mouse pointer: + +`swaylock --pointer {{default}}` + +- Lock the screen to a PNG background tiled over all monitors: + +`swaylock --image {{path/to/file.png}} --tiling` + +- Lock the screen and show the number of failed login attempts: + +`swaylock --show-failed-attempts` + +- Load configuration from a file: + +`swaylock --config {{path/to/config}}` diff --git a/linux/switch_root b/linux/switch_root new file mode 100644 index 00000000..2cd36dfd --- /dev/null +++ b/linux/switch_root @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# switch_root + +> Use a different filesystem as the root of the mount tree. +> Note: switch_root will fail to function if the new root is not the root of a mount. Use bind-mounting as a workaround. +> See also: `chroot`, `mount`. +> More information: . + +- Move `/proc`, `/dev`, `/sys` and `/run` to the specified filesystem, use this filesystem as the new root and start the specified init process: + +`switch_root {{new_root}} {{/sbin/init}}` + +- Display help: + +`switch_root -h` diff --git a/linux/swupd b/linux/swupd new file mode 100644 index 00000000..e45cc391 --- /dev/null +++ b/linux/swupd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# swupd + +> Package management utility for Clear Linux. +> More information: . + +- Update to the latest version: + +`sudo swupd update` + +- Show current version, and check whether a newer one exists: + +`swupd check-update` + +- List installed bundles: + +`swupd bundle-list` + +- Locate the bundle where a wanted package exists: + +`swupd search -b {{package}}` + +- Install a new bundle: + +`sudo swupd bundle-add {{bundle}}` + +- Remove a bundle: + +`sudo swupd bundle-remove {{bundle}}` + +- Correct broken or missing files: + +`sudo swupd verify` diff --git a/linux/sxiv b/linux/sxiv new file mode 100644 index 00000000..85467b13 --- /dev/null +++ b/linux/sxiv @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sxiv + +> Simple X Image Viewer. +> More information: . + +- Open an image: + +`sxiv {{path/to/image}}` + +- Open an image in fullscreen mode: + +`sxiv -f {{path/to/file}}` + +- Open a newline-separated list of images, reading filenames from `stdin`: + +`echo {{path/to/file}} | sxiv -i` + +- Open one or more images as a slideshow: + +`sxiv -S {{seconds}} {{path/to/image1 path/to/image2}}` + +- Open one or more images in thumbnail mode: + +`sxiv -t {{path/to/image1 path/to/image2}}` diff --git a/linux/synopkg b/linux/synopkg new file mode 100644 index 00000000..b5c43dc2 --- /dev/null +++ b/linux/synopkg @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# synopkg + +> Package management utility for Synology DiskStation Manager. +> More information: . + +- List the names of installed packages: + +`synopkg list --name` + +- List packages which depend on a specific package: + +`synopkg list --depend-on {{package}}` + +- Start/Stop a package: + +`sudo synopkg {{start|stop}} {{package}}` + +- Print the status of a package: + +`synopkg status {{package}}` + +- Uninstall a package: + +`sudo synopkg uninstall {{package}}` + +- Check if updates are available for a package: + +`synopkg checkupdate {{package}}` + +- Upgrade all packages to the latest version: + +`sudo synopkg upgradeall` + +- Install a package from a synopkg file: + +`sudo synopkg install {{path/to/package.spk}}` diff --git a/linux/synoupgrade b/linux/synoupgrade new file mode 100644 index 00000000..f576f053 --- /dev/null +++ b/linux/synoupgrade @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# synoupgrade + +> Upgrade Synology DiskStation Manager (DSM) - the Synology NAS operating system. +> More information: . + +- Check if upgrades are available: + +`sudo synoupgrade --check` + +- Check for patches without upgrading the DSM version: + +`sudo synoupgrade --check-smallupdate` + +- Download the latest upgrade available (use `--download-smallupdate` for patches): + +`sudo synoupgrade --download` + +- Start the upgrade process: + +`sudo synoupgrade --start` + +- Upgrade to the latest version automatically: + +`sudo synoupgrade --auto` + +- Apply patches without upgrading the DSM version automatically: + +`sudo synoupgrade --auto-smallupdate` + +- Upgrade the DSM using a patch file (should be an absolute path): + +`sudo synoupgrade --patch {{/path/to/file.pat}}` + +- Display help: + +`synoupgrade` diff --git a/linux/sysctl b/linux/sysctl new file mode 100644 index 00000000..9597f75f --- /dev/null +++ b/linux/sysctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# sysctl + +> List and change kernel runtime variables. +> More information: . + +- Show all available variables and their values: + +`sysctl -a` + +- Set a changeable kernel state variable: + +`sysctl -w {{section.tunable}}={{value}}` + +- Get currently open file handlers: + +`sysctl fs.file-nr` + +- Get limit for simultaneous open files: + +`sysctl fs.file-max` + +- Apply changes from `/etc/sysctl.conf`: + +`sysctl -p` diff --git a/linux/systemctl b/linux/systemctl new file mode 100644 index 00000000..60bd6970 --- /dev/null +++ b/linux/systemctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl + +> Control the systemd system and service manager. +> More information: . + +- Show all running services: + +`systemctl status` + +- List failed units: + +`systemctl --failed` + +- Start/Stop/Restart/Reload a service: + +`systemctl {{start|stop|restart|reload}} {{unit}}` + +- Show the status of a unit: + +`systemctl status {{unit}}` + +- Enable/Disable a unit to be started on bootup: + +`systemctl {{enable|disable}} {{unit}}` + +- Mask/Unmask a unit to prevent enablement and manual activation: + +`systemctl {{mask|unmask}} {{unit}}` + +- Reload systemd, scanning for new or changed units: + +`systemctl daemon-reload` + +- Check if a unit is enabled: + +`systemctl is-enabled {{unit}}` diff --git a/linux/systemd-ac-power b/linux/systemd-ac-power new file mode 100644 index 00000000..64b95272 --- /dev/null +++ b/linux/systemd-ac-power @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-ac-power + +> Report whether the computer is connected to an external power source. +> More information: . + +- Silently check and return a 0 status code when running on AC power, and a non-zero code otherwise: + +`systemd-ac-power` + +- Additionally print `yes` or `no` to `stdout`: + +`systemd-ac-power --verbose` diff --git a/linux/systemd-analyze b/linux/systemd-analyze new file mode 100644 index 00000000..639b8528 --- /dev/null +++ b/linux/systemd-analyze @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-analyze + +> Analyze and debug system manager. +> Show timing details about the boot process of units (services, mount points, devices, sockets). +> More information: . + +- List all running units, ordered by the time they took to initialize: + +`systemd-analyze blame` + +- Print a tree of the time-critical chain of units: + +`systemd-analyze critical-chain` + +- Create an SVG file showing when each system service started, highlighting the time that they spent on initialization: + +`systemd-analyze plot > {{path/to/file.svg}}` + +- Plot a dependency graph and convert it to an SVG file: + +`systemd-analyze dot | dot -T{{svg}} > {{path/to/file.svg}}` + +- Show security scores of running units: + +`systemd-analyze security` diff --git a/linux/systemd-ask-password b/linux/systemd-ask-password new file mode 100644 index 00000000..0c1e1a67 --- /dev/null +++ b/linux/systemd-ask-password @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-ask-password + +> Query the user for a system password. +> More information: . + +- Query a system password with a specific message: + +`systemd-ask-password "{{message}}"` + +- Specify an identifier for the password query: + +`systemd-ask-password --id={{identifier}} "{{message}}"` + +- Use a kernel keyring key name as a cache for the password: + +`systemd-ask-password --keyname={{key_name}} "{{message}}"` + +- Set a custom timeout for the password query: + +`systemd-ask-password --timeout={{seconds}} "{{message}}"` + +- Force the use of an agent system and never ask on current TTY: + +`systemd-ask-password --no-tty "{{message}}"` + +- Store a password in the kernel keyring without displaying it: + +`systemd-ask-password --no-output --keyname={{key_name}} "{{message}}"` diff --git a/linux/systemd-cat b/linux/systemd-cat new file mode 100644 index 00000000..1bad50bc --- /dev/null +++ b/linux/systemd-cat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-cat + +> Connect a pipeline or program's output streams with the systemd journal. +> More information: . + +- Write the output of the specified command to the journal (both output streams are captured): + +`systemd-cat {{command}}` + +- Write the output of a pipeline to the journal (`stderr` stays connected to the terminal): + +`{{command}} | systemd-cat` diff --git a/linux/systemd-cgls b/linux/systemd-cgls new file mode 100644 index 00000000..53353372 --- /dev/null +++ b/linux/systemd-cgls @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-cgls + +> Show the contents of the selected Linux control group hierarchy in a tree. +> More information: . + +- Display the whole control group hierarchy on your system: + +`systemd-cgls` + +- Display a control group tree of a specific resource controller: + +`systemd-cgls {{cpu|memory|io}}` + +- Display the control group hierarchy of one or more systemd units: + +`systemd-cgls --unit {{unit1 unit2 ...}}` diff --git a/linux/systemd-cgtop b/linux/systemd-cgtop new file mode 100644 index 00000000..2f5ddea6 --- /dev/null +++ b/linux/systemd-cgtop @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-cgtop + +> Show the top control groups of the local Linux control group hierarchy, ordered by their CPU, memory, or disk I/O load. +> See also: `top`. +> More information: . + +- Start an interactive view: + +`systemd-cgtop` + +- Change the sort order: + +`systemd-cgtop --order={{cpu|memory|path|tasks|io}}` + +- Show the CPU usage by time instead of percentage: + +`systemd-cgtop --cpu=percentage` + +- Change the update interval in seconds (or one of these time units: `ms`, `us`, `min`): + +`systemd-cgtop --delay={{interval}}` + +- Only count userspace processes (without kernel threads): + +`systemd-cgtop -P` diff --git a/linux/systemd-confext b/linux/systemd-confext new file mode 100644 index 00000000..1ecf2066 --- /dev/null +++ b/linux/systemd-confext @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-confext + +> This command is an alias of `systemd-sysext`. +> It follows the same principle as `systemd-sysext`, but instead of working on `/usr` and `/opt`, `confext` will extend only `/etc`. +> More information: . + +- View documentation for the original command: + +`tldr systemd-sysext` diff --git a/linux/systemd-creds b/linux/systemd-creds new file mode 100644 index 00000000..028d4f07 --- /dev/null +++ b/linux/systemd-creds @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-creds + +> List, show, encrypt and decrypt service credentials. +> More information: . + +- Encrypt a file and set a specific name: + +`systemd-creds encrypt --name={{name}} {{path/to/input_file}} {{path/to/output}}` + +- Decrypt the file again: + +`systemd-creds decrypt {{path/to/input_file}} {{path/to/output_file}}` + +- Encrypt text from `stdin`: + +`echo -n {{text}} | systemd-creds encrypt --name={{name}} - {{path/to/output}}` + +- Encrypt the text and append it to the service file (the credentials will be available in `$CREDENTIALS_DIRECTORY`): + +`echo -n {{text}} | systemd-creds encrypt --name={{name}} --pretty - - >> {{service}}` + +- Create a credential that is only valid until the given timestamp: + +`systemd-creds encrypt --not-after="{{timestamp}}" {{path/to/input_file}} {{path/to/output_file}}` diff --git a/linux/systemd-cryptenroll b/linux/systemd-cryptenroll new file mode 100644 index 00000000..dae6c5ae --- /dev/null +++ b/linux/systemd-cryptenroll @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-cryptenroll + +> Interactively enroll or remove methods used to unlock LUKS2-encrypted devices. Uses a password to unlock the device unless otherwise specified. +> In order to allow a partition to be unlocked during system boot, update the `/etc/crypttab` file or the initramfs. +> More information: . + +- Enroll a new password (similar to `cryptsetup luksAddKey`): + +`systemd-cryptenroll --password {{path/to/luks2_block_device}}` + +- Enroll a new recovery key (i.e. a randomly generated passphrase that can be used as a fallback): + +`systemd-cryptenroll --recovery-key {{path/to/luks2_block_device}}` + +- List available tokens, or enroll a new PKCS#11 token: + +`systemd-cryptenroll --pkcs11-token-uri {{list|auto|pkcs11_token_uri}} {{path/to/luks2_block_device}}` + +- List available FIDO2 devices, or enroll a new FIDO2 device (`auto` can be used as the device name when there is only one token plugged in): + +`systemd-cryptenroll --fido2-device {{list|auto|path/to/fido2_hidraw_device}} {{path/to/luks2_block_device}}` + +- Enroll a new FIDO2 device with user verification (biometrics): + +`systemd-cryptenroll --fido2-device {{auto|path/to/fido2_hidraw_device}} --fido2-with-user-verification yes {{path/to/luks2_block_device}}` + +- Unlock using a FIDO2 device, and enroll a new FIDO2 device: + +`systemd-cryptenroll --unlock-fido2-device {{path/to/fido2_hidraw_unlock_device}} --fido2-device {{path/to/fido2_hidraw_enroll_device}} {{path/to/luks2_block_device}}` + +- Enroll a TPM2 security chip (only secure-boot-policy PCR) and require an additional alphanumeric PIN: + +`systemd-cryptenroll --tpm2-device {{auto|path/to/tpm2_block_device}} --tpm2-with-pin yes {{path/to/luks2_block_device}}` + +- Remove all empty passwords/all passwords/all FIDO2 devices/all PKCS#11 tokens/all TPM2 security chips/all recovery keys/all methods: + +`systemd-cryptenroll --wipe-slot {{empty|password|fido2|pkcs#11|tpm2|recovery|all}} {{path/to/luks2_block_device}}` diff --git a/linux/systemd-delta b/linux/systemd-delta new file mode 100644 index 00000000..147c86ba --- /dev/null +++ b/linux/systemd-delta @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-delta + +> Find overridden systemd-related configuration files. +> More information: . + +- Show all overridden configuration files: + +`systemd-delta` + +- Show only files of specific types (comma-separated list): + +`systemd-delta --type {{masked|equivalent|redirected|overridden|extended|unchanged}}` + +- Show only files whose path starts with the specified prefix (Note: a prefix is a directory containing subdirectories with systemd configuration files): + +`systemd-delta {{/etc|/run|/usr/lib|...}}` + +- Further restrict the search path by adding a suffix (the prefix is optional): + +`systemd-delta {{prefix}}/{{tmpfiles.d|sysctl.d|systemd/system|...}}` diff --git a/linux/systemd-detect-virt b/linux/systemd-detect-virt new file mode 100644 index 00000000..0ed0036e --- /dev/null +++ b/linux/systemd-detect-virt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-detect-virt + +> Detect execution in a virtualized environment. +> More information: . + +- List detectable virtualization technologies: + +`systemd-detect-virt --list` + +- Detect virtualization, print the result and return a zero status code when running in a VM or a container, and a non-zero code otherwise: + +`systemd-detect-virt` + +- Silently check without printing anything: + +`systemd-detect-virt --quiet` + +- Only detect container virtualization: + +`systemd-detect-virt --container` + +- Only detect hardware virtualization: + +`systemd-detect-virt --vm` diff --git a/linux/systemd-dissect b/linux/systemd-dissect new file mode 100644 index 00000000..fab506ef --- /dev/null +++ b/linux/systemd-dissect @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-dissect + +> Introspect and interact with file system OS disk images, specifically Discoverable Disk Images (DDIs). +> More information: . + +- Show general image information about the OS image: + +`systemd-dissect {{path/to/image.raw}}` + +- Mount an OS image: + +`systemd-dissect --mount {{path/to/image.raw}} {{/mnt/image}}` + +- Unmount an OS image: + +`systemd-dissect --umount {{/mnt/image}}` + +- List files in an image: + +`systemd-dissect --list {{path/to/image.raw}}` + +- Attach an OS image to an automatically allocated loopback block device and print its path: + +`systemd-dissect --attach {{path/to/image.raw}}` + +- Detach an OS image from a loopback block device: + +`systemd-dissect --detach {{path/to/device}}` diff --git a/linux/systemd-escape b/linux/systemd-escape new file mode 100644 index 00000000..42dae5c3 --- /dev/null +++ b/linux/systemd-escape @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-escape + +> Escape strings for usage in systemd unit names. +> More information: . + +- Escape the given text: + +`systemd-escape {{text}}` + +- Reverse the escaping process: + +`systemd-escape --unescape {{text}}` + +- Treat the given text as a path: + +`systemd-escape --path {{text}}` + +- Append the given suffix to the escaped text: + +`systemd-escape --suffix {{suffix}} {{text}}` + +- Use a template and inject the escaped text: + +`systemd-escape --template {{template}} {{text}}` diff --git a/linux/systemd-firstboot b/linux/systemd-firstboot new file mode 100644 index 00000000..c1caaec1 --- /dev/null +++ b/linux/systemd-firstboot @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-firstboot + +> Initialize basic system settings on or before the first boot-up of a system. +> More information: . + +- Operate on the specified directory instead of the root directory of the host system: + +`sudo systemd-firstboot --root={{path/to/root_directory}}` + +- Set the system keyboard layout: + +`sudo systemd-firstboot --keymap={{keymap}}` + +- Set the system hostname: + +`sudo systemd-firstboot --hostname={{hostname}}` + +- Set the root user's password: + +`sudo systemd-firstboot --root-password={{password}}` + +- Prompt the user interactively for a specific basic setting: + +`sudo systemd-firstboot --prompt={{setting}}` + +- Force writing configuration even if the relevant files already exist: + +`sudo systemd-firstboot --force` + +- Remove all existing files that are configured by `systemd-firstboot`: + +`sudo systemd-firstboot --reset` + +- Remove the password of the system's root user: + +`sudo systemd-firstboot --delete-root-password` diff --git a/linux/systemd-hwdb b/linux/systemd-hwdb new file mode 100644 index 00000000..85ae269f --- /dev/null +++ b/linux/systemd-hwdb @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-hwdb + +> Hardware database management tool. +> More information: . + +- Update the binary hardware database in `/etc/udev`: + +`systemd-hwdb update` + +- Query the hardware database and print the result for a specific modalias: + +`systemd-hwdb query {{modalias}}` + +- Update the binary hardware database, returning a non-zero exit value on any parsing error: + +`systemd-hwdb --strict update` + +- Update the binary hardware database in `/usr/lib/udev`: + +`systemd-hwdb --usr update` + +- Update the binary hardware database in the specified root path: + +`systemd-hwdb --root={{path/to/root}} update` diff --git a/linux/systemd-id128 b/linux/systemd-id128 new file mode 100644 index 00000000..0da14011 --- /dev/null +++ b/linux/systemd-id128 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-id128 + +> Generate and print sd-128 identifiers. +> More information: . + +- Generate a new random identifier: + +`systemd-id128 new` + +- Print the identifier of the current machine: + +`systemd-id128 machine-id` + +- Print the identifier of the current boot: + +`systemd-id128 boot-id` + +- Print the identifier of the current service invocation (this is available in systemd services): + +`systemd-id128 invocation-id` + +- Generate a new random identifier and print it as a UUID (five groups of digits separated by hyphens): + +`systemd-id128 new --uuid` diff --git a/linux/systemd-inhibit b/linux/systemd-inhibit new file mode 100644 index 00000000..7105592b --- /dev/null +++ b/linux/systemd-inhibit @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-inhibit + +> Prohibit the system from entering certain power states. +> Inhibitor locks may be used to block or delay system sleep and shutdown requests as well as automatic idle handling. +> More information: . + +- List all active inhibition locks and the reasons for their creation: + +`systemd-inhibit --list` + +- Block system shutdown for a specified number of seconds with the `sleep` command: + +`systemd-inhibit --what shutdown sleep {{5}}` + +- Keep the system from sleeping or idling until the download is complete: + +`systemd-inhibit --what sleep:idle wget {{https://example.com/file}}` + +- Ignore lid close switch until the script exits: + +`systemd-inhibit --what sleep:handle-lid-switch {{path/to/script}}` + +- Ignore power button press while command is running: + +`systemd-inhibit --what handle-power-key {{command}}` + +- Describe who and why created the inhibitor (default: the command and its arguments for `--who` and `Unknown reason` for `--why`): + +`systemd-inhibit --who {{$USER}} --why {{reason}} --what {{operation}} {{command}}` diff --git a/linux/systemd-machine-id-setup b/linux/systemd-machine-id-setup new file mode 100644 index 00000000..674d3e12 --- /dev/null +++ b/linux/systemd-machine-id-setup @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-machine-id-setup + +> Initialize the machine ID stored in `/etc/machine-id` at install time with a provisioned or randomly generated ID. +> Note: Always use `sudo` to execute these commands as they require elevated privileges. +> More information: . + +- Print the generated or committed machine ID: + +`systemd-machine-id-setup --print` + +- Specify an image policy: + +`systemd-machine-id-setup --image-policy={{your_policy}}` + +- Display the output as JSON: + +`sudo systemd-machine-id-setup --json=pretty` + +- Operate on a disk image instead of a directory tree: + +`systemd-machine-id-setup --image={{/path/to/image}}` diff --git a/linux/systemd-mount b/linux/systemd-mount new file mode 100644 index 00000000..a3d74f8e --- /dev/null +++ b/linux/systemd-mount @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-mount + +> Establish and destroy transient mount or auto-mount points. +> More information: . + +- Mount a file system (image or block device) at `/run/media/system/LABEL` where LABEL is the filesystem label or the device name if there is no label: + +`systemd-mount {{path/to/file_or_device}}` + +- Mount a file system (image or block device) at a specific location: + +`systemd-mount {{path/to/file_or_device}} {{path/to/mount_point}}` + +- List all local, known block devices with file systems that may be mounted: + +`systemd-mount --list` + +- Create an automount point that mounts the actual file system at the time of first access: + +`systemd-mount --automount=yes {{path/to/file_or_device}}` + +- Unmount one or more devices: + +`systemd-mount --umount {{path/to/mount_point_or_device1}} {{path/to/mount_point_or_device2}}` + +- Mount a file system (image or block device) with a specific file system type: + +`systemd-mount --type={{file_system_type}} {{path/to/file_or_device}} {{path/to/mount_point}}` + +- Mount a file system (image or block device) with additional mount options: + +`systemd-mount --options={{mount_options}} {{path/to/file_or_device}} {{path/to/mount_point}}` diff --git a/linux/systemd-notify b/linux/systemd-notify new file mode 100644 index 00000000..8a5efb45 --- /dev/null +++ b/linux/systemd-notify @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-notify + +> Notify the service manager about start-up completion and other daemon status changes. +> This command is useless outside systemd service scripts. +> More information: . + +- Notify systemd that the service has completed its initialization and is fully started. It should be invoked when the service is ready to accept incoming requests: + +`systemd-notify --booted` + +- Signal to systemd that the service is ready to handle incoming connections or perform its tasks: + +`systemd-notify --ready` + +- Provide a custom status message to systemd (this information is shown by `systemctl status`): + +`systemd-notify --status="{{Add custom status message here...}}"` diff --git a/linux/systemd-nspawn b/linux/systemd-nspawn new file mode 100644 index 00000000..662fd44d --- /dev/null +++ b/linux/systemd-nspawn @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-nspawn + +> Spawn a command or OS in a lightweight container. +> More information: . + +- Run a command in a container: + +`systemd-nspawn --directory {{path/to/container_root}}` + +- Run a full Linux-based OS in a container: + +`systemd-nspawn --boot --directory {{path/to/container_root}}` + +- Run the specified command as PID 2 in the container (as opposed to PID 1) using a stub init process: + +`systemd-nspawn --directory {{path/to/container_root}} --as-pid2` + +- Specify the machine name and hostname: + +`systemd-nspawn --machine={{container_name}} --hostname={{container_host}} --directory {{path/to/container_root}}` diff --git a/linux/systemd-path b/linux/systemd-path new file mode 100644 index 00000000..4dd0606c --- /dev/null +++ b/linux/systemd-path @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-path + +> List and query system and user paths. +> More information: . + +- Display a list of known paths and their current values: + +`systemd-path` + +- Query the specified path and display its value: + +`systemd-path "{{path_name}}"` + +- Suffix printed paths with `suffix_string`: + +`systemd-path --suffix {{suffix_string}}` + +- Print a short version string and then exit: + +`systemd-path --version` diff --git a/linux/systemd-repart b/linux/systemd-repart new file mode 100644 index 00000000..cbc9d6e4 --- /dev/null +++ b/linux/systemd-repart @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-repart + +> Automatically grow and add partitions. +> Grows and adds partitions based on the configuration files described in repart.d. +> Does not automatically resize file system on partition. See systemd-growfs to extend file system. +> More information: . + +- Grow the root partition (/) to all available disk space: + +`systemd-repart` + +- View changes without applying: + +`systemd-repart --dry-run=yes` + +- Grow root partition size to 10 gigabytes: + +`systemd-repart --size=10G --root /` diff --git a/linux/systemd-resolve b/linux/systemd-resolve new file mode 100644 index 00000000..9b527a53 --- /dev/null +++ b/linux/systemd-resolve @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-resolve + +> Resolve domain names, IPV4 and IPv6 addresses, DNS resource records, and services. +> Note: this tool has been renamed to `resolvectl` in new versions of `systemd`. +> More information: . + +- View documentation for `resolvectl`: + +`tldr resolvectl` diff --git a/linux/systemd-run b/linux/systemd-run new file mode 100644 index 00000000..ba1aa3d7 --- /dev/null +++ b/linux/systemd-run @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-run + +> Run programs in transient scope units, service units, or path-, socket-, or timer-triggered service units. +> More information: . + +- Start a transient service: + +`sudo systemd-run {{command}} {{argument1 argument2 ...}}` + +- Start a transient service under the service manager of the current user (no privileges): + +`systemd-run --user {{command}} {{argument1 argument2 ...}}` + +- Start a transient service with a custom unit name and description: + +`sudo systemd-run --unit={{name}} --description={{string}} {{command}} {{argument1 argument2 ...}}` + +- Start a transient service that does not get cleaned up after it terminates with a custom environment variable: + +`sudo systemd-run --remain-after-exit --set-env={{name}}={{value}} {{command}} {{argument1 argument2 ...}}` + +- Start a transient timer that periodically runs its transient service (see `man systemd.time` for calendar event format): + +`sudo systemd-run --on-calendar={{calendar_event}} {{command}} {{argument1 argument2 ...}}` + +- Share the terminal with the program (allowing interactive input/output) and make sure the execution details remain after the program exits: + +`systemd-run --remain-after-exit --pty {{command}}` + +- Set properties (e.g. CPUQuota, MemoryMax) of the process and wait until it exits: + +`systemd-run --property MemoryMax={{memory_in_bytes}} --property CPUQuota={{percentage_of_CPU_time}}% --wait {{command}}` + +- Use the program in a shell pipeline: + +`{{command1}} | systemd-run --pipe {{command2}} | {{command3}}` diff --git a/linux/systemd-socket-activate b/linux/systemd-socket-activate new file mode 100644 index 00000000..1610cbbe --- /dev/null +++ b/linux/systemd-socket-activate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-socket-activate + +> Socket activation for systemd services. +> More information: . + +- Activate a service when a specific socket is connected: + +`systemd-socket-activate {{path/to/socket.service}}` + +- Activate multiple sockets for a service: + +`systemd-socket-activate {{path/to/socket1.service}} {{path/to/socket2.service}}` + +- Pass environment variables to the service being activated: + +`{{SYSTEMD_SOCKET_ACTIVATION=1}} systemd-socket-activate {{path/to/socket.service}}` + +- Activate a service along with a notification socket: + +`systemd-socket-activate {{path/to/socket.socket}} {{path/to/service.service}}` + +- Activate a service with a specified port: + +`systemd-socket-activate {{path/to/socket.service}} -l {{8080}}` diff --git a/linux/systemd-stdio-bridge b/linux/systemd-stdio-bridge new file mode 100644 index 00000000..06664def --- /dev/null +++ b/linux/systemd-stdio-bridge @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-stdio-bridge + +> Implement a proxy between `stdin`/`stdout` and a D-Bus. +> Note: It expects to receive an open connection via `stdin`/`stdout` when started, and will create a new connection to the specified bus. +> More information: . + +- Forward `stdin`/`stdout` to the local system bus: + +`systemd-stdio-bridge` + +- Forward `stdin`/`stdout` to a specific user's D-Bus: + +`systemd-stdio-bridge --{{user}}` + +- Forward `stdin`/`stdout` to the local system bus within a specific container: + +`systemd-stdio-bridge --machine={{mycontainer}}` + +- Forward `stdin`/`stdout` to a custom D-Bus address: + +`systemd-stdio-bridge --bus-path=unix:path={{/custom/dbus/socket}}` diff --git a/linux/systemd-sysext b/linux/systemd-sysext new file mode 100644 index 00000000..bc23ec07 --- /dev/null +++ b/linux/systemd-sysext @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-sysext + +> Activate or deactivate system extension images. +> More information: . + +- List installed extension images: + +`systemd-sysext list` + +- Merge system extension images into `/usr/` and `/opt/`: + +`systemd-sysext merge` + +- Check the current merge status: + +`systemd-sysext status` + +- Unmerge all currently installed system extension images from `/usr/` and `/opt/`: + +`systemd-sysext unmerge` + +- Refresh system extension images (a combination of `unmerge` and `merge`): + +`systemd-sysext refresh` diff --git a/linux/systemd-sysusers b/linux/systemd-sysusers new file mode 100644 index 00000000..3982b782 --- /dev/null +++ b/linux/systemd-sysusers @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-sysusers + +> Create system users and groups. +> If the config file is not specified, files in the `sysusers.d` directories are used. +> More information: . + +- Create users and groups from a specific configuration file: + +`systemd-sysusers {{path/to/file}}` + +- Process configuration files and print what would be done without actually doing anything: + +`systemd-sysusers --dry-run {{path/to/file}}` + +- Print the contents of all configuration files (before each file, its name is printed as a comment): + +`systemd-sysusers --cat-config` diff --git a/linux/systemd-tmpfiles b/linux/systemd-tmpfiles new file mode 100644 index 00000000..5470f369 --- /dev/null +++ b/linux/systemd-tmpfiles @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-tmpfiles + +> Create, delete and clean up volatile and temporary files and directories. +> This command is automatically invoked on boot by systemd services, and running it manually is usually not needed. +> More information: . + +- Create files and directories as specified in the configuration: + +`systemd-tmpfiles --create` + +- Clean up files and directories with age parameters configured: + +`systemd-tmpfiles --clean` + +- Remove files and directories as specified in the configuration: + +`systemd-tmpfiles --remove` + +- Apply operations for user-specific configurations: + +`systemd-tmpfiles --create --user` + +- Execute lines marked for early boot: + +`systemd-tmpfiles --create --boot` diff --git a/linux/systemd-tty-ask-password-agent b/linux/systemd-tty-ask-password-agent new file mode 100644 index 00000000..431e99ff --- /dev/null +++ b/linux/systemd-tty-ask-password-agent @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-tty-ask-password-agent + +> List or process pending systemd password requests. +> More information: . + +- List all currently pending system password requests: + +`systemd-tty-ask-password-agent --list` + +- Continuously process password requests: + +`systemd-tty-ask-password-agent --watch` + +- Process all currently pending system password requests by querying the user on the calling TTY: + +`systemd-tty-ask-password-agent --query` + +- Forward password requests to wall instead of querying the user on the calling TTY: + +`systemd-tty-ask-password-agent --wall` diff --git a/linux/systemd-umount b/linux/systemd-umount new file mode 100644 index 00000000..60df3763 --- /dev/null +++ b/linux/systemd-umount @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemd-umount + +> This command is an alias of `systemd-mount --umount`. + +- View documentation for the original command: + +`tldr systemd-mount` diff --git a/linux/tac b/linux/tac new file mode 100644 index 00000000..1a3cf7d1 --- /dev/null +++ b/linux/tac @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tac + +> Display and concatenate files with lines in reversed order. +> See also: `cat`. +> More information: . + +- Concatenate specific files in reversed order: + +`tac {{path/to/file1 path/to/file2 ...}}` + +- Display `stdin` in reversed order: + +`{{cat path/to/file}} | tac` + +- Use a specific separator: + +`tac --separator {{,}} {{path/to/file1 path/to/file2 ...}}` + +- Use a specific regex as a separator: + +`tac --regex --separator {{[,;]}} {{path/to/file1 path/to/file2 ...}}` + +- Use a separator before each file: + +`tac --before {{path/to/file1 path/to/file2 ...}}` diff --git a/linux/tailf b/linux/tailf new file mode 100644 index 00000000..d2c1fbfe --- /dev/null +++ b/linux/tailf @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tailf + +> This command is superseded by `tail -f`. +> More information: . + +- View documentation for the recommended replacement: + +`tldr tail` diff --git a/linux/talk b/linux/talk new file mode 100644 index 00000000..6717a7ed --- /dev/null +++ b/linux/talk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +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: . + +- Start a talk session with a user on the same machine: + +`talk {{username}}` + +- Start a talk session with a user on the same machine, who is logged in on tty3: + +`talk {{username}} {{tty3}}` + +- Start a talk session with a user on a remote machine: + +`talk {{username}}@{{hostname}}` + +- Clear text on both terminal screens: + +`+D` + +- Exit the talk session: + +`+C` diff --git a/linux/taskset b/linux/taskset new file mode 100644 index 00000000..783808cd --- /dev/null +++ b/linux/taskset @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# taskset + +> Get or set a process' CPU affinity or start a new process with a defined CPU affinity. +> More information: . + +- Get a running process' CPU affinity by PID: + +`taskset --pid --cpu-list {{pid}}` + +- Set a running process' CPU affinity by PID: + +`taskset --pid --cpu-list {{cpu_id}} {{pid}}` + +- Start a new process with affinity for a single CPU: + +`taskset --cpu-list {{cpu_id}} {{command}}` + +- Start a new process with affinity for multiple non-sequential CPUs: + +`taskset --cpu-list {{cpu_id_1}},{{cpu_id_2}},{{cpu_id_3}}` + +- Start a new process with affinity for CPUs 1 through 4: + +`taskset --cpu-list {{cpu_id_1}}-{{cpu_id_4}}` diff --git a/linux/tc b/linux/tc new file mode 100644 index 00000000..d0c7ed12 --- /dev/null +++ b/linux/tc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tc + +> Show/manipulate traffic control settings. +> More information: . + +- Add constant network delay to outbound packages: + +`tc qdisc add dev {{eth0}} root netem delay {{delay_in_milliseconds}}ms` + +- Add normal distributed network delay to outbound packages: + +`tc qdisc add dev {{eth0}} root netem delay {{mean_delay_ms}}ms {{delay_std_ms}}ms` + +- Add package corruption/loss/duplication to a portion of packages: + +`tc qdisc add dev {{eth0}} root netem {{corruption|loss|duplication}} {{effect_percentage}}%` + +- Limit bandwidth, burst rate and max latency: + +`tc qdisc add dev eth0 root tbf rate {{max_bandwidth_mb}}mbit burst {{max_burst_rate_kb}}kbit latency {{max_latency_before_drop_ms}}ms` + +- Show active traffic control policies: + +`tc qdisc show dev {{eth0}}` + +- Delete all traffic control rules: + +`tc qdisc del dev {{eth0}}` + +- Change traffic control rule: + +`tc qdisc change dev {{eth0}} root netem {{policy}} {{policy_parameters}}` diff --git a/linux/tcpflow b/linux/tcpflow new file mode 100644 index 00000000..0b378896 --- /dev/null +++ b/linux/tcpflow @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tcpflow + +> Capture TCP traffic for debugging and analysis. +> More information: . + +- Show all data on the given interface and port: + +`tcpflow -c -i {{eth0}} port {{80}}` diff --git a/linux/tcpick b/linux/tcpick new file mode 100644 index 00000000..4d836729 --- /dev/null +++ b/linux/tcpick @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tcpick + +> Packet sniffing and network traffic analysis tool. +> It can capture and display TCP connections and data. It can also monitor network traffic on a interface, host, or port. +> More information: . + +- Capture traffic on a specific [i]nterface, port and host:: + +`sudo tcpick -i {{interface}} -C -h {{host}} -p {{port}}` + +- Capture traffic on port 80 (HTTP) of a specific host: + +`sudo tcpick -i {{eth0}} -C -h {{192.168.1.100}} -p {{80}}` + +- Display help: + +`tcpick --help` diff --git a/linux/tcpkill b/linux/tcpkill new file mode 100644 index 00000000..09d595f8 --- /dev/null +++ b/linux/tcpkill @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tcpkill + +> Kills specified in-progress TCP connections. +> More information: . + +- Kill in-progress connections at a specified interface, host and port: + +`tcpkill -i {{eth1}} host {{192.95.4.27}} and port {{2266}}` diff --git a/linux/tcptraceroute b/linux/tcptraceroute new file mode 100644 index 00000000..4918c8d3 --- /dev/null +++ b/linux/tcptraceroute @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tcptraceroute + +> A traceroute implementation using TCP packets. +> More information: . + +- Trace the route to a host: + +`tcptraceroute {{host}}` + +- Specify the destination port and packet length in bytes: + +`tcptraceroute {{host}} {{destination_port}} {{packet_length}}` + +- Specify the local source port and source address: + +`tcptraceroute {{host}} -p {{source_port}} -s {{source_address}}` + +- Set the first and maximum TTL: + +`tcptraceroute {{host}} -f {{first_ttl}} -m {{max_ttl}}` + +- Specify the wait time and number of queries per hop: + +`tcptraceroute {{host}} -w {{wait_time}} -q {{number_of_queries}}` + +- Specify the interface: + +`tcptraceroute {{host}} -i {{interface}}` diff --git a/linux/telinit b/linux/telinit new file mode 100644 index 00000000..d2c2119a --- /dev/null +++ b/linux/telinit @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# telinit + +> Change SysV runlevel. +> Since the concept SysV runlevels is obsolete the runlevel requests will be transparently translated into systemd unit activation requests. +> More information: . + +- Power off the machine: + +`telinit 0` + +- Reboot the machine: + +`telinit 6` + +- Change SysV run level: + +`telinit {{2|3|4|5}}` + +- Change to rescue mode: + +`telinit 1` + +- Reload daemon configuration: + +`telinit q` + +- Do not send a wall message before reboot/power-off (6/0): + +`telinit --no-wall {{value}}` diff --git a/linux/terminator b/linux/terminator new file mode 100644 index 00000000..111f8af4 --- /dev/null +++ b/linux/terminator @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# terminator + +> Arrange multiple GNOME terminals in one window. +> More information: . + +- Start `terminator` window: + +`terminator` + +- Start with a fullscreen window: + +`terminator -f` + +- Split terminals horizontally: + +` + + O` + +- Split terminals vertically: + +` + + E` + +- Open new tab: + +` + + T` diff --git a/linux/termusic b/linux/termusic new file mode 100644 index 00000000..c87fc379 --- /dev/null +++ b/linux/termusic @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# termusic + +> A terminal music player written in Rust that uses vim-like key bindings. +> More information: . + +- Open termusic to a specific directory. (It can be set permanently in `~/.config/termusic/config.toml`): + +`termusic {path/to/directory}` + +- Disable showing the album cover for a specific file: + +`termusic -c {path/to/music_file}` + +- Display help: + +`termusic --help` diff --git a/linux/tftp b/linux/tftp new file mode 100644 index 00000000..702b3b75 --- /dev/null +++ b/linux/tftp @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tftp + +> Trivial File Transfer Protocol client. +> More information: . + +- Connect to a TFTP server specifying its IP address and port: + +`tftp {{server_ip}} {{port}}` + +- Connect to a TFTP server and execute a TFTP [c]ommand: + +`tftp {{server_ip}} -c {{command}}` + +- Connect to a TFTP server using IPv6 and force originating port to be in [R]ange: + +`tftp {{server_ip}} -6 -R {{port}}:{{port}}` + +- Set the transfer mode to binary or ascii through the tftp client: + +`mode {{binary|ascii}}` + +- Download file from a server through the tftp client: + +`get {{file}}` + +- Upload file to a server through the tftp client: + +`put {{file}}` + +- Exit the tftp client: + +`quit` diff --git a/linux/thunar b/linux/thunar new file mode 100644 index 00000000..5f5158c0 --- /dev/null +++ b/linux/thunar @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# thunar + +> Graphical file manager for XFCE desktop environments. +> More information: . + +- Open a new window showing the current directory: + +`thunar` + +- Open the bulk rename utility: + +`thunar --bulk-rename` + +- Close all open thunar windows: + +`thunar --quit` diff --git a/linux/tic b/linux/tic new file mode 100644 index 00000000..58aa4301 --- /dev/null +++ b/linux/tic @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tic + +> Compile terminfo and install for ncurses. +> More information: . + +- Compile and install terminfo for a terminal: + +`tic -xe {{terminal}} {{path/to/terminal.info}}` + +- Check terminfo file for errors: + +`tic -c {{path/to/terminal.info}}` + +- Print database locations: + +`tic -D` diff --git a/linux/timedatectl b/linux/timedatectl new file mode 100644 index 00000000..a2e16759 --- /dev/null +++ b/linux/timedatectl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# timedatectl + +> Control the system time and date. +> More information: . + +- Check the current system clock time: + +`timedatectl` + +- Set the local time of the system clock directly: + +`timedatectl set-time "{{yyyy-MM-dd hh:mm:ss}}"` + +- List available timezones: + +`timedatectl list-timezones` + +- Set the system timezone: + +`timedatectl set-timezone {{timezone}}` + +- Enable Network Time Protocol (NTP) synchronization: + +`timedatectl set-ntp on` + +- Change the hardware clock time standard to localtime: + +`timedatectl set-local-rtc 1` diff --git a/linux/timeshift b/linux/timeshift new file mode 100644 index 00000000..27de2deb --- /dev/null +++ b/linux/timeshift @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# timeshift + +> System restore utility. +> More information: . + +- List snapshots: + +`sudo timeshift --list` + +- Create a new snapshot (if scheduled): + +`sudo timeshift --check` + +- Create a new snapshot (even if not scheduled): + +`sudo timeshift --create` + +- Restore a snapshot (selecting which snapshot to restore interactively): + +`sudo timeshift --restore` + +- Restore a specific snapshot: + +`sudo timeshift --restore --snapshot '{{snapshot}}'` + +- Delete a specific snapshot: + +`sudo timeshift --delete --snapshot '{{snapshot}}'` diff --git a/linux/tlp b/linux/tlp new file mode 100644 index 00000000..7096d58e --- /dev/null +++ b/linux/tlp @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tlp + +> Advanced power management for Linux. +> See also `tlp-stat`. +> More information: . + +- Apply settings (according to the actual power source): + +`sudo tlp start` + +- Apply battery settings (ignoring the actual power source): + +`sudo tlp bat` + +- Apply AC settings (ignoring the actual power source): + +`sudo tlp ac` diff --git a/linux/tlp-stat b/linux/tlp-stat new file mode 100644 index 00000000..cc55aa9d --- /dev/null +++ b/linux/tlp-stat @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tlp-stat + +> Generate TLP status reports. +> See also `tlp`. +> More information: . + +- Generate status report with configuration and all active settings: + +`sudo tlp-stat` + +- Show battery information: + +`sudo tlp-stat -b` + +- Show configuration: + +`sudo tlp-stat -c` diff --git a/linux/tod b/linux/tod new file mode 100644 index 00000000..6a798b23 --- /dev/null +++ b/linux/tod @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tod + +> A tiny Todoist client in Rust. +> It takes simple input and dumps it in your inbox or another project. Taking advantage of natural language processing to assign due dates, tags, etc. +> More information: . + +- Import your projects (this is necessary to enable project prompts): + +`tod project import` + +- Quickly create a task with due date: + +`tod --quickadd {{Buy more milk today}}` + +- Create a new task (you will be prompted for content and project): + +`tod task create` + +- Create a task in a project: + +`tod task create --content "{{Write more rust}}" --project {{code}}` + +- Get the next task for a project: + +`tod task next` + +- Get your work schedule: + +`tod task list --scheduled --project {{work}}` + +- Get all tasks for work: + +`tod task list --project {{work}}` diff --git a/linux/toilet b/linux/toilet new file mode 100644 index 00000000..86655f4b --- /dev/null +++ b/linux/toilet @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toilet + +> Display ASCII-art fonts. +> More information: . + +- Generate ASCII art for a given text: + +`toilet {{input_text}}` + +- Generate ASCII art using a custom font file: + +`toilet {{input_text}} -f {{font_filename}}` + +- Generate ASCII art using a filter: + +`toilet {{input_text}} --filter {{filter_name}}` + +- Show available toilet filters: + +`toilet --filter list` diff --git a/linux/tomb b/linux/tomb new file mode 100644 index 00000000..ef11903c --- /dev/null +++ b/linux/tomb @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tomb + +> Manage encrypted storage directories that can be safely transported and hidden in a filesystem. +> More information: . + +- Create a new tomb with an initial size of 100 MB: + +`tomb dig -s {{100}} {{encrypted_directory.tomb}}` + +- Create a new key file that can be used to lock a tomb; user will be prompted for a password for the key: + +`tomb forge {{encrypted_directory.tomb.key}}` + +- Forcefully create a new key, even if the tomb isn't allowing key forging (due to swap): + +`tomb forge {{encrypted_directory.tomb.key}} -f` + +- Initialize and lock an empty tomb using a key made with `forge`: + +`tomb lock {{encrypted_directory.tomb}} -k {{encrypted_directory.tomb.key}}` + +- Mount a tomb (by default in `/media`) using its key, making it usable as a regular filesystem directory: + +`tomb open {{encrypted_directory.tomb}} -k {{encrypted_directory.tomb.key}}` + +- Close a tomb (fails if the tomb is being used by a process): + +`tomb close {{encrypted_directory.tomb}}` + +- Forcefully close all open tombs, killing any applications using them: + +`tomb slam all` + +- List all open tombs: + +`tomb list` diff --git a/linux/toolbox b/linux/toolbox new file mode 100644 index 00000000..24c38f2c --- /dev/null +++ b/linux/toolbox @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox + +> Manage containerized command-line environments on Linux. +> Some subcommands such as `toolbox create` have their own usage documentation. +> More information: . + +- Run a `toolbox` subcommand: + +`toolbox {{subcommand}}` + +- Display help for a specific subcommand (such as `create`, `enter`, `rm`, `rmi`, etc.): + +`toolbox help {{subcommand}}` + +- Display help: + +`toolbox --help` + +- Display version: + +`toolbox --version` diff --git a/linux/toolbox-create b/linux/toolbox-create new file mode 100644 index 00000000..bfa3f17c --- /dev/null +++ b/linux/toolbox-create @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox create + +> Create a new `toolbox` container. +> More information: . + +- Create a `toolbox` container for a specific distribution: + +`toolbox create --distro {{distribution}}` + +- Create a `toolbox` container for a specific release of the current distribution: + +`toolbox create --release {{release}}` + +- Create a `toolbox` container with a custom image: + +`toolbox create --image {{name}}` + +- Create a `toolbox` container from a custom Fedora image: + +`toolbox create --image {{registry.fedoraproject.org/fedora-toolbox:39}}` + +- Create a `toolbox` container using the default image for Fedora 39: + +`toolbox create --distro {{fedora}} --release {{f39}}` diff --git a/linux/toolbox-enter b/linux/toolbox-enter new file mode 100644 index 00000000..5a0e5085 --- /dev/null +++ b/linux/toolbox-enter @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox enter + +> Enter a `toolbox` container for interactive use. +> See also: `toolbox run`. +> More information: . + +- Enter a `toolbox` container using the default image of a specific distribution: + +`toolbox enter --distro {{distribution}}` + +- Enter a `toolbox` container using the default image of a specific release of the current distribution: + +`toolbox enter --release {{release}}` + +- Enter a toolbox container using the default image for Fedora 39: + +`toolbox enter --distro {{fedora}} --release {{f39}}` diff --git a/linux/toolbox-help b/linux/toolbox-help new file mode 100644 index 00000000..0102ff08 --- /dev/null +++ b/linux/toolbox-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox help + +> Displays help information about `toolbox`. +> More information: . + +- Display the `toolbox` manual: + +`toolbox help` + +- Display the `toolbox` manual for a specific subcommand: + +`toolbox help {{subcommand}}` diff --git a/linux/toolbox-init-container b/linux/toolbox-init-container new file mode 100644 index 00000000..06f87c69 --- /dev/null +++ b/linux/toolbox-init-container @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox init-container + +> Initialize a running `toolbox` container. +> This command should not be executed by the user, and cannot be run on the host. +> More information: . + +- Initialize a running toolbox: + +`toolbox init-container --gid {{gid}} --home {{home}} --home-link --media-link --mnt-link --monitor-host --shell {{shell}} --uid {{uid}} --user {{user}}` diff --git a/linux/toolbox-list b/linux/toolbox-list new file mode 100644 index 00000000..5f026ffd --- /dev/null +++ b/linux/toolbox-list @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox list + +> List existing `toolbox` containers and images. +> More information: . + +- List all `toolbox` containers and images: + +`toolbox list` + +- List only `toolbox` containers: + +`toolbox list --containers` + +- List only `toolbox` images: + +`toolbox list --images` diff --git a/linux/toolbox-rm b/linux/toolbox-rm new file mode 100644 index 00000000..14065a6b --- /dev/null +++ b/linux/toolbox-rm @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox rm + +> Remove one or more `toolbox` containers. +> See also: `toolbox rmi`. +> More information: . + +- Remove a toolbox container: + +`toolbox rm {{container_name}}` + +- Remove all `toolbox` containers: + +`toolbox rm --all` + +- Force the removal of a currently active `toolbox` container: + +`toolbox rm --force {{container_name}}` diff --git a/linux/toolbox-rmi b/linux/toolbox-rmi new file mode 100644 index 00000000..4a181ffd --- /dev/null +++ b/linux/toolbox-rmi @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox rmi + +> Remove `toolbox` images. +> See also: `toolbox rm`. +> More information: . + +- Remove one or more `toolbox` image: + +`toolbox rmi {{image_name1 image_name2 ...}}` + +- Remove all `toolbox` images: + +`toolbox rmi --all` + +- Force the removal of a `toolbox` image which is currently being used by a container (the container will be removed as well): + +`toolbox rmi --force {{image_name}}` diff --git a/linux/toolbox-run b/linux/toolbox-run new file mode 100644 index 00000000..f3e2ea48 --- /dev/null +++ b/linux/toolbox-run @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# toolbox run + +> Run a command in an existing `toolbox` container. +> See also: `toolbox enter`. +> More information: . + +- Run a command inside a specific `toolbox` container: + +`toolbox run --container {{container_name}} {{command}}` + +- Run a command inside a `toolbox` container for a specific release of a distribution: + +`toolbox run --distro {{distribution}} --release {{release}} {{command}}` + +- Run `emacs` inside a `toolbox` container using the default image for Fedora 39: + +`toolbox run --distro {{fedora}} --release {{f39}} {{emacs}}` diff --git a/linux/top b/linux/top new file mode 100644 index 00000000..a0771df4 --- /dev/null +++ b/linux/top @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# top + +> Display dynamic real-time information about running processes. +> More information: . + +- Start `top`: + +`top` + +- Do not show any idle or zombie processes: + +`top -i` + +- Show only processes owned by given user: + +`top -u {{username}}` + +- Sort processes by a field: + +`top -o {{field_name}}` + +- Show the individual threads of a given process: + +`top -Hp {{process_id}}` + +- Show only the processes with the given PID(s), passed as a comma-separated list. (Normally you wouldn't know PIDs off hand. This example picks the PIDs from the process name): + +`top -p $(pgrep -d ',' {{process_name}})` + +- Display help about interactive commands: + +`?` diff --git a/linux/trace-cmd b/linux/trace-cmd new file mode 100644 index 00000000..14935f05 --- /dev/null +++ b/linux/trace-cmd @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trace-cmd + +> Utility to interact with the Ftrace Linux kernel internal tracer. +> This utility only runs as root. +> More information: . + +- Display the status of tracing system: + +`trace-cmd stat` + +- List available tracers: + +`trace-cmd list -t` + +- Start tracing with a specific plugin: + +`trace-cmd start -p {{timerlat|osnoise|hwlat|blk|mmiotrace|function_graph|wakeup_dl|wakeup_rt|wakeup|function|nop}}` + +- View the trace output: + +`trace-cmd show` + +- Stop the tracing but retain the buffers: + +`trace-cmd stop` + +- Clear the trace buffers: + +`trace-cmd clear` + +- Clear the trace buffers and stop tracing: + +`trace-cmd reset` diff --git a/linux/tracepath b/linux/tracepath new file mode 100644 index 00000000..a315b1f5 --- /dev/null +++ b/linux/tracepath @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tracepath + +> Trace the path to a network host discovering MTU along this path. +> More information: . + +- A preferred way to trace the path to a host: + +`tracepath -p {{33434}} {{host}}` + +- Specify the initial destination port, useful with non-standard firewall settings: + +`tracepath -p {{destination_port}} {{host}}` + +- Print both hostnames and numerical IP addresses: + +`tracepath -b {{host}}` + +- Specify a maximum TTL (number of hops): + +`tracepath -m {{max_hops}} {{host}}` + +- Specify the initial packet length (defaults to 65535 for IPv4 and 128000 for IPv6): + +`tracepath -l {{packet_length}} {{host}}` + +- Use only IPv6 addresses: + +`tracepath -6 {{host}}` diff --git a/linux/trap b/linux/trap new file mode 100644 index 00000000..82d2712d --- /dev/null +++ b/linux/trap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trap + +> Execute a command upon an event. +> More information: . + +- List the available event names (e.g. `SIGWINCH`): + +`trap -l` + +- List the commands and the names of the expected events: + +`trap -p` + +- Execute a command when a signal is received: + +`trap 'echo "Caught signal {{SIGHUP}}"' {{SIGHUP}}` + +- Remove commands: + +`trap - {{SIGHUP}} {{SIGINT}}` diff --git a/linux/trash b/linux/trash new file mode 100644 index 00000000..4168a652 --- /dev/null +++ b/linux/trash @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trash + +> Manage the trashcan/recycling bin. +> More information: . + +- Delete a file and send it to the trash: + +`trash {{path/to/file}}` + +- List all files in the trash: + +`trash-list` + +- Interactively restore a file from the trash: + +`trash-restore` + +- Empty the trash: + +`trash-empty` + +- Permanently delete all files in the trash which are older than 10 days: + +`trash-empty {{10}}` + +- Remove all files in the trash, which match a specific blob pattern: + +`trash-rm "{{*.o}}"` + +- Remove all files with a specific original location: + +`trash-rm {{/path/to/file_or_directory}}` diff --git a/linux/trashy b/linux/trashy new file mode 100644 index 00000000..e804998c --- /dev/null +++ b/linux/trashy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trashy + +> An alternative to `rm` and `trash-cli` written in Rust. +> More information: . + +- Move a specific file to the trash: + +`trash {{path/to/file}}` + +- Move specific files to the trash: + +`trash {{path/to/file1 path/to/file2 ...}}` + +- List items in the trash: + +`trash list` + +- Restore a specific file from the trash: + +`trash restore {{file}}` + +- Remove a specific file from the trash: + +`trash empty {{file}}` + +- Restore all files from the trash: + +`trash restore --all` + +- Remove all files from the trash: + +`trash empty --all` diff --git a/linux/trayer b/linux/trayer new file mode 100644 index 00000000..613420d2 --- /dev/null +++ b/linux/trayer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trayer + +> A lightweight GTK-2 based systray. +> More information: . + +- Run `trayer`: + +`trayer` + +- Position `trayer` to a specific edge: + +`trayer --edge {{left|right|top|bottom}}` + +- Provide a specific height and width of the panel (in pixels): + +`trayer --width {{10}} --height {{32}}` + +- Provide the width of the panel in pixels or percentages: + +`trayer --widthtype {{pixel|percent}} --width {{72}}` + +- Align `trayer` to a specific direction: + +`trayer --align {{left|center|right}}` + +- Provide spacing between icons (in pixels): + +`trayer --iconspacing {{10}}` diff --git a/linux/treetime b/linux/treetime new file mode 100644 index 00000000..10286ffb --- /dev/null +++ b/linux/treetime @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# treetime + +> TreeTime provides routines for ancestral sequence reconstruction and inference of molecular-clock phylogenies. +> More information: . + +- Infer ancestral sequences maximizing the joint or marginal likelihood: + +`treetime ancestral` + +- Analyze patterns of recurrent mutations aka homoplasies: + +`treetime homoplasy` + +- Estimate molecular clock parameters and reroot the tree: + +`treetime clock` + +- Map discrete character such as host or country to the tree: + +`treetime mugration` diff --git a/linux/trizen b/linux/trizen new file mode 100644 index 00000000..1ab93dc7 --- /dev/null +++ b/linux/trizen @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trizen + +> Arch Linux utility for building packages from the Arch User Repository (AUR). +> More information: . + +- Synchronize and update all AUR packages: + +`trizen -Syua` + +- Install a new package: + +`trizen -S {{package}}` + +- Remove a package and its dependencies: + +`trizen -Rs {{package}}` + +- Search the package database for a keyword: + +`trizen -Ss {{keyword}}` + +- Show information about a package: + +`trizen -Si {{package}}` + +- List installed packages and versions: + +`trizen -Qe` diff --git a/linux/trust b/linux/trust new file mode 100644 index 00000000..5d8c7c07 --- /dev/null +++ b/linux/trust @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# trust + +> Operate on the trust policy store. +> More information: . + +- List trust policy store items: + +`trust list` + +- List information about specific items in the trust policy store: + +`trust list --filter={{blocklist|ca-anchors|certificates|trust-policy}}` + +- Store a specific trust anchor in the trust policy store: + +`trust anchor {{path/to/certificate.crt}}` + +- Remove a specific anchor from the trust policy store: + +`trust anchor --remove {{path/to/certificate.crt}}` + +- Extract trust policy from the shared trust policy store: + +`trust extract --format=x509-directory --filter=ca-anchors {{path/to/directory}}` + +- Display help for a subcommand: + +`trust {{subcommand}} --help` diff --git a/linux/tshark b/linux/tshark new file mode 100644 index 00000000..105a2846 --- /dev/null +++ b/linux/tshark @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tshark + +> Packet analysis tool, CLI version of Wireshark. +> More information: . + +- Monitor everything on localhost: + +`tshark` + +- Only capture packets matching a specific capture filter: + +`tshark -f '{{udp port 53}}'` + +- Only show packets matching a specific output filter: + +`tshark -Y '{{http.request.method == "GET"}}'` + +- Decode a TCP port using a specific protocol (e.g. HTTP): + +`tshark -d tcp.port=={{8888}},{{http}}` + +- Specify the format of captured output: + +`tshark -T {{json|text|ps|…}}` + +- Select specific fields to output: + +`tshark -T {{fields|ek|json|pdml}} -e {{http.request.method}} -e {{ip.src}}` + +- Write captured packet to a file: + +`tshark -w {{path/to/file}}` + +- Analyze packets from a file: + +`tshark -r {{path/to/file.pcap}}` diff --git a/linux/ttyplot b/linux/ttyplot new file mode 100644 index 00000000..7cd6e0db --- /dev/null +++ b/linux/ttyplot @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ttyplot + +> A realtime plotting utility for the command-line with data input from `stdin`. +> More information: . + +- Plot the values `1`, `2` and `3` (`cat` prevents ttyplot to exit): + +`{ echo {{1 2 3}}; cat } | ttyplot` + +- Set a specific title and unit: + +`{ echo {{1 2 3}}; cat } | ttyplot -t {{title}} -u {{unit}}` + +- Use a while loop to continuously plot random values: + +`{ while {{true}}; do echo {{$RANDOM}}; sleep {{1}}; done } | ttyplot` + +- Parse the output from `ping` and visualize it: + +`ping {{8.8.8.8}} | sed -u '{{s/^.*time=//g; s/ ms//g}}' | ttyplot -t "{{ping to 8.8.8.8}}" -u {{ms}}` diff --git a/linux/tune2fs b/linux/tune2fs new file mode 100644 index 00000000..16b9bbb2 --- /dev/null +++ b/linux/tune2fs @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tune2fs + +> Adjust parameters of an ext2, ext3 or ext4 filesystem. +> May be used on mounted filesystems. +> More information: . + +- Set the max number of counts before a filesystem is checked to 2: + +`tune2fs -c {{2}} {{/dev/sdXN}}` + +- Set the filesystem label to MY_LABEL: + +`tune2fs -L {{'MY_LABEL'}} {{/dev/sdXN}}` + +- Enable discard and user-specified extended attributes for a filesystem: + +`tune2fs -o {{discard,user_xattr}} {{/dev/sdXN}}` + +- Enable journaling for a filesystem: + +`tune2fs -o^{{nobarrier}} {{/dev/sdXN}}` diff --git a/linux/tuxi b/linux/tuxi new file mode 100644 index 00000000..8fefd705 --- /dev/null +++ b/linux/tuxi @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# tuxi + +> Scrape Google search results and SERPs and provide instant and concise answers. +> More information: . + +- Make a search using Google: + +`tuxi {{search_terms}}` + +- Display the search results in [r]aw format (no pretty output, no colors): + +`tuxi -r {{search_terms}}` + +- Display only search results (silences "Did you mean?", greetings and usage): + +`tuxi -q {{search_terms}}` + +- Display help: + +`tuxi -h` diff --git a/linux/ubuntu-bug b/linux/ubuntu-bug new file mode 100644 index 00000000..abb24a41 --- /dev/null +++ b/linux/ubuntu-bug @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ubuntu-bug + +> This command is an alias of `apport-bug`. +> More information: . + +- View documentation for the original command: + +`tldr apport-bug` diff --git a/linux/ubuntu-security-status b/linux/ubuntu-security-status new file mode 100644 index 00000000..390b07e8 --- /dev/null +++ b/linux/ubuntu-security-status @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ubuntu-security-status + +> Display information about security support for installed Ubuntu packages. +> More information: . + +- Display the number of unsupported packages: + +`ubuntu-security-status` + +- List packages that are no longer available for download: + +`ubuntu-security-status --unavailable` + +- List third-party packages: + +`ubuntu-security-status --thirdparty` diff --git a/linux/udevadm b/linux/udevadm new file mode 100644 index 00000000..8c4029e9 --- /dev/null +++ b/linux/udevadm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# udevadm + +> Linux `udev` management tool. +> More information: . + +- Monitor all device events: + +`sudo udevadm monitor` + +- Print `uevents` sent out by the kernel: + +`sudo udevadm monitor --kernel` + +- Print device events after being processed by `udev`: + +`sudo udevadm monitor --udev` + +- List attributes of device `/dev/sda`: + +`sudo udevadm info --attribute-walk {{/dev/sda}}` + +- Reload all `udev` rules: + +`sudo udevadm control --reload-rules` + +- Trigger all `udev` rules to run: + +`sudo udevadm trigger` + +- Test an event run by simulating loading of `/dev/sda`: + +`sudo udevadm test {{/dev/sda}}` diff --git a/linux/udisksctl b/linux/udisksctl new file mode 100644 index 00000000..8b07b4b7 --- /dev/null +++ b/linux/udisksctl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# udisksctl + +> Interact with `udisksd` to query and manipulate storage devices. +> More information: . + +- Show high-level information about disk drives and block devices: + +`udisksctl status` + +- Show detailed information about a device: + +`udisksctl info --block-device {{/dev/sdX}}` + +- Show detailed information about a device partition: + +`udisksctl info --block-device {{/dev/sdXN}}` + +- Mount a device partition and prints the mount point: + +`udisksctl mount --block-device {{/dev/sdXN}}` + +- Unmount a device partition: + +`udisksctl unmount --block-device {{/dev/sdXN}}` + +- Monitor the daemon for events: + +`udisksctl monitor` diff --git a/linux/ufw b/linux/ufw new file mode 100644 index 00000000..f54a95d1 --- /dev/null +++ b/linux/ufw @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ufw + +> Uncomplicated Firewall. +> Frontend for `iptables` aiming to make configuration of a firewall easier. +> More information: . + +- Enable ufw: + +`ufw enable` + +- Disable ufw: + +`ufw disable` + +- Show ufw rules, along with their numbers: + +`ufw status numbered` + +- Allow incoming traffic on port 5432 on this host with a comment identifying the service: + +`ufw allow {{5432}} comment "{{Service}}"` + +- Allow only TCP traffic from 192.168.0.4 to any address on this host, on port 22: + +`ufw allow proto {{tcp}} from {{192.168.0.4}} to {{any}} port {{22}}` + +- Deny traffic on port 80 on this host: + +`ufw deny {{80}}` + +- Deny all UDP traffic to ports in range 8412:8500: + +`ufw deny proto {{udp}} from {{any}} to {{any}} port {{8412:8500}}` + +- Delete a particular rule. The rule number can be retrieved from the `ufw status numbered` command: + +`ufw delete {{rule_number}}` diff --git a/linux/ul b/linux/ul new file mode 100644 index 00000000..943ca92b --- /dev/null +++ b/linux/ul @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ul + +> Performs the underlining of a text. +> Each character in a string must be underlined separately. +> More information: . + +- Display the contents of the file with underlines where applicable: + +`ul {{file.txt}}` + +- Display the contents of the file with underlines made of dashes `-`: + +`ul -i {{file.txt}}` diff --git a/linux/umount b/linux/umount new file mode 100644 index 00000000..8d70d904 --- /dev/null +++ b/linux/umount @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# umount + +> Unlink a filesystem from its mount point, making it no longer accessible. +> A filesystem cannot be unmounted when it is busy. +> More information: . + +- Unmount a filesystem, by passing the path to the source it is mounted from: + +`umount {{path/to/device_file}}` + +- Unmount a filesystem, by passing the path to the target where it is mounted: + +`umount {{path/to/mounted_directory}}` + +- When an unmount fails, try to remount the filesystem read-only: + +`umount --read-only {{path/to/mounted_directory}}` + +- Recursively unmount each specified directory: + +`umount --recursive {{path/to/mounted_directory}}` + +- Unmount all mounted filesystems (except the `proc` filesystem): + +`umount -a` diff --git a/linux/uname b/linux/uname new file mode 100644 index 00000000..8dc62363 --- /dev/null +++ b/linux/uname @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uname + +> Uname prints information about the machine and operating system it is run on. +> More information: . + +- Print all information: + +`uname --all` + +- Print the current kernel name: + +`uname --kernel-name` + +- Print the current network node host name: + +`uname --nodename` + +- Print the current kernel release: + +`uname --kernel-release` + +- Print the current kernel version: + +`uname --kernel-version` + +- Print the current machine hardware name: + +`uname --machine` + +- Print the current processor type: + +`uname --processor` + +- Print the current operating system name: + +`uname --operating-system` diff --git a/linux/uncompress b/linux/uncompress new file mode 100644 index 00000000..aa1aa83a --- /dev/null +++ b/linux/uncompress @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uncompress + +> Uncompress files compressed using the Unix `compress` command. +> More information: . + +- Uncompress specific files: + +`uncompress {{path/to/file1.Z path/to/file2.Z ...}}` + +- Uncompress specific files while ignoring non-existent ones: + +`uncompress -f {{path/to/file1.Z path/to/file2.Z ...}}` + +- Write to `stdout` (no files are changed and no `.Z` files are created): + +`uncompress -c {{path/to/file1.Z path/to/file2.Z ...}}` + +- Verbose mode (write to `stderr` about percentage reduction or expansion): + +`uncompress -v {{path/to/file1.Z path/to/file2.Z ...}}` diff --git a/linux/unix2dos b/linux/unix2dos new file mode 100644 index 00000000..6123431f --- /dev/null +++ b/linux/unix2dos @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unix2dos + +> Change Unix-style line endings to DOS-style. +> Replaces LF with CRLF. +> More information: . + +- Change the line endings of a file: + +`unix2dos {{path/to/file}}` + +- Create a copy with DOS-style line endings: + +`unix2dos -n {{path/to/unix_file}} {{path/to/dos_file}}` diff --git a/linux/unix2mac b/linux/unix2mac new file mode 100644 index 00000000..1ca21a6e --- /dev/null +++ b/linux/unix2mac @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unix2mac + +> Change Unix-style line endings to macOS-style. +> Replaces LF with CR. +> More information: . + +- Change the line endings of a file: + +`unix2mac {{path/to/file}}` + +- Create a copy with macOS-style line endings: + +`unix2mac -n {{path/to/unix_file}} {{path/to/mac_file}}` diff --git a/linux/unmount b/linux/unmount new file mode 100644 index 00000000..39ad792b --- /dev/null +++ b/linux/unmount @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# umount + +> The correct command is `umount` (u-mount). +> More information: . + +- View documentation for the correct command: + +`tldr umount` diff --git a/linux/unset b/linux/unset new file mode 100644 index 00000000..f93c8ba1 --- /dev/null +++ b/linux/unset @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unset + +> Remove shell variables or functions. +> More information: . + +- Remove the variable `foo`, or if the variable doesn't exist, remove the function `foo`: + +`unset {{foo}}` + +- Remove the variables foo and bar: + +`unset -v {{foo}} {{bar}}` + +- Remove the function my_func: + +`unset -f {{my_func}}` diff --git a/linux/unshadow b/linux/unshadow new file mode 100644 index 00000000..694fd36c --- /dev/null +++ b/linux/unshadow @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unshadow + +> Utility provided by the John the Ripper project to obtain the traditional Unix password file if the system uses shadow passwords. +> More information: . + +- Combine the `/etc/shadow` and `/etc/passwd` of the current system: + +`sudo unshadow /etc/passwd /etc/shadow` + +- Combine two arbitrary shadow and password files: + +`sudo unshadow {{path/to/passwd}} {{path/to/shadow}}` diff --git a/linux/unshare b/linux/unshare new file mode 100644 index 00000000..05342053 --- /dev/null +++ b/linux/unshare @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unshare + +> Execute a command in new user-defined namespaces. +> More information: . + +- Execute a command without sharing access to connected networks: + +`unshare --net {{command}} {{command_arguments}}` + +- Execute a command as a child process without sharing mounts, processes, or networks: + +`unshare --mount --pid --net --fork {{command}} {{command_arguments}}` diff --git a/linux/unsquashfs b/linux/unsquashfs new file mode 100644 index 00000000..96024e24 --- /dev/null +++ b/linux/unsquashfs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unsquashfs + +> Uncompress, extract and list files in squashfs filesystems. +> More information: . + +- Extract a squashfs filesystem to `squashfs-root` in the current working directory: + +`unsquashfs {{filesystem.squashfs}}` + +- Extract a squashfs filesystem to the specified directory: + +`unsquashfs -dest {{path/to/directory}} {{filesystem.squashfs}}` + +- Display the names of files as they are extracted: + +`unsquashfs -info {{filesystem.squashfs}}` + +- Display the names of files and their attributes as they are extracted: + +`unsquashfs -linfo {{filesystem.squashfs}}` + +- List files inside the squashfs filesystem (without extracting): + +`unsquashfs -ls {{filesystem.squashfs}}` + +- List files and their attributes inside the squashfs filesystem (without extracting): + +`unsquashfs -lls {{filesystem.squashfs}}` diff --git a/linux/unzipsfx b/linux/unzipsfx new file mode 100644 index 00000000..c68fcaa6 --- /dev/null +++ b/linux/unzipsfx @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# unzipsfx + +> Create a self-extracting compressed binary file by prepending self-extracting stubs on a `zip` file. +> More information: . + +- Create a self-extracting binary file of a `zip` archive: + +`cat unzipsfx {{path/to/archive.zip}} > {{filename}} && chmod 755 {{filename}}` + +- Extract a self-extracting binary in the current directory: + +`{{./path/to/binary)}}` + +- Test a self-extracting binary for errors: + +`{{./path/to/binary)}} -t` + +- Print content of a file in the self-extracting binary without extraction: + +`{{./path/to/binary)}} -c {{path/to/filename}}` + +- Print comments on `zip` archive in the self-extracting binary: + +`{{./path/to/binary)}} -z` diff --git a/linux/update-alternatives b/linux/update-alternatives new file mode 100644 index 00000000..05aaa352 --- /dev/null +++ b/linux/update-alternatives @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# update-alternatives + +> A convenient tool for maintaining symbolic links to determine default commands. +> More information: . + +- Add a symbolic link: + +`sudo update-alternatives --install {{path/to/symlink}} {{command_name}} {{path/to/command_binary}} {{priority}}` + +- Configure a symbolic link for `java`: + +`sudo update-alternatives --config {{java}}` + +- Remove a symbolic link: + +`sudo update-alternatives --remove {{java}} {{/opt/java/jdk1.8.0_102/bin/java}}` + +- Display information about a specified command: + +`update-alternatives --display {{java}}` + +- Display all commands and their current selection: + +`update-alternatives --get-selections` diff --git a/linux/update-rc.d b/linux/update-rc.d new file mode 100644 index 00000000..87890e82 --- /dev/null +++ b/linux/update-rc.d @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# update-rc.d + +> Install and remove services which are System-V style init script links. +> Init scripts are in the `/etc/init.d/`. +> More information: . + +- Install a service: + +`update-rc.d {{mysql}} defaults` + +- Enable a service: + +`update-rc.d {{mysql}} enable` + +- Disable a service: + +`update-rc.d {{mysql}} disable` + +- Forcibly remove a service: + +`update-rc.d -f {{mysql}} remove` diff --git a/linux/updatedb b/linux/updatedb new file mode 100644 index 00000000..b754ae31 --- /dev/null +++ b/linux/updatedb @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# updatedb + +> Create or update the database used by `locate`. +> It is usually run daily by cron. +> More information: . + +- Refresh database content: + +`sudo updatedb` + +- Display file names as soon as they are found: + +`sudo updatedb --verbose` diff --git a/linux/updpkgsums b/linux/updpkgsums new file mode 100644 index 00000000..2d7f38cb --- /dev/null +++ b/linux/updpkgsums @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# updpkgsums + +> Update the checksums of the sources in a `PKGBUILD`. +> Unless a preexisting hashing algorithm is used, SHA256 will be used. +> More information: . + +- Update the checksums in a `PKGBUILD`: + +`updpkgsums` + +- Display help: + +`updpkgsums -h` + +- Display version: + +`updpkgsums -v` diff --git a/linux/upower b/linux/upower new file mode 100644 index 00000000..2b647d49 --- /dev/null +++ b/linux/upower @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# upower + +> System utility to provide power and battery information and statistics. +> More information: . + +- Display power and battery information: + +`upower --dump` + +- List all power devices: + +`upower --enumerate` + +- Watch for and print power status changes: + +`upower --monitor` + +- Watch for and print detailed power status changes: + +`upower --monitor-detail` + +- Display version: + +`upower --version` diff --git a/linux/uprecords b/linux/uprecords new file mode 100644 index 00000000..daacb2b3 --- /dev/null +++ b/linux/uprecords @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uprecords + +> Displays a summary of historical uptime records. +> More information: . + +- Display a summary of the top 10 historical uptime records: + +`uprecords` + +- Display the top 25 records: + +`uprecords -m {{25}}` + +- Display the downtime between reboots instead of the kernel version: + +`uprecords -d` + +- Show the most recent reboots: + +`uprecords -B` + +- Don't truncate information: + +`uprecords -w` diff --git a/linux/urpme b/linux/urpme new file mode 100644 index 00000000..c797585f --- /dev/null +++ b/linux/urpme @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpme + +> Uninstall packages in Mageia. +> See also: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. +> More information: . + +- Uninstall a package: + +`sudo urpme {{package}}` + +- Uninstall orphan packages (Note: use it with caution as it might unintentionally remove important packages): + +`sudo urpme --auto-orphans` + +- Uninstall a package and its dependencies: + +`sudo urpme --auto-orphans {{package}}` diff --git a/linux/urpmf b/linux/urpmf new file mode 100644 index 00000000..b86973ac --- /dev/null +++ b/linux/urpmf @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmf + +> Find files in packages and query information about them in Mageia. +> See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmi.update`, `urpmq`. +> More information: . + +- Search for packages that contain a file: + +`urpmf {{filename}}` + +- Search for packages that contain both a keyword [a]nd another in their summaries: + +`urpmf --summary {{keyword1}} -a {{keyword2}}` + +- Search for packages that contain a keyword [o]r another in their descriptions: + +`urpmf --description {{keyword1}} -o {{keyword2}}` + +- Search for packages that do not contain a keyword in their name ignoring case distinction using "|" as the [F]ield separator (":" by default): + +`urpmf --description ! {{keyword}} -F'|'` diff --git a/linux/urpmi b/linux/urpmi new file mode 100644 index 00000000..779d0dd6 --- /dev/null +++ b/linux/urpmi @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmi + +> Install packages in Mageia. +> See also: `urpm.update`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. +> More information: . + +- Install a package from the repository or from a local RPM file: + +`sudo urpmi {{package|path/to/file.rpm}}` + +- Download a package without installing it: + +`urpmi --no-install {{package}}` + +- Update all installed packages (run `urpmi.update -a` to get the available updates): + +`sudo urpmi --auto-select` + +- Update a package of one or more machines on the network according to `/etc/urpmi/parallel.cfg`: + +`sudo urpmi --parallel local {{package}}` + +- Mark all orphaned packages as manually installed: + +`sudo urpmi $(urpmq --auto-orphans -f)` diff --git a/linux/urpmi-addmedia b/linux/urpmi-addmedia new file mode 100644 index 00000000..c672c65e --- /dev/null +++ b/linux/urpmi-addmedia @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmi.addmedia + +> Add media in Mageia. +> Note: Mageia documentation uses medium and repository as synonymous. +> See also: `urpmi`, `urpmi.update`, `urpme`, `urpmi.removemedia`, `urpmf`, `urpmq`. +> More information: . + +- Add a medium: + +`sudo urpmi.addmedia {{medium}} {{ftp://ftp.site.com/path/to/Mageia/RPMS}}` + +- Add a medium from a hard drive (run `genhdlist2` in the directory first): + +`sudo urpmi.addmedia --distrib HD file:/{{/path/to/repo}}` + +- Add important media from a chosen mirror: + +`sudo urpmi.addmedia --distrib ftp://{{mirror_website}/mirror/mageia/distrib/{{version}}/{{arch}}` + +- Automatically select mirrors from a mirror list: + +`sudo urpmi.addmedia --distrib --mirrorlist {{mirrorlist}}` diff --git a/linux/urpmi-removemedia b/linux/urpmi-removemedia new file mode 100644 index 00000000..c9c5d9ef --- /dev/null +++ b/linux/urpmi-removemedia @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmi.removemedia + +> Remove media in Mageia. +> Note: Mageia documentation uses medium and repository as synonymous. +> See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.update`, `urpmf`, `urpmq`. +> More information: . + +- Remove a medium: + +`sudo urpmi.removemedia {{medium}}` + +- Remove all media: + +`sudo urpmi.removemedia -a` + +- Remove media fuzz[y] matching on media names: + +`sudo urpmi.removemedia -y {{keyword}}` diff --git a/linux/urpmi-update b/linux/urpmi-update new file mode 100644 index 00000000..fe6c2d57 --- /dev/null +++ b/linux/urpmi-update @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmi.update + +> Update the list of packages from a package repository in Mageia. +> Note: Mageia documentation uses medium and repository as synonymous. +> See also: `urpmi`, `urpme`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpmq`. +> More information: . + +- Update all enabled media: + +`urpmi.update -a` + +- Update specific media (including disabled media): + +`urpmi.update {{medium1 medium2 ...}}` + +- Update all media that contain a specific keyword: + +`urpmi.update {{keyword}}` + +- Update all configured media: + +`urpmi.update e` diff --git a/linux/urpmq b/linux/urpmq new file mode 100644 index 00000000..8c9f9640 --- /dev/null +++ b/linux/urpmq @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urpmq + +> Query information about packages and media in Mageia. +> See also: `urpmi`, `urpmi.update`, `urpmi.addmedia`, `urpmi.removemedia`, `urpmf`, `urpme`. +> More information: . + +- Display information about an installable package: + +`urpmq -i {{package}}` + +- Display direct dependencies of a package: + +`urpmq --requires {{package}}` + +- Display direct and indirect dependencies of a package: + +`urpmq --requires-recursive {{package}}` + +- List the not installed packages needed for an RPM file with their sources: + +`sudo urpmq --requires-recursive -m --sources {{path/to/file.rpm}}` + +- List all configured media with their URLs, including inactive media: + +`urpmq --list-media --list-url` + +- Search for a package printing [g]roup, version and [r]elease: + +`urpmq -g -r --fuzzy {{keyword}}` + +- Search for a package with using its exact name: + +`urpmq -g -r {{package}}` diff --git a/linux/urxvt b/linux/urxvt new file mode 100644 index 00000000..ad866ebe --- /dev/null +++ b/linux/urxvt @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# urxvt + +> Rxvt-unicode. +> A customizable terminal emulator. +> More information: . + +- Open a new urxvt window: + +`urxvt` + +- Run in a specific directory: + +`urxvt -cd {{path/to/directory}}` + +- Run a command in a new urxvt window: + +`urxvt -e {{command}}` + +- Run a command and keep the window open: + +`urxvt --hold -e {{command}}` + +- Run a command within the `sh` shell: + +`urxvt -e {{sh}} -c {{command}}` diff --git a/linux/usbip b/linux/usbip new file mode 100644 index 00000000..7a7148cf --- /dev/null +++ b/linux/usbip @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# usbip + +> Use USB devices remotely. +> More information: . + +- List all local USB devices and their bus ID's: + +`usbip list --local` + +- Start a `usbip` daemon on the server: + +`systemctl start usbipd` + +- Bind a USB device to `usbip` on the server: + +`sudo usbip bind --busid={{bus_id}}` + +- Load the kernel module required by `usbip` on the client: + +`sudo modprobe vhci-hcd` + +- Attach to the `usbip` device on the client (bus ID is the same as on the server): + +`sudo usbip attach -r {{ip_address}} --busid={{bus_id}}` + +- List attached devices: + +`usbip port` + +- Detach from a device: + +`sudo usbip detach --port={{port}}` + +- Unbind a device: + +`usbip unbind --busid={{bus_id}}` diff --git a/linux/useradd b/linux/useradd new file mode 100644 index 00000000..262e1a68 --- /dev/null +++ b/linux/useradd @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# useradd + +> Create a new user. +> See also: `users`, `userdel`, `usermod`. +> More information: . + +- Create a new user: + +`sudo useradd {{username}}` + +- Create a new user with the specified user id: + +`sudo useradd --uid {{id}} {{username}}` + +- Create a new user with the specified shell: + +`sudo useradd --shell {{path/to/shell}} {{username}}` + +- Create a new user belonging to additional groups (mind the lack of whitespace): + +`sudo useradd --groups {{group1,group2,...}} {{username}}` + +- Create a new user with the default home directory: + +`sudo useradd --create-home {{username}}` + +- Create a new user with the home directory filled by template directory files: + +`sudo useradd --skel {{path/to/template_directory}} --create-home {{username}}` + +- Create a new system user without the home directory: + +`sudo useradd --system {{username}}` diff --git a/linux/userdbctl b/linux/userdbctl new file mode 100644 index 00000000..d012c71c --- /dev/null +++ b/linux/userdbctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# userdbctl + +> Inspect users, groups and group memberships on the system. +> More information: . + +- List all known user records: + +`userdbctl user` + +- Show details of a specific user: + +`userdbctl user {{username}}` + +- List all known groups: + +`userdbctl group` + +- Show details of a specific group: + +`userdbctl group {{groupname}}` + +- List all services currently providing user/group definitions to the system: + +`userdbctl services` diff --git a/linux/userdel b/linux/userdel new file mode 100644 index 00000000..b47c2c22 --- /dev/null +++ b/linux/userdel @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# userdel + +> Remove a user account or remove a user from a group. +> See also: `users`, `useradd`, `usermod`. +> More information: . + +- Remove a user: + +`sudo userdel {{username}}` + +- Remove a user in other root directory: + +`sudo userdel --root {{path/to/other/root}} {{username}}` + +- Remove a user along with the home directory and mail spool: + +`sudo userdel --remove {{username}}` diff --git a/linux/usermod b/linux/usermod new file mode 100644 index 00000000..33f2b336 --- /dev/null +++ b/linux/usermod @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# usermod + +> Modifies a user account. +> See also: `users`, `useradd`, `userdel`. +> More information: . + +- Change a username: + +`sudo usermod --login {{new_username}} {{username}}` + +- Change a user id: + +`sudo usermod --uid {{id}} {{username}}` + +- Change a user shell: + +`sudo usermod --shell {{path/to/shell}} {{username}}` + +- Add a user to supplementary groups (mind the lack of whitespace): + +`sudo usermod --append --groups {{group1,group2,...}} {{username}}` + +- Change a user home directory: + +`sudo usermod --move-home --home {{path/to/new_home}} {{username}}` diff --git a/linux/utmpdump b/linux/utmpdump new file mode 100644 index 00000000..99990f1d --- /dev/null +++ b/linux/utmpdump @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# utmpdump + +> Dump and load btmp, utmp and wtmp accounting files. +> More information: . + +- Dump the `/var/log/wtmp` file to `stdout` as plain text: + +`utmpdump {{/var/log/wtmp}}` + +- Load a previously dumped file into `/var/log/wtmp`: + +`utmpdump -r {{dumpfile}} > {{/var/log/wtmp}}` diff --git a/linux/uuid b/linux/uuid new file mode 100644 index 00000000..346b5150 --- /dev/null +++ b/linux/uuid @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uuid + +> Generate and decode Universally Unique Identifiers (UUID). +> See also `uuidgen`. +> More information: . + +- Generate a UUIDv1 (based on time and system's hardware address, if present): + +`uuid` + +- Generate a UUIDv4 (based on random data): + +`uuid -v {{4}}` + +- Generate multiple UUIDv4 identifiers at once: + +`uuid -v {{4}} -n {{number_of_uuids}}` + +- Generate a UUIDv4 and specify the output format: + +`uuid -v {{4}} -F {{BIN|STR|SIV}}` + +- Generate a UUIDv4 and write the output to a file: + +`uuid -v {{4}} -o {{path/to/file}}` + +- Generate a UUIDv5 (based on the supplied object name) with a specified namespace prefix: + +`uuid -v {{5}} ns:{{DNS|URL|OID|X500}} {{object_name}}` + +- Decode a given UUID: + +`uuid -d {{uuid}}` diff --git a/linux/uuidd b/linux/uuidd new file mode 100644 index 00000000..35ccda0b --- /dev/null +++ b/linux/uuidd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uuidd + +> Daemon for generating UUIDs. +> More information: . + +- Generate a random UUID: + +`uuidd --random` + +- Generate a bulk number of random UUIDs: + +`uuidd --random --uuids {{number_of_uuids}}` + +- Generate a time-based UUID, based on the current time and MAC address of the system: + +`uuidd --time` diff --git a/linux/uuidgen b/linux/uuidgen new file mode 100644 index 00000000..0bda4f25 --- /dev/null +++ b/linux/uuidgen @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uuidgen + +> Generate unique identifiers (UUIDs). +> See also `uuid`. +> More information: . + +- Create a random UUIDv4: + +`uuidgen --random` + +- Create a UUIDv1 based on the current time: + +`uuidgen --time` + +- Create a UUIDv5 of the name with a specified namespace prefix: + +`uuidgen --sha1 --namespace {{@dns|@url|@oid|@x500}} --name {{object_name}}` diff --git a/linux/uuidparse b/linux/uuidparse new file mode 100644 index 00000000..3c5b41eb --- /dev/null +++ b/linux/uuidparse @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uuidparse + +> Parse universally unique identifiers. +> See also: `uuidgen`. +> More information: . + +- Parse the specified UUIDs, use a tabular output format: + +`uuidparse {{uuid1 uuid2 ...}}` + +- Parse UUIDs from `stdin`: + +`{{command}} | uuidparse` + +- Use the JSON output format: + +`uuidparse --json {{uuid1 uuid2 ...}}` + +- Do not print a header line: + +`uuidparse --noheadings {{uuid1 uuid2 ...}}` + +- Use the raw output format: + +`uuidparse --raw {{uuid1 uuid2 ...}}` + +- Specify which of the four output columns to print: + +`uuidparse --output {{UUID,VARIANT,TYPE,TIME}}` + +- Display help: + +`uuidparse -h` diff --git a/linux/uvcdynctrl b/linux/uvcdynctrl new file mode 100644 index 00000000..3809ce73 --- /dev/null +++ b/linux/uvcdynctrl @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# uvcdynctrl + +> A libwebcam command-line tool to manage dynamic controls in uvcvideo. +> More information: . + +- List all available cameras: + +`uvcdynctrl -l` + +- Use a specific device (defaults to `video0`): + +`uvcdynctrl -d {{device_name}}` + +- List available controls: + +`uvcdynctrl -c` + +- Set a new control value (for negative values, use `-- -value`): + +`uvcdynctrl -s {{control_name}} {{value}}` + +- Get the current control value: + +`uvcdynctrl -g {{control_name}}` + +- Save the state of the current controls to a file: + +`uvcdynctrl -W {{filename}}` + +- Load the state of the controls from a file: + +`uvcdynctrl -L {{filename}}` diff --git a/linux/v4l2-ctl b/linux/v4l2-ctl new file mode 100644 index 00000000..30e94518 --- /dev/null +++ b/linux/v4l2-ctl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# v4l2-ctl + +> Control video devices. +> More information: . + +- List all video devices: + +`v4l2-ctl --list-devices` + +- List supported video formats and resolutions of default video device `/dev/video0`: + +`v4l2-ctl --list-formats-ext` + +- List supported video formats and resolutions of a specific video device: + +`v4l2-ctl --list-formats-ext --device {{path/to/video_device}}` + +- Get all details of a video device: + +`v4l2-ctl --all --device {{path/to/video_device}}` + +- Capture a JPEG photo with a specific resolution from video device: + +`v4l2-ctl --device {{path/to/video_device}} --set-fmt-video=width={{width}},height={{height}},pixelformat=MJPG --stream-mmap --stream-to={{path/to/output.jpg}} --stream-count=1` + +- Capture a raw video stream from video device: + +`v4l2-ctl --device {{path/to/video_device}} --set-fmt-video=width={{width}},height={{height}},pixelformat={{format}} --stream-mmap --stream-to={{path/to/output}} --stream-count={{number_of_frames_to_capture}}` + +- List all video device's controls and their values: + +`v4l2-ctl --list-ctrls --device {{path/to/video_device}}` + +- Set the value of a video device control: + +`v4l2-ctl --device {{path/to/video_device}} --set-ctrl={{control_name}}={{value}}` diff --git a/linux/vcgencmd b/linux/vcgencmd new file mode 100644 index 00000000..dcb5109d --- /dev/null +++ b/linux/vcgencmd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vcgencmd + +> Print system information for a Raspberry Pi. +> More information: . + +- List all available commands: + +`vcgencmd commands` + +- Print the current CPU temperature: + +`vcgencmd measure_temp` + +- Print the current voltage: + +`vcgencmd measure_volts` + +- Print the throttled state of the system as a bit pattern: + +`vcgencmd get_throttled` + +- Print the bootloader configuration (only available on Raspberry Pi 4 models): + +`vcgencmd bootloader_config` + +- Display help: + +`vcgencmd --help` diff --git a/linux/veracrypt b/linux/veracrypt new file mode 100644 index 00000000..588df1d3 --- /dev/null +++ b/linux/veracrypt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# veracrypt + +> Free and open source disk encryption software. +> More information: . + +- Create a new volume through a text user interface and use `/dev/urandom` as a source of random data: + +`veracrypt --text --create --random-source={{/dev/urandom}}` + +- Decrypt a volume interactively through a text user interface and mount it to a directory: + +`veracrypt --text {{path/to/volume}} {{path/to/mount_point}}` + +- Decrypt a partition using a keyfile and mount it to a directory: + +`veracrypt --keyfiles={{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` + +- Dismount a volume on the directory it is mounted to: + +`veracrypt --dismount {{path/to/mounted_point}}` diff --git a/linux/vgchange b/linux/vgchange new file mode 100644 index 00000000..d073d137 --- /dev/null +++ b/linux/vgchange @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vgchange + +> Change the attributes of a Logical Volume Manager (LVM) volume group. +> See also: `lvm`. +> More information: . + +- Change the activation status of logical volumes in all volume groups: + +`sudo vgchange --activate {{y|n}}` + +- Change the activation status of logical volumes in the specified volume group (determine with `vgscan`): + +`sudo vgchange --activate {{y|n}} {{volume_group}}` diff --git a/linux/vgcreate b/linux/vgcreate new file mode 100644 index 00000000..84295c59 --- /dev/null +++ b/linux/vgcreate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vgcreate + +> Create volume groups combining multiple mass-storage devices. +> See also: `lvm`. +> More information: . + +- Create a new volume group called vg1 using the `/dev/sda1` device: + +`vgcreate {{vg1}} {{/dev/sda1}}` + +- Create a new volume group called vg1 using multiple devices: + +`vgcreate {{vg1}} {{/dev/sda1}} {{/dev/sdb1}} {{/dev/sdc1}}` diff --git a/linux/vgdisplay b/linux/vgdisplay new file mode 100644 index 00000000..51d5a650 --- /dev/null +++ b/linux/vgdisplay @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vgdisplay + +> Display information about Logical Volume Manager (LVM) volume groups. +> See also: `lvm`. +> More information: . + +- Display information about all volume groups: + +`sudo vgdisplay` + +- Display information about volume group vg1: + +`sudo vgdisplay {{vg1}}` diff --git a/linux/vgs b/linux/vgs new file mode 100644 index 00000000..eecfa9b1 --- /dev/null +++ b/linux/vgs @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vgs + +> Display information about volume groups. +> See also: `lvm`. +> More information: . + +- Display information about volume groups: + +`vgs` + +- Display all volume groups: + +`vgs -a` + +- Change default display to show more details: + +`vgs -v` + +- Display only specific fields: + +`vgs -o {{field_name_1}},{{field_name_2}}` + +- Append field to default display: + +`vgs -o +{{field_name}}` + +- Suppress heading line: + +`vgs --noheadings` + +- Use separator to separate fields: + +`vgs --separator =` diff --git a/linux/vgscan b/linux/vgscan new file mode 100644 index 00000000..3d75eac1 --- /dev/null +++ b/linux/vgscan @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vgscan + +> Scan for volume groups on all supported Logical Volume Manager (LVM) block devices. +> See also: `lvm` and `vgchange`. +> More information: . + +- Scan for volume groups and print information about each group found: + +`sudo vgscan` + +- Scan for volume groups and add the special files in `/dev`, if they don't already exist, needed to access the logical volumes in the found groups: + +`sudo vgscan --mknodes` diff --git a/linux/viewnior b/linux/viewnior new file mode 100644 index 00000000..428bae30 --- /dev/null +++ b/linux/viewnior @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# viewnior + +> Simple and elegant image viewer. +> More information: . + +- View an image: + +`viewnior {{path/to/image.ext}}` + +- View in fullscreen mode: + +`viewnior --fullscreen {{path/to/image.ext}}` + +- View fullscreen in slideshow mode: + +`viewnior --slideshow {{path/to/image.ext}}` diff --git a/linux/vigr b/linux/vigr new file mode 100644 index 00000000..0dc60254 --- /dev/null +++ b/linux/vigr @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vigr + +> Edit the group file. +> More information: . + +- Edit the group file: + +`vigr` + +- Display version: + +`vigr --version` diff --git a/linux/vipw b/linux/vipw new file mode 100644 index 00000000..9ed4d8d2 --- /dev/null +++ b/linux/vipw @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vipw + +> Edit the password file. +> More information: . + +- Edit the password file: + +`vipw` + +- Display version: + +`vipw --version` diff --git a/linux/virt-manager b/linux/virt-manager new file mode 100644 index 00000000..7db95db4 --- /dev/null +++ b/linux/virt-manager @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-manager + +> CLI launcher for virt-manager, a desktop user interface for managing KVM and Xen virtual machines and LXC containers. +> More information: . + +- Launch virt-manager: + +`virt-manager` + +- Connect to a hypervisor: + +`virt-manager --connect {{hypervisor_uri}}` + +- Don't fork virt-manager process into background on startup: + +`virt-manager --no-fork` + +- Print debug output: + +`virt-manager --debug` + +- Open the "New VM" wizard: + +`virt-manager --show-domain-creator` + +- Show domain details window: + +`virt-manager --show-domain-editor {{name|id|uuid}}` + +- Show domain performance window: + +`virt-manager --show-domain-performance {{name|id|uuid}}` + +- Show connection details window: + +`virt-manager --show-host-summary` diff --git a/linux/virt-viewer b/linux/virt-viewer new file mode 100644 index 00000000..4a522958 --- /dev/null +++ b/linux/virt-viewer @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-viewer + +> Minimal graphical interface for a virtual machine (VM). +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> More information: . + +- Launch `virt-viewer` with a prompt to select running virtual machines: + +`virt-viewer` + +- Launch `virt-viewer` for a specific virtual machine by ID, UUID or name: + +`virt-viewer "{{domain}}"` + +- Wait for a virtual machine to start and automatically reconnect if it shutdown and restarts: + +`virt-viewer --reconnect --wait "{{domain}}"` + +- Connect to a specific remote virtual machine over TLS: + +`virt-viewer --connect "xen//{{url}}" "{{domain}}"` + +- Connect to a specific remote virtual machine over SSH: + +`virt-viewer --connect "qemu+ssh//{{username}}@{{url}}/system" "{{domain}}"` diff --git a/linux/virt-xml b/linux/virt-xml new file mode 100644 index 00000000..19f35e97 --- /dev/null +++ b/linux/virt-xml @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-xml + +> Edit libvirt Domain XML files with explicit command-line options. +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> More information: . + +- List all the suboptions for a specific option: + +`virt-xml --{{option}}=?` + +- List all the suboptions for disk, network, and boot: + +`virt-xml --disk=? --network=? --boot=?` + +- Edit a value for a specific domain: + +`virt-xml {{domain}} --edit --{{option}} {{suboption}}={{new_value}}` + +- Change the description for a specific domain: + +`virt-xml {{domain}} --edit --metadata description="{{new_description}}"` + +- Enable/Disable the boot device menu for a specific domain: + +`virt-xml {{domain}} --edit --boot bootmenu={{on|off}}` + +- Attach host USB hub to a running VM (See: tldr lsusb): + +`virt-xml {{domain}} --update --add-device --hostdev {{bus}}.{{device}}` diff --git a/linux/virt-xml-validate b/linux/virt-xml-validate new file mode 100644 index 00000000..fb594094 --- /dev/null +++ b/linux/virt-xml-validate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-xml-validate + +> Validate `libvirt` XML files against a schema. +> If a schema is not specified, the schema is determined by the root element in the XML file. +> More information: . + +- Validate an XML file against a specific schema: + +`virt-xml-validate {{path/to/file.xml}} {{schema}}` + +- Validate the domain XML against the domain schema: + +`virt-xml-validate {{path/to/domain.xml}} domain` diff --git a/linux/vkpurge b/linux/vkpurge new file mode 100644 index 00000000..c2f47e61 --- /dev/null +++ b/linux/vkpurge @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vkpurge + +> List or remove old kernel versions left behind by `xbps`. +> The `version` arguments support shell globs. +> More information: . + +- List all removable kernel versions (or those matching `version` if the argument is specified): + +`vkpurge list {{version}}` + +- Remove all unused kernels: + +`vkpurge rm all` + +- Remove kernel versions matching `version`: + +`vkpurge rm {{version}}` diff --git a/linux/vmstat b/linux/vmstat new file mode 100644 index 00000000..a29529f1 --- /dev/null +++ b/linux/vmstat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vmstat + +> Report information about processes, memory, paging, block IO, traps, disks and CPU activity. +> More information: . + +- Display virtual memory statistics: + +`vmstat` + +- Display reports every 2 seconds for 5 times: + +`vmstat {{2}} {{5}}` diff --git a/linux/vmware-checkvm b/linux/vmware-checkvm new file mode 100644 index 00000000..e4dd7597 --- /dev/null +++ b/linux/vmware-checkvm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vmware-checkvm + +> Check if the current host is a VMware VM or not. +> More information: . + +- Return the current VMware software version (exit status determines whether the system is a VM or not): + +`vmware-checkvm` + +- Return the VMware hardware version: + +`vmware-checkvm -h` diff --git a/linux/vncserver b/linux/vncserver new file mode 100644 index 00000000..455abd7b --- /dev/null +++ b/linux/vncserver @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vncserver + +> Launches a VNC (Virtual Network Computing) desktop. +> More information: . + +- Launch a VNC Server on next available display: + +`vncserver` + +- Launch a VNC Server with specific screen geometry: + +`vncserver --geometry {{width}}x{{height}}` + +- Kill an instance of VNC Server running on a specific display: + +`vncserver --kill :{{display_number}}` diff --git a/linux/vncviewer b/linux/vncviewer new file mode 100644 index 00000000..db2a995d --- /dev/null +++ b/linux/vncviewer @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vncviewer + +> Launches a VNC (Virtual Network Computing) client. +> More information: . + +- Launch a VNC client which connects to a host on a given display: + +`vncviewer {{host}}:{{display_number}}` + +- Launch in full-screen mode: + +`vncviewer -FullScreen {{host}}:{{display_number}}` + +- Launch a VNC client with a specific screen geometry: + +`vncviewer --geometry {{width}}x{{height}} {{host}}:{{display_number}}` + +- Launch a VNC client which connects to a host on a given port: + +`vncviewer {{host}}::{{port}}` diff --git a/linux/vnstat b/linux/vnstat new file mode 100644 index 00000000..d3da2ca3 --- /dev/null +++ b/linux/vnstat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vnstat + +> A console-based network traffic monitor. +> More information: . + +- Display traffic summary for all interfaces: + +`vnstat` + +- Display traffic summary for a specific network interface: + +`vnstat -i {{eth0}}` + +- Display live stats for a specific network interface: + +`vnstat -l -i {{eth0}}` + +- Show traffic statistics on an hourly basis for the last 24 hours using a bar graph: + +`vnstat -hg` + +- Measure and show average traffic for 30 seconds: + +`vnstat -tr {{30}}` diff --git a/linux/vnstati b/linux/vnstati new file mode 100644 index 00000000..af4672fa --- /dev/null +++ b/linux/vnstati @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vnstati + +> PNG image output support for vnStat. +> More information: . + +- Output a summary of the last 2: months, days, and all-time: + +`vnstati --summary --iface {{network_interface}} --output {{path/to/output.png}}` + +- Output the 10 most traffic-intensive days of all time: + +`vnstati --top10 --iface {{network_interface}} --output {{path/to/output.png}}` + +- Output monthly traffic statistics from the last 12 months: + +`vnstati --months --iface {{network_interface}} --output {{path/to/output.png}}` + +- Output hourly traffic statistics from the last 24 hours: + +`vnstati --hours --iface {{network_interface}} --output {{path/to/output.png}}` diff --git a/linux/vpnc b/linux/vpnc new file mode 100644 index 00000000..54ba2c3d --- /dev/null +++ b/linux/vpnc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vpnc + +> A VPN client for the Cisco 3000 VPN Concentrator. +> More information: . + +- Connect with a defined configuration file: + +`sudo vpnc {{config_file}}` + +- Terminate the previously created connection: + +`sudo vpnc-disconnect` diff --git a/linux/vrms b/linux/vrms new file mode 100644 index 00000000..d1554939 --- /dev/null +++ b/linux/vrms @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vrms + +> Report non-free packages installed on Debian-based OSes. +> More information: . + +- List non-free and contrib packages (and their description): + +`vrms` + +- Only output the package names: + +`vrms --sparse` diff --git a/linux/vso b/linux/vso new file mode 100644 index 00000000..106063d2 --- /dev/null +++ b/linux/vso @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# vso + +> Package manager, system updater and a task automator for Vanilla OS. +> More information: . + +- Check for system updates to the host system: + +`vso sys-upgrade check` + +- Upgrade the host system now: + +`vso sys-upgrade upgrade --now` + +- Initialize the Pico subsystem (used for package management): + +`vso pico-init` + +- Install applications inside the subsystem: + +`vso install {{package1 package2 ...}}` + +- Remove applications from the subsystem: + +`vso remove {{package1 package2 ...}}` + +- Enter the subsystem's shell: + +`vso shell` + +- Run an application from the subsystem: + +`vso run {{package}}` + +- Display VSO configuration: + +`vso config show` diff --git a/linux/w b/linux/w new file mode 100644 index 00000000..6e98db3a --- /dev/null +++ b/linux/w @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# w + +> Display who is logged in and their processes. +> More information: . + +- Display information about all users who are currently logged in: + +`w` + +- Display information about a specific user: + +`w {{username}}` + +- Display information without including the header: + +`w --no-header` + +- Display information without including the login, JCPU and PCPU columns: + +`w --short` diff --git a/linux/waitpid b/linux/waitpid new file mode 100644 index 00000000..3011d07f --- /dev/null +++ b/linux/waitpid @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# waitpid + +> Wait for the termination of arbitrary processes. +> See also: `wait`. +> More information: . + +- Sleep until all processes whose PIDs have been specified have exited: + +`waitpid {{pid1 pid2 ...}}` + +- Sleep for at most `n` seconds: + +`waitpid --timeout {{n}} {{pid1 pid2 ...}}` + +- Do not error if specified PIDs have already exited: + +`waitpid --exited {{pid1 pid2 ...}}` + +- Sleep until `n` of the specified processes have exited: + +`waitpid --count {{n}} {{pid1 pid2 ...}}` + +- Display help: + +`waitpid -h` diff --git a/linux/wajig b/linux/wajig new file mode 100644 index 00000000..5252598a --- /dev/null +++ b/linux/wajig @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wajig + +> Simplified all-in-one-place system support tool for Debian-based systems. +> More information: . + +- Update the list of available packages and versions: + +`wajig update` + +- Install a package, or update it to the latest available version: + +`wajig install {{package}}` + +- Remove a package and its configuration files: + +`wajig purge {{package}}` + +- Perform an update and then a dist-upgrade: + +`wajig daily-upgrade` + +- Display the sizes of installed packages: + +`wajig sizes` + +- List the version and distribution for all installed packages: + +`wajig versions` + +- List versions of upgradable packages: + +`wajig toupgrade` + +- Display packages which have some form of dependency on the given package: + +`wajig dependents {{package}}` diff --git a/linux/wal-telegram b/linux/wal-telegram new file mode 100644 index 00000000..2604dce2 --- /dev/null +++ b/linux/wal-telegram @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wal-telegram + +> Generates themes for Telegram based the colors generated by pywal/wal. +> More information: . + +- Generate with wal's palette and the current wallpaper (feh only): + +`wal-telegram` + +- Generate with wal's palette and a specified background image: + +`wal-telegram --background={{path/to/image}}` + +- Generate with wal's palette and a colored background based on the palette: + +`wal-telegram --tiled` + +- Apply a gaussian blur on the background image: + +`wal-telegram -g` + +- Specify a location for the generated theme (default is `$XDG_CACHE_HOME/wal-telegram` or `~/.cache/wal-telegram`): + +`wal-telegram --destination={{path/to/destination}}` + +- Restart the telegram app after generation: + +`wal-telegram --restart` diff --git a/linux/wall b/linux/wall new file mode 100644 index 00000000..e80aa2c9 --- /dev/null +++ b/linux/wall @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wall + +> Write a message on the terminals of users currently logged in. +> More information: . + +- Send a message: + +`wall {{message}}` + +- Send a message to users that belong to a specific group: + +`wall --group {{group_name}} {{message}}` + +- Send a message from a file: + +`wall {{file}}` + +- Send a message with timeout (default 300): + +`wall --timeout {{seconds}} {{file}}` diff --git a/linux/wami b/linux/wami new file mode 100644 index 00000000..36afdfe9 --- /dev/null +++ b/linux/wami @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wami + +> An open-source and easy-to-use tool that recommends suitable programs for tasks. +> More information: . + +- Find expanded results in all categories from the lake and [S]ort them in the specified order: + +`wami --show-all -S {{asc|desc}} --search-all {{search_string}}` + +- Search GitHub to find expanded results, [S]orted in descending order: + +`wami --show-all -S desc --github {{search_string}}` + +- Search GitHub for topics that match the search string: + +`wami --list-topics {{search_string}}` + +- Search the lake for a tool used in pentests to query for default credentials and [S]ort the results in descending order: + +`wami -S desc --search-all pentest credential default` diff --git a/linux/warpd b/linux/warpd new file mode 100644 index 00000000..a2eb31a6 --- /dev/null +++ b/linux/warpd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# warpd + +> A modal keyboard driven pointer manipulation program. +> More information: . + +- Run warpd in normal mode: + +`warpd --normal` + +- Run warpd in hint mode: + +`warpd --hint` + +- Move cursor left: + +`h` + +- Move cursor down: + +`j` + +- Move cursor up: + +`k` + +- Move cursor right: + +`l` + +- Emulate left click: + +`m` diff --git a/linux/watch b/linux/watch new file mode 100644 index 00000000..3525ec4f --- /dev/null +++ b/linux/watch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# watch + +> Execute a command repeatedly, and monitor the output in full-screen mode. +> More information: . + +- Monitor files in the current directory: + +`watch {{ls}}` + +- Monitor disk space and highlight the changes: + +`watch -d {{df}}` + +- Monitor "node" processes, refreshing every 3 seconds: + +`watch -n {{3}} "{{ps aux | grep node}}"` + +- Monitor disk space and if it changes, stop monitoring: + +`watch -g {{df}}` diff --git a/linux/waydroid b/linux/waydroid new file mode 100644 index 00000000..3e8a1677 --- /dev/null +++ b/linux/waydroid @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# waydroid + +> A container-based approach to boot a full Android system on a regular Linux system like Ubuntu. +> More information: . + +- Start Waydroid: + +`waydroid` + +- Initialize Waydroid (required on first run or after reinstalling Android): + +`waydroid init` + +- Install a new Android app from a file: + +`waydroid app install {{path/to/file.apk}}` + +- Launch an Android app by its package name: + +`waydroid app launch {{com.example.app}}` + +- Start or stop the Waydroid session: + +`waydroid session {{start|stop}}` + +- Manage the Waydroid container: + +`waydroid container {{start|stop|restart|freeze|unfreeze}}` diff --git a/linux/wdctl b/linux/wdctl new file mode 100644 index 00000000..f0d44801 --- /dev/null +++ b/linux/wdctl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wdctl + +> Show the hardware watchdog status. +> More information: . + +- Display the watchdog status: + +`wdctl` + +- Display the watchdog status in a single line in key-value pairs: + +`wdctl --oneline` + +- Display only specific watchdog flags (list is driver specific): + +`wdctl --flags {{flag_list}}` diff --git a/linux/wg b/linux/wg new file mode 100644 index 00000000..bae34fb0 --- /dev/null +++ b/linux/wg @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wg + +> Manage the configuration of WireGuard interfaces. +> More information: . + +- Check status of currently active interfaces: + +`sudo wg` + +- Generate a new private key: + +`wg genkey` + +- Generate a public key from a private key: + +`wg pubkey < {{path/to/private_key}} > {{path/to/public_key}}` + +- Generate a public and private key: + +`wg genkey | tee {{path/to/private_key}} | wg pubkey > {{path/to/public_key}}` + +- Show the current configuration of a wireguard interface: + +`sudo wg showconf {{wg0}}` diff --git a/linux/wg-quick b/linux/wg-quick new file mode 100644 index 00000000..e3ca8496 --- /dev/null +++ b/linux/wg-quick @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wg-quick + +> Quickly set up WireGuard tunnels based on config files. +> More information: . + +- Set up a VPN tunnel: + +`wg-quick up {{interface_name}}` + +- Delete a VPN tunnel: + +`wg-quick down {{interface_name}}` diff --git a/linux/whatis b/linux/whatis new file mode 100644 index 00000000..b5b868ec --- /dev/null +++ b/linux/whatis @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# whatis + +> Display one-line descriptions from manual pages. +> More information: . + +- Display a description from a man page: + +`whatis {{command}}` + +- Don't cut the description off at the end of the line: + +`whatis --long {{command}}` + +- Display descriptions for all commands matching a glob: + +`whatis --wildcard {{net*}}` + +- Search man page descriptions with a regular expression: + +`whatis --regex '{{wish[0-9]\.[0-9]}}'` + +- Display descriptions in a specific language: + +`whatis --locale={{en}} {{command}}` diff --git a/linux/whiptail b/linux/whiptail new file mode 100644 index 00000000..96bbe540 --- /dev/null +++ b/linux/whiptail @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# whiptail + +> Display text-based dialog boxes from shell scripts. +> More information: . + +- Display a simple message: + +`whiptail --title "{{title}}" --msgbox "{{message}}" {{height_in_chars}} {{width_in_chars}}` + +- Display a boolean choice, returning the result through the exit code: + +`whiptail --title "{{title}}" --yesno "{{message}}" {{height_in_chars}} {{width_in_chars}}` + +- Customise the text on the yes/no buttons: + +`whiptail --title "{{title}}" --yes-button "{{text}}" --no-button "{{text}}" --yesno "{{message}}" {{height_in_chars}} {{width_in_chars}}` + +- Display a text input box: + +`{{result_variable_name}}="$(whiptail --title "{{title}}" --inputbox "{{message}}" {{height_in_chars}} {{width_in_chars}} {{default_text}} 3>&1 1>&2 2>&3)"` + +- Display a password input box: + +`{{result_variable_name}}="$(whiptail --title "{{title}}" --passwordbox "{{message}}" {{height_in_chars}} {{width_in_chars}} 3>&1 1>&2 2>&3)"` + +- Display a multiple-choice menu: + +`{{result_variable_name}}=$(whiptail --title "{{title}}" --menu "{{message}}" {{height_in_chars}} {{width_in_chars}} {{menu_display_height}} "{{value_1}}" "{{display_text_1}}" "{{value_n}}" "{{display_text_n}}" ..... 3>&1 1>&2 2>&3)` diff --git a/linux/wifi-menu b/linux/wifi-menu new file mode 100644 index 00000000..cc79b8cd --- /dev/null +++ b/linux/wifi-menu @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wifi-menu + +> Interactively connect to a wireless network. +> More information: . + +- Set up a wireless connection interactively: + +`wifi-menu` + +- Interactively set up a connection to a network and obscure the password: + +`wifi-menu --obscure` + +- Display help: + +`wifi-menu --help` diff --git a/linux/wine b/linux/wine new file mode 100644 index 00000000..2129edb9 --- /dev/null +++ b/linux/wine @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wine + +> Run Windows executables on Unix-based systems. +> More information: . + +- Run a specific program inside the `wine` environment: + +`wine {{command}}` + +- Run a specific program in background: + +`wine start {{command}}` + +- Install/uninstall an MSI package: + +`wine msiexec /{{i|x}} {{path/to/package.msi}}` + +- Run `File Explorer`, `Notepad`, or `WordPad`: + +`wine {{explorer|notepad|write}}` + +- Run `Registry Editor`, `Control Panel`, or `Task Manager`: + +`wine {{regedit|control|taskmgr}}` + +- Run the configuration tool: + +`wine winecfg` diff --git a/linux/winetricks b/linux/winetricks new file mode 100644 index 00000000..c45b70d3 --- /dev/null +++ b/linux/winetricks @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# winetricks + +> Manage Wine virtual Windows environments. +> More information: . + +- Start a graphical setup at the default Wine location: + +`winetricks` + +- Specify a custom Wine directory to run Winetricks in: + +`WINEPREFIX={{path/to/wine_directory}} winetricks` + +- Install a Windows DLL or component to the default Wine directory: + +`winetricks {{package}}` diff --git a/linux/wipefs b/linux/wipefs new file mode 100644 index 00000000..666c32cd --- /dev/null +++ b/linux/wipefs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wipefs + +> Wipe filesystem, raid, or partition-table signatures from a device. +> More information: . + +- Display signatures for specified device: + +`sudo wipefs {{/dev/sdX}}` + +- Wipe all available signature types for a specific device with no recursion into partitions: + +`sudo wipefs --all {{/dev/sdX}}` + +- Wipe all available signature types for the device and partitions using a glob pattern: + +`sudo wipefs --all {{/dev/sdX}}*` + +- Perform dry run: + +`sudo wipefs --all --no-act {{/dev/sdX}}` + +- Force wipe, even if the filesystem is mounted: + +`sudo wipefs --all --force {{/dev/sdX}}` diff --git a/linux/wl-copy b/linux/wl-copy new file mode 100644 index 00000000..9742ee1e --- /dev/null +++ b/linux/wl-copy @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wl-copy + +> Clear and copy to Wayland clipboard. +> See also: `wl-paste`, `xclip`. +> More information: . + +- Copy the text to the clipboard: + +`wl-copy "{{text}}"` + +- Pipe the command (`ls`) output to the clipboard: + +`{{ls}} | wl-copy` + +- Copy for only one paste and then clear it: + +`wl-copy --paste-once "{{text}}"` + +- Copy an image: + +`wl-copy < {{path/to/image}}` + +- Clear the clipboard: + +`wl-copy --clear` diff --git a/linux/wl-paste b/linux/wl-paste new file mode 100644 index 00000000..1762b910 --- /dev/null +++ b/linux/wl-paste @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wl-paste + +> Paste content in Wayland clipboard. +> See also: `wl-copy`, `xclip`. +> More information: . + +- Paste the contents of the clipboard: + +`wl-paste` + +- Write the contents of the clipboard to a file: + +`wl-paste > {{path/to/file}}` + +- Pipe the contents of the clipboard to a command: + +`wl-paste | {{command}}` diff --git a/linux/wmctrl b/linux/wmctrl new file mode 100644 index 00000000..2b9cf418 --- /dev/null +++ b/linux/wmctrl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wmctrl + +> CLI for X Window Manager. +> More information: . + +- List all windows, managed by the window manager: + +`wmctrl -l` + +- Switch to the first window whose (partial) title matches: + +`wmctrl -a {{window_title}}` + +- Move a window to the current workspace, raise it and give it focus: + +`wmctrl -R {{window_title}}` + +- Switch to a workspace: + +`wmctrl -s {{workspace_number}}` + +- Select a window and toggle fullscreen: + +`wmctrl -r {{window_title}} -b toggle,fullscreen` + +- Select a window a move it to a workspace: + +`wmctrl -r {{window_title}} -t {{workspace_number}}` diff --git a/linux/wodim b/linux/wodim new file mode 100644 index 00000000..c1ba0130 --- /dev/null +++ b/linux/wodim @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wodim + +> Command (aliased as `cdrecord` on some systems) for recording data to CDs or DVDs. +> Some invocations of wodim can cause destructive actions, such as erasing all the data on a disc. +> More information: . + +- Display optical drives available to `wodim`: + +`wodim --devices` + +- Record ("burn") an audio-only disc: + +`wodim dev=/dev/{{optical_drive}} -audio {{track*.cdaudio}}` + +- Burn a file to a disc, ejecting the disc once done (some recorders require this): + +`wodim -eject dev=/dev/{{optical_drive}} -data {{file.iso}}` + +- Burn a file to the disc in an optical drive, potentially writing to multiple discs in succession: + +`wodim -tao dev=/dev/{{optical_drive}} -data {{file.iso}}` diff --git a/linux/woeusb b/linux/woeusb new file mode 100644 index 00000000..cd01a795 --- /dev/null +++ b/linux/woeusb @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# woeusb + +> Windows media creation tool. +> More information: . + +- Format a USB then create a bootable Windows installation drive: + +`woeusb --device {{path/to/windows.iso}} {{/dev/sdX}}` + +- Copy Windows files to an existing partition of a USB storage device and make it bootable, without erasing the current data: + +`woeusb --partition {{path/to/windows.iso}} {{/dev/sdXN}}` diff --git a/linux/wol b/linux/wol new file mode 100644 index 00000000..1cd359c7 --- /dev/null +++ b/linux/wol @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wol + +> Client for sending Wake-on-LAN magic packets. +> More information: . + +- Send a WoL packet to a device: + +`wol {{mac_address}}` + +- Send a WoL packet to a device in another subnet based on its IP: + +`wol --ipaddr={{ip_address}} {{mac_address}}` + +- Send a WoL packet to a device in another subnet based on its hostname: + +`wol --host={{hostname}} {{mac_address}}` + +- Send a WoL packet to a specific port on a host: + +`wol --port={{port_number}} {{mac_address}}` + +- Read hardware addresses, IP addresses/hostnames, optional ports and SecureON passwords from a file: + +`wol --file={{path/to/file}}` + +- Turn on verbose output: + +`wol --verbose {{mac_address}}` diff --git a/linux/wpa_cli b/linux/wpa_cli new file mode 100644 index 00000000..c0515cd2 --- /dev/null +++ b/linux/wpa_cli @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wpa_cli + +> Add and configure wlan interfaces. +> More information: . + +- Scan for available networks: + +`wpa_cli scan` + +- Show scan results: + +`wpa_cli scan_results` + +- Add a network: + +`wpa_cli add_network {{number}}` + +- Set a network's SSID: + +`wpa_cli set_network {{number}} ssid "{{SSID}}"` + +- Enable network: + +`wpa_cli enable_network {{number}}` + +- Save config: + +`wpa_cli save_config` diff --git a/linux/wpa_passphrase b/linux/wpa_passphrase new file mode 100644 index 00000000..4de55fbc --- /dev/null +++ b/linux/wpa_passphrase @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wpa_passphrase + +> Generate a WPA-PSK key from an ASCII passphrase for a SSID. +> More information: . + +- Compute and display the WPA-PSK key for a given SSID reading the passphrase from `stdin`: + +`wpa_passphrase {{SSID}}` + +- Compute and display WPA-PSK key for a given SSID specifying the passphrase as an argument: + +`wpa_passphrase {{SSID}} {{passphrase}}` diff --git a/linux/wpctl b/linux/wpctl new file mode 100644 index 00000000..7a623788 --- /dev/null +++ b/linux/wpctl @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wpctl + +> Manage WirePlumber, a session and policy manager for PipeWire. +> Note: you can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink. +> More information: . + +- List all objects managed by WirePlumber: + +`wpctl status` + +- Print all properties of an object: + +`wpctl inspect {{id}}` + +- Set an object to be the default in its group: + +`wpctl set-default {{id}}` + +- Get the volume of a sink: + +`wpctl get-volume {{id}}` + +- Set the volume of a sink to `n` percent: + +`wpctl set-volume {{id}} {{n}}%` + +- Increase/Decrease the volume of a sink by `n` percent: + +`wpctl set-volume {{id}} {{n}}%{{+|-}}` + +- Mute/Unmute a sink (1 is mute, 0 is unmute): + +`wpctl set-mute {{id}} {{1|0|toggle}}` diff --git a/linux/wtf b/linux/wtf new file mode 100644 index 00000000..ca04f3ae --- /dev/null +++ b/linux/wtf @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# wtf + +> Show the expansions of acronyms. +> More information: . + +- Expand a given acronym: + +`wtf {{IMO}}` + +- Specify a computer related search type: + +`wtf -t {{comp}} {{WWW}}` diff --git a/linux/x0vncserver b/linux/x0vncserver new file mode 100644 index 00000000..fb2d003d --- /dev/null +++ b/linux/x0vncserver @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# x0vncserver + +> TigerVNC Server for X displays. +> More information: . + +- Start a VNC server using a passwordfile: + +`x0vncserver -display {{:0}} -passwordfile {{path/to/file}}` + +- Start a VNC server using a specific port: + +`x0vncserver -display {{:0}} -rfbport {{port}}` diff --git a/linux/x11vnc b/linux/x11vnc new file mode 100644 index 00000000..351b97b2 --- /dev/null +++ b/linux/x11vnc @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# x11vnc + +> A VNC server that will enable VNC on an existing display server. +> By default, the server will automatically terminate once all clients disconnect from it. +> More information: . + +- Launch a VNC server that allows multiple clients to connect: + +`x11vnc -shared` + +- Launch a VNC server in view-only mode, and which won't terminate once the last client disconnects: + +`x11vnc -forever -viewonly` + +- Launch a VNC server on a specific display and screen (both starting at index zero): + +`x11vnc -display :{{display}}.{{screen}}` + +- Launch a VNC server on the third display's default screen: + +`x11vnc -display :{{2}}` + +- Launch a VNC server on the first display's second screen: + +`x11vnc -display :{{0}}.{{1}}` diff --git a/linux/xauth b/linux/xauth new file mode 100644 index 00000000..deaaa497 --- /dev/null +++ b/linux/xauth @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xauth + +> Edit and display the authorization information used in connecting to the X server. +> More information: . + +- Start interactive mode with a specific authority file (defaults to `~/.Xauthority`): + +`xauth -f {{path/to/file}}` + +- Display information about the authority file: + +`xauth info` + +- Display authorization entries for all the displays: + +`xauth list` + +- Add an authorization for a specific display: + +`xauth add {{display_name}} {{protocol_name}} {{key}}` + +- Remove the authorization for a specific display: + +`xauth remove {{display_name}}` + +- Print the authorization entry for the current display to `stdout`: + +`xauth extract - $DISPLAY` + +- Merge the authorization entries from a specific file into the authorization database: + +`cat {{path/to/file}} | xauth merge -` + +- Display help: + +`xauth --help` diff --git a/linux/xbacklight b/linux/xbacklight new file mode 100644 index 00000000..4843a78f --- /dev/null +++ b/linux/xbacklight @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xbacklight + +> Utility to adjust backlight brightness using the RandR extension. +> More information: . + +- Get the current screen brightness as a percentage: + +`xbacklight` + +- Set the screen brightness to 40%: + +`xbacklight -set {{40}}` + +- Increase current brightness by 25%: + +`xbacklight -inc {{25}}` + +- Decrease current brightness by 75%: + +`xbacklight -dec {{75}}` + +- Increase backlight to 100%, over 60 seconds (value given in ms), using 60 steps: + +`xbacklight -set {{100}} -time {{60000}} -steps {{60}}` diff --git a/linux/xbps b/linux/xbps new file mode 100644 index 00000000..2add2b8c --- /dev/null +++ b/linux/xbps @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xbps + +> The X Binary Package System is the package manager used by Void Linux. +> For equivalent commands in other package managers, see . +> More information: . + +- View documentation for installing and updating packages: + +`tldr xbps-install` + +- View documentation for removing packages: + +`tldr xbps-remove` + +- View documentation for querying for package and repository information: + +`tldr xbps-query` diff --git a/linux/xbps-install b/linux/xbps-install new file mode 100644 index 00000000..8729cdeb --- /dev/null +++ b/linux/xbps-install @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xbps-install + +> XBPS utility to (re)install and update packages. +> See also: `xbps`. +> More information: . + +- Install a new package: + +`xbps-install {{package}}` + +- Synchronize and update all packages: + +`xbps-install --sync --update` diff --git a/linux/xbps-query b/linux/xbps-query new file mode 100644 index 00000000..d9050b3c --- /dev/null +++ b/linux/xbps-query @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xbps-query + +> XBPS utility to query for package and repository information. +> See also: `xbps`. +> More information: . + +- Search for a package in remote repositories using a regular expression or a keyword (if `--regex` is omitted): + +`xbps-query --search {{regular_expression|keyword}} --repository --regex` + +- Show information about an installed package: + +`xbps-query --show {{package}}` + +- Show information about a package in remote repositories: + +`xbps-query --show {{package}} --repository` + +- List packages registered in the package database: + +`xbps-query --list-pkgs` + +- List explicitly installed packages (i.e. not automatically installed as dependencies): + +`xbps-query --list-manual-pkgs` diff --git a/linux/xbps-remove b/linux/xbps-remove new file mode 100644 index 00000000..ac8f8290 --- /dev/null +++ b/linux/xbps-remove @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xbps-remove + +> XBPS utility to remove packages. +> See also: `xbps`. +> More information: . + +- Remove a package: + +`xbps-remove {{package}}` + +- Remove a package and its dependencies: + +`xbps-remove --recursive {{package}}` + +- Remove orphan packages (installed as dependencies but no longer required by any package): + +`xbps-remove --remove-orphans` + +- Remove obsolete packages from the cache: + +`xbps-remove --clean-cache` diff --git a/linux/xclip b/linux/xclip new file mode 100644 index 00000000..97949528 --- /dev/null +++ b/linux/xclip @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xclip + +> X11 clipboard manipulation tool, similar to `xsel`. +> Handles the X primary and secondary selections, plus the system clipboard (`Ctrl + C`/`Ctrl + V`). +> See also: `wl-copy`. +> More information: . + +- Copy the output from a command to the X11 primary selection area (clipboard): + +`echo 123 | xclip` + +- Copy the output from a command to a given X11 selection area: + +`echo 123 | xclip -selection {{primary|secondary|clipboard}}` + +- Copy the output from a command to the system clipboard, using short notation: + +`echo 123 | xclip -sel clip` + +- Copy the contents of a file into the system clipboard: + +`xclip -sel clip {{input_file.txt}}` + +- Copy the contents of a PNG into the system clipboard (can be pasted in other programs correctly): + +`xclip -sel clip -t image/png {{input_file.png}}` + +- Copy the user input in the console into the system clipboard: + +`xclip -i` + +- Paste the contents of the X11 primary selection area to the console: + +`xclip -o` + +- Paste the contents of the system clipboard to the console: + +`xclip -o -sel clip` diff --git a/linux/xclock b/linux/xclock new file mode 100644 index 00000000..d2bbda7b --- /dev/null +++ b/linux/xclock @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xclock + +> Display the time in analog or digital form. +> More information: . + +- Display an analog clock: + +`xclock` + +- Display a 24-hour digital clock with the hour and minute fields only: + +`xclock -digital -brief` + +- Display a digital clock using an strftime format string (see strftime(3)): + +`xclock -digital -strftime {{format}}` + +- Display a 24-hour digital clock with the hour, minute and second fields that updates every second: + +`xclock -digital -strftime '%H:%M:%S' -update 1` + +- Display a 12-hour digital clock with the hour and minute fields only: + +`xclock -digital -twelve -brief` diff --git a/linux/xcowsay b/linux/xcowsay new file mode 100644 index 00000000..a425887f --- /dev/null +++ b/linux/xcowsay @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xcowsay + +> Display a cute cow and message on your Linux desktop. +> The cow is displayed for either a fixed amount of time, or an amount of time calculated from the size of the text. Click on the cow to dismiss it immediately. +> More information: . + +- Display a cow saying "hello, world": + +`xcowsay "{{hello, world}}"` + +- Display a cow with output from another command: + +`ls | xcowsay` + +- Display a cow at the specified X and Y coordinates: + +`xcowsay --at={{X}},{{Y}}` + +- Display a different sized cow: + +`xcowsay --cow-size={{small|med|large}}` + +- Display a thought bubble instead of a speech bubble: + +`xcowsay --think` + +- Display a different image instead of the default cow: + +`xcowsay --image={{path/to/file}}` diff --git a/linux/xcursorgen b/linux/xcursorgen new file mode 100644 index 00000000..e4597e41 --- /dev/null +++ b/linux/xcursorgen @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xcursorgen + +> Create an X cursor file from a collection of PNGs. +> If `--prefix` is omitted, the image files must be located in the current working directory. +> More information: . + +- Create an X cursor file using a configuration file: + +`xcursorgen {{path/to/config.cursor}} {{path/to/output_file}}` + +- 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}}` + +- Create an X cursor file using a configuration file and write the output to `stdout`: + +`xcursorgen {{path/to/config.cursor}}` diff --git a/linux/xdg-desktop-menu b/linux/xdg-desktop-menu new file mode 100644 index 00000000..1fc66408 --- /dev/null +++ b/linux/xdg-desktop-menu @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdg-desktop-menu + +> Command-line tool for installing or uninstalling desktop menu items. +> More information: . + +- Install an application to the desktop menu system: + +`xdg-desktop-menu install {{path/to/file.desktop}}` + +- Install an application to the desktop menu system with the vendor prefix check disabled: + +`xdg-desktop-menu install --novendor {{path/to/file.desktop}}` + +- Uninstall an application from the desktop menu system: + +`xdg-desktop-menu uninstall {{path/to/file.desktop}}` + +- Force an update of the desktop menu system: + +`xdg-desktop-menu forceupdate --mode {{user|system}}` diff --git a/linux/xdg-mime b/linux/xdg-mime new file mode 100644 index 00000000..955b190a --- /dev/null +++ b/linux/xdg-mime @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdg-mime + +> Query and manage MIME types according to the XDG standard. +> More information: . + +- Display the MIME type of a file: + +`xdg-mime query filetype {{path/to/file}}` + +- Display the default application for opening PNGs: + +`xdg-mime query default {{image/png}}` + +- Display the default application for opening a specific file: + +`xdg-mime query default $(xdg-mime query filetype {{path/to/file}})` + +- Set imv as the default application for opening PNG and JPEG images: + +`xdg-mime default {{imv.desktop}} {{image/png}} {{image/jpeg}}` diff --git a/linux/xdg-open b/linux/xdg-open new file mode 100644 index 00000000..6124cb5c --- /dev/null +++ b/linux/xdg-open @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdg-open + +> Opens a file or URL in the user's preferred application. +> More information: . + +- Open the current directory in the default file explorer: + +`xdg-open .` + +- Open a URL in the default browser: + +`xdg-open {{https://example.com}}` + +- Open an image in the default image viewer: + +`xdg-open {{path/to/image}}` + +- Open a PDF in the default PDF viewer: + +`xdg-open {{path/to/pdf}}` + +- Display help: + +`xdg-open --help` diff --git a/linux/xdg-settings b/linux/xdg-settings new file mode 100644 index 00000000..5462ae36 --- /dev/null +++ b/linux/xdg-settings @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdg-settings + +> Manage settings of XDG-compatible desktop environments. +> More information: . + +- Print the default web browser: + +`xdg-settings get {{default-web-browser}}` + +- Set the default web browser to Firefox: + +`xdg-settings set {{default-web-browser}} {{firefox.desktop}}` + +- Set the default mail URL scheme handler to Evolution: + +`xdg-settings set {{default-url-scheme-handler}} {{mailto}} {{evolution.desktop}}` + +- Set the default PDF document viewer: + +`xdg-settings set {{pdf-viewer.desktop}}` + +- Display help: + +`xdg-settings --help` diff --git a/linux/xdg-user-dirs-update b/linux/xdg-user-dirs-update new file mode 100644 index 00000000..0ce6b2e5 --- /dev/null +++ b/linux/xdg-user-dirs-update @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdg-user-dirs-update + +> Update XDG user directories. +> More information: . + +- Change XDG's DESKTOP directory to the specified directory (must be absolute): + +`xdg-user-dirs-update --set DESKTOP "{{path/to/directory}}"` + +- Write the result to the specified dry-run-file instead of the `user-dirs.dirs` file: + +`xdg-user-dirs-update --dummy-output "{{path/to/dry_run_file}}" --set {{xdg_user_directory}} "{{path/to/directory}}"` diff --git a/linux/xdotool b/linux/xdotool new file mode 100644 index 00000000..787f8db4 --- /dev/null +++ b/linux/xdotool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xdotool + +> Command-line automation for X11. +> More information: . + +- Retrieve the X-Windows window ID of the running Firefox window(s): + +`xdotool search --onlyvisible --name {{firefox}}` + +- Click the right mouse button: + +`xdotool click {{3}}` + +- Get the ID of the currently active window: + +`xdotool getactivewindow` + +- Focus on the window with ID of 12345: + +`xdotool windowfocus --sync {{12345}}` + +- Type a message, with a 500ms delay for each letter: + +`xdotool type --delay {{500}} "Hello world"` + +- Press the enter key: + +`xdotool key {{KP_Enter}}` diff --git a/linux/xed b/linux/xed new file mode 100644 index 00000000..7e3ca079 --- /dev/null +++ b/linux/xed @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xed + +> Edit files in Cinnamon desktop environment. +> More information: . + +- Start the editor: + +`xed` + +- Open specific files: + +`xed {{path/to/file1 path/to/file2 ...}}` + +- Open files using a specific encoding: + +`xed --encoding {{WINDOWS-1252}} {{path/to/file1 path/to/file2 ...}}` + +- Print all supported encodings: + +`xed --list-encodings` + +- Open a file and go to a specific line: + +`xed +{{10}} {{path/to/file}}` diff --git a/linux/xeyes b/linux/xeyes new file mode 100644 index 00000000..8dc71d39 --- /dev/null +++ b/linux/xeyes @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xeyes + +> Display eyes on the screen that follow the mouse cursor. +> More information: . + +- Launch xeyes on the local machine's default display: + +`xeyes` + +- Launch xeyes on a remote machine's display 0, screen 0: + +`xeyes -display {{remote_host}}:{{0}}.{{0}}` diff --git a/linux/xfce4-screenshooter b/linux/xfce4-screenshooter new file mode 100644 index 00000000..52646b4f --- /dev/null +++ b/linux/xfce4-screenshooter @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xfce4-screenshooter + +> The XFCE4 screenshot tool. +> More information: . + +- Launch the screenshooter GUI: + +`xfce4-screenshooter` + +- Take a screenshot of the entire screen and launch the GUI to ask how to proceed: + +`xfce4-screenshooter --fullscreen` + +- Take a screenshot of the entire screen and save it in the specified directory: + +`xfce4-screenshooter --fullscreen --save {{path/to/directory}}` + +- Wait some time before taking the screenshot: + +`xfce4-screenshooter --delay {{seconds}}` + +- Take a screenshot of a region of the screen (select using the mouse): + +`xfce4-screenshooter --region` + +- Take a screenshot of the active window, and copy it to the clipboard: + +`xfce4-screenshooter --window --clipboard` + +- Take a screenshot of the active window, and open it with a chosen program: + +`xfce4-screenshooter --window --open {{gimp}}` diff --git a/linux/xfce4-terminal b/linux/xfce4-terminal new file mode 100644 index 00000000..643147c3 --- /dev/null +++ b/linux/xfce4-terminal @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xfce4-terminal + +> The XFCE4 terminal emulator. +> More information: . + +- Open a new terminal window: + +`xfce4-terminal` + +- Set the initial title: + +`xfce4-terminal --initial-title "{{initial_title}}"` + +- Open a new tab in the current terminal window: + +`xfce4-terminal --tab` + +- Execute a command in a new terminal window: + +`xfce4-terminal --command "{{command_with_args}}"` + +- Keep the terminal around after the executed command finishes executing: + +`xfce4-terminal --command "{{command_with_args}}" --hold` + +- Open multiple new tabs, executing a command in each: + +`xfce4-terminal --tab --command "{{command1}}" --tab --command "{{command2}}"` diff --git a/linux/xfreerdp b/linux/xfreerdp new file mode 100644 index 00000000..f5572503 --- /dev/null +++ b/linux/xfreerdp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xfreerdp + +> Free Remote Desktop Protocol implementation. +> More information: . + +- Connect to a FreeRDP server: + +`xfreerdp /u:{{username}} /p:{{password}} /v:{{ip_address}}` + +- Connect to a FreeRDP server and activate audio output redirection using `sys:alsa` device: + +`xfreerdp /u:{{username}} /p:{{password}} /v:{{ip_address}} /sound:{{sys:alsa}}` + +- Connect to a FreeRDP server with dynamic resolution: + +`xfreerdp /v:{{ip_address}} /u:{{username}} /p:{{password}} /dynamic-resolution` + +- Connect to a FreeRDP server with clipboard redirection: + +`xfreerdp /v:{{ip_address}} /u:{{username}} /p:{{password}} +clipboard` + +- Connect to a FreeRDP server ignoring any certificate checks: + +`xfreerdp /v:{{ip_address}} /u:{{username}} /p:{{password}} /cert:ignore` + +- Connect to a FreeRDP server with a shared directory: + +`xfreerdp /v:{{ip_address}} /u:{{username}} /p:{{password}} /drive:{{path/to/directory}},{{share_name}}` diff --git a/linux/xinput b/linux/xinput new file mode 100644 index 00000000..d63c4fcc --- /dev/null +++ b/linux/xinput @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xinput + +> List available input devices, query information about a device and change input device settings. +> More information: . + +- List all input devices: + +`xinput list` + +- Disable an input: + +`xinput disable {{id}}` + +- Enable an input: + +`xinput enable {{id}}` + +- Disconnect an input from its master: + +`xinput float {{id}}` + +- Reattach an input as slave to a master: + +`xinput reattach {{id}} {{master_id}}` + +- List settings of an input device: + +`xinput list-props {{id}}` + +- Change a setting of an input device: + +`xinput set-prop {{id}} {{setting_id}} {{value}}` diff --git a/linux/xman b/linux/xman new file mode 100644 index 00000000..fa15ae11 --- /dev/null +++ b/linux/xman @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xman + +> Manual page viewer for X Window System. +> More information: . + +- Start `xman` in three-button window: + +`xman` + +- Open the manual page output stored in a given file: + +`xman -helpfile {{filename}}` + +- Show both manual page and directory: + +`xman -bothshown` diff --git a/linux/xmodmap b/linux/xmodmap new file mode 100644 index 00000000..f371de7d --- /dev/null +++ b/linux/xmodmap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xmodmap + +> Utility for modifying keymaps and pointer button mappings in X. +> More information: . + +- Swap left-click and right-click on the pointer: + +`xmodmap -e 'pointer = 3 2 1'` + +- Reassign a key on the keyboard to another key: + +`xmodmap -e 'keycode {{keycode}} = {{keyname}}'` + +- Disable a key on the keyboard: + +`xmodmap -e 'keycode {{keycode}} ='` + +- Execute all xmodmap expressions in the specified file: + +`xmodmap {{path/to/file}}` diff --git a/linux/xmount b/linux/xmount new file mode 100644 index 00000000..0a19b823 --- /dev/null +++ b/linux/xmount @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xmount + +> Convert on-the-fly between multiple input and output hard disk image types with optional write cache support. +> Creates a virtual file system using FUSE (Filesystem in Userspace) that contains a virtual representation of the input image. +> More information: . + +- Mount a `.raw` image file into a DMG container file: + +`xmount --in {{raw}} {{path/to/image.dd}} --out {{dmg}} {{mountpoint}}` + +- Mount an EWF image file with write-cache support into a VHD file to boot from: + +`xmount --cache {{path/to/cache.ovl}} --in {{ewf}} {{path/to/image.E??}} --out {{vhd}} {{mountpoint}}` + +- Mount the first partition at sector 2048 into a new `.raw` image file: + +`xmount --offset {{2048}} --in {{raw}} {{path/to/image.dd}} --out {{raw}} {{mountpoint}}` diff --git a/linux/xrandr b/linux/xrandr new file mode 100644 index 00000000..32c0088e --- /dev/null +++ b/linux/xrandr @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xrandr + +> Set the size, orientation and/or reflection of the outputs for a screen. +> More information: . + +- Display the current state of the system (known screens, resolutions, ...): + +`xrandr --query` + +- Disable disconnected outputs and enable connected ones with default settings: + +`xrandr --auto` + +- Change the resolution and update frequency of DisplayPort 1 to 1920x1080, 60Hz: + +`xrandr --output {{DP1}} --mode {{1920x1080}} --rate {{60}}` + +- Set the resolution of HDMI2 to 1280x1024 and put it on the right of DP1: + +`xrandr --output {{HDMI2}} --mode {{1280x1024}} --right-of {{DP1}}` + +- Disable the VGA1 output: + +`xrandr --output {{VGA1}} --off` + +- Set the brightness for LVDS1 to 50%: + +`xrandr --output {{LVDS1}} --brightness {{0.5}}` diff --git a/linux/xrdb b/linux/xrdb new file mode 100644 index 00000000..284e54d9 --- /dev/null +++ b/linux/xrdb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xrdb + +> X window server's resource database utility for Unix-like systems. +> More information: . + +- Start `xrdb` in interactive mode: + +`xrdb` + +- Load values (e.g. style rules) from a resource file: + +`xrdb -load {{~/.Xresources}}` + +- Query the resource database and print currently set values: + +`xrdb -query` diff --git a/linux/xsel b/linux/xsel new file mode 100644 index 00000000..9c98ff0f --- /dev/null +++ b/linux/xsel @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xsel + +> X11 selection and clipboard manipulation tool. +> More information: . + +- Use a command's output as input of the clip[b]oard (equivalent to `Ctrl + C`): + +`echo 123 | xsel -ib` + +- Use the contents of a file as input of the clipboard: + +`cat {{path/to/file}} | xsel -ib` + +- Output the clipboard's contents into the terminal (equivalent to `Ctrl + V`): + +`xsel -ob` + +- Output the clipboard's contents into a file: + +`xsel -ob > {{path/to/file}}` + +- Clear the clipboard: + +`xsel -cb` + +- Output the X11 primary selection's contents into the terminal (equivalent to a mouse middle-click): + +`xsel -op` diff --git a/linux/xset b/linux/xset new file mode 100644 index 00000000..938eb1bf --- /dev/null +++ b/linux/xset @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xset + +> User preference utility for X. +> More information: . + +- Disable the screensaver: + +`xset s off` + +- Disable the bell sound: + +`xset b off` + +- Set the screensaver to start after 60 minutes of inactivity: + +`xset s 3600 3600` + +- Disable DPMS (Energy Star) features: + +`xset -dpms` + +- Enable DPMS (Energy Star) features: + +`xset +dpms` diff --git a/linux/xsetwacom b/linux/xsetwacom new file mode 100644 index 00000000..f82cb941 --- /dev/null +++ b/linux/xsetwacom @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xsetwacom + +> Command-line tool to change settings for Wacom pen tablets at runtime. +> More information: . + +- List all the available Wacom devices. The device name is in the first column: + +`xsetwacom list` + +- Set Wacom area to specific screen. Get name of the screen with `xrandr`: + +`xsetwacom set "{{device_name}}" MapToOutput {{screen}}` + +- Set mode to relative (like a mouse) or absolute (like a pen) mode: + +`xsetwacom set "{{device_name}}" Mode "{{Relative|Absolute}}"` + +- Rotate the input (useful for tablet-PC when rotating screen) by 0|90|180|270 degrees from "natural" rotation: + +`xsetwacom set "{{device_name}}" Rotate {{none|half|cw|ccw}}` + +- Set button to only work when the tip of the pen is touching the tablet: + +`xsetwacom set "{{device_name}}" TabletPCButton "on"` diff --git a/linux/xterm b/linux/xterm new file mode 100644 index 00000000..706b7073 --- /dev/null +++ b/linux/xterm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xterm + +> A terminal emulator for the X Window System. +> More information: . + +- Open the terminal with a title of `Example`: + +`xterm -T {{Example}}` + +- Open the terminal in fullscreen mode: + +`xterm -fullscreen` + +- Open the terminal with a dark blue background and yellow foreground (font color): + +`xterm -bg {{darkblue}} -fg {{yellow}}` + +- Open the terminal with 100 characters per line and 35 lines, in screen position x=200px, y=20px: + +`xterm -geometry {{100}}x{{35}}+{{200}}+{{20}}` + +- Open the terminal using a Serif font and a font size equal to 20: + +`xterm -fa {{'Serif'}} -fs {{20}}` diff --git a/linux/xtrlock b/linux/xtrlock new file mode 100644 index 00000000..0f97cf3f --- /dev/null +++ b/linux/xtrlock @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xtrlock + +> Lock the X display until the user supplies their password. +> More information: . + +- Lock the display and show a padlock instead of the cursor: + +`xtrlock` + +- Display a blank screen as well as the padlock cursor: + +`xtrlock -b` + +- Fork the xtrlock process and return immediately: + +`xtrlock -f` diff --git a/linux/xvfb-run b/linux/xvfb-run new file mode 100644 index 00000000..2736843a --- /dev/null +++ b/linux/xvfb-run @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xvfb-run + +> Run a command in a virtual X server environment. +> More information: . + +- Run the specified command in a virtual X server: + +`xvfb-run {{command}}` + +- Try to get a free server number, if the default (99) is not available: + +`xvfb-run --auto-servernum {{command}}` + +- Pass arguments to the Xvfb server: + +`xvfb-run --server-args "{{-screen 0 1024x768x24}}" {{command}}` diff --git a/linux/xwinwrap b/linux/xwinwrap new file mode 100644 index 00000000..c9b0a60c --- /dev/null +++ b/linux/xwinwrap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xwinwrap + +> Run a player or a program as desktop background. +> More information: . + +- Run a video using mpv: + +`xwinwrap -b -nf -ov -- {{mpv}} -wid {{wid}} --loop --no-audio --no-resume-playback --panscan={{1.0}} {{path/to/video.mp4}}` + +- Run a video in fullscreen using mpv: + +`xwinwrap -b -nf -fs -ov -- {{mpv}} -wid {{wid}} --loop --no-audio --no-resume-playback --panscan={{1.0}} {{path/to/video.mp4}}` + +- Run a video using mpv with 80% opacity: + +`xwinwrap -b -nf -ov -o 0.8 --- {{mpv}} -wid {{wid}} --loop --no-audio --no-resume-playback --panscan={{1.0}} {{path/to/video.mp4}}` + +- Run a video using mpv in a second monitor 1600x900 with 1920 offset on X-axis: + +`xwinwrap -g 1600x900+1920 -b -nf -ov -- {{mpv}} -wid {{wid}} --loop --no-audio --no-resume-playback --panscan={{1.0}} {{path/to/video.mkv}}` diff --git a/linux/xxhsum b/linux/xxhsum new file mode 100644 index 00000000..5f4bcd2c --- /dev/null +++ b/linux/xxhsum @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# xxhsum + +> Print or verify checksums using fast non-cryptographic algorithm xxHash. +> More information: . + +- Calculate the checksum for a file using a specific algorithm: + +`xxhsum -H{{0|32|64|128}} {{path/to/file}}` + +- Run benchmark: + +`xxhsum -b` diff --git a/linux/yaourt b/linux/yaourt new file mode 100644 index 00000000..ba59c1ad --- /dev/null +++ b/linux/yaourt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# yaourt + +> Arch Linux utility for building packages from the Arch User Repository. +> More information: . + +- Synchronize and update all packages (including AUR): + +`yaourt -Syua` + +- Install a new package (includes AUR): + +`yaourt -S {{package}}` + +- Remove a package and its dependencies (includes AUR packages): + +`yaourt -Rs {{package}}` + +- Search the package database for a keyword (including AUR): + +`yaourt -Ss {{query}}` + +- List installed packages, versions, and repositories (AUR packages will be listed under the repository name 'local'): + +`yaourt -Q` diff --git a/linux/yay b/linux/yay new file mode 100644 index 00000000..b91e02f1 --- /dev/null +++ b/linux/yay @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# yay + +> Yet Another Yogurt: build and install packages from the Arch User Repository. +> Also see `pacman`. +> More information: . + +- Interactively search and install packages from the repos and AUR: + +`yay {{package_name|search_term}}` + +- Synchronize and update all packages from the repos and AUR: + +`yay` + +- Synchronize and update only AUR packages: + +`yay -Sua` + +- Install a new package from the repos and AUR: + +`yay -S {{package}}` + +- Remove an installed package and both its dependencies and configuration files: + +`yay -Rns {{package}}` + +- Search the package database for a keyword from the repos and AUR: + +`yay -Ss {{keyword}}` + +- Remove orphaned packages (installed as dependencies but not required by any package): + +`yay -Yc` + +- Show statistics for installed packages and system health: + +`yay -Ps` diff --git a/linux/yetris b/linux/yetris new file mode 100644 index 00000000..f67df862 --- /dev/null +++ b/linux/yetris @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# yetris + +> Clone of the game Tetris in the terminal. +> More information: . + +- Start a Tetris game: + +`yetris` + +- Navigate the piece horizontally: + +`{{Left|Right arrow key}}` + +- Rotate the piece clockwise or counterclockwise: + +`{{x|z}}` + +- Hold a piece (only one allowed at a time): + +`c` + +- Soft drop the piece: + +`` + +- Hard drop the piece: + +`` + +- Pause/unpause the game: + +`p` + +- Quit the game: + +`q` diff --git a/linux/yplan b/linux/yplan new file mode 100644 index 00000000..ff3c58a2 --- /dev/null +++ b/linux/yplan @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# yplan + +> Generate LaTeX code for a two-page vertical daily planner for any chosen year. +> The generated output can be converted or printed using conversion tools such as `pandoc`, `pdflatex`, or `xetex`. +> More information: . + +- Create a daily planner with specified language, lettercase (uppercase or lowercase) and year: + +`yplan {{language}} {{lettercase}} {{year}} > {{path/to/file.tex}}` diff --git a/linux/ytfzf b/linux/ytfzf new file mode 100644 index 00000000..6346c9ab --- /dev/null +++ b/linux/ytfzf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# ytfzf + +> A POSIX script that helps you find and download videos and music. +> More information: . + +- Search for videos on YouTube with thumbnail previews: + +`ytfzf --show-thumbnails {{search_pattern}}` + +- Play only the audio of the first item in a loop: + +`ytfzf --audio-only --auto-select --loop {{search_pattern}}` + +- Download a video from the history: + +`ytfzf --download --choose-from-history` + +- Play all the music found in a search: + +`ytfzf --audio-only --select-all {{search_pattern}}` + +- See the trending videos in an external menu: + +`ytfzf --trending --ext-menu {{search_pattern}}` + +- Search on PeerTube instead of YouTube: + +`ytfzf --peertube {{search_pattern}}` diff --git a/linux/yum b/linux/yum new file mode 100644 index 00000000..effd89a1 --- /dev/null +++ b/linux/yum @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# yum + +> Package management utility for RHEL, Fedora, and CentOS (for older versions). +> For equivalent commands in other package managers, see . +> More information: . + +- Install a new package: + +`yum install {{package}}` + +- Install a new package and assume yes to all questions (also works with update, great for automated updates): + +`yum -y install {{package}}` + +- Find the package that provides a particular command: + +`yum provides {{command}}` + +- Remove a package: + +`yum remove {{package}}` + +- Display available updates for installed packages: + +`yum check-update` + +- Upgrade installed packages to the newest available versions: + +`yum upgrade` diff --git a/linux/zathura b/linux/zathura new file mode 100644 index 00000000..719a3a68 --- /dev/null +++ b/linux/zathura @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zathura + +> A vim-like modal document viewer, with an integrated command-line. +> Make sure a backend is installed (poppler, PostScript, or DjVu). +> More information: . + +- Open a file: + +`zathura {{path/to/file}}` + +- Navigate left/up/down/right: + +`{{H|J|K|L|arrow keys}}` + +- Rotate: + +`r` + +- Invert Colors: + +` + R` + +- Search for text by a given string: + +`/{{string}}` + +- Create/delete bookmarks: + +`:{{bmark|bdelete}} {{bookmark_name}}` + +- List bookmarks: + +`:blist` diff --git a/linux/zbarcam b/linux/zbarcam new file mode 100644 index 00000000..bda64864 --- /dev/null +++ b/linux/zbarcam @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zbarcam + +> Scan and decode barcodes (and QR codes) from a video device. +> More information: . + +- Continuously read barcodes and print them to `stdout`: + +`zbarcam` + +- Disable output video window while scanning: + +`zbarcam --nodisplay` + +- Print barcodes without type information: + +`zbarcam --raw` + +- Define capture device: + +`zbarcam /dev/{{video_device}}` diff --git a/linux/zenity b/linux/zenity new file mode 100644 index 00000000..d09d048a --- /dev/null +++ b/linux/zenity @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zenity + +> Display dialogs from the command-line/shell scripts. +> Return user-inserted values or 1 if error. +> More information: . + +- Display the default question dialog: + +`zenity --question` + +- Display an info dialog displaying the text "Hello!": + +`zenity --info --text="{{Hello!}}"` + +- Display a name/password form and output the data separated by ";": + +`zenity --forms --add-entry="{{Name}}" --add-password="{{Password}}" --separator="{{;}}"` + +- Display a file selection form in which the user can only select directories: + +`zenity --file-selection --directory` + +- Display a progress bar which updates its message every second and show a progress percent: + +`{{(echo "#1"; sleep 1; echo "50"; echo "#2"; sleep 1; echo "100")}} | zenity --progress` diff --git a/linux/zforce b/linux/zforce new file mode 100644 index 00000000..77226054 --- /dev/null +++ b/linux/zforce @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zforce + +> Add a `.gz` extension to files compressed using `gzip`. +> More information: . + +- Add a `.gz` extension to the supplied Gzip files (Note: other files are ignored): + +`zforce {{path/to/file1 path/to/file2 ...}}` diff --git a/linux/zile b/linux/zile new file mode 100644 index 00000000..c61bc013 --- /dev/null +++ b/linux/zile @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zile + +> A lightweight clone of the Emacs text editor. +> More information: . + +- Start a buffer for temporary notes, which won't be saved: + +`zile` + +- Open a file: + +`zile {{path/to/file}}` + +- Save a file: + +` + X, + S` + +- Quit: + +` + X, + C` + +- Open a file at a specified line number: + +`zile +{{line_number}} {{path/to/file}}` + +- Undo changes: + +` + X, U` diff --git a/linux/zip b/linux/zip new file mode 100644 index 00000000..e3910383 --- /dev/null +++ b/linux/zip @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zip + +> Package and compress (archive) files into `zip` archive. +> See also: `unzip`. +> More information: . + +- Add files/directories to a specific archive: + +`zip -r {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Remove files/directories from a specific archive: + +`zip --delete {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Archive files/directories e[x]cluding specified ones: + +`zip {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} --exclude {{path/to/excluded_files_or_directories}}` + +- Archive files/directories with a specific compression level (`0` - the lowest, `9` - the highest): + +`zip -r -{{0..9}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Create an encrypted archive with a specific password: + +`zip -r --encrypt {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Archive files/directories to a multi-part [s]plit `zip` archive (e.g. 3 GB parts): + +`zip -r -s {{3g}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Print a specific archive contents: + +`zip -sf {{path/to/compressed.zip}}` diff --git a/linux/zipcloak b/linux/zipcloak new file mode 100644 index 00000000..efe10deb --- /dev/null +++ b/linux/zipcloak @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zipcloak + +> Encrypt the contents within a zipfile. +> More information: . + +- Encrypt the contents of a zipfile: + +`zipcloak {{path/to/archive.zip}}` + +- [d]ecrypt the contents of a zipfile: + +`zipcloak -d {{path/to/archive.zip}}` + +- [O]utput the encrypted contents into a new zipfile: + +`zipcloak {{path/to/archive.zip}} -O {{path/to/encrypted.zip}}` diff --git a/linux/zipsplit b/linux/zipsplit new file mode 100644 index 00000000..9ce52fef --- /dev/null +++ b/linux/zipsplit @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zipsplit + +> Read a zipfile and split it into smaller zipfiles. +> More information: . + +- Split zipfile into pieces that are no larger than a particular size [n]: + +`zipsplit -n {{size}} {{path/to/archive.zip}}` + +- [p]ause between the creation of each split zipfile: + +`zipsplit -p -n {{size}} {{path/to/archive.zip}}` + +- Output the split zipfiles into the `archive` directory: + +`zipsplit -b {{archive}} -n {{size}} {{path/to/archive.zip}}` diff --git a/linux/zramctl b/linux/zramctl new file mode 100644 index 00000000..f56fac69 --- /dev/null +++ b/linux/zramctl @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zramctl + +> Setup and control zram devices. +> Use `mkfs` or `mkswap` to format zram devices to partitions. +> More information: . + +- Check if zram is enabled: + +`lsmod | grep -i zram` + +- Enable zram with a dynamic number of devices (use `zramctl` to configure devices further): + +`sudo modprobe zram` + +- Enable zram with exactly 2 devices: + +`sudo modprobe zram num_devices={{2}}` + +- Find and initialize the next free zram device to a 2 GB virtual drive using LZ4 compression: + +`sudo zramctl --find --size {{2GB}} --algorithm {{lz4}}` + +- List currently initialized devices: + +`zramctl` diff --git a/linux/zypper b/linux/zypper new file mode 100644 index 00000000..50c463c9 --- /dev/null +++ b/linux/zypper @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# zypper + +> SUSE & openSUSE package management utility. +> For equivalent commands in other package managers, see . +> More information: . + +- Synchronize list of packages and versions available: + +`zypper refresh` + +- Install a new package: + +`zypper install {{package}}` + +- Remove a package: + +`zypper remove {{package}}` + +- Upgrade installed packages to the newest available versions: + +`zypper update` + +- Search package via keyword: + +`zypper search {{keyword}}` + +- Show information related to configured repositories: + +`zypper repos --sort-by-priority` diff --git a/liquidctl b/liquidctl new file mode 100644 index 00000000..0f918d8b --- /dev/null +++ b/liquidctl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# liquidctl + +> Control liquid coolers. +> More information: . + +- List available devices: + +`liquidctl list` + +- Initialize all supported devices: + +`sudo liquidctl initialize all` + +- Print the status of available liquid coolers: + +`liquidctl status` + +- Match a string in product name to pick a device and set its fan speed to 0% at 20°C, 50% at 50°C and 100% at 70°C: + +`liquidctl --match {{string}} set fan speed {{20 0 50 50 70 100}}` diff --git a/lispmtopgm b/lispmtopgm new file mode 100644 index 00000000..16c253c4 --- /dev/null +++ b/lispmtopgm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lispmtopgm + +> Convert a Lisp Machine bitmap into a PGM image. +> See also: `pgmtolispm`. +> More information: . + +- Convert the specified Lisp Machine bitmap file into a PGM image: + +`lispmtopgm {{path/to/input.lispm}} > {{path/to/output.pgm}}` diff --git a/live-server b/live-server new file mode 100644 index 00000000..f0154bac --- /dev/null +++ b/live-server @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# live-server + +> A simple development HTTP server with live reload capability. +> More information: . + +- Serve an `index.html` file and reload on changes: + +`live-server` + +- Specify a port (default is 8080) from which to serve a file: + +`live-server --port={{8081}}` + +- Specify a given file to serve: + +`live-server --open={{about.html}}` + +- Proxy all requests for ROUTE to URL: + +`live-server --proxy={{/}}:{{http:localhost:3000}}` diff --git a/llc b/llc new file mode 100644 index 00000000..be6eec89 --- /dev/null +++ b/llc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llc + +> Compiles LLVM Intermediate Representation or bitcode to target-specific assembly language. +> More information: . + +- Compile a bitcode or IR file to an assembly file with the same base name: + +`llc {{path/to/file.ll}}` + +- Enable all optimizations: + +`llc -O3 {{path/to/input.ll}}` + +- Output assembly to a specific file: + +`llc --output {{path/to/output.s}}` + +- Emit fully relocatable, position independent code: + +`llc -relocation-model=pic {{path/to/input.ll}}` diff --git a/lldb b/lldb new file mode 100644 index 00000000..1f859c17 --- /dev/null +++ b/lldb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lldb + +> The LLVM Low-Level Debugger. +> More information: . + +- Debug an executable: + +`lldb {{executable}}` + +- Attach `lldb` to a running process with a given PID: + +`lldb -p {{pid}}` + +- Wait for a new process to launch with a given name, and attach to it: + +`lldb -w -n {{process_name}}` diff --git a/lli b/lli new file mode 100644 index 00000000..b5286925 --- /dev/null +++ b/lli @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lli + +> Directly execute programs from LLVM bitcode. +> More information: . + +- Execute a bitcode or IR file: + +`lli {{path/to/file.ll}}` + +- Execute with command-line arguments: + +`lli {{path/to/file.ll}} {{argument1 argument2 ...}}` + +- Enable all optimizations: + +`lli -O3 {{path/to/file.ll}}` + +- Load a dynamic library before linking: + +`lli --dlopen={{path/to/library.dll}} {{path/to/file.ll}}` diff --git a/llm b/llm new file mode 100644 index 00000000..d4f6c43f --- /dev/null +++ b/llm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llm + +> Interact with Large Language Models (LLMs) via remote APIs and models that can be installed and run on your machine. +> More information: . + +- Set up an OpenAI API Key: + +`llm keys set openai` + +- Run a prompt: + +`llm "{{Ten fun names for a pet pelican}}"` + +- Run a [s]ystem prompt against a file: + +`cat {{path/to/file.py}} | llm --system "{{Explain this code}}"` + +- Install packages from PyPI into the same environment as LLM: + +`llm install {{package1 package2 ...}}` + +- Download and run a prompt against a [m]odel: + +`llm --model {{orca-mini-3b-gguf2-q4_0}} "{{What is the capital of France?}}"` + +- Have an interactive chat with a specific [m]odel: + +`llm chat --model {{chatgpt}}` diff --git a/llvd b/llvd new file mode 100644 index 00000000..38d3acc3 --- /dev/null +++ b/llvd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvd + +> Linkedin Learning Video Downloader. +> More information: . + +- Download a [c]ourse using cookie-based authentication: + +`llvd -c {{course-slug}} --cookies` + +- Download a course at a specific [r]esolution: + +`llvd -c {{course-slug}} -r 720` + +- Download a course with [ca]ptions (subtitles): + +`llvd -c {{course-slug}} --caption` + +- Download a course [p]ath with [t]hrottling between 10 to 30 seconds: + +`llvd -p {{path-slug}} -t {{10,30}} --cookies` diff --git a/llvm-ar b/llvm-ar new file mode 100644 index 00000000..c8b7f110 --- /dev/null +++ b/llvm-ar @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-ar + +> This command is an alias of `ar`. + +- View documentation for the original command: + +`tldr ar` diff --git a/llvm-as b/llvm-as new file mode 100644 index 00000000..42a94522 --- /dev/null +++ b/llvm-as @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-as + +> LLVM Intermediate Representation (`.ll`) to Bitcode (`.bc`) assembler. +> More information: . + +- Assemble an IR file: + +`llvm-as -o {{path/to/out.bc}} {{path/to/source.ll}}` + +- Assemble an IR file and include a module hash in the produced Bitcode file: + +`llvm-as --module-hash -o {{path/to/out.bc}} {{path/to/source.ll}}` + +- Read an IR file from `stdin` and assemble it: + +`cat {{path/to/source.ll}} | llvm-as -o {{path/to/out.bc}}` diff --git a/llvm-bcanalyzer b/llvm-bcanalyzer new file mode 100644 index 00000000..2e7b49fd --- /dev/null +++ b/llvm-bcanalyzer @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-bcanalyzer + +> LLVM Bitcode (`.bc`) analyzer. +> More information: . + +- Print statistics about a Bitcode file: + +`llvm-bcanalyzer {{path/to/file.bc}}` + +- Print an SGML representation and statistics about a Bitcode file: + +`llvm-bcanalyzer -dump {{path/to/file.bc}}` + +- Read a Bitcode file from `stdin` and analyze it: + +`cat {{path/to/file.bc}} | llvm-bcanalyzer` diff --git a/llvm-cat b/llvm-cat new file mode 100644 index 00000000..441ee8f0 --- /dev/null +++ b/llvm-cat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-cat + +> Concatenate LLVM Bitcode (`.bc`) files. +> More information: . + +- Concatenate Bitcode files: + +`llvm-cat {{path/to/file1.bc}} {{path/to/file2.bc}} -o {{path/to/out.bc}}` diff --git a/llvm-config b/llvm-config new file mode 100644 index 00000000..835015da --- /dev/null +++ b/llvm-config @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-config + +> Get various configuration information needed to compile programs which use LLVM. +> Typically called from build systems, like in Makefiles or configure scripts. +> More information: . + +- Compile and link an LLVM based program: + +`clang++ $(llvm-config --cxxflags --ldflags --libs) --output {{path/to/output_executable}} {{path/to/source.cc}}` + +- Print the `PREFIX` of your LLVM installation: + +`llvm-config --prefix` + +- Print all targets supported by your LLVM build: + +`llvm-config --targets-built` diff --git a/llvm-dis b/llvm-dis new file mode 100644 index 00000000..7f7a458f --- /dev/null +++ b/llvm-dis @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-dis + +> Converts LLVM bitcode files into human-readable LLVM Intermediate Representation (IR). +> More information: . + +- Convert a bitcode file as LLVM IR and write the result to `stdout`: + +`llvm-dis {{path/to/input.bc}} -o -` + +- Convert a bitcode file to an LLVM IR file with the same filename: + +`llvm-dis {{path/to/file.bc}}` + +- Convert a bitcode file to LLVM IR, writing the result to the specified file: + +`llvm-dis {{path/to/input.bc}} -o {{path/to/output.ll}}` diff --git a/llvm-g++ b/llvm-g++ new file mode 100644 index 00000000..369d74f1 --- /dev/null +++ b/llvm-g++ @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-g++ + +> This command is an alias of `clang++`. + +- View documentation for the original command: + +`tldr clang++` diff --git a/llvm-gcc b/llvm-gcc new file mode 100644 index 00000000..7c2d0bde --- /dev/null +++ b/llvm-gcc @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-gcc + +> This command is an alias of `clang`. + +- View documentation for the original command: + +`tldr clang` diff --git a/llvm-nm b/llvm-nm new file mode 100644 index 00000000..1be7f16b --- /dev/null +++ b/llvm-nm @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-nm + +> This command is an alias of `nm`. + +- View documentation for the original command: + +`tldr nm` diff --git a/llvm-objdump b/llvm-objdump new file mode 100644 index 00000000..9680268c --- /dev/null +++ b/llvm-objdump @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-objdump + +> This command is an alias of `objdump`. + +- View documentation for the original command: + +`tldr objdump` diff --git a/llvm-strings b/llvm-strings new file mode 100644 index 00000000..001c0f81 --- /dev/null +++ b/llvm-strings @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-strings + +> This command is an alias of `strings`. + +- View documentation for the original command: + +`tldr strings` diff --git a/lmms b/lmms new file mode 100644 index 00000000..80185ec8 --- /dev/null +++ b/lmms @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lmms + +> Free, open source, cross-platform digital audio workstation. +> Render a `.mmp` or `.mmpz` project file, dump a `.mmpz` as XML, or start the GUI. +> More information: . + +- Start the GUI: + +`lmms` + +- Start the GUI and load external config: + +`lmms --config {{path/to/config.xml}}` + +- Start the GUI and import MIDI or Hydrogen file: + +`lmms --import {{path/to/midi/or/hydrogen/file}}` + +- Start the GUI with a specified window size: + +`lmms --geometry {{x_size}}x{{y_size}}+{{x_offset}}+{{y_offset}}` + +- Dump a `.mmpz` file: + +`lmms dump {{path/to/mmpz/file.mmpz}}` + +- Render a project file: + +`lmms render {{path/to/mmpz_or_mmp/file}}` + +- Render the individual tracks of a project file: + +`lmms rendertracks {{path/to/mmpz_or_mmp/file}} {{path/to/dump/directory}}` + +- Render with custom samplerate, format, and as a loop: + +`lmms render --samplerate {{88200}} --format {{ogg}} --loop --output {{path/to/output/file.ogg}}` diff --git a/ln b/ln new file mode 100644 index 00000000..e322d0f3 --- /dev/null +++ b/ln @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ln + +> Creates links to files and directories. +> More information: . + +- Create a symbolic link to a file or directory: + +`ln -s {{/path/to/file_or_directory}} {{path/to/symlink}}` + +- Overwrite an existing symbolic link to point to a different file: + +`ln -sf {{/path/to/new_file}} {{path/to/symlink}}` + +- Create a hard link to a file: + +`ln {{/path/to/file}} {{path/to/hardlink}}` diff --git a/loadtest b/loadtest new file mode 100644 index 00000000..1cb544c0 --- /dev/null +++ b/loadtest @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# loadtest + +> Run a load test on the selected HTTP or WebSockets URL. +> More information: . + +- Run with concurrent users and a specified amount of requests per second: + +`loadtest --concurrency {{10}} --rps {{200}} {{https://example.com}}` + +- Run with a custom HTTP header: + +`loadtest --headers "{{accept:text/plain;text-html}}" {{https://example.com}}` + +- Run with a specific HTTP method: + +`loadtest --method {{GET}} {{https://example.com}}` diff --git a/loc b/loc new file mode 100644 index 00000000..e24464d3 --- /dev/null +++ b/loc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# loc + +> Count lines of code. Written in Rust. +> More information: . + +- Print lines of code in the current directory: + +`loc` + +- Print lines of code in the target directory: + +`loc {{path/to/directory}}` + +- Print lines of code with stats for individual files: + +`loc --files` + +- Print lines of code without .gitignore (etc.) files (e.g. two -u flags will additionally count hidden files and dirs): + +`loc -u` diff --git a/local b/local new file mode 100644 index 00000000..2a329991 --- /dev/null +++ b/local @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# local + +> Declare local variables and give them attributes. +> More information: . + +- Declare a string variable with the specified value: + +`local {{variable}}="{{value}}"` + +- Declare an integer variable with the specified value: + +`local -i {{variable}}="{{value}}"` + +- Declare an array variable with the specified value: + +`local {{variable}}=({{item_a item_b item_c}})` + +- Declare an associative array variable with the specified value: + +`local -A {{variable}}=({{[key_a]=item_a [key_b]=item_b [key_c]=item_c}})` + +- Declare a readonly variable with the specified value: + +`local -r {{variable}}="{{value}}"` diff --git a/locust b/locust new file mode 100644 index 00000000..c619d80b --- /dev/null +++ b/locust @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# locust + +> Load-testing tool to determine number of concurrent users a system can handle. +> More information: . + +- Load-test "example.com" with web interface using locustfile.py: + +`locust --host={{http://example.com}}` + +- Use a different test file: + +`locust --locustfile={{test_file.py}} --host={{http://example.com}}` + +- Run test without web interface, spawning 1 user a second until there are 100 users: + +`locust --no-web --clients={{100}} --hatch-rate={{1}} --host={{http://example.com}}` + +- Start Locust in master mode: + +`locust --master --host={{http://example.com}}` + +- Connect Locust slave to master: + +`locust --slave --host={{http://example.com}}` + +- Connect Locust slave to master on a different machine: + +`locust --slave --master-host={{master_hostname}} --host={{http://example.com}}` diff --git a/logger b/logger new file mode 100644 index 00000000..c37ec935 --- /dev/null +++ b/logger @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# logger + +> Add messages to syslog (/var/log/syslog). +> More information: . + +- Log a message to syslog: + +`logger {{message}}` + +- Take input from `stdin` and log to syslog: + +`echo {{log_entry}} | logger` + +- Send the output to a remote syslog server running at a given port. Default port is 514: + +`echo {{log_entry}} | logger --server {{hostname}} --port {{port}}` + +- Use a specific tag for every line logged. Default is the name of logged in user: + +`echo {{log_entry}} | logger --tag {{tag}}` + +- Log messages with a given priority. Default is `user.notice`. See `man logger` for all priority options: + +`echo {{log_entry}} | logger --priority {{user.warning}}` diff --git a/logname b/logname new file mode 100644 index 00000000..e566d6c1 --- /dev/null +++ b/logname @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# logname + +> Shows the user's login name. +> More information: . + +- Display the currently logged in user's name: + +`logname` diff --git a/logstash b/logstash new file mode 100644 index 00000000..b3488d72 --- /dev/null +++ b/logstash @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# logstash + +> An Elasticsearch ETL (extract, transform and load) tool. +> Commonly used to load data from various sources (such as databases and log files) into Elasticsearch. +> More information: . + +- Check validity of a Logstash configuration: + +`logstash --configtest --config {{logstash_config.conf}}` + +- Run Logstash using configuration: + +`sudo logstash --config {{logstash_config.conf}}` + +- Run Logstash with the most basic inline configuration string: + +`sudo logstash -e 'input {} filter {} output {}'` diff --git a/lolcat b/lolcat new file mode 100644 index 00000000..97c62032 --- /dev/null +++ b/lolcat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lolcat + +> Put a rainbow in everything you `cat` to the console. +> More information: . + +- Print a file to the console in rainbow colors: + +`lolcat {{path/to/file}}` + +- Print the result of a text-producing command in rainbow colors: + +`{{fortune}} | lolcat` + +- Print a file to the console with animated rainbow colors: + +`lolcat -a {{path/to/file}}` + +- Print a file to the console with 24-bit (truecolor) rainbow colors: + +`lolcat -t {{path/to/file}}` diff --git a/look b/look new file mode 100644 index 00000000..725e1ecb --- /dev/null +++ b/look @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# look + +> Display lines beginning with a prefix in a sorted file. +> Note: the lines in the file must be sorted. +> See also: `grep`, `sort`. +> More information: . + +- Search for lines beginning with a specific prefix in a specific file: + +`look {{prefix}} {{path/to/file}}` + +- Case-insensitively ([f]) search only on alphanumeric characters ([d]): + +`look -f -d {{prefix}} {{path/to/file}}` + +- Specify a string [t]ermination character (space by default): + +`look -t {{,}}` + +- Search in `/usr/share/dict/words` (`-d` and `-f` are assumed): + +`look {{prefix}}` diff --git a/lorem b/lorem new file mode 100644 index 00000000..7e260bd8 --- /dev/null +++ b/lorem @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lorem + +> Create some random Latin looking placeholder text. +> More information: . + +- Print the specified number of words: + +`lorem -n {{20}}` + +- Print 10 lines of Goethe's Faust: + +`lorem -l {{10}} --faust` + +- Print 5 sentences of Poe's Raven: + +`lorem -s {{5}} --raven` + +- Print 40 random characters from Boccaccio's Decameron: + +`lorem --randomize -c {{40}} --decamerone` diff --git a/lp b/lp new file mode 100644 index 00000000..d582548c --- /dev/null +++ b/lp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lp + +> Print files. +> More information: . + +- Print the output of a command to the default printer (see `lpstat` command): + +`echo "test" | lp` + +- Print a file to the default printer: + +`lp {{path/to/filename}}` + +- Print a file to a named printer (see `lpstat` command): + +`lp -d {{printer_name}} {{path/to/filename}}` + +- Print N copies of file to default printer (replace N with desired number of copies): + +`lp -n {{N}} {{path/to/filename}}` + +- Print only certain pages to the default printer (print pages 1, 3-5, and 16): + +`lp -P 1,3-5,16 {{path/to/filename}}` + +- Resume printing a job: + +`lp -i {{job_id}} -H resume` diff --git a/lpadmin b/lpadmin new file mode 100644 index 00000000..8b1d5c3c --- /dev/null +++ b/lpadmin @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpadmin + +> Configure CUPS printers and classes. +> See also: `lpoptions`. +> More information: . + +- Set the default printer: + +`lpadmin -d {{printer}}` + +- Delete a specific printer or class: + +`lpadmin -x {{printer|class}}` + +- Add a printer to a class: + +`lpadmin -p {{printer}} -c {{class}}` + +- Remove a printer from a class: + +`lpadmin -p {{printer}} -r {{class}}` diff --git a/lpass b/lpass new file mode 100644 index 00000000..5ab052f7 --- /dev/null +++ b/lpass @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpass + +> Command-line interface for the LastPass password manager. +> More information: . + +- Log in to your LastPass account, by entering your master password when prompted: + +`lpass login {{username}}` + +- Show login status: + +`lpass status` + +- List all sites grouped by category: + +`lpass ls` + +- Generate a new password for gmail.com with the identifier `myinbox` and add to LastPass: + +`lpass generate --username {{username}} --url {{gmail.com}} {{myinbox}} {{password_length}}` + +- Show password for a specified entry: + +`lpass show {{myinbox}} --password` diff --git a/lpinfo b/lpinfo new file mode 100644 index 00000000..9c17d52b --- /dev/null +++ b/lpinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpinfo + +> List connected printers and installed drivers for the CUPS print server. +> More information: . + +- List all the currently connected printers: + +`lpinfo -v` + +- List all the currently installed printer drivers: + +`lpinfo -m` + +- Search installed printer drivers by make and model: + +`lpinfo --make-and-model "{{printer_model}}" -m` diff --git a/lpmove b/lpmove new file mode 100644 index 00000000..ded170ba --- /dev/null +++ b/lpmove @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpmove + +> Move a job or all jobs to another printer. +> See also: `cancel`, `lp`, `lpr`, `lprm`. +> More information: . + +- Move a specific job to `new_printer`: + +`lpmove {{job_id}} {{new_printer}}` + +- Move a job from `old_printer` to `new_printer`: + +`lpmove {{old_printer}}-{{job_id}} {{new_printer}}` + +- Move all jobs from `old_printer` to `new_printer`: + +`lpmove {{old_printer}} {{new_printer}}` + +- Move a specific job to `new_printer` on a specific server: + +`lpmove -h {{server}} {{job_id}} {{new_printer}}` diff --git a/lpoptions b/lpoptions new file mode 100644 index 00000000..367357c1 --- /dev/null +++ b/lpoptions @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpoptions + +> Display or set printer options and defaults. +> See also: `lpadmin`. +> More information: . + +- Set the default printer: + +`lpoptions -d {{printer[/instance]}}` + +- List printer-specific options of a specific printer: + +`lpoptions -d {{printer}} -l` + +- Set a new option on a specific printer: + +`lpoptions -d {{printer}} -o {{option}}` + +- Remove the options of a specific printer: + +`lpoptions -d {{printer}} -x` diff --git a/lpq b/lpq new file mode 100644 index 00000000..1a8787c1 --- /dev/null +++ b/lpq @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpq + +> Show printer queue status. +> More information: . + +- Show the queued jobs of the default destination: + +`lpq` + +- Show the queued jobs of all printers enforcing encryption: + +`lpq -a -E` + +- Show the queued jobs in a long format: + +`lpq -l` + +- Show the queued jobs of a specific printer or class: + +`lpq -P {{destination[/instance]}}` + +- Show the queued jobs once every n seconds until the queue is empty: + +`lpq +{{interval}}` diff --git a/lpr b/lpr new file mode 100644 index 00000000..6feaa967 --- /dev/null +++ b/lpr @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpr + +> CUPS tool for printing files. +> See also: `lpstat` and `lpadmin`. +> More information: . + +- Print a file to the default printer: + +`lpr {{path/to/file}}` + +- Print 2 copies: + +`lpr -# {{2}} {{path/to/file}}` + +- Print to a named printer: + +`lpr -P {{printer}} {{path/to/file}}` + +- Print either a single page (e.g. 2) or a range of pages (e.g. 2–16): + +`lpr -o page-ranges={{2|2-16}} {{path/to/file}}` + +- Print double-sided either in portrait (long) or in landscape (short): + +`lpr -o sides={{two-sided-long-edge|two-sided-short-edge}} {{path/to/file}}` + +- Set page size (more options may be available depending on setup): + +`lpr -o media={{a4|letter|legal}} {{path/to/file}}` + +- Print multiple pages per sheet: + +`lpr -o number-up={{2|4|6|9|16}} {{path/to/file}}` diff --git a/lprm b/lprm new file mode 100644 index 00000000..631b8ccb --- /dev/null +++ b/lprm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lprm + +> Cancel queued print jobs of a server. +> See also: `lpq`. +> More information: . + +- Cancel current job on the default printer: + +`lprm` + +- Cancel a job of a specific server: + +`lprm -h {{server[:port]}} {{job_id}}` + +- Cancel multiple jobs with a encrypted connection to the server: + +`lprm -E {{job_id1 job_id2 ...}}` + +- Cancel all jobs: + +`lprm -` + +- Cancel the current job of a specific printer or class: + +`lprm -P {{destination[/instance]}}` diff --git a/lpstat b/lpstat new file mode 100644 index 00000000..e4394d85 --- /dev/null +++ b/lpstat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lpstat + +> Show status information about printers. +> More information: . + +- List printers present on the machine and whether they are enabled for printing: + +`lpstat -p` + +- Show the default printer: + +`lpstat -d` + +- Display all available status information: + +`lpstat -t` + +- List print jobs queued by a specific user: + +`lpstat -u {{user}}` diff --git a/ls b/ls new file mode 100644 index 00000000..09391e9c --- /dev/null +++ b/ls @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ls + +> List directory contents. +> More information: . + +- List files one per line: + +`ls -1` + +- List all files, including hidden files: + +`ls -a` + +- List all files, with trailing `/` added to directory names: + +`ls -F` + +- Long format list (permissions, ownership, size, and modification date) of all files: + +`ls -la` + +- Long format list with size displayed using human-readable units (KiB, MiB, GiB): + +`ls -lh` + +- Long format list sorted by size (descending) recursively: + +`ls -lSR` + +- Long format list of all files, sorted by modification date (oldest first): + +`ls -ltr` + +- Only list directories: + +`ls -d */` diff --git a/lsd b/lsd new file mode 100644 index 00000000..6d89f333 --- /dev/null +++ b/lsd @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lsd + +> List directory contents. +> The next generation `ls` command, written in Rust. +> More information: . + +- List files and directories, one per line: + +`lsd -1` + +- List all files and directories, including hidden ones, in the current directory: + +`lsd -a` + +- List all files and directories with trailing `/` added to directory names: + +`lsd -F` + +- List all files and directories in long format (permissions, ownership, size, and modification date): + +`lsd -la` + +- List all files and directories in long format with size displayed using human-readable units (KiB, MiB, GiB): + +`lsd -lh` + +- List all files and directories in long format, sorted by size (descending): + +`lsd -lS` + +- List all files and directories in long format, sorted by modification date (oldest first): + +`lsd -ltr` + +- Only list directories: + +`lsd -d {{*/}}` diff --git a/lsof b/lsof new file mode 100644 index 00000000..190949c6 --- /dev/null +++ b/lsof @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lsof + +> Lists open files and the corresponding processes. +> Note: Root privileges (or sudo) is required to list files opened by others. +> More information: . + +- Find the processes that have a given file open: + +`lsof {{path/to/file}}` + +- Find the process that opened a local internet port: + +`lsof -i :{{port}}` + +- Only output the process ID (PID): + +`lsof -t {{path/to/file}}` + +- List files opened by the given user: + +`lsof -u {{username}}` + +- List files opened by the given command or process: + +`lsof -c {{process_or_command_name}}` + +- List files opened by a specific process, given its PID: + +`lsof -p {{PID}}` + +- List open files in a directory: + +`lsof +D {{path/to/directory}}` + +- Find the process that is listening on a local IPv6 TCP port and don't convert network or port numbers: + +`lsof -i6TCP:{{port}} -sTCP:LISTEN -n -P` diff --git a/lspath b/lspath new file mode 100644 index 00000000..0a29ea23 --- /dev/null +++ b/lspath @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lspath + +> List the contents of the `PATH` environment variable, with optional paging. +> More information: . + +- Print the contents of the system `PATH` variable, with one element per line: + +`lspath` + +- Print the current contents of the system `PATH` variable, with one element per line, with the output paged: + +`lspath --page` diff --git a/lsyncd b/lsyncd new file mode 100644 index 00000000..ab573933 --- /dev/null +++ b/lsyncd @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lsyncd + +> Watch files and directories and run `rsync` when they change. +> It is often used to keep two directories on separate systems in sync, ensuring that changes made in one directory are immediately mirrored to the other. +> More information: . + +- Watch the source for changes and run `rsync` to synchronize files to the destination on every change: + +`lsyncd -rsync {{path/to/source}} {{host::share_name}}` + +- Use SSH instead of `rsyncd` shares: + +`lsyncd -rsyncssh {{path/to/source}} {{host}} {{path/to/destination}}` diff --git a/lt b/lt new file mode 100644 index 00000000..5309e1f0 --- /dev/null +++ b/lt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lt + +> Localtunnel exposes your localhost to the world for easy testing and sharing. +> More information: . + +- Start tunnel from a specific port: + +`lt --port {{8000}}` + +- Specify the upstream server doing the forwarding: + +`lt --port {{8000}} --host {{host}}` + +- Request a specific subdomain: + +`lt --port {{8000}} --subdomain {{subdomain}}` + +- Print basic request info: + +`lt --port {{8000}} --print-requests` + +- Open the tunnel URL in the default web browser: + +`lt --port {{8000}} --open` diff --git a/lua b/lua new file mode 100644 index 00000000..2e404ebd --- /dev/null +++ b/lua @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lua + +> A powerful, light-weight embeddable programming language. +> More information: . + +- Start an interactive Lua shell: + +`lua` + +- Execute a Lua script: + +`lua {{path/to/script.lua}} {{--optional-argument}}` + +- Execute a Lua expression: + +`lua -e '{{print("Hello World")}}'` diff --git a/luac b/luac new file mode 100644 index 00000000..9800834b --- /dev/null +++ b/luac @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# luac + +> Lua bytecode compiler. +> More information: . + +- Compile a Lua source file to Lua bytecode: + +`luac -o {{byte_code.luac}} {{source.lua}}` + +- Do not include debug symbols in the output: + +`luac -s -o {{byte_code.luac}} {{source.lua}}` diff --git a/luajit b/luajit new file mode 100644 index 00000000..1de8aab7 --- /dev/null +++ b/luajit @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# luajit + +> A just-in-time compiler (JIT) for the Lua programming language. +> See also: `lua`. +> More information: . + +- Start an interactive Lua shell: + +`luajit` + +- Execute a Lua script: + +`luajit {{path/to/script.lua}} {{--optional-argument}}` + +- Execute a Lua expression: + +`luajit -e '{{print("Hello World")}}'` diff --git a/lualatex b/lualatex new file mode 100644 index 00000000..140ec789 --- /dev/null +++ b/lualatex @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lualatex + +> An extended version of TeX using Lua to compile. +> More information: . + +- Start `texlua` to act as a Lua interpreter: + +`lualatex` + +- Compile a Tex file to PDF: + +`lualatex {{path/to/file.tex}}` + +- Compile a Tex file without error interruption: + +`lualatex -interaction nonstopmode {{path/to/file.tex}}` + +- Compile a Tex file with a specific output file name: + +`lualatex -jobname={{filename}} {{path/to/file.tex}}` diff --git a/lumen b/lumen new file mode 100644 index 00000000..3d9abb66 --- /dev/null +++ b/lumen @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lumen + +> A command-line installer for the Lumen micro-framework. +> More information: . + +- Create a new Lumen application: + +`lumen new {{application_name}}` + +- List the available installer commands: + +`lumen list` diff --git a/lwp-request b/lwp-request new file mode 100644 index 00000000..902f13ba --- /dev/null +++ b/lwp-request @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lwp-request + +> Simple command-line HTTP client. +> Built with libwww-perl. +> More information: . + +- Make a simple GET request: + +`lwp-request -m GET {{http://example.com/some/path}}` + +- Upload a file with a POST request: + +`lwp-request -m POST {{http://example.com/some/path}} < {{path/to/file}}` + +- Make a request with a custom user agent: + +`lwp-request -H 'User-Agent: {{user_agent}} -m {{METHOD}} {{http://example.com/some/path}}` + +- Make a request with HTTP authentication: + +`lwp-request -C {{username}}:{{password}} -m {{METHOD}} {{http://example.com/some/path}}` + +- Make a request and print request headers: + +`lwp-request -U -m {{METHOD}} {{http://example.com/some/path}}` + +- Make a request and print response headers and status chain: + +`lwp-request -E -m {{METHOD}} {{http://example.com/some/path}}` diff --git a/lynx b/lynx new file mode 100644 index 00000000..fd7b7bd0 --- /dev/null +++ b/lynx @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lynx + +> Command-line web browser. +> More information: . + +- Visit a website: + +`lynx {{example.com}}` + +- Apply restrictions for anonymous account: + +`lynx -anonymous {{example.com}}` + +- Turn on mouse support, if available: + +`lynx -use_mouse {{example.com}}` + +- Force color mode on, if available: + +`lynx -color {{example.com}}` + +- Open a link, using a specific file to read and write cookies: + +`lynx -cookie_file={{path/to/file}} {{example.com}}` + +- Navigate forwards and backwards through the links on a page: + +`{{Up arrow key|Down arrow key}}` + +- Go back to the previously displayed page: + +`{{Left arrow key|u}}` + +- Exit: + +`q + y` diff --git a/lz4 b/lz4 new file mode 100644 index 00000000..eae5bad4 --- /dev/null +++ b/lz4 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lz4 + +> Compress or decompress .lz4 files. +> More information: . + +- Compress a file: + +`lz4 {{path/to/file}}` + +- Decompress a file: + +`lz4 -d {{file.lz4}}` + +- Decompress a file and write to `stdout`: + +`lz4 -dc {{file.lz4}}` + +- Package and compress a directory and its contents: + +`tar cvf - {{path/to/directory}} | lz4 - {{dir.tar.lz4}}` + +- Decompress and unpack a directory and its contents: + +`lz4 -dc {{dir.tar.lz4}} | tar -xv` + +- Compress a file using the best compression: + +`lz4 -9 {{path/to/file}}` diff --git a/lzcat b/lzcat new file mode 100644 index 00000000..22089044 --- /dev/null +++ b/lzcat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzcat + +> This command is an alias of `xz --format=lzma --decompress --stdout`. +> More information: . + +- View documentation for the original command: + +`tldr xz` diff --git a/lzcmp b/lzcmp new file mode 100644 index 00000000..75dc6c6c --- /dev/null +++ b/lzcmp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzcmp + +> This command is an alias of `xzcmp`. + +- View documentation for the original command: + +`tldr xzcmp` diff --git a/lzegrep b/lzegrep new file mode 100644 index 00000000..dad8b784 --- /dev/null +++ b/lzegrep @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzegrep + +> This command is an alias of `xzgrep --extended-regexp`. +> See also: `egrep`. + +- View documentation for the original command: + +`tldr xzgrep` diff --git a/lzfgrep b/lzfgrep new file mode 100644 index 00000000..f395af78 --- /dev/null +++ b/lzfgrep @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzfgrep + +> This command is an alias of `xzgrep --fixed-strings`. +> See also: `fgrep`. + +- View documentation for the original command: + +`tldr xzgrep` diff --git a/lzgrep b/lzgrep new file mode 100644 index 00000000..5496dcd7 --- /dev/null +++ b/lzgrep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzgrep + +> This command is an alias of `xzgrep`. + +- View documentation for the original command: + +`tldr xzgrep` diff --git a/lzip b/lzip new file mode 100644 index 00000000..c18a556b --- /dev/null +++ b/lzip @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzip + +> A lossless data compressor with a user interface similar to `gzip` or `bzip2`. +> Lzip uses a simplified form of the "Lempel-Ziv-Markovchain-Algorithm" (LZMA) stream format and provides 3-factor integrity checking to maximize interoperability and optimize safety. +> More information: . + +- Archive a file, replacing it with with a compressed version: + +`lzip {{path/to/file}}` + +- Archive a file, keeping the input file: + +`lzip -k {{path/to/file}}` + +- Archive a file with the best compression (level=9): + +`lzip -k {{path/to/file}} --best` + +- Archive a file at the fastest speed (level=0): + +`lzip -k {{path/to/file}} --fast` + +- Test the integrity of compressed file: + +`lzip --test {{path/to/archive.lz}}` + +- Decompress a file, replacing it with the original uncompressed version: + +`lzip -d {{path/to/archive.lz}}` + +- Decompress a file, keeping the archive: + +`lzip -d -k {{path/to/archive.lz}}` + +- List files which are in an archive and show compression stats: + +`lzip --list {{path/to/archive.lz}}` diff --git a/lzless b/lzless new file mode 100644 index 00000000..d6fcb1ab --- /dev/null +++ b/lzless @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzless + +> This command is an alias of `xzless`. + +- View documentation for the original command: + +`tldr xzless` diff --git a/lzma b/lzma new file mode 100644 index 00000000..428b3d7d --- /dev/null +++ b/lzma @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzma + +> This command is an alias of `xz --format=lzma`. +> More information: . + +- View documentation for the original command: + +`tldr xz` diff --git a/lzmore b/lzmore new file mode 100644 index 00000000..4b25e17a --- /dev/null +++ b/lzmore @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzmore + +> This command is an alias of `xzmore`. + +- View documentation for the original command: + +`tldr xzmore` diff --git a/lzop b/lzop new file mode 100644 index 00000000..e0092a56 --- /dev/null +++ b/lzop @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# lzop + +> Compress or decompress files with LZO compression. +> More information: . + +- Compress a file into a new file with the `.lzo` suffix: + +`lzop {{path/to/file}}` + +- Decompress a file: + +`lzop -d {{path/to/file.lzo}}` + +- Compress a file, while specifying the compression level. 0 = Worst, 9 = Best (Default level is 3): + +`lzop -{{level}} {{path/to/file}}` diff --git a/m4 b/m4 new file mode 100644 index 00000000..d0da1ee7 --- /dev/null +++ b/m4 @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# m4 + +> Macro processor. +> More information: . + +- Process macros in a file: + +`m4 {{path/to/file}}` + +- Define a macro before processing files: + +`m4 -D{{macro_name}}={{macro_value}} {{path/to/file}}` diff --git a/macchina b/macchina new file mode 100644 index 00000000..82030c1a --- /dev/null +++ b/macchina @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# macchina + +> Display information about your computer. +> More information: . + +- List out system information, with either default settings or those specified in your configuration file: + +`macchina` + +- Specify a custom configuration file path: + +`macchina --config {{path/to/configuration_file}}` + +- List system information, but lengthen uptime, shell and kernel output: + +`macchina --long-uptime --long-shell --long-kernel` + +- Check for any errors/system failures encountered when trying to fetch system information: + +`macchina --doctor` + +- List original artists of all the ASCII art: + +`macchina --ascii-artists` diff --git a/macptopbm b/macptopbm new file mode 100644 index 00000000..dbe51d39 --- /dev/null +++ b/macptopbm @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# macptopbm + +> Read a MacPaint file as input and produce a PBM image as output. +> See also: `pbmtomacp`. +> More information: . + +- Convert a MacPaint file into a PGM image: + +`macptopbm {{path/to/file.macp}} > {{path/to/output.pbm}}` + +- Skip over a specified number of bytes when reading the file: + +`macptopbm -extraskip {{N}} > {{path/to/output.pbm}}` + +- Suppress all informational messages: + +`macptopbm -quiet > {{path/to/output.pbm}}` + +- Display version: + +`macptopbm -version` diff --git a/maestral b/maestral new file mode 100644 index 00000000..7ecfeef5 --- /dev/null +++ b/maestral @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# maestral + +> A lightweight Dropbox client for macOS and Linux. +> More information: . + +- Start the GUI: + +`maestral gui` + +- Print current status of Maestral: + +`maestral status` + +- Pause syncing: + +`maestral pause` + +- Resume syncing: + +`maestral resume` + +- Print sync status of a specific file or folder: + +`maestral filestatus {{path/to/file_or_directory}}` diff --git a/magento b/magento new file mode 100644 index 00000000..44916248 --- /dev/null +++ b/magento @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# magento + +> Manage the Magento PHP framework. +> More information: . + +- Enable one or more modules: + +`magento module:enable {{module1 module2 ...}}` + +- Disable one or more modules: + +`magento module:disable {{module1 module2 ...}}` + +- Update the database after enabling modules: + +`magento setup:upgrade` + +- Update code and dependency injection configuration: + +`magento setup:di:compile` + +- Deploy static assets: + +`magento setup:static-content:deploy` + +- Enable maintenance mode: + +`magento maintenance:enable` + +- Disable maintenance mode: + +`magento maintenance:disable` + +- List all available commands: + +`magento list` diff --git a/magick b/magick new file mode 100644 index 00000000..ff4fd1d3 --- /dev/null +++ b/magick @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# magick + +> Create, edit, compose, or convert between image formats. +> ImageMagick version 7+. See `convert` for versions 6 and below. +> More information: . + +- Convert between image formats: + +`magick {{path/to/input_image.png}} {{path/to/output_image.jpg}}` + +- Resize an image, making a new copy: + +`magick {{path/to/input_image.jpg}} -resize {{100x100}} {{path/to/output_image.jpg}}` + +- Create a GIF out of all JPG images in the current directory: + +`magick {{*.jpg}} {{path/to/images.gif}}` + +- Create a checkerboard pattern: + +`magick -size {{640x480}} pattern:checkerboard {{path/to/checkerboard.png}}` + +- Create a PDF file out of all JPG images in the current directory: + +`magick {{*.jpg}} -adjoin {{path/to/file.pdf}}` diff --git a/mail b/mail new file mode 100644 index 00000000..24cdedb9 --- /dev/null +++ b/mail @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mail + +> The command operates on the user's mailbox if no argument is given. +> To send an email the message body is built from `stdin`. +> More information: . + +- Send a typed email message. The command-line below continues after pressing Enter key. Input CC email-id (optional) press Enter key. Input message text (can be multiline). Press Ctrl-D key to complete the message text: + +`mail --subject="{{subject line}}" {{to_user@example.com}}` + +- Send an email that contains file content: + +`mail --subject="{{$HOSTNAME filename.txt}}" {{to_user@example.com}} < {{path/to/filename.txt}}` + +- Send a `tar.gz` file as an attachment: + +`tar cvzf - {{path/to/directory1 path/to/directory2}} | uuencode {{data.tar.gz}} | mail --subject="{{subject_line}}" {{to_user@example.com}}` diff --git a/mailx b/mailx new file mode 100644 index 00000000..5b754828 --- /dev/null +++ b/mailx @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mailx + +> Send and receive mail. +> More information: . + +- Send mail (the content should be typed after the command, and ended with `Ctrl+D`): + +`mailx -s "{{subject}}" {{to_addr}}` + +- Send mail with content passed from another command: + +`echo "{{content}}" | mailx -s "{{subject}}" {{to_addr}}` + +- Send mail with content read from a file: + +`mailx -s "{{subject}}" {{to_addr}} < {{content.txt}}` + +- Send mail to a recipient and CC to another address: + +`mailx -s "{{subject}}" -c {{cc_addr}} {{to_addr}}` + +- Send mail specifying the sender address: + +`mailx -s "{{subject}}" -r {{from_addr}} {{to_addr}}` + +- Send mail with an attachment: + +`mailx -a {{path/to/file}} -s "{{subject}}" {{to_addr}}` diff --git a/make b/make new file mode 100644 index 00000000..7bf32944 --- /dev/null +++ b/make @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# make + +> Task runner for targets described in Makefile. +> Mostly used to control the compilation of an executable from source code. +> More information: . + +- Call the first target specified in the Makefile (usually named "all"): + +`make` + +- Call a specific target: + +`make {{target}}` + +- Call a specific target, executing 4 jobs at a time in parallel: + +`make -j{{4}} {{target}}` + +- Use a specific Makefile: + +`make --file {{path/to/file}}` + +- Execute make from another directory: + +`make --directory {{path/to/directory}}` + +- Force making of a target, even if source files are unchanged: + +`make --always-make {{target}}` + +- Override a variable defined in the Makefile: + +`make {{target}} {{variable}}={{new_value}}` + +- Override variables defined in the Makefile by the environment: + +`make --environment-overrides {{target}}` diff --git a/makebuildserver b/makebuildserver new file mode 100644 index 00000000..933b6ae4 --- /dev/null +++ b/makebuildserver @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# makebuildserver + +> Create an F-Droid build server virtual machine. +> More information: . + +- Create a new virtual machine or update an existing one (if available): + +`makebuildserver` + +- Force creating a fresh virtual machine: + +`makebuildserver --clean` diff --git a/makensis b/makensis new file mode 100644 index 00000000..60d7fda8 --- /dev/null +++ b/makensis @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# makensis + +> Cross-platform compiler for NSIS installers. +> It compiles a NSIS script into a Windows installer executable. +> More information: . + +- Compile a NSIS script: + +`makensis {{path/to/file.nsi}}` + +- Compile a NSIS script in strict mode (treat warnings as errors): + +`makensis -WX {{path/to/file.nsi}}` + +- Display help for a specific command: + +`makensis -CMDHELP {{command}}` diff --git a/makepasswd b/makepasswd new file mode 100644 index 00000000..02570c0d --- /dev/null +++ b/makepasswd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# makepasswd + +> Generate and encrypt passwords. +> More information: . + +- Generate a random password (8 to 10 characters long, containing letters and numbers): + +`makepasswd` + +- Generate a 10 characters long password: + +`makepasswd --chars {{10}}` + +- Generate a 5 to 10 characters long password: + +`makepasswd --minchars {{5}} --maxchars {{10}}` + +- Generate a password containing only the characters "b", "a" or "r": + +`makepasswd --string {{bar}}` diff --git a/mamba b/mamba new file mode 100644 index 00000000..16963b29 --- /dev/null +++ b/mamba @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mamba + +> Fast, cross-platform package manager, intended as a drop-in replacement for conda. +> Some subcommands such as `mamba repoquery` have their own usage documentation. +> More information: . + +- Create a new environment, installing the specified packages into it: + +`mamba create --name {{environment_name}} {{python=3.10 matplotlib}}` + +- Install packages into the current environment, specifying the package [c]hannel: + +`mamba install -c {{conda-forge}} {{python=3.6 numpy}}` + +- Update all packages in the current environment: + +`mamba update --all` + +- Search for a specific package across repositories: + +`mamba repoquery search {{numpy}}` + +- List all environments: + +`mamba info --envs` + +- Remove unused [p]ackages and [t]arballs from the cache: + +`mamba clean -pt` + +- Activate an environment: + +`mamba activate {{environment_name}}` + +- List all installed packages in the currently activated environment: + +`mamba list` diff --git a/mamba-repoquery b/mamba-repoquery new file mode 100644 index 00000000..87486710 --- /dev/null +++ b/mamba-repoquery @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mamba repoquery + +> Efficiently query conda and mamba package repositories and package dependencies. +> More information: . + +- Search for all available versions of a particular package: + +`mamba repoquery search {{package}}` + +- Search for all packages satisfying specific constraints: + +`mamba repoquery search {{sphinx<5}}` + +- List the dependencies of a package installed in the currently activated environment, in a tree format: + +`mamba repoquery depends --tree {{scipy}}` + +- Print packages in the current environment that require a particular package to be installed (i.e. inverse of `depends`): + +`mamba repoquery whoneeds {{ipython}}` diff --git a/man b/man new file mode 100644 index 00000000..f0822bbf --- /dev/null +++ b/man @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# man + +> Format and display manual pages. +> More information: . + +- Display the man page for a command: + +`man {{command}}` + +- Display the man page for a command from section 7: + +`man {{7}} {{command}}` + +- List all available sections for a command: + +`man -f {{command}}` + +- Display the path searched for manpages: + +`man --path` + +- Display the location of a manpage rather than the manpage itself: + +`man -w {{command}}` + +- Display the man page using a specific locale: + +`man {{command}} --locale={{locale}}` + +- Search for manpages containing a search string: + +`man -k "{{search_string}}"` diff --git a/masscan b/masscan new file mode 100644 index 00000000..1591615b --- /dev/null +++ b/masscan @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# masscan + +> Network scanner for scanning as fast as possible. +> Best run with elevated privileges. Nmap compatibility run `masscan --nmap` to find out more. +> More information: . + +- Scan an IP or network subnet for port 80: + +`masscan {{ip_address|network_prefix}} --ports {{80}}` + +- Scan a class B subnet for the top 100 ports at 100,000 packets per second: + +`masscan {{10.0.0.0/16}} --top-ports {{100}} --rate {{100000}}` + +- Scan a class B subnet avoiding ranges from a specific exclude file: + +`masscan {{10.0.0.0/16}} --top-ports {{100}} --excludefile {{path/to/file}}` + +- Scan the Internet for port 443: + +`masscan {{0.0.0.0/0}} --ports {{443}} --rate {{10000000}}` + +- Scan the Internet for a specific port range and export to a file: + +`masscan {{0.0.0.0/0}} --ports {{0-65535}} -output-format {{binary|grepable|json|list|xml}} --output-filename {{path/to/file}}` diff --git a/mat2 b/mat2 new file mode 100644 index 00000000..08edb4d4 --- /dev/null +++ b/mat2 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mat2 + +> Anonymise various file formats by removing metadata. +> More information: . + +- List supported file formats: + +`mat2 --list` + +- Remove metadata from a file: + +`mat2 {{path/to/file}}` + +- Remove metadata from a file and print detailed output to the console: + +`mat2 --verbose {{path/to/file}}` + +- Show metadata in a file without removing it: + +`mat2 --show {{path/to/file}}` + +- Partially remove metadata from a file: + +`mat2 --lightweight {{path/to/file}}` + +- Remove metadata from a file in place, without creating a backup: + +`mat2 --inplace {{path/to/file}}` diff --git a/mate-dictionary b/mate-dictionary new file mode 100644 index 00000000..40255016 --- /dev/null +++ b/mate-dictionary @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mate-dictionary + +> Look up words on dictionaries. +> More information: . + +- Print a specific word definition: + +`mate-dictionary --no-window --look-up '{{word}}'` + +- Show similar words for a specific one in a new window: + +`mate-dictionary --match '{{word}}'` diff --git a/matlab b/matlab new file mode 100644 index 00000000..4f6fe986 --- /dev/null +++ b/matlab @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# matlab + +> Numerical computation environment by MathWorks. +> More information: . + +- Run without splash screen during startup: + +`matlab -nosplash` + +- Execute a MATLAB statement: + +`matlab -r "{{matlab_statement}}"` + +- Run a MATLAB script: + +`matlab -r "run({{path/to/script.m}})"` diff --git a/maza b/maza new file mode 100644 index 00000000..2745dc8e --- /dev/null +++ b/maza @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# maza + +> Local ad blocker. Like Pi-hole but local and using the operating system. +> More information: . + +- Update the Maza database: + +`maza update` + +- Start Maza: + +`sudo maza start` + +- Stop Maza: + +`sudo maza stop` + +- Show the status of Maza: + +`maza status` diff --git a/mc b/mc new file mode 100644 index 00000000..1b633dcf --- /dev/null +++ b/mc @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mc + +> Midnight Commander, a terminal based file manager. +> Navigate the directory structure using the arrow keys, the mouse or by typing the commands into the terminal. +> More information: . + +- Start Midnight Commander: + +`mc` + +- Start Midnight Commander in black and white: + +`mc -b` diff --git a/mcfly b/mcfly new file mode 100644 index 00000000..a0b5e31f --- /dev/null +++ b/mcfly @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mcfly + +> A smart command history search and management tool. +> Replaces your default shell history search (ctrl-r) with an intelligent search engine providing context and relevance to the commands. +> More information: . + +- Print the mcfly integration code for the specified shell: + +`mcfly init {{bash|fish|zsh}}` + +- Search the history for a command, with 20 results: + +`mcfly search --results {{20}} "{{search_terms}}"` + +- Add a new command to the history: + +`mcfly add "{{command}}"` + +- Record that a directory has moved and transfer the historical records from the old path to the new one: + +`mcfly move "{{path/to/old_directory}}" "{{path/to/new_directory}}"` + +- Train the suggestion engine (developer tool): + +`mcfly train` + +- Display help for a specific subcommand: + +`mcfly help {{subcommand}}` diff --git a/mcs b/mcs new file mode 100644 index 00000000..d96e9d27 --- /dev/null +++ b/mcs @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mcs + +> Mono C# Compiler. +> More information: . + +- Compile the specified files: + +`mcs {{path/to/input_file1.cs path/to/input_file2.cs ...}}` + +- Specify the output program name: + +`mcs -out:{{path/to/file.exe}} {{path/to/input_file1.cs path/to/input_file2.cs ...}}` + +- Specify the output program type: + +`mcs -target:{{exe|winexe|library|module}} {{path/to/input_file1.cs path/to/input_file2.cs ...}}` diff --git a/md-to-clip b/md-to-clip new file mode 100644 index 00000000..bd45316b --- /dev/null +++ b/md-to-clip @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# md-to-clip + +> Converter from tldr-pages to Command Line Interface Pages. +> See also: `clip-view`. +> More information: . + +- Convert tldr-pages files and save into the same directories: + +`md-to-clip {{path/to/page1.md path/to/page2.md ...}}` + +- Convert tldr-pages files and save into a specific directory: + +`md-to-clip --output-directory {{path/to/directory}} {{path/to/page1.md path/to/page2.md ...}}` + +- Convert a tldr-page file to `stdout`: + +`md-to-clip --no-file-save <(echo '{{page-content}}')` + +- Convert tldr-pages files while recognizing additional placeholders from a specific config: + +`md-to-clip --special-placeholder-config {{path/to/config.yaml}} {{path/to/page1.md path/to/page2.md ...}}` + +- Display help: + +`md-to-clip --help` + +- Display version: + +`md-to-clip --version` diff --git a/md5sum b/md5sum new file mode 100644 index 00000000..657d2a6f --- /dev/null +++ b/md5sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# md5sum + +> Calculate MD5 cryptographic checksums. +> More information: . + +- Calculate the MD5 checksum for one or more files: + +`md5sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of MD5 checksums to a file: + +`md5sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.md5}}` + +- Calculate an MD5 checksum from `stdin`: + +`{{command}} | md5sum` + +- Read a file of MD5 sums and filenames and verify all files have matching checksums: + +`md5sum --check {{path/to/file.md5}}` + +- Only show a message for missing files or when verification fails: + +`md5sum --check --quiet {{path/to/file.md5}}` + +- Only show a message when verification fails, ignoring missing files: + +`md5sum --ignore-missing --check --quiet {{path/to/file.md5}}` diff --git a/mdatopbm b/mdatopbm new file mode 100644 index 00000000..03e4d1b9 --- /dev/null +++ b/mdatopbm @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mdatopbm + +> Convert a Microdesign MDA file to a PBM image. +> See also: `pbmtomda`. +> More information: . + +- Convert a MDA file to a PBM image: + +`mdatopbm {{path/to/image.mda}} > {{path/to/output.pbm}}` + +- Invert the colors in the input image: + +`mdatopbm -i {{path/to/image.mda}} > {{path/to/output.pbm}}` + +- Double the input image's height: + +`mdatopbm -d {{path/to/image.mda}} > {{path/to/output.pbm}}` diff --git a/mdp b/mdp new file mode 100644 index 00000000..1a336f05 --- /dev/null +++ b/mdp @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mdp + +> A command-line based tool to make presentations from Markdown files. +> More information: . + +- Launch a presentation in the terminal from a Markdown file: + +`mdp {{presentation.md}}` + +- Disable fading transitions: + +`mdp --nofade {{presentation.md}}` + +- Invert font colors to use in terminals with light background: + +`mdp --invert {{presentation.md}}` + +- Disable transparency in transparent terminals: + +`mdp --notrans {{presentation.md}}` diff --git a/mediainfo b/mediainfo new file mode 100644 index 00000000..71b20bf1 --- /dev/null +++ b/mediainfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mediainfo + +> Display metadata from video and audio files. +> More information: . + +- Display metadata for a given file in the console: + +`mediainfo {{file}}` + +- Store the output to a given file along with displaying in the console: + +`mediainfo --Logfile={{out.txt}} {{file}}` + +- List metadata attributes that can be extracted: + +`mediainfo --Info-Parameters` diff --git a/meld b/meld new file mode 100644 index 00000000..49438ce0 --- /dev/null +++ b/meld @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# meld + +> Graphical diffing and merging tool. +> More information: . + +- Start `meld`: + +`meld` + +- Compare 2 files: + +`meld {{path/to/file_1}} {{path/to/file_2}}` + +- Compare 2 directories: + +`meld {{path/to/directory_1}} {{path/to/directory_2}}` + +- Compare 3 files: + +`meld {{path/to/file_1}} {{path/to/file_2}} {{path/to/file_3}}` + +- Open a comparison as a new tab in a pre-existing meld instance: + +`meld --newtab {{path/to/file_1}} {{path/to/file_2}}` + +- Compare multiple sets of files: + +`meld --diff {{path/to/file_1}} {{path/to/file_2}} --diff {{path/to/file_3}} {{path/to/file_4}}` diff --git a/mesg b/mesg new file mode 100644 index 00000000..c7222bba --- /dev/null +++ b/mesg @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mesg + +> Check or set a terminal's ability to receive messages from other users, usually from the `write` command. +> See also `write`, `talk`. +> More information: . + +- Check terminal's openness to write messages: + +`mesg` + +- Disallow receiving messages from the write command: + +`mesg n` + +- Allow receiving messages from the write command: + +`mesg y` diff --git a/meshlabserver b/meshlabserver new file mode 100644 index 00000000..ec40f095 --- /dev/null +++ b/meshlabserver @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# meshlabserver + +> Command-line interface for the MeshLab 3D mesh processing software. +> More information: . + +- Convert an STL file to an OBJ file: + +`meshlabserver -i {{input.stl}} -o {{output.obj}}` + +- Convert a WRL file to a OFF file, including the vertex and face normals in the output mesh: + +`meshlabserver -i {{input.wrl}} -o {{output.off}} -om vn fn` + +- Dump a list of all the available processing filters into a file: + +`meshlabserver -d {{path/to/file}}` + +- Process a 3D file using a filter script created in the MeshLab GUI (Filters > Show current filter script > Save Script): + +`meshlabserver -i {{input.ply}} -o {{output.ply}} -s {{filter_script.mlx}}` + +- Process a 3D file using a filter script, writing the output of the filters into a log file: + +`meshlabserver -i {{input.x3d}} -o {{output.x3d}} -s {{filter_script.mlx}} -l {{logfile}}` diff --git a/meshnamed b/meshnamed new file mode 100644 index 00000000..61e0ebd5 --- /dev/null +++ b/meshnamed @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# meshnamed + +> Distributed naming system for IPv6 mesh networks. +> More information: . + +- Start a local meshname DNS server: + +`meshnamed` + +- Convert an IPv6 address into a meshname: + +`meshnamed -getname {{200:6fc8:9220:f400:5cc2:305a:4ac6:967e}}` + +- Convert a meshname to an IPv6 address: + +`meshnamed -getip {{aiag7sesed2aaxgcgbnevruwpy}}` diff --git a/meson b/meson new file mode 100644 index 00000000..d9a436e7 --- /dev/null +++ b/meson @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# meson + +> SCons-like build system that uses Python as a front-end language and Ninja as a building backend. +> More information: . + +- Generate a C project with a given name and version: + +`meson init --language={{c}} --name={{myproject}} --version={{0.1}}` + +- Configure the `builddir` with default values: + +`meson setup {{build_dir}}` + +- Build the project: + +`meson compile -C {{path/to/build_dir}}` + +- Run all tests in the project: + +`meson test` + +- Show the help: + +`meson --help` + +- Display version: + +`meson --version` diff --git a/meteor b/meteor new file mode 100644 index 00000000..ef9d28d1 --- /dev/null +++ b/meteor @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# meteor + +> Full-stack JavaScript platform for building web applications. +> More information: . + +- Run a meteor project from its root directory in development mode: + +`meteor` + +- Create a project under the given directory: + +`meteor create {{path/to/directory}}` + +- Display the list of packages the project is currently using: + +`meteor list` + +- Add a package to the project: + +`meteor add {{package}}` + +- Remove a package from the project: + +`meteor remove {{package}}` + +- Create a production build of the project as a tarball under the given directory: + +`meteor build {{path/to/directory}}` diff --git a/mg b/mg new file mode 100644 index 00000000..52d3c01e --- /dev/null +++ b/mg @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mg + +> A small, fast, and portable text editor based on `emacs`. +> More information: . + +- Open a file for editing: + +`mg {{path/to/file}}` + +- Open a file at a specified line number: + +`mg +{{line_number}} {{path/to/file}}` + +- Open files in a read-only mode: + +`mg -R {{path/to/file1 path/to/file2 ...}}` + +- Disable `~` backup files while editing: + +`mg -n {{path/to/file}}` diff --git a/mgrtopbm b/mgrtopbm new file mode 100644 index 00000000..f9159045 --- /dev/null +++ b/mgrtopbm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mgrtopbm + +> Convert a MGR bitmap into a PBM file. +> See also: `pbmtomgr`. +> More information: . + +- Convert a MGR bitmap into a PBM file: + +`mgrtopbm {{path/to/image.mgr}} > {{path/to/output.pbm}}` diff --git a/mh_copyright b/mh_copyright new file mode 100644 index 00000000..85cbeac2 --- /dev/null +++ b/mh_copyright @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mh_copyright + +> Adjust copyright headers for MATLAB or Octave code. +> More information: . + +- Update the year (range) to include the current year for the specified files: + +`mh_copyright --primary-entity="{{entity}}" --update-year {{path/to/file_or_directory1.m path/to/file_or_director2.m ...}}` + +- Update the year (range) to include the current year for all files: + +`mh_copyright --primary-entity="{{entity}}" --update-year` diff --git a/mh_lint b/mh_lint new file mode 100644 index 00000000..c7a4219d --- /dev/null +++ b/mh_lint @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mh_lint + +> Attempt to find bugs in MATLAB or Octave code. +> Please note that this tool is neither sound nor complete. +> More information: . + +- Check the current directory: + +`mh_lint` + +- Check a specific directory recursively: + +`mh_lint {{path/to/directory}}` + +- Check a MATLAB file: + +`mh_lint {{path/to/file.m}}` + +- Check an Octave file: + +`mh_lint --octave {{path/to/file.m}}` diff --git a/mh_metric b/mh_metric new file mode 100644 index 00000000..95677a91 --- /dev/null +++ b/mh_metric @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mh_metric + +> Calculate and enforce code metrics for MATLAB or Octave code. +> More information: . + +- Print the code metrics for the specified files: + +`mh_metric {{path/to/file1.m path/to/file2.m ...}}` + +- Print the code metrics for the specified Octave files: + +`mh_metric --octave {{path/to/file1.m path/to/file2.m ...}}` + +- Print the code metrics for the specified directory recursively: + +`mh_metric {{path/to/directory}}` + +- Print the code metrics for the current directory: + +`mh_metric` + +- Print the code metrics report in HTML or JSON format: + +`mh_metric --{{html|json}} {{path/to/output_file}}` diff --git a/micro b/micro new file mode 100644 index 00000000..e36eeb25 --- /dev/null +++ b/micro @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# micro + +> A modern and intuitive terminal-based text editor. +> You can use your keyboard, but also your mouse to navigate and/or select text. +> More information: . + +- Open a file: + +`micro {{path/to/file}}` + +- Save a file: + +` + S` + +- Cut the entire line: + +` + K` + +- Search for a pattern in the file (press `Ctrl + N`/`Ctrl + P` to go to next/previous match): + +` + F "{{pattern}}" ` + +- Execute a command: + +` + E {{command}} ` + +- Perform a substitution in the whole file: + +` + E replaceall "{{pattern}}" "{{replacement}}" ` + +- Quit: + +` + Q` diff --git a/mid3v2 b/mid3v2 new file mode 100644 index 00000000..c77fb1cf --- /dev/null +++ b/mid3v2 @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mid3v2 + +> Edit audio tags. +> See also: `id3v2`. +> More information: . + +- List all supported ID3v2.3 or ID3v2.4 frames and their meanings: + +`id3v2 --list-frames {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- List all supported ID3v1 numeric genres: + +`id3v2 --list-genres {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- List all tags in specific files: + +`id3v2 --list {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- Set specific artist, album, or song information: + +`id3v2 {{--artist|--album|--song}}={{string}} {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- Set specific picture information: + +`id3v2 --picture={{filename:description:image_type:mime_type}} {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- Set specific year information: + +`id3v2 --year={{YYYY}} {{path/to/file1.mp3 path/to/file2.mp3 ...}}` + +- Set specific date information: + +`id3v2 --date={{YYYY-MM-DD}} {{path/to/file1.mp3 path/to/file2.mp3 ...}}` diff --git a/middleman b/middleman new file mode 100644 index 00000000..99489942 --- /dev/null +++ b/middleman @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# middleman + +> Static site generator written in Ruby. +> More information: . + +- Create a new Middleman project: + +`middleman init "{{project_name}}"` + +- Start local server for current project on port 4567: + +`middleman server` + +- Start local server for current project on a specified port: + +`middleman server -p "{{port}}"` + +- Build the project in the current directory to prepare for deployment: + +`bundle exec middleman build` + +- Deploy the Middleman project in the current directory: + +`middleman deploy` diff --git a/minetest b/minetest new file mode 100644 index 00000000..8d596d1e --- /dev/null +++ b/minetest @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minetest + +> Multiplayer infinite-world block sandbox. +> See also `minetestserver`, the server-only binary. +> More information: . + +- Start Minetest in client mode: + +`minetest` + +- Start Minetest in server mode by hosting a specific world: + +`minetest --server --world {{name}}` + +- Write logs to a specific file: + +`minetest --logfile {{path/to/file}}` + +- Only write errors to the console: + +`minetest --quiet` diff --git a/minetestserver b/minetestserver new file mode 100644 index 00000000..7a959650 --- /dev/null +++ b/minetestserver @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minetestserver + +> Multiplayer infinite-world block sandbox server. +> See also `minetest`, the graphical client. +> More information: . + +- Start the server: + +`minetestserver` + +- List available worlds: + +`minetestserver --world list` + +- Load the specified world: + +`minetestserver --world {{world_name}}` + +- List the available game IDs: + +`minetestserver --gameid list` + +- Use the specified game: + +`minetestserver --gameid {{game_id}}` + +- Listen on a specific port: + +`minetestserver --port {{34567}}` + +- Migrate to a different data backend: + +`minetestserver --migrate {{sqlite3|leveldb|redis}}` + +- Start an interactive terminal after starting the server: + +`minetestserver --terminal` diff --git a/mingle b/mingle new file mode 100644 index 00000000..029e606d --- /dev/null +++ b/mingle @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mingle + +> Bundle the edges of a graph layout. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Bundle the edges of one or more graph layouts (that already have layout information): + +`mingle {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}` + +- Perform layout, bundling, and output to a picture with one command: + +`dot {{path/to/input.gv}} | mingle | dot -T {{png}} > {{path/to/output.png}}` + +- Display help: + +`mingle -?` diff --git a/minifab b/minifab new file mode 100644 index 00000000..fc879aba --- /dev/null +++ b/minifab @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minifab + +> Utility tool that automates the setup and deployment of Hyperledger Fabric networks. +> More information: . + +- Bring up the default Hyperledger Fabric network: + +`minifab up -i {{minifab_version}}` + +- Bring down the Hyperledger Fabric network: + +`minifab down` + +- Install chaincode onto a specified channel: + +`minifab install -n {{chaincode_name}}` + +- Install a specific chaincode version onto a channel: + +`minifab install -n {{chaincode_name}} -v {{chaincode_version}}` + +- Initialize the chaincode after installation/upgrade: + +`minifab approve,commit,initialize,discover` + +- Invoke a chaincode method with the specified arguments: + +`minifab invoke -n {{chaincode_name}} -p '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` + +- Make a query on the ledger: + +`minifab blockquery {{block_number}}` + +- Quickly run an application: + +`minifab apprun -l {{app_programming_language}}` diff --git a/minikube b/minikube new file mode 100644 index 00000000..70ebb0e9 --- /dev/null +++ b/minikube @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minikube + +> Run Kubernetes locally. +> More information: . + +- Start the cluster: + +`minikube start` + +- Get the IP address of the cluster: + +`minikube ip` + +- Access a service named my_service exposed via a node port and get the URL: + +`minikube service {{my_service}} --url` + +- Open the Kubernetes dashboard in a browser: + +`minikube dashboard` + +- Stop the running cluster: + +`minikube stop` + +- Delete the cluster: + +`minikube delete` + +- Connect to LoadBalancer services: + +`minikube tunnel` diff --git a/miniserve b/miniserve new file mode 100644 index 00000000..99d5463c --- /dev/null +++ b/miniserve @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# miniserve + +> Simple HTTP file server. +> More information: . + +- Serve a directory: + +`miniserve {{path/to/directory}}` + +- Serve a single file: + +`miniserve {{path/to/file}}` + +- Serve a directory using HTTP basic authentication: + +`miniserve --auth {{username}}:{{password}} {{path/to/directory}}` diff --git a/minisign b/minisign new file mode 100644 index 00000000..211e3de7 --- /dev/null +++ b/minisign @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# minisign + +> A dead simple tool to sign files and verify signatures. +> More information: . + +- Generate a new keypair at the default location: + +`minisign -G` + +- Sign a file: + +`minisign -Sm {{path/to/file}}` + +- Sign a file, adding a trusted (signed) and an untrusted (unsigned) comment in the signature: + +`minisign -Sm {{path/to/file}} -c "{{Untrusted comment}}" -t "{{Trusted comment}}"` + +- Verify a file and the trusted comments in its signature using the specified public key file: + +`minisign -Vm {{path/to/file}} -p {{path/to/publickey.pub}}` + +- Verify a file and the trusted comments in its signature, specifying a public key as a Base64 encoded literal: + +`minisign -Vm {{path/to/file}} -P "{{public_key_base64}}"` diff --git a/mispipe b/mispipe new file mode 100644 index 00000000..bc52a257 --- /dev/null +++ b/mispipe @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mispipe + +> Pipe two commands and return the exit status of the first command. +> More information: . + +- Pipe two commands and return the exit status of the first command: + +`mispipe {{command1}} {{command2}}` diff --git a/mitmdump b/mitmdump new file mode 100644 index 00000000..0e316dbd --- /dev/null +++ b/mitmdump @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mitmdump + +> View, record, and programmatically transform HTTP traffic. +> The command-line counterpart to mitmproxy. +> More information: . + +- Start a proxy and save all output to a file: + +`mitmdump -w {{path/to/file}}` + +- Filter a saved traffic file to just POST requests: + +`mitmdump -nr {{input_filename}} -w {{output_filename}} "{{~m post}}"` + +- Replay a saved traffic file: + +`mitmdump -nc {{path/to/file}}` diff --git a/mitmproxy b/mitmproxy new file mode 100644 index 00000000..543a2f79 --- /dev/null +++ b/mitmproxy @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mitmproxy + +> An interactive man-in-the-middle HTTP proxy. +> See also: `mitmweb`. +> More information: . + +- Start `mitmproxy` with default settings: + +`mitmproxy` + +- Start `mitmproxy` bound to a custom address and port: + +`mitmproxy --listen-host {{ip_address}} --listen-port {{port}}` + +- Start `mitmproxy` using a script to process traffic: + +`mitmproxy --scripts {{path/to/script.py}}` + +- Export the logs with SSL/TLS master keys to external programs (wireshark, etc.): + +`SSLKEYLOGFILE="{{path/to/file}}" mitmproxy` diff --git a/mitmweb b/mitmweb new file mode 100644 index 00000000..a4184343 --- /dev/null +++ b/mitmweb @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mitmweb + +> A web-based interactive man-in-the-middle HTTP proxy. +> See also: `mitmproxy`. +> More information: . + +- Start `mitmweb` with default settings: + +`mitmweb` + +- Start `mitmweb` bound to a custom address and port: + +`mitmweb --listen-host {{ip_address}} --listen-port {{port}}` + +- Start `mitmweb` using a script to process traffic: + +`mitmweb --scripts {{path/to/script.py}}` diff --git a/mix b/mix new file mode 100644 index 00000000..ffe03dfe --- /dev/null +++ b/mix @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mix + +> Build tool that provides tasks for creating, compiling, and testing Elixir projects, managing its dependencies, and more. +> More information: . + +- Execute a particular file: + +`mix run {{my_script.exs}}` + +- Create a new project: + +`mix new {{project_name}}` + +- Compile project: + +`mix compile` + +- Run project tests: + +`mix test` + +- Display help: + +`mix help` diff --git a/mixxx b/mixxx new file mode 100644 index 00000000..9f2bdab0 --- /dev/null +++ b/mixxx @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mixxx + +> Free and open source cross-platform DJ software. +> More information: . + +- Start the Mixxx GUI in fullscreen: + +`mixxx --fullScreen` + +- Start in safe developer mode to debug a crash: + +`mixxx --developer --safeMode` + +- Debug a malfunction: + +`mixxx --debugAssertBreak --developer --loglevel trace` + +- Start Mixxx using the specified settings file: + +`mixxx --resourcePath {{mixxx/res/controllers}} --settingsPath {{path/to/settings-file}}` + +- Debug a custom controller mapping: + +`mixxx --controllerDebug --resourcePath {{path/to/mapping-directory}}` + +- Display help: + +`mixxx --help` diff --git a/mk b/mk new file mode 100644 index 00000000..bff5f6af --- /dev/null +++ b/mk @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mk + +> Task runner for targets described in Mkfile. +> Mostly used to control the compilation of an executable from source code. +> More information: . + +- Call the first target specified in the Mkfile (usually named "all"): + +`mk` + +- Call a specific target: + +`mk {{target}}` + +- Call a specific target, executing 4 jobs at a time in parallel: + +`NPROC=4 mk {{target}}` + +- Force mking of a target, even if source files are unchanged: + +`mk -w{{target}} {{target}}` + +- Assume all targets to be out of date. Thus, update `target` and all of its dependencies: + +`mk -a {{target}}` + +- Keep going as far as possible on error: + +`mk -k` diff --git a/mkcert b/mkcert new file mode 100644 index 00000000..6c4d9686 --- /dev/null +++ b/mkcert @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkcert + +> Make locally-trusted development certificates. +> More information: . + +- Install the local CA in the system trust store: + +`mkcert -install` + +- Generate certificate and private key for a given domain: + +`mkcert {{example.org}}` + +- Generate certificate and private key for multiple domains: + +`mkcert {{example.org}} {{myapp.dev}} {{127.0.0.1}}` + +- Generate wildcard certificate and private key for a given domain and its subdomains: + +`mkcert "{{*.example.it}}"` + +- Uninstall the local CA: + +`mkcert -uninstall` diff --git a/mkdir b/mkdir new file mode 100644 index 00000000..dd1678c6 --- /dev/null +++ b/mkdir @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkdir + +> Create directories and set their permissions. +> More information: . + +- Create specific directories: + +`mkdir {{path/to/directory1 path/to/directory2 ...}}` + +- Create specific directories and their [p]arents if needed: + +`mkdir -p {{path/to/directory1 path/to/directory2 ...}}` + +- Create directories with specific permissions: + +`mkdir -m {{rwxrw-r--}} {{path/to/directory1 path/to/directory2 ...}}` diff --git a/mkdocs b/mkdocs new file mode 100644 index 00000000..a30e2096 --- /dev/null +++ b/mkdocs @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkdocs + +> Project documentation with Markdown. +> More information: . + +- Create a new mkdocs project: + +`mkdocs new {{project_name}}` + +- Serve the project in the current directory using the mkdocs dev-server: + +`mkdocs serve` + +- Build the documentation in the current directory: + +`mkdocs build` + +- Deploy the documentation in the current directory to GitHub pages: + +`mkdocs gh-deploy` diff --git a/mkfifo b/mkfifo new file mode 100644 index 00000000..7b0ca6ec --- /dev/null +++ b/mkfifo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfifo + +> Makes FIFOs (named pipes). +> More information: . + +- Create a named pipe at a given path: + +`mkfifo {{path/to/pipe}}` diff --git a/mkfile b/mkfile new file mode 100644 index 00000000..132a7d66 --- /dev/null +++ b/mkfile @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkfile + +> Create empty files of any size. +> More information: . + +- Create an empty file of 15 kilobytes: + +`mkfile -n {{15k}} {{path/to/file}}` + +- Create a file of a given size and unit (bytes, KB, MB, GB): + +`mkfile -n {{size}}{{b|k|m|g}} {{path/to/file}}` + +- Create two files of 4 megabytes each: + +`mkfile -n {{4m}} {{first_filename}} {{second_filename}}` diff --git a/mktemp b/mktemp new file mode 100644 index 00000000..55ed9a5e --- /dev/null +++ b/mktemp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mktemp + +> Create a temporary file or directory. +> More information: . + +- Create an empty temporary file and print its absolute path: + +`mktemp` + +- Use a custom directory if `$TMPDIR` is not set (the default is platform-dependent, but usually `/tmp`): + +`mktemp -p {{/path/to/tempdir}}` + +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` + +- Use a custom file name template: + +`mktemp -t {{example.XXXXXXXX}}` + +- Create an empty temporary directory and print its absolute path: + +`mktemp -d` diff --git a/mktorrent b/mktorrent new file mode 100644 index 00000000..8b2695f1 --- /dev/null +++ b/mktorrent @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mktorrent + +> Create BitTorrent metainfo files. +> More information: . + +- Create a torrent with 2^21 KB as the piece size: + +`mktorrent -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` + +- Create a private torrent with a 2^21 KB piece size: + +`mktorrent -p -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` + +- Create a torrent with a comment: + +`mktorrent -c "{{comment}}" -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` + +- Create a torrent with multiple trackers: + +`mktorrent -a {{tracker_announce_url,tracker_announce_url_2}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` + +- Create a torrent with web seed URLs: + +`mktorrent -a {{tracker_announce_url}} -w {{web_seed_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` diff --git a/mkvmerge b/mkvmerge new file mode 100644 index 00000000..68da8041 --- /dev/null +++ b/mkvmerge @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mkvmerge + +> Merge and extract multimedia streams. +> More information: . + +- Display information about a Matroska file: + +`mkvmerge --identify {{path/to/file.mkv}}` + +- Extract the audio from track 1 of a specific file: + +`mkvextract tracks {{path/to/file.mkv}} {{1}}:{{path/to/output.webm}}` + +- Extract the subtitle from track 3 of a specific file: + +`mkvextract tracks {{path/to/file.mkv}} {{3}}:{{path/to/subs.srt}}` + +- Add a subtitle track to a file: + +`mkvmerge --output {{path/to/output.mkv}} {{path/to/file.mkv}} {{path/to/subs.srt}}` diff --git a/mlr b/mlr new file mode 100644 index 00000000..4184eafd --- /dev/null +++ b/mlr @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mlr + +> Miller is like `awk`, `sed`, `cut`, `join`, and `sort` for name-indexed data such as CSV, TSV, and tabular JSON. +> More information: . + +- Pretty-print a CSV file in a tabular format: + +`mlr --icsv --opprint cat {{example.csv}}` + +- Receive JSON data and pretty print the output: + +`echo '{"hello":"world"}' | mlr --ijson --opprint cat` + +- Sort alphabetically on a field: + +`mlr --icsv --opprint sort -f {{field}} {{example.csv}}` + +- Sort in descending numerical order on a field: + +`mlr --icsv --opprint sort -nr {{field}} {{example.csv}}` + +- Convert CSV to JSON, performing calculations and display those calculations: + +`mlr --icsv --ojson put '${{newField1}} = ${{oldFieldA}}/${{oldFieldB}}' {{example.csv}}` + +- Receive JSON and format the output as vertical JSON: + +`echo '{"hello":"world", "foo":"bar"}' | mlr --ijson --ojson --jvstack cat` + +- Filter lines of a compressed CSV file treating numbers as strings: + +`mlr --prepipe 'gunzip' --csv filter -S '${{fieldName}} =~ "{{regular_expression}}"' {{example.csv.gz}}` diff --git a/mm2gv b/mm2gv new file mode 100644 index 00000000..1845f572 --- /dev/null +++ b/mm2gv @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mm2gv + +> Convert a graph from Matrix Market `mm` format to `gv` format. +> Converters: `gml2gv`, `gv2gml`, `gv2gxl`, `gxl2gv`, `graphml2gv` & `mm2gv`. +> More information: . + +- Convert a graph from `mm` to `gv` format: + +`mm2gv -o {{output.gv}} {{input.mm}}` + +- Convert a graph using `stdin` and `stdout`: + +`cat {{input.mm}} | mm2gv > {{output.gv}}` + +- Display help: + +`mm2gv -?` diff --git a/mmdc b/mmdc new file mode 100644 index 00000000..75bcc471 --- /dev/null +++ b/mmdc @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mmdc + +> CLI for mermaid, a diagram generation tool with a domain-specific language. +> A mermaid definition file is taken as input and a SVG, PNG, or PDF file is generated as output. +> More information: . + +- Convert a file to the specified format (automatically determined from the file extension): + +`mmdc --input {{input.mmd}} --output {{output.svg}}` + +- Specify the theme of the chart: + +`mmdc --input {{input.mmd}} --output {{output.svg}} --theme {{forest|dark|neutral|default}}` + +- Specify the background color of the chart (e.g. `lime`, `"#D8064F"`, or `transparent`): + +`mmdc --input {{input.mmd}} --output {{output.svg}} --backgroundColor {{color}}` diff --git a/mmls b/mmls new file mode 100644 index 00000000..06438aff --- /dev/null +++ b/mmls @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mmls + +> Display the partition layout of a volume system. +> More information: . + +- Display the partition table stored in an image file: + +`mmls {{path/to/image_file}}` + +- Display the partition table with an additional column for the partition size: + +`mmls -B -i {{path/to/image_file}}` + +- Display the partition table in a split EWF image: + +`mmls -i ewf {{image.e01}} {{image.e02}}` + +- Display nested partition tables: + +`mmls -t {{nested_table_type}} -o {{offset}} {{path/to/image_file}}` diff --git a/mmv b/mmv new file mode 100644 index 00000000..7da68945 --- /dev/null +++ b/mmv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mmv + +> Move and rename files in bulk. +> More information: . + +- Rename all files with a certain extension to a different extension: + +`mmv "*{{.old_extension}}" "#1{{.new_extension}}"` + +- Copy `report6part4.txt` to `./french/rapport6partie4.txt` along with all similarly named files: + +`mmv -c "{{report*part*.txt}}" "{{./french/rapport#1partie#2.txt}}"` + +- Append all `.txt` files into one file: + +`mmv -a "{{*.txt}}" "{{all.txt}}"` + +- Convert dates in filenames from "M-D-Y" format to "D-M-Y" format: + +`mmv "{{[0-1][0-9]-[0-3][0-9]-[0-9][0-9][0-9][0-9].txt}}" "{{#3#4-#1#2-#5#6#7#8.txt}}"` diff --git a/mocha b/mocha new file mode 100644 index 00000000..871decae --- /dev/null +++ b/mocha @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mocha + +> A feature-rich JavaScript test framework. +> More information: . + +- Run tests with default configuration or as configured in `mocha.opts`: + +`mocha` + +- Run tests contained at a specific location: + +`mocha {{directory/with/tests}}` + +- Run tests that match a specific `grep` pattern: + +`mocha --grep {{regular_expression}}` + +- Run tests on changes to JavaScript files in the current directory and once initially: + +`mocha --watch` + +- Run tests with a specific reporter: + +`mocha --reporter {{reporter}}` diff --git a/mods b/mods new file mode 100644 index 00000000..cc7d75b8 --- /dev/null +++ b/mods @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mods + +> AI for the command line, built for pipelines. +> More information: . + +- Ask a generic question: + +`mods "{{write me a poem about platypuses}}"` + +- Open settings in your `$EDITOR`: + +`mods --settings` + +- Ask for comments on your code, in markdown format: + +`mods --format "{{what are your thoughts on improving this code?}}" < {{path/to/file}}` + +- Ask for help with your documentation, in markdown format: + +`mods --format "{{write a new section to this readme for a feature that sends you a free rabbit if you hit r}}" < {{README.md}}` + +- Organize your videos, in markdown format: + +`ls {{path/to/videos}} | mods --format "{{organize these by decade and summarize}}"` + +- Read through raw HTML and summarize the contents, in markdown format: + +`curl "{{https://api.open-meteo.com/v1/forecast?latitude=29.00&longitude=-90.00¤t_weather=true&hourly=temperature_2m,relativehumidity_2m,windspeed_10m}}" | mods --format "{{summarize this weather data for a human}}"` + +- Display help: + +`mods --help` diff --git a/moe b/moe new file mode 100644 index 00000000..3ba4451e --- /dev/null +++ b/moe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# moe + +> A WYSIWYG text editor for ISO-8859-15 encoded text. +> More information: . + +- Open moe and create a backup file (file~) when saving edits: + +`moe {{path/to/file}}` + +- Open a file as read-only: + +`moe --read-only {{path/to/file}}` + +- Edit a file without creating backups: + +`moe --no-backup {{path/to/file}}` + +- Edit a file ignoring case in searches: + +`moe --ignore-case {{path/to/file}}` + +- Save and Quit: + +` + X` diff --git a/mogrify b/mogrify new file mode 100644 index 00000000..4df533a9 --- /dev/null +++ b/mogrify @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mogrify + +> Perform operations on multiple images, such as resizing, cropping, flipping, and adding effects. +> Changes are applied directly to the original file. Part of ImageMagick. +> More information: . + +- Resize all JPEG images in the directory to 50% of their initial size: + +`mogrify -resize {{50%}} {{*.jpg}}` + +- Resize all images starting with `DSC` to 800x600: + +`mogrify -resize {{800x600}} {{DSC*}}` + +- Convert all PNGs in the directory to JPEG: + +`mogrify -format {{jpg}} {{*.png}}` + +- Halve the saturation of all image files in the current directory: + +`mogrify -modulate {{100,50}} {{*}}` + +- Double the brightness of all image files in the current directory: + +`mogrify -modulate {{200}} {{*}}` diff --git a/molecule b/molecule new file mode 100644 index 00000000..0d021d78 --- /dev/null +++ b/molecule @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# molecule + +> Molecule helps testing Ansible roles. +> More information: . + +- Create a new Ansible role: + +`molecule init role --role-name {{role_name}}` + +- Run tests: + +`molecule test` + +- Start the instance: + +`molecule create` + +- Configure the instance: + +`molecule converge` + +- List scenarios of the instance: + +`molecule matrix converge` + +- Log in into the instance: + +`molecule login` diff --git a/mongo b/mongo new file mode 100644 index 00000000..604f67a1 --- /dev/null +++ b/mongo @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongo + +> The legacy MongoDB shell. See `mongosh` for the new shell. +> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. +> More information: . + +- Connect to a local database on the default port (`mongodb://localhost:27017`): + +`mongo` + +- Connect to a database: + +`mongo --host {{host}} --port {{port}} {{db_name}}` + +- Authenticate using the specified username on the specified database (you will be prompted for a password): + +`mongo --host {{host}} --port {{port}} --username {{username}} --authenticationDatabase {{authdb_name}} {{db_name}}` + +- Evaluate a JavaScript expression on a database: + +`mongo --eval '{{JSON.stringify(db.foo.findOne())}}' {{db_name}}` diff --git a/mongod b/mongod new file mode 100644 index 00000000..ea1bdf3f --- /dev/null +++ b/mongod @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongod + +> The MongoDB database server. +> More information: . + +- Specify the storage directory (default: `/data/db` on Linux and macOS, `C:\data\db` on Windows): + +`mongod --dbpath {{path/to/directory}}` + +- Specify a configuration file: + +`mongod --config {{path/to/file}}` + +- Specify the port to listen on (default: 27017): + +`mongod --port {{port}}` + +- Specify the database profiling level. 0 is off, 1 is only slow operations, 2 is all (default: 0): + +`mongod --profile {{0|1|2}}` diff --git a/mongodump b/mongodump new file mode 100644 index 00000000..d54a3039 --- /dev/null +++ b/mongodump @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongodump + +> Utility to export the contents of a MongoDB instance. +> More information: . + +- Create a dump of all databases (this will place the files inside a directory called "dump"): + +`mongodump` + +- Specify an output location for the dump: + +`mongodump --out {{path/to/directory}}` + +- Create a dump of a given database: + +`mongodump --db {{database_name}}` + +- Create a dump of a given collection within a given database: + +`mongodump --collection {{collection_name}} --db {{database_name}}` + +- Connect to a given host running on a given port, and create a dump: + +`mongodump --host {{host}} --port {{port}}` + +- Create a dump of a given database with a given username; user will be prompted for password: + +`mongodump --username {{username}} {{database}} --password` + +- Create a dump from a specific instance; host, user, password and database will be defined in the connection string: + +`mongodump --uri {{connection_string}}` diff --git a/mongoexport b/mongoexport new file mode 100644 index 00000000..fdb93d56 --- /dev/null +++ b/mongoexport @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongoexport + +> Produce exports of data stored in a MongoDB instance formatted as JSON or CSV. +> More information: . + +- Export a collection to `stdout`, formatted as JSON: + +`mongoexport --uri={{connection_string}} --collection={{collection_name}}` + +- Export the documents in the specified collection that match a query to a JSON file: + +`mongoexport --db={{database_name}} --collection={{collection_name}} --query="{{query_object}}" --out={{path/to/file.json}}` + +- Export documents as a JSON array instead of one object per line: + +`mongoexport --collection={{collection_name}} --jsonArray` + +- Export documents to a CSV file: + +`mongoexport --collection={{collection_name}} --type={{csv}} --fields="{{field1,field2,...}}" --out={{path/to/file.csv}}` + +- Export documents that match the query in the specified file to a CSV file, omitting the list of field names on the first line: + +`mongoexport --collection={{collection_name}} --type={{csv}} --fields="{{field1,field2,...}}" --queryFile={{path/to/file}} --noHeaderLine --out={{path/to/file.csv}}` + +- Export documents to `stdout`, formatted as human-readable JSON: + +`mongoexport --uri={{mongodb_uri}} --collection={{collection_name}} --pretty` + +- Display help: + +`mongoexport --help` diff --git a/mongoimport b/mongoimport new file mode 100644 index 00000000..217a3c39 --- /dev/null +++ b/mongoimport @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongoimport + +> Imports content from a JSON, CSV, or TSV file into a MongoDB database. +> More information: . + +- Import a JSON file into a specific collection: + +`mongoimport --file={{path/to/file.json}} --uri={{mongodb_uri}} --collection={{collection_name}}` + +- Import a CSV file, using the first line of the file to determine field names: + +`mongoimport --type={{csv}} --file={{path/to/file.csv}} --db={{database_name}} --collection={{collection_name}}` + +- Import a JSON array, using each element as a separate document: + +`mongoimport --jsonArray --file={{path/to/file.json}}` + +- Import a JSON file using a specific mode and a query to match existing documents: + +`mongoimport --file={{path/to/file.json}} --mode={{delete|merge|upsert}} --upsertFields="{{field1,field2,...}}"` + +- Import a CSV file, reading field names from a separate CSV file and ignoring fields with empty values: + +`mongoimport --type={{csv}} --file={{path/to/file.csv}} --fieldFile={{path/to/field_file.csv}} --ignoreBlanks` + +- Display help: + +`mongoimport --help` diff --git a/mongorestore b/mongorestore new file mode 100644 index 00000000..c7dce9f7 --- /dev/null +++ b/mongorestore @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongorestore + +> Utility to import a collection or database from a binary dump into a MongoDB instance. +> More information: . + +- Import a BSON data dump from a directory to a MongoDB database: + +`mongorestore --db {{database_name}} {{path/to/directory}}` + +- Import a BSON data dump from a directory to a given database in a MongoDB server host, running at a given port, with user authentication (user will be prompted for password): + +`mongorestore --host {{database_host:port}} --db {{database_name}} --username {{username}} {{path/to/directory}} --password` + +- Import a collection from a BSON file to a MongoDB database: + +`mongorestore --db {{database_name}} {{path/to/file}}` + +- Import a collection from a BSON file to a given database in a MongoDB server host, running at a given port, with user authentication (user will be prompted for password): + +`mongorestore --host {{database_host:port}} --db {{database_name}} --username {{username}} {{path/to/file}} --password` diff --git a/mongosh b/mongosh new file mode 100644 index 00000000..0fef5d31 --- /dev/null +++ b/mongosh @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mongosh + +> A new shell for MongoDB, replacement for `mongo`. +> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. +> More information: . + +- Connect to a local database on the default port (`mongodb://localhost:27017`): + +`mongosh` + +- Connect to a database: + +`mongosh --host {{host}} --port {{port}} {{db_name}}` + +- Authenticate using the specified username on the specified database (you will be prompted for a password): + +`mongosh --host {{host}} --port {{port}} --username {{username}} --authenticationDatabase {{authdb_name}} {{db_name}}` + +- Evaluate a JavaScript expression on a database: + +`mongosh --eval '{{JSON.stringify(db.foo.findOne())}}' {{db_name}}` diff --git a/monodevelop b/monodevelop new file mode 100644 index 00000000..21c5977a --- /dev/null +++ b/monodevelop @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# monodevelop + +> Cross platform IDE for C#, F# and more. +> More information: . + +- Start MonoDevelop: + +`monodevelop` + +- Open a specific file: + +`monodevelop {{path/to/file}}` + +- Open a specific file with the caret at a specific position: + +`monodevelop {{path/to/file}};{{line_number}};{{column_number}}` + +- Force opening a new window instead of switching to an existing one: + +`monodevelop --new-window` + +- Disable redirection of `stdout` and `stderr` to a log file: + +`monodevelop --no-redirect` + +- Enable performance monitoring: + +`monodevelop --perf-log` diff --git a/monodis b/monodis new file mode 100644 index 00000000..127827f0 --- /dev/null +++ b/monodis @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# monodis + +> The Mono Common Intermediate Language (CIL) disassembler. +> More information: . + +- Disassemble an assembly to textual CIL: + +`monodis {{path/to/assembly.exe}}` + +- Save the output to a file: + +`monodis --output={{path/to/output.il}} {{path/to/assembly.exe}}` + +- Show information about an assembly: + +`monodis --assembly {{path/to/assembly.dll}}` + +- List the references of an assembly: + +`monodis --assemblyref {{path/to/assembly.exe}}` + +- List all the methods in an assembly: + +`monodis --method {{path/to/assembly.exe}}` + +- List resources embedded within an assembly: + +`monodis --manifest {{path/to/assembly.dll}}` + +- Extract all the embedded resources to the current directory: + +`monodis --mresources {{path/to/assembly.dll}}` diff --git a/monop b/monop new file mode 100644 index 00000000..53eb5d56 --- /dev/null +++ b/monop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# monop + +> Finds and displays signatures of Types and methods inside .NET assemblies. +> More information: . + +- Show the structure of a Type built-in of the .NET Framework: + +`monop {{System.String}}` + +- List the types in an assembly: + +`monop -r:{{path/to/assembly.exe}}` + +- Show the structure of a Type in a specific assembly: + +`monop -r:{{path/to/assembly.dll}} {{Namespace.Path.To.Type}}` + +- Only show members defined in the specified Type: + +`monop -r:{{path/to/assembly.dll}} --only-declared {{Namespace.Path.To.Type}}` + +- Show private members: + +`monop -r:{{path/to/assembly.dll}} --private {{Namespace.Path.To.Type}}` + +- Hide obsolete members: + +`monop -r:{{path/to/assembly.dll}} --filter-obsolete {{Namespace.Path.To.Type}}` + +- List the other assemblies that a specified assembly references: + +`monop -r:{{path/to/assembly.dll}} --refs` diff --git a/montage b/montage new file mode 100644 index 00000000..151ae57e --- /dev/null +++ b/montage @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# montage + +> Tiles images into a customizable grid. +> Part of ImageMagick. +> More information: . + +- Tile images into a grid, automatically resizing images larger than the grid cell size: + +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} {{path/to/montage.jpg}}` + +- Tile images into a grid, automatically calculating the grid cell size from the largest image: + +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} {{path/to/montage.jpg}}` + +- Specify the grid cell size and resize images to fit it before tiling: + +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{640x480+0+0}} {{path/to/montage.jpg}}` + +- Limit the number of rows and columns in the grid, causing input images to overflow into multiple output montages: + +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} -tile {{2x3}} {{montage_%d.jpg}}` + +- Resize and crop images to fill their grid cells before tiling: + +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} -resize {{640x480^}} -gravity {{center}} -crop {{640x480+0+0}} {{path/to/montage.jpg}}` diff --git a/more b/more new file mode 100644 index 00000000..3e0761e1 --- /dev/null +++ b/more @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# more + +> Interactively display a file, allowing scrolling and searching. +> See also: `less`. +> More information: . + +- Open a file: + +`more {{path/to/file}}` + +- Search case-[i]nsensitively when pressing "/": + +`more -i {{path/to/file}}` + +- Display a specific line: + +`more +{{line_number}} {{path/to/file}}` + +- Go to the next page: + +`` + +- Search for a string (press `n` to go to the next match): + +`/{{something}}` + +- Exit: + +`q` + +- Display help about interactive commands: + +`h` diff --git a/moreutils b/moreutils new file mode 100644 index 00000000..fb2384bd --- /dev/null +++ b/moreutils @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# moreutils + +> A collection of UNIX tools. +> Note: moreutils isn't a command, but a set of commands. +> More information: . + +- View documentation for pages related to standard streams: + +`tldr {{ifne|mispipe|pee|sponge|vipe|vidir}}` + +- View documentation for other pages: + +`tldr {{combine|errno|ifdata|isutt8|lckdo|parallel|zrun}}` diff --git a/moro b/moro new file mode 100644 index 00000000..7776d5de --- /dev/null +++ b/moro @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# moro + +> Track work time. +> More information: . + +- Invoke `moro` without parameters, to set the current time as the start of the working day: + +`moro` + +- Specify a custom time for the start of the working day: + +`moro hi {{09:30}}` + +- Invoke `moro` without parameters a second time, to set the current time at the end of the working day: + +`moro` + +- Specify a custom time for the end of the working day: + +`moro bye {{17:30}}` + +- Add a note on the current working day: + +`moro note {{3 hours on project Foo}}` + +- Show a report of time logs and notes for the current working day: + +`moro report` + +- Show a report of time logs and notes for all working days on record: + +`moro report --all` diff --git a/mosh b/mosh new file mode 100644 index 00000000..b0c0c553 --- /dev/null +++ b/mosh @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mosh + +> Mobile Shell (`mosh`) is a robust and responsive replacement for SSH. +> `mosh` persists connections to remote servers while roaming between networks. +> More information: . + +- Connect to a remote server: + +`mosh {{username}}@{{remote_host}}` + +- Connect to a remote server with a specific identity (private key): + +`mosh --ssh="ssh -i {{path/to/key_file}}" {{username}}@{{remote_host}}` + +- Connect to a remote server using a specific port: + +`mosh --ssh="ssh -p {{2222}}" {{username}}@{{remote_host}}` + +- Run a command on a remote server: + +`mosh {{remote_host}} -- {{command -with -flags}}` + +- Select Mosh UDP port (useful when `remote_host` is behind a NAT): + +`mosh -p {{124}} {{username}}@{{remote_host}}` + +- Usage when `mosh-server` binary is outside standard path: + +`mosh --server={{path/to/bin/}}mosh-server {{remote_host}}` diff --git a/mosquitto b/mosquitto new file mode 100644 index 00000000..24e93b1a --- /dev/null +++ b/mosquitto @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mosquitto + +> An MQTT broker. +> More information: . + +- Start Mosquitto: + +`mosquitto` + +- Specify a configuration file to use: + +`mosquitto --config-file {{path/to/file.conf}}` + +- Listen on a specific port: + +`mosquitto --port {{8883}}` + +- Daemonize by forking into the background: + +`mosquitto --daemon` diff --git a/mosquitto_passwd b/mosquitto_passwd new file mode 100644 index 00000000..0f195999 --- /dev/null +++ b/mosquitto_passwd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mosquitto_passwd + +> Manage password files for mosquitto. +> See also `mosquitto`, the MQTT server that this manages. +> More information: . + +- Add a new user to a password file (will prompt to enter the password): + +`mosquitto_passwd {{path/to/password_file}} {{username}}` + +- Create the password file if it doesn't already exist: + +`mosquitto_passwd -c {{path/to/password_file}} {{username}}` + +- Delete the specified username instead: + +`mosquitto_passwd -D {{path/to/password_file}} {{username}}` + +- Upgrade an old plain-text password file to a hashed password file: + +`mosquitto_passwd -U {{path/to/password_file}}` diff --git a/mosquitto_pub b/mosquitto_pub new file mode 100644 index 00000000..7855fd07 --- /dev/null +++ b/mosquitto_pub @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mosquitto_pub + +> A simple MQTT version 3.1.1 client that will publish a single message on a topic and exit. +> More information: . + +- Publish a temperature value of 32 on the topic `sensors/temperature` to 192.168.1.1 (defaults to `localhost`) with Quality of Service (`QoS`) set to 1: + +`mosquitto_pub -h {{192.168.1.1}} -t {{sensors/temperature}} -m {{32}} -q {{1}}` + +- Publish timestamp and temperature data on the topic `sensors/temperature` to a remote host on a non-standard port: + +`mosquitto_pub -h {{192.168.1.1}} -p {{1885}} -t {{sensors/temperature}} -m "{{1266193804 32}}"` + +- Publish light switch status and retain the message on the topic `switches/kitchen_lights/status` to a remote host because there may be a long period of time between light switch events: + +`mosquitto_pub -r -h "{{iot.eclipse.org}}" -t {{switches/kitchen_lights/status}} -m "{{on}}"` + +- Send the contents of a file (`data.txt`) as a message and publish it to `sensors/temperature` topic: + +`mosquitto_pub -t {{sensors/temperature}} -f {{data.txt}}` + +- Send the contents of a file (`data.txt`), by reading from `stdin` and send the entire input as a message and publish it to `sensors/temperature` topic: + +`mosquitto_pub -t {{sensors/temperature}} -s < {{data.txt}}` + +- Read newline delimited data from `stdin` as a message and publish it to `sensors/temperature` topic: + +`{{echo data.txt}} | mosquitto_pub -t {{sensors/temperature}} -l` diff --git a/mosquitto_sub b/mosquitto_sub new file mode 100644 index 00000000..c52174c6 --- /dev/null +++ b/mosquitto_sub @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mosquitto_sub + +> A simple MQTT version 3.1.1 client that will subscribe to topics and print the messages that it receives. +> More information: . + +- Subscribe to the topic `sensors/temperature` information with Quality of Service (`QoS`) set to 1. (The default hostname is `localhost` and port 1883): + +`mosquitto_sub -t {{sensors/temperature}} -q {{1}}` + +- Subscribe to all broker status messages publishing on `iot.eclipse.org` port 1885 and print published messages verbosely: + +`mosquitto_sub -v -h "iot.eclipse.org" -p 1885 -t {{\$SYS/#}}` + +- Subscribe to multiple topics matching a given pattern. (+ takes any metric name): + +`mosquitto_sub -t {{sensors/machines/+/temperature/+}}` diff --git a/most b/most new file mode 100644 index 00000000..52e3315c --- /dev/null +++ b/most @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# most + +> Open one or several files for interactive reading, allowing scrolling and search. +> More information: . + +- Open a file: + +`most {{path/to/file}}` + +- Open several files: + +`most {{path/to/file1 path/to/file2 ...}}` + +- Open a file at the first occurrence of "string": + +`most {{path/to/file}} +/{{string}}` + +- Move through opened files: + +`:O n` + +- Jump to the 100th line: + +`{{100}}j` + +- Edit current file: + +`e` + +- Split the current window in half: + +` o` + +- Exit: + +`Q` diff --git a/mount b/mount new file mode 100644 index 00000000..01ed39ee --- /dev/null +++ b/mount @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mount + +> Provides access to an entire filesystem in one directory. +> More information: . + +- Show all mounted filesystems: + +`mount` + +- Mount a device to a directory: + +`mount -t {{filesystem_type}} {{path/to/device_file}} {{path/to/target_directory}}` + +- Create a specific directory if it does not exist and mount a device to it: + +`mount --mkdir {{path/to/device_file}} {{path/to/target_directory}}` + +- Mount a device to a directory for a specific user: + +`mount -o uid={{user_id}},gid={{group_id}} {{path/to/device_file}} {{path/to/target_directory}}` + +- Mount a CD-ROM device (with the filetype ISO9660) to `/cdrom` (readonly): + +`mount -t {{iso9660}} -o ro {{/dev/cdrom}} {{/cdrom}}` + +- Mount all the filesystem defined in `/etc/fstab`: + +`mount -a` + +- Mount a specific filesystem described in `/etc/fstab` (e.g. `/dev/sda1 /my_drive ext2 defaults 0 2`): + +`mount {{/my_drive}}` + +- Mount a directory to another directory: + +`mount --bind {{path/to/old_dir}} {{path/to/new_dir}}` diff --git a/mozillavpn b/mozillavpn new file mode 100644 index 00000000..5d9ba76f --- /dev/null +++ b/mozillavpn @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mozillavpn + +> A Virtual Private Network from the makers of Firefox. +> More information: . + +- Log in with an interactive prompt: + +`mozillavpn login` + +- Connect to Mozilla VPN: + +`mozillavpn activate` + +- Display the connection status: + +`mozillavpn status` + +- List available servers: + +`mozillavpn servers` + +- Select a specific server: + +`mozillavpn select {{server_name}}` + +- Disconnect from Mozilla VPN: + +`mozillavpn deactivate` + +- Log out: + +`mozillavpn logout` + +- Display help for a subcommand: + +`mozillavpn {{subcommand}} --help` diff --git a/mp3info b/mp3info new file mode 100644 index 00000000..ec424ca5 --- /dev/null +++ b/mp3info @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mp3info + +> Viewer/editor for ID3v1 (but not ID3v2) tags of MP3 files. +> More information: . + +- Show all ID3v1 tags of a specific MP3 file: + +`mp3info {{path/to/file.mp3}}` + +- Edit ID3v1 tags interactively: + +`mp3info -i {{path/to/file.mp3}}` + +- Set values for ID3v1 tags in a specific MP3 file: + +`mp3info -a "{{artist_name}}" -t "{{song_title}}" -l "{{album_title}}" -y {{year}} -c "{{comment_text}}" {{path/to/file.mp3}}` + +- Set the number of the track in the album for a specific MP3 file: + +`mp3info -n {{track_number}} {{path/to/file.mp3}}` + +- Print a list of valid genres and their numeric codes: + +`mp3info -G` + +- Set the music genre for a specific MP3 file: + +`mp3info -g {{genre_number}} {{path/to/file.mp3}}` diff --git a/mp4box b/mp4box new file mode 100644 index 00000000..fc8ed0f6 --- /dev/null +++ b/mp4box @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mp4box + +> MPEG-4 Systems Toolbox: muxe streams into MP4 container. +> More information: . + +- Display information about an existing MP4 file: + +`mp4box -info {{path/to/file}}` + +- Add an SRT subtitle file into an MP4 file: + +`mp4box -add {{input_subs.srt}}:lang=eng -add {{input.mp4}} {{output.mp4}}` + +- Combine audio from one file and video from another: + +`mp4box -add {{input1.mp4}}#audio -add {{input2.mp4}}#video {{output.mp4}}` diff --git a/mpc b/mpc new file mode 100644 index 00000000..e72fc9ff --- /dev/null +++ b/mpc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mpc + +> Music Player Client. +> Program for controlling the Music Player Daemon (MPD). +> More information: . + +- Toggle play/pause: + +`mpc toggle` + +- Stop playing: + +`mpc stop` + +- Show information about the currently playing song: + +`mpc status` + +- Play next song: + +`mpc next` + +- Play previous song: + +`mpc prev` + +- Forward or rewind the currently playing song: + +`mpc [+-]{{seconds}}` diff --git a/mpd b/mpd new file mode 100644 index 00000000..601fef83 --- /dev/null +++ b/mpd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mpd + +> Music Player Daemon. +> More information: . + +- Start MPD: + +`mpd` + +- Start MPD but don't read from the configuration file: + +`mpd --no-config` + +- Start MPD and don't detach it from the console: + +`mpd --no-daemon` + +- Kill the currently running MPD session: + +`mpd --kill` diff --git a/mpg321 b/mpg321 new file mode 100644 index 00000000..eceb9b92 --- /dev/null +++ b/mpg321 @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mpg321 + +> High Performance MPEG 1.0/2.0/2.5 Audio Player for Layer 1, 2, and 3. +> Mpg321 was written (sometime in 1999) to be a drop-in replacement for the (previously) non-free mpg123 player. +> More information: . + +- Play an audio source exactly N times (N=0 means forever): + +`mpg321 -l {{N}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` + +- Play a directory recursively: + +`mpg321 -B {{path/to/directory}}` + +- Enable Basic Keys ( `*` or `/` - Increase or decrease volume, `n` - Skip song, `m` - Mute/unmute.) while playing: + +`mpg321 -K {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` + +- Play files randomly until interrupted: + +`mpg321 -Z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` + +- Shuffle the files before playing them once: + +`mpg321 -z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` + +- Play all files in the current directory and subdirectories, randomly (until interrupted), with Basic Keys enabled: + +`mpg321 -B -Z -K .` diff --git a/mplayer b/mplayer new file mode 100644 index 00000000..ba57a35a --- /dev/null +++ b/mplayer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mplayer + +> Cross-platform multimedia player. +> More information: . + +- Play the specified file or URL: + +`mplayer {{path/to/file|url}}` + +- Play multiple files: + +`mplayer {{path/to/file1 path/to/file2 ...}}` + +- Play a specific file repeatedly: + +`mplayer -loop {{0}} {{path/to/file}}` + +- Pause playback: + +`` + +- Quit mplayer: + +`` + +- Seek backward or forward 10 seconds: + +`{{Left|Right}}` diff --git a/mpv b/mpv new file mode 100644 index 00000000..11d31d2a --- /dev/null +++ b/mpv @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mpv + +> A audio/video player based on MPlayer. +> More information: . + +- Play a video or audio from a URL or file: + +`mpv {{url|path/to/file}}'` + +- Jump backward/forward 5 seconds: + +`LEFT RIGHT` + +- Jump backward/forward 1 minute: + +`DOWN UP` + +- Decrease or increase playback speed by 10%: + +`[ ]` + +- Take a screenshot of the current frame (saved to `./mpv-shotNNNN.jpg` by default): + +`s` + +- Play a file at a specified speed (1 by default): + +`mpv --speed {{0.01..100}} {{path/to/file}}` + +- Play a file using a profile defined in the `mpv.conf` file: + +`mpv --profile {{profile_name}} {{path/to/file}}` + +- Display the output of webcam or other video input device: + +`mpv /dev/{{video0}}` diff --git a/mr b/mr new file mode 100644 index 00000000..cc5816b0 --- /dev/null +++ b/mr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mr + +> Manage all of your version control repositories at once. +> More information: . + +- Register a repository: + +`mr register` + +- Update repositories in 5 concurrent jobs: + +`mr -j{{5}} update` + +- Print the status of all repositories: + +`mr status` + +- Checkout all repositories to the latest version: + +`mr checkout` diff --git a/msbuild b/msbuild new file mode 100644 index 00000000..e2e89f51 --- /dev/null +++ b/msbuild @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# msbuild + +> The Microsoft build tool for Visual Studio project solutions. +> More information: . + +- Build the first project file in the current directory: + +`msbuild` + +- Build a specific project file: + +`msbuild {{path/to/project_file}}` + +- Specify one or more semicolon-separated targets to build: + +`msbuild {{path/to/project_file}} /target:{{targets}}` + +- Specify one or more semicolon-separated properties: + +`msbuild {{path/to/project_file}} /property:{{name=value}}` + +- Specify the build tools version to use: + +`msbuild {{path/to/project_file}} /toolsversion:{{version}}` + +- Display detailed information at the end of the log about how the project was configured: + +`msbuild {{path/to/project_file}} /detailedsummary` + +- Display help: + +`msbuild /help` diff --git a/mscore b/mscore new file mode 100644 index 00000000..ef1db4f5 --- /dev/null +++ b/mscore @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mscore + +> This command is an alias of `musescore`. +> More information: . + +- View documentation for the original command: + +`tldr musescore` diff --git a/msfvenom b/msfvenom new file mode 100644 index 00000000..4154534d --- /dev/null +++ b/msfvenom @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# msfvenom + +> Manually generate payloads for metasploit. +> More information: . + +- List payloads: + +`msfvenom -l payloads` + +- List formats: + +`msfvenom -l formats` + +- Show payload options: + +`msfvenom -p {{payload}} --list-options` + +- Create an ELF binary with a reverse TCP handler: + +`msfvenom -p linux/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f elf -o {{path/to/binary}}` + +- Create an EXE binary with a reverse TCP handler: + +`msfvenom -p windows/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f exe -o {{path/to/binary.exe}}` + +- Create a raw bash with a reverse TCP handler: + +`msfvenom -p cmd/unix/reverse_bash LHOST={{local_ip}} LPORT={{local_port}} -f raw` diff --git a/msmtp b/msmtp new file mode 100644 index 00000000..a19bec52 --- /dev/null +++ b/msmtp @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# msmtp + +> An SMTP client. +> It reads text from `stdin` and sends it to an SMTP server. +> More information: . + +- Send an email using the default account configured in `~/.msmtprc`: + +`echo "{{Hello world}}" | msmtp {{to@example.org}}` + +- Send an email using a specific account configured in `~/.msmtprc`: + +`echo "{{Hello world}}" | msmtp --account={{account_name}} {{to@example.org}}` + +- Send an email without a configured account. The password should be specified in the `~/.msmtprc` file: + +`echo "{{Hello world}}" | msmtp --host={{localhost}} --port={{999}} --from={{from@example.org}} {{to@example.org}}` diff --git a/mtr b/mtr new file mode 100644 index 00000000..8586469e --- /dev/null +++ b/mtr @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mtr + +> Matt's Traceroute: combined traceroute and ping tool. +> More information: . + +- Traceroute to a host and continuously ping all intermediary hops: + +`mtr {{example.com}}` + +- Disable IP address and host name mapping: + +`mtr --no-dns {{example.com}}` + +- Generate output after pinging each hop 10 times: + +`mtr --report-wide {{example.com}}` + +- Force IP IPv4 or IPV6: + +`mtr -4 {{example.com}}` + +- Wait for a given time (in seconds) before sending another packet to the same hop: + +`mtr --interval {{10}} {{example.com}}` + +- Display the Autonomous System Number (ASN) for each hop: + +`mtr --aslookup {{example.com}}` + +- Display both IP address and reverse DNS name: + +`mtr --show-ips {{example.com}}` diff --git a/mtvtoppm b/mtvtoppm new file mode 100644 index 00000000..0d53f78b --- /dev/null +++ b/mtvtoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mtvtoppm + +> Convert an MTV or PRT ray tracer file to a PPM image. +> More information: . + +- Convert an MTV or PRT ray tracer file to a PPM image: + +`mtvtoppm {{path/to/file.mtv}} > {{path/to/output.ppm}}` diff --git a/mu b/mu new file mode 100644 index 00000000..79008187 --- /dev/null +++ b/mu @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mu + +> Index and search emails from a local Maildir. +> More information: . + +- Initialize the email database, optionally specifying the Maildir directory and email addresses: + +`mu init --maildir={{path/to/directory}} --my-address={{name@example.com}}` + +- Index new emails: + +`mu index` + +- Find messages using a specific keyword (in message body, subject, sender, ...): + +`mu find {{keyword}}` + +- Find messages to Alice with subject `jellyfish` containing the words `apples` or `oranges`: + +`mu find to:{{alice}} subject:{{jellyfish}} {{apples}} OR {{oranges}}` + +- Find unread messages about words starting with `soc` (the `*` only works at the end of the search term) in the Sent Items folder: + +`mu find 'subject:{{soc}}*' flag:{{unread}} maildir:'/{{Sent Items}}'` + +- Find messages from Sam with attached images, between 2 KiB and 2 MiB, written in 2021: + +`mu find 'mime:{{image/*}} size:{{2k..2m}} date:{{20210101..20211231}} from:{{sam}}` + +- List contacts with `Bob` in either name or email address: + +`mu cfind {{Bob}}` diff --git a/mullvad b/mullvad new file mode 100644 index 00000000..173ff757 --- /dev/null +++ b/mullvad @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mullvad + +> CLI client for Mullvad VPN. +> More information: . + +- Link your mullvad account with the specified account number: + +`mullvad account set {{account_number}}` + +- Enable LAN access while VPN is on: + +`mullvad lan set allow` + +- Establish the VPN tunnel: + +`mullvad connect` + +- Check status of VPN tunnel: + +`mullvad status` diff --git a/multipass b/multipass new file mode 100644 index 00000000..8e6cc5df --- /dev/null +++ b/multipass @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# multipass + +> Manage Ubuntu virtual machines using native hypervisors. +> More information: . + +- List the aliases that can be used to launch an instance: + +`multipass find` + +- Launch a new instance, set its name and use a cloud-init configuration file: + +`multipass launch -n {{instance_name}} --cloud-init {{configuration_file}}` + +- List all the created instances and some of their properties: + +`multipass list` + +- Start a specific instance by name: + +`multipass start {{instance_name}}` + +- Show the properties of an instance: + +`multipass info {{instance_name}}` + +- Open a shell prompt on a specific instance by name: + +`multipass shell {{instance_name}}` + +- Delete an instance by name: + +`multipass delete {{instance_name}}` + +- Mount a directory into a specific instance: + +`multipass mount {{path/to/local/directory}} {{instance_name}}:{{path/to/target/directory}}` diff --git a/multitail b/multitail new file mode 100644 index 00000000..b9b78cbe --- /dev/null +++ b/multitail @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# multitail + +> Extension of tail. +> More information: . + +- Tail all files matching a pattern in a single stream: + +`multitail -Q 1 '{{pattern}}'` + +- Tail all files in a directory in a single stream: + +`multitail -Q 1 '{{path/to/directory}}/*'` + +- Automatically add new files to a window: + +`multitail -Q {{pattern}}` + +- Show 5 logfiles while merging 2 and put them in 2 columns with only one in the left column: + +`multitail -s 2 -sn 1,3 {{path/to/mergefile}} -I {{path/to/file1}} {{path/to/file2}} {{path/to/file3}} {{path/to/file4}}` diff --git a/mumble b/mumble new file mode 100644 index 00000000..88263506 --- /dev/null +++ b/mumble @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mumble + +> Low-latency, high quality voice chat software. +> More information: . + +- Open Mumble: + +`mumble` + +- Open Mumble and immediately connect to a server: + +`mumble mumble://{{username}}@{{example.com}}` + +- Open Mumble and immediately connect to a password protected server: + +`mumble mumble://{{username}}:{{password}}@{{example.com}}` + +- Mute/unmute the microphone in a running Mumble instance: + +`mumble rpc {{mute|unmute}}` + +- Mute/unmute the microphone and the audio output of Mumble: + +`mumble rpc {{deaf|undeaf}}` diff --git a/mupdf b/mupdf new file mode 100644 index 00000000..b8e742b4 --- /dev/null +++ b/mupdf @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mupdf + +> A lightweight PDF, XPS, and E-book viewer. +> More information: . + +- Open a PDF on the first page: + +`mupdf {{path/to/file}}` + +- Open a PDF on page 3: + +`mupdf {{path/to/file}} {{3}}` + +- Open a password secured PDF: + +`mupdf -p {{password}} {{path/to/file}}` + +- Open a PDF with an initial zoom level, specified as DPI, of 72: + +`mupdf -r {{72}} {{path/to/file}}` + +- Open a PDF with inverted color: + +`mupdf -I {{path/to/file}}` + +- Open a PDF tinted red #FF0000 (hexadecimal color syntax RRGGBB): + +`mupdf -C {{FF0000}}` + +- Open a PDF without anti-aliasing (0 = off, 8 = best): + +`mupdf -A {{0}}` diff --git a/musescore b/musescore new file mode 100644 index 00000000..3005f19c --- /dev/null +++ b/musescore @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# musescore + +> MuseScore 3 sheet music editor. +> More information: . + +- Use a specific audio driver: + +`musescore --audio-driver {{jack|alsa|portaudio|pulse}}` + +- Set the MP3 output bitrate in kbit/s: + +`musescore --bitrate {{bitrate}}` + +- Start MuseScore in debug mode: + +`musescore --debug` + +- Enable experimental features, such as layers: + +`musescore --experimental` + +- Export the given file to the specified output file. The file type depends on the given extension: + +`musescore --export-to {{output_file}} {{input_file}}` + +- Print a diff between the given scores: + +`musescore --diff {{path/to/file1}} {{path/to/file2}}` + +- Specify a MIDI import operations file: + +`musescore --midi-operations {{path/to/file}}` diff --git a/musl-gcc b/musl-gcc new file mode 100644 index 00000000..019884e6 --- /dev/null +++ b/musl-gcc @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# musl-gcc + +> A wrapper around `gcc` that automatically sets options for linking against musl libc. +> All options specified are passed directly to `gcc`. +> More information: . + +- View documentation for `gcc`: + +`tldr gcc` diff --git a/mutagen b/mutagen new file mode 100644 index 00000000..75e2a135 --- /dev/null +++ b/mutagen @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mutagen + +> Real-time file synchronization and network forwarding tool. +> More information: . + +- 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/}}` + +- 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/}}` + +- Stop a running session: + +`mutagen sync terminate {{session_name}}` + +- Start a project: + +`mutagen project start` + +- Stop a project: + +`mutagen project terminate` + +- List running sessions for the current project: + +`mutagen project list` diff --git a/mutool b/mutool new file mode 100644 index 00000000..79e5e171 --- /dev/null +++ b/mutool @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mutool + +> Convert, query information and extract data from PDF files. +> More information: . + +- Convert a range of pages to PNGs (Note: `%nd` in the output placeholder must be replaced with a print modifier like `%d` or `%2d`): + +`mutool convert -o {{path/to/output%nd.png}} {{path/to/input.pdf}} {{1-10}}` + +- Convert one or more pages of a PDF into text in `stdout`: + +`mutool draw -F txt {{path/to/input.pdf}} {{2,3,5,...}}` + +- Concatenate multiple PDF files: + +`mutool merge -o {{path/to/output.pdf}} {{path/to/input1.pdf path/to/input2.pdf ...}}` + +- Query information about all content embedded in a PDF: + +`mutool info {{path/to/input.pdf}}` + +- Extract all images, fonts and resources embedded in a PDF to the current directory: + +`mutool extract {{path/to/input.pdf}}` + +- Show the outline (table of contents) of a PDF: + +`mutool show {{path/to/input.pdf}} outline` diff --git a/mutt b/mutt new file mode 100644 index 00000000..d19ba42f --- /dev/null +++ b/mutt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mutt + +> Command-line email client. +> More information: . + +- Open the specified mailbox: + +`mutt -f {{mailbox}}` + +- Send an email and specify a subject and a cc recipient: + +`mutt -s {{subject}} -c {{cc@example.com}} {{recipient@example.com}}` + +- Send an email with files attached: + +`mutt -a {{file1}} {{file2}} -- {{recipient@example.com}}` + +- Specify a file to include as the message body: + +`mutt -i {{path/to/file}} {{recipient@example.com}}` + +- Specify a draft file containing the header and the body of the message, in RFC 5322 format: + +`mutt -H {{path/to/file}} {{recipient@example.com}}` diff --git a/mv b/mv new file mode 100644 index 00000000..41e4c63c --- /dev/null +++ b/mv @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mv + +> Move or rename files and directories. +> More information: . + +- Rename a file or directory when the target is not an existing directory: + +`mv {{path/to/source}} {{path/to/target}}` + +- Move a file or directory into an existing directory: + +`mv {{path/to/source}} {{path/to/existing_directory}}` + +- Move multiple files into an existing directory, keeping the filenames unchanged: + +`mv {{path/to/source1 path/to/source2 ...}} {{path/to/existing_directory}}` + +- Do not prompt for confirmation before overwriting existing files: + +`mv -f {{path/to/source}} {{path/to/target}}` + +- Prompt for confirmation before overwriting existing files, regardless of file permissions: + +`mv -i {{path/to/source}} {{path/to/target}}` + +- Do not overwrite existing files at the target: + +`mv -n {{path/to/source}} {{path/to/target}}` + +- Move files in verbose mode, showing files after they are moved: + +`mv -v {{path/to/source}} {{path/to/target}}` diff --git a/mvn b/mvn new file mode 100644 index 00000000..fa70c381 --- /dev/null +++ b/mvn @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mvn + +> Apache Maven: build and manage Java-based projects. +> More information: . + +- Compile a project: + +`mvn compile` + +- Compile and package the compiled code in its distributable format, such as a `jar`: + +`mvn package` + +- Compile and package, skipping unit tests: + +`mvn package -DskipTests` + +- Install the built package in local maven repository. (This will invoke the compile and package commands too): + +`mvn install` + +- Delete build artifacts from the target directory: + +`mvn clean` + +- Do a clean and then invoke the package phase: + +`mvn clean package` + +- Clean and then package the code with a given build profile: + +`mvn clean -P {{profile}} package` + +- Run a class with a main method: + +`mvn exec:java -Dexec.mainClass="{{com.example.Main}}" -Dexec.args="{{argument1 argument2 ...}}"` diff --git a/mycli b/mycli new file mode 100644 index 00000000..e4883b9c --- /dev/null +++ b/mycli @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mycli + +> A command-line client for MySQL that can do auto-completion and syntax highlighting. +> More information: . + +- Connect to a local database on port 3306, using the current user's username: + +`mycli {{database_name}}` + +- Connect to a database (user will be prompted for a password): + +`mycli -u {{username}} {{database_name}}` + +- Connect to a database on another host: + +`mycli -h {{database_host}} -P {{port}} -u {{username}} {{database_name}}` diff --git a/mysql b/mysql new file mode 100644 index 00000000..c30f4a87 --- /dev/null +++ b/mysql @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysql + +> The MySQL command-line tool. +> More information: . + +- Connect to a database: + +`mysql {{database_name}}` + +- Connect to a database, user will be prompted for a password: + +`mysql -u {{user}} --password {{database_name}}` + +- Connect to a database on another host: + +`mysql -h {{database_host}} {{database_name}}` + +- Connect to a database through a Unix socket: + +`mysql --socket {{path/to/socket.sock}}` + +- Execute SQL statements in a script file (batch file): + +`mysql -e "source {{filename.sql}}" {{database_name}}` + +- Restore a database from a backup created with `mysqldump` (user will be prompted for a password): + +`mysql --user {{user}} --password {{database_name}} < {{path/to/backup.sql}}` + +- Restore all databases from a backup (user will be prompted for a password): + +`mysql --user {{user}} --password < {{path/to/backup.sql}}` diff --git a/mysqlbinlog b/mysqlbinlog new file mode 100644 index 00000000..cf231495 --- /dev/null +++ b/mysqlbinlog @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysqlbinlog + +> Utility for processing MySQL binary log files. +> More information: . + +- Show events from a specific binary log file: + +`mysqlbinlog {{path/to/binlog}}` + +- Show entries from a binary log for a specific database: + +`mysqlbinlog --database {{database_name}} {{path/to/binlog}}` + +- Show events from a binary log between specific dates: + +`mysqlbinlog --start-datetime='{{2022-01-01 01:00:00}}' --stop-datetime='{{2022-02-01 01:00:00}}' {{path/to/binlog}}` + +- Show events from a binary log between specific positions: + +`mysqlbinlog --start-position={{100}} --stop-position={{200}} {{path/to/binlog}}` + +- Show binary log from a MySQL server on the given host: + +`mysqlbinlog --host={{hostname}} {{path/to/binlog}}` diff --git a/mysqlcheck b/mysqlcheck new file mode 100644 index 00000000..29ac8a61 --- /dev/null +++ b/mysqlcheck @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysqlcheck + +> Check and repair MySQL tables. +> More information: . + +- Check a table: + +`mysqlcheck --check {{table}}` + +- Check a table and provide credentials to access it: + +`mysqlcheck --check {{table}} --user {{username}} --password {{password}}` + +- Repair a table: + +`mysqlcheck --repair {{table}}` + +- Optimize a table: + +`mysqlcheck --optimize {{table}}` diff --git a/mysqld b/mysqld new file mode 100644 index 00000000..5bc272d7 --- /dev/null +++ b/mysqld @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysqld + +> Start the MySQL database server. +> More information: . + +- Start the MySQL database server: + +`mysqld` + +- Start the server, printing error messages to the console: + +`mysqld --console` + +- Start the server, saving logging output to a custom log file: + +`mysqld --log={{path/to/file.log}}` + +- Print the default arguments and their values and exit: + +`mysqld --print-defaults` + +- Start the server, reading arguments and values from a file: + +`mysqld --defaults-file={{path/to/file}}` + +- Start the server and listen on a custom port: + +`mysqld --port={{port}}` + +- Display help: + +`mysqld --verbose --help` diff --git a/mysqldump b/mysqldump new file mode 100644 index 00000000..6b609886 --- /dev/null +++ b/mysqldump @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysqldump + +> Backups MySQL databases. +> See also `mysql` for restoring databases. +> More information: . + +- Create a backup (user will be prompted for a password): + +`mysqldump --user {{user}} --password {{database_name}} --result-file={{path/to/file.sql}}` + +- Backup a specific table redirecting the output to a file (user will be prompted for a password): + +`mysqldump --user {{user}} --password {{database_name}} {{table_name}} > {{path/to/file.sql}}` + +- Backup all databases redirecting the output to a file (user will be prompted for a password): + +`mysqldump --user {{user}} --password --all-databases > {{path/to/file.sql}}` + +- Backup all databases from a remote host, redirecting the output to a file (user will be prompted for a password): + +`mysqldump --host={{ip_or_hostname}} --user {{user}} --password --all-databases > {{path/to/file.sql}}` diff --git a/mysqlsh b/mysqlsh new file mode 100644 index 00000000..5cb4ba1c --- /dev/null +++ b/mysqlsh @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mysqlsh + +> Advanced command-line client for MySQL, supporting SQL, JavaScript, and Python. +> It offers features for managing InnoDB clusters and document store collections. +> More information: . + +- Start MySQL Shell in interactive mode: + +`mysqlsh` + +- Connect to a MySQL server: + +`mysqlsh --user {{username}} --host {{hostname}} --port {{port}}` + +- Execute a SQL statement on the server and exit: + +`mysqlsh --user {{username}} --execute '{{sql_statement}}'` + +- Start MySQL Shell in JavaScript mode: + +`mysqlsh --js` + +- Start MySQL Shell in Python mode: + +`mysqlsh --py` + +- Import JSON documents into a MySQL collection: + +`mysqlsh --import {{path/to/file.json}} --schema {{schema_name}} --collection {{collection_name}}` + +- Enable verbose output: + +`mysqlsh --verbose` diff --git a/mytop b/mytop new file mode 100644 index 00000000..16a4be7b --- /dev/null +++ b/mytop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mytop + +> Display MySQL server performance info like `top`. +> More information: . + +- Start `mytop`: + +`mytop` + +- Connect with a specified username and password: + +`mytop -u {{user}} -p {{password}}` + +- Connect with a specified username (the user will be prompted for a password): + +`mytop -u {{user}} --prompt` + +- Do not show any idle (sleeping) threads: + +`mytop -u {{user}} -p {{password}} --noidle` diff --git a/n b/n new file mode 100644 index 00000000..2c9a247f --- /dev/null +++ b/n @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# n + +> Manage multiple node versions. +> More information: . + +- Install a given version of node. If the version is already installed, it will be activated: + +`n {{version}}` + +- Display installed versions and interactively activate one of them: + +`n` + +- Remove a version: + +`n rm {{version}}` + +- Execute a file with a given version: + +`n use {{version}} {{file.js}}` + +- Output binary path for a version: + +`n bin {{version}}` diff --git a/naabu b/naabu new file mode 100644 index 00000000..c400e4eb --- /dev/null +++ b/naabu @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# naabu + +> A fast port scanner written in Go with a focus on reliability and simplicity. +> Note: Some features are only activated when `naabu` is run with root privileges such as SYN scan. +> More information: . + +- Run a SYN scan against default (top 100) ports of remote host: + +`sudo naabu -host {{host}}` + +- Display available network interfaces and public IP address of the local host: + +`naabu -interface-list` + +- Scan all ports of the remote host (CONNECT scan without `sudo`): + +`naabu -p - -host {{host}}` + +- Scan the top 1000 ports of the remote host: + +`naabu -top-ports 1000 -host {{host}}` + +- Scan TCP ports 80, 443 and UDP port 53 of the remote host: + +`naabu -p 80,443,u:53 -host {{host}}` + +- Show CDN type the remote host is using, if any: + +`naabu -p 80,443 -cdn -host {{host}}` + +- Run `nmap` from `naabu` for additional functionalities (`nmap` must be installed): + +`sudo naabu -v -host {{host}} -nmap-cli 'nmap {{-v -T5 -sC}}'` diff --git a/nano b/nano new file mode 100644 index 00000000..e0ff8314 --- /dev/null +++ b/nano @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nano + +> Command-line text editor. An enhanced `Pico` clone. +> More information: . + +- Start the editor: + +`nano` + +- Start the editor without using configuration files: + +`nano --ignorercfiles` + +- Open specific files, moving to the next file when closing the previous one: + +`nano {{path/to/file1 path/to/file2 ...}}` + +- Open a file and position the cursor at a specific line and column: + +`nano +{{line}},{{column}} {{path/to/file}}` + +- Open a file and enable soft wrapping: + +`nano --softwrap {{path/to/file}}` + +- Open a file and indent new lines to the previous line's indentation: + +`nano --autoindent {{path/to/file}}` + +- Open a file and create a backup file (`path/to/file~`) on save: + +`nano --backup {{path/to/file}}` diff --git a/nasm b/nasm new file mode 100644 index 00000000..7953990e --- /dev/null +++ b/nasm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nasm + +> The Netwide Assembler, a portable 80x86 assembler. +> More information: . + +- Assemble `source.asm` into a binary file `source`, in the (default) raw binary format: + +`nasm {{source.asm}}` + +- Assemble `source.asm` into a binary file `output_file`, in the specified format: + +`nasm -f {{format}} {{source.asm}} -o {{output_file}}` + +- List valid output formats (along with basic nasm help): + +`nasm -hf` + +- Assemble and generate an assembly listing file: + +`nasm -l {{list_file}} {{source.asm}}` + +- 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}}` diff --git a/nativefier b/nativefier new file mode 100644 index 00000000..ad0e4634 --- /dev/null +++ b/nativefier @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nativefier + +> Command-line tool to create a desktop app for any web site with minimal configuration. +> More information: . + +- Make a desktop app for a website: + +`nativefier {{url}}` + +- Create a desktop app with a custom name: + +`nativefier --name {{name}} {{url}}` + +- Use a custom icon, should be a PNG: + +`nativefier --icon {{path/to/icon.png}} {{url}}` diff --git a/nbtscan b/nbtscan new file mode 100644 index 00000000..b5f9185e --- /dev/null +++ b/nbtscan @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nbtscan + +> Scan networks for NetBIOS name information. +> More information: . + +- Scan a network for NetBIOS names: + +`nbtscan {{192.168.0.1/24}}` + +- Scan a single IP address: + +`nbtscan {{192.168.0.1}}` + +- Display verbose output: + +`nbtscan -v {{192.168.0.1/24}}` + +- Display output in `/etc/hosts` format: + +`nbtscan -e {{192.168.0.1/24}}` + +- Read IP addresses/networks to scan from a file: + +`nbtscan -f {{path/to/file.txt}}` diff --git a/nc b/nc new file mode 100644 index 00000000..64aa074c --- /dev/null +++ b/nc @@ -0,0 +1,40 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nc + +> A versatile utility for redirecting IO into a network stream. +> More information: . + +- Start a listener on the specified TCP port and send a file into it: + +`nc -l -p {{port}} < {{filename}}` + +- Connect to a target listener on the specified port and receive a file from it: + +`nc {{host}} {{port}} > {{received_filename}}` + +- Scan the open TCP ports of a specified host: + +`nc -v -z -w {{timeout_in_seconds}} {{host}} {{start_port}}-{{end_port}}` + +- Start a listener on the specified TCP port and provide your local shell access to the connected party (this is dangerous and can be abused): + +`nc -l -p {{port}} -e {{shell_executable}}` + +- Connect to a target listener and provide your local shell access to the remote party (this is dangerous and can be abused): + +`nc {{host}} {{port}} -e {{shell_executable}}` + +- Act as a proxy and forward data from a local TCP port to the given remote host: + +`nc -l -p {{local_port}} | nc {{host}} {{remote_port}}` + +- Send an HTTP GET request: + +`echo -e "GET / HTTP/1.1 +Host: {{host}} + +" | nc {{host}} 80` diff --git a/ncc b/ncc new file mode 100644 index 00000000..c7187ce1 --- /dev/null +++ b/ncc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ncc + +> Compile a Node.js application into a single file. +> Supports TypeScript, binary addons and dynamic requires. +> More information: . + +- Bundle a Node.js application: + +`ncc build {{path/to/file.js}}` + +- Bundle and minify a Node.js application: + +`ncc build --minify {{path/to/file.js}}` + +- Bundle and minify a Node.js application and generate source maps: + +`ncc build --source-map {{path/to/file.js}}` + +- Automatically recompile on changes to source files: + +`ncc build --watch {{path/to/file.js}}` + +- Bundle a Node.js application into a temporary directory and run it for testing: + +`ncc run {{path/to/file.js}}` + +- Clean the `ncc` cache: + +`ncc clean cache` diff --git a/ncdu b/ncdu new file mode 100644 index 00000000..518da8de --- /dev/null +++ b/ncdu @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ncdu + +> Disk usage analyzer with an ncurses interface. +> More information: . + +- Analyze the current working directory: + +`ncdu` + +- Colorize output: + +`ncdu --color {{dark|off}}` + +- Analyze a given directory: + +`ncdu {{path/to/directory}}` + +- Save results to a file: + +`ncdu -o {{path/to/file}}` + +- Exclude files that match a pattern, argument can be given multiple times to add more patterns: + +`ncdu --exclude '{{*.txt}}'` diff --git a/ncmpcpp b/ncmpcpp new file mode 100644 index 00000000..c600c7cf --- /dev/null +++ b/ncmpcpp @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ncmpcpp + +> A command-line music player client for the Music Player Daemon. +> More information: . + +- Connect to a music player daemon on a given host and port: + +`ncmpcpp --host {{ip}} --port {{port}}` + +- Display metadata of the current song to console: + +`ncmpcpp --current-song` + +- Use a specified configuration file: + +`ncmpcpp --config {{file}}` + +- Use a different set of key bindings from a file: + +`ncmpcpp --bindings {{file}}` diff --git a/ncu b/ncu new file mode 100644 index 00000000..a43a23ff --- /dev/null +++ b/ncu @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ncu + +> Find newer versions of package dependencies and check outdated npm packages locally or globally. +> `ncu` only updates dependency versions in `package.json`. To install the new versions, run `npm install` afterwards. +> More information: . + +- List outdated dependencies in the current directory: + +`ncu` + +- List outdated global npm packages: + +`ncu --global` + +- Upgrade all dependencies in the current directory: + +`ncu --upgrade` + +- Interactively upgrade dependencies in the current directory: + +`ncu --interactive` + +- List outdated dependencies up to the highest minor version: + +`ncu --target {{minor}}` + +- List outdated dependencies that match a keyword or regular expression: + +`ncu --filter {{keyword|/regex/}}` + +- List only a specific section of outdated dependencies: + +`ncu --dep {{dev|optional|peer|prod|packageManager}}` + +- Display help: + +`ncu --help` diff --git a/neato b/neato new file mode 100644 index 00000000..b16e8bdc --- /dev/null +++ b/neato @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# neato + +> Render an image of a `linear undirected` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`neato -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`neato -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`neato -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{graph {this -- that} }}" | neato -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`neato -?` diff --git a/ned b/ned new file mode 100644 index 00000000..e4a4f761 --- /dev/null +++ b/ned @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ned + +> Is like `grep` but with powerful replace capabilities. +> Unlike `sed`, as it isn't restricted to line oriented editing. +> More information: . + +- Recursively search starting in the current directory, ignoring case: + +`ned --ignore-case --recursive '{{^[dl]og}}' {{.}}` + +- Search always showing colored output: + +`ned --colors '{{^[dl]og}}' {{.}}` + +- Search never showing colored output: + +`ned --colors=never '{{^[dl]og}}' {{.}}` + +- Search ignoring certain files: + +`ned --recursive --exclude '{{*.htm}}' '{{^[dl]og}}' {{.}}` + +- Simple replace: + +`ned '{{dog}}' --replace '{{cat}}' {{.}}` + +- Replace using numbered group references: + +`ned '{{the ([a-z]+) dog and the ([a-z]+) dog}}' --replace '{{the $2 dog and the $1 dog}}' {{.}}` + +- Replace changing case: + +`ned '{{([a-z]+) dog}}' --case-replacements --replace '{{\U$1! dog}}' --stdout {{.}}` + +- Preview results of a find and replace without updating the target files: + +`ned '{{^[sb]ad}}' --replace '{{happy}}' --stdout {{.}}` diff --git a/neofetch b/neofetch new file mode 100644 index 00000000..1e0cc421 --- /dev/null +++ b/neofetch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# neofetch + +> Display information about your operating system, software and hardware. +> More information: . + +- Return the default config, and create it if it's the first time the program runs: + +`neofetch` + +- Trigger an info line from appearing in the output, where 'infoname' is the function name in the configuration file, e.g. memory: + +`neofetch --{{enable|disable}} {{infoname}}` + +- Hide/Show OS architecture: + +`neofetch --os_arch {{on|off}}` + +- Enable/Disable CPU brand in output: + +`neofetch --cpu_brand {{on|off}}` diff --git a/neomutt b/neomutt new file mode 100644 index 00000000..8334d295 --- /dev/null +++ b/neomutt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# neomutt + +> NeoMutt command-line email client. +> More information: . + +- Open the specified mailbox: + +`neomutt -f {{path/to/mailbox}}` + +- Start writing an email and specify a subject and a `cc` recipient: + +`neomutt -s "{{subject}}" -c {{cc@example.com}} {{recipient@example.com}}` + +- Send an email with files attached: + +`neomutt -a {{path/to/file1 path/to/file2 ...}} -- {{recipient@example.com}}` + +- Specify a file to include as the message body: + +`neomutt -i {{path/to/file}} {{recipient@example.com}}` + +- Specify a draft file containing the header and the body of the message, in RFC 5322 format: + +`neomutt -H {{path/to/file}} {{recipient@example.com}}` diff --git a/neotoppm b/neotoppm new file mode 100644 index 00000000..f20a5718 --- /dev/null +++ b/neotoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# neotoppm + +> Convert an Atari Neochrome NEO file into a PPM image. +> More information: . + +- Generate the PPM image as output for an Atari Neochrome NEO file as input: + +`neotoppm {{path/to/file.neo}}` + +- Display version: + +`neotoppm -version` diff --git a/nest b/nest new file mode 100644 index 00000000..f7fbdb61 --- /dev/null +++ b/nest @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nest + +> Command-line tool to initialize, develop, and maintain Nest applications. +> More information: . + +- Display information about installed nest version: + +`nest info` + +- Create a new NestJS project in a directory of the same name: + +`nest new {{project_name}}` + +- Build a specific NestJS project: + +`nest build {{project_name}}` + +- Run a specific NestJS project: + +`nest start {{project_name}}` + +- Import a library into the current NestJS project: + +`nest add {{library_name}}` diff --git a/netbsd/cal b/netbsd/cal new file mode 100644 index 00000000..a3b32651 --- /dev/null +++ b/netbsd/cal @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Display a calendar. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display a calendar for a specific year: + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` + +- Display the whole calendar for the current year using [j]ulian days (one-based, numbered from January 1): + +`cal -y -j` + +- [h]ighlight today and display [3] months spanning the date: + +`cal -h -3 {{month}} {{year}}` + +- Display the 2 months [B]efore and 3 [A]fter a specific [m]onth of the current year: + +`cal -A 3 -B 2 {{month}}` + +- Display a specific number of months before and after ([C]ontext) the specified month: + +`cal -C {{months}} {{month}}` + +- Specify the starting [d]ay of the week (0: Sunday, 1: Monday, ..., 6: Saturday): + +`cal -d {{0..6}}` diff --git a/netbsd/chfn b/netbsd/chfn new file mode 100644 index 00000000..0eb16d11 --- /dev/null +++ b/netbsd/chfn @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chfn + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/netbsd/chpass b/netbsd/chpass new file mode 100644 index 00000000..d81df6ab --- /dev/null +++ b/netbsd/chpass @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chpass + +> Add or change user database information, including login shell and password. +> See also: `passwd`. +> More information: . + +- Set a specific login shell for the current user interactively: + +`su -c chpass` + +- Set a specific login [s]hell for the current user: + +`chpass -s {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`chpass chsh -s {{path/to/shell}} {{username}}` + +- Specify a user database entry in the `passwd` file format: + +`su -c 'chpass -a {{username:encrypted_password:uid:gid:...}} -s {{path/to/file}}' {{username}}` + +- Only update the [l]ocal password file: + +`su -c 'chpass -l -s {{path/to/shell}}' {{username}}` + +- Forcedly change the database [y]P password database entry: + +`su -c 'chpass -y -s {{path/to/shell}}' {{username}}` diff --git a/netbsd/chsh b/netbsd/chsh new file mode 100644 index 00000000..1cfdee2b --- /dev/null +++ b/netbsd/chsh @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chsh + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/netbsd/df b/netbsd/df new file mode 100644 index 00000000..34fa978f --- /dev/null +++ b/netbsd/df @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage using 512-byte units: + +`df` + +- Use [h]uman-readable units (based on powers of 1024): + +`df -h` + +- Display all the fields of the structure(s) returned by `statvfs`: + +`df -G` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Include statistics on the number of free and used [i]nodes: + +`df -i` + +- Use 1024-byte units when writing space figures: + +`df -k` + +- Display information in a [P]ortable way: + +`df -P` diff --git a/netbsd/pkgin b/netbsd/pkgin new file mode 100644 index 00000000..d90bc086 --- /dev/null +++ b/netbsd/pkgin @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgin + +> Manage `pkgsrc` binary packages on NetBSD. +> More information: . + +- Install a package: + +`pkgin install {{package}}` + +- Remove a package and its dependencies: + +`pkgin remove {{package}}` + +- Upgrade all packages: + +`pkgin full-upgrade` + +- Search for a package: + +`pkgin search {{keyword}}` + +- List installed packages: + +`pkgin list` + +- Remove unneeded dependencies: + +`pkgin autoremove` diff --git a/netbsd/sed b/netbsd/sed new file mode 100644 index 00000000..a67a8d3f --- /dev/null +++ b/netbsd/sed @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script.sed}}` + +- Delay opening each file until a command containing the related `w` function or flag is applied to a line of input: + +`{{command}} | sed -fa {{path/to/script.sed}}` + +- Turn on GNU re[g]ex extension: + +`{{command}} | sed -fg {{path/to/script.sed}}` + +- Replace all `apple` (extended regex) occurrences with `APPLE` (extended regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed -E 's/(apple)/\U\1/g'` + +- Print just a first line to `stdout`: + +`{{command}} | sed -n '1p'` + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in a specific file and overwrite the original file in place: + +`sed -i 's/apple/mango/g' {{path/to/file}}` diff --git a/netbsd/sockstat b/netbsd/sockstat new file mode 100644 index 00000000..7064c951 --- /dev/null +++ b/netbsd/sockstat @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, netbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# sockstat + +> List open Internet or UNIX domain sockets. +> Note: this program is a rewrite for NetBSD 3.0 from FreeBSD's `sockstat`. +> See also: `netstat`. +> More information: . + +- Show information for IPv4, IPv6 and Unix sockets for both listening and connected sockets: + +`sockstat` + +- Show information for IPv[4]/IPv[6] sockets [l]istening on specific [p]orts using a specific [P]rotocol: + +`sockstat -{{4|6}} -l -P {{tcp|udp|sctp|divert}} -p {{port1,port2...}}` + +- Also show [c]onnected sockets, showing [u]nix sockets: + +`sockstat -cu` + +- Only show [n]umeric output, without resolving symbolic names for addresses and ports: + +`sockstat -n` + +- Only list sockets of the specified address [f]amily: + +`sockstat -f {{inet|inet6|local|unix}}` diff --git a/netcat b/netcat new file mode 100644 index 00000000..4719892f --- /dev/null +++ b/netcat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# netcat + +> This command is an alias of `nc`. + +- View documentation for the original command: + +`tldr nc` diff --git a/netlify b/netlify new file mode 100644 index 00000000..fbd9b2ac --- /dev/null +++ b/netlify @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# netlify + +> Deploy sites and configure continuous deployment to the Netlify platform. +> More information: . + +- Log in to the Netlify account: + +`netlify login` + +- Deploy the contents of a directory to Netlify: + +`netlify deploy` + +- Configure continuous deployment for a new or an existing site: + +`netlify init` + +- Start a local dev server: + +`netlify dev` diff --git a/netperf b/netperf new file mode 100644 index 00000000..7a44e7d4 --- /dev/null +++ b/netperf @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# netperf + +> Client-side command for `netperf`, the benchmarking application that measures network throughput. Similar to `iperf`. +> See also: `netserver`, for the server-side command. +> More information: . + +- Connect to server on a specific IP address via default port (12865): + +`netperf {{address}}` + +- Specify [p]ort: + +`netperf {{address}} -p {{port}}` + +- Specify the sampling [l]ength in seconds (default is 10): + +`netperf {{address}} -l {{seconds}}` + +- Force IPv[4] or IPv[6]: + +`netperf {{address}} -{{4|6}}` diff --git a/netserver b/netserver new file mode 100644 index 00000000..ea50fe22 --- /dev/null +++ b/netserver @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# netserver + +> Server-side command for `netperf`, the benchmarking application that measures network throughput. +> See also: `netperf`, for the client-side command. +> More information: . + +- Start a server on the default port (12865) and fork to background: + +`netserver` + +- Start server in foreground and do not fork: + +`netserver -D` + +- Specify [p]ort: + +`netserver -p {{port}}` + +- Force IPv[4] or IPv[6]: + +`netserver -{{4|6}}` diff --git a/netstat b/netstat new file mode 100644 index 00000000..81e2d1f9 --- /dev/null +++ b/netstat @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# netstat + +> Displays network-related information such as open connections, open socket ports, etc. +> More information: . + +- List all ports: + +`netstat --all` + +- List all listening ports: + +`netstat --listening` + +- List listening TCP ports: + +`netstat --tcp` + +- Display PID and program names: + +`netstat --program` + +- List information continuously: + +`netstat --continuous` + +- List routes and do not resolve IP addresses to hostnames: + +`netstat --route --numeric` + +- List listening TCP and UDP ports (+ user and process if you're root): + +`netstat --listening --program --numeric --tcp --udp --extend` diff --git a/newman b/newman new file mode 100644 index 00000000..5eb2e257 --- /dev/null +++ b/newman @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# newman + +> Collection runner for Postman. +> More information: . + +- Run a collection (from a file): + +`newman run {{path/to/collection.json}}` + +- Run a collection (from a URL): + +`newman run {{https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv}}` diff --git a/newsboat b/newsboat new file mode 100644 index 00000000..807a20b0 --- /dev/null +++ b/newsboat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# newsboat + +> An RSS/Atom feed reader for text terminals. +> More information: . + +- First import feed URLs from an OPML file: + +`newsboat -i {{my-feeds.xml}}` + +- Alternatively, add feeds manually: + +`echo {{http://example.com/path/to/feed}} >> "${HOME}/.newsboat/urls"` + +- Start Newsboat and refresh all feeds on startup: + +`newsboat -r` + +- Execute one or more commands in non-interactive mode: + +`newsboat -x {{reload print-unread ...}}` + +- See keyboard shortcuts (the most relevant are visible in the status line): + +`?` diff --git a/next b/next new file mode 100644 index 00000000..e5c38c38 --- /dev/null +++ b/next @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# next + +> React framework that uses server-side rendering for building optimized web applications. +> More information: . + +- Start the current application in development mode: + +`next dev` + +- Start the current application and listen on a specific port: + +`next dev --port {{port}}` + +- Build the current application optimized for production: + +`next build` + +- Start the compiled application in production mode: + +`next start` + +- Start the compiled application and listen on a specific port: + +`next start --port {{port}}` + +- Export the current application to static HTML pages: + +`next export` + +- Display the Next.js telemetry status: + +`next telemetry` + +- Display help for a subcommand: + +`next {{build|dev|export|start|telemetry}} --help` diff --git a/nextclade b/nextclade new file mode 100644 index 00000000..0903b7d4 --- /dev/null +++ b/nextclade @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nextclade + +> Bioinformatics tool for virus genome alignment, clade assignment and qc checks. +> More information: . + +- Align sequences to user provided [r]eference, [o]utputting the alignment to a file: + +`nextclade run {{path/to/sequences.fa}} -r {{path/to/reference.fa}} -o {{path/to/alignment.fa}}` + +- Create a [t]SV report, auto-downloading the latest [d]ataset: + +`nextclade run {{path/to/fasta}} -d {{dataset_name}} -t {{path/to/report.tsv}}` + +- List all available datasets: + +`nextclade dataset list` + +- Download the latest SARS-CoV-2 dataset: + +`nextclade dataset get --name sars-cov-2 --output-dir {{path/to/directory}}` + +- Use a downloaded [D]ataset, producing all [O]utputs: + +`nextclade run -D {{path/to/dataset_dir}} -O {{path/to/output_dir}} {{path/to/sequences.fasta}}` + +- Run on multiple files: + +`nextclade run -d {{dataset_name}} -t {{path/to/output_tsv}} -- {{path/to/input_fasta_1 path/to/input_fasta_2 ...}}` + +- Try reverse complement if sequence does not align: + +`nextclade run --retry-reverse-complement -d {{dataset_name}} -t {{path/to/output_tsv}} {{path/to/input_fasta}}` diff --git a/nextflow b/nextflow new file mode 100644 index 00000000..1fcd8010 --- /dev/null +++ b/nextflow @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nextflow + +> Run computational pipelines. Mostly used for bioinformatics workflows. +> More information: . + +- Run a pipeline, use cached results from previous runs: + +`nextflow run {{main.nf}} -resume` + +- Run a specific release of a remote workflow from GitHub: + +`nextflow run {{user/repo}} -revision {{release_tag}}` + +- Run with a given work directory for intermediate files, save execution report: + +`nextflow run {{workflow}} -work-dir {{path/to/directory}} -with-report {{report.html}}` + +- Show details of previous runs in current directory: + +`nextflow log` + +- Remove cache and intermediate files for a specific run: + +`nextflow clean -force {{run_name}}` + +- List all downloaded projects: + +`nextflow list` + +- Pull the latest version of a remote workflow from Bitbucket: + +`nextflow pull {{user/repo}} -hub bitbucket` + +- Update Nextflow: + +`nextflow self-update` diff --git a/nf-core b/nf-core new file mode 100644 index 00000000..f7bf2f21 --- /dev/null +++ b/nf-core @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nf-core + +> The nf-core framework tools, to create, check and develop best-practice guidelines for Nextflow. +> More information: . + +- List existing pipelines on nf-core: + +`nf-core list` + +- Create a new pipeline skeleton: + +`nf-core create` + +- Lint the pipeline code: + +`nf-core lint {{path/to/directory}}` + +- Bump software versions in pipeline recipe: + +`nf-core bump-version {{path/to/directory}} {{new_version}}` + +- Launch an nf-core pipeline: + +`nf-core launch {{pipeline_name}}` + +- Download an nf-core pipeline for offline use: + +`nf-core download {{pipeline_name}}` diff --git a/ng b/ng new file mode 100644 index 00000000..175c4012 --- /dev/null +++ b/ng @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ng + +> Create and manage Angular applications. +> More information: . + +- Create a new Angular application inside a directory: + +`ng new {{project_name}}` + +- Add a new component to one's application: + +`ng generate component {{component_name}}` + +- Add a new class to one's application: + +`ng generate class {{class_name}}` + +- Add a new directive to one's application: + +`ng generate directive {{directive_name}}` + +- Run the application with the following command in its root directory: + +`ng serve` + +- Build the application: + +`ng build` + +- Run unit tests: + +`ng test` + +- Display the version of your current Angular installation: + +`ng version` diff --git a/nginx b/nginx new file mode 100644 index 00000000..e768acf2 --- /dev/null +++ b/nginx @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nginx + +> Nginx web server. +> More information: . + +- Start server with the default configuration file: + +`nginx` + +- Start server with a custom configuration file: + +`nginx -c {{configuration_file}}` + +- Start server with a prefix for all relative paths in the configuration file: + +`nginx -c {{configuration_file}} -p {{prefix/for/relative/paths}}` + +- Test the configuration without affecting the running server: + +`nginx -t` + +- Reload the configuration by sending a signal with no downtime: + +`nginx -s reload` diff --git a/ngrep b/ngrep new file mode 100644 index 00000000..841096d4 --- /dev/null +++ b/ngrep @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ngrep + +> Filter network traffic packets using regular expressions. +> More information: . + +- Capture traffic of all interfaces: + +`ngrep -d any` + +- Capture traffic of a specific interface: + +`ngrep -d {{eth0}}` + +- Capture traffic crossing port 22 of interface eth0: + +`ngrep -d {{eth0}} port {{22}}` + +- Capture traffic from or to a host: + +`ngrep host {{www.example.com}}` + +- Filter keyword 'User-Agent:' of interface eth0: + +`ngrep -d {{eth0}} '{{User-Agent:}}'` diff --git a/ngrok b/ngrok new file mode 100644 index 00000000..38ab08e1 --- /dev/null +++ b/ngrok @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ngrok + +> Reverse proxy that creates a secure tunnel from a public endpoint to a locally running web service. +> More information: . + +- Expose a local HTTP service on a given port: + +`ngrok http {{80}}` + +- Expose a local HTTP service on a specific host: + +`ngrok http {{foo.dev}}:{{80}}` + +- Expose a local HTTPS server: + +`ngrok http https://localhost` + +- Expose TCP traffic on a given port: + +`ngrok tcp {{22}}` + +- Expose TLS traffic for a specific host and port: + +`ngrok tls -hostname={{foo.com}} {{443}}` diff --git a/ngs b/ngs new file mode 100644 index 00000000..b0f91295 --- /dev/null +++ b/ngs @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ngs + +> Scripting language created specifically for Ops. +> More information: . + +- Execute a code snippet: + +`ngs -e "{{echo('ngs is executed')}}"` + +- Execute a script: + +`ngs {{path/to/script.ngs}}` + +- Display version: + +`ngs --version` diff --git a/nice b/nice new file mode 100644 index 00000000..133fdbe7 --- /dev/null +++ b/nice @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nice + +> Execute a program with a custom scheduling priority (niceness). +> Niceness values range from -20 (the highest priority) to 19 (the lowest). +> More information: . + +- Launch a program with altered priority: + +`nice -n {{niceness_value}} {{command}}` diff --git a/nikto b/nikto new file mode 100644 index 00000000..1f0a236f --- /dev/null +++ b/nikto @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nikto + +> Web server scanner which performs tests against web servers for multiple items. +> More information: . + +- Perform a basic Nikto scan against a target host: + +`perl nikto.pl -h {{192.168.0.1}}` + +- Specify the port number when performing a basic scan: + +`perl nikto.pl -h {{192.168.0.1}} -p {{443}}` + +- Scan ports and protocols with full URL syntax: + +`perl nikto.pl -h {{https://192.168.0.1:443/}}` + +- Scan multiple ports in the same scanning session: + +`perl nikto.pl -h {{192.168.0.1}} -p {{80,88,443}}` + +- Update to the latest plugins and databases: + +`perl nikto.pl -update` diff --git a/nim b/nim new file mode 100644 index 00000000..2399491d --- /dev/null +++ b/nim @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nim + +> The Nim compiler. +> Processes, compiles and links Nim language source files. +> More information: . + +- Compile a source file: + +`nim compile {{path/to/file.nim}}` + +- Compile and run a source file: + +`nim compile -r {{path/to/file.nim}}` + +- Compile a source file with release optimizations enabled: + +`nim compile -d:release {{path/to/file.nim}}` + +- Build a release binary optimized for low file size: + +`nim compile -d:release --opt:size {{path/to/file.nim}}` + +- Generate HTML documentation for a module (output will be placed in the current directory): + +`nim doc {{path/to/file.nim}}` + +- Check a file for syntax and semantics: + +`nim check {{path/to/file.nim}}` diff --git a/nimble b/nimble new file mode 100644 index 00000000..d1609acd --- /dev/null +++ b/nimble @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nimble + +> Package manager for the Nim programming language. +> Manage Nim projects and their dependencies. +> More information: . + +- Search for packages: + +`nimble search {{search_string}}` + +- Install a package: + +`nimble install {{package}}` + +- List installed packages: + +`nimble list -i` + +- Create a new Nimble package in the current directory: + +`nimble init` + +- Build a Nimble package: + +`nimble build` + +- Install a Nimble package: + +`nimble install` diff --git a/ninja b/ninja new file mode 100644 index 00000000..f37d15ba --- /dev/null +++ b/ninja @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ninja + +> A Build system designed to be fast. +> More information: . + +- Build in the current directory: + +`ninja` + +- Build in the current directory, executing 4 jobs at a time in parallel: + +`ninja -j {{4}}` + +- Build a program in a given directory: + +`ninja -C {{path/to/directory}}` + +- Show targets (e.g. `install` and `uninstall`): + +`ninja -t targets` + +- Display help: + +`ninja -h` diff --git a/nix b/nix new file mode 100644 index 00000000..df4b73da --- /dev/null +++ b/nix @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix + +> A powerful package manager that makes package management reliable, reproducible, and declarative. +> `nix` is experimental and requires enabling experimental features. For a classic, stable interface, see `tldr nix classic`. +> Some subcommands such as `build`, `develop`, `flake`, `registry`, `profile`, `search`, `repl`, `store`, `edit`, `why-depends`, etc. have their own usage documentation. +> More information: . + +- Enable the `nix` command: + +`mkdir -p ~/.config/nix; echo 'experimental-features = nix-command flakes' > ~/.config/nix/nix.conf` + +- Search for a package in nixpkgs via its name or description: + +`nix search nixpkgs {{search_term}}` + +- Start a shell with the specified packages from nixpkgs available: + +`nix shell {{nixpkgs#pkg1 nixpkgs#pkg2 nixpkgs#pkg3 ...}}` + +- Install some packages from nixpkgs permanently: + +`nix profile install {{nixpkgs#pkg1 nixpkgs#pkg2 nixpkgs#pkg3 ...}}` + +- Remove unused paths from Nix store to free up space: + +`nix store gc` + +- Start an interactive environment for evaluating Nix expressions: + +`nix repl` + +- Display help for a specific subcommand: + +`nix help {{subcommand}}` diff --git a/nix-build b/nix-build new file mode 100644 index 00000000..887c9633 --- /dev/null +++ b/nix-build @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix-build + +> Build a Nix expression. +> See also: `tldr nix3 build`. +> More information: . + +- Build a Nix expression: + +`nix-build '' --attr {{firefox}}` + +- Build a sandboxed Nix expression (on non-NixOS): + +`nix-build '' --attr {{firefox}} --option sandbox true` diff --git a/nix-classic b/nix-classic new file mode 100644 index 00000000..79d5a49a --- /dev/null +++ b/nix-classic @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix classic + +> A classic, stable interface to a powerful package manager that makes package management reliable, reproducible, and declarative. +> Some Nix commands such as `nix-build`, `nix-shell`, `nix-env`, and `nix-store` have their own pages. See also: `tldr nix`. +> More information: . + +- Search for a package in nixpkgs via its name: + +`nix-env -qaP {{search_term_regexp}}` + +- Start a shell with the specified packages available: + +`nix-shell -p {{pkg1 pkg2 pkg3...}}` + +- Install some packages permanently: + +`nix-env -iA {{nixpkgs.pkg1 nixpkgs.pkg2...}}` + +- Show all dependencies of a store path (package), in a tree format: + +`nix-store --query --tree {{/nix/store/...}}` + +- Update the channels (repositories): + +`nix-channel --update` + +- Remove unused paths from Nix store: + +`nix-collect-garbage` diff --git a/nix-collect-garbage b/nix-collect-garbage new file mode 100644 index 00000000..a6415857 --- /dev/null +++ b/nix-collect-garbage @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix-collect-garbage + +> Delete unused and unreachable nix store paths. +> Generations can be listed using `nix-env --list-generations`. +> More information: . + +- Delete all store paths unused by current generations of each profile: + +`sudo nix-collect-garbage --delete-old` + +- Simulate the deletion of old store paths: + +`sudo nix-collect-garbage --delete-old --dry-run` + +- Delete all store paths older than 30 days: + +`sudo nix-collect-garbage --delete-older-than 30d` diff --git a/nix-env b/nix-env new file mode 100644 index 00000000..512cb8a4 --- /dev/null +++ b/nix-env @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix-env + +> Manipulate or query Nix user environments. +> More information: . + +- List all installed packages: + +`nix-env -q` + +- Query installed packages: + +`nix-env -q {{search_term}}` + +- Query available packages: + +`nix-env -qa {{search_term}}` + +- Install package: + +`nix-env -iA nixpkgs.{{pkg_name}}` + +- Install a package from a URL: + +`nix-env -i {{pkg_name}} --file {{example.com}}` + +- Uninstall package: + +`nix-env -e {{pkg_name}}` + +- Upgrade one package: + +`nix-env -u {{pkg_name}}` + +- Upgrade all packages: + +`nix-env -u` diff --git a/nix-shell b/nix-shell new file mode 100644 index 00000000..b6ee9ab2 --- /dev/null +++ b/nix-shell @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix-shell + +> Start an interactive shell based on a Nix expression. +> See also: `tldr nix3 shell`. +> More information: . + +- Start with nix expression in `shell.nix` or `default.nix` in the current directory: + +`nix-shell` + +- Run shell command in non-interactive shell and exit: + +`nix-shell --run "{{command}} {{argument1 argument2 ...}}"` + +- Start with expression in `default.nix` in the current directory: + +`nix-shell {{default.nix}}` + +- Start with packages loaded from nixpkgs: + +`nix-shell --packages {{package1 package2 ...}}` + +- Start with packages loaded from specific nixpkgs revision: + +`nix-shell --packages {{package1 package2 ...}} -I nixpkgs={{https://github.com/NixOS/nixpkgs/archive/nixpkgs_revision.tar.gz}}` + +- Evaluate rest of file in specific interpreter, for use in `#!-scripts` (see ): + +`nix-shell -i {{interpreter}} --packages {{package1 package2 ...}}` diff --git a/nix-store b/nix-store new file mode 100644 index 00000000..cf9f494b --- /dev/null +++ b/nix-store @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix-store + +> Manipulate or query the Nix store. +> See also: `tldr nix3 store`. +> More information: . + +- Collect garbage, such as removing unused paths: + +`nix-store --gc` + +- Hard-link identical files together to reduce space usage: + +`nix-store --optimise` + +- Delete a specific store path (must be unused): + +`nix-store --delete {{/nix/store/...}}` + +- Show all dependencies of a store path (package), in a tree format: + +`nix-store --query --tree {{/nix/store/...}}` + +- Calculate the total size of a certain store path with all the dependencies: + +`du -cLsh $(nix-store --query --references {{/nix/store/...}})` + +- Show all dependents of a particular store path: + +`nix-store --query --referrers {{/nix/store/...}}` diff --git a/nix3-build b/nix3-build new file mode 100644 index 00000000..e43cea7e --- /dev/null +++ b/nix3-build @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix build + +> Build a Nix expression (downloading from the cache when possible). +> See also: `tldr nix-build`. See `tldr nix3 flake` for information about flakes. +> More information: . + +- Build a package from nixpkgs, symlinking the result to `./result`: + +`nix build {{nixpkgs#pkg}}` + +- Build a package from a flake in the current directory, showing the build logs in the process: + +`nix build -L {{.#pkg}}` + +- Build the default package from a flake in some directory: + +`nix build {{./path/to/directory}}` + +- Build a package without making the `result` symlink, instead printing the store path to the `stdout`: + +`nix build --no-link --print-out-paths` diff --git a/nix3-develop b/nix3-develop new file mode 100644 index 00000000..7c4959c4 --- /dev/null +++ b/nix3-develop @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix develop + +> Run a bash shell that provides the build environment of a derivation. +> More information: . + +- Start a shell with all dependencies of a package from nixpkgs available: + +`nix develop {{nixpkgs#pkg}}` + +- Start a development shell for the default package in a flake in the current directory: + +`nix develop` + +- In that shell, configure and build the sources: + +`configurePhase; buildPhase` diff --git a/nix3-edit b/nix3-edit new file mode 100644 index 00000000..e3b11570 --- /dev/null +++ b/nix3-edit @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix edit + +> Open the Nix expression of a Nix package in $EDITOR. +> More information: . + +- Open the source of the Nix expression of a package from nixpkgs in your `$EDITOR`: + +`nix edit {{nixpkgs#pkg}}` + +- Dump the source of a package to `stdout`: + +`EDITOR=cat nix edit {{nixpkgs#pkg}}` diff --git a/nix3-flake b/nix3-flake new file mode 100644 index 00000000..b69e6624 --- /dev/null +++ b/nix3-flake @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix flake + +> Manage Nix flakes. +> More information: . + +- Create a new flake (just the `flake.nix` file) from the default template, in the current directory: + +`nix flake init` + +- Update all inputs (dependencies) of the flake in the current directory: + +`nix flake update` + +- Update a specific input (dependency) of the flake in the current directory: + +`nix flake lock --update-input {{input}}` + +- Show all the outputs of a flake on github: + +`nix flake show {{github:owner/repo}}` + +- Display help: + +`nix flake --help` diff --git a/nix3-profile b/nix3-profile new file mode 100644 index 00000000..a4d75c6b --- /dev/null +++ b/nix3-profile @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix profile + +> Install, update and remove packages from Nix profiles. +> More information: . + +- Install some packages from nixpkgs into the default profile: + +`nix profile install {{nixpkgs#pkg1 nixpkgs#pkg2 ...}}` + +- Install a package from a flake on GitHub into a custom profile: + +`nix profile install {{github:owner/repo/pkg}} --profile {{./path/to/directory}}` + +- List packages currently installed in the default profile: + +`nix profile list` + +- Remove a package installed from nixpkgs from the default profile, by name: + +`nix profile remove {{legacyPackages.x86_64-linux.pkg}}` + +- Upgrade packages in the default to the latest available versions: + +`nix profile upgrade` + +- Rollback (cancel) the latest action on the default profile: + +`nix profile rollback` diff --git a/nix3-registry b/nix3-registry new file mode 100644 index 00000000..7c199c7c --- /dev/null +++ b/nix3-registry @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix registry + +> Manage a Nix flake registry. +> See `tldr nix3 flake` for information about flakes. +> More information: . + +- Pin the `nixpkgs` revision to the current version of the upstream repository: + +`nix registry pin {{nixpkgs}}` + +- Pin an entry to the latest version of the branch, or a particular reivision of a github repository: + +`nix registry pin {{entry}} {{github:owner/repo/branch_or_revision}}` + +- Add a new entry that always points to the latest version of a github repository, updating automatically: + +`nix registry add {{entry}} {{github:owner/repo}}` + +- Remove a registry entry: + +`nix registry remove {{entry}}` + +- See documentation about what Nix flake registries are: + +`nix registry --help` diff --git a/nix3-repl b/nix3-repl new file mode 100644 index 00000000..7a2222c4 --- /dev/null +++ b/nix3-repl @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix repl + +> Start an interactive environment for evaluating Nix expressions. +> See for a description of the Nix expression language. +> More information: . + +- Start an interactive environment for evaluating Nix expressions: + +`nix repl` + +- Load all packages from a flake (e.g. `nixpkgs`) into scope: + +`:lf {{nixpkgs}}` + +- Build a package from an expression: + +`:b {{expression}}` + +- Start a shell with package from the expression available: + +`:u {{expression}}` + +- Start a shell with dependencies of the package from the expression available: + +`:s {{expression}}` diff --git a/nix3-run b/nix3-run new file mode 100644 index 00000000..e7e6512a --- /dev/null +++ b/nix3-run @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix run + +> Run an application from a Nix flake. +> See `tldr nix3 flake` for information about flakes. +> More information: . + +- Run the default application in the flake in the current directory: + +`nix run` + +- Run a command whose name matches the package name from nixpkgs (if you want a different command from that package, see `tldr nix3 shell`): + +`nix run nixpkgs#{{pkg}}` + +- Run a command with provided arguments: + +`nix run nixpkgs#{{vim}} -- {{path/to/file}}` + +- Run from a remote repository: + +`nix run {{remote_name}}:{{owner}}/{{repo}}` + +- Run from a remote repository using a specific tag, revision or branch: + +`nix run {{remote_name}}:{{owner}}/{{repo}}/{{reference}}` + +- Run from a remote repository specifying a subdirectory and a program: + +`nix run "{{remote_name}}:{{owner}}/{{repo}}?dir={{dir_name}}#{{app}}"` + +- Run the flake of a GitHub pull request: + +`nix run github:{{owner}}/{{repo}}/pull/{{number}}/head` diff --git a/nix3-search b/nix3-search new file mode 100644 index 00000000..bc7e4034 --- /dev/null +++ b/nix3-search @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix search + +> Search for packages in a Nix flake. +> See `tldr nix3 flake` for information about flakes. +> More information: . + +- Search `nixpkgs` for a package based on its name or description: + +`nix search {{nixpkgs}} {{search_term...}}` + +- Show description of a package from nixpkgs: + +`nix search {{nixpkgs#pkg}}` + +- Show all packages available from a flake on github: + +`nix search {{github:owner/repo}}` diff --git a/nix3-shell b/nix3-shell new file mode 100644 index 00000000..6552b633 --- /dev/null +++ b/nix3-shell @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix shell + +> Start a shell in which the specified packages are available. +> See also: `tldr nix-shell`. See `tldr nix3 flake` for information about flakes. +> More information: . + +- Start an interactive shell with some packages from `nixpkgs`: + +`nix shell {{nixpkgs#pkg1 nixpkgs#packageSet.pkg2 ...}}` + +- Start a shell providing a package from an older version of `nixpkgs` (21.05): + +`nix shell {{nixpkgs/nixos-21.05#pkg}}` + +- Start a shell with the "default package" from a flake in the current directory, printing build logs if any builds happen: + +`nix shell -L` + +- Start a shell with a package from a flake on GitHub: + +`nix shell {{github:owner/repo#pkg}}` + +- Run a command in a shell with a package: + +`nix shell {{nixpkgs#pkg}} -c {{some-cmd --someflag 'Some other arguments'}}` diff --git a/nix3-store b/nix3-store new file mode 100644 index 00000000..ba3b23ac --- /dev/null +++ b/nix3-store @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix store + +> Manipulate the Nix store. +> See also: `tldr nix-store`. +> More information: . + +- Collect garbage, i.e. remove unused paths to reduce space usage: + +`nix store gc` + +- Hard-link identical files together to reduce space usage: + +`nix store optimise` + +- Delete a specific store path (most be unused): + +`nix store delete {{/nix/store/...}}` + +- List a contents of the store path, on a remote store: + +`nix store --store {{https://cache.nixos.org}} ls {{/nix/store/...}}` + +- Show the differences in versions between two store paths, with their respective dependencies: + +`nix store diff-closures {{/nix/store/...}} {{/nix/store/...}}` diff --git a/nix3-why-depends b/nix3-why-depends new file mode 100644 index 00000000..70555684 --- /dev/null +++ b/nix3-why-depends @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix why-depends + +> Show why a package depends on another package. +> More information: . + +- Show why the currently running NixOS system requires a certain store path: + +`nix why-depends {{/run/current-system}} {{/nix/store/...}}` + +- Show why a package from nixpkgs requires another package as a _build-time_ dependency: + +`nix why-depends --derivation {{nixpkgs#dependent}} {{nixpkgs#dependency}}` diff --git a/nixpkgs-review b/nixpkgs-review new file mode 100644 index 00000000..e50f9f38 --- /dev/null +++ b/nixpkgs-review @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nixpkgs-review + +> Review pull requests in the NixOS packages repository (nixpkgs). +> After a successful build, a `nix-shell` with all built packages is started. +> More information: . + +- Build changed packages in the specified pull request: + +`nixpkgs-review pr {{pr_number|pr_url}}` + +- Build changed packages and post a comment with a report (requires setting up a token in `hub`, `gh`, or the `GITHUB_TOKEN` environment variable): + +`nixpkgs-review pr --post-result {{pr_number|pr_url}}` + +- Build changed packages and print a report: + +`nixpkgs-review pr --print-result {{pr_number|pr_url}}` + +- Build changed packages in a local commit: + +`nixpkgs-review rev {{HEAD}}` + +- Build changed packages that haven't been committed yet: + +`nixpkgs-review wip` + +- Build changed packages that have been staged: + +`nixpkgs-review wip --staged` diff --git a/nkf b/nkf new file mode 100644 index 00000000..d6ed3d32 --- /dev/null +++ b/nkf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nkf + +> Network kanji filter. +> Converts kanji code from one encoding to another. +> More information: . + +- Convert to UTF-8 encoding: + +`nkf -w {{path/to/file.txt}}` + +- Convert to SHIFT_JIS encoding: + +`nkf -s {{path/to/file.txt}}` + +- Convert to UTF-8 encoding and overwrite the file: + +`nkf -w --overwrite {{path/to/file.txt}}` + +- Use LF as the new line code and overwrite (UNIX type): + +`nkf -d --overwrite {{path/to/file.txt}}` + +- Use CRLF as the new line code and overwrite (windows type): + +`nkf -c --overwrite {{path/to/file.txt}}` + +- Decrypt mime file and overwrite: + +`nkf -m --overwrite {{path/to/file.txt}}` diff --git a/nl b/nl new file mode 100644 index 00000000..df7a0dba --- /dev/null +++ b/nl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nl + +> Number lines from a file or from `stdin`. +> More information: . + +- Number non-blank lines in a file: + +`nl {{path/to/file}}` + +- Read from `stdin`: + +`{{command}} | nl -` + +- Number [a]ll [b]ody lines including blank lines or do [n]ot number body lines: + +`nl -b {{a|n}} {{path/to/file}}` + +- Number only the [b]ody lines that match a basic regular expression (BRE) [p]attern: + +`nl -b p'FooBar[0-9]' {{path/to/file}}` + +- Use a specific [i]ncrement for line numbering: + +`nl -i {{increment}} {{path/to/file}}` + +- Specify the line numbering format to [r]ight or [l]eft justified, keeping leading [z]eros or [n]ot: + +`nl -n {{rz|ln|rn}}` + +- Specify the line numbering's [w]idth (6 by default): + +`nl -w {{col_width}} {{path/to/file}}` + +- Use a specific string to [s]eparate the line numbers from the lines (TAB by default): + +`nl -s {{separator}} {{path/to/file}}` diff --git a/nload b/nload new file mode 100644 index 00000000..aaae10f8 --- /dev/null +++ b/nload @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nload + +> Visualize network usage in the terminal. +> More information: . + +- View all network traffic (use the arrow keys to switch interfaces): + +`nload` + +- View network traffic on specific interfaces (use the arrow keys to switch interfaces): + +`nload device {{interface_one}} {{interface_two}}` diff --git a/nm b/nm new file mode 100644 index 00000000..35d850c6 --- /dev/null +++ b/nm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nm + +> List symbol names in object files. +> More information: . + +- List global (extern) functions in a file (prefixed with T): + +`nm -g {{path/to/file.o}}` + +- List only undefined symbols in a file: + +`nm -u {{path/to/file.o}}` + +- List all symbols, even debugging symbols: + +`nm -a {{path/to/file.o}}` + +- Demangle C++ symbols (make them readable): + +`nm --demangle {{path/to/file.o}}` diff --git a/nm-classic b/nm-classic new file mode 100644 index 00000000..69892919 --- /dev/null +++ b/nm-classic @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nm-classic + +> This command is an alias of `nm`. + +- View documentation for the original command: + +`tldr nm` diff --git a/nmap b/nmap new file mode 100644 index 00000000..df531c75 --- /dev/null +++ b/nmap @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nmap + +> Network exploration tool and security/port scanner. +> Some features only activate when Nmap is run with root privileges. +> More information: . + +- Check if an IP address is up, and guess the remote host's operating system: + +`nmap -O {{ip_or_hostname}}` + +- Try to determine whether the specified hosts are up (ping scan) and what their names and MAC addresses are: + +`sudo nmap -sn {{ip_or_hostname}} {{optional_another_address}}` + +- Also enable scripts, service detection, OS fingerprinting and traceroute: + +`nmap -A {{address_or_addresses}}` + +- Scan a specific list of ports (use '-p-' for all ports from 1 to 65535): + +`nmap -p {{port1,port2,...,portN}} {{address_or_addresses}}` + +- Perform service and version detection of the top 1000 ports using default NSE scripts; writing results ('-oN') to output file: + +`nmap -sC -sV -oN {{top-1000-ports.txt}} {{address_or_addresses}}` + +- Scan target(s) carefully using 'default and safe' NSE scripts: + +`nmap --script "default and safe" {{address_or_addresses}}` + +- Scan web server running on standard ports 80 and 443 using all available 'http-*' NSE scripts: + +`nmap --script "http-*" {{address_or_addresses}} -p 80,443` + +- Perform a stealthy very slow scan ('-T0') trying to avoid detection by IDS/IPS and use decoy ('-D') source IP addresses: + +`nmap -T0 -D {{decoy1_ipaddress,decoy2_ipaddress,...,decoyN_ipaddress}} {{address_or_addresses}}` diff --git a/nmblookup b/nmblookup new file mode 100644 index 00000000..8becf995 --- /dev/null +++ b/nmblookup @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nmblookup + +> Discover SMB shares. +> More information: . + +- Find hosts in the local network with SMB shares: + +`nmblookup -S '*'` + +- Find hosts in the local network with SMB shares run by SAMBA: + +`nmblookup --status __SAMBA__` diff --git a/nms b/nms new file mode 100644 index 00000000..976382f4 --- /dev/null +++ b/nms @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nms + +> Command-line tool that recreates the famous data decryption effect seen in the 1992 movie Sneakers from `stdin`. +> More information: . + +- Decrypt text after a keystroke: + +`echo "{{Hello, World!}}" | nms` + +- Decrypt output immediately, without waiting for a keystroke: + +`{{ls -la}} | nms -a` + +- Decrypt the content of a file, with a custom output color: + +`cat {{path/to/file}} | nms -a -f {{blue|white|yellow|black|magenta|green|red}}` + +- Clear the screen before decrypting: + +`{{command}} | nms -a -c` diff --git a/node b/node new file mode 100644 index 00000000..eed9d32d --- /dev/null +++ b/node @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# node + +> Server-side JavaScript platform (Node.js). +> More information: . + +- Run a JavaScript file: + +`node {{path/to/file}}` + +- Start a REPL (interactive shell): + +`node` + +- Execute the specified file restarting the process when an imported file is changed (requires Node.js version 18.11+): + +`node --watch {{path/to/file}}` + +- Evaluate JavaScript code by passing it as an argument: + +`node -e "{{code}}"` + +- Evaluate and print the result, useful to print node's dependencies versions: + +`node -p "process.versions"` + +- Activate inspector, pausing execution until a debugger is connected once source code is fully parsed: + +`node --no-lazy --inspect-brk {{path/to/file}}` diff --git a/nodemon b/nodemon new file mode 100644 index 00000000..80e6e51a --- /dev/null +++ b/nodemon @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nodemon + +> Watch files and automatically restart a node application when changes are detected. +> More information: . + +- Execute the specified file and watch a specific file for changes: + +`nodemon {{path/to/file.js}}` + +- Manually restart nodemon (note nodemon must already be active for this to work): + +`rs` + +- Ignore specific files: + +`nodemon --ignore {{path/to/file_or_directory}}` + +- Pass arguments to the node application: + +`nodemon {{path/to/file.js}} {{arguments}}` + +- Pass arguments to node itself if they're not nodemon arguments already (e.g. `--inspect`): + +`nodemon {{arguments}} {{path/to/file.js}}` + +- Run an arbitrary non-node script: + +`nodemon --exec "{{command_to_run_script}} {{options}}" {{path/to/script}}` + +- Run a Python script: + +`nodemon --exec "python {{options}}" {{path/to/file.py}}` diff --git a/nodenv b/nodenv new file mode 100644 index 00000000..39350e78 --- /dev/null +++ b/nodenv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nodenv + +> Manage Node.js versions. +> More information: . + +- Install a specific version of Node.js: + +`nodenv install {{version}}` + +- Display a list of available versions: + +`nodenv install --list` + +- Use a specific version of Node.js across the whole system: + +`nodenv global {{version}}` + +- Use a specific version of Node.js with a directory: + +`nodenv local {{version}}` + +- Display the Node.js version for the current directory: + +`nodenv version` + +- Display the location of a Node.js installed command (e.g. `npm`): + +`nodenv which {{command}}` diff --git a/nohup b/nohup new file mode 100644 index 00000000..048abd11 --- /dev/null +++ b/nohup @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nohup + +> Allows for a process to live when the terminal gets killed. +> More information: . + +- Run a process that can live beyond the terminal: + +`nohup {{command}} {{argument1 argument2 ...}}` + +- Launch `nohup` in background mode: + +`nohup {{command}} {{argument1 argument2 ...}} &` + +- Run a shell script that can live beyond the terminal: + +`nohup {{path/to/script.sh}} &` + +- Run a process and write the output to a specific file: + +`nohup {{command}} {{argument1 argument2 ...}} > {{path/to/output_file}} &` diff --git a/nokogiri b/nokogiri new file mode 100644 index 00000000..87d80f3b --- /dev/null +++ b/nokogiri @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nokogiri + +> An HTML, XML, SAX and Reader parser. +> More information: . + +- Parse the contents of a URL or file: + +`nokogiri {{url|path/to/file}}` + +- Parse as a specific type: + +`nokogiri {{url|path/to/file}} --type {{xml|html}}` + +- Load a specific initialization file before parsing: + +`nokogiri {{url|path/to/file}} -C {{path/to/config_file}}` + +- Parse using a specific encoding: + +`nokogiri {{url|path/to/file}} --encoding {{encoding}}` + +- Validate using a RELAX NG file: + +`nokogiri {{url|path/to/file}} --rng {{url|path/to/file}}` diff --git a/nomad b/nomad new file mode 100644 index 00000000..995d8132 --- /dev/null +++ b/nomad @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nomad + +> Distributed, highly available, datacenter-aware scheduler. +> More information: . + +- Show the status of nodes in the cluster: + +`nomad node status` + +- Validate a job file: + +`nomad job validate {{path/to/file.nomad}}` + +- Plan a job for execution on the cluster: + +`nomad job plan {{path/to/file.nomad}}` + +- Run a job on the cluster: + +`nomad job run {{path/to/file.nomad}}` + +- Show the status of jobs currently running on the cluster: + +`nomad job status` + +- Show the detailed status information about a specific job: + +`nomad job status {{job_name}}` + +- Follow the logs of a specific allocation: + +`nomad alloc logs {{alloc_id}}` + +- Show the status of storage volumes: + +`nomad volume status` diff --git a/nop b/nop new file mode 100644 index 00000000..2e36b545 --- /dev/null +++ b/nop @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nop + +> Check validity and pretty-print graphs in canonical format. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Pretty-print one or more graphs in canonical format: + +`nop {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Check one or more graphs for validity, producing no output graph: + +`nop -p {{path/to/input1.gv}} {{path/to/input2.gv ...}}` + +- Display help: + +`nop -?` diff --git a/noti b/noti new file mode 100644 index 00000000..3c405bd2 --- /dev/null +++ b/noti @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# noti + +> Monitor a process and trigger a banner notification. +> More information: . + +- Display a notification when `tar` finishes compressing files: + +`noti {{tar -cjf example.tar.bz2 example/}}` + +- Display a notification even when you put it after the command to watch: + +`{{command_to_watch}}; noti` + +- Monitor a process by PID and trigger a notification when the PID disappears: + +`noti -w {{process_id}}` diff --git a/notmuch b/notmuch new file mode 100644 index 00000000..e20827b5 --- /dev/null +++ b/notmuch @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# notmuch + +> Command-line based program for indexing, searching, reading, and tagging large collections of email messages. +> More information: . + +- Configure for first use: + +`notmuch setup` + +- Add a tag for all messages matching a search term: + +`notmuch tag +{{custom_tag}} "{{search_term}}"` + +- Remove a tag for all messages matching a search term: + +`notmuch tag -{{custom_tag}} "{{search_term}}"` + +- Count messages matching the given search term: + +`notmuch count --output={{messages|threads}} "{{search_term}}"` + +- Search for messages matching the given search term: + +`notmuch search --format={{json|text}} --output={{summary|threads|messages|files|tags}} "{{search_term}}"` + +- Limit the number of search results to X: + +`notmuch search --format={{json|text}} --output={{summary|threads|messages|files|tags}} --limit={{X}} "{{search_term}}"` + +- Create a reply template for a set of messages: + +`notmuch reply --format={{default|headers-only}} --reply-to={{sender|all}} "{{search_term}}"` diff --git a/now b/now new file mode 100644 index 00000000..f22ceec6 --- /dev/null +++ b/now @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# now + +> Cloud platform for serverless deployment. +> This command is deprecated. See `vercel`, the updated version of this tool. +> More information: . + +- Deploy the current directory: + +`now` + +- Display a list of deployments: + +`now list` + +- Display information related to a deployment: + +`now inspect {{deployment_url}}` + +- Remove a deployment: + +`now remove {{deployment_id}}` + +- Log in into an account or create a new one: + +`now login` + +- Initialize an example project (a new directory will be created): + +`now init` diff --git a/nping b/nping new file mode 100644 index 00000000..d0e183e6 --- /dev/null +++ b/nping @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nping + +> Network packet generation tool/ping utility. +> More information: . + +- Ping a specified host using ICMP if the user is allowed to, otherwise using TCP: + +`nping {{example.com}}` + +- Ping a specified host using ICMP assuming that the user is allowed to do so: + +`nping --icmp --privileged {{example.com}}` + +- Ping a specified host using UDP: + +`nping --udp {{example.com}}` + +- Ping a specified host on a given port using TCP: + +`nping --tcp --dest-port {{443}} {{example.com}}` + +- Ping a certain number of times: + +`nping --count {{10}} {{example.com}}` + +- Wait a certain amount of time between each ping: + +`nping --delay {{5s}} {{example.com}}` + +- Send the request over a specified interface: + +`nping --interface {{eth0}} {{example.com}}` + +- Set the Reserved/Evil bit in sent packets: + +`nping --evil {{example.com}}` diff --git a/npm b/npm new file mode 100644 index 00000000..9233e26f --- /dev/null +++ b/npm @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm + +> JavaScript and Node.js package manager. +> Manage Node.js projects and their module dependencies. +> More information: . + +- Interactively create a `package.json` file: + +`npm init` + +- Download all the packages listed as dependencies in `package.json`: + +`npm install` + +- Download a specific version of a package and add it to the list of dependencies in `package.json`: + +`npm install {{package_name}}@{{version}}` + +- Download the latest version of a package and add it to the list of dev dependencies in `package.json`: + +`npm install {{package_name}} --save-dev` + +- Download the latest version of a package and install it globally: + +`npm install --global {{package_name}}` + +- Uninstall a package and remove it from the list of dependencies in `package.json`: + +`npm uninstall {{package_name}}` + +- List of locally installed dependencies: + +`npm list` + +- List top-level globally installed packages: + +`npm list --global --depth={{0}}` diff --git a/npm-check b/npm-check new file mode 100644 index 00000000..5f85de6d --- /dev/null +++ b/npm-check @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm-check + +> Check for outdated, incorrect, and unused npm package dependencies. +> More information: . + +- Display a report of outdated, incorrect, and unused dependencies: + +`npm-check` + +- Interactively update out-of-date packages: + +`npm-check --update` + +- Update everything without prompting: + +`npm-check --update-all` + +- Don't check for unused packages: + +`npm-check --skip-unused` diff --git a/npm-fund b/npm-fund new file mode 100644 index 00000000..1a5cc5df --- /dev/null +++ b/npm-fund @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm fund + +> Retrieve funding information from packages. +> More information: . + +- List dependencies with funding URL for the project in the current directory: + +`npm fund` + +- Open the funding URL for a specific package in the default web browser: + +`npm fund {{package}}` + +- List dependencies with a funding URL for a specific [w]orkspace for the project in the current directory: + +`npm fund -w {{workspace}}` diff --git a/npm-home b/npm-home new file mode 100644 index 00000000..bf177fea --- /dev/null +++ b/npm-home @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm-home + +> Open the npm page, Yarn page, or GitHub repository of a package in the web browser. +> More information: . + +- Open the npm page of a specific package in the web browser: + +`npm-home {{package}}` + +- Open the GitHub repository of a specific package in the web browser: + +`npm-home -g {{package}}` + +- Open the Yarn page of a specific package in the web browser: + +`npm-home -y {{package}}` diff --git a/npm-name b/npm-name new file mode 100644 index 00000000..56a84ebd --- /dev/null +++ b/npm-name @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm-name + +> Check whether a package or organization name is available on npm. +> More information: . + +- Check if a specific package name is available in the npm registry: + +`npm-name {{package}}` + +- Find similar package names in the npm registry: + +`npm-name --similar {{package}}` diff --git a/npm-query b/npm-query new file mode 100644 index 00000000..cbb834d1 --- /dev/null +++ b/npm-query @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm query + +> Print an array of dependency objects using CSS-like selectors. +> More information: . + +- Print direct dependencies: + +`npm query ':root > *'` + +- Print all direct production/development dependencies: + +`npm query ':root > .{{prod|dev}}'` + +- Print dependencies with a specific name: + +`npm query '#{{package}}'` + +- Print dependencies with a specific name and within a semantic versioning range: + +`npm query #{{package}}@{{semantic_version}}` + +- Print dependencies which have no dependencies: + +`npm query ':empty'` + +- Find all dependencies with postinstall scripts and uninstall them: + +`npm query ":attr(scripts, [postinstall])" | jq 'map(.name) | join(" +")' -r | xargs -I {} npm uninstall {}` + +- Find all Git dependencies and print which application requires them: + +`npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}` diff --git a/npm-why b/npm-why new file mode 100644 index 00000000..60c6ac50 --- /dev/null +++ b/npm-why @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npm-why + +> Identifies why an npm package is installed. +> More information: . + +- Show why an npm package is installed: + +`npm-why {{package}}` diff --git a/nproc b/nproc new file mode 100644 index 00000000..76a951d7 --- /dev/null +++ b/nproc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nproc + +> Print the number of processing units (normally CPUs) available. +> More information: . + +- Display the number of available processing units: + +`nproc` + +- Display the number of installed processing units, including any inactive ones: + +`nproc --all` + +- If possible, subtract a given number of units from the returned value: + +`nproc --ignore {{count}}` diff --git a/npx b/npx new file mode 100644 index 00000000..e95ccc20 --- /dev/null +++ b/npx @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# npx + +> Execute binaries from `npm` packages. +> More information: . + +- Execute the command from a local or remote `npm` package: + +`npx {{command}} {{argument1 argument2 ...}}` + +- In case multiple commands with the same name exist, it is possible to explicitly specify the package: + +`npx --package {{package}} {{command}}` + +- Run a command if it exists in the current path or in `node_modules/.bin`: + +`npx --no-install {{command}} {{argument1 argument2 ...}}` + +- Execute a specific command suppressing any output from `npx` itself: + +`npx --quiet {{command}} {{argument1 argument2 ...}}` + +- Display help: + +`npx --help` diff --git a/nrm b/nrm new file mode 100644 index 00000000..f5abec50 --- /dev/null +++ b/nrm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nrm + +> npm registry manager. +> Helps to easily switch between different npm registries. +> More information: . + +- List all registries: + +`nrm ls` + +- Change to a particular registry: + +`nrm use {{registry}}` + +- Show the response time for all registries: + +`nrm test` + +- Add a custom registry: + +`nrm add {{registry}} {{url}}` + +- Delete a registry: + +`nrm del {{registry}}` diff --git a/nslookup b/nslookup new file mode 100644 index 00000000..769ebf97 --- /dev/null +++ b/nslookup @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nslookup + +> Query name servers for various domain records. +> More information: . + +- Query your system's default name server for an IP address (A record) of the domain: + +`nslookup {{example.com}}` + +- Query a given name server for a NS record of the domain: + +`nslookup -type=NS {{example.com}} {{8.8.8.8}}` + +- Query for a reverse lookup (PTR record) of an IP address: + +`nslookup -type=PTR {{54.240.162.118}}` + +- Query for ANY available records using TCP protocol: + +`nslookup -vc -type=ANY {{example.com}}` + +- Query a given name server for the whole zone file (zone transfer) of the domain using TCP protocol: + +`nslookup -vc -type=AXFR {{example.com}} {{name_server}}` + +- Query for a mail server (MX record) of the domain, showing details of the transaction: + +`nslookup -type=MX -debug {{example.com}}` + +- Query a given name server on a specific port number for a TXT record of the domain: + +`nslookup -port={{port_number}} -type=TXT {{example.com}} {{name_server}}` diff --git a/nth b/nth new file mode 100644 index 00000000..7154de51 --- /dev/null +++ b/nth @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nth + +> Name That Hash - Instantly name the type of any hash. +> More information: . + +- Name a hash: + +`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}}` + +- Name hashes in a file: + +`nth -f {{path/to/hashes}}` + +- Print in JSON format: + +`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}} -g` + +- Decode hash in Base64 before naming it: + +`nth -t {{NWY0ZGNjM2I1YWE3NjVkNjFkODMyN2RlYjg4MmNmOTkK}} -b64` diff --git a/ntl b/ntl new file mode 100644 index 00000000..5901d4ad --- /dev/null +++ b/ntl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ntl + +> This command is an alias of `netlify`. +> More information: . + +- View documentation for the original command: + +`tldr netlify` diff --git a/nu b/nu new file mode 100644 index 00000000..ad902fd6 --- /dev/null +++ b/nu @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nu + +> Nushell ("a new type of shell") takes a modern, structured approach to your command-line. +> See also: `elvish`. +> More information: . + +- Start an interactive shell session: + +`nu` + +- Execute specific commands: + +`nu --commands "{{echo 'nu is executed'}}"` + +- Execute a specific script: + +`nu {{path/to/script.nu}}` + +- Execute a specific script with logging: + +`nu --log-level {{error|warn|info|debug|trace}} {{path/to/script.nu}}` diff --git a/nuclei b/nuclei new file mode 100644 index 00000000..6d7095f5 --- /dev/null +++ b/nuclei @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nuclei + +> Fast and customizable vulnerability scanner based on a simple YAML based DSL. +> More information: . + +- [u]pdate `nuclei` [t]emplates to the latest released version: + +`nuclei -ut` + +- [l]ist all [t]emplates with a specific [p]rotocol [t]ype: + +`nuclei -tl -pt {{dns|file|http|headless|tcp|workflow|ssl|websocket|whois|code|javascript}}` + +- Run an [a]utomatic web [s]can using wappalyzer technology detection specifying a target [u]RL/host to scan: + +`nuclei -as -u {{scanme.nmap.org}}` + +- Run HTTP [p]rotocol [t]ype templates of high and critical severity, [e]xporting results to [m]arkdown files inside a specific directory: + +`nuclei -severity high,critical -pt http -u {{http://scanme.sh}} -me {{markdown_directory}}` + +- Run all templates using a different [r]ate [l]imit and maximum [b]ulk [s]ize with silent output (only showing the findings): + +`nuclei -rl {{150}} -bs {{25}} -c {{25}} -silent -u {{http://scanme.sh}}` + +- Run the WordPress [w]orkflow against a WordPress site: + +`nuclei -w {{path/to/nuclei-templates/workflows/wordpress-workflow.yaml}} -u {{https://sample.wordpress.site}}` + +- Run one or more specific [t]emplates or directory with [t]emplates with [v]erbose output in `stderr` and [o]utput detected issues/vulnerabilities to a file: + +`nuclei -t {{path/to/nuclei-templates/http}} -u {{http://scanme.sh}} -v -o {{results}}` + +- Run scan based on one or more [t]emplate [c]onditions: + +`nuclei -tc {{"contains(tags, 'xss') && contains(tags, 'cve')"}} -u {{https://vulnerable.website}}` diff --git a/nudoku b/nudoku new file mode 100644 index 00000000..0513d29a --- /dev/null +++ b/nudoku @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nudoku + +> Sudoku game in terminal. +> More information: . + +- Start a sudoku game: + +`nudoku` + +- Choose the difficulty of the game: + +`nudoku -d {{easy|normal|hard}}` + +- Navigate the board: + +`{{h|j|k|l}} OR {{Left|Down|Up|Right arrow key}}` + +- Delete a number: + +`{{Backspace|x}}` + +- Get a hint: + +`H` + +- See the complete solution: + +`S` + +- Create a new puzzle: + +`N` + +- Quit the game: + +`Q` diff --git a/numfmt b/numfmt new file mode 100644 index 00000000..52707248 --- /dev/null +++ b/numfmt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# numfmt + +> Convert numbers to and from human-readable strings. +> More information: . + +- Convert 1.5K (SI Units) to 1500: + +`numfmt --from={{si}} {{1.5K}}` + +- Convert 5th field (1-indexed) to IEC Units without converting header: + +`ls -l | numfmt --header={{1}} --field={{5}} --to={{iec}}` + +- Convert to IEC units, pad with 5 characters, left aligned: + +`du -s * | numfmt --to={{iec}} --format="{{%-5f}}"` diff --git a/nvcc b/nvcc new file mode 100644 index 00000000..625a49c8 --- /dev/null +++ b/nvcc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvcc + +> The NVIDIA CUDA Compiler Driver. +> More information: . + +- Compile a CUDA program: + +`nvcc {{path/to/source.cu}} -o {{path/to/executable}}` + +- Generate debu[g] information: + +`nvcc {{path/to/source.cu}} -o {{path/to/executable}} --debug --device-debug` + +- Include libraries from a different path: + +`nvcc {{path/to/source.cu}} -o {{path/to/executable}} -I{{path/to/includes}} -L{{path/to/library}} -l{{library_name}}` + +- Specify the compute capability for a specific GPU architecture: + +`nvcc {{path/to/source.cu}} -o {{path/to/executable}} --generate-code arch={{arch_name}},code={{gpu_code_name}}` diff --git a/nvidia-smi b/nvidia-smi new file mode 100644 index 00000000..f6c39917 --- /dev/null +++ b/nvidia-smi @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvidia-smi + +> Aid the management and monitoring of NVIDIA GPU devices. +> More information: . + +- Display information on all available GPUs and processes using them: + +`nvidia-smi` + +- Display more detailed GPU information: + +`nvidia-smi --query` + +- Monitor overall GPU usage with 1-second update interval: + +`nvidia-smi dmon` diff --git a/nvim b/nvim new file mode 100644 index 00000000..939ab625 --- /dev/null +++ b/nvim @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvim + +> Neovim, a programmer's text editor based on Vim, provides several modes for different kinds of text manipulation. +> Pressing `i` in normal mode enters insert mode. `` goes back to normal mode, which doesn't allow regular text insertion. +> See also: `vim`, `vimtutor`, `vimdiff`. +> More information: . + +- Open a file: + +`nvim {{path/to/file}}` + +- Enter text editing mode (insert mode): + +`i` + +- Copy ("yank") or cut ("delete") the current line (paste it with `P`): + +`{{yy|dd}}` + +- Enter normal mode and undo the last operation: + +`u` + +- Search for a pattern in the file (press `n`/`N` to go to next/previous match): + +`/{{search_pattern}}` + +- Perform a regular expression substitution in the whole file: + +`:%s/{{regular_expression}}/{{replacement}}/g` + +- Enter normal mode and save (write) the file, and quit: + +`:wq` + +- Quit without saving: + +`:q!` diff --git a/nvm b/nvm new file mode 100644 index 00000000..7f9b3be4 --- /dev/null +++ b/nvm @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvm + +> Install, uninstall or switch between Node.js versions. +> Supports version numbers like "12.8" or "v16.13.1", and labels like "stable", "system", etc. +> See also: `asdf`. +> More information: . + +- Install a specific version of Node.js: + +`nvm install {{node_version}}` + +- Use a specific version of Node.js in the current shell: + +`nvm use {{node_version}}` + +- Set the default Node.js version: + +`nvm alias default {{node_version}}` + +- List all available Node.js versions and highlight the default one: + +`nvm list` + +- Uninstall a given Node.js version: + +`nvm uninstall {{node_version}}` + +- Launch the REPL of a specific version of Node.js: + +`nvm run {{node_version}} --version` + +- Execute a script in a specific version of Node.js: + +`nvm exec {{node_version}} node {{app.js}}` diff --git a/nvm.fish b/nvm.fish new file mode 100644 index 00000000..a3d6808d --- /dev/null +++ b/nvm.fish @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvm + +> Install, uninstall, or switch between Node.js versions under the `fish` shell. +> Supports version numbers like "12.8" or "v16.13.1", and labels like "stable", "system", etc. +> More information: . + +- Install a specific version of Node.js: + +`nvm install {{node_version}}` + +- Use a specific version of Node.js in the current shell: + +`nvm use {{node_version}}` + +- Set the default Node.js version: + +`set nvm_default_version {{node_version}}` + +- List all available Node.js versions and highlight the default one: + +`nvm list` + +- Uninstall a given Node.js version: + +`nvm uninstall {{node_version}}` diff --git a/nvme b/nvme new file mode 100644 index 00000000..20cf3ba3 --- /dev/null +++ b/nvme @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nvme + +> NVMe storage user space utility. +> More information: . + +- List all nvme devices: + +`sudo nvme list` + +- Show device information: + +`sudo nvme smart-log {{device}}` diff --git a/nx b/nx new file mode 100644 index 00000000..deba1528 --- /dev/null +++ b/nx @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nx + +> Manage `nx` workspaces. +> More information: . + +- Build a specific project: + +`nx build {{project}}` + +- Test a specific project: + +`nx test {{project}}` + +- Execute a target on a specific project: + +`nx run {{project}}:{{target}}` + +- Execute a target on multiple projects: + +`nx run-many --target {{target}} --projects {{project1}},{{project2}}` + +- Execute a target on all projects in the workspace: + +`nx run-many --target {{target}} --all` + +- Execute a target only on projects that have been changed: + +`nx affected --target {{target}}` diff --git a/nyxt b/nyxt new file mode 100644 index 00000000..8f837ad8 --- /dev/null +++ b/nyxt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nyxt + +> A keyboard-driven web browser for power users. +> More information: . + +- List all profiles: + +`nyxt --list-data-profiles` + +- Set the `init.lisp` file path: + +`nyxt --init {{path/to/file}}` + +- Change the path to the auto-config file: + +`nyxt --auto-config {{path/to/file}}` + +- Print system information: + +`nyxt --system-information` diff --git a/oathtool b/oathtool new file mode 100644 index 00000000..c6d16a0a --- /dev/null +++ b/oathtool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# oathtool + +> OATH one-time password tool. +> More information: . + +- Generate TOTP token (behaves like Google Authenticator): + +`oathtool --totp --base32 "{{secret}}"` + +- Generate a TOTP token for a specific time: + +`oathtool --totp --now "{{2004-02-29 16:21:42}}" --base32 "{{secret}}"` + +- Validate a TOTP token: + +`oathtool --totp --base32 "{{secret}}" "{{token}}"` diff --git a/objdump b/objdump new file mode 100644 index 00000000..794b8e76 --- /dev/null +++ b/objdump @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# objdump + +> View information about object files. +> More information: . + +- Display the file header information: + +`objdump -f {{binary}}` + +- Display all header information: + +`objdump -x {{binary}}` + +- Display the disassembled output of executable sections: + +`objdump -d {{binary}}` + +- Display the disassembled executable sections in intel syntax: + +`objdump -M intel -d {{binary}}` + +- Display a complete binary hex dump of all sections: + +`objdump -s {{binary}}` diff --git a/obs b/obs new file mode 100644 index 00000000..13cd3b7f --- /dev/null +++ b/obs @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# obs + +> Open Broadcaster Software. +> Video recording and livestreaming program. +> More information: . + +- Launch OBS: + +`obs` + +- Launch OBS in portable mode: + +`obs --portable` + +- Automatically start recording a video on launch: + +`obs --startrecording` + +- Automatically start the replay buffer on launch: + +`obs --startreplaybuffer` + +- Automatically start streaming on launch: + +`obs --startstreaming` + +- Minimise to the system tray on launch: + +`obs --minimize-to-tray` + +- Make the log more verbose (for debugging): + +`obs --verbose` diff --git a/oc b/oc new file mode 100644 index 00000000..09660a99 --- /dev/null +++ b/oc @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# oc + +> The OpenShift Container Platform CLI. +> Allows for application and container management. +> More information: . + +- Log in to the OpenShift Container Platform server: + +`oc login` + +- Create a new project: + +`oc new-project {{project_name}}` + +- Switch to an existing project: + +`oc project {{project_name}}` + +- Add a new application to a project: + +`oc new-app {{repo_url}} --name {{application}}` + +- Open a remote shell session to a container: + +`oc rsh {{pod_name}}` + +- List pods in a project: + +`oc get pods` + +- Log out from the current session: + +`oc logout` diff --git a/ocaml b/ocaml new file mode 100644 index 00000000..96177d19 --- /dev/null +++ b/ocaml @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ocaml + +> The OCaml repl (read-evaluate-print-loop). +> Interprets Ocaml commands. +> More information: . + +- Read OCaml commands from the user and execute them: + +`ocaml` + +- Read OCaml commands from a file and execute them: + +`ocaml {{path/to/file.ml}}` + +- Run OCaml script with modules: + +`ocaml {{module1}} {{module2}} {{path/to/file.ml}}` diff --git a/ocamlc b/ocamlc new file mode 100644 index 00000000..7824d477 --- /dev/null +++ b/ocamlc @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ocamlc + +> The OCaml bytecode compiler. +> Produces executables runnable by the OCaml interpreter. +> More information: . + +- Create a binary from a source file: + +`ocamlc {{path/to/source_file.ml}}` + +- Create a named binary from a source file: + +`ocamlc -o {{path/to/binary}} {{path/to/source_file.ml}}` + +- Automatically generate a module signature (interface) file: + +`ocamlc -i {{path/to/source_file.ml}}` diff --git a/ocamlfind b/ocamlfind new file mode 100644 index 00000000..33766033 --- /dev/null +++ b/ocamlfind @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ocamlfind + +> The findlib package manager for OCaml. +> Simplifies linking executables with external libraries. +> More information: . + +- Compile a source file to a native binary and link with packages: + +`ocamlfind ocamlopt -package {{package1}},{{package2}} -linkpkg -o {{path/to/executable}} {{path/to/source.ml}}` + +- Compile a source file to a bytecode binary and link with packages: + +`ocamlfind ocamlc -package {{package1}},{{package2}} -linkpkg -o {{path/to/executable}} {{path/to/source.ml}}` + +- Cross-compile for a different platform: + +`ocamlfind -toolchain {{cross-toolchain}} ocamlopt -o {{path/to/executable}} {{path/to/source.ml}}` diff --git a/ocamlopt b/ocamlopt new file mode 100644 index 00000000..25b7c8cc --- /dev/null +++ b/ocamlopt @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ocamlopt + +> The OCaml native code compiler. +> Produces native executables, e.g. ELF on Linux. +> More information: . + +- Compile a source file: + +`ocamlopt -o {{path/to/binary}} {{path/to/source_file.ml}}` + +- Compile with debugging enabled: + +`ocamlopt -g -o {{path/to/binary}} {{path/to/source_file.ml}}` diff --git a/ocrmypdf b/ocrmypdf new file mode 100644 index 00000000..62294272 --- /dev/null +++ b/ocrmypdf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ocrmypdf + +> Generate a searchable PDF or PDF/A from a scanned PDF or an image of text. +> More information: . + +- Create a new searchable PDF/A file from a scanned PDF or image file: + +`ocrmypdf {{path/to/input_file}} {{path/to/output.pdf}}` + +- Replace a scanned PDF file with a searchable PDF file: + +`ocrmypdf {{path/to/file.pdf}} {{path/to/file.pdf}}` + +- Skip pages of a mixed-format input PDF file that already contain text: + +`ocrmypdf --skip-text {{path/to/input.pdf}} {{path/to/output.pdf}}` + +- Clean, de-skew, and rotate pages of a poor scan: + +`ocrmypdf --clean --deskew --rotate-pages {{path/to/input_file}} {{path/to/output.pdf}}` + +- Set the metadata of the searchable PDF file: + +`ocrmypdf --title "{{title}}" --author "{{author}}" --subject "{{subject}}" --keywords "{{keyword; key phrase; ...}}" {{path/to/input_file}} {{path/to/output.pdf}}` + +- Display help: + +`ocrmypdf --help` diff --git a/octave b/octave new file mode 100644 index 00000000..de1c43a0 --- /dev/null +++ b/octave @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# octave + +> A programming language for scientific computing. +> More information: . + +- Start an interactive session: + +`octave` + +- Execute a specific script file: + +`octave {{path/to/script.m}}` + +- Execute a script file with specific arguments: + +`octave {{path/to/script.m}} {{argument1 argument2 ...}}` + +- Start an interactive session with a GUI: + +`octave --gui` + +- Display help: + +`octave --help` + +- Display version: + +`octave --version` diff --git a/od b/od new file mode 100644 index 00000000..ccda498e --- /dev/null +++ b/od @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# od + +> Display file contents in octal, decimal or hexadecimal format. +> Optionally display the byte offsets and/or printable representation for each line. +> More information: . + +- Display file using default settings: octal format, 8 bytes per line, byte offsets in octal, and duplicate lines replaced with `*`: + +`od {{path/to/file}}` + +- Display file in verbose mode, i.e. without replacing duplicate lines with `*`: + +`od -v {{path/to/file}}` + +- Display file in hexadecimal format (2-byte units), with byte offsets in decimal format: + +`od --format={{x}} --address-radix={{d}} -v {{path/to/file}}` + +- Display file in hexadecimal format (1-byte units), and 4 bytes per line: + +`od --format={{x1}} --width={{4}} -v {{path/to/file}}` + +- Display file in hexadecimal format along with its character representation, and do not print byte offsets: + +`od --format={{xz}} --address-radix={{n}} -v {{path/to/file}}` + +- Read only 100 bytes of a file starting from the 500th byte: + +`od --read-bytes {{100}} --skip-bytes={{500}} -v {{path/to/file}}` diff --git a/odps b/odps new file mode 100644 index 00000000..d4ddb6c4 --- /dev/null +++ b/odps @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps + +> Aliyun ODPS (Open Data Processing Service) command-line tool. +> Some subcommands such as `odps inst` have their own usage documentation. +> More information: . + +- Start the command-line with a custom configuration file: + +`odpscmd --config={{odps_config.ini}}` + +- Switch current project: + +`use {{project_name}};` + +- Show tables in the current project: + +`show tables;` + +- Describe a table: + +`desc {{table_name}};` + +- Show table partitions: + +`show partitions {{table_name}};` + +- Describe a partition: + +`desc {{table_name}} partition ({{partition_spec}});` diff --git a/odps-auth b/odps-auth new file mode 100644 index 00000000..1b0808ba --- /dev/null +++ b/odps-auth @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps auth + +> User authorities in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Add a user to the current project: + +`add user {{username}};` + +- Grant a set of authorities to a user: + +`grant {{action_list}} on {{object_type}} {{object_name}} to user {{username}};` + +- Show authorities of a user: + +`show grants for {{username}};` + +- Create a user role: + +`create role {{role_name}};` + +- Grant a set of authorities to a role: + +`grant {{action_list}} on {{object_type}} {{object_name}} to role {{role_name}};` + +- Describe authorities of a role: + +`desc role {{role_name}};` + +- Grant a role to a user: + +`grant {{role_name}} to {{username}};` diff --git a/odps-func b/odps-func new file mode 100644 index 00000000..7c996f92 --- /dev/null +++ b/odps-func @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps func + +> Manage functions in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Show functions in the current project: + +`list functions;` + +- Create a Java function using a `.jar` resource: + +`create function {{func_name}} as {{path.to.package.Func}} using '{{package.jar}}';` + +- Create a Python function using a `.py` resource: + +`create function {{func_name}} as {{script.Func}} using '{{script.py}}';` + +- Delete a function: + +`drop function {{func_name}};` diff --git a/odps-inst b/odps-inst new file mode 100644 index 00000000..6f2e07fe --- /dev/null +++ b/odps-inst @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps inst + +> Manage instances in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Show instances created by current user: + +`show instances;` + +- Describe the details of an instance: + +`desc instance {{instance_id}};` + +- Check the status of an instance: + +`status {{instance_id}};` + +- Wait on the termination of an instance, printing log and progress information until then: + +`wait {{instance_id}};` + +- Kill an instance: + +`kill {{instance_id}};` diff --git a/odps-resource b/odps-resource new file mode 100644 index 00000000..57ec3767 --- /dev/null +++ b/odps-resource @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps resource + +> Manage resources in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Show resources in the current project: + +`list resources;` + +- Add file resource: + +`add file {{filename}} as {{alias}};` + +- Add archive resource: + +`add archive {{archive.tar.gz}} as {{alias}};` + +- Add .jar resource: + +`add jar {{package.jar}};` + +- Add .py resource: + +`add py {{script.py}};` + +- Delete resource: + +`drop resource {{resource_name}};` diff --git a/odps-table b/odps-table new file mode 100644 index 00000000..45d48e05 --- /dev/null +++ b/odps-table @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps table + +> Create and modify tables in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Create a table with partition and lifecycle: + +`create table {{table_name}} ({{col}} {{type}}) partitioned by ({{col}} {{type}}) lifecycle {{days}};` + +- Create a table based on the definition of another table: + +`create table {{table_name}} like {{another_table}};` + +- Add partition to a table: + +`alter table {{table_name}} add partition ({{partition_spec}});` + +- Delete partition from a table: + +`alter table {{table_name}} drop partition ({{partition_spec}});` + +- Delete table: + +`drop table {{table_name}};` diff --git a/odps-tunnel b/odps-tunnel new file mode 100644 index 00000000..2feb0ab5 --- /dev/null +++ b/odps-tunnel @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# odps tunnel + +> Data tunnel in ODPS (Open Data Processing Service). +> See also `odps`. +> More information: . + +- Download table to local file: + +`tunnel download {{table_name}} {{path/to/file}};` + +- Upload local file to a table partition: + +`tunnel upload {{path/to/file}} {{table_name}}/{{partition_spec}};` + +- Upload table specifying field and record delimiters: + +`tunnel upload {{path/to/file}} {{table_name}} -fd {{field_delim}} -rd {{record_delim}};` + +- Upload table using multiple threads: + +`tunnel upload {{path/to/file}} {{table_name}} -threads {{num}};` diff --git a/offlineimap b/offlineimap new file mode 100644 index 00000000..7913721a --- /dev/null +++ b/offlineimap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# offlineimap + +> Synchronize a remote IMAP server with local Maildir folders. +> More information: . + +- Synchronize once, without enabling autorefresh: + +`offlineimap -o` + +- Synchronize a specific account: + +`offlineimap -a {{account}}` + +- Synchronize a specific folder: + +`offlineimap -f {{folder}}` diff --git a/ogr2ogr b/ogr2ogr new file mode 100644 index 00000000..efbfa4a9 --- /dev/null +++ b/ogr2ogr @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ogr2ogr + +> Convert geospatial vector data between file formats. +> More information: . + +- Convert a Shapefile into a GeoPackage: + +`ogr2ogr -f GPKG {{path/to/output.gpkg}} {{path/to/input.shp}}` + +- Reduce a GeoJSON to features matching a condition: + +`ogr2ogr -where '{{myProperty > 42}}' -f {{GeoJSON}} {{path/to/output.geojson}} {{path/to/input.geojson}}` + +- Change coordinate reference system of a GeoPackage from `EPSG:4326` to `EPSG:3857`: + +`ogr2ogr -s_srs {{EPSG:4326}} -t_srs {{EPSG:3857}} -f GPKG {{path/to/output.gpkg}} {{path/to/input.gpkg}}` + +- Convert a CSV file into a GeoPackage, specifying the names of the coordinate columns and assigning a coordinate reference system: + +`ogr2ogr -f GPKG {{path/to/output.gpkg}} {{path/to/input.csv}} -oo X_POSSIBLE_NAMES={{longitude}} -oo Y_POSSIBLE_NAMES={{latitude}} -a_srs {{EPSG:4326}}` + +- Load a GeoPackage into a PostGIS database: + +`ogr2ogr -f PostgreSQL PG:dbname="{{database_name}}" {{path/to/input.gpkg}}` + +- Clip layers of a GeoPackage file to the given bounding box: + +`ogr2ogr -spat {{min_x}} {{min_y}} {{max_x}} {{max_y}} -f GPKG {{path/to/output.gpkg}} {{path/to/input.gpkg}}` diff --git a/ogrinfo b/ogrinfo new file mode 100644 index 00000000..cd286e3f --- /dev/null +++ b/ogrinfo @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ogrinfo + +> List information about an OGR-supported data source. +> More information: . + +- List supported formats: + +`ogrinfo --formats` + +- List layers of a data source: + +`ogrinfo {{path/to/input.gpkg}}` + +- Get detailed information about a specific layer of a data source: + +`ogrinfo {{path/to/input.gpkg}} {{layer_name}}` + +- Show summary information about a specific layer of a data source: + +`ogrinfo -so {{path/to/input.gpkg}} {{layer_name}}` + +- Show summary of all layers of the data source: + +`ogrinfo -so -al {{path/to/input.gpkg}}` + +- Show detailed information of features matching a condition: + +`ogrinfo -where '{{attribute_name > 42}}' {{path/to/input.gpkg}} {{layer_name}}` + +- Update a layer in the data source with SQL: + +`ogrinfo {{path/to/input.geojson}} -dialect SQLite -sql "{{UPDATE input SET attribute_name = 'foo'}}"` diff --git a/ogrmerge.py b/ogrmerge.py new file mode 100644 index 00000000..1a9e5608 --- /dev/null +++ b/ogrmerge.py @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ogrmerge.py + +> Merge several vector datasets into a single one. +> More information: . + +- Create a GeoPackage with a layer for each input Shapefile: + +`ogrmerge.py -f {{GPKG}} -o {{path/to/output.gpkg}} {{path/to/input1.shp path/to/input2.shp ...}}` + +- Create a virtual datasource (VRT) with a layer for each input GeoJSON: + +`ogrmerge.py -f {{VRT}} -o {{path/to/output.vrt}} {{path/to/input1.geojson path/to/input2.geojson ...}}` + +- Concatenate two vector datasets and store source name of dataset in attribute 'source_name': + +`ogrmerge.py -single -f {{GeoJSON}} -o {{path/to/output.geojson}} -src_layer_field_name country {{source_name}} {{path/to/input1.shp path/to/input2.shp ...}}` diff --git a/ohdear-cli b/ohdear-cli new file mode 100644 index 00000000..985ed9d2 --- /dev/null +++ b/ohdear-cli @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ohdear-cli + +> An unofficial Oh Dear CLI written with Laravel Zero. +> More information: . + +- Display details about the currently authenticated user: + +`ohdear-cli me` + +- Add a new site to Oh Dear: + +`ohdear-cli sites:add {{url}}` + +- Display a list of sites and their current status: + +`ohdear-cli sites:list` + +- Display details about a specific site: + +`ohdear-cli sites:show {{site_id}}` diff --git a/okular b/okular new file mode 100644 index 00000000..9241f4a6 --- /dev/null +++ b/okular @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# okular + +> View documents. +> More information: . + +- Launch document viewer: + +`okular` + +- Open specific documents: + +`okular {{path/to/file1 path/to/file2 ...}}` + +- Open a document at a specific page: + +`okular --page {{page_number}} {{path/to/file}}` + +- Open a specific document in presentation mode: + +`okular --presentation {{path/to/file}}` + +- Open a specific document and start a print dialog: + +`okular --print {{path/to/file}}` + +- Open a document and search for a specific string: + +`okular --find {{search_string}} {{path/to/file}}` diff --git a/ollama b/ollama new file mode 100644 index 00000000..2108bafb --- /dev/null +++ b/ollama @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ollama + +> A large language model runner. +> More information: . + +- Start the daemon required to run other commands: + +`ollama serve` + +- Run a model and chat with it: + +`ollama run {{model}}` + +- Run a model with a single prompt: + +`ollama run {{model}} {{prompt}}` + +- List downloaded models: + +`ollama list` + +- Delete a model: + +`ollama rm {{model}}` + +- Create a model from a `Modelfile`: + +`ollama create {{new_model_name}} -f {{path/to/Modelfile}}` diff --git a/omf b/omf new file mode 100644 index 00000000..e3275461 --- /dev/null +++ b/omf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# omf + +> Oh My Fish, the Fishshell Framework. +> Install packages to extend and modify the fish shell. +> More information: . + +- Install one or more packages: + +`omf install {{name}}` + +- List installed packages: + +`omf list` + +- List available themes: + +`omf theme` + +- Apply a theme: + +`omf theme {{name}}` + +- Remove a theme or package: + +`omf remove {{name}}` + +- Uninstall Oh My Fish: + +`omf destroy` diff --git a/omz b/omz new file mode 100644 index 00000000..d3456424 --- /dev/null +++ b/omz @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# omz + +> Oh My Zsh command-line tool. +> More information: . + +- Update Oh My Zsh: + +`omz update` + +- Print the changes from the latest update of Oh My Zsh: + +`omz changelog` + +- Restart the current Zsh session and Oh My Zsh: + +`omz reload` + +- List all available plugins: + +`omz plugin list` + +- Enable/Disable an Oh My Zsh plugin: + +`omz plugin {{enable|disable}} {{plugin}}` + +- List all available themes: + +`omz theme list` + +- Set an Oh My Zsh theme in `~/.zshrc`: + +`omz theme set {{theme}}` diff --git a/ooniprobe b/ooniprobe new file mode 100644 index 00000000..d4b16238 --- /dev/null +++ b/ooniprobe @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ooniprobe + +> Open Observatory of Network Interference (OONI). +> Test the blocking of websites and apps. Measure the speed and performance of your network. +> More information: . + +- List all tests performed: + +`ooniprobe list` + +- Show information about a specific test: + +`ooniprobe list {{7}}` + +- Run all available tests: + +`ooniprobe run all` + +- Perform a specific test: + +`ooniprobe run {{performance}}` + +- Check the availability of a specific website: + +`ooniprobe run websites --input {{https://ooni.org/}}` + +- Check the availability of all websites listed in a file: + +`ooniprobe run websites --input-file {{path/to/my-websites.txt}}` + +- Display detailed information about a test in JSON format: + +`ooniprobe show {{9}}` diff --git a/op b/op new file mode 100644 index 00000000..75fcc2e5 --- /dev/null +++ b/op @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# op + +> Official CLI for 1Password's desktop app. +> More information: . + +- Sign in to a 1Password account: + +`op signin` + +- List all vaults: + +`op vault list` + +- Print item details in JSON format: + +`op item get {{item_name}} --format json` + +- Create a new item with a category in the default vault: + +`op item create --category {{category_name}}` + +- Print a referenced secret to `stdout`: + +`op read {{secret_reference}}` + +- Pass secret references from exported environment variables to a command: + +`op run -- {{command}}` + +- Pass secret references from an environment file to a command: + +`op run --env-file {{path/to/env_file.env}} -- {{command}}` + +- Read secret references from a file and save plaintext secrets to a file: + +`op inject --in-file {{path/to/input_file}} --out-file {{path/to/output_file}}` diff --git a/opam b/opam new file mode 100644 index 00000000..fb78954e --- /dev/null +++ b/opam @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# opam + +> OCaml Package Manager. +> Manage OCaml compilers, tools and libraries. +> More information: . + +- Initialize opam for first use: + +`opam init` + +- Search for packages: + +`opam search {{query}}` + +- Install a package and all of its dependencies: + +`opam install {{package}}` + +- Display detailed information about a package: + +`opam show {{package}}` + +- List all installed packages: + +`opam list` + +- Update the local package database: + +`opam update` + +- Upgrade all installed packages: + +`opam upgrade` + +- Display help: + +`opam help` diff --git a/open b/open new file mode 100644 index 00000000..b838bbf9 --- /dev/null +++ b/open @@ -0,0 +1,16 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# open + +> `open` can refer to multiple commands with the same name. + +- View documentation for the command available in macOS: + +`tldr open -p osx` + +- View documentation for the command available through `fish`: + +`tldr open.fish` diff --git a/open.fish b/open.fish new file mode 100644 index 00000000..e7990e16 --- /dev/null +++ b/open.fish @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# open + +> Opens files, directories, and URIs with default applications. +> This command is available through `fish` on operating systems without the built-in `open` command (e.g. Haiku and macOS). +> More information: . + +- Open a file with the associated application: + +`open {{path/to/file.ext}}` + +- Open all the files of a given extension in the current directory with the associated application: + +`open {{*.ext}}` + +- Open a directory using the default file manager: + +`open {{path/to/directory}}` + +- Open a website using the default web browser: + +`open {{https://example.com}}` + +- Open a specific URI using the default application that can handle it: + +`open {{tel:123}}` diff --git a/openai b/openai new file mode 100644 index 00000000..274e0d89 --- /dev/null +++ b/openai @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openai + +> CLI tool providing access to the OpenAI API. +> More information: . + +- List models: + +`openai api models.list` + +- Create a completion: + +`openai api completions.create --model {{ada}} --prompt {{"Hello world"}}` + +- Create a chat completion: + +`openai api chat_completions.create --model {{gpt-3.5-turbo}} --message {{user "Hello world"}}` + +- Generate images via DALL·E API: + +`openai api image.create --prompt {{"two dogs playing chess, cartoon"}} --num-images {{1}}` diff --git a/openbsd/cal b/openbsd/cal new file mode 100644 index 00000000..e2829d68 --- /dev/null +++ b/openbsd/cal @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Display a calendar with the current day highlighted. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display a calendar for a specific year: + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` + +- Display a calendar for the current [y]ear: + +`cal -y` + +- Display [j]ulian days (starting from one, numbered from January 1): + +`cal -j` + +- Use [m]onday as week start instead of Sunday: + +`cal -m` + +- Number [w]eek numbers (incompatible with `-j`): + +`cal -w` diff --git a/openbsd/chfn b/openbsd/chfn new file mode 100644 index 00000000..9256a476 --- /dev/null +++ b/openbsd/chfn @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chfn + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/openbsd/chpass b/openbsd/chpass new file mode 100644 index 00000000..85b45fb9 --- /dev/null +++ b/openbsd/chpass @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chpass + +> Add or change user database information, including login shell and password. +> See also: `passwd`. +> More information: . + +- Set a specific login shell for the current user interactively: + +`doas chsh` + +- Set a specific login [s]hell for the current user: + +`doas chsh -s {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`doas chsh -s {{path/to/shell}} {{username}}` + +- Specify a user database entry in the `passwd` file format: + +`doas chsh -a {{username:encrypted_password:uid:gid:...}}` diff --git a/openbsd/chsh b/openbsd/chsh new file mode 100644 index 00000000..da00410c --- /dev/null +++ b/openbsd/chsh @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# chsh + +> This command is an alias of `chpass`. + +- View documentation for the original command: + +`tldr chpass` diff --git a/openbsd/df b/openbsd/df new file mode 100644 index 00000000..75364df6 --- /dev/null +++ b/openbsd/df @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage using 512-byte units: + +`df` + +- Display all filesystems and their disk usage in [h]uman-readable form (based on powers of 1024): + +`df -h` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Include statistics on the number of free and used [i]nodes: + +`df -i` + +- Use 1024-byte units when writing space figures: + +`df -k` + +- Display information in a [P]ortable way: + +`df -P` diff --git a/openbsd/pkg b/openbsd/pkg new file mode 100644 index 00000000..20c07f45 --- /dev/null +++ b/openbsd/pkg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg + +> OpenBSD package manager utility. +> More information: . + +- View documentation for installing/updating packages: + +`tldr pkg_add` + +- View documentation for removing packages: + +`tldr pkg_delete` + +- View documentation for viewing information about packages: + +`tldr pkg_info` diff --git a/openbsd/pkg_add b/openbsd/pkg_add new file mode 100644 index 00000000..56f250cc --- /dev/null +++ b/openbsd/pkg_add @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg_add + +> Install/update packages in OpenBSD. +> See also: `pkg_info`, `pkg_delete`. +> More information: . + +- Update all packages, including dependencies: + +`pkg_add -u` + +- Install a new package: + +`pkg_add {{package}}` + +- Install packages from the raw output of `pkg_info`: + +`pkg_add -l {{path/to/file}}` diff --git a/openbsd/pkg_delete b/openbsd/pkg_delete new file mode 100644 index 00000000..7935279e --- /dev/null +++ b/openbsd/pkg_delete @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg_delete + +> Remove packages in OpenBSD. +> See also: `pkg_add`, `pkg_info`. +> More information: . + +- Delete a package: + +`pkg_delete {{package}}` + +- Delete a package, including its unused dependencies: + +`pkg_delete -a {{package}}` + +- Dry-run deletion of a package: + +`pkg_delete -n {{package}}` diff --git a/openbsd/pkg_info b/openbsd/pkg_info new file mode 100644 index 00000000..cb88fef3 --- /dev/null +++ b/openbsd/pkg_info @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg_info + +> View information about packages in OpenBSD. +> See also: `pkg_add`, `pkg_delete`. +> More information: . + +- Search for a package using the package name: + +`pkg_info -Q {{package}}` + +- Output a list of installed packages for use with `pkg_add -l`: + +`pkg_info -mz` diff --git a/openbsd/sed b/openbsd/sed new file mode 100644 index 00000000..196e2aa9 --- /dev/null +++ b/openbsd/sed @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, openbsd] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script.sed}}` + +- Delay opening each file until a command containing the related `w` function or flag is applied to a line of input: + +`{{command}} | sed -fa {{path/to/script.sed}}` + +- Replace all `apple` (extended regex) occurrences with `APPLE` (extended regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed -E 's/(apple)/\U\1/g'` + +- Print just a first line to `stdout`: + +`{{command}} | sed -n '1p'` + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in a specific file and overwrite the original file in place: + +`sed -i 's/apple/mango/g' {{path/to/file}}` diff --git a/openconnect b/openconnect new file mode 100644 index 00000000..a2ca33bb --- /dev/null +++ b/openconnect @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openconnect + +> A VPN client, for Cisco AnyConnect VPNs and others. +> More information: . + +- Connect to a server: + +`openconnect {{vpn.example.org}}` + +- Connect to a server, forking into the background: + +`openconnect --background {{vpn.example.org}}` + +- Terminate the connection that is running in the background: + +`killall -SIGINT openconnect` + +- Connect to a server, reading options from a configuration file: + +`openconnect --config={{path/to/file}} {{vpn.example.org}}` + +- Connect to a server and authenticate with a specific SSL client certificate: + +`openconnect --certificate={{path/to/file}} {{vpn.example.org}}` diff --git a/openscad b/openscad new file mode 100644 index 00000000..7e443895 --- /dev/null +++ b/openscad @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openscad + +> Software for creating solid 3D CAD objects. +> More information: . + +- Open a file: + +`openscad {{path/to/button.scad}}` + +- Convert a file to STL: + +`openscad -o {{path/to/button.stl}} {{path/to/button.scad}}` + +- Render a file to PNG in a specific colorscheme: + +`openscad -o {{path/to/button.png}} --colorscheme {{Sunset}} {{path/to/button.scad}}` diff --git a/openssl b/openssl new file mode 100644 index 00000000..22fdcc41 --- /dev/null +++ b/openssl @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl + +> OpenSSL cryptographic toolkit. +> Some subcommands such as `openssl req` have their own usage documentation. +> More information: . + +- Display help: + +`openssl help` + +- Display help for a specific subcommand: + +`openssl help {{x509}}` + +- Display version: + +`openssl version` diff --git a/openssl-dgst b/openssl-dgst new file mode 100644 index 00000000..3c4bb49e --- /dev/null +++ b/openssl-dgst @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl dgst + +> OpenSSL command to generate digest values and perform signature operations. +> More information: . + +- Calculate the SHA256 digest for a file, saving the result to a specific file: + +`openssl dgst -sha256 -binary -out {{output_file}} {{input_file}}` + +- Sign a file using an RSA key, saving the result to a specific file: + +`openssl dgst -sign {{private_key_file}} -sha256 -sigopt rsa_padding_mode:pss -out {{output_file}} {{input_file}}` + +- Verify an RSA signature: + +`openssl dgst -verify {{public_key_file}} -signature {{signature_file}} -sigopt rsa_padding_mode:pss {{signature_message_file}}` + +- Sign a file using and ECDSA key: + +`openssl dgst -sign {{private_key_file}} -sha256 -out {{output_file}} {{input_file}}` + +- Verify an ECDSA signature: + +`openssl dgst -verify {{public_key_file}} -signature {{signature_file}} {{signature_message_file}}` diff --git a/openssl-genpkey b/openssl-genpkey new file mode 100644 index 00000000..dd23aed2 --- /dev/null +++ b/openssl-genpkey @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl genpkey + +> OpenSSL command to generate asymmetric key pairs. +> More information: . + +- Generate an RSA private key of 2048 bits, saving it to a specific file: + +`openssl genpkey -algorithm rsa -pkeyopt rsa_keygen_bits:{{2048}} -out {{filename.key}}` + +- Generate an elliptic curve private key using the curve `prime256v1`, saving it to a specific file: + +`openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:{{prime256v1}} -out {{filename.key}}` + +- Generate an `ED25519` elliptic curve private key, saving it to a specific file: + +`openssl genpkey -algorithm {{ED25519}} -out {{filename.key}}` diff --git a/openssl-genrsa b/openssl-genrsa new file mode 100644 index 00000000..74cc8efe --- /dev/null +++ b/openssl-genrsa @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl genrsa + +> OpenSSL command to generate RSA private keys. +> More information: . + +- Generate an RSA private key of 2048 bits to `stdout`: + +`openssl genrsa` + +- Save an RSA private key of an arbitrary number of bits to the output file: + +`openssl genrsa -out {{output_file.key}} {{1234}}` + +- Generate an RSA private key and encrypt it with AES256 (you will be prompted for a passphrase): + +`openssl genrsa {{-aes256}}` diff --git a/openssl-prime b/openssl-prime new file mode 100644 index 00000000..8e5575f0 --- /dev/null +++ b/openssl-prime @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl prime + +> OpenSSL command to compute prime numbers. +> More information: . + +- Generate a 2048bit prime number and display it in hexadecimal: + +`openssl prime -generate -bits 2048 -hex` + +- Check if a given number is prime: + +`openssl prime {{number}}` diff --git a/openssl-req b/openssl-req new file mode 100644 index 00000000..19e87c03 --- /dev/null +++ b/openssl-req @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl req + +> OpenSSL command to manage PKCS#10 Certificate Signing Requests. +> More information: . + +- Generate a certificate signing request to be sent to a certificate authority: + +`openssl req -new -sha256 -key {{filename.key}} -out {{filename.csr}}` + +- Generate a self-signed certificate and a corresponding key-pair, storing both in a file: + +`openssl req -new -x509 -newkey {{rsa}}:{{4096}} -keyout {{filename.key}} -out {{filename.cert}} -subj "{{/C=XX/CN=foobar}}" -days {{365}}` diff --git a/openssl-s_client b/openssl-s_client new file mode 100644 index 00000000..e20fe54d --- /dev/null +++ b/openssl-s_client @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl s_client + +> OpenSSL command to create TLS client connections. +> More information: . + +- Display the start and expiry dates for a domain's certificate: + +`openssl s_client -connect {{host}}:{{port}} 2>/dev/null | openssl x509 -noout -dates` + +- Display the certificate presented by an SSL/TLS server: + +`openssl s_client -connect {{host}}:{{port}} OpenSSL command to generate and verify timestamps. +> More information: . + +- Generate a SHA-512 timestamp request of a specific file and output to `file.tsq`: + +`openssl ts -query -data {{path/to/file}} -sha512 -out {{path/to/file.tsq}}` + +- Check the date and metadata of a specific timestamp response file: + +`openssl ts -reply -in {{path/to/file.tsr}} -text` + +- Verify a timestamp request file and a timestamp response file from the server with an SSL certificate file: + +`openssl ts -verify -in {{path/to/file.tsr}} -queryfile {{path/to/file.tsq}} -partial_chain -CAfile {{path/to/cert.pem}}` + +- Create a timestamp response for request using key and signing certificate and output it to `file.tsr`: + +`openssl ts -reply -queryfile {{path/to/file.tsq}} -inkey {{path/to/tsakey.pem}} -signer tsacert.pem -out {{path/to/file.tsr}}` diff --git a/openssl-x509 b/openssl-x509 new file mode 100644 index 00000000..a98de580 --- /dev/null +++ b/openssl-x509 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openssl x509 + +> OpenSSL command to manage X.509 certificates. +> More information: . + +- Display certificate information: + +`openssl x509 -in {{filename.crt}} -noout -text` + +- Display a certificate's expiration date: + +`openssl x509 -enddate -noout -in {{filename.pem}}` + +- Convert a certificate between binary DER encoding and textual PEM encoding: + +`openssl x509 -inform {{der}} -outform {{pem}} -in {{original_certificate_file}} -out {{converted_certificate_file}}` + +- Store a certificate's public key in a file: + +`openssl x509 -in {{certificate_file}} -noout -pubkey -out {{output_file}}` diff --git a/openttd b/openttd new file mode 100644 index 00000000..b22c56b0 --- /dev/null +++ b/openttd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openttd + +> Open source clone of the Microprose game "Transport Tycoon Deluxe". +> More information: . + +- Start a new game: + +`openttd -g` + +- Load save game at start: + +`openttd -g {{path/to/file}}` + +- Start with the specified window resolution: + +`openttd -r {{1920x1080}}` + +- Start with a custom configuration file: + +`openttd -c {{path/to/file}}` + +- Start with selected video, sound, and music drivers: + +`openttd -v {{video_driver}} -s {{sound_driver}} -m {{music_driver}}` + +- Start a dedicated server, forked in the background: + +`openttd -f -D {{host}}:{{port}}` + +- Join a server with a password: + +`openttd -n {{host}}:{{port}}#{{player_name}} -p {{password}}` diff --git a/openvpn b/openvpn new file mode 100644 index 00000000..ac76d294 --- /dev/null +++ b/openvpn @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openvpn + +> OpenVPN client and daemon binary. +> More information: . + +- Connect to server using a configuration file: + +`sudo openvpn {{path/to/client.conf}}` + +- Try to set up an insecure peer-to-peer tunnel on bob.example.com host: + +`sudo openvpn --remote {{alice.example.com}} --dev {{tun1}} --ifconfig {{10.4.0.1}} {{10.4.0.2}}` + +- Connect to the awaiting bob.example.com host without encryption: + +`sudo openvpn --remote {{bob.example.com}} --dev {{tun1}} --ifconfig {{10.4.0.2}} {{10.4.0.1}}` + +- Create a cryptographic key and save it to file: + +`openvpn --genkey secret {{path/to/key}}` + +- Try to set up a peer-to-peer tunnel on bob.example.com host with a static key: + +`sudo openvpn --remote {{alice.example.com}} --dev {{tun1}} --ifconfig {{10.4.0.1}} {{10.4.0.2}} --secret {{path/to/key}}` + +- Connect to the awaiting bob.example.com host with the same static key as on bob.example.com: + +`sudo openvpn --remote {{bob.example.com}} --dev {{tun1}} --ifconfig {{10.4.0.2}} {{10.4.0.1}} --secret {{path/to/key}}` diff --git a/opt b/opt new file mode 100644 index 00000000..a293fe80 --- /dev/null +++ b/opt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# opt + +> Runs optimizations and analyse LLVM source files. +> More information: . + +- Run an optimization or analysis on a bitcode file: + +`opt -{{passname}} {{path/to/file.bc}} -S -o {{file_opt.bc}}` + +- Output the Control Flow Graph of a function to a `.dot` file: + +`opt {{-dot-cfg}} -S {{path/to/file.bc}} -disable-output` + +- Optimize the program at level 2 and output the result to another file: + +`opt -O2 {{path/to/file.bc}} -S -o {{path/to/output_file.bc}}` diff --git a/optipng b/optipng new file mode 100644 index 00000000..3083838c --- /dev/null +++ b/optipng @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# optipng + +> PNG file optimization utility. +> More information: . + +- Compress a PNG with default settings: + +`optipng {{path/to/file.png}}` + +- Compress a PNG with the best compression: + +`optipng -o{{7}} {{path/to/file.png}}` + +- Compress a PNG with the fastest compression: + +`optipng -o{{0}} {{path/to/file.png}}` + +- Compress a PNG and add interlacing: + +`optipng -i {{1}} {{path/to/file.png}}` + +- Compress a PNG and preserve all metadata (including file timestamps): + +`optipng -preserve {{path/to/file.png}}` + +- Compress a PNG and remove all metadata: + +`optipng -strip all {{path/to/file.png}}` diff --git a/opusenc b/opusenc new file mode 100644 index 00000000..7f472580 --- /dev/null +++ b/opusenc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# opusenc + +> Convert WAV or FLAC audio to Opus. +> More information: . + +- Convert WAV to Opus using default options: + +`opusenc {{path/to/input.wav}} {{path/to/output.opus}}` + +- Convert stereo audio at the highest quality level: + +`opusenc --bitrate {{512}} {{path/to/input.wav}} {{path/to/output.opus}}` + +- Convert 5.1 surround sound audio at the highest quality level: + +`opusenc --bitrate {{1536}} {{path/to/input.flac}} {{path/to/output.opus}}` + +- Convert speech audio at the lowest quality level: + +`opusenc {{path/to/input.wav}} --downmix-mono --bitrate {{6}} {{path/to/out.opus}}` diff --git a/orca-c b/orca-c new file mode 100644 index 00000000..f15a97b2 --- /dev/null +++ b/orca-c @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# orca-c + +> A C-port of the ORCA live programming environment. +> ORCA is an esoteric programming language for creating procedural sequencers. +> More information: . + +- Start ORCA with an empty workspace: + +`orca-c` + +- Start ORCA and open a specific file: + +`orca-c {{path/to/file.orca}}` + +- Start ORCA and set a specific tempo (defaults to 120): + +`orca-c --bpm {{beats_per_minute}}` + +- Start ORCA and set the size of the grid: + +`orca-c --initial-size {{columns}}x{{rows}}` + +- Start ORCA and set the maximum number of undo steps (defaults to 100): + +`orca-c --undo-limit {{limit}}` + +- Show the main menu inside of ORCA: + +`F1` + +- Show all shortcuts inside of ORCA: + +`?` + +- Show all ORCA operators inside of ORCA: + +` + g` diff --git a/osage b/osage new file mode 100644 index 00000000..50d29d25 --- /dev/null +++ b/osage @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# osage + +> Render an image of a `clustered` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`osage -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`osage -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`osage -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | osage -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`osage -?` diff --git a/osmium b/osmium new file mode 100644 index 00000000..214f7be3 --- /dev/null +++ b/osmium @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# osmium + +> Multipurpose tool for handling OpenStreetMap (OSM) files. +> More information: . + +- Show file information: + +`osmium fileinfo {{path/to/input.osm}}` + +- Display contents: + +`osmium show {{path/to/input.osm}}` + +- Convert file format from PBF into XML: + +`osmium cat {{path/to/input.osm.pbf}} -o {{path/to/output.osm}}` + +- Extract a geographic region by the given [b]ounding box: + +`osmium extract -b {{min_longitude}},{{min_latitude}},{{max_longitude}},{{max_latitude}} {{path/to/input.pbf}} -o {{path/to/output.pbf}}` + +- Extract a geographic region by a GeoJSON file: + +`osmium extract -p {{path/to/polygon.geojson}} {{path/to/input.pbf}} -o {{path/to/output.pbf}}` + +- Filter all objects tagged as "restaurant": + +`osmium tags-filter {{path/to/input.pbf}} amenity=restaurant -o {{path/to/output.pbf}}` + +- Filter for "way" objects tagged as "highway": + +`osmium tags-filter {{path/to/input.pbf}} w/highway -o {{path/to/output.pbf}}` + +- Filter "way" and "relation" objects tagged as "building": + +`osmium tags-filter {{path/to/input.pbf}} wr/building -o {{path/to/output.pbf}}` diff --git a/osv-scanner b/osv-scanner new file mode 100644 index 00000000..4b342c9f --- /dev/null +++ b/osv-scanner @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# osv-scanner + +> Scan various mediums for dependencies and matches them against the OSV database. +> More information: . + +- Scan a docker image: + +`osv-scanner -D {{docker_image_name}}` + +- Scan a package lockfile: + +`osv-scanner -L {{path/to/lockfile}}` + +- Scan an SBOM file: + +`osv-scanner -S {{path/to/sbom_file}}` + +- Scan multiple directories recursively: + +`osv-scanner -r {{directory1 directory2 ...}}` + +- Skip scanning Git repositories: + +`osv-scanner --skip-git {{-r|-D}} {{target}}` + +- Output result in JSON format: + +`osv-scanner --json {{-D|-L|-S|-r}} {{target}}` diff --git a/osx/aa b/osx/aa new file mode 100644 index 00000000..ad74d7fe --- /dev/null +++ b/osx/aa @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# aa + +> This command is an alias of `yaa`. + +- View documentation for the original command: + +`tldr yaa` diff --git a/osx/afinfo b/osx/afinfo new file mode 100644 index 00000000..34c67e67 --- /dev/null +++ b/osx/afinfo @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# afinfo + +> Audio file metadata parser for OS X. +> Built-in command of OS X. +> More information: . + +- Display info of a given audio file: + +`afinfo {{path/to/file}}` + +- Print a one line description of the audio file: + +`afinfo --brief {{path/to/file}}` + +- Print metadata info and contents of the audio file's InfoDictionary: + +`afinfo --info {{path/to/file}}` + +- Print output in XML format: + +`afinfo --xml {{path/to/file}}` + +- Print warnings for the audio file if any: + +`afinfo --warnings {{path/to/file}}` + +- Display help: + +`afinfo --help` diff --git a/osx/afplay b/osx/afplay new file mode 100644 index 00000000..eee75602 --- /dev/null +++ b/osx/afplay @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# afplay + +> Command-line audio player. +> More information: . + +- Play a sound file (waits until playback ends): + +`afplay {{path/to/file}}` + +- Play a sound file at 2x speed (playback rate): + +`afplay --rate {{2}} {{path/to/file}}` + +- Play a sound file at half speed: + +`afplay --rate {{0.5}} {{path/to/file}}` + +- Play the first N seconds of a sound file: + +`afplay --time {{seconds}} {{path/to/file}}` diff --git a/osx/aiac b/osx/aiac new file mode 100644 index 00000000..6d740169 --- /dev/null +++ b/osx/aiac @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# aiac + +> Use OpenAI to generate IaC configurations, utilities, queries and more. +> More information: . + +- Generate Terraform for Azure storage account: + +`aiac get terraform {{for an azure storage account}}` + +- Generate a Dockerfile for nginx: + +`aiac get dockerfile {{for a secured nginx}}` + +- Generate GitHub action that applies Terraform: + +`aiac get github action {{that plans and applies terraform}}` + +- Generate a port scanner in Python: + +`aiac get python {{code that scans all open ports in my network}}` + +- Generate a MongoDB query: + +`aiac get mongo {{query that aggregates all documents by created date}}` diff --git a/osx/airport b/osx/airport new file mode 100644 index 00000000..83be77fa --- /dev/null +++ b/osx/airport @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# airport + +> Wireless network configuration utility. +> More information: . + +- Show current wireless status information: + +`airport --getinfo` + +- Sniff wireless traffic on channel 1: + +`airport sniff {{1}}` + +- Scan for available wireless networks: + +`airport --scan` + +- Disassociate from current airport network: + +`sudo airport --disassociate` diff --git a/osx/airportd b/osx/airportd new file mode 100644 index 00000000..9fdc10ec --- /dev/null +++ b/osx/airportd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# airportd + +> Manages wireless interfaces. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`airportd` diff --git a/osx/apachectl b/osx/apachectl new file mode 100644 index 00000000..8a84df57 --- /dev/null +++ b/osx/apachectl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# apachectl + +> Apache HTTP Server control interface for macOS. +> More information: . + +- Start the `org.apache.httpd` launchd job: + +`apachectl start` + +- Stop the launchd job: + +`apachectl stop` + +- Stop, then start launchd job: + +`apachectl restart` diff --git a/osx/applecamerad b/osx/applecamerad new file mode 100644 index 00000000..7f553913 --- /dev/null +++ b/osx/applecamerad @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# applecamerad + +> Camera manager. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`applecamerad` diff --git a/osx/appsleepd b/osx/appsleepd new file mode 100644 index 00000000..f04360c6 --- /dev/null +++ b/osx/appsleepd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# appsleepd + +> Provides app sleep services. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`appsleepd` diff --git a/osx/arch b/osx/arch new file mode 100644 index 00000000..46e2d58b --- /dev/null +++ b/osx/arch @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# arch + +> Display the name of the system architecture, or run a command under a different architecture. +> See also: `uname`. +> More information: . + +- Display the system's architecture: + +`arch` + +- Run a command using x86_64: + +`arch -x86_64 "{{command}}"` + +- Run a command using arm: + +`arch -arm64 "{{command}}"` diff --git a/osx/archey b/osx/archey new file mode 100644 index 00000000..cf069b87 --- /dev/null +++ b/osx/archey @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# archey + +> Simple tool for stylishly displaying system information. +> More information: . + +- Show system information: + +`archey` + +- Show system information without colored output: + +`archey --nocolor` + +- Show system information, using MacPorts instead of Homebrew: + +`archey --macports` + +- Show system information without IP address check: + +`archey --offline` diff --git a/osx/as b/osx/as new file mode 100644 index 00000000..647358d7 --- /dev/null +++ b/osx/as @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# as + +> Portable GNU assembler. +> Primarily intended to assemble output from `gcc` to be used by `ld`. +> More information: . + +- Assemble a file, writing the output to `a.out`: + +`as {{path/to/file.s}}` + +- Assemble the output to a given file: + +`as {{path/to/file.s}} -o {{path/to/output_file.o}}` + +- Generate output faster by skipping whitespace and comment preprocessing. (Should only be used for trusted compilers): + +`as -f {{path/to/file.s}}` + +- Include a given path to the list of directories to search for files specified in `.include` directives: + +`as -I {{path/to/directory}} {{path/to/file.s}}` diff --git a/osx/asr b/osx/asr new file mode 100644 index 00000000..4a5ccb18 --- /dev/null +++ b/osx/asr @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# asr + +> Restore (copy) a disk image onto a volume. +> The command name stands for Apple Software Restore. +> More information: . + +- Restore a disk image to a target volume: + +`sudo asr restore --source {{image_file.dmg}} --target {{path/to/volume_file}}` + +- Erase the target volume before restoring: + +`sudo asr restore --source {{image_file.dmg}} --target {{path/to/volume_file}} --erase` + +- Skip verification after restoring: + +`sudo asr restore --source {{image_file.dmg}} --target {{path/to/volume_file}} --noverify` + +- Clone volumes without using an intermediate disk image: + +`sudo asr restore --source {{path/to/volume_file}} --target {{path/to/volume_file}}` diff --git a/osx/autofsd b/osx/autofsd new file mode 100644 index 00000000..80da6730 --- /dev/null +++ b/osx/autofsd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# autofsd + +> Runs `automount` on startup and network configuration change events. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`autofsd` diff --git a/osx/automountd b/osx/automountd new file mode 100644 index 00000000..9395f0ce --- /dev/null +++ b/osx/automountd @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# automountd + +> An automatic mount/unmount daemon for `autofs`. Started on demand by `launchd`. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`automountd` + +- Log more details to `syslog`: + +`automountd -v` diff --git a/osx/auvaltool b/osx/auvaltool new file mode 100644 index 00000000..50ed39ef --- /dev/null +++ b/osx/auvaltool @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# auvaltool + +> AudioUnit validation tool for Mac. +> More information: . + +- List all [a]vailable AudioUnits of any type: + +`auvaltool -a` + +- List all [a]vailable AudioUnits of any type with their [l]ocation: + +`auvaltool -al` diff --git a/osx/avbdeviced b/osx/avbdeviced new file mode 100644 index 00000000..835cb573 --- /dev/null +++ b/osx/avbdeviced @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# avbdeviced + +> A service for managing Audio Video Bridging (AVB) devices. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`avbdeviced` diff --git a/osx/backupd b/osx/backupd new file mode 100644 index 00000000..b3189466 --- /dev/null +++ b/osx/backupd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# backupd + +> Creates Time Machine backups and manages its backup history. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`backupd` diff --git a/osx/base64 b/osx/base64 new file mode 100644 index 00000000..b84f7de2 --- /dev/null +++ b/osx/base64 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# base64 + +> Encode and decode using Base64 representation. +> More information: . + +- Encode a file: + +`base64 --input={{plain_file}}` + +- Decode a file: + +`base64 --decode --input={{base64_file}}` + +- Encode from `stdin`: + +`echo -n "{{plain_text}}" | base64` + +- Decode from `stdin`: + +`echo -n {{base64_text}} | base64 --decode` diff --git a/osx/bc b/osx/bc new file mode 100644 index 00000000..df1292cf --- /dev/null +++ b/osx/bc @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# bc + +> An arbitrary precision calculator language. +> See also: `dc`. +> More information: . + +- Start an interactive session: + +`bc` + +- Start an interactive session with the standard math library enabled: + +`bc --mathlib` + +- Calculate an expression: + +`bc --expression='{{5 / 3}}'` + +- Execute a script: + +`bc {{path/to/script.bc}}` + +- Calculate an expression with the specified scale: + +`bc --expression='scale = {{10}}; {{5 / 3}}'` + +- Calculate a sine/cosine/arctangent/natural logarithm/exponential function using `mathlib`: + +`bc --mathlib --expression='{{s|c|a|l|e}}({{1}})'` diff --git a/osx/biomesyncd b/osx/biomesyncd new file mode 100644 index 00000000..e525acb6 --- /dev/null +++ b/osx/biomesyncd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# biomesyncd + +> Synchronizes data between devices registered to the same account. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`biomesyncd` diff --git a/osx/biometrickitd b/osx/biometrickitd new file mode 100644 index 00000000..3b99b601 --- /dev/null +++ b/osx/biometrickitd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# biometrickitd + +> Provides support for biometric operations. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`biometrickitd` diff --git a/osx/bird b/osx/bird new file mode 100644 index 00000000..a90fb647 --- /dev/null +++ b/osx/bird @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# bird + +> This supports the syncing of iCloud and iCloud Drive. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`bird` diff --git a/osx/bless b/osx/bless new file mode 100644 index 00000000..0396f833 --- /dev/null +++ b/osx/bless @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# bless + +> Set volume boot capability and startup disk options. +> More information: . + +- Bless a volume with only Mac OS X or Darwin, and create the BootX and `boot.efi` files as needed: + +`bless --folder {{/Volumes/Mac OS X/System/Library/CoreServices}} --bootinfo --bootefi` + +- Set a volume containing either Mac OS 9 and Mac OS X to be the active volume: + +`bless --mount {{/Volumes/Mac OS}} --setBoot` + +- Set the system to NetBoot and broadcast for an available server: + +`bless --netboot --server {{bsdp://255.255.255.255}}` + +- Gather information about the currently selected volume (as determined by the firmware), suitable for piping to a program capable of parsing Property Lists: + +`bless --info --plist` diff --git a/osx/bnepd b/osx/bnepd new file mode 100644 index 00000000..bca8a570 --- /dev/null +++ b/osx/bnepd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# bnepd + +> A service that handles all Bluetooth network connections. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`bnepd` diff --git a/osx/brightness b/osx/brightness new file mode 100644 index 00000000..ccd9d164 --- /dev/null +++ b/osx/brightness @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# brightness + +> Get and set the brightness level of all internal and certain external displays. +> More information: . + +- Show current brightness: + +`brightness -l` + +- Set a specific brightness: + +`brightness {{0..1}}` + +- Set the brightness to 50%: + +`brightness {{0.5}}` diff --git a/osx/caffeinate b/osx/caffeinate new file mode 100644 index 00000000..99fda03c --- /dev/null +++ b/osx/caffeinate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# caffeinate + +> Prevent macOS from sleeping. +> More information: . + +- Prevent from sleeping for 1 hour (3600 seconds): + +`caffeinate -u -t {{3600}}` + +- Prevent from sleeping until a command completes: + +`caffeinate -s "{{command}}"` + +- Prevent from sleeping until a process with the specified PID completes: + +`caffeinate -w {{pid}}` + +- Prevent from sleeping (use `Ctrl + C` to exit): + +`caffeinate -i` + +- Prevent disk from sleeping (use `Ctrl + C` to exit): + +`caffeinate -m` diff --git a/osx/cal b/osx/cal new file mode 100644 index 00000000..79d99137 --- /dev/null +++ b/osx/cal @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cal + +> Prints calendar information. +> More information: . + +- Display a calendar for the current month: + +`cal` + +- Display previous, current and next month: + +`cal -3` + +- Display a calendar for a specific month (1-12 or name): + +`cal -m {{month}}` + +- Display a calendar for the current year: + +`cal -y` + +- Display a calendar for a specific year (4 digits): + +`cal {{year}}` + +- Display a calendar for a specific month and year: + +`cal {{month}} {{year}}` + +- Display date of Easter (Western Christian churches) in a given year: + +`ncal -e {{year}}` diff --git a/osx/carthage b/osx/carthage new file mode 100644 index 00000000..f7b63c0f --- /dev/null +++ b/osx/carthage @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# carthage + +> A dependency management tool for Cocoa applications. +> More information: . + +- Download the latest version of all dependencies mentioned in Cartfile, and build them: + +`carthage update` + +- Update dependencies, but only build for iOS: + +`carthage update --platform ios` + +- Update dependencies, but don't build any of them: + +`carthage update --no-build` + +- Download and rebuild the current version of dependencies (without updating them): + +`carthage bootstrap` + +- Rebuild a specific dependency: + +`carthage build {{dependency}}` diff --git a/osx/cat b/osx/cat new file mode 100644 index 00000000..bd24618d --- /dev/null +++ b/osx/cat @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cat + +> Print and concatenate files. +> More information: . + +- Print the contents of a file to `stdout`: + +`cat {{path/to/file}}` + +- Concatenate several files into an output file: + +`cat {{path/to/file1 path/to/file2 ...}} > {{path/to/output_file}}` + +- Append several files to an output file: + +`cat {{path/to/file1 path/to/file2 ...}} >> {{path/to/output_file}}` + +- Copy the contents of a file into an output file without buffering: + +`cat -u {{/dev/tty12}} > {{/dev/tty13}}` + +- Write `stdin` to a file: + +`cat - > {{path/to/file}}` + +- Number all output lines: + +`cat -n {{path/to/file}}` + +- Display non-printable and whitespace characters (with `M-` prefix if non-ASCII): + +`cat -v -t -e {{path/to/file}}` diff --git a/osx/cfprefsd b/osx/cfprefsd new file mode 100644 index 00000000..c05f6622 --- /dev/null +++ b/osx/cfprefsd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cfprefsd + +> Provides preferences services (`CFPreferences`, `NSUserDefaults`). +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`cfprefsd` diff --git a/osx/chflags b/osx/chflags new file mode 100644 index 00000000..57c07dd5 --- /dev/null +++ b/osx/chflags @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# chflags + +> Change file or directory flags. +> More information: . + +- Set the `hidden` flag for a file: + +`chflags {{hidden}} {{path/to/file}}` + +- Unset the `hidden` flag for a file: + +`chflags {{nohidden}} {{path/to/file}}` + +- Recursively set the `uchg` flag for a directory: + +`chflags -R {{uchg}} {{path/to/directory}}` + +- Recursively unset the `uchg` flag for a directory: + +`chflags -R {{nouchg}} {{path/to/directory}}` diff --git a/osx/chpass b/osx/chpass new file mode 100644 index 00000000..817a3d2d --- /dev/null +++ b/osx/chpass @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# chpass + +> Add or change user database information, including login shell and password. +> Note: it's not possible to change the user's password on Open Directory systems, use `passwd` instead. +> See also: `passwd`. +> More information: . + +- Add or change user database information for the current user interactively: + +`su -c chpass` + +- Set a specific login [s]hell for the current user: + +`chpass -s {{path/to/shell}}` + +- Set a login [s]hell for a specific user: + +`chpass -s {{path/to/shell}} {{username}}` + +- Edit the user record on the directory node at the given [l]ocation: + +`chpass -l {{location}} -s {{path/to/shell}} {{username}}` + +- Use the given [u]sername when authenticating to the directory node containing the user: + +`chpass -u {{authname}} -s {{path/to/shell}} {{username}}` diff --git a/osx/cloudd b/osx/cloudd new file mode 100644 index 00000000..ae85fdfc --- /dev/null +++ b/osx/cloudd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cloudd + +> Backs the CloudKit feature. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`cloudd` diff --git a/osx/cloudphotod b/osx/cloudphotod new file mode 100644 index 00000000..dd9417cc --- /dev/null +++ b/osx/cloudphotod @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cloudphotod + +> This synchronizes iCloud Photos. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`cloudphotod` diff --git a/osx/codesign b/osx/codesign new file mode 100644 index 00000000..7b0c4be6 --- /dev/null +++ b/osx/codesign @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# codesign + +> Create and manipulate code signatures for macOS. +> More information: . + +- Sign an application with a certificate: + +`codesign --sign "{{My Company Name}}" {{path/to/application_file.app}}` + +- Verify the certificate of an application: + +`codesign --verify {{path/to/application_file.app}}` diff --git a/osx/coreaudiod b/osx/coreaudiod new file mode 100644 index 00000000..2e6dd972 --- /dev/null +++ b/osx/coreaudiod @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# coreaudiod + +> Service for Core Audio, Apple's audio system. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`coreaudiod` diff --git a/osx/coreautha b/osx/coreautha new file mode 100644 index 00000000..2d5b0ffe --- /dev/null +++ b/osx/coreautha @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# coreautha + +> A system agent providing the `LocalAuthentication` framework. +> It should not be invoked manually. See also: `coreauthd`. +> More information: . + +- Start the agent: + +`coreautha` diff --git a/osx/coreauthd b/osx/coreauthd new file mode 100644 index 00000000..59027f06 --- /dev/null +++ b/osx/coreauthd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# coreauthd + +> A system daemon providing the `LocalAuthentication` framework. +> It should not be invoked manually. See also: `coreautha`. +> More information: . + +- Start the agent: + +`coreauthd` diff --git a/osx/corebrightnessd b/osx/corebrightnessd new file mode 100644 index 00000000..b1cc91e6 --- /dev/null +++ b/osx/corebrightnessd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# corebrightnessd + +> Manages Night Shift. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`corebrightnessd` diff --git a/osx/coredatad b/osx/coredatad new file mode 100644 index 00000000..a09b89df --- /dev/null +++ b/osx/coredatad @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# coredatad + +> Schedules CloudKit operations for clients of NSPersistentCloudKitContainer. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`coredatad` diff --git a/osx/cot b/osx/cot new file mode 100644 index 00000000..e4cefe5d --- /dev/null +++ b/osx/cot @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cot + +> The Plain-Text Editor for macOS. +> More information: . + +- Start CotEditor: + +`cot` + +- Open specific files: + +`cot {{path/to/file1 path/to/file2 ...}}` + +- Open a new blank document: + +`cot --new` + +- Open a specific file and block the terminal until it is closed: + +`cot --wait {{path/to/file}}` + +- Open a specific file with the cursor at a specific line and column: + +`cot --line {{1}} --column {{80}} {{path/to/file}}` diff --git a/osx/csrutil b/osx/csrutil new file mode 100644 index 00000000..d8ffb2fd --- /dev/null +++ b/osx/csrutil @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# csrutil + +> Manage the System Integrity Protection configuration. +> More information: . + +- Display the System Integrity Protection status: + +`csrutil status` + +- Disable the System Integrity Protection: + +`csrutil disable` + +- Enable the System Integrity Protection: + +`csrutil enable` + +- Display the list of allowed NetBoot sources: + +`csrutil netboot list` + +- Add an IPv4 address to the list of allowed NetBoot sources: + +`csrutil netboot add {{ip}}` + +- Reset the System Integrity Protection status and clear the NetBoot list: + +`csrutil clear` diff --git a/osx/csshx b/osx/csshx new file mode 100644 index 00000000..d1974ed6 --- /dev/null +++ b/osx/csshx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# csshX + +> Cluster SSH tool for macOS. +> More information: . + +- Connect to multiple hosts: + +`csshX {{hostname1}} {{hostname2}}` + +- Connect to multiple hosts with a given SSH key: + +`csshX {{user@hostname1}} {{user@hostname2}} --ssh_args "-i {{path/to/key_file.pem}}"` + +- Connect to a pre-defined cluster from `/etc/clusters`: + +`csshX cluster1` diff --git a/osx/ctkd b/osx/ctkd new file mode 100644 index 00000000..f8a87d7c --- /dev/null +++ b/osx/ctkd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ctkd + +> SmartCard daemon. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`ctkd` diff --git a/osx/cut b/osx/cut new file mode 100644 index 00000000..53e38e39 --- /dev/null +++ b/osx/cut @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# cut + +> Cut out fields from `stdin` or files. +> More information: . + +- Print a specific character/field range of each line: + +`{{command}} | cut -{{c|f}} {{1|1,10|1-10|1-|-10}}` + +- Print a field range of each line with a specific delimiter: + +`{{command}} | cut -d "{{,}}" -f {{1}}` + +- Print a character range of each line of a specific file: + +`cut -c {{1}} {{path/to/file}}` diff --git a/osx/dark-mode b/osx/dark-mode new file mode 100644 index 00000000..4bba876d --- /dev/null +++ b/osx/dark-mode @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dark-mode + +> Control macOS dark mode. +> More information: . + +- Toggle dark mode (turn it on if it's currently off, off if it's currently on): + +`dark-mode` + +- Turn dark mode on: + +`dark-mode on` + +- Turn dark mode off: + +`dark-mode off` + +- Check if dark mode is on: + +`dark-mode status` diff --git a/osx/date b/osx/date new file mode 100644 index 00000000..14d28441 --- /dev/null +++ b/osx/date @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# date + +> Set or display the system date. +> More information: . + +- Display the current date using the default locale's format: + +`date +%c` + +- Display the current date in UTC and ISO 8601 format: + +`date -u +%Y-%m-%dT%H:%M:%SZ` + +- Display the current date as a Unix timestamp (seconds since the Unix epoch): + +`date +%s` + +- Display a specific date (represented as a Unix timestamp) using the default format: + +`date -r 1473305798` diff --git a/osx/dd b/osx/dd new file mode 100644 index 00000000..0ba5c92c --- /dev/null +++ b/osx/dd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dd + +> Convert and copy a file. +> More information: . + +- Make a bootable USB drive from an isohybrid file (such like `archlinux-xxx.iso`) and show the progress: + +`dd if={{path/to/file.iso}} of={{/dev/usb_device}} status=progress` + +- Clone a drive to another drive with 4 MB block, ignore error and show the progress: + +`dd if={{/dev/source_device}} of={{/dev/dest_device}} bs={{4m}} conv={{noerror}} status=progress` + +- Generate a file of 100 random bytes by using kernel random driver: + +`dd if=/dev/urandom of={{path/to/random_file}} bs={{100}} count={{1}}` + +- Benchmark the write performance of a disk: + +`dd if=/dev/zero of={{path/to/1GB_file}} bs={{1024}} count={{1000000}}` + +- Generate a system backup into an IMG file and show the progress: + +`dd if=/dev/{{drive_device}} of={{path/to/file.img}} status=progress` + +- Restore a drive from an IMG file and show the progress: + +`dd if={{path/to/file.img}} of={{/dev/drive_device}} status=progress` + +- Check the progress of an ongoing dd operation (run this command from another shell): + +`kill -USR1 $(pgrep ^dd)` diff --git a/osx/defaults b/osx/defaults new file mode 100644 index 00000000..d418ef8e --- /dev/null +++ b/osx/defaults @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# defaults + +> Read and write macOS user configuration for applications. +> More information: . + +- Read system defaults for an application option: + +`defaults read "{{application}}" "{{option}}"` + +- Read default values for an application option: + +`defaults read -app "{{application}}" "{{option}}"` + +- Search for a keyword in domain names, keys, and values: + +`defaults find "{{keyword}}"` + +- Write the default value of an application option: + +`defaults write "{{application}}" "{{option}}" {{-type}} {{value}}` + +- Speed up Mission Control animations: + +`defaults write com.apple.Dock expose-animation-duration -float 0.1` + +- Delete all defaults of an application: + +`defaults delete "{{application}}"` diff --git a/osx/deleted b/osx/deleted new file mode 100644 index 00000000..3bdaefb4 --- /dev/null +++ b/osx/deleted @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# deleted + +> Keeps track of purgeable space and asks clients to purge when space is low. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`deleted` diff --git a/osx/df b/osx/df new file mode 100644 index 00000000..54afebec --- /dev/null +++ b/osx/df @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# df + +> Display an overview of the filesystem disk space usage. +> More information: . + +- Display all filesystems and their disk usage using 512-byte units: + +`df` + +- Use [h]uman-readable units (based on powers of 1024) and display a grand total: + +`df -h -c` + +- Use [H]uman-readable units (based on powers of 1000): + +`df -{{-si|H}}` + +- Display the filesystem and its disk usage containing the given file or directory: + +`df {{path/to/file_or_directory}}` + +- Include statistics on the number of free and used [i]nodes including the filesystem t[Y]pes: + +`df -iY` + +- Use 1024-byte units when writing space figures: + +`df -k` + +- Display information in a [P]ortable way: + +`df -P` diff --git a/osx/dhcp6d b/osx/dhcp6d new file mode 100644 index 00000000..f10c0416 --- /dev/null +++ b/osx/dhcp6d @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dhcp6d + +> Stateless DHCPv6 server. See also: `InternetSharing`. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`dhcp6d` + +- Use a custom configuration: + +`dhcp6d {{path/to/config_file}}` diff --git a/osx/diskutil b/osx/diskutil new file mode 100644 index 00000000..1cda650f --- /dev/null +++ b/osx/diskutil @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# diskutil + +> Utility to manage local disks and volumes. +> More information: . + +- List all currently available disks, partitions and mounted volumes: + +`diskutil list` + +- Repair the filesystem data structures of a volume: + +`diskutil repairVolume {{/dev/disk_device}}` + +- Unmount a volume: + +`diskutil unmountDisk {{/dev/disk_device}}` + +- Eject a CD/DVD (unmount first): + +`diskutil eject {{/dev/disk_device1}}` diff --git a/osx/distnoted b/osx/distnoted new file mode 100644 index 00000000..59cf7aaf --- /dev/null +++ b/osx/distnoted @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# distnoted + +> Provides distributed notification services. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`distnoted` diff --git a/osx/ditto b/osx/ditto new file mode 100644 index 00000000..0a738e15 --- /dev/null +++ b/osx/ditto @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ditto + +> Copy files and directories. +> More information: . + +- Overwrite contents of destination directory with contents of source directory: + +`ditto {{path/to/source_directory}} {{path/to/destination_directory}}` + +- Print a line to the Terminal window for every file that's being copied: + +`ditto -V {{path/to/source_directory}} {{path/to/destination_directory}}` + +- Copy a given file or directory, while retaining the original file permissions: + +`ditto -rsrc {{path/to/source_directory}} {{path/to/destination_directory}}` diff --git a/osx/dmesg b/osx/dmesg new file mode 100644 index 00000000..263ac66a --- /dev/null +++ b/osx/dmesg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dmesg + +> Write the kernel messages to `stdout`. +> More information: . + +- Show kernel messages: + +`dmesg` + +- Show how much physical memory is available on this system: + +`dmesg | grep -i memory` + +- Show kernel messages 1 page at a time: + +`dmesg | less` diff --git a/osx/dockutil b/osx/dockutil new file mode 100644 index 00000000..2496627a --- /dev/null +++ b/osx/dockutil @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dockutil + +> Manage macOS dock items. +> More information: . + +- Add an application to the end of the current user's dock: + +`dockutil --add {{path/to/application}}` + +- Replace one application with another in the current user's dock: + +`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}}` + +- Add a URL dock item after another item: + +`dockutil --add {{vnc://example_server.local}} --label '{{Example VNC}}' --after {{dock_item_label}}` + +- Remove an application from the dock given its dock label name: + +`dockutil --remove '{{dock_item_label}}'` + +- Add a spacer in a section after an application: + +`dockutil --add '' --type {{spacer|small-spacer|flex-spacer}} --section {{apps}} --after {{dock_item_label}}` + +- Remove all spacer tiles: + +`dockutil --remove spacer-tiles` diff --git a/osx/dot_clean b/osx/dot_clean new file mode 100644 index 00000000..0ec1275e --- /dev/null +++ b/osx/dot_clean @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dot_clean + +> Merge ._* files with corresponding native files. +> More information: . + +- Merge all `._*` files recursively: + +`dot_clean {{path/to/directory}}` + +- Don't recursively merge all `._*` in a directory (flat merge): + +`dot_clean -f {{path/to/directory}}` + +- Merge and delete all `._*` files: + +`dot_clean -m {{path/to/directory}}` + +- Only delete `._*` files if there's a matching native file: + +`dot_clean -n {{path/to/directory}}` + +- Follow symlinks: + +`dot_clean -s {{path/to/directory}}` + +- Print verbose output: + +`dot_clean -v {{path/to/directory}}` diff --git a/osx/drutil b/osx/drutil new file mode 100644 index 00000000..1a0a5e02 --- /dev/null +++ b/osx/drutil @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# drutil + +> Interact with DVD burners. +> More information: . + +- Eject a disk from the drive: + +`drutil eject` + +- Burn a directory as an ISO9660 filesystem onto a DVD. Don't verify and eject when complete: + +`drutil burn -noverify -eject -iso9660` diff --git a/osx/dtrace b/osx/dtrace new file mode 100644 index 00000000..f7f603e3 --- /dev/null +++ b/osx/dtrace @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# dtrace + +> A simple interface to invoke the D language compiler, retrieve buffered trace, and print traced data from the DTrace kernel facility. +> Generic front-end to DTrace facility, requiring root privileges. +> More information: . + +- Set target data model for a specific architecture: + +`dtrace -arch {{arch_name}}` + +- Claim [a]nonymous tracing state and display the traced data: + +`dtrace -a` + +- Set principal trace buffer size. Supported units are `k`, `m`, `g`, or `t`: + +`dtrace -b {{2g}}` + +- Compile the specified D Program [s]ource file: + +`dtrace -s {{D_script}}` + +- Run the specified [c]ommand and exit upon its completion: + +`dtrace -c {{command}}` + +- Specify [f]unction name to trace or list (-l option). The corresponding argument can include any of the probe description forms like `provider:module:function`, `module:function` or `function`: + +`dtrace -f {{function}}` + +- Grad the specified [p]rocess ID, cache its symbol table, and exit upon completion: + +`dtrace -p {{pid}}` + +- Combine different options for tracing function in a process: + +`dtrace -a -b {{buffer_size}} -f {{function}} -p {{pid}}` diff --git a/osx/du b/osx/du new file mode 100644 index 00000000..bc0197b0 --- /dev/null +++ b/osx/du @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# du + +> Disk usage: estimate and summarize file and directory space usage. +> More information: . + +- List the sizes of a directory and any subdirectories, in the given unit (KiB/MiB/GiB): + +`du -{{k|m|g}} {{path/to/directory}}` + +- List the sizes of a directory and any subdirectories, in human-readable form (i.e. auto-selecting the appropriate unit for each size): + +`du -h {{path/to/directory}}` + +- Show the size of a single directory, in human-readable units: + +`du -sh {{path/to/directory}}` + +- List the human-readable sizes of a directory and of all the files and directories within it: + +`du -ah {{path/to/directory}}` + +- List the human-readable sizes of a directory and any subdirectories, up to N levels deep: + +`du -h -d {{2}} {{path/to/directory}}` + +- List the human-readable size of all `.jpg` files in subdirectories of the current directory, and show a cumulative total at the end: + +`du -ch {{*/*.jpg}}` diff --git a/osx/duti b/osx/duti new file mode 100644 index 00000000..a9f8f6e2 --- /dev/null +++ b/osx/duti @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# duti + +> Set default applications for document types and URL schemes on macOS. +> More information: . + +- Set Safari as the default handler for HTML documents: + +`duti -s {{com.apple.Safari}} {{public.html}} all` + +- Set VLC as the default viewer for files with `.m4v` extensions: + +`duti -s {{org.videolan.vlc}} {{m4v}} viewer` + +- Set Finder as the default handler for the ftp:// URL scheme: + +`duti -s {{com.apple.Finder}} "{{ftp}}"` + +- Display information about the default application for a given extension: + +`duti -x {{ext}}` + +- Display the default handler for a given UTI: + +`duti -d {{uti}}` + +- Display all handlers of a given UTI: + +`duti -l {{uti}}` diff --git a/osx/ed b/osx/ed new file mode 100644 index 00000000..95479a1e --- /dev/null +++ b/osx/ed @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ed + +> The original Unix text editor. +> See also: `awk`, `sed`. +> More information: . + +- Start an interactive editor session with an empty document: + +`ed` + +- Start an interactive editor session with an empty document and a specific [p]rompt: + +`ed -p '> '` + +- Start an interactive editor session with an empty document and without diagnostics, byte counts and '!' prompt: + +`ed -s` + +- Edit a specific file (this shows the byte count of the loaded file): + +`ed {{path/to/file}}` + +- Replace a string with a specific replacement for all lines: + +`,s/{{regular_expression}}/{{replacement}}/g` diff --git a/osx/emond b/osx/emond new file mode 100644 index 00000000..4327fd2f --- /dev/null +++ b/osx/emond @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# emond + +> Event Monitor service that accepts events from various services, runs them through a simple rules engine, and takes action. +> The actions can run commands, send email, or SMS messages. +> More information: . + +- Start the daemon: + +`emond` + +- Specify rules for emond to process by giving a path to a file or directory: + +`emond -r {{path/to/file_or_directory}}` + +- Use a specific configuration file: + +`emond -c {{path/to/config_file}}` diff --git a/osx/fdesetup b/osx/fdesetup new file mode 100644 index 00000000..172cc53a --- /dev/null +++ b/osx/fdesetup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# fdesetup + +> Set and retrieve FileVault related information. +> More information: . + +- List current FileVault enabled users: + +`sudo fdesetup list` + +- Get current FileVault status: + +`fdesetup status` + +- Add FileVault enabled user: + +`sudo fdesetup add -usertoadd {{user1}}` + +- Enable FileVault: + +`sudo fdesetup enable` + +- Disable FileVault: + +`sudo fdesetup disable` diff --git a/osx/filecoordinationd b/osx/filecoordinationd new file mode 100644 index 00000000..04e03bd2 --- /dev/null +++ b/osx/filecoordinationd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# filecoordinationd + +> Coordinates access to files by multiple processes (`NSFileCoordinator`, `NSFilePresenter`). +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`filecoordinationd` diff --git a/osx/fileicon b/osx/fileicon new file mode 100644 index 00000000..1dca87c8 --- /dev/null +++ b/osx/fileicon @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# fileicon + +> Manage custom file and folder icons. +> More information: . + +- Set a custom icon for a specific file or directory: + +`fileicon set {{path/to/file_or_directory}} {{path/to/icon_file.png}}` + +- Remove a custom icon from a specific file or directory: + +`fileicon rm {{path/to/file_or_directory}}` + +- Save the custom icon of a file or directory as a `.icns` file into the current directory: + +`fileicon get {{path/to/file_or_directory}}` + +- Test if a specific file or directory has a custom icon: + +`fileicon test {{path/to/file_or_directory}}` diff --git a/osx/fontd b/osx/fontd new file mode 100644 index 00000000..b8244228 --- /dev/null +++ b/osx/fontd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# fontd + +> Makes fonts available to the system. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`fontd` diff --git a/osx/fsck b/osx/fsck new file mode 100644 index 00000000..08516df6 --- /dev/null +++ b/osx/fsck @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# fsck + +> Check the integrity of a filesystem or repair it. The filesystem should be unmounted at the time the command is run. +> It is a wrapper that calls `fsck_hfs`, `fsck_apfs`, `fsck_msdos`, `fsck_exfat`, and `fsck_udf` as needed. +> More information: . + +- Check filesystem `/dev/sdX`, reporting any damaged blocks: + +`fsck {{/dev/sdX}}` + +- Check filesystem `/dev/sdX` only if it is clean, reporting any damaged blocks and interactively letting the user choose to repair each one: + +`fsck -f {{/dev/sdX}}` + +- Check filesystem `/dev/sdX` only if it is clean, reporting any damaged blocks and automatically repairing them: + +`fsck -fy {{/dev/sdX}}` + +- Check filesystem `/dev/sdX`, reporting whether it has been cleanly unmounted: + +`fsck -q {{/dev/sdX}}` diff --git a/osx/ftxdiff b/osx/ftxdiff new file mode 100644 index 00000000..7a99eb47 --- /dev/null +++ b/osx/ftxdiff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ftxdiff + +> Compare differences between two fonts. +> More information: . + +- Output differences to a specific text file: + +`ftxdiff --output {{path/to/fontdiff_file.txt}} {{path/to/font_file1.ttc}} {{path/to/font_file2.ttc}}` + +- Include glyph names in output: + +`ftxdiff --include-glyph-names` + +- Include unicode names in output: + +`ftxdiff --include-unicode-names` diff --git a/osx/g[ b/osx/g[ new file mode 100644 index 00000000..dd806c6a --- /dev/null +++ b/osx/g[ @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# g[ + +> This command is an alias of GNU `[`. + +- View documentation for the original command: + +`tldr -p linux [` diff --git a/osx/gawk b/osx/gawk new file mode 100644 index 00000000..9b64f31f --- /dev/null +++ b/osx/gawk @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gawk + +> This command is an alias of GNU `awk`. + +- View documentation for the original command: + +`tldr -p linux awk` diff --git a/osx/gb2sum b/osx/gb2sum new file mode 100644 index 00000000..5a96ef8f --- /dev/null +++ b/osx/gb2sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gb2sum + +> This command is an alias of GNU `b2sum`. + +- View documentation for the original command: + +`tldr -p linux b2sum` diff --git a/osx/gbase32 b/osx/gbase32 new file mode 100644 index 00000000..b6d43360 --- /dev/null +++ b/osx/gbase32 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gbase32 + +> This command is an alias of GNU `base32`. + +- View documentation for the original command: + +`tldr -p linux base32` diff --git a/osx/gbase64 b/osx/gbase64 new file mode 100644 index 00000000..ac98dcd5 --- /dev/null +++ b/osx/gbase64 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gbase64 + +> This command is an alias of GNU `base64`. + +- View documentation for the original command: + +`tldr -p linux base64` diff --git a/osx/gbasename b/osx/gbasename new file mode 100644 index 00000000..d194b37d --- /dev/null +++ b/osx/gbasename @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gbasename + +> This command is an alias of GNU `basename`. + +- View documentation for the original command: + +`tldr -p linux basename` diff --git a/osx/gbasenc b/osx/gbasenc new file mode 100644 index 00000000..18b34f02 --- /dev/null +++ b/osx/gbasenc @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gbasenc + +> This command is an alias of GNU `basenc`. + +- View documentation for the original command: + +`tldr -p linux basenc` diff --git a/osx/gcat b/osx/gcat new file mode 100644 index 00000000..e91c1bfe --- /dev/null +++ b/osx/gcat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcat + +> This command is an alias of GNU `cat`. + +- View documentation for the original command: + +`tldr -p linux cat` diff --git a/osx/gchcon b/osx/gchcon new file mode 100644 index 00000000..d9cbbb57 --- /dev/null +++ b/osx/gchcon @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gchcon + +> This command is an alias of GNU `chcon`. + +- View documentation for the original command: + +`tldr -p linux chcon` diff --git a/osx/gchgrp b/osx/gchgrp new file mode 100644 index 00000000..4714e661 --- /dev/null +++ b/osx/gchgrp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gchgrp + +> This command is an alias of GNU `chgrp`. + +- View documentation for the original command: + +`tldr -p linux chgrp` diff --git a/osx/gchmod b/osx/gchmod new file mode 100644 index 00000000..0f685853 --- /dev/null +++ b/osx/gchmod @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gchmod + +> This command is an alias of GNU `chmod`. + +- View documentation for the original command: + +`tldr -p linux chmod` diff --git a/osx/gchown b/osx/gchown new file mode 100644 index 00000000..24fbd0b0 --- /dev/null +++ b/osx/gchown @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gchown + +> This command is an alias of GNU `chown`. + +- View documentation for the original command: + +`tldr -p linux chown` diff --git a/osx/gchroot b/osx/gchroot new file mode 100644 index 00000000..c02c1dba --- /dev/null +++ b/osx/gchroot @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gchroot + +> This command is an alias of GNU `chroot`. + +- View documentation for the original command: + +`tldr -p linux chroot` diff --git a/osx/gcksum b/osx/gcksum new file mode 100644 index 00000000..7a436438 --- /dev/null +++ b/osx/gcksum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcksum + +> This command is an alias of GNU `cksum`. + +- View documentation for the original command: + +`tldr -p linux cksum` diff --git a/osx/gcomm b/osx/gcomm new file mode 100644 index 00000000..24bf5647 --- /dev/null +++ b/osx/gcomm @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcomm + +> This command is an alias of GNU `comm`. + +- View documentation for the original command: + +`tldr -p linux comm` diff --git a/osx/gcp b/osx/gcp new file mode 100644 index 00000000..b2ed11e4 --- /dev/null +++ b/osx/gcp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcp + +> This command is an alias of GNU `cp`. + +- View documentation for the original command: + +`tldr -p linux cp` diff --git a/osx/gcsplit b/osx/gcsplit new file mode 100644 index 00000000..24a1c8b0 --- /dev/null +++ b/osx/gcsplit @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcsplit + +> This command is an alias of GNU `csplit`. + +- View documentation for the original command: + +`tldr -p linux csplit` diff --git a/osx/gcut b/osx/gcut new file mode 100644 index 00000000..6f8277f0 --- /dev/null +++ b/osx/gcut @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcut + +> This command is an alias of GNU `cut`. + +- View documentation for the original command: + +`tldr -p linux cut` diff --git a/osx/gdate b/osx/gdate new file mode 100644 index 00000000..1524504f --- /dev/null +++ b/osx/gdate @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdate + +> This command is an alias of GNU `date`. + +- View documentation for the original command: + +`tldr -p linux date` diff --git a/osx/gdd b/osx/gdd new file mode 100644 index 00000000..88c1d75f --- /dev/null +++ b/osx/gdd @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdd + +> This command is an alias of GNU `dd`. + +- View documentation for the original command: + +`tldr -p linux dd` diff --git a/osx/gdf b/osx/gdf new file mode 100644 index 00000000..203c6ed0 --- /dev/null +++ b/osx/gdf @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdf + +> This command is an alias of GNU `df`. + +- View documentation for the original command: + +`tldr -p linux df` diff --git a/osx/gdir b/osx/gdir new file mode 100644 index 00000000..37655c55 --- /dev/null +++ b/osx/gdir @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdir + +> This command is an alias of GNU `dir`. + +- View documentation for the original command: + +`tldr -p linux dir` diff --git a/osx/gdircolors b/osx/gdircolors new file mode 100644 index 00000000..a6411ddd --- /dev/null +++ b/osx/gdircolors @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdircolors + +> This command is an alias of GNU `dircolors`. + +- View documentation for the original command: + +`tldr -p linux dircolors` diff --git a/osx/gdirname b/osx/gdirname new file mode 100644 index 00000000..a1110b88 --- /dev/null +++ b/osx/gdirname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdirname + +> This command is an alias of GNU `dirname`. + +- View documentation for the original command: + +`tldr -p linux dirname` diff --git a/osx/gdnsdomainname b/osx/gdnsdomainname new file mode 100644 index 00000000..e22c7bed --- /dev/null +++ b/osx/gdnsdomainname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gdnsdomainname + +> This command is an alias of GNU `dnsdomainname`. + +- View documentation for the original command: + +`tldr -p linux dnsdomainname` diff --git a/osx/gecho b/osx/gecho new file mode 100644 index 00000000..17acbe64 --- /dev/null +++ b/osx/gecho @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gecho + +> This command is an alias of GNU `echo`. + +- View documentation for the original command: + +`tldr -p linux echo` diff --git a/osx/ged b/osx/ged new file mode 100644 index 00000000..3848df91 --- /dev/null +++ b/osx/ged @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ged + +> This command is an alias of GNU `ed`. + +- View documentation for the original command: + +`tldr -p linux ed` diff --git a/osx/gegrep b/osx/gegrep new file mode 100644 index 00000000..7d03e51d --- /dev/null +++ b/osx/gegrep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gegrep + +> This command is an alias of GNU `egrep`. + +- View documentation for the original command: + +`tldr -p linux egrep` diff --git a/osx/genv b/osx/genv new file mode 100644 index 00000000..b0c7e17d --- /dev/null +++ b/osx/genv @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# genv + +> This command is an alias of GNU `env`. + +- View documentation for the original command: + +`tldr -p linux env` diff --git a/osx/getfileinfo b/osx/getfileinfo new file mode 100644 index 00000000..4b0bc5d7 --- /dev/null +++ b/osx/getfileinfo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# GetFileInfo + +> Get information about a file in an HFS+ directory. +> More information: . + +- Display information about a given file: + +`GetFileInfo {{path/to/file}}` + +- Display the [d]ate and time a given file was created: + +`GetFileInfo -d {{path/to/file}}` + +- Display the date and time a given file was last [m]odified: + +`GetFileInfo -m {{path/to/file}}` + +- Display the [c]reator of a given file: + +`GetFileInfo -c {{path/to/file}}` diff --git a/osx/gexpand b/osx/gexpand new file mode 100644 index 00000000..fe5db039 --- /dev/null +++ b/osx/gexpand @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gexpand + +> This command is an alias of GNU `expand`. + +- View documentation for the original command: + +`tldr -p linux expand` diff --git a/osx/gexpr b/osx/gexpr new file mode 100644 index 00000000..e912af21 --- /dev/null +++ b/osx/gexpr @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gexpr + +> This command is an alias of GNU `expr`. + +- View documentation for the original command: + +`tldr -p linux expr` diff --git a/osx/gfactor b/osx/gfactor new file mode 100644 index 00000000..cb0454ff --- /dev/null +++ b/osx/gfactor @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfactor + +> This command is an alias of GNU `factor`. + +- View documentation for the original command: + +`tldr -p linux factor` diff --git a/osx/gfalse b/osx/gfalse new file mode 100644 index 00000000..5cccd3df --- /dev/null +++ b/osx/gfalse @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfalse + +> This command is an alias of GNU `false`. + +- View documentation for the original command: + +`tldr -p linux false` diff --git a/osx/gfgrep b/osx/gfgrep new file mode 100644 index 00000000..78d79920 --- /dev/null +++ b/osx/gfgrep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfgrep + +> This command is an alias of GNU `fgrep`. + +- View documentation for the original command: + +`tldr -p linux fgrep` diff --git a/osx/gfind b/osx/gfind new file mode 100644 index 00000000..e5357264 --- /dev/null +++ b/osx/gfind @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfind + +> This command is an alias of GNU `find`. + +- View documentation for the original command: + +`tldr -p linux find` diff --git a/osx/gfmt b/osx/gfmt new file mode 100644 index 00000000..83fb773c --- /dev/null +++ b/osx/gfmt @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfmt + +> This command is an alias of GNU `fmt`. + +- View documentation for the original command: + +`tldr -p linux fmt` diff --git a/osx/gfold b/osx/gfold new file mode 100644 index 00000000..91e8cace --- /dev/null +++ b/osx/gfold @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gfold + +> This command is an alias of GNU `fold`. + +- View documentation for the original command: + +`tldr -p linux fold` diff --git a/osx/gftp b/osx/gftp new file mode 100644 index 00000000..85ce43df --- /dev/null +++ b/osx/gftp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gftp + +> This command is an alias of GNU `ftp`. + +- View documentation for the original command: + +`tldr -p linux ftp` diff --git a/osx/ggrep b/osx/ggrep new file mode 100644 index 00000000..c862a4de --- /dev/null +++ b/osx/ggrep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ggrep + +> This command is an alias of GNU `grep`. + +- View documentation for the original command: + +`tldr -p linux grep` diff --git a/osx/ggroups b/osx/ggroups new file mode 100644 index 00000000..c02a3bb8 --- /dev/null +++ b/osx/ggroups @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ggroups + +> This command is an alias of GNU `groups`. + +- View documentation for the original command: + +`tldr -p linux groups` diff --git a/osx/ghead b/osx/ghead new file mode 100644 index 00000000..d9fd88c3 --- /dev/null +++ b/osx/ghead @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ghead + +> This command is an alias of GNU `head`. + +- View documentation for the original command: + +`tldr -p linux head` diff --git a/osx/ghostid b/osx/ghostid new file mode 100644 index 00000000..d82a5d58 --- /dev/null +++ b/osx/ghostid @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ghostid + +> This command is an alias of GNU `hostid`. + +- View documentation for the original command: + +`tldr -p linux hostid` diff --git a/osx/ghostname b/osx/ghostname new file mode 100644 index 00000000..e6785c98 --- /dev/null +++ b/osx/ghostname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ghostname + +> This command is an alias of GNU `hostname`. + +- View documentation for the original command: + +`tldr -p linux hostname` diff --git a/osx/gid b/osx/gid new file mode 100644 index 00000000..4d4369e3 --- /dev/null +++ b/osx/gid @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gid + +> This command is an alias of GNU `id`. + +- View documentation for the original command: + +`tldr -p linux id` diff --git a/osx/gifconfig b/osx/gifconfig new file mode 100644 index 00000000..d3500f14 --- /dev/null +++ b/osx/gifconfig @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gifconfig + +> This command is an alias of GNU `ifconfig`. + +- View documentation for the original command: + +`tldr -p linux ifconfig` diff --git a/osx/gindent b/osx/gindent new file mode 100644 index 00000000..a872e1c2 --- /dev/null +++ b/osx/gindent @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gindent + +> This command is an alias of GNU `indent`. + +- View documentation for the original command: + +`tldr -p linux indent` diff --git a/osx/ginstall b/osx/ginstall new file mode 100644 index 00000000..0817da18 --- /dev/null +++ b/osx/ginstall @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ginstall + +> This command is an alias of GNU `install`. + +- View documentation for the original command: + +`tldr -p linux install` diff --git a/osx/gjoin b/osx/gjoin new file mode 100644 index 00000000..94566669 --- /dev/null +++ b/osx/gjoin @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gjoin + +> This command is an alias of GNU `join`. + +- View documentation for the original command: + +`tldr -p linux join` diff --git a/osx/gkill b/osx/gkill new file mode 100644 index 00000000..ec914251 --- /dev/null +++ b/osx/gkill @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gkill + +> This command is an alias of GNU `kill`. + +- View documentation for the original command: + +`tldr -p linux kill` diff --git a/osx/glibtool b/osx/glibtool new file mode 100644 index 00000000..2c9f8b79 --- /dev/null +++ b/osx/glibtool @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glibtool + +> This command is an alias of GNU `libtool`. + +- View documentation for the original command: + +`tldr -p linux libtool` diff --git a/osx/glibtoolize b/osx/glibtoolize new file mode 100644 index 00000000..b227ef34 --- /dev/null +++ b/osx/glibtoolize @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glibtoolize + +> This command is an alias of GNU `libtoolize`. + +- View documentation for the original command: + +`tldr -p linux libtoolize` diff --git a/osx/glink b/osx/glink new file mode 100644 index 00000000..a565a3ba --- /dev/null +++ b/osx/glink @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glink + +> This command is an alias of GNU `link`. + +- View documentation for the original command: + +`tldr -p linux link` diff --git a/osx/gln b/osx/gln new file mode 100644 index 00000000..01b6d84c --- /dev/null +++ b/osx/gln @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gln + +> This command is an alias of GNU `ln`. + +- View documentation for the original command: + +`tldr -p linux ln` diff --git a/osx/glocate b/osx/glocate new file mode 100644 index 00000000..0dc0bf70 --- /dev/null +++ b/osx/glocate @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glocate + +> This command is an alias of GNU `locate`. + +- View documentation for the original command: + +`tldr -p linux locate` diff --git a/osx/glogger b/osx/glogger new file mode 100644 index 00000000..96687941 --- /dev/null +++ b/osx/glogger @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glogger + +> This command is an alias of GNU `logger`. + +- View documentation for the original command: + +`tldr -p linux logger` diff --git a/osx/glogname b/osx/glogname new file mode 100644 index 00000000..74667f20 --- /dev/null +++ b/osx/glogname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# glogname + +> This command is an alias of GNU `logname`. + +- View documentation for the original command: + +`tldr -p linux logname` diff --git a/osx/gls b/osx/gls new file mode 100644 index 00000000..66ae29d1 --- /dev/null +++ b/osx/gls @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gls + +> This command is an alias of GNU `ls`. + +- View documentation for the original command: + +`tldr -p linux ls` diff --git a/osx/gmake b/osx/gmake new file mode 100644 index 00000000..34d9b27b --- /dev/null +++ b/osx/gmake @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmake + +> This command is an alias of GNU `make`. + +- View documentation for the original command: + +`tldr -p linux make` diff --git a/osx/gmd5sum b/osx/gmd5sum new file mode 100644 index 00000000..968b8488 --- /dev/null +++ b/osx/gmd5sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmd5sum + +> This command is an alias of GNU `md5sum`. + +- View documentation for the original command: + +`tldr -p linux md5sum` diff --git a/osx/gmkdir b/osx/gmkdir new file mode 100644 index 00000000..02e93de4 --- /dev/null +++ b/osx/gmkdir @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmkdir + +> This command is an alias of GNU `mkdir`. + +- View documentation for the original command: + +`tldr -p linux mkdir` diff --git a/osx/gmkfifo b/osx/gmkfifo new file mode 100644 index 00000000..5aad8d6f --- /dev/null +++ b/osx/gmkfifo @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmkfifo + +> This command is an alias of GNU `mkfifo`. + +- View documentation for the original command: + +`tldr -p linux mkfifo` diff --git a/osx/gmknod b/osx/gmknod new file mode 100644 index 00000000..bfdf163f --- /dev/null +++ b/osx/gmknod @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmknod + +> This command is an alias of GNU `mknod`. + +- View documentation for the original command: + +`tldr -p linux mknod` diff --git a/osx/gmktemp b/osx/gmktemp new file mode 100644 index 00000000..46e5b0ff --- /dev/null +++ b/osx/gmktemp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmktemp + +> This command is an alias of GNU `mktemp`. + +- View documentation for the original command: + +`tldr -p linux mktemp` diff --git a/osx/gmv b/osx/gmv new file mode 100644 index 00000000..ebb43180 --- /dev/null +++ b/osx/gmv @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gmv + +> This command is an alias of GNU `mv`. + +- View documentation for the original command: + +`tldr -p linux mv` diff --git a/osx/gnice b/osx/gnice new file mode 100644 index 00000000..b661f98a --- /dev/null +++ b/osx/gnice @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gnice + +> This command is an alias of GNU `nice`. + +- View documentation for the original command: + +`tldr -p linux nice` diff --git a/osx/gnl b/osx/gnl new file mode 100644 index 00000000..36377e50 --- /dev/null +++ b/osx/gnl @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gnl + +> This command is an alias of GNU `nl`. + +- View documentation for the original command: + +`tldr -p linux nl` diff --git a/osx/gnohup b/osx/gnohup new file mode 100644 index 00000000..740d3003 --- /dev/null +++ b/osx/gnohup @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gnohup + +> This command is an alias of GNU `nohup`. + +- View documentation for the original command: + +`tldr -p linux nohup` diff --git a/osx/gnproc b/osx/gnproc new file mode 100644 index 00000000..db7ad1c3 --- /dev/null +++ b/osx/gnproc @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gnproc + +> This command is an alias of GNU `nproc`. + +- View documentation for the original command: + +`tldr -p linux nproc` diff --git a/osx/gnumfmt b/osx/gnumfmt new file mode 100644 index 00000000..b9e01553 --- /dev/null +++ b/osx/gnumfmt @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gnumfmt + +> This command is an alias of GNU `numfmt`. + +- View documentation for the original command: + +`tldr -p linux numfmt` diff --git a/osx/god b/osx/god new file mode 100644 index 00000000..c9a5d5b4 --- /dev/null +++ b/osx/god @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# god + +> This command is an alias of GNU `od`. + +- View documentation for the original command: + +`tldr -p linux od` diff --git a/osx/goku b/osx/goku new file mode 100644 index 00000000..a41dc217 --- /dev/null +++ b/osx/goku @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# goku + +> Manage Karabiner configuration. +> More information: . + +- Generate `karabiner.json` using the default configuration: + +`goku` + +- Generate `karabiner.json` using the specific `config.edn` file: + +`goku --config {{path/to/config.edn}}` + +- Dry run the new configuration into `stdout` instead of updating `karabiner.json`: + +`goku --dry-run` + +- Dry run the whole configuration into `stdout` instead of updating `karabiner.json`: + +`goku --dry-run-all` + +- Display help: + +`goku --help` + +- Display version: + +`goku --version` diff --git a/osx/gpaste b/osx/gpaste new file mode 100644 index 00000000..9f4e038e --- /dev/null +++ b/osx/gpaste @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gpaste + +> This command is an alias of GNU `paste`. + +- View documentation for the original command: + +`tldr -p linux paste` diff --git a/osx/gpathchk b/osx/gpathchk new file mode 100644 index 00000000..b1fdc212 --- /dev/null +++ b/osx/gpathchk @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gpathchk + +> This command is an alias of GNU `pathchk`. + +- View documentation for the original command: + +`tldr -p linux pathchk` diff --git a/osx/gping b/osx/gping new file mode 100644 index 00000000..4b092a18 --- /dev/null +++ b/osx/gping @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gping + +> This command is an alias of GNU `ping`. + +- View documentation for the original command: + +`tldr -p linux ping` diff --git a/osx/gping6 b/osx/gping6 new file mode 100644 index 00000000..6d7784b4 --- /dev/null +++ b/osx/gping6 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gping6 + +> This command is an alias of GNU `ping6`. + +- View documentation for the original command: + +`tldr -p linux ping6` diff --git a/osx/gpinky b/osx/gpinky new file mode 100644 index 00000000..7ef8d267 --- /dev/null +++ b/osx/gpinky @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gpinky + +> This command is an alias of GNU `pinky`. + +- View documentation for the original command: + +`tldr -p linux pinky` diff --git a/osx/gpr b/osx/gpr new file mode 100644 index 00000000..80a3d525 --- /dev/null +++ b/osx/gpr @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gpr + +> This command is an alias of GNU `pr`. + +- View documentation for the original command: + +`tldr -p linux pr` diff --git a/osx/gprintenv b/osx/gprintenv new file mode 100644 index 00000000..6b222b18 --- /dev/null +++ b/osx/gprintenv @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gprintenv + +> This command is an alias of GNU `printenv`. + +- View documentation for the original command: + +`tldr -p linux printenv` diff --git a/osx/gprintf b/osx/gprintf new file mode 100644 index 00000000..d6d619d0 --- /dev/null +++ b/osx/gprintf @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gprintf + +> This command is an alias of GNU `printf`. + +- View documentation for the original command: + +`tldr -p linux printf` diff --git a/osx/gptx b/osx/gptx new file mode 100644 index 00000000..c8493809 --- /dev/null +++ b/osx/gptx @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gptx + +> This command is an alias of GNU `ptx`. + +- View documentation for the original command: + +`tldr -p linux ptx` diff --git a/osx/gpwd b/osx/gpwd new file mode 100644 index 00000000..f1f8de00 --- /dev/null +++ b/osx/gpwd @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gpwd + +> This command is an alias of GNU `pwd`. + +- View documentation for the original command: + +`tldr -p linux pwd` diff --git a/osx/grcp b/osx/grcp new file mode 100644 index 00000000..08e2a998 --- /dev/null +++ b/osx/grcp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grcp + +> This command is an alias of GNU `rcp`. + +- View documentation for the original command: + +`tldr -p linux rcp` diff --git a/osx/greadlink b/osx/greadlink new file mode 100644 index 00000000..6d25b86e --- /dev/null +++ b/osx/greadlink @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# greadlink + +> This command is an alias of GNU `readlink`. + +- View documentation for the original command: + +`tldr -p linux readlink` diff --git a/osx/grealpath b/osx/grealpath new file mode 100644 index 00000000..a7029809 --- /dev/null +++ b/osx/grealpath @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grealpath + +> This command is an alias of GNU `realpath`. + +- View documentation for the original command: + +`tldr -p linux realpath` diff --git a/osx/grexec b/osx/grexec new file mode 100644 index 00000000..094c8d8d --- /dev/null +++ b/osx/grexec @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grexec + +> This command is an alias of GNU `rexec`. + +- View documentation for the original command: + +`tldr -p linux rexec` diff --git a/osx/grlogin b/osx/grlogin new file mode 100644 index 00000000..76c0664f --- /dev/null +++ b/osx/grlogin @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grlogin + +> This command is an alias of GNU `rlogin`. + +- View documentation for the original command: + +`tldr -p linux rlogin` diff --git a/osx/grm b/osx/grm new file mode 100644 index 00000000..af1cc626 --- /dev/null +++ b/osx/grm @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grm + +> This command is an alias of GNU `rm`. + +- View documentation for the original command: + +`tldr -p linux rm` diff --git a/osx/grmdir b/osx/grmdir new file mode 100644 index 00000000..8f5bdff9 --- /dev/null +++ b/osx/grmdir @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grmdir + +> This command is an alias of GNU `rmdir`. + +- View documentation for the original command: + +`tldr -p linux rmdir` diff --git a/osx/grsh b/osx/grsh new file mode 100644 index 00000000..be0411db --- /dev/null +++ b/osx/grsh @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# grsh + +> This command is an alias of GNU `rsh`. + +- View documentation for the original command: + +`tldr -p linux rsh` diff --git a/osx/gruncon b/osx/gruncon new file mode 100644 index 00000000..768e6188 --- /dev/null +++ b/osx/gruncon @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gruncon + +> This command is an alias of GNU `runcon`. + +- View documentation for the original command: + +`tldr -p linux runcon` diff --git a/osx/gsed b/osx/gsed new file mode 100644 index 00000000..b8f4c233 --- /dev/null +++ b/osx/gsed @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsed + +> This command is an alias of GNU `sed`. + +- View documentation for the original command: + +`tldr -p linux sed` diff --git a/osx/gseq b/osx/gseq new file mode 100644 index 00000000..e5403a3b --- /dev/null +++ b/osx/gseq @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gseq + +> This command is an alias of GNU `seq`. + +- View documentation for the original command: + +`tldr -p linux seq` diff --git a/osx/gsha1sum b/osx/gsha1sum new file mode 100644 index 00000000..37d2ebe5 --- /dev/null +++ b/osx/gsha1sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsha1sum + +> This command is an alias of GNU `sha1sum`. + +- View documentation for the original command: + +`tldr -p linux sha1sum` diff --git a/osx/gsha224sum b/osx/gsha224sum new file mode 100644 index 00000000..444641ef --- /dev/null +++ b/osx/gsha224sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsha224sum + +> This command is an alias of GNU `sha224sum`. + +- View documentation for the original command: + +`tldr -p linux sha224sum` diff --git a/osx/gsha256sum b/osx/gsha256sum new file mode 100644 index 00000000..f6abeedf --- /dev/null +++ b/osx/gsha256sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsha256sum + +> This command is an alias of GNU `sha256sum`. + +- View documentation for the original command: + +`tldr -p linux sha256sum` diff --git a/osx/gsha384sum b/osx/gsha384sum new file mode 100644 index 00000000..6819a384 --- /dev/null +++ b/osx/gsha384sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsha384sum + +> This command is an alias of GNU `sha384sum`. + +- View documentation for the original command: + +`tldr -p linux sha384sum` diff --git a/osx/gsha512sum b/osx/gsha512sum new file mode 100644 index 00000000..715230dc --- /dev/null +++ b/osx/gsha512sum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsha512sum + +> This command is an alias of GNU `sha512sum`. + +- View documentation for the original command: + +`tldr -p linux sha512sum` diff --git a/osx/gshred b/osx/gshred new file mode 100644 index 00000000..ac04c6eb --- /dev/null +++ b/osx/gshred @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gshred + +> This command is an alias of GNU `shred`. + +- View documentation for the original command: + +`tldr -p linux shred` diff --git a/osx/gshuf b/osx/gshuf new file mode 100644 index 00000000..59ec81b2 --- /dev/null +++ b/osx/gshuf @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gshuf + +> This command is an alias of GNU `shuf`. + +- View documentation for the original command: + +`tldr -p linux shuf` diff --git a/osx/gsleep b/osx/gsleep new file mode 100644 index 00000000..62de6f48 --- /dev/null +++ b/osx/gsleep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsleep + +> This command is an alias of GNU `sleep`. + +- View documentation for the original command: + +`tldr -p linux sleep` diff --git a/osx/gsort b/osx/gsort new file mode 100644 index 00000000..98d479ed --- /dev/null +++ b/osx/gsort @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsort + +> This command is an alias of GNU `sort`. + +- View documentation for the original command: + +`tldr -p linux sort` diff --git a/osx/gsplit b/osx/gsplit new file mode 100644 index 00000000..ad29d453 --- /dev/null +++ b/osx/gsplit @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsplit + +> This command is an alias of GNU `split`. + +- View documentation for the original command: + +`tldr -p linux split` diff --git a/osx/gstat b/osx/gstat new file mode 100644 index 00000000..7b341780 --- /dev/null +++ b/osx/gstat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gstat + +> This command is an alias of GNU `stat`. + +- View documentation for the original command: + +`tldr -p linux stat` diff --git a/osx/gstdbuf b/osx/gstdbuf new file mode 100644 index 00000000..36dca9e3 --- /dev/null +++ b/osx/gstdbuf @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gstdbuf + +> This command is an alias of GNU `stdbuf`. + +- View documentation for the original command: + +`tldr -p linux stdbuf` diff --git a/osx/gstty b/osx/gstty new file mode 100644 index 00000000..45c10fc8 --- /dev/null +++ b/osx/gstty @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gstty + +> This command is an alias of GNU `stty`. + +- View documentation for the original command: + +`tldr -p linux stty` diff --git a/osx/gsum b/osx/gsum new file mode 100644 index 00000000..430a06a6 --- /dev/null +++ b/osx/gsum @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsum + +> This command is an alias of GNU `sum`. + +- View documentation for the original command: + +`tldr -p linux sum` diff --git a/osx/gsync b/osx/gsync new file mode 100644 index 00000000..424d520a --- /dev/null +++ b/osx/gsync @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gsync + +> This command is an alias of GNU `sync`. + +- View documentation for the original command: + +`tldr -p linux sync` diff --git a/osx/gtac b/osx/gtac new file mode 100644 index 00000000..50a71524 --- /dev/null +++ b/osx/gtac @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtac + +> This command is an alias of GNU `tac`. + +- View documentation for the original command: + +`tldr -p linux tac` diff --git a/osx/gtail b/osx/gtail new file mode 100644 index 00000000..8ff16fed --- /dev/null +++ b/osx/gtail @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtail + +> This command is an alias of GNU `tail`. + +- View documentation for the original command: + +`tldr -p linux tail` diff --git a/osx/gtalk b/osx/gtalk new file mode 100644 index 00000000..c5332c14 --- /dev/null +++ b/osx/gtalk @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtalk + +> This command is an alias of GNU `talk`. + +- View documentation for the original command: + +`tldr -p linux talk` diff --git a/osx/gtar b/osx/gtar new file mode 100644 index 00000000..df1cdf1a --- /dev/null +++ b/osx/gtar @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtar + +> This command is an alias of GNU `tar`. + +- View documentation for the original command: + +`tldr -p linux tar` diff --git a/osx/gtee b/osx/gtee new file mode 100644 index 00000000..05d3aef0 --- /dev/null +++ b/osx/gtee @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtee + +> This command is an alias of GNU `tee`. + +- View documentation for the original command: + +`tldr -p linux tee` diff --git a/osx/gtelnet b/osx/gtelnet new file mode 100644 index 00000000..e34f4942 --- /dev/null +++ b/osx/gtelnet @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtelnet + +> This command is an alias of GNU `telnet`. + +- View documentation for the original command: + +`tldr -p linux telnet` diff --git a/osx/gtest b/osx/gtest new file mode 100644 index 00000000..8db72dad --- /dev/null +++ b/osx/gtest @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtest + +> This command is an alias of GNU `test`. + +- View documentation for the original command: + +`tldr -p linux test` diff --git a/osx/gtftp b/osx/gtftp new file mode 100644 index 00000000..5f74ed51 --- /dev/null +++ b/osx/gtftp @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtftp + +> This command is an alias of GNU `tftp`. + +- View documentation for the original command: + +`tldr -p linux tftp` diff --git a/osx/gtime b/osx/gtime new file mode 100644 index 00000000..ac829405 --- /dev/null +++ b/osx/gtime @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtime + +> This command is an alias of GNU `time`. + +- View documentation for the original command: + +`tldr -p linux time` diff --git a/osx/gtimeout b/osx/gtimeout new file mode 100644 index 00000000..698003e6 --- /dev/null +++ b/osx/gtimeout @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtimeout + +> This command is an alias of GNU `timeout`. + +- View documentation for the original command: + +`tldr -p linux timeout` diff --git a/osx/gtouch b/osx/gtouch new file mode 100644 index 00000000..ad4f83f6 --- /dev/null +++ b/osx/gtouch @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtouch + +> This command is an alias of GNU `touch`. + +- View documentation for the original command: + +`tldr -p linux touch` diff --git a/osx/gtr b/osx/gtr new file mode 100644 index 00000000..bf66059b --- /dev/null +++ b/osx/gtr @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtr + +> This command is an alias of GNU `tr`. + +- View documentation for the original command: + +`tldr -p linux tr` diff --git a/osx/gtraceroute b/osx/gtraceroute new file mode 100644 index 00000000..82bb5a1c --- /dev/null +++ b/osx/gtraceroute @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtraceroute + +> This command is an alias of GNU `traceroute`. + +- View documentation for the original command: + +`tldr -p linux traceroute` diff --git a/osx/gtrue b/osx/gtrue new file mode 100644 index 00000000..2a5d09da --- /dev/null +++ b/osx/gtrue @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtrue + +> This command is an alias of GNU `true`. + +- View documentation for the original command: + +`tldr -p linux true` diff --git a/osx/gtruncate b/osx/gtruncate new file mode 100644 index 00000000..a27ad7b1 --- /dev/null +++ b/osx/gtruncate @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtruncate + +> This command is an alias of GNU `truncate`. + +- View documentation for the original command: + +`tldr -p linux truncate` diff --git a/osx/gtsort b/osx/gtsort new file mode 100644 index 00000000..d1102a6d --- /dev/null +++ b/osx/gtsort @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtsort + +> This command is an alias of GNU `tsort`. + +- View documentation for the original command: + +`tldr -p linux tsort` diff --git a/osx/gtty b/osx/gtty new file mode 100644 index 00000000..d2ae888a --- /dev/null +++ b/osx/gtty @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gtty + +> This command is an alias of GNU `tty`. + +- View documentation for the original command: + +`tldr -p linux tty` diff --git a/osx/guname b/osx/guname new file mode 100644 index 00000000..80bea1af --- /dev/null +++ b/osx/guname @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# guname + +> This command is an alias of GNU `uname`. + +- View documentation for the original command: + +`tldr -p linux uname` diff --git a/osx/gunexpand b/osx/gunexpand new file mode 100644 index 00000000..baaf3f42 --- /dev/null +++ b/osx/gunexpand @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gunexpand + +> This command is an alias of GNU `unexpand`. + +- View documentation for the original command: + +`tldr -p linux unexpand` diff --git a/osx/guniq b/osx/guniq new file mode 100644 index 00000000..f405066f --- /dev/null +++ b/osx/guniq @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# guniq + +> This command is an alias of GNU `uniq`. + +- View documentation for the original command: + +`tldr -p linux uniq` diff --git a/osx/gunits b/osx/gunits new file mode 100644 index 00000000..e6e59172 --- /dev/null +++ b/osx/gunits @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gunits + +> This command is an alias of GNU `units`. + +- View documentation for the original command: + +`tldr -p linux units` diff --git a/osx/gunlink b/osx/gunlink new file mode 100644 index 00000000..3704d878 --- /dev/null +++ b/osx/gunlink @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gunlink + +> This command is an alias of GNU `unlink`. + +- View documentation for the original command: + +`tldr -p linux unlink` diff --git a/osx/gupdatedb b/osx/gupdatedb new file mode 100644 index 00000000..08a949ea --- /dev/null +++ b/osx/gupdatedb @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gupdatedb + +> This command is an alias of GNU `updatedb`. + +- View documentation for the original command: + +`tldr -p linux updatedb` diff --git a/osx/guptime b/osx/guptime new file mode 100644 index 00000000..b171c5aa --- /dev/null +++ b/osx/guptime @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# guptime + +> This command is an alias of GNU `uptime`. + +- View documentation for the original command: + +`tldr -p linux uptime` diff --git a/osx/gusers b/osx/gusers new file mode 100644 index 00000000..cccf8f8e --- /dev/null +++ b/osx/gusers @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gusers + +> This command is an alias of GNU `users`. + +- View documentation for the original command: + +`tldr -p linux users` diff --git a/osx/gvdir b/osx/gvdir new file mode 100644 index 00000000..4949ab53 --- /dev/null +++ b/osx/gvdir @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gvdir + +> This command is an alias of GNU `vdir`. + +- View documentation for the original command: + +`tldr -p linux vdir` diff --git a/osx/gwc b/osx/gwc new file mode 100644 index 00000000..9477c906 --- /dev/null +++ b/osx/gwc @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gwc + +> This command is an alias of GNU `wc`. + +- View documentation for the original command: + +`tldr -p linux wc` diff --git a/osx/gwhich b/osx/gwhich new file mode 100644 index 00000000..65c86403 --- /dev/null +++ b/osx/gwhich @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gwhich + +> This command is an alias of GNU `which`. + +- View documentation for the original command: + +`tldr -p linux which` diff --git a/osx/gwho b/osx/gwho new file mode 100644 index 00000000..b80de89a --- /dev/null +++ b/osx/gwho @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gwho + +> This command is an alias of GNU `who`. + +- View documentation for the original command: + +`tldr -p linux who` diff --git a/osx/gwhoami b/osx/gwhoami new file mode 100644 index 00000000..f61532ce --- /dev/null +++ b/osx/gwhoami @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gwhoami + +> This command is an alias of GNU `whoami`. + +- View documentation for the original command: + +`tldr -p linux whoami` diff --git a/osx/gwhois b/osx/gwhois new file mode 100644 index 00000000..56cd9577 --- /dev/null +++ b/osx/gwhois @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gwhois + +> This command is an alias of GNU `whois`. + +- View documentation for the original command: + +`tldr -p linux whois` diff --git a/osx/gxargs b/osx/gxargs new file mode 100644 index 00000000..5ba5b378 --- /dev/null +++ b/osx/gxargs @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gxargs + +> This command is an alias of GNU `xargs`. + +- View documentation for the original command: + +`tldr -p linux xargs` diff --git a/osx/gyes b/osx/gyes new file mode 100644 index 00000000..94699c45 --- /dev/null +++ b/osx/gyes @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gyes + +> This command is an alias of GNU `yes`. + +- View documentation for the original command: + +`tldr -p linux yes` diff --git a/osx/hdiutil b/osx/hdiutil new file mode 100644 index 00000000..ea6fc5a7 --- /dev/null +++ b/osx/hdiutil @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# hdiutil + +> Utility to create and manage disk images. +> More information: . + +- Mount an image: + +`hdiutil attach {{path/to/image_file}}` + +- Unmount an image: + +`hdiutil detach /Volumes/{{volume_file}}` + +- List mounted images: + +`hdiutil info` + +- Create an ISO image from the contents of a directory: + +`hdiutil makehybrid -o {{path/to/output_file}} {{path/to/directory}}` diff --git a/osx/head b/osx/head new file mode 100644 index 00000000..98c2c789 --- /dev/null +++ b/osx/head @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# head + +> Output the first part of files. +> More information: . + +- Output the first few lines of a file: + +`head --lines {{8}} {{path/to/file}}` + +- Output the first few bytes of a file: + +`head --bytes {{8}} {{path/to/file}}` + +- Output everything but the last few lines of a file: + +`head --lines -{{8}} {{path/to/file}}` + +- Output everything but the last few bytes of a file: + +`head --bytes -{{8}} {{path/to/file}}` diff --git a/osx/hidd b/osx/hidd new file mode 100644 index 00000000..4db0d3f0 --- /dev/null +++ b/osx/hidd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# hidd + +> HID library userland daemon. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`hidd` diff --git a/osx/httpie b/osx/httpie new file mode 100644 index 00000000..62521c7e --- /dev/null +++ b/osx/httpie @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# httpie + +> A user friendly HTTP tool. +> More information: . + +- Send a GET request (default method with no request data): + +`http {{https://example.com}}` + +- Send a POST request (default method with request data): + +`http {{https://example.com}} {{hello=World}}` + +- Send a POST request with redirected input: + +`http {{https://example.com}} < {{file.json}}` + +- Send a PUT request with a given JSON body: + +`http PUT {{https://example.com/todos/7}} {{hello=world}}` + +- Send a DELETE request with a given request header: + +`http DELETE {{https://example.com/todos/7}} {{API-Key:foo}}` + +- Show the whole HTTP exchange (both request and response): + +`http -v {{https://example.com}}` + +- Download a file: + +`http --download {{https://example.com}}` + +- Follow redirects and show intermediary requests and responses: + +`http --follow --all {{https://example.com}}` diff --git a/osx/icalbuddy b/osx/icalbuddy new file mode 100644 index 00000000..63a5b659 --- /dev/null +++ b/osx/icalbuddy @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# icalBuddy + +> Command-line utility for printing events and tasks from the macOS calendar database. +> More information: . + +- Show events later today: + +`icalBuddy --includeOnlyEventsFromNowOn eventsToday` + +- Show uncompleted tasks: + +`icalBuddy uncompletedTasks` + +- Show a formatted list separated by calendar for all events today: + +`icalBuddy --formatOutput --separateByCalendar eventsToday` + +- Show tasks for a specified number of days: + +`icalBuddy --includeOnlyEventsFromNowOn "tasksDueBefore:today+{{number_of_days}}"` + +- Show events in a time range: + +`icalBuddy eventsFrom:{{start_date}} to:{{end_date}}` diff --git a/osx/indent b/osx/indent new file mode 100644 index 00000000..c4eb5e55 --- /dev/null +++ b/osx/indent @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# indent + +> Change the appearance of a C/C++ program by inserting or deleting whitespace. +> More information: . + +- Format C/C++ source according to the Berkeley style: + +`indent {{path/to/source_file.c}} {{path/to/indented_file.c}} -nbad -nbap -bc -br -c33 -cd33 -cdb -ce -ci4 -cli0 -di16 -fc1 -fcb -i4 -ip -l75 -lp -npcs -nprs -psl -sc -nsob -ts8` + +- Format C/C++ source according to the style of Kernighan & Ritchie (K&R): + +`indent {{path/to/source_file.c}} {{path/to/indented_file.c}} -nbad -bap -nbc -br -c33 -cd33 -ncdb -ce -ci4 -cli0 -cs -d0 -di1 -nfc1 -nfcb -i4 -nip -l75 -lp -npcs -nprs -npsl -nsc -nsob` diff --git a/osx/internetsharing b/osx/internetsharing new file mode 100644 index 00000000..fc94b6ea --- /dev/null +++ b/osx/internetsharing @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# InternetSharing + +> Sets up Internet Sharing. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`InternetSharing` diff --git a/osx/ipconfig b/osx/ipconfig new file mode 100644 index 00000000..14ffb601 --- /dev/null +++ b/osx/ipconfig @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ipconfig + +> View and control IP configuration state. +> More information: . + +- List all network interfaces: + +`ipconfig getiflist` + +- Show the IP address of an interface: + +`ipconfig getifaddr {{interface_name}}` diff --git a/osx/istats b/osx/istats new file mode 100644 index 00000000..154159fc --- /dev/null +++ b/osx/istats @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# istats + +> Show various statistics such as the CPU temperature, fan speeds and battery status. +> More information: . + +- Show all the stats: + +`istats` + +- Show all CPU stats: + +`istats cpu` + +- Show all fan stats: + +`istats fan` + +- Scan and print temperatures: + +`istats scan` diff --git a/osx/java_home b/osx/java_home new file mode 100644 index 00000000..84f74cbc --- /dev/null +++ b/osx/java_home @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# java_home + +> Return a value for $JAVA_HOME or execute command using this variable. +> More information: . + +- List JVMs based on a specific version: + +`java_home --version {{1.5+}}` + +- List JVMs based on a specific [arch]itecture: + +`java_home --arch {{i386}}` + +- List JVMs based on a specific tasks (defaults to `CommandLine`): + +`java_home --datamodel {{Applets|WebStart|BundledApp|JNI|CommandLine}}` + +- List JVMs in a XML format: + +`java_home --xml` + +- Display help: + +`java_home --help` diff --git a/osx/kmutil b/osx/kmutil new file mode 100644 index 00000000..3f35e427 --- /dev/null +++ b/osx/kmutil @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# kmutil + +> Utility for managing kernel extensions (kexts) and kext collections on disk. +> More information: . + +- Find kexts available on the operating system: + +`kmutil find` + +- Display logging information about the Kernel Management sub-system: + +`kmutil log` + +- Inspect and display a kext collection's contents according to the options provided: + +`kmutil inspect {{options}}` + +- Check the consistency of kext collections against each other: + +`kmutil check` + +- Dump kernelmanagerd state for debugging: + +`sudo kmutil dumpstate` + +- Load one or more extensions based on the bundle specified at this path in the results: + +`kmutil load --bundle-path {{path/to/extension.kext}}` diff --git a/osx/launchctl b/osx/launchctl new file mode 100644 index 00000000..64973e50 --- /dev/null +++ b/osx/launchctl @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# launchctl + +> Control Apple's `launchd` manager for launch daemons (system-wide services) and launch agents (per-user programs). +> `launchd` loads XML-based `*.plist` files placed in the appropriate locations, and runs the corresponding commands according to their defined schedule. +> More information: . + +- Activate a user-specific agent to be loaded into `launchd` whenever the user logs in: + +`launchctl load ~/Library/LaunchAgents/{{my_script}}.plist` + +- Activate an agent which requires root privileges to run and/or should be loaded whenever any user logs in (note the absence of `~` in the path): + +`sudo launchctl load /Library/LaunchAgents/{{root_script}}.plist` + +- Activate a system-wide daemon to be loaded whenever the system boots up (even if no user logs in): + +`sudo launchctl load /Library/LaunchDaemons/{{system_daemon}}.plist` + +- Show all loaded agents/daemons, with the PID if the process they specify is currently running, and the exit code returned the last time they ran: + +`launchctl list` + +- Unload a currently loaded agent, e.g. to make changes (Note: the plist file is automatically loaded into `launchd` after a reboot and/or logging in): + +`launchctl unload ~/Library/LaunchAgents/{{my_script}}.plist` + +- Manually run a known (loaded) agent/daemon, even if it is not the right time (Note: this command uses the agent's label, rather than the filename): + +`launchctl start {{script_file}}` + +- Manually kill the process associated with a known agent/daemon, if it is running: + +`launchctl stop {{script_file}}` diff --git a/osx/launchd b/osx/launchd new file mode 100644 index 00000000..0a7b820c --- /dev/null +++ b/osx/launchd @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# launchd + +> This manages processes, both for the system and users. +> You cannot invoke launchd manually, use launchctl to interact with it. +> More information: . + +- Run init: + +`/sbin/launchd` + +- View documentation for interacting with launchd using launchctl: + +`tldr launchctl` diff --git a/osx/lipo b/osx/lipo new file mode 100644 index 00000000..8dded5f5 --- /dev/null +++ b/osx/lipo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# lipo + +> Handle Mach-O Universal Binaries. +> More information: . + +- Create a universal file from two single-architecture files: + +`lipo {{path/to/binary_file.x86_64}} {{path/to/binary_file.arm64e}} -create -output {{path/to/binary_file}}` + +- List all architectures contained in a universal file: + +`lipo {{path/to/binary_file}} -archs` + +- Display detailed information about a universal file: + +`lipo {{path/to/binary_file}} -detailed_info` + +- Extract a single-architecture file from a universal file: + +`lipo {{path/to/binary_file}} -thin {{arm64e}} -output {{path/to/binary_file.arm64e}}` diff --git a/osx/lldb b/osx/lldb new file mode 100644 index 00000000..08afc27b --- /dev/null +++ b/osx/lldb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# lldb + +> The LLVM Low-Level Debugger. +> More information: . + +- Debug an executable: + +`lldb "{{executable}}"` + +- Attach `lldb` to a running process with a given PID: + +`lldb -p {{pid}}` + +- Wait for a new process to launch with a given name, and attach to it: + +`lldb -w -n "{{process_name}}"` diff --git a/osx/llvm-lipo b/osx/llvm-lipo new file mode 100644 index 00000000..d530848b --- /dev/null +++ b/osx/llvm-lipo @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# llvm-lipo + +> This command is an alias of `lipo`. + +- View documentation for the original command: + +`tldr lipo` diff --git a/osx/locate b/osx/locate new file mode 100644 index 00000000..cc26b12b --- /dev/null +++ b/osx/locate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# locate + +> Find filenames quickly. +> More information: . + +- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily): + +`locate "{{pattern}}"` + +- Look for a file by its exact filename (a pattern containing no globbing characters is interpreted as `*pattern*`): + +`locate */{{filename}}` + +- Recompute the database. You need to do it if you want to find recently added files: + +`sudo /usr/libexec/locate.updatedb` diff --git a/osx/log b/osx/log new file mode 100644 index 00000000..548430e4 --- /dev/null +++ b/osx/log @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# log + +> View, export, and configure logging systems. +> More information: . + +- Stream live system logs: + +`log stream` + +- Stream logs sent to `syslog` from the process with a specific PID: + +`log stream --process {{process_id}}` + +- Show logs sent to syslog from a process with a specific name: + +`log show --predicate "process == '{{process_name}}'"` + +- Export all logs to disk for the past hour: + +`sudo log collect --last {{1h}} --output {{path/to/file.logarchive}}` diff --git a/osx/look b/osx/look new file mode 100644 index 00000000..625f1558 --- /dev/null +++ b/osx/look @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# look + +> Display lines beginning with a prefix in a sorted file. +> See also: `grep`, `sort`. +> More information: . + +- Search for lines beginning with a specific prefix in a specific file: + +`look {{prefix}} {{path/to/file}}` + +- Case-insensitively search only on alphanumeric characters: + +`look -{{f|-ignore-case}} -{{d|-alphanum}} {{prefix}} {{path/to/file}}` + +- Specify a string [t]ermination character (space by default): + +`look -{{t|-terminate}} {{,}}` + +- Search in `/usr/share/dict/words` (`--ignore-case` and `--alphanum` are assumed): + +`look {{prefix}}` diff --git a/osx/lpstat b/osx/lpstat new file mode 100644 index 00000000..8d584f55 --- /dev/null +++ b/osx/lpstat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# lpstat + +> Display status information about the current classes, jobs, and printers. +> More information: . + +- Show a long listing of printers, classes, and jobs: + +`lpstat -l` + +- Force encryption when connecting to the CUPS server: + +`lpstat -E` + +- Show the ranking of print jobs: + +`lpstat -R` + +- Show whether or not the CUPS server is running: + +`lpstat -r` + +- Show all status information: + +`lpstat -t` diff --git a/osx/lsappinfo b/osx/lsappinfo new file mode 100644 index 00000000..97f27759 --- /dev/null +++ b/osx/lsappinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# lsappinfo + +> Control and query CoreApplicationServices about the app state on the system. +> More information: . + +- List all running applications with their details: + +`lsappinfo list` + +- Show the front application: + +`lsappinfo front` + +- Show the information for a specific application: + +`lsappinfo info {{com.apple.calculator}}` diff --git a/osx/m b/osx/m new file mode 100644 index 00000000..721222cc --- /dev/null +++ b/osx/m @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# m + +> Swiss Army Knife for macOS. +> More information: . + +- Get the battery status: + +`m battery status` + +- Turn off Bluetooth: + +`m bluetooth off` + +- List available filesystems for formatting: + +`m disk filesystems` + +- Enable Dock's auto hide feature: + +`m dock autohide YES` + +- Disable the firewall: + +`m firewall disable` diff --git a/osx/machine b/osx/machine new file mode 100644 index 00000000..33fceb3b --- /dev/null +++ b/osx/machine @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# machine + +> Print machine type. +> More information: . + +- Print CPU architecture: + +`machine` diff --git a/osx/mas b/osx/mas new file mode 100644 index 00000000..52cf3665 --- /dev/null +++ b/osx/mas @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mas + +> Command-line interface for the Mac App Store. +> More information: . + +- Sign into the Mac App Store for the first time: + +`mas signin "{{user@example.com}}"` + +- Show all installed applications and their product identifiers: + +`mas list` + +- Search for an application, displaying the price alongside the results: + +`mas search "{{application}}" --price` + +- Install or update an application: + +`mas install {{product_identifier}}` + +- Install all pending updates: + +`mas upgrade` diff --git a/osx/mate b/osx/mate new file mode 100644 index 00000000..480ed0e2 --- /dev/null +++ b/osx/mate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mate + +> General-purpose text editor for macOS. +> More information: . + +- Start TextMate: + +`mate` + +- Open specific files: + +`mate {{path/to/file1 path/to/file2 ...}}` + +- Specify the filetype of a file: + +`mate --type {{filetype}} {{path/to/file}}` + +- Open and wait until finished editing a specific file: + +`mate --wait {{path/to/file}}` + +- Open a file with the cursor at a specific line and column: + +`mate --line {{line_number}}:{{column_number}} {{path/to/file}}` diff --git a/osx/md5 b/osx/md5 new file mode 100644 index 00000000..c06fd60e --- /dev/null +++ b/osx/md5 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# md5 + +> Calculate MD5 cryptographic checksums. +> More information: . + +- Calculate the MD5 checksum for a file: + +`md5 {{path/to/file}}` + +- Calculate MD5 checksums for multiple files: + +`md5 {{path/to/file1 path/to/file2 ...}}` + +- Output only the md5 checksum (no filename): + +`md5 -q {{path/to/file}}` + +- Print a checksum of the given string: + +`md5 -s "{{string}}"` diff --git a/osx/mdfind b/osx/mdfind new file mode 100644 index 00000000..feb2d107 --- /dev/null +++ b/osx/mdfind @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mdfind + +> List files matching a query. +> More information: . + +- Find a file by its name: + +`mdfind -name {{file}}` + +- Find a file by its content: + +`mdfind "{{query}}"` + +- Find a file containing a string, in a given directory: + +`mdfind -onlyin {{directory}} "{{query}}"` diff --git a/osx/mdls b/osx/mdls new file mode 100644 index 00000000..ab2f7703 --- /dev/null +++ b/osx/mdls @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mdls + +> Display the metadata attributes for a file. +> More information: . + +- Display the list of metadata attributes for file: + +`mdls {{path/to/file}}` + +- Display a specific metadata attribute: + +`mdls -name {{attribute}} {{path/to/file}}` diff --git a/osx/mdutil b/osx/mdutil new file mode 100644 index 00000000..74b42f30 --- /dev/null +++ b/osx/mdutil @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mdutil + +> Manage the metadata stores used by Spotlight for indexing. +> More information: . + +- Show the indexing status of the startup volume: + +`mdutil -s {{/}}` + +- Turn on/off the Spotlight indexing for a given volume: + +`mdutil -i {{on|off}} {{path/to/volume}}` + +- Turn on/off indexing for all volumes: + +`mdutil -a -i {{on|off}}` + +- Erase the metadata stores and restart the indexing process: + +`mdutil -E {{path/to/volume}}` diff --git a/osx/mktemp b/osx/mktemp new file mode 100644 index 00000000..33b3728d --- /dev/null +++ b/osx/mktemp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mktemp + +> Create a temporary file or directory. +> More information: . + +- Create an empty temporary file and print its absolute path: + +`mktemp` + +- Use a custom directory (defaults to the output of `getconf DARWIN_USER_TEMP_DIR`, or `/tmp`): + +`mktemp --tmpdir={{/path/to/tempdir}}` + +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` + +- Use a custom file name prefix: + +`mktemp -t {{example}}` + +- Create an empty temporary directory and print its absolute path: + +`mktemp --directory` diff --git a/osx/mysides b/osx/mysides new file mode 100644 index 00000000..ed4026a9 --- /dev/null +++ b/osx/mysides @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# mysides + +> Add, list and remove finder favorites. +> More information: . + +- List sidebar favorites: + +`mysides list` + +- Add a new item to the end of the sidebar favorites: + +`mysides add {{example}} {{file:///Users/Shared/example}}` + +- Remove an item by name: + +`mysides remove {{example}}` + +- Add the current directory to the sidebar: + +`mysides add $(basename $(pwd)) file:///$(pwd)` + +- Remove the current directory from the sidebar: + +`mysides remove $(basename $(pwd))` diff --git a/osx/nettop b/osx/nettop new file mode 100644 index 00000000..75f918e6 --- /dev/null +++ b/osx/nettop @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# nettop + +> Display updated information about the network. +> More information: . + +- Monitor TCP and UDP sockets from all interfaces: + +`nettop` + +- Monitor TCP sockets from Loopback interfaces: + +`nettop -m {{tcp}} -t {{loopback}}` + +- Monitor a specific process: + +`nettop -p "{{process_id|process_name}}"` + +- Display a per-process summary: + +`nettop -P` + +- Print 10 samples of network information: + +`nettop -l {{10}}` + +- Monitor changes every 5 seconds: + +`nettop -d -s {{5}}` + +- While running nettop, list interactive commands: + +`h` + +- Display help: + +`nettop -h` diff --git a/osx/networkquality b/osx/networkquality new file mode 100644 index 00000000..2b052ed3 --- /dev/null +++ b/osx/networkquality @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# networkQuality + +> Measure the network quality by connecting to the internet. +> More information: . + +- Test the network quality for the default interface: + +`networkQuality` + +- Test the upload and download speeds sequentially instead of in parallel: + +`networkQuality -s` + +- Test a specified network interface: + +`networkQuality -I {{en0}}` + +- Test the network quality with verbose output: + +`networkQuality -v` diff --git a/osx/networksetup b/osx/networksetup new file mode 100644 index 00000000..20cf396d --- /dev/null +++ b/osx/networksetup @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# networksetup + +> Configuration tool for Network System Preferences. +> More information: . + +- List available network service providers (Ethernet, Wi-Fi, Bluetooth, etc): + +`networksetup -listallnetworkservices` + +- Show network settings for a particular networking device: + +`networksetup -getinfo "{{Wi-Fi}}"` + +- Get currently connected Wi-Fi network name (Wi-Fi device usually en0 or en1): + +`networksetup -getairportnetwork {{en0}}` + +- Connect to a particular Wi-Fi network: + +`networksetup -setairportnetwork {{en0}} {{Airport Network SSID}} {{password}}` diff --git a/osx/nfcd b/osx/nfcd new file mode 100644 index 00000000..5e5462fa --- /dev/null +++ b/osx/nfcd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# nfcd + +> This daemon controls the NFC controller. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`nfcd` diff --git a/osx/notifyd b/osx/notifyd new file mode 100644 index 00000000..37a55970 --- /dev/null +++ b/osx/notifyd @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# notifyd + +> Notification server. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`notifyd` + +- Log debug messages to the default log file (`/var/log/notifyd.log`): + +`notifyd -d` + +- Log debug messages to an alternate log file: + +`notifyd -d -log_file {{path/to/log_file}}` diff --git a/osx/nvram b/osx/nvram new file mode 100644 index 00000000..44719b80 --- /dev/null +++ b/osx/nvram @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# nvram + +> Manipulate firmware variables. +> More information: . + +- [p]rint all the variables stored in the NVRAM: + +`nvram -p` + +- [p]rint all the variables stored in the NVRAM using [x]ML format: + +`nvram -xp` + +- Modify the value of a firmware variable: + +`sudo nvram {{name}}="{{value}}"` + +- [d]elete a firmware variable: + +`sudo nvram -d {{name}}` + +- [c]lear all the firmware variables: + +`sudo nvram -c` + +- Set a firmware variable from a specific [x]ML [f]ile: + +`sudo nvram -xf {{path/to/file.xml}}` diff --git a/osx/ocspd b/osx/ocspd new file mode 100644 index 00000000..539d1cee --- /dev/null +++ b/osx/ocspd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ocspd + +> This retrieves and caches Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses for certificate verification. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`ocspd` diff --git a/osx/open b/osx/open new file mode 100644 index 00000000..6fd66bac --- /dev/null +++ b/osx/open @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# open + +> Opens files, directories and applications. +> More information: . + +- Open a file with the associated application: + +`open {{file.ext}}` + +- Run a graphical macOS [a]pplication: + +`open -a "{{Application}}"` + +- Run a graphical macOS app based on the [b]undle identifier (refer to `osascript` for an easy way to get this): + +`open -b {{com.domain.application}}` + +- Open the current directory in Finder: + +`open .` + +- [R]eveal a file in Finder: + +`open -R {{path/to/file}}` + +- Open all the files of a given extension in the current directory with the associated application: + +`open {{*.ext}}` + +- Open a [n]ew instance of an application specified via [b]undle identifier: + +`open -n -b {{com.domain.application}}` diff --git a/osx/opensnoop b/osx/opensnoop new file mode 100644 index 00000000..acf3b7fd --- /dev/null +++ b/osx/opensnoop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# opensnoop + +> Track file opens on your system. +> More information: . + +- Print all file opens as they occur: + +`sudo opensnoop` + +- Track all file opens by a process by name: + +`sudo opensnoop -n "{{process_name}}"` + +- Track all file opens by a process by PID: + +`sudo opensnoop -p {{PID}}` + +- Track which processes open a specified file: + +`sudo opensnoop -f {{path/to/file}}` diff --git a/osx/osascript b/osx/osascript new file mode 100644 index 00000000..148e3e46 --- /dev/null +++ b/osx/osascript @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# osascript + +> Run AppleScript or JavaScript for Automation (JXA). +> More information: . + +- Run an AppleScript command: + +`osascript -e "{{say 'Hello world'}}"` + +- Run multiple AppleScript commands: + +`osascript -e "{{say 'Hello'}}" -e "{{say 'world'}}"` + +- Run a compiled (`*.scpt`), bundled (`*.scptd`), or plaintext (`*.applescript`) AppleScript file: + +`osascript {{path/to/apple.scpt}}` + +- Get the bundle identifier of an application (useful for `open -b`): + +`osascript -e 'id of app "{{Application}}"'` + +- Run a JavaScript command: + +`osascript -l JavaScript -e "{{console.log('Hello world');}}"` + +- Run a JavaScript file: + +`osascript -l JavaScript {{path/to/script.js}}` diff --git a/osx/pbcopy b/osx/pbcopy new file mode 100644 index 00000000..ea89bd8e --- /dev/null +++ b/osx/pbcopy @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# pbcopy + +> Copy data from `stdin` to the clipboard. +> Comparable to pressing Cmd + C on the keyboard. +> More information: . + +- Place the contents of a specific file in the clipboard: + +`pbcopy < {{path/to/file}}` + +- Place the results of a specific command in the clipboard: + +`find . -type t -name "*.png" | pbcopy` diff --git a/osx/pbpaste b/osx/pbpaste new file mode 100644 index 00000000..40cac7f7 --- /dev/null +++ b/osx/pbpaste @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# pbpaste + +> Send the contents of the clipboard to `stdout`. +> Comparable to pressing Cmd + V on the keyboard. +> More information: . + +- Write the contents of the clipboard to a file: + +`pbpaste > {{path/to/file}}` + +- Use the contents of the clipboard as input to a command: + +`pbpaste | grep foo` diff --git a/osx/photoanalysisd b/osx/photoanalysisd new file mode 100644 index 00000000..827ecdae --- /dev/null +++ b/osx/photoanalysisd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# photoanalysisd + +> Analyze photo libraries for Memories, People, and scene or object based search. +> `photoanalysisd` should not be invoked manually. +> More information: . + +- Start the daemon: + +`photoanalysisd` diff --git a/osx/photolibraryd b/osx/photolibraryd new file mode 100644 index 00000000..5a9e282a --- /dev/null +++ b/osx/photolibraryd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# photolibraryd + +> This handles all photo library requests. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`photolibraryd` diff --git a/osx/ping b/osx/ping new file mode 100644 index 00000000..8aa91832 --- /dev/null +++ b/osx/ping @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ping + +> Send ICMP ECHO_REQUEST packets to network hosts. +> More information: . + +- Ping the specified host: + +`ping "{{hostname}}"` + +- Ping a host a specific number of times: + +`ping -c {{count}} "{{host}}"` + +- Ping `host`, specifying the interval in `seconds` between requests (default is 1 second): + +`ping -i {{seconds}} "{{host}}"` + +- Ping `host` without trying to lookup symbolic names for addresses: + +`ping -n "{{host}}"` + +- Ping `host` and ring the bell when a packet is received (if your terminal supports it): + +`ping -a "{{host}}"` + +- Ping `host` and prints the time a packet was received (this option is an Apple addition): + +`ping --apple-time "{{host}}"` diff --git a/osx/pkgutil b/osx/pkgutil new file mode 100644 index 00000000..0458f2da --- /dev/null +++ b/osx/pkgutil @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# pkgutil + +> Query and manipulate Mac OS X Installer packages and receipts. +> More information: . + +- List package IDs for all installed packages: + +`pkgutil --pkgs` + +- Verify cryptographic signatures of a package file: + +`pkgutil --check-signature {{path/to/filename.pkg}}` + +- List all the files for an installed package given its ID: + +`pkgutil --files {{com.microsoft.Word}}` + +- Extract the contents of a package file into a directory: + +`pkgutil --expand-full {{path/to/filename.pkg}} {{path/to/directory}}` diff --git a/osx/plutil b/osx/plutil new file mode 100644 index 00000000..44743ee0 --- /dev/null +++ b/osx/plutil @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# plutil + +> View, convert, validate, or edit property list ("plist") files. +> More information: . + +- Display the contents of one or more plist files in human-readable format: + +`plutil -p {{file1.plist file2.plist ...}}` + +- Convert one or more plist files to XML format, overwriting the original files in-place: + +`plutil -convert xml1 {{file1.plist file2.plist ...}}` + +- Convert one or more plist files to binary format, overwriting the original files in-place: + +`plutil -convert binary1 {{file1.plist file2.plist ...}}` + +- Convert a plist file to a different format, writing to a new file: + +`plutil -convert {{xml1|binary1|json|swift|objc}} {{path/to/file.plist}} -o {{path/to/new_file.plist}}` + +- Convert a plist file to a different format, writing to `stdout`: + +`plutil -convert {{xml1|binary1|json|swift|objc}} {{path/to/file.plist}} -o -` diff --git a/osx/pmset b/osx/pmset new file mode 100644 index 00000000..ba73d13c --- /dev/null +++ b/osx/pmset @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# pmset + +> Configure macOS power management settings, as one might do in System Preferences > Energy Saver. +> Commands that modify settings must begin with `sudo`. +> More information: . + +- Display the current power management settings: + +`pmset -g` + +- Display the current power source and battery levels: + +`pmset -g batt` + +- Put display to sleep immediately: + +`pmset displaysleepnow` + +- Set display to never sleep when on charger power: + +`sudo pmset -c displaysleep 0` + +- Set display to sleep after 15 minutes when on battery power: + +`sudo pmset -b displaysleep 15` + +- Schedule computer to automatically wake up every weekday at 9 AM: + +`sudo pmset repeat wake MTWRF 09:00:00` + +- Restore to system defaults: + +`sudo pmset -a displaysleep 10 disksleep 10 sleep 30 womp 1` diff --git a/osx/pod b/osx/pod new file mode 100644 index 00000000..433b0882 --- /dev/null +++ b/osx/pod @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# pod + +> Dependency manager for Swift and Objective-C Cocoa projects. +> More information: . + +- Create a Podfile for the current project with the default contents: + +`pod init` + +- Download and install all pods defined in the Podfile (that haven't been installed before): + +`pod install` + +- List all available pods: + +`pod list` + +- Show the outdated pods (of those currently installed): + +`pod outdated` + +- Update all currently installed pods to their newest version: + +`pod update` + +- Update a specific (previously installed) pod to its newest version: + +`pod update {{pod_name}}` + +- Remove CocoaPods from a Xcode project: + +`pod deintegrate {{xcode_project}}` diff --git a/osx/port b/osx/port new file mode 100644 index 00000000..e672c55c --- /dev/null +++ b/osx/port @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# port + +> Package manager for macOS. +> More information: . + +- Search for a package: + +`port search {{search_term}}` + +- Install a package: + +`sudo port install {{package}}` + +- List installed packages: + +`port installed` + +- Update port and fetch the latest list of available packages: + +`sudo port selfupdate` + +- Upgrade outdated packages: + +`sudo port upgrade outdated` + +- Remove old versions of installed packages: + +`sudo port uninstall inactive` diff --git a/osx/ps b/osx/ps new file mode 100644 index 00000000..f95cc7db --- /dev/null +++ b/osx/ps @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# ps + +> Information about running processes. +> More information: . + +- List all running processes: + +`ps aux` + +- List all running processes including the full command string: + +`ps auxww` + +- Search for a process that matches a string: + +`ps aux | grep {{string}}` + +- Get the parent PID of a process: + +`ps -o ppid= -p {{pid}}` + +- Sort processes by memory usage: + +`ps -m` + +- Sort processes by CPU usage: + +`ps -r` diff --git a/osx/qlmanage b/osx/qlmanage new file mode 100644 index 00000000..cca621bd --- /dev/null +++ b/osx/qlmanage @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# qlmanage + +> QuickLook server tool. +> More information: . + +- Display QuickLook for one or multiple files: + +`qlmanage -p {{path/to/file1 path/to/file2 ...}}` + +- Compute 300px wide PNG thumbnails of all JPEGs in the current directory and put them in a directory: + +`qlmanage {{*.jpg}} -t -s {{300}} {{path/to/directory}}` + +- Reset QuickLook: + +`qlmanage -r` diff --git a/osx/rargs b/osx/rargs new file mode 100644 index 00000000..78d455bf Binary files /dev/null and b/osx/rargs differ diff --git a/osx/readlink b/osx/readlink new file mode 100644 index 00000000..683af363 --- /dev/null +++ b/osx/readlink @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# readlink + +> Follow symlinks and get symlink information. +> More information: . + +- Print the absolute path which the symlink points to: + +`readlink {{path/to/symlink_file}}` diff --git a/osx/reboot b/osx/reboot new file mode 100644 index 00000000..e5efdca5 --- /dev/null +++ b/osx/reboot @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# reboot + +> Reboot the system. +> More information: . + +- Reboot immediately: + +`sudo reboot` + +- Reboot immediately without gracefully shutting down: + +`sudo reboot -q` diff --git a/osx/rename b/osx/rename new file mode 100644 index 00000000..bdce45f4 --- /dev/null +++ b/osx/rename @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# rename + +> Rename a file or group of files with a regular expression. +> More information: . + +- Replace `from` with `to` in the filenames of the specified files: + +`rename 's/{{from}}/{{to}}/' {{*.txt}}` diff --git a/osx/route b/osx/route new file mode 100644 index 00000000..efeafb39 --- /dev/null +++ b/osx/route @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# route + +> Manually manipulate the routing tables. +> Necessitates to be root. +> More information: . + +- Add a route to a destination through a gateway: + +`sudo route add "{{destination_ip_address}}" "{{gateway_address}}"` + +- Add a route to a /24 subnet through a gateway: + +`sudo route add "{{subnet_ip_address}}/24" "{{gateway_address}}"` + +- Run in test mode (does not do anything, just print): + +`sudo route -t add "{{destination_ip_address}}/24" "{{gateway_address}}"` + +- Remove all routes: + +`sudo route flush` + +- Delete a specific route: + +`sudo route delete "{{destination_ip_address}}/24"` + +- Lookup and display the route for a destination (hostname or IP address): + +`sudo route get "{{destination}}"` diff --git a/osx/safeejectgpu b/osx/safeejectgpu new file mode 100644 index 00000000..3e295209 --- /dev/null +++ b/osx/safeejectgpu @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# SafeEjectGPU + +> Eject a GPU safely. +> More information: . + +- Eject all GPUs: + +`SafeEjectGPU Eject` + +- List all GPUs attached: + +`SafeEjectGPU gpus` + +- List apps using a GPU: + +`SafeEjectGPU gpuid {{GPU_ID}} apps` + +- Get the status of a GPU: + +`SafeEjectGPU gpuid {{GPU_ID}} status` + +- Eject a GPU: + +`SafeEjectGPU gpuid {{GPU_ID}} Eject` + +- Launch an app on a GPU: + +`SafeEjectGPU gpuid {{GPU_ID}} LaunchOnGPU {{path/to/App.app}}` diff --git a/osx/say b/osx/say new file mode 100644 index 00000000..5b13cd72 --- /dev/null +++ b/osx/say @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# say + +> Converts text to speech. +> More information: . + +- Say a phrase aloud: + +`say "{{I like to ride my bike.}}"` + +- Read a file aloud: + +`say --input-file={{filename.txt}}` + +- Say a phrase with a custom voice and speech rate: + +`say --voice={{voice}} --rate={{words_per_minute}} "{{I'm sorry Dave, I can't let you do that.}}"` + +- List the available voices (different voices speak in different languages): + +`say --voice="?"` + +- Say something in Polish: + +`say --voice={{Zosia}} "{{Litwo, ojczyzno moja!}}"` + +- Create an audio file of the spoken text: + +`say --output-file={{filename.aiff}} "{{Here's to the Crazy Ones.}}"` diff --git a/osx/screencapture b/osx/screencapture new file mode 100644 index 00000000..001b9d71 --- /dev/null +++ b/osx/screencapture @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# screencapture + +> Utility to take screenshots and screen recordings. +> More information: . + +- Take a screenshot and save it to a file: + +`screencapture {{path/to/file.png}}` + +- Take a screenshot including the mouse cursor: + +`screencapture -C {{path/to/file.png}}` + +- Take a screenshot and open it in Preview, instead of saving: + +`screencapture -P` + +- Take a screenshot of a selected rectangular area: + +`screencapture -i {{path/to/file.png}}` + +- Take a screenshot after a delay: + +`screencapture -T {{seconds}} {{path/to/file.png}}` + +- Make a screen recording and save it to a file: + +`screencapture -v {{path/to/file.mp4}}` diff --git a/osx/scutil b/osx/scutil new file mode 100644 index 00000000..b50ed905 --- /dev/null +++ b/osx/scutil @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# scutil + +> Manage system configuration parameters. +> Necessitates to be root when setting configuration. +> More information: . + +- Display DNS Configuration: + +`scutil --dns` + +- Display proxy configuration: + +`scutil --proxy` + +- Get computer name: + +`scutil --get ComputerName` + +- Set computer name: + +`sudo scutil --set ComputerName {{computer_name}}` + +- Get hostname: + +`scutil --get HostName` + +- Set hostname: + +`scutil --set HostName {{hostname}}` diff --git a/osx/sdef b/osx/sdef new file mode 100644 index 00000000..a7bdeb23 --- /dev/null +++ b/osx/sdef @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sdef + +> Get or generate a scripting definitions (`sdef`) file from a scriptable application. +> More information: . + +- Print the scripting definitions of the given application: + +`sdef {{/Applications/XCode.app}}` diff --git a/osx/secd b/osx/secd new file mode 100644 index 00000000..b0c63916 --- /dev/null +++ b/osx/secd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# secd + +> Controls access to and modification of keychain items. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`secd` diff --git a/osx/security b/osx/security new file mode 100644 index 00000000..66a010d4 --- /dev/null +++ b/osx/security @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# security + +> Administer keychains, keys, certificates and the Security framework. +> More information: . + +- List all available keychains: + +`security list-keychains` + +- Delete a specific keychain: + +`security delete-keychain {{path/to/file.keychain}}` + +- Create a keychain: + +`security create-keychain -p {{password}} {{path/to/file.keychain}}` + +- Set a certificate to use with a website or [s]ervice by its [c]ommon name (fails if several certificates with the same common name exist): + +`security set-identity-preference -s {{URL|hostname|service}} -c "{{common_name}}" {{path/to/file.keychain}}` + +- Add a certificate from file to a [k]eychain (if -k isn't specified, the default keychain is used): + +`security add-certificates -k {{file.keychain}} {{path/to/cert_file.pem}}` + +- Add a CA certificate to the per-user Trust Settings: + +`security add-trusted-cert -k {{path/to/user-keychain.keychain-db}} {{path/to/ca-cert_file.pem}}` + +- Remove a CA certificate from the per-user Trust Settings: + +`security remove-trusted-cert {{path/to/ca-cert_file.pem}}` diff --git a/osx/securityd b/osx/securityd new file mode 100644 index 00000000..3996fa35 --- /dev/null +++ b/osx/securityd @@ -0,0 +1,15 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# securityd + +> This manages security contexts and cryptographic operations. +> Works with secd for keychain access. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`securityd` diff --git a/osx/sed b/osx/sed new file mode 100644 index 00000000..f829ad98 --- /dev/null +++ b/osx/sed @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script_file.sed}}` + +- Replace all `apple` (extended regex) occurrences with `APPLE` (extended regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed -E 's/(apple)/\U\1/g'` + +- Print just a first line to `stdout`: + +`{{command}} | sed -n '1p'` + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in a `file` and save a backup of the original to `file.bak`: + +`sed -i bak 's/apple/mango/g' {{path/to/file}}` diff --git a/osx/setfile b/osx/setfile new file mode 100644 index 00000000..d6084c1c --- /dev/null +++ b/osx/setfile @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# setfile + +> Sets file attributes on files in an HFS+ directory. +> More information: . + +- Set creation date for specific files: + +`setfile -d "{{MM/DD/YYYY HH:MM:SS}}" {{path/to/file1 path/to/file2 ...}}` + +- Set modification date for specific files: + +`setfile -m "{{MM/DD/YYYY HH:MM:SS}}" {{path/to/file1 path/to/file2 ...}}` + +- Set modification date for symlink file (not to linked file itself): + +`setfile -P -m "{{MM/DD/YYYY HH:MM:SS}}" {{path/to/file1 path/to/file2 ...}}` diff --git a/osx/shortcuts b/osx/shortcuts new file mode 100644 index 00000000..2b8cc8c4 --- /dev/null +++ b/osx/shortcuts @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# shortcuts + +> Manage shortcuts. +> Note: you can also use the `Shortcuts` app. +> More information: . + +- Run the specified shortcut (`Count holidays`): + +`shortcuts run "{{Count holidays}}"` + +- Print all shortcuts: + +`shortcuts list` + +- Print all shortcut folders: + +`shortcuts list --folders` + +- Open the specified shortcut (`Count holidays`) in the Shortcuts editor: + +`shortcuts view "{{Count holidays}}"` diff --git a/osx/shuf b/osx/shuf new file mode 100644 index 00000000..8060bd6b --- /dev/null +++ b/osx/shuf @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# shuf + +> Generate random permutations. +> More information: . + +- Randomize the order of lines in a file and output the result: + +`shuf {{filename}}` + +- Only output the first 5 entries of the result: + +`shuf --head-count={{5}} {{filename}}` + +- Write output to another file: + +`shuf {{filename}} --output={{output_filename}}` + +- Generate random numbers in range 1-10: + +`shuf --input-range={{1-10}}` diff --git a/osx/shutdown b/osx/shutdown new file mode 100644 index 00000000..4377554b --- /dev/null +++ b/osx/shutdown @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# shutdown + +> Shutdown and reboot the system. +> More information: . + +- Power off (halt) immediately: + +`shutdown -h now` + +- Sleep immediately: + +`shutdown -s now` + +- Reboot immediately: + +`shutdown -r now` + +- Reboot in 5 minutes: + +`shutdown -r "+{{5}}"` + +- Power off (halt) at 1:00 pm (Uses 24h clock): + +`shutdown -h {{1300}}` + +- Reboot on May 10th 2042 at 11:30 am (Input format: YYMMDDHHMM): + +`shutdown -r {{4205101130}}` diff --git a/osx/signal b/osx/signal new file mode 100644 index 00000000..a069b47b --- /dev/null +++ b/osx/signal @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# signal + +> Simplified software signal facilities. +> More information: . + +- View documentation for signals in macOS: + +`man signal` diff --git a/osx/sips b/osx/sips new file mode 100644 index 00000000..6cd5794f --- /dev/null +++ b/osx/sips @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sips + +> Apple Scriptable Image Processing System. +> Raster/Query images and ColorSync ICC Profiles. +> More information: . + +- Specify an output directory so that originals do not get modified: + +`sips --out {{path/to/out_dir}}` + +- Resample image at specified size, Image aspect ratio may be altered: + +`sips --resampleHeightWidth {{1920}} {{300}} {{image_file.ext}}` + +- Resample image so height and width aren't greater than specified size (notice the capital Z): + +`sips --resampleHeightWidthMax {{1920}} {{300}} {{image_file.ext}}` + +- Resample all images in a directory to fit a width of 960px (honoring aspect ratio): + +`sips --resampleWidth {{960}} {{path/to/images}}` + +- Convert an image from CMYK to RGB: + +`sips --matchTo "/System/Library/ColorSync/Profiles/Generic RGB Profile.icc" {{path/to/image.ext}} {{path/to/out_dir}}` + +- Remove ColorSync ICC profile from an image: + +`sips --deleteProperty profile --deleteColorManagementProperties {{path/to/image_file.ext}}` diff --git a/osx/sntp b/osx/sntp new file mode 100644 index 00000000..179e0c02 --- /dev/null +++ b/osx/sntp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sntp + +> A very Simple Network Time Protocol client program. +> More information: . + +- Query a specified SNTP server and display the time: + +`sntp {{pool.ntp.org}}` + +- Synchronize the system clock with a specified SNTP server: + +`sudo sntp -S {{pool.ntp.org}}` + +- Enable debug logging: + +`sntp -d {{pool.ntp.org}}` diff --git a/osx/sntpd b/osx/sntpd new file mode 100644 index 00000000..fe259629 --- /dev/null +++ b/osx/sntpd @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sntpd + +> An SNTP server. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`sntpd` + +- Overwrite existing state with the local clock (stratum 1), for running a master/primary server, without synchronizing with another (higher stratum) server: + +`sntpd -L` + +- Use a custom file for the SNTP state: + +`sntpd -z {{path/to/state.bin}}` diff --git a/osx/softwareupdate b/osx/softwareupdate new file mode 100644 index 00000000..0682f763 --- /dev/null +++ b/osx/softwareupdate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# softwareupdate + +> Update macOS App Store apps. +> More information: . + +- List all available updates: + +`softwareupdate --list` + +- Download and install all updates: + +`softwareupdate --install --all` + +- Download and install all [r]ecommended updates: + +`softwareupdate --install --recommended` + +- Download and install a specific app: + +`softwareupdate --install {{update_name}}` diff --git a/osx/spctl b/osx/spctl new file mode 100644 index 00000000..9bb935fc --- /dev/null +++ b/osx/spctl @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# spctl + +> Manage the security assessment policy subsystem. +> Utility for managing Gatekeeper in macOS. +> More information: . + +- Turn off Gatekeeper: + +`spctl --master-disable` + +- Add a rule to allow an application to run (labeling of rule is optional): + +`spctl --add --label {{rule_name}} {{path/to/file}}` + +- Turn on Gatekeeper: + +`spctl --master-enable` + +- List all rules on the system: + +`spctl --list` diff --git a/osx/split b/osx/split new file mode 100644 index 00000000..e5ab6972 --- /dev/null +++ b/osx/split @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# split + +> Split a file into pieces. +> More information: . + +- Split a file, each split having 10 lines (except the last split): + +`split -l {{10}} {{filename}}` + +- Split a file by a regular expression. The matching line will be the first line of the next output file: + +`split -p {{cat|^[dh]og}} {{filename}}` + +- Split a file with 512 bytes in each split (except the last split; use 512k for kilobytes and 512m for megabytes): + +`split -b {{512}} {{filename}}` + +- Split a file into 5 files. File is split such that each split has same size (except the last split): + +`split -n {{5}} {{filename}}` diff --git a/osx/spotify b/osx/spotify new file mode 100644 index 00000000..ae9e1dad --- /dev/null +++ b/osx/spotify @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# spotify + +> A command-line interface to Spotify. +> More information: . + +- Find a song by name and play it: + +`spotify play {{song_name}}` + +- Find a playlist by name and play it: + +`spotify play list {{playlist_name}}` + +- Pause (or resume) playback: + +`spotify pause` + +- Skip to the next song in a playlist: + +`spotify next` + +- Change volume: + +`spotify vol {{up|down|value}}` + +- Show the playback status and song details: + +`spotify status` diff --git a/osx/stat b/osx/stat new file mode 100644 index 00000000..9056a381 --- /dev/null +++ b/osx/stat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# stat + +> Display file status. +> More information: . + +- Show file properties such as size, permissions, creation and access dates among others: + +`stat {{path/to/file}}` + +- Same as above but verbose (more similar to Linux's `stat`): + +`stat -x {{path/to/file}}` + +- Show only octal file permissions: + +`stat -f %Mp%Lp {{path/to/file}}` + +- Show owner and group of the file: + +`stat -f "%Su %Sg" {{path/to/file}}` + +- Show the size of the file in bytes: + +`stat -f "%z %N" {{path/to/file}}` diff --git a/osx/sw_vers b/osx/sw_vers new file mode 100644 index 00000000..5c95a8f9 --- /dev/null +++ b/osx/sw_vers @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sw_vers + +> Print macOS operating system version information. +> More information: . + +- Print all available information (OS name, version number, and build): + +`sw_vers` + +- Print only the version number of the operating system: + +`sw_vers -productVersion` + +- Print only the build identifier: + +`sw_vers -buildVersion` diff --git a/osx/symptomsd b/osx/symptomsd new file mode 100644 index 00000000..f09dd789 --- /dev/null +++ b/osx/symptomsd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# symptomsd + +> Provides services for `Symptoms.framework`. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`symptomsd` diff --git a/osx/sysctl b/osx/sysctl new file mode 100644 index 00000000..2903232d --- /dev/null +++ b/osx/sysctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# sysctl + +> Access kernel state information. +> More information: . + +- Show all available variables and their values: + +`sysctl -a` + +- Show Apple model identifier: + +`sysctl -n hw.model` + +- Show CPU model: + +`sysctl -n machdep.cpu.brand_string` + +- Show available CPU features (MMX, SSE, SSE2, SSE3, AES, etc): + +`sysctl -n machdep.cpu.features` + +- Set a changeable kernel state variable: + +`sysctl -w {{section.tunable}}={{value}}` diff --git a/osx/system_profiler b/osx/system_profiler new file mode 100644 index 00000000..6b3ef3e5 --- /dev/null +++ b/osx/system_profiler @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# system_profiler + +> Report system hardware and software configuration. +> More information: . + +- Display a report with specific details level (mini [no personal information], basic or full): + +`system_profiler -detailLevel {{level}}` + +- Display a full system profiler report which can be opened by `System Profiler.app`: + +`system_profiler -xml > MyReport.spx` + +- Display a hardware overview (Model, CPU, Memory, Serial, etc) and software data (System, Kernel, Name, Uptime, etc): + +`system_profiler SPHardwareDataType SPSoftwareDataType` + +- Print the system serial number: + +`system_profiler SPHardwareDataType|grep "Serial Number (system)" | awk '{ print $4 }'` diff --git a/osx/systemsetup b/osx/systemsetup new file mode 100644 index 00000000..039adc34 --- /dev/null +++ b/osx/systemsetup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# systemsetup + +> Configure System Preferences machine settings. +> More information: . + +- Enable remote login (SSH): + +`systemsetup -setremotelogin on` + +- Specify timezone, NTP Server and enable network time: + +`systemsetup -settimezone "{{US/Pacific}}" -setnetworktimeserver {{us.pool.ntp.org}} -setusingnetworktime on` + +- Make the machine never sleep and automatically restart on power failure or kernel panic: + +`systemsetup -setsleep off -setrestartpowerfailure on -setrestartfreeze on` + +- List valid startup disks: + +`systemsetup -liststartupdisks` + +- Specify a new startup disk: + +`systemsetup -setstartupdisk {{path/to/directory}}` diff --git a/osx/systemsoundserverd b/osx/systemsoundserverd new file mode 100644 index 00000000..7a8abea9 --- /dev/null +++ b/osx/systemsoundserverd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# systemsoundserverd + +> Core Audio related daemon. +> It should not be invoked manually. + +- Start the daemon: + +`systemsoundserverd` diff --git a/osx/tail b/osx/tail new file mode 100644 index 00000000..7b259a8f --- /dev/null +++ b/osx/tail @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# tail + +> Display the last part of a file. +> See also: `head`. +> More information: . + +- Show last 'count' lines in file: + +`tail -n {{8}} {{path/to/file}}` + +- Print a file from a specific line number: + +`tail -n +{{8}} {{path/to/file}}` + +- Print a specific count of bytes from the end of a given file: + +`tail -c {{8}} {{path/to/file}}` + +- Print the last lines of a given file and keep reading file until `Ctrl + C`: + +`tail -f {{path/to/file}}` + +- Keep reading file until `Ctrl + C`, even if the file is inaccessible: + +`tail -F {{path/to/file}}` + +- Show last 'count' lines in 'file' and refresh every 'seconds' seconds: + +`tail -n {{8}} -s {{10}} -f {{path/to/file}}` diff --git a/osx/tart b/osx/tart new file mode 100644 index 00000000..5fc1c1b2 --- /dev/null +++ b/osx/tart @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# tart + +> Build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon. +> More information: . + +- Pull a remote VM image: + +`tart pull {{acme.io/org/name:tag}}` + +- Clone a VM from a local or remote image source: + +`tart clone {{source-vm}} {{vm-name}}` + +- Create a new Mac VM from a specific ipsw file: + +`tart create --from-ipsw={{latest|path/to/file.ipsw}} {{vm-name}}` + +- Run an existing VM: + +`tart run {{vm-name}}` + +- Run an existing VM with a specific mounted directory: + +`tart run --dir={{path/to/directory}}:{{/path/to/local_directory}} {{vm-name}}` + +- List VMs: + +`tart list` + +- Get IP address of a running VM: + +`tart ip {{vm-name}}` + +- Change a VM's display resolution: + +`tart set {{vm-name}} --display {{640}}x{{400}}` diff --git a/osx/terminal-notifier b/osx/terminal-notifier new file mode 100644 index 00000000..acc719ca --- /dev/null +++ b/osx/terminal-notifier @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# terminal-notifier + +> Send macOS User Notifications. +> More information: . + +- Send a notification (only the message is required): + +`terminal-notifier -group {{tldr-info}} -title {{TLDR}} -message '{{TLDR rocks}}'` + +- Display piped data with a sound: + +`echo '{{Piped Message Data!}}' | terminal-notifier -sound {{default}}` + +- Open a URL when the notification is clicked: + +`terminal-notifier -message '{{Check your Apple stock!}}' -open '{{http://finance.yahoo.com/q?s=AAPL}}'` + +- Open an app when the notification is clicked: + +`terminal-notifier -message '{{Imported 42 contacts.}}' -activate {{com.apple.AddressBook}}` diff --git a/osx/textutil b/osx/textutil new file mode 100644 index 00000000..c29b10fa --- /dev/null +++ b/osx/textutil @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# textutil + +> Manipulate text files of various formats. +> More information: . + +- Display information about `foo.rtf`: + +`textutil -info {{path/to/foo.rtf}}` + +- Convert `foo.rtf` into `foo.html`: + +`textutil -convert {{html}} {{path/to/foo.rtf}}` + +- Convert rich text to normal text: + +`textutil {{path/to/foo.rtf}} -convert {{txt}}` + +- Convert `foo.txt` into `foo.rtf`, using Times 10 for the font: + +`textutil -convert {{rtf}} -font {{Times}} -fontsize {{10}} {{path/to/foo.txt}}` + +- Load all RTF files in the current directory, concatenates their contents, and writes the result out as `index.html` with the HTML title set to "Several Files": + +`textutil -cat {{html}} -title "Several Files" -output {{path/to/index.html}} *.rtf` diff --git a/osx/timed b/osx/timed new file mode 100644 index 00000000..fbcfd4ec --- /dev/null +++ b/osx/timed @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# timed + +> Service that synchronizes system time (e.g. using NTP). +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`timed` diff --git a/osx/tmutil b/osx/tmutil new file mode 100644 index 00000000..da7adfeb --- /dev/null +++ b/osx/tmutil @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# tmutil + +> Utility for managing Time Machine backups. Most verbs require root privileges. +> More information: . + +- Set an HFS+ drive as the backup destination: + +`sudo tmutil setdestination {{path/to/disk_mount_point}}` + +- Set an APF share or SMB share as the backup destination: + +`sudo tmutil setdestination "{{protocol://user[:password]@host/share}}"` + +- Append the given destination to the list of destinations: + +`sudo tmutil setdestination -a {{destination}}` + +- Enable automatic backups: + +`sudo tmutil enable` + +- Disable automatic backups: + +`sudo tmutil disable` + +- Start a backup, if one is not running already, and release control of the shell: + +`sudo tmutil startbackup` + +- Start a backup and block until the backup is finished: + +`sudo tmutil startbackup -b` + +- Stop a backup: + +`sudo tmutil stopbackup` diff --git a/osx/top b/osx/top new file mode 100644 index 00000000..8a91a28e --- /dev/null +++ b/osx/top @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# top + +> Display dynamic real-time information about running processes. +> More information: . + +- Start `top`, all options are available in the interface: + +`top` + +- Start `top` sorting processes by internal memory size (default order - process ID): + +`top -o mem` + +- Start `top` sorting processes first by CPU, then by running time: + +`top -o cpu -O time` + +- Start `top` displaying only processes owned by given user: + +`top -user {{user_name}}` + +- Display help about interactive commands: + +`?` diff --git a/osx/translationd b/osx/translationd new file mode 100644 index 00000000..2a919b7e --- /dev/null +++ b/osx/translationd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# translationd + +> Enables Translation features. +> It should not be invoked manually. + +- Start the daemon: + +`translationd` diff --git a/osx/uname b/osx/uname new file mode 100644 index 00000000..9fbfd567 --- /dev/null +++ b/osx/uname @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# uname + +> Print details about the current machine and the operating system running on it. +> Note: for additional information about the operating system, try the `sw_vers` command. +> More information: . + +- Print kernel name: + +`uname` + +- Print system architecture and processor information: + +`uname -mp` + +- Print kernel name, kernel release and kernel version: + +`uname -srv` + +- Print system hostname: + +`uname -n` + +- Print all available system information: + +`uname -a` diff --git a/osx/universalaccessd b/osx/universalaccessd new file mode 100644 index 00000000..7aca50fb --- /dev/null +++ b/osx/universalaccessd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# universalaccessd + +> Provides universal access services. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`universalaccessd` diff --git a/osx/uptime b/osx/uptime new file mode 100644 index 00000000..cd05ad27 --- /dev/null +++ b/osx/uptime @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# uptime + +> Tell how long the system has been running and other information. +> More information: . + +- Print current time, uptime, number of logged-in users and other information: + +`uptime` diff --git a/osx/usernoted b/osx/usernoted new file mode 100644 index 00000000..24c14c91 --- /dev/null +++ b/osx/usernoted @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# usernoted + +> Provides notification services. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`usernoted` diff --git a/osx/uuidgen b/osx/uuidgen new file mode 100644 index 00000000..b7d72478 --- /dev/null +++ b/osx/uuidgen @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# uuidgen + +> Generate new UUID (Universally Unique IDentifier) strings. +> More information: . + +- Generate a UUID string: + +`uuidgen` diff --git a/osx/valet b/osx/valet new file mode 100644 index 00000000..1b2d8c0f --- /dev/null +++ b/osx/valet @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# valet + +> A Laravel development environment that allows hosting sites via local tunnels on `http://.test`. +> More information: . + +- Start the valet daemon: + +`valet start` + +- Register the current working directory as a path that Valet should search for sites: + +`valet park` + +- View 'parked' paths: + +`valet paths` + +- Serve a single site instead of an entire directory: + +`valet link {{application_name}}` + +- Share a project via an Ngrok tunnel: + +`valet share` diff --git a/osx/vm_stat b/osx/vm_stat new file mode 100644 index 00000000..ab4bf9ef --- /dev/null +++ b/osx/vm_stat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# vm_stat + +> Show virtual memory statistics. +> More information: . + +- Display virtual memory statistics: + +`vm_stat` + +- Display reports every 2 seconds for 5 times: + +`vm_stat -c {{5}} {{2}}` diff --git a/osx/vpnd b/osx/vpnd new file mode 100644 index 00000000..0fa909f6 --- /dev/null +++ b/osx/vpnd @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# vpnd + +> Listens for incoming VPN connections. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`vpnd` + +- Run the daemon in the foreground: + +`vpnd -x` + +- Run the daemon in the foreground and print logs to the terminal: + +`vpnd -d` + +- Run the daemon in the foreground, print logs to the terminal, and quit after validating arguments: + +`vpnd -n` + +- Run the daemon for a specific server configuration: + +`vpnd -i {{server_id}}` + +- Display help: + +`vpnd -h` diff --git a/osx/w b/osx/w new file mode 100644 index 00000000..e73af5a0 --- /dev/null +++ b/osx/w @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# w + +> Show who is logged on and what they are doing. +> Print user login, TTY, remote host, login time, idle time, current process. +> More information: . + +- Show logged-in users information: + +`w` + +- Show logged-in users information without a header: + +`w -h` + +- Show information about logged-in users, sorted by their idle time: + +`w -i` diff --git a/osx/wacaw b/osx/wacaw new file mode 100644 index 00000000..b7edd607 --- /dev/null +++ b/osx/wacaw @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wacaw + +> Command-line tool for macOS to capture both still pictures and video from an attached camera. +> More information: . + +- Take a picture from webcam: + +`wacaw {{filename}}` + +- Record a video: + +`wacaw --video {{filename}} --duration {{10}}` + +- Take a picture with custom resolution: + +`wacaw --width {{width}} --height {{100}} {{filename}}` + +- Copy image just taken to clipboard: + +`wacaw --to-clipboard` + +- List the devices available: + +`wacaw --list-devices` diff --git a/osx/warmd b/osx/warmd new file mode 100644 index 00000000..e57d50dd --- /dev/null +++ b/osx/warmd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# warmd + +> Controls caches used during startup and login. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`warmd` diff --git a/osx/watchdogd b/osx/watchdogd new file mode 100644 index 00000000..dddeba34 --- /dev/null +++ b/osx/watchdogd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# watchdogd + +> Works with the Watchdog KEXT to ensure that the system is healthy and running. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`watchdogd` diff --git a/osx/watchlistd b/osx/watchlistd new file mode 100644 index 00000000..30b6b23f --- /dev/null +++ b/osx/watchlistd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# watchlistd + +> Manages the Apple TV app's watch list. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`watchlistd` diff --git a/osx/wc b/osx/wc new file mode 100644 index 00000000..ddba8a58 --- /dev/null +++ b/osx/wc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wc + +> Count lines, words, or bytes. +> More information: . + +- Count lines in file: + +`wc -l {{path/to/file}}` + +- Count words in file: + +`wc -w {{path/to/file}}` + +- Count characters (bytes) in file: + +`wc -c {{path/to/file}}` + +- Count characters in file (taking multi-byte character sets into account): + +`wc -m {{path/to/file}}` + +- Use `stdin` to count lines, words and characters (bytes) in that order: + +`{{find .}} | wc` diff --git a/osx/webinspectord b/osx/webinspectord new file mode 100644 index 00000000..f065e70c --- /dev/null +++ b/osx/webinspectord @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# webinspectord + +> Relays commands between Web Inspector and remote targets like WKWebView. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`webinspectord` diff --git a/osx/whatis b/osx/whatis new file mode 100644 index 00000000..822f7c7d --- /dev/null +++ b/osx/whatis @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# whatis + +> Search a set of database files for short descriptions of system commands for keywords. +> More information: . + +- Search for information about keyword: + +`whatis {{keyword}}` + +- Search for information about multiple keywords: + +`whatis {{keyword1}} {{keyword2}}` diff --git a/osx/whence b/osx/whence new file mode 100644 index 00000000..cf31bc54 --- /dev/null +++ b/osx/whence @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# whence + +> A zsh builtin to indicate how a command would be interpreted. +> More information: . + +- Interpret `command`, with expansion if defined as an `alias` (similar to the `command -v` builtin): + +`whence "{{command}}"` + +- Display type of `command`, with location if defined as a function, or binary (equivalent to the `type` and `command -V` builtins): + +`whence -v "{{command}}"` + +- Same as above, except display content of shell functions instead of location (equivalent to `which` builtin): + +`whence -c "{{command}}"` + +- Same as above, but show all occurrences on command path (equivalent to the `where` builtin): + +`whence -ca "{{command}}"` + +- Search only the `PATH` for `command`, ignoring builtins, aliases or shell functions (equivalent to the `where` command): + +`whence -p "{{command}}"` diff --git a/osx/wifi-password b/osx/wifi-password new file mode 100644 index 00000000..086f8695 --- /dev/null +++ b/osx/wifi-password @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wifi-password + +> Get the password of the Wi-Fi. +> More information: . + +- Get the password for the Wi-Fi you are currently logged onto: + +`wifi-password` + +- Get the password for the Wi-Fi with a specific SSID: + +`wifi-password {{ssid}}` + +- Print only the password as output: + +`wifi-password -q` diff --git a/osx/wifivelocityd b/osx/wifivelocityd new file mode 100644 index 00000000..6eef2cdb --- /dev/null +++ b/osx/wifivelocityd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wifivelocityd + +> XPC helper for performing system context actions for the WiFiVelocity framework. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`wifivelocityd` diff --git a/osx/wps b/osx/wps new file mode 100644 index 00000000..8f0a4e95 --- /dev/null +++ b/osx/wps @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wps + +> Assists AirPort in connecting to a network using Wireless Protected Setup. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`wps` diff --git a/osx/wwand b/osx/wwand new file mode 100644 index 00000000..7c90ecdb --- /dev/null +++ b/osx/wwand @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# wwand + +> USB WWAN device configuration daemon. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`wwand` diff --git a/osx/xartstorageremoted b/osx/xartstorageremoted new file mode 100644 index 00000000..e5f23011 --- /dev/null +++ b/osx/xartstorageremoted @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xartstorageremoted + +> The xART Remote Storage Daemon. Receives save/fetch requests from the CoProcessor. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`xartstorageremoted` diff --git a/osx/xattr b/osx/xattr new file mode 100644 index 00000000..28f9515a --- /dev/null +++ b/osx/xattr @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xattr + +> Utility to work with extended filesystem attributes. +> More information: . + +- List key:value extended attributes for a given file: + +`xattr -l {{file}}` + +- Write an attribute for a given file: + +`xattr -w {{attribute_key}} {{attribute_value}} {{file}}` + +- Delete an attribute from a given file: + +`xattr -d {{com.apple.quarantine}} {{file}}` + +- Delete all extended attributes from a given file: + +`xattr -c {{file}}` + +- Recursively delete an attribute in a given directory: + +`xattr -rd {{attribute_key}} {{directory}}` diff --git a/osx/xcode-select b/osx/xcode-select new file mode 100644 index 00000000..ad0261bd --- /dev/null +++ b/osx/xcode-select @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xcode-select + +> Switch between different versions of Xcode and the included developer tools. +> Also used to update the path to Xcode if it is moved after installation. +> More information: . + +- Install Xcode's command-line tools: + +`xcode-select --install` + +- Select a given path as the active developer directory: + +`xcode-select --switch {{path/to/Xcode.app/Contents/Developer}}` + +- Select a given Xcode instance and use its developer directory as the active one: + +`xcode-select --switch {{path/to/Xcode_file.app}}` + +- Print the currently selected developer directory: + +`xcode-select --print-path` + +- Discard any user-specified developer directory so that it will be found via the default search mechanism: + +`sudo xcode-select --reset` diff --git a/osx/xcodebuild b/osx/xcodebuild new file mode 100644 index 00000000..d6a37144 --- /dev/null +++ b/osx/xcodebuild @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xcodebuild + +> Build Xcode projects. +> More information: . + +- Build workspace: + +`xcodebuild -workspace {{workspace_name.workspace}} -scheme {{scheme_name}} -configuration {{configuration_name}} clean build SYMROOT={{SYMROOT_path}}` + +- Build project: + +`xcodebuild -target {{target_name}} -configuration {{configuration_name}} clean build SYMROOT={{SYMROOT_path}}` + +- Show SDKs: + +`xcodebuild -showsdks` diff --git a/osx/xcodes b/osx/xcodes new file mode 100644 index 00000000..24626913 --- /dev/null +++ b/osx/xcodes @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xcodes + +> Download, install and manage multiple Xcode versions. +> See also: `xcodes runtimes`. +> More information: . + +- List all installed Xcode versions: + +`xcodes installed` + +- List all available Xcode versions: + +`xcodes list` + +- Select an Xcode version by specifying a version number or a path: + +`xcodes select {{xcode_version|path/to/Xcode.app}}` + +- Download and install a specific Xcode version: + +`xcodes install {{xcode_version}}` + +- Install the latest Xcode release and select it: + +`xcodes install --latest --select` + +- Download a specific Xcode version archive to a given directory without installing it: + +`xcodes download {{xcode_version}} --directory {{path/to/directory}}` diff --git a/osx/xcodes-runtimes b/osx/xcodes-runtimes new file mode 100644 index 00000000..d2f2525d --- /dev/null +++ b/osx/xcodes-runtimes @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xcodes runtimes + +> Manage Xcode Simulator runtimes. +> More information: . + +- Display all available Simulator runtimes: + +`xcodes runtimes --include-betas` + +- Download a Simulator runtime: + +`xcodes runtimes download {{runtime_name}}` + +- Download and install a Simulator runtime: + +`xcodes runtimes install {{runtime_name}}` + +- Download/install a Simulator runtime for specific iOS/watchOS/tvOS/visionOS version (must be written as case-sensitive): + +`xcodes runtimes {{download|install}} "{{iOS|watchOS|tvOS|visionOS}} {{runtime_version}}"` + +- Set a specific location where the runtime archive will be first downloaded (defaults to `~/Downloads`): + +`xcodes runtimes {{download|install}} {{runtime_name}} --directory {{path/to/directory}}` + +- Do not delete the downloaded archive when the Simulator is successfully installed: + +`xcodes runtimes install {{runtime_name}} --keep-archive` diff --git a/osx/xcrun b/osx/xcrun new file mode 100644 index 00000000..f0239a13 --- /dev/null +++ b/osx/xcrun @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xcrun + +> Run or locate development tools and properties. +> More information: . + +- Find and run a tool from the active developer directory: + +`xcrun {{tool}} {{arguments}}` + +- Show verbose output: + +`xcrun {{tool}} {{arguments}} --verbose` + +- Find a tool for a given SDK: + +`xcrun --sdk {{sdk_name}}` + +- Find a tool for a given toolchain: + +`xcrun --toolchain {{name}}` + +- Display help: + +`xcrun --help` + +- Display version: + +`xcrun --version` diff --git a/osx/xctool b/osx/xctool new file mode 100644 index 00000000..36b4f9ed --- /dev/null +++ b/osx/xctool @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xctool + +> Build Xcode projects. +> More information: . + +- Build a single project without any workspace: + +`xctool -project {{YourProject.xcodeproj}} -scheme {{YourScheme}} build` + +- Build a project that is part of a workspace: + +`xctool -workspace {{YourWorkspace.xcworkspace}} -scheme {{YourScheme}} build` + +- Clean, build and execute all the tests: + +`xctool -workspace {{YourWorkspace.xcworkspace}} -scheme {{YourScheme}} clean build test` diff --git a/osx/xed b/osx/xed new file mode 100644 index 00000000..204b1352 --- /dev/null +++ b/osx/xed @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xed + +> Opens files for editing in Xcode. +> More information: . + +- Open file in Xcode: + +`xed {{path/to/file1 path/to/file2 ...}}` + +- Open file(s) in Xcode, create if it doesn't exist: + +`xed --create {{path/to/file1 path/to/file2 ...}}` + +- Open a file in Xcode and jump to line number 75: + +`xed --line 75 {{path/to/file}}` diff --git a/osx/xip b/osx/xip new file mode 100644 index 00000000..c1b9562e --- /dev/null +++ b/osx/xip @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xip + +> Create or expand compressed files in a secure xip archive. +> Only archives signed by Apple are trusted, so this tool should not be used to create archives. +> More information: . + +- Expand the archive into the current working directory: + +`xip --expand {{path/to/file.xip}}` diff --git a/osx/xml2man b/osx/xml2man new file mode 100644 index 00000000..e55fae85 --- /dev/null +++ b/osx/xml2man @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xml2man + +> Compile MPGL to mdoc. +> More information: . + +- Compile an MPGL file to a viewable man page: + +`xml2man {{path/to/command_file.mxml}}` + +- Compile an MPGL file to a specific output file: + +`xml2man {{path/to/service_file.mxml}} {{path/to/service_file.7}}` + +- Compile an MPGL file to a specific output file, overwriting if it already exists: + +`xml2man -f {{path/to/function_file.mxml}} {{path/to/function_file.3}}` diff --git a/osx/xsand b/osx/xsand new file mode 100644 index 00000000..307babe3 --- /dev/null +++ b/osx/xsand @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xsand + +> Xsan file system management daemon. Provides services for the Xsan file system. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`xsand` diff --git a/osx/xsltproc b/osx/xsltproc new file mode 100644 index 00000000..5464544f --- /dev/null +++ b/osx/xsltproc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# xsltproc + +> Transform XML with XSLT to produce output (usually HTML or XML). +> More information: . + +- Transform an XML file with a specific XSLT stylesheet: + +`xsltproc --output {{path/to/output_file.html}} {{path/to/stylesheet_file.xslt}} {{path/to/file.xml}}` + +- Pass a value to a parameter in the stylesheet: + +`xsltproc --output {{path/to/output_file.html}} --stringparam "{{name}}" "{{value}}" {{path/to/stylesheet_file.xslt}} {{path/to/xml_file.xml}}` diff --git a/osx/yaa b/osx/yaa new file mode 100644 index 00000000..d17d7856 --- /dev/null +++ b/osx/yaa @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# yaa + +> Create and manipulate YAA archives. +> More information: . + +- Create an archive from a directory: + +`yaa archive -d {{path/to/directory}} -o {{path/to/output_file.yaa}}` + +- Create an archive from a file: + +`yaa archive -i {{path/to/file}} -o {{path/to/output_file.yaa}}` + +- Extract an archive to the current directory: + +`yaa extract -i {{path/to/archive_file.yaa}}` + +- List the contents of an archive: + +`yaa list -i {{path/to/archive_file.yaa}}` + +- Create an archive with a specific compression algorithm: + +`yaa archive -a {{algorithm}} -d {{path/to/directory}} -o {{path/to/output_file.yaa}}` + +- Create an archive with an 8 MB block size: + +`yaa archive -b {{8m}} -d {{path/to/directory}} -o {{path/to/output_file.yaa}}` diff --git a/osx/yabai b/osx/yabai new file mode 100644 index 00000000..cf41169d --- /dev/null +++ b/osx/yabai @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# yabai + +> A tiling window manager for macOS based on binary space partitioning. +> More information: . + +- Send a config [m]essage for setting the layout: + +`yabai -m config layout {{bsp|stack|float}}` + +- Set the window gap in pt: + +`yabai -m config window_gap {{10}}` + +- Enable opacity: + +`yabai -m config window_opacity on` + +- Disable window shadow: + +`yabai -m config window_shadow off` + +- Enable status bar: + +`yabai -m config status_bar on` diff --git a/ouch b/ouch new file mode 100644 index 00000000..b24c512a --- /dev/null +++ b/ouch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ouch + +> Command-line utility for compressing and decompressing files and directories. +> More information: . + +- Decompress a specific file: + +`ouch decompress {{path/to/archive.tar.xz}}` + +- Decompress a file to a specific location: + +`ouch decompress {{path/to/archive.tar.xz}} --dir {{path/to/directory}}` + +- Decompress multiple files: + +`ouch decompress {{path/to/archive1.tar path/to/archive2.tar.gz ...}}` + +- Compress files: + +`ouch compress {{path/to/file1 path/to/file2 ...}} {{path/to/archive.zip}}` diff --git a/p10k b/p10k new file mode 100644 index 00000000..908464ee --- /dev/null +++ b/p10k @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# p10k + +> Manage configurations for powerlevel10k. +> More information: . + +- Configure powerlevel10k interactively: + +`p10k configure` + +- Reload powerlevel10k: + +`p10k reload` + +- Display help: + +`p10k help` diff --git a/p4 b/p4 new file mode 100644 index 00000000..25a7e307 --- /dev/null +++ b/p4 @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# p4 + +> Perforce Version Control System. +> More information: . + +- Log in to the Perforce service: + +`p4 login -a` + +- Create a client: + +`p4 client` + +- Copy files from depot into the client workspace: + +`p4 sync` + +- Create or edit changelist description: + +`p4 change` + +- Open a file to edit: + +`p4 edit -c {{changelist_number}} {{path/to/file}}` + +- Open a new file to add it to the depot: + +`p4 add` + +- Display list of files modified by changelist: + +`p4 describe -c {{changelist_number}}` + +- Submit a changelist to the depot: + +`p4 submit -c {{changelist_number}}` diff --git a/p5 b/p5 new file mode 100644 index 00000000..7d88513e --- /dev/null +++ b/p5 @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# p5 + +> Template builder and sketch manager for p5.js. +> More information: . + +- Create a new p5 collection: + +`p5 new {{collection_name}}` + +- Generate a new p5 project (should be run from collection directory): + +`p5 generate {{project_name}}` + +- Run the p5 manager server: + +`p5 server` + +- Update libraries to their latest versions: + +`p5 update` diff --git a/p7zip b/p7zip new file mode 100644 index 00000000..9fd947a9 --- /dev/null +++ b/p7zip @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# p7zip + +> Wrapper of 7-Zip file archiver with high compression ratio. +> Internally executes either 7za or 7zr command. +> More information: . + +- Archive a file, replacing it with a 7zipped compressed version: + +`p7zip {{path/to/file}}` + +- Archive a file keeping the input file: + +`p7zip -k {{path/to/file}}` + +- Decompress a file, replacing it with the original uncompressed version: + +`p7zip -d {{compressed.ext}}.7z` + +- Decompress a file keeping the input file: + +`p7zip -d -k {{compressed.ext}}.7z` + +- Skip some checks and force compression or decompression: + +`p7zip -f {{path/to/file}}` diff --git a/paci b/paci new file mode 100644 index 00000000..34d8d85c --- /dev/null +++ b/paci @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# paci + +> A package manager for Bash scripts. +> More information: . + +- Update the list of available packages and versions (it's recommended to run this before other `paci` commands): + +`paci refresh` + +- Configure its behaviour: + +`paci configure` + +- Search for a given package: + +`paci search {{package}}` + +- Install a package: + +`paci install {{package}}` + +- Update a package: + +`paci update {{package}}` diff --git a/packer b/packer new file mode 100644 index 00000000..f98595d9 --- /dev/null +++ b/packer @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# packer + +> Build automated machine images. +> More information: . + +- Build an image: + +`packer build {{path/to/config.json}}` + +- Check the syntax of a Packer image config: + +`packer validate {{path/to/config.json}}` + +- Format a Packer image config: + +`packer fmt {{path/to/config.pkr.hcl}}` diff --git a/packtpub b/packtpub new file mode 100644 index 00000000..36ff2bdd --- /dev/null +++ b/packtpub @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# packtpub + +> Download freely offered books from packtpub.com. +> More information: . + +- Download the daily offer book into the current directory with the specified book format (defaults to `pdf`): + +`packtpub download --type {{pdf|ebup|mobi}}` + +- Download the daily offer book into the specified directory: + +`packtpub download --dir {{path/to/directory}}` + +- Start an interactive login to packtpub.com: + +`packtpub login` + +- Log out from packtpub.com: + +`packtpub logout` + +- Display the daily offer: + +`packtpub view-offer` + +- Open the daily offer in the default web browser: + +`packtpub view-offer` + +- Display the currently logged-in user: + +`packtpub whoami` diff --git a/packwiz b/packwiz new file mode 100644 index 00000000..653a5855 --- /dev/null +++ b/packwiz @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# packwiz + +> Create, edit and manage Minecraft modpacks. +> More information: . + +- Interactively create a new modpack in the current directory: + +`packwiz init` + +- Add a mod from Modrinth or Curseforge: + +`packwiz {{modrinth|curseforge}} add {{url|slug|search_term}}` + +- List all mods in the modpack: + +`packwiz list` + +- Update `index.toml` after manually editing files: + +`packwiz refresh` + +- Export as a Modrinth (`.mrpack`) or Curseforge (`.zip`) file: + +`packwiz {{modrinth|curseforge}} export` diff --git a/pactl b/pactl new file mode 100644 index 00000000..50b59752 --- /dev/null +++ b/pactl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pactl + +> Control a running PulseAudio sound server. +> More information: . + +- List all sinks (or other types - sinks are outputs and sink-inputs are active audio streams): + +`pactl list {{sinks}} short` + +- Change the default sink (output) to 1 (the number can be retrieved via the `list` subcommand): + +`pactl set-default-sink {{1}}` + +- Move sink-input 627 to sink 1: + +`pactl move-sink-input {{627}} {{1}}` + +- Set the volume of sink 1 to 75%: + +`pactl set-sink-volume {{1}} {{0.75}}` + +- Toggle mute on the default sink (using the special name `@DEFAULT_SINK@`): + +`pactl set-sink-mute {{@DEFAULT_SINK@}} toggle` diff --git a/pageres b/pageres new file mode 100644 index 00000000..b5a0e395 --- /dev/null +++ b/pageres @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pageres + +> Capture screenshots of websites in various resolutions. +> More information: . + +- Take multiple screenshots of multiple URLs at different resolutions: + +`pageres {{https://example.com/}} {{https://example2.com/}} {{1366x768}} {{1600x900}}` + +- Provide specific options for a URL, overriding global options: + +`pageres [{{https://example.com/}} {{1366x768}} --no-crop] [{{https://example2.com/}} {{1024x768}}] --crop` + +- Provide a custom filename template: + +`pageres {{https://example.com/}} {{1024x768}} --filename={{'<%= date %> - <%= url %>'}}` + +- Capture a specific element on a page: + +`pageres {{https://example.com/}} {{1366x768}} --selector='{{.page-header}}'` + +- Hide a specific element: + +`pageres {{https://example.com/}} {{1366x768}} --hide='{{.page-header}}'` + +- Capture a screenshot of a local file: + +`pageres {{local_file_path.html}} {{1366x768}}` diff --git a/pake b/pake new file mode 100644 index 00000000..e5931453 --- /dev/null +++ b/pake @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pake + +> Turn any webpage into a desktop app with Rust/Tauri. +> More information: . + +- Package a web page: + +`pake {{https://www.google.com/}}` + +- Package a web page with a specific window size: + +`pake --width {{800}} --height {{600}} {{https://www.google.com/}}` + +- Package a web page with a custom application name and icon: + +`pake --name {{Google}} --icon {{path/to/icon.ico}} {{https://www.google.com/}}` + +- Package a web page with a non-resizable window: + +`pake --no-resizable {{https://www.google.com/}}` + +- Package a web page with fullscreen mode: + +`pake --fullscreen {{https://www.google.com/}}` + +- Package a web page with a transparent title bar: + +`pake --transparent {{https://www.google.com/}}` diff --git a/palmtopnm b/palmtopnm new file mode 100644 index 00000000..3d621fec --- /dev/null +++ b/palmtopnm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# palmtopnm + +> Convert a Palm bitmap file to a PNM image. +> More information: . + +- Convert a Palm bitmap to a PNM image: + +`palmtopnm {{path/to/file.palm}} > {{path/to/file.pnm}}` + +- Display information about the input file: + +`palmtopnm -verbose {{path/to/file.palm}} > {{path/to/file.pnm}}` + +- Convert the n'th rendition of the image contained in the input file: + +`palmtopnm -rendition {{n}} {{path/to/file.palm}} > {{path/to/file.pnm}}` + +- Write a histogram of the colors in the input file to `stdout`: + +`palmtopnm -showhist {{path/to/file.palm}} > {{path/to/file.pnm}}` + +- Output the transparent color of the input image if set: + +`palmtopnm -transparent {{path/to/file.palm}}` diff --git a/pambackground b/pambackground new file mode 100644 index 00000000..c1d58583 --- /dev/null +++ b/pambackground @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pambackground + +> Create a mask of the background in a PAM image. +> See also: `pbmmask`. +> More information: . + +- Create a mask of the background in a PAM image: + +`pambackground {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pamcomp b/pamcomp new file mode 100644 index 00000000..5d999a7b --- /dev/null +++ b/pamcomp @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamcomp + +> Overlay two PAM images. +> More information: . + +- Overlay two images such with the overlay blocking parts of the underlay: + +`pamcomp {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` + +- Set the horizontal alignment of the overlay: + +`pamcomp -align {{left|center|right|beyondleft|beyondright}} -xoff {{x_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` + +- Set the vertical alignment of the overlay: + +`pamcomp -valign {{top|middle|bottom|above|below}} -yoff {{y_offset}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` + +- Set the opacity of the overlay: + +`pamcomp -opacity {{0.7}} {{path/to/overlay.pam}} {{path/to/underlay.pam}} > {{path/to/output.pam}}` diff --git a/pamdepth b/pamdepth new file mode 100644 index 00000000..25808fda --- /dev/null +++ b/pamdepth @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamdepth + +> Reduce the depth (i.e. color resolution) in an image. +> More information: . + +- Read a PBM image, set its maxval and save it to a file: + +`pamdepth {{maxval}} {{path/to/image.pbm}} > {{path/to/file.pbm}}` diff --git a/pamditherbw b/pamditherbw new file mode 100644 index 00000000..ec0bb7e4 --- /dev/null +++ b/pamditherbw @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamditherbw + +> Apply dithering to a greyscale image, i.e. turn it into a pattern of black and white pixels that look the same as the original greyscale. +> See also: `pbmreduce`. +> More information: . + +- Read a PGM image, apply dithering and save it to a file: + +`ppmditherbw {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Use the specified quantization method: + +`ppmditherbw -{{floyd|fs|atkinson|threshold|hilbert|...}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Use the atkinson quantization method and the specified seed for a pseudo-random number generator: + +`ppmditherbw -atkinson -randomseed {{1337}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Specify the thresholding value for quantization methods that perform some sort of thresholding: + +`ppmditherbw -{{fs|atkinson|thresholding}} -value {{0.3}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` diff --git a/pamenlarge b/pamenlarge new file mode 100644 index 00000000..fdeec1f8 --- /dev/null +++ b/pamenlarge @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamenlarge + +> Enlarge a PAM image by duplicating pixels. +> See also: `pbmreduce`, `pamditherbw`, `pbmpscale`. +> More information: . + +- Enlarge the specified image by the specified factor: + +`pamenlarge -scale {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` + +- Enlarge the specified image by the specified factors horizontally and vertically: + +`pamenlarge -xscale {{XN}} -yscale {{YN}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pamfile b/pamfile new file mode 100644 index 00000000..a3cd5ac8 --- /dev/null +++ b/pamfile @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamfile + +> Describe Netpbm (PAM or PNM) files. +> More information: . + +- Describe the specified Netpbm files: + +`pamfile {{path/to/file1 path/to/file2 ...}}` + +- Describe every image in each input file (as opposed to only the first image in each file) in a machine-readable format: + +`pamfile -allimages -machine {{path/to/file}}` + +- Display a count on how many images the input files contain: + +`pamfile -count {{path/to/file}}` diff --git a/pamflip b/pamflip new file mode 100644 index 00000000..4ae36f63 --- /dev/null +++ b/pamflip @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamflip + +> Flip or rotate a PAM or PNM image. +> More information: . + +- Rotate the input image counter-clockwise for a specific degree: + +`pamflip -rotate{{90|180|270}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Flip left for right: + +`pamflip -leftright {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Flip top for bottom: + +`pamflip -topbottom {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Flip the input image on the main diagonal: + +`pamflip -transpose {{path/to/input.pam}} > {{path/to/output.pam}}` diff --git a/pamfunc b/pamfunc new file mode 100644 index 00000000..3b1faa13 --- /dev/null +++ b/pamfunc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamfunc + +> Apply a simple arithmetic function to a Netpbm image. +> More information: . + +- Apply the specified arithmetic function with `n` as the second argument to each sample in the specified PAM image: + +`pamfunc -{{multiplier|divisor|adder|subtractor|min|max}} {{n}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Apply the specified bit string function with `n` as the second argument to each sample in the specified PAM image: + +`pamfunc -{{andmask|ormask|xormask|shiftleft|shiftright}} {{n}} {{path/to/input.pam}} > {{path/to/output.pam}}` diff --git a/pamixer b/pamixer new file mode 100644 index 00000000..d1e28db8 --- /dev/null +++ b/pamixer @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamixer + +> A simple command-line mixer for PulseAudio. +> More information: . + +- List all sinks and sources with their corresponding IDs: + +`pamixer --list-sinks --list-sources` + +- Set the volume to 75% on the default sink: + +`pamixer --set-volume {{75}}` + +- Toggle mute on a sink other than the default: + +`pamixer --toggle-mute --sink {{ID}}` + +- Increase the volume on default sink by 5%: + +`pamixer --increase {{5}}` + +- Decrease the volume on a source by 5%: + +`pamixer --decrease {{5}} --source {{ID}}` + +- Use the allow boost option to increase, decrease, or set the volume above 100%: + +`pamixer --set-volume {{105}} --allow-boost` + +- Mute the default sink (use `--unmute` instead to unmute): + +`pamixer --mute` diff --git a/pamnoraw b/pamnoraw new file mode 100644 index 00000000..f81cd603 --- /dev/null +++ b/pamnoraw @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamnoraw + +> This command is an alias of `pamtopnm -plain`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pamoil b/pamoil new file mode 100644 index 00000000..1aefac8d --- /dev/null +++ b/pamoil @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamoil + +> Turn a PAM image into an oil painting. +> More information: . + +- Turn a PAM image into an oil painting: + +`pamoil {{path/to/input_file.pam}} > {{path/to/output_file.pam}}` + +- Consider a neighborhood of N pixels for the "smearing" effect: + +`pamoil -n {{N}} {{path/to/input_file.pam}} > {{path/to/output_file.pam}}` diff --git a/pampop9 b/pampop9 new file mode 100644 index 00000000..4439b4a6 --- /dev/null +++ b/pampop9 @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pampop9 + +> Simulate a multi-lens camera such as the Pop9. +> More information: . + +- Tile the input image xtiles by ytiles times, increasing the offset each time as determined by xdelta and ydelta: + +`pampop9 {{path/to/input.pam}} {{xtiles}} {{ytiles}} {{xdelta}} {{ydelta}} > {{path/to/output.pam}}` diff --git a/pamscale b/pamscale new file mode 100644 index 00000000..c3f84083 --- /dev/null +++ b/pamscale @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamscale + +> Scale a Netpbm image. +> More information: . + +- Scale an image such that the result has the specified dimensions: + +`pamscale -width {{width}} -height {{height}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Scale an image such that the result has the specified width, keeping the aspect ratio: + +`pamscale -width {{width}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Scale an image such that its width and height is changed by the specified factors: + +`pamscale -xscale {{x_factor}} -yscale {{y_factor}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Scale an image such that it fits into the specified bounding box while preserving its aspect ratio: + +`pamscale -xyfit {{bbox_width}} {{bbox_height}} {{path/to/input.pam}} > {{path/to/output.pam}}` + +- Scale an image such that it completely fills the specified box while preserving its aspect ratio: + +`pamscale -xyfill {{box_width}} {{box_height}} {{path/to/input.pam}} > {{path/to/output.pam}}` diff --git a/pamstack b/pamstack new file mode 100644 index 00000000..f4dc3ae2 --- /dev/null +++ b/pamstack @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamstack + +> Stack the planes of multiple PAM images into one PAM image. +> More information: . + +- Stack the planes of the specified PAM images in the specified order: + +`pamstack {{path/to/image1.pam path/to/image2.pam ...}} > {{path/to/output.pam}}` + +- Specify the tuple type name of the output PAM file (maximum of 255 characters): + +`pamstack -tupletype {{tuple_type}} {{path/to/image1.pam path/to/image2.pam ...}} > {{path/to/output.pam}}` diff --git a/pamstretch b/pamstretch new file mode 100644 index 00000000..98388e1a --- /dev/null +++ b/pamstretch @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamstretch + +> Scale up a PAM image by interpolating between pixels. +> See also: `pamstretch-gen`, `pamenlarge`, `pamscale`. +> More information: . + +- Scale up a PAM image by an integer factor: + +`pamstretch {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` + +- Scale up a PAM image by the specified factors in the horizontal and vertical directions: + +`pamstretch -xscale {{XN}} -yscale {{YN}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pamstretch-gen b/pamstretch-gen new file mode 100644 index 00000000..e7d43b2c --- /dev/null +++ b/pamstretch-gen @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamstretch-gen + +> Scale up a PAM image by decimal values. +> See also: `pamstretch`, `pamenlarge`, `pamscale`. +> More information: . + +- Scale up a PAM image by the specified decimal factor: + +`pamstretch-gen {{N}} {{path/to/image.pam}} > {{path/to/output.pam}}` diff --git a/pamtopam b/pamtopam new file mode 100644 index 00000000..b8bcf1a5 --- /dev/null +++ b/pamtopam @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtopam + +> Copy a PAM image. +> More information: . + +- Copy a PAM image (i.e. a PBM, PGM, PPM or PAM image) from `stdin` to `stdout`: + +`pamtopam < {{path/to/image.pam}} > {{path/to/output.pam}}` + +- Display version: + +`pamtopam -version` diff --git a/pamtopnm b/pamtopnm new file mode 100644 index 00000000..0068961d --- /dev/null +++ b/pamtopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtopnm + +> Convert a PAM image to an equivalent PNM image. +> More information: . + +- Convert a PAM image to an equivalent PNM image, i.e. a PBM, PGM or PPM image: + +`pamtopnm {{path/to/image.pam}} > {{path/to/output.pbm|pgm|ppm}}` + +- Display version: + +`pamtopnm -version` diff --git a/pamtoqoi b/pamtoqoi new file mode 100644 index 00000000..787541f6 --- /dev/null +++ b/pamtoqoi @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtoqoi + +> Convert a Netpbm image to a QOI image (Quite OK Image format). +> More information: . + +- Convert a Netpbm image to the QOI format: + +`pamtoqoi {{path/to/image.pnm}} > {{path/to/output.qoi}}` diff --git a/pamtotga b/pamtotga new file mode 100644 index 00000000..a7320637 --- /dev/null +++ b/pamtotga @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtotga + +> Convert a Netpbm image to a TrueVision Targa file. +> More information: . + +- Convert a Netpbm image to a TrueVision Targa file: + +`pamtotga {{path/to/file.pam}} > {{path/to/output.tga}}` + +- Specify the color map of the output image: + +`pamtotga -{{cmap|cmap16|mono|rgb}} {{path/to/file.pam}} > {{path/to/output.tga}}` + +- Display version: + +`pamtotga -version` diff --git a/pamtotiff b/pamtotiff new file mode 100644 index 00000000..60d86033 --- /dev/null +++ b/pamtotiff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtotiff + +> Convert a PAM image to a TIFF file. +> More information: . + +- Convert a PAM image to a TIFF image: + +`pamtotiff {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` + +- Explicitly specify a compression method for the output file: + +`pamtotiff -{{none|packbits|lzw|g3|g4|flate|adobeflate}} {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` + +- Always produce a color TIFF image, even if the input image is greyscale: + +`pamtotiff -color {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` diff --git a/pamtowinicon b/pamtowinicon new file mode 100644 index 00000000..52db6474 --- /dev/null +++ b/pamtowinicon @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtowinicon + +> Convert a PAM image to a Windows ICO file. +> More information: . + +- Convert a PAM image file to an ICO file: + +`pamtowinicon {{path/to/input_file.pam}} > {{path/to/output.ico}}` + +- Encode images with resolutions smaller than t in the BMP format and all other images in the PNG format: + +`pamtowinicon -pngthreshold {{t}} {{path/to/input_file.pam}} > {{path/to/output.ico}}` + +- Make all pixels outside the non-opaque area black: + +`pamtowinicon -truetransparent {{path/to/input_file.pam}} > {{path/to/output.ico}}` diff --git a/pamtoxvmini b/pamtoxvmini new file mode 100644 index 00000000..5e4fe7d6 --- /dev/null +++ b/pamtoxvmini @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pamtoxvmini + +> Convert a Netpbm image to an XV thumbnail picture. +> More information: . + +- Convert a PAM image to an XV thumbnail picture: + +`pamtoxvmini {{path/to/input_file.pam}} > {{path/to/output_file}}` diff --git a/pandoc b/pandoc new file mode 100644 index 00000000..2f498721 --- /dev/null +++ b/pandoc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pandoc + +> Convert documents between various formats. +> More information: . + +- Convert file to PDF (the output format is determined by file extension): + +`pandoc {{input.md}} -o {{output.pdf}}` + +- Force conversion to use a specific format: + +`pandoc {{input.docx}} --to {{gfm}} -o {{output.md}}` + +- Convert to a standalone file with the appropriate headers/footers (for LaTeX, HTML, etc.): + +`pandoc {{input.md}} -s -o {{output.tex}}` + +- List all supported input formats: + +`pandoc --list-input-formats` + +- List all supported output formats: + +`pandoc --list-output-formats` diff --git a/paperkey b/paperkey new file mode 100644 index 00000000..3319d9f3 --- /dev/null +++ b/paperkey @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# paperkey + +> An OpenPGP key archiver. +> More information: . + +- Take a specific secret key and generate a text file with the secret data: + +`paperkey --secret-key {{path/to/secret_key.gpg}} --output {{path/to/secret_data.txt}}` + +- Take the secret key data in `secret_data.txt` and combine it with the public key to reconstruct the secret key: + +`paperkey --pubring {{path/to/public_key.gpg}} --secrets {{path/to/secret_data.txt}} --output {{secret_key.gpg}}` + +- Export a specific secret key and generate a text file with the secret data: + +`gpg --export-secret-key {{key}} | paperkey --output {{path/to/secret_data.txt}}` diff --git a/parallel b/parallel new file mode 100644 index 00000000..2d82b7b8 --- /dev/null +++ b/parallel @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# parallel + +> Run commands on multiple CPU cores. +> More information: . + +- Gzip several files at once, using all cores: + +`parallel gzip ::: {{path/to/file1 path/to/file2 ...}}` + +- Read arguments from `stdin`, run 4 jobs at once: + +`ls *.txt | parallel -j4 gzip` + +- Convert JPG images to PNG using replacement strings: + +`parallel convert {} {.}.png ::: *.jpg` + +- Parallel xargs, cram as many args as possible onto one command: + +`{{args}} | parallel -X {{command}}` + +- Break `stdin` into ~1M blocks, feed each block to `stdin` of new command: + +`cat {{big_file.txt}} | parallel --pipe --block 1M {{command}}` + +- Run on multiple machines via SSH: + +`parallel -S {{machine1}},{{machine2}} {{command}} ::: {{arg1}} {{arg2}}` + +- Download 4 files simultaneously from a text file containing links showing progress: + +`parallel -j4 --bar --eta wget -q {} :::: {{path/to/links.txt}}` + +- Print the jobs which `parallel` is running in `stderr`: + +`parallel -t {{command}} ::: {{args}}` diff --git a/parallel-lint b/parallel-lint new file mode 100644 index 00000000..db078ab1 --- /dev/null +++ b/parallel-lint @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# parallel-lint + +> Check the syntax of PHP files in parallel. +> More information: . + +- Lint a specific directory: + +`parallel-lint {{path/to/directory}}` + +- Lint a directory using the specified number of parallel processes: + +`parallel-lint -j {{processes}} {{path/to/directory}}` + +- Lint a directory, excluding the specified directory: + +`parallel-lint --exclude {{path/to/excluded_directory}} {{path/to/directory}}` + +- Lint a directory of files using a comma-separated list of extension(s): + +`parallel-lint -e {{php,html,phpt}} {{path/to/directory}}` + +- Lint a directory and output the results as JSON: + +`parallel-lint --json {{path/to/directory}}` + +- Lint a directory and show Git Blame results for rows containing errors: + +`parallel-lint --blame {{path/to/directory}}` diff --git a/parquet-tools b/parquet-tools new file mode 100644 index 00000000..2024f6da --- /dev/null +++ b/parquet-tools @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# parquet-tools + +> Show, inspect and manipulate Parquet file. +> More information: . + +- Display the content of a Parquet file: + +`parquet-tools cat {{path/to/parquet}}` + +- Display the first few lines of a Parquet file: + +`parquet-tools head {{path/to/parquet}}` + +- Print the schema of a Parquet file: + +`parquet-tools schema {{path/to/parquet}}` + +- Print the metadata of a Parquet file: + +`parquet-tools meta {{path/to/parquet}}` + +- Print the content and metadata of a Parquet file: + +`parquet-tools dump {{path/to/parquet}}` + +- Concatenate several Parquet files into the target one: + +`parquet-tools merge {{path/to/parquet1}} {{path/to/parquet2}} {{path/to/target_parquet}}` + +- Print the count of rows in a Parquet file: + +`parquet-tools rowcount {{path/to/parquet}}` + +- Print the column and offset indexes of a Parquet file: + +`parquet-tools column-index {{path/to/parquet}}` diff --git a/particle b/particle new file mode 100644 index 00000000..993a5531 --- /dev/null +++ b/particle @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# particle + +> Interact with Particle devices. +> More information: . + +- Log in or create an account for the Particle CLI: + +`particle setup` + +- Display a list of devices: + +`particle list` + +- Create a new Particle project interactively: + +`particle project create` + +- Compile a Particle project: + +`particle compile {{device_type}} {{path/to/source_code.ino}}` + +- Update a device to use a specific app remotely: + +`particle flash {{device_name}} {{path/to/program.bin}}` + +- Update a device to use the latest firmware via serial: + +`particle flash --serial {{path/to/firmware.bin}}` + +- Execute a function on a device: + +`particle call {{device_name}} {{function_name}} {{function_arguments}}` diff --git a/pass b/pass new file mode 100644 index 00000000..5eab112d --- /dev/null +++ b/pass @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pass + +> Store and read passwords or other sensitive data. +> All data is GPG-encrypted, and managed with a Git repository. +> More information: . + +- Initialize (or re-encrypt) the storage using one or more GPG IDs: + +`pass init {{gpg_id_1}} {{gpg_id_2}}` + +- Save a new password and additional information (press Ctrl + D on a new line to complete): + +`pass insert --multiline {{path/to/data}}` + +- Edit an entry: + +`pass edit {{path/to/data}}` + +- Copy a password (first line of the data file) to the clipboard: + +`pass -c {{path/to/data}}` + +- List the whole store tree: + +`pass` + +- Generate a new random password with a given length, and copy it to the clipboard: + +`pass generate -c {{path/to/data}} {{num}}` + +- Initialize a new Git repository (any changes done by pass will be committed automatically): + +`pass git init` + +- Run a Git command on behalf of the password storage: + +`pass git {{command}}` diff --git a/pass-otp b/pass-otp new file mode 100644 index 00000000..24e2cdb4 --- /dev/null +++ b/pass-otp @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pass otp + +> A pass extension for managing one-time-password (OTP) tokens. +> More information: . + +- Prompt for an otpauth URI token and create a new pass file: + +`pass otp insert {{path/to/pass}}` + +- Prompt for an otpauth URI token and append to an existing pass file: + +`pass otp append {{path/to/pass}}` + +- Print a 2FA code using the OTP token in a pass file: + +`pass otp {{path/to/pass}}` + +- Copy and don't print a 2FA code using the OTP token in a pass file: + +`pass otp --clip {{path/to/pass}}` + +- Display a QR code using the OTP token stored in a pass file: + +`pass otp uri --qrcode {{path/to/pass}}` + +- Prompt for an OTP secret value specifying issuer and account (at least one must be specified) and append to existing pass file: + +`pass otp append --secret --issuer {{issuer_name}} --account {{account_name}} {{path/to/pass}}` diff --git a/passwd b/passwd new file mode 100644 index 00000000..1382dcdc --- /dev/null +++ b/passwd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# passwd + +> Change a user's password. +> More information: . + +- Change the password of the current user interactively: + +`passwd` + +- Change the password of a specific user: + +`passwd {{username}}` + +- Get the current status of the user: + +`passwd -S` + +- Make the password of the account blank (it will set the named account passwordless): + +`passwd -d` diff --git a/paste b/paste new file mode 100644 index 00000000..43050af8 --- /dev/null +++ b/paste @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# paste + +> Merge lines of files. +> More information: . + +- Join all the lines into a single line, using TAB as delimiter: + +`paste -s {{path/to/file}}` + +- Join all the lines into a single line, using the specified delimiter: + +`paste -s -d {{delimiter}} {{path/to/file}}` + +- Merge two files side by side, each in its column, using TAB as delimiter: + +`paste {{file1}} {{file2}}` + +- Merge two files side by side, each in its column, using the specified delimiter: + +`paste -d {{delimiter}} {{file1}} {{file2}}` + +- Merge two files, with lines added alternatively: + +`paste -d ' +' {{file1}} {{file2}}` diff --git a/pastel b/pastel new file mode 100644 index 00000000..eb9d7784 --- /dev/null +++ b/pastel @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pastel + +> Generate, analyze, convert and manipulate colors. +> More information: . + +- Convert colors from one format to another. Here from RGB to HSL: + +`pastel format {{hsl}} {{ff8000}}` + +- Show and analyze colors on the terminal: + +`pastel color "{{rgb(255,50,127)}}"` + +- Pick a color from somewhere on the screen: + +`pastel pick` + +- Generate a set of N visually distinct colors: + +`pastel distinct {{8}}` + +- List all X11/CSS color names: + +`pastel list` diff --git a/patch b/patch new file mode 100644 index 00000000..ca1cb0c8 --- /dev/null +++ b/patch @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# patch + +> Patch a file (or files) with a diff file. +> Note that diff files should be generated by the `diff` command. +> More information: . + +- Apply a patch using a diff file (filenames must be included in the diff file): + +`patch < {{patch.diff}}` + +- Apply a patch to a specific file: + +`patch {{path/to/file}} < {{patch.diff}}` + +- Patch a file writing the result to a different file: + +`patch {{path/to/input_file}} -o {{path/to/output_file}} < {{patch.diff}}` + +- Apply a patch to the current directory: + +`patch -p1 < {{patch.diff}}` + +- Apply the reverse of a patch: + +`patch -R < {{patch.diff}}` diff --git a/patchwork b/patchwork new file mode 100644 index 00000000..dcff6be8 --- /dev/null +++ b/patchwork @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# patchwork + +> Render an image of a `squareified treemap` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`patchwork -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`patchwork -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`patchwork -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | patchwork -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`patchwork -?` diff --git a/pathchk b/pathchk new file mode 100644 index 00000000..2c9c3ea2 --- /dev/null +++ b/pathchk @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pathchk + +> Check the validity and portability of pathnames. +> More information: . + +- Check pathnames for validity in the current system: + +`pathchk {{path1 path2 …}}` + +- Check pathnames for validity on a wider range of POSIX compliant systems: + +`pathchk -p {{path1 path2 …}}` + +- Check pathnames for validity on all POSIX compliant systems: + +`pathchk --portability {{path1 path2 …}}` + +- Only check for empty pathnames or leading dashes (-): + +`pathchk -P {{path1 path2 …}}` diff --git a/pax b/pax new file mode 100644 index 00000000..c0006eba --- /dev/null +++ b/pax @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pax + +> Archiving and copying utility. +> More information: . + +- List the contents of an archive: + +`pax -f {{archive.tar}}` + +- List the contents of a `gzip` archive: + +`pax -zf {{archive.tar.gz}}` + +- Create an archive from files: + +`pax -wf {{target.tar}} {{path/to/file1 path/to/file2 ...}}` + +- Create an archive from files, using output redirection: + +`pax -w {{path/to/file1 path/to/file2 ...}} > {{target.tar}}` + +- Extract an archive into the current directory: + +`pax -rf {{source.tar}}` + +- Copy to a directory, while keeping the original metadata; `target/` must exist: + +`pax -rw {{path/to/file1}} {{path/to/directory1 path/to/directory2 ...}} {{target/}}` diff --git a/pbmclean b/pbmclean new file mode 100644 index 00000000..db8bc512 --- /dev/null +++ b/pbmclean @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmclean + +> Clean up a PBM image by erasing isolated black and white pixels. +> More information: . + +- Clean up a PBM image by erasing isolated black and white pixels: + +`pbmclean {{path/to/image.pbm}} > {{path/to/output.pbm}}` + +- Clean up only black/white pixels: + +`pbmclean -{{black|white}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` + +- Specify the minimum number of neighbouring pixels of the same color in order for a pixel not to be considered isolated: + +`pbmclean -minneighbours {{3}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pbmlife b/pbmlife new file mode 100644 index 00000000..e833606a --- /dev/null +++ b/pbmlife @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmlife + +> Apply Conway's Rules of Life to a PBM image. +> More information: . + +- Apply the Rules of Life to an input PBM image file for one generation and the output the result as a PBM image file: + +`pbmlife {{path/to/file.pbm}}` + +- Display version: + +`pbmlife -version` diff --git a/pbmmake b/pbmmake new file mode 100644 index 00000000..6a9e1e0a --- /dev/null +++ b/pbmmake @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmmake + +> Create a blank bitmap. +> More information: . + +- Create a blank bitmap of the specified dimensions: + +`pbmmake {{width}} {{height}} > {{path/to/output_file.pbm}}` + +- Specify the color of the created bitmap: + +`pbmmake -{{white|black|grey}} {{width}} {{height}} > {{path/to/output_file.pbm}}` diff --git a/pbmmask b/pbmmask new file mode 100644 index 00000000..88bbb14a --- /dev/null +++ b/pbmmask @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmmask + +> Create a mask bitmap from a regular bitmap. +> See also: `pambackground`. +> More information: . + +- Create a mask bitmap separating background from foreground: + +`pbmmask {{path/to/image.pbm}} > {{path/to/output.pbm}}` + +- Expand the generated mask by one pixel: + +`pbmmask -expand {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pbmnoise b/pbmnoise new file mode 100644 index 00000000..f59a7944 --- /dev/null +++ b/pbmnoise @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmnoise + +> Generate white noise. +> More information: . + +- Generate a PGM image containing white noise: + +`pbmnoise {{width}} {{height}} > {{path/to/output.pbm}}` + +- Specify the seed for the pseudo-random number generator: + +`pbmnoise {{width}} {{height}} -randomseed {{value}} > {{path/to/output.pbm}}` + +- Specify the desired rate of white to black pixels: + +`pbmnoise {{width}} {{height}} -ratio {{1/3}} > {{path/to/output.pbm}}` diff --git a/pbmpage b/pbmpage new file mode 100644 index 00000000..cd5d6ede --- /dev/null +++ b/pbmpage @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmpage + +> Generate a test pattern for printing. +> More information: . + +- Generate a test pattern for printing onto US standard paper: + +`pbmpage > {{path/to/file.pbm}}` + +- Generate a test pattern for printing onto A4 paper: + +`pbmpage -a4 > {{path/to/file.pbm}}` + +- Specify the pattern to use: + +`pbmpage {{1|2|3}} > {{path/to/file.pbm}}` diff --git a/pbmpscale b/pbmpscale new file mode 100644 index 00000000..43073b04 --- /dev/null +++ b/pbmpscale @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmpscale + +> Enlarge a PBM image with edge smoothing. +> See also: `pamenlarge`. +> More information: . + +- Enlarge a PBM image by the specified factor with edge smoothing: + +`pbmpscale {{N}} {{path/to/image.pbm}} > {{path/to/file.pbm}}` diff --git a/pbmreduce b/pbmreduce new file mode 100644 index 00000000..96908f6a --- /dev/null +++ b/pbmreduce @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmreduce + +> Proportionally reduce a PBM image. +> See also: `pamenlarge`, `pamditherbw`. +> More information: . + +- Reduce the specified image by the specified factor: + +`pbmreduce {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` + +- Use simple thresholding when reducing: + +`pbmreduce -threshold {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` + +- Use the specified threshold for all quantizations: + +`pbmreduce -value {{0.6}} {{N}} {{path/to/image.pbm}} > {{path/to/output.pbm}}` diff --git a/pbmtext b/pbmtext new file mode 100644 index 00000000..afbb2b53 --- /dev/null +++ b/pbmtext @@ -0,0 +1,28 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtext + +> Render text as a PBM image. +> See also: `pbmtextps`. +> More information: . + +- Render a single line of text as a PBM image: + +`pbmtext "{{Hello World!}}" > {{path/to/output.pbm}}` + +- Render multiple lines of text as a PBM image: + +`echo "{{Hello +World!}}" | pbmtext > {{path/to/output.pbm}}` + +- Render text using a custom font supplied as a PBM file: + +`pbmtext -font {{path/to/font.pbm}} "{{Hello World!}}" > {{path/to/output.pbm}}` + +- Specify the number of pixels between characters and lines: + +`echo "{{Hello +World!}}" | pbmtext -space {{3}} -lspace {{10}} > {{path/to/output.pbm}}` diff --git a/pbmtextps b/pbmtextps new file mode 100644 index 00000000..614f31ed --- /dev/null +++ b/pbmtextps @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtextps + +> Render text as a PBM image using PostScript. +> See also: `pbmtext`. +> More information: . + +- Render a single line of text as a PBM image: + +`pbmtextps "{{Hello World!}}" > {{path/to/output.pbm}}` + +- Specify the font and font size: + +`pbmtextps -font {{Times-Roman}} -fontsize {{30}} "{{Hello World!}}" > {{path/to/output.pbm}}` + +- Specify the desired left and top margins: + +`pbmtextps -leftmargin {{70}} -topmargin {{162}} "{{Hello World!}}" > {{path/to/output.pbm}}` + +- Do not output the rendered text as a PBM image, but a PostScript program that would create this image: + +`pbmtextps -dump-ps "{{Hello World!}}" > {{path/to/output.ps}}` diff --git a/pbmtoascii b/pbmtoascii new file mode 100644 index 00000000..7355cd0c --- /dev/null +++ b/pbmtoascii @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoascii + +> Convert a PBM image to ASCII graphics. +> More information: . + +- Read a PBM file as input and produce an ASCII output: + +`pbmtoascii {{path/to/input_file.pbm}}` + +- Read a PBM file as input and save an ASCII output into a file: + +`pbmtoascii {{path/to/input_file.pbm}} > {{path/to/output_file}}` + +- Read a PBM file as input while setting the pixel mapping (defaults to 1x2): + +`pbmtoascii -{{1x2|2x4}} {{path/to/input_file.pbm}}` + +- Display version: + +`pbmtoascii -version` diff --git a/pbmtoatk b/pbmtoatk new file mode 100644 index 00000000..39deebb3 --- /dev/null +++ b/pbmtoatk @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoatk + +> Convert a PBM image to an Andrew Toolkit raster object. +> See also: `atktopbm`. +> More information: . + +- Convert a PBM image to an Andrew Toolkit raster object: + +`pbmtoatk {{path/to/image.pbm}} > {{path/to/output.atk}}` diff --git a/pbmtobbnbg b/pbmtobbnbg new file mode 100644 index 00000000..91c0c03c --- /dev/null +++ b/pbmtobbnbg @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtobbnbg + +> Convert a PBM image to a BitGraph graphic. +> More information: . + +- Convert a PBM image to a BitGraph terminal Display Pixel Data sequence: + +`pbmtobbnbg < {{path/to/image.pbm}} > {{path/to/output.dpd}}` + +- Specify the rasterop: + +`pbmtobbnbg {{3}} < {{path/to/image.pbm}} > {{path/to/output.dpd}}` diff --git a/pbmtocmuwm b/pbmtocmuwm new file mode 100644 index 00000000..247d99ac --- /dev/null +++ b/pbmtocmuwm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtocmuwm + +> Convert a PBM image to a CMU window manager bitmap. +> See also: `cmuwmtopbm`. +> More information: . + +- Convert a PBM image to a CMU window manager bitmap: + +`pbmtocmuwm {{path/to/image.pbm}} > {{path/to/output.bmp}}` diff --git a/pbmtoepsi b/pbmtoepsi new file mode 100644 index 00000000..9e84f332 --- /dev/null +++ b/pbmtoepsi @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoepsi + +> Convert a PBM image to an encapsulated PostScript style preview bitmap. +> More information: . + +- Convert a PBM image to an encapsulated PostScript style preview bitmap: + +`pbmtoepsi {{path/to/image.pbm}} > {{path/to/output.bmp}}` + +- Produce a quadratic output image with the specified resolution: + +`pbmtoepsi -dpi {{144}} {path/to/image.pbm}} > {{path/to/output.bmp}}` + +- Produce an output image with the specified horizontal and vertical resolution: + +`pbmtoepsi -dpi {{72x144}} {{path/to/image.pbm}} > {{path/to/output.bmp}}` + +- Only create a boundary box: + +`pbmtoepsi -bbonly {{path/to/image.pbm}} > {{path/to/output.bmp}}` diff --git a/pbmtoepson b/pbmtoepson new file mode 100644 index 00000000..b28f39de --- /dev/null +++ b/pbmtoepson @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoepson + +> Convert a PBM image to an Epson printer graphic. +> See also: `pbmtoescp2`. +> More information: . + +- Convert a PBM image to an Epson printer graphic: + +`pbmtoepson {{path/to/image.pbm}} > {{path/to/output.epson}}` + +- Specify the printer protocol of the output: + +`pbmtoepson -protocol {{escp9|escp}} {{path/to/image.pbm}} > {{path/to/output.epson}}` + +- Specify the horizontal DPI of the output: + +`pbmtoepson -dpi {{60|72|80|90|120|144|240}} {{path/to/image.pbm}} > {{path/to/output.epson}}` diff --git a/pbmtoescp2 b/pbmtoescp2 new file mode 100644 index 00000000..bd2cf6ad --- /dev/null +++ b/pbmtoescp2 @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoescp2 + +> Convert a PBM image to a ESC/P2 printer file. +> See also: `pbmtoepson`, `escp2topbm`. +> More information: . + +- Convert a PBM image to a ESC/P2 printer file: + +`pbmtoescp2 {{path/to/image.pbm}} > {{path/to/output.escp2}}` + +- Specify the compression of the output: + +`pbmtoescp2 -compression {{0|1}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` + +- Specify the horizontal and vertical resolution of the output in dots per inch: + +`pbmtoescp2 -resolution {{180|360|720}} {{path/to/image.pbm}} > {{path/to/output.escp2}}` + +- Place a formfeed command at the end of the output: + +`pbmtoescp2 -formfeed {{path/to/image.pbm}} > {{path/to/output.escp2}}` diff --git a/pbmtogem b/pbmtogem new file mode 100644 index 00000000..8bb7d786 --- /dev/null +++ b/pbmtogem @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtogem + +> Read a PBM image as input and produce a compressed GEM .img file as output. +> `pbmtogem` cannot compress repeated lines. +> More information: . + +- Convert a PBM image into a GEM .img file: + +`pbmtogem {{path/to/file.pbm}} > {{path/to/file.img}}` + +- Suppress all informational messages: + +`pbmtogem -quiet` + +- Display version: + +`pbmtogem -version` diff --git a/pbmtogo b/pbmtogo new file mode 100644 index 00000000..bf33052c --- /dev/null +++ b/pbmtogo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtogo + +> Convert a PBM image to a compressed GraphOn graphic. +> More information: . + +- Convert a PBM image to a compressed GraphOn graphic: + +`pbmtogo {{path/to/image.pbm}} > {{path/to/output.go}}` diff --git a/pbmtolj b/pbmtolj new file mode 100644 index 00000000..d32d5b2f --- /dev/null +++ b/pbmtolj @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtolj + +> Convert a PBM file to an HP LaserJet file. +> More information: . + +- Convert a PBM file to an HP LaserJet file: + +`pbmtolj {{path/to/input.pbm}} > {{path/to/output.lj}}` + +- Compress the output file using the specified method: + +`pbmtolj -{{packbits|delta|compress}} {{path/to/input.pbm}} > {{path/to/output.lj}}` + +- Specify the required resolution: + +`pbmtolj -resolution {{75|100|150|300|600}} {{path/to/input.pbm}} > {{path/to/output.lj}}` diff --git a/pbmtomacp b/pbmtomacp new file mode 100644 index 00000000..94b48150 --- /dev/null +++ b/pbmtomacp @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtomacp + +> Convert a PBM image to a MacPaint file. +> See also: `macptopbm`. +> More information: . + +- Convert a PBM image to a MACP file: + +`pbmtomacp {{path/to/image.pbm}} > {{path/to/output.macp}}` + +- Do not compress the output file: + +`pbmtomacp -norle {{path/to/image.pbm}} > {{path/to/output.macp}}` diff --git a/pbmtomda b/pbmtomda new file mode 100644 index 00000000..51bbffe1 --- /dev/null +++ b/pbmtomda @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtomda + +> Convert a PBM image to a Microdesign MDA file. +> See also: `mdatopbm`. +> More information: . + +- Convert a PBM image to a MDA file: + +`pbmtomda {{path/to/image.pbm}} > {{path/to/output.mda}}` + +- Invert the colors in the input image: + +`pbmtomda -i {{path/to/image.pbm}} > {{path/to/output.mda}}` + +- Halve the input image's height: + +`pbmtomda -d {{path/to/image.pbm}} > {{path/to/output.mda}}` diff --git a/pbmtomgr b/pbmtomgr new file mode 100644 index 00000000..5499fece --- /dev/null +++ b/pbmtomgr @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtomgr + +> Convert a PBM image into a MGR bitmap. +> See also: `mgrtopbm`. +> More information: . + +- Convert a PBM image into a MGR bitmap: + +`pbmtomgr {{path/to/image.pbm}} > {{path/to/output.mgr}}` diff --git a/pbmtonokia b/pbmtonokia new file mode 100644 index 00000000..0b830a1b --- /dev/null +++ b/pbmtonokia @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtonokia + +> Convert a PBM image to one of Nokia's Smart Messaging Formats . +> More information: . + +- Convert a PBM image into a Nokia Operator Logo as hexcode: + +`pbmtonokia -fmt NEX_NOL -net {{network_operator_code}} {{path/to/image.pbm}} > {{path/to/output.hex}}` + +- Convert a PBM image into a Nokia Group Graphic as hexcode: + +`pbmtonokia -fmt NEX_NGG {{path/to/image.pbm}} > {{path/to/output.hex}}` + +- Convert a PBM image into a Nokia Picture Message with the specified text as hexcode: + +`pbmtonokia -fmt NEX_NPM -txt {{text_message}} {{path/to/image.pbm}} > {{path/to/output.hex}}` + +- Convert a PBM image into a Nokia Operator Logo as a NOL file: + +`pbmtonokia -fmt NOL {{path/to/image.pbm}} > {{path/to/output.nol}}` + +- Convert a PBM image into a Nokia Group Graphic as an NGG file: + +`pbmtonokia -fmt NGG {{path/to/image.pbm}} > {{path/to/output.ngg}}` + +- Convert a PBM image into a Nokia Picture Message as an NPM file: + +`pbmtonokia -fmt NPM {{path/to/image.pbm}} > {{path/to/output.npm}}` diff --git a/pbmtopgm b/pbmtopgm new file mode 100644 index 00000000..bdd20b65 --- /dev/null +++ b/pbmtopgm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtopgm + +> Convert a PBM image to PGM by averaging areas surrounding individual pixels. +> See also: `pnmconvol`, `pamditherbw`. +> More information: . + +- Convert PBM image to PGM by averaging the `w`x`h`-sized area surrounding each pixel: + +`pbmtopgm {{w}} {{h}} {{path/to/image.pbm}} > {{path/to/output.pgm}}` diff --git a/pbmtoplot b/pbmtoplot new file mode 100644 index 00000000..734e5a6f --- /dev/null +++ b/pbmtoplot @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoplot + +> Convert a PBM image into a UNIX plot file. +> More information: . + +- Convert a PBM image into a UNIX plot file: + +`pbmtoplot {{path/to/image.pbm}} > {{path/to/output.plot}}` diff --git a/pbmtoppa b/pbmtoppa new file mode 100644 index 00000000..3cf7e2c1 --- /dev/null +++ b/pbmtoppa @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoppa + +> Convert a PBM image to HP Printer Performance Architecture format. +> More information: . + +- Convert a PBM image into a PPA file: + +`pbmtoppa {{path/to/image.pbm}} > {{path/to/output.ppa}}` + +- Specify the desired dots-per-inch and paper size: + +`pbmtoppa -d {{300}} -s {{a4}} {{path/to/image.pbm}} > {{path/to/output.ppa}}` diff --git a/pbmtoptx b/pbmtoptx new file mode 100644 index 00000000..3e290d82 --- /dev/null +++ b/pbmtoptx @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoptx + +> Convert a PBM image into Printronix printer graphics. +> More information: . + +- Convert a PBM image into a PTX file: + +`pbmtoptx {{path/to/image.pbm}} > {{path/to/output.ptx}}` diff --git a/pbmtowbmp b/pbmtowbmp new file mode 100644 index 00000000..6b6f4338 --- /dev/null +++ b/pbmtowbmp @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtowbmp + +> Convert a PBM image to a wireless bitmap file. +> More information: . + +- Convert a PBM image to a WBMP file: + +`pbmtowbmp {{path/to/input_file.pbm}} > {{path/to/output_file.wbmp}}` diff --git a/pbmtox10bm b/pbmtox10bm new file mode 100644 index 00000000..55a960a3 --- /dev/null +++ b/pbmtox10bm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtox10bm + +> This command is superseded by `pbmtoxbm -x10`. +> More information: . + +- View documentation for the current command: + +`tldr pbmtoxbm` diff --git a/pbmtoxbm b/pbmtoxbm new file mode 100644 index 00000000..18e1f95b --- /dev/null +++ b/pbmtoxbm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoxbm + +> Convert a PBM image to a X11 or X10 bitmap. +> More information: . + +- Convert a PBM image to a X11 XBM file: + +`pbmtoxbm {{path/to/input_file.pbm}} > {{path/to/output_file.xbm}}` + +- Explicitly specify whether an X11 or X10 bitmap should be generated: + +`pbmtoxbm -{{x11|x10}} {{path/to/input_file.pbm}} > {{path/to/output_file.xbm}}` diff --git a/pbmtoybm b/pbmtoybm new file mode 100644 index 00000000..ce8ba3e1 --- /dev/null +++ b/pbmtoybm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtoybm + +> Convert a PBM file to a Bennet Yee "face" file. +> More information: . + +- Convert a PBM image file to YBM: + +`pbmtoybm {{path/to/input_file.pbm}} > {{path/to/output_file.ybm}}` diff --git a/pbmtozinc b/pbmtozinc new file mode 100644 index 00000000..23154528 --- /dev/null +++ b/pbmtozinc @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmtozinc + +> Convert a PBM image to a Zinc bitmap as used by the Zinc Interface Library Version 1.0. +> More information: . + +- Convert a PBM image to a Zinc bitmap: + +`pbmtozinc {{path/to/image.pbm}} > {{path/to/output.zinc}}` diff --git a/pbmupc b/pbmupc new file mode 100644 index 00000000..f5bac0ef --- /dev/null +++ b/pbmupc @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbmupc + +> Generate a PBM image of a Universal Product Code (UPC). +> More information: . + +- Generate a UPC image for the specified product type, manufacturer code, and product code: + +`pbmupc {{product_type}} {{manufacturer_code}} {{product_code}} > {{path/to/output.pbm}}` + +- Use an alternative style that does not display the checksum: + +`pbmupc -s2 {{product_type}} {{manufacturer_code}} {{product_code}} > {{path/to/output.pbm}}` diff --git a/pbzip2 b/pbzip2 new file mode 100644 index 00000000..bed6e43e --- /dev/null +++ b/pbzip2 @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pbzip2 + +> A parallel implementation of the `bzip2` file compressor. +> See also: `bzip2`, `tar`. +> More information: . + +- Compress a file: + +`pbzip2 {{path/to/file}}` + +- Compress a file using the specified number of processors: + +`pbzip2 -p{{4}} {{path/to/file}}` + +- [d]ecompress a file: + +`pbzip2 --decompress {{path/to/compressed_file.bz2}}` + +- Display help: + +`pbzip2 -h` diff --git a/pcapfix b/pcapfix new file mode 100644 index 00000000..863f6f24 --- /dev/null +++ b/pcapfix @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pcapfix + +> Repair damaged or corrupted `pcap` and `pcapng` files. +> More information: . + +- Repair a `pcap`/`pcapng` file (Note: for `pcap` files, only the first 262144 bytes of each packet are scanned): + +`pcapfix {{path/to/file.pcapng}}` + +- Repair an entire `pcap` file: + +`pcapfix --deep-scan {{path/to/file.pcap}}` + +- Repair a `pcap`/`pcapng` file and write the repaired file to the specified location: + +`pcapfix --outfile {{path/to/repaired.pcap}} {{path/to/file.pcap}}` + +- Repair a `pcapng` file and treat it as a `pcapng` file, ignoring the automatic recognition: + +`pcapfix --pcapng {{path/to/file.pcapng}}` + +- Repair a file and show the process in detail: + +`pcapfix --verbose {{path/to/file.pcap}}` diff --git a/pcxtoppm b/pcxtoppm new file mode 100644 index 00000000..87bf573b --- /dev/null +++ b/pcxtoppm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pcxtoppm + +> Convert a PCX file to a PPM image. +> More information: . + +- Convert a PCX file to a PPM image: + +`pcxtoppm {{path/to/file.pcx}} > {{path/to/file.ppm}}` + +- Use a predefined standard palette even if the PCX file provides one: + +`pcxtoppm -stdpalette {{path/to/file.pcx}} > {{path/to/file.ppm}}` + +- Print information on the PCX header to `stdout`: + +`pcxtoppm -verbose {{path/to/file.pcx}} > {{path/to/file.ppm}}` diff --git a/pdf-parser b/pdf-parser new file mode 100644 index 00000000..c29f6871 --- /dev/null +++ b/pdf-parser @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdf-parser + +> Identify fundamental elements of a PDF file without rendering it. +> More information: . + +- Display statistics for a PDF file: + +`pdf-parser --stats {{path/to/file.pdf}}` + +- Display objects of type `/Font` in a PDF file: + +`pdf-parser --type={{/Font}} {{path/to/file.pdf}}` + +- Search for strings in indirect objects: + +`pdf-parser --search={{search_string}} {{path/to/file.pdf}}` diff --git a/pdffonts b/pdffonts new file mode 100644 index 00000000..8c241363 --- /dev/null +++ b/pdffonts @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdffonts + +> Portable Document Format (PDF) file fonts information viewer. +> More information: . + +- Print PDF file fonts information: + +`pdffonts {{path/to/file.pdf}}` + +- Specify user password for PDF file to bypass security restrictions: + +`pdffonts -upw {{password}} {{path/to/file.pdf}}` + +- Specify owner password for PDF file to bypass security restrictions: + +`pdffonts -opw {{password}} {{path/to/file.pdf}}` + +- Print additional information on location of the font that will be used when the PDF file is rasterized: + +`pdffonts -loc {{path/to/file.pdf}}` + +- Print additional information on location of the font that will be used when the PDF file is converted to PostScript: + +`pdffonts -locPS {{path/to/file.pdf}}` diff --git a/pdfgrep b/pdfgrep new file mode 100644 index 00000000..c65d1a39 --- /dev/null +++ b/pdfgrep @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfgrep + +> Search text in PDF files. +> More information: . + +- Find lines that match pattern in a PDF: + +`pdfgrep {{pattern}} {{file.pdf}}` + +- Include file name and page number for each matched line: + +`pdfgrep --with-filename --page-number {{pattern}} {{file.pdf}}` + +- Do a case-insensitive search for lines that begin with "foo" and return the first 3 matches: + +`pdfgrep --max-count {{3}} --ignore-case {{'^foo'}} {{file.pdf}}` + +- Find pattern in files with a `.pdf` extension in the current directory recursively: + +`pdfgrep --recursive {{pattern}}` + +- Find pattern on files that match a specific glob in the current directory recursively: + +`pdfgrep --recursive --include {{'*book.pdf'}} {{pattern}}` diff --git a/pdfimages b/pdfimages new file mode 100644 index 00000000..045a9906 --- /dev/null +++ b/pdfimages @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfimages + +> Utility for extracting images from PDFs. +> More information: . + +- Extract all images from a PDF file and save them as PNGs: + +`pdfimages -png {{path/to/file.pdf}} {{filename_prefix}}` + +- Extract images from pages 3 to 5: + +`pdfimages -f {{3}} -l {{5}} {{path/to/file.pdf}} {{filename_prefix}}` + +- Extract images from a PDF file and include the page number in the output filenames: + +`pdfimages -p {{path/to/file.pdf}} {{filename_prefix}}` + +- List information about all the images in a PDF file: + +`pdfimages -list {{path/to/file.pdf}}` diff --git a/pdfinfo b/pdfinfo new file mode 100644 index 00000000..80e47d5a --- /dev/null +++ b/pdfinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfinfo + +> Portable Document Format (PDF) file information viewer. +> More information: . + +- Print PDF file information: + +`pdfinfo {{path/to/file.pdf}}` + +- Specify user password for PDF file to bypass security restrictions: + +`pdfinfo -upw {{password}} {{path/to/file.pdf}}` + +- Specify owner password for PDF file to bypass security restrictions: + +`pdfinfo -opw {{password}} {{path/to/file.pdf}}` diff --git a/pdfjam b/pdfjam new file mode 100644 index 00000000..b4cd0e10 --- /dev/null +++ b/pdfjam @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfjam + +> Shell frontend for the LaTeX pdfpages package for mingling PDFs. +> More information: . + +- Merge two (or more) PDFs: + +`pdfjam {{path/to/file1.pdf}} {{path/to/file2.pdf}} --outfile {{path/to/output_file.pdf}}` + +- Merge the first page of each file together: + +`pdfjam {{files...}} 1 --outfile {{path/to/output_file.pdf}}` + +- Merge subranges from two PDFs: + +`pdfjam {{path/to/file1.pdf 3-5,1}} {{path/to/file2.pdf 4-6}} --outfile {{path/to/output_file.pdf}}` + +- Sign an A4 page (adjust delta to height for other formats) with a scanned signature by overlaying them: + +`pdfjam {{path/to/file.pdf}} {{path/to/signature}} --fitpaper true --outfile {{path/to/signed.pdf}} --nup "{{1x2}}" --delta "{{0 -842pt}}"` + +- Arrange the pages from the input file into a fancy 2x2 grid: + +`pdfjam {{path/to/file.pdf}} --nup {{2x2}} --suffix {{4up}} --preamble '{{\usepackage{fancyhdr} \pagestyle{fancy}}}'` + +- Reverse the order of pages within each given file and concatenate them: + +`pdfjam {{files...}} {{last-1}} --suffix {{reversed}}` diff --git a/pdfjoin b/pdfjoin new file mode 100644 index 00000000..c6eb9c51 --- /dev/null +++ b/pdfjoin @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfjoin + +> PDF merging utility based on pdfjam. +> More information: . + +- Merge two PDFs into one with the default suffix "joined": + +`pdfjoin {{path/to/file1.pdf}} {{path/to/file2.pdf}}` + +- Merge the first page of each given file together: + +`pdfjoin {{path/to/file1.pdf path/to/file2.pdf ...}} {{1}} --outfile {{output_file}}` + +- Save pages 3 to 5 followed by page 1 to a new PDF with custom suffix: + +`pdfjoin {{path/to/file.pdf}} {{3-5,1}} --suffix {{rearranged}}` + +- Merge page subranges from two PDFs: + +`pdfjoin {/path/to/file1.pdf}} {{2-}} {{file2}} {{last-3}} --outfile {{output_file}}` diff --git a/pdflatex b/pdflatex new file mode 100644 index 00000000..f188bfb8 --- /dev/null +++ b/pdflatex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdflatex + +> Compile a PDF document from LaTeX source files. +> More information: . + +- Compile a PDF document: + +`pdflatex {{source.tex}}` + +- Compile a PDF document specifying an output directory: + +`pdflatex -output-directory={{path/to/directory}} {{source.tex}}` + +- Compile a PDF document, exiting on each error: + +`pdflatex -halt-on-error {{source.tex}}` diff --git a/pdfposter b/pdfposter new file mode 100644 index 00000000..08a3eae1 --- /dev/null +++ b/pdfposter @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfposter + +> Convert a large-sheeted PDF into multiple A4 pages for printing. +> More information: . + +- Convert an A2 poster into 4 A4 pages: + +`pdfposter --poster-size a2 {{input_file.pdf}} {{output_file.pdf}}` + +- Scale an A4 poster to A3 and then generate 2 A4 pages: + +`pdfposter --scale 2 {{input_file.pdf}} {{output_file.pdf}}` diff --git a/pdfseparate b/pdfseparate new file mode 100644 index 00000000..f3fe56be --- /dev/null +++ b/pdfseparate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfseparate + +> Portable Document Format (PDF) file page extractor. +> More information: . + +- Extract pages from PDF file and make a separate PDF file for each page: + +`pdfseparate {{path/to/source_filename.pdf}} {{path/to/destination_filename-%d.pdf}}` + +- Specify the first/start page for extraction: + +`pdfseparate -f {{3}} {{path/to/source_filename.pdf}} {{path/to/destination_filename-%d.pdf}}` + +- Specify the last page for extraction: + +`pdfseparate -l {{10}} {{path/to/source_filename.pdf}} {{path/to/destination_filename-%d.pdf}}` diff --git a/pdftex b/pdftex new file mode 100644 index 00000000..87c9a432 --- /dev/null +++ b/pdftex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftex + +> Compile a PDF document from TeX source files. +> More information: . + +- Compile a PDF document: + +`pdftex {{source.tex}}` + +- Compile a PDF document, specifying an output directory: + +`pdftex -output-directory={{path/to/directory}} {{source.tex}}` + +- Compile a PDF document, exiting on each error: + +`pdftex -halt-on-error {{source.tex}}` diff --git a/pdftk b/pdftk new file mode 100644 index 00000000..4fbcbd7e --- /dev/null +++ b/pdftk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftk + +> PDF toolkit. +> More information: . + +- Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: + +`pdftk {{input.pdf}} cat {{1-3 5 6-10}} output {{output.pdf}}` + +- Merge (concatenate) a list of PDF files and save the result as another one: + +`pdftk {{file1.pdf file2.pdf ...}} cat output {{output.pdf}}` + +- Split each page of a PDF file into a separate file, with a given filename output pattern: + +`pdftk {{input.pdf}} burst output {{out_%d.pdf}}` + +- Rotate all pages by 180 degrees clockwise: + +`pdftk {{input.pdf}} cat {{1-endsouth}} output {{output.pdf}}` + +- Rotate third page by 90 degrees clockwise and leave others unchanged: + +`pdftk {{input.pdf}} cat {{1-2 3east 4-end}} output {{output.pdf}}` diff --git a/pdftocairo b/pdftocairo new file mode 100644 index 00000000..49d8f639 --- /dev/null +++ b/pdftocairo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftocairo + +> Converts PDF files to PNG/JPEG/TIFF/PDF/PS/EPS/SVG using cairo. +> More information: . + +- Convert a PDF file to JPEG: + +`pdftocairo {{path/to/file.pdf}} -jpeg` + +- Convert to PDF expanding the output to fill the paper: + +`pdftocairo {{path/to/file.pdf}} {{output.pdf}} -pdf -expand` + +- Convert to SVG specifying the first/last page to convert: + +`pdftocairo {{path/to/file.pdf}} {{output.svg}} -svg -f {{first_page}} -l {{last_page}}` + +- Convert to PNG with 200ppi resolution: + +`pdftocairo {{path/to/file.pdf}} {{output.png}} -png -r 200` + +- Convert to grayscale TIFF setting paper size to A3: + +`pdftocairo {{path/to/file.pdf}} -tiff -gray -paper A3` + +- Convert to PNG cropping x and y pixels from the top-left corner: + +`pdftocairo {{path/to/file.pdf}} -png -x {{x_pixels}} -y {{y_pixels}}` diff --git a/pdftotext b/pdftotext new file mode 100644 index 00000000..3e3aee84 --- /dev/null +++ b/pdftotext @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdftotext + +> Convert PDF files to plain text format. +> More information: . + +- Convert `filename.pdf` to plain text and print it to `stdout`: + +`pdftotext {{filename.pdf}} -` + +- Convert `filename.pdf` to plain text and save it as `filename.txt`: + +`pdftotext {{filename.pdf}}` + +- Convert `filename.pdf` to plain text and preserve the layout: + +`pdftotext -layout {{filename.pdf}}` + +- Convert `input.pdf` to plain text and save it as `output.txt`: + +`pdftotext {{input.pdf}} {{output.txt}}` + +- Convert pages 2, 3 and 4 of `input.pdf` to plain text and save them as `output.txt`: + +`pdftotext -f {{2}} -l {{4}} {{input.pdf}} {{output.txt}}` diff --git a/pdfunite b/pdfunite new file mode 100644 index 00000000..1350388d --- /dev/null +++ b/pdfunite @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pdfunite + +> PDF merging utility. +> More information: . + +- Merge 2 PDFs into a single PDF: + +`pdfunite {{path/to/fileA.pdf}} {{path/to/fileB.pdf}} {{path/to/merged_output.pdf}}` + +- Merge a directory of PDFs into a single PDF: + +`pdfunite {{path/to/directory/*.pdf}} {{path/to/merged_output.pdf}}` diff --git a/peco b/peco new file mode 100644 index 00000000..42fc18b9 --- /dev/null +++ b/peco @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# peco + +> Interactive filtering tool. +> More information: . + +- Start `peco` on all files in the specified directory: + +`find {{path/to/directory}} -type f | peco` + +- Start `peco` for running processes: + +`ps aux | peco` + +- Start `peco` with a specified query: + +`peco --query "{{query}}"` diff --git a/pee b/pee new file mode 100644 index 00000000..12cd1639 --- /dev/null +++ b/pee @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pee + +> Tee `stdin` to pipes. +> See also: `tee`. +> More information: . + +- Run each command, providing each one with a distinct copy of `stdin`: + +`pee {{command1 command2 ...}}` + +- Write a copy of `stdin` to `stdout` (like `tee`): + +`pee cat {{command1 command2 ...}}` + +- Immediately terminate upon SIGPIPEs and write errors: + +`pee --no-ignore-sigpipe --no-ignore-write-errors {{command1 command2 ...}}` diff --git a/peerflix b/peerflix new file mode 100644 index 00000000..d9cc9a7b --- /dev/null +++ b/peerflix @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# peerflix + +> Stream video- or audio-based torrents to a media player. +> More information: . + +- Stream the largest media file in a torrent: + +`peerflix "{{torrent_url|magnet_link}}"` + +- List all streamable files contained in a torrent (given as a magnet link): + +`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}" --list` + +- Stream the largest file in a torrent, given as a torrent URL, to VLC: + +`peerflix "{{http://example.net/music.torrent}}" --vlc` + +- Stream the largest file in a torrent to MPlayer, with subtitles: + +`peerflix "{{torrent_url|magnet_link}}" --mplayer --subtitles {{subtitle-file.srt}}` + +- Stream all files from a torrent to Airplay: + +`peerflix "{{torrent_url|magnet_link}}" --all --airplay` diff --git a/peerindex b/peerindex new file mode 100644 index 00000000..45c2838b --- /dev/null +++ b/peerindex @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# peerindex + +> Inspect MRT TABLE_DUMPV2 Peer Index Table. +> Can read files compressed with `gzip`, `bzip2` and `xz`. +> More information: . + +- List all peers: + +`peerindex {{master6.mrt}}` + +- Display all peers that have provided routing information: + +`peerindex -r {{master6.mrt}}` diff --git a/peludna-prognoza b/peludna-prognoza new file mode 100644 index 00000000..fd8af8ed --- /dev/null +++ b/peludna-prognoza @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# peludna-prognoza + +> Fetch pollen measurement data for Croatian cities from your terminal using Pliva's allergies data API. +> More information: . + +- Start an interactive search for a city and fetch data for it: + +`peludna-prognoza` + +- Fetch data for a city: + +`peludna-prognoza "{{city}}"` + +- Display data in a machine-readable format: + +`peludna-prognoza "{{city}}" --{{json|xml}}` + +- Display the pollen measurement page for a city at in the default web browser: + +`peludna-prognoza "{{city}}" --web` diff --git a/perl b/perl new file mode 100644 index 00000000..e4ba3e88 --- /dev/null +++ b/perl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# perl + +> The Perl 5 language interpreter. +> More information: . + +- Print lines from `stdin` [m/] matching regex1 and case insensitive [/i] regex2: + +`perl -n -e 'print if m/{{regex1}}/ and m/{{regex2}}/i'` + +- Say [-E] first match group, using a regexp, ignoring space in regex [/x]: + +`perl -n -E 'say $1 if m/{{before}} ( {{group_regex}} ) {{after}}/x'` + +- [-i]n-place, with backup, [s/] substitute all occurrence [/g] of regex with replacement: + +`perl -i'.bak' -p -e 's/{{regex}}/{{replacement}}/g' {{path/to/files}}` + +- Use perl's inline documentation, some pages also available via manual pages on Linux: + +`perldoc perlrun ; perldoc module ; perldoc -f splice; perldoc -q perlfaq1` diff --git a/perlbrew b/perlbrew new file mode 100644 index 00000000..96883ec5 --- /dev/null +++ b/perlbrew @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# perlbrew + +> Manage Perl installations in the home directory. +> See also: `asdf`. +> More information: . + +- Initialize a `perlbrew` environment: + +`perlbrew init` + +- List available Perl versions: + +`perlbrew available` + +- Install/uninstall a Perl version: + +`perlbrew {{install|uninstall}} {{version}}` + +- List perl installations: + +`perlbrew list` + +- Switch to an installation and set it as default: + +`perlbrew switch perl-{{version}}` + +- Use the system Perl again: + +`perlbrew off` + +- List installed CPAN modules for the installation in use: + +`perlbrew list-modules` + +- Clone CPAN modules from one installation to another: + +`perlbrew clone-modules {{source_installation}} {{destination_installation}}` diff --git a/perldoc b/perldoc new file mode 100644 index 00000000..93fa1764 --- /dev/null +++ b/perldoc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# perldoc + +> Look up Perl documentation in `.pod` format. +> More information: . + +- View documentation for a builtin [f]unction, a [v]ariable or an [a]PI: + +`perldoc -{{f|v|a}} {{name}}` + +- Search in the the question headings of Perl FAQ: + +`perldoc -q {{regex}}` + +- Send output directly to `stdout` (by default, it is send to a pager): + +`perldoc -T {{page|module|program|URL}}` + +- Specify the language code of the desired translation: + +`perldoc -L {{language_code}} {{page|module|program|URL}}` diff --git a/pest b/pest new file mode 100644 index 00000000..b49818d0 --- /dev/null +++ b/pest @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pest + +> A PHP testing framework with a focus on simplicity. +> More information: . + +- Initialize a standard Pest configuration in the current directory: + +`pest --init` + +- Run tests in the current directory: + +`pest` + +- Run tests annotated with the given group: + +`pest --group {{name}}` + +- Run tests and print the coverage report to `stdout`: + +`pest --coverage` + +- Run tests with coverage and fail if the coverage is less than the minimum percentage: + +`pest --coverage --min={{80}}` diff --git a/pfetch b/pfetch new file mode 100644 index 00000000..049fb6b5 --- /dev/null +++ b/pfetch @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pfetch + +> Display system information. +> More information: . + +- Display the ASCII art and default fields: + +`pfetch` + +- Display only the ASCII art and color palette fields: + +`PF_INFO="{{ascii palette}}" pfetch` + +- Display all possible fields: + +`PF_INFO="{{ascii title os host kernel uptime pkgs memory shell editor wm de palette}}" pfetch` + +- Display a different username and hostname: + +`USER="{{user}}" HOSTNAME="{{hostname}}" pfetch` + +- Display without colors: + +`PF_COLOR={{0}} pfetch` diff --git a/pg_ctl b/pg_ctl new file mode 100644 index 00000000..9142582e --- /dev/null +++ b/pg_ctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pg_ctl + +> Utility for controlling a PostgreSQL server and database cluster. +> More information: . + +- Initialize a new PostgreSQL database cluster: + +`pg_ctl -D {{data_directory}} init` + +- Start a PostgreSQL server: + +`pg_ctl -D {{data_directory}} start` + +- Stop a PostgreSQL server: + +`pg_ctl -D {{data_directory}} stop` + +- Restart a PostgreSQL server: + +`pg_ctl -D {{data_directory}} restart` + +- Reload the PostgreSQL server configuration: + +`pg_ctl -D {{data_directory}} reload` diff --git a/pg_dump b/pg_dump new file mode 100644 index 00000000..dc289f8c --- /dev/null +++ b/pg_dump @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pg_dump + +> Extract a PostgreSQL database into a script file or other archive file. +> More information: . + +- Dump database into an SQL-script file: + +`pg_dump {{db_name}} > {{output_file.sql}}` + +- Same as above, customize username: + +`pg_dump -U {{username}} {{db_name}} > {{output_file.sql}}` + +- Same as above, customize host and port: + +`pg_dump -h {{host}} -p {{port}} {{db_name}} > {{output_file.sql}}` + +- Dump a database into a custom-format archive file: + +`pg_dump -Fc {{db_name}} > {{output_file.dump}}` + +- Dump only database data into an SQL-script file: + +`pg_dump -a {{db_name}} > {{path/to/output_file.sql}}` + +- Dump only schema (data definitions) into an SQL-script file: + +`pg_dump -s {{db_name}} > {{path/to/output_file.sql}}` diff --git a/pg_dumpall b/pg_dumpall new file mode 100644 index 00000000..d204c55c --- /dev/null +++ b/pg_dumpall @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pg_dumpall + +> Extract a PostgreSQL database cluster into a script file or other archive file. +> More information: . + +- Dump all databases: + +`pg_dumpall > {{path/to/file.sql}}` + +- Dump all databases using a specific username: + +`pg_dumpall --username={{username}} > {{path/to/file.sql}}` + +- Same as above, customize host and port: + +`pg_dumpall -h {{host}} -p {{port}} > {{output_file.sql}}` + +- Dump all databases into a custom-format archive file with moderate compression: + +`pg_dumpall -Fc > {{output_file.dump}}` + +- Dump only database data into an SQL-script file: + +`pg_dumpall --data-only > {{path/to/file.sql}}` + +- Dump only schema (data definitions) into an SQL-script file: + +`pg_dumpall -s > {{output_file.sql}}` diff --git a/pg_isready b/pg_isready new file mode 100644 index 00000000..5c0a6471 --- /dev/null +++ b/pg_isready @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pg_isready + +> Check the connection status of a PostgreSQL server. +> More information: . + +- Check connection: + +`pg_isready` + +- Check connection with a specific hostname and port: + +`pg_isready --host={{hostname}} --port={{port}}` + +- Check connection displaying a message only when the connection fails: + +`pg_isready --quiet` diff --git a/pg_restore b/pg_restore new file mode 100644 index 00000000..898b2895 --- /dev/null +++ b/pg_restore @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pg_restore + +> Restore a PostgreSQL database from an archive file created by pg_dump. +> More information: . + +- Restore an archive into an existing database: + +`pg_restore -d {{db_name}} {{archive_file.dump}}` + +- Same as above, customize username: + +`pg_restore -U {{username}} -d {{db_name}} {{archive_file.dump}}` + +- Same as above, customize host and port: + +`pg_restore -h {{host}} -p {{port}} -d {{db_name}} {{archive_file.dump}}` + +- List database objects included in the archive: + +`pg_restore --list {{archive_file.dump}}` + +- Clean database objects before creating them: + +`pg_restore --clean -d {{db_name}} {{archive_file.dump}}` + +- Use multiple jobs to do the restoring: + +`pg_restore -j {{2}} -d {{db_name}} {{archive_file.dump}}` diff --git a/pgbench b/pgbench new file mode 100644 index 00000000..5886af95 --- /dev/null +++ b/pgbench @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgbench + +> Run a benchmark test on PostgreSQL. +> More information: . + +- Initialize a database with a scale factor of 50 times the default size: + +`pgbench --initialize --scale={{50}} {{database_name}}` + +- Benchmark a database with 10 clients, 2 worker threads, and 10,000 transactions per client: + +`pgbench --client={{10}} --jobs={{2}} --transactions={{10000}} {{database_name}}` diff --git a/pgmbentley b/pgmbentley new file mode 100644 index 00000000..aa7ebee7 --- /dev/null +++ b/pgmbentley @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmbentley + +> Bentleyize a PGM image. +> More information: . + +- Apply the Bentley Effect on a PGM image: + +`pgmbentley {{path/to/input_file.pgm}} > {{path/to/output_file.pgm}}` diff --git a/pgmdeshadow b/pgmdeshadow new file mode 100644 index 00000000..9b068c6e --- /dev/null +++ b/pgmdeshadow @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmdeshadow + +> Deshadow a PGM image. +> More information: . + +- Remove grey shadows from a PGM image: + +`pgmdeshadow {{path/to/input_file.pgm}} > {{path/to/output_file.pgm}}` diff --git a/pgmenhance b/pgmenhance new file mode 100644 index 00000000..319a9426 --- /dev/null +++ b/pgmenhance @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmenhance + +> Edge-enhance a PGM image. +> See also: `pamedge`. +> More information: . + +- Edge-enhance a PGM image: + +`pgmenhance {{path/to/image.pgm}} > {{path/to/output.pgm}}` + +- Specify the level of enhancement: + +`pgmenhance -{{1..9}} {{path/to/image.pgm}} > {{path/to/output.pgm}}` diff --git a/pgmhist b/pgmhist new file mode 100644 index 00000000..dd4d6889 --- /dev/null +++ b/pgmhist @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmhist + +> Print a histogram of the values present in a PGM image. +> See also: `ppmhist`. +> More information: . + +- Display the histogram for human reading: + +`pgmhist {{path/to/image.pgm}}` + +- Display the median grey value: + +`pgmhist -median {{path/to/image.pgm}}` + +- Display four quartile grey value: + +`pgmhist -quartile {{path/to/image.pgm}}` + +- Report the existence of invalid grey values: + +`pgmhist -forensic {{path/to/image.pgm}}` + +- Display machine-readable output: + +`pgmhist -machine {{path/to/image.pgm}}` diff --git a/pgmkernel b/pgmkernel new file mode 100644 index 00000000..4ae7af0f --- /dev/null +++ b/pgmkernel @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmkernel + +> Generate a convolution kernel to be used with `pnmconvol`. +> See also: `pnmconvol`. +> More information: . + +- Generate a convolution kernel: + +`pgmkernel {{width}} {{height}} > {{path/to/output.pgm}}` + +- Generate a quadratic convolution kernel: + +`pgmkernel {{size}} > {{path/to/output.pgm}}` + +- Specify the weight of the center in the generated kernel: + +`pgmkernel -weight {{value}} {{width}} {{height}} > {{path/to/output.pgm}}` diff --git a/pgmmake b/pgmmake new file mode 100644 index 00000000..a25f056b --- /dev/null +++ b/pgmmake @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmmake + +> Create PGM image with a uniform gray level. +> More information: . + +- Create PGM image with a uniform gray level (specified as a number between 0 and 1) and the specified dimensions: + +`pgmmake {{graylevel}} {{width}} {{height}} > {{path/to/output_file.pgm}}` diff --git a/pgmnoise b/pgmnoise new file mode 100644 index 00000000..eb142d4d --- /dev/null +++ b/pgmnoise @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmnoise + +> Generate white noise. +> More information: . + +- Generate a PGM image containing white noise: + +`pgmnoise {{width}} {{height}} > {{path/to/output.pgm}}` + +- Specify the seed for the pseudo-random number generator: + +`pgmnoise {{width}} {{height}} -randomseed {{value}} > {{path/to/output.pgm}}` diff --git a/pgmoil b/pgmoil new file mode 100644 index 00000000..5c67a3be --- /dev/null +++ b/pgmoil @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmoil + +> This command is superseded by `pamoil`. +> More information: . + +- View documentation for the current command: + +`tldr pamoil` diff --git a/pgmramp b/pgmramp new file mode 100644 index 00000000..389ba2de --- /dev/null +++ b/pgmramp @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmramp + +> Generate a greyscale map. +> More information: . + +- Generate a left-to-right greyscale map: + +`pgmtexture -lr > {{path/to/output.pgm}}` + +- Generate a top-to-bottom greyscale map: + +`pgmtexture -tb > {{path/to/output.pgm}}` + +- Generate a rectangular greyscale map: + +`pgmtexture -rectangle > {{path/to/output.pgm}}` + +- Generate a elliptical greyscale map: + +`pgmtexture -ellipse {{path/to/image.pgm}} > {{path/to/output.pgm}}` + +- Generate a greyscale map from the top-left corner to the bottom-right corner: + +`pgmtexture -diagonal {{path/to/image.pgm}} > {{path/to/output.pgm}}` diff --git a/pgmtexture b/pgmtexture new file mode 100644 index 00000000..85b49322 --- /dev/null +++ b/pgmtexture @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtexture + +> Extract textural features from a PGM image. +> More information: . + +- Extract textural features from a PGM image: + +`pgmtexture {{path/to/image.pgm}} > {{path/to/output.pgm}}` + +- Specify the distance parameter for the feature extraction algorithm: + +`pgmtexture -d {{distance}} {{path/to/image.pgm}} > {{path/to/output.pgm}}` diff --git a/pgmtofs b/pgmtofs new file mode 100644 index 00000000..b21d74e9 --- /dev/null +++ b/pgmtofs @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtofs + +> Convert a PGM image to Usenix FaceSaver format. +> See also: `fstopgm`. +> More information: . + +- Convert the specified PGM image to Usenix FaceSave format: + +`pgmtofs {{path/to/input.pgm}} > {{path/to/output.fs}}` diff --git a/pgmtolispm b/pgmtolispm new file mode 100644 index 00000000..714194f0 --- /dev/null +++ b/pgmtolispm @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtolispm + +> Convert a PGM image to Lisp Machine format. +> See also: `lispmtopgm`. +> More information: . + +- Convert the specified PGM image to Lisp Machine format: + +`pgmtolispm {{path/to/input.pgm}} > {{path/to/output.lispm}}` diff --git a/pgmtopgm b/pgmtopgm new file mode 100644 index 00000000..b1bedbdd --- /dev/null +++ b/pgmtopgm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtopgm + +> Copy a PGM image file. +> More information: . + +- Copy PGM file from `stdin` to `stderr`: + +`pgmtopgm` + +- Display version: + +`pgmtopgm -version` diff --git a/pgmtoppm b/pgmtoppm new file mode 100644 index 00000000..b5d47d95 --- /dev/null +++ b/pgmtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtoppm + +> Colorize a PGM image. +> More information: . + +- Map all greyscale values of the input image to all colors between the two specified colors: + +`pgmtoppm -black {{red}} --white {{blue}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` + +- Map all greyscale values of the input image to colors according to the specified colormap: + +`pgmtoppm -map {{path/to/colormap.ppm}} {{path/to/input.pgm}} > {{path/to/output.ppm}}` diff --git a/pgmtosbig b/pgmtosbig new file mode 100644 index 00000000..3745e4a5 --- /dev/null +++ b/pgmtosbig @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtosbig + +> Convert a PGM image to the SBIG CCDOPS format. +> More information: . + +- Convert a PGM image file to the SBIG CCDOPS format: + +`pgmtosbig {{path/to/input_file.pgm}} > {{path/to/output.sbig}}` diff --git a/pgmtost4 b/pgmtost4 new file mode 100644 index 00000000..0ee6c31b --- /dev/null +++ b/pgmtost4 @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgmtost4 + +> Convert a PGM image to the SBIG ST-4 format. +> More information: . + +- Convert a PGM image file to the SBIG ST-4 format: + +`pgmtost4 {{path/to/input_file.pgm}} > {{path/to/output.st4}}` diff --git a/pgrep b/pgrep new file mode 100644 index 00000000..e7e49372 --- /dev/null +++ b/pgrep @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pgrep + +> Find or signal processes by name. +> More information: . + +- Return PIDs of any running processes with a matching command string: + +`pgrep {{process_name}}` + +- Search for processes including their command-line options: + +`pgrep --full "{{process_name}} {{parameter}}"` + +- Search for processes run by a specific user: + +`pgrep --euid root {{process_name}}` diff --git a/phan b/phan new file mode 100644 index 00000000..c5f3acab --- /dev/null +++ b/phan @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phan + +> A static analysis tool for PHP. +> More information: . + +- Generate a `.phan/config.php` in the current directory: + +`phan --init` + +- Generate a Phan configuration file using a specific level (1 being strictest to 5 being the least strict): + +`phan --init --init-level {{level}}` + +- Analyze the current directory: + +`phan` + +- Analyze one or more directories: + +`phan --directory {{path/to/directory}} --directory {{path/to/another_directory}}` + +- Specify a configuration file (defaults to `.phan/config.php`): + +`phan --config-file {{path/to/config.php}}` + +- Specify the output mode: + +`phan --output-mode {{text|verbose|json|csv|codeclimate|checkstyle|pylint|html}}` + +- Specify the number of parallel processes: + +`phan --processes {{number_of_processes}}` diff --git a/phing b/phing new file mode 100644 index 00000000..3eaa585a --- /dev/null +++ b/phing @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phing + +> A PHP build tool based on Apache Ant. +> More information: . + +- Perform the default task in the `build.xml` file: + +`phing` + +- Initialize a new build file: + +`phing -i {{path/to/build.xml}}` + +- Perform a specific task: + +`phing {{task_name}}` + +- Use the given build file path: + +`phing -f {{path/to/build.xml}} {{task_name}}` + +- Log to the given file: + +`phing -logfile {{path/to/log_file}} {{task_name}}` + +- Use custom properties in the build: + +`phing -D{{property}}={{value}} {{task_name}}` + +- Specify a custom listener class: + +`phing -listener {{class_name}} {{task_name}}` + +- Build using verbose output: + +`phing -verbose {{task_name}}` diff --git a/phive b/phive new file mode 100644 index 00000000..27b7ed98 --- /dev/null +++ b/phive @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phive + +> The Phar Installation and Verification Environment for secure PHP application deployment. +> More information: . + +- Display a list of available aliased Phars: + +`phive list` + +- Install a specified Phar to the local directory: + +`phive install {{alias|url}}` + +- Install a specified Phar globally: + +`phive install {{alias|url}} --global` + +- Install a specified Phar to a target directory: + +`phive install {{alias|url}} --target {{path/to/directory}}` + +- Update all Phar files to the latest version: + +`phive update` + +- Remove a specified Phar file: + +`phive remove {{alias|url}}` + +- Remove unused Phar files: + +`phive purge` + +- List all available commands: + +`phive help` diff --git a/php b/php new file mode 100644 index 00000000..3bbacd02 --- /dev/null +++ b/php @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# php + +> PHP command-line interface. +> More information: . + +- Parse and execute a PHP script: + +`php {{path/to/file}}` + +- Check syntax on (i.e. lint) a PHP script: + +`php -l {{path/to/file}}` + +- Run PHP interactively: + +`php -a` + +- Run PHP code (Notes: Don't use tags; escape double quotes with backslash): + +`php -r "{{code}}"` + +- Start a PHP built-in web server in the current directory: + +`php -S {{host:port}}` + +- List installed PHP extensions: + +`php -m` + +- Display information about the current PHP configuration: + +`php -i` + +- Display information about a specific function: + +`php --rf {{function_name}}` diff --git a/php-artisan b/php-artisan new file mode 100644 index 00000000..1da6603c --- /dev/null +++ b/php-artisan @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# php artisan + +> Laravel's Artisan command-line interface. +> More information: . + +- Start PHP's built-in web server for the current Laravel application: + +`php artisan serve` + +- Start an interactive PHP command-line interface: + +`php artisan tinker` + +- Generate a new Eloquent model class with a migration, factory and resource controller: + +`php artisan make:model {{ModelName}} --all` + +- Display a list of all available commands: + +`php artisan help` diff --git a/php-coveralls b/php-coveralls new file mode 100644 index 00000000..e168a235 --- /dev/null +++ b/php-coveralls @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# php-coveralls + +> A PHP client for Coveralls. +> More information: . + +- Send coverage information to Coveralls: + +`php-coveralls` + +- Send coverage information to Coveralls for a specific directory: + +`php-coveralls --root_dir {{path/to/directory}}` + +- Send coverage information to Coveralls with a specific config: + +`php-coveralls --config {{path/to/.coveralls.yml}}` + +- Send coverage information to Coveralls with verbose output: + +`php-coveralls --verbose` + +- Send coverage information to Coveralls excluding source files with no executable statements: + +`php-coveralls --exclude-no-stmt` + +- Send coverage information to Coveralls with a specific environment name: + +`php-coveralls --env {{test|dev|prod}}` + +- Specify multiple Coverage Clover XML files to upload: + +`php-coveralls --coverage_clover {{path/to/first_clover.xml}} --coverage_clover {{path/to/second_clover.xml}}` + +- Output the JSON that will be sent to Coveralls to a specific file: + +`php-coveralls --json_path {{path/to/coveralls-upload.json}}` diff --git a/php-cs-fixer b/php-cs-fixer new file mode 100644 index 00000000..3ef0ad7f --- /dev/null +++ b/php-cs-fixer @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# PHP-CS-Fixer + +> Automatic coding style fixer for PHP. +> More information: . + +- Execute code style fixing in the current directory: + +`php-cs-fixer fix` + +- Execute code style fixing for a specific directory: + +`php-cs-fixer fix {{path/to/directory}}` + +- Execute code style linting without applying changes: + +`php-cs-fixer fix --dry-run` + +- Execute code style fixes using specific rules: + +`php-cs-fixer fix --rules={{rules}}` + +- Display the rules that have been applied: + +`php-cs-fixer fix --verbose` + +- Output the results in a different format: + +`php-cs-fixer fix --format={{txt|json|xml|checkstyle|junit|gitlab}}` + +- Display files that require fixing: + +`php-cs-fixer list-files` + +- Describe a rule or ruleset: + +`php-cs-fixer describe {{rule}}` diff --git a/php-yii b/php-yii new file mode 100644 index 00000000..cc281999 --- /dev/null +++ b/php-yii @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# php yii + +> Yii Framework's command-line interface. +> More information: . + +- Start PHP's built-in web server for the current Yii application: + +`php yii {{serve}}` + +- Generate a controller, views and related files for the CRUD actions on the specified model class: + +`php yii {{gii/crud}} --modelClass={{ModelName}} --controllerClass={{ControllerName}}` + +- Display help: + +`php yii {{help}}` diff --git a/phpbu b/phpbu new file mode 100644 index 00000000..4294354a --- /dev/null +++ b/phpbu @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpbu + +> A backup utility framework for PHP. +> More information: . + +- Run backups using the default `phpbu.xml` configuration file: + +`phpbu` + +- Run backups using a specific configuration file: + +`phpbu --configuration={{path/to/configuration_file.xml}}` + +- Only run the specified backups: + +`phpbu --limit={{backup_task_name}}` + +- Simulate the actions that would have been performed: + +`phpbu --simulate` diff --git a/phpcbf b/phpcbf new file mode 100644 index 00000000..d133970f --- /dev/null +++ b/phpcbf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpcbf + +> Fix violations detected by phpcs. +> More information: . + +- Fix issues in the specified directory (defaults to the PEAR standard): + +`phpcbf {{path/to/directory}}` + +- Display a list of installed coding standards: + +`phpcbf -i` + +- Specify a coding standard to validate against: + +`phpcbf {{path/to/directory}} --standard {{standard}}` + +- Specify comma-separated file extensions to include when sniffing: + +`phpcbf {{path/to/directory}} --extensions {{file_extension1,file_extension2,...}}` + +- A comma-separated list of files to load before processing: + +`phpcbf {{path/to/directory}} --bootstrap {{path/to/file1,path/to/file2,...)}}` + +- Don't recurse into subdirectories: + +`phpcbf {{path/to/directory}} -l` diff --git a/phpcpd b/phpcpd new file mode 100644 index 00000000..ef8b0dff --- /dev/null +++ b/phpcpd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpcpd + +> A copy and paste detector for PHP code. +> More information: . + +- Analyze duplicated code for a specific file or directory: + +`phpcpd {{path/to/file_or_directory}}` + +- Analyze using fuzzy matching for variable names: + +`phpcpd --fuzzy {{path/to/file_or_directory}}` + +- Specify a minimum number of identical lines (defaults to 5): + +`phpcpd --min-lines {{number_of_lines}} {{path/to/file_or_directory}}` + +- Specify a minimum number of identical tokens (defaults to 70): + +`phpcpd --min-tokens {{number_of_tokens}} {{path/to/file_or_directory}}` + +- Exclude a directory from analysis (must be relative to the source): + +`phpcpd --exclude {{path/to/excluded_directory}} {{path/to/file_or_directory}}` + +- Output the results to a PHP-CPD XML file: + +`phpcpd --log-pmd {{path/to/log_file}} {{path/to/file_or_directory}}` diff --git a/phpcs b/phpcs new file mode 100644 index 00000000..1b6ee806 --- /dev/null +++ b/phpcs @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpcs + +> Tokenize PHP, JavaScript and CSS files to detect violations of a defined set of coding standards. +> More information: . + +- Sniff the specified directory for issues (defaults to the PEAR standard): + +`phpcs {{path/to/directory}}` + +- Display a list of installed coding standards: + +`phpcs -i` + +- Specify a coding standard to validate against: + +`phpcs {{path/to/directory}} --standard {{standard}}` + +- Specify comma-separated file extensions to include when sniffing: + +`phpcs {{path/to/directory}} --extensions {{file_extension1,file_extension2,...}}` + +- Specify the format of the output report (e.g. `full`, `xml`, `json`, `summary`): + +`phpcs {{path/to/directory}} --report {{format}}` + +- Set configuration variables to be used during the process: + +`phpcs {{path/to/directory}} --config-set {{key}} {{value}}` + +- A comma-separated list of files to load before processing: + +`phpcs {{path/to/directory}} --bootstrap {{path/to/file1,path/to/file2,...}}` + +- Don't recurse into subdirectories: + +`phpcs {{path/to/directory}} -l` diff --git a/phpdox b/phpdox new file mode 100644 index 00000000..f6d1c645 --- /dev/null +++ b/phpdox @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpdox + +> A PHP documentation generator. +> More information: . + +- Display an annotated skeleton configuration XML file: + +`phpdox --skel` + +- Generate documentation for the current working directory: + +`phpdox` + +- Generate documentation using a specific configuration file: + +`phpdox --file {{path/to/phpdox.xml}}` + +- Only run the metadata collection process: + +`phpdox --collector` + +- Only run the documentation generator process: + +`phpdox --generator` diff --git a/phpenv b/phpenv new file mode 100644 index 00000000..0a45d265 --- /dev/null +++ b/phpenv @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpenv + +> A PHP version manager for development purposes. +> More information: . + +- Install a PHP version globally: + +`phpenv install {{version}}` + +- Refresh shim files for all PHP binaries known to `phpenv`: + +`phpenv rehash` + +- List all installed PHP versions: + +`phpenv versions` + +- Display the currently active PHP version: + +`phpenv version` + +- Set the global PHP version: + +`phpenv global {{version}}` + +- Set the local PHP version, which overrides the global version: + +`phpenv local {{version}}` + +- Unset the local PHP version: + +`phpenv local --unset` diff --git a/phpize b/phpize new file mode 100644 index 00000000..49e04f45 --- /dev/null +++ b/phpize @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpize + +> Prepare a PHP extension for compiling. +> More information: . + +- Prepare the PHP extension in the current directory for compiling: + +`phpize` + +- Delete files previously created by phpize: + +`phpize --clean` diff --git a/phploc b/phploc new file mode 100644 index 00000000..fbedd06a --- /dev/null +++ b/phploc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phploc + +> Quickly measure the size and analyzing the structure of a PHP project. +> More information: . + +- Analyze a directory and print the result: + +`phploc {{path/to/directory}}` + +- Include only specific files from a comma-separated list (globs are allowed): + +`phploc {{path/to/directory}} --names '{{path/to/file1,path/to/file2,...}}'` + +- Exclude specific files from a comma-separated list (globs are allowed): + +`phploc {{path/to/directory}} --names-exclude '{{path/to/file1,path/to/file2,...}}'` + +- Exclude a specific directory from analysis: + +`phploc {{path/to/directory}} --exclude {{path/to/exclude_directory}}` + +- Log the results to a specific CSV file: + +`phploc {{path/to/directory}} --log-csv {{path/to/file}}` + +- Log the results to a specific XML file: + +`phploc {{path/to/directory}} --log-xml {{path/to/file}}` + +- Count PHPUnit test case classes and test methods: + +`phploc {{path/to/directory}} --count-tests` diff --git a/phpmd b/phpmd new file mode 100644 index 00000000..34165977 --- /dev/null +++ b/phpmd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpmd + +> PHP mess detector: check for common potential problems. +> More information: . + +- Display a list of available rulesets and formats: + +`phpmd` + +- Scan a file or directory for problems using comma-separated rulesets: + +`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}}` + +- Specify the minimum priority threshold for rules: + +`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --minimumpriority {{priority}}` + +- Include only the specified extensions in analysis: + +`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --suffixes {{extensions}}` + +- Exclude the specified comma-separated directories: + +`phpmd {{path/to/file_or_directory1,path/to/file_or_directory2,...}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --exclude {{directory_patterns}}` + +- Output the results to a file instead of `stdout`: + +`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --reportfile {{path/to/report_file}}` + +- Ignore the use of warning-suppressive PHPDoc comments: + +`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --strict` diff --git a/phpspec b/phpspec new file mode 100644 index 00000000..35cde844 --- /dev/null +++ b/phpspec @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpspec + +> A Behaviour Driven Development tool for PHP. +> More information: . + +- Create a specification for a class: + +`phpspec describe {{class_name}}` + +- Run all specifications in the "spec" directory: + +`phpspec run` + +- Run a single specification: + +`phpspec run {{path/to/class_specification_file}}` + +- Run specifications using a specific configuration file: + +`phpspec run -c {{path/to/configuration_file}}` + +- Run specifications using a specific bootstrap file: + +`phpspec run -b {{path/to/bootstrap_file}}` + +- Disable code generation prompts: + +`phpspec run --no-code-generation` + +- Enable fake return values: + +`phpspec run --fake` diff --git a/phpstan b/phpstan new file mode 100644 index 00000000..92c07658 --- /dev/null +++ b/phpstan @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpstan + +> A PHP static analysis tool to discover bugs in code. +> More information: . + +- Analyze one or more directories: + +`phpstan analyse {{path/to/directory1 path/to/directory2 ...}}` + +- Analyze a directory using a configuration file: + +`phpstan analyse {{path/to/directory}} --configuration {{path/to/config}}` + +- Analyze using a specific rule level (0-7, higher is stricter): + +`phpstan analyse {{path/to/directory}} --level {{level}}` + +- Specify an autoload file to load before analyzing: + +`phpstan analyse {{path/to/directory}} --autoload-file {{path/to/autoload_file}}` + +- Specify a memory limit during analysis: + +`phpstan analyse {{path/to/directory}} --memory-limit {{memory_limit}}` + +- Display available options for analysis: + +`phpstan analyse --help` diff --git a/phpstorm b/phpstorm new file mode 100644 index 00000000..a105a580 --- /dev/null +++ b/phpstorm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpstorm + +> A cross-platform IDE for PHP based on the JetBrains IntelliJ platform. +> More information: . + +- Open a specific directory: + +`phpstorm {{path/to/directory}}` + +- Open a file: + +`phpstorm {{path/to/file}}` + +- Open a file at a specific line: + +`phpstorm --line {{line_number}} {{path/to/file}}` + +- View the differences between two files: + +`phpstorm diff {{path/to/left_file}} {{path/to/right_file}}` diff --git a/phpunit b/phpunit new file mode 100644 index 00000000..34763bda --- /dev/null +++ b/phpunit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# phpunit + +> PHPUnit command-line test runner. +> More information: . + +- Run tests in the current directory. Note: Expects you to have a 'phpunit.xml': + +`phpunit` + +- Run tests in a specific file: + +`phpunit {{path/to/TestFile.php}}` + +- Run tests annotated with the given group: + +`phpunit --group {{name}}` + +- Run tests and generate a coverage report in HTML: + +`phpunit --coverage-html {{path/to/directory}}` diff --git a/piactl b/piactl new file mode 100644 index 00000000..472e1aad --- /dev/null +++ b/piactl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# piactl + +> The command-line tool for Private Internet Access, a commercial VPN provider. +> More information: . + +- Log in to Private Internet Access: + +`piactl login {{path/to/login_file}}` + +- Connect to Private Internet Access: + +`piactl connect` + +- Disconnect from Private Internet Access: + +`piactl disconnect` + +- Enable or disable the Private Internet Access daemon in the background: + +`piactl background {{enable|disable}}` + +- List all available VPN regions: + +`piactl get regions` + +- Display the current VPN region: + +`piactl get region` + +- Set your VPN region: + +`piactl set region {{region}}` + +- Log out of Private Internet Access: + +`piactl logout` diff --git a/pic b/pic new file mode 100644 index 00000000..54df47cf --- /dev/null +++ b/pic @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pic + +> Picture preprocessor for the groff (GNU Troff) document formatting system. +> See also `groff` and `troff`. +> More information: . + +- Process input with pictures, saving the output for future typesetting with groff to PostScript: + +`pic {{path/to/input.pic}} > {{path/to/output.roff}}` + +- Typeset input with pictures to PDF using the [me] macro package: + +`pic -T {{pdf}} {{path/to/input.pic}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}` diff --git a/picard b/picard new file mode 100644 index 00000000..969b16f7 --- /dev/null +++ b/picard @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# picard + +> Next generation MusicBrainz tagging application. +> More information: . + +- Start Picard: + +`picard` + +- Open a set of files: + +`picard {{path/to/file1.mp3}} {{path/to/file2.mp3}}` + +- Display the version of Picard installed: + +`picard --long-version` diff --git a/picgo b/picgo new file mode 100644 index 00000000..fe232a4f --- /dev/null +++ b/picgo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# picgo + +> Upload an image to an image hosting service (default is SM.MS). +> More information: . + +- Interactively select a hosting service: + +`picgo set uploader` + +- Upload the image in current clipboard: + +`picgo upload` + +- Upload an image from a specific path: + +`picgo upload {{path/to/image}}` diff --git a/pickle b/pickle new file mode 100644 index 00000000..434215b6 --- /dev/null +++ b/pickle @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pickle + +> A PHP extension installer based on Composer. +> More information: . + +- Install a specific PHP extension: + +`pickle install {{extension_name}}` + +- Convert an existing PECL extension configuration to a Pickle configuration file: + +`pickle convert {{path/to/directory}}` + +- Validate a PECL extension: + +`pickle validate {{path/to/directory}}` + +- Package a PECL extension for release: + +`pickle release {{path/to/directory}}` diff --git a/picocom b/picocom new file mode 100644 index 00000000..9cc374a3 --- /dev/null +++ b/picocom @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# picocom + +> Minimal program to emulate serial consoles. +> More information: . + +- Connect to a serial console with a specified baud rate: + +`picocom {{/dev/ttyXYZ}} --baud {{baud_rate}}` + +- Map special characters (e.g. `LF` to `CRLF`): + +`picocom {{/dev/ttyXYZ}} --imap {{lfcrlf}}` diff --git a/picom-trans b/picom-trans new file mode 100644 index 00000000..56fc7632 --- /dev/null +++ b/picom-trans @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# picom-trans + +> Set the window opacity for the `picom` window compositor. +> More information: . + +- Set the currently focused window opacity to a specific percentage: + +`picom-trans --current --opacity {{90}}` + +- Set the opacity of a window with a specific name: + +`picom-trans --name {{Firefox}} --opacity {{90}}` + +- Set the opacity of a specific window selected via mouse cursor: + +`picom-trans --select --opacity {{90}}` + +- Toggle the opacity of a specific window: + +`picom-trans --name {{Firefox}} --toggle` diff --git a/picttoppm b/picttoppm new file mode 100644 index 00000000..c3cf1558 --- /dev/null +++ b/picttoppm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# picttoppm + +> Convert a Macintosh PICT file to a PPM image. +> More information: . + +- Convert a PICT file to a PPM image: + +`picttoppm {{path/to/file.pict}} > {{path/to/file.ppm}}` + +- Force any images in the PICT file to be output at full resolution: + +`picttoppm -fullres {{path/to/file.pict}} > {{path/to/file.ppm}}` + +- Do not assume that the input file contains a PICT header and execute quickdraw operations only: + +`picttoppm -noheader -quickdraw {{path/to/file.pict}} > {{path/to/file.ppm}}` diff --git a/pigz b/pigz new file mode 100644 index 00000000..d812db7a --- /dev/null +++ b/pigz @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pigz + +> Multithreaded zlib compression utility. +> More information: . + +- Compress a file with default options: + +`pigz {{path/to/file}}` + +- Compress a file using the best compression method: + +`pigz -9 {{path/to/file}}` + +- Compress a file using no compression and 4 processors: + +`pigz -0 -p{{4}} {{path/to/file}}` + +- Compress a directory using tar: + +`tar cf - {{path/to/directory}} | pigz > {{path/to/file.tar.gz}}` + +- Decompress a file: + +`pigz -d {{archive.gz}}` + +- List the contents of an archive: + +`pigz -l {{archive.tar.gz}}` diff --git a/ping b/ping new file mode 100644 index 00000000..b96061e9 --- /dev/null +++ b/ping @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ping + +> Send ICMP ECHO_REQUEST packets to network hosts. +> More information: . + +- Ping host: + +`ping {{host}}` + +- Ping a host only a specific number of times: + +`ping -c {{count}} {{host}}` + +- Ping host, specifying the interval in seconds between requests (default is 1 second): + +`ping -i {{seconds}} {{host}}` + +- Ping host without trying to lookup symbolic names for addresses: + +`ping -n {{host}}` + +- Ping host and ring the bell when a packet is received (if your terminal supports it): + +`ping -a {{host}}` + +- Also display a message if no response was received: + +`ping -O {{host}}` diff --git a/ping6 b/ping6 new file mode 100644 index 00000000..646aa879 --- /dev/null +++ b/ping6 @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ping6 + +> Send ICMP ECHO_REQUEST packets to network hosts via IPv6 address. +> More information: . + +- Ping a host: + +`ping6 {{host}}` + +- Ping a host only a specific number of times: + +`ping6 -c {{count}} {{host}}` + +- Ping a host, specifying the interval in seconds between requests (default is 1 second): + +`ping6 -i {{seconds}} {{host}}` + +- Ping a host without trying to lookup symbolic names for addresses: + +`ping6 -n {{host}}` + +- Ping a host and ring the bell when a packet is received (if your terminal supports it): + +`ping6 -a {{host}}` diff --git a/pinky b/pinky new file mode 100644 index 00000000..5d077e5c --- /dev/null +++ b/pinky @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pinky + +> Print user information using the `finger` protocol. +> More information: . + +- Display details about the current user: + +`pinky` + +- Display details for a specific user: + +`pinky {{user}}` + +- Display details in the long format: + +`pinky {{user}} -l` + +- Omit the user's home directory and shell in long format: + +`pinky {{user}} -lb` + +- Omit the user's project file in long format: + +`pinky {{user}} -lh` + +- Omit the column headings in short format: + +`pinky {{user}} -f` diff --git a/pint b/pint new file mode 100644 index 00000000..cd94eef6 --- /dev/null +++ b/pint @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Pint + +> An opinionated PHP code style fixer based on PHP-CS-Fixer. +> More information: . + +- Execute code style fixing: + +`pint` + +- Display all files that are changed: + +`pint -v` + +- Execute code style linting without applying changes: + +`pint --test` + +- Execute code style fixes using a specific configuration file: + +`pint --config {{path/to/pint.json}}` + +- Execute code style fixes using a specific preset: + +`pint --preset {{psr12}}` diff --git a/pinta b/pinta new file mode 100644 index 00000000..0e77fc65 --- /dev/null +++ b/pinta @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pinta + +> A free, open source program for drawing and image editing. +> More information: . + +- Start Pinta: + +`pinta` + +- Open specific files: + +`pinta {{path/to/image1 path/to/image2 ...}}` diff --git a/pio b/pio new file mode 100644 index 00000000..bc51809f --- /dev/null +++ b/pio @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio + +> Development environment for embedded boards. +> Some subcommands such as `pio run` have their own usage documentation. +> More information: . + +- Display help and list subcommands: + +`pio --help` + +- Display help for a specific subcommand: + +`pio {{subcommand}} --help` + +- Display version: + +`pio --version` diff --git a/pio-access b/pio-access new file mode 100644 index 00000000..b30255a1 --- /dev/null +++ b/pio-access @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio access + +> Set the access level on published resources (packages) in the registry. +> More information: . + +- Grant a user access to a resource: + +`pio access grant {{guest|maintainer|admin}} {{username}} {{resource_urn}}` + +- Remove a user's access to a resource: + +`pio access revoke {{username}} {{resource_urn}}` + +- Show all resources that a user or team has access to and the access level: + +`pio access list {{username}}` + +- Restrict access to a resource to specific users or team members: + +`pio access private {{resource_urn}}` + +- Allow all users access to a resource: + +`pio access public {{resource_urn}}` diff --git a/pio-account b/pio-account new file mode 100644 index 00000000..a13cfbc2 --- /dev/null +++ b/pio-account @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio account + +> Manage your PlatformIO account in the command-line. +> More information: . + +- Register a new PlatformIO account: + +`pio account register --username {{username}} --email {{email}} --password {{password}} --firstname {{firstname}} --lastname {{lastname}}` + +- Permanently delete your PlatformIO account and related data: + +`pio account destroy` + +- Log in to your PlatformIO account: + +`pio account login --username {{username}} --password {{password}}` + +- Log out of your PlatformIO account: + +`pio account logout` + +- Update your PlatformIO profile: + +`pio account update --username {{username}} --email {{email}} --firstname {{firstname}} --lastname {{lastname}} --current-password {{password}}` + +- Show detailed information about your PlatformIO account: + +`pio account show` + +- Reset your password using your username or email: + +`pio account forgot --username {{username_or_email}}` diff --git a/pio-boards b/pio-boards new file mode 100644 index 00000000..1b1658e8 --- /dev/null +++ b/pio-boards @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio boards + +> List pre-configured embedded boards available in PlatformIO. +> More information: . + +- List all available boards: + +`pio boards` + +- List only boards from installed platforms: + +`pio boards --installed` diff --git a/pio-check b/pio-check new file mode 100644 index 00000000..bd537126 --- /dev/null +++ b/pio-check @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio check + +> Perform a static analysis check on a PlatformIO project. +> More information: . + +- Perform a basic analysis check on the current project: + +`pio check` + +- Perform a basic analysis check on a specific project: + +`pio check --project-dir {{project_dir}}` + +- Perform an analysis check for a specific environment: + +`pio check --environment {{environment}}` + +- Perform an analysis check and only report a specified defect severity type: + +`pio check --severity {{low|medium|high}}` + +- Perform an analysis check and show detailed information when processing environments: + +`pio check --verbose` diff --git a/pio-ci b/pio-ci new file mode 100644 index 00000000..0ef8d65a --- /dev/null +++ b/pio-ci @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio ci + +> Build PlatformIO projects with an arbitrary source code structure. +> This will create a new temporary project which the source code will be copied into. +> More information: . + +- Build a PlatformIO project in the default system temporary directory and delete it afterwards: + +`pio ci {{path/to/project}}` + +- Build a PlatformIO project and specify specific libraries: + +`pio ci --lib {{path/to/library_directory}} {{path/to/project}}` + +- Build a PlatformIO project and specify a specific board (`pio boards` lists all of them): + +`pio ci --board {{board}} {{path/to/project}}` + +- Build a PlatformIO project in a specific directory: + +`pio ci --build-dir {{path/to/build_directory}} {{path/to/project}}` + +- Build a PlatformIO project and don't delete the build directory: + +`pio ci --keep-build-dir {{path/to/project}}` + +- Build a PlatformIO project using a specific configuration file: + +`pio ci --project-conf {{path/to/platformio.ini}}` diff --git a/pio-debug b/pio-debug new file mode 100644 index 00000000..10e1a2a4 --- /dev/null +++ b/pio-debug @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio debug + +> Debug PlatformIO projects. +> More information: . + +- Debug the PlatformIO project in the current directory: + +`pio debug` + +- Debug a specific PlatformIO project: + +`pio debug --project-dir {{path/to/platformio_project}}` + +- Debug a specific environment: + +`pio debug --environment {{environment}}` + +- Debug a PlatformIO project using a specific configuration file: + +`pio debug --project-conf {{path/to/platformio.ini}}` + +- Debug a PlatformIO project using the `gdb` debugger: + +`pio debug --interface={{gdb}} {{gdb_options}}` diff --git a/pio-device b/pio-device new file mode 100644 index 00000000..9d4ab288 --- /dev/null +++ b/pio-device @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio device + +> Manage and monitor PlatformIO devices. +> More information: . + +- List all available serial ports: + +`pio device list` + +- List all available logical devices: + +`pio device list --logical` + +- Start an interactive device monitor: + +`pio device monitor` + +- Start an interactive device monitor and listen to a specific port: + +`pio device monitor --port {{/dev/ttyUSBX}}` + +- Start an interactive device monitor and set a specific baud rate (defaults to 9600): + +`pio device monitor --baud {{57600}}` + +- Start an interactive device monitor and set a specific EOL character (defaults to `CRLF`): + +`pio device monitor --eol {{CRLF|CR|LF}}` + +- Go to the menu of the interactive device monitor: + +` + T` diff --git a/pio-home b/pio-home new file mode 100644 index 00000000..78f93220 --- /dev/null +++ b/pio-home @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio home + +> Launch the PlatformIO Home web server. +> More information: . + +- Open PlatformIO Home in the default web browser: + +`pio home` + +- Use a specific HTTP port (defaults to 8008): + +`pio home --port {{port}}` + +- Bind to a specific IP address (defaults to 127.0.0.1): + +`pio home --host {{ip_address}}` + +- Do not automatically open PlatformIO Home in the default web browser: + +`pio home --no-open` + +- Automatically shutdown the server on timeout (in seconds) when no clients are connected: + +`pio home --shutdown-timeout {{time}}` + +- Specify a unique session identifier to keep PlatformIO Home isolated from other instances and protected from 3rd party access: + +`pio home --session-id {{id}}` diff --git a/pio-init b/pio-init new file mode 100644 index 00000000..9cfb9cd6 --- /dev/null +++ b/pio-init @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio init + +> This command is an alias of `pio project init`. + +- View documentation for the original command: + +`tldr pio project` diff --git a/pio-lib b/pio-lib new file mode 100644 index 00000000..98ba74a0 --- /dev/null +++ b/pio-lib @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio lib + +> Manage PlatformIO libraries. +> More information: . + +- List installed libraries: + +`pio lib list` + +- List built-in libraries based on installed development platforms and their frameworks: + +`pio lib builtin` + +- Search for existing libraries: + +`pio lib search {{keyword}}` + +- Show details about a library: + +`pio lib show {{library}}` + +- Install a library: + +`pio lib install {{library}}` + +- Update installed libraries: + +`pio lib update` + +- Uninstall a library: + +`pio lib uninstall {{library}}` + +- Show PlatformIO library registry statistics: + +`pio lib stats` diff --git a/pio-org b/pio-org new file mode 100644 index 00000000..a334ea5a --- /dev/null +++ b/pio-org @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio org + +> Manage PlatformIO organizations and their owners. +> More information: . + +- Create a new organization: + +`pio org create {{organization_name}}` + +- Delete an organization: + +`pio org destroy {{organization_name}}` + +- Add a user to an organization: + +`pio org add {{organization_name}} {{username}}` + +- Remove a user from an organization: + +`pio org remove {{organization_name}} {{username}}` + +- List all organizations the current user is a member of and their owners: + +`pio org list` + +- Update the name, email or display name of an organization: + +`pio org update --orgname {{new_organization_name}} --email {{new_email}} --displayname {{new_display_name}} {{organization_name}}` diff --git a/pio-package b/pio-package new file mode 100644 index 00000000..b9ff6d3b --- /dev/null +++ b/pio-package @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio package + +> Manage packages in the registry. +> Packages can only be removed within 72 hours (3 days) from the date that they are published. +> More information: . + +- Create a package tarball from the current directory: + +`pio package pack --output {{path/to/package.tar.gz}}` + +- Create and publish a package tarball from the current directory: + +`pio package publish` + +- Publish the current directory and restrict public access to it: + +`pio package publish --private` + +- Publish a package: + +`pio package publish {{path/to/package.tar.gz}}` + +- Publish a package with a custom release date (UTC): + +`pio package publish {{path/to/package.tar.gz}} --released-at "{{2021-04-08 21:15:38}}"` + +- Remove all versions of a published package from the registry: + +`pio package unpublish {{package}}` + +- Remove a specific version of a published package from the registry: + +`pio package unpublish {{package}}@{{version}}` + +- Undo the removal, putting all versions or a specific version of the package back into the registry: + +`pio package unpublish --undo {{package}}@{{version}}` diff --git a/pio-platform b/pio-platform new file mode 100644 index 00000000..166746b6 --- /dev/null +++ b/pio-platform @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio platform + +> Manage PlatformIO development platforms. +> More information: . + +- List all installed development platforms: + +`pio platform list` + +- Search for existing development platforms: + +`pio platform search {{platform}}` + +- Show details about a development platform: + +`pio platform show {{platform}}` + +- Install a development platform: + +`pio platform install {{platform}}` + +- Update installed development platforms: + +`pio platform update` + +- Uninstall a development platform: + +`pio platform uninstall {{platform}}` + +- List all supported frameworks: + +`pio platform frameworks` diff --git a/pio-project b/pio-project new file mode 100644 index 00000000..b1362d77 --- /dev/null +++ b/pio-project @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio project + +> Manage PlatformIO projects. +> More information: . + +- Initialize a new PlatformIO project: + +`pio project init` + +- Initialize a new PlatformIO project in a specific directory: + +`pio project init --project-dir {{path/to/project_directory}}` + +- Initialize a new PlatformIO project, specifying a board ID: + +`pio project init --board {{ATmega328P|uno|...}}` + +- Initialize a new PlatformIO based project, specifying one or more project options: + +`pio project init --project-option="{{option}}={{value}}" --project-option="{{option}}={{value}}"` + +- Print the configuration of a project: + +`pio project config` diff --git a/pio-remote b/pio-remote new file mode 100644 index 00000000..b2f6a67b --- /dev/null +++ b/pio-remote @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio remote + +> Helper command for PlatformIO Remote Development. +> `pio remote [command]` takes the same arguments as its locally executing counterpart `pio [command]`. +> More information: . + +- List all active Remote Agents: + +`pio remote agent list` + +- Start a new Remote Agent with a specific name and share it with friends: + +`pio remote agent start --name {{agent_name}} --share {{example1@example.com}} --share {{example2@example.com}}` + +- List devices from specified Agents (omit `--agent` to specify all Agents): + +`pio remote --agent {{agent_name1}} --agent {{agent_name2}} device list` + +- Connect to the serial port of a remote device: + +`pio remote --agent {{agent_name}} device monitor` + +- Run all targets on a specified Agent: + +`pio remote --agent {{agent_name}} run` + +- Update installed core packages, development platforms and global libraries on a specific Agent: + +`pio remote --agent {{agent_name}} update` + +- Run all tests in all environments on a specific Agent: + +`pio remote --agent {{agent_name}} test` diff --git a/pio-run b/pio-run new file mode 100644 index 00000000..e9566d06 --- /dev/null +++ b/pio-run @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio run + +> Run PlatformIO project targets. +> More information: . + +- List all available project targets: + +`pio run --list-targets` + +- List all available project targets of a specific environment: + +`pio run --list-targets --environment {{environment}}` + +- Run all targets: + +`pio run` + +- Run all targets of specified environments: + +`pio run --environment {{environment1}} --environment {{environment2}}` + +- Run specified targets: + +`pio run --target {{target1}} --target {{target2}}` + +- Run the targets of a specified configuration file: + +`pio run --project-conf {{path/to/platformio.ini}}` diff --git a/pio-settings b/pio-settings new file mode 100644 index 00000000..360c295d --- /dev/null +++ b/pio-settings @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio settings + +> View and modify PlatformIO settings. +> More information: . + +- Display the names, values and descriptions of all PlatformIO settings: + +`pio settings get` + +- Display the name, value and description of a specific PlatformIO setting: + +`pio settings get {{setting}}` + +- Set a specific setting value: + +`pio settings set {{setting}} {{value}}` + +- Reset the values of all modified settings to their factory defaults: + +`pio settings reset` diff --git a/pio-system b/pio-system new file mode 100644 index 00000000..06cf5054 --- /dev/null +++ b/pio-system @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio system + +> Miscellaneous system commands for PlatformIO. +> More information: . + +- Install shell completion for the current shell (supports Bash, Fish, Zsh and PowerShell): + +`pio system completion install` + +- Uninstall shell completion for the current shell: + +`pio system completion uninstall` + +- Display system-wide PlatformIO information: + +`pio system info` + +- Remove unused PlatformIO data: + +`pio system prune` + +- Remove only cached data: + +`pio system prune --cache` + +- List unused PlatformIO data that would be removed but do not actually remove it: + +`pio system prune --dry-run` diff --git a/pio-team b/pio-team new file mode 100644 index 00000000..fba48a0c --- /dev/null +++ b/pio-team @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio team + +> Manage PlatformIO teams. +> More information: . + +- Create a new team with the specified description: + +`pio team create --description {{description}} {{organization_name}}:{{team_name}}` + +- Delete a team: + +`pio team destroy {{organization_name}}:{{team_name}}` + +- Add a new user to a team: + +`pio team add {{organization_name}}:{{team_name}} {{username}}` + +- Remove a user from a team: + +`pio team remove {{organization_name}}:{{team_name}} {{username}}` + +- List all teams that the user is part of and their members: + +`pio team list` + +- List all teams in an organization: + +`pio team list {{organization_name}}` + +- Rename a team: + +`pio team update --name {{new_team_name}} {{organization_name}}:{{team_name}}` + +- Change the description of a team: + +`pio team update --description {{new_description}} {{organization_name}}:{{team_name}}` diff --git a/pio-test b/pio-test new file mode 100644 index 00000000..5f79c5c6 --- /dev/null +++ b/pio-test @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio test + +> Run local tests on a PlatformIO project. +> More information: . + +- Run all tests in all environments of the current PlatformIO project: + +`pio test` + +- Test only specific environments: + +`pio test --environment {{environment1}} --environment {{environment2}}` + +- Run only tests whose name matches a specific glob pattern: + +`pio test --filter "{{pattern}}"` + +- Ignore tests whose name matches a specific glob pattern: + +`pio test --ignore "{{pattern}}"` + +- Specify a port for firmware uploading: + +`pio test --upload-port {{upload_port}}` + +- Specify a custom configuration file for running the tests: + +`pio test --project-conf {{path/to/platformio.ini}}` diff --git a/pio-update b/pio-update new file mode 100644 index 00000000..1986a1ca --- /dev/null +++ b/pio-update @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio update + +> Update installed PlatformIO Core packages, development platforms and global libraries. +> See also: `pio platform update`, `pio lib update`. +> More information: . + +- Perform a full update of all packages, development platforms and global libraries: + +`pio update` + +- Update core packages only (skips platforms and libraries): + +`pio update --core-packages` + +- Check for new versions of packages, platforms and libraries but do not actually update them: + +`pio update --dry-run` diff --git a/pio-upgrade b/pio-upgrade new file mode 100644 index 00000000..9b56ffaf --- /dev/null +++ b/pio-upgrade @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio upgrade + +> Update PlatformIO to the latest version. +> More information: . + +- Update PlatformIO to the latest version: + +`pio upgrade` + +- Update PlatformIO to the latest development (unstable) version: + +`pio upgrade --dev` diff --git a/piodebuggdb b/piodebuggdb new file mode 100644 index 00000000..6e3b4fa0 --- /dev/null +++ b/piodebuggdb @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# piodebuggdb + +> This command is an alias of `pio debug --interface=gdb`. + +- View documentation for the original command: + +`tldr pio debug` diff --git a/pip b/pip new file mode 100644 index 00000000..fd763916 --- /dev/null +++ b/pip @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pip + +> Python package manager. +> Some subcommands such as `pip install` have their own usage documentation. +> More information: . + +- Install a package (see `pip install` for more install examples): + +`pip install {{package}}` + +- Install a package to the user's directory instead of the system-wide default location: + +`pip install --user {{package}}` + +- Upgrade a package: + +`pip install --upgrade {{package}}` + +- Uninstall a package: + +`pip uninstall {{package}}` + +- Save installed packages to file: + +`pip freeze > {{requirements.txt}}` + +- Show installed package info: + +`pip show {{package}}` + +- Install packages from a file: + +`pip install --requirement {{requirements.txt}}` diff --git a/pip-freeze b/pip-freeze new file mode 100644 index 00000000..d561b61e --- /dev/null +++ b/pip-freeze @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pip freeze + +> List installed packages in requirements format. +> More information: . + +- List installed packages: + +`pip freeze` + +- List installed packages and write it to the `requirements.txt` file: + +`pip freeze > requirements.txt` + +- List installed packages in a virtual environment, excluding globally installed packages: + +`pip freeze --local > requirements.txt` + +- List installed packages in the user-site: + +`pip freeze --user > requirements.txt` + +- List all packages, including `pip`, `distribute`, `setuptools`, and `wheel` (they are skipped by default): + +`pip freeze --all > requirements.txt` diff --git a/pip-install b/pip-install new file mode 100644 index 00000000..bf924e45 --- /dev/null +++ b/pip-install @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pip install + +> Install Python packages. +> More information: . + +- Install a package: + +`pip install {{package}}` + +- Install a specific version of a package: + +`pip install {{package}}=={{version}}` + +- Install packages listed in a file: + +`pip install -r {{path/to/requirements.txt}}` + +- Install packages from an URL or local file archive (.tar.gz | .whl): + +`pip install --find-links {{url|path/to/file}}` + +- Install the local package in the current directory in develop (editable) mode: + +`pip install --editable {{.}}` diff --git a/pip-uninstall b/pip-uninstall new file mode 100644 index 00000000..848d8b78 --- /dev/null +++ b/pip-uninstall @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pip uninstall + +> Uninstall Python packages. +> More information: . + +- Uninstall a package: + +`pip uninstall {{package}}` + +- Uninstall packages listed in a specific file: + +`pip uninstall --requirement {{path/to/requirements.txt}}` + +- Uninstall package without asking for confirmation: + +`pip uninstall --yes {{package}}` diff --git a/pip3 b/pip3 new file mode 100644 index 00000000..bf392c01 --- /dev/null +++ b/pip3 @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pip3 + +> Python package manager. +> More information: . + +- Install a package: + +`pip3 install {{package}}` + +- Install a specific version of a package: + +`pip3 install {{package}}=={{version}}` + +- Upgrade a package: + +`pip3 install --upgrade {{package}}` + +- Uninstall a package: + +`pip3 uninstall {{package}}` + +- Save the list of installed packages to a file: + +`pip3 freeze > {{requirements.txt}}` + +- Install packages from a file: + +`pip3 install --requirement {{requirements.txt}}` + +- Show installed package info: + +`pip3 show {{package}}` diff --git a/pipenv b/pipenv new file mode 100644 index 00000000..f7db4288 --- /dev/null +++ b/pipenv @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pipenv + +> Simple and unified Python development workflow. +> Manages packages and the virtual environment for a project. +> More information: . + +- Create a new project: + +`pipenv` + +- Create a new project using Python 3: + +`pipenv --three` + +- Install a package: + +`pipenv install {{package}}` + +- Install all the dependencies for a project: + +`pipenv install` + +- Install all the dependencies for a project (including dev packages): + +`pipenv install --dev` + +- Uninstall a package: + +`pipenv uninstall {{package}}` + +- Start a shell within the created virtual environment: + +`pipenv shell` + +- Generate a `requirements.txt` (list of dependencies) for a project: + +`pipenv lock --requirements` diff --git a/pipx b/pipx new file mode 100644 index 00000000..503e721a --- /dev/null +++ b/pipx @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pipx + +> Install and run Python applications in isolated environments. +> More information: . + +- Run an app in a temporary virtual environment: + +`pipx run {{pycowsay}} {{moo}}` + +- Install a package in a virtual environment and add entry points to path: + +`pipx install {{package}}` + +- List installed packages: + +`pipx list` + +- Run an app in a temporary virtual environment with a package name different from the executable: + +`pipx run --spec {{httpx-cli}} {{httpx}} {{http://www.github.com}}` + +- Inject dependencies into an existing virtual environment: + +`pipx inject {{package}} {{dependency1 dependency2 ...}}` + +- Install a package in a virtual environment with pip arguments: + +`pipx install --pip-args='{{pip-args}}' {{package}}` diff --git a/pixiecore b/pixiecore new file mode 100644 index 00000000..4aa29364 --- /dev/null +++ b/pixiecore @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pixiecore + +> Manage the network booting of machines. +> More information: . + +- Start a PXE boot server which provides a `netboot.xyz` boot image: + +`pixiecore {{quick}} xyz --dhcp-no-bind` + +- Start a new PXE boot server which provides an Ubuntu boot image: + +`pixiecore {{quick}} ubuntu --dhcp-no-bind` + +- List all available boot images for quick mode: + +`pixiecore quick --help` diff --git a/pixterm b/pixterm new file mode 100644 index 00000000..d142de88 --- /dev/null +++ b/pixterm @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pixterm + +> Image printing in the terminal. +> See also: `chafa`, `catimg`. +> More information: . + +- Render a static image directly in the terminal: + +`pixterm {{path/to/file}}` + +- Use the image's original aspect ratio: + +`pixterm -s 2 {{path/to/file}}` + +- Specify a custom aspect ratio using a specific number of [t]erminal [r]ows and [c]olumns: + +`pixterm -tr {{24}} -tc {{80}} {{path/to/file}}` + +- Filter the output with a [m]atte background color and character [d]ithering: + +`pixterm -m {{000000}} -d 2 {{path/to/file}}` diff --git a/pjtoppm b/pjtoppm new file mode 100644 index 00000000..21c05372 --- /dev/null +++ b/pjtoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pjtoppm + +> Convert a HP PaintJet file to PPM. +> More information: . + +- Convert a HP PaintJet file to PPM: + +`pjtoppm {{path/to/input.pj}} > {{path/to/output.ppm}}` diff --git a/pkg-config b/pkg-config new file mode 100644 index 00000000..9f4f346e --- /dev/null +++ b/pkg-config @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pkg-config + +> Provide the details of installed libraries for compiling applications. +> More information: . + +- Get the list of libraries and their dependencies: + +`pkg-config --libs {{library1 library2 ...}}` + +- Get the list of libraries, their dependencies, and proper cflags for gcc: + +`pkg-config --cflags --libs {{library1 library2 ...}}` + +- Compile your code with libgtk-3, libwebkit2gtk-4.0 and all their dependencies: + +`c++ example.cpp $(pkg-config --cflags --libs gtk+-3.0 webkit2gtk-4.0) -o example` diff --git a/pkill b/pkill new file mode 100644 index 00000000..cb3d218e --- /dev/null +++ b/pkill @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pkill + +> Signal process by name. +> Mostly used for stopping processes. +> More information: . + +- Kill all processes which match: + +`pkill "{{process_name}}"` + +- Kill all processes which match their full command instead of just the process name: + +`pkill -f "{{command_name}}"` + +- Force kill matching processes (can't be blocked): + +`pkill -9 "{{process_name}}"` + +- Send SIGUSR1 signal to processes which match: + +`pkill -USR1 "{{process_name}}"` + +- Kill the main `firefox` process to close the browser: + +`pkill --oldest "{{firefox}}"` diff --git a/plantuml b/plantuml new file mode 100644 index 00000000..9da40938 --- /dev/null +++ b/plantuml @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# plantuml + +> Create UML diagrams from a plain text language and render them in different formats. +> More information: . + +- Render diagrams to default format (PNG): + +`plantuml {{diagram1.puml}} {{diagram2.puml}}` + +- Render a diagram in given format (e.g. `png`, `pdf`, `svg`, `txt`): + +`plantuml -t {{format}} {{diagram.puml}}` + +- Render all diagrams of a directory: + +`plantuml {{path/to/diagrams}}` + +- Render a diagram to the output directory: + +`plantuml -o {{path/to/output}} {{diagram.puml}}` + +- Render a diagram with the configuration file: + +`plantuml -config {{config.cfg}} {{diagram.puml}}` + +- Display help: + +`plantuml -help` diff --git a/platformio b/platformio new file mode 100644 index 00000000..7001d34f --- /dev/null +++ b/platformio @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# platformio + +> This command is an alias of `pio`. +> More information: . + +- View documentation for the original command: + +`tldr pio` diff --git a/play b/play new file mode 100644 index 00000000..568845b3 --- /dev/null +++ b/play @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# play + +> Audio player of SoX - Sound eXchange. +> Plays any audio, with audio formats identified by the extension. +> More information: . + +- Play the given audio file: + +`play {{path/to/audio_file}}` + +- Play the given audio files: + +`play {{path/to/audio_file1 path/to/audio_file2 ...}}` + +- Play the given audio at twice the speed: + +`play {{path/to/audio_file}} speed 2.0` + +- Play the given audio in reverse: + +`play {{path/to/audio_file}} reverse` diff --git a/plenv b/plenv new file mode 100644 index 00000000..bf62e8ff --- /dev/null +++ b/plenv @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# plenv + +> Switch between multiple versions of Perl. +> More information: . + +- Show the currently selected Perl version and how it was selected: + +`plenv version` + +- List all available installed Perl versions: + +`plenv versions` + +- Set the global Perl version (used unless a local or shell version takes priority): + +`plenv global {{version}}` + +- Set the local application-specific Perl version (used in the current directory and all directories below it): + +`plenv local {{version}}` + +- Set the shell-specific Perl version (used for the current session only): + +`plenv shell {{version}}` + +- Display help: + +`plenv` + +- Display help for a command: + +`plenv help {{command}}` diff --git a/plesk b/plesk new file mode 100644 index 00000000..1ad136bb --- /dev/null +++ b/plesk @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# plesk + +> Plesk hosting control panel. +> More information: . + +- Generate an auto login link for the admin user and print it: + +`plesk login` + +- Show product version information: + +`plesk version` + +- List all hosted domains: + +`plesk bin domain --list` + +- Start watching for changes in the `panel.log` file: + +`plesk log {{panel.log}}` + +- Start the interactive MySQL console: + +`plesk db` + +- Open the Plesk main configuration file in the default editor: + +`plesk conf {{panel.ini}}` diff --git a/plocate b/plocate new file mode 100644 index 00000000..5808faf6 --- /dev/null +++ b/plocate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# plocate + +> Find filenames quickly. +> Make sure to run `sudo updatedb` to include new files. +> More information: . + +- Look for patterns in the database (recomputed periodically): + +`plocate {{pattern}}` + +- Look for a file by its exact filename (a pattern containing no globbing characters is interpreted as `*pattern*`): + +`plocate */{{filename}}` diff --git a/pm2 b/pm2 new file mode 100644 index 00000000..d6d9db68 --- /dev/null +++ b/pm2 @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pm2 + +> Process manager for Node.js. +> Used for log management, monitoring and configuring processes. +> More information: . + +- Start a process with a name that can be used for later operations: + +`pm2 start {{app.js}} --name {{application_name}}` + +- List processes: + +`pm2 list` + +- Monitor all processes: + +`pm2 monit` + +- Stop a process: + +`pm2 stop {{application_name}}` + +- Restart a process: + +`pm2 restart {{application_name}}` + +- Dump all processes for resurrecting them later: + +`pm2 save` + +- Resurrect previously dumped processes: + +`pm2 resurrect` diff --git a/pngcheck b/pngcheck new file mode 100644 index 00000000..99b8e90d --- /dev/null +++ b/pngcheck @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pngcheck + +> Print detailed information about and verify PNG, JNG, and MNG files. +> More information: . + +- Print a summary for an image (width, height, and color depth): + +`pngcheck {{image.png}}` + +- Print information for an image with [c]olorized output: + +`pngcheck -c {{image.png}}` + +- Print [v]erbose information for an image: + +`pngcheck -cvt {{image.png}}` + +- Receive an image from `stdin` and display detailed information: + +`cat {{path/to/image.png}} | pngcheck -cvt` + +- [s]earch for PNGs within a specific file and display information about them: + +`pngcheck -s {{image.png}}` + +- Search for PNGs within another file and e[x]tract them: + +`pngcheck -x {{image.png}}` diff --git a/pngcrush b/pngcrush new file mode 100644 index 00000000..91a455ed --- /dev/null +++ b/pngcrush @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pngcrush + +> PNG compression utility. +> More information: . + +- Compress a PNG file: + +`pngcrush {{in.png}} {{out.png}}` + +- Compress all PNGs and output them to the specified directory: + +`pngcrush -d {{path/to/output}} *.png` + +- Compress PNG file with all 114 available algorithms and pick the best result: + +`pngcrush -rem allb -brute -reduce {{in.png}} {{out.png}}` diff --git a/pngquant b/pngquant new file mode 100644 index 00000000..c2b90184 --- /dev/null +++ b/pngquant @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pngquant + +> PNG converter and lossy image compressor. +> More information: . + +- Compress a specific PNG as much as possible and write result to a new file: + +`pngquant {{path/to/file.png}}` + +- Compress a specific PNG and override original: + +`pngquant --ext .png --force {{path/to/file.png}}` + +- Try to compress a specific PNG with custom quality (skip if below the min value): + +`pngquant --quality {{0-100}} {{path/to/file.png}}` + +- Compress a specific PNG with the number of colors reduced to 64: + +`pngquant {{64}} {{path/to/file.png}}` + +- Compress a specific PNG and skip if the file is larger than the original: + +`pngquant --skip-if-larger {{path/to/file.png}}` + +- Compress a specific PNG and remove metadata: + +`pngquant --strip {{path/to/file.png}}` + +- Compress a specific PNG and save it to the given path: + +`pngquant {{path/to/file.png}} --output {{path/to/file.png}}` + +- Compress a specific PNG and show progress: + +`pngquant --verbose {{path/to/file.png}}` diff --git a/pnmalias b/pnmalias new file mode 100644 index 00000000..3562d1e5 --- /dev/null +++ b/pnmalias @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmalias + +> Apply antialiasing onto a PNM image. +> More information: . + +- Perform antialiasing on a PNM image, taking black pixels as background and white pixels as foreground: + +`pnmalias {{path/to/input.pnm}} > {{path/to/output.ppm}}` + +- Explicitly specify the background and foreground color: + +`pnmalias -bcolor {{background_color}} -fcolor {{foreground_color}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` + +- Apply altialiasing to foreground pixels only: + +`pnmalias -fonly {{path/to/input.pnm}} > {{path/to/output.ppm}}` + +- Apply antialiasing to all surrounding pixels of background pixels: + +`pnmalias -balias {{path/to/input.pnm}} > {{path/to/output.ppm}}` diff --git a/pnmcolormap b/pnmcolormap new file mode 100644 index 00000000..a00839e9 --- /dev/null +++ b/pnmcolormap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmcolormap + +> Create quantization color map for a PNM image. +> More information: . + +- Generate an image using only `n_colors` or less colors as close as possible to the input image: + +`pnmcolormap {{n_colors}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` + +- Use the splitspread strategy for determining the output colors, possibly producing a better result for images with small details: + +`pnmcolormap -splitspread {{n_colors}} {{path/to/input.pnm}} > {{path/to/output.ppm}}` + +- Sort the resulting colormap, which is useful for comparing colormaps: + +`pnmcolormap -sort {{path/to/input.pnm}} > {{path/to/output.ppm}}` diff --git a/pnmcomp b/pnmcomp new file mode 100644 index 00000000..743a3a40 --- /dev/null +++ b/pnmcomp @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmcomp + +> This command is superseded by `pamcomp`. +> More information: . + +- View documentation for the current command: + +`tldr pamcomp` diff --git a/pnmconvol b/pnmconvol new file mode 100644 index 00000000..e637fbbe --- /dev/null +++ b/pnmconvol @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmconvol + +> Convolute a PNM image. +> More information: . + +- Convolve a PNM image with the specified convolution matrix: + +`pnmconvol -matrix=-1,3,-1 {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Convolve a PNM image with the convolution matrix in the specified files, one for each layer in the input image: + +`pnmconvol -matrixfile {{path/to/matrix1,path/to/matrix2,...}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Convolve a PNM image with the convolution matrix in the specified PNM file: + +`pnmconvol {{path/to/matrix.pnm}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Normalize the weights in the convolution matrix such that they add up to one: + +`pnmconvol -matrix=-1,3,-1 -normalize {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmcrop b/pnmcrop new file mode 100644 index 00000000..c67e0cab --- /dev/null +++ b/pnmcrop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmcrop + +> Crop PNM images. +> More information: . + +- Remove white borders on a PNM image: + +`pnmcrop -white {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Remove borders of the specified color that are on the top and left side of the image: + +`pnmcrop -bg-color {{color}} -top -left {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Determine the color of the borders to be removed by the color of the pixel in the specified corner: + +`pnmcrop -bg-corner {{topleft|topright|bottomleft|bottomright}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Leave a border with a width of `n` pixels. Additionally, specify the behaviour if the image is entirely made out of background: + +`pnmcrop -margins {{n}} -blank-image {{pass|minimize|maxcrop}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmdepth b/pnmdepth new file mode 100644 index 00000000..be57ef9c --- /dev/null +++ b/pnmdepth @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmdepth + +> This command is an alias of `pamdepth`. +> More information: . + +- View documentation for the original command: + +`tldr pamdepth` diff --git a/pnmgamma b/pnmgamma new file mode 100644 index 00000000..28685cd5 --- /dev/null +++ b/pnmgamma @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmgamma + +> Perform gamma correction on PNM images. +> More information: . + +- Convert the image from BT.709 luminance to radiance or sRGB luminance: + +`pnmgamma -{{bt709tolinear|bt709tosrgb}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Convert the image from radiance or sRGB luminance to BT.709 luminance: + +`pnmgamma -{{lineartobt709|srgbtobt709}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Specify the gamma value used for the gamma transfer function: + +`pnmgamma -gamma {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Specify the gamma value used for the gamma transfer function per color component: + +`pnmgamma -rgamma {{value}} -ggamma {{value}} -bgamma {{value}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmhisteq b/pnmhisteq new file mode 100644 index 00000000..71d00eec --- /dev/null +++ b/pnmhisteq @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmhisteq + +> Histogram-equalize a PNM image. +> More information: . + +- Increase the contrast of a PNM image using histogram equalization: + +`pnmhisteq {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Only modify grey pixels: + +`pnmhisteq -grey {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Do not include black or white pixels in the histogram equalization: + +`pnmhisteq -no{{black|white}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmhistmap b/pnmhistmap new file mode 100644 index 00000000..97ebec4a --- /dev/null +++ b/pnmhistmap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmhistmap + +> Draw a histogram of a PNM image. +> More information: . + +- Draw a histogram of a PNM image: + +`pnmhistmap {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Draw the histogram as dots instead of bars: + +`pnmhistmap -dots {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Specify the range of intensity values to include: + +`pnmhistmap -lval {{minval}} -rval {{maxval}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmindex b/pnmindex new file mode 100644 index 00000000..661ff07b --- /dev/null +++ b/pnmindex @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmindex + +> Build a visual index of multiple PNM images. +> See also: `pamundice`. +> More information: . + +- Produce an image containing thumbnails of the specified images in a grid: + +`pnmindex {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` + +- Specify the size of the (quadratic) thumbnails: + +`pnmindex -size {{50}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` + +- Specify the number of thumbnails per row: + +`pnmindex -across {{10}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` + +- Specify the maximum number of colors in the output: + +`pnmindex -colors {{512}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pnm}}` diff --git a/pnminvert b/pnminvert new file mode 100644 index 00000000..b55455aa --- /dev/null +++ b/pnminvert @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnminvert + +> Invert a PNM image. +> More information: . + +- Invert the colors or greyscale values in a PNM image: + +`pnminvert {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmmargin b/pnmmargin new file mode 100644 index 00000000..b6388fbb --- /dev/null +++ b/pnmmargin @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmmargin + +> Add a border to a PNM image. +> More information: . + +- Add a border of the specified size to a PNM image: + +`pnmmargin {{size}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Specify the color of the border: + +`pnmmargin -color {{color}} {{size}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmmontage b/pnmmontage new file mode 100644 index 00000000..bf97444e --- /dev/null +++ b/pnmmontage @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmmontage + +> Create a montage from multiple PNM images. +> More information: . + +- Produce a packing of the specified images: + +`pnmmontage {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` + +- Specify the quality of the packing (Note: larger values produce smaller packings but take longer to compute.): + +`pnmmontage -{{0..9}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` + +- Produce a packing that is not larger than `p` percent of the optimal packing: + +`pnmmontage -quality {{p}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` + +- Write the positions of the input files within the packed image to a machine-readable file: + +`pnmmontage -data {{path/to/datafile}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` diff --git a/pnmnlfilt b/pnmnlfilt new file mode 100644 index 00000000..86416a6c --- /dev/null +++ b/pnmnlfilt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmnlfilt + +> Apply a non-linear filter onto a PNM image. +> More information: . + +- Apply the "alpha trimmed mean" filter with the specified alpha and radius values onto the PNM image: + +`pnmnlfilt {{0.0..0.5}} {{radius}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Apply the "optimal estimation smoothing" filter with the specified noise threshold and radius onto the PNM image: + +`pnmnlfilt {{1.0..2.0}} {{radius}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Apply the "edge enhancement" filter with the specified alpha and radius onto the PNM image: + +`pnmnlfilt {{-0.9..(-0.1)}} {{radius}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmnorm b/pnmnorm new file mode 100644 index 00000000..71c36667 --- /dev/null +++ b/pnmnorm @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmnorm + +> Normalize the contrast in a PNM image. +> See also: `pnmhisteq`. +> More information: . + +- Force the brightest pixels to be white, the darkest pixels to be black and spread out the ones in between linearly: + +`pnmnorm {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Force the brightest pixels to be white, the darkest pixels to be black and spread out the ones in between quadratically such that pixels with a brightness of `n` become 50 % bright: + +`pnmnorm -midvalue {{n}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Keep the pixels' hue, only modify the brightness: + +`pnmnorm -keephues {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Specify a method to calculate a pixel's brightness: + +`pnmnorm -{{luminosity|colorvalue|saturation}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmpad b/pnmpad new file mode 100644 index 00000000..80853daa --- /dev/null +++ b/pnmpad @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmpad + +> Add borders to a PNM image. +> See also: `pnmmargin`, `pamcut`, `pamcomp`. +> More information: . + +- Add borders of the specified sizes to the image: + +`pnmpad -left {{100}} -right {{150}} -top {{123}} -bottom {{456}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Pad the image to the specified size: + +`pnmpad -width {{1000}} -height {{500}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Pad the width of the image to the specified size, controlling the ratio between right and left padding: + +`pnmpad -width {{1000}} -halign {{0.7}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Pad the width of the image using the specified color: + +`pnmpad -width {{1000}} -color {{red}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmpaste b/pnmpaste new file mode 100644 index 00000000..d3761e44 --- /dev/null +++ b/pnmpaste @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmpaste + +> Paste a PNM image into another PNM image. +> More information: . + +- Paste a PNM image into another PNM image at the specified coordinates: + +`pnmpaste {{x}} {{y}} {{path/to/image1.pnm}} {{path/to/image2.pnm}} > {{path/to/output.pnm}}` + +- Paste the image read from `stdin` into the specified image: + +`{{command}} | pnmpaste {{x}} {{y}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` + +- Combine the overlapping pixels by the specified boolean operation, where white pixels represent `true` while black pixels represent `false`: + +`pnmpaste -{{and|nand|or|nor|xor|xnor}} {{x}} {{y}} {{path/to/image1.pnm}} {{path/to/image2.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmpsnr b/pnmpsnr new file mode 100644 index 00000000..04821719 --- /dev/null +++ b/pnmpsnr @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmpsnr + +> Compute the difference between two images. +> More information: . + +- Compute the difference, i.e. the peak signal-to-noise ratio (PSNR) between two images: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}}` + +- Compare the color components rather than the luminance and chrominance components of the images: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}} -rgb` + +- Run in comparison mode, i.e. only output `nomatch` or `match` depending on whether the computing PSNR exceeds `n` or not: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}} -target {{n}}` + +- Run in comparison mode and compare the individual image components, i.e. Y, Cb, and Cr, to the corresponding thresholds: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}} -target1 {{threshold_Y}} -target2 {{threshold_Cb}} -target3 {{threshold_Cr}}` + +- Run in comparison mode and compare the individual image components, i.e. red, green, and blue to the corresponding thresholds: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}} -rgb -target1 {{threshold_red}} -target2 {{threshold_green}} -target3 {{threshold_blue}}` + +- Produce machine-readable output: + +`pnmpsnr {{path/to/file1.pnm}} {{path/to/file2.pnm}} -machine` diff --git a/pnmquant b/pnmquant new file mode 100644 index 00000000..b0b4b932 --- /dev/null +++ b/pnmquant @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmquant + +> Quantize the colors in a PNM image into a smaller set. +> This command is a combination of `pnmcolormap` and `pnmremap` and accepts the union of their options, except `-mapfile`. +> More information: . + +- Generate an image using only `n_colors` or less colors as close as possible to the input image: + +`pnmquant {{n_colors}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmremap b/pnmremap new file mode 100644 index 00000000..5accdfab --- /dev/null +++ b/pnmremap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmremap + +> Replace the colors in a PNM image. +> More information: . + +- Replace the colors in an image with those in the specified color palette: + +`pnmremap -mapfile {{path/to/palette_file.ppm}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Use Floyd-Steinberg dithering for representing colors missing in the color palette: + +`pnmremap -mapfile {{path/to/palette_file.ppm}} -floyd {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Use the first color in the palette for representing colors missing in the color palette: + +`pnmremap -mapfile {{path/to/palette_file.ppm}} -firstisdefault {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Use the specified color for representing colors missing in the color palette: + +`pnmremap -mapfile {{path/to/palette_file.ppm}} -missingcolor {{color}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmrotate b/pnmrotate new file mode 100644 index 00000000..1612969d --- /dev/null +++ b/pnmrotate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmrotate + +> Rotate a PNM image. +> More information: . + +- Rotate a PNM image by some angle (measured in degrees, counter-clockwise): + +`pnmrotate {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Specify the background color exposed by rotating the input image: + +`pnmrotate -background {{color}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Disable anti-aliasing, improving performance but decreasing quality: + +`pnmrotate -noantialias {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmscale b/pnmscale new file mode 100644 index 00000000..367982d5 --- /dev/null +++ b/pnmscale @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmscale + +> This command has been replaced by `pamscale`. +> More information: . + +- View documentation for `pamscale`: + +`tldr pamscale` diff --git a/pnmscalefixed b/pnmscalefixed new file mode 100644 index 00000000..b73a7c6f --- /dev/null +++ b/pnmscalefixed @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmscalefixed + +> Scale a PNM file quickly with possibly reduced quality. +> See also: `pamscale`. +> More information: . + +- Scale an image such that the result has the specified dimensions: + +`pnmscalefixed -width {{width}} -height {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Scale an image such that the result has the specified width, keeping the aspect ratio: + +`pnmscalefixed -width {{width}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Scale an image such that its width and height is changed by the specified factors: + +`pnmscalefixed -xscale {{x_factor}} -yscale {{y_factor}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmshear b/pnmshear new file mode 100644 index 00000000..c4db4b09 --- /dev/null +++ b/pnmshear @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmshear + +> Shear a PNM image. +> More information: . + +- Shear a PNM image by the specified angle: + +`pnmshear {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Specify the color of the background in the sheared image: + +`pnmshear -background {{blue}} {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Do not perform anti-aliasing: + +`pnmshear -noantialias {{angle}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmsmooth b/pnmsmooth new file mode 100644 index 00000000..0d2cfcd8 --- /dev/null +++ b/pnmsmooth @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmsmooth + +> Smooth out a PNM image. +> More information: . + +- Smooth out a PNM image using a convolution matrix of size 3x3: + +`pnmsmooth {{path/to/input.pnm}} > {{path/to/output.pnm}}` + +- Smooth out a PNM image using a convolution matrix of size width times height: + +`pnmsmooth -width {{width}} -height {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmtile b/pnmtile new file mode 100644 index 00000000..221f2ab5 --- /dev/null +++ b/pnmtile @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtile + +> Replicate an image to fill a specified area. +> More information: . + +- Replicate an image to fill an area of the specified dimensions: + +`pnmtile {{width}} {{height}} {{path/to/input.pnm}} > {{path/to/output.pnm}}` diff --git a/pnmtoddif b/pnmtoddif new file mode 100644 index 00000000..47b862aa --- /dev/null +++ b/pnmtoddif @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtoddif + +> Convert a PNM image to a DDIF image file. +> More information: . + +- Convert a PNM image to a DDIF image file: + +`pnmtoddif {{path/to/image.pnm}} > {{path/to/image.ddif}}` + +- Explicitly specify the horizontal and vertical resolution of the output image: + +`pnmtoddif -resolution {{horizontal_dpi}} {{vertical_dpi}} {{path/to/image.pnm}} > {{path/to/image.ddif}}` diff --git a/pnmtofiasco b/pnmtofiasco new file mode 100644 index 00000000..03c7dca4 --- /dev/null +++ b/pnmtofiasco @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtofiasco + +> Convert a PNM image to a compressed FIASCO file. +> More information: . + +- Convert a PNM image to a compressed FIASCO file: + +`pnmtofiasco {{path/to/file.pnm}} > {{path/to/file.fiasco}}` + +- Specify the [i]nput files through a pattern: + +`pnmtofiasco --image-name "{{img[01-09+1].pnm}}" > {{path/to/file.fiasco}}` + +- Specify the compression quality: + +`pnmtofiasco --quality {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` + +- Load the options to be used from the specified configuration file: + +`pnmtofiasco --config {{path/to/fiascorc}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` diff --git a/pnmtojpeg b/pnmtojpeg new file mode 100644 index 00000000..03de2c1f --- /dev/null +++ b/pnmtojpeg @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtojpeg + +> Converts a PNM image file to the JPEG/JFIF/EXIF image format. +> More information: . + +- Read a PNM image as input and produce a JPEG/JFIF/EXIF image as output: + +`pnmtojpeg {{path/to/file.pnm}} > {{path/to/file.jpg}}` + +- Display version: + +`pnmtojpeg -version` diff --git a/pnmtopalm b/pnmtopalm new file mode 100644 index 00000000..212e01f9 --- /dev/null +++ b/pnmtopalm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtopalm + +> Convert a PNM image to a Palm bitmap. +> More information: . + +- Convert a PNM image to a Palm bitmap: + +`pnmtopalm {{path/to/file.pnm}} > {{path/to/file.palm}}` + +- Specify the color depth of the resulting bitmap: + +`pnmtopalm -depth {{1|2|4|8|16}} {{path/to/file.pnm}} > {{path/to/file.palm}}` + +- Choose a compression method for the resulting bitmap: + +`pnmtopalm -{{scanline_compression|rle_compression|packbits_compression}} {{path/to/file.pnm}} > {{path/to/file.palm}}` + +- Build a custom colormap and include it in the resulting bitmap: + +`pnmtopalm -colormap {{path/to/file.pnm}} > {{path/to/file.palm}}` + +- Specify the bitmap's density: + +`pnmtopalm -density {{72|108|144|216|288}} {{path/to/file.pnm}} > {{path/to/file.palm}}` diff --git a/pnmtopclxl b/pnmtopclxl new file mode 100644 index 00000000..c184093f --- /dev/null +++ b/pnmtopclxl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtopclxl + +> Convert a PNM file to an HP LaserJet PCL XL printer stream. +> More information: . + +- Convert PNM files to an HP LaserJet PCL XL printer stream: + +`pnmtopclxl {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` + +- Specify the resolution of the image as well as the location of the page from the upper left corner of each image: + +`pnmtopclxl -dpi {{resolution}} -xoffs {{x_offset}} -yoffs {{y_offset}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` + +- Generate a duplex printer stream for the specified paper format: + +`pnmtopclxl -duplex {{vertical|horizontal}} -format {{letter|legal|a3|a4|a5|...}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` diff --git a/pnmtoplainpnm b/pnmtoplainpnm new file mode 100644 index 00000000..668875d4 --- /dev/null +++ b/pnmtoplainpnm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtoplainpnm + +> This command is an alias of `pamtopnm -plain`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pnmtopng b/pnmtopng new file mode 100644 index 00000000..40489318 --- /dev/null +++ b/pnmtopng @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtopng + +> Converts a PNM image file to PNG image format. +> More information: . + +- Read a PNM image as input and produce a PNG image as output: + +`pnmtopng {{path/to/file.pnm}} > {{path/to/file.png}}` + +- Display version: + +`pnmtopng -version` diff --git a/pnmtopnm b/pnmtopnm new file mode 100644 index 00000000..82209a4d --- /dev/null +++ b/pnmtopnm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtopnm + +> This command is an alias of `pamtopnm`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pnmtops b/pnmtops new file mode 100644 index 00000000..65362134 --- /dev/null +++ b/pnmtops @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtops + +> Convert a PNM image to a PostScript file. +> More information: . + +- Convert a PNM image to a PS file: + +`pnmtops {{path/to/file.pnm}} > {{path/to/file.ps}}` + +- Specify the dimensions of the output image in inches: + +`pnmtops -imagewidth {{imagewidth}} -imageheight {{imageheight}} {{path/to/file.pnm}} > {{path/to/file.ps}}` + +- Specify the dimensions of the page the output image resides on in inches: + +`pnmtops -width {{width}} -height {{height}} {{path/to/file.pnm}} > {{path/to/file.ps}}` diff --git a/pnmtorast b/pnmtorast new file mode 100644 index 00000000..e78769b1 --- /dev/null +++ b/pnmtorast @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtorast + +> Convert a PNM file to a Sun rasterfile. +> More information: . + +- Convert a PNM image to a RAST image: + +`pnmtorast {{path/to/input.pnm}} > {{path/to/output.rast}}` + +- Force either `RT_STANDARD` or `RT_BYTE_ENCODED` form for the output: + +`pnmtorast -{{standard|rle}} {{path/to/input.pnm}} > {{path/to/output.rast}}` diff --git a/pnmtorle b/pnmtorle new file mode 100644 index 00000000..95a6b0ec --- /dev/null +++ b/pnmtorle @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtorle + +> Convert a PNM file to an Utah Raster Tools RLE image file. +> More information: . + +- Convert a PNM image to an RLE image: + +`pnmtorle {{path/to/input.pnm}} > {{path/to/output.rle}}` + +- Print PNM header information to `stdout`: + +`pnmtorle -verbose {{path/to/input.pnm}} > {{path/to/output.rle}}` + +- Include a transparency channel in the output image in which every black pixel is set to fully transparent and every other pixel is set to fully opaque: + +`pnmtorle -alpha {{path/to/input.pnm}} > {{path/to/output.rle}}` diff --git a/pnmtosgi b/pnmtosgi new file mode 100644 index 00000000..93226125 --- /dev/null +++ b/pnmtosgi @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtosgi + +> Convert a PNM file to an SGI image file. +> More information: . + +- Convert a PNM image to an SGI image: + +`pnmtosgi {{path/to/input.pnm}} > {{path/to/output.sgi}}` + +- Disable or enable compression: + +`pnmtosgi -{{verbatim|rle}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` + +- Write the specified string into the SGI image header's `imagename` field: + +`pnmtosgi -imagename {{string}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` diff --git a/pnmtosir b/pnmtosir new file mode 100644 index 00000000..003bae91 --- /dev/null +++ b/pnmtosir @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtosir + +> Convert a PNM file to a Solitaire Image Recorder file. +> More information: . + +- Convert a PNM image to a SIR image: + +`pnmtosir {{path/to/input.pnm}} > {{path/to/output.sir}}` diff --git a/pnmtotiff b/pnmtotiff new file mode 100644 index 00000000..b8157516 --- /dev/null +++ b/pnmtotiff @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtotiff + +> This command is superseded by `pamtotiff`. +> More information: . + +- View documentation for the current command: + +`tldr pamtotiff` diff --git a/pnmtotiffcmyk b/pnmtotiffcmyk new file mode 100644 index 00000000..a7f0e14e --- /dev/null +++ b/pnmtotiffcmyk @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtotiffcmyk + +> Convert a PNM image to a CMYK encoded TIFF. +> More information: . + +- Convert a PNM image to a CMYK encoded TIFF: + +`pnmtotiffcmyk {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` + +- Specify the TIFF compression method: + +`pnmtotiffcmyk -{{none|packbits|lzw}} {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` + +- Control the fill order: + +`pnmtotiffcmyk -{{msb2lsb|lsb2msb}} {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` diff --git a/pnmtoxwd b/pnmtoxwd new file mode 100644 index 00000000..52a8199e --- /dev/null +++ b/pnmtoxwd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnmtoxwd + +> Convert a PNM file into an X11 window dump file. +> More information: . + +- Convert a PNM image file to XWD: + +`pnmtoxwd {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` + +- Produce the output in the DirectColor format: + +`pnmtoxwd -directcolor {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` + +- Set the color depth of the output to b bits: + +`pnmtoxwd -pseudodepth {{b}} {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` diff --git a/pnpm b/pnpm new file mode 100644 index 00000000..3d3076d8 --- /dev/null +++ b/pnpm @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnpm + +> Fast, disk space efficient package manager for Node.js. +> Manage Node.js projects and their module dependencies. +> More information: . + +- Create a `package.json` file: + +`pnpm init` + +- Download all the packages listed as dependencies in `package.json`: + +`pnpm install` + +- Download a specific version of a package and add it to the list of dependencies in `package.json`: + +`pnpm add {{module_name}}@{{version}}` + +- Download a package and add it to the list of [D]ev dependencies in `package.json`: + +`pnpm add -D {{module_name}}` + +- Download a package and install it [g]lobally: + +`pnpm add -g {{module_name}}` + +- Uninstall a package and remove it from the list of dependencies in `package.json`: + +`pnpm remove {{module_name}}` + +- Print a tree of locally installed modules: + +`pnpm list` + +- List top-level [g]lobally installed modules: + +`pnpm list -g --depth={{0}}` diff --git a/pnpx b/pnpx new file mode 100644 index 00000000..e2f0f5ac --- /dev/null +++ b/pnpx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pnpx + +> Directly execute binaries from npm packages, using `pnpm` instead of `npm`. +> More information: . + +- Execute the binary from a given npm module: + +`pnpx {{module_name}}` + +- Execute a specific binary from a given npm module, in case the module has multiple binaries: + +`pnpx --package {{package_name}} {{module_name}}` + +- Display help: + +`pnpx --help` diff --git a/podman b/podman new file mode 100644 index 00000000..51b0532d --- /dev/null +++ b/podman @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman + +> Simple management tool for pods, containers and images. +> Podman provides a Docker-CLI comparable command-line. Simply put: `alias docker=podman`. +> More information: . + +- List all containers (both running and stopped): + +`podman ps --all` + +- Create a container from an image, with a custom name: + +`podman run --name {{container_name}} {{image}}` + +- Start or stop an existing container: + +`podman {{start|stop}} {{container_name}}` + +- Pull an image from a registry (defaults to Docker Hub): + +`podman pull {{image}}` + +- Display the list of already downloaded images: + +`podman images` + +- Open a shell inside an already running container: + +`podman exec --interactive --tty {{container_name}} {{sh}}` + +- Remove a stopped container: + +`podman rm {{container_name}}` + +- Display the logs of one or more containers and follow log output: + +`podman logs --follow {{container_name}} {{container_id}}` diff --git a/podman-build b/podman-build new file mode 100644 index 00000000..9834e913 --- /dev/null +++ b/podman-build @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman build + +> Daemonless tool for building container images. +> Podman provides a Docker-CLI comparable command-line. Simply put: `alias docker=podman`. +> More information: . + +- Create an image using a `Dockerfile` or `Containerfile` in the specified directory: + +`podman build {{path/to/directory}}` + +- Create an image with a specified tag: + +`podman build --tag {{image_name:version}} {{path/to/directory}}` + +- Create an image from a non-standard file: + +`podman build --file {{Containerfile.different}} .` + +- Create an image without using any previously cached images: + +`podman build --no-cache {{path/to/directory}}` + +- Create an image suppressing all output: + +`podman build --quiet {{path/to/directory}}` diff --git a/podman-compose b/podman-compose new file mode 100644 index 00000000..52bb103f --- /dev/null +++ b/podman-compose @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman-compose + +> Run and manage Compose Specification container definition. +> More information: . + +- List all running containers: + +`podman-compose ps` + +- Create and start all containers in the background using a local `docker-compose.yml`: + +`podman-compose up -d` + +- Start all containers, building if needed: + +`podman-compose up --build` + +- Start all containers using an alternate compose file: + +`podman-compose {{path/to/file}} up` + +- Stop all running containers: + +`podman-compose stop` + +- Remove all containers, networks, and volumes: + +`podman-compose down --volumes` + +- Follow logs for a container (omit all container names): + +`podman-compose logs --follow {{container_name}}` + +- Run a one-time command in a service with no ports mapped: + +`podman-compose run {{service_name}} {{command}}` diff --git a/podman-image b/podman-image new file mode 100644 index 00000000..c3ca6d4d --- /dev/null +++ b/podman-image @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman image + +> Manage Docker images. +> See also: `podman build`, `podman import`, and `podman pull`. +> More information: . + +- List local Docker images: + +`podman image ls` + +- Delete unused local Docker images: + +`podman image prune` + +- Delete all unused images (not just those without a tag): + +`podman image prune --all` + +- Show the history of a local Docker image: + +`podman image history {{image}}` diff --git a/podman-images b/podman-images new file mode 100644 index 00000000..a2f20262 --- /dev/null +++ b/podman-images @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman images + +> Manage Podman images. +> More information: . + +- List all Podman images: + +`podman images` + +- List all Podman images including intermediates: + +`podman images --all` + +- List the output in quiet mode (only numeric IDs): + +`podman images --quiet` + +- List all Podman images not used by any container: + +`podman images --filter dangling=true` + +- List images that contain a substring in their name: + +`podman images "{{*image|image*}}"` diff --git a/podman-machine b/podman-machine new file mode 100644 index 00000000..2372f77a --- /dev/null +++ b/podman-machine @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman machine + +> Create and manage virtual machines running Podman. +> Included with Podman version 4 or greater. +> More information: . + +- List existing machines: + +`podman machine ls` + +- Create a new default machine: + +`podman machine init` + +- Create a new machine with a specific name: + +`podman machine init {{name}}` + +- Create a new machine with different resources: + +`podman machine init --cpus={{4}} --memory={{4096}} --disk-size={{50}}` + +- Start or stop a machine: + +`podman machine {{start|stop}} {{name}}` + +- Connect to a running machine via SSH: + +`podman machine ssh {{name}}` + +- Inspect information about a machine: + +`podman machine inspect {{name}}` diff --git a/podman-ps b/podman-ps new file mode 100644 index 00000000..689b8424 --- /dev/null +++ b/podman-ps @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman ps + +> List Podman containers. +> More information: . + +- List currently running podman containers: + +`podman ps` + +- List all podman containers (running and stopped): + +`podman ps --all` + +- Show the latest created container (includes all states): + +`podman ps --latest` + +- Filter containers that contain a substring in their name: + +`podman ps --filter "name={{name}}"` + +- Filter containers that share a given image as an ancestor: + +`podman ps --filter "ancestor={{image}}:{{tag}}"` + +- Filter containers by exit status code: + +`podman ps --all --filter "exited={{code}}"` + +- Filter containers by status (created, running, removing, paused, exited and dead): + +`podman ps --filter "status={{status}}"` + +- Filter containers that mount a specific volume or have a volume mounted in a specific path: + +`podman ps --filter "volume={{path/to/directory}}" --format "table {{.ID}} {{.Image}} {{.Names}} {{.Mounts}}"` diff --git a/podman-rmi b/podman-rmi new file mode 100644 index 00000000..18e9b75b --- /dev/null +++ b/podman-rmi @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman rmi + +> Remove Podman images. +> More information: . + +- Remove one or more images given their names: + +`podman rmi {{image:tag}} {{image2:tag}} {{...}}` + +- Force remove an image: + +`podman rmi --force {{image}}` + +- Remove an image without deleting untagged parents: + +`podman rmi --no-prune {{image}}` + +- Display help: + +`podman rmi` diff --git a/podman-run b/podman-run new file mode 100644 index 00000000..500e2c04 --- /dev/null +++ b/podman-run @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# podman run + +> Run a command in a new Podman container. +> More information: . + +- Run command in a new container from a tagged image: + +`podman run {{image:tag}} {{command}}` + +- Run command in a new container in background and display its ID: + +`podman run --detach {{image:tag}} {{command}}` + +- Run command in a one-off container in interactive mode and pseudo-TTY: + +`podman run --rm --interactive --tty {{image:tag}} {{command}}` + +- Run command in a new container with passed environment variables: + +`podman run --env '{{variable}}={{value}}' --env {{variable}} {{image:tag}} {{command}}` + +- Run command in a new container with bind mounted volumes: + +`podman run --volume {{/path/to/host_path}}:{{/path/to/container_path}} {{image:tag}} {{command}}` + +- Run command in a new container with published ports: + +`podman run --publish {{host_port}}:{{container_port}} {{image:tag}} {{command}}` + +- Run command in a new container overwriting the entrypoint of the image: + +`podman run --entrypoint {{command}} {{image:tag}}` + +- Run command in a new container connecting it to a network: + +`podman run --network {{network}} {{image:tag}}` diff --git a/poetry b/poetry new file mode 100644 index 00000000..48c9ea3c --- /dev/null +++ b/poetry @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry + +> Manage Python packages and dependencies. +> See also: `asdf`. +> More information: . + +- Create a new Poetry project in the directory with a specific name: + +`poetry new {{project_name}}` + +- Install and add a dependency and its sub-dependencies to the `pyproject.toml` file in the current directory: + +`poetry add {{dependency}}` + +- Install the project dependencies using the `pyproject.toml` file in the current directory: + +`poetry install` + +- Interactively initialize the current directory as a new Poetry project: + +`poetry init` + +- Get the latest version of all dependencies and update `poetry.lock`: + +`poetry update` + +- Execute a command inside the project's virtual environment: + +`poetry run {{command}}` + +- Bump the minor version of the project in `pyproject.toml`: + +`poetry version minor` diff --git a/polybar b/polybar new file mode 100644 index 00000000..23464d28 --- /dev/null +++ b/polybar @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# polybar + +> A fast and easy-to-use status bar. +> More information: . + +- Start Polybar (the bar name is optional if only one bar is defined in the config): + +`polybar {{bar_name}}` + +- Start Polybar with the specified config: + +`polybar --config={{path/to/config.ini}} {{bar_name}}` + +- Start Polybar and reload the bar when the configuration file is modified: + +`polybar --reload {{bar_name}}` diff --git a/polybar-msg b/polybar-msg new file mode 100644 index 00000000..2f73b38d --- /dev/null +++ b/polybar-msg @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# polybar-msg + +> Control `polybar` using inter-process-messaging (IPC). +> Note: IPC is disabled by default and can be enabled by setting `enable-ipc = true` in the Polybar config. +> More information: . + +- Quit the bar: + +`polybar-msg cmd quit` + +- Restart the bar in-place: + +`polybar-msg cmd restart` + +- Hide the bar (does nothing if the bar is already hidden): + +`polybar-msg cmd hide` + +- Show the bar again (does nothing if the bar is not hidden): + +`polybar-msg cmd show` + +- Toggle between hidden/visible: + +`polybar-msg cmd toggle` + +- Execute a module action (the data string is optional): + +`polybar-msg action "#{{module_name}}.{{action_name}}.{{data_string}}"` + +- Only send messages to a specific Polybar instance (all instances by default): + +`polybar-msg -p {{pid}} {{cmd|action}} {{payload}}` diff --git a/pop b/pop new file mode 100644 index 00000000..49e3dabe --- /dev/null +++ b/pop @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pop + +> Send emails from your terminal. +> More information: . + +- Launch the Text-based User Interface: + +`pop` + +- Send an email using the content of a Markdown file as body: + +`pop < {{path/to/message.md}} --from {{me@example.com}} --to {{you@example.com}} --subject "{{On the Subject of Ducks...}}" --attach {{path/to/attachment}}` + +- Display help: + +`pop --help` diff --git a/popd b/popd new file mode 100644 index 00000000..35d72b6e --- /dev/null +++ b/popd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# popd + +> 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: . + +- Remove the top directory from the stack and cd to it: + +`popd` + +- Remove the Nth directory (starting from zero to the left from the list printed with `dirs`): + +`popd +N` + +- Remove the Nth directory (starting from zero to the right from the list printed with `dirs`): + +`popd -N` + +- Remove the 1st directory (starting from zero to the left from the list printed with `dirs`): + +`popd -n` diff --git a/popeye b/popeye new file mode 100644 index 00000000..a7572312 --- /dev/null +++ b/popeye @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# popeye + +> Report potential issues with Kubernetes deployment manifests. +> More information: . + +- Scan the current Kubernetes cluster: + +`popeye` + +- Scan a specific namespace: + +`popeye -n {{namespace}}` + +- Scan specific Kubernetes context: + +`popeye --context={{context}}` + +- Use a spinach configuration file for scanning: + +`popeye -f {{spinach.yaml}}` diff --git a/postcss b/postcss new file mode 100644 index 00000000..67ab0e51 --- /dev/null +++ b/postcss @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# postcss + +> Transform styles with JS plugins. +> More information: . + +- Parse and transform a CSS file: + +`postcss {{path/to/file}}` + +- Parse and transform a CSS file and output to a specific file: + +`postcss {{path/to/file}} --output {{path/to/file}}` + +- Parse and transform a CSS file and output to a specific directory: + +`postcss {{path/to/file}} --dir {{path/to/directory}}` + +- Parse and transform a CSS file in-place: + +`postcss {{path/to/file}} --replace` + +- Specify a custom PostCSS parser: + +`postcss {{path/to/file}} --parser {{parser}}` + +- Specify a custom PostCSS syntax: + +`postcss {{path/to/file}} --syntax {{syntax}}` + +- Watch for changes to a CSS file: + +`postcss {{path/to/file}} --watch` + +- Display help: + +`postcss --help` diff --git a/powershell b/powershell new file mode 100644 index 00000000..55faa24b --- /dev/null +++ b/powershell @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# powershell + +> This command may be mistaken as the cross-platform version of PowerShell (formerly known as PowerShell Core), which uses `pwsh` instead of `powershell`. +> The original `powershell` command in Windows is still available to use the legacy Windows version of PowerShell (version 5.1 and below). +> More information: . + +- View the documentation for the command referring to the latest, cross-platform version of PowerShell (version 6 and above): + +`tldr pwsh` + +- View the documentation for the command referring to the legacy Windows PowerShell (version 5.1 and below): + +`tldr powershell -p windows` diff --git a/ppmchange b/ppmchange new file mode 100644 index 00000000..21e11380 --- /dev/null +++ b/ppmchange @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmchange + +> Change all pixels of one color in a PPM image to another color. +> More information: . + +- Exchange the first color in each `oldcolor` - `newcolor` pair with the second color: + +`ppmchange {{oldcolor1 newcolor1 oldcolor2 newcolor2 ...}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` + +- Specify how similar colors must be in order to be considered the same: + +`ppmchange -closeness {{percentage}} {{oldcolor1 newcolor1 oldcolor2 newcolor2 ...}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` + +- Replace all pixels not specified in the arguments by a color: + +`ppmchange -remainder {{color}} {{oldcolor1 newcolor1 oldcolor2 newcolor2 ...}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` diff --git a/ppmcie b/ppmcie new file mode 100644 index 00000000..ac48100b --- /dev/null +++ b/ppmcie @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmcie + +> Draw a CIE color chart as a PPM image. +> More information: . + +- Draw a CIE color chart using the REC709 color system as a PPM image: + +`ppmcie > {{path/to/output.ppm}}` + +- Specify the color system to be used: + +`ppmcie -{{cie|ebu|hdtv|ntsc|smpte}} > {{path/to/output.ppm}}` + +- Specify the location of the individual illuminants: + +`ppmcie -{{red|green|blue}} {{xpos ypos}} > {{path/to/output.ppm}}` + +- Do not dim the area outside the Maxwell triangle: + +`ppmcie -full > {{path/to/output.ppm}}` diff --git a/ppmcolormask b/ppmcolormask new file mode 100644 index 00000000..f4e6a910 --- /dev/null +++ b/ppmcolormask @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmcolormask + +> Produce a mask of areas of a certain color in a PPM image. +> More information: . + +- Produce a mask of areas of a certain color in the specified PPM image: + +`ppmcolormask -color {{red,blue}} {{path/to/input.ppm}} > {{path/to/output.pbm}}` diff --git a/ppmdim b/ppmdim new file mode 100644 index 00000000..c5208579 --- /dev/null +++ b/ppmdim @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmdim + +> Dim a PPM image. +> Partly superseded by `pamfunc -multiplier`. +> More information: . + +- Dim the specified PPM image by dimfactor: + +`ppmdim {{0.6}} {{path/to/input.ppm}} > {{path/to/output.ppm}}` diff --git a/ppmdist b/ppmdist new file mode 100644 index 00000000..3e3726f2 --- /dev/null +++ b/ppmdist @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmdist + +> Produce a grayscale version of a PPM image. +> More information: . + +- Produce a grayscale version of the specified PPM image: + +`ppmdist {{path/to/input.ppm}} > {{path/to/output.pgm}}` + +- Use the specified method to map colors to graylevels: + +`ppmdist -{{frequency|intensity}} {{path/to/input.ppm}} > {{path/to/output.pgm}}` diff --git a/ppmdither b/ppmdither new file mode 100644 index 00000000..4f0e649b --- /dev/null +++ b/ppmdither @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmdither + +> Reduce the number of colors in an image by applying dithering. +> More information: . + +- Read a PPM image, apply dithering and save it to a file: + +`ppmdither {{path/to/image.ppm}} > {{path/to/file.ppm}}` + +- Specify the desired number of shades for each primary color: + +`ppmdither -red {{2}} -green {{3}} -blue {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` + +- Specify the dimensions of the dithering matrix: + +`ppmdither -dim {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` diff --git a/ppmfade b/ppmfade new file mode 100644 index 00000000..3b9431f4 --- /dev/null +++ b/ppmfade @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmfade + +> Generate a transition between two PPM images. +> More information: . + +- Generate a transition between two PPM images ([f]irst and [l]ast) using the specified effect: + +`ppmfade -f {{path/to/image1.ppm}} -l {{path/to/image2.ppm}} -{{mix|spread|shift|relief|oil|...}}` + +- Generate a transition starting with the specified image and ending in a solid black image: + +`ppmfade -f {{path/to/image.ppm}} -{{mix|spread|shift|relief|oil|...}}` + +- Generate a transition starting with a solid black image and ending with the specified image: + +`ppmfade -l {{path/to/image.ppm}} -{{mix|spread|shift|relief|oil|...}}` + +- Store the resulting images in files named `base.NNNN.ppm` where `NNNN` is a increasing number: + +`ppmfade -f {{path/to/image1.ppm}} -l {{path/to/image2.ppm}} -{{mix|spread|shift|relief|oil|...}} -base {{base}}` diff --git a/ppmflash b/ppmflash new file mode 100644 index 00000000..b58a323e --- /dev/null +++ b/ppmflash @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmflash + +> Brighten a PPM image file. +> More information: . + +- Generate a PPM image as output that is `flashfactor` times brighter than the input PPM image: + +`ppmflash {{flashfactor}} {{path/to/file.ppm}} > {{path/to/file.ppm}}` + +- Display version: + +`ppmflash -version` diff --git a/ppmforge b/ppmforge new file mode 100644 index 00000000..aeb7def8 --- /dev/null +++ b/ppmforge @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmforge + +> Generate fractals resembling clouds, planets and starry skies. +> More information: . + +- Generate an image of a planet: + +`ppmforge > {{path/to/image.ppm}}` + +- Generate an image of clouds or the night sky: + +`ppmforge -{{night|clouds}} > {{path/to/image.ppm}}` + +- Use a custom mesh size and dimension for fractal generation and specify the dimensions of the output: + +`ppmforge -mesh {{512}} -dimension {{2.5}} -xsize {{1000}} -ysize {{1000}} > {{path/to/image.ppm}}` + +- Control the tilt and the angle from which the generated planet is illuminated: + +`ppmforge -tilt {{-15}} -hour {{12}} > {{path/to/image.ppm}}` diff --git a/ppmhist b/ppmhist new file mode 100644 index 00000000..60b7c68b --- /dev/null +++ b/ppmhist @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmhist + +> Print a histogram of the colors present in a PPM image. +> See also: `pgmhist`. +> More information: . + +- Generate the histogram for human reading: + +`ppmhist -nomap {{path/to/image.ppm}}` + +- Generate a PPM file of the colormap for the image, with the color histogram as comments: + +`ppmhist -map {{path/to/image.ppm}}` + +- Display version: + +`ppmhist -version` diff --git a/ppmlabel b/ppmlabel new file mode 100644 index 00000000..bfe40511 --- /dev/null +++ b/ppmlabel @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmlabel + +> Add text to a PPM image. +> More information: . + +- Add text to a PPM image at the specified location: + +`ppmlabel -x {{pos_x}} -y {{pos_y}} -text {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Add multiple texts at different locations: + +`ppmlabel -x {{pos_x1}} -y {{pos_y1}} -text {{text1}} -x {{pos_x2}} -y {{pos_y2}} -text {{text2}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Specify the line color, the background color, the tilt and the size of the added text: + +`ppmlabel -x {{pos_x}} -y {{pos_y}} -color {{line_color}} -background {{background_color}} -angle {{tilt}} -size {{size}} -text {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmmake b/ppmmake new file mode 100644 index 00000000..f1e13fe6 --- /dev/null +++ b/ppmmake @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmmake + +> Create a PPM image of a specified color and dimensions. +> More information: . + +- Create a PPM image of the specified color and dimensions: + +`ppmmake {{color}} {{width}} {{height}} > {{path/to/output_file.ppm}}` diff --git a/ppmmix b/ppmmix new file mode 100644 index 00000000..c08bb626 --- /dev/null +++ b/ppmmix @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmmix + +> Blend together two PPM images. +> More information: . + +- Blend the specified PPM images using fadefactor to control the weight of each image: + +`ppmmix {{fadefactor}} {{path/to/input_file1.ppm}} {{path/to/input_file2.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmntsc b/ppmntsc new file mode 100644 index 00000000..8ff121b4 --- /dev/null +++ b/ppmntsc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmntsc + +> Make the RGB colors in a PPM image compatible with NTSC or PAL color systems. +> More information: . + +- Make the RGB colors in a PPM image compatible with NTSC color systems: + +`ppmntsc {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Make the RGB colors in a PPM image compatible with PAL color systems: + +`ppmntsc --pal {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Print the number of illegal pixels in the input image to `stderr`: + +`ppmntsc --verbose {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Output only legal/illegal/corrected pixels, set other pixels to black: + +`ppmntsc --{{legalonly|illegalonly|correctedonly}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmpat b/ppmpat new file mode 100644 index 00000000..a7efec8e --- /dev/null +++ b/ppmpat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmpat + +> Produce a PPM image with a pattern. +> More information: . + +- Produce a PPM file of the specified pattern with the specified dimensions: + +`ppmpat -{{gingham2|gingham3|madras|tartan|poles|...}} {{width}} {{height}} > {{path/to/file.ppm}}` + +- Produce a PPM file of a camo pattern using the specified colors: + +`ppmpat -camo -color {{color1,color2,...}} {{width}} {{height}} > {{path/to/file.ppm}}` diff --git a/ppmquant b/ppmquant new file mode 100644 index 00000000..ad29d284 --- /dev/null +++ b/ppmquant @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmquant + +> This command has been replaced by `pnmquant` and `pnmremap`. +> More information: . + +- View documentation for `pnmquant`: + +`tldr pnmquant` + +- View documentation for `pnmremap`: + +`tldr pnmremap` diff --git a/ppmrainbow b/ppmrainbow new file mode 100644 index 00000000..e7fb1f4f --- /dev/null +++ b/ppmrainbow @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmrainbow + +> Generate a rainbow. +> More information: . + +- Generate a rainbow consisting of the specified colors: + +`ppmrainbow {{color1 color2 ...}} > {{path/to/output_file.ppm}}` + +- Specify the size of the output in pixels: + +`ppmrainbow -width {{width}} -height {{height}} {{color1 color2 ...}} > {{path/to/output_file.ppm}}` + +- End the rainbow with the last color specified, do not repeat the first color: + +`ppmrainbow -norepeat {{color1 color2 ...}} > {{path/to/output_file.ppm}}` diff --git a/ppmrelief b/ppmrelief new file mode 100644 index 00000000..b20d3e04 --- /dev/null +++ b/ppmrelief @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmrelief + +> Produce a relief of a PPM image. +> More information: . + +- Produce a relief of the specified PPM image: + +`ppmrelief {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmshadow b/ppmshadow new file mode 100644 index 00000000..92dc141a --- /dev/null +++ b/ppmshadow @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmshadow + +> Add simulated shadows to a PPM image. +> More information: . + +- Add simulated shadows to a PPM image: + +`ppmshadow {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- [b]lur the image by the specified number of pixels: + +`ppmshadow -b {{n}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Specify the displacement of the simulated light source to the left and the top of the image: + +`ppmshadow -x {{left_offset}} -y {{top_offset}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmshift b/ppmshift new file mode 100644 index 00000000..550a6ed0 --- /dev/null +++ b/ppmshift @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmshift + +> Shift the lines in a PPM image by a randomized amount. +> More information: . + +- Shift the lines in the input image by a randomized amount not exceeding s to the left or to the right: + +`ppmshift {{s}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/ppmspread b/ppmspread new file mode 100644 index 00000000..cab75cca --- /dev/null +++ b/ppmspread @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmspread + +> Displace the pixels in a PPM image by a randomized amount. +> More information: . + +- Displace the pixels in a PPM image by a randomized amount that is at most a: + +`ppmspread {{a}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` + +- Specify a seed to a the pseudo-random number generator: + +`ppmspread {{a}} {{path/to/input_file.ppm}} -randomseed {{seed}} > {{path/to/output_file.ppm}}` diff --git a/ppmtoacad b/ppmtoacad new file mode 100644 index 00000000..1c68f3b3 --- /dev/null +++ b/ppmtoacad @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoacad + +> Convert a PPM image to an AutoCAD database or slide. +> More information: . + +- Convert a PPM image to an AutoCAD slide: + +`ppmtoacad {{path/to/file.ppm}} > {{path/to/file.acad}}` + +- Convert a PPM image to an AutoCAD binary database import file: + +`ppmtoacad -dxb {{path/to/file.ppm}} > {{path/to/file.dxb}}` + +- Restrict the colors in the output to 8 RGB shades: + +`ppmtoacad -8 {{path/to/file.ppm}} > {{path/to/file.dxb}}` diff --git a/ppmtoarbtxt b/ppmtoarbtxt new file mode 100644 index 00000000..eba0a036 --- /dev/null +++ b/ppmtoarbtxt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoarbtxt + +> Convert a PPM image to an arbitrary text format according to a template. +> More information: . + +- Convert a PPM image to text as specified by the given template: + +`ppmtoarbtxt {{path/to/template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Convert a PPM image to text as specified by the given template, prepend the contents of the specified head template: + +`ppmtoarbtxt {{path/to/template}} -hd {{path/to/head_template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Convert a PPM image to text as specified by the given template, append the contents of the specified tail template: + +`ppmtoarbtxt {{path/to/template}} -hd {{path/to/tail_template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Display version: + +`ppmtoarbtxt -version` diff --git a/ppmtobmp b/ppmtobmp new file mode 100644 index 00000000..32fcc76d --- /dev/null +++ b/ppmtobmp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtobmp + +> Convert a PPM image to a BMP file. +> More information: . + +- Convert a PPM image to a BMP file: + +`ppmtobmp {{path/to/file.ppm}} > {{path/to/file.bmp}}` + +- Explicitly specify whether or not a Windows BMP file or an OS/2 BMP file should be created: + +`ppmtobmp -{{windows|os2}} {{path/to/file.ppm}} > {{path/to/file.bmp}}` + +- Use a specific number of bits for each pixel: + +`ppmtobmp -bbp {{1|4|8|24}} {{path/to/file.ppm}} > {{path/to/file.bmp}}` diff --git a/ppmtoeyuv b/ppmtoeyuv new file mode 100644 index 00000000..ba5189be --- /dev/null +++ b/ppmtoeyuv @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoeyuv + +> Convert a PPM image to an Berkeley YUV file. +> More information: . + +- Read a PPM image from the input file, convert it to a Berkeley YUV image and store it in the specified output file: + +`ppmtoeyuv {{path/to/input_file.ppm}} > {{path/to/output_file.eyuv}}` diff --git a/ppmtoicr b/ppmtoicr new file mode 100644 index 00000000..dd18834b --- /dev/null +++ b/ppmtoicr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoicr + +> Convert a PPM image to NCSA ICR format. +> More information: . + +- Convert a PPM image to a ICR file: + +`ppmtoicr {{path/to/file.ppm}} > {{path/to/file.icr}}` + +- Display the output in name: + +`ppmtoicr -windowname {{name}} {{path/to/file.ppm}} > {{path/to/file.icr}}` + +- Expand the image by the specified factor: + +`ppmtoicr -expand {{factor}} {{path/to/file.ppm}} > {{path/to/file.icr}}` + +- Display the output on the screen with the specified number: + +`ppmtoicr -display {{number}} {{path/to/file.ppm}} > {{path/to/file.icr}}` diff --git a/ppmtoilbm b/ppmtoilbm new file mode 100644 index 00000000..db80cdb0 --- /dev/null +++ b/ppmtoilbm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoilbm + +> Convert a PPM image to an ILBM file. +> More information: . + +- Convert a PPM image to an ILBM file: + +`ppmtoilbm {{path/to/file.ppm}} > {{path/to/file.ilbm}}` + +- Write a maximum of n planes to the ILBM file and produce a HAM/24bit/direct color file if this number is exceeded: + +`ppmtoilbm -maxplanes {{n}} -{{hamif|24if|dcif}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` + +- Produce a ILBM file with exactly n planes: + +`ppmtoilbm -fixplanes {{n}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` + +- Select the compression method to be used: + +`ppmtoilbm -{{compress|nocompress|savemem}} {{path/to/file.ppm}} > {{path/to/file.ilbm}}` diff --git a/ppmtoleaf b/ppmtoleaf new file mode 100644 index 00000000..23f2a98d --- /dev/null +++ b/ppmtoleaf @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoleaf + +> Convert a PPM image to the Interleaf image format. +> More information: . + +- Convert a PPM image to a LEAF file: + +`ppmtoleaf {{path/to/file.ppm}} > {{path/to/file.leaf}}` diff --git a/ppmtolj b/ppmtolj new file mode 100644 index 00000000..1e506ac7 --- /dev/null +++ b/ppmtolj @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtolj + +> Convert a PPM file to an HP LaserJet PCL 5 Color file. +> More information: . + +- Convert a PPM file to an HP LaserJet PCL 5 Color file: + +`ppmtolj {{path/to/input.ppm}} > {{path/to/output.lj}}` + +- Apply a gamma correction using the specified gamma value: + +`ppmtolj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.lj}}` + +- Specify the required resolution: + +`ppmtolj -resolution {{75|100|150|300|600}} {{path/to/input.ppm}} > {{path/to/output.lj}}` diff --git a/ppmtomitsu b/ppmtomitsu new file mode 100644 index 00000000..e76c2579 --- /dev/null +++ b/ppmtomitsu @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtomitsu + +> Convert a PPM image to a Mitsubishi S340-10 file. +> More information: . + +- Convert a PPM image to a MITSU file: + +`ppmtomitsu {{path/to/file.ppm}} > {{path/to/file.mitsu}}` + +- Enlarge the image by the specified factor, use the specified sharpness and produce `n` copies: + +`ppmtomitsu -enlarge {{1|2|3}} -sharpness {{1|2|3|4}} -copy {{n}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` + +- Use the given medium for the printing process: + +`ppmtomitsu -media {{A|A4|AS|A4S}} {{path/to/file.ppm}} > {{path/to/file.mitsu}}` diff --git a/ppmtompeg b/ppmtompeg new file mode 100644 index 00000000..e69f8127 --- /dev/null +++ b/ppmtompeg @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtompeg + +> Encode an MPEG-1 stream. +> More information: . + +- Produce an MPEG-1 stream using the parameter file to specify inputs and outputs: + +`ppmtompeg {{path/to/parameter_file}}` + +- Encode the GOP with the specified number only: + +`ppmtompeg -gop {{gop_num}} {{path/to/parameter_file}}` + +- Specify the first and last frame to encode: + +`ppmtompeg -frames {{first_frame}} {{last_frame}} {{path/to/parameter_file}}` + +- Combine multiple MPEG frames into a single MPEG-1 stream: + +`ppmtompeg -combine_frames {{path/to/parameter_file}}` diff --git a/ppmtoneo b/ppmtoneo new file mode 100644 index 00000000..1088121d --- /dev/null +++ b/ppmtoneo @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoneo + +> Convert a PPM image to an Atari Neochrome file. +> More information: . + +- Convert a PPM image to a NEO file: + +`ppmtoneo {{path/to/file.ppm}} > {{path/to/file.neo}}` diff --git a/ppmtopcx b/ppmtopcx new file mode 100644 index 00000000..1fa9170b --- /dev/null +++ b/ppmtopcx @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtopcx + +> Convert a PPM image to a PCX file. +> More information: . + +- Convert a PPM image to a PCX file: + +`ppmtopcx {{path/to/file.ppm}} > {{path/to/file.pcx}}` + +- Produce a PCX file with the specified color depth: + +`ppmtopcx -{{8bit|24bit}} {{path/to/file.ppm}} > {{path/to/file.pcx}}` diff --git a/ppmtopgm b/ppmtopgm new file mode 100644 index 00000000..5c7b7024 --- /dev/null +++ b/ppmtopgm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtopgm + +> Convert a PPM image to a PGM image. +> More information: . + +- Convert PPM image to PGM image: + +`ppmtopgm {{path/to/file.ppm}} > {{path/to/file.pgm}}` + +- Display version: + +`ppmtopgm -version` diff --git a/ppmtopict b/ppmtopict new file mode 100644 index 00000000..98821b60 --- /dev/null +++ b/ppmtopict @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtopict + +> Convert a PPM image to a Macintosh PICT file. +> More information: . + +- Convert a PPM image to a PICT file: + +`ppmtopict {{path/to/file.ppm}} > {{path/to/file.pict}}` diff --git a/ppmtopj b/ppmtopj new file mode 100644 index 00000000..d85418ab --- /dev/null +++ b/ppmtopj @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtopj + +> Convert a PPM file to an HP PaintJet file. +> More information: . + +- Convert a PPM file to an HP PaintJet file: + +`ppmtopj {{path/to/input.ppm}} > {{path/to/output.pj}}` + +- Move the image in the x and y direction: + +`ppmtopj -xpos {{dx}} -ypos {{dy}} {{path/to/input.ppm}} > {{path/to/output.pj}}` + +- Explicitly specify a gamma value: + +`ppmtopj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.pj}}` diff --git a/ppmtoppm b/ppmtoppm new file mode 100644 index 00000000..657f7edc --- /dev/null +++ b/ppmtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoppm + +> Copy a PPM image. +> More information: . + +- Copy a PPM image (i.e. a PBM, PGM or PPM image) from `stdin` to `stdout`: + +`ppmtoppm < {{path/to/image.ppm}} > {{path/to/output.ppm}}` + +- Display version: + +`ppmtoppm -version` diff --git a/ppmtopuzz b/ppmtopuzz new file mode 100644 index 00000000..51571890 --- /dev/null +++ b/ppmtopuzz @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtopuzz + +> Convert a PPM image to an X11 puzzle file. +> More information: . + +- Convert a PPM image to an X11 puzzle file: + +`ppmtopuzz {{path/to/file.ppm}} > {{path/to/file.puzz}}` diff --git a/ppmtosixel b/ppmtosixel new file mode 100644 index 00000000..8562a998 --- /dev/null +++ b/ppmtosixel @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtosixel + +> Convert a PPM image to DEC sixel format. +> More information: . + +- Convert a PPM image to DEC sixel format: + +`ppmtosixel {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Produce an uncompressed SIXEL file that is much slower to print: + +`ppmtosixel -raw {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Add a left margin of 1.5 inches: + +`ppmtosixel -margin {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Encode control codes in a more portable (although less space-efficient) way: + +`ppmtosixel -7bit {{path/to/file.ppm}} > {{path/to/file.sixel}}` diff --git a/ppmtospu b/ppmtospu new file mode 100644 index 00000000..002cfe6e --- /dev/null +++ b/ppmtospu @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtospu + +> Convert a PPM file to an Atari Spectrum 512 image. +> More information: . + +- Convert a PPM file to an Atari Spectrum 512 image: + +`ppmtospu {{path/to/input.ppm}} > {{path/to/output.spu}}` + +- Use a dithering matrix of the specified size (0 means no dithering): + +`ppmtospu -d{{0|2|4}} {{path/to/input.ppm}} > {{path/to/output.spu}}` diff --git a/ppmtotga b/ppmtotga new file mode 100644 index 00000000..0d9bd070 --- /dev/null +++ b/ppmtotga @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtotga + +> This command is superseded by `pamtotga`. +> More information: . + +- View documentation for the current command: + +`tldr pamtotga` diff --git a/ppmtowinicon b/ppmtowinicon new file mode 100644 index 00000000..ea0719d8 --- /dev/null +++ b/ppmtowinicon @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtowinicon + +> This command is superseded by `pamtowinicon`. +> More information: . + +- View documentation for the current command: + +`tldr pamtowinicon` diff --git a/ppmtoxpm b/ppmtoxpm new file mode 100644 index 00000000..ec5f2196 --- /dev/null +++ b/ppmtoxpm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoxpm + +> Convert a PPM image to an X11 version 3 pixmap. +> More information: . + +- Convert a PPM image to a XPM image: + +`ppmtoxpm {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- Specify the prefix string in the output XPM image: + +`ppmtoxpm -name {{prefix_string}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- In the output XPM file, specify colors by their hexadecimal code instead of their name: + +`ppmtoxpm -hexonly {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- Use the specified PGM file as a transparency mask: + +`ppmtoxpm -alphamask {{path/to/alpha_file.pgm}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` diff --git a/ppmtoyuv b/ppmtoyuv new file mode 100644 index 00000000..68403912 --- /dev/null +++ b/ppmtoyuv @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoyuv + +> Convert a PPM image to an Abekas YUV file. +> More information: . + +- Read a PPM image from the input file, convert it to an Abekas YUV image and store it in the specified output file: + +`ppmtoyuv {{path/to/input_file.ppm}} > {{path/to/output_file.yuv}}` diff --git a/ppmtoyuvsplit b/ppmtoyuvsplit new file mode 100644 index 00000000..97d23969 --- /dev/null +++ b/ppmtoyuvsplit @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtoyuvsplit + +> Convert a PPM image to three subsampled Abekas YUV files. +> More information: . + +- Read a PPM image from the input file, convert it to three subsampled Abekas YUV image and store these images to output files starting with the specified basename: + +`ppmtoyuvsplit {{basename}} {{path/to/input_file.ppm}}` diff --git a/ppmtv b/ppmtv new file mode 100644 index 00000000..f499ca32 --- /dev/null +++ b/ppmtv @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ppmtv + +> Make a PPM Image look like taken from an American TV. +> Dim every other row of image data down by the specified dim factor (a number between 0 and 1). +> More information: . + +- Give the PPM image an American TV appearance: + +`ppmtv {{dim_factor}} {{path/to/file.ppm}} > {{path/to/output.ppm}}` + +- Suppress all informational messages: + +`ppmtv -quiet` + +- Display version: + +`ppmtv -version` diff --git a/pppd b/pppd new file mode 100644 index 00000000..07311fe1 --- /dev/null +++ b/pppd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pppd + +> Establish Point-to-Point connection to another computer. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`pppd` diff --git a/pprof b/pprof new file mode 100644 index 00000000..82ac3d2f --- /dev/null +++ b/pprof @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pprof + +> Command-line tool for visualization and analysis of profile data. +> More information: . + +- Generate a text report from a specific profiling file, on fibbo binary: + +`pprof -top {{./fibbo}} {{./fibbo-profile.pb.gz}}` + +- Generate a graph and open it on a web browser: + +`pprof -svg {{./fibbo}} {{./fibbo-profile.pb.gz}}` + +- Run pprof in interactive mode to be able to manually launch `pprof` on a file: + +`pprof {{./fibbo}} {{./fibbo-profile.pb.gz}}` + +- Run a web server that serves a web interface on top of `pprof`: + +`pprof -http={{localhost:8080}} {{./fibbo}} {{./fibbo-profile.pb.gz}}` + +- Fetch a profile from an HTTP server and generate a report: + +`pprof {{http://localhost:8080/debug/pprof}}` diff --git a/pr b/pr new file mode 100644 index 00000000..e46c8cf6 --- /dev/null +++ b/pr @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pr + +> Paginate or columnate files for printing. +> More information: . + +- Print multiple files with a default header and footer: + +`pr {{path/to/file1 path/to/file2 ...}}` + +- Print with a custom centered header: + +`pr -h "{{header}}" {{path/to/file1 path/to/file2 ...}}` + +- Print with numbered lines and a custom date format: + +`pr -n -D "{{format}}" {{path/to/file1 path/to/file2 ...}}` + +- Print all files together, one in each column, without a header or footer: + +`pr -m -T {{path/to/file1 path/to/file2 ...}}` + +- Print, beginning at page 2 up to page 5, with a given page length (including header and footer): + +`pr +{{2}}:{{5}} -l {{page_length}} {{path/to/file1 path/to/file2 ...}}` + +- Print with an offset for each line and a truncating custom page width: + +`pr -o {{offset}} -W {{width}} {{path/to/file1 path/to/file2 ...}}` diff --git a/pre-commit b/pre-commit new file mode 100644 index 00000000..318a7461 --- /dev/null +++ b/pre-commit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pre-commit + +> Create Git hooks that get run before a commit. +> More information: . + +- Install pre-commit into your Git hooks: + +`pre-commit install` + +- Run pre-commit hooks on all staged files: + +`pre-commit run` + +- Run pre-commit hooks on all files, staged or unstaged: + +`pre-commit run --all-files` + +- Clean pre-commit cache: + +`pre-commit clean` diff --git a/prettier b/prettier new file mode 100644 index 00000000..902ba54d --- /dev/null +++ b/prettier @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# prettier + +> An opinionated code formatter for JavaScript, JSON, CSS, YAML, and more. +> More information: . + +- Format a file and print the result to `stdout`: + +`prettier {{path/to/file}}` + +- Check if a specific file has been formatted: + +`prettier --check {{path/to/file}}` + +- Run with a specific configuration file: + +`prettier --config {{path/to/config_file}} {{path/to/file}}` + +- Format a file or directory, replacing the original: + +`prettier --write {{path/to/file_or_directory}}` + +- Format files or directories recursively using single quotes and no trailing commas: + +`prettier --single-quote --trailing-comma {{none}} --write {{path/to/file_or_directory}}` + +- Format JavaScript and TypeScript files recursively, replacing the original: + +`prettier --write "**/*.{js,jsx,ts,tsx}"` diff --git a/pretty-bytes b/pretty-bytes new file mode 100644 index 00000000..6a128b84 --- /dev/null +++ b/pretty-bytes @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pretty-bytes + +> Convert bytes to a human-readable string. +> More information: . + +- Convert numeric bytes value to a human-readable string: + +`pretty-bytes {{1337}}` + +- Convert numeric bytes value from `stdin` to a human-readable string: + +`echo {{1337}} | pretty-bytes` + +- Display help: + +`pretty-bytes --help` diff --git a/printenv b/printenv new file mode 100644 index 00000000..84bd33b1 --- /dev/null +++ b/printenv @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# printenv + +> Print values of all or environment variables. +> More information: . + +- Display key-value pairs of all environment variables: + +`printenv` + +- Display the value of a specific variable: + +`printenv {{HOME}}` + +- Display the value of a variable and end with NUL instead of newline: + +`printenv --null {{HOME}}` diff --git a/printf b/printf new file mode 100644 index 00000000..2e253b2a --- /dev/null +++ b/printf @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# printf + +> Format and print text. +> More information: . + +- Print a text message: + +`printf "{{%s +}}" "{{Hello world}}"` + +- Print an integer in bold blue: + +`printf "{{%.3d +}}" {{42}}` + +- Print a float number with the Unicode Euro sign: + +`printf "{{€ %.2f +}}" {{123.4}}` + +- Print a text message composed with environment variables: + +`printf "{{var1: %s var2: %s +}}" "{{$VAR1}}" "{{$VAR2}}"` + +- Store a formatted message in a variable (does not work on zsh): + +`printf -v {{myvar}} {{"This is %s = %d +" "a year" 2016}}` diff --git a/procs b/procs new file mode 100644 index 00000000..a436f100 --- /dev/null +++ b/procs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# procs + +> Display information about the active processes. +> More information: . + +- List all processes showing the PID, user, CPU usage, memory usage, and the command which started them: + +`procs` + +- List all processes as a tree: + +`procs --tree` + +- List information about processes, if the commands which started them contain `zsh`: + +`procs {{zsh}}` + +- List information about all processes sorted by CPU time in [a]scending or [d]escending order: + +`procs {{--sorta|--sortd}} cpu` + +- List information about processes with either a PID, command, or user containing `41` or `firefox`: + +`procs --or {{PID|command|user}} {{41}} {{firefox}}` + +- List information about processes with both PID `41` and a command or user containing `zsh`: + +`procs --and {{41}} {{zsh}}` diff --git a/progpilot b/progpilot new file mode 100644 index 00000000..99e50748 --- /dev/null +++ b/progpilot @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# progpilot + +> A PHP static analysis tool for detecting security vulnerabilities. +> More information: . + +- Analyze the current directory: + +`progpilot` + +- Analyze a specific file or directory: + +`progpilot {{path/to/file_or_directory}}` + +- Specify a custom configuration file: + +`progpilot --configuration {{path/to/configuration.yml}}` diff --git a/progress b/progress new file mode 100644 index 00000000..544206e4 --- /dev/null +++ b/progress @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# progress + +> Display/Monitor the progress of running coreutils. +> More information: . + +- Show the progress of running coreutils: + +`progress` + +- Show the progress of running coreutils in quiet mode: + +`progress -q` + +- Launch and monitor a single long-running command: + +`{{command}} & progress --monitor --pid $!` + +- Include an estimate of time remaining for completion: + +`progress --wait --command {{firefox}}` diff --git a/projucer b/projucer new file mode 100644 index 00000000..9a339e65 --- /dev/null +++ b/projucer @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Projucer + +> A project manager for JUCE framework applications. +> More information: . + +- Display information about a project: + +`Projucer --status {{path/to/project_file}}` + +- Resave all files and resources in a project: + +`Projucer --resave {{path/to/project_file}}` + +- Update the version number in a project: + +`Projucer --set-version {{version_number}} {{path/to/project_file}}` + +- Generate a JUCE project from a PIP file: + +`Projucer --create-project-from-pip {{path/to/PIP}} {{path/to/output}}` + +- Remove all JUCE-style comments (`//=====`, `//-----` or `///////`): + +`Projucer --tidy-divider-comments {{path/to/target_folder}}` + +- Display help: + +`Projucer --help` diff --git a/promtool b/promtool new file mode 100644 index 00000000..d115ce27 --- /dev/null +++ b/promtool @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# promtool + +> Tooling for the Prometheus monitoring system. +> More information: . + +- Check if the configuration files are valid or not (if present report errors): + +`promtool check config {{config_file.yml}}` + +- Check if the rule files are valid or not (if present report errors): + +`promtool check rules {{rules_file.yml}}` + +- Pass Prometheus metrics over `stdin` to check them for consistency and correctness: + +`curl --silent {{http://example.com:9090/metrics/}} | promtool check metrics` + +- Unit tests for rules config: + +`promtool test rules {{test_file.yml}}` diff --git a/prosodyctl b/prosodyctl new file mode 100644 index 00000000..40903c83 --- /dev/null +++ b/prosodyctl @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# prosodyctl + +> The control tool for the Prosody XMPP server. +> Note: process management through `prosodyctl` is discouraged. Instead, use the tools provided by your system (e.g. `systemctl`). +> More information: . + +- Show the status of the Prosody server: + +`sudo prosodyctl status` + +- Reload the server's configuration files: + +`sudo prosodyctl reload` + +- Add a user to the Prosody XMPP server: + +`sudo prosodyctl adduser {{user@example.com}}` + +- Set a user's password: + +`sudo prosodyctl passwd {{user@example.com}}` + +- Permanently delete a user: + +`sudo prosodyctl deluser {{user@example.com}}` diff --git a/protector b/protector new file mode 100644 index 00000000..e7423310 --- /dev/null +++ b/protector @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# protector + +> Protect or unprotect branches on GitHub repositories. +> More information: . + +- Protect branches of a GitHub repository (create branch protection rules): + +`protector {{branches_regex}} -repos {{organization/repository}}` + +- Use the dry run to see what would be protected (can also be used for freeing): + +`protector -dry-run {{branches_regex}} -repos {{organization/repository}}` + +- Free branches of a GitHub repository (delete branch protection rules): + +`protector -free {{branches_regex}} -repos {{organization/repository}}` diff --git a/protoc b/protoc new file mode 100644 index 00000000..9ea3c398 --- /dev/null +++ b/protoc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# protoc + +> Parse Google Protobuf `.proto` files and generate output in the specified language. +> More information: . + +- Generate Python code from a `.proto` file: + +`protoc --python_out={{path/to/output_directory}} {{input_file.proto}}` + +- Generate Java code from a `.proto` file that imports other `.proto` files: + +`protoc --java_out={{path/to/output_directory}} --proto_path={{path/to/import_search_path}} {{input_file.proto}}` + +- Generate code for multiple languages: + +`protoc --csharp_out={{path/to/c#_output_directory}} --js_out={{path/to/js_output_directory}} {{input_file.proto}}` diff --git a/prqlc b/prqlc new file mode 100644 index 00000000..97083aad --- /dev/null +++ b/prqlc @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# prqlc + +> PRQL compiler. +> PRQL is a modern language for transforming data - a simple, powerful, pipelined SQL replacement. +> More information: . + +- Run the compiler interactively: + +`prqlc compile` + +- Compile a specific `.prql` file to `stdout`: + +`prqlc compile {{path/to/file.prql}}` + +- Compile a `.prql` file to a `.sql` file: + +`prqlc compile {{path/to/source.prql}} {{path/to/target.sql}}` + +- Compile a query: + +`echo "{{from employees | filter has_dog | select salary}}" | prqlc compile` + +- Watch a directory and compile on file modification: + +`prqlc watch {{path/to/directory}}` diff --git a/ps b/ps new file mode 100644 index 00000000..3fa99d23 --- /dev/null +++ b/ps @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ps + +> Information about running processes. +> More information: . + +- List all running processes: + +`ps aux` + +- List all running processes including the full command string: + +`ps auxww` + +- Search for a process that matches a string: + +`ps aux | grep {{string}}` + +- List all processes of the current user in extra full format: + +`ps --user $(id -u) -F` + +- List all processes of the current user as a tree: + +`ps --user $(id -u) f` + +- Get the parent PID of a process: + +`ps -o ppid= -p {{pid}}` + +- Sort processes by memory consumption: + +`ps --sort size` diff --git a/ps-nvm b/ps-nvm new file mode 100644 index 00000000..d94ad9f8 --- /dev/null +++ b/ps-nvm @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ps-nvm + +> PowerShell-based utility to manage multiple Node.js versions, inspired by `nvm`. +> This tool provides multiple commands that all can only be run through PowerShell. +> More information: . + +- View documentation for `Get-NodeInstallLocation`, a tool to get the current Node.js install location: + +`tldr get-nodeinstalllocation` + +- View documentation for `Get-NodeVersions`, a tool to list all available and currently-installed Node.js versions: + +`tldr get-nodeversions` + +- View documentation for `Install-NodeVersion`, a tool to install Node.js runtime versions: + +`tldr install-nodeversion` + +- View documentation for `Remove-NodeVersion`, a tool to uninstall an existing Node.js version: + +`tldr remove-nodeversion` + +- View documentation for `Set-NodeInstallLocation`, a tool to set the Node.js install location: + +`tldr set-nodeinstalllocation` + +- View documentation for `Set-NodeVersion`, a tool to set the default version of Node.js: + +`tldr set-nodeversion` diff --git a/psalm b/psalm new file mode 100644 index 00000000..91103729 --- /dev/null +++ b/psalm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# psalm + +> A static analysis tool for finding errors in PHP applications. +> More information: . + +- Generate a Psalm configuration: + +`psalm --init` + +- Analyze the current working directory: + +`psalm` + +- Analyze a specific directory or file: + +`psalm {{path/to/file_or_directory}}` + +- Analyze a project with a specific configuration file: + +`psalm --config {{path/to/psalm.xml}}` + +- Include informational findings in the output: + +`psalm --show-info` + +- Analyze a project and display statistics: + +`psalm --stats` + +- Analyze a project in parallel with 4 threads: + +`psalm --threads {{4}}` diff --git a/psgrep b/psgrep new file mode 100644 index 00000000..b54f3f04 --- /dev/null +++ b/psgrep @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# psgrep + +> Search running processes with `grep`. +> More information: . + +- Find process lines containing a specific string: + +`psgrep {{process_name}}` + +- Find process lines containing a specific string, excluding headers: + +`psgrep -n {{process_name}}` + +- Search using a simplified format (PID, user, command): + +`psgrep -s {{process_name}}` diff --git a/psidtopgm b/psidtopgm new file mode 100644 index 00000000..f803fe6e --- /dev/null +++ b/psidtopgm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# psidtopgm + +> Convert PostScript image data to a PGM image. +> More information: . + +- Convert the image data in a PS file to a PGM image of the specified dimensions and quality: + +`psidtopgm {{width}} {{height}} {{bits_per_sample}} {{path/to/file.ps}} > {{path/to/image.pgm}}` diff --git a/psql b/psql new file mode 100644 index 00000000..121737d7 --- /dev/null +++ b/psql @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# psql + +> PostgreSQL command-line client. +> More information: . + +- Connect to the database. By default, it connects to the local socket using port 5432 with the currently logged in user: + +`psql {{database}}` + +- Connect to the database on given server host running on given port with given username, without a password prompt: + +`psql -h {{host}} -p {{port}} -U {{username}} {{database}}` + +- Connect to the database; user will be prompted for password: + +`psql -h {{host}} -p {{port}} -U {{username}} -W {{database}}` + +- Execute a single SQL query or PostgreSQL command on the given database (useful in shell scripts): + +`psql -c '{{query}}' {{database}}` + +- Execute commands from a file on the given database: + +`psql {{database}} -f {{file.sql}}` diff --git a/pssh b/pssh new file mode 100644 index 00000000..6d8efa6b --- /dev/null +++ b/pssh @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pssh + +> Parallel SSH program. +> More information: . + +- Run a command on two hosts, and print its output on each server inline: + +`pssh -i -H "{{host1}} {{host2}}" {{hostname -i}}` + +- Run a command and save the output to separate files: + +`pssh -H {{host1}} -H {{host2}} -o {{path/to/output_dir}} {{hostname -i}}` + +- Run a command on multiple hosts, specified in a new-line separated file: + +`pssh -i -h {{path/to/hosts_file}} {{hostname -i}}` + +- Run a command as root (this asks for the root password): + +`pssh -i -h {{path/to/hosts_file}} -A -l {{root_username}} {{hostname -i}}` + +- Run a command with extra SSH arguments: + +`pssh -i -h {{path/to/hosts_file}} -x "{{-O VisualHostKey=yes}}" {{hostname -i}}` + +- Run a command limiting the number of parallel connections to 10: + +`pssh -i -h {{path/to/hosts_file}} -p {{10}} '{{cd dir; ./script.sh; exit}}'` diff --git a/pstopnm b/pstopnm new file mode 100644 index 00000000..14c51bdb --- /dev/null +++ b/pstopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pstopnm + +> Convert a PostScript file to a PNM image. +> More information: . + +- Convert a PS file to PNM images, storing page N of the input to `path/to/fileN.ppm`: + +`pstopnm {{path/to/file.ps}}` + +- Explicitly specify the output format: + +`pstopnm -{{pbm|pgm|ppm}} {{path/to/file.ps}}` + +- Specify the resolution of the output in dots per inch: + +`pstopnm -dpi {{n}} {{path/to/file.ps}}` diff --git a/psysh b/psysh new file mode 100644 index 00000000..77000f7c --- /dev/null +++ b/psysh @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# psysh + +> A runtime developer console, interactive debugger and REPL for PHP. +> More information: . + +- Open a shell in the current directory: + +`psysh` + +- Open a shell in a specific directory: + +`psysh --cwd {{path/to/directory}}` + +- Use a specific configuration file: + +`psysh --config {{path/to/file}}` diff --git a/pt b/pt new file mode 100644 index 00000000..d6a1fd53 --- /dev/null +++ b/pt @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pt + +> Platinum Searcher. +> A code search tool similar to `ag`. +> More information: . + +- Find files containing "foo" and print the files with highlighted matches: + +`pt {{foo}}` + +- Find files containing "foo" and display count of matches in each file: + +`pt -c {{foo}}` + +- Find files containing "foo" as a whole word and ignore its case: + +`pt -wi {{foo}}` + +- Find "foo" in files with a given extension using a regular expression: + +`pt -G='{{\.bar$}}' {{foo}}` + +- Find files whose contents match the regular expression, up to 2 directories deep: + +`pt --depth={{2}} -e '{{^ba[rz]*$}}'` diff --git a/ptargrep b/ptargrep new file mode 100644 index 00000000..dec89afc --- /dev/null +++ b/ptargrep @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ptargrep + +> Find regular expression patterns in tar archive files. +> More information: . + +- Search for a pattern within one or more `tar` archives: + +`ptargrep "{{search_pattern}}" {{path/to/file1 path/to/file2 ...}}` + +- Extract to the current directory using the basename of the file from the archive: + +`ptargrep --basename "{{search_pattern}}" {{path/to/file}}` + +- Search for a case-insensitive pattern matching within a `tar` archive: + +`ptargrep --ignore-case "{{search_pattern}}" {{path/to/file}}` diff --git a/ptpython b/ptpython new file mode 100644 index 00000000..fb25ddaa --- /dev/null +++ b/ptpython @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ptpython + +> A better Python REPL. +> More information: . + +- Start a REPL (interactive shell): + +`ptpython` + +- Execute a specific Python file: + +`ptpython {{path/to/file.py}}` + +- Execute a specific Python file and start a REPL: + +`ptpython -i {{path/to/file.py}}` + +- Open the menu: + +`F2` + +- Open the history page: + +`F3` + +- Toggle paste mode: + +`F6` + +- Quit: + +` + D` diff --git a/ptpython3 b/ptpython3 new file mode 100644 index 00000000..421cb4ff --- /dev/null +++ b/ptpython3 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ptpython3 + +> This command is an alias of `ptpython`. + +- View documentation for the original command: + +`tldr ptpython` diff --git a/pueue b/pueue new file mode 100644 index 00000000..296bcc5a --- /dev/null +++ b/pueue @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue + +> A task management tool for sequential and parallel execution of long-running tasks. +> Some subcommands such as `pueue add` have their own usage documentation. +> More information: . + +- Show general help and available subcommands: + +`pueue --help` + +- Execute a pueue subcommand: + +`pueue {{subcommand}}` + +- Check the version of pueue: + +`pueue --version` diff --git a/pueue-add b/pueue-add new file mode 100644 index 00000000..b9b1ff72 --- /dev/null +++ b/pueue-add @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue add + +> Enqueue a task for execution. +> More information: . + +- Add any command to the default queue: + +`pueue add {{command}}` + +- Pass a list of flags or arguments to a command when enqueuing: + +`pueue add -- {{command --arg -f}}` + +- Add a command but do not start it if it's the first in a queue: + +`pueue add --stashed -- {{rsync --archive --compress /local/directory /remote/directory}}` + +- Add a command to a group and start it immediately, see `pueue group` to manage groups: + +`pueue add --immediate --group "{{CPU_intensive}}" -- {{ffmpeg -i input.mp4 frame_%d.png}}` + +- Add a command and start it after commands 9 and 12 finish successfully: + +`pueue add --after {{9}} {{12}} --group "{{torrents}}" -- {{transmission-cli torrent_file.torrent}}` + +- Add a command with a label after some delay has passed, see `pueue enqueue` for valid datetime formats: + +`pueue add --label "{{compressing large file}}" --delay "{{wednesday 10:30pm}}" -- "{{7z a compressed_file.7z large_file.xml}}"` diff --git a/pueue-clean b/pueue-clean new file mode 100644 index 00000000..93541d14 --- /dev/null +++ b/pueue-clean @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue clean + +> Remove all finished tasks from the list and clear logs. +> More information: . + +- Remove finished tasks and clear logs: + +`pueue clean` + +- Only clean commands that finished successfully: + +`pueue clean --successful-only` diff --git a/pueue-completions b/pueue-completions new file mode 100644 index 00000000..3e29f95e --- /dev/null +++ b/pueue-completions @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue completions + +> Generates shell completion files for Bash, Elvish, Fish, PowerShell, and Zsh. +> More information: . + +- Generate completions for Bash: + +`sudo pueue completions bash {{/usr/share/bash-completion/completions/pueue.bash}}` + +- Generate completions for zsh: + +`sudo pueue completions zsh {{/usr/share/zsh/site-functions}}` + +- Generate completions for fish: + +`sudo pueue completions fish {{/usr/share/fish/completions}}` diff --git a/pueue-edit b/pueue-edit new file mode 100644 index 00000000..78f9df74 --- /dev/null +++ b/pueue-edit @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue edit + +> Edit the command or path of a stashed or queued task. +> More information: . + +- Edit a task, see `pueue status` to get the task ID: + +`pueue edit {{task_id}}` + +- Edit the path from which a task is executed: + +`pueue edit {{task_id}} --path` + +- Edit a command with the specified editor: + +`EDITOR={{nano}} pueue edit {{task_id}}` diff --git a/pueue-enqueue b/pueue-enqueue new file mode 100644 index 00000000..84d9e6aa --- /dev/null +++ b/pueue-enqueue @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue enqueue + +> Enqueue stashed tasks. +> See also: `pueue stash`. +> More information: . + +- Enqueue multiple stashed tasks at once: + +`pueue enqueue {{task_id}} {{task_id}}` + +- Enqueue a stashed task after 60 seconds: + +`pueue enqueue --delay {{60}} {{task_id}}` + +- Enqueue a stashed task next Wednesday: + +`pueue enqueue --delay {{wednesday}} {{task_id}}` + +- Enqueue a stashed task after four months: + +`pueue enqueue --delay "4 months" {{task_id}}` + +- Enqueue a stashed task on 2021-02-19: + +`pueue enqueue --delay {{2021-02-19}} {{task_id}}` + +- List all available date/time formats: + +`pueue enqueue --help` diff --git a/pueue-follow b/pueue-follow new file mode 100644 index 00000000..21b525a6 --- /dev/null +++ b/pueue-follow @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue follow + +> Follow the output of a currently running task. +> See also: `pueue log`. +> More information: . + +- Follow the output of a task (`stdout` + `stderr`): + +`pueue follow {{task_id}}` + +- Follow `stderr` of a task: + +`pueue follow --err {{task_id}}` diff --git a/pueue-group b/pueue-group new file mode 100644 index 00000000..d89767fa --- /dev/null +++ b/pueue-group @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue group + +> Display, add or remove groups. +> More information: . + +- Show all groups with their statuses and number of parallel jobs: + +`pueue group` + +- Add a custom group: + +`pueue group --add "{{group_name}}"` + +- Remove a group and move its tasks to the default group: + +`pueue group --remove "{{group_name}}"` diff --git a/pueue-help b/pueue-help new file mode 100644 index 00000000..b3d4dd8a --- /dev/null +++ b/pueue-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue help + +> Display help for subcommands. +> More information: . + +- Show all available subcommands and flags: + +`pueue help` + +- Display help for a specific subcommand: + +`pueue help {{subcommand}}` diff --git a/pueue-kill b/pueue-kill new file mode 100644 index 00000000..3b109864 --- /dev/null +++ b/pueue-kill @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue kill + +> Kill running tasks or whole groups. +> More information: . + +- Kill all tasks in the default group: + +`pueue kill` + +- Kill a specific task: + +`pueue kill {{task_id}}` + +- Kill a task and terminate all its child processes: + +`pueue kill --children {{task_id}}` + +- Kill all tasks in a group and pause the group: + +`pueue kill --group {{group_name}}` + +- Kill all tasks across all groups and pause all groups: + +`pueue kill --all` diff --git a/pueue-log b/pueue-log new file mode 100644 index 00000000..44986787 --- /dev/null +++ b/pueue-log @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue log + +> Display the log output of 1 or more tasks. +> See also: `pueue status`. +> More information: . + +- Show the last few lines of output from all tasks: + +`pueue log` + +- Show the full output of a task: + +`pueue log {{task_id}}` + +- Show the last few lines of output from several tasks: + +`pueue log {{task_id}} {{task_id}}` + +- Print a specific number of lines from the tail of output: + +`pueue log --lines {{number_of_lines}} {{task_id}}` diff --git a/pueue-parallel b/pueue-parallel new file mode 100644 index 00000000..1aca7ab8 --- /dev/null +++ b/pueue-parallel @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue parallel + +> Set the amount of allowed parallel tasks. +> More information: . + +- Set the maximum number of tasks allowed to run in parallel, in the default group: + +`pueue parallel {{max_number_of_parallel_tasks}}` + +- Set the maximum number of tasks allowed to run in parallel, in a specific group: + +`pueue parallel --group {{group_name}} {{maximum_number_of_parallel_tasks}}` diff --git a/pueue-pause b/pueue-pause new file mode 100644 index 00000000..6cc47bd8 --- /dev/null +++ b/pueue-pause @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue pause + +> Pause running tasks or groups. +> See also: `pueue start`. +> More information: . + +- Pause all tasks in the default group: + +`pueue pause` + +- Pause a running task: + +`pueue pause {{task_id}}` + +- Pause a running task and stop all its direct children: + +`pueue pause --children {{task_id}}` + +- Pause all tasks in a group and prevent it from starting new tasks: + +`pueue pause --group {{group_name}}` + +- Pause all tasks and prevent all groups from starting new tasks: + +`pueue pause --all` diff --git a/pueue-remove b/pueue-remove new file mode 100644 index 00000000..c62bdcd6 --- /dev/null +++ b/pueue-remove @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue remove + +> Remove tasks from the list. Running or paused tasks need to be killed first. +> More information: . + +- Remove a killed or finished task: + +`pueue remove {{task_id}}` + +- Remove multiple tasks at once: + +`pueue remove {{task_id}} {{task_id}}` diff --git a/pueue-reset b/pueue-reset new file mode 100644 index 00000000..f5e43c42 --- /dev/null +++ b/pueue-reset @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue reset + +> Kill everything and reset. +> More information: . + +- Kill all tasks and remove everything (logs, status, groups, task IDs): + +`pueue reset` + +- Kill all tasks, terminate their children, and reset everything: + +`pueue reset --children` + +- Reset without asking for confirmation: + +`pueue reset --force` diff --git a/pueue-restart b/pueue-restart new file mode 100644 index 00000000..93fcbbef --- /dev/null +++ b/pueue-restart @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue restart + +> Restart tasks. +> More information: . + +- Restart a specific task: + +`pueue restart {{task_id}}` + +- Restart multiple tasks at once, and start them immediately (do not enqueue): + +`pueue restart --start-immediately {{task_id}} {{task_id}}` + +- Restart a specific task from a different path: + +`pueue restart --edit-path {{task_id}}` + +- Edit a command before restarting: + +`pueue restart --edit {{task_id}}` + +- Restart a task in-place (without enqueuing as a separate task): + +`pueue restart --in-place {{task_id}}` + +- Restart all failed tasks and stash them: + +`pueue restart --all-failed --stashed` diff --git a/pueue-send b/pueue-send new file mode 100644 index 00000000..42bcdaf8 --- /dev/null +++ b/pueue-send @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue send + +> Send input to a task. +> More information: . + +- Send input to a running command: + +`pueue send {{task_id}} "{{input}}"` + +- Send confirmation to a task expecting y/N (e.g. apt, cp): + +`pueue send {{task_id}} {{y}}` diff --git a/pueue-shutdown b/pueue-shutdown new file mode 100644 index 00000000..71215bdc --- /dev/null +++ b/pueue-shutdown @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue shutdown + +> Remotely shut down the daemon. +> Only use this subcommand if the daemon isn't started by a service manager. +> More information: . + +- Shutdown the daemon without a service manager: + +`pueue shutdown` diff --git a/pueue-start b/pueue-start new file mode 100644 index 00000000..73f969f7 --- /dev/null +++ b/pueue-start @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue start + +> Resume operation of tasks or groups of tasks. +> See also: `pueue pause`. +> More information: . + +- Resume all tasks in the default group: + +`pueue start` + +- Resume a specific task: + +`pueue start {{task_id}}` + +- Resume multiple tasks at once: + +`pueue start {{task_id}} {{task_id}}` + +- Resume all tasks and start their children: + +`pueue start --all --children` + +- Resume all tasks in a specific group: + +`pueue start group {{group_name}}` diff --git a/pueue-stash b/pueue-stash new file mode 100644 index 00000000..3bcdbcef --- /dev/null +++ b/pueue-stash @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue stash + +> Stash tasks to prevent them starting automatically. +> See also `pueue start` and `pueue enqueue`. +> More information: . + +- Stash an enqueued task: + +`pueue stash {{task_id}}` + +- Stash multiple tasks at once: + +`pueue stash {{task_id}} {{task_id}}` + +- Start a stashed task immediately: + +`pueue start {{task_id}}` + +- Enqueue a task to be executed when preceding tasks finish: + +`pueue enqueue {{task_id}}` diff --git a/pueue-status b/pueue-status new file mode 100644 index 00000000..96fb9ce1 --- /dev/null +++ b/pueue-status @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue status + +> Display the current status of all tasks. +> More information: . + +- Show the status of all tasks: + +`pueue status` + +- Show the status of a specific group: + +`pueue status --group {{group_name}}` diff --git a/pueue-switch b/pueue-switch new file mode 100644 index 00000000..a71f9059 --- /dev/null +++ b/pueue-switch @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pueue switch + +> Switches the queue position of two enqueued or stashed commands. +> More information: . + +- Switch the priority of two tasks: + +`pueue switch {{task_id1}} {{task_id2}}` diff --git a/pulumi b/pulumi new file mode 100644 index 00000000..a100091a --- /dev/null +++ b/pulumi @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pulumi + +> Define infrastructure on any cloud using familiar programming languages. +> Some subcommands such as `pulumi up` have their own usage documentation. +> More information: . + +- Create a new project using a template: + +`pulumi new` + +- Create a new stack using an isolated deployment target: + +`pulumi stack init` + +- Configure variables (e.g. keys, regions, etc.) interactively: + +`pulumi config` + +- Preview and deploy changes to a program and/or infrastructure: + +`pulumi up` + +- Preview deployment changes without performing them (dry-run): + +`pulumi preview` + +- Destroy a program and its infrastructure: + +`pulumi destroy` diff --git a/pulumi-up b/pulumi-up new file mode 100644 index 00000000..debe2980 --- /dev/null +++ b/pulumi-up @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pulumi up + +> Create or update the resources in a stack. +> More information: . + +- Preview and deploy changes to a program and/or infrastructure: + +`pulumi up` + +- Automatically approve and perform the update after previewing it: + +`pulumi up --yes` + +- Preview and deploy changes in a specific stack: + +`pulumi up --stack {{stack}}` diff --git a/pup b/pup new file mode 100644 index 00000000..b71a7fd7 --- /dev/null +++ b/pup @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pup + +> Command-line HTML parsing tool. +> More information: . + +- Transform a raw HTML file into a cleaned, indented, and colored format: + +`cat {{index.html}} | pup --color` + +- Filter HTML by element tag name: + +`cat {{index.html}} | pup '{{tag}}'` + +- Filter HTML by id: + +`cat {{index.html}} | pup '{{div#id}}'` + +- Filter HTML by attribute value: + +`cat {{index.html}} | pup '{{input[type="text"]}}'` + +- Print all text from the filtered HTML elements and their children: + +`cat {{index.html}} | pup '{{div}} text{}'` + +- Print HTML as JSON: + +`cat {{index.html}} | pup '{{div}} json{}'` diff --git a/puppet b/puppet new file mode 100644 index 00000000..a3d5bc97 --- /dev/null +++ b/puppet @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# puppet + +> Help to manage and automate the configuration of servers. +> Some subcommands such as `puppet agent` have their own usage documentation. +> More information: . + +- Execute a Puppet subcommand: + +`puppet {{subcommand}}` + +- Check the Puppet version: + +`puppet --version` + +- Display help: + +`puppet --help` + +- Display help for a subcommand: + +`puppet help {{subcommand}}` diff --git a/puppet-agent b/puppet-agent new file mode 100644 index 00000000..a2ca7532 --- /dev/null +++ b/puppet-agent @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# puppet agent + +> Retrieves the client configuration from a Puppet server and applies it to the local host. +> More information: . + +- Register a node at a Puppet server and apply the received catalog: + +`puppet agent --test --server {{puppetserver_fqdn}} --serverport {{port}} --waitforcert {{poll_time}}` + +- Run the agent in the background (uses settings from `puppet.conf`): + +`puppet agent` + +- Run the agent once in the foreground, then exit: + +`puppet agent --test` + +- Run the agent in dry-mode: + +`puppet agent --test --noop` + +- Log every resource being evaluated (even if nothing is being changed): + +`puppet agent --test --evaltrace` + +- Disable the agent: + +`puppet agent --disable "{{message}}"` + +- Enable the agent: + +`puppet agent --enable` diff --git a/puppet-apply b/puppet-apply new file mode 100644 index 00000000..b966ba25 --- /dev/null +++ b/puppet-apply @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# puppet apply + +> Apply Puppet manifests locally. +> More information: . + +- Apply a manifest: + +`puppet apply {{path/to/manifest}}` + +- Execute puppet code: + +`puppet apply --execute {{code}}` + +- Use a specific module and hiera configuration file: + +`puppet apply --modulepath {{path/to/directory}} --hiera_config {{path/to/file}} {{path/to/manifest}}` diff --git a/pushd b/pushd new file mode 100644 index 00000000..721dd3c0 --- /dev/null +++ b/pushd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pushd + +> 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: . + +- Switch to directory and push it on the stack: + +`pushd {{path/to/directory}}` + +- Switch first and second directories on the stack: + +`pushd` + +- Rotate stack by making the 5th element the top of the stack: + +`pushd +4` + +- Rotate the stack 4 times to the left (the current directory stays at the top by replacing the 5th element): + +`pushd -n +4` diff --git a/pv b/pv new file mode 100644 index 00000000..37500633 --- /dev/null +++ b/pv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pv + +> Monitor the progress of data through a pipe. +> More information: . + +- Print the contents of the file and display a progress bar: + +`pv {{path/to/file}}` + +- Measure the speed and amount of data flow between pipes (`--size` is optional): + +`command1 | pv --size {{expected_amount_of_data_for_eta}} | command2` + +- Filter a file, see both progress and amount of output data: + +`pv -cN in {{big_text_file}} | grep {{pattern}} | pv -cN out > {{filtered_file}}` + +- Attach to an already running process and see its file reading progress: + +`pv -d {{PID}}` + +- Read an erroneous file, skip errors as `dd conv=sync,noerror` would: + +`pv -EE {{path/to/faulty_media}} > image.img` + +- Stop reading after reading specified amount of data, rate limit to 1K/s: + +`pv -L 1K --stop-at --size {{maximum_file_size_to_be_read}}` diff --git a/pve-firewall b/pve-firewall new file mode 100644 index 00000000..3655266d --- /dev/null +++ b/pve-firewall @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pve-firewall + +> Manage Proxmox VE Firewall. +> More information: . + +- Compile and print all firewall rules: + +`pve-firewall compile` + +- Show information about the local network: + +`pve-firewall localnet` + +- Restart the Proxmox VE Firewall service: + +`pve-firewall restart` + +- Start the Proxmox VE Firewall service: + +`pve-firewall start` + +- Stop the Proxmox VE Firewall service: + +`pve-firewall stop` + +- Simulate all firewall rules: + +`pve-firewall simulate` + +- Show the status of Proxmox VE Firewall: + +`pve-firewall status` diff --git a/pvecm b/pvecm new file mode 100644 index 00000000..145ab678 --- /dev/null +++ b/pvecm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pvecm + +> Proxmox VE Cluster Manager. +> More information: . + +- Add the current node to an existing cluster: + +`pvecm add {{hostname_or_ip}}` + +- Add a node to the cluster configuration (internal use): + +`pvecm addnode {{node}}` + +- Display the version of the cluster join API available on this node: + +`pvecm apiver` + +- Generate new cluster configuration: + +`pvecm create {{clustername}}` + +- Remove a node from the cluster configuration: + +`pvecm delnode {{node}}` + +- Display the local view of the cluster nodes: + +`pvecm nodes` + +- Display the local view of the cluster status: + +`pvecm status` diff --git a/pveperf b/pveperf new file mode 100644 index 00000000..74e07694 --- /dev/null +++ b/pveperf @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pveperf + +> A benchmarking tool in Proxmox Server. Gather CPU and hard disk performance data for the hard disk. +> More information: . + +- Show CPU and hard disk performance data for the hard disk mounted at `/`: + +`pveperf` diff --git a/pwd b/pwd new file mode 100644 index 00000000..95747205 --- /dev/null +++ b/pwd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pwd + +> Print name of current/working directory. +> More information: . + +- Print the current directory: + +`pwd` + +- Print the current directory, and resolve all symlinks (i.e. show the "physical" path): + +`pwd -P` diff --git a/pwgen b/pwgen new file mode 100644 index 00000000..14ae80db --- /dev/null +++ b/pwgen @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pwgen + +> Generate pronounceable passwords. +> More information: . + +- Generate random password with s[y]mbols: + +`pwgen -y {{length}}` + +- Generate secure, hard-to-memorize passwords: + +`pwgen -s {{length}}` + +- Generate password with at least one capital letter in them: + +`pwgen -c {{length}}` diff --git a/pwsh b/pwsh new file mode 100644 index 00000000..9bca92b3 --- /dev/null +++ b/pwsh @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pwsh + +> Command-line shell and scripting language designed especially for system administration. +> This command refers to PowerShell version 6 and above (also known as PowerShell Core and cross-platform PowerShell). +> To use the original Windows version (5.1 and below, also known as the legacy Windows PowerShell), use `powershell` instead of `pwsh`. +> More information: . + +- Start an interactive shell session: + +`pwsh` + +- Start an interactive shell session without loading startup configs: + +`pwsh -NoProfile` + +- Execute specific commands: + +`pwsh -Command "{{echo 'powershell is executed'}}"` + +- Execute a specific script: + +`pwsh -File {{path/to/script.ps1}}` + +- Start a session with a specific version of PowerShell: + +`pwsh -Version {{version}}` + +- Prevent a shell from exit after running startup commands: + +`pwsh -NoExit` + +- Describe the format of data sent to PowerShell: + +`pwsh -InputFormat {{Text|XML}}` + +- Determine how an output from PowerShell is formatted: + +`pwsh -OutputFormat {{Text|XML}}` diff --git a/py-spy b/py-spy new file mode 100644 index 00000000..994f5ef6 --- /dev/null +++ b/py-spy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# py-spy + +> A sampling profiler for Python programs. +> More information: . + +- Show a live view of the functions that take the most execution time of a running process: + +`py-spy top --pid {{pid}}` + +- Start a program and show a live view of the functions that take the most execution time: + +`py-spy top -- python {{path/to/file.py}}` + +- Produce an SVG flame graph of the function call execution time: + +`py-spy record -o {{path/to/profile.svg}} --pid {{pid}}` + +- Dump the call stack of a running process: + +`py-spy dump --pid {{pid}}` diff --git a/pyats b/pyats new file mode 100644 index 00000000..926f2398 --- /dev/null +++ b/pyats @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyATS + +> A vendor agnostic test automation framework by Cisco Systems, used for network and systems testing. +> More information: . + +- Run a `pyATS` subcommand: + +`pyats {{subcommand}}` + +- Display help: + +`pyats --help` + +- Display help about a specific subcommand: + +`pyats {{subcommand}} --help` + +- Display version: + +`pyats version check` diff --git a/pyats-shell b/pyats-shell new file mode 100644 index 00000000..427d4bdb --- /dev/null +++ b/pyats-shell @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyats shell + +> Start a pre-loaded pyATS interactive Python Shell to save time in prototyping. +> More information: . + +- Open pyATS shell with a defined Testbed file: + +`pyats shell --testbed-file {{path/to/testbed.yaml}}` + +- Open pyATS shell with a defined Pickle file: + +`pyats shell --pickle-file {{path/to/pickle.file}}` + +- Open pyATS with IPython disabled: + +`pyats shell --no-ipython` diff --git a/pyats-version b/pyats-version new file mode 100644 index 00000000..01cad2d9 --- /dev/null +++ b/pyats-version @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyats version + +> View and upgrade the pyATS installation. +> More information: . + +- Display version of all packages: + +`pyats version check` + +- Display outdated packages: + +`pyats version check --outdated` + +- Update packages to the most recent version: + +`pyats version update` + +- Update or downgrade packages to a specific version: + +`pyats version update {{version}}` diff --git a/pycodestyle b/pycodestyle new file mode 100644 index 00000000..b5dd67d9 --- /dev/null +++ b/pycodestyle @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pycodestyle + +> Check Python code against PEP 8 style conventions. +> More information: . + +- Check the style of a single file: + +`pycodestyle {{file.py}}` + +- Check the style of multiple files: + +`pycodestyle {{file1.py file2.py ...}}` + +- Show only the first occurrence of an error: + +`pycodestyle --first {{file.py}}` + +- Show the source code for each error: + +`pycodestyle --show-source {{file.py}}` + +- Show the specific PEP 8 text for each error: + +`pycodestyle --show-pep8 {{file.py}}` diff --git a/pydoc b/pydoc new file mode 100644 index 00000000..03a49edc --- /dev/null +++ b/pydoc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pydoc + +> Display offline Python documentation. +> More information: . + +- Print documentation on a subject (Python keyword, topic, function, module, package, etc.): + +`pydoc {{subject}}` + +- Start an HTTP server on an arbitrary unused port and open a [b]rowser to see the documentation: + +`pydoc -b` + +- Display help: + +`pydoc` diff --git a/pyenv b/pyenv new file mode 100644 index 00000000..5989674e --- /dev/null +++ b/pyenv @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyenv + +> Switch between multiple versions of Python easily. +> See also: `asdf`. +> More information: . + +- List all available commands: + +`pyenv commands` + +- List all Python versions under the `${PYENV_ROOT}/versions` directory: + +`pyenv versions` + +- List all Python versions that can be installed from upstream: + +`pyenv install --list` + +- Install a Python version under the `${PYENV_ROOT}/versions` directory: + +`pyenv install {{2.7.10}}` + +- Uninstall a Python version under the `${PYENV_ROOT}/versions` directory: + +`pyenv uninstall {{2.7.10}}` + +- Set Python version to be used globally in the current machine: + +`pyenv global {{2.7.10}}` + +- Set Python version to be used in the current directory and all directories below it: + +`pyenv local {{2.7.10}}` diff --git a/pyenv-virtualenv b/pyenv-virtualenv new file mode 100644 index 00000000..db542117 --- /dev/null +++ b/pyenv-virtualenv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyenv virtualenv + +> Create virtual environments based on one's installed Python distributions. +> More information: . + +- Create a new Python 3.6.6 virtual environment: + +`pyenv virtualenv {{3.6.6}} {{virtualenv_name}}` + +- List all existing virtual environments: + +`pyenv virtualenvs` + +- Activate a virtual environment: + +`pyenv activate {{virtualenv_name}}` + +- Deactivate the virtual environment: + +`pyenv deactivate` diff --git a/pyflakes b/pyflakes new file mode 100644 index 00000000..4126a404 --- /dev/null +++ b/pyflakes @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyflakes + +> Checks Python source code files for errors. +> More information: . + +- Check a single Python file: + +`pyflakes check {{path/to/file.py}}` + +- Check Python files in a specific directory: + +`pyflakes checkPath {{path/to/directory}}` + +- Check Python files in a directory recursively: + +`pyflakes checkRecursive {{path/to/directory}}` + +- Check all Python files found in multiple directories: + +`pyflakes iterSourceCode {{path/to/directory_1}} {{path/to/directory_2}}` diff --git a/pygmentize b/pygmentize new file mode 100644 index 00000000..90b51734 --- /dev/null +++ b/pygmentize @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pygmentize + +> Python-based syntax highlighter. +> More information: . + +- Highlight file syntax and print to `stdout` (language is inferred from the file extension): + +`pygmentize {{file.py}}` + +- Explicitly set the language for syntax highlighting: + +`pygmentize -l {{javascript}} {{input_file}}` + +- List available lexers (processors for input languages): + +`pygmentize -L lexers` + +- Save output to a file in HTML format: + +`pygmentize -f html -o {{output_file.html}} {{input_file.py}}` + +- List available output formats: + +`pygmentize -L formatters` + +- Output an HTML file, with additional formatter options (full page, with line numbers): + +`pygmentize -f html -O "full,linenos=True" -o {{output_file.html}} {{input_file}}` diff --git a/pyinfra b/pyinfra new file mode 100644 index 00000000..9739e23f --- /dev/null +++ b/pyinfra @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pyinfra + +> Automates infrastructure at a large scale. +> More information: . + +- Execute a command over SSH: + +`pyinfra {{target_ip_address}} exec -- {{command_name_and_arguments}}` + +- Execute contents of a deploy file on a list of targets: + +`pyinfra {{path/to/target_list.py}} {{path/to/deploy.py}}` + +- Execute commands on locally: + +`pyinfra @local {{path/to/deploy.py}}` + +- Execute commands over Docker: + +`pyinfra @docker/{{container}} {{path/to/deploy.py}}` diff --git a/pylint b/pylint new file mode 100644 index 00000000..4105a33c --- /dev/null +++ b/pylint @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pylint + +> A Python code linter. +> More information: . + +- Show lint errors in a file: + +`pylint {{path/to/file.py}}` + +- Lint a file and use a configuration file (usually named `pylintrc`): + +`pylint --rcfile {{path/to/pylintrc}} {{path/to/file.py}}` + +- Lint a file and disable a specific error code: + +`pylint --disable {{C,W,no-error,design}} {{path/to/file}}` diff --git a/pypy b/pypy new file mode 100644 index 00000000..1217585f --- /dev/null +++ b/pypy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pypy + +> Fast and compliant alternative implementation of the Python language. +> More information: . + +- Start a REPL (interactive shell): + +`pypy` + +- Execute script in a given Python file: + +`pypy {{path/to/file.py}}` + +- Execute script as part of an interactive shell: + +`pypy -i {{path/to/file.py}}` + +- Execute a Python expression: + +`pypy -c "{{expression}}"` + +- Run library module as a script (terminates option list): + +`pypy -m {{module}} {{arguments}}` + +- Install a package using pip: + +`pypy -m pip install {{package}}` + +- Interactively debug a Python script: + +`pypy -m pdb {{path/to/file.py}}` diff --git a/pystun3 b/pystun3 new file mode 100644 index 00000000..72541664 --- /dev/null +++ b/pystun3 @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pystun3 + +> Classic STUN client written in Python. +> More information: . + +- Make a STUN request: + +`pystun3` + +- Make a STUN request and specify the stun server: + +`pystun3 --stun-host {{stun.1und1.de}}` + +- Make a STUN request and specify the source port: + +`pystun3 --source-port {{7932}}` diff --git a/pytest b/pytest new file mode 100644 index 00000000..dec71716 --- /dev/null +++ b/pytest @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pytest + +> Run Python tests. +> More information: . + +- Run tests from specific files: + +`pytest {{path/to/test_file1.py path/to/test_file2.py ...}}` + +- Run tests with names matching a specific [k]eyword expression: + +`pytest -k {{expression}}` + +- Exit as soon as a test fails or encounters an error: + +`pytest --exitfirst` + +- Run tests matching or excluding markers: + +`pytest -m {{marker_name1 and not marker_name2}}` + +- Run until a test failure, continuing from the last failing test: + +`pytest --stepwise` + +- Run tests without capturing output: + +`pytest --capture=no` diff --git a/python b/python new file mode 100644 index 00000000..78cd3398 --- /dev/null +++ b/python @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# python + +> Python language interpreter. +> More information: . + +- Start a REPL (interactive shell): + +`python` + +- Execute a specific Python file: + +`python {{path/to/file.py}}` + +- Execute a specific Python file and start a REPL: + +`python -i {{path/to/file.py}}` + +- Execute a Python expression: + +`python -c "{{expression}}"` + +- Run the script of the specified library module: + +`python -m {{module}} {{arguments}}` + +- Install a package using `pip`: + +`python -m pip install {{package}}` + +- Interactively debug a Python script: + +`python -m pdb {{path/to/file.py}}` + +- Start the built-in HTTP server on port 8000 in the current directory: + +`python -m http.server` diff --git a/python3 b/python3 new file mode 100644 index 00000000..2a7e6158 --- /dev/null +++ b/python3 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# python3 + +> This command is an alias of `python`. + +- View documentation for the original command: + +`tldr python` diff --git a/q b/q new file mode 100644 index 00000000..f8d34984 --- /dev/null +++ b/q @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# q + +> Execute SQL-like queries on .csv and .tsv files. +> More information: . + +- Query `.csv` file by specifying the delimiter as ',': + +`q -d',' "SELECT * from {{path/to/file}}"` + +- Query `.tsv` file: + +`q -t "SELECT * from {{path/to/file}}"` + +- Query file with header row: + +`q -d{{delimiter}} -H "SELECT * from {{path/to/file}}"` + +- Read data from `stdin`; '-' in the query represents the data from `stdin`: + +`{{output}} | q "select * from -"` + +- Join two files (aliased as `f1` and `f2` in the example) on column `c1`, a common column: + +`q "SELECT * FROM {{path/to/file}} f1 JOIN {{path/to/other_file}} f2 ON (f1.c1 = f2.c1)"` + +- Format output using an output delimiter with an output header line (Note: command will output column names based on the input file header or the column aliases overridden in the query): + +`q -D{{delimiter}} -O "SELECT {{column}} as {{alias}} from {{path/to/file}}"` diff --git a/qc b/qc new file mode 100644 index 00000000..e69dce3f --- /dev/null +++ b/qc @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qc + +> Manage and execute command snippets stored in QOwnNotes notes. +> See also: `qownnotes`. +> More information: . + +- Configure the snippet manager, e.g. to set the security token from QOwnNotes: + +`qc configure` + +- Search and print command snippets stored in your `Commands.md` note and all your notes tagged with `commands`: + +`qc search` + +- Execute a snippet and show the command before executing: + +`qc exec --command` + +- Execute the last snippet and show the command before executing: + +`qc exec --command --last` + +- Switch between note folders in QOwnNotes: + +`qc switch` diff --git a/qcp b/qcp new file mode 100644 index 00000000..1a4f5684 --- /dev/null +++ b/qcp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qcp + +> Copy files using the default text editor to define the filenames. +> More information: . + +- Copy a single file (open an editor with the source filename on the left and the target filename on the right): + +`qcp {{source_file}}` + +- Copy multiple JPG files: + +`qcp {{*.jpg}}` + +- Copy files, but swap the positions of the source and the target filenames in the editor: + +`qcp --option swap {{*.jpg}}` diff --git a/qdbus b/qdbus new file mode 100644 index 00000000..14528263 --- /dev/null +++ b/qdbus @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qdbus + +> Inter-Process Communication (IPC) and Remote Procedure Calling (RPC) mechanism originally developed for Linux. +> More information: . + +- List available service names: + +`qdbus` + +- List object paths for a specific service: + +`qdbus {{service_name}}` + +- List methods, signals and properties available on a specific 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}}` + +- Display the current brightness value in a KDE Plasma session: + +`qdbus {{org.kde.Solid.PowerManagement}} {{/org/kde/Solid/PowerManagement/Actions/BrightnessControl}} {{org.kde.Solid.PowerManagement.Actions.BrightnessControl.brightness}}` + +- Set a specific brightness to a KDE Plasma session: + +`qdbus {{org.kde.Solid.PowerManagement}} {{/org/kde/Solid/PowerManagement/Actions/BrightnessControl}} {{org.kde.Solid.PowerManagement.Actions.BrightnessControl.setBrightness}} {{5000}}` + +- Invoke volume up shortcut in a KDE Plasma session: + +`qdbus {{org.kde.kglobalaccel}} {{/component/kmix}} {{invokeShortcut}} "{{increase_volume}}"` + +- Gracefully log out and then do nothing, reboot or shut down: + +`qdbus {{org.kde.Shutdown}} {{/Shutdown}} {{logout|logoutAndReboot|logoutAndShutdown}}` diff --git a/qemu b/qemu new file mode 100644 index 00000000..568273df --- /dev/null +++ b/qemu @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qemu + +> Generic machine emulator and virtualizer. +> Supports a large variety of CPU architectures. +> More information: . + +- Boot from image emulating i386 architecture: + +`qemu-system-i386 -hda {{image_name.img}}` + +- Boot from image emulating x64 architecture: + +`qemu-system-x86_64 -hda {{image_name.img}}` + +- Boot QEMU instance with a live ISO image: + +`qemu-system-i386 -hda {{image_name.img}} -cdrom {{os_image.iso}} -boot d` + +- Specify amount of RAM for instance: + +`qemu-system-i386 -m 256 -hda image_name.img -cdrom os-image.iso -boot d` + +- Boot from physical device (e.g. from USB to test bootable medium): + +`qemu-system-i386 -hda /dev/{{storage_device}}` diff --git a/qemu-img b/qemu-img new file mode 100644 index 00000000..6d46497e --- /dev/null +++ b/qemu-img @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qemu-img + +> Create and manipulate Quick Emulator Virtual HDD images. +> More information: . + +- Create disk image with a specific size (in gigabytes): + +`qemu-img create {{image_name.img}} {{gigabytes}}G` + +- Show information about a disk image: + +`qemu-img info {{image_name.img}}` + +- Increase or decrease image size: + +`qemu-img resize {{image_name.img}} {{gigabytes}}G` + +- Dump the allocation state of every sector of the specified disk image: + +`qemu-img map {{image_name.img}}` + +- Convert a VMware .vmdk disk image to a KVM .qcow2 disk image: + +`qemu-img convert -f {{vmdk}} -O {{qcow2}} {{path/to/file/foo.vmdk}} {{path/to/file/foo.qcow2}}` diff --git a/qm-nbdstop b/qm-nbdstop new file mode 100644 index 00000000..58f3b6ff --- /dev/null +++ b/qm-nbdstop @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qm nbdstop + +> Stop embedded nbd server. +> More information: . + +- Stop embedded nbd server: + +`qm nbdstop {{VM_ID}}` diff --git a/qm-stop b/qm-stop new file mode 100644 index 00000000..914e35f4 --- /dev/null +++ b/qm-stop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qm stop + +> Stop a virtual machine. +> More information: . + +- Stop a virtual machine immediately: + +`qm stop {{VM_ID}}` + +- Stop a virtual machine and wait for at most 10 seconds: + +`qm stop --timeout {{10}} {{VM_ID}}` + +- Stop a virtual machine and skip lock (only root can use this option): + +`qm stop --skiplock {{true}} {{VM_ID}}` + +- Stop a virtual machine and don't deactivate storage volumes: + +`qm stop --keepActive {{true}} {{VM_ID}}` diff --git a/qmmp b/qmmp new file mode 100644 index 00000000..73d035f9 --- /dev/null +++ b/qmmp @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qmmp + +> An audio player with an interface similar to Winamp or XMMS. +> More information: . + +- Launch the GUI: + +`qmmp` + +- Start or stop the currently playing audio: + +`qmmp --play-pause` + +- Seek [f]or[w]ar[d]s or [b]ack[w]ar[d]s a specific amount of time in seconds: + +`qmmp --seek-{{fwd|bwd}} {{time_in_seconds}}` + +- Play the next audio file: + +`qmmp --next` + +- Play the previous audio file: + +`qmmp --previous` + +- Display the current volume: + +`qmmp --volume-status` + +- [inc]rease or [dec]rease the volume of the currently playing audio by 5%: + +`qmmp --volume-{{inc|dec}}` diff --git a/qmv b/qmv new file mode 100644 index 00000000..4e507075 --- /dev/null +++ b/qmv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qmv + +> Move files and directories using the default text editor to define the filenames. +> More information: . + +- Move a single file (open an editor with the source filename on the left and the target filename on the right): + +`qmv {{source_file}}` + +- Move multiple JPG files: + +`qmv {{*.jpg}}` + +- Move multiple directories: + +`qmv -d {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` + +- Move all files and directories inside a directory: + +`qmv --recursive {{path/to/directory}}` + +- Move files, but swap the positions of the source and the target filenames in the editor: + +`qmv --option swap {{*.jpg}}` + +- Rename all files and folders in the current directory, but show only target filenames in the editor (you can think of it as a kind of simple mode): + +`qmv --format=do .` diff --git a/qoitopam b/qoitopam new file mode 100644 index 00000000..4db861c2 --- /dev/null +++ b/qoitopam @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qoitopam + +> Convert a QOI image (Quite OK Image format) to Netpbm. +> More information: . + +- Convert a QOI image to Netpbm: + +`qoitopam {{path/to/image.qoi}} > {{path/to/output.pnm}}` diff --git a/qownnotes b/qownnotes new file mode 100644 index 00000000..bc447c20 --- /dev/null +++ b/qownnotes @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qownnotes + +> Markdown note-taking application. +> Optionally integrates with the note-taking applications of Nextcloud and ownCloud. +> See also: `qc`, for managing command snippets. +> More information: . + +- Run in portable mode: + +`QOwnNotes --portable` + +- Dump settings and other information about the app and environment in GitHub Markdown: + +`QOwnNotes --dump-settings` + +- Specify a different context for settings and internal files: + +`QOwnNotes --session {{test}}` + +- Trigger a menu action after the application was started: + +`QOwnNotes --action {{actionShow_Todo_List}}` diff --git a/qpdf b/qpdf new file mode 100644 index 00000000..3ddf0eaf --- /dev/null +++ b/qpdf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qpdf + +> Versatile PDF transformation software. +> More information: . + +- Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: + +`qpdf --empty --pages {{path/to/input.pdf}} {{1-3,5,6-10}} -- {{path/to/output.pdf}}` + +- Merge (concatenate) all the pages of multiple PDF files and save the result as a new PDF: + +`qpdf --empty --pages {{path/to/file1.pdf file2.pdf ...}} -- {{path/to/output.pdf}}` + +- Merge (concatenate) given pages from a list of PDF files and save the result as a new PDF: + +`qpdf --empty --pages {{path/to/file1.pdf}} {{1,6-8}} {{path/to/file2.pdf}} {{3,4,5}} -- {{path/to/output.pdf}}` + +- Write each group of `n` pages to a separate output file with a given filename pattern: + +`qpdf --split-pages={{n}} {{path/to/input.pdf}} {{path/to/out_%d.pdf}}` + +- Rotate certain pages of a PDF with a given angle: + +`qpdf --rotate={{90:2,4,6}} --rotate={{180:7-8}} {{path/to/input.pdf}} {{path/to/output.pdf}}` + +- Remove the password from a password-protected file: + +`qpdf --password={{password}} --decrypt {{path/to/input.pdf}} {{path/to/output.pdf}}` diff --git a/qr b/qr new file mode 100644 index 00000000..e186de3b --- /dev/null +++ b/qr @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qr + +> Generate QR codes in the terminal with ANSI VT-100 escape codes. +> More information: . + +- Generate a QR code: + +`echo "{{data}}" | qr` + +- Specify the error correction level (defaults to M): + +`echo "{{data}}" | qr --error-correction={{L|M|Q|H}}` diff --git a/qrencode b/qrencode new file mode 100644 index 00000000..4e28fbe9 --- /dev/null +++ b/qrencode @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qrencode + +> QR Code generator. Supports PNG and EPS. +> More information: . + +- Convert a string to a QR code and save to an output file: + +`qrencode -o {{path/to/output_file.png}} {{string}}` + +- Convert an input file to a QR code and save to an output file: + +`qrencode -o {{path/to/output_file.png}} -r {{path/to/input_file}}` + +- Convert a string to a QR code and print it in terminal: + +`qrencode -t ansiutf8 {{string}}` + +- Convert input from pipe to a QR code and print it in terminal: + +`echo {{string}} | qrencode -t ansiutf8` diff --git a/qrttoppm b/qrttoppm new file mode 100644 index 00000000..f2bde7d5 --- /dev/null +++ b/qrttoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qrttoppm + +> Convert a QRT ray tracer file to a PPM image. +> More information: . + +- Convert a QRT file to a PPM image: + +`qrttoppm {{path/to/file.qrt}} > {{path/to/image.ppm}}` diff --git a/qtcreator b/qtcreator new file mode 100644 index 00000000..da43589b --- /dev/null +++ b/qtcreator @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qtcreator + +> Cross-platform IDE for Qt applications. +> More information: . + +- Start Qt Creator: + +`qtcreator` + +- Start Qt Creator and restore the last session: + +`qtcreator -lastsession` + +- Start Qt Creator but don't load the specified plugin: + +`qtcreator -noload {{plugin}}` + +- Start Qt Creator but don't load any plugins: + +`qtcreator -noload {{all}}` + +- Start Qt Creator in presentation mode with pop-ups for keyboard shortcuts: + +`qtcreator -presentationMode` + +- Start Qt Creator and show the diff from a specific commit: + +`qtcreator -git-show {{commit}}` diff --git a/quarto b/quarto new file mode 100644 index 00000000..cc8eed6c --- /dev/null +++ b/quarto @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# quarto + +> An open-source scientific and technical publishing system built on Pandoc. +> More information: . + +- Create a new project: + +`quarto create-project {{path/to/destination_directory}} --type {{book|default|website}}` + +- Create a new blog website: + +`quarto create-project {{path/to/destination_directory}} --type {{website}} --template {{blog}}` + +- Render input file(s) to different formats: + +`quarto render {{path/to/file.{{qmd|rmd|ipynb}}}} --to {{html|pdf|docx}}` + +- Render and preview a document or a website: + +`quarto preview {{path/to/destination_directory|path/to/file}}` + +- Publish a document or project to Quarto Pub, Github Pages, RStudio Connect or Netlify: + +`quarto publish {{quarto-pub|gh-pages|connect|netlify}}` diff --git a/quilt b/quilt new file mode 100644 index 00000000..e36fd5f1 --- /dev/null +++ b/quilt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# quilt + +> Manage a series of patches. +> More information: . + +- Import an existing patch from a file: + +`quilt import {{path/to/filename.patch}}` + +- Create a new patch: + +`quilt new {{filename.patch}}` + +- Add a file to the current patch: + +`quilt add {{path/to/file}}` + +- After editing the file, refresh the current patch with the changes: + +`quilt refresh` + +- Apply all the patches in the series file: + +`quilt push -a` + +- Remove all applied patches: + +`quilt pop -a` diff --git a/quota b/quota new file mode 100644 index 00000000..9ad22fd5 --- /dev/null +++ b/quota @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# quota + +> Display users' disk space usage and allocated limits. +> More information: . + +- Show disk quotas in human-readable units for the current user: + +`quota -s` + +- Verbose output (also display quotas on filesystems where no storage is allocated): + +`quota -v` + +- Quiet output (only display quotas on filesystems where usage is over quota): + +`quota -q` + +- Print quotas for the groups of which the current user is a member: + +`quota -g` + +- Show disk quotas for another user: + +`sudo quota -u {{username}}` diff --git a/qutebrowser b/qutebrowser new file mode 100644 index 00000000..143b65e3 --- /dev/null +++ b/qutebrowser @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qutebrowser + +> A keyboard-driven, vim-like browser based on PyQt5. +> More information: . + +- Open qutebrowser with a specified storage directory: + +`qutebrowser --basedir {{path/to/directory}}` + +- Open a qutebrowser instance with temporary settings: + +`qutebrowser --set {{content.geolocation}} {{true|false}}` + +- Restore a named session of a qutebrowser instance: + +`qutebrowser --restore {{session_name}}` + +- Launch qutebrowser, opening all URLs using the specified method: + +`qutebrowser --target {{auto|tab|tab-bg|tab-silent|tab-bg-silent|window|private-window}}` + +- Open qutebrowser with a temporary base directory and print logs to `stdout` as JSON: + +`qutebrowser --temp-basedir --json-logging` diff --git a/r b/r new file mode 100644 index 00000000..d71da1d7 --- /dev/null +++ b/r @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# R + +> R language interpreter. +> More information: . + +- Start a REPL (interactive shell): + +`R` + +- Start R in vanilla mode (i.e. a blank session that doesn't save the workspace at the end): + +`R --vanilla` + +- Execute a file: + +`R -f {{path/to/file.R}}` + +- Execute an R expression and then exit: + +`R -e {{expr}}` + +- Run R with a debugger: + +`R -d {{debugger}}` + +- Check R packages from package sources: + +`R CMD check {{path/to/package_source}}` + +- Display version: + +`R --version` diff --git a/r2 b/r2 new file mode 100644 index 00000000..20cd13e8 --- /dev/null +++ b/r2 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# r2 + +> This command is an alias of `radare2`. + +- View documentation for the original command: + +`tldr radare2` diff --git a/r2e b/r2e new file mode 100644 index 00000000..38b5dfac --- /dev/null +++ b/r2e @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# r2e + +> Forwards RSS feeds to an email address. +> Requires a configured `sendmail` or smtp setup. +> More information: . + +- Create a new feed database that sends email to an email address: + +`r2e new {{email_address}}` + +- Subscribe to a feed: + +`r2e add {{feed_name}} {{feed_URI}}` + +- Send new stories to an email address: + +`r2e run` + +- List all feeds: + +`r2e list` + +- Delete a feed at a specified index: + +`r2e delete {{index}}` diff --git a/rabin2 b/rabin2 new file mode 100644 index 00000000..ea8e6688 --- /dev/null +++ b/rabin2 @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rabin2 + +> Get information about binary files (ELF, PE, Java CLASS, Mach-O) - symbols, sections, linked libraries, etc. +> Comes bundled with `radare2`. +> More information: . + +- Display general information about a binary (architecture, type, endianness): + +`rabin2 -I {{path/to/binary}}` + +- Display linked libraries: + +`rabin2 -l {{path/to/binary}}` + +- Display symbols imported from libraries: + +`rabin2 -i {{path/to/binary}}` + +- Display strings contained in the binary: + +`rabin2 -z {{path/to/binary}}` + +- Display the output in JSON: + +`rabin2 -j -I {{path/to/binary}}` diff --git a/racket b/racket new file mode 100644 index 00000000..8232bef8 --- /dev/null +++ b/racket @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# racket + +> Racket language interpreter. +> More information: . + +- Start a REPL (interactive shell): + +`racket` + +- Execute a Racket script: + +`racket {{path/to/script.rkt}}` + +- Execute a Racket expression: + +`racket --eval "{{expression}}"` + +- Run module as a script (terminates option list): + +`racket --lib {{module_name}} --main {{arguments}}` + +- Start a REPL (interactive shell) for the `typed/racket` hashlang: + +`racket -I typed/racket` diff --git a/raco b/raco new file mode 100644 index 00000000..70e40fda --- /dev/null +++ b/raco @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# raco + +> Racket command-line tools. +> More information: . + +- Install a package, automatically installing dependencies: + +`raco pkg install --auto {{package_source}}` + +- Install the current directory as a package: + +`raco pkg install` + +- Build (or rebuild) bytecode, documentation, executables, and metadata indexes for collections: + +`raco setup {{collection1 collection2 ...}}` + +- Run tests in files: + +`raco test {{path/to/tests1.rkt path/to/tests2.rkt ...}}` + +- Search local documentation: + +`raco docs {{search_terms ...}}` + +- Display help: + +`raco help` diff --git a/radare2 b/radare2 new file mode 100644 index 00000000..193ceb92 --- /dev/null +++ b/radare2 @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# radare2 + +> A set of reverse engineering tools. +> More information: . + +- Open a file in write mode without parsing the file format headers: + +`radare2 -nw {{path/to/binary}}` + +- Debug a program: + +`radare2 -d {{path/to/binary}}` + +- Run a script before entering the interactive CLI: + +`radare2 -i {{path/to/script.r2}} {{path/to/binary}}` + +- Display help text for any command in the interactive CLI: + +`> {{radare2_command}}?` + +- Run a shell command from the interactive CLI: + +`> !{{shell_command}}` + +- Dump raw bytes of current block to a file: + +`> pr > {{path/to/file.bin}}` diff --git a/rage b/rage new file mode 100644 index 00000000..682e81bf --- /dev/null +++ b/rage @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rage + +> A simple, secure and modern file encryption tool (and Rust library) with small explicit keys, no config options, and UNIX-style composability. +> Rust implementation of `age`. +> More information: . + +- Encrypt a file for `user` and save it to `message.age`: + +`echo "{{Your secret message}}" | rage --encrypt --recipient {{user}} --output {{path/to/message.age}}` + +- Decrypt a file with `identity_file` and save it to `message`: + +`rage --decrypt --identity {{path/to/identity_file}} --output {{message}}` diff --git a/rails b/rails new file mode 100644 index 00000000..5fa135e1 --- /dev/null +++ b/rails @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rails + +> A server-side MVC framework written in Ruby. +> Some subcommands such as `rails generate` have their own usage documentation. +> More information: . + +- Create a new rails project: + +`rails new "{{project_name}}"` + +- Start local server for current project on port 3000: + +`rails server` + +- Start local server for current project on a specified port: + +`rails server -p "{{port}}"` + +- Open console to interact with application from command-line: + +`rails console` + +- Check current version of rails: + +`rails --version` diff --git a/rails-db b/rails-db new file mode 100644 index 00000000..a787c9b0 --- /dev/null +++ b/rails-db @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rails db + +> Various database-related subcommands for Ruby on Rails. +> More information: . + +- Create databases, load the schema, and initialize with seed data: + +`rails db:setup` + +- Access the database console: + +`rails db` + +- Create the databases defined in the current environment: + +`rails db:create` + +- Destroy the databases defined in the current environment: + +`rails db:drop` + +- Run pending migrations: + +`rails db:migrate` + +- View the status of each migration file: + +`rails db:migrate:status` + +- Rollback the last migration: + +`rails db:rollback` + +- Fill the current database with data defined in `db/seeds.rb`: + +`rails db:seed` diff --git a/rails-destroy b/rails-destroy new file mode 100644 index 00000000..5d3c1ffc --- /dev/null +++ b/rails-destroy @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rails destroy + +> Destroy Rails resources. +> More information: . + +- List all available generators to destroy: + +`rails destroy` + +- Destroy a model named Post: + +`rails destroy model {{Post}}` + +- Destroy a controller named Posts: + +`rails destroy controller {{Posts}}` + +- Destroy a migration that creates Posts: + +`rails destroy migration {{CreatePosts}}` + +- Destroy a scaffold for a model named Post: + +`rails destroy scaffold {{Post}}` diff --git a/rails-generate b/rails-generate new file mode 100644 index 00000000..fc1ce432 --- /dev/null +++ b/rails-generate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rails generate + +> Generate new Rails templates in an existing project. +> More information: . + +- List all available generators: + +`rails generate` + +- Generate a new model named Post with attributes title and body: + +`rails generate model {{Post}} {{title:string}} {{body:text}}` + +- Generate a new controller named Posts with actions index, show, new and create: + +`rails generate controller {{Posts}} {{index}} {{show}} {{new}} {{create}}` + +- Generate a new migration that adds a category attribute to an existing model called Post: + +`rails generate migration {{AddCategoryToPost}} {{category:string}}` + +- Generate a scaffold for a model named Post, predefining the attributes title and body: + +`rails generate scaffold {{Post}} {{title:string}} {{body:text}}` diff --git a/rails-routes b/rails-routes new file mode 100644 index 00000000..18077056 --- /dev/null +++ b/rails-routes @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rails routes + +> List routes in a Rails application. +> More information: . + +- List all routes: + +`rails routes` + +- List all routes in an expanded format: + +`rails routes --expanded` + +- List routes partially matching URL helper method name, HTTP verb, or URL path: + +`rails routes -g {{posts_path|GET|/posts}}` + +- List routes that map to a specified controller: + +`rails routes -c {{posts|Posts|Blogs::PostsController}}` diff --git a/railway b/railway new file mode 100644 index 00000000..bc7a1bbb --- /dev/null +++ b/railway @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# railway + +> Connect code to a Railway project. +> More information: . + +- Login to a Railway account: + +`railway login` + +- Link to an existing Project under a Railway account or team: + +`railway link {{projectId}}` + +- Create a new project: + +`railway init` + +- Run a local command using variables from the active environment: + +`railway run {{cmd}}` + +- Deploy the linked project directory (if running from a subdirectory, the project root is still deployed): + +`railway up` + +- Open an interactive shell to a database: + +`railway connect` diff --git a/rainbowstream b/rainbowstream new file mode 100644 index 00000000..ab5546df --- /dev/null +++ b/rainbowstream @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rainbowstream + +> Terminal-based Twitter client supporting realtime tweetstream, trends, sending, search, favorites and user management. +> Online help with `h`, up and down arrows for history, tab to auto-complete and 2-tab for suggestion. +> More information: . + +- Open RainbowStream: + +`rainbowstream` + +- Show your timeline (optional number of tweets to display, default is 5): + +`home [{{num_of_last_tweets}}]` + +- Show profile of a given user: + +`whois @{{user}}` + +- Tweet the message as-is: + +`t {{message}}` + +- Retweet the tweet with given ID (ID is beside the time): + +`rt {{tweet_id}}` + +- Favorite the tweet with given ID: + +`fav {{tweet_id}}` + +- Perform a search for a given word (with or without hashtag): + +`s {{word}}` diff --git a/rake b/rake new file mode 100644 index 00000000..76137e09 --- /dev/null +++ b/rake @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rake + +> A Make-like program for Ruby. +> Tasks for `rake` are specified in a Rakefile. +> More information: . + +- Run the `default` Rakefile task: + +`rake` + +- Run a specific task: + +`rake {{task}}` + +- Execute `n` jobs at a time in parallel (number of CPU cores + 4 by default): + +`rake --jobs {{n}}` + +- Use a specific Rakefile: + +`rake --rakefile {{path/to/Rakefile}}` + +- Execute `rake` from another directory: + +`rake --directory {{path/to/directory}}` diff --git a/ranger b/ranger new file mode 100644 index 00000000..8efe467c --- /dev/null +++ b/ranger @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ranger + +> Console file manager with VI key bindings. +> More information: . + +- Launch ranger: + +`ranger` + +- Show only directories: + +`ranger --show-only-dirs` + +- Change the configuration directory: + +`ranger --confdir={{path/to/directory}}` + +- Change the data directory: + +`ranger --datadir={{path/to/directory}}` + +- Print CPU usage statistics on exit: + +`ranger --profile` diff --git a/rapper b/rapper new file mode 100644 index 00000000..19a18016 --- /dev/null +++ b/rapper @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rapper + +> The Raptor RDF parsing utility. +> Part of the Raptor RDF Syntax Library. +> More information: . + +- Convert an RDF/XML document to Turtle: + +`rapper -i rdfxml -o turtle {{path/to/file}}` + +- Count the number of triples in a Turtle file: + +`rapper -i turtle -c {{path/to/file}}` diff --git a/rar b/rar new file mode 100644 index 00000000..f141d8b5 --- /dev/null +++ b/rar @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rar + +> The RAR archiver. Supports multi-volume archives that can be optionally self-extracting. +> More information: . + +- Archive 1 or more files: + +`rar a {{path/to/archive_name.rar}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` + +- Archive a directory: + +`rar a {{path/to/archive_name.rar}} {{path/to/directory}}` + +- Split the archive into parts of equal size (50M): + +`rar a -v{{50M}} -R {{path/to/archive_name.rar}} {{path/to/file_or_directory}}` + +- Password protect the resulting archive: + +`rar a -p{{password}} {{path/to/archive_name.rar}} {{path/to/file_or_directory}}` + +- Encrypt file data and headers with password: + +`rar a -hp{{password}} {{path/to/archive_name.rar}} {{path/to/file_or_directory}}` + +- Use a specific compression level (0-5): + +`rar a -m{{compression_level}} {{path/to/archive_name.rar}} {{path/to/file_or_directory}}` diff --git a/rarcrack b/rarcrack new file mode 100644 index 00000000..9f458fa7 --- /dev/null +++ b/rarcrack @@ -0,0 +1,20 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rarcrack + +> Password cracker for `rar`, `zip` and `7z` archives. + +- Brute force the password for an archive (tries to guess the archive type): + +`rarcrack {{path/to/file.zip}}` + +- Specify the archive type: + +`rarcrack --type {{rar|zip|7z}} {{path/to/file.zip}}` + +- Use multiple threads: + +`rarcrack --threads {{6}} {{path/to/file.zip}}` diff --git a/rasttopnm b/rasttopnm new file mode 100644 index 00000000..872cb781 --- /dev/null +++ b/rasttopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rasttopnm + +> Convert a Sun rasterfile to a PNM file. +> More information: . + +- Convert a RAST image to a PNM file: + +`rasttopnm {{path/to/input.rast}} > {{path/to/output.pnm}}` + +- Use the color map indices in the raster if they are color values: + +`rasttopnm -index {{path/to/input.rast}} > {{path/to/output.pnm}}` diff --git a/rawtopgm b/rawtopgm new file mode 100644 index 00000000..adeb70cf --- /dev/null +++ b/rawtopgm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rawtopgm + +> Convert a raw greyscale image to a PGM image. +> More information: . + +- Convert a raw greyscale image to a PGM image: + +`rawtopgm {{width}} {{height}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Convert a raw greyscale image to a PGM image, assume the image to be a square: + +`rawtopgm {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Convert a raw greyscale image in which the pixels come bottom-first instead of top-first to a PGM image: + +`rawtopgm {{width}} {{height}} -bottomfirst {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Ignore the first n bytes of the specified file: + +`rawtopgm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Ignore the last m bytes of each row in the specified file: + +`rawtopgm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Specify the maxval for the grey values in the input to be equal to N: + +`rawtopgm {{width}} {{height}} -maxval {{N}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Specify the number of bytes that represent each sample in the input and that the byte-sequence is to be interpreted as little-endian: + +`rawtopgm {{width}} {{height}} -bpp {{1|2}} -littleendian {{path/to/image.raw}} > {{path/to/output.pgm}}` diff --git a/rawtoppm b/rawtoppm new file mode 100644 index 00000000..6cd10ba7 --- /dev/null +++ b/rawtoppm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rawtoppm + +> Convert a raw RGB stream to a PPM image. +> More information: . + +- Convert a raw RGB stream to a PPM image: + +`rawtoppm {{width}} {{height}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Convert a raw RGB stream in which the pixels come bottom-first instead of top-first to a PPM image: + +`rawtoppm {{width}} {{height}} {{path/to/image.raw}} | pamflip -tb > {{path/to/output.ppm}}` + +- Ignore the first n bytes of the specified file: + +`rawtoppm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Ignore the last m bytes of each row in the specified file: + +`rawtoppm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Specify the order of color components for each pixel: + +`rawtoppm {{width}} {{height}} -{{rgb|rbg|grb|gbr|brg|bgr}} {{path/to/image.raw}} > {{path/to/output.ppm}}` diff --git a/rbac-lookup b/rbac-lookup new file mode 100644 index 00000000..ed378ba4 --- /dev/null +++ b/rbac-lookup @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rbac-lookup + +> Find roles and cluster roles attached to any user, service account or group name in your Kubernetes cluster. +> More information: . + +- View all RBAC bindings: + +`rbac-lookup` + +- View RBAC bindings that match a given expression: + +`rbac-lookup {{search_term}}` + +- View all RBAC bindings along with the source role binding: + +`rbac-lookup -o wide` + +- View all RBAC bindings filtered by subject: + +`rbac-lookup -k {{user|group|serviceaccount}}` + +- View all RBAC bindings along with IAM roles (if you are using GKE): + +`rbac-lookup --gke` diff --git a/rbash b/rbash new file mode 100644 index 00000000..ca7c8c31 --- /dev/null +++ b/rbash @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rbash + +> 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: . + +- Start an interactive shell session: + +`rbash` + +- Execute a command and then exit: + +`rbash -c "{{command}}"` + +- Execute a script: + +`rbash {{path/to/script.sh}}` + +- Execute a script, printing each command before executing it: + +`rbash -x {{path/to/script.sh}}` + +- Execute commands from a script, stopping at the first error: + +`rbash -e {{path/to/script.sh}}` + +- Read and execute commands from `stdin`: + +`rbash -s` diff --git a/rbenv b/rbenv new file mode 100644 index 00000000..26b0601e --- /dev/null +++ b/rbenv @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rbenv + +> Easily install Ruby versions and manage application environments. +> See also: `asdf`. +> More information: . + +- Install a Ruby version: + +`rbenv install {{version}}` + +- Display a list of the latest stable versions for each Ruby: + +`rbenv install --list` + +- Display a list of installed Ruby versions: + +`rbenv versions` + +- Use a specific Ruby version across the whole system: + +`rbenv global {{version}}` + +- Use a specific Ruby version for an application/project directory: + +`rbenv local {{version}}` + +- Display the currently selected Ruby version: + +`rbenv version` + +- Uninstall a Ruby version: + +`rbenv uninstall {{version}}` + +- Display all Ruby versions that contain the specified executable: + +`rbenv whence {{executable}}` diff --git a/rbt b/rbt new file mode 100644 index 00000000..3a7f79b7 --- /dev/null +++ b/rbt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rbt + +> RBTools is a set of command-line tools for working with Review Board and RBCommons. +> More information: . + +- Post changes to Review Board: + +`rbt post {{change_number}}` + +- Display the diff that will be sent to Review Board: + +`rbt diff` + +- Land a change in a local branch or on a review request: + +`rbt land {{branch_name}}` + +- Patch your tree with a change on a review request: + +`rbt patch {{review_request_id}}` + +- Set up RBTool to talk to a repository: + +`rbt setup-repo` diff --git a/rc b/rc new file mode 100644 index 00000000..4bfaf529 --- /dev/null +++ b/rc @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rc + +> A modern simplistic port listener & reverse shell. +> Similar to `nc`. +> More information: . + +- Start listening on a specific port: + +`rc -lp {{port}}` + +- Start a reverse shell: + +`rc {{host}} {{port}} -r {{shell}}` diff --git a/rcat b/rcat new file mode 100644 index 00000000..284243d7 --- /dev/null +++ b/rcat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rcat + +> This command is an alias of `rc`. + +- View documentation for the original command: + +`tldr rc` diff --git a/rclone b/rclone new file mode 100644 index 00000000..7951e95e --- /dev/null +++ b/rclone @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rclone + +> Copy, synchronize or move files and directories to and from many cloud services. +> More information: . + +- Launch an interactive menu to setup rclone: + +`rclone config` + +- List contents of a directory on an rclone remote: + +`rclone lsf {{remote_name}}:{{path/to/directory}}` + +- Copy a file or directory from the local machine to the remote destination: + +`rclone copy {{path/to/source_file_or_directory}} {{remote_name}}:{{path/to/directory}}` + +- Copy files changed within the past 24 hours to a remote from the local machine, asking the user to confirm each file: + +`rclone copy --interactive --max-age 24h {{remote_name}}:{{path/to/directory}} {{path/to/local_directory}} ` + +- Mirror a specific file or directory (Note: Unlike copy, sync removes files from the remote if it does not exist locally): + +`rclone sync {{path/to/file_or_directory}} {{remote_name}}:{{path/to/directory}}` + +- Delete a remote file or directory (Note: `--dry-run` means test, remove it from the command to actually delete): + +`rclone --dry-run delete {{remote_name}}:{{path/to/file_or_directory}}` + +- Mount rclone remote (experimental): + +`rclone mount {{remote_name}}:{{path/to/directory}} {{path/to/mount_point}}` + +- Unmount rclone remote if CTRL-C fails (experimental): + +`fusermount -u {{path/to/mount_point}}` diff --git a/rdfind b/rdfind new file mode 100644 index 00000000..192c4089 --- /dev/null +++ b/rdfind @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rdfind + +> Find files with duplicate content and get rid of them. +> More information: . + +- Identify all duplicates in a given directory and output a summary: + +`rdfind -dryrun true {{path/to/directory}}` + +- Replace all duplicates with hardlinks: + +`rdfind -makehardlinks true {{path/to/directory}}` + +- Replace all duplicates with symlinks/soft links: + +`rdfind -makesymlinks true {{path/to/directory}}` + +- Delete all duplicates and do not ignore empty files: + +`rdfind -deleteduplicates true -ignoreempty false {{path/to/directory}}` diff --git a/react-native b/react-native new file mode 100644 index 00000000..02ae85c4 --- /dev/null +++ b/react-native @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# react-native + +> A framework for building native apps with React. +> More information: . + +- Initialize a new React Native project in a directory of the same name: + +`react-native init {{project_name}}` + +- Start the metro bundler: + +`react-native start` + +- Start the metro bundler with a clean cache: + +`react-native start --reset-cache` + +- Build the current application and start it on a connected Android device or emulator: + +`react-native run-android` + +- Build the current application and start it on an iOS simulator: + +`react-native run-ios` + +- Build the current application in `release` mode and start it on a connected Android device or emulator: + +`react-native run-android --variant={{release}}` + +- Start `logkitty` and print logs to `stdout`: + +`react-native log-android` + +- Start `tail system.log` for an iOS simulator and print logs to `stdout`: + +`react-native log-ios` diff --git a/react-native-start b/react-native-start new file mode 100644 index 00000000..29405569 --- /dev/null +++ b/react-native-start @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# react-native start + +> Command-line tools to start the React Native server. +> More information: . + +- Start the server that communicates with connected devices: + +`react-native start` + +- Start the metro bundler with a clean cache: + +`react-native start --reset-cache` + +- Start the server in a custom port (defaults to 8081): + +`react-native start --port {{3000}}` + +- Start the server in verbose mode: + +`react-native start --verbose` + +- Specify the maximum number of workers for transforming files (default is the number of CPU cores): + +`react-native start --max-workers {{count}}` + +- Disable interactive mode: + +`react-native start --no-interactive` diff --git a/read b/read new file mode 100644 index 00000000..459b6403 --- /dev/null +++ b/read @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# read + +> Shell builtin for retrieving data from `stdin`. +> More information: . + +- Store data that you type from the keyboard: + +`read {{variable}}` + +- Do not let backslash (\) act as an escape character: + +`read -r {{variable}}` + +- Read `stdin` and perform an action on every line: + +`while read line; do echo "$line"; done` diff --git a/readlink b/readlink new file mode 100644 index 00000000..02d851c2 --- /dev/null +++ b/readlink @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# readlink + +> Follow symlinks and get symlink information. +> More information: . + +- Get the actual file to which the symlink points: + +`readlink {{path/to/file}}` + +- Get the absolute path to a file: + +`readlink -f {{path/to/file}}` diff --git a/readonly b/readonly new file mode 100644 index 00000000..d6b657c1 --- /dev/null +++ b/readonly @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# readonly + +> Set read-only shell variables. +> More information: . + +- Set a read-only variable: + +`readonly {{variable_name}}={{value}}` + +- Mark a variable as read-only: + +`readonly {{existing_variable}}` + +- [p]rint the names and values of all read-only variables to `stdout`: + +`readonly -p` diff --git a/realpath b/realpath new file mode 100644 index 00000000..b4d2559b --- /dev/null +++ b/realpath @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# realpath + +> Display the resolved absolute path for a file or directory. +> More information: . + +- Display the absolute path for a file or directory: + +`realpath {{path/to/file_or_directory}}` + +- Require all path components to exist: + +`realpath --canonicalize-existing {{path/to/file_or_directory}}` + +- Resolve ".." components before symlinks: + +`realpath --logical {{path/to/file_or_directory}}` + +- Disable symlink expansion: + +`realpath --no-symlinks {{path/to/file_or_directory}}` + +- Suppress error messages: + +`realpath --quiet {{path/to/file_or_directory}}` diff --git a/recsel b/recsel new file mode 100644 index 00000000..e46932a5 --- /dev/null +++ b/recsel @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# recsel + +> Print records from a recfile: a human-editable, plain text database. +> More information: . + +- Extract name and version field: + +`recsel -p name,version {{data.rec}}` + +- Use "~" to match a string with a given regular expression: + +`recsel -e "{{field_name}} ~ '{{regular_expression}}' {{data.rec}}"` + +- Use a predicate to match a name and a version: + +`recsel -e "name ~ '{{regular_expression}}' && version ~ '{{regular_expression}}'" {{data.rec}}` diff --git a/rector b/rector new file mode 100644 index 00000000..e4b91bd5 --- /dev/null +++ b/rector @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rector + +> An automated tool for updating and refactoring PHP 5.3+ code. +> More information: . + +- Process a specific directory: + +`rector process {{path/to/directory}}` + +- Process a directory without applying changes (dry run): + +`rector process {{path/to/directory}} --dry-run` + +- Process a directory and apply coding standards: + +`rector process {{path/to/directory}} --with-style` + +- Display a list of available levels: + +`rector levels` + +- Process a directory with a specific level: + +`rector process {{path/to/directory}} --level {{level_name}}` diff --git a/redis-benchmark b/redis-benchmark new file mode 100644 index 00000000..afa24b1c --- /dev/null +++ b/redis-benchmark @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# redis-benchmark + +> Benchmark a Redis server. +> More information: . + +- Run full benchmark: + +`redis-benchmark` + +- Run benchmark on a specific Redis server: + +`redis-benchmark -h {{host}} -p {{port}} -a {{password}}` + +- Run a subset of tests with default 100000 requests: + +`redis-benchmark -h {{host}} -p {{port}} -t {{set,lpush}} -n {{100000}}` + +- Run with a specific script: + +`redis-benchmark -n {{100000}} script load "{{redis.call('set', 'foo', 'bar')}}"` + +- Run benchmark by using 100000 [r]andom keys: + +`redis-benchmark -t {{set}} -r {{100000}}` + +- Run benchmark by using a [P]ipelining of 16 commands: + +`redis-benchmark -n {{1000000}} -t {{set,get}} -P {{16}}` + +- Run benchmark [q]uietly and only show query per seconds result: + +`redis-benchmark -q` diff --git a/redis-cli b/redis-cli new file mode 100644 index 00000000..0b7368a8 --- /dev/null +++ b/redis-cli @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# redis-cli + +> Opens a connection to a Redis server. +> More information: . + +- Connect to the local server: + +`redis-cli` + +- Connect to a remote server on the default port (6379): + +`redis-cli -h {{host}}` + +- Connect to a remote server specifying a port number: + +`redis-cli -h {{host}} -p {{port}}` + +- Connect to a remote server specifying a URI: + +`redis-cli -u {{uri}}` + +- Specify a password: + +`redis-cli -a {{password}}` + +- Execute Redis command: + +`redis-cli {{redis_command}}` + +- Connect to the local cluster: + +`redis-cli -c` diff --git a/redis-server b/redis-server new file mode 100644 index 00000000..ab8b0173 --- /dev/null +++ b/redis-server @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# redis-server + +> Persistent key-value database. +> More information: . + +- Start Redis server, using the default port (6379), and write logs to `stdout`: + +`redis-server` + +- Start Redis server, using the default port, as a background process: + +`redis-server --daemonize yes` + +- Start Redis server, using the specified port, as a background process: + +`redis-server --port {{port}} --daemonize yes` + +- Start Redis server with a custom configuration file: + +`redis-server {{path/to/redis.conf}}` + +- Start Redis server with verbose logging: + +`redis-server --loglevel {{warning|notice|verbose|debug}}` diff --git a/redshift b/redshift new file mode 100644 index 00000000..39018b48 --- /dev/null +++ b/redshift @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# redshift + +> Adjust the color temperature of your screen according to your surroundings. +> More information: . + +- Turn on Redshift with a specific [t]emperature during day (e.g., 5700K) and at night (e.g., 3600K): + +`redshift -t {{5700}}:{{3600}}` + +- Turn on Redshift with a manually specified custom [l]ocation: + +`redshift -l {{latitude}}:{{longitude}}` + +- Turn on Redshift with a specific screen [b]rightness during the day (e.g, 70%) and at night (e.g., 40%): + +`redshift -b {{0.7}}:{{0.4}}` + +- Turn on Redshift with custom [g]amma levels (between 0 and 1): + +`redshift -g {{red}}:{{green}}:{{blue}}` + +- Turn on Redshift with a constant unchanging color temperature: + +`redshift -O {{temperature}}` diff --git a/reflac b/reflac new file mode 100644 index 00000000..7b3ad55e --- /dev/null +++ b/reflac @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# reflac + +> Recompress FLAC files in-place while preserving metadata. +> More information: . + +- Recompress a directory of FLAC files: + +`reflac {{path/to/directory}}` + +- Enable maximum compression (very slow): + +`reflac --best {{path/to/directory}}` + +- Display filenames as they are processed: + +`reflac --verbose {{path/to/directory}}` + +- Recurse into subdirectories: + +`reflac --recursive {{path/to/directory}}` + +- Preserve file modification times: + +`reflac --preserve {{path/to/directory}}` diff --git a/reflex b/reflex new file mode 100644 index 00000000..30f4e620 --- /dev/null +++ b/reflex @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# reflex + +> Watch a directory and rerun a command when certain files change. +> More information: . + +- Rebuild with `make` if any file changes: + +`reflex make` + +- Compile and run Go application if any `.go` file changes: + +`reflex --regex='{{\.go$}}' {{go run .}}` + +- Ignore a directory when watching for changes: + +`reflex --inverse-regex='{{^dir/}}' {{command}}` + +- Run command when reflex starts and restarts on file changes: + +`reflex --start-service=true {{command}}` + +- Substitute the filename that changed in: + +`reflex -- echo {}` diff --git a/rekor-cli b/rekor-cli new file mode 100644 index 00000000..9f3f1f1f --- /dev/null +++ b/rekor-cli @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rekor-cli + +> Immutable tamper resistant ledger of metadata generated within a software projects supply chain. +> More information: . + +- Upload an artifact to Rekor: + +`rekor-cli upload --artifact {{path/to/file.ext}} --signature {{path/to/file.ext.sig}} --pki-format={{x509}} --public-key={{path/to/key.pub}}` + +- Get information regarding entries in the Transparency Log: + +`rekor-cli get --uuid={{0e81b4d9299e2609e45b5c453a4c0e7820ac74e02c4935a8b830d104632fd2d1}}` + +- Search the Rekor index to find entries by Artifact: + +`rekor-cli search --artifact {{path/to/file.ext}}` + +- Search the Rekor index to find entries by a specific hash: + +`rekor-cli search --sha {{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}}` diff --git a/remove-nodeversion b/remove-nodeversion new file mode 100644 index 00000000..d53dd871 --- /dev/null +++ b/remove-nodeversion @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Remove-NodeVersion + +> Uninstall Node.js runtime versions for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Uninstall a given Node.js version: + +`Remove-NodeVersion {{node_version}}` + +- Uninstall multiple Node.js versions: + +`Remove-NodeVersion {{node_version1 , node_version2 , ...}}` + +- Uninstall all currently-installed versions of Node.js 20.x: + +`Get-NodeVersions -Filter ">=20.0.0 <21.0.0" | Remove-NodeVersion` + +- Uninstall all currently-installed versions of Node.js: + +`Get-NodeVersions | Remove-NodeVersion` diff --git a/renice b/renice new file mode 100644 index 00000000..f9eb45fd --- /dev/null +++ b/renice @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# renice + +> Alter the scheduling priority/niceness of running processes. +> Niceness values range from -20 (most favorable to the process) to 19 (least favorable to the process). +> See also: `nice`. +> More information: . + +- Increase/decrease the priority of a running [p]rocess: + +`renice -n {{3}} -p {{pid}}` + +- Increase/decrease the priority of all processes owned by a [u]ser: + +`renice -n {{-4}} -u {{uid|user}}` + +- Increase/decrease the priority of all processes that belong to a process [g]roup: + +`renice -n {{5}} -g {{process_group}}` diff --git a/repren b/repren new file mode 100644 index 00000000..505a691e --- /dev/null +++ b/repren @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# repren + +> Multi-pattern string replacement and file renaming tool. +> More information: . + +- Do a dry-run renaming a directory of PNGs with a literal string replacement: + +`repren --dry-run --rename --literal --from '{{find_string}}' --to '{{replacement_string}}' {{*.png}}` + +- Do a dry-run renaming a directory of JPEGs with a regular expression: + +`repren --rename --dry-run --from '{{regular_expression}}' --to '{{replacement_string}}' {{*.jpg}} {{*.jpeg}}` + +- Do a find-and-replace on the contents of a directory of CSV files: + +`repren --from '{{([0-9]+) example_string}}' --to '{{replacement_string \1}}' {{*.csv}}` + +- Do both a find-and-replace and a rename operation at the same time, using a pattern file: + +`repren --patterns {{path/to/patfile.ext}} --full {{*.txt}}` + +- Do a case-insensitive rename: + +`repren --rename --insensitive --patterns {{path/to/patfile.ext}} *` diff --git a/resolvconf b/resolvconf new file mode 100644 index 00000000..c33e7275 --- /dev/null +++ b/resolvconf @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# resolvconf + +> Manage nameserver information. +> Acts as an intermediary between programs that supply nameserver information and applications that use this information. +> This page documents Debian's implementation of `resolvconf`. +> More information: . + +- Add or override the IFACE.PROG record and run the update scripts if updating is enabled: + +`resolvconf -a {{IFACE.PROG}}` + +- Delete the IFACE.PROG record and run the update scripts if updating is enabled: + +`resolvconf -d {{IFACR.PROG}}` + +- Just run the update scripts if updating is enabled: + +`resolvconf -u` + +- Set the flag indicating whether `resolvconf` should run update scripts when invoked with `-a`, `-d` or `-u`: + +`resolvconf --enable-updates` + +- Clear the flag indicating whether to run updates: + +`resolvconf --disable-updates` + +- Check whether updates are enabled: + +`resolvconf --updates-are-enabled` diff --git a/restic b/restic new file mode 100644 index 00000000..479f5519 --- /dev/null +++ b/restic @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# restic + +> A fast, secure and secure backup program. +> More information: . + +- Initialize a backup repository in the specified local directory: + +`restic init --repo {{path/to/repository}}` + +- Backup a directory to the repository: + +`restic --repo {{path/to/repository}} backup {{path/to/directory}}` + +- Show backup snapshots currently stored in the repository: + +`restic --repo {{path/to/repository}} snapshots` + +- Restore a specific backup snapshot to a target directory: + +`restic --repo {{path/to/repository}} restore {{latest|snapshot_id}} --target {{path/to/target}}` + +- Restore a specific path from a specific backup to a target directory: + +`restic --repo {{path/to/repository}} restore {{snapshot_id}} --target {{path/to/target}} --include {{path/to/restore}}` + +- Clean up the repository and keep only the most recent snapshot of each unique backup: + +`restic forget --keep-last 1 --prune` diff --git a/resume b/resume new file mode 100644 index 00000000..b3df50f9 --- /dev/null +++ b/resume @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# resume + +> Easily setup a new resume. +> More information: . + +- Create a new `resume.json` file in the current working directory: + +`resume init` + +- Validate a `resume.json` against schema tests to ensure it complies with the standard: + +`resume validate` + +- Export a resume locally in a stylized HTML or PDF format: + +`resume export {{path/to/html_or_pdf}}` + +- Start a web server that serves a local `resume.json`: + +`resume serve` diff --git a/retry b/retry new file mode 100644 index 00000000..998028a3 --- /dev/null +++ b/retry @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# retry + +> Repeat command until it succeeds or a criterion is met. +> More information: . + +- Retry a command until it succeeds: + +`retry {{command}}` + +- Retry a command every n seconds until it succeeds: + +`retry --delay={{n}} {{command}}` + +- Give up after n attempts: + +`retry --times={{n}} {{command}}` diff --git a/rev b/rev new file mode 100644 index 00000000..2f56c0fa --- /dev/null +++ b/rev @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rev + +> Reverse a line of text. +> More information: . + +- Reverse the text string "hello": + +`echo "hello" | rev` + +- Reverse an entire file and print to `stdout`: + +`rev {{path/to/file}}` diff --git a/rfetch b/rfetch new file mode 100644 index 00000000..4f6788c6 --- /dev/null +++ b/rfetch @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rfetch + +> A configurable fetch program to output system information. +> More information: . + +- Display system information: + +`rfetch` + +- Display system [a]rchitecture: + +`rfetch -a` + +- Display system up[t]ime: + +`rfetch -t` + +- Display system [k]ernel: + +`rfetch -k` + +- Display system [c]PU: + +`rfetch -c` + +- Display Linux [D]istro: + +`rfetch -D` + +- View [d]esktop environment: + +`rfetch -d` diff --git a/rg b/rg new file mode 100644 index 00000000..7a6ee4c5 --- /dev/null +++ b/rg @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rg + +> Ripgrep is a recursive line-oriented search tool. +> Aims to be a faster alternative to `grep`. +> More information: . + +- Recursively search the current directory for a regular expression: + +`rg {{regular_expression}}` + +- Search for regular expressions recursively in the current directory, including hidden files and files listed in `.gitignore`: + +`rg --no-ignore --hidden {{regular_expression}}` + +- Search for a regular expression only in a subset of directories: + +`rg {{regular_expression}} {{set_of_subdirs}}` + +- Search for a regular expression in files matching a glob (e.g. `README.*`): + +`rg {{regular_expression}} --glob {{glob}}` + +- Search for filenames that match a regular expression: + +`rg --files | rg {{regular_expression}}` + +- Only list matched files (useful when piping to other commands): + +`rg --files-with-matches {{regular_expression}}` + +- Show lines that do not match the given regular expression: + +`rg --invert-match {{regular_expression}}` + +- Search a literal string pattern: + +`rg --fixed-strings -- {{string}}` diff --git a/rga b/rga new file mode 100644 index 00000000..4f8d2e38 --- /dev/null +++ b/rga @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rga + +> Ripgrep wrapper with rich file type searching capabilities. +> More information: . + +- Search recursively for a pattern in all files in the current directory: + +`rga {{regular_expression}}` + +- List available adapters: + +`rga --rga-list-adapters` + +- Change which adapters to use (e.g. ffmpeg, pandoc, poppler etc.): + +`rga --rga-adapters={{adapter1,adapter2}} {{regular_expression}}` + +- Search for a pattern using the mime type instead of the file extension (slower): + +`rga --rga-accurate {{regular_expression}}` + +- Display help: + +`rga --help` diff --git a/rgpt b/rgpt new file mode 100644 index 00000000..3703d9a3 --- /dev/null +++ b/rgpt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rgpt + +> An automated code review tool that uses GPT you can use straight from your terminal. +> More information: . + +- Ask GPT to improve the code with no extra options: + +`rgpt --i "$(git diff {{path/to/file}})"` + +- Get a more detailed verbose output from `rgpt` while reviewing the code: + +`rgpt --v --i "$(git diff {{path/to/file}})"` + +- Ask GPT to improve the code and limit it to a certain amount of GPT3 tokens: + +`rgpt --max {{300}} --i "$(git diff {{path/to/file}})"` + +- Ask GPT for a more unique result using a float value between 0 and 2. (higher = more unique): + +`rgpt --pres {{1.2}} --i "$(git diff {{path/to/file}})"` + +- Ask GPT to review your code using a specific model: + +`rgpt --model {{davinci}} --i "$(git diff {{path/to/file}})"` + +- Make `rgpt` use a JSON output: + +`rgpt --json --i "$(git diff {{path/to/file}})"` diff --git a/rgrep b/rgrep new file mode 100644 index 00000000..edf6974d --- /dev/null +++ b/rgrep @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rgrep + +> Recursively find patterns in files using regular expressions. +> Equivalent to `grep -r`. +> More information: . + +- Recursively search for a pattern in the current working directory: + +`rgrep "{{search_pattern}}"` + +- Recursively search for a case-insensitive pattern in the current working directory: + +`rgrep --ignore-case "{{search_pattern}}"` + +- Recursively search for an extended regular expression pattern (supports `?`, `+`, `{}`, `()` and `|`) in the current working directory: + +`rgrep --extended-regexp "{{search_pattern}}"` + +- Recursively search for an exact string (disables regular expressions) in the current working directory: + +`rgrep --fixed-strings "{{exact_string}}"` + +- Recursively search for a pattern in a specified directory (or file): + +`rgrep "{{search_pattern}}" {{path/to/file_or_directory}}` diff --git a/rhash b/rhash new file mode 100644 index 00000000..eb10a27b --- /dev/null +++ b/rhash @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rhash + +> Calculate or check common message digests. +> More information: . + +- Calculate default CRC32 digests of a file: + +`rhash {{path/to/file}}` + +- Recursively process a directory to generate an SFV file using SHA1: + +`rhash --sha1 --recursive {{path/to/folder}} > {{path/to/output.sfv}}` + +- Verify the integrity of files based on an SFV file: + +`rhash --check {{path/to/file.sfv}}` + +- Calculate the SHA3 digest of a text message: + +`rhash --sha3-256 --message '{{message}}'` + +- Calculate CRC32 digest of a file and output digest encoded in base64 using BSD format: + +`rhash --base64 --bsd {{path/to/file}}` + +- Use custom output template: + +`rhash --printf '{{%p %s %{mtime} %m +}}' {{path/to/file}}` diff --git a/rich b/rich new file mode 100644 index 00000000..ce9f316a --- /dev/null +++ b/rich @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rich + +> A toolbox for fancy output in the terminal. +> More information: . + +- Display a file with syntax highlighting: + +`rich {{path/to/file.py}}` + +- Add line numbers, and indentation guides: + +`rich {{path/to/file.py}} --line-number --guides` + +- Apply a theme: + +`rich {{path/to/file.py}} --theme {{monokai}}` + +- Display a file in an interactive pager: + +`rich {{path/to/file.py}} --pager` + +- Display contents from a URL: + +`rich {{https://raw.githubusercontent.com/Textualize/rich-cli/main/README.md}} --markdown --pager` + +- Export a file as HTML: + +`rich {{path/to/file.md}} --export-html {{path/to/file.html}}` + +- Display text with formatting tags, custom alignment, and line width: + +`rich --print {{"Hello [green on black]Stylized[/green on black] [bold]World[/bold]"}} --{{left|center|right}} --width {{10}}` diff --git a/rip b/rip new file mode 100644 index 00000000..16324924 --- /dev/null +++ b/rip @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rip + +> Remove files or directories by sending them to the graveyard, allowing for them to be recovered. +> More information: . + +- Remove files or directories from specified locations and place them in the graveyard: + +`rip {{path/to/file_or_directory}} {{path/to/another/file_or_directory}}` + +- Interactively remove files or directories, with a prompt before every removal: + +`rip --inspect {{path/to/file_or_directory}} {{path/to/another/file_or_directory}}` + +- List all files and directories in the graveyard that were originally within the current directory: + +`rip --seance` + +- Permanently delete every file and directory in the graveyard: + +`rip --decompose` + +- Put back the files and directories which were affected by the most recent removal: + +`rip --unbury` + +- Put back every file and directory that is listed by `rip --seance`: + +`rip --seance --unbury` diff --git a/ripgrep b/ripgrep new file mode 100644 index 00000000..fba8b2da --- /dev/null +++ b/ripgrep @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ripgrep + +> `ripgrep` is the common name for the command `rg`. + +- View documentation for the original command: + +`tldr rg` diff --git a/rletopnm b/rletopnm new file mode 100644 index 00000000..6e119204 --- /dev/null +++ b/rletopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rletopnm + +> Convert a Utah Raster Tools RLE image file to a PNM file. +> More information: . + +- Convert an RLE image to a PNM file: + +`rletopnm {{path/to/input.rle}} > {{path/to/output.pnm}}` + +- Create a PGM image containing the RLE file's alpha channel: + +`rletopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input.rle}} > {{path/to/output.pnm}}` + +- Operate in verbose mode and print the contents of the RLE header to `stdout`: + +`rletopnm -verbose {{path/to/input.rle}} > {{path/to/output.pnm}}` diff --git a/rlwrap b/rlwrap new file mode 100644 index 00000000..2e4da204 --- /dev/null +++ b/rlwrap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rlwrap + +> Add line editing, persistent history and prompt completion to a REPL command. +> More information: . + +- Run a REPL command with line editing, persistent history and prompt completion: + +`rlwrap {{command}}` + +- Use all words seen on input and output for prompt completion: + +`rlwrap --remember {{command}}` + +- Better prompt completion if prompts contain ANSI colour codes: + +`rlwrap --ansi-colour-aware {{command}}` + +- Enable filename completion (case sensitive): + +`rlwrap --complete-filenames {{command}}` + +- Add coloured prompts, use colour name, or an ASCI-conformant colour specification. Use an uppercase colour name for bold styling: + +`rlwrap --prompt-colour={{black|red|green|yellow|blue|cyan|purple|white|colour_spec}} {{command}}` diff --git a/rm b/rm new file mode 100644 index 00000000..23e6002c --- /dev/null +++ b/rm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rm + +> Remove files or directories. +> See also: `rmdir`. +> More information: . + +- Remove specific files: + +`rm {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files ignoring nonexistent ones: + +`rm -f {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files interactively prompting before each removal: + +`rm -i {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files printing info about each removal: + +`rm -v {{path/to/file1 path/to/file2 ...}}` + +- Remove specific files and directories recursively: + +`rm -r {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/rmdir b/rmdir new file mode 100644 index 00000000..3c793b1f --- /dev/null +++ b/rmdir @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rmdir + +> Remove directories without files. +> See also: `rm`. +> More information: . + +- Remove specific directories: + +`rmdir {{path/to/directory1 path/to/directory2 ...}}` + +- Remove specific nested directories recursively: + +`rmdir -p {{path/to/directory1 path/to/directory2 ...}}` diff --git a/rmlint b/rmlint new file mode 100644 index 00000000..58a8eaeb --- /dev/null +++ b/rmlint @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rmlint + +> Find space waste and other broken things on your filesystem. +> More information: . + +- Check directories for duplicated, empty and broken files: + +`rmlint {{path/to/directory1 path/to/directory2 ...}}` + +- Check for space wasters, preferably keeping files in tagged directories (after the double slash): + +`rmlint {{path/to/directory}} // {{path/to/original_directory}}` + +- Check for space wasters, keeping everything in the untagged directories: + +`rmlint --keep-all-untagged {{path/to/directory}} // {{path/to/original_directory}}` + +- Delete duplicate files found by an execution of `rmlint`: + +`./rmlint.sh` + +- Find duplicate directory trees: + +`rmlint --merge-directories {{path/to/directory}}` + +- Mark files at lower path [d]epth as originals, on tie choose shorter [l]ength: + +`rmlint --rank-by={{dl}} {{path/to/directory}}` + +- Find only duplicates that have the same filename in addition to the same contents: + +`rmlint --match-basename {{path/to/directory}}` + +- Find only duplicates that have the same extension in addition to the same contents: + +`rmlint --match-extension {{path/to/directory}}` diff --git a/roave-backward-compatibility-check b/roave-backward-compatibility-check new file mode 100644 index 00000000..98c33905 --- /dev/null +++ b/roave-backward-compatibility-check @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# roave-backward-compatibility-check + +> Verify backward compatibility breaks between two versions of a PHP library. +> More information: . + +- Check for breaking changes since the last tag: + +`roave-backward-compatibility-check` + +- Check for breaking changes since a specific tag: + +`roave-backward-compatibility-check --from={{git_reference}}` + +- Check for breaking changes between the last tag and a specific reference: + +`roave-backward-compatibility-check --to={{git_reference}}` + +- Check for breaking changes and output to Markdown: + +`roave-backward-compatibility-check --format=markdown > {{results.md}}` diff --git a/robo b/robo new file mode 100644 index 00000000..98f870cb --- /dev/null +++ b/robo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# robo + +> PHP task runner. +> More information: . + +- List available commands: + +`robo list` + +- Run a specific command: + +`robo {{foo}}` + +- Simulate running a specific command: + +`robo --simulate {{foo}}` diff --git a/roll b/roll new file mode 100644 index 00000000..c13b6559 --- /dev/null +++ b/roll @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# roll + +> Rolls a user-defined dice sequence. +> More information: . + +- Roll 3 6-sided dice and sums the results: + +`roll {{3d}}` + +- Roll 1 8-sided die, add 3 and sum the results: + +`roll {{d8 + 3}}` + +- Roll 4 6-sided dice, keep the 3 highest results and sum the results: + +`roll {{4d6h3}}` + +- Roll 2 12-sided dice 2 times and show every roll: + +`roll --verbose {{2{2d12}}}` + +- Roll 2 20-sided dice until the result is bigger than 10: + +`roll "{{2d20>10}}"` + +- Roll 2 5-sided dice 3 times and show the total sum: + +`roll --sum-series {{3{2d5}}}` diff --git a/ropgadget b/ropgadget new file mode 100644 index 00000000..9ff5816d --- /dev/null +++ b/ropgadget @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ROPgadget + +> Find ROP gadgets in binary files. +> More information: . + +- List gadgets in the binary file: + +`ROPgadget --binary {{path/to/binary}}` + +- Filter gadgets in the binary file by a regular expression: + +`ROPgadget --binary {{path/to/binary}} --re {{regex}}` + +- List gadgets in the binary file, excluding specified type: + +`ROPgadget --binary {{path/to/binary}} --{{norop|nojob|nosys}}` + +- Exclude bad byte gadgets in the binary file: + +`ROPgadget --binary {{path/to/binary}} --badbytes {{byte_string}}` + +- List gadgets up to the specified number of bytes in the binary file: + +`ROPgadget --binary {{path/to/binary}} --depth {{nbyte}}` diff --git a/ropper b/ropper new file mode 100644 index 00000000..fc6e3251 --- /dev/null +++ b/ropper @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ropper + +> Find ROP gadgets in binary files. +> More information: . + +- List gadgets in the binary file: + +`ropper --file {{path/to/binary}}` + +- Filter gadgets in the binary file by a regular expression: + +`ropper --file {{path/to/binary}} --search {{regex}}` + +- List gadgets of specified type in the binary file: + +`ropper --file {{path/to/binary}} --type {{rop|job|sys|all}}` + +- Exclude bad byte gadgets in the binary file: + +`ropper --file {{path/to/binary}} --badbytes {{byte_string}}` + +- List gadgets up to the specified instruction count in the binary file: + +`ropper --file {{path/to/binary}} --inst-count {{count}}` diff --git a/route b/route new file mode 100644 index 00000000..70e4e5e6 --- /dev/null +++ b/route @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# route + +> Use route cmd to set the route table. +> More information: . + +- Display the information of route table: + +`route -n` + +- Add route rule: + +`sudo route add -net {{ip_address}} netmask {{netmask_address}} gw {{gw_address}}` + +- Delete route rule: + +`sudo route del -net {{ip_address}} netmask {{netmask_address}} dev {{gw_address}}` diff --git a/rpi-imager b/rpi-imager new file mode 100644 index 00000000..67621a37 --- /dev/null +++ b/rpi-imager @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rpi-imager + +> Flash images onto storage devices. +> More information: . + +- Write a specific image to a specific block device: + +`rpi-imager --cli {{path/to/image.zip}} {{/dev/sdX}}` + +- Write a specific image to a block device, disabling the checksum verification: + +`rpi-imager --cli --disable-verify {{path/to/image.zip}} {{/dev/sdX}}` + +- Write a specific image to a block device, which will expect a specific checksum when running the verification: + +`rpi-imager --cli --sha256 {{expected_hash}} {{path/to/image.zip}} {{/dev/sdX}}` diff --git a/rr b/rr new file mode 100644 index 00000000..d8c44af3 --- /dev/null +++ b/rr @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rr + +> Debugging tool designed to record and replay program execution. +> More information: . + +- Record an application: + +`rr record {{path/to/binary --arg1 --arg2}}` + +- Replay latest recorded execution: + +`rr replay` diff --git a/rscript b/rscript new file mode 100644 index 00000000..ff4ad036 --- /dev/null +++ b/rscript @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Rscript + +> Run a script with the R programming language. +> More information: . + +- Run a script: + +`Rscript {{path/to/file.R}}` + +- Run a script in vanilla mode (i.e. a blank session that doesn't save the workspace at the end): + +`Rscript --vanilla {{path/to/file.R}}` + +- Execute one or more R expressions: + +`Rscript -e {{expression1}} -e {{expression2}}` + +- Display R version: + +`Rscript --version` diff --git a/rspec b/rspec new file mode 100644 index 00000000..fb332c0b --- /dev/null +++ b/rspec @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rspec + +> Behavior-driven development testing framework written in Ruby to test Ruby code. +> More information: . + +- Initialize an .rspec configuration and a spec helper file: + +`rspec --init` + +- Run all tests: + +`rspec` + +- Run a specific directory of tests: + +`rspec {{path/to/directory}}` + +- Run one or more test files: + +`rspec {{path/to/file1 path/to/file2 ...}}` + +- Run a specific test in a file (e.g. the test starts on line 83): + +`rspec {{path/to/file}}:{{83}}` + +- Run specs with a specific seed: + +`rspec --seed {{seed_number}}` diff --git a/rss2email b/rss2email new file mode 100644 index 00000000..054a3de4 --- /dev/null +++ b/rss2email @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rss2email + +> Deliver news from RSS feeds to an email program. +> More information: . + +- List all feeds: + +`r2e list` + +- Convert RSS entries to email: + +`r2e run` + +- Add a feed: + +`r2e add {{feed_address}}` + +- Add a feed with a specific email address: + +`r2e add {{feed_address}} {{new_email@example.com}}` + +- Delete a specific feed: + +`r2e delete {{number_of_feed_in_list}}` + +- Display help: + +`r2e -h` diff --git a/rsstail b/rsstail new file mode 100644 index 00000000..e16b5395 --- /dev/null +++ b/rsstail @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rsstail + +> `tail` for RSS feeds. +> More information: . + +- Show the feed of a given URL and wait for new entries appearing at the bottom: + +`rsstail -u {{url}}` + +- Show the feed in reverse chronological order (newer at the bottom): + +`rsstail -r -u {{url}}` + +- Include publication date and link: + +`rsstail -pl -u {{url}}` + +- Set update interval: + +`rsstail -u {{url}} -i {{interval_in_seconds}}` + +- Show feed and exit: + +`rsstail -1 -u {{url}}` diff --git a/rsync b/rsync new file mode 100644 index 00000000..de209ca7 --- /dev/null +++ b/rsync @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rsync + +> Transfer files either to or from a remote host (but not between two remote hosts), by default using SSH. +> To specify a remote path, use `user@host:path/to/file_or_directory`. +> More information: . + +- Transfer a file: + +`rsync {{path/to/source}} {{path/to/destination}}` + +- Use archive mode (recursively copy directories, copy symlinks without resolving, and preserve permissions, ownership and modification times): + +`rsync --archive {{path/to/source}} {{path/to/destination}}` + +- Compress the data as it is sent to the destination, display verbose and human-readable progress, and keep partially transferred files if interrupted: + +`rsync --compress --verbose --human-readable --partial --progress {{path/to/source}} {{path/to/destination}}` + +- Recursively copy directories: + +`rsync --recursive {{path/to/source}} {{path/to/destination}}` + +- Transfer directory contents, but not the directory itself: + +`rsync --recursive {{path/to/source}}/ {{path/to/destination}}` + +- Use archive mode, resolve symlinks and skip files that are newer on the destination: + +`rsync --archive --update --copy-links {{path/to/source}} {{path/to/destination}}` + +- Transfer a directory to a remote host running `rsyncd` and delete files on the destination that do not exist on the source: + +`rsync --recursive --delete rsync://{{host}}:{{path/to/source}} {{path/to/destination}}` + +- Transfer a file over SSH using a different port than the default (22) and show global progress: + +`rsync --rsh 'ssh -p {{port}}' --info=progress2 {{host}}:{{path/to/source}} {{path/to/destination}}` diff --git a/rtl_sdr b/rtl_sdr new file mode 100644 index 00000000..a07ef2b2 --- /dev/null +++ b/rtl_sdr @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rtl_sdr + +> Raw data recorder for RTL-SDR receivers. +> Data is encoded using I/Q sampling (aka quadrature sampling). +> More information: . + +- Save RAW data from a frequency (specified in Hz) to a file: + +`rtl_sdr -f {{100000000}} {{path/to/file}}` + +- Pipe data to another program: + +`rtl_sdr -f {{100000000}} - | {{aplay}}` + +- Read a specified number of samples: + +`rtl_sdr -f {{100000000}} -n {{20}} -` + +- Specify the sample rate in Hz (ranges 225001-300000 and 900001-3200000): + +`rtl_sdr -f {{100000000}} -s {{2400000}} -` + +- Specify the device by its index: + +`rtl_sdr -f {{100000000}} -d {{0}} -` + +- Specify the gain: + +`rtl_sdr -f {{100000000}} -g {{20}} -` + +- Specify the output block size: + +`rtl_sdr -f {{100000000}} -b {{9999999}} -` + +- Use synchronous output: + +`rtl_sdr -f {{100000000}} -S -` diff --git a/rtmpdump b/rtmpdump new file mode 100644 index 00000000..7fa2f053 --- /dev/null +++ b/rtmpdump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rtmpdump + +> Dump media content streamed over the RTMP protocol. +> More information: . + +- Download a file: + +`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} -o {{file.ext}}` + +- Download a file from a Flash player: + +`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --swfVfy {{http://example.com/player}} --flashVer "{{LNX 10,0,32,18}}" -o {{file.ext}}` + +- Specify connection parameters if they are not detected correctly: + +`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --app {{app_name}} --playpath {{path/to/video}} -o {{file.ext}}` + +- Download a file from a server that requires a referrer: + +`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --pageUrl {{http://example.com/webpage}} -o {{file.ext}}` diff --git a/rtv b/rtv new file mode 100644 index 00000000..3f910a9b --- /dev/null +++ b/rtv @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rtv + +> Reddit Terminal Viewer. +> Use arrow keys to navigate. Right and Left to view and return from a submission, respectively. +> More information: . + +- Open the front page: + +`/front` + +- Open a subreddit: + +`/r/{{subreddit_name}}` + +- Expand/collapse comments: + +`[space]` + +- Open link: + +`o` + +- Log in: + +`u` + +- Display help: + +`?` diff --git a/rubocop b/rubocop new file mode 100644 index 00000000..cb3fd099 --- /dev/null +++ b/rubocop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rubocop + +> Lint Ruby files. +> More information: . + +- Check all files in the current directory (including subdirectories): + +`rubocop` + +- Check one or more specific files or directories: + +`rubocop {{path/to/file}} {{path/to/directory}}` + +- Write output to file: + +`rubocop --out {{path/to/file}}` + +- View list of cops (linter rules): + +`rubocop --show-cops` + +- Exclude a cop: + +`rubocop --except {{cop_1}} {{cop_2}}` + +- Run only specified cops: + +`rubocop --only {{cop_1}} {{cop_2}}` + +- Auto-correct files (experimental): + +`rubocop --auto-correct` diff --git a/ruby b/ruby new file mode 100644 index 00000000..59293195 --- /dev/null +++ b/ruby @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ruby + +> Ruby programming language interpreter. +> See also: `gem`, `bundler`, `rake`, `irb`. +> More information: . + +- Execute a Ruby script: + +`ruby {{script.rb}}` + +- Execute a single Ruby command in the command-line: + +`ruby -e {{command}}` + +- Check for syntax errors on a given Ruby script: + +`ruby -c {{script.rb}}` + +- Start the built-in HTTP server on port 8080 in the current directory: + +`ruby -run -e httpd` + +- Locally execute a Ruby binary without installing the required library it depends on: + +`ruby -I {{path/to/library_folder}} -r {{library_require_name}} {{path/to/bin_folder/bin_name}}` + +- Display Ruby version: + +`ruby -v` diff --git a/runit b/runit new file mode 100644 index 00000000..99e5bd56 --- /dev/null +++ b/runit @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# runit + +> 3-stage init system. +> More information: . + +- Start runit's 3-stage init scheme: + +`runit` + +- Shut down runit: + +`kill --CONT {{runit_pid}}` diff --git a/runsv b/runsv new file mode 100644 index 00000000..c6b322d1 --- /dev/null +++ b/runsv @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# runsv + +> Start and manage a runit service. +> More information: . + +- Start a runit service as the current user: + +`runsv {{path/to/service}}` + +- Start a runit service as root: + +`sudo runsv {{path/to/service}}` diff --git a/runsvchdir b/runsvchdir new file mode 100644 index 00000000..4f2cd4c8 --- /dev/null +++ b/runsvchdir @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# runsvchdir + +> Change the directory `runsvdir` uses by default. +> More information: . + +- Switch `runsvdir` directories: + +`sudo runsvchdir {{path/to/directory}}` diff --git a/runsvdir b/runsvdir new file mode 100644 index 00000000..5c278449 --- /dev/null +++ b/runsvdir @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# runsvdir + +> Run an entire directory of services. +> More information: . + +- Start and manage all services in a directory as the current user: + +`runsvdir {{path/to/services}}` + +- Start and manage all services in a directory as root: + +`sudo runsvdir {{path/to/services}}` + +- Start services in separate sessions: + +`runsvdir -P {{path/to/services}}` diff --git a/rustc b/rustc new file mode 100644 index 00000000..f597e274 --- /dev/null +++ b/rustc @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustc + +> The Rust compiler. +> Rust projects usually use `cargo` instead of invoking `rustc` directly. +> More information: . + +- Compile a binary crate: + +`rustc {{path/to/main.rs}}` + +- Compile with optimizations (`s` means optimize for binary size; `z` is the same with even more optimizations): + +`rustc -C lto -C opt-level={{0|1|2|3|s|z}} {{path/to/main.rs}}` + +- Compile with debugging information: + +`rustc -g {{path/to/main.rs}}` + +- Explain an error message: + +`rustc --explain {{error_code}}` + +- Compile with architecture-specific optimizations for the current CPU: + +`rustc -C target-cpu={{native}} {{path/to/main.rs}}` + +- Display the target list (Note: you have to add a target using `rustup` first to be able to compile for it): + +`rustc --print target-list` + +- Compile for a specific target: + +`rustc --target {{target_triple}} {{path/to/main.rs}}` diff --git a/rustdoc b/rustdoc new file mode 100644 index 00000000..560d91b8 --- /dev/null +++ b/rustdoc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustdoc + +> Generate documentation for a Rust crate. +> More information: . + +- Generate documentation from the crate's root: + +`rustdoc {{src/lib.rs}}` + +- Pass a name for the project: + +`rustdoc {{src/lib.rs}} --crate-name {{name}}` + +- Generate documentation from Markdown files: + +`rustdoc {{path/to/file.md}}` + +- Specify the output directory: + +`rustdoc {{src/lib.rs}} --out-dir {{path/to/output_directory}}` diff --git a/rustfmt b/rustfmt new file mode 100644 index 00000000..2f3f6ec6 --- /dev/null +++ b/rustfmt @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustfmt + +> Format Rust source code. +> More information: . + +- Format a file, overwriting the original file in-place: + +`rustfmt {{path/to/source.rs}}` + +- Check a file for formatting and display any changes on the console: + +`rustfmt --check {{path/to/source.rs}}` + +- Backup any modified files before formatting (the original file is renamed with a `.bk` extension): + +`rustfmt --backup {{path/to/source.rs}}` diff --git a/rustic b/rustic new file mode 100644 index 00000000..255f09e0 --- /dev/null +++ b/rustic @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustic + +> Create fast, encrypted, deduplicated backups powered by Rust. +> More information: . + +- Initialize a new repository: + +`rustic init --repository {{/srv/rustic-repo}}` + +- Create a new backup of a file/directory to a repository: + +`rustic backup --repository {{/srv/rustic-repo}} {{path/to/file_or_directory}}` diff --git a/rustscan b/rustscan new file mode 100644 index 00000000..d29f55f4 --- /dev/null +++ b/rustscan @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustscan + +> Fast Port Scanner written in Rust with `nmap` built in. +> More information: . + +- Scan all ports of one or more comma-delimited [a]ddresses using the default values: + +`rustscan --addresses {{ip_or_hostname}}` + +- Scan the [t]op 1000 ports with service and version detection: + +`rustscan --top --addresses {{address_or_addresses}}` + +- Scan a specific list of [p]orts: + +`rustscan --ports {{port1,port2,...,portN}} --addresses {{address_or_addresses}}` + +- Scan a specific range of ports: + +`rustscan --range {{start-end}} --addresses {{address_or_addresses}}` + +- Add script arguments to `nmap`: + +`rustscan --addresses {{address_or_addresses}} -- -A -sC` + +- Scan with custom [b]atch size (default: 4500) and [t]imeout (default: 1500ms): + +`rustscan --batch-size {{batch_size}} --timeout {{timeout}} --addresses {{address_or_addresses}}` + +- Scan with specific port order: + +`rustscan --scan-order {{serial|random}} --addresses {{address_or_addresses}}` + +- Scan in greppable mode (only output of the ports, no `nmap`): + +`rustscan --greppable --addresses {{address_or_addresses}}` diff --git a/rustup b/rustup new file mode 100644 index 00000000..9ac5733f --- /dev/null +++ b/rustup @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup + +> Install, manage, and update Rust toolchains. +> Some subcommands, such as `toolchain`, `target`, `update`, etc. have their own usage documentation. +> More information: . + +- Install the nightly toolchain for your system: + +`rustup install nightly` + +- Switch the default toolchain to nightly so that the `cargo` and `rustc` commands will use it: + +`rustup default nightly` + +- Use the nightly toolchain when inside the current project but leave global settings unchanged: + +`rustup override set nightly` + +- Update all toolchains: + +`rustup update` + +- List installed toolchains: + +`rustup show` + +- Run `cargo build` with a certain toolchain: + +`rustup run {{toolchain}} cargo build` + +- Open the local Rust documentation in the default web browser: + +`rustup doc` diff --git a/rustup-check b/rustup-check new file mode 100644 index 00000000..20becdf9 --- /dev/null +++ b/rustup-check @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup check + +> Check for updates to Rust toolchains and `rustup`. +> More information: . + +- Check for all updates: + +`rustup check` diff --git a/rustup-completions b/rustup-completions new file mode 100644 index 00000000..a13c3e70 --- /dev/null +++ b/rustup-completions @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup completions + +> Generate shell completions for `rustup` and `cargo`. +> More information: . + +- Print the completion script to `stdout`: + +`rustup completions {{bash|elvish|fish|powershell|zsh}} {{rustup|cargo}}` diff --git a/rustup-component b/rustup-component new file mode 100644 index 00000000..40a78739 --- /dev/null +++ b/rustup-component @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup component + +> Modify a toolchain's installed components. +> Without the `--toolchain` option `rustup` will use the default toolchain. See `rustup help toolchain` for more information about toolchains. +> More information: . + +- Add a component to a toolchain: + +`rustup component add --toolchain {{toolchain}} {{component}}` + +- Remove a component from a toolchain: + +`rustup component remove --toolchain {{toolchain}} {{component}}` + +- List installed and available components for a toolchain: + +`rustup component list --toolchain {{toolchain}}` + +- List installed components for a toolchain: + +`rustup component list --toolchain {{toolchain}} --installed` diff --git a/rustup-default b/rustup-default new file mode 100644 index 00000000..44f87e22 --- /dev/null +++ b/rustup-default @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup default + +> Set the default Rust toolchain. +> More information: . + +- Switch the default Rust toolchain (see `rustup help toolchain` for more information): + +`rustup default {{toolchain}}` diff --git a/rustup-doc b/rustup-doc new file mode 100644 index 00000000..19d223c2 --- /dev/null +++ b/rustup-doc @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup doc + +> Open the offline Rust documentation for the current toolchain. +> There are a lot more documentation pages not mentioned here. See `rustup help doc` for more information. +> More information: . + +- Open the main page: + +`rustup doc` + +- Open the documentation for a specific topic (a module in the standard library, a type, a keyword, etc.): + +`rustup doc {{std::fs|usize|fn|...}}` + +- Open the Rust Programming Language book: + +`rustup doc --book` + +- Open the Cargo book: + +`rustup doc --cargo` + +- Open the Rust Reference: + +`rustup doc --reference` diff --git a/rustup-help b/rustup-help new file mode 100644 index 00000000..98a3fc66 --- /dev/null +++ b/rustup-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup help + +> Display help on `rustup` and its subcommands. +> More information: . + +- Display help: + +`rustup help` + +- Display help for a subcommand: + +`rustup help {{subcommand}}` diff --git a/rustup-init.sh b/rustup-init.sh new file mode 100644 index 00000000..c33f0dd1 --- /dev/null +++ b/rustup-init.sh @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup-init.sh + +> Script to install `rustup` and the Rust toolchain. +> More information: . + +- Download and run `rustup-init` to install `rustup` and the default Rust toolchain: + +`curl https://sh.rustup.rs -sSf | sh -s` + +- Download and run `rustup-init` and pass arguments to it: + +`curl https://sh.rustup.rs -sSf | sh -s -- {{arguments}}` + +- Run `rustup-init` and specify additional components or targets to install: + +`rustup-init.sh --target {{target}} --component {{component}}` + +- Run `rustup-init` and specify the default toolchain to install: + +`rustup-init.sh --default-toolchain {{toolchain}}` + +- Run `rustup-init` and do not install any toolchain: + +`rustup-init.sh --default-toolchain {{none}}` + +- Run `rustup-init` and specify an installation profile: + +`rustup-init.sh --profile {{minimal|default|complete}}` + +- Run `rustup-init` without asking for confirmation: + +`rustup-init.sh -y` diff --git a/rustup-install b/rustup-install new file mode 100644 index 00000000..3fc09f63 --- /dev/null +++ b/rustup-install @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup install + +> Install or update Rust toolchains. +> This command is an alias of `rustup update`, but can only install/update one toolchain at a time. +> More information: . + +- Install or update a specific toolchain (see `rustup help toolchain` for more information): + +`rustup install {{toolchain}}` diff --git a/rustup-man b/rustup-man new file mode 100644 index 00000000..79a7e10a --- /dev/null +++ b/rustup-man @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup man + +> View the man page for a command managed by `rustup`. +> More information: . + +- View the man page for a given command from the default toolchain: + +`rustup man {{command}}` + +- View the man page for a given command from the specified toolchain: + +`rustup man --toolchain {{command}}` diff --git a/rustup-override b/rustup-override new file mode 100644 index 00000000..fd211c0b --- /dev/null +++ b/rustup-override @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup override + +> Modify directory toolchain overrides. +> See `rustup help toolchain` for more information about toolchains. +> More information: . + +- List directiory toolchain overrides: + +`rustup override list` + +- Set the override toolchain for the current directory (i.e. tell `rustup` to run `cargo`, `rustc`, etc. from a specific toolchain when in that directory): + +`rustup override set {{toolchain}}` + +- Remove the toolchain override for the current directory: + +`rustup override unset` + +- Remove all toolchain overrides for directories that no longer exist: + +`rustup override unset --nonexistent` diff --git a/rustup-run b/rustup-run new file mode 100644 index 00000000..4514c4f2 --- /dev/null +++ b/rustup-run @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup run + +> Run a command with an environment configured for a Rust toolchain. +> Note: all commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`. +> More information: . + +- Run a command using a given Rust toolchain (see `rustup help toolchain` for more information): + +`rustup run {{toolchain}} {{command}}` diff --git a/rustup-self b/rustup-self new file mode 100644 index 00000000..cc26f895 --- /dev/null +++ b/rustup-self @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup self + +> Modify the `rustup` installation. +> More information: . + +- Update `rustup`: + +`rustup self update` + +- Uninstall `rustup`: + +`rustup self uninstall` diff --git a/rustup-set b/rustup-set new file mode 100644 index 00000000..1eb3d479 --- /dev/null +++ b/rustup-set @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup set + +> Alter `rustup` settings. +> More information: . + +- Set the default host triple: + +`rustup set default-host {{host_triple}}` + +- Set the default profile (`minimal` includes only `rustc`, `rust-std` and `cargo`, whereas `default` adds `rust-docs`, `rustfmt` and `clippy`): + +`rustup set profile {{minimal|default}}` + +- Set whether `rustup` should update itself when running `rustup update`: + +`rustup set auto-self-update {{enable|disable|check-only}}` diff --git a/rustup-show b/rustup-show new file mode 100644 index 00000000..91e4f029 --- /dev/null +++ b/rustup-show @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup show + +> Show installed toolchains, targets and the version of `rustc`. +> More information: . + +- Show all information: + +`rustup show` + +- Show the active toolchain: + +`rustup show active-toolchain` + +- Show the rustup data directory: + +`rustup show home` diff --git a/rustup-target b/rustup-target new file mode 100644 index 00000000..e51db845 --- /dev/null +++ b/rustup-target @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup target + +> Modify a toolchain's supported targets. +> Without the `--toolchain` option `rustup` will use the default toolchain. See `rustup help toolchain` for more information about toolchains. +> More information: . + +- Add a target to a toolchain: + +`rustup target add --toolchain {{toolchain}} {{target}}` + +- Remove a target from a toolchain: + +`rustup target remove --toolchain {{toolchain}} {{target}}` + +- List available and installed targets for a toolchain: + +`rustup target list --toolchain {{toolchain}}` + +- List installed targets for a toolchain: + +`rustup target list --toolchain {{toolchain}} --installed` diff --git a/rustup-toolchain b/rustup-toolchain new file mode 100644 index 00000000..74707aa1 --- /dev/null +++ b/rustup-toolchain @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup toolchain + +> Manage Rust toolchains. +> See `rustup help toolchain` for more information about toolchains. +> More information: . + +- Install or update a given toolchain: + +`rustup install {{toolchain}}` + +- Uninstall a toolchain: + +`rustup uninstall {{toolchain}}` + +- List installed toolchains: + +`rustup list` + +- Create a custom toolchain by symlinking to a directory: + +`rustup link {{custom_toolchain_name}} {{path/to/directory}}` diff --git a/rustup-update b/rustup-update new file mode 100644 index 00000000..24a7448f --- /dev/null +++ b/rustup-update @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup update + +> Update Rust toolchains and `rustup` itself (if not installed using a package manager). +> More information: . + +- Update all installed toolchains and `rustup`: + +`rustup update` + +- Install or update a specific toolchain (see `rustup help toolchain` for more information): + +`rustup update {{toolchain}}` diff --git a/rustup-which b/rustup-which new file mode 100644 index 00000000..add6bd8a --- /dev/null +++ b/rustup-which @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup which + +> Display which binary will be run for a command managed by `rustup`. +> Like `which`, but searches a Rust toolchain instead of `$PATH`. +> More information: . + +- Display the path to the binary in the default toolchain: + +`rustup which {{command}}` + +- Display the path to the binary in the specified toolchain (see `rustup help toolchain` for more information): + +`rustup which --toolchain {{toolchain}} {{command}}` diff --git a/rvm b/rvm new file mode 100644 index 00000000..fa9c0e6b --- /dev/null +++ b/rvm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rvm + +> Easily installing, managing, and working with multiple ruby environments. +> More information: . + +- Install one or more versions of Ruby: + +`rvm install {{version1 version2 ...}}` + +- Display a list of installed versions: + +`rvm list` + +- Use a specific version of Ruby: + +`rvm use {{version}}` + +- Set the default Ruby version: + +`rvm --default use {{version}}` + +- Upgrade a version of Ruby to a new version: + +`rvm upgrade {{current_version}} {{new_version}}` + +- Uninstall a version of Ruby and keep its sources: + +`rvm uninstall {{version}}` + +- Remove a version of Ruby and its sources: + +`rvm remove {{version}}` + +- Show specific dependencies for your OS: + +`rvm requirements` diff --git a/s b/s new file mode 100644 index 00000000..daa91ff7 --- /dev/null +++ b/s @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# s + +> Web search from the terminal. +> More information: . + +- Search for a query on Google (default provider): + +`s {{query}}` + +- List all providers: + +`s --list-providers` + +- Search for a query with a given provider: + +`s --provider {{provider}} {{query}}` + +- Use a specified binary to perform the search query: + +`s --binary "{{binary}} {{arguments}}" {{query}}` diff --git a/s3cmd b/s3cmd new file mode 100644 index 00000000..f8b09acb --- /dev/null +++ b/s3cmd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# s3cmd + +> Command line tool and client for uploading, retrieving and managing data in S3 compatible object storage. +> More information: . + +- Invoke configuration/reconfiguration tool: + +`s3cmd --configure` + +- List Buckets/Folders/Objects: + +`s3cmd ls s3://{{bucket|path/to/file}}` + +- Create Bucket/Folder: + +`s3cmd mb s3://{{bucket}}` + +- Download a specific file from a bucket: + +`s3cmd get s3://{{bucket_name}}/{{path/to/file}} {{path/to/local_file}}` + +- Upload a file to a bucket: + +`s3cmd put {{local_file}} s3://{{bucket}}/{{file}}` + +- Move an object to a specific bucket location: + +`s3cmd mv s3://{{src_bucket}}/{{src_object}} s3://{{dst_bucket}}/{{dst_object}}` + +- Delete a specific object: + +`s3cmd rm s3://{{bucket}}/{{object}}` diff --git a/safe b/safe new file mode 100644 index 00000000..9cad5788 --- /dev/null +++ b/safe @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# safe + +> Interact with HashiCorp Vault. +> More information: . + +- Add a safe target: + +`safe target {{vault_addr}} {{target_name}}` + +- Authenticate the CLI client against the Vault server, using an authentication token: + +`safe auth {{authentication_token}}` + +- Print the environment variables describing the current target: + +`safe env` + +- Display a tree hierarchy of all reachable keys for a given path: + +`safe tree {{path}}` + +- Move a secret from one path to another: + +`safe move {{old/path/to/secret}} {{new/path/to/secret}}` + +- Generate a new 2048-bit SSH key-pair and store it: + +`safe ssh {{2048}} {{path/to/secret}}` + +- Set non-sensitive keys for a secret: + +`safe set {{path/to/secret}} {{key}}={{value}}` + +- Set auto-generated password in a secret: + +`safe gen {{path/to/secret}} {{key}}` diff --git a/sails b/sails new file mode 100644 index 00000000..6401cb70 --- /dev/null +++ b/sails @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sails + +> A realtime enterprise level MVC framework built on top of Node.js. +> More information: . + +- Start Sails: + +`sails lift` + +- Create new Sails project: + +`sails new {{projectName}}` + +- Generate Sails API: + +`sails generate {{name}}` + +- Generate Sails Controller: + +`sails generate controller {{name}}` + +- Generate Sails Model: + +`sails generate model {{name}}` diff --git a/salt b/salt new file mode 100644 index 00000000..db5e4eb3 --- /dev/null +++ b/salt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# salt + +> Execute commands and assert state on remote salt minions. +> More information: . + +- List connected minions: + +`salt '*' test.ping` + +- Execute a highstate on all connected minions: + +`salt '*' state.highstate` + +- Upgrade packages using the OS package manager (apt, yum, brew) on a subset of minions: + +`salt '*.example.com' pkg.upgrade` + +- Execute an arbitrary command on a particular minion: + +`salt '{{minion_id}}' cmd.run "ls "` diff --git a/salt-call b/salt-call new file mode 100644 index 00000000..c56259ed --- /dev/null +++ b/salt-call @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# salt-call + +> Invoke salt locally on a salt minion. +> More information: . + +- Perform a highstate on this minion: + +`salt-call state.highstate` + +- Perform a highstate dry-run, compute all changes but don't actually perform them: + +`salt-call state.highstate test=true` + +- Perform a highstate with verbose debugging output: + +`salt-call -l debug state.highstate` + +- List this minion's grains: + +`salt-call grains.items` diff --git a/salt-key b/salt-key new file mode 100644 index 00000000..b1b2043e --- /dev/null +++ b/salt-key @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# salt-key + +> Manages salt minion keys on the salt master. +> Needs to be run on the salt master, likely as root or with sudo. +> More information: . + +- List all accepted, unaccepted and rejected minion keys: + +`salt-key -L` + +- Accept a minion key by name: + +`salt-key -a {{MINION_ID}}` + +- Reject a minion key by name: + +`salt-key -r {{MINION_ID}}` + +- Print fingerprints of all public keys: + +`salt-key -F` diff --git a/salt-run b/salt-run new file mode 100644 index 00000000..d9ca24ae --- /dev/null +++ b/salt-run @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# salt-run + +> Frontend for executing salt-runners on minions. +> More information: . + +- Show status of all minions: + +`salt-run manage.status` + +- Show all minions which are disconnected: + +`salt-run manage.up` diff --git a/sam2p b/sam2p new file mode 100644 index 00000000..d3074d21 --- /dev/null +++ b/sam2p @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sam2p + +> Raster (bitmap) image converter with smart PDF and PostScript (EPS) output. +> More information: . + +- Concatenate all PDF files into one: + +`sam2p *.pdf {{path/to/output.pdf}}` diff --git a/samtools b/samtools new file mode 100644 index 00000000..172c12dd --- /dev/null +++ b/samtools @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# samtools + +> Tools for handling high-throughput sequencing (genomics) data. +> Used for reading/writing/editing/indexing/viewing of data in SAM/BAM/CRAM format. +> More information: . + +- Convert a SAM input file to BAM stream and save to file: + +`samtools view -S -b {{input.sam}} > {{output.bam}}` + +- Take input from `stdin` (-) and print the SAM header and any reads overlapping a specific region to `stdout`: + +`{{other_command}} | samtools view -h - chromosome:start-end` + +- Sort file and save to BAM (the output format is automatically determined from the output file's extension): + +`samtools sort {{input}} -o {{output.bam}}` + +- Index a sorted BAM file (creates `sorted_input.bam.bai`): + +`samtools index {{sorted_input.bam}}` + +- Print alignment statistics about a file: + +`samtools flagstat {{sorted_input}}` + +- Count alignments to each index (chromosome/contig): + +`samtools idxstats {{sorted_indexed_input}}` + +- Merge multiple files: + +`samtools merge {{output}} {{input1 input2 ...}}` + +- Split input file according to read groups: + +`samtools split {{merged_input}}` diff --git a/sass b/sass new file mode 100644 index 00000000..94693b75 --- /dev/null +++ b/sass @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sass + +> Converts SCSS or Sass files to CSS. +> More information: . + +- Convert a SCSS or Sass file to CSS and print out the result: + +`sass {{inputfile.scss|inputfile.sass}}` + +- Convert a SCSS or Sass file to CSS and save the result to a file: + +`sass {{inputfile.scss|inputfile.sass}} {{outputfile.css}}` + +- Watch a SCSS or Sass file for changes and output or update the CSS file with same filename: + +`sass --watch {{inputfile.scss|inputfile.sass}}` + +- Watch a SCSS or Sass file for changes and output or update the CSS file with the given filename: + +`sass --watch {{inputfile.scss|inputfile.sass}}:{{outputfile.css}}` diff --git a/satis b/satis new file mode 100644 index 00000000..ada490f6 --- /dev/null +++ b/satis @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# satis + +> The command-line utility for the Satis static Composer repository. +> More information: . + +- Initialize a Satis configuration: + +`satis init {{satis.json}}` + +- Add a VCS repository to the Satis configuration: + +`satis add {{repository_url}}` + +- Build the static output from the configuration: + +`satis build {{satis.json}} {{path/to/output_directory}}` + +- Build the static output by updating only the specified repository: + +`satis build --repository-url {{repository_url}} {{satis.json}} {{path/to/output_directory}}` + +- Remove useless archive files: + +`satis purge {{satis.json}} {{path/to/output_directory}}` diff --git a/sbcl b/sbcl new file mode 100644 index 00000000..3f2dd830 --- /dev/null +++ b/sbcl @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sbcl + +> High performance Common Lisp compiler. +> More information: . + +- Start a REPL (interactive shell): + +`sbcl` + +- Execute a Lisp script: + +`sbcl --script {{path/to/script.lisp}}` diff --git a/sbigtopgm b/sbigtopgm new file mode 100644 index 00000000..78251082 --- /dev/null +++ b/sbigtopgm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sbigtopgm + +> Convert an SBIG CCDOPS file to PGM. +> More information: . + +- Convert an SBIG CCDOPS image file to PGM: + +`sbigtopgm {{path/to/input_file.sbig}} > {{path/to/output.pgm}}` diff --git a/sbt b/sbt new file mode 100644 index 00000000..65a2d806 --- /dev/null +++ b/sbt @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sbt + +> Build tool for Scala and Java projects. +> More information: . + +- Start a REPL (interactive shell): + +`sbt` + +- Create a new Scala project from an existing Giter8 template hosted on GitHub: + +`sbt new {{scala/hello-world.g8}}` + +- Compile and run all tests: + +`sbt test` + +- Delete all generated files in the `target` directory: + +`sbt clean` + +- Compile the main sources in `src/main/scala` and `src/main/java` directories: + +`sbt compile` + +- Use the specified version of sbt: + +`sbt -sbt-version {{version}}` + +- Use a specific jar file as the sbt launcher: + +`sbt -sbt-jar {{path}}` + +- List all sbt options: + +`sbt -h` diff --git a/sbuild b/sbuild new file mode 100644 index 00000000..d90d4165 --- /dev/null +++ b/sbuild @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sbuild + +> Build a Debian binary package in a clean `chroot` environment. +> More information: . + +- Build the package in the current directory: + +`sbuild` + +- Build the given package: + +`sbuild {{package}}` + +- Build for a certain distribution: + +`sbuild --dist {{distribution}}` + +- Build using custom dependencies (if a directory is passed, all files ending with `.deb` are used): + +`sbuild --extra-package {{path/to/file_or_directory}}` + +- Run a shell in case of build failure to further investigate: + +`sbuild --build-failed-commands=%SBUILD_SHELL` + +- Cross build for a certain architecture: + +`sbuild --host {{architecture}}` + +- Build for the given native architecture: + +`sbuild --arch {{architecture}}` diff --git a/sc-im b/sc-im new file mode 100644 index 00000000..cd908247 --- /dev/null +++ b/sc-im @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# SC-IM + +> A curses based, vim-like spreadsheet calculator. +> Use hjkl or arrow keys to navigate. +> More information: . + +- Start SC-IM: + +`scim {{path/to/file.csv}}` + +- Enter a string into the current cell: + +`{{<|>}}` + +- Enter a numeric constant into the current cell: + +`=` + +- Edit string in the current cell: + +`E` + +- Edit number in the current cell: + +`e` + +- Center align the current cell: + +`|` diff --git a/sc_analysis_dump b/sc_analysis_dump new file mode 100644 index 00000000..82af8ca8 --- /dev/null +++ b/sc_analysis_dump @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_analysis_dump + +> Dump of traceroute data in an easily parsed format. +> More information: . + +- Output the traceroute of `warts` files one after the other in an easy-to-parse format: + +`sc_analysis_dump {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_tracediff b/sc_tracediff new file mode 100644 index 00000000..826c3f87 --- /dev/null +++ b/sc_tracediff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_tracediff + +> Display traceroute paths where the path has changed. +> More information: . + +- Show the difference between traceroutes in two `warts` files: + +`sc_tracediff {{path/to/file1.warts}} {{path/to/file2.warts}}` + +- Show the difference between the traceroutes in two `warts` files, including those that have not changed: + +`sc_tracediff -a {{path/to/file1.warts}} {{path/to/file2.warts}}` + +- Show the difference between the traceroutes in two `warts` files and try to show DNS names and not IP addresses if possible: + +`sc_tracediff -n {{path/to/file1.warts}} {{path/to/file2.warts}}` diff --git a/sc_ttlexp b/sc_ttlexp new file mode 100644 index 00000000..c9a098d1 --- /dev/null +++ b/sc_ttlexp @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_ttlexp + +> Dump source addresses from ICMP TTL expired messages in `warts` files. +> More information: . + +- Output the source address of ICMP TTL expire messages in `warts` files one after the other: + +`sc_ttlexp {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_warts2csv b/sc_warts2csv new file mode 100644 index 00000000..ac3e1fcc --- /dev/null +++ b/sc_warts2csv @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_warts2csv + +> Dump traceroutes collected by `scamper` in CSV format. +> More information: . + +- Convert traceroute data in `warts` files to CSV and output it: + +`sc_warts2csv {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_warts2json b/sc_warts2json new file mode 100644 index 00000000..de2506da --- /dev/null +++ b/sc_warts2json @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_warts2json + +> JSON dump of information contained in a `warts` file. +> More information: . + +- Convert `warts` files to JSON and output the result: + +`sc_warts2json {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_warts2pcap b/sc_warts2pcap new file mode 100644 index 00000000..2e824e5c --- /dev/null +++ b/sc_warts2pcap @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_warts2pcap + +> Write packets included in `warts` object to a `pcap` file. +> This is only possible for tbit, sting and sniff. +> More information: . + +- Convert the data from several `warts` files into one `pcap` file: + +`sc_warts2pcap -o {{path/to/output.pcap}} {{path/to/file1.warts path/to/file2.warts ...}}` + +- Convert the data from a `warts` file into a `pcap` file and sort the packets by timestamp: + +`sc_warts2pcap -s -o {{path/to/output.pcap}} {{path/to/file.warts}}` diff --git a/sc_warts2text b/sc_warts2text new file mode 100644 index 00000000..e2ea1be2 --- /dev/null +++ b/sc_warts2text @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_warts2text + +> Simple dump of information contained in a `warts` file. +> More information: . + +- Output the information in `warts` files as text: + +`sc_warts2text {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_wartscat b/sc_wartscat new file mode 100644 index 00000000..286cf602 --- /dev/null +++ b/sc_wartscat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_wartscat + +> Concatenate `warts` files. +> More information: . + +- Concatenate `warts` files into one: + +`sc_wartscat -o {{path/to/output.warts}} {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_wartsdump b/sc_wartsdump new file mode 100644 index 00000000..f349fffa --- /dev/null +++ b/sc_wartsdump @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_wartsdump + +> Verbose dump of information contained in a `warts` file. +> More information: . + +- Output the content of `warts` files verbose: + +`sc_wartsdump {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/sc_wartsfilter b/sc_wartsfilter new file mode 100644 index 00000000..c0e03c60 --- /dev/null +++ b/sc_wartsfilter @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_wartsfilter + +> Select specific records from a `warts` file. +> More information: . + +- Filter all data records that had specific destinations and write them to a separate file: + +`sc_wartsfilter -i {{path/to/input.warts}} -o {{path/to/output.warts}} -a {{192.0.2.5}} -a {{192.0.2.6}}` + +- Filter all records that had certain destinations in a prefix and write them to a separate file: + +`sc_wartsfilter -i {{path/to/input.warts}} -o {{path/to/output.warts}} -a {{2001:db8::/32}}` + +- Filter all records that using a specific action and output them as JSON: + +`sc_wartsfilter -i {{path/to/input.warts}} -t {{ping}} | sc_warts2json` diff --git a/sc_wartsfix b/sc_wartsfix new file mode 100644 index 00000000..4ce34acb --- /dev/null +++ b/sc_wartsfix @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sc_wartsfix + +> Truncate damaged `warts` files. +> More information: . + +- Save all records (in a separate file) up to the last intact one: + +`sc_wartsfix {{path/to/file1.warts path/to/file2.warts ...}}` diff --git a/scala b/scala new file mode 100644 index 00000000..79e0d7ab --- /dev/null +++ b/scala @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scala + +> Scala application launcher and interactive interpreter. +> More information: . + +- Start a REPL (interactive shell): + +`scala` + +- Start the interpreter with a dependency in the classpath: + +`scala -classpath {{filename.jar}} {{command}}` + +- Execute a Scala script: + +`scala {{script.scala}}` + +- Execute a `.jar` program: + +`scala {{filename.jar}}` + +- Execute a single Scala command in the command-line: + +`scala -e {{command}}` diff --git a/scala-cli b/scala-cli new file mode 100644 index 00000000..dd0efc2b --- /dev/null +++ b/scala-cli @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scala-cli + +> Interact with the Scala programming language. +> More information: . + +- Start a REPL (interactive shell) using a specific Scala and JVM version: + +`scala-cli --scala {{3.1.0}} --jvm {{temurin:17}}` + +- Compile and run a Scala script: + +`scala-cli run {{path/to/script.scala}}` + +- Compile and test a Scala script: + +`scala-cli test {{path/to/script.scala}}` + +- Format a Scala script, updating the file in-place: + +`scala-cli fmt {{path/to/script.scala}}` + +- Generate files for IDE (VSCode and IntelliJ) support: + +`scala-cli setup-ide {{path/to/script.scala}}` diff --git a/scalafmt b/scalafmt new file mode 100644 index 00000000..a7f75bf6 --- /dev/null +++ b/scalafmt @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scalafmt + +> Code formatter for Scala. +> Configurations are stored in the `.scalafmt.conf` file. +> More information: . + +- Reformat all `.scala` files in the current directory recursively: + +`scalafmt` + +- Reformat specific files or directories with a custom formatting configuration: + +`scalafmt --config {{path/to/.scalafmt.conf}} {{path/to/file_or_directory}} {{path/to/file_or_directory}} {{...}}` + +- Check if files are correctly formatted, returning `0` if all files respect the formatting style: + +`scalafmt --config {{path/to/.scalafmt.conf}} --test` + +- Exclude files or directories: + +`scalafmt --exclude {{path/to/file_or_directory}} {{...}}` + +- Format only files that were edited against the current Git branch: + +`scalafmt --config {{path/to/.scalafmt.conf}} --mode diff` diff --git a/scamper b/scamper new file mode 100644 index 00000000..7c3bf638 --- /dev/null +++ b/scamper @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scamper + +> Actively probes the Internet in order to analyze topology and performance. +> Includes some tools that start with `sc_`, for example `sc_warts2text` or `sc_ttlexp`. +> More information: . + +- Execute the standard option (traceroute) to a destination: + +`scamper -i {{192.0.2.1}}` + +- Execute two actions (ping and traceroute) on two different targets: + +`scamper -I "{{ping}} {{192.0.2.1}}" -I "{{trace}} {{192.0.2.2}}` + +- Ping several hosts with UDP, use a specific port number for the first ping and increase it for each subsequent ping: + +`scamper -c "{{ping}} -P {{UDP-dport}} -d {{33434}}" -i {{192.0.2.1}} -i {{192.0.2.2}}` + +- Use the Multipath Discovery Algorithm (MDA) to determine the presence of load-balanced paths to the destination and use ICMP echo packets to sample with a maximum of three attempts, write the result to a `warts` file: + +`scamper -O {{warts}} -o {{path/to/output.warts}} -I "{{tracelb}} -P {{ICMP-echo}} -q {{3}} {{192.0.2.1}}"` + +- Execute a Paris traceroute with ICMP to a destination and save the result in a compressed `warts` file: + +`scamper -O {{warts.gz}} -o {{path/to/output.warts}} -I "{{trace}} -P {{icmp-paris}} {{2001:db8:dead:beaf::4}}"` + +- Record all ICMP packets that arrive at a specific IP address and have a specific ICMP ID in a `warts` file: + +`scamper -O {{warts}} -o {{path/to/output.warts}} -I "sniff -S {{2001:db8:dead:beef::6}} icmp[icmpid] == {{101}}"` diff --git a/scan-build b/scan-build new file mode 100644 index 00000000..9416aa05 --- /dev/null +++ b/scan-build @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scan-build + +> Command-line utility to run a static analyzer over a codebase as part of performing a regular build. +> More information: . + +- Build and analyze the project in the current directory: + +`scan-build {{make}}` + +- Run a command and pass all subsequent options to it: + +`scan-build {{command}} {{command_arguments}}` + +- Display help: + +`scan-build` diff --git a/scc b/scc new file mode 100644 index 00000000..5a6843a9 --- /dev/null +++ b/scc @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scc + +> Count lines of code. Written in Go. +> More information: . + +- Print lines of code in the current directory: + +`scc` + +- Print lines of code in the target directory: + +`scc {{path/to/directory}}` + +- Display output for every file: + +`scc --by-file` + +- Display output using a specific output format (defaults to `tabular`): + +`scc --format {{tabular|wide|json|csv|cloc-yaml|html|html-table}}` + +- Only count files with specific file extensions: + +`scc --include-ext {{go,java,js}}` + +- Exclude directories from being counted: + +`scc --exclude-dir {{.git,.hg}}` + +- Display output and sort by column (defaults to by files): + +`scc --sort {{files|name|lines|blanks|code|comments|complexity}}` + +- Display help: + +`scc -h` diff --git a/sccmap b/sccmap new file mode 100644 index 00000000..949311ba --- /dev/null +++ b/sccmap @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sccmap + +> Extract strongly connected components of directed graphs. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Extract strongly connected components of one or more directed graphs: + +`sccmap -S {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Print statistics about a graph, producing no output graph: + +`sccmap -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}` + +- Display help: + +`sccmap -?` diff --git a/scd b/scd new file mode 100644 index 00000000..dd9c0dd8 --- /dev/null +++ b/scd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scd + +> File manager focused on shell integration. +> More information: . + +- Index paths recursively for the very first run: + +`scd -ar {{path/to/directory}}` + +- Change to a specific directory: + +`scd {{path/to/directory}}` + +- Change to a path matching specific patterns: + +`scd "{{pattern1 pattern2 ...}}"` + +- Show selection menu and ranking of 20 most likely directories: + +`scd -v` + +- Add a specific alias for the current directory: + +`scd --alias={{word}}` + +- Change to a directory using a specific alias: + +`scd {{word}}` diff --git a/scheme b/scheme new file mode 100644 index 00000000..b42e8dad --- /dev/null +++ b/scheme @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scheme + +> MIT Scheme language interpreter and REPL (interactive shell). +> More information: . + +- Start a REPL (interactive shell): + +`scheme` + +- Run a scheme program (with no REPL output): + +`scheme --quiet < {{script.scm}}` + +- Load a scheme program into the REPL: + +`scheme --load {{script.scm}}` + +- Load scheme expressions into the REPL: + +`scheme --eval "{{(define foo 'x)}}"` + +- Open the REPL in quiet mode: + +`scheme --quiet` diff --git a/scp b/scp new file mode 100644 index 00000000..e0b33155 --- /dev/null +++ b/scp @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scp + +> Secure copy. +> Copy files between hosts using Secure Copy Protocol over SSH. +> More information: . + +- Copy a local file to a remote host: + +`scp {{path/to/local_file}} {{remote_host}}:{{path/to/remote_file}}` + +- Use a specific port when connecting to the remote host: + +`scp -P {{port}} {{path/to/local_file}} {{remote_host}}:{{path/to/remote_file}}` + +- Copy a file from a remote host to a local directory: + +`scp {{remote_host}}:{{path/to/remote_file}} {{path/to/local_directory}}` + +- Recursively copy the contents of a directory from a remote host to a local directory: + +`scp -r {{remote_host}}:{{path/to/remote_directory}} {{path/to/local_directory}}` + +- Copy a file between two remote hosts transferring through the local host: + +`scp -3 {{host1}}:{{path/to/remote_file}} {{host2}}:{{path/to/remote_directory}}` + +- Use a specific username when connecting to the remote host: + +`scp {{path/to/local_file}} {{remote_username}}@{{remote_host}}:{{path/to/remote_directory}}` + +- Use a specific ssh private key for authentication with the remote host: + +`scp -i {{~/.ssh/private_key}} {{path/to/local_file}} {{remote_host}}:{{path/to/remote_file}}` + +- Use a specific proxy when connecting to the remote host: + +`scp -J {{proxy_username}}@{{proxy_host}} {{path/to/local_file}} {{remote_host}}:{{path/to/remote_file}}` diff --git a/scrapy b/scrapy new file mode 100644 index 00000000..ae3f7141 --- /dev/null +++ b/scrapy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scrapy + +> Web-crawling framework. +> More information: . + +- Create a project: + +`scrapy startproject {{project_name}}` + +- Create a spider (in project directory): + +`scrapy genspider {{spider_name}} {{website_domain}}` + +- Edit spider (in project directory): + +`scrapy edit {{spider_name}}` + +- Run spider (in project directory): + +`scrapy crawl {{spider_name}}` + +- Fetch a webpage as Scrapy sees it and print the source to `stdout`: + +`scrapy fetch {{url}}` + +- Open a webpage in the default browser as Scrapy sees it (disable JavaScript for extra fidelity): + +`scrapy view {{url}}` + +- Open Scrapy shell for URL, which allows interaction with the page source in a Python shell (or IPython if available): + +`scrapy shell {{url}}` diff --git a/scrcpy b/scrcpy new file mode 100644 index 00000000..fd9b818b --- /dev/null +++ b/scrcpy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# scrcpy + +> Display and control your Android device on a desktop. +> More information: . + +- Display a mirror of a connected device: + +`scrcpy` + +- Display a mirror of a specific device based on its ID or IP address (find it under the `adb devices` command): + +`scrcpy --serial {{0123456789abcdef|192.168.0.1:5555}}` + +- Start display in fullscreen mode: + +`scrcpy --fullscreen` + +- Rotate the display screen. Each incremental value adds a 90 degree counterclockwise rotation: + +`scrcpy --rotation {{0|1|2|3}}` + +- Show touches on physical device: + +`scrcpy --show-touches` + +- Record display screen: + +`scrcpy --record {{path/to/file.mp4}}` + +- Specify the target directory for pushing files to device by drag and drop (non-APK): + +`scrcpy --push-target {{path/to/directory}}` diff --git a/screen b/screen new file mode 100644 index 00000000..72ae0572 --- /dev/null +++ b/screen @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# screen + +> Hold a session open on a remote server. Manage multiple windows with a single SSH connection. +> See also `tmux` and `zellij`. +> More information: . + +- Start a new screen session: + +`screen` + +- Start a new named screen session: + +`screen -S {{session_name}}` + +- Start a new daemon and log the output to `screenlog.x`: + +`screen -dmLS {{session_name}} {{command}}` + +- Show open screen sessions: + +`screen -ls` + +- Reattach to an open screen: + +`screen -r {{session_name}}` + +- Detach from inside a screen: + +` + A, D` + +- Kill the current screen session: + +` + A, K` + +- Kill a detached screen: + +`screen -X -S {{session_name}} quit` diff --git a/screenfetch b/screenfetch new file mode 100644 index 00000000..ba6cd571 --- /dev/null +++ b/screenfetch @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# screenfetch + +> Display system information. +> More information: . + +- Start `screenfetch`: + +`screenfetch` + +- Take a screenshot (requires 'scrot'): + +`screenfetch -s` + +- Specify distribution logo: + +`screenfetch -A '{{distribution_name}}'` + +- Specify distribution logo and text: + +`screenfetch -D '{{distribution_name}}'` + +- Strip all color: + +`screenfetch -N` diff --git a/script b/script new file mode 100644 index 00000000..0e64d839 --- /dev/null +++ b/script @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# script + +> Make a typescript file of a terminal session. +> More information: . + +- Start recording in file named "typescript": + +`script` + +- Stop recording: + +`exit` + +- Start recording in a given file: + +`script {{logfile.log}}` + +- Append to an existing file: + +`script -a {{logfile.log}}` + +- Execute quietly without start and done messages: + +`script -q {{logfile.log}}` diff --git a/sd b/sd new file mode 100644 index 00000000..71a4fb3e --- /dev/null +++ b/sd @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sd + +> Intuitive find and replace. +> More information: . + +- Trim some whitespace using a regular expression (output stream: `stdout`): + +`{{echo 'lorem ipsum 23 '}} | sd '\s+$' ''` + +- Replace words using capture groups (output stream: `stdout`): + +`{{echo 'cargo +nightly watch'}} | sd '(\w+)\s+\+(\w+)\s+(\w+)' 'cmd: $1, channel: $2, subcmd: $3'` + +- Find and replace in a specific file (output stream: `stdout`): + +`sd -p {{'window.fetch'}} {{'fetch'}} {{path/to/file.js}}` + +- Find and replace in all files in the current project (output stream: `stdout`): + +`sd {{'from "react"'}} {{'from "preact"'}} "$(find . -type f)"` diff --git a/sdcv b/sdcv new file mode 100644 index 00000000..5bc79d9d --- /dev/null +++ b/sdcv @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sdcv + +> StarDict, a command-line dictionary client. +> Dictionaries are provided separately from the client. +> More information: . + +- Start `sdcv` interactively: + +`sdcv` + +- List installed dictionaries: + +`sdcv --list-dicts` + +- Display a definition from a specific dictionary: + +`sdcv --use-dict {{dictionary_name}} {{search_term}}` + +- Look up a definition with a fuzzy search: + +`sdcv {{search_term}}` + +- Look up a definition with an exact search: + +`sdcv --exact-search {{search_term}}` + +- Look up a definition and format the output as JSON: + +`sdcv --json {{search_term}}` + +- Search for dictionaries in a specific directory: + +`sdcv --data-dir {{path/to/directory}} {{search_term}}` diff --git a/sdiff b/sdiff new file mode 100644 index 00000000..ea707b09 --- /dev/null +++ b/sdiff @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sdiff + +> Compare the differences between and optionally merge 2 files. +> More information: . + +- Compare 2 files: + +`sdiff {{path/to/file1}} {{path/to/file2}}` + +- Compare 2 files, ignoring all tabs and whitespace: + +`sdiff -W {{path/to/file1}} {{path/to/file2}}` + +- Compare 2 files, ignoring whitespace at the end of lines: + +`sdiff -Z {{path/to/file1}} {{path/to/file2}}` + +- Compare 2 files in a case-insensitive manner: + +`sdiff -i {{path/to/file1}} {{path/to/file2}}` + +- Compare and then merge, writing the output to a new file: + +`sdiff -o {{path/to/merged_file}} {{path/to/file1}} {{path/to/file2}}` diff --git a/sdk b/sdk new file mode 100644 index 00000000..c6dc7136 --- /dev/null +++ b/sdk @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sdk + +> Manage parallel versions of multiple Software Development Kits. +> Supports Java, Groovy, Scala, Kotlin, Gradle, Maven, Vert.x and many others. +> More information: . + +- Install an SDK version: + +`sdk install {{sdk_name}} {{sdk_version}}` + +- Use a specific SDK version for the current terminal session: + +`sdk use {{sdk_name}} {{sdk_version}}` + +- Show the stable version of any available SDK: + +`sdk current {{sdk_name}}` + +- Show the stable versions of all installed SDKs: + +`sdk current` + +- List all available SDKs: + +`sdk list` + +- List all versions of an SDK: + +`sdk list {{sdk_name}}` + +- Upgrade an SDK to the latest stable version: + +`sdk upgrade {{sdk_name}}` + +- Uninstall a specific SDK version: + +`sdk rm {{sdk_name}} {{sdk_version}}` diff --git a/sdkmanager b/sdkmanager new file mode 100644 index 00000000..68312e8e --- /dev/null +++ b/sdkmanager @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sdkmanager + +> Install packages for the Android SDK. +> More information: . + +- List available packages: + +`sdkmanager --list` + +- Install a package: + +`sdkmanager {{package}}` + +- Update every installed package: + +`sdkmanager --update` + +- Uninstall a package: + +`sdkmanager --uninstall {{package}}` diff --git a/searchsploit b/searchsploit new file mode 100644 index 00000000..46445929 --- /dev/null +++ b/searchsploit @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# searchsploit + +> Searchsploit searches exploit database's database for exploits, shellcodes and/or papers. +> If known version numbers are used as search terms, exploits for both the exact version and others whose version range covers the one specified are shown. +> More information: . + +- Search for an exploit, shellcode, or paper: + +`searchsploit {{search_terms}}` + +- Search for a known specific version, e.g. sudo version 1.8.27: + +`searchsploit sudo 1.8.27` + +- Show the exploit-db link to the found resources: + +`searchsploit --www {{search_terms}}` + +- Make a copy of the resource to the current directory (requires the number of the exploit): + +`searchsploit --mirror {{exploit_number}}` + +- Open the resource to read with the pager defined in the `$PAGER` environment variable: + +`searchsploit --explore {{exploit_number}}` + +- Update the local exploit database: + +`searchsploit --update` diff --git a/secrethub b/secrethub new file mode 100644 index 00000000..2e3d3bf8 --- /dev/null +++ b/secrethub @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# secrethub + +> Keep secrets out of config files. +> More information: . + +- Print a secret to `stdout`: + +`secrethub read {{path/to/secret}}` + +- Generate a random value and store it as a new or updated secret: + +`secrethub generate {{path/to/secret}}` + +- Store a value from the clipboard as a new or updated secret: + +`secrethub write --clip {{path/to/secret}}` + +- Store a value supplied on `stdin` as a new or updated secret: + +`echo "{{secret_value}}" | secrethub write {{path/to/secret}}` + +- Audit a repository or secret: + +`secrethub audit {{path/to/repo_or_secret}}` diff --git a/security-checker b/security-checker new file mode 100644 index 00000000..1cf46c72 --- /dev/null +++ b/security-checker @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# security-checker + +> Check if a PHP application uses dependencies with known security vulnerabilities. +> More information: . + +- Look for security issues in the project dependencies (based on the `composer.lock` file in the current directory): + +`security-checker security:check` + +- Use a specific `composer.lock` file: + +`security-checker security:check {{path/to/composer.lock}}` + +- Return results as a JSON object: + +`security-checker security:check --format=json` diff --git a/sed b/sed new file mode 100644 index 00000000..ca6587c9 --- /dev/null +++ b/sed @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sed + +> Edit text in a scriptable manner. +> See also: `awk`, `ed`. +> More information: . + +- Replace all `apple` (basic regex) occurrences with `mango` (basic regex) in all input lines and print the result to `stdout`: + +`{{command}} | sed 's/apple/mango/g'` + +- Execute a specific script [f]ile and print the result to `stdout`: + +`{{command}} | sed -f {{path/to/script.sed}}` + +- Print just a first line to `stdout`: + +`{{command}} | sed -n '1p'` diff --git a/semver b/semver new file mode 100644 index 00000000..2e4fd548 --- /dev/null +++ b/semver @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# semver + +> Semantic version string parser. +> More information: . + +- Check if a version string respects the semantic versioning format (prints an empty string if it does not match): + +`semver {{1.2}}` + +- Convert a version string to the semantic versioning format: + +`semver --coerce {{1.2}}` + +- Test if `1.2.3` matches the `^1.0` range (prints an empty string if it does not match): + +`semver {{1.2.3}} --range "{{^1.0}}"` + +- Test with multiple ranges: + +`semver {{1.2.3}} --range {{">=1.0"}} {{"<2.0"}}` + +- Test multiple version strings and return only the ones that match: + +`semver {{1.2.3}} {{2.0.0}} --range "{{^1.0}}"` diff --git a/sendmail b/sendmail new file mode 100644 index 00000000..735d43ec --- /dev/null +++ b/sendmail @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sendmail + +> Send email. +> More information: . + +- Send a message with the content of `message.txt` to the mail directory of local user `username`: + +`sendmail {{username}} < {{message.txt}}` + +- Send an email from you@yourdomain.com (assuming the mail server is configured for this) to test@gmail.com containing the message in `message.txt`: + +`sendmail -f {{you@yourdomain.com}} {{test@gmail.com}} < {{message.txt}}` + +- Send an email from you@yourdomain.com (assuming the mail server is configured for this) to test@gmail.com containing the file `file.zip`: + +`sendmail -f {{you@yourdomain.com}} {{test@gmail.com}} < {{file.zip}}` diff --git a/seq b/seq new file mode 100644 index 00000000..e06dca34 --- /dev/null +++ b/seq @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# seq + +> Output a sequence of numbers to `stdout`. +> More information: . + +- Sequence from 1 to 10: + +`seq 10` + +- Every 3rd number from 5 to 20: + +`seq 5 3 20` + +- Separate the output with a space instead of a newline: + +`seq -s " " 5 3 20` + +- Format output width to a minimum of 4 digits padding with zeros as necessary: + +`seq -f "%04g" 5 3 20` diff --git a/sequelize b/sequelize new file mode 100644 index 00000000..77e87db2 --- /dev/null +++ b/sequelize @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sequelize + +> Promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. +> More information: . + +- Create a model with 3 fields and a migration file: + +`sequelize model:generate --name {{table_name}} --attributes {{field1:integer,field2:string,field3:boolean}}` + +- Run the migration file: + +`sequelize db:migrate` + +- Revert all migrations: + +`sequelize db:migrate:undo:all` + +- Create a seed file with the specified name to populate the database: + +`sequelize seed:generate --name {{seed_filename}}` + +- Populate database using all seed files: + +`sequelize db:seed:all` diff --git a/serialver b/serialver new file mode 100644 index 00000000..cf545e78 --- /dev/null +++ b/serialver @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# serialver + +> Returns the serialVersionUID of classes. +> It does not set a security manager by default. +> More information: . + +- Display the serialVersionUID of a class: + +`serialver {{classnames}}` + +- Display the serialVersionUID for a colon-separated list of classes and resources: + +`serialver -classpath {{path/to/directory}} {{classname1:classname2:...}}` + +- Use a specific option from reference page of Java application launcher to the Java Virtual Machine: + +`serialver -Joption {{classnames}}` diff --git a/serve b/serve new file mode 100644 index 00000000..8ab382d9 --- /dev/null +++ b/serve @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# serve + +> Static file serving and directory listing. +> More information: . + +- Start an HTTP server listening on the default port to serve the current directory: + +`serve` + +- Start an HTTP server on a specific [p]ort to serve a specific directory: + +`serve -p {{port}} {{path/to/directory}}` + +- Start an HTTP server with CORS enabled by including the `Access-Control-Allow-Origin: *` header in all responses: + +`serve --cors` + +- Start an HTTP server on the default port rewriting all not-found requests to the `index.html` file: + +`serve --single` + +- Start an HTTPS server on the default port using the specified certificate: + +`serve --ssl-cert {{path/to/cert.pem}} --ssl-key {{path/to/key.pem}}` + +- Start an HTTP server on the default port using a specific configuration file: + +`serve --config {{path/to/serve.json}}` + +- Display help: + +`serve --help` diff --git a/serverless b/serverless new file mode 100644 index 00000000..9377850e --- /dev/null +++ b/serverless @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# serverless + +> 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: . + +- Create a serverless project: + +`serverless create` + +- Create a serverless project from a template: + +`serverless create --template {{template_name}}` + +- Deploy to a cloud provider: + +`serverless deploy` + +- Display information about a serverless project: + +`serverless info` + +- Invoke a deployed function: + +`serverless invoke -f {{function_name}}` + +- Follow the logs for a project: + +`serverless logs -t` diff --git a/set b/set new file mode 100644 index 00000000..516da90d --- /dev/null +++ b/set @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# set + +> Toggle shell options or set the values of positional parameters. +> More information: . + +- Display the names and values of shell variables: + +`set` + +- Export newly initialized variables to child processes: + +`set -a` + +- Write formatted messages to `stderr` when jobs finish: + +`set -b` + +- Write and edit text in the command line with `vi`-like keybindings (e.g. `yy`): + +`set -o {{vi}}` + +- Exit the shell when (some) commands fail: + +`set -e` diff --git a/set-nodeinstalllocation b/set-nodeinstalllocation new file mode 100644 index 00000000..3d2f9dd2 --- /dev/null +++ b/set-nodeinstalllocation @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-NodeInstallLocation + +> Set the default Node.js installation directory for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Change the Node.js install location to a specified directory (`ps-nvm` will create a new `.nvm` subdirectory to install them): + +`Set-NodeInstallLocation {{path/to/directory}}` diff --git a/set-nodeversion b/set-nodeversion new file mode 100644 index 00000000..02e2db8c --- /dev/null +++ b/set-nodeversion @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-NodeVersion + +> Set the default Node.js version for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Use a specific version of Node.js in the current PowerShell session: + +`Set-NodeVersion {{node_version}}` + +- Use the latest installed Node.js version 20.x: + +`Set-NodeVersion ^20` + +- Set the default Node.js version for the current user (only applies to future PowerShell sessions): + +`Set-NodeVersion {{node_version}} -Persist User` + +- Set the default Node.js version for all users (must be run as Administrator/root and only applies to future PowerShell sessions): + +`Set-NodeVersion {{node_version}} -Persist Machine` diff --git a/sf b/sf new file mode 100644 index 00000000..956af009 --- /dev/null +++ b/sf @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sf + +> A powerful command line interface that simplifies development and build automation when working with your Salesforce org. +> More information: . + +- Authorize a Salesforce Organization: + +`sf force:auth:web:login --setalias {{organization}} --instanceurl {{organization_url}}` + +- List all authorized organizations: + +`sf force:org:list` + +- Open a specific organization in the default web browser: + +`sf force:org:open --targetusername {{organization}}` + +- Display information about a specific organization: + +`sf force:org:display --targetusername {{organization}}` + +- Push source metadata to an Organization: + +`sf force:source:push --targetusername {{organization}}` + +- Pull source metadata from an Organization: + +`sf force:source:pull --targetusername {{organization}}` + +- Generate a password for the organization's logged-in user: + +`sf force:user:password:generate --targetusername {{organization}}` + +- Assign a permission set for the organization's logged-in user: + +`sf force:user:permset:assign --permsetname {{permission_set_name}} --targetusername {{organization}}` diff --git a/sfdp b/sfdp new file mode 100644 index 00000000..41b926b0 --- /dev/null +++ b/sfdp @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sfdp + +> Render an image of a `scaled force-directed` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`sfdp -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`sfdp -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`sfdp -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | sfdp -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`sfdp -?` diff --git a/sftp b/sftp new file mode 100644 index 00000000..0f4a3ae7 --- /dev/null +++ b/sftp @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sftp + +> Secure File Transfer Program. +> Interactive program to copy files between hosts over SSH. +> For non-interactive file transfers, see `scp` or `rsync`. +> More information: . + +- Connect to a remote server and enter an interactive command mode: + +`sftp {{remote_user}}@{{remote_host}}` + +- Connect using an alternate port: + +`sftp -P {{remote_port}} {{remote_user}}@{{remote_host}}` + +- Connect using a predefined host (in `~/.ssh/config`): + +`sftp {{host}}` + +- Transfer remote file to the local system: + +`get {{/path/remote_file}}` + +- Transfer local file to the remote system: + +`put {{/path/local_file}}` + +- Transfer remote directory to the local system recursively (works with `put` too): + +`get -R {{/path/remote_directory}}` + +- Get list of files on local machine: + +`lls` + +- Get list of files on remote machine: + +`ls` diff --git a/sg b/sg new file mode 100644 index 00000000..21c6d2ec --- /dev/null +++ b/sg @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sg + +> Ast-grep is a tool for code structural search, lint, and rewriting. +> More information: . + +- Scan for possible queries using interactive mode: + +`sg scan --interactive` + +- Rewrite code in the current directory using patterns: + +`sg run --pattern '{{foo}}' --rewrite '{{bar}}' --lang {{python}}` + +- Visualize possible changes without applying them: + +`sg run --pattern '{{useState($A)}}' --rewrite '{{useState($A)}}' --lang {{typescript}}` + +- Output results as JSON, extract information using `jq` and interactively view it using `jless`: + +`sg run --pattern '{{Some($A)}}' --rewrite '{{None}}' --json | jq '{{.[].replacement}}' | jless` diff --git a/sgitopnm b/sgitopnm new file mode 100644 index 00000000..0e5700f0 --- /dev/null +++ b/sgitopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sgitopnm + +> Convert an SGI file to a PNM file. +> More information: . + +- Convert an SGI image to a PNM file: + +`sgitopnm {{path/to/input.sgi}} > {{path/to/output.pnm}}` + +- Display information about the SGI file: + +`sgitopnm -verbose {{path/to/input.sgi}} > {{path/to/output.pnm}}` + +- Extract channel n of the SGI file: + +`sgitopnm -channel {{n}} {{path/to/input.sgi}} > {{path/to/output.pnm}}` diff --git a/sgpt b/sgpt new file mode 100644 index 00000000..6a4b5ce8 --- /dev/null +++ b/sgpt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sgpt + +> Command-line productivity tool powered by OpenAI's GPT models. +> More information: . + +- Use it as a search engine, asking for the mass of the sun: + +`sgpt "{{mass of the sun}}"` + +- Execute Shell commands, and apply `chmod 444` to all files in the current directory: + +`sgpt --shell "{{make all files in current directory read only}}"` + +- Generate code, solving classic fizz buzz problem: + +`sgpt --code "{{solve fizz buzz problem using Python}}"` + +- Start a chat session with a unique session name: + +`sgpt --chat {{session_name}} "{{please remember my favorite number: 4}}"` + +- Start a `REPL` (Read–eval–print loop) session: + +`sgpt --repl {{command}}` + +- Display help: + +`sgpt --help` diff --git a/sh b/sh new file mode 100644 index 00000000..009148ad --- /dev/null +++ b/sh @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sh + +> Bourne shell, the standard command language interpreter. +> See also `histexpand` for history expansion. +> More information: . + +- Start an interactive shell session: + +`sh` + +- Execute a command and then exit: + +`sh -c "{{command}}"` + +- Execute a script: + +`sh {{path/to/script.sh}}` + +- Read and execute commands from `stdin`: + +`sh -s` diff --git a/sha1sum b/sha1sum new file mode 100644 index 00000000..2efe99f8 --- /dev/null +++ b/sha1sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sha1sum + +> Calculate SHA1 cryptographic checksums. +> More information: . + +- Calculate the SHA1 checksum for one or more files: + +`sha1sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of SHA1 checksums to a file: + +`sha1sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha1}}` + +- Calculate a SHA1 checksum from `stdin`: + +`{{command}} | sha1sum` + +- Read a file of SHA1 sums and filenames and verify all files have matching checksums: + +`sha1sum --check {{path/to/file.sha1}}` + +- Only show a message for missing files or when verification fails: + +`sha1sum --check --quiet {{path/to/file.sha1}}` + +- Only show a message when verification fails, ignoring missing files: + +`sha1sum --ignore-missing --check --quiet {{path/to/file.sha1}}` diff --git a/sha224sum b/sha224sum new file mode 100644 index 00000000..34542822 --- /dev/null +++ b/sha224sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sha224sum + +> Calculate SHA224 cryptographic checksums. +> More information: . + +- Calculate the SHA224 checksum for one or more files: + +`sha224sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of SHA224 checksums to a file: + +`sha224sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha224}}` + +- Calculate a SHA224 checksum from `stdin`: + +`{{command}} | sha224sum` + +- Read a file of SHA224 sums and filenames and verify all files have matching checksums: + +`sha224sum --check {{path/to/file.sha224}}` + +- Only show a message for missing files or when verification fails: + +`sha224sum --check --quiet {{path/to/file.sha224}}` + +- Only show a message when verification fails, ignoring missing files: + +`sha224sum --ignore-missing --check --quiet {{path/to/file.sha224}}` diff --git a/sha256sum b/sha256sum new file mode 100644 index 00000000..855f91a1 --- /dev/null +++ b/sha256sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sha256sum + +> Calculate SHA256 cryptographic checksums. +> More information: . + +- Calculate the SHA256 checksum for one or more files: + +`sha256sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of SHA256 checksums to a file: + +`sha256sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha256}}` + +- Calculate a SHA256 checksum from `stdin`: + +`{{command}} | sha256sum` + +- Read a file of SHA256 sums and filenames and verify all files have matching checksums: + +`sha256sum --check {{path/to/file.sha256}}` + +- Only show a message for missing files or when verification fails: + +`sha256sum --check --quiet {{path/to/file.sha256}}` + +- Only show a message when verification fails, ignoring missing files: + +`sha256sum --ignore-missing --check --quiet {{path/to/file.sha256}}` diff --git a/sha384sum b/sha384sum new file mode 100644 index 00000000..9e909259 --- /dev/null +++ b/sha384sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sha384sum + +> Calculate SHA384 cryptographic checksums. +> More information: . + +- Calculate the SHA384 checksum for one or more files: + +`sha384sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of SHA384 checksums to a file: + +`sha384sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha384}}` + +- Calculate a SHA384 checksum from `stdin`: + +`{{command}} | sha384sum` + +- Read a file of SHA384 sums and filenames and verify all files have matching checksums: + +`sha384sum --check {{path/to/file.sha384}}` + +- Only show a message for missing files or when verification fails: + +`sha384sum --check --quiet {{path/to/file.sha384}}` + +- Only show a message when verification fails, ignoring missing files: + +`sha384sum --ignore-missing --check --quiet {{path/to/file.sha384}}` diff --git a/sha512sum b/sha512sum new file mode 100644 index 00000000..ea646d4d --- /dev/null +++ b/sha512sum @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sha512sum + +> Calculate SHA512 cryptographic checksums. +> More information: . + +- Calculate the SHA512 checksum for one or more files: + +`sha512sum {{path/to/file1 path/to/file2 ...}}` + +- Calculate and save the list of SHA512 checksums to a file: + +`sha512sum {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha512}}` + +- Calculate a SHA512 checksum from `stdin`: + +`{{command}} | sha512sum` + +- Read a file of SHA512 sums and filenames and verify all files have matching checksums: + +`sha512sum --check {{path/to/file.sha512}}` + +- Only show a message for missing files or when verification fails: + +`sha512sum --check --quiet {{path/to/file.sha512}}` + +- Only show a message when verification fails, ignoring missing files: + +`sha512sum --ignore-missing --check --quiet {{path/to/file.sha512}}` diff --git a/shar b/shar new file mode 100644 index 00000000..2549e994 --- /dev/null +++ b/shar @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shar + +> Create a shell archive. +> More information: . + +- Create a shell script that when executed extracts the given files from itself: + +`shar {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` diff --git a/shards b/shards new file mode 100644 index 00000000..a6018ce9 --- /dev/null +++ b/shards @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shards + +> Dependency management tool for the Crystal language. +> More information: . + +- Create a skeleton `shard.yml` file: + +`shards init` + +- Install dependencies from a `shard.yml` file: + +`shards install` + +- Update all dependencies: + +`shards update` + +- List all installed dependencies: + +`shards list` + +- Display version of dependency: + +`shards version {{path/to/dependency_directory}}` diff --git a/shasum b/shasum new file mode 100644 index 00000000..c537fc9e --- /dev/null +++ b/shasum @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shasum + +> Calculate SHA cryptographic checksums. +> More information: . + +- Calculate the SHA1 checksum for one or more files: + +`shasum {{path/to/file1 path/to/file2 ...}}` + +- Calculate the SHA256 checksum for one or more files: + +`shasum --algorithm 256 {{path/to/file1 path/to/file2 ...}}` + +- Calculate the SHA512 checksum for one or more files: + +`shasum --algorithm 512 {{path/to/file1 path/to/file2 ...}}` + +- Calculate a SHA1 checksum from `stdin`: + +`{{command}} | shasum` + +- Calculate and save the list of SHA256 checksums to a file: + +`shasum --algorithm 256 {{path/to/file1 path/to/file2 ...}} > {{path/to/file.sha256}}` + +- Read a file of SHA1 sums and filenames and verify all files have matching checksums: + +`shasum --check {{path/to/file}}` + +- Only show a message for missing files or when verification fails: + +`shasum --check --quiet {{path/to/file}}` + +- Only show a message when verification fails, ignoring missing files: + +`shasum --ignore-missing --check --quiet {{path/to/file}}` diff --git a/shc b/shc new file mode 100644 index 00000000..4b3d60fc --- /dev/null +++ b/shc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shc + +> Generic shell script compiler. +> More information: . + +- Compile a shell script: + +`shc -f {{script}}` + +- Compile a shell script and specify an output binary file: + +`shc -f {{script}} -o {{binary}}` + +- Compile a shell script and set an expiration date for the executable: + +`shc -f {{script}} -e {{dd/mm/yyyy}}` + +- Compile a shell script and set a message to display upon expiration: + +`shc -f {{script}} -e {{dd/mm/yyyy}} -m "{{Please contact your provider}}"` diff --git a/shellcheck b/shellcheck new file mode 100644 index 00000000..fcddae8b --- /dev/null +++ b/shellcheck @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shellcheck + +> Shell script static analysis tool. +> Check shell scripts for errors, usage of deprecated/insecure features, and bad practices. +> More information: . + +- Check a shell script: + +`shellcheck {{path/to/script.sh}}` + +- Check a shell script interpreting it as the specified shell dialect (overrides the shebang at the top of the script): + +`shellcheck --shell {{sh|bash|dash|ksh}} {{path/to/script.sh}}` + +- Ignore one or more error types: + +`shellcheck --exclude {{SC1009,SC1073}} {{path/to/script.sh}}` + +- Also check any sourced shell scripts: + +`shellcheck --check-sourced {{path/to/script.sh}}` + +- Display output in the specified format (defaults to `tty`): + +`shellcheck --format {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}` + +- Enable one or more optional checks: + +`shellcheck --enable={{add-default-case|avoid-nullary-conditions}}` + +- List all available optional checks that are disabled by default: + +`shellcheck --list-optional` diff --git a/shfmt b/shfmt new file mode 100644 index 00000000..d65244ef --- /dev/null +++ b/shfmt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shfmt + +> Shell parser, formatter and interpreter. +> More information: . + +- Print a formatted version of a shell script: + +`shfmt {{path/to/file}}` + +- List unformatted files: + +`shfmt --list {{path/to/directory}}` + +- Write the result to the file instead of printing it to the terminal: + +`shfmt --write {{path/to/file}}` + +- Simplify the code, removing redundant pieces of syntax (i.e. removing "$" from vars in expressions): + +`shfmt --simplify {{path/to/file}}` diff --git a/shift b/shift new file mode 100644 index 00000000..c0ee29d6 --- /dev/null +++ b/shift @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shift + +> Move positional parameters. +> More information: . + +- Remove the first positional parameter: + +`shift` + +- Remove the first `N` positional parameters: + +`shift {{N}}` diff --git a/shiori b/shiori new file mode 100644 index 00000000..6c1d937a --- /dev/null +++ b/shiori @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shiori + +> Simple bookmark manager built with Go. +> More information: . + +- Import bookmarks from HTML Netscape bookmark format file: + +`shiori import {{path/to/bookmarks.html}}` + +- Save the specified URL as bookmark: + +`shiori add {{url}}` + +- List the saved bookmarks: + +`shiori print` + +- Open the saved bookmark in a browser: + +`shiori open {{bookmark_id}}` + +- Start the web interface for managing bookmarks at port 8181: + +`shiori serve --port {{8181}}` diff --git a/shopt b/shopt new file mode 100644 index 00000000..cafc47f8 --- /dev/null +++ b/shopt @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shopt + +> 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: . + +- List of all settable options and whether they are set: + +`shopt` + +- Set an option: + +`shopt -s {{option_name}}` + +- Unset an option: + +`shopt -u {{option_name}}` + +- Print a list of all options and their status formatted as runnable `shopt` commands: + +`shopt -p` + +- Display help: + +`help shopt` diff --git a/showfigfonts b/showfigfonts new file mode 100644 index 00000000..324a56de --- /dev/null +++ b/showfigfonts @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# showfigfonts + +> Display available figlet fonts. +> See also `figlet`. +> More information: . + +- Display available fonts: + +`showfigfonts` + +- Display available fonts using a specific text: + +`showfigfonts {{input_text}}` diff --git a/shred b/shred new file mode 100644 index 00000000..bac2ed16 --- /dev/null +++ b/shred @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shred + +> Overwrite files to securely delete data. +> More information: . + +- Overwrite a file: + +`shred {{path/to/file}}` + +- Overwrite a file and show progress on the screen: + +`shred --verbose {{path/to/file}}` + +- Overwrite a file, leaving [z]eros instead of random data: + +`shred --zero {{path/to/file}}` + +- Overwrite a file a specific [n]umber of times: + +`shred --iterations {{25}} {{path/to/file}}` + +- Overwrite a file and remove it: + +`shred --remove {{path/to/file}}` + +- Overwrite a file 100 times, add a final overwrite with [z]eros, remove the file after overwriting it and show [v]erbose progress on the screen: + +`shred -vzun 100 {{path/to/file}}` diff --git a/shuf b/shuf new file mode 100644 index 00000000..388462aa --- /dev/null +++ b/shuf @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# shuf + +> Generate random permutations. +> More information: . + +- Randomize the order of lines in a file and output the result: + +`shuf {{path/to/file}}` + +- Only output the first 5 entries of the result: + +`shuf --head-count={{5}} {{path/to/file}}` + +- Write the output to another file: + +`shuf {{path/to/input}} --output={{path/to/output}}` + +- Generate 3 random numbers in the range 1-10 (inclusive): + +`shuf --head-count={{3}} --input-range={{1-10}} --repeat` diff --git a/siege b/siege new file mode 100644 index 00000000..6604f07e --- /dev/null +++ b/siege @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# siege + +> HTTP loadtesting and benchmarking tool. +> More information: . + +- Test a URL with default settings: + +`siege {{https://example.com}}` + +- Test a list of URLs: + +`siege --file {{path/to/url_list.txt}}` + +- Test list of URLs in a random order (Simulates internet traffic): + +`siege --internet --file {{path/to/url_list.txt}}` + +- Benchmark a list of URLs (without waiting between requests): + +`siege --benchmark --file {{path/to/url_list.txt}}` + +- Set the amount of concurrent connections: + +`siege --concurrent={{50}} --file {{path/to/url_list.txt}}` + +- Set how long for the siege to run for: + +`siege --time={{30s}} --file {{path/to/url_list.txt}}` diff --git a/silicon b/silicon new file mode 100644 index 00000000..103758e5 --- /dev/null +++ b/silicon @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# silicon + +> Create an image of source code. +> More information: . + +- Generate an image from a specific source file: + +`silicon {{path/to/source_file}} --output {{path/to/output_image}}` + +- Generate an image from a source file with a specific programming language syntax highlighting (e.g. `rust`, `py`, `js`, etc.): + +`silicon {{path/to/source_file}} --output {{path/to/output_image}} --language {{language|extension}}` + +- Generate an image from `stdin`: + +`{{command}} | silicon --output {{path/to/output_image}}` diff --git a/simplehttpserver b/simplehttpserver new file mode 100644 index 00000000..2b31855e --- /dev/null +++ b/simplehttpserver @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# simplehttpserver + +> A simple HTTP/S server that supports file upload, basic authentication, and YAML rules for custom responses. +> A Go alternative to Python's `http.server`. +> More information: . + +- Start the HTTP server serving the current directory with verbose output (listen on all interfaces and port 8000 by default): + +`simplehttpserver -verbose` + +- Start the HTTP server with basic authentication serving a specific path over port 80 on all interfaces: + +`sudo simplehttpserver -basic-auth {{username}}:{{password}} -path {{/var/www/html}} -listen 0.0.0.0:80` + +- Start the HTTP server, enabling HTTPS using a self-signed certificate with custom SAN on all interfaces: + +`sudo simplehttpserver -https -domain {{*.selfsigned.com}} -listen 0.0.0.0:443` + +- Start the HTTP server with custom response headers and upload capability: + +`simplehttpserver -upload -header '{{X-Powered-By: Go}}' -header '{{Server: SimpleHTTPServer}}'` + +- Start the HTTP server with customizable rules in YAML (see documentation for DSL): + +`simplehttpserver -rules {{rules.yaml}}` diff --git a/sindresorhus b/sindresorhus new file mode 100644 index 00000000..cb81f259 --- /dev/null +++ b/sindresorhus @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sindresorhus + +> Sindre Sorhus's personal CLI. +> More information: . + +- Start Sindre's interactive CLI: + +`sindresorhus` diff --git a/singularity b/singularity new file mode 100644 index 00000000..7ee7633e --- /dev/null +++ b/singularity @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# singularity + +> Manage Singularity containers and images. +> More information: . + +- Download a remote image from Sylabs Cloud: + +`singularity pull --name {{image.sif}} {{library://godlovedc/funny/lolcow:latest}}` + +- Rebuild a remote image using the latest Singularity image format: + +`singularity build {{image.sif}} {{docker://godlovedc/lolcow}}` + +- Start a container from an image and get a shell inside it: + +`singularity shell {{image.sif}}` + +- Start a container from an image and run a command: + +`singularity exec {{image.sif}} {{command}}` + +- Start a container from an image and execute the internal runscript: + +`singularity run {{image.sif}}` + +- Build a singularity image from a recipe file: + +`sudo singularity build {{image.sif}} {{recipe}}` diff --git a/sirtopnm b/sirtopnm new file mode 100644 index 00000000..039c00ea --- /dev/null +++ b/sirtopnm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sirtopnm + +> Convert a Solitaire Image Recorder file to a PNM file. +> More information: . + +- Convert a SIR image to a PNM file: + +`sirtopnm {{path/to/input.sir}} > {{path/to/output.pnm}}` diff --git a/sk b/sk new file mode 100644 index 00000000..1b0eada4 --- /dev/null +++ b/sk @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sk + +> Fuzzy finder written in Rust. +> Similar to `fzf`. +> More information: . + +- Start `skim` on all files in the specified directory: + +`find {{path/to/directory}} -type f | sk` + +- Start `skim` for running processes: + +`ps aux | sk` + +- Start `skim` with a specified query: + +`sk --query "{{query}}"` + +- Select multiple files with `Shift + Tab` and write to a file: + +`find {{path/to/directory}} -type f | sk --multi > {{path/to/file}}` diff --git a/skaffold b/skaffold new file mode 100644 index 00000000..b04fe711 --- /dev/null +++ b/skaffold @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# skaffold + +> Facilitate continuous development for Kubernetes applications. +> More information: . + +- Build the artifacts: + +`skaffold build -f {{skaffold.yaml}}` + +- Build and deploy your app every time your code changes: + +`skaffold dev -f {{skaffold.yaml}}` + +- Run a pipeline file: + +`skaffold run -f {{skaffold.yaml}}` + +- Run a diagnostic on Skaffold: + +`skaffold diagnose -f {{skaffold.yaml}}` + +- Deploy the artifacts: + +`skaffold deploy -f {{skaffold.yaml}}` diff --git a/skate b/skate new file mode 100644 index 00000000..1187192e --- /dev/null +++ b/skate @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# skate + +> Simple and powerful key-value store. +> More information: . + +- Store a key and a value on the default database: + +`skate set "{{key}}" "{{value}}"` + +- Show your keys saved on the default database: + +`skate list` + +- Delete key and value from the default database: + +`skate delete "{{key}}"` + +- Create a new key and value in a new database: + +`skate set "{{key}}"@"{{database_name}}" "{{value}}"` + +- Show your keys saved in a non default database: + +`skate list @"{{database_name}}"` + +- Delete key and value from a specific database: + +`skate delete "{{key}}"@"{{database_name}}"` + +- Show the databases available: + +`skate list-dbs` + +- Delete local db and pull down fresh copy from Charm Cloud: + +`skate reset @"{{database_name}}"` diff --git a/skicka b/skicka new file mode 100644 index 00000000..27ad2e69 --- /dev/null +++ b/skicka @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# skicka + +> Manage your Google Drive. +> More information: . + +- Upload a file/folder to Google Drive: + +`skicka upload {{path/to/local}} {{path/to/remote}}` + +- Download a file/folder from Google Drive: + +`skicka download {{path/to/remote}} {{path/to/local}}` + +- List files: + +`skicka ls {{path/to/folder}}` + +- Show amount of space used by children folders: + +`skicka du {{path/to/parent/folder}}` + +- Create a folder: + +`skicka mkdir {{path/to/folder}}` + +- Delete a file: + +`skicka rm {{path/to/file}}` diff --git a/skopeo b/skopeo new file mode 100644 index 00000000..bb8c6f3d --- /dev/null +++ b/skopeo @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# skopeo + +> Container image management toolbox. +> Provides various utility commands to manage remote container images. +> More information: . + +- Inspect a remote image from a registry: + +`skopeo inspect docker://{{registry_hostname}}/{{image:tag}}` + +- List available tags for a remote image: + +`skopeo list-tags docker://{{registry_hostname}}/{{image}}` + +- Download an image from a registry: + +`skopeo copy docker://{{registry_hostname}}/{{image:tag}} dir:{{path/to/directory}}` + +- Copy an image from one registry to another: + +`skopeo copy docker://{{source_registry}}/{{image:tag}} docker://{{destination_registry}}/{{image:tag}}` + +- Delete an image from a registry: + +`skopeo delete docker://{{registry_hostname}}/{{image:tag}}` + +- Log in to a registry: + +`skopeo login --username {{username}} {{registry_hostname}}` diff --git a/sl b/sl new file mode 100644 index 00000000..6cf1def6 --- /dev/null +++ b/sl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sl + +> Steam locomotive running through your terminal. +> More information: . + +- Let a steam locomotive run through your terminal: + +`sl` + +- The train burns, people scream: + +`sl -a` + +- Let the train fly: + +`sl -F` + +- Make the train little: + +`sl -l` + +- Let the user exit (CTRL + C): + +`sl -e` diff --git a/slackcat b/slackcat new file mode 100644 index 00000000..9439b53d --- /dev/null +++ b/slackcat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# slackcat + +> Utility for passing files and command output to Slack. +> More information: . + +- Post a file to Slack: + +`slackcat --channel {{channel_name}} {{path/to/file}}` + +- Post a file to Slack with a custom filename: + +`slackcat --channel {{channel_name}} --filename={{filename}} {{path/to/file}}` + +- Pipe command output to Slack as a text snippet: + +`{{command}} | slackcat --channel {{channel_name}} --filename={{snippet_name}}` + +- Stream command output to Slack continuously: + +`{{command}} | slackcat --channel {{channel_name}} --stream` diff --git a/sldtoppm b/sldtoppm new file mode 100644 index 00000000..46057dc5 --- /dev/null +++ b/sldtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sldtoppm + +> Convert an AutoCAD slide file to a PPM image. +> More information: . + +- Convert an SLD file to a PPM image: + +`sldtoppm {{path/to/input.sld}} > {{path/to/output.ppm}}` + +- Compensate for non-square pixels by scaling the width of the image: + +`sldtoppm -adjust {{path/to/input.sld}} > {{path/to/output.ppm}}` diff --git a/sleep b/sleep new file mode 100644 index 00000000..901d6360 --- /dev/null +++ b/sleep @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sleep + +> Delay for a specified amount of time. +> More information: . + +- Delay in seconds: + +`sleep {{seconds}}` + +- Execute a specific command after 20 seconds delay: + +`sleep 20 && {{command}}` diff --git a/slimrb b/slimrb new file mode 100644 index 00000000..36c3d6ec --- /dev/null +++ b/slimrb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# slimrb + +> Convert Slim files to HTML. +> More information: . + +- Convert a Slim file to HTML: + +`slimrb {{input.slim}} {{output.html}}` + +- Convert a Slim file and output to prettified HTML: + +`slimrb --pretty {{input.slim}} {{output.html}}` + +- Convert a Slim file to ERB: + +`slimrb --erb {{input.slim}} {{output.erb}}` diff --git a/smalltalkci b/smalltalkci new file mode 100644 index 00000000..5817c4f0 --- /dev/null +++ b/smalltalkci @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# smalltalkci + +> Framework for testing Smalltalk projects with GitHub Actions, Travis CI, AppVeyor, GitLab CI, and others. +> More information: . + +- Run tests for a configuration file: + +`smalltalkci {{path/to/.smalltalk.ston}}` + +- Run tests for the `.smalltalk.ston` configuration in the current directory: + +`smalltalkci` + +- Debug tests in headful mode (show VM window): + +`smalltalkci --headful` + +- Download and prepare a well-known smalltalk image for the tests: + +`smalltalkci --smalltalk {{Squeak64-Trunk}}` + +- Specify a custom Smalltalk image and VM: + +`smalltalkci --image {{path/to/Smalltalk.image}} --vm {{path/to/vm}}` + +- Clean up caches and delete builds: + +`smalltalkci --clean` diff --git a/smartctl b/smartctl new file mode 100644 index 00000000..bb1c6b96 --- /dev/null +++ b/smartctl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# smartctl + +> Monitor disk health including SMART data. +> More information: . + +- Display SMART health summary: + +`sudo smartctl --health {{/dev/sdX}}` + +- Display device information: + +`sudo smartctl --info {{/dev/sdX}}` + +- Start a short self-test in the background: + +`sudo smartctl --test short {{/dev/sdX}}` + +- Display current/last self-test status and other SMART capabilities: + +`sudo smartctl --capabilities {{/dev/sdX}}` + +- Display exhaustive SMART data: + +`sudo smartctl --all {{/dev/sdX}}` diff --git a/smbmap b/smbmap new file mode 100644 index 00000000..0ec04a5e --- /dev/null +++ b/smbmap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# smbmap + +> Allow users to enumerate samba share drives across an entire domain. +> More information: . + +- Enumerate hosts with NULL sessions enabled and open shares: + +`smbmap --host-file {{path/to/file}}` + +- Enumerate hosts and check SMB file permissions: + +`smbmap --host-file {{path/to/file}} -u {{username}} -p {{password}} -q` + +- Connect to an ip or hostname through smb using a username and password: + +`smbmap -u {{username}} -p {{password}} -d {{domain}} -H {{ip_or_hostname}}` + +- Locate and download files [R]ecursively up to N levels depth, searching for filename pattern (regex), and excluding certain shares: + +`smbmap --host-file {{path/to/file}} -u {{username}} -p {{password}} -q -R --depth {{number}} --exclude {{sharename}} -A {{filepattern}}` + +- Upload file through smb using username and password: + +`smbmap -u {{username}} -p {{password}} -d {{domain}} -H {{ip_or_hostname}} --upload {{path/to/file}} '{{/share_name/remote_filename}}'` diff --git a/sn b/sn new file mode 100644 index 00000000..452bf518 --- /dev/null +++ b/sn @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sn + +> Mono StrongName utility for signing and verifying IL assemblies. +> More information: . + +- Generate a new StrongNaming key: + +`sn -k {{path/to/key.snk}}` + +- Re-sign an assembly with the specified private key: + +`sn -R {{path/to/assembly.dll}} {{path/to/key_pair.snk}}` + +- Show the public key of the private key that was used to sign an assembly: + +`sn -T {{path/to/assembly.exe}}` + +- Extract the public key to a file: + +`sn -e {{path/to/assembly.dll}} {{path/to/output.pub}}` diff --git a/snakefmt b/snakefmt new file mode 100644 index 00000000..977b16b8 --- /dev/null +++ b/snakefmt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# snakefmt + +> Format Snakemake files. +> More information: . + +- Format a specific Snakefile: + +`snakefmt {{path/to/snakefile}}` + +- Format all Snakefiles recursively in a specific directory: + +`snakefmt {{path/to/directory}}` + +- Format a file using a specific configuration file: + +`snakefmt --config {{path/to/config.toml}} {{path/to/snakefile}}` + +- Format a file using a specific maximum line length: + +`snakefmt --line-length {{100}} {{path/to/snakefile}}` + +- Display the changes that would be performed without performing them (dry-run): + +`snakefmt --diff {{path/to/snakefile}}` diff --git a/sngrep b/sngrep new file mode 100644 index 00000000..2286ef7c --- /dev/null +++ b/sngrep @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sngrep + +> Display SIP calls message flows from terminal. +> More information: . + +- Visualize SIP packets from a PCAP file: + +`sngrep -I {{path/to/file.pcap}}` + +- Visualize only dialogs starting with INVITE packets with RTP packets from a PCAP file: + +`sngrep -crI {{path/to/file.pcap}}` + +- Real-time interface with only dialogs starting with INVITE packets with RTP packets: + +`sngrep -cr` + +- Only capture packets without interface to a file: + +`sngrep -NO {{path/to/file.pcap}}` diff --git a/snort b/snort new file mode 100644 index 00000000..11192d4d --- /dev/null +++ b/snort @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# snort + +> Open-source network intrusion detection system. +> More information: . + +- Capture packets with verbose output: + +`sudo snort -v -i {{interface}}` + +- Capture packets and dump application layer data with verbose output: + +`sudo snort -vd -i {{interface}}` + +- Capture packets and display link layer packet headers with verbose output: + +`sudo snort -ve -i {{interface}}` + +- Capture packets and save them in the specified directory: + +`sudo snort -i {{interface}} -l {{path/to/directory}}` + +- Capture packets according to rules and save offending packets along with alerts: + +`sudo snort -i {{interface}} -c {{path/to/rules.conf}} -l {{path/to/directory}}` diff --git a/snowsql b/snowsql new file mode 100644 index 00000000..d8be22dc --- /dev/null +++ b/snowsql @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# snowsql + +> SnowSQL command-line client for Snowflake's Data Cloud. +> More information: . + +- Connect to a specific instance at (password can be provided in prompt or configuration file): + +`snowsql --accountname {{account}} --username {{username}} --dbname {{database}} --schemaname {{schema}}` + +- Connect to an instance specified by a specific configuration file (defaults to `~/.snowsql/config`): + +`snowsql --config {{path/to/configuration_file}}` + +- Connect to the default instance using a token for multi-factor authentication: + +`snowsql --mfa-passcode {{token}}` + +- Execute a single SQL query or SnowSQL command on the default connection (useful in shell scripts): + +`snowsql --query '{{query}}'` + +- Execute commands from a specific file on the default connection: + +`snowsql --filename {{path/to/file.sql}}` diff --git a/snyk b/snyk new file mode 100644 index 00000000..e6e978a6 --- /dev/null +++ b/snyk @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# snyk + +> Find vulnerabilities in your code and remediate risks. +> More information: . + +- Log in to your Snyk account: + +`snyk auth` + +- Test your code for any known vulnerabilities: + +`snyk test` + +- Test a local Docker image for any known vulnerabilities: + +`snyk test --docker {{docker_image}}` + +- Record the state of dependencies and any vulnerabilities on snyk.io: + +`snyk monitor` + +- Auto patch and ignore vulnerabilities: + +`snyk wizard` diff --git a/socat b/socat new file mode 100644 index 00000000..826af854 --- /dev/null +++ b/socat @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# socat + +> Multipurpose relay (SOcket CAT). +> More information: . + +- Listen to a port, wait for an incoming connection and transfer data to STDIO: + +`socat - TCP-LISTEN:8080,fork` + +- Listen on a port using SSL and print to STDOUT: + +`socat OPENSSL-LISTEN:4433,reuseaddr,cert=./cert.pem,cafile=./ca.cert.pem,key=./key.pem,verify=0 STDOUT` + +- Create a connection to a host and port, transfer data in STDIO to connected host: + +`socat - TCP4:www.example.com:80` + +- Forward incoming data of a local port to another host and port: + +`socat TCP-LISTEN:80,fork TCP4:www.example.com:80` diff --git a/solcjs b/solcjs new file mode 100644 index 00000000..85c63a59 --- /dev/null +++ b/solcjs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# solcjs + +> A set of JavaScript bindings for the Solidity compiler. +> More information: . + +- Compile a specific contract to hex: + +`solcjs --bin {{path/to/file.sol}}` + +- Compile the ABI of a specific contract: + +`solcjs --abi {{path/to/file.sol}}` + +- Specify a base path to resolve imports from: + +`solcjs --bin --base-path {{path/to/directory}} {{path/to/file.sol}}` + +- Specify one or more paths to include containing external code: + +`solcjs --bin --include-path {{path/to/directory}} {{path/to/file.sol}}` + +- Optimise the generated bytecode: + +`solcjs --bin --optimize {{path/to/file.sol}}` diff --git a/solo b/solo new file mode 100644 index 00000000..c3e0a344 --- /dev/null +++ b/solo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# solo + +> Interact with Solo hardware security keys. +> More information: . + +- List connected Solos: + +`solo ls` + +- Update the currently connected Solo's firmware to the latest version: + +`solo key update` + +- Blink the LED of a specific Solo: + +`solo key wink --serial {{serial_number}}` + +- Generate random bytes using the currently connected Solo's secure random number generator: + +`solo key rng raw` + +- Monitor the serial output of a Solo: + +`solo monitor {{path/to/serial_port}}` diff --git a/sonar-scanner b/sonar-scanner new file mode 100644 index 00000000..9493f44b --- /dev/null +++ b/sonar-scanner @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sonar-scanner + +> A generic scanner for SonarQube projects that do not use build tools such as Maven, Gradle, or Ant. +> More information: . + +- Scan a project with configuration file in your project's root directory named `sonar-project.properties`: + +`sonar-scanner` + +- Scan a project using configuration file other than `sonar-project.properties`: + +`sonar-scanner -D{{project.settings=myproject.properties}}` + +- Print debugging information: + +`sonar-scanner -X` + +- Display help: + +`sonar-scanner -h` diff --git a/sops b/sops new file mode 100644 index 00000000..a04b1563 --- /dev/null +++ b/sops @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sops + +> SOPS (Secrets OPerationS): manage secrets. +> More information: . + +- Encrypt a file: + +`sops -e {{path/to/myfile.json}} > {{path/to/myfile.enc.json}}` + +- Decrypt a file to `stdout`: + +`sops -d {{path/to/myfile.enc.json}}` + +- Rotate data keys for a sops file: + +`sops -r {{path/to/myfile.enc.yaml}}` + +- Change the extension of the file once encrypted: + +`sops -d --input-type json {{path/to/myfile.enc.json}}` + +- Extract keys by naming them, and array elements by numbering them: + +`sops -d --extract '["an_array"][1]' {{path/to/myfile.enc.json}}` + +- Show the difference between two sops files: + +`diff <(sops -d {{path/to/secret1.enc.yaml}}) <(sops -d {{path/to/secret2.enc.yaml}})` diff --git a/sort b/sort new file mode 100644 index 00000000..5499fd8e --- /dev/null +++ b/sort @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sort + +> Sort lines of text files. +> More information: . + +- Sort a file in ascending order: + +`sort {{path/to/file}}` + +- Sort a file in descending order: + +`sort --reverse {{path/to/file}}` + +- Sort a file in case-insensitive way: + +`sort --ignore-case {{path/to/file}}` + +- Sort a file using numeric rather than alphabetic order: + +`sort --numeric-sort {{path/to/file}}` + +- Sort `/etc/passwd` by the 3rd field of each line numerically, using ":" as a field separator: + +`sort --field-separator={{:}} --key={{3n}} {{/etc/passwd}}` + +- Sort a file preserving only unique lines: + +`sort --unique {{path/to/file}}` + +- Sort a file, printing the output to the specified output file (can be used to sort a file in-place): + +`sort --output={{path/to/file}} {{path/to/file}}` + +- Sort numbers with exponents: + +`sort --general-numeric-sort {{path/to/file}}` diff --git a/soupault b/soupault new file mode 100644 index 00000000..dab34154 --- /dev/null +++ b/soupault @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# soupault + +> A static website generator based on HTML element tree rewriting. +> It can also be used as an HTML post-processor or metadata extractor. +> More information: . + +- Initialize a minimal website project in the current working directory: + +`soupault --init` + +- Build a website: + +`soupault` + +- Override default configuration file and directory locations: + +`soupault --config {{config_path}} --site-dir {{input_dir}} --build-dir {{output_dir}}` + +- Extract metadata into a JSON file without generating pages: + +`soupault --index-only --dump-index-json {{path/to/file.json}}` + +- Show the effective configuration (values from `soupault.toml` plus defaults): + +`soupault --show-effective-config` diff --git a/source b/source new file mode 100644 index 00000000..fbda8762 --- /dev/null +++ b/source @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# source + +> Execute commands from a file in the current shell. +> More information: . + +- Evaluate contents of a given file: + +`source {{path/to/file}}` + +- Evaluate contents of a given file (alternatively replacing `source` with `.`): + +`. {{path/to/file}}` diff --git a/sox b/sox new file mode 100644 index 00000000..44561a0b --- /dev/null +++ b/sox @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sox + +> Sound eXchange: play, record and convert audio files. +> Audio formats are identified by the extension. +> More information: . + +- Merge two audio files into one: + +`sox -m {{path/to/input_audio1}} {{path/to/input_audio2}} {{path/to/output_audio}}` + +- Trim an audio file to the specified times: + +`sox {{path/to/input_audio}} {{path/to/output_audio}} trim {{start}} {{end}}` + +- Normalize an audio file (adjust volume to the maximum peak level, without clipping): + +`sox --norm {{path/to/input_audio}} {{path/to/output_audio}}` + +- Reverse and save an audio file: + +`sox {{path/to/input_audio}} {{path/to/output_audio}} reverse` + +- Print statistical data of an audio file: + +`sox {{path/to/input_audio}} -n stat` + +- Increase the volume of an audio file by 2x: + +`sox -v 2.0 {{path/to/input_audio}} {{path/to/output_audio}}` diff --git a/soxi b/soxi new file mode 100644 index 00000000..0bae649a --- /dev/null +++ b/soxi @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# soxi + +> SoXI - Sound eXchange Information, display sound file metadata. +> More information: . + +- Display the sound file metadata: + +`soxi {{path/to/file.wav}}` diff --git a/spark b/spark new file mode 100644 index 00000000..df19bb4b --- /dev/null +++ b/spark @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spark + +> The Laravel Spark command-line tool. +> More information: . + +- Register your API token: + +`spark register {{token}}` + +- Display the currently registered API token: + +`spark token` + +- Create a new Spark project: + +`spark new {{project_name}}` + +- Create a new Spark project with Braintree stubs: + +`spark new {{project_name}} --braintree` + +- Create a new Spark project with team-based billing stubs: + +`spark new {{project_name}} --team-billing` diff --git a/spatial b/spatial new file mode 100644 index 00000000..8b38c8a6 --- /dev/null +++ b/spatial @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spatial + +> A set of commands for managing and developing SpatialOS projects. +> More information: . + +- Run this when you use a project for the first time: + +`spatial worker build` + +- Build workers for local deployment on Unity on macOS: + +`spatial worker build --target=development --target=Osx` + +- Build workers for local deployment on Unreal on Windows: + +`spatial worker build --target=local --target=Windows` + +- Deploy locally: + +`spatial local launch {{launch_config}} --snapshot={{snapshot_file}}` + +- Launch a local worker to connect to your local deployment: + +`spatial local worker launch {{worker_type}} {{launch_config}}` + +- Upload an assembly to use for cloud deployments: + +`spatial cloud upload {{assembly_name}}` + +- Launch a cloud deployment: + +`spatial cloud launch {{assembly_name}} {{launch_config}} {{deployment_name}}` + +- Clean worker directories: + +`spatial worker clean` diff --git a/spctoppm b/spctoppm new file mode 100644 index 00000000..4e06d14c --- /dev/null +++ b/spctoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spctoppm + +> Convert an Atari compressed Spectrum image to a PPM image. +> More information: . + +- Convert an SPC file to a PPM image: + +`spctoppm {{path/to/input.spc}} > {{path/to/output.ppm}}` diff --git a/spectacle b/spectacle new file mode 100644 index 00000000..0d341f76 --- /dev/null +++ b/spectacle @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spectacle + +> KDE's screenshot utility. +> More information: . + +- Capture a screenshot of the entire desktop: + +`spectacle` + +- Capture a screenshot of the active window: + +`spectacle --activewindow` + +- Capture a screenshot of a specific region: + +`spectacle --region` diff --git a/speed-test b/speed-test new file mode 100644 index 00000000..b5aef20b --- /dev/null +++ b/speed-test @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# speed-test + +> Test your internet connection speed and ping using . +> More information: . + +- Test your internet connection and ping speed: + +`speed-test` + +- Print the results as JSON: + +`speed-test --json` + +- Print the results in megabytes per second (MBps): + +`speed-test --bytes` + +- Print more detailed information: + +`speed-test --verbose` diff --git a/speedcrunch b/speedcrunch new file mode 100644 index 00000000..932c127e --- /dev/null +++ b/speedcrunch @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# speedcrunch + +> A high-precision scientific calculator. +> More information: . + +- Start SpeedCrunch: + +`speedcrunch` + +- Copy the result of the most recent calculation: + +` + R` + +- Open the formula book: + +` + 1` + +- Clear the calculator of recent calculations: + +` + N` + +- Wrap highlighted in parentheses (defaults to wrapping all if nothing selected): + +` + P` + +- Load a speedcrunch session: + +` + L` + +- Save a speedcrunch session: + +` + S` + +- Toggle keypad: + +` + K` diff --git a/speedtest b/speedtest new file mode 100644 index 00000000..e323d0d5 --- /dev/null +++ b/speedtest @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# speedtest + +> Official command-line interface for testing internet bandwidth using https://speedtest.net. +> Note: some platforms link `speedtest` to `speedtest-cli`. If some of the examples in this page don't work, see `speedtest-cli`. +> More information: . + +- Run a speed test: + +`speedtest` + +- Run a speed test and specify the unit of the output: + +`speedtest --unit={{auto-decimal-bits|auto-decimal-bytes|auto-binary-bits|auto-binary-bytes}}` + +- Run a speed test and specify the output format: + +`speedtest --format={{human-readable|csv|tsv|json|jsonl|json-pretty}}` + +- Run a speed test and specify the number of decimal points to use (0 to 8, defaults to 2): + +`speedtest --precision={{precision}}` + +- Run a speed test and print its progress (only available for output format `human-readable` and `json`): + +`speedtest --progress={{yes|no}}` + +- List all `speedtest.net` servers, sorted by distance: + +`speedtest --servers` + +- Run a speed test to a specific `speedtest.net` server: + +`speedtest --server-id={{server_id}}` diff --git a/speedtest-cli b/speedtest-cli new file mode 100644 index 00000000..c79547cc --- /dev/null +++ b/speedtest-cli @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# speedtest-cli + +> Test internet bandwidth using . +> See also `speedtest` for the official CLI. +> More information: . + +- Run a speed test: + +`speedtest-cli` + +- Run a speed test and display values in bytes, instead of bits: + +`speedtest-cli --bytes` + +- Run a speed test using `HTTPS`, instead of `HTTP`: + +`speedtest-cli --secure` + +- Run a speed test without performing download tests: + +`speedtest-cli --no-download` + +- Run a speed test and generate an image of the results: + +`speedtest-cli --share` + +- List all `speedtest.net` servers, sorted by distance: + +`speedtest-cli --list` + +- Run a speed test to a specific speedtest.net server: + +`speedtest-cli --server {{server_id}}` + +- Run a speed test and display the results as JSON (suppresses progress information): + +`speedtest-cli --json` diff --git a/spfquery b/spfquery new file mode 100644 index 00000000..42665d8b --- /dev/null +++ b/spfquery @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spfquery + +> Query Sender Policy Framework records to validate e-mail senders. +> More information: . + +- Check if an IP address is allowed to send an e-mail from the specified e-mail address: + +`spfquery -ip {{8.8.8.8}} -sender {{sender@example.com}}` + +- Turn on debugging output: + +`spfquery -ip {{8.8.8.8}} -sender {{sender@example.com}} --debug` diff --git a/sphinx-build b/sphinx-build new file mode 100644 index 00000000..1ebc6b19 --- /dev/null +++ b/sphinx-build @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sphinx-build + +> Sphinx documentation generator. +> More information: . + +- Build documentation: + +`sphinx-build -b {{html|epub|text|latex|man|...}} {{path/to/source_dir}} {{path/to/build_dir}}` + +- Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package): + +`sphinx-build -b {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}` diff --git a/spicetify b/spicetify new file mode 100644 index 00000000..e7d65af4 --- /dev/null +++ b/spicetify @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spicetify + +> Customize the Spotify client UI and functionality. +> More information: . + +- Generate a configuration file on very first run and display help: + +`spicetify` + +- Backup and preprocess Spotify application files: + +`spicetify backup` + +- Print all configuration fields and values: + +`spicetify config` + +- Change the value of a configuration field: + +`spicetify config {{field}} {{value}}` + +- Apply the customization changes to Spotify: + +`spicetify apply` + +- Restore Spotify to its original state: + +`spicetify restore` diff --git a/spike b/spike new file mode 100644 index 00000000..62dfc51d --- /dev/null +++ b/spike @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spike + +> A fully featured static website generator written in JavaScript. +> More information: . + +- Create a new project using the default template: + +`spike new {{project_name}}` + +- Compile your project, watch for changes, and auto-reload the browser: + +`spike watch` + +- Compile your project once to the "public" directory: + +`spike compile` + +- Remove the output directory: + +`spike clean` diff --git a/split b/split new file mode 100644 index 00000000..ffed3e60 --- /dev/null +++ b/split @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# split + +> Split a file into pieces. +> More information: . + +- Split a file, each split having 10 lines (except the last split): + +`split -l {{10}} {{path/to/file}}` + +- Split a file into 5 files. File is split such that each split has same size (except the last split): + +`split -n {{5}} {{path/to/file}}` + +- Split a file with 512 bytes in each split (except the last split; use 512k for kilobytes and 512m for megabytes): + +`split -b {{512}} {{path/to/file}}` + +- Split a file with at most 512 bytes in each split without breaking lines: + +`split -C {{512}} {{path/to/file}}` diff --git a/sponge b/sponge new file mode 100644 index 00000000..a29e4f4d --- /dev/null +++ b/sponge @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sponge + +> Soak up the input before writing the output file. +> More information: . + +- Append file content to the source file: + +`cat {{path/to/file}} | sponge -a {{path/to/file}}` + +- Remove all lines starting with # in a file: + +`grep -v '^{{#}}' {{path/to/file}} | sponge {{path/to/file}}` diff --git a/spotdl b/spotdl new file mode 100644 index 00000000..33b7450b --- /dev/null +++ b/spotdl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# spotdl + +> Download Spotify playlists and songs along with metadata. +> More information: . + +- Download songs from the provided URLs and embed metadata: + +`spotdl {{open.spotify.com/playlist/playlistId open.spotify.com/track/trackId ...}}` + +- Start a web interface to download individual songs: + +`spotdl web` + +- Save only the metadata without downloading anything: + +`spotdl save {{open.spotify.com/playlist/playlistId ...}} --save-file {{path/to/save_file.spotdl}}` diff --git a/sputoppm b/sputoppm new file mode 100644 index 00000000..19c0095c --- /dev/null +++ b/sputoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sputoppm + +> Convert an Atari uncompressed Spectrum image to a PPM image. +> More information: . + +- Convert an SPU file to a PPM image: + +`sputoppm {{path/to/input.spu}} > {{path/to/output.ppm}}` diff --git a/sqlite-utils b/sqlite-utils new file mode 100644 index 00000000..0f948625 --- /dev/null +++ b/sqlite-utils @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sqlite-utils + +> Command-line tool used to manipulate SQLite databases in a number of different ways. +> More information: . + +- Create a database: + +`sqlite-utils create-database {{path/to/database.db}}` + +- Create a table: + +`sqlite-utils create-table {{path/to/database.db}} {{table_name}} {{id integer name text height float photo blob --pk id}}` + +- List tables: + +`sqlite-utils tables {{path/to/database.db}}` + +- Upsert a record: + +`{{echo '[ {"id": 1, "name": "Linus Torvalds"}, {"id": 2, "name": "Steve Wozniak"}, {"id": 3, "name": "Tony Hoare"} ]'}} | sqlite-utils upsert {{path/to/database.db}} {{table_name}} - {{--pk id}}` + +- Select records: + +`sqlite-utils rows {{path/to/database.db}} {{table_name}}` + +- Delete a record: + +`sqlite-utils query {{path/to/database.db}} "{{delete from table_name where name = 'Tony Hoare'}}"` + +- Drop a table: + +`sqlite-utils drop-table {{path/to/database.db}} {{table_name}}` + +- Display help: + +`sqlite-utils -h` diff --git a/sqlite3 b/sqlite3 new file mode 100644 index 00000000..212890d9 --- /dev/null +++ b/sqlite3 @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sqlite3 + +> The command-line interface to SQLite 3, which is a self-contained file-based embedded SQL engine. +> More information: . + +- Start an interactive shell with a new database: + +`sqlite3` + +- Open an interactive shell against an existing database: + +`sqlite3 {{path/to/database.sqlite3}}` + +- Execute an SQL statement against a database and then exit: + +`sqlite3 {{path/to/database.sqlite3}} '{{SELECT * FROM some_table;}}'` diff --git a/sqlmap b/sqlmap new file mode 100644 index 00000000..9da818e3 --- /dev/null +++ b/sqlmap @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sqlmap + +> Detect and exploit SQL injection flaws. +> More information: . + +- Run sqlmap against a single target URL: + +`python sqlmap.py -u "{{http://www.target.com/vuln.php?id=1}}"` + +- Send data in a POST request (`--data` implies POST request): + +`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{id=1}}"` + +- Change the parameter delimiter (& is the default): + +`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` + +- Select a random `User-Agent` from `./txt/user-agents.txt` and use it: + +`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --random-agent` + +- Provide user credentials for HTTP protocol authentication: + +`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` diff --git a/sqsc b/sqsc new file mode 100644 index 00000000..1dddd250 --- /dev/null +++ b/sqsc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sqsc + +> A command-line AWS Simple Queue Service client. +> More information: . + +- List all queues: + +`sqsc lq {{queue_prefix}}` + +- List all messages in a queue: + +`sqsc ls {{queue_name}}` + +- Copy all messages from one queue to another: + +`sqsc cp {{source_queue}} {{destination_queue}}` + +- Move all messages from one queue to another: + +`sqsc mv {{source_queue}} {{destination_queue}}` + +- Describe a queue: + +`sqsc describe {{queue_name}}` + +- Query a queue with SQL syntax: + +`sqsc query "SELECT body FROM {{queue_name}} WHERE body LIKE '%user%'"` + +- Pull all messages from a queue into a local SQLite database in your present working directory: + +`sqsc pull {{queue_name}}` diff --git a/srm b/srm new file mode 100644 index 00000000..4006183d --- /dev/null +++ b/srm @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# srm + +> Securely remove files or directories. +> Overwrites the existing data one or multiple times. Drop in replacement for rm. +> More information: . + +- Remove a file after a single-pass overwriting with random data: + +`srm -s {{path/to/file}}` + +- Remove a file after seven passes of overwriting with random data: + +`srm -m {{path/to/file}}` + +- Recursively remove a directory and its contents overwriting each file with a single-pass of random data: + +`srm -r -s {{path/to/directory}}` + +- Prompt before every removal: + +`srm -i {{\*}}` diff --git a/ss-local b/ss-local new file mode 100644 index 00000000..7099b322 --- /dev/null +++ b/ss-local @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ss-local + +> Run a Shadowsocks client as a SOCKS5 proxy. +> More information: . + +- Run a Shadowsocks proxy by specifying the host, server port, local port, password, and encryption method: + +`ss-local -s {{host}} -p {{server_port}} -l {{local port}} -k {{password}} -m {{encrypt_method}}` + +- Run a Shadowsocks proxy by specifying the configuration file: + +`ss-local -c {{path/to/config/file.json}}` + +- Use a plugin to run the proxy client: + +`ss-local --plugin {{plugin_name}} --plugin-opts {{plugin_options}}` + +- Enable TCP fast open: + +`ss-local --fast-open` diff --git a/ssh b/ssh new file mode 100644 index 00000000..d014e44d --- /dev/null +++ b/ssh @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh + +> Secure Shell is a protocol used to securely log onto remote systems. +> It can be used for logging or executing commands on a remote server. +> More information: . + +- Connect to a remote server: + +`ssh {{username}}@{{remote_host}}` + +- Connect to a remote server with a specific identity (private key): + +`ssh -i {{path/to/key_file}} {{username}}@{{remote_host}}` + +- Connect to a remote server using a specific port: + +`ssh {{username}}@{{remote_host}} -p {{2222}}` + +- Run a command on a remote server with a [t]ty allocation allowing interaction with the remote command: + +`ssh {{username}}@{{remote_host}} -t {{command}} {{command_arguments}}` + +- SSH tunneling: Dynamic port forwarding (SOCKS proxy on `localhost:1080`): + +`ssh -D {{1080}} {{username}}@{{remote_host}}` + +- SSH tunneling: Forward a specific port (`localhost:9999` to `example.org:80`) along with disabling pseudo-[T]ty allocation and executio[N] of remote commands: + +`ssh -L {{9999}}:{{example.org}}:{{80}} -N -T {{username}}@{{remote_host}}` + +- SSH jumping: Connect through a jumphost to a remote server (Multiple jump hops may be specified separated by comma characters): + +`ssh -J {{username}}@{{jump_host}} {{username}}@{{remote_host}}` + +- Agent forwarding: Forward the authentication information to the remote machine (see `man ssh_config` for available options): + +`ssh -A {{username}}@{{remote_host}}` diff --git a/ssh-add b/ssh-add new file mode 100644 index 00000000..6a7327c3 --- /dev/null +++ b/ssh-add @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh-add + +> Manage loaded SSH keys in the `ssh-agent`. +> Ensure that `ssh-agent` is up and running for the keys to be loaded in it. +> More information: . + +- Add the default ssh keys in `~/.ssh` to the ssh-agent: + +`ssh-add` + +- Add a specific key to the ssh-agent: + +`ssh-add {{path/to/private_key}}` + +- List fingerprints of currently loaded keys: + +`ssh-add -l` + +- Delete a key from the ssh-agent: + +`ssh-add -d {{path/to/private_key}}` + +- Delete all currently loaded keys from the ssh-agent: + +`ssh-add -D` + +- Add a key to the ssh-agent and the keychain: + +`ssh-add -K {{path/to/private_key}}` diff --git a/ssh-agent b/ssh-agent new file mode 100644 index 00000000..82ab6252 --- /dev/null +++ b/ssh-agent @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh-agent + +> Spawn an SSH Agent process. +> An SSH Agent holds SSH keys decrypted in memory until removed or the process is killed. +> See also `ssh-add`, which can add and manage keys held by an SSH Agent. +> More information: . + +- Start an SSH Agent for the current shell: + +`eval $(ssh-agent)` + +- Kill the currently running agent: + +`ssh-agent -k` diff --git a/ssh-copy-id b/ssh-copy-id new file mode 100644 index 00000000..0f69f7f2 --- /dev/null +++ b/ssh-copy-id @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh-copy-id + +> Install your public key in a remote machine's authorized_keys. +> More information: . + +- Copy your keys to the remote machine: + +`ssh-copy-id {{username}}@{{remote_host}}` + +- Copy the given public key to the remote: + +`ssh-copy-id -i {{path/to/certificate}} {{username}}@{{remote_host}}` + +- Copy the given public key to the remote with specific port: + +`ssh-copy-id -i {{path/to/certificate}} -p {{port}} {{username}}@{{remote_host}}` diff --git a/ssh-keygen b/ssh-keygen new file mode 100644 index 00000000..7367ffaa --- /dev/null +++ b/ssh-keygen @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh-keygen + +> Generate ssh keys used for authentication, password-less logins, and other things. +> More information: . + +- Generate a key interactively: + +`ssh-keygen` + +- Generate an ed25519 key with 32 key derivation function rounds and save the key to a specific file: + +`ssh-keygen -t {{ed25519}} -a {{32}} -f {{~/.ssh/filename}}` + +- Generate an RSA 4096-bit key with email as a comment: + +`ssh-keygen -t {{rsa}} -b {{4096}} -C "{{comment|email}}"` + +- Remove the keys of a host from the known_hosts file (useful when a known host has a new key): + +`ssh-keygen -R {{remote_host}}` + +- Retrieve the fingerprint of a key in MD5 Hex: + +`ssh-keygen -l -E {{md5}} -f {{~/.ssh/filename}}` + +- Change the password of a key: + +`ssh-keygen -p -f {{~/.ssh/filename}}` + +- Change the type of the key format (for example from OPENSSH format to PEM), the file will be rewritten in-place: + +`ssh-keygen -p -N "" -m {{PEM}} -f {{~/.ssh/OpenSSH_private_key}}` + +- Retrieve public key from secret key: + +`ssh-keygen -y -f {{~/.ssh/OpenSSH_private_key}}` diff --git a/ssh-keyscan b/ssh-keyscan new file mode 100644 index 00000000..76662f83 --- /dev/null +++ b/ssh-keyscan @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ssh-keyscan + +> Get the public ssh keys of remote hosts. +> More information: . + +- Retrieve all public ssh keys of a remote host: + +`ssh-keyscan {{host}}` + +- Retrieve all public ssh keys of a remote host listening on a specific port: + +`ssh-keyscan -p {{port}} {{host}}` + +- Retrieve certain types of public ssh keys of a remote host: + +`ssh-keyscan -t {{rsa,dsa,ecdsa,ed25519}} {{host}}` + +- Manually update the ssh known_hosts file with the fingerprint of a given host: + +`ssh-keyscan -H {{host}} >> ~/.ssh/known_hosts` diff --git a/sshd b/sshd new file mode 100644 index 00000000..e1e5e558 --- /dev/null +++ b/sshd @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sshd + +> Secure Shell Daemon - allows remote machines to securely log in to the current machine. +> Remote machines can execute commands as it is executed at this machine. +> More information: . + +- Start daemon in the background: + +`sshd` + +- Run sshd in the foreground: + +`sshd -D` + +- Run with verbose output (for debugging): + +`sshd -D -d` + +- Run on a specific port: + +`sshd -p {{port}}` diff --git a/sshfs b/sshfs new file mode 100644 index 00000000..47a1c20b --- /dev/null +++ b/sshfs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sshfs + +> Filesystem client based on SSH. +> More information: . + +- Mount remote directory: + +`sshfs {{username}}@{{remote_host}}:{{remote_directory}} {{mountpoint}}` + +- Unmount remote directory: + +`umount {{mountpoint}}` + +- Mount remote directory from server with specific port: + +`sshfs {{username}}@{{remote_host}}:{{remote_directory}} -p {{2222}}` + +- Use compression: + +`sshfs {{username}}@{{remote_host}}:{{remote_directory}} -C` + +- Follow symbolic links: + +`sshfs -o follow_symlinks {{username}}@{{remote_host}}:{{remote_directory}} {{mountpoint}}` diff --git a/sshpass b/sshpass new file mode 100644 index 00000000..7096cc37 --- /dev/null +++ b/sshpass @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sshpass + +> An ssh password provider. +> It works by creating a TTY, feeding the password into it, and then redirecting `stdin` to the ssh session. +> More information: . + +- Connect to a remote server using a password supplied on a file descriptor (in this case, `stdin`): + +`sshpass -d {{0}} ssh {{user}}@{{hostname}}` + +- Connect to a remote server with the password supplied as an option, and automatically accept unknown ssh keys: + +`sshpass -p {{password}} ssh -o StrictHostKeyChecking=no {{user}}@{{hostname}}` + +- Connect to a remote server using the first line of a file as the password, automatically accept unknown ssh keys, and launch a command: + +`sshpass -f {{path/to/file}} ssh -o StrictHostKeyChecking=no {{user}}@{{hostname}} "{{command}}"` diff --git a/sshuttle b/sshuttle new file mode 100644 index 00000000..ad1cba84 --- /dev/null +++ b/sshuttle @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sshuttle + +> Transparent proxy server that tunnels traffic over an SSH connection. +> Doesn't require root or any special setup on the remote SSH server, though root access on the local machine is prompted for. +> More information: . + +- Forward all IPv4 TCP traffic via a remote SSH server: + +`sshuttle --remote={{username}}@{{sshserver}} {{0.0.0.0/0}}` + +- Also forward all DNS traffic to the server's default DNS resolver: + +`sshuttle --dns --remote={{username}}@{{sshserver}} {{0.0.0.0/0}}` + +- Forward all traffic except that which is bound for a specific subnet: + +`sshuttle --remote={{username}}@{{sshserver}} {{0.0.0.0/0}} --exclude {{192.168.0.1/24}}` + +- Use the tproxy method to forward all IPv4 and IPv6 traffic: + +`sshuttle --method=tproxy --remote={{username}}@{{sshserver}} {{0.0.0.0/0}} {{::/0}} --exclude={{your_local_ip_address}} --exclude={{ssh_server_ip_address}}` diff --git a/sslscan b/sslscan new file mode 100644 index 00000000..2ccf8a21 --- /dev/null +++ b/sslscan @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sslscan + +> Check SSL/TLS protocols and ciphers supported by a server. +> More information: . + +- Test a server on port 443: + +`sslscan {{example.com}}` + +- Test a specified port: + +`sslscan {{example.com}}:{{465}}` + +- Show certificate information: + +`testssl --show-certificate {{example.com}}` diff --git a/st-flash b/st-flash new file mode 100644 index 00000000..9c9f4371 --- /dev/null +++ b/st-flash @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# st-flash + +> Flash binary files to STM32 ARM Cortex microcontrollers. +> More information: . + +- Read 4096 bytes from the device starting from 0x8000000: + +`st-flash read {{firmware}}.bin {{0x8000000}} {{4096}}` + +- Write firmware to device starting from 0x8000000: + +`st-flash write {{firmware}}.bin {{0x8000000}}` + +- Erase firmware from device: + +`st-flash erase` diff --git a/st-info b/st-info new file mode 100644 index 00000000..5e59c995 --- /dev/null +++ b/st-info @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# st-info + +> Provides information about connected STLink and STM32 devices. +> More information: . + +- Display amount of program memory available: + +`st-info --flash` + +- Display amount of SRAM memory available: + +`st-info --sram` + +- Display summarized information of the device: + +`st-info --probe` diff --git a/st-util b/st-util new file mode 100644 index 00000000..4234d777 --- /dev/null +++ b/st-util @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# st-util + +> Run GDB (GNU Debugger) server to interact with STM32 ARM Cortex microcontoller. +> More information: . + +- Run GDB server on port 4500: + +`st-util -p {{4500}}` + +- Connect to GDB server: + +`(gdb) target extended-remote {{localhost}}:{{4500}}` + +- Write firmware to device: + +`(gdb) load {{firmware.elf}}` diff --git a/st4topgm b/st4topgm new file mode 100644 index 00000000..185d1d04 --- /dev/null +++ b/st4topgm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# st4topgm + +> Convert an SBIG ST-4 file to PGM. +> More information: . + +- Convert an SBIG ST-4 file to a PGM file: + +`st4topgm {{path/to/input_file.st4}} > {{path/to/output.pgm}}` diff --git a/stack b/stack new file mode 100644 index 00000000..0d666d19 --- /dev/null +++ b/stack @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stack + +> Manage Haskell projects. +> More information: . + +- Create a new package: + +`stack new {{package}} {{template}}` + +- Compile a package: + +`stack build` + +- Run tests inside a package: + +`stack test` + +- Compile a project and re-compile every time a file changes: + +`stack build --file-watch` + +- Compile a project and execute a command after compilation: + +`stack build --exec "{{command}}"` + +- Run a program and pass an argument to it: + +`stack exec {{program}} -- {{argument}}` diff --git a/standard b/standard new file mode 100644 index 00000000..240fc158 --- /dev/null +++ b/standard @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# standard + +> The JavaScript Standard Style tool for linting and fixing JavaScript code. +> More information: . + +- Lint all JavaScript source files in the current directory: + +`standard` + +- Lint specific JavaScript file(s): + +`standard {{path/to/file1 path/to/file2 ...}}` + +- Apply automatic fixes during linting: + +`standard --fix` + +- Declare any available global variables: + +`standard --global {{variable}}` + +- Use a custom ESLint plugin when linting: + +`standard --plugin {{plugin}}` + +- Use a custom JS parser when linting: + +`standard --parser {{parser}}` + +- Use a custom ESLint environment when linting: + +`standard --env {{environment}}` diff --git a/standard-version b/standard-version new file mode 100644 index 00000000..cb0abddc --- /dev/null +++ b/standard-version @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# standard-version + +> Automate versioning and changelog generation, with SemVer and Conventional Commits. +> More information: . + +- Update the changelog file and tag a release: + +`standard-version` + +- Tag a release without bumping the version: + +`standard-version --first-release` + +- Update the changelog and tag an alpha release: + +`standard-version --prerelease alpha` + +- Update the changelog and tag a specific release type: + +`standard-version --release-as {{major|minor|patch}}` + +- Tag a release, preventing hooks from being verified during the commit step: + +`standard-version --no-verify` + +- Tag a release committing all staged changes, not just files affected by `standard-version`: + +`standard-version --commit-all` + +- Update a specific changelog file and tag a release: + +`standard-version --infile {{path/to/file.md}}` + +- Display the release that would be performed without performing them: + +`standard-version --dry-run` diff --git a/starship b/starship new file mode 100644 index 00000000..bc18930d --- /dev/null +++ b/starship @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# starship + +> The minimal, blazing-fast, and infinitely customizable prompt for any shell. +> Some subcommands such as `starship init` have their own usage documentation. +> More information: . + +- Print the starship integration code for the specified shell: + +`starship init {{bash|elvish|fish|ion|powershell|tcsh|zsh}}` + +- Explain each part of the current prompt and show the time taken to render them: + +`starship explain` + +- Print the computed starship configuration (use `--default` to print default configuration instead): + +`starship print-config` + +- List supported modules: + +`starship module --list` + +- Edit the starship configuration in the default editor: + +`starship configure` + +- Create a bug report GitHub issue pre-populated with information about the system and starship configuration: + +`starship bug-report` + +- Print the completion script for the specified shell: + +`starship completions {{bash|elvish|fish|powershell|zsh}}` + +- Display help for a subcommand: + +`starship {{subcommand}} --help` diff --git a/starship-init b/starship-init new file mode 100644 index 00000000..e1119854 --- /dev/null +++ b/starship-init @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# starship init + +> Print shell integration code for starship. +> More information: . + +- Print the starship integration code for the specified shell: + +`starship init {{bash|elvish|fish|ion|powershell|tcsh|zsh}}` + +- Append the `starship` integration code to `~/.bashrc`: + +`starship init {{bash}} >> {{~/.bashrc}}` + +- Append the `starship` integration code to `~/.zshrc`: + +`starship init {{zsh}} >> {{~/.zshrc}}` + +- Display help: + +`starship init --help` diff --git a/stat b/stat new file mode 100644 index 00000000..f28b6655 --- /dev/null +++ b/stat @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stat + +> Display file and filesystem information. +> More information: . + +- Display properties about a specific file such as size, permissions, creation and access dates among others: + +`stat {{path/to/file}}` + +- Display properties about a specific file such as size, permissions, creation and access dates among others without labels: + +`stat --terse {{path/to/file}}` + +- Display information about the filesystem where a specific file is located: + +`stat --file-system {{path/to/file}}` + +- Show only octal file permissions: + +`stat --format="%a %n" {{path/to/file}}` + +- Show the owner and group of a specific file: + +`stat --format="%U %G" {{path/to/file}}` + +- Show the size of a specific file in bytes: + +`stat --format="%s %n" {{path/to/file}}` diff --git a/stdbuf b/stdbuf new file mode 100644 index 00000000..ccc7357a --- /dev/null +++ b/stdbuf @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stdbuf + +> Run a command with modified buffering operations for its standard streams. +> More information: . + +- Change `stdin` buffer size to 512 KiB: + +`stdbuf --input={{512K}} {{command}}` + +- Change `stdout` buffer to line-buffered: + +`stdbuf --output={{L}} {{command}}` + +- Change `stderr` buffer to unbuffered: + +`stdbuf --error={{0}} {{command}}` diff --git a/steam b/steam new file mode 100644 index 00000000..acb27e35 --- /dev/null +++ b/steam @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# steam + +> Video game platform by Valve. +> More information: . + +- Launch Steam, printing debug messages to `stdout`: + +`steam` + +- Launch Steam and enable its in-app debug console tab: + +`steam -console` + +- Enable and open the Steam console tab in a running Steam instance: + +`steam steam://open/console` + +- Log into Steam with the specified credentials: + +`steam -login {{username}} {{password}}` + +- Launch Steam in Big Picture Mode: + +`steam -tenfoot` + +- Exit Steam: + +`steam -shutdown` diff --git a/steamcmd b/steamcmd new file mode 100644 index 00000000..2ac3be88 --- /dev/null +++ b/steamcmd @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# steamcmd + +> A command-line version of the Steam client. +> More information: . + +- Install or update an application anonymously: + +`steamcmd +login {{anonymous}} +app_update {{appid}} +quit` + +- Install or update an application using the specified credentials: + +`steamcmd +login {{username}} +app_update {{appid}} +quit` + +- Install an application for a specific platform: + +`steamcmd +@sSteamCmdForcePlatformType {{windows}} +login {{anonymous}} +app_update {{appid}} validate +quit` diff --git a/stern b/stern new file mode 100644 index 00000000..5d6d4984 --- /dev/null +++ b/stern @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stern + +> Tail multiple pods and containers from Kubernetes. +> More information: . + +- Tail all pods within a current namespace: + +`stern .` + +- Tail all pods with a specific status: + +`stern . --container-state {{running|waiting|terminated}}` + +- Tail all pods that matches a given regular expression: + +`stern {{pod_query}}` + +- Tail matched pods from all namespaces: + +`stern {{pod_query}} --all-namespaces` + +- Tail matched pods from 15 minutes ago: + +`stern {{pod_query}} --since {{15m}}` + +- Tail matched pods with a specific label: + +`stern {{pod_query}} --selector {{release=canary}}` diff --git a/stl2gts b/stl2gts new file mode 100644 index 00000000..520a2100 --- /dev/null +++ b/stl2gts @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stl2gts + +> Convert STL files into the GTS (GNU triangulated surface library) file format. +> More information: . + +- Convert an STL file to a GTS file: + +`stl2gts < {{path/to/file.stl}} > {{path/to/file.gts}}` + +- Convert an STL file to a GTS file and revert face normals: + +`stl2gts --revert < {{path/to/file.stl}} > {{path/to/file.gts}}` + +- Convert an STL file to a GTS file and do not merge vertices: + +`stl2gts --nomerge < {{path/to/file.stl}} > {{path/to/file.gts}}` + +- Convert an STL file to a GTS file and display surface statistics: + +`stl2gts --verbose < {{path/to/file.stl}} > {{path/to/file.gts}}` + +- Display help: + +`stl2gts --help` diff --git a/stolonctl b/stolonctl new file mode 100644 index 00000000..b2e338b3 --- /dev/null +++ b/stolonctl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stolonctl + +> CLI for Stolon, a cloud native PostgreSQL manager for PostgreSQL high availability. +> More information: . + +- Get cluster status: + +`stolonctl --cluster-name {{cluster_name}} --store-backend {{store_backend}} --store-endpoints {{store_endpoints}} status` + +- Get cluster data: + +`stolonctl --cluster-name {{cluster_name}} --store-backend {{store_backend}} --store-endpoints {{store_endpoints}} clusterdata` + +- Get cluster specification: + +`stolonctl --cluster-name {{cluster_name}} --store-backend {{store_backend}} --store-endpoints {{store_endpoints}} spec` + +- Update cluster specification with a patch in JSON format: + +`stolonctl --cluster-name {{cluster_name}} --store-backend {{store_backend}} --store-endpoints {{store_endpoints}} update --patch '{{cluster_spec}}'` diff --git a/stormlock b/stormlock new file mode 100644 index 00000000..8ab5e841 --- /dev/null +++ b/stormlock @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Stormlock + +> Centralized locking system. +> More information: . + +- Acquire a lease for resource: + +`stormlock acquire {{resource}}` + +- Release the given lease for the given resource: + +`stormlock release {{resource}} {{lease_id}}` + +- Show information on the current lease for a resource, if any: + +`stormlock current {{resource}}` + +- Test if a lease for given resource is currently active: + +`stormlock is-held {{resource}} {{lease_id}}` diff --git a/stow b/stow new file mode 100644 index 00000000..e8dd0e45 --- /dev/null +++ b/stow @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stow + +> Symlink manager. +> Often used to manage dotfiles. +> More information: . + +- Symlink all files recursively to a given directory: + +`stow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` + +- Delete symlinks recursively from a given directory: + +`stow --delete --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` + +- Simulate to see what the result would be like: + +`stow --simulate --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` + +- Delete and resymlink: + +`stow --restow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` + +- Exclude files matching a regular expression: + +`stow --ignore={{regular_expression}} --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` diff --git a/streamlink b/streamlink new file mode 100644 index 00000000..b1341feb --- /dev/null +++ b/streamlink @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# streamlink + +> Extracts streams from various services and pipes them into a video player of choice. +> More information: . + +- Attempt to extract streams from the URL specified, and if it's successful, print out a list of available streams to choose from: + +`streamlink {{example.com/stream}}` + +- Open a stream with the specified quality: + +`streamlink {{example.com/stream}} {{720p60}}` + +- Select the highest or lowest available quality: + +`streamlink {{example.com/stream}} {{best|worst}}` + +- Use a specific player to feed stream data to (VLC is used by default if found): + +`streamlink --player={{mpv}} {{example.com/stream}} {{best}}` + +- Skip a specific amount of time from the beginning of the stream. For live streams, this is a negative offset from the end of the stream (rewind): + +`streamlink --hls-start-offset {{[HH:]MM:SS}} {{example.com/stream}} {{best}}` + +- Skip to the beginning of a live stream, or as far back as possible: + +`streamlink --hls-live-restart {{example.com/stream}} {{best}}` + +- Write stream data to a file instead of playing it: + +`streamlink --output {{path/to/file.ts}} {{example.com/stream}} {{best}}` + +- Open the stream in the player, while at the same time writing it to a file: + +`streamlink --record {{path/to/file.ts}} {{example.com/stream}} {{best}}` diff --git a/stressapptest b/stressapptest new file mode 100644 index 00000000..11d5fa91 --- /dev/null +++ b/stressapptest @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stressapptest + +> Userspace memory and IO test. +> More information: . + +- Test the given amount of memory (in Megabytes): + +`stressapptest -M {{memory}}` + +- Test memory as well as I/O for the given file: + +`stressapptest -M {{memory}} -f {{path/to/file}}` + +- Test specifying the verbosity level, where 0=lowest, 20=highest, 8=default: + +`stressapptest -M {{memory}} -v {{level}}` diff --git a/strings b/strings new file mode 100644 index 00000000..c88fb559 --- /dev/null +++ b/strings @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# strings + +> Find printable strings in an object file or binary. +> More information: . + +- Print all strings in a binary: + +`strings {{path/to/file}}` + +- Limit results to strings at least n characters long: + +`strings -n {{n}} {{path/to/file}}` + +- Prefix each result with its offset within the file: + +`strings -t d {{path/to/file}}` + +- Prefix each result with its offset within the file in hexadecimal: + +`strings -t x {{path/to/file}}` diff --git a/strip-nondeterminism b/strip-nondeterminism new file mode 100644 index 00000000..0064a1ae --- /dev/null +++ b/strip-nondeterminism @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# strip-nondeterminism + +> Remove non-deterministic information (e.g. timestamps) from files. +> More information: . + +- Strip nondeterministic information from a file: + +`strip-nondeterminism {{path/to/file}}` + +- Strip nondeterministic information from a file manually specifying the filetype: + +`strip-nondeterminism --type {{filetype}} {{path/to/file}}` + +- Strip nondeterministic information from a file; instead of removing timestamps set them to the specified UNIX timestamp: + +`strip-nondeterminism --timestamp {{unix_timestamp}} {{path/to/file}}` diff --git a/stripe b/stripe new file mode 100644 index 00000000..45a19b12 --- /dev/null +++ b/stripe @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stripe + +> Interact with a Stripe account. +> More information: . + +- Follow the logs of activity on the account: + +`stripe logs tail` + +- Listen for events, filtering on events with the name `charge.succeeded` and forwarding them to localhost:3000/events: + +`stripe listen --events="{{charge.succeeded}}" --forward-to="{{localhost:3000/events}}"` + +- Send a test webhook event: + +`stripe trigger {{charge.succeeded}}` + +- Create a customer: + +`stripe customers create --email="{{test@example.com}}" --name="{{Jenny Rosen}}"` + +- Print to JSON: + +`stripe listen --print-json` diff --git a/stty b/stty new file mode 100644 index 00000000..2e3c3bb1 --- /dev/null +++ b/stty @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stty + +> Set options for a terminal device interface. +> More information: . + +- Display all settings for the current terminal: + +`stty --all` + +- Set the number of rows or columns: + +`stty {{rows|cols}} {{count}}` + +- Get the actual transfer speed of a device: + +`stty --file {{path/to/device_file}} speed` + +- Reset all modes to reasonable values for the current terminal: + +`stty sane` diff --git a/stun b/stun new file mode 100644 index 00000000..a3496036 --- /dev/null +++ b/stun @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stun + +> Classic STUN client. +> More information: . + +- Make a STUN request: + +`stun {{stun.1und1.de}}` + +- Make a STUN request and specify the source port: + +`stun {{stun.1und1.de}} -p {{4302}}` diff --git a/stylua b/stylua new file mode 100644 index 00000000..b4a0507f --- /dev/null +++ b/stylua @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# stylua + +> An opinionated Lua code formatter. +> More information: . + +- Auto-format a file or an entire directory: + +`stylua {{path/to/file_or_directory}}` + +- Check if a specific file has been formatted: + +`stylua --check {{path/to/file}}` + +- Run with a specific configuration file: + +`stylua --config-path {{path/to/config_file}} {{path/to/file}}` + +- Format code from `stdin` and output to `stdout`: + +`stylua - < {{path/to/file.lua}}` + +- Format a file or directory using spaces and preferring single quotes: + +`stylua --indent-type {{Spaces}} --quote-style {{AutoPreferSingle}} {{path/to/file_or_directory}}` diff --git a/su b/su new file mode 100644 index 00000000..c6b296da --- /dev/null +++ b/su @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# su + +> Switch shell to another user. +> More information: . + +- Switch to superuser (requires the root password): + +`su` + +- Switch to a given user (requires the user's password): + +`su {{username}}` + +- Switch to a given user and simulate a full login shell: + +`su - {{username}}` + +- Execute a command as another user: + +`su - {{username}} -c "{{command}}"` diff --git a/subfinder b/subfinder new file mode 100644 index 00000000..5bb9c6c7 --- /dev/null +++ b/subfinder @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# subfinder + +> Discover valid subdomains for websites. +> Designed as a passive framework to be useful for bug bounties and safe for penetration testing. +> More information: . + +- Find subdomains for a specific [d]omain: + +`subfinder -d {{example.com}}` + +- Show only the subdomains found: + +`subfinder --silent -d {{example.com}}` + +- Use a brute-force attack to find subdomains: + +`subfinder -d {{example.com}} -b` + +- Remove wildcard subdomains: + +`subfinder -nW -d {{example.com}}` + +- Use a given comma-separated list of [r]esolvers: + +`subfinder -r {{8.8.8.8,1.1.1.1,...}} -d {{example.com}}` diff --git a/subl b/subl new file mode 100644 index 00000000..3eafa7ef --- /dev/null +++ b/subl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# subl + +> Sublime Text editor. +> More information: . + +- Open the current directory in Sublime Text: + +`subl {{.}}` + +- Open a file or directory in Sublime Text: + +`subl {{path/to/file_or_directory}}` + +- Open a file and jump to a specific line number: + +`subl {{path/to/file}}:{{line_number}}` + +- Open a file or directory in the currently open window: + +`subl -a {{path/to/file}}` + +- Open a file or directory in a new window: + +`subl -n {{path/to/file}}` diff --git a/subliminal b/subliminal new file mode 100644 index 00000000..51e29085 --- /dev/null +++ b/subliminal @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# subliminal + +> Python-based subtitle downloader. +> More information: . + +- Download English subtitles for a video: + +`subliminal download -l {{en}} {{video.ext}}` diff --git a/sublist3r b/sublist3r new file mode 100644 index 00000000..ef3a1d86 --- /dev/null +++ b/sublist3r @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sublist3r + +> Fast subdomains enumeration tool for penetration testers. +> More information: . + +- Find subdomains for a domain: + +`sublist3r --domain {{domain_name}}` + +- Find subdomains for a domain, also enabling brute force search: + +`sublist3r --domain {{domain_name}} --bruteforce` + +- Save the found subdomains to a text file: + +`sublist3r --domain {{domain_name}} --output {{path/to/output_file}}` + +- Display help: + +`sublist3r --help` diff --git a/sudo b/sudo new file mode 100644 index 00000000..9e61cadf --- /dev/null +++ b/sudo @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sudo + +> Executes a single command as the superuser or another user. +> More information: . + +- Run a command as the superuser: + +`sudo {{less /var/log/syslog}}` + +- Edit a file as the superuser with your default editor: + +`sudo --edit {{/etc/fstab}}` + +- Run a command as another user and/or group: + +`sudo --user={{user}} --group={{group}} {{id -a}}` + +- Repeat the last command prefixed with `sudo` (only in `bash`, `zsh`, etc.): + +`sudo !!` + +- Launch the default shell with superuser privileges and run login-specific files (`.profile`, `.bash_profile`, etc.): + +`sudo --login` + +- Launch the default shell with superuser privileges without changing the environment: + +`sudo --shell` + +- Launch the default shell as the specified user, loading the user's environment and reading login-specific files (`.profile`, `.bash_profile`, etc.): + +`sudo --login --user={{user}}` + +- List the allowed (and forbidden) commands for the invoking user: + +`sudo --list` diff --git a/sum b/sum new file mode 100644 index 00000000..f2ae8851 --- /dev/null +++ b/sum @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sum + +> Compute checksums and the number of blocks for a file. +> A predecessor to the more modern `cksum`. +> More information: . + +- Compute a checksum with BSD-compatible algorithm and 1024-byte blocks: + +`sum {{path/to/file}}` + +- Compute a checksum with System V-compatible algorithm and 512-byte blocks: + +`sum --sysv {{path/to/file}}` diff --git a/sunos/devfsadm b/sunos/devfsadm new file mode 100644 index 00000000..0348a763 --- /dev/null +++ b/sunos/devfsadm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# devfsadm + +> Administration command for `/dev`. Maintains the `/dev` namespace. +> More information: . + +- Scan for new disks: + +`devfsadm -c disk` + +- Cleanup any dangling /dev links and scan for new device: + +`devfsadm -C -v` + +- Dry-run - output what would be changed but make no modifications: + +`devfsadm -C -v -n` diff --git a/sunos/dmesg b/sunos/dmesg new file mode 100644 index 00000000..482b2d51 --- /dev/null +++ b/sunos/dmesg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# dmesg + +> Write the kernel messages to `stdout`. +> More information: . + +- Show kernel messages: + +`dmesg` + +- Show how much physical memory is available on this system: + +`dmesg | grep -i memory` + +- Show kernel messages 1 page at a time: + +`dmesg | less` diff --git a/sunos/prctl b/sunos/prctl new file mode 100644 index 00000000..470c6939 --- /dev/null +++ b/sunos/prctl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# prctl + +> Get or set the resource controls of running processes, tasks, and projects. +> More information: . + +- Examine process limits and permissions: + +`prctl {{pid}}` + +- Examine process limits and permissions in machine parsable format: + +`prctl -P {{pid}}` + +- Get specific limit for a running process: + +`prctl -n process.max-file-descriptor {{pid}}` diff --git a/sunos/prstat b/sunos/prstat new file mode 100644 index 00000000..f2800ee4 --- /dev/null +++ b/sunos/prstat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# prstat + +> Report active process statistics. +> More information: . + +- Examine all processes and reports statistics sorted by CPU usage: + +`prstat` + +- Examine all processes and reports statistics sorted by memory usage: + +`prstat -s rss` + +- Report total usage summary for each user: + +`prstat -t` + +- Report microstate process accounting information: + +`prstat -m` + +- Print out a list of top 5 CPU using processes every second: + +`prstat -c -n {{5}} -s cpu {{1}}` diff --git a/sunos/snoop b/sunos/snoop new file mode 100644 index 00000000..d0825131 --- /dev/null +++ b/sunos/snoop @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# snoop + +> Network packet sniffer. +> SunOS equivalent of tcpdump. +> More information: . + +- Capture packets on a specific network interface: + +`snoop -d {{e1000g0}}` + +- Save captured packets in a file instead of displaying them: + +`snoop -o {{path/to/file}}` + +- Display verbose protocol layer summary of packets from a file: + +`snoop -V -i {{path/to/file}}` + +- Capture network packets that come from a hostname and go to a given port: + +`snoop to port {{port}} from host {{hostname}}` + +- Capture and show a hex-dump of network packets exchanged between two IP addresses: + +`snoop -x0 -p4 {{ip1}} {{ip2}}` diff --git a/sunos/svcadm b/sunos/svcadm new file mode 100644 index 00000000..ec7a8f2f --- /dev/null +++ b/sunos/svcadm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# svcadm + +> Manipulate service instances. +> More information: . + +- Enable a service in the service database: + +`svcadm enable {{service_name}}` + +- Disable service: + +`svcadm disable {{service_name}}` + +- Restart a running service: + +`svcadm restart {{service_name}}` + +- Command service to re-read configuration files: + +`svcadm refresh {{service_name}}` + +- Clear a service from maintenance state and command it to start: + +`svcadm clear {{service_name}}` diff --git a/sunos/svccfg b/sunos/svccfg new file mode 100644 index 00000000..3e2b4aa6 --- /dev/null +++ b/sunos/svccfg @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# svccfg + +> Import, export, and modify service configurations. +> More information: . + +- Validate configuration file: + +`svccfg validate {{path/to/smf_file.xml}}` + +- Export service configurations to file: + +`svccfg export {{servicename}} > {{path/to/smf_file.xml}}` + +- Import/update service configurations from file: + +`svccfg import {{path/to/smf_file.xml}}` diff --git a/sunos/svcs b/sunos/svcs new file mode 100644 index 00000000..58050006 --- /dev/null +++ b/sunos/svcs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# svcs + +> List information about running services. +> More information: . + +- List all running services: + +`svcs` + +- List services that are not running: + +`svcs -vx` + +- List information about a service: + +`svcs apache` + +- Show location of service log file: + +`svcs -L apache` + +- Display end of a service log file: + +`tail $(svcs -L apache)` diff --git a/sunos/truss b/sunos/truss new file mode 100644 index 00000000..d7606674 --- /dev/null +++ b/sunos/truss @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# truss + +> Troubleshooting tool for tracing system calls. +> SunOS equivalent of strace. +> More information: . + +- Start tracing a program by executing it, following all child processes: + +`truss -f {{program}}` + +- Start tracing a specific process by its PID: + +`truss -p {{pid}}` + +- Start tracing a program by executing it, showing arguments and environment variables: + +`truss -a -e {{program}}` + +- Count time, calls, and errors for each system call and report a summary on program exit: + +`truss -c -p {{pid}}` + +- Trace a process filtering output by system call: + +`truss -p {{pid}} -t {{system_call_name}}` diff --git a/sup b/sup new file mode 100644 index 00000000..8f3afdbc --- /dev/null +++ b/sup @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sup + +> Manage a RSS feed in the current directory. +> See also: `lb`. +> More information: . + +- Add an article to the RSS feed: + +`sup {{path/to/file.html}}` diff --git a/supervisorctl b/supervisorctl new file mode 100644 index 00000000..b1088b40 --- /dev/null +++ b/supervisorctl @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# supervisorctl + +> Supervisor is a client/server system that allows its users to control a number of processes on UNIX-like operating systems. +> Supervisorctl is the command-line client piece of the supervisor which provides a shell-like interface. +> More information: . + +- Show the status of a process (or all processes if `process_name` is not specified): + +`supervisorctl status {{process_name}}` + +- Start/stop/restart a process: + +`supervisorctl {{start|stop|restart}} {{process_name}}` + +- Start/stop/restart all processes in a group: + +`supervisorctl {{start|stop|restart}} {{group_name}}:*` + +- Show last 100 bytes of process `stderr`: + +`supervisorctl tail -100 {{process_name}} stderr` + +- Keep displaying `stdout` of a process: + +`supervisorctl tail -f {{process_name}} stdout` + +- Reload process configuration file to add/remove processes as necessary: + +`supervisorctl update` diff --git a/supervisord b/supervisord new file mode 100644 index 00000000..250ee847 --- /dev/null +++ b/supervisord @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# supervisord + +> Supervisor is a client/server system for controlling some processes on UNIX-like operating systems. +> Supervisord is the server part of supervisor; it is primarily managed via a configuration file. +> More information: . + +- Start `supervisord` with specified configuration file: + +`supervisord -c {{path/to/file}}` + +- Run supervisord in the foreground: + +`supervisord -n` diff --git a/surfraw b/surfraw new file mode 100644 index 00000000..a35f0792 --- /dev/null +++ b/surfraw @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# surfraw + +> Query a variety of web search engines. +> Consists of a collection of elvi, each of which knows how to search a website. +> More information: . + +- Display the list of supported website search scripts (elvi): + +`surfraw -elvi` + +- Open the elvi's results page for a specific search in the browser: + +`surfraw {{elvi}} "{{search_terms}}"` + +- Display an elvi description and its specific options: + +`surfraw {{elvi}} -local-help` + +- Search using an elvi with specific options and open the results page in the browser: + +`surfraw {{elvi}} {{elvi_options}} "{{search_terms}}"` + +- Display the URL to the elvi's results page for a specific search: + +`surfraw -print {{elvi}} "{{search_terms}}"` + +- Search using the alias: + +`sr {{elvi}} "{{search_terms}}"` diff --git a/surge b/surge new file mode 100644 index 00000000..08d00042 --- /dev/null +++ b/surge @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# surge + +> Simple web publishing. +> More information: . + +- Upload a new site to surge.sh: + +`surge {{path/to/my_project}}` + +- Deploy site to custom domain (note that the DNS records must point to the surge.sh subdomain): + +`surge {{path/to/my_project}} {{my_custom_domain.com}}` + +- List your surge projects: + +`surge list` + +- Remove a project: + +`surge teardown {{my_custom_domain.com}}` diff --git a/sv b/sv new file mode 100644 index 00000000..25fb1861 --- /dev/null +++ b/sv @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sv + +> Control a running runsv service. +> More information: . + +- Start a service: + +`sudo sv up {{path/to/service}}` + +- Stop a service: + +`sudo sv down {{path/to/service}}` + +- Get service status: + +`sudo sv status {{path/to/service}}` + +- Reload a service: + +`sudo sv reload {{path/to/service}}` + +- Start a service, but only if it's not running and don't restart it if it stops: + +`sudo sv once {{path/to/service}}` diff --git a/svgcleaner b/svgcleaner new file mode 100644 index 00000000..46aa0849 --- /dev/null +++ b/svgcleaner @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# svgcleaner + +> SVG optimizing utility. +> More information: . + +- Optimize an SVG: + +`svgcleaner {{input.svg}} {{output.svg}}` + +- Optimize an SVG multiple times: + +`svgcleaner --multipass {{input.svg}} {{output.svg}}` diff --git a/svgo b/svgo new file mode 100644 index 00000000..c983ac4e --- /dev/null +++ b/svgo @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# svgo + +> SVG Optimizer: optimizing Scalable Vector Graphics files. Based in Node.js. +> It applies a series of transformation rules (plugins), which can be toggled individually. +> More information: . + +- Optimize a file using the default plugins (overwrites the original file): + +`svgo {{test.svg}}` + +- Optimize a file and save the result to another file: + +`svgo {{test.svg}} -o {{test.min.svg}}` + +- Optimize all SVG files within a directory (overwrites the original files): + +`svgo -f {{path/to/directory/with/svg/files}}` + +- Optimize all SVG files within a directory and save the resulting files to another directory: + +`svgo -f {{path/to/input/directory}} -o {{path/to/output/directory}}` + +- Optimize SVG content passed from another command, and save the result to a file: + +`{{cat test.svg}} | svgo -i - -o {{test.min.svg}}` + +- Optimize a file and print out the result: + +`svgo {{test.svg}} -o -` + +- Show available plugins: + +`svgo --show-plugins` diff --git a/svgr b/svgr new file mode 100644 index 00000000..1d6f83e2 --- /dev/null +++ b/svgr @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# svgr + +> Transform SVGs into React components. +> More information: . + +- Transform a SVG file into a React component to `stdout`: + +`svgr -- {{path/to/file.svg}}` + +- Transform a SVG file into a React component using TypeScript to `stdout`: + +`svgr --typescript -- {{path/to/file.svg}}` + +- Transform a SVG file into a React component using JSX transform to `stdout`: + +`svgr --jsx-runtime automatic -- {{path/to/file.svg}}` + +- Transform all SVG files from a directory to React components into a specific directory: + +`svgr --out-dir {{path/to/output_directory}} {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory skipping already transformed files: + +`svgr --out-dir {{path/to/output_directory}} --ignore-existing {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory using a specific case for filenames: + +`svgr --out-dir {{path/to/output_directory}} --filename-case {{camel|kebab|pascal}} {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory without generating an index file: + +`svgr --out-dir {{path/to/output_directory}} --no-index {{path/to/input_directory}}` diff --git a/svn b/svn new file mode 100644 index 00000000..94006483 --- /dev/null +++ b/svn @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# svn + +> Subversion command-line client tool. +> More information: . + +- Check out a working copy from a repository: + +`svn co {{url/to/repository}}` + +- Bring changes from the repository into the working copy: + +`svn up` + +- Put files and directories under version control, scheduling them for addition to repository. They will be added in next commit: + +`svn add {{PATH}}` + +- Send changes from your working copy to the repository: + +`svn ci -m {{commit_log_message}} [{{PATH}}]` + +- Display changes from the last 10 revisions, showing modified files for each revision: + +`svn log -vl {{10}}` + +- Display help: + +`svn help` diff --git a/svn-changelist b/svn-changelist new file mode 100644 index 00000000..4aabddc0 --- /dev/null +++ b/svn-changelist @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# svn changelist + +> Associate a changelist with a set of files. +> 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}}` + +- Remove files from a changelist: + +`svn changelist --remove {{path/to/file1}} {{path/to/file2}}` + +- Remove the whole changelist at once: + +`svn changelist --remove --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 ...}}` + +- Commit a changelist: + +`svn commit --changelist {{changelist_name}}` diff --git a/swagger-codegen b/swagger-codegen new file mode 100644 index 00000000..78f81ec1 --- /dev/null +++ b/swagger-codegen @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# swagger-codegen + +> Generate code and documentation for your REST api from a OpenAPI/swagger definition. +> More information: . + +- Generate documentation and code from an OpenAPI/swagger file: + +`swagger-codegen generate -i {{swagger_file}} -l {{language}}` + +- Generate Java code using the library retrofit2 and the option useRxJava2: + +`swagger-codegen generate -i {{http://petstore.swagger.io/v2/swagger.json}} -l {{java}} --library {{retrofit2}} -D{{useRxJava2}}={{true}}` + +- List available languages: + +`swagger-codegen langs` + +- Display help for a specific command: + +`swagger-codegen {{generate|config-help|meta|langs|version}} --help` diff --git a/swc b/swc new file mode 100644 index 00000000..24a995ef --- /dev/null +++ b/swc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# swc + +> JavaScript and TypeScript compiler written in Rust. +> More information: . + +- Transpile a specified input file and output to `stdout`: + +`swc {{path/to/file}}` + +- Transpile the input file every time it is changed: + +`swc {{path/to/file}} --watch` + +- Transpile a specified input file and output to a specific file: + +`swc {{path/to/input_file}} --out-file {{path/to/output_file}}` + +- Transpile a specified input directory and output to a specific directory: + +`swc {{path/to/input_directory}} --out-dir {{path/to/output_directory}}` + +- Transpile a specified input directory using a specific configuration file: + +`swc {{path/to/input_directory}} --config-file {{path/to/.swcrc}}` + +- Ignore files in a directory specified using glob path: + +`swc {{path/to/input_directory}} --ignore {{path/to/ignored_file1 path/to/ignored_file2 ...}}` diff --git a/swift b/swift new file mode 100644 index 00000000..ee666f0f --- /dev/null +++ b/swift @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# swift + +> Create, run and build Swift projects. +> More information: . + +- Start a REPL (interactive shell): + +`swift` + +- Execute a program: + +`swift {{file.swift}}` + +- Start a new project with the package manager: + +`swift package init` + +- Generate an Xcode project file: + +`swift package generate-xcodeproj` + +- Update dependencies: + +`swift package update` + +- Compile project for release: + +`swift build -c release` diff --git a/swig b/swig new file mode 100644 index 00000000..67179aca --- /dev/null +++ b/swig @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# swig + +> Generate bindings between C/C++ code and various high level languages such as JavaScript, Python, C#, and more. +> It uses special `.i` or `.swg` files to generate the bindings (C/C++ with SWIG directives, then outputs a C/C++ file that contains all the wrapper code needed to build an extension module. +> More information: . + +- Generate a binding between C++ and Python: + +`swig -c++ -python -o {{path/to/output_wrapper.cpp}} {{path/to/swig_file.i}}` + +- Generate a binding between C++ and Go: + +`swig -go -cgo -intgosize 64 -c++ {{path/to/swig_file.i}}` + +- Generate a binding between C and Java: + +`swig -java {{path/to/swig_file.i}}` + +- Generate a binding between C and Ruby and prefix the Ruby module with `foo::bar::`: + +`swig -ruby -prefix "{{foo::bar::}}" {{path/to/swig_file.i}}` diff --git a/swipl b/swipl new file mode 100644 index 00000000..63f08e71 --- /dev/null +++ b/swipl @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# swipl + +> SWI-Prolog - A comprehensive free Prolog environment. +> More information: . + +- Start an interactive session: + +`swipl` + +- Execute a command without showing any output: + +`swipl --quiet -t "{{command}}"` + +- Execute a script: + +`swipl {{path/to/file.pl}}` + +- Print all shell configuration variables: + +`swipl --dump-runtime-variables` + +- Display version: + +`swipl --version` diff --git a/symfony b/symfony new file mode 100644 index 00000000..8a51a347 --- /dev/null +++ b/symfony @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# symfony + +> The console component for the Symfony framework. +> More information: . + +- Create a new Symfony project: + +`symfony new {{name}}` + +- Run a local web server: + +`symfony serve` + +- Stop the local web server: + +`symfony server:stop` + +- Check for security issues in the project's dependencies: + +`symfony security:check` diff --git a/sync b/sync new file mode 100644 index 00000000..0c163d2b --- /dev/null +++ b/sync @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sync + +> Flushes all pending write operations to the appropriate disks. +> More information: . + +- Flush all pending write operations on all disks: + +`sync` + +- Flush all pending write operations on a single file to disk: + +`sync {{path/to/file}}` diff --git a/syncthing b/syncthing new file mode 100644 index 00000000..9d64e072 --- /dev/null +++ b/syncthing @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# syncthing + +> Continuous bidirectional decentralised folder synchronisation tool. +> More information: . + +- Start Syncthing: + +`syncthing` + +- Start Syncthing without opening a web browser: + +`syncthing -no-browser` + +- Print the device ID: + +`syncthing -device-id` + +- Change the home directory: + +`syncthing -home={{path/to/directory}}` + +- Force a full index exchange: + +`syncthing -reset-deltas` + +- 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: + +`syncthing -paths` + +- Disable the Syncthing monitor process: + +`syncthing -no-restart` diff --git a/sysbench b/sysbench new file mode 100644 index 00000000..4f8c0cdc --- /dev/null +++ b/sysbench @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sysbench + +> Benchmark a System's CPU, IO and memory. +> More information: . + +- Run a CPU benchmark with 1 thread for 10 seconds: + +`sysbench cpu run` + +- Run a CPU benchmark with multiple threads for a specified time: + +`sysbench --threads={{number_of_threads}} --time={{seconds}}` + +- Run a memory benchmark with 1 thread for 10 seconds: + +`sysbench memory run` + +- Prepare a filesystem-level read benchmark: + +`sysbench fileio prepare` + +- Run a filesystem-level benchmark: + +`sysbench --file-test-mode={{rndrd|rndrw|rndwr|seqrd|seqrewr|seqwr}} fileio run` diff --git a/tabula b/tabula new file mode 100644 index 00000000..f76cbe04 --- /dev/null +++ b/tabula @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tabula + +> Extract tables from PDF files. +> More information: . + +- Extract all tables from a PDF to a CSV file: + +`tabula -o {{file.csv}} {{file.pdf}}` + +- Extract all tables from a PDF to a JSON file: + +`tabula --format JSON -o {{file.json}} {{file.pdf}}` + +- Extract tables from pages 1, 2, 3, and 6 of a PDF: + +`tabula --pages {{1-3,6}} {{file.pdf}}` + +- Extract tables from page 1 of a PDF, guessing which portion of the page to examine: + +`tabula --guess --pages {{1}} {{file.pdf}}` + +- Extract all tables from a PDF, using ruling lines to determine cell boundaries: + +`tabula --spreadsheet {{file.pdf}}` + +- Extract all tables from a PDF, using blank space to determine cell boundaries: + +`tabula --no-spreadsheet {{file.pdf}}` diff --git a/tac b/tac new file mode 100644 index 00000000..9f929865 --- /dev/null +++ b/tac @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tac + +> Display and concatenate files with lines in reversed order. +> See also: `cat`. +> More information: . + +- Concatenate specific files in reversed order: + +`tac {{path/to/file1 path/to/file2 ...}}` + +- Display `stdin` in reversed order: + +`{{cat path/to/file}} | tac` + +- Use a specific [s]eparator: + +`tac -s {{separator}} {{path/to/file1 path/to/file2 ...}}` + +- Use a specific [r]egex as a [s]eparator: + +`tac -r -s {{separator}} {{path/to/file1 path/to/file2 ...}}` + +- Use a separator [b]efore each file: + +`tac -b {{path/to/file1 path/to/file2 ...}}` diff --git a/tail b/tail new file mode 100644 index 00000000..40d7411c --- /dev/null +++ b/tail @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tail + +> Display the last part of a file. +> See also: `head`. +> More information: . + +- Show last 'count' lines in file: + +`tail --lines {{count}} {{path/to/file}}` + +- Print a file from a specific line number: + +`tail --lines +{{count}} {{path/to/file}}` + +- Print a specific count of bytes from the end of a given file: + +`tail --bytes {{count}} {{path/to/file}}` + +- Print the last lines of a given file and keep reading file until `Ctrl + C`: + +`tail --follow {{path/to/file}}` + +- Keep reading file until `Ctrl + C`, even if the file is inaccessible: + +`tail --retry --follow {{path/to/file}}` + +- Show last 'num' lines in 'file' and refresh every 'n' seconds: + +`tail --lines {{count}} --sleep-interval {{seconds}} --follow {{path/to/file}}` diff --git a/tailscale b/tailscale new file mode 100644 index 00000000..ce2eb4cf --- /dev/null +++ b/tailscale @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tailscale + +> A private WireGuard network service. +> Some subcommands such as `tailscale up` have their own usage documentation. +> More information: . + +- Connect to Tailscale: + +`sudo tailscale up` + +- Disconnect from Tailscale: + +`sudo tailscale down` + +- Display the current Tailscale IP addresses: + +`tailscale ip` + +- Ping a peer node at the Tailscale layer and display which route it took for each response: + +`tailscale ping {{ip|hostname}}` + +- Analyze the local network conditions and display the result: + +`tailscale netcheck` + +- Start a web server for controlling Tailscale: + +`tailscale web` + +- Display a shareable identifier to help diagnose issues: + +`tailscale bugreport` + +- Display help for a subcommand: + +`tailscale {{subcommand}} --help` diff --git a/tailscale-file b/tailscale-file new file mode 100644 index 00000000..9a0d3f84 --- /dev/null +++ b/tailscale-file @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tailscale file + +> Send files across connected devices on a Tailscale network. +> It currently does not support sending files to devices owned by other users even on the same Tailscale network. +> More information: . + +- Send a file to a specific node: + +`sudo tailscale file cp {{path/to/file}} {{hostname|ip}}:` + +- Store files that were sent to the current node into a specific directory: + +`sudo tailscale file get {{path/to/directory}}` diff --git a/tailscale-ssh b/tailscale-ssh new file mode 100644 index 00000000..247eb6df --- /dev/null +++ b/tailscale-ssh @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tailscale ssh + +> SSH to a Tailscale machine (Linux Only). +> More information: . + +- Advertise/Disable SSH on the host: + +`sudo tailscale up --ssh={{true|false}}` + +- SSH to a specific host which has Tailscale-SSH enabled: + +`tailscale ssh {{username}}@{{host}}` diff --git a/tailscale-up b/tailscale-up new file mode 100644 index 00000000..c7429214 --- /dev/null +++ b/tailscale-up @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tailscale up + +> Connect the client to the Tailscale network. +> In version 1.8 and above, command-line arguments are stored and reused until they're overwritten or `--reset` is called. +> More information: . + +- Connect to Tailscale: + +`sudo tailscale up` + +- Connect and offer the current machine to be an exit node for internet traffic: + +`sudo tailscale up --advertise-exit-node` + +- Connect using a specific node for internet traffic: + +`sudo tailscale up --exit-node={{exit_node_ip}}` + +- Connect and block incoming connections to the current node: + +`sudo tailscale up --shields-up` + +- Connect and don't accept DNS configuration from the admin panel (defaults to `true`): + +`sudo tailscale up --accept-dns=false` + +- Connect and configure Tailscale as a subnet router: + +`sudo tailscale up --advertise-routes={{10.0.0.0/24,10.0.1.0/24,...}}` + +- Connect and accept subnet routes from Tailscale: + +`sudo tailscale up --accept-routes` + +- Reset unspecified settings to their default values and connect: + +`sudo tailscale up --reset` diff --git a/takeout b/takeout new file mode 100644 index 00000000..1241d009 --- /dev/null +++ b/takeout @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# takeout + +> A Docker-based development-only dependency manager. +> More information: . + +- Display a list of available services: + +`takeout enable` + +- Enable a specific service: + +`takeout enable {{name}}` + +- Enable a specific service with the default parameters: + +`takeout enable --default {{name}}` + +- Display a list of enabled services: + +`takeout disable` + +- Disable a specific service: + +`takeout disable {{name}}` + +- Disable all services: + +`takeout disable --all` + +- Start a specific container: + +`takeout start {{container_id}}` + +- Stop a specific container: + +`takeout stop {{container_id}}` diff --git a/tar b/tar new file mode 100644 index 00000000..0ddd8639 --- /dev/null +++ b/tar @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tar + +> Archiving utility. +> Often combined with a compression method, such as `gzip` or `bzip2`. +> More information: . + +- [c]reate an archive and write it to a [f]ile: + +`tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}` + +- [c]reate a g[z]ipped archive and write it to a [f]ile: + +`tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}` + +- [c]reate a g[z]ipped archive from a directory using relative paths: + +`tar czf {{path/to/target.tar.gz}} --directory={{path/to/directory}} .` + +- E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely: + +`tar xvf {{path/to/source.tar[.gz|.bz2|.xz]}}` + +- E[x]tract a (compressed) archive [f]ile into the target directory: + +`tar xf {{path/to/source.tar[.gz|.bz2|.xz]}} --directory={{path/to/directory}}` + +- [c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program: + +`tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}` + +- Lis[t] the contents of a `tar` [f]ile [v]erbosely: + +`tar tvf {{path/to/source.tar}}` + +- E[x]tract files matching a pattern from an archive [f]ile: + +`tar xf {{path/to/source.tar}} --wildcards "{{*.html}}"` diff --git a/tarsnap b/tarsnap new file mode 100644 index 00000000..1ca5278d --- /dev/null +++ b/tarsnap @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tarsnap + +> Manipulate remote Tarsnap encrypted backups. +> Note: you don't need to specify the key file and the cache directory if you configure them in `/usr/local/etc/tarsnap.conf` or `~/.tarsnaprc`. +> See also: `tarsnap-keygen`. +> More information: . + +- [c]reate a backup archive of one or more files or directories, specifying the cryptographic key and the cache directory: + +`tarsnap -c --keyfile {{path/to/key_file}} --cachedir {{path/to/cache_directory}} -f {{archive_name}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Display how much data would be uploaded: + +`tarsnap -c --dry-run --print-stats --keyfile {{path/to/key_file}} --cachedir {{path/to/cache_directory}} -f {{archive_name}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- List stored archives: + +`tarsnap --list-archives --keyfile {{path/to/key_file}}` + +- [d]elete a specific archive: + +`tarsnap -d --keyfile {{path/to/key_file}} --cachedir {{path/to/cache_directory}} -f {{archive_name}}` + +- Lis[t] the contents of a specific archive in [v]erbose mode: + +`tarsnap -tv --keyfile {{path/to/key_file}} -f {{archive_name}}` + +- Restore one or more files or directories from a specific archive: + +`tarsnap -x --keyfile {{path/to/key_file}} -f {{archive_name}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Copy an archive: + +`tarsnap -c --keyfile {{path/to/key_file}} -f {{new_archive_name}} @@{{source_archive_name}}` diff --git a/tarsnap-keygen b/tarsnap-keygen new file mode 100644 index 00000000..299f6cc8 --- /dev/null +++ b/tarsnap-keygen @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tarsnap-keygen + +> Generate a key file for use with Tarsnap, an online backup service. +> More information: . + +- Register a machine with the Tarsnap server: + +`sudo tarsnap-keygen --keyfile {{path/to/file.key}} --user {{user_email}} --machine {{machine_name}}` + +- Encrypt the key file (a passphrase will be requested twice): + +`sudo tarsnap-keygen --keyfile {{path/to/file.key}} --user {{user_email}} --machine {{machine_name}} --passphrased` diff --git a/task b/task new file mode 100644 index 00000000..b01912a4 --- /dev/null +++ b/task @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# task + +> Command-line to-do list manager. +> More information: . + +- Add a new task which is due tomorrow: + +`task add {{description}} due:{{tomorrow}}` + +- Update a task's priority: + +`task {{task_id}} modify priority:{{H|M|L}}` + +- Complete a task: + +`task {{task_id}} done` + +- Delete a task: + +`task {{task_id}} delete` + +- List all open tasks: + +`task list` + +- List open tasks due before the end of the week: + +`task list due.before:{{eow}}` + +- Show a graphical burndown chart, by day: + +`task burndown.daily` + +- List all reports: + +`task reports` diff --git a/tb b/tb new file mode 100644 index 00000000..ff950bc6 --- /dev/null +++ b/tb @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tb + +> Manage tasks and notes across multiple boards. +> More information: . + +- Add a new task to a board: + +`tb --task {{task_description}} @{{board_name}}` + +- Add a new note to a board: + +`tb --note {{note_description}} @{{board_name}}` + +- Edit item's priority: + +`tb --priority @{{item_id}} {{priority}}` + +- Check/uncheck item: + +`tb --check {{item_id}}` + +- Archive all checked items: + +`tb --clear` + +- Move item to a board: + +`tb --move @{{item_id}} {{board_name}}` diff --git a/tbl b/tbl new file mode 100644 index 00000000..5dfea959 --- /dev/null +++ b/tbl @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tbl + +> Table preprocessor for the groff (GNU Troff) document formatting system. +> See also `groff` and `troff`. +> More information: . + +- Process input with tables, saving the output for future typesetting with groff to PostScript: + +`tbl {{path/to/input_file}} > {{path/to/output.roff}}` + +- Typeset input with tables to PDF using the [me] macro package: + +`tbl -T {{pdf}} {{path/to/input.tbl}} | groff -{{me}} -T {{pdf}} > {{path/to/output.pdf}}` diff --git a/tcc b/tcc new file mode 100644 index 00000000..9abbf5fd --- /dev/null +++ b/tcc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tcc + +> A tiny C compiler that can run C source files as scripts and otherwise has command-line options similar to `gcc`. +> More information: . + +- Compile and link 2 source files to generate an executable: + +`tcc -o {{executable_name}} {{path/to/file1.c}} {{path/to/file2.c}}` + +- Directly run an input file like a script and pass arguments to it: + +`tcc -run {{path/to/source_file.c}} {{arguments}}` + +- Interpret C source files with a shebang inside the file: + +`#!/full/path/to/tcc -run` diff --git a/tcpdump b/tcpdump new file mode 100644 index 00000000..06a66e5f --- /dev/null +++ b/tcpdump @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tcpdump + +> Dump traffic on a network. +> More information: . + +- List available network interfaces: + +`tcpdump -D` + +- Capture the traffic of a specific interface: + +`tcpdump -i {{eth0}}` + +- Capture all TCP traffic showing contents (ASCII) in console: + +`tcpdump -A tcp` + +- Capture the traffic from or to a host: + +`tcpdump host {{www.example.com}}` + +- Capture the traffic from a specific interface, source, destination and destination port: + +`tcpdump -i {{eth0}} src {{192.168.1.1}} and dst {{192.168.1.2}} and dst port {{80}}` + +- Capture the traffic of a network: + +`tcpdump net {{192.168.1.0/24}}` + +- Capture all traffic except traffic over port 22 and save to a dump file: + +`tcpdump -w {{dumpfile.pcap}} port not {{22}}` + +- Read from a given dump file: + +`tcpdump -r {{dumpfile.pcap}}` diff --git a/tcsh b/tcsh new file mode 100644 index 00000000..c405635a --- /dev/null +++ b/tcsh @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tcsh + +> C shell with file name completion and command-line editing. +> See also: `csh`. +> More information: . + +- Start an interactive shell session: + +`tcsh` + +- Start an interactive shell session without loading startup configs: + +`tcsh -f` + +- Execute specific [c]ommands: + +`tcsh -c "{{echo 'tcsh is executed'}}"` + +- Execute a specific script: + +`tcsh {{path/to/script.tcsh}}` + +- Check a specific script for syntax errors: + +`tcsh -n {{path/to/script.tcsh}}` + +- Execute specific commands from `stdin`: + +`{{echo "echo 'tcsh is executed'"}} | tcsh` diff --git a/tea b/tea new file mode 100644 index 00000000..ecf22275 --- /dev/null +++ b/tea @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tea + +> Interact with Gitea servers. +> More information: . + +- Log into a Gitea server: + +`tea login add --name "{{name}}" --url "{{url}}" --token "{{token}}"` + +- Display all repositories: + +`tea repos ls` + +- Display a list of issues: + +`tea issues ls` + +- Display a list of issues for a specific repository: + +`tea issues ls --repo "{{repository}}"` + +- Create a new issue: + +`tea issues create --title "{{title}}" --body "{{body}}"` + +- Display a list of open pull requests: + +`tea pulls ls` + +- Open the current repository in a browser: + +`tea open` diff --git a/tectonic b/tectonic new file mode 100644 index 00000000..42cd8129 --- /dev/null +++ b/tectonic @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tectonic + +> A modern, self-contained TeX/LaTeX engine. +> More information: . + +- Compile a standalone TeX/LaTeX file: + +`tectonic -X compile {{path/to/file.tex}}` + +- Compile a standalone TeX/LaTeX file with synctex data: + +`tectonic -X compile --synctex {{path/to/file.tex}}` + +- Initialize a tectonic project in the current directory: + +`tectonic -X init` + +- Initialize a tectonic project in the specified directory: + +`tectonic -X new {{project_name}}` + +- Build the project in the current directory: + +`tectonic -X build` + +- Start a watcher to build the project in the current directory on change: + +`tectonic -X watch` diff --git a/tee b/tee new file mode 100644 index 00000000..2800032e --- /dev/null +++ b/tee @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tee + +> Read from `stdin` and write to `stdout` and files (or commands). +> More information: . + +- Copy `stdin` to each file, and also to `stdout`: + +`echo "example" | tee {{path/to/file}}` + +- Append to the given files, do not overwrite: + +`echo "example" | tee -a {{path/to/file}}` + +- Print `stdin` to the terminal, and also pipe it into another program for further processing: + +`echo "example" | tee {{/dev/tty}} | {{xargs printf "[%s]"}}` + +- Create a directory called "example", count the number of characters in "example" and write "example" to the terminal: + +`echo "example" | tee >(xargs mkdir) >(wc -c)` diff --git a/telegram-desktop b/telegram-desktop new file mode 100644 index 00000000..91ee7697 --- /dev/null +++ b/telegram-desktop @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# telegram-desktop + +> Instant messenger with open source clients, chats and stickers. +> More information: . + +- Start GUI: + +`telegram-desktop` + +- Run GUI as an autostart if allowed: + +`telegram-desktop -autostart` + +- Run GUI minimized to tray: + +`telegram-desktop -startintray` diff --git a/telnet b/telnet new file mode 100644 index 00000000..ff6262f3 --- /dev/null +++ b/telnet @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# telnet + +> Connect to a specified port of a host using the telnet protocol. +> More information: . + +- Telnet to the default port of a host: + +`telnet {{host}}` + +- Telnet to a specific port of a host: + +`telnet {{ip_address}} {{port}}` + +- Exit a telnet session: + +`quit` + +- Emit the default escape character combination for terminating the session: + +` + ]` + +- Start `telnet` with "x" as the session termination character: + +`telnet -e {{x}} {{ip_address}} {{port}}` + +- Telnet to Star Wars animation: + +`telnet {{towel.blinkenlights.nl}}` diff --git a/termdown b/termdown new file mode 100644 index 00000000..0f5bd254 --- /dev/null +++ b/termdown @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# termdown + +> Countdown timer and stopwatch for the command-line. +> More information: . + +- Start a stopwatch: + +`termdown` + +- Start a 1 minute and 30 seconds countdown: + +`termdown {{1m30s}}` + +- Start a 1 minute 30 seconds countdown with blinking the terminal at the end: + +`termdown {{1m30s}} --blink` + +- Show a title above countdown: + +`termdown {{1m30s}} --title "{{Interesting title}}"` + +- Display current time: + +`termdown --time` diff --git a/terminalizer b/terminalizer new file mode 100644 index 00000000..266c1381 --- /dev/null +++ b/terminalizer @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# terminalizer + +> Record the terminal, generate animated GIFs and a web player, and optionally upload to . +> See also: `asciinema`. +> More information: . + +- Create the global configuration directory: + +`terminalizer init` + +- Record the terminal and create a recording file: + +`terminalizer record {{path/to/recording.gif}}` + +- Play a recorded file on the terminal: + +`terminalizer play {{path/to/recording.gif}}` + +- Render a recording file as an animated GIF image: + +`terminalizer render {{path/to/recording.gif}}` + +- Upload a video to : + +`terminalizer share {{path/to/recording.gif}}` diff --git a/terraform b/terraform new file mode 100644 index 00000000..a985c96b --- /dev/null +++ b/terraform @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# terraform + +> Create and deploy infrastructure as code to cloud providers. +> More information: . + +- Initialize a new or existing Terraform configuration: + +`terraform init` + +- Verify that the configuration files are syntactically valid: + +`terraform validate` + +- Format configuration according to Terraform language style conventions: + +`terraform fmt` + +- Generate and show an execution plan: + +`terraform plan` + +- Build or change infrastructure: + +`terraform apply` + +- Destroy Terraform-managed infrastructure: + +`terraform destroy` diff --git a/terraform-fmt b/terraform-fmt new file mode 100644 index 00000000..41e03e34 --- /dev/null +++ b/terraform-fmt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# terraform fmt + +> Format configuration according to Terraform language style conventions. +> More information: . + +- Format the configuration in the current directory: + +`terraform fmt` + +- Format the configuration in the current directory and subdirectories: + +`terraform fmt -recursive` + +- Display diffs of formatting changes: + +`terraform fmt -diff` + +- Do not list files that were formatted to `stdout`: + +`terraform fmt -list=false` diff --git a/terraform-plan b/terraform-plan new file mode 100644 index 00000000..51a3a422 --- /dev/null +++ b/terraform-plan @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# terraform plan + +> Generate and show Terraform execution plans. +> More information: . + +- Generate and show the execution plan in the currently directory: + +`terraform plan` + +- Show a plan to destroy all remote objects that currently exist: + +`terraform plan -destroy` + +- Show a plan to update the Terraform state and output values: + +`terraform plan -refresh-only` + +- Specify values for input variables: + +`terraform plan -var '{{name1}}={{value1}}' -var '{{name2}}={{value2}}'` + +- Focus Terraform's attention on only a subset of resources: + +`terraform plan -target {{resource_type.resource_name[instance index]}}` + +- Output a plan as JSON: + +`terraform plan -json` + +- Write a plan to a specific file: + +`terraform plan -no-color > {{path/to/file}}` diff --git a/terragrunt b/terragrunt new file mode 100644 index 00000000..80c3de4a --- /dev/null +++ b/terragrunt @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# terragrunt + +> Keep your Terraform CLI arguments DRY. +> More information: . + +- Generate and show an execution plan: + +`terragrunt plan` + +- Build or change infrastructure: + +`terragrunt apply` + +- Show current deployment (from state): + +`terragrunt show` + +- Show module output values: + +`terragrunt output` + +- Destroy Terraform-managed infrastructure: + +`terragrunt destroy` + +- Build or change infrastructure from a tree of Terragrunt modules (stack): + +`terragrunt run-all apply` diff --git a/tesseract b/tesseract new file mode 100644 index 00000000..d39cb305 --- /dev/null +++ b/tesseract @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tesseract + +> OCR (Optical Character Recognition) engine. +> More information: . + +- Recognize text in an image and save it to `output.txt` (the `.txt` extension is added automatically): + +`tesseract {{image.png}} {{output}}` + +- Specify a custom language (default is English) with an ISO 639-2 code (e.g. deu = Deutsch = German): + +`tesseract -l deu {{image.png}} {{output}}` + +- List the ISO 639-2 codes of available languages: + +`tesseract --list-langs` + +- Specify a custom page segmentation mode (default is 3): + +`tesseract -psm {{0_to_10}} {{image.png}} {{output}}` + +- List page segmentation modes and their descriptions: + +`tesseract --help-psm` diff --git a/test b/test new file mode 100644 index 00000000..4940fb1b --- /dev/null +++ b/test @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# test + +> Check file types and compare values. +> Returns 0 if the condition evaluates to true, 1 if it evaluates to false. +> More information: . + +- Test if a given variable is equal to a given string: + +`test "{{$MY_VAR}}" = "{{/bin/zsh}}"` + +- Test if a given variable is empty: + +`test -z "{{$GIT_BRANCH}}"` + +- Test if a file exists: + +`test -f "{{path/to/file_or_directory}}"` + +- Test if a directory does not exist: + +`test ! -d "{{path/to/directory}}"` + +- If A is true, then do B, or C in the case of an error (notice that C may run even if A fails): + +`test {{condition}} && {{echo "true"}} || {{echo "false"}}` diff --git a/testssl b/testssl new file mode 100644 index 00000000..ebc3869a --- /dev/null +++ b/testssl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# testssl + +> Check SSL/TLS protocols and ciphers supported by a server. +> More information: . + +- Test a server (run every check) on port 443: + +`testssl {{example.com}}` + +- Test a different port: + +`testssl {{example.com:465}}` + +- Only check available protocols: + +`testssl --protocols {{example.com}}` + +- Only check vulnerabilities: + +`testssl --vulnerable {{example.com}}` + +- Only check HTTP security headers: + +`testssl --headers {{example.com}}` + +- Test other STARTTLS enabled protocols: + +`testssl --starttls {{ftp|smtp|pop3|imap|xmpp|sieve|xmpp-server|telnet|ldap|irc|lmtp|nntp|postgres|mysql}} {{example.com}}:{{port}}` diff --git a/tex b/tex new file mode 100644 index 00000000..e4925dd9 --- /dev/null +++ b/tex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tex + +> Compile a DVI document from TeX source files. +> More information: . + +- Compile a DVI document: + +`tex {{source.tex}}` + +- Compile a DVI document, specifying an output directory: + +`tex -output-directory={{path/to/directory}} {{source.tex}}` + +- Compile a DVI document, exiting on each error: + +`tex -halt-on-error {{source.tex}}` diff --git a/texcount b/texcount new file mode 100644 index 00000000..d1497622 --- /dev/null +++ b/texcount @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# texcount + +> Count words in TeX documents omitting macros. +> Note: if the TeX document uses `\include` or `\input` and you want to count the included files, `texcount` must be run in the directory of the root TeX file. +> More information: . + +- Count words in a TeX file: + +`texcount {{path/to/file.tex}}` + +- Count words in a document and subdocuments built with `\input` or `\include`: + +`texcount -merge {{file.tex}}` + +- Count words in a document and subdocuments, listing each file separately (and a total count): + +`texcount -inc {{file.tex}}` + +- Count words with verbose output: + +`texcount -v {{path/to/file.tex}}` diff --git a/texdoc b/texdoc new file mode 100644 index 00000000..88faa1f4 --- /dev/null +++ b/texdoc @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# texdoc + +> Search for appropriate documentation for (La)TeX commands or packages. +> More information: . + +- Open the first search result in the default PDF viewer: + +`texdoc {{search}}` + +- List the best search results: + +`texdoc --list {{search}}` + +- Open full documentation of texdoc: + +`texdoc {{texdoc}}` diff --git a/texliveonfly b/texliveonfly new file mode 100644 index 00000000..bbcceadf --- /dev/null +++ b/texliveonfly @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# texliveonfly + +> Downloads missing TeX Live packages while compiling `.tex` files. +> More information: . + +- Download missing packages while compiling: + +`texliveonfly {{source.tex}}` + +- Use a specific compiler (defaults to `pdflatex`): + +`texliveonfly --compiler={{compiler}} {{source.tex}}` + +- Use a custom TeX Live `bin` folder: + +`texliveonfly --texlive_bin={{path/to/texlive_bin}} {{source.tex}}` diff --git a/textql b/textql new file mode 100644 index 00000000..310b30ea --- /dev/null +++ b/textql @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# textql + +> Execute SQL against structured text like csv or tsv files. +> More information: . + +- Print the lines in the specified `.csv` file that match a SQL query to `stdout`: + +`textql -sql "{{SELECT * FROM filename}}" {{path/to/filename.csv}}` + +- Query `.tsv` file: + +`textql -dlm=tab -sql "{{SELECT * FROM filename}}" {{path/to/filename.tsv}}` + +- Query file with header row: + +`textql -dlm={{delimiter}} -header -sql "{{SELECT * FROM filename}}" {{path/to/filename.csv}}` + +- Read data from `stdin`: + +`cat {{path/to/file}} | textql -sql "{{SELECT * FROM stdin}}"` + +- Join two files on a specified common column: + +`textql -header -sql "SELECT * FROM {{path/to/file1}} JOIN {{file2}} ON {{path/to/file1}}.{{c1}} = {{file2}}.{{c1}} LIMIT {{10}}" -output-header {{path/to/file1.csv}} {{path/to/file2.csv}}` + +- Format output using an output delimiter with an output header line: + +`textql -output-dlm={{delimiter}} -output-header -sql "SELECT {{column}} AS {{alias}} FROM {{filename}}" {{path/to/filename.csv}}` diff --git a/tgatoppm b/tgatoppm new file mode 100644 index 00000000..da2baa1a --- /dev/null +++ b/tgatoppm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tgatoppm + +> Convert a TrueVision Targa file to a Netpbm image. +> More information: . + +- Convert a TrueVision Targa file to a PPM image: + +`tgatoppm {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Dump information from the TGA header to `stdout`: + +`tgatoppm --headerdump {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Write the transparency channel values of the input image to the specified file: + +`tgatoppm --alphaout {{path/to/transparency_file.pgm}} {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Display version: + +`tgatoppm -version` diff --git a/theharvester b/theharvester new file mode 100644 index 00000000..dc43b879 --- /dev/null +++ b/theharvester @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# theHarvester + +> A tool designed to be used in the early stages of a penetration test. +> More information: . + +- Gather information on a domain using Google: + +`theHarvester --domain {{domain_name}} --source google` + +- Gather information on a domain using multiple sources: + +`theHarvester --domain {{domain_name}} --source {{google,bing,crtsh}}` + +- Change the limit of results to work with: + +`theHarvester --domain {{domain_name}} --source {{google}} --limit {{200}}` + +- Save the output to two files in XML and HTML format: + +`theHarvester --domain {{domain_name}} --source {{google}} --file {{output_file_name}}` + +- Display help: + +`theHarvester --help` diff --git a/thinkjettopbm b/thinkjettopbm new file mode 100644 index 00000000..914af0a9 --- /dev/null +++ b/thinkjettopbm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# thinkjettopbm + +> Convert a HP ThinkJet printer commands file to a PBM file. +> More information: . + +- Convert a HP ThinkJet printer commands file to a PBM file: + +`thinkjettopbm {{path/to/input}} > {{path/to/output.pbm}}` + +- Print debug information to `stderr`: + +`thinkjettopbm -d {{path/to/input}} > {{path/to/output.pbm}}` diff --git a/thunderbird b/thunderbird new file mode 100644 index 00000000..ce821071 --- /dev/null +++ b/thunderbird @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# thunderbird + +> Email client and RSS reader. +> More information: . + +- Open thunderbird: + +`thunderbird` + +- Use a specific user profile: + +`thunderbird -P {{profile_name}}` + +- Use a specific user profile directory: + +`thunderbird --profile {{path/to/profile/directory}}` diff --git a/tidy b/tidy new file mode 100644 index 00000000..6d2d6625 --- /dev/null +++ b/tidy @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tidy + +> Clean up and pretty print HTML, XHTML and XML files. +> Note: `tidy` cannot preserve original indentation. +> More information: . + +- Pretty print an HTML file: + +`tidy {{path/to/file.html}}` + +- Enable [i]ndentation, [w]rapping lines in 100, saving to `output.html`: + +`tidy --indent y --wrap 100 -output {{path/to/output.html}} {{path/to/file.html}}` + +- Modify an HTML file in-place using a configuration file: + +`tidy -config {{path/to/configuration}} -modify {{path/to/file.html}}` diff --git a/tifftopnm b/tifftopnm new file mode 100644 index 00000000..00387a68 --- /dev/null +++ b/tifftopnm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tifftopnm + +> Convert a TIFF image to a PNM image. +> More information: . + +- Convert a TIFF to a PNM file: + +`tifftopnm {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Create a PGM file containing the alpha channel of the input image: + +`tifftopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Respect the `fillorder` tag in the input TIFF image: + +`tifftopnm -respectfillorder {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Print TIFF header information to `stderr`: + +`tifftopnm -headerdump {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` diff --git a/tig b/tig new file mode 100644 index 00000000..f662be27 --- /dev/null +++ b/tig @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tig + +> A text-mode interface for Git. +> More information: . + +- Show the sequence of commits starting from the current one in reverse chronological order: + +`tig` + +- Show the history of a specific branch: + +`tig {{branch}}` + +- Show the history of specific files or directories: + +`tig {{path1 path2 ...}}` + +- Show the difference between two references (such as branches or tags): + +`tig {{base_ref}}..{{compared_ref}}` + +- Display commits from all branches and stashes: + +`tig --all` + +- Start in stash view, displaying all saved stashes: + +`tig stash` diff --git a/time b/time new file mode 100644 index 00000000..6ff1b936 --- /dev/null +++ b/time @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# time + +> Measure how long a command took to run. +> Note: `time` can either exist as a shell builtin, a standalone program or both. +> More information: . + +- Run the `command` and print the time measurements to `stdout`: + +`time {{command}}` diff --git a/timeout b/timeout new file mode 100644 index 00000000..c1997d11 --- /dev/null +++ b/timeout @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# timeout + +> Run a command with a time limit. +> More information: . + +- Run `sleep 10` and terminate it after 3 seconds: + +`timeout 3s sleep 10` + +- Send a signal to the command after the time limit expires (SIGTERM by default): + +`timeout --signal {{INT}} {{5s}} {{sleep 10}}` diff --git a/timetrap b/timetrap new file mode 100644 index 00000000..35e4fe68 --- /dev/null +++ b/timetrap @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# timetrap + +> Simple command-line time tracker written in Ruby. +> More information: . + +- Create a new timesheet: + +`timetrap sheet {{timesheet}}` + +- Check in an entry started 5 minutes ago: + +`timetrap in --at "{{5 minutes ago}}" {{entry_notes}}` + +- Display the current timesheet: + +`timetrap display` + +- Edit the last entry's end time: + +`timetrap edit --end {{time}}` diff --git a/timew b/timew new file mode 100644 index 00000000..c300859e --- /dev/null +++ b/timew @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# timew + +> A time tracking tool used to measure the duration of activities. +> More information: . + +- Start a new stopwatch, giving a tag name to the activity being tracked: + +`timew start {{activity_tag}}` + +- View running stopwatches: + +`timew` + +- Stop the stopwatch with a given tag name: + +`timew stop {{activity_tag}}` + +- Stop all running stopwatches: + +`timew stop` + +- View tracked items: + +`timew summary` diff --git a/timidity b/timidity new file mode 100644 index 00000000..12087c8c --- /dev/null +++ b/timidity @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# timidity + +> A MIDI file player and converter. +> More information: . + +- Play a MIDI file: + +`timidity {{path/to/file.mid}}` + +- Play a MIDI file in a loop: + +`timidity --loop {{path/to/file.mid}}` + +- Play a MIDI file in a specific key (0 = C major/A minor, -1 = F major/D minor, +1 = G major/E minor, etc.): + +`timidity --force-keysig={{-flats|+sharps}} {{path/to/file.mid}}` + +- Convert a MIDI file to PCM (WAV) audio: + +`timidity --output-mode={{w}} --output-file={{path/to/file.wav}} {{path/to/file.mid}}` + +- Convert a MIDI file to FLAC audio: + +`timidity --output-mode={{F}} --output-file={{path/to/file.flac}} {{path/to/file.mid}}` diff --git a/tldr b/tldr new file mode 100644 index 00000000..2551ce10 --- /dev/null +++ b/tldr @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tldr + +> Display simple help pages for command-line tools from the tldr-pages project. +> Note: the `--language` and `--list` options are not required by the client specification, but most clients implement them. +> More information: . + +- Print the tldr page for a specific command (hint: this is how you got here!): + +`tldr {{command}}` + +- Print the tldr page for a specific subcommand: + +`tldr {{command}} {{subcommand}}` + +- Print the tldr page for a command in the given [L]anguage (if available, otherwise fall back to English): + +`tldr --language {{language_code}} {{command}}` + +- Print the tldr page for a command from a specific [p]latform: + +`tldr --platform {{android|common|freebsd|linux|osx|netbsd|openbsd|sunos|windows}} {{command}}` + +- [u]pdate the local cache of tldr pages: + +`tldr --update` + +- List all pages for the current platform and `common`: + +`tldr --list` diff --git a/tldr-lint b/tldr-lint new file mode 100644 index 00000000..fcc0578f --- /dev/null +++ b/tldr-lint @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tldr-lint + +> Lint and format `tldr` pages. +> More information: . + +- Lint all pages: + +`tldr-lint {{pages_directory}}` + +- Format a specific page to `stdout`: + +`tldr-lint --format {{page.md}}` + +- Format all pages in place: + +`tldr-lint --format --in-place {{pages_directory}}` diff --git a/tldrl b/tldrl new file mode 100644 index 00000000..05928c5c --- /dev/null +++ b/tldrl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tldrl + +> This command is an alias of `tldr-lint`. +> More information: . + +- View documentation for the original command: + +`tldr tldr-lint` diff --git a/tlmgr b/tlmgr new file mode 100644 index 00000000..7970f6d8 --- /dev/null +++ b/tlmgr @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr + +> Manages packages and configuration options of an existing TeX Live installation. +> Some subcommands such as `tlmgr paper` have their own usage documentation. +> More information: . + +- Install a package and its dependencies: + +`tlmgr install {{package}}` + +- Remove a package and its dependencies: + +`tlmgr remove {{package}}` + +- Display information about a package: + +`tlmgr info {{package}}` + +- Update all packages: + +`tlmgr update --all` + +- Show possible updates without updating anything: + +`tlmgr update --list` + +- Start a GUI version of tlmgr: + +`tlmgr gui` + +- List all TeX Live configurations: + +`tlmgr conf` diff --git a/tlmgr-arch b/tlmgr-arch new file mode 100644 index 00000000..a8b6298a --- /dev/null +++ b/tlmgr-arch @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr arch + +> This command is an alias of `tlmgr platform`. +> More information: . + +- View documentation for the original command: + +`tldr tlmgr platform` diff --git a/tlmgr-backup b/tlmgr-backup new file mode 100644 index 00000000..afb2abb6 --- /dev/null +++ b/tlmgr-backup @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr backup + +> Manage backups of TeX Live packages. +> The default backup directory is specified by the `backupdir` option, and can be obtained with `tlmgr option`. +> More information: . + +- Make a backup of one or more packages: + +`tlmgr backup {{package1 package2 ...}}` + +- Make a backup of all packages: + +`tlmgr backup --all` + +- Make a backup to a custom directory: + +`tlmgr backup {{package}} --backupdir {{path/to/backup_directory}}` + +- Remove a backup of one or more packages: + +`tlmgr backup clean {{package1 package2 ...}}` + +- Remove all backups: + +`tlmgr backup clean --all` diff --git a/tlmgr-candidates b/tlmgr-candidates new file mode 100644 index 00000000..68274938 --- /dev/null +++ b/tlmgr-candidates @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr candidates + +> Get available candidate repositories from which a TeX Live package can be installed. +> More information: . + +- List all available repositories from which a package can be installed: + +`tlmgr candidates {{package}}` diff --git a/tlmgr-check b/tlmgr-check new file mode 100644 index 00000000..18ce0068 --- /dev/null +++ b/tlmgr-check @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr check + +> Check the consistency of a TeX Live installation. +> More information: . + +- Check the consistency of the whole TeX Live installation: + +`tlmgr check all` + +- Check the consistency of the whole TeX Live information in verbose mode: + +`tlmgr check all -v` + +- Check for missing dependencies: + +`tlmgr check depends` + +- Check if all TeX Live executables are present: + +`tlmgr check executes` + +- Check if all files listed in the local TLPDB are present: + +`tlmgr check files` + +- Check for duplicate filenames in the runfiles sections: + +`tlmgr check runfiles` diff --git a/tlmgr-conf b/tlmgr-conf new file mode 100644 index 00000000..7e36fcea --- /dev/null +++ b/tlmgr-conf @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr conf + +> Manage the TeX Live configuration. +> More information: . + +- Show the current TeX Live configuration: + +`tlmgr conf` + +- Show the current `texmf`, `tlmgr`, or `updmap` configuration: + +`tlmgr conf {{texmf|tlmgr|updmap}}` + +- Show only a specific configuration option: + +`tlmgr conf {{texmf|tlmgr|updmap}} {{configuration_key}}` + +- Set a specific configuration option: + +`tlmgr conf {{texmf|tlmgr|updmap}} {{configuration_key}} {{value}}` + +- Delete a specific configuration option: + +`tlmgr conf {{texmf|tlmgr|updmap}} --delete {{configuration_key}}` + +- Disable the execution of system calls via `\write18`: + +`tlmgr conf texmf {{shell_escape}} {{0}}` + +- Show all additional `texmf` trees: + +`tlmgr conf auxtrees show` diff --git a/tlmgr-dump-tlpdb b/tlmgr-dump-tlpdb new file mode 100644 index 00000000..00c3f4d3 --- /dev/null +++ b/tlmgr-dump-tlpdb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr dump-tlpdb + +> Dump the TeX Live package database. +> More information: . + +- Dump the local package database: + +`tlmgr dump-tlpdb --local` + +- Dump the remote package database: + +`tlmgr dump-tlpdb --remote` + +- Dump the local package database as JSON: + +`tlmgr dump-tlpdb --local --json` diff --git a/tlmgr-generate b/tlmgr-generate new file mode 100644 index 00000000..b767103d --- /dev/null +++ b/tlmgr-generate @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr generate + +> Remake configuration files from information stored locally. +> More information: . + +- Remake the configuration file storing into a specific location: + +`tlmgr generate --dest {{output_file}}` + +- Remake the configuration file using a local configuration file: + +`tlmgr generate --localcfg {{local_configuration_file}}` + +- Run necessary programs after rebuilding configuration files: + +`tlmgr generate --rebuild-sys` diff --git a/tlmgr-gui b/tlmgr-gui new file mode 100644 index 00000000..db93b67b --- /dev/null +++ b/tlmgr-gui @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr gui + +> Start a graphical user interface for `tlmgr`. +> `tlmgr gui` depends on the package `perl-tk`, which has to be installed manually. +> More information: . + +- Start a GUI for `tlmgr`: + +`sudo tlmgr gui` + +- Start a GUI specifying the background color: + +`sudo tlmgr gui -background "{{#f39bc3}}"` + +- Start a GUI specifying the foreground color: + +`sudo tlmgr gui -foreground "{{#0ef3bd}}"` + +- Start a GUI specifying the font and font size: + +`sudo tlmgr gui -font "{{helvetica 18}}"` + +- Start a GUI setting a specific geometry: + +`sudo tlmgr gui -geometry {{width}}x{{height}}-{{xpos}}+{{ypos}}` + +- Start a GUI passing an arbitrary X resource string: + +`sudo tlmgr gui -xrm {{xresource}}` diff --git a/tlmgr-info b/tlmgr-info new file mode 100644 index 00000000..3592e81d --- /dev/null +++ b/tlmgr-info @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr info + +> Show information about TeX Live packages. +> More information: . + +- List all available TeX Live packages, prefexing installed ones with `i`: + +`tlmgr info` + +- List all available collections: + +`tlmgr info collections` + +- List all available schemes: + +`tlmgr info scheme` + +- Show information about a specific package: + +`tlmgr info {{package}}` + +- List all files contained in a specific package: + +`tlmgr info {{package}} --list` + +- List all installed packages: + +`tlmgr info --only-installed` + +- Show only specific information about a package: + +`tlmgr info {{package}} --data "{{name}},{{category}},{{installed}},{{size}},{{depends}},..."` + +- Print all available packages as JSON encoded array: + +`tlmgr info --json` diff --git a/tlmgr-install b/tlmgr-install new file mode 100644 index 00000000..9193d4ca --- /dev/null +++ b/tlmgr-install @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr install + +> Install TeX Live packages. +> More information: . + +- Install a package and its dependencies: + +`sudo tlmgr install {{package}}` + +- Reinstall a package: + +`sudo tlmgr install --reinstall {{package}}` + +- Simulate installing a package without making any changes: + +`tlmgr install --dry-run {{package}}` + +- Install a package without its dependencies: + +`sudo tlmgr install --no-depends {{package}}` + +- Install a package from a specific file: + +`sudo tlmgr install --file {{path/to/package}}` diff --git a/tlmgr-key b/tlmgr-key new file mode 100644 index 00000000..713c329a --- /dev/null +++ b/tlmgr-key @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr key + +> Manage GPG keys used to verify TeX Live databases. +> More information: . + +- List all keys for TeX Live: + +`tlmgr key list` + +- Add a key from a specific file: + +`sudo tlmgr key add {{path/to/key.gpg}}` + +- Add a key from `stdin`: + +`cat {{path/to/key.gpg}} | sudo tlmgr key add -` + +- Remove a specific key by its ID: + +`sudo tlmgr key remove {{key_id}}` diff --git a/tlmgr-option b/tlmgr-option new file mode 100644 index 00000000..2fc7a5d2 --- /dev/null +++ b/tlmgr-option @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr option + +> TeX Live settings manager. +> More information: . + +- List all TeX Live settings: + +`tlmgr option showall` + +- List all currently set Tex Live settings: + +`tlmgr option show` + +- Print all TeX Live settings in JSON format: + +`tlmgr option showall --json` + +- Show the value of a specific TeX Live setting: + +`tlmgr option {{setting}}` + +- Modify the value of a specific TeX Live setting: + +`tlmgr option {{setting}} {{value}}` + +- Set TeX Live to get future updates from the internet after installing from DVD: + +`tlmgr option {{repository}} {{https://mirror.ctan.org/systems/texlive/tlnet}}` diff --git a/tlmgr-paper b/tlmgr-paper new file mode 100644 index 00000000..69228be6 --- /dev/null +++ b/tlmgr-paper @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr paper + +> Manage paper size options of an TeX Live installation. +> More information: . + +- Show the default paper size used by all TeX Live programs: + +`tlmgr paper` + +- Set the default paper size for all TeX Live programs to A4: + +`sudo tlmgr paper {{a4}}` + +- Show the default paper size used by a specific TeX Live program: + +`tlmgr {{pdftex}} paper` + +- Set the default paper size for a specific TeX Live program to A4: + +`sudo tlmgr {{pdftex}} paper {{a4}}` + +- List all available paper sizes for a specific TeX Live program: + +`tlmgr {{pdftex}} paper --list` + +- Dump the default paper size used by all TeX Live programs in JSON format: + +`tlmgr paper --json` diff --git a/tlmgr-path b/tlmgr-path new file mode 100644 index 00000000..29c8758d --- /dev/null +++ b/tlmgr-path @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr path + +> Add or remove symlinks for TeX Live executables, man pages and info pages. +> This command has to be re-run for files added in the future. +> More information: . + +- Add symlinks to TeX Live files: + +`sudo tlmgr path add` + +- Remove symlinks to TeX Live files: + +`sudo tlmgr path remove` diff --git a/tlmgr-pinning b/tlmgr-pinning new file mode 100644 index 00000000..aeb6ca5f --- /dev/null +++ b/tlmgr-pinning @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr pinning + +> The pinning action manages the pinning file. +> More information: . + +- Show the current pinning data: + +`tlmgr pinning show` + +- Pin the matching the packages to the given repository: + +`tlmgr pinning add {{repository}} {{package1 package2 ...}}` + +- Remove any packages recorded in the pinning file matching the packages for the given repository: + +`tlmgr pinning remove {{repository}} {{package1 package2 ...}}` + +- Remove all pinning data for the given repository: + +`tlmgr pinning remove {{repository}} --all` diff --git a/tlmgr-platform b/tlmgr-platform new file mode 100644 index 00000000..64f83d93 --- /dev/null +++ b/tlmgr-platform @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr platform + +> Manage TeX Live platforms. +> More information: . + +- List all available platforms in the package repository: + +`tlmgr platform list` + +- Add the executables for a specific platform: + +`sudo tlmgr platform add {{platform}}` + +- Remove the executables for a specific platform: + +`sudo tlmgr platform remove {{platform}}` + +- Auto-detect and switch to the current platform: + +`sudo tlmgr platform set auto` + +- Switch to a specific platform: + +`sudo tlmgr platform set {{platform}}` diff --git a/tlmgr-recreate-tlpdb b/tlmgr-recreate-tlpdb new file mode 100644 index 00000000..2bb73913 --- /dev/null +++ b/tlmgr-recreate-tlpdb @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr recreate-tlpdb + +> Recreate the TeX Live package database. +> This command has a lack of documentation and should be used with caution. +> More information: . + +- Recreate the `texlive.tlpdb` database file and dump it to `stdout`: + +`sudo tlmgr recreate-tlpdb` diff --git a/tlmgr-remove b/tlmgr-remove new file mode 100644 index 00000000..218d7f84 --- /dev/null +++ b/tlmgr-remove @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr remove + +> Uninstall TeX Live packages. +> By default, removed packages will be backed up to `./tlpkg/backups` under the TL installation directory. +> More information: . + +- Uninstall a TeX Live package: + +`sudo tlmgr remove {{package}}` + +- Simulate uninstalling a package without making any changes: + +`tlmgr remove --dry-run {{package}}` + +- Uninstall a package without its dependencies: + +`sudo tlmgr remove --no-depends {{package}}` + +- Uninstall a package and back it up to a specific directory: + +`sudo tlmgr remove --backupdir {{path/to/directory}} {{package}}` + +- Uninstall all of TeX Live, asking for confirmation: + +`sudo tlmgr remove --all` diff --git a/tlmgr-repository b/tlmgr-repository new file mode 100644 index 00000000..0610a9ad --- /dev/null +++ b/tlmgr-repository @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr repository + +> Manage repositories of a TeX Live installation. +> More information: . + +- List all configured repositories and their tags (if set): + +`tlmgr repository list` + +- List all packages available in a specific repository: + +`tlmgr repository list {{path|url|tag}}` + +- Add a new repository with a specific tag (the tag is not required): + +`sudo tlmgr repository add {{path|url}} {{tag}}` + +- Remove a specific repository: + +`sudo tlmgr repository remove {{path|url|tag}}` + +- Set a new list of repositories, overwriting the previous list: + +`sudo tlmgr repository set {{path|url|tag}}#{{tag}} {{path|url|tag}}#{{tag}} {{...}}` + +- Show the verification status of all configured repositories: + +`tlmgr repository status` diff --git a/tlmgr-restore b/tlmgr-restore new file mode 100644 index 00000000..eeb5a34b --- /dev/null +++ b/tlmgr-restore @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr restore + +> Restore package backups created with `tlmgr backup`. +> The default backup directory is specified by the `backupdir` option, and can be obtained with `tlmgr option`. +> More information: . + +- List all available backup revisions for all packages: + +`tlmgr restore` + +- List all available backup revisions for a specific package: + +`tlmgr restore {{package}}` + +- Restore a specific revision of a specific package: + +`tlmgr restore {{package}} {{revision}}` + +- Restore the latest revision of all backed-up packages: + +`tlmgr restore --all` + +- Restore a package from a custom backup directory: + +`tlmgr restore {{package}} {{revision}} --backupdir {{path/to/backup_directory}}` + +- Perform a dry-run and print all taken actions without making them: + +`tlmgr restore --dry-run {{package}} {{revision}}` diff --git a/tlmgr-search b/tlmgr-search new file mode 100644 index 00000000..d80613f0 --- /dev/null +++ b/tlmgr-search @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr search + +> Search for TeX Live packages using (Perl) regular expressions. +> More information: . + +- Search for a package name and descriptions of all locally installed packages from a specific regular expression: + +`tlmgr search "{{regular_expression}}"` + +- Search for all file names of all locally installed packages from a regular expression: + +`tlmgr search --file "{{regular_expression}}"` + +- Search for all file names, package names, and descriptions of all locally installed packages from a regular expression: + +`tlmgr search --all "{{regular_expression}}"` + +- Search the TeX Live database, instead of the local installation: + +`tlmgr search --global "{{regular_expression}}"` + +- Restrict the matches for package names and descriptions (but not for file names) to whole words: + +`tlmgr search --all --word "{{regular_expression}}"` diff --git a/tlmgr-shell b/tlmgr-shell new file mode 100644 index 00000000..8a10bf48 --- /dev/null +++ b/tlmgr-shell @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr shell + +> Start an interactive shell of the native TeX Live manager. +> More information: . + +- Start an interactive shell of `tlmgr`: + +`tlmgr shell` + +- Run any `tlmgr` subcommand in the interactive shell: + +`{{subcommand}} {{arguments}}` + +- Quit the interactive shell: + +`quit` + +- List all TeX Live variables: + +`get` + +- Get the value of a TeX Live variable: + +`get {{variable}}` + +- Set the value of a TeX Live variable: + +`set {{variable}} {{value}}` + +- Restart the interactive shell: + +`restart` + +- Display the version of the current protocol: + +`protocol` diff --git a/tlmgr-update b/tlmgr-update new file mode 100644 index 00000000..a76634c8 --- /dev/null +++ b/tlmgr-update @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tlmgr update + +> Update TeX Live packages. +> More information: . + +- Update all TeX Live packages: + +`sudo tlmgr update --all` + +- Update tlmgr itself: + +`sudo tlmgr update --self` + +- Update a specific package: + +`sudo tlmgr update {{package}}` + +- Update all except a specific package: + +`sudo tlmgr update --all --exclude {{package}}` + +- Update all packages, making a backup of the current packages: + +`sudo tlmgr update --all --backup` + +- Update a specific package without updating its dependencies: + +`sudo tlmgr update --no-depends {{package}}` + +- Simulate updating all packages without making any changes: + +`sudo tlmgr update --all --dry-run` diff --git a/tmpmail b/tmpmail new file mode 100644 index 00000000..f34d2df2 --- /dev/null +++ b/tmpmail @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tmpmail + +> A temporary email right from your terminal written in POSIX sh. +> More information: . + +- Create a temporary inbox: + +`tmpmail --generate` + +- List messages and their numeric ID: + +`tmpmail` + +- Display the most recent received email: + +`tmpmail --recent` + +- Open a specific message: + +`tmpmail {{email_id}}` + +- View email as raw text without HTML tags: + +`tmpmail --text` + +- Open email with a specific browser (default is w3m): + +`tmpmail --browser {{browser}}` diff --git a/tmsu b/tmsu new file mode 100644 index 00000000..85d0de63 --- /dev/null +++ b/tmsu @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tmsu + +> Simple command-line tool for tagging files. +> More information: . + +- Tag a specific file with multiple tags: + +`tmsu tag {{path/to/file.mp3}} {{music}} {{big-jazz}} {{mp3}}` + +- Tag multiple files: + +`tmsu tag --tags "{{music mp3}}" {{*.mp3}}` + +- List tags of specified file(s): + +`tmsu tags {{*.mp3}}` + +- List files with specified tag(s): + +`tmsu files {{big-jazz}} {{music}}` + +- List files with tags matching boolean expression: + +`tmsu files "{{(year >= 1990 and year <= 2000)}} and {{grunge}}"` + +- Mount tmsu virtual filesystem to an existing directory: + +`tmsu mount {{path/to/directory}}` diff --git a/tmux b/tmux new file mode 100644 index 00000000..724ba1aa --- /dev/null +++ b/tmux @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tmux + +> Terminal multiplexer. +> It allows multiple sessions with windows, panes, and more. +> See also: `zellij`, `screen`. +> More information: . + +- Start a new session: + +`tmux` + +- Start a new named session: + +`tmux new -s {{name}}` + +- List existing sessions: + +`tmux ls` + +- Attach to the most recently used session: + +`tmux attach` + +- Detach from the current session (inside a tmux session): + +`-B d` + +- Create a new window (inside a tmux session): + +`-B c` + +- Switch between sessions and windows (inside a tmux session): + +`-B w` + +- Kill a session by name: + +`tmux kill-session -t {{name}}` diff --git a/tmuxinator b/tmuxinator new file mode 100644 index 00000000..3509e53b --- /dev/null +++ b/tmuxinator @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tmuxinator + +> Create and manage tmux sessions easily. +> More information: . + +- Create a new project: + +`tmuxinator new {{project}}` + +- Edit a project: + +`tmuxinator edit {{project}}` + +- List projects: + +`tmuxinator list` + +- Start a tmux session based on project: + +`tmuxinator start {{project}}` + +- Stop a project's tmux session: + +`tmuxinator stop {{project}}` diff --git a/todo b/todo new file mode 100644 index 00000000..f5767a05 --- /dev/null +++ b/todo @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# todo + +> A simple, standards-based, cli todo manager. +> More information: . + +- List startable tasks: + +`todo list --startable` + +- Add a new task to the work list: + +`todo new {{thing_to_do}} --list {{work}}` + +- Add a location to a task with a given ID: + +`todo edit --location {{location_name}} {{task_id}}` + +- Show details about a task: + +`todo show {{task_id}}` + +- Mark tasks with the specified IDs as completed: + +`todo done {{task_id1 task_id2 ...}}` + +- Delete a task: + +`todo delete {{task_id}}` + +- Delete done tasks and reset the IDs of the remaining tasks: + +`todo flush` diff --git a/todo.sh b/todo.sh new file mode 100644 index 00000000..fd3d64eb --- /dev/null +++ b/todo.sh @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# todo.sh + +> Simple and extensible shell script for managing your `todo.txt` file. +> More information: . + +- List every item: + +`todo.sh ls` + +- Add an item with project and context tags: + +`todo.sh add '{{description}} +{{project}} @{{context}}'` + +- Mark an item as [do]ne: + +`todo.sh do {{item_no}}` + +- Remove an item: + +`todo.sh rm {{item_no}}` + +- Set an item's [pri]ority (A-Z): + +`todo.sh pri {{item_no}} {{priority}}` + +- Replace an item: + +`todo.sh replace {{item_no}} '{{new_description}}'` diff --git a/todoist b/todoist new file mode 100644 index 00000000..7787e665 --- /dev/null +++ b/todoist @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# todoist + +> Access from the command-line. +> More information: . + +- Add a task: + +`todoist add "{{task_name}}"` + +- Add a high priority task with a label, project, and due date: + +`todoist add "{{task_name}}" --priority {{1}} --label-ids "{{label_id}}" --project-name "{{project_name}}" --date "{{tmr 9am}}"` + +- Add a high priority task with a label, project, and due date in quick mode: + +`todoist quick '#{{project_name}} "{{tmr 9am}}" p{{1}} {{task_name}} @{{label_name}}'` + +- List all tasks with a header and color: + +`todoist --header --color list` + +- List all high priority tasks: + +`todoist list --filter p{{1}}` + +- List today's tasks with high priority that have the specified label: + +`todoist list --filter '(@{{label_name}} | {{today}}) & p{{1}}'` diff --git a/todoman b/todoman new file mode 100644 index 00000000..4c09d738 --- /dev/null +++ b/todoman @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +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: . + +- View documentation for the original command: + +`tldr todo` diff --git a/tokei b/tokei new file mode 100644 index 00000000..587c761c --- /dev/null +++ b/tokei @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tokei + +> A program that prints out statistics about code. +> More information: . + +- Get a report on the code in a directory and all subdirectories: + +`tokei {{path/to/directory}}` + +- Get a report for a directory excluding `.min.js` files: + +`tokei {{path/to/directory}} -e {{*.min.js}}` + +- Print out statistics for individual files in a directory: + +`tokei {{path/to/directory}} --files` + +- Get a report for all files of type Rust and Markdown: + +`tokei {{path/to/directory}} -t={{Rust}},{{Markdown}}` diff --git a/topgrade b/topgrade new file mode 100644 index 00000000..67b60405 --- /dev/null +++ b/topgrade @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# topgrade + +> Update all applications on the system. +> More information: . + +- Run updates: + +`topgrade` + +- Say yes to all updates: + +`topgrade -y` + +- Cleanup temporary/old files: + +`topgrade -c` + +- Disable a certain update operation: + +`topgrade --disable {{operation}}` + +- Only perform a certain update operation: + +`topgrade --only {{operation}}` + +- Edit the configuration file with default editor: + +`topgrade --edit-config` diff --git a/topydo b/topydo new file mode 100644 index 00000000..a655a937 --- /dev/null +++ b/topydo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# topydo + +> A to-do list application that uses the todo.txt format. +> More information: . + +- Add a to-do to a specific project with a given context: + +`topydo add "{{todo_message}} +{{project_name}} @{{context_name}}"` + +- Add a to-do with a due date of tomorrow with a priority of `A`: + +`topydo add "(A) {{todo _message}} due:{{1d}}"` + +- Add a to-do with a due date of Friday: + +`topydo add "{{todo_message}} due:{{fri}}"` + +- Add a non-strict repeating to-do (next due = now + rec): + +`topydo add "water flowers due:{{mon}} rec:{{1w}}"` + +- Add a strict repeating to-do (next due = current due + rec): + +`topydo add "{{todo_message}} due:{{2020-01-01}} rec:{{+1m}}"` + +- Revert the last `topydo` command executed: + +`topydo revert` diff --git a/touch b/touch new file mode 100644 index 00000000..4fc2971e --- /dev/null +++ b/touch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# touch + +> Create files and set access/modification times. +> More information: . + +- Create specific files: + +`touch {{path/to/file1 path/to/file2 ...}}` + +- Set the file [a]ccess or [m]odification times to the current one and don't [c]reate file if it doesn't exist: + +`touch -c -{{a|m}} {{path/to/file1 path/to/file2 ...}}` + +- Set the file [t]ime to a specific value and don't [c]reate file if it doesn't exist: + +`touch -c -t {{YYYYMMDDHHMM.SS}} {{path/to/file1 path/to/file2 ...}}` + +- Set the file time of a specific file to the time of anothe[r] file and don't [c]reate file if it doesn't exist: + +`touch -c -r {{~/.emacs}} {{path/to/file1 path/to/file2 ...}}` diff --git a/tox b/tox new file mode 100644 index 00000000..c7f393e4 --- /dev/null +++ b/tox @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tox + +> Automate Python testing across multiple Python versions. +> Use tox.ini to configure environments and test command. +> More information: . + +- Run tests on all test environments: + +`tox` + +- Create a `tox.ini` configuration: + +`tox-quickstart` + +- List the available environments: + +`tox --listenvs-all` + +- Run tests on a specific environment (e.g. Python 3.6): + +`tox -e {{py36}}` + +- Force the virtual environment to be recreated: + +`tox --recreate -e {{py27}}` diff --git a/tpp b/tpp new file mode 100644 index 00000000..6612f974 --- /dev/null +++ b/tpp @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tpp + +> Command-Line based presentation tool. +> More information: . + +- View a presentation: + +`tpp {{path/to/file}}` + +- Output a presentation: + +`tpp -t {{type}} -o {{path/to/output}} {{path/to/file}}` diff --git a/tput b/tput new file mode 100644 index 00000000..c3bc2b6c --- /dev/null +++ b/tput @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tput + +> View and modify terminal settings and capabilities. +> More information: . + +- Move the cursor to a screen location: + +`tput cup {{row}} {{column}}` + +- Set foreground (af) or background (ab) color: + +`tput {{setaf|setab}} {{ansi_color_code}}` + +- Show number of columns, lines, or colors: + +`tput {{cols|lines|colors}}` + +- Ring the terminal bell: + +`tput bel` + +- Reset all terminal attributes: + +`tput sgr0` + +- Enable or disable word wrap: + +`tput {{smam|rmam}}` diff --git a/tr b/tr new file mode 100644 index 00000000..927eae17 --- /dev/null +++ b/tr @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tr + +> Translate characters: run replacements based on single characters and character sets. +> More information: . + +- Replace all occurrences of a character in a file, and print the result: + +`tr {{find_character}} {{replace_character}} < {{path/to/file}}` + +- Replace all occurrences of a character from another command's output: + +`echo {{text}} | tr {{find_character}} {{replace_character}}` + +- Map each character of the first set to the corresponding character of the second set: + +`tr '{{abcd}}' '{{jkmn}}' < {{path/to/file}}` + +- Delete all occurrences of the specified set of characters from the input: + +`tr -d '{{input_characters}}' < {{path/to/file}}` + +- Compress a series of identical characters to a single character: + +`tr -s '{{input_characters}}' < {{path/to/file}}` + +- Translate the contents of a file to upper-case: + +`tr "[:lower:]" "[:upper:]" < {{path/to/file}}` + +- Strip out non-printable characters from a file: + +`tr -cd "[:print:]" < {{path/to/file}}` diff --git a/traceroute b/traceroute new file mode 100644 index 00000000..f97f45e5 --- /dev/null +++ b/traceroute @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# traceroute + +> Print the route packets trace to network host. +> More information: . + +- Traceroute to a host: + +`traceroute {{example.com}}` + +- Disable IP address and host name mapping: + +`traceroute -n {{example.com}}` + +- Specify wait time in seconds for response: + +`traceroute --wait={{0.5}} {{example.com}}` + +- Specify number of queries per hop: + +`traceroute --queries={{5}} {{example.com}}` + +- Specify size in bytes of probing packet: + +`traceroute {{example.com}} {{42}}` + +- Determine the MTU to the destination: + +`traceroute --mtu {{example.com}}` + +- Use ICMP instead of UDP for tracerouting: + +`traceroute --icmp {{example.com}}` diff --git a/traefik b/traefik new file mode 100644 index 00000000..26161dc8 --- /dev/null +++ b/traefik @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# traefik + +> An HTTP reverse proxy and load balancer. +> More information: . + +- Start server with default config: + +`traefik` + +- Start server with a custom configuration file: + +`traefik --c {{config_file.toml}}` + +- Start server with cluster mode enabled: + +`traefik --cluster` + +- Start server with web UI enabled: + +`traefik --web` diff --git a/trans b/trans new file mode 100644 index 00000000..c781a454 --- /dev/null +++ b/trans @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trans + +> Translate Shell is a command-line translator. +> More information: . + +- Translate a word (language is detected automatically): + +`trans "{{word_or_sentence_to_translate}}"` + +- Get a brief translation: + +`trans --brief "{{word_or_sentence_to_translate}}"` + +- Translate a word into french: + +`trans :{{fr}} {{word}}` + +- Translate a word from German to English: + +`trans {{de}}:{{en}} {{Schmetterling}}` + +- Behave like a dictionary to get the meaning of a word: + +`trans -d {{word}}` diff --git a/transcode b/transcode new file mode 100644 index 00000000..2416589c --- /dev/null +++ b/transcode @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transcode + +> Transcode video and audio codecs, and convert between media formats. +> More information: . + +- Create stabilization file to be able to remove camera shakes: + +`transcode -J stabilize -i {{input_file}}` + +- Remove camera shakes after creating stabilization file, transform video using XviD: + +`transcode -J transform -i {{input_file}} -y xvid -o {{output_file}}` + +- Resize the video to 640x480 pixels and convert to MPEG4 codec using XviD: + +`transcode -Z 640x480 -i {{input_file}} -y xvid -o {{output_file}}` diff --git a/transcrypt b/transcrypt new file mode 100644 index 00000000..d4193cd1 --- /dev/null +++ b/transcrypt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transcrypt + +> Transparently encrypt files within a Git repository. +> More information: . + +- Initialize an unconfigured repository: + +`transcrypt` + +- List the currently encrypted files: + +`git ls-crypt` + +- Display the credentials of a configured repository: + +`transcrypt --display` + +- Initialize and decrypt a fresh clone of a configured repository: + +`transcrypt --cipher={{cipher}}` + +- Rekey to change the encryption cipher or password: + +`transcrypt --rekey` diff --git a/transfersh b/transfersh new file mode 100644 index 00000000..fb05c16c --- /dev/null +++ b/transfersh @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transfersh + +> An unofficial command-line client for transfer.sh. +> More information: . + +- Upload a file to transfer.sh: + +`transfersh {{path/to/file}}` + +- Upload a file showing a progress bar (requires Python package `requests_toolbelt`): + +`transfersh --progress {{path/to/file}}` + +- Upload a file using a different file name: + +`transfersh --name {{filename}} {{path/to/file}}` + +- Upload a file to a custom transfer.sh server: + +`transfersh --servername {{upload.server.name}} {{path/to/file}}` + +- Upload all files from a directory recursively: + +`transfersh --recursive {{path/to/directory/}}` + +- Upload a specific directory as an uncompressed tar: + +`transfersh -rt {{path/to/directory}}` diff --git a/transmission b/transmission new file mode 100644 index 00000000..5a379d21 --- /dev/null +++ b/transmission @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission + +> A simple torrent client. +> Transmission isn't a command, but a set of commands. See the pages below. +> More information: . + +- View documentation for running Transmission's daemon: + +`tldr transmission-daemon` + +- View documentation for interacting with the daemon: + +`tldr transmission-remote` + +- View documentation for creating torrent files: + +`tldr transmission-create` + +- View documentation for modifying torrent files: + +`tldr transmission-edit` + +- View documentation for getting info about torrent files: + +`tldr transmission-show` + +- View documentation for the deprecated method for interacting with the daemon: + +`tldr transmission-cli` diff --git a/transmission-cli b/transmission-cli new file mode 100644 index 00000000..7c6d47e7 --- /dev/null +++ b/transmission-cli @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-cli + +> A lightweight, command-line BitTorrent client. +> This tool has been deprecated, please see `transmission-remote`. +> More information: . + +- Download a specific torrent: + +`transmission-cli {{url|magnet|path/to/file}}` + +- Download a torrent to a specific directory: + +`transmission-cli --download-dir {{path/to/download_directory}} {{url|magnet|path/to/file}}` + +- Create a torrent file from a specific file or directory: + +`transmission-cli --new {{path/to/source_file_or_directory}}` + +- Specify the download speed limit (in KB/s): + +`transmission-cli --downlimit {{50}} {{url|magnet|path/to/file}}` + +- Specify the upload speed limit (in KB/s): + +`transmission-cli --uplimit {{50}} {{url|magnet|path/to/file}}` + +- Use a specific port for connections: + +`transmission-cli --port {{port_number}} {{url|magnet|path/to/file}}` + +- Force encryption for peer connections: + +`transmission-cli --encryption-required {{url|magnet|path/to/file}}` + +- Use a Bluetack-formatted peer blocklist: + +`transmission-cli --blocklist {{blocklist_url|path/to/blocklist}} {{url|magnet|path/to/file}}` diff --git a/transmission-create b/transmission-create new file mode 100644 index 00000000..48970a03 --- /dev/null +++ b/transmission-create @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-create + +> Create BitTorrent `.torrent` files. +> See also: `transmission`. +> More information: . + +- Create a torrent with 2048 KB as the piece size: + +`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` + +- Create a private torrent with a 2048 KB piece size: + +`transmission-create -p -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` + +- Create a torrent with a comment: + +`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} -c {{comment}} {{path/to/file_or_directory}}` + +- Create a torrent with multiple trackers: + +`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} --tracker {{tracker_url2}} {{path/to/file_or_directory}}` + +- Display help page: + +`transmission-create --help` diff --git a/transmission-daemon b/transmission-daemon new file mode 100644 index 00000000..f1adfccb --- /dev/null +++ b/transmission-daemon @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-daemon + +> Daemon controlled with `transmission-remote` or its web interface. +> See also: `transmission`. +> More information: . + +- Start a headless `transmission` session: + +`transmission-daemon` + +- Start and watch a specific directory for new torrents: + +`transmission-daemon --watch-dir {{path/to/directory}}` + +- Dump daemon settings in JSON format: + +`transmission-daemon --dump-settings > {{path/to/file.json}}` + +- Start with specific settings for the web interface: + +`transmission-daemon --auth --username {{username}} --password {{password}} --port {{9091}} --allowed {{127.0.0.1}}` diff --git a/transmission-edit b/transmission-edit new file mode 100644 index 00000000..d8233f53 --- /dev/null +++ b/transmission-edit @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-edit + +> Modify announce URLs from torrent files. +> See also: `transmission`. +> More information: . + +- Add or remove a URL from a torrent's announce list: + +`transmission-edit --{{add|delete}} {{http://example.com}} {{path/to/file.torrent}}` + +- Update a tracker's passcode in a torrent file: + +`transmission-edit --replace {{old-passcode}} {{new-passcode}} {{path/to/file.torrent}}` diff --git a/transmission-remote b/transmission-remote new file mode 100644 index 00000000..fa0e3b0a --- /dev/null +++ b/transmission-remote @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-remote + +> Remote control utility for `transmission-daemon` and `transmission`. +> More information: . + +- Add a torrent file or magnet link to Transmission and download to a specified directory: + +`transmission-remote {{hostname}} -a {{torrent|url}} -w {{/path/to/download_directory}}` + +- Change the default download directory: + +`transmission-remote {{hostname}} -w {{/path/to/download_directory}}` + +- List all torrents: + +`transmission-remote {{hostname}} --list` + +- Start torrent 1 and 2, stop torrent 3: + +`transmission-remote {{hostname}} -t "{{1,2}}" --start -t {{3}} --stop` + +- Remove torrent 1 and 2, and also delete local data for torrent 2: + +`transmission-remote {{hostname}} -t {{1}} --remove -t {{2}} --remove-and-delete` + +- Stop all torrents: + +`transmission-remote {{hostname}} -t {{all}} --stop` + +- Move torrents 1-10 and 15-20 to a new directory (which will be created if it does not exist): + +`transmission-remote {{hostname}} -t "{{1-10,15-20}}" --move {{/path/to/new_directory}}` diff --git a/transmission-show b/transmission-show new file mode 100644 index 00000000..2a5f785c --- /dev/null +++ b/transmission-show @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# transmission-show + +> Get information about a torrent file. +> See also: `transmission`. +> More information: . + +- Display metadata for a specific torrent: + +`transmission-show {{path/to/file.torrent}}` + +- Generate a magnet link for a specific torrent: + +`transmission-show --magnet {{path/to/file.torrent}}` + +- Query a torrent's trackers and print the current number of peers: + +`transmission-show --scrape {{path/to/file.torrent}}` diff --git a/trap b/trap new file mode 100644 index 00000000..bd9bf6d4 --- /dev/null +++ b/trap @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trap + +> Execute a command upon an event. +> More information: . + +- List the commands and the names of the expected events: + +`trap` + +- Execute a command when a signal is received: + +`trap 'echo "Caught signal {{SIGHUP}}"' {{HUP}}` + +- Remove commands: + +`trap - {{HUP}} {{INT}}` diff --git a/trash-cli b/trash-cli new file mode 100644 index 00000000..fefc9b67 --- /dev/null +++ b/trash-cli @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trash-cli + +> A command-line interface to the trashcan APIs. +> More information: . + +- Trash specific files and directories into the current trashcan: + +`trash-put {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Remove specific files from the current trashcan: + +`trash-rm {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Empty the current trashcan: + +`trash-empty` + +- List trashed files and directories in the current trashcan: + +`trash-list` + +- Restore a specific file or directory by a number from the displayed list from the current trashcan: + +`trash-restore` diff --git a/travis b/travis new file mode 100644 index 00000000..454b0686 --- /dev/null +++ b/travis @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# travis + +> Command-line client to interface with Travis CI. +> More information: . + +- Display the client version: + +`travis version` + +- Authenticate the CLI client against the server, using an authentication token: + +`travis login` + +- List repositories the user has permissions on: + +`travis repos` + +- Encrypt values in `.travis.yml`: + +`travis encrypt {{token}}` + +- Generate a `.travis.yml` file and enable the project: + +`travis init` diff --git a/trawl b/trawl new file mode 100644 index 00000000..96434b3d --- /dev/null +++ b/trawl @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trawl + +> Prints out network interface information to the console, much like ifconfig/ipconfig/ip/ifdata. +> More information: . + +- Show column names: + +`trawl -n` + +- Filter interface names using a case-insensitive regular expression: + +`trawl -f wi` + +- List available interfaces: + +`trawl -i` + +- Include the loopback interface: + +`trawl -l` diff --git a/tre b/tre new file mode 100644 index 00000000..ede371fd --- /dev/null +++ b/tre @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tre + +> Show the contents of the current directory as a tree. +> Respects the `.gitignore` settings by default. +> More information: . + +- Print directories only: + +`tre --directories` + +- Print JSON containing files in the tree hierarchy instead of the normal tree diagram: + +`tre --json` + +- Print files and directories up to the specified depth limit (where 1 means the current directory): + +`tre --limit {{depth}}` + +- Print all hidden files and directories using the specified colorization mode: + +`tre --all --color {{automatic|always|never}}` + +- Print files within the tree hierarchy, assigning a shell alias to each file that, when called, will open the associated file using the provided `command` (or in `$EDITOR` by default): + +`tre --editor {{command}}` + +- Print files within the tree hierarchy, excluding all paths that match the provided regular expression: + +`tre --exclude {{regular_expression}}` + +- Display version: + +`tre --version` + +- Display help: + +`tre --help` diff --git a/tred b/tred new file mode 100644 index 00000000..71e295da --- /dev/null +++ b/tred @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tred + +> Compute the transitive reduction of directed graphs. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Construct the transitive reduction graph of one or more directed graphs: + +`tred {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Display help: + +`tred -?` diff --git a/tree b/tree new file mode 100644 index 00000000..994c1bb5 --- /dev/null +++ b/tree @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tree + +> Show the contents of the current directory as a tree. +> More information: . + +- Print files and directories up to 'num' levels of depth (where 1 means the current directory): + +`tree -L {{num}}` + +- Print directories only: + +`tree -d` + +- Print hidden files too with colorization on: + +`tree -a -C` + +- Print the tree without indentation lines, showing the full path instead (use `-N` to not escape non-printable characters): + +`tree -i -f` + +- Print the size of each file and the cumulative size of each directory, in human-readable format: + +`tree -s -h --du` + +- Print files within the tree hierarchy, using a wildcard (glob) pattern, and pruning out directories that don't contain matching files: + +`tree -P '{{*.txt}}' --prune` + +- Print directories within the tree hierarchy, using the wildcard (glob) pattern, and pruning out directories that aren't ancestors of the wanted one: + +`tree -P {{directory_name}} --matchdirs --prune` + +- Print the tree ignoring the given directories: + +`tree -I '{{directory_name1|directory_name2}}'` diff --git a/trivy b/trivy new file mode 100644 index 00000000..d2a46c4b --- /dev/null +++ b/trivy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# trivy + +> Scanner for vulnerabilities in container images, file systems, and Git repositories, as well as for configuration issues. +> More information: . + +- Scan an image: + +`trivy image {{image:tag}}` + +- Scan the filesystem for vulnerabilities and misconfigurations: + +`trivy fs --security-checks {{vuln,config}} {{path/to/project_directory}}` + +- Scan a directory for misconfigurations: + +`trivy config {{path/to/iac_directory}}` + +- Generate output with a SARIF template: + +`trivy image --format {{template}} --template {{"@sarif.tpl"}} -o {{path/to/report.sarif}} {{image:tag}}` diff --git a/troff b/troff new file mode 100644 index 00000000..9cc0e80c --- /dev/null +++ b/troff @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# troff + +> Typesetting processor for the groff (GNU Troff) document formatting system. +> See also `groff`. +> More information: . + +- Format output for a PostScript printer, saving the output to a file: + +`troff {{path/to/input.roff}} | grops > {{path/to/output.ps}}` + +- Format output for a PostScript printer using the [me] macro package, saving the output to a file: + +`troff -{{me}} {{path/to/input.roff}} | grops > {{path/to/output.ps}}` + +- Format output as [a]SCII text using the [man] macro package: + +`troff -T {{ascii}} -{{man}} {{path/to/input.roff}} | grotty` + +- Format output as a [pdf] file, saving the output to a file: + +`troff -T {{pdf}} {{path/to/input.roff}} | gropdf > {{path/to/output.pdf}}` diff --git a/true b/true new file mode 100644 index 00000000..5df74006 --- /dev/null +++ b/true @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# true + +> Returns a successful exit status code of 0. +> Use this with the || operator to make a command always exit with 0. +> More information: . + +- Return a successful exit code: + +`true` diff --git a/truffle b/truffle new file mode 100644 index 00000000..5eeb1457 --- /dev/null +++ b/truffle @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# truffle + +> Develop smart contracts for running services on the Ethereum blockchain. +> More information: . + +- Download a pre-built Truffle project (Truffle Box): + +`truffle unbox {{box_name}}` + +- Compile contract source files in the current directory: + +`truffle compile` + +- Run JavaScript and Solidity tests: + +`truffle test` + +- Run migrations to deploy contracts: + +`truffle migrate` + +- Display help for a subcommand: + +`truffle help {{subcommand}}` diff --git a/truncate b/truncate new file mode 100644 index 00000000..4c3c08c7 --- /dev/null +++ b/truncate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# truncate + +> Shrink or extend the size of a file to the specified size. +> More information: . + +- Set a size of 10 GB to an existing file, or create a new file with the specified size: + +`truncate --size {{10G}} {{filename}}` + +- Extend the file size by 50 MiB, fill with holes (which reads as zero bytes): + +`truncate --size +{{50M}} {{filename}}` + +- Shrink the file by 2 GiB, by removing data from the end of file: + +`truncate --size -{{2G}} {{filename}}` + +- Empty the file's content: + +`truncate --size 0 {{filename}}` + +- Empty the file's content, but do not create the file if it does not exist: + +`truncate --no-create --size 0 {{filename}}` diff --git a/ts b/ts new file mode 100644 index 00000000..326a1c88 --- /dev/null +++ b/ts @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ts + +> Add timestamps to every line from `stdin`. +> More information: . + +- Add a timestamp to the beginning of each line: + +`{{command}} | ts` + +- Add timestamps with microsecond precision: + +`{{command}} | ts "{{%b %d %H:%M:%.S}}"` + +- Add [i]ncremental timestamps with microsecond precision, starting from zero: + +`{{command}} | ts -i "{{%H:%M:%.S}}"` + +- Convert existing timestamps in a text file (eg. a log file) into [r]elative format: + +`cat {{path/to/file}} | ts -r` diff --git a/ts-node b/ts-node new file mode 100644 index 00000000..2fc1d9d6 --- /dev/null +++ b/ts-node @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ts-node + +> Run TypeScript code directly, without any compiling. +> More information: . + +- Execute a TypeScript file without compiling (`node` + `tsc`): + +`ts-node {{path/to/file.ts}}` + +- Execute a TypeScript file without loading `tsconfig.json`: + +`ts-node --skip-project {{path/to/file.ts}}` + +- Evaluate TypeScript code passed as a literal: + +`ts-node --eval '{{console.log("Hello World")}}'` + +- Execute a TypeScript file in script mode: + +`ts-node --script-mode {{path/to/file.ts}}` + +- Transpile a TypeScript file to JavaScript without executing it: + +`ts-node --transpile-only {{path/to/file.ts}}` + +- Display TS-Node help: + +`ts-node --help` diff --git a/tsc b/tsc new file mode 100644 index 00000000..c591c08b --- /dev/null +++ b/tsc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tsc + +> TypeScript compiler. +> More information: . + +- Compile a TypeScript file `foobar.ts` into a JavaScript file `foobar.js`: + +`tsc {{foobar.ts}}` + +- Compile a TypeScript file into JavaScript using a specific target syntax (default is `ES3`): + +`tsc --target {{ES5|ES2015|ES2016|ES2017|ES2018|ESNEXT}} {{foobar.ts}}` + +- Compile a TypeScript file into a JavaScript file with a custom name: + +`tsc --outFile {{output.js}} {{input.ts}}` + +- Compile all `.ts` files of a TypeScript project defined in a `tsconfig.json` file: + +`tsc --build {{tsconfig.json}}` + +- Run the compiler using command-line options and arguments fetched from a text file: + +`tsc @{{args.txt}}` + +- Type-check multiple JavaScript files, and output only the errors: + +`tsc --allowJs --checkJs --noEmit {{src/**/*.js}}` diff --git a/tslint b/tslint new file mode 100644 index 00000000..b63028fe --- /dev/null +++ b/tslint @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tslint + +> A pluggable linting utility for TypeScript. +> More information: . + +- Create TSLint config: + +`tslint --init` + +- Lint on a given set of files: + +`tslint {{path/to/file1.js path/to/file2.js ...}}` + +- Fix lint issues: + +`tslint --fix` + +- Lint with the configuration file in the project root: + +`tslint --project {{path/to/project_root}}` diff --git a/tsort b/tsort new file mode 100644 index 00000000..d7797485 --- /dev/null +++ b/tsort @@ -0,0 +1,20 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tsort + +> Perform a topological sort. +> A common use is to show the dependency order of nodes in a directed acyclic graph. +> More information: . + +- Perform a topological sort consistent with a partial sort per line of input separated by blanks: + +`tsort {{path/to/file}}` + +- Perform a topological sort consistent on strings: + +`echo -e "{{UI Backend +Backend Database +Docs UI}}" | tsort` diff --git a/tsv-filter b/tsv-filter new file mode 100644 index 00000000..602057e7 --- /dev/null +++ b/tsv-filter @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tsv-filter + +> Filter lines of a TSV file by running tests against individual fields. +> More information: . + +- Print the lines where a specific column is numerically equal to a given number: + +`tsv-filter -H --eq {{field_name}}:{{number}} {{path/to/tsv_file}}` + +- Print the lines where a specific column is [eq]ual/[n]on [e]qual/[l]ess [t]han/[l]ess than or [e]qual/[g]reater [t]han/[g]reater than or [e]qual to a given number: + +`tsv-filter --{{eq|ne|lt|le|gt|ge}} {{column_number}}:{{number}} {{path/to/tsv_file}}` + +- Print the lines where a specific column is [eq]ual/[n]ot [e]qual/part of/not part of a given string: + +`tsv-filter --str-{{eq|ne|in-fld|not-in-fld}} {{column_number}}:{{string}} {{path/to/tsv_file}}` + +- Filter for non-empty fields: + +`tsv-filter --not-empty {{column_number}} {{path/to/tsv_file}}` + +- Print the lines where a specific column is empty: + +`tsv-filter --invert --not-empty {{column_number}} {{path/to/tsv_file}}` + +- Print the lines that satisfy two conditions: + +`tsv-filter --eq {{column_number1}}:{{number}} --str-eq {{column_number2}}:{{string}} {{path/to/tsv_file}}` + +- Print the lines that match at least one condition: + +`tsv-filter --or --eq {{column_number1}}:{{number}} --str-eq {{column_number2}}:{{string}} {{path/to/tsv_file}}` + +- Count matching lines, interpreting first line as a [H]eader: + +`tsv-filter --count -H --eq {{field_name}}:{{number}} {{path/to/tsv_file}}` diff --git a/tt b/tt new file mode 100644 index 00000000..90cf8795 --- /dev/null +++ b/tt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tt + +> A terminal based typing test. +> More information: . + +- Start quote mode with the builtin quote list in English: + +`tt -quotes {{en}}` + +- Produce a test consisting of 50 randomly drawn words in 5 groups of 10 words each: + +`tt -n {{10}} -g {{5}}` + +- Start a timed test lasting 10 seconds: + +`tt -t {{10}}` + +- Start `tt` with no theming and showing your WPM as you type: + +`tt -showwpm -notheme` diff --git a/tts b/tts new file mode 100644 index 00000000..36bd2685 --- /dev/null +++ b/tts @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tts + +> Synthesize speech. +> More information: . + +- Run text-to-speech with the default models, writing the output to "tts_output.wav": + +`tts --text "{{text}}"` + +- List provided models: + +`tts --list_models` + +- Query info for a model by idx: + +`tts --model_info_by_idx {{model_type/model_query_idx}}` + +- Query info for a model by name: + +`tts --model_info_by_name {{model_type/language/dataset/model_name}}` + +- Run a text-to-speech model with its default vocoder model: + +`tts --text "{{text}}" --model_name {{model_type/language/dataset/model_name}}` + +- Run your own text-to-speech model (using the Griffin-Lim vocoder): + +`tts --text "{{text}}" --model_path {{path/to/model.pth}} --config_path {{path/to/config.json}} --out_path {{path/to/file.wav}}` diff --git a/tty b/tty new file mode 100644 index 00000000..c68a41d1 --- /dev/null +++ b/tty @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tty + +> Returns terminal name. +> More information: . + +- Print the file name of this terminal: + +`tty` diff --git a/tuckr b/tuckr new file mode 100644 index 00000000..0bd49d51 --- /dev/null +++ b/tuckr @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tuckr + +> Dotfile manager written in Rust. +> More information: . + +- Check dotfile status: + +`tuckr status` + +- Add all dotfiles to system: + +`tuckr add \*` + +- Add all dotfiles except specified programs: + +`tuckr add \* -e {{program1}},{{program2}}` + +- Remove all dotfiles from the system: + +`tuckr rm \*` + +- Add a program dotfile and run its setup script: + +`tuckr set {{program}}` diff --git a/tuir b/tuir new file mode 100644 index 00000000..f1154469 --- /dev/null +++ b/tuir @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tuir + +> A text user-interface (TUI) to view and interact with Reddit from your terminal. +> Navigate with the Vim keys. +> More information: . + +- Launch tuir: + +`tuir` + +- Open a subreddit: + +`/{{subreddit_name}}` + +- Open a link: + +`o` + +- Open a specific subreddit on launch: + +`tuir -s {{subreddit_name}}` + +- Open external links using programs defined in the mailcap config: + +`tuir --enable-media` diff --git a/turbo b/turbo new file mode 100644 index 00000000..a185f285 --- /dev/null +++ b/turbo @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# turbo + +> High-performance build system for JavaScript and TypeScript codebases. +> See also: `nx`. +> More information: . + +- Log in using the default web browser with a Vercel account: + +`turbo login` + +- Link the current directory to a Vercel organization and enable remote caching: + +`turbo link` + +- Build the current project: + +`turbo run build` + +- Run a task without concurrency: + +`turbo run {{task_name}} --concurrency={{1}}` + +- Run a task ignoring cached artifacts and forcibly re-execute all tasks: + +`turbo run {{task_name}} --force` + +- Run a task in parallel across packages: + +`turbo run {{task_name}} --parallel --no-cache` + +- Unlink the current directory from your Vercel organization and disable Remote Caching: + +`turbo unlink` + +- Generate a Dot graph of a specific task execution (the output file format can be controlled with the filename): + +`turbo run {{task_name}} --graph={{path/to/file.html|jpg|json|pdf|png|svg}}` diff --git a/twine b/twine new file mode 100644 index 00000000..fe5ed17b --- /dev/null +++ b/twine @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# twine + +> Utility for publishing Python packages on PyPI. +> More information: . + +- Upload to PyPI: + +`twine upload dist/*` + +- Upload to the Test PyPI [r]epository to verify things look right: + +`twine upload -r testpypi dist/*` + +- Upload to PyPI with a specified [u]sername and [p]assword: + +`twine upload -u {{username}} -p {{password}} dist/*` + +- Upload to an alternative repository URL: + +`twine upload --repository-url {{repository_url}} dist/*` + +- Check that your distribution's long description should render correctly on PyPI: + +`twine check dist/*` + +- Upload using a specific pypirc configuration file: + +`twine upload --config-file {{configuration_file}} dist/*` + +- Continue uploading files if one already exists (only valid when uploading to PyPI): + +`twine upload --skip-existing dist/*` + +- Upload to PyPI showing detailed information: + +`twine upload --verbose dist/*` diff --git a/twm b/twm new file mode 100644 index 00000000..7f08ceaa --- /dev/null +++ b/twm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# twm + +> A window manager for the X Window system. +> More information: . + +- Connect to the default X server: + +`twm` + +- Connect to a specific X server: + +`twm -display {{display}}` + +- Only manage the default screen: + +`twm -s` + +- Use a specific startup file: + +`twm -f {{path/to/file}}` + +- Enable verbose mode and print unexpected errors in X: + +`twm -v` diff --git a/twopi b/twopi new file mode 100644 index 00000000..7697788f --- /dev/null +++ b/twopi @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# twopi + +> Render an image of a `radial` network graph from a `graphviz` file. +> Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. +> More information: . + +- Render a `png` image with a filename based on the input filename and output format (uppercase -O): + +`twopi -T {{png}} -O {{path/to/input.gv}}` + +- Render a `svg` image with the specified output filename (lowercase -o): + +`twopi -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` + +- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: + +`twopi -T {{format}} -O {{path/to/input.gv}}` + +- Render a `gif` image using `stdin` and `stdout`: + +`echo "{{digraph {this -> that} }}" | twopi -T {{gif}} > {{path/to/image.gif}}` + +- Display help: + +`twopi -?` diff --git a/twurl b/twurl new file mode 100644 index 00000000..d1e15dd8 --- /dev/null +++ b/twurl @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# twurl + +> Curl-like command but tailored specifically for the Twitter API. +> More information: . + +- Authorize `twurl` to access a Twitter account: + +`twurl authorize --consumer-key {{twitter_api_key}} --consumer-secret {{twitter_api_secret}}` + +- Make a GET request to an API endpoint: + +`twurl -X GET {{twitter_api_endpoint}}` + +- Make a POST request to an API endpoint: + +`twurl -X POST -d '{{endpoint_params}}' {{twitter_api_endpoint}}` + +- Upload media to Twitter: + +`twurl -H "{{twitter_upload_url}}" -X POST "{{twitter_upload_endpoint}}" --file "{{path/to/media.jpg}}" --file-field "media"` + +- Access a different Twitter API host: + +`twurl -H {{twitter_api_url}} -X GET {{twitter_api_endpoint}}` + +- Create an alias for a requested resource: + +`twurl alias {{alias_name}} {{resource}}` diff --git a/tye b/tye new file mode 100644 index 00000000..4ace830c --- /dev/null +++ b/tye @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# tye + +> Develop, test, and deploy microservices and distributed applications easily. +> More information: . + +- Scaffold a `tye.yaml` file representing the application: + +`tye init` + +- Run an application locally: + +`tye run` + +- Build an application's containers: + +`tye build` + +- Push an application's containers: + +`tye push` + +- Deploy an application to Kubernetes: + +`tye deploy` + +- Remove a deployed application from Kubernetes: + +`tye undeploy` diff --git a/type b/type new file mode 100644 index 00000000..6207d015 --- /dev/null +++ b/type @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# type + +> Display the type of command the shell will execute. +> More information: . + +- Display the type of a command: + +`type {{command}}` + +- Display all locations containing the specified executable: + +`type -a {{command}}` + +- Display the name of the disk file that would be executed: + +`type -p {{command}}` diff --git a/typeorm b/typeorm new file mode 100644 index 00000000..4e527afb --- /dev/null +++ b/typeorm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +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: . + +- Generate a new initial TypeORM project structure: + +`typeorm init` + +- Create an empty migration file: + +`typeorm migration:create --name {{migration_name}}` + +- Create a migration file with the SQL statements to update the schema: + +`typeorm migration:generate --name {{migration_name}}` + +- Run all pending migrations: + +`typeorm migration:run` + +- Create a new entity file in a specific directory: + +`typeorm entity:create --name {{entity}} --dir {{path/to/directory}}` + +- Display the SQL statements to be executed by `typeorm schema:sync` on the default connection: + +`typeorm schema:log` + +- Execute a specific SQL statement on the default connection: + +`typeorm query {{sql_sentence}}` + +- Display help for a subcommand: + +`typeorm {{subcommand}} --help` diff --git a/typeset b/typeset new file mode 100644 index 00000000..46ef339a --- /dev/null +++ b/typeset @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# typeset + +> Declare variables and give them attributes. +> More information: . + +- Declare a string variable with the specified value: + +`typeset {{variable}}="{{value}}"` + +- Declare an integer variable with the specified value: + +`typeset -i {{variable}}="{{value}}"` + +- Declare an array variable with the specified value: + +`typeset {{variable}}=({{item_a item_b item_c}})` + +- Declare an associative array variable with the specified value: + +`typeset -A {{variable}}=({{[key_a]=item_a [key_b]=item_b [key_c]=item_c}})` + +- Declare a readonly variable with the specified value: + +`typeset -r {{variable}}="{{value}}"` + +- Declare a global variable within a function with the specified value: + +`typeset -g {{variable}}="{{value}}"` diff --git a/typst b/typst new file mode 100644 index 00000000..22e62309 --- /dev/null +++ b/typst @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# typst + +> Compile a Typst file to PDF. +> Note: Specifying the output location is optional. +> More information: . + +- List all discoverable fonts in the system and the given directory: + +`typst --font-path {{path/to/fonts_directory}} fonts` + +- Compile a Typst file: + +`typst compile {{path/to/source.typ}} {{path/to/output.pdf}}` + +- Watch a Typst file and recompile on changes: + +`typst watch {{path/to/source.typ}} {{path/to/output.pdf}}` diff --git a/u3d b/u3d new file mode 100644 index 00000000..4e772e27 --- /dev/null +++ b/u3d @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# u3d + +> A set of tools to interact with Unity. +> More information: . + +- Open the project in the current directory using the correct Unity version: + +`u3d` + +- List installed versions of Unity: + +`u3d list` + +- List available versions of Unity that can be downloaded: + +`u3d available` + +- Download and install latest stable Unity version: + +`u3d install latest_stable` + +- Download and install Unity version and editor [p]ackages: + +`u3d install {{2021.2.0f1}} -p {{Unity,iOS,Android}}` diff --git a/ufraw-batch b/ufraw-batch new file mode 100644 index 00000000..208a4fd5 --- /dev/null +++ b/ufraw-batch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ufraw-batch + +> Convert RAW files from cameras into standard image files. +> More information: . + +- Simply convert RAW files to JPG: + +`ufraw-batch --out-type=jpg {{input_file(s)}}` + +- Simply convert RAW files to PNG: + +`ufraw-batch --out-type=png {{input_file(s)}}` + +- Extract the preview image from the raw file: + +`ufraw-batch --embedded-image {{input_file(s)}}` + +- Save the file with size up to the given maximums MAX1 and MAX2: + +`ufraw-batch --size=MAX1,MAX2 {{input_file(s)}}` diff --git a/ugrep b/ugrep new file mode 100644 index 00000000..ef5cc8a5 --- /dev/null +++ b/ugrep @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ugrep + +> Ultra fast search tool with query TUI. +> More information: . + +- Start a query TUI to search files in the current directory recursively (CTRL-Z for help): + +`ugrep --query` + +- Search the current directory recursively for files containing a regex search pattern: + +`ugrep "{{search_pattern}}"` + +- Search in a specific file or in all files in a specific directory, showing line numbers of matches: + +`ugrep --line-number "{{search_pattern}}" {{path/to/file_or_directory}}` + +- Search in all files in the current directory recursively and print the name of each matching file: + +`ugrep --files-with-matches "{{search_pattern}}"` + +- Fuzzy search files with up to 3 extra, missing or mismatching characters in the pattern: + +`ugrep --fuzzy={{3}} "{{search_pattern}}"` + +- Also search compressed files, `zip` and `tar` archives recursively: + +`ugrep --decompress "{{search_pattern}}"` + +- Search only files whose filenames match a specific glob pattern: + +`ugrep --glob="{{glob_pattern}}" "{{search_pattern}}"` + +- Search only C++ source files (use `--file-type=list` to list all file types): + +`ugrep --file-type=cpp "{{search_pattern}}"` diff --git a/ulimit b/ulimit new file mode 100644 index 00000000..10a7f8ba --- /dev/null +++ b/ulimit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ulimit + +> Get and set user limits. +> More information: . + +- Get the properties of all the user limits: + +`ulimit -a` + +- Get hard limit for the number of simultaneously opened files: + +`ulimit -H -n` + +- Get soft limit for the number of simultaneously opened files: + +`ulimit -S -n` + +- Set max per-user process limit: + +`ulimit -u 30` diff --git a/umask b/umask new file mode 100644 index 00000000..a5445f95 --- /dev/null +++ b/umask @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# umask + +> Manage the read/write/execute permissions that are masked out (i.e. restricted) for newly created files by the user. +> More information: . + +- Display the current mask in octal notation: + +`umask` + +- Display the current mask in symbolic (human-readable) mode: + +`umask -S` + +- Change the mask symbolically to allow read permission for all users (the rest of the mask bits are unchanged): + +`umask {{a+r}}` + +- Set the mask (using octal) to restrict no permissions for the file's owner, and restrict all permissions for everyone else: + +`umask {{077}}` diff --git a/umount b/umount new file mode 100644 index 00000000..9136a17c --- /dev/null +++ b/umount @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# umount + +> Unlink a filesystem from its mount point, making it no longer accessible. +> A filesystem cannot be unmounted when it is busy. +> More information: . + +- Unmount a filesystem, by passing the path to the source it is mounted from: + +`umount {{path/to/device_file}}` + +- Unmount a filesystem, by passing the path to the target where it is mounted: + +`umount {{path/to/mounted_directory}}` + +- Unmount all mounted filesystems (except the `proc` filesystem): + +`umount -a` diff --git a/unalias b/unalias new file mode 100644 index 00000000..539b657d --- /dev/null +++ b/unalias @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unalias + +> Remove aliases. +> More information: . + +- Remove an alias: + +`unalias {{alias_name}}` + +- Remove all aliases: + +`unalias -a` diff --git a/uname b/uname new file mode 100644 index 00000000..d78ca0e2 --- /dev/null +++ b/uname @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uname + +> Print details about the current machine and the operating system running on it. +> See also `lsb_release`. +> More information: . + +- Print kernel name: + +`uname` + +- Print system architecture and processor information: + +`uname --machine --processor` + +- Print kernel name, kernel release and kernel version: + +`uname --kernel-name --kernel-release --kernel-version` + +- Print system hostname: + +`uname --nodename` + +- Print all available system information: + +`uname --all` diff --git a/unar b/unar new file mode 100644 index 00000000..5170c283 --- /dev/null +++ b/unar @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unar + +> Extract contents from archive files. +> More information: . + +- Extract an archive to the current directory: + +`unar {{archive}}` + +- Extract an archive to the specified directory: + +`unar -o {{path/to/directory}} {{archive}}` + +- Force overwrite if files to be unpacked already exist: + +`unar -f {{archive}}` + +- Force rename if files to be unpacked already exist: + +`unar -r {{archive}}` + +- Force skip if files to be unpacked already exist: + +`unar -s {{archive}}` diff --git a/unclutter b/unclutter new file mode 100644 index 00000000..bde28184 --- /dev/null +++ b/unclutter @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unclutter + +> Hides the mouse cursor. +> More information: . + +- Hide mouse cursor after 3 seconds: + +`unclutter -idle {{3}}` diff --git a/uncrustify b/uncrustify new file mode 100644 index 00000000..36549ff0 --- /dev/null +++ b/uncrustify @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uncrustify + +> C, C++, C#, D, Java and Pawn source code formatter. +> More information: . + +- Format a single file: + +`uncrustify -f {{path/to/file.cpp}} -o {{path/to/output.cpp}}` + +- Read filenames from `stdin`, and take backups before writing output back to the original filepaths: + +`find . -name "*.cpp" | uncrustify -F - --replace` + +- Don't make backups (useful if files are under version control): + +`find . -name "*.cpp" | uncrustify -F - --no-backup` + +- Use a custom configuration file and write the result to `stdout`: + +`uncrustify -c {{path/to/uncrustify.cfg}} -f {{path/to/file.cpp}}` + +- Explicitly set a configuration variable's value: + +`uncrustify --set {{option}}={{value}}` + +- Generate a new configuration file: + +`uncrustify --update-config -o {{path/to/new.cfg}}` diff --git a/unexpand b/unexpand new file mode 100644 index 00000000..1bb318da --- /dev/null +++ b/unexpand @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unexpand + +> Convert spaces to tabs. +> More information: . + +- Convert blanks in each file to tabs, writing to `stdout`: + +`unexpand {{path/to/file}}` + +- Convert blanks to tabs, reading from `stdout`: + +`unexpand` + +- Convert all blanks, instead of just initial blanks: + +`unexpand -a {{path/to/file}}` + +- Convert only leading sequences of blanks (overrides -a): + +`unexpand --first-only {{path/to/file}}` + +- Have tabs a certain number of characters apart, not 8 (enables -a): + +`unexpand -t {{number}} {{path/to/file}}` diff --git a/unflatten b/unflatten new file mode 100644 index 00000000..08420f85 --- /dev/null +++ b/unflatten @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unflatten + +> Adjust directed graphs to improve the layout aspect ratio. +> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`. +> More information: . + +- Adjust one or more directed graphs to improve the layout aspect ratio: + +`unflatten {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}` + +- Use `unflatten` as a preprocessor for `dot` layout to improve aspect ratio: + +`unflatten {{path/to/input.gv}} | dot -T {{png}} {{path/to/output.png}}` + +- Display help: + +`unflatten -?` diff --git a/unimatrix b/unimatrix new file mode 100644 index 00000000..564568c9 --- /dev/null +++ b/unimatrix @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unimatrix + +> Simulate the Matrix look with Unicode characters. +> See also: `cmatrix`. +> More information: . + +- Mimic the default output of `cmatrix` (no unicode, works in a TTY): + +`unimatrix --no-bold --speed {{96}} --character-list {{o}}` + +- No bold characters, slowly, with emojis, numbers, and a few symbols: + +`unimatrix --no-bold --speed {{50}} --character-list {{ens}}` + +- Change the color of characters: + +`unimatrix --color {{red|green|blue|white|...}}` + +- Select character set(s) using letter codes (see `unimatrix --help` for available character sets): + +`unimatrix --character-list {{character_sets}}` + +- Change the scrolling speed: + +`unimatrix --speed {{number}}` diff --git a/uniq b/uniq new file mode 100644 index 00000000..02f1f4c2 --- /dev/null +++ b/uniq @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uniq + +> Output the unique lines from a input or file. +> Since it does not detect repeated lines unless they are adjacent, we need to sort them first. +> More information: . + +- Display each line once: + +`sort {{path/to/file}} | uniq` + +- Display only unique lines: + +`sort {{path/to/file}} | uniq -u` + +- Display only duplicate lines: + +`sort {{path/to/file}} | uniq -d` + +- Display number of occurrences of each line along with that line: + +`sort {{path/to/file}} | uniq -c` + +- Display number of occurrences of each line, sorted by the most frequent: + +`sort {{path/to/file}} | uniq -c | sort -nr` diff --git a/unison b/unison new file mode 100644 index 00000000..3275ce5c --- /dev/null +++ b/unison @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unison + +> Bidirectional file synchronisation tool. +> More information: . + +- Sync two directories (creates log first time these two directories are synchronized): + +`unison {{path/to/directory_1}} {{path/to/directory_2}}` + +- Automatically accept the (non-conflicting) defaults: + +`unison {{path/to/directory_1}} {{path/to/directory_2}} -auto` + +- Ignore some files using a pattern: + +`unison {{path/to/directory_1}} {{path/to/directory_2}} -ignore {{pattern}}` + +- View documentation: + +`unison -doc {{topics}}` diff --git a/units b/units new file mode 100644 index 00000000..1ec9bfbf --- /dev/null +++ b/units @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# units + +> Provide the conversion between two units of measure. +> More information: . + +- Run in interactive mode: + +`units` + +- List all units containing a specific string in interactive mode: + +`search {{string}}` + +- Show the conversion between two simple units: + +`units {{quarts}} {{tablespoons}}` + +- Convert between units with quantities: + +`units "{{15 pounds}}" {{kilograms}}` + +- Show the conversion between two compound units: + +`units "{{meters / second}}" "{{inches / hour}}"` + +- Show the conversion between units with different dimensions: + +`units "{{acres}}" "{{ft^2}}"` + +- Show the conversion of byte multipliers: + +`units "{{15 megabytes}}" {{bytes}}` diff --git a/unlink b/unlink new file mode 100644 index 00000000..f4791dc7 --- /dev/null +++ b/unlink @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unlink + +> Remove a link to a file from the filesystem. +> The file contents is lost if the link is the last one to the file. +> More information: . + +- Remove the specified file if it is the last link: + +`unlink {{path/to/file}}` diff --git a/unlzma b/unlzma new file mode 100644 index 00000000..a4a6bfe7 --- /dev/null +++ b/unlzma @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unlzma + +> This command is an alias of `xz --format=lzma --decompress`. +> More information: . + +- View documentation for the original command: + +`tldr xz` diff --git a/unp b/unp new file mode 100644 index 00000000..66a10fcf --- /dev/null +++ b/unp @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unp + +> Extract any archive. +> Relevant extractors need to be installed, e.g. `unrar` for RAR. +> More information: . + +- Extract an archive: + +`unp {{path/to/archive.zip}}` + +- Extract multiple archives: + +`unp {{path/to/archive1.tar.gz}} {{path/to/archive2.rar}}` diff --git a/unrar b/unrar new file mode 100644 index 00000000..ff22e3ba --- /dev/null +++ b/unrar @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unrar + +> Extract RAR archives. +> More information: . + +- Extract files with original directory structure: + +`unrar x {{compressed.rar}}` + +- Extract files to a specified path with the original directory structure: + +`unrar x {{compressed.rar}} {{path/to/extract}}` + +- Extract files into current directory, losing directory structure in the archive: + +`unrar e {{compressed.rar}}` + +- Test integrity of each file inside the archive file: + +`unrar t {{compressed.rar}}` + +- List files inside the archive file without decompressing it: + +`unrar l {{compressed.rar}}` diff --git a/unxz b/unxz new file mode 100644 index 00000000..4bda2faf --- /dev/null +++ b/unxz @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unxz + +> This command is an alias of `xz --decompress`. +> More information: . + +- View documentation for the original command: + +`tldr xz` diff --git a/unzip b/unzip new file mode 100644 index 00000000..666e6c76 --- /dev/null +++ b/unzip @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unzip + +> Extract files/directories from ZIP archives. +> See also: `zip`. +> More information: . + +- Extract all files/directories from specific archives into the current directory: + +`unzip {{path/to/archive1.zip path/to/archive2.zip ...}}` + +- Extract files/directories from archives to a specific path: + +`unzip {{path/to/archive1.zip path/to/archive2.zip ...}} -d {{path/to/output}}` + +- Extract files/directories from archives to `stdout`: + +`unzip -c {{path/to/archive1.zip path/to/archive2.zip ...}}` + +- Extract the contents of the file(s) to `stdout` alongside the extracted file names: + +`unzip -O {{gbk}} {{path/to/archive1.zip path/to/archive2.zip ...}}` + +- List the contents of a specific archive without extracting them: + +`unzip -l {{path/to/archive.zip}}` + +- Extract a specific file from an archive: + +`unzip -j {{path/to/archive.zip}} {{path/to/file_in_archive1 path/to/file_in_archive2 ...}}` diff --git a/unzstd b/unzstd new file mode 100644 index 00000000..af3234e0 --- /dev/null +++ b/unzstd @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# unzstd + +> This command is an alias of `zstd --decompress`. + +- View documentation for the original command: + +`tldr zstd` diff --git a/updog b/updog new file mode 100644 index 00000000..0ac69c35 --- /dev/null +++ b/updog @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# updog + +> A replacement for Python's SimpleHTTPServer. +> It allows uploading and downloading via HTTP/S, can set ad hoc SSL certificates and use HTTP basic auth. +> More information: . + +- Start a HTTP server for the current directory: + +`updog` + +- Start a HTTP server for a specified directory: + +`updog --directory {{/path/to/directory}}` + +- Start a HTTP server on a specified port: + +`updog --port {{port}}` + +- Start a HTTP server with a password (To log in, leave the username blank and enter the password in the password field): + +`updog --password {{password}}` + +- Enable transport encryption via SSL: + +`updog --ssl` diff --git a/uptime b/uptime new file mode 100644 index 00000000..d48ea22c --- /dev/null +++ b/uptime @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uptime + +> Tell how long the system has been running and other information. +> More information: . + +- Print current time, uptime, number of logged-in users and other information: + +`uptime` + +- Show only the amount of time the system has been booted for: + +`uptime --pretty` + +- Print the date and time the system booted up at: + +`uptime --since` + +- Display version: + +`uptime --version` diff --git a/upx b/upx new file mode 100644 index 00000000..dc61dd08 --- /dev/null +++ b/upx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# upx + +> Compress or decompress executables. +> More information: . + +- Compress executable: + +`upx {{path/to/file}}` + +- Decompress executable: + +`upx -d {{path/to/file}}` + +- Detailed help: + +`upx --help` diff --git a/users b/users new file mode 100644 index 00000000..b263f6b7 --- /dev/null +++ b/users @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# users + +> Display a list of logged in users. +> See also: `useradd`, `userdel`, `usermod`. +> More information: . + +- Print logged in usernames: + +`users` + +- Print logged in usernames according to a given file: + +`users {{/var/log/wmtp}}` diff --git a/usql b/usql new file mode 100644 index 00000000..27a8c77d --- /dev/null +++ b/usql @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# usql + +> Universal CLI interface for SQL databases. +> More information: . + +- Connect to a specific database: + +`usql {{sqlserver|mysql|postgres|sqlite3|...}}://{{username}}:{{password}}@{{host}}:{{port}}/{{database_name}}` + +- Execute commands from a file: + +`usql --file={{path/to/query.sql}}` + +- Execute a specific SQL command: + +`usql --command="{{sql_command}}"` + +- List databases available on the server: + +`usql --list-databases` + +- Run an SQL command in the `usql` prompt: + +`{{prompt}}=> {{command}}` + +- Display the database schema: + +`{{prompt}}=> \d` + +- Export query results to a specific file: + +`{{prompt}}=> \g {{/path/to/results.txt}}` + +- Import data from a CSV file into a specific table: + +`{{prompt}}=> \ No newline at end of file diff --git a/uudecode b/uudecode new file mode 100644 index 00000000..bd69bfb1 --- /dev/null +++ b/uudecode @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uudecode + +> Decode files encoded by `uuencode`. +> More information: . + +- Decode a file that was encoded with `uuencode` and print the result to `stdout`: + +`uudecode {{path/to/encoded_file}}` + +- Decode a file that was encoded with `uuencode` and write the result to a file: + +`uudecode -o {{path/to/decoded_file}} {{path/to/encoded_file}}` diff --git a/uuencode b/uuencode new file mode 100644 index 00000000..4099fe12 --- /dev/null +++ b/uuencode @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uuencode + +> Encode binary files into ASCII for transport via mediums that only support simple ASCII encoding. +> More information: . + +- Encode a file and print the result to `stdout`: + +`uuencode {{path/to/input_file}} {{output_file_name_after_decoding}}` + +- Encode a file and write the result to a file: + +`uuencode -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` + +- Encode a file using Base64 instead of the default uuencode encoding and write the result to a file: + +`uuencode -m -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` diff --git a/uvicorn b/uvicorn new file mode 100644 index 00000000..0591d94b --- /dev/null +++ b/uvicorn @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# uvicorn + +> Python ASGI HTTP Server, for asynchronous projects. +> More information: . + +- Run Python web app: + +`uvicorn {{import.path:app_object}}` + +- Listen on port 8080 on localhost: + +`uvicorn --host {{localhost}} --port {{8080}} {{import.path:app_object}}` + +- Turn on live reload: + +`uvicorn --reload {{import.path:app_object}}` + +- Use 4 worker processes for handling requests: + +`uvicorn --workers {{4}} {{import.path:app_object}}` + +- Run app over HTTPS: + +`uvicorn --ssl-certfile {{cert.pem}} --ssl-keyfile {{key.pem}} {{import.path:app_object}}` diff --git a/vagrant b/vagrant new file mode 100644 index 00000000..a298d115 --- /dev/null +++ b/vagrant @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vagrant + +> Manage lightweight, reproducible, and portable development environments. +> More information: . + +- Create Vagrantfile in current directory with the base Vagrant box: + +`vagrant init` + +- Create Vagrantfile with the Ubuntu 20.04 (Focal Fossa) box from HashiCorp Atlas: + +`vagrant init ubuntu/focal64` + +- Start and provision the vagrant environment: + +`vagrant up` + +- Suspend the machine: + +`vagrant suspend` + +- Halt the machine: + +`vagrant halt` + +- Connect to machine via SSH: + +`vagrant ssh` + +- Output the SSH configuration file of the running Vagrant machine: + +`vagrant ssh-config` + +- List all local boxes: + +`vagrant box list` diff --git a/vala b/vala new file mode 100644 index 00000000..18e8613f --- /dev/null +++ b/vala @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vala + +> Vala code runner. +> Tutorial: . +> More information: . + +- Run a vala file, with gtk+: + +`vala {{path/to/file.vala}} --pkg {{gtk+-3.0}}` + +- Display help: + +`vala --help` + +- Display version: + +`vala --version` diff --git a/valac b/valac new file mode 100644 index 00000000..3ff5ee75 --- /dev/null +++ b/valac @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# valac + +> Vala code compiler. +> Tutorial: . +> More information: . + +- Compile a vala file, with gtk+: + +`valac {{path/to/file.vala}} --pkg {{gtk+-3.0}}` + +- Display help: + +`valac --help` + +- Display version: + +`valac --version` diff --git a/vale b/vale new file mode 100644 index 00000000..2e152654 --- /dev/null +++ b/vale @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vale + +> Extensible style checker that supports multiple markup formats, such as Markdown and AsciiDoc. +> More information: . + +- Check the style of a file: + +`vale {{path/to/file}}` + +- Check the style of a file with a specified configuration: + +`vale --config='{{path/to/.vale.ini}}' {{path/to/file}}` + +- Output the results in JSON format: + +`vale --output=JSON {{path/to/file}}` + +- Check style issues at the specific severity and higher: + +`vale --minAlertLevel={{suggestion|warning|error}} {{path/to/file}}` + +- Check the style from `stdin`, specifying markup format: + +`cat {{file.md}} | vale --ext=.md` + +- List the current configuration: + +`vale ls-config` diff --git a/valgrind b/valgrind new file mode 100644 index 00000000..3ac3dc4a --- /dev/null +++ b/valgrind @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# valgrind + +> Wrapper for a set of expert tools for profiling, optimizing and debugging programs. +> Commonly used tools include `memcheck`, `cachegrind`, `callgrind`, `massif`, `helgrind`, and `drd`. +> More information: . + +- Use the (default) Memcheck tool to show a diagnostic of memory usage by `program`: + +`valgrind {{program}}` + +- Use Memcheck to report all possible memory leaks of `program` in full detail: + +`valgrind --leak-check=full --show-leak-kinds=all {{program}}` + +- Use the Cachegrind tool to profile and log CPU cache operations of `program`: + +`valgrind --tool=cachegrind {{program}}` + +- Use the Massif tool to profile and log heap memory and stack usage of `program`: + +`valgrind --tool=massif --stacks=yes {{program}}` diff --git a/var-dump-server b/var-dump-server new file mode 100644 index 00000000..db5926a5 --- /dev/null +++ b/var-dump-server @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# var-dump-server + +> Symfony dump server. +> Collects data dumped by the Symfony VarDumper component. +> More information: . + +- Start the server: + +`var-dump-server` + +- Dump the data in an HTML file: + +`var-dump-server --format=html > {{path/to/file.html}}` + +- Make the server listen on a specific address and port: + +`var-dump-server --host {{127.0.0.1:9912}}` diff --git a/varnishlog b/varnishlog new file mode 100644 index 00000000..34433485 --- /dev/null +++ b/varnishlog @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# varnishlog + +> Display Varnish logs. +> More information: . + +- Display logs in real time: + +`varnishlog` + +- Only display requests to a specific domain: + +`varnishlog -q 'ReqHeader eq "Host: {{example.com}}"'` + +- Only display POST requests: + +`varnishlog -q 'ReqMethod eq "{{POST}}"'` + +- Only display requests to a specific path: + +`varnishlog -q 'ReqURL eq "{{/path}}"'` + +- Only display requests to paths matching a regular expression: + +`varnishlog -q 'ReqURL ~ "{{regex}}"'` diff --git a/vault b/vault new file mode 100644 index 00000000..1ba7f53c --- /dev/null +++ b/vault @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vault + +> Interact with HashiCorp Vault. +> More information: . + +- Connect to a Vault server and initialize a new encrypted data store: + +`vault init` + +- Unseal (unlock) the vault, by providing one of the key shares needed to access the encrypted data store: + +`vault unseal {{key-share-x}}` + +- Authenticate the CLI client against the Vault server, using an authentication token: + +`vault auth {{authentication_token}}` + +- Store a new secret in the vault, using the generic back-end called "secret": + +`vault write secret/{{hello}} value={{world}}` + +- Read a value from the vault, using the generic back-end called "secret": + +`vault read secret/{{hello}}` + +- Read a specific field from the value: + +`vault read -field={{field_name}} secret/{{hello}}` + +- Seal (lock) the Vault server, by removing the encryption key of the data store from memory: + +`vault seal` diff --git a/vboxmanage b/vboxmanage new file mode 100644 index 00000000..a97f96bd --- /dev/null +++ b/vboxmanage @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# VBoxManage + +> Command-line interface to VirtualBox. +> Includes all the functionality of the GUI and more. +> Some subcommands such as `vboxmanage startvm` have their own usage documentation. +> More information: . + +- Execute a VboxManage subcommand: + +`VBoxManage {{subcommand}}` + +- Display help: + +`VBoxManage --help` + +- Display help for a specific subcommand: + +`VBoxManage --help {{clonevm|import|export|startvm|...}}` + +- Display version: + +`VBoxManage --version` diff --git a/vboxmanage-clonevm b/vboxmanage-clonevm new file mode 100644 index 00000000..c59057df --- /dev/null +++ b/vboxmanage-clonevm @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-clonevm + +> Create a clone of an existing virtual machine (VM). +> More information: . + +- Clone the specified VM: + +`VBoxManage clonevm {{vm_name}}` + +- Specify a new name for the new VM: + +`VBoxManage clonevm {{vm_name}} --name {{new_vm_name}}` + +- Indicate the folder where the new VM configuration is saved: + +`VBoxManage clonevm {{vm_name}} --basefolder {{path/to/directory}}` + +- Register the cloned VM in VirtualBox: + +`VBoxManage clonevm {{vm_name}} --register` diff --git a/vboxmanage-cloud b/vboxmanage-cloud new file mode 100644 index 00000000..890291f1 --- /dev/null +++ b/vboxmanage-cloud @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-cloud + +> VirtualBox command-line interface for managing cloud instances and images. +> More information: . + +- List the instances in the specified state belonging to the specified compartment: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} list instances --state={{running|terminated|paused}} --compartment-id={{compartment_id}` + +- Create a new instance: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} instance create --domain-name={{domain_name}} --image-id={{image_id}} | {{--options...}}` + +- Gather information about a particular instance: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} instance info --id={{unique_id}}` + +- Terminate an instance: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} instance terminate --id={{unique_id}}` + +- List images within a specific compartment and state: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} list images --compartment-id={{compartment_id}} --state={{state_name}}` + +- Create a new image: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} image create --instance-id={{instance_id}} --display-name={{display_name}} --compartment-id={{compartmet_id}}` + +- Retrieve information about a particular image: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} image info --id={{unique_id}}` + +- Delete an image: + +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} image delete --id={{unique_id}}` diff --git a/vboxmanage-controlvm b/vboxmanage-controlvm new file mode 100644 index 00000000..675c09f4 --- /dev/null +++ b/vboxmanage-controlvm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-controlvm + +> Change the state and the settings of a currently running virtual machine. +> More information: . + +- Temporarily stop the execution of a virtual machine: + +`VBoxManage controlvm {{uuid|vm_name}} pause` + +- Resume the execution of a paused virtual machine: + +`VBoxManage controlvm {{uuid|vm_name}} resume` + +- Perform a cold reset on the virtual machine: + +`VBoxManage controlvm {{uuid|vm_name}} reset` + +- Poweroff a virtual machine with the same effect as pulling the power cable of a computer: + +`VBoxManage controlvm {{uuid|vm_name}} poweroff` + +- Shutdown the virtual machine and save its current state: + +`VBoxManage controlvm {{uuid|vm_name}} savestate` + +- Send an ACPI (Advanced Configuration and Power Interface) shutdown signal to the virtual machine: + +`VBoxManage controlvm {{uuid|vm_name}} acpipowerbutton` + +- Send command to reboot itself to the guest OS: + +`VBoxManage controlvm {{uuid|vm_name}} reboot` + +- Shutdown down the virtual machine without saving its state: + +`VBoxManage controlvm {{uuid|vm_name}} shutdown` diff --git a/vboxmanage-createvm b/vboxmanage-createvm new file mode 100644 index 00000000..7bf3bd19 --- /dev/null +++ b/vboxmanage-createvm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-createvm + +> Create a new virtual machine. +> More information: . + +- Create a new VM with default settings: + +`VBoxManage createvm --name {{vm_name}}` + +- Set the base folder where the VM configuration will be stored: + +`VBoxManage createvm --name {{vm_name}} --basefolder {{path/to/directory}}` + +- Set the guest OS type (one of `VBoxManage list ostypes`) for the imported VM: + +`VBoxManage createvm --name {{vm_name}} --ostype {{ostype}}` + +- Register the created VM in VirtualBox: + +`VBoxManage createvm --name {{vm_name}} --register` + +- Set the VM to the specified groups: + +`VBoxManage createvm --name {{vm_name}} --group {{group1,group2,...}}` + +- Set the Universally Unique Identifier (UUID) of the VM: + +`VBoxManage createvm --name {{vm_name}} --uuid {{uuid}}` + +- Set the cipher to use for encryption: + +`VBoxManage createvm --name {{vm_name}} --cipher {{AES-128|AES-256}}` diff --git a/vboxmanage-export b/vboxmanage-export new file mode 100644 index 00000000..87977b46 --- /dev/null +++ b/vboxmanage-export @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-export + +> Export virtual machines to a virtual appliance (ISO) or a cloud service. +> More information: . + +- Specify the target OVA file: + +`VBoxManage export --output {{path/to/filename.ova}}` + +- Export in OVF 0.9 legacy mode: + +`VBoxManage export --legacy09` + +- Export in OVF (0.9|1.0|2.0) format: + +`VBoxManage export --{{ovf09|ovf10|ovf20}}` + +- Create manifest of the exported files: + +`VBoxManage export --manifest` + +- Specify a description of the VM: + +`VBoxManage export --description "{{vm_description}}"` diff --git a/vboxmanage-extpack b/vboxmanage-extpack new file mode 100644 index 00000000..52cf7c65 --- /dev/null +++ b/vboxmanage-extpack @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-extpack + +> Manage extension packs for Oracle VirtualBox. +> More information: . + +- Install extension packs to VirtualBox (Note: you need to remove the existing version of the extension pack before installing a new version.): + +`VBoxManage extpack install {{path/to/file.vbox-extpack}}` + +- Remove the existing version of the VirtualBox extension pack: + +`VBoxManage extpack install --replace` + +- Uninstall extension packs from VirtualBox: + +`VBoxManage extpack uninstall {{extension_pack_name}}` + +- Uninstall extension packs and skip most uninstallation refusals: + +`VBoxManage extpack uninstall --force {{extension_pack_name}}` + +- Clean up temporary files and directories left by extension packs: + +`VBoxManage extpack cleanup` diff --git a/vboxmanage-import b/vboxmanage-import new file mode 100644 index 00000000..d67c613d --- /dev/null +++ b/vboxmanage-import @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-import + +> Import a previously exported virtual machine (VM). +> More information: . + +- Import a VM from an OVF or OVA file: + +`VBoxManage import {{path/to/file.ovf}}` + +- Set the name of the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --name {{vm_name}}` + +- Indicate the folder where the configuration of the imported VM will be stored: + +`VBoxManage import {{path/to/file.ovf}} --basefolder {{path/to/directory}}` + +- Register the imported VM in VirtualBox: + +`VBoxManage import {{path/to/file.ovf}} --register` + +- Perform a dry run to check the import without actually importing: + +`VBoxManage import {{path/to/file.ovf}} --dry-run` + +- Set the guest OS type (one of `VBoxManage list ostypes`) for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --ostype={{ostype}}` + +- Set the memory (in megabytes) for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --memory={{1}}` + +- Set the number of CPUs for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --cpus={{1}}` diff --git a/vboxmanage-list b/vboxmanage-list new file mode 100644 index 00000000..0867a2ec --- /dev/null +++ b/vboxmanage-list @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-list + +> List information about the Oracle VM VirtualBox software and associated service. +> More information: . + +- List all VirtualBox virtual machines: + +`VBoxManage list vms` + +- Show DHCP servers available on the host system: + +`VBoxManage list dhcpservers` + +- Show Oracle VM VirtualBox extension packs currently installed: + +`VBoxManage list extpacks` + +- Show all virtual machine groups: + +`VBoxManage list groups` + +- Show virtual disk settings that are currently in use by VirtualBox: + +`VBoxManage list hdds` + +- Show host-only network interfaces available on host system: + +`VBoxManage list hostonlyifs` + +- Show the list of currently running virtual machines: + +`VBoxManage list runningvms` + +- Show host system information: + +`VBoxManage list hostinfo` diff --git a/vboxmanage-movevm b/vboxmanage-movevm new file mode 100644 index 00000000..35c2cfc3 --- /dev/null +++ b/vboxmanage-movevm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage movevm + +> Move a virtual machine (VM) to a new location on the host system. +> More information: . + +- Move the specified virtual machine to the current location: + +`VBoxManage movevm {{vm_name}}` + +- Specify the new location (full or relative pathname) of the virtual machine: + +`VBoxManage movevm {{vm_name}} --folder {{path/to/new_location}}` diff --git a/vboxmanage-registervm b/vboxmanage-registervm new file mode 100644 index 00000000..b2cccf0e --- /dev/null +++ b/vboxmanage-registervm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-registervm + +> Register a virtual machine (VM). +> More information: . + +- Register an existing VM: + +`VBoxManage registervm {{path/to/filename.vbox}}` + +- Supply the encryption password file of the VM: + +`VBoxManage registervm {{path/to/filename.vbox}} --password {{path/to/password_file}}` + +- Prompt for the encryption password on the command line: + +`VBoxManage registervm {{path/to/filename.vbox}} --password -` diff --git a/vboxmanage-showvminfo b/vboxmanage-showvminfo new file mode 100644 index 00000000..244c5e16 --- /dev/null +++ b/vboxmanage-showvminfo @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-showvminfo + +> Show information about registered virtual machine. +> More information: . + +- Show information about a particular virtual machine: + +`VBoxManage showvminfo {{vm_name|uuid}}` + +- Show more detailed information about a particular virtual machine: + +`VBoxManage showvminfo --details {{vm_name|uuid}}` + +- Show information in a machine readable format: + +`VBoxManage showvminfo --machinereadable {{vm_name|uuid}}` + +- Specify password ID if the virtual machine is encrypted: + +`VBoxManage showvminfo --password-id {{password_id}} {{vm_name|uuid}}` + +- Specify the password file if the virtual machine is encrypted: + +`VBoxManage showvminfo --password {{path/to/password_file}} {{vm_name|uuid}}` + +- Show the logs of a specific virtual machine: + +`VBoxManage showvminfo --log {{vm_name|uuid}}` diff --git a/vboxmanage-startvm b/vboxmanage-startvm new file mode 100644 index 00000000..3c9a9a82 --- /dev/null +++ b/vboxmanage-startvm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-startvm + +> Start a virtual machine. +> More information: . + +- Start a virtual machine: + +`VBoxManage startvm {{vm_name|uuid}}` + +- Start a virtual machine with the specified UI mode: + +`VBoxManage startvm {{vm_name|uuid}} --type {{headless|gui|sdl|separate}}` + +- Specify a password file to start an encrypted virtual machine: + +`VBoxManage startvm {{vm_name|uuid}} --password {{path/to/password_file}}` + +- Specify a password ID to start an encrypted virtual machine: + +`VBoxManage startvm {{vm_name|uuid}} --password-id {{password_id}}` + +- Start a virtual machine with an environment variable pair name value: + +`VBoxManage startvm {{vm_name|uuid}} --put-env={{name}}={{value}}` diff --git a/vboxmanage-unregistervm b/vboxmanage-unregistervm new file mode 100644 index 00000000..b3b30cf6 --- /dev/null +++ b/vboxmanage-unregistervm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vboxmanage-unregistervm + +> Unregister a virtual machine (VM). +> More information: . + +- Unregister an existing VM: + +`VBoxManage unregistervm {{uuid|vm_name}}` + +- Delete hard disk image files, all saved state files, VM logs, and XML VM machine files: + +`VBoxManage unregistervm {{uuid|vm_name}} --delete` + +- Delete all files from the VM: + +`VBoxManage unregistervm {{uuid|vm_name}} --delete-all` diff --git a/vcpkg b/vcpkg new file mode 100644 index 00000000..fa073387 --- /dev/null +++ b/vcpkg @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vcpkg + +> Package manager for C/C++ libraries. +> Note: packages are not installed in the system. To use them, you need to tell your build system (e.g. CMake) to use `vckg`. +> More information: . + +- Build and add package `libcurl` to the `vcpkg` environment: + +`vcpkg install curl` + +- Build and add `zlib` using the `emscripten` toolchain: + +`vcpkg install --triplet=wasm32-emscripten zlib` + +- Search for a package: + +`vcpkg search {{pkg_name}}` + +- Configure a CMake project to use `vcpkg` packages: + +`cmake -B build -DCMAKE_TOOLCHAIN_FILE={{path/to/vcpkg_install_directory}}/scripts/buildsystems/vcpkg.cmake` diff --git a/vcsh b/vcsh new file mode 100644 index 00000000..23f36da4 --- /dev/null +++ b/vcsh @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vcsh + +> Version Control System for the home directory using Git repositories. +> More information: . + +- Initialize an (empty) repository: + +`vcsh init {{repository_name}}` + +- Clone a repository into a custom directory name: + +`vcsh clone {{git_url}} {{repository_name}}` + +- List all managed repositories: + +`vcsh list` + +- Execute a Git command on a managed repository: + +`vcsh {{repository_name}} {{git_command}}` + +- Push/pull all managed repositories to/from remotes: + +`vcsh {{push|pull}}` + +- Write a custom `.gitignore` file for a managed repository: + +`vcsh write-gitignore {{repository_name}}` diff --git a/vdir b/vdir new file mode 100644 index 00000000..4fcb552c --- /dev/null +++ b/vdir @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vdir + +> List directory contents. +> Drop-in replacement for `ls -l`. +> More information: . + +- List files and directories in the current directory, one per line, with details: + +`vdir` + +- List with sizes displayed in human-readable units (KB, MB, GB): + +`vdir -h` + +- List including hidden files (starting with a dot): + +`vdir -a` + +- List files and directories sorting entries by size (largest first): + +`vdir -S` + +- List files and directories sorting entries by modification time (newest first): + +`vdir -t` + +- List grouping directories first: + +`vdir --group-directories-first` + +- Recursively list all files and directories in a specific directory: + +`vdir --recursive {{path/to/directory}}` diff --git a/vectorize-pixelart b/vectorize-pixelart new file mode 100644 index 00000000..3b352cac --- /dev/null +++ b/vectorize-pixelart @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vectorize-pixelart + +> Convert PNG pixel art graphics to SVG/EPS vector images. +> More information: . + +- Convert a PNG to a vector image format: + +`vectorize-pixelart {{path/to/input.png}} {{path/to/output.svg|.eps}}` diff --git a/vegeta b/vegeta new file mode 100644 index 00000000..44bef0ff --- /dev/null +++ b/vegeta @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vegeta + +> A command-line utility and a library for HTTP load testing. +> See also `ab`. +> More information: . + +- Launch an attack lasting 30 seconds: + +`echo "{{GET https://example.com}}" | vegeta attack -duration={{30s}}` + +- Launch an attack on a server with a self-signed HTTPS certificate: + +`echo "{{GET https://example.com}}" | vegeta attack -insecure -duration={{30s}}` + +- Launch an attack with a rate of 10 requests per second: + +`echo "{{GET https://example.com}}" | vegeta attack -duration={{30s}} -rate={{10}}` + +- Launch an attack and display a report: + +`echo "{{GET https://example.com}}" | vegeta attack -duration={{30s}} | vegeta report` + +- Launch an attack and plot the results on a graph (latency over time): + +`echo "{{GET https://example.com}}" | vegeta attack -duration={{30s}} | vegeta plot > {{path/to/results.html}}` + +- Launch an attack against multiple URLs from a file: + +`vegeta attack -duration={{30s}} -targets={{requests.txt}} | vegeta report` diff --git a/vela b/vela new file mode 100644 index 00000000..c008ecb8 --- /dev/null +++ b/vela @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vela + +> Command-line tools for the Vela pipeline. +> More information: . + +- Trigger a pipeline to run from a Git branch, commit or tag: + +`vela add deployment --org {{organization}} --repo {{repository_name}} --target {{environment}} --ref {{branch|commit|refs/tags/git_tag}} --description "{{deploy_description}}"` + +- List deployments for a repository: + +`vela get deployment --org {{organization}} --repo {{repository_name}}` + +- Inspect a specific deployment: + +`vela view deployment --org {{organization}} --repo {{repository_name}} --deployment {{deployment_number}}` diff --git a/velero b/velero new file mode 100644 index 00000000..8274b7e7 --- /dev/null +++ b/velero @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# velero + +> Backup and migrate Kubernetes applications and their persistent volumes. +> More information: . + +- Create a backup containing all resources: + +`velero backup create {{backup_name}}` + +- List all backups: + +`velero backup get` + +- Delete a backup: + +`velero backup delete {{backup_name}}` + +- Create a weekly backup, each living for 90 days (2160 hours): + +`velero schedule create {{schedule_name}} --schedules="{{@every 7d}}" --ttl {{2160h0m0s}}` + +- Create a restore from the latest successful backup triggered by specific schedule: + +`velero restore create --from-schedule {{schedule_name}}` diff --git a/venv b/venv new file mode 100644 index 00000000..f15b1932 --- /dev/null +++ b/venv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# venv + +> Create lightweight virtual environments in python. +> More information: . + +- Create a Python virtual environment: + +` python -m venv {{path/to/virtual_environment}}` + +- Activate the virtual environment (Linux and macOS): + +`source {{path/to/virtual_environment}}/bin/activate` + +- Activate the virtual environment (Windows): + +`{{path o irtual_environment}}\Scriptsctivate.bat` + +- Deactivate the virtual environment: + +`deactivate` diff --git a/vercel b/vercel new file mode 100644 index 00000000..a3e1de47 --- /dev/null +++ b/vercel @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vercel + +> Deploy and manage your Vercel deployments. +> More information: . + +- Deploy the current directory: + +`vercel` + +- Deploy the current directory to production: + +`vercel --prod` + +- Deploy a directory: + +`vercel {{path/to/project}}` + +- Initialize an example project: + +`vercel init` + +- Deploy with Environment Variables: + +`vercel --env {{ENV}}={{var}}` + +- Build with Environment Variables: + +`vercel --build-env {{ENV}}={{var}}` + +- Set default regions to enable the deployment on: + +`vercel --regions {{region_id}}` + +- Remove a deployment: + +`vercel remove {{project_name}}` diff --git a/verilator b/verilator new file mode 100644 index 00000000..db50dc5b --- /dev/null +++ b/verilator @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# verilator + +> Converts Verilog and SystemVerilog hardware description language (HDL) design into a C++ or SystemC model to be executed after compiling. +> More information: . + +- Build a specific C project in the current directory: + +`verilator --binary --build-jobs 0 -Wall {{path/to/source.v}}` + +- Create a C++ executable in a specific folder: + +`verilator --cc --exe --build --build-jobs 0 -Wall {{path/to/source.cpp}} {{path/to/output.v}}` + +- Perform linting over a code in the current directory: + +`verilator --lint-only -Wall` + +- Create XML output about the design (files, modules, instance hierarchy, logic and data types) to feed into other tools: + +`verilator --xml-output -Wall {{path/to/output.xml}}` diff --git a/vf b/vf new file mode 100644 index 00000000..4db1d52e --- /dev/null +++ b/vf @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vf + +> VirtualFish is a fish shell tool for managing Python virtual environments. +> More information: . + +- Create a virtual environment: + +`vf new {{virtualenv_name}}` + +- Create a virtual environment for a specific Python version: + +`vf new --python {{/usr/local/bin/python3.8}} {{virtualenv_name}}` + +- Activate and use the specified virtual environment: + +`vf activate {{virtualenv_name}}` + +- Connect the current virtualenv to the current directory, so that it is activated automatically as soon as you enter it (and deactivated as soon as you leave): + +`vf connect` + +- Deactivate the current virtual environment: + +`vf deactivate` + +- List all virtual environments: + +`vf ls` + +- Remove a virtual environment: + +`vf rm {{virtualenv_name}}` + +- Display help: + +`vf help` diff --git a/vgmstream_cli b/vgmstream_cli new file mode 100644 index 00000000..c30c0f6b --- /dev/null +++ b/vgmstream_cli @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vgmstream_cli + +> Play a wide variety of audio formats used in video games and convert them into `wav`. +> More information: . + +- Decode an `adc` file to `wav`. (Default output name is `input.wav`): + +`vgmstream_cli {{path/to/input.adc}} -o {{path/to/output.wav}}` + +- Print metadata without decoding the audio: + +`vgmstream_cli {{path/to/input.adc}} -m` + +- Decode an audio file without loops: + +`vgmstream_cli {{path/to/input.adc}} -o {{path/to/output.wav}} -i` + +- Decode with three loops, then add a 3s delay followed by a 5s fadeout: + +`vgmstream_cli {{path/to/input.adc}} -o {{path/to/output.wav}} -l {{3.0}} -f {{5.0}} -d {{3.0}}` + +- Convert multiple files to `bgm_(original name).wav` (Default `-o` pattern is `?f.wav`): + +`vgmstream_cli -o {{path/to/bgm_?f.wav}} {{path/to/file1.adc}} {{path/to/file2.adc}}` + +- Play the file looping endlessly (`channels` and `rate` must match metadata): + +`vgmstream_cli {{path/to/input.adc}} -pec | aplay --format cd --channels {{1}} --rate {{44100}}` diff --git a/vgrep b/vgrep new file mode 100644 index 00000000..19f198b7 --- /dev/null +++ b/vgrep @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vgrep + +> A user friendly pager for grep. +> See also: `ugrep`, `rg`. +> More information: . + +- Recursively search the current directory for a pattern and cache it: + +`vgrep {{search_pattern}}` + +- Display the contents of the cache: + +`vgrep` + +- Open the "4th" match from the cache in the default editor: + +`vgrep --show {{4}}` + +- Display a context of "3" lines for each match in the cache: + +`vgrep --show=context{{3}}` + +- Display the number of matches for each directory in the tree: + +`vgrep --show=tree` + +- Display the number of matches for each file in the tree: + +`vgrep --show=files` + +- Start an interactive shell with cached matches: + +`vgrep --interactive` diff --git a/vhs b/vhs new file mode 100644 index 00000000..cea83252 --- /dev/null +++ b/vhs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vhs + +> Generate terminal gifs from a tape file. +> More information: . + +- Create a tape file (add commands to the tape file using an editor): + +`vhs new {{path/to/file.tape}}` + +- Record inputs to a tape file (once done, exit the shell to create the tape): + +`vhs record > {{path/to/file.tape}}` + +- Record inputs to a tape file using a specific shell: + +`vhs record --shell {{shell}} > {{path/to/file.tape}}` + +- Validate the syntax of a tape file: + +`vhs validate {{path/to/file.tape}}` + +- Create a gif from a tape file: + +`vhs < {{path/to/file.tape}}` + +- Publish a gif to and get a shareable URL: + +`vhs publish {{path/to/file.gif}}` diff --git a/vi b/vi new file mode 100644 index 00000000..4cdcfe6b --- /dev/null +++ b/vi @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vi + +> This command is an alias of `vim`. + +- View documentation for the original command: + +`tldr vim` diff --git a/vidir b/vidir new file mode 100644 index 00000000..aab878fa --- /dev/null +++ b/vidir @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vidir + +> Edit directories in a text editor. +> More information: . + +- Edit the contents of the specified directories: + +`vidir {{path/to/directory1 path/to/directory2 ...}}` + +- Display each action taken by the program: + +`vidir --verbose {{path/to/directory1 path/to/directory2 ...}}` + +- Edit the contents of current directory: + +`vidir` + +- Use the specified text editor: + +`EDITOR={{vim}} vidir {{path/to/directory1 path/to/directory2 ...}}` + +- Read a list of files to edit from `stdin`: + +`{{command}} | vidir -` diff --git a/view b/view new file mode 100644 index 00000000..8fa35bfe --- /dev/null +++ b/view @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# view + +> A read-only version of `vim`. +> This is equivalent to `vim -R`. +> More information: . + +- Open a file: + +`view {{path/to/file}}` diff --git a/vifm b/vifm new file mode 100644 index 00000000..92677899 --- /dev/null +++ b/vifm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vifm + +> VI File Manager is a command-line file manager. +> More information: . + +- Open the current directory: + +`vifm .` + +- Open specified directories on left or right plane: + +`vifm {{path/to/directory1 path/to/directory2 ...}}` diff --git a/vim b/vim new file mode 100644 index 00000000..835ad0ce --- /dev/null +++ b/vim @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vim + +> Vim (Vi IMproved), a command-line text editor, provides several modes for different kinds of text manipulation. +> Pressing `i` in normal mode enters insert mode. Pressing `` goes back to normal mode, which enables the use of Vim commands. +> See also: `vimdiff`, `vimtutor`, `nvim`. +> More information: . + +- Open a file: + +`vim {{path/to/file}}` + +- Open a file at a specified line number: + +`vim +{{line_number}} {{path/to/file}}` + +- View Vim's help manual: + +`:help` + +- Save and quit the current buffer: + +`:wq` + +- Enter normal mode and undo the last operation: + +`u` + +- Search for a pattern in the file (press `n`/`N` to go to next/previous match): + +`/{{search_pattern}}` + +- Perform a regular expression substitution in the whole file: + +`:%s/{{regular_expression}}/{{replacement}}/g` + +- Display the line numbers: + +`:set nu` diff --git a/vimdiff b/vimdiff new file mode 100644 index 00000000..2e0e6118 --- /dev/null +++ b/vimdiff @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vimdiff + +> Open up two or more files in vim and show the differences between them. +> See also: `vim`, `vimtutor`, `nvim`. +> More information: . + +- Open two files and show the differences: + +`vimdiff {{path/to/file1}} {{path/to/file2}}` + +- Move the cursor to the window on the left|right: + +` + w {{h|l}}` + +- Jump to the previous difference: + +`[c` + +- Jump to the next difference: + +`]c` + +- Copy the highlighted difference from the other window to the current window: + +`do` + +- Copy the highlighted difference from the current window to the other window: + +`dp` + +- Update all highlights and folds: + +`:diffupdate` + +- Toggle the highlighted code fold: + +`za` diff --git a/vimtutor b/vimtutor new file mode 100644 index 00000000..fd801205 --- /dev/null +++ b/vimtutor @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vimtutor + +> Vim tutor, teaching the basic vim commands. +> See also: `vim`, `vimdiff`, `nvim`. +> More information: . + +- Launch the vim tutor using the given language (en, fr, de, ...): + +`vimtutor {{language}}` + +- Exit the tutor: + +` :q ` diff --git a/vipe b/vipe new file mode 100644 index 00000000..478d8a87 --- /dev/null +++ b/vipe @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vipe + +> Run a text editor in the middle of a UNIX pipeline. +> More information: . + +- Edit the output of `command1` before piping it into `command2`: + +`{{command1}} | vipe | {{command2}}` + +- Buffer the output of `command1` in a temporary file with the specified file extension in order to aid syntax highlighting: + +`{{command1}} | vipe --suffix {{json}} | {{command2}}` + +- Use the specified text editor: + +`{{command1}} | EDITOR={{vim}} vipe | {{command2}}` diff --git a/virsh b/virsh new file mode 100644 index 00000000..9fa4a981 --- /dev/null +++ b/virsh @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh + +> Manage virsh guest domains. (Note: 'guest_id' can be the id, name or UUID of the guest). +> Some subcommands such as `virsh list` have their own usage documentation. +> More information: . + +- Connect to a hypervisor session: + +`virsh connect {{qemu:///system}}` + +- List all domains: + +`virsh list --all` + +- Dump guest configuration file: + +`virsh dumpxml {{guest_id}} > {{path/to/guest.xml}}` + +- Create a guest from a configuration file: + +`virsh create {{path/to/config_file.xml}}` + +- Edit a guest's configuration file (editor can be changed with $EDITOR): + +`virsh edit {{guest_id}}` + +- Start/reboot/shutdown/suspend/resume a guest: + +`virsh {{command}} {{guest_id}}` + +- Save the current state of a guest to a file: + +`virsh save {{guest_id}} {{filename}}` + +- Delete a running guest: + +`virsh destroy {{guest_id}} && virsh undefine {{guest_id}}` diff --git a/virsh-connect b/virsh-connect new file mode 100644 index 00000000..22887643 --- /dev/null +++ b/virsh-connect @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh-connect + +> Connect to a virtual machine hypervisor. +> See also: `virsh`. +> More information: . + +- Connect to the default hypervisor: + +`virsh connect` + +- Connect as root to the local QEMU/KVM hypervisor: + +`virsh connect qemu:///system` + +- Launch a new instance of the hypervisor and connect to it as the local user: + +`virsh connect qemu:///session` + +- Connect as root to a remote hypervisor using ssh: + +`virsh connect qemu+ssh://{{user_name@host_name}}/system` diff --git a/virsh-domblklist b/virsh-domblklist new file mode 100644 index 00000000..b5dc2d42 --- /dev/null +++ b/virsh-domblklist @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh-domblklist + +> List information about block devices associated with a virtual machine. +> See also: `virsh`. +> More information: . + +- List the target name and source path of the block devices: + +`virsh domblklist --domain {{vm_name}}` + +- List the disk type and device value as well as the target name and source path: + +`virsh domblklist --domain {{vm_name}} --details` diff --git a/virsh-help b/virsh-help new file mode 100644 index 00000000..6739cde4 --- /dev/null +++ b/virsh-help @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh-help + +> Display information about `virsh` commands or command groups. +> See also: `virsh`. +> More information: . + +- List the `virsh` commands grouped into related categories: + +`virsh help` + +- List the command categories: + +`virsh help | grep "keyword"` + +- List the commands in a category: + +`virsh help {{category_keyword}}` + +- Display help for a command: + +`virsh help {{command}}` diff --git a/virsh-list b/virsh-list new file mode 100644 index 00000000..f0bc393e --- /dev/null +++ b/virsh-list @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh-list + +> List the ID, name, and state of virtual machines. +> See also: `virsh`. +> More information: . + +- List information about running virtual machines: + +`virsh list` + +- List information about virtual machines regardless of state: + +`virsh list --all` + +- List information about virtual machines with autostart either enabled or disabled: + +`virsh list --all --{{autostart|no-autostart}}` + +- List information about virtual machines either with or without snapshots: + +`virsh list --all --{{with-snapshot|without-snapshot}}` diff --git a/virsh-pool-autostart b/virsh-pool-autostart new file mode 100644 index 00000000..b856d63b --- /dev/null +++ b/virsh-pool-autostart @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-autostart + +> Enable or disable autostart for a virtual machine storage pool. +> See also: `virsh`. +> More information: . + +- Enable autostart for the storage pool specified by name or UUID (determine using `virsh pool-list`): + +`virsh pool-autostart --pool {{name|uuid}}` + +- Disable autostart for the storage pool specified by name or UUID: + +`virsh pool-autostart --pool {{name|uuid}} --disable` diff --git a/virsh-pool-build b/virsh-pool-build new file mode 100644 index 00000000..6ec7079c --- /dev/null +++ b/virsh-pool-build @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-build + +> Build the underlying storage system for a virtual machine storage pool as defined in it's configuration file in `/etc/libvirt/storage`. +> See also: `virsh`, `virsh-pool-define-as`, `virsh-pool-start`. +> More information: . + +- Build the storage pool specified by name or UUID (determine using `virsh pool-list`): + +`virsh pool-build --pool {{name|uuid}}` diff --git a/virsh-pool-define-as b/virsh-pool-define-as new file mode 100644 index 00000000..5c784d6f --- /dev/null +++ b/virsh-pool-define-as @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-define-as + +> Create a configuration file in `/etc/libvirt/storage` for a persistent virtual machine storage pool from the provided arguments. +> See also: `virsh`, `virsh-pool-build`, `virsh-pool-start`. +> More information: . + +- Create the configuration file for a storage pool called pool_name using `/var/vms` as the underlying storage system: + +`virsh pool-define-as --name {{pool_name}} --type {{dir}} --target {{/var/vms}}` diff --git a/virsh-pool-delete b/virsh-pool-delete new file mode 100644 index 00000000..6ae0cee4 --- /dev/null +++ b/virsh-pool-delete @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-delete + +> Delete the underlying storage system of an inactive virtual machine storage pool. +> See also: `virsh`, `virsh-pool-destroy`, `virsh-pool-undefine`. +> More information: . + +- Delete the underlying storage system for the storage pool specified by name or UUID (determine using `virsh pool-list`): + +`virsh pool-delete --pool {{name|uuid}}` diff --git a/virsh-pool-destroy b/virsh-pool-destroy new file mode 100644 index 00000000..63a6d073 --- /dev/null +++ b/virsh-pool-destroy @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-destroy + +> Stop an active virtual machine storage pool. +> See also: `virsh`, `virsh-pool-delete`. +> More information: . + +- Stop a storage pool specified by name or UUID (determine using `virsh pool-list`): + +`virsh pool-destroy --pool {{name|uuid}}` diff --git a/virsh-pool-info b/virsh-pool-info new file mode 100644 index 00000000..1eaa547d --- /dev/null +++ b/virsh-pool-info @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-info + +> List information about a virtual machine storage pool. +> See also: `virsh`. +> More information: . + +- List the name, UUID, state, persistence type, autostart status, capacity, space allocated, and space available for the storage pool specified by name or UUID (determine using `virsh pool-list`): + +`virsh pool-info --pool {{name|uuid}}` diff --git a/virsh-pool-list b/virsh-pool-list new file mode 100644 index 00000000..84fb6b0b --- /dev/null +++ b/virsh-pool-list @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-list + +> List information about virtual machine storage pools. +> See also: `virsh`, `virsh-pool-autostart`, `virsh-pool-define-as`. +> More information: . + +- List the name, state, and whether autostart is enabled or disabled for active storage pools: + +`virsh pool-list` + +- List information for active and inactive or just inactive storage pools: + +`virsh pool-list --{{all|inactive}}` + +- List extended information about persistence, capacity, allocation, and available space for active storage pools: + +`virsh pool-list --details` + +- List information for active storage pools with either autostart enabled or disabled: + +`virsh pool-list --{{autostart|no-autostart}}` + +- List information for active storage pools that are either persistent or transient: + +`virsh pool-list --{{persistent|transient}}` + +- List the name and UUID of active storage pools: + +`virsh pool-list --name --uuid` diff --git a/virsh-pool-start b/virsh-pool-start new file mode 100644 index 00000000..df93e586 --- /dev/null +++ b/virsh-pool-start @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-start + +> Start a previously configured but inactive virtual machine storage pool. +> See also: `virsh`, `virsh-pool-define-as`, `virsh-pool-destroy`. +> More information: . + +- Start the storage pool specified by name or UUID (determine using `virsh pool-list`) and create the underlying storage system if it doesn't exist: + +`virsh pool-start --pool {{name|uuid}} --build` diff --git a/virsh-pool-undefine b/virsh-pool-undefine new file mode 100644 index 00000000..1f1534d8 --- /dev/null +++ b/virsh-pool-undefine @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh pool-undefine + +> Delete the configuration file in `/etc/libvirt/storage` for a stopped virtual machine storage pool. +> See also: `virsh`, `virsh-pool-destroy`. +> More information: . + +- Delete the configuration for the storage pool specified name or UUID (determine using `virsh pool-list`): + +`virsh pool-undefine --pool {{name|uuid}}` diff --git a/virsh-undefine b/virsh-undefine new file mode 100644 index 00000000..66b2d4a2 --- /dev/null +++ b/virsh-undefine @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virsh-undefine + +> Delete a virtual machine. +> More information: . + +- Delete only the virtual machine configuration file: + +`virsh undefine --domain {{vm_name}}` + +- Delete the configuration file and all associated storage volumes: + +`virsh undefine --domain {{vm_name}} --remove-all-storage` + +- 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}}` diff --git a/virt-clone b/virt-clone new file mode 100644 index 00000000..2596368c --- /dev/null +++ b/virt-clone @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-clone + +> Clone a libvirt virtual machine. +> More information: . + +- Clone a virtual machine and automatically generate a new name, storage path, and MAC address: + +`virt-clone --original {{vm_name}} --auto-clone` + +- Clone a virtual machine and specify the new name, storage path, and MAC address: + +`virt-clone --original {{vm_name}} --name {{new_vm_name}} --file {{path/to/new_storage}} --mac {{ff:ff:ff:ff:ff:ff|RANDOM}}` diff --git a/virt-install b/virt-install new file mode 100644 index 00000000..fddb4416 --- /dev/null +++ b/virt-install @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-install + +> Create virtual machines with libvirt and begin OS installation. +> More information: . + +- Create a virtual machine with 1 GB RAM and 12 GB storage and start a Debian installation: + +`virt-install --name {{vm_name}} --memory {{1024}} --disk path={{path/to/image.qcow2}},size={{12}} --cdrom {{path/to/debian.iso}}` + +- Create a x86-64, KVM-accelerated, UEFI-based virtual machine with the Q35 chipset, 4 GiB RAM, 16 GiB RAW storage, and start a Fedora installation: + +`virt-install --name {{vm_name}} --arch {{x86_64}} --virt-type {{kvm}} --machine {{q35}} --boot {{uefi}} --memory {{4096}} --disk path={{path/to/image.raw}},size={{16}} --cdrom {{path/to/fedora.iso}}` + +- Create a diskless live virtual machine without an emulated sound device or a USB controller. Don't start an installation and don't autoconnect to console but attach a cdrom to it (might be useful for when using a live CD like tails): + +`virt-install --name {{vm_name}} --memory {{512}} --disk {{none}} --controller {{type=usb,model=none}} --sound {{none}} --autoconsole {{none}} --install {{no_install=yes}} --cdrom {{path/to/tails.iso}}` + +- Create a virtual machine with 16 GiB RAM, 250 GiB storage, 8 cores with hyperthreading, a specific CPU topology, and a CPU model that shares most features with the host CPU: + +`virt-install --name {{vm_name}} --cpu {{host-model}},topology.sockets={{1}},topology.cores={{4}},topology.threads={{2}} --memory {{16384}} --disk path={{path/to/image.qcow2}},size={{250}} --cdrom {{path/to/debian.iso}}` + +- Create a virtual machine and kickstart an automated deployment based on Fedora 35 using only remote resources (no ISO required): + +`virt-install --name {{vm_name}} --memory {{2048}} --disk path={{path/to/image.qcow2}},size={{20}} --location={{https://download.fedoraproject.org/pub/fedora/linux/releases/35/Everything/x86_64/os/}} --extra-args={{"inst.ks=https://path/to/valid/kickstart.org"}}` diff --git a/virt-sparsify b/virt-sparsify new file mode 100644 index 00000000..bf96fd6a --- /dev/null +++ b/virt-sparsify @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-sparsify + +> Make virtual machine drive images thin-provisioned. +> Note: Use only for offline machines to avoid data corruption. +> More information: . + +- Create a sparsified compressed image without snapshots from an unsparsified one: + +`virt-sparsify --compress {{path/to/image.qcow2}} {{path/to/image_new.qcow2}}` + +- Sparsify an image in-place: + +`virt-sparsify --in-place {{path/to/image.img}}` diff --git a/virt-sysprep b/virt-sysprep new file mode 100644 index 00000000..60d4ee8a --- /dev/null +++ b/virt-sysprep @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virt-sysprep + +> Reset, unconfigure, or customize a virtual machine image. +> More information: . + +- List all supported operations (enabled operations are indicated with asterisks): + +`virt-sysprep --list-operations` + +- Run all enabled operations but don't actually apply the changes: + +`virt-sysprep --domain {{vm_name}} --dry-run` + +- Run only the specified operations: + +`virt-sysprep --domain {{vm_name}} --operations {{operation1,operation2,...}}` + +- Generate a new `/etc/machine-id` file and enable customizations to be able to change the host name to avoid network conflicts: + +`virt-sysprep --domain {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` diff --git a/virtualenv b/virtualenv new file mode 100644 index 00000000..33ef2ffc --- /dev/null +++ b/virtualenv @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virtualenv + +> Create virtual isolated Python environments. +> More information: . + +- Create a new environment: + +`virtualenv {{path/to/venv}}` + +- Customize the prompt prefix: + +`virtualenv --prompt={{prompt_prefix}} {{path/to/venv}}` + +- Use a different version of Python with virtualenv: + +`virtualenv --python={{path/to/pythonbin}} {{path/to/venv}}` + +- Start (select) the environment: + +`source {{path/to/venv}}/bin/activate` + +- Stop the environment: + +`deactivate` diff --git a/virtualenvwrapper b/virtualenvwrapper new file mode 100644 index 00000000..9cc466db --- /dev/null +++ b/virtualenvwrapper @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# virtualenvwrapper + +> Group of simple wrapper commands for Python's `virtualenv` tool. +> More information: . + +- Create a new Python `virtualenv` in `$WORKON_HOME`: + +`mkvirtualenv {{virtualenv_name}}` + +- Create a `virtualenv` for a specific Python version: + +`mkvirtualenv --python {{/usr/local/bin/python3.8}} {{virtualenv_name}}` + +- Activate or use a different `virtualenv`: + +`workon {{virtualenv_name}}` + +- Stop the `virtualenv`: + +`deactivate` + +- List all virtual environments: + +`lsvirtualenv` + +- Remove a `virtualenv`: + +`rmvirtualenv {{virtualenv_name}}` + +- Get summary of all virtualenvwrapper commands: + +`virtualenvwrapper` diff --git a/visudo b/visudo new file mode 100644 index 00000000..bebdaf9e --- /dev/null +++ b/visudo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# visudo + +> Safely edit the sudoers file. +> More information: . + +- Edit the sudoers file: + +`sudo visudo` + +- Check the sudoers file for errors: + +`sudo visudo -c` + +- Edit the sudoers file using a specific editor: + +`sudo EDITOR={{editor}} visudo` + +- Display version information: + +`visudo --version` diff --git a/vite b/vite new file mode 100644 index 00000000..b93eb3fb --- /dev/null +++ b/vite @@ -0,0 +1,27 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Vite + +> Create a Vite project. +> Used to build JavaScript projects. +> Available templates: vanilla, vanilla-ts, vue, vue-ts, react, react-ts, react-swc, react-swc-ts, preact, preact-ts, lit, lit-ts, svelte, svelte-ts. +> More information: . + +- Setup using `npm` 6.x: + +`npm create vite@latest my-react-app --template react-ts` + +- Setup using `npm` 7+, extra double-dash is needed: + +`npm create vite@latest my-react-app -- --template react-ts` + +- Setup using `yarn`: + +`yarn create vite my-react-app --template react-ts` + +- Setup using `pnpm`: + +`pnpm create vite my-react-app --template react-ts` diff --git a/viu b/viu new file mode 100644 index 00000000..c3d39d41 --- /dev/null +++ b/viu @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# viu + +> View images on the terminal. +> More information: . + +- Render an image or animated GIF: + +`viu {{path/to/file}}` + +- Render an image or GIF from the internet using `curl`: + +`curl -s {{https://example.com/image.png}} | viu -` + +- Render an image with a transparent background: + +`viu -t {{path/to/file}}` + +- Render an image with a specific width and height in pixels: + +`viu -w {{width}} -h {{height}} {{path/to/file}}` + +- Render an image or GIF and display its file name: + +`viu -n {{path/to/file}}` diff --git a/vladimyr b/vladimyr new file mode 100644 index 00000000..13cd4961 --- /dev/null +++ b/vladimyr @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vladimyr + +> Dario Vladović's personal CLI. +> More information: . + +- Start Dario's interactive CLI: + +`vladimyr` diff --git a/vlc b/vlc new file mode 100644 index 00000000..eeba6e33 --- /dev/null +++ b/vlc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vlc + +> Cross-platform multimedia player. +> More information: . + +- Play a file: + +`vlc {{path/to/file}}` + +- Play in fullscreen: + +`vlc --fullscreen {{path/to/file}}` + +- Play muted: + +`vlc --no-audio {{path/to/file}}` + +- Play repeatedly: + +`vlc --loop {{path/to/file}}` + +- Play video from a URL: + +`vlc {{https://www.youtube.com/watch?v=oHg5SJYRHA0}}` diff --git a/volta b/volta new file mode 100644 index 00000000..3134457b --- /dev/null +++ b/volta @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# volta + +> A JavaScript Tool Manager that installs Node.js runtimes, npm and Yarn package managers, or any binaries from npm. +> More information: . + +- List all installed tools: + +`volta list` + +- Install the latest version of a tool: + +`volta install {{node|npm|yarn|package_name}}` + +- Install a specific version of a tool: + +`volta install {{node|npm|yarn}}@version` + +- Choose a tool version for a project (will store it in `package.json`): + +`volta pin {{node|npm|yarn}}@version` + +- Display help: + +`volta help` + +- Display help for a subcommand: + +`volta help {{fetch|install|uninstall|pin|list|completions|which|setup|run|help}}` diff --git a/vsce b/vsce new file mode 100644 index 00000000..e3080f14 --- /dev/null +++ b/vsce @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vsce + +> Extension manager for Visual Studio Code. +> More information: . + +- List all the extensions created by a publisher: + +`vsce list {{publisher}}` + +- Publish an extension as major, minor or patch version: + +`vsce publish {{major|minor|patch}}` + +- Unpublish an extension: + +`vsce unpublish {{extension_id}}` + +- Package the current working directory as a `.vsix` file: + +`vsce package` + +- Show the metadata associated with an extension: + +`vsce show {{extension_id}}` diff --git a/vt b/vt new file mode 100644 index 00000000..ea1f6180 --- /dev/null +++ b/vt @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vt + +> Command-line interface for VirusTotal. +> API key from a VirusTotal account is required for this command. +> More information: . + +- Scan a specific file for viruses: + +`vt scan file {{path/to/file}}` + +- Scan a URL for viruses: + +`vt scan url {{url}}` + +- Display information from a specific analysis: + +`vt analysis {{file_id|analysis_id}}` + +- Download files in encrypted `.zip` format (requires premium account): + +`vt download {{file_id}} --output {{path/to/directory}} --zip --zip-password {{password}}` + +- Initialize or re-initialize `vt` to enter API key interactively: + +`vt init` + +- Display information about a domain: + +`vt domain {{url}}` + +- Display information for a specific URL: + +`vt url {{url}}` + +- Display information for a specific IP address: + +`vt domain {{ip_address}}` diff --git a/vue b/vue new file mode 100644 index 00000000..0146844a --- /dev/null +++ b/vue @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vue + +> Multi-purpose CLI for Vue.js. +> Some subcommands such as `vue build` have their own usage documentation. +> More information: . + +- Create a new Vue project interactively: + +`vue create {{project_name}}` + +- Create a new project with web UI: + +`vue ui` diff --git a/vue-build b/vue-build new file mode 100644 index 00000000..626ad622 --- /dev/null +++ b/vue-build @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vue build + +> A subcommand provided by `@vue/cli` and `@vue/cli-service-global` that enables quick prototyping. +> More information: . + +- Build a `.js` or `.vue` file in production mode with zero config: + +`vue build {{filename}}` diff --git a/vue-init b/vue-init new file mode 100644 index 00000000..fb24c215 --- /dev/null +++ b/vue-init @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vue init + +> Legacy project initialization subcommand of the Vue.js framework. +> More information: . + +- Create a new project using one of the default templates: + +`vue init {{webpack|webpack-simple|browserify|browserify-simple|simple}} {{project_name}}` + +- Create a new project using a local template: + +`vue init {{path/to/template_directory}} {{project_name}}` + +- Create a new project using a template from GitHub: + +`vue init {{username}}/{{repo}} {{project_name}}` diff --git a/vue-serve b/vue-serve new file mode 100644 index 00000000..61635c57 --- /dev/null +++ b/vue-serve @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vue serve + +> A subcommand provided by `@vue/cli` and `@vue/cli-service-global` that enables quick prototyping. +> More information: . + +- Serve a `.js` or `.vue` file in development mode with zero config: + +`vue serve {{filename}}` diff --git a/vzdump b/vzdump new file mode 100644 index 00000000..b5239668 --- /dev/null +++ b/vzdump @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vzdump + +> Backup Utility for virtual machines and containers. +> More information: . + +- Dump a guest virtual machine into the default dump directory (usually `/var/lib/vz/dump/`), excluding snapshots: + +`vzdump {{vm_id}}` + +- Back up the guest virtual machines with the IDs 101, 102, and 103: + +`vzdump {{101 102 103}}` + +- Dump a guest virtual machine using a specific mode: + +`vzdump {{vm_id}} --mode {{suspend|snapshot}}` + +- Back up all guest systems and send an notification email to the root and admin users: + +`vzdump --all --mode {{suspend}} --mailto {{root}} --mailto {{admin}}` + +- Use snapshot mode (no downtime required) and a non-default dump directory: + +`vzdump {{vm_id}} --dumpdir {{path/to/directory}} --mode {{snapshot}}` + +- Back up all guest virtual machines excluding the IDs 101 and 102: + +`vzdump --mode {{suspend}} --exclude {{101, 102}}` diff --git a/w b/w new file mode 100644 index 00000000..86c29a74 --- /dev/null +++ b/w @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# w + +> Show who is logged on and what they are doing. +> Print user login, TTY, remote host, login time, idle time, current process. +> More information: . + +- Show logged-in users info: + +`w` + +- Show logged-in users info without a header: + +`w -h` diff --git a/w3m b/w3m new file mode 100644 index 00000000..061cbaf9 --- /dev/null +++ b/w3m @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# w3m + +> A text-based web browser. +> Supports SSL and mouse input, even over SSH. +> More information: . + +- Open a URL: + +`w3m {{https://example.com}}` + +- Open a URL in monochrome mode: + +`w3m {{https://example.com}} -M` + +- Open a URL without mouse support: + +`w3m {{https://example.com}} -no-mouse` + +- Open a new browser tab: + +` + T` + +- Display your browser history: + +` + H` + +- Quit w3m: + +`q + y` diff --git a/waifu2x-ncnn-vulkan b/waifu2x-ncnn-vulkan new file mode 100644 index 00000000..6632d613 --- /dev/null +++ b/waifu2x-ncnn-vulkan @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# waifu2x-ncnn-vulkan + +> Image upscaler for manga/anime-style images using NCNN neural network framework. +> More information: . + +- Upscale an image: + +`waifu2x-ncnn-vulkan -i {{path/to/input_file}} -o {{path/to/output_file}}` + +- Upscale an image by a custom scale factor and denoise it: + +`waifu2x-ncnn-vulkan -i {{path/to/input_file}} -o {{path/to/output_file}} -s {{1|2|4|8|16|32}} -n {{-1|0|1|2|3}}` + +- Save the upscaled image in a specific format: + +`waifu2x-ncnn-vulkan -i {{path/to/input_file}} -o {{path/to/output_file}} -f {{jpg|png|webp}}` diff --git a/wait b/wait new file mode 100644 index 00000000..f377d6c2 --- /dev/null +++ b/wait @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wait + +> Wait for a process to complete before proceeding. +> More information: . + +- Wait for a process to finish given its process ID (PID) and return its exit status: + +`wait {{pid}}` + +- Wait for all processes known to the invoking shell to finish: + +`wait` diff --git a/waitress-serve b/waitress-serve new file mode 100644 index 00000000..daccce74 --- /dev/null +++ b/waitress-serve @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# waitress-serve + +> Pure Python WSGI HTTP Server. +> More information: . + +- Run a Python web app: + +`waitress-serve {{import.path:wsgi_func}}` + +- Listen on port 8080 on localhost: + +`waitress-serve --listen={{localhost}}:{{8080}} {{import.path:wsgi_func}}` + +- Start waitress on a Unix socket: + +`waitress-serve --unix-socket={{path/to/socket}} {{import.path:wsgi_func}}` + +- Use 4 threads to process requests: + +`waitress-serve --threads={{4}} {{import.path:wsgifunc}}` + +- Call a factory method that returns a WSGI object: + +`waitress-serve --call {{import.path.wsgi_factory}}` + +- Use the HTTPS URL scheme: + +`waitress-serve --url-scheme={{https}} {{import.path:wsgi_func}}` diff --git a/wal b/wal new file mode 100644 index 00000000..6f521f11 --- /dev/null +++ b/wal @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wal + +> Create color schemes based on the dominant colors of a wallpaper. +> More information: . + +- Preview color scheme: + +`wal --preview {{image.png}}` + +- Create color scheme: + +`wal -i {{image.png}}` + +- Create a light color scheme: + +`wal -i {{image.png}} -l` + +- Skip setting the desktop wallpaper: + +`wal -i {{image.png}} -n` + +- Skip setting the terminal colors: + +`wal -i {{image.png}} -s` + +- Restore the previously generated color scheme and wallpaper: + +`wal -R` diff --git a/wapm b/wapm new file mode 100644 index 00000000..5fe05b5e --- /dev/null +++ b/wapm @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wapm + +> The WebAssembly package manager. +> More information: . + +- Interactively create a new `wapm.toml` file: + +`wapm init` + +- Download all the packages listed as dependencies in `wapm.toml`: + +`wapm install` + +- Download a specific version of a package and add it to the list of dependencies in `wapm.toml`: + +`wapm install {{package}}@{{version}}` + +- Download a package and install it globally: + +`wapm install --global {{package}}` + +- Uninstall a package and remove it from the list of dependencies in `wapm.toml`: + +`wapm uninstall {{package}}` + +- Print a tree of locally installed dependencies: + +`wapm list` + +- List top-level globally installed packages: + +`wapm list --global` + +- Execute a package command using the Wasmer runtime: + +`wapm run {{command_name}} {{arguments}}` diff --git a/warp-cli b/warp-cli new file mode 100644 index 00000000..dd88f63a --- /dev/null +++ b/warp-cli @@ -0,0 +1,39 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# warp-cli + +> Connect, disconnect and switch modes of a connection to Cloudflare's WARP service. +> WARP is a VPN that encrypts traffic for privacy, security, and speed. +> See also: `fastd`, `ivpn`, `mozzilavpn`, `mullvad`. +> More information: . + +- Register the current device to WARP (must be run before first connection): + +`warp-cli register` + +- Connect to WARP: + +`warp-cli connect` + +- Disconnect from WARP: + +`warp-cli disconnect` + +- Display the WARP connection status: + +`warp-cli status` + +- Switch to a specific mode: + +`warp-cli set-mode {{mode}}` + +- Display help: + +`warp-cli help` + +- Display help for a subcommand: + +`warp-cli help {{subcommand}}` diff --git a/warp-diag b/warp-diag new file mode 100644 index 00000000..a5992227 --- /dev/null +++ b/warp-diag @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# warp-diag + +> Diagnostic and feedback tool for Cloudflare's WARP service. +> See also: `warp-cli`. +> More information: . + +- Generate a `zip` file with information about the system configuration and the WARP connection: + +`warp-diag` + +- Generate a `zip` file with debug information including a timestamp to the output filename: + +`warp-diag --add-ts` + +- Save the output file under a specific directory: + +`warp-diag --output {{path/to/directory}}` + +- Submit a new feedback to Cloudflare's WARP interactively: + +`warp-diag feedback` diff --git a/wasm-objdump b/wasm-objdump new file mode 100644 index 00000000..95e43904 --- /dev/null +++ b/wasm-objdump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wasm-objdump + +> Display information from WebAssembly binaries. +> More information: . + +- Display the section headers of a given binary: + +`wasm-objdump -h {{file.wasm}}` + +- Display the entire disassembled output of a given binary: + +`wasm-objdump -d {{file.wasm}}` + +- Display the details of each section: + +`wasm-objdump --details {{file.wasm}}` + +- Display the details of a given section: + +`wasm-objdump --section '{{import}}' --details {{file.wasm}}` diff --git a/wasm-opt b/wasm-opt new file mode 100644 index 00000000..6a47d069 --- /dev/null +++ b/wasm-opt @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wasm-opt + +> Optimize WebAssembly binary files. +> More information: . + +- Apply default optimizations and write to a given file: + +`wasm-opt -O {{input.wasm}} -o {{output.wasm}}` + +- Apply all optimizations and write to a given file (takes more time, but generates optimal code): + +`wasm-opt -O4 {{input.wasm}} -o {{output.wasm}}` + +- Optimize a file for size: + +`wasm-opt -Oz {{input.wasm}} -o {{output.wasm}}` + +- Print the textual representation of the binary to console: + +`wasm-opt {{input.wasm}} --print` diff --git a/wasm2c b/wasm2c new file mode 100644 index 00000000..10c0b290 --- /dev/null +++ b/wasm2c @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wasm2c + +> Convert a file from the WebAssembly binary format to a C source file and header. +> More information: . + +- Convert a file to a C source file and header and display it to the console: + +`wasm2c {{file.wasm}}` + +- Write the output to a given file (`file.h` gets additionally generated): + +`wasm2c {{file.wasm}} -o {{file.c}}` diff --git a/wasm2wat b/wasm2wat new file mode 100644 index 00000000..7b4854c1 --- /dev/null +++ b/wasm2wat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wasm2wat + +> Convert a file from the WebAssembly binary format to the text format. +> More information: . + +- Convert a file to the text format and display it to the console: + +`wasm2wat {{file.wasm}}` + +- Write the output to a given file: + +`wasm2wat {{file.wasm}} -o {{file.wat}}` diff --git a/wat2wasm b/wat2wasm new file mode 100644 index 00000000..1f8829f1 --- /dev/null +++ b/wat2wasm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wat2wasm + +> Convert a file from the WebAssembly text format to the binary format. +> More information: . + +- Parse and check a file for errors: + +`wat2wasm {{file.wat}}` + +- Write the output binary to a given file: + +`wat2wasm {{file.wat}} -o {{file.wasm}}` + +- Display simplified representation of every byte: + +`wat2wasm -v {{file.wat}}` diff --git a/watch b/watch new file mode 100644 index 00000000..6da8b309 --- /dev/null +++ b/watch @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# watch + +> Execute a program periodically, showing output fullscreen. +> More information: . + +- Repeatedly run a command and show the result: + +`watch {{command}}` + +- Re-run a command every 60 seconds: + +`watch -n {{60}} {{command}}` + +- Monitor the contents of a directory, highlighting differences as they appear: + +`watch -d {{ls -l}}` + +- Repeatedly run a pipeline and show the result: + +`watch '{{command_1}} | {{command_2}} | {{command_3}}'` diff --git a/watchexec b/watchexec new file mode 100644 index 00000000..d180dc43 --- /dev/null +++ b/watchexec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# watchexec + +> Run arbitrary commands when files change. +> More information: . + +- Call `ls -la` when any file in the current directory changes: + +`watchexec {{ls -la}}` + +- Run `make` when any JavaScript, CSS and HTML file in the current directory changes: + +`watchexec --exts {{js,css,html}} make` + +- Run `make` when any file in the `lib` or `src` directory changes: + +`watchexec --watch {{lib}} --watch {{src}} {{make}}` + +- Call/restart `my_server` when any file in the current directory changes, sending `SIGKILL` to stop the child process: + +`watchexec --restart --stop-signal {{SIGKILL}} {{my_server}}` diff --git a/watson b/watson new file mode 100644 index 00000000..5448a91a --- /dev/null +++ b/watson @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# watson + +> A wonderful CLI to track your time. +> More information: . + +- Start monitoring time in project: + +`watson start {{project}}` + +- Start monitoring time in project with tags: + +`watson start {{project}} +{{tag}}` + +- Stop monitoring time for the current project: + +`watson stop` + +- Display the latest working sessions: + +`watson log` + +- Edit most recent frame: + +`watson edit` + +- Remove most recent frame: + +`watson remove` diff --git a/wbmptopbm b/wbmptopbm new file mode 100644 index 00000000..dee33caa --- /dev/null +++ b/wbmptopbm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wbmptopbm + +> Convert a wireless bitmap file to a PBM image. +> More information: . + +- Convert a WBMP file to a PBM image: + +`wbmptopbm {{path/to/input_file.wbpm}} > {{path/to/output_file.pbm}}` diff --git a/wc b/wc new file mode 100644 index 00000000..1f92248e --- /dev/null +++ b/wc @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wc + +> Count lines, words, and bytes. +> More information: . + +- Count all lines in a file: + +`wc --lines {{path/to/file}}` + +- Count all words in a file: + +`wc --words {{path/to/file}}` + +- Count all bytes in a file: + +`wc --bytes {{path/to/file}}` + +- Count all characters in a file (taking multi-byte characters into account): + +`wc --chars {{path/to/file}}` + +- Count all lines, words and bytes from `stdin`: + +`{{find .}} | wc` + +- Count the length of the longest line in number of characters: + +`wc --max-line-length {{path/to/file}}` diff --git a/weasyprint b/weasyprint new file mode 100644 index 00000000..6131d738 --- /dev/null +++ b/weasyprint @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# weasyprint + +> Render HTML to PDF or PNG. +> More information: . + +- Render an HTML file to PDF: + +`weasyprint {{path/to/input.html}} {{path/to/output.pdf}}` + +- Render an HTML file to PNG, including an additional user stylesheet: + +`weasyprint {{path/to/input.html}} {{path/to/output.png}} --stylesheet {{path/to/stylesheet.css}}` + +- Output additional debugging information when rendering: + +`weasyprint {{path/to/input.html}} {{path/to/output.pdf}} --verbose` + +- Specify a custom resolution when outputting to PNG: + +`weasyprint {{path/to/input.html}} {{path/to/output.png}} --resolution {{300}}` + +- Specify a base URL for relative URLs in the input HTML file: + +`weasyprint {{path/to/input.html}} {{path/to/output.png}} --base-url {{url_or_filename}}` diff --git a/web-ext b/web-ext new file mode 100644 index 00000000..47d2e12a --- /dev/null +++ b/web-ext @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# web-ext + +> A command-line tool for managing web extension development. +> More information: . + +- Run the web extension in the current directory in Firefox: + +`web-ext run` + +- Run a web extension from a specific directory in Firefox: + +`web-ext run --source-dir {{path/to/directory}}` + +- Display verbose execution output: + +`web-ext run --verbose` + +- Run a web extension in Firefox Android: + +`web-ext run --target firefox-android` + +- Lint the manifest and source files for errors: + +`web-ext lint` + +- Build and package the extension: + +`web-ext build` + +- Display verbose build output: + +`web-ext build --verbose` + +- Sign a package for self-hosting: + +`web-ext sign --api-key {{api_key}} --api-secret {{api_secret}}` diff --git a/webpack b/webpack new file mode 100644 index 00000000..cced3ea3 --- /dev/null +++ b/webpack @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# webpack + +> Bundle a web project's js files and other assets into a single output file. +> More information: . + +- Create a single output file from an entry point file: + +`webpack {{app.js}} {{bundle.js}}` + +- Load CSS files too from the JavaScript file (this uses the CSS loader for `.css` files): + +`webpack {{app.js}} {{bundle.js}} --module-bind '{{css=css}}'` + +- Pass a configuration file (with e.g. the entry script and the output filename) and show compilation progress: + +`webpack --config {{webpack.config.js}} --progress` + +- Automatically recompile on changes to project files: + +`webpack --watch {{app.js}} {{bundle.js}}` diff --git a/webstorm b/webstorm new file mode 100644 index 00000000..45fe8a50 --- /dev/null +++ b/webstorm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# webstorm + +> The JetBrains JavaScript IDE. +> More information: . + +- Open the current directory in WebStorm: + +`webstorm` + +- Open a specific directory in WebStorm: + +`webstorm {{path/to/directory}}` + +- Open specific files in the LightEdit mode: + +`webstorm -e {{path/to/file1 path/to/file2 ...}}` + +- Open and wait until done editing a specific file in the LightEdit mode: + +`webstorm --wait -e {{path/to/file}}` + +- Open a file with the cursor at the specific line: + +`webstorm --line {{line_number}} {{path/to/file}}` + +- Open and compare files (supports up to 3 files): + +`webstorm diff {{path/to/file1 path/to/file2 path/to/optional_file3}}` + +- Open and perform a three-way merge: + +`webstorm merge {{path/to/left_file}} {{path/to/right_file}} {{path/to/target_file}}` diff --git a/webtorrent b/webtorrent new file mode 100644 index 00000000..57a0eed0 --- /dev/null +++ b/webtorrent @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# webtorrent + +> The command-line interface for WebTorrent. +> Supports magnets, URLs, info hashes and `.torrent` files. +> More information: . + +- Download a torrent: + +`webtorrent download "{{torrent_id}}"` + +- Stream a torrent to VLC media player: + +`webtorrent download "{{torrent_id}}" --vlc` + +- Stream a torrent to a Digital Living Network Alliance (DLNA) device: + +`webtorrent download "{{torrent_id}}" --dlna` + +- Display a list of files for a specific torrent: + +`webtorrent download "{{torrent_id}}" --select` + +- Specify a file index from the torrent to download: + +`webtorrent download "{{torrent_id}}" --select {{index}}` + +- Seed a specific file or directory: + +`webtorrent seed {{path/to/file_or_directory}}` + +- Create a new torrent file for the specified file path: + +`webtorrent create {{path/to/file}}` + +- Display information for a magnet URI or `.torrent` file: + +`webtorrent info {{path/to/file_or_magnet}}` diff --git a/weechat b/weechat new file mode 100644 index 00000000..5a31f820 --- /dev/null +++ b/weechat @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# weechat + +> Command-line internet relay chat client with various features. +> More information: . + +- Start WeeChat: + +`weechat` + +- Do not load any plugin(s) on startup: + +`weechat --no-plugin` + +- Do not load any script(s) on startup: + +`weechat --no-script` + +- Do not connect to servers automatically: + +`weechat --no-connect` + +- Write default terminal colors to `stdout`: + +`weechat --colors` diff --git a/wfuzz b/wfuzz new file mode 100644 index 00000000..3f9c9012 --- /dev/null +++ b/wfuzz @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wfuzz + +> A web application bruteforcer. +> More information: . + +- Directory and file bruteforce using the specified wordlist and also proxying the traffic: + +`wfuzz -w {{path/to/file}} -p {{127.0.0.1:8080}} {{http://example.com/FUZZ}}` + +- Save the results to a file: + +`wfuzz -w {{path/to/file}} -f {{filename}} {{http://example.com/FUZZ}}` + +- Show colorized output while only showing the declared response codes in the output: + +`wfuzz -c -w {{path/to/file}} --sc {{200,301,302}} {{http://example.com/FUZZ}}` + +- Use a custom header to fuzz subdomains while hiding specific response codes and word counts. Increase the threads to 100 and include the target ip/domain: + +`wfuzz -w {{path/to/file}} -H {{"Host: FUZZ.example.com"}} --hc {{301}} --hw {{222}} -t {{100}} {{example.com}}` diff --git a/wget b/wget new file mode 100644 index 00000000..7f462bb3 --- /dev/null +++ b/wget @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wget + +> Download files from the Web. +> Supports HTTP, HTTPS, and FTP. +> More information: . + +- Download the contents of a URL to a file (named "foo" in this case): + +`wget {{https://example.com/foo}}` + +- Download the contents of a URL to a file (named "bar" in this case): + +`wget --output-document {{bar}} {{https://example.com/foo}}` + +- Download a single web page and all its resources with 3-second intervals between requests (scripts, stylesheets, images, etc.): + +`wget --page-requisites --convert-links --wait=3 {{https://example.com/somepage.html}}` + +- Download all listed files within a directory and its sub-directories (does not download embedded page elements): + +`wget --mirror --no-parent {{https://example.com/somepath/}}` + +- Limit the download speed and the number of connection retries: + +`wget --limit-rate={{300k}} --tries={{100}} {{https://example.com/somepath/}}` + +- Download a file from an HTTP server using Basic Auth (also works for FTP): + +`wget --user={{username}} --password={{password}} {{https://example.com}}` + +- Continue an incomplete download: + +`wget --continue {{https://example.com}}` + +- Download all URLs stored in a text file to a specific directory: + +`wget --directory-prefix {{path/to/directory}} --input-file {{URLs.txt}}` diff --git a/where b/where new file mode 100644 index 00000000..90722cd7 --- /dev/null +++ b/where @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# where + +> Reports all known instances of a command. +> It could be an executable in the PATH environment variable, an alias, or a shell builtin. +> More information: . + +- Find all instances of a command: + +`where {{command}}` diff --git a/whereis b/whereis new file mode 100644 index 00000000..87012d2e --- /dev/null +++ b/whereis @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# whereis + +> Locate the binary, source, and manual page files for a command. +> More information: . + +- Locate binary, source and man pages for ssh: + +`whereis {{ssh}}` + +- Locate binary and man pages for ls: + +`whereis -bm {{ls}}` + +- Locate source of gcc and man pages for Git: + +`whereis -s {{gcc}} -m {{git}}` + +- Locate binaries for gcc in `/usr/bin/` only: + +`whereis -b -B {{/usr/bin/}} -f {{gcc}}` + +- Locate unusual binaries (those that have more or less than one binary on the system): + +`whereis -u *` + +- Locate binaries that have unusual manual entries (binaries that have more or less than one manual installed): + +`whereis -u -m *` diff --git a/which b/which new file mode 100644 index 00000000..0a27a4e5 --- /dev/null +++ b/which @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# which + +> Locate a program in the user's path. +> More information: . + +- Search the PATH environment variable and display the location of any matching executables: + +`which {{executable}}` + +- If there are multiple executables which match, display all: + +`which -a {{executable}}` diff --git a/while b/while new file mode 100644 index 00000000..18058bfd --- /dev/null +++ b/while @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# while + +> Simple shell loop. +> More information: . + +- Read `stdin` and perform an action on every line: + +`while read line; do echo "$line"; done` + +- Execute a command forever once every second: + +`while :; do {{command}}; sleep 1; done` diff --git a/whisper b/whisper new file mode 100644 index 00000000..0027999e --- /dev/null +++ b/whisper @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# whisper + +> Convert audio files to `txt`, `vtt`, `srt`, `tsv` and `json`. +> More information: . + +- Convert a specific audio file to all of the given file formats: + +`whisper {{path/to/audio.mp3}}` + +- Convert an audio file specifying the output format of the converted file: + +`whisper {{path/to/audio.mp3}} --output_format {{txt}}` + +- Convert an audio file using a specific model for conversion: + +`whisper {{path/to/audio.mp3}} --model {{tiny.en,tiny,base.en,base,small.en,small,medium.en,medium,large-v1,large-v2,large}}` + +- Convert an audio file specifying which language the audio file is in to reduce conversion time: + +`whisper {{path/to/audio.mp3}} --language {{english}}` + +- Convert an audio file and save it to a specific location: + +`whisper {{path/to/audio.mp3}} --output_dir "{{path/to/output}}"` + +- Convert an audio file in quiet mode: + +`whisper {{path/to/audio.mp3}} --verbose {{False}}` diff --git a/who b/who new file mode 100644 index 00000000..456307cb --- /dev/null +++ b/who @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# who + +> Display who is logged in and related data (processes, boot time). +> More information: . + +- Display the username, line, and time of all currently logged-in sessions: + +`who` + +- Display information only for the current terminal session: + +`who am i` + +- Display all available information: + +`who -a` + +- Display all available information with table headers: + +`who -a -H` diff --git a/whoami b/whoami new file mode 100644 index 00000000..96052b8e --- /dev/null +++ b/whoami @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# whoami + +> Print the username associated with the current effective user ID. +> More information: . + +- Display currently logged username: + +`whoami` + +- Display the username after a change in the user ID: + +`sudo whoami` diff --git a/whois b/whois new file mode 100644 index 00000000..102322d1 --- /dev/null +++ b/whois @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# whois + +> Command-line client for the WHOIS (RFC 3912) protocol. +> More information: . + +- Get information about a domain name: + +`whois {{example.com}}` + +- Get information about an IP address: + +`whois {{8.8.8.8}}` + +- Get abuse contact for an IP address: + +`whois -b {{8.8.8.8}}` diff --git a/wiggle b/wiggle new file mode 100644 index 00000000..795f1f5f --- /dev/null +++ b/wiggle @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wiggle + +> A patch application tool resolving conflicts in patches that `patch` cannot handle. +> Note: Wiggle forcefully applies all changes, merging when conflicts arise, and reporting unresolvable issues. +> More information: . + +- Apply changes from the patch file to the original file: + +`wiggle {{path/to/my_patch.patch}}` + +- Apply changes to the [o]utput file: + +`wiggle {{path/to/my_patch.patch}} -o {{path/to/output_file.txt}}` + +- Take any changes in `file.rej` that could not have been applied and merge them into a file: + +`wiggle --replace {{path/to/file}} {{path/to/file.rej}}` + +- E[x]tract one branch of a patch or merge file: + +`wiggle -x {{path/to/my_patch.patch}}` + +- Apply a patch and save the compared words to the [o]utput file: + +`wiggle --words {{path/to/my_word_patch.patch}} -o {{path/to/word_patched_code.c}}` + +- Display help about the merge function: + +`wiggle --merge --help` diff --git a/wikit b/wikit new file mode 100644 index 00000000..0a452d34 --- /dev/null +++ b/wikit @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wikit + +> A command line program for getting Wikipedia summaries easily. +> More information: . + +- Show a short summary of a specific topic on Wikipedia: + +`wikit {{topic}}` + +- Specify a [l]anguage (ISO 639-1 language code): + +`wikit {{topic}} --lang {{language_code}}` + +- Open the full Wikipedia article in the default browser: + +`wikit {{topic}} -b` + +- Open a disambiguation menu: + +`wikit {{topic}} -d` diff --git a/windows/add-appxpackage b/windows/add-appxpackage new file mode 100644 index 00000000..ffce7b4f --- /dev/null +++ b/windows/add-appxpackage @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Add-AppxPackage + +> A PowerShell utility to add a signed app package (`.appx`, `.msix`, `.appxbundle` and `.msixbundle`) to a user account. +> More information: . + +- Add an app package: + +`Add-AppxPackage -Path {{path o\package.msix}}` + +- Add an app package with dependencies: + +`Add-AppxPackage -Path {{path o\package.msix}} -DependencyPath {{path o\dependencies.msix}}` + +- Install an app using the app installer file: + +`Add-AppxPackage -AppInstallerFile {{path opp.appinstaller}}` + +- Add an unsigned package: + +`Add-AppxPackage -Path {{path o\package.msix}} -DependencyPath {{path o\dependencies.msix}} -AllowUnsigned` diff --git a/windows/assoc b/windows/assoc new file mode 100644 index 00000000..f0a94a1e --- /dev/null +++ b/windows/assoc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# assoc + +> Display or change associations between file extensions and file types. +> More information: . + +- List all associations between file extensions and file types: + +`assoc` + +- Display the associated file type for a specific extension: + +`assoc {{.txt}}` + +- Set the associated file type for a specific extension: + +`assoc .{{txt}}={{txtfile}}` + +- View the output of `assoc` one screen at a time: + +`assoc | {{more}}` diff --git a/windows/attrib b/windows/attrib new file mode 100644 index 00000000..dc2d22f1 --- /dev/null +++ b/windows/attrib @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# attrib + +> Display or change attributes of files or directories. +> More information: . + +- Display all set attributes of files in the current directory: + +`attrib` + +- Display all set attributes of files in a specific directory: + +`attrib {{path o\directory}}` + +- Display all set attributes of files and [d]irectories in the current directory: + +`attrib /d` + +- Display all set attributes of files in the current directory and [s]ub-directories: + +`attrib /s` + +- Add the `[r]ead-only` or `[a]rchive` or `[s]ystem` or `[h]idden` or `not content [i]ndexed` attribute to files or directories: + +`attrib +{{r|a|s|h|i}} {{path o ile_or_directory1 path o ile_or_directory2 ...}}` + +- Remove a specific attribute of files or directories: + +`attrib -{{r|a|s|h|i}} {{path o ile_or_directory1 path o ile_or_directory2 ...}}` diff --git a/windows/azcopy b/windows/azcopy new file mode 100644 index 00000000..d338a441 --- /dev/null +++ b/windows/azcopy @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# azcopy + +> A file transfer tool for uploading to Azure Cloud Storage Accounts. +> More information: . + +- Log in to an Azure Tenant: + +`azopy login` + +- Upload a local file: + +`azcopy copy '{{path o\source_file}}' 'https://{{storage_account_name}}.blob.core.windows.net/{{container_name}}/{{blob_name}}'` + +- Upload files with `.txt` and `.jpg` extensions: + +`azcopy copy '{{path o\source_directory}}' 'https://{{storage_account_name}}.blob.core.windows.net/{{container_name}}' --include-pattern '{{*.txt;*.jpg}}'` + +- Copy a container directly between two Azure storage accounts: + +`azcopy copy 'https://{{source_storage_account_name}}.blob.core.windows.net/{{container_name}}' 'https://{{destination_storage_account_name}}.blob.core.windows.net/{{container_name}}'` + +- Synchronize a local directory and delete files in the destination if they no longer exist in the source: + +`azcopy sync '{{path o\source_directory}}' 'https://{{storage_account_name}}.blob.core.windows.net/{{container_name}}' --recursive --delete-destination=true` + +- Display help: + +`azcopy --help` diff --git a/windows/bcdboot b/windows/bcdboot new file mode 100644 index 00000000..c719d571 --- /dev/null +++ b/windows/bcdboot @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# bcdboot + +> Configure or repair boot files. +> More information: . + +- Initialize the system partition by using BCD files from the source Windows folder: + +`bcdboot {{C:\Windows}}` + +- Enable [v]erbose mode: + +`bcdboot {{C:\Windows}} /v` + +- Specify the volume letter of the [s]ystem partition: + +`bcdboot {{C:\Windows}} /s {{S:}}` + +- Specify a [l]ocale: + +`bcdboot {{C:\Windows}} /l {{en-us}}` + +- Specify a [f]irmware type while copying the boot files to a specified volume: + +`bcdboot {{C:\Windows}} /s {{S:}} /f {{UEFI|BIOS|ALL}}` diff --git a/windows/bleachbit_console b/windows/bleachbit_console new file mode 100644 index 00000000..87f66297 --- /dev/null +++ b/windows/bleachbit_console @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# bleachbit_console + +> Clean junk files on the filesystem. +> More information: . + +- Perform the clean-up operation and delete files: + +`bleachbit_console.exe --clean` + +- Preview the files that will be deleted and other changes that will be made before actually performing the clean-up operation: + +`bleachbit_console.exe --preview` + +- Display system information: + +`bleachbit_console.exe --sysinfo` + +- Start the graphical user interface (GUI) version of Bleachbit: + +`bleachbit_console.exe --gui` + +- Display version: + +`bleachbit_console.exe --version` diff --git a/windows/cd b/windows/cd new file mode 100644 index 00000000..27bae19c --- /dev/null +++ b/windows/cd @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cd + +> Display the current working directory or move to a different directory. +> In PowerShell, this command is an alias of `Set-Location`. This documentation is based on the Command Prompt (`cmd`) version of `cd`. +> More information: . + +- View documentation of the equivalent PowerShell command: + +`tldr set-location` + +- Display the path of the current directory: + +`cd` + +- Go to a specific directory in the same drive: + +`cd {{path o\directory}}` + +- Go to a specific directory in a different [d]rive: + +`cd /d {{C}}:{{path o\directory}}` + +- Go up to the parent of the current directory: + +`cd ..` + +- Go to the home directory of the current user: + +`cd %userprofile%` + +- Go to root of current drive: + +`cd \` diff --git a/windows/certutil b/windows/certutil new file mode 100644 index 00000000..4b908e10 --- /dev/null +++ b/windows/certutil @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# certutil + +> A tool to manage and configure certificate information. +> More information: . + +- Dump the configuration information or files: + +`certutil {{filename}}` + +- Encode a file in hexadecimal: + +`certutil -encodehex {{path o\input_file}} {{path o\output_file}}` + +- Encode a file to Base64: + +`certutil -encode {{path o\input_file}} {{path o\output_file}}` + +- Decode a Base64-encoded file: + +`certutil -decode {{path o\input_file}} {{path o\output_file}}` + +- Generate and display a cryptographic hash over a file: + +`certutil -hashfile {{path o\input_file}} {{md2|md4|md5|sha1|sha256|sha384|sha512}}` diff --git a/windows/chdir b/windows/chdir new file mode 100644 index 00000000..b73eba15 --- /dev/null +++ b/windows/chdir @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# chdir + +> This command is an alias of `cd` in Command Prompt, and subsequently `Set-Location` in PowerShell. +> More information: . + +- View documentation for the original Command Prompt command: + +`tldr cd` + +- View documentation for the original PowerShell command: + +`tldr set-location` diff --git a/windows/chkdsk b/windows/chkdsk new file mode 100644 index 00000000..a834b6e0 --- /dev/null +++ b/windows/chkdsk @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# chkdsk + +> Check file system and volume metadata for errors. +> More information: . + +- Specify the drive letter (followed by a colon), mount point, or volume name to check: + +`chkdsk {{volume}}` + +- Fix errors on a specific volume: + +`chkdsk {{volume}} /f` + +- Dismount a specific volume before checking: + +`chkdsk {{volume}} /x` + +- Change the log file size to the specified size (only for NTFS): + +`chkdsk /l{{size}}` diff --git a/windows/choco b/windows/choco new file mode 100644 index 00000000..4605a478 --- /dev/null +++ b/windows/choco @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco + +> The Chocolatey package manager. +> Some subcommands such as `choco install` have their own usage documentation. +> More information: . + +- Execute a Chocolatey command: + +`choco {{command}}` + +- Display help: + +`choco -?` + +- Display help for a specific command: + +`choco {{command}} -?` + +- Display version: + +`choco --version` diff --git a/windows/choco-apikey b/windows/choco-apikey new file mode 100644 index 00000000..d55f3618 --- /dev/null +++ b/windows/choco-apikey @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco apikey + +> Manage API keys for Chocolatey sources. +> More information: . + +- Display a list of sources and their API keys: + +`choco apikey` + +- Display a specific source and its API key: + +`choco apikey --source "{{source_url}}"` + +- Set an API key for a source: + +`choco apikey --source "{{source_url}}" --key "{{api_key}}"` + +- Remove an API key for a source: + +`choco apikey --source "{{source_url}}" --remove` diff --git a/windows/choco-feature b/windows/choco-feature new file mode 100644 index 00000000..af10470f --- /dev/null +++ b/windows/choco-feature @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco feature + +> Interact with features with Chocolatey. +> More information: . + +- Display a list of available features: + +`choco feature list` + +- Enable a feature: + +`choco feature enable --name {{name}}` + +- Disable a feature: + +`choco feature disable --name {{name}}` diff --git a/windows/choco-info b/windows/choco-info new file mode 100644 index 00000000..be5a150d --- /dev/null +++ b/windows/choco-info @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco info + +> Display detailed information about a package with Chocolatey. +> More information: . + +- Display information on a specific package: + +`choco info {{package}}` + +- Display information for a local package only: + +`choco info {{package}} --local-only` + +- Specify a custom source to receive packages information from: + +`choco info {{package}} --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco info {{package}} --user {{username}} --password {{password}}` diff --git a/windows/choco-install b/windows/choco-install new file mode 100644 index 00000000..f2fb530b --- /dev/null +++ b/windows/choco-install @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco install + +> Install one or more packages with Chocolatey. +> More information: . + +- Install one or more packages: + +`choco install {{package1 package2 ...}}` + +- Install packages from a custom configuration file: + +`choco install {{path o\packages_file.config}}` + +- Install a specific `nuspec` or `nupkg` file: + +`choco install {{path o ile}}` + +- Install a specific version of a package: + +`choco install {{package}} --version {{version}}` + +- Allow installing multiple versions of a package: + +`choco install {{package}} --allow-multiple` + +- Confirm all prompts automatically: + +`choco install {{package}} --yes` + +- Specify a custom source to receive packages from: + +`choco install {{package}} --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco install {{package}} --user {{username}} --password {{password}}` diff --git a/windows/choco-list b/windows/choco-list new file mode 100644 index 00000000..13d655b8 --- /dev/null +++ b/windows/choco-list @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco list + +> Display a list of packages with Chocolatey. +> More information: . + +- Display all available packages: + +`choco list` + +- Display all locally installed packages: + +`choco list --local-only` + +- Display a list including local programs: + +`choco list --include-programs` + +- Display only approved packages: + +`choco list --approved-only` + +- Specify a custom source to display packages from: + +`choco list --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco list --user {{username}} --password {{password}}` diff --git a/windows/choco-new b/windows/choco-new new file mode 100644 index 00000000..f33afb84 --- /dev/null +++ b/windows/choco-new @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco new + +> Generate new package specification files with Chocolatey. +> More information: . + +- Create a new package skeleton: + +`choco new {{package}}` + +- Create a new package with a specific version: + +`choco new {{package}} --version {{version}}` + +- Create a new package with a specific maintainer name: + +`choco new {{package}} --maintainer {{maintainer_name}}` + +- Create a new package in a custom output directory: + +`choco new {{package}} --output-directory {{path/to/directory}}` + +- Create a new package with specific 32-bit and 64-bit installer URLs: + +`choco new {{package}} url="{{url}}" url64="{{url}}"` diff --git a/windows/choco-outdated b/windows/choco-outdated new file mode 100644 index 00000000..2e34ea52 --- /dev/null +++ b/windows/choco-outdated @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco outdated + +> Check for outdated packages with Chocolatey. +> More information: . + +- Display a list of outdated packages in table format: + +`choco outdated` + +- Ignore pinned packages in the output: + +`choco outdated --ignore-pinned` + +- Specify a custom source to check packages from: + +`choco outdated --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco outdated --user {{username}} --password {{password}}` diff --git a/windows/choco-pack b/windows/choco-pack new file mode 100644 index 00000000..1823bd15 --- /dev/null +++ b/windows/choco-pack @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco pack + +> Package a NuGet specification into a `nupkg` file. +> More information: . + +- Package a NuGet specification to a `nupkg` file: + +`choco pack {{path o\specification_file}}` + +- Package a NuGet specification specifying the version of the resulting file: + +`choco pack {{path o\specification_file}} --version {{version}}` + +- Package a NuGet specification to a specific directory: + +`choco pack {{path o\specification_file}} --output-directory {{path o\output_directory}}` diff --git a/windows/choco-pin b/windows/choco-pin new file mode 100644 index 00000000..abd20a0a --- /dev/null +++ b/windows/choco-pin @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco pin + +> Pin a package at a version with Chocolatey. +> Pinned packages are skipped automatically when upgrading. +> More information: . + +- Display a list of pinned packages and their versions: + +`choco pin list` + +- Pin a package at its current version: + +`choco pin add --name {{package}}` + +- Pin a package at a specific version: + +`choco pin add --name {{package}} --version {{version}}` + +- Remove a pin for a specific package: + +`choco pin remove --name {{package}}` diff --git a/windows/choco-push b/windows/choco-push new file mode 100644 index 00000000..8738d1c0 --- /dev/null +++ b/windows/choco-push @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco-push + +> Push a compiled NuGet package (`nupkg`) to a package feed. +> More information: . + +- Push a compiled `nupkg` to the specified feed: + +`choco push --source {{https://push.chocolatey.org/}}` + +- Push a compiled `nupkg` to the specified feed with a timeout in seconds (default is 2700): + +`choco push --source {{https://push.chocolatey.org/}} --execution-timeout {{500}}` diff --git a/windows/choco-search b/windows/choco-search new file mode 100644 index 00000000..c17f0bf7 --- /dev/null +++ b/windows/choco-search @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco search + +> Search for a local or remote package with Chocolatey. +> More information: . + +- Search for a package: + +`choco search {{query}}` + +- Search for a package locally: + +`choco search {{query}} --local-only` + +- Only include exact matches in the results: + +`choco search {{query}} --exact` + +- Confirm all prompts automatically: + +`choco search {{query}} --yes` + +- Specify a custom source to search for packages in: + +`choco search {{query}} --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco search {{query}} --user {{username}} --password {{password}}` diff --git a/windows/choco-source b/windows/choco-source new file mode 100644 index 00000000..3f340a10 --- /dev/null +++ b/windows/choco-source @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco source + +> Manage sources for packages with Chocolatey. +> More information: . + +- List currently available sources: + +`choco source list` + +- Add a new package source: + +`choco source add --name {{name}} --source {{url}}` + +- Add a new package source with credentials: + +`choco source add --name {{name}} --source {{url}} --user {{username}} --password {{password}}` + +- Add a new package source with a client certificate: + +`choco source add --name {{name}} --source {{url}} --cert {{path o \ No newline at end of file diff --git a/windows/choco-uninstall b/windows/choco-uninstall new file mode 100644 index 00000000..21d81611 --- /dev/null +++ b/windows/choco-uninstall @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco uninstall + +> Uninstall packages with Chocolatey. +> More information: . + +- Uninstall one or more packages: + +`choco uninstall {{package1 package2 ...}}` + +- Uninstall a specific version of a package: + +`choco uninstall {{package}} --version {{version}}` + +- Confirm all prompts automatically: + +`choco uninstall {{package}} --yes` + +- Remove all dependencies when uninstalling: + +`choco uninstall {{package}} --remove-dependencies` + +- Uninstall all packages: + +`choco uninstall all` diff --git a/windows/choco-upgrade b/windows/choco-upgrade new file mode 100644 index 00000000..7137adac --- /dev/null +++ b/windows/choco-upgrade @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choco upgrade + +> Upgrade one or more packages with Chocolatey. +> More information: . + +- Upgrade one or more packages: + +`choco upgrade {{package1 package2 ...}}` + +- Upgrade to a specific version of a package: + +`choco upgrade {{package}} --version {{version}}` + +- Upgrade all packages: + +`choco upgrade all` + +- Upgrade all except specified comma-separated packages: + +`choco upgrade all --except "{{package1,package2,...}}"` + +- Confirm all prompts automatically: + +`choco upgrade {{package}} --yes` + +- Specify a custom source to receive packages from: + +`choco upgrade {{package}} --source {{source_url|alias}}` + +- Provide a username and password for authentication: + +`choco upgrade {{package}} --user {{username}} --password {{password}}` diff --git a/windows/choice b/windows/choice new file mode 100644 index 00000000..5bf5779b --- /dev/null +++ b/windows/choice @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# choice + +> Prompt user to select a choice and return the selected choice index. +> More information: . + +- Prompt the current user to select a `Y` or `N` choice: + +`choice` + +- Prompt the current user to select a [c]hoice from a specific set: + +`choice /c {{AB}}` + +- Prompt the current user to select a choice with a specific [m]essage: + +`choice /m "{{message}}"` + +- Prompt the current user to select a [c]ase-[s]ensitive [c]hoice from a specific set: + +`choice /cs /c {{Ab}}` + +- Prompt the current user to select a choice and prefer the [d]efault choice in a specific [t]ime: + +`choice /t {{5}} /d {{N}}` + +- Display help: + +`choice /?` diff --git a/windows/chrome b/windows/chrome new file mode 100644 index 00000000..94376910 --- /dev/null +++ b/windows/chrome @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# chrome + +> This command is an alias of `chromium`. +> More information: . + +- View documentation for the original command: + +`tldr chromium` diff --git a/windows/cinst b/windows/cinst new file mode 100644 index 00000000..19174714 --- /dev/null +++ b/windows/cinst @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cinst + +> This command is an alias of `choco install`. +> More information: . + +- View documentation for the original command: + +`tldr choco install` diff --git a/windows/cipher b/windows/cipher new file mode 100644 index 00000000..b2c83d87 --- /dev/null +++ b/windows/cipher @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cipher + +> Display or alter the encryption of directories and files on NTFS volumes. +> More information: . + +- Display information about a specific encrypted file or directory: + +`cipher /c:{{path o ile_or_directory}}` + +- [e]ncrypt a file or directory (files added later to the directory are also encrypted as the directory is marked): + +`cipher /e:{{path o ile_or_directory}}` + +- [d]ecrypt a file or directory: + +`cipher /d:{{path o ile_or_directory}}` + +- Securely remove a file or directory: + +`cipher /w:{{path o ile_or_directory}}` diff --git a/windows/clear b/windows/clear new file mode 100644 index 00000000..9733c57f --- /dev/null +++ b/windows/clear @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# clear + +> In PowerShell, this command is an alias of `Clear-Host`. + +- View documentation for the original command: + +`tldr clear-host` diff --git a/windows/clear-host b/windows/clear-host new file mode 100644 index 00000000..8e1fdd16 --- /dev/null +++ b/windows/clear-host @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Clear-Host + +> Clears the screen. +> This command can only be used through PowerShell. +> More information: . + +- Clear the screen: + +`cls` diff --git a/windows/clear-recyclebin b/windows/clear-recyclebin new file mode 100644 index 00000000..89a97385 --- /dev/null +++ b/windows/clear-recyclebin @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Clear-RecycleBin + +> Clear items from the Recycle Bin. +> This command can only be used through PowerShell versions 5.1 and below, or 7.1 and above. +> More information: . + +- Clear and delete all items inside the Recycle Bin: + +`Clear-RecycleBin` + +- Clear the Recycle Bin for a specific drive: + +`Clear-RecycleBin -DriveLetter {{C}}` + +- Clear the Recycle Bin without further confirmation: + +`Clear-RecycleBin -Force` diff --git a/windows/clip b/windows/clip new file mode 100644 index 00000000..c951f867 --- /dev/null +++ b/windows/clip @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# clip + +> Copy input content to the Windows clipboard. +> More information: . + +- Pipe command-line output to the Windows clipboard: + +`{{dir}} | clip` + +- Copy the contents of a file to the Windows clipboard: + +`clip < {{path o ile.ext}}` + +- Copy text with a trailing newline to the Windows clipboard: + +`echo {{some text}} | clip` + +- Copy text without a trailing newline to the Windows clipboard: + +`echo | set /p="some text" | clip` diff --git a/windows/clist b/windows/clist new file mode 100644 index 00000000..c7da96b5 --- /dev/null +++ b/windows/clist @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# clist + +> This command is an alias of `choco list`. +> More information: . + +- View documentation for the original command: + +`tldr choco list` diff --git a/windows/cls b/windows/cls new file mode 100644 index 00000000..389ef037 --- /dev/null +++ b/windows/cls @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cls + +> Clears the screen. +> In PowerShell, this command is an alias of `Clear-Host`. This documentation is based on the Command Prompt (`cmd`) version of `cls`. +> More information: . + +- View the documentation of the equivalent PowerShell command: + +`tldr clear-host` + +- Clear the screen: + +`cls` diff --git a/windows/cmd b/windows/cmd new file mode 100644 index 00000000..dec8ba45 --- /dev/null +++ b/windows/cmd @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cmd + +> The Windows command interpreter. +> More information: . + +- Start an interactive shell session: + +`cmd` + +- Execute specific [c]ommands: + +`cmd /c {{echo Hello world}}` + +- Execute a specific script: + +`cmd {{path o\script.bat}}` + +- Execute specific commands and then enter an interactive shell: + +`cmd /k {{echo Hello world}}` + +- Start an interactive shell session where `echo` is disabled in command output: + +`cmd /q` + +- Start an interactive shell session with delayed [v]ariable expansion enabled or disabled: + +`cmd /v:{{on|off}}` + +- Start an interactive shell session with command [e]xtensions enabled or disabled: + +`cmd /e:{{on|off}}` + +- Start an interactive shell session with used [u]nicode encoding: + +`cmd /u` diff --git a/windows/cmdkey b/windows/cmdkey new file mode 100644 index 00000000..bb0d84cc --- /dev/null +++ b/windows/cmdkey @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cmdkey + +> Create, show, and delete stored user names and passwords. +> More information: . + +- List all user credentials: + +`cmdkey /list` + +- Store credentials for a user that accesses a server: + +`cmdkey /add:{{server_name}} /user:{{user_name}}` + +- Delete credentials for a specific target: + +`cmdkey /delete {{target_name}}` diff --git a/windows/cmstp b/windows/cmstp new file mode 100644 index 00000000..3107530c --- /dev/null +++ b/windows/cmstp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cmstp + +> Manage connection service profiles. +> More information: . + +- Install a specific profile: + +`cmstp "{{path o\profile_file}}"` + +- Install without creating a desktop shortcut: + +`cmstp /ns "{{path o\profile_file}}"` + +- Install without checking for dependencies: + +`cmstp /nf "{{path o\profile_file}}"` + +- Only install for the current user: + +`cmstp /su "{{path o\profile_file}}"` + +- Install for all users (requires administrator privileges): + +`cmstp /au "{{path o\profile_file}}"` + +- Install silently without any prompts: + +`cmstp /s "{{path o\profile_file}}"` + +- Uninstall a specific profile: + +`cmstp /u "{{path o\profile_file}}"` + +- Uninstall silently without a confirmation prompt: + +`cmstp /u /s "{{path o\profile_file}}"` diff --git a/windows/color b/windows/color new file mode 100644 index 00000000..c211b2db --- /dev/null +++ b/windows/color @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# color + +> Set the console foreground and background colors. +> More information: . + +- Set the console colors to the default values: + +`color` + +- List available color values and detailed information: + +`color /?` + +- Set the console foreground and background to a specific color using hexadecimal numbers (`1-9,a-f`): + +`color {{foreground_code}}{{background_code}}` diff --git a/windows/comp b/windows/comp new file mode 100644 index 00000000..71f517af --- /dev/null +++ b/windows/comp @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# comp + +> Compare the contents of two files or sets of files. +> Use wildcards (*) to compare sets of files. +> More information: . + +- Compare files interactively: + +`comp` + +- Compare two specified files: + +`comp {{path o ile1}} {{path o ile2}}` + +- Compare two sets of files: + +`comp {{path o\directory1}}\* {{path o\directory2}}\*` + +- Display differences in decimal format: + +`comp /d {{path o ile1}} {{path o ile2}}` + +- Display differences in ASCII format: + +`comp /a {{path o ile1}} {{path o ile2}}` + +- Display line numbers for differences: + +`comp /l {{path o ile1}} {{path o ile2}}` + +- Compare files case-insensitively: + +`comp /c {{path o ile1}} {{path o ile2}}` + +- Compare only the first 5 lines of each file: + +`comp /n={{5}} {{path o ile1}} {{path o ile2}}` diff --git a/windows/cpush b/windows/cpush new file mode 100644 index 00000000..70f64b41 --- /dev/null +++ b/windows/cpush @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cpush + +> This command is an alias of `choco push`. +> More information: . + +- View documentation for the original command: + +`tldr choco-push` diff --git a/windows/cuninst b/windows/cuninst new file mode 100644 index 00000000..22a6ee82 --- /dev/null +++ b/windows/cuninst @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# cuninst + +> This command is an alias of `choco uninstall`. +> More information: . + +- View documentation for the original command: + +`tldr choco uninstall` diff --git a/windows/curl b/windows/curl new file mode 100644 index 00000000..a37b785e --- /dev/null +++ b/windows/curl @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# curl + +> In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `curl` program () is not properly installed. +> More information: . + +- View documentation for the original `curl` command: + +`tldr curl -p common` + +- View documentation for PowerShell's `Invoke-WebRequest` command: + +`tldr invoke-webrequest` + +- Check whether `curl` is properly installed by printing its version number. If this command evaluates into an error, PowerShell may have substituted this command with `Invoke-WebRequest`: + +`curl --version` diff --git a/windows/date b/windows/date new file mode 100644 index 00000000..6883599c --- /dev/null +++ b/windows/date @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# date + +> Displays or sets the system date. +> More information: . + +- Display the current system date and prompt to enter a new date (leave empty to keep unchanged): + +`date` + +- Display the current system date without prompting for a new date: + +`date /t` + +- Change the current system date to a specific date: + +`date {{month}}-{{day}}-{{year}}` diff --git a/windows/del b/windows/del new file mode 100644 index 00000000..1f42c738 --- /dev/null +++ b/windows/del @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# del + +> Delete one or more files. +> In PowerShell, this command is an alias of `Remove-Item`. This documentation is based on the Command Prompt (`cmd`) version of `del`. +> More information: . + +- View the documentation of the equivalent PowerShell command: + +`tldr remove-item` + +- Delete one or more files or patterns: + +`del {{file_pattern1 file_pattern2 ...}}` + +- Prompt for confirmation before deleting each file: + +`del {{file_pattern}} /p` + +- Force the deletion of read-only files: + +`del {{file_pattern}} /f` + +- Recursively delete file(s) from all subdirectories: + +`del {{file_pattern}} /s` + +- Do not prompt when deleting files based on a global wildcard: + +`del {{file_pattern}} /q` + +- Display the help and list available attributes: + +`del /?` + +- Delete files based on specified attributes: + +`del {{file_pattern}} /a {{attribute}}` diff --git a/windows/dir b/windows/dir new file mode 100644 index 00000000..8fa4a129 --- /dev/null +++ b/windows/dir @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# dir + +> List directory contents. +> More information: . + +- Show the contents of the current directory: + +`dir` + +- Show the contents of a given directory: + +`dir {{path o\directory}}` + +- Show the contents of the current directory, including hidden ones: + +`dir /a` + +- Show the contents of a given directory, including hidden ones: + +`dir {{path o\directory}} /a` + +- Show a bare list of directories and files, with no additional information: + +`dir /b` diff --git a/windows/diskpart b/windows/diskpart new file mode 100644 index 00000000..1a1f7ab6 --- /dev/null +++ b/windows/diskpart @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# diskpart + +> Disk, volume and partition manager. +> More information: . + +- Run diskpart by itself in an administrative command prompt to enter its command-line: + +`diskpart` + +- List all disks: + +`list disk` + +- Select a volume: + +`select volume {{volume}}` + +- Assign a drive letter to the selected volume: + +`assign letter {{letter}}` + +- Create a new partition: + +`create partition primary` + +- Activate the selected volume: + +`active` + +- Exit diskpart: + +`exit` diff --git a/windows/doskey b/windows/doskey new file mode 100644 index 00000000..f1415b9a --- /dev/null +++ b/windows/doskey @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# doskey + +> Manage macros, windows commands and command-lines. +> More information: . + +- List available macros: + +`doskey /macros` + +- Create a new macro: + +`doskey {{name}} = "{{command}}"` + +- Create a new macro for a specific executable: + +`doskey /exename={{executable}} {{name}} = "{{command}}"` + +- Remove a macro: + +`doskey {{name}} =` + +- Display all commands that are stored in memory: + +`doskey /history` + +- Save macros to a file for portability: + +`doskey /macros > {{path o\macinit_file}}` + +- Load macros from a file: + +`doskey /macrofile = {{path o\macinit_file}}` diff --git a/windows/driverquery b/windows/driverquery new file mode 100644 index 00000000..96cd7536 --- /dev/null +++ b/windows/driverquery @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# driverquery + +> Display information about installed device drivers. +> More information: . + +- Display a list of all installed device drivers: + +`driverquery` + +- Display a list of drivers in the specified format: + +`driverquery /fo {{table|list|csv}}` + +- Display a list of drivers with a column to indicate if they are signed: + +`driverquery /si` + +- Exclude the header in the output list: + +`driverquery /nh` + +- Display a list of drivers for a remote machine: + +`driverquery /s {{hostname}} /u {{username}} /p {{password}}` + +- Display a list of drivers with verbose information: + +`driverquery /v` + +- Display help: + +`driverquery /?` diff --git a/windows/eventcreate b/windows/eventcreate new file mode 100644 index 00000000..b5a2f4b0 --- /dev/null +++ b/windows/eventcreate @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# eventcreate + +> Create custom entries in the event log. +> Event IDs can be any number between 1 and 1000. +> More information: . + +- Create a new event with a given ID (1-1000) in the log: + +`eventcreate /t {{success|error|warning|information}} /id {{id}} /d "{{message}}"` + +- Create an event in a specific event log: + +`eventcreate /l {{log_name}} /t {{type}} /id {{id}} /d "{{message}}"` + +- Create an event with a specific source: + +`eventcreate /so {{source_name}} /t {{type}} /id {{id}} /d "{{message}}"` + +- Create an event in a remote machine's event log: + +`eventcreate /s {{hostname}} /u {{username}} /p {{password}} /t {{type}} /id {{id}} /d "{{message}}"` diff --git a/windows/exit b/windows/exit new file mode 100644 index 00000000..8bd033d9 --- /dev/null +++ b/windows/exit @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# exit + +> Quit the current CMD instance or the current batch file. +> More information: . + +- Quit the current CMD instance: + +`exit` + +- Quit the current batch script: + +`exit /b` + +- Quit using a specific exit code: + +`exit {{2}}` diff --git a/windows/expand b/windows/expand new file mode 100644 index 00000000..f3ef9ae0 --- /dev/null +++ b/windows/expand @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# expand + +> Uncompress Windows Cabinet files. +> More information: . + +- Uncompress a single-file Cabinet file to the specified directory: + +`expand {{path o ile.cab}} {{path o\directory}}` + +- Display the list of files in a source Cabinet file: + +`expand {{path o ile.cab}} {{path o\directory}} -d` + +- Uncompress all files from the Cabinet file: + +`expand {{path o ile.cab}} {{path o\directory}} -f:*` + +- Uncompress a specific file from a Cabinet file: + +`expand {{path o ile.cab}} {{path o\directory}} -f:{{path o ile}}` + +- Ignore the directory structure when uncompressing, and add them to a single directory: + +`expand {{path o ile.cab}} {{path o\directory}} -i` diff --git a/windows/explorer b/windows/explorer new file mode 100644 index 00000000..05c7a86f --- /dev/null +++ b/windows/explorer @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# explorer + +> The Windows File Explorer. +> More information: . + +- Open Windows Explorer: + +`explorer` + +- Open Windows Explorer in the current directory: + +`explorer .` + +- Open Windows Explorer in a specific directory: + +`explorer {{path o\directory}}` diff --git a/windows/fc b/windows/fc new file mode 100644 index 00000000..311f2c10 --- /dev/null +++ b/windows/fc @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# fc + +> Compare the differences between two files or sets of files. +> Use wildcards (*) to compare sets of files. +> More information: . + +- Compare 2 specified files: + +`fc {{path o ile1}} {{path o ile2}}` + +- Perform a case-insensitive comparison: + +`fc /c {{path o ile1}} {{path o ile2}}` + +- Compare files as Unicode text: + +`fc /u {{path o ile1}} {{path o ile2}}` + +- Compare files as ASCII text: + +`fc /l {{path o ile1}} {{path o ile2}}` + +- Compare files as binary: + +`fc /b {{path o ile1}} {{path o ile2}}` + +- Disable tab-to-space expansion: + +`fc /t {{path o ile1}} {{path o ile2}}` + +- Compress whitespace (tabs and spaces) for comparisons: + +`fc /w {{path o ile1}} {{path o ile2}}` diff --git a/windows/find b/windows/find new file mode 100644 index 00000000..1b77c7d3 --- /dev/null +++ b/windows/find @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# find + +> Find a specified string in files. +> More information: . + +- Find lines that contain a specified string: + +`find "{{string}}" {{path o ile_or_directory}}` + +- Display lines that do not contain the specified string: + +`find "{{string}}" {{path o ile_or_directory}} /v` + +- Display the count of lines that contain the specified string: + +`find "{{string}}" {{path o ile_or_directory}} /c` + +- Display line numbers with the list of lines: + +`find "{{string}}" {{path o ile_or_directory}} /n` diff --git a/windows/findstr b/windows/findstr new file mode 100644 index 00000000..02f8fa52 --- /dev/null +++ b/windows/findstr @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# findstr + +> Find specified text within one or more files. +> More information: . + +- Find one or more strings in all files: + +`findstr "{{string1 string2 ...}}" *` + +- Find one or more strings in a piped command's output: + +`{{dir}} | findstr "{{string1 string2 ...}}"` + +- Find one or more strings in all files recur[s]ively: + +`findstr /s "{{string1 string2 ...}}" *` + +- Find strings using a case-insensitive search: + +`findstr /i "{{string1 string2 ...}}" *"` + +- Find strings in all files using regular expressions: + +`findstr /r "{{expression}}" *` + +- Find a literal string (containing spaces) in all text files: + +`findstr /c:"{{string1 string2 ...}}" *.txt` + +- Display the line number before each matching line: + +`findstr /n "{{string1 string2 ...}}" *` + +- Display only the filenames that contain a match: + +`findstr /m "{{string1 string2 ...}}" *` diff --git a/windows/finger b/windows/finger new file mode 100644 index 00000000..3c68149c --- /dev/null +++ b/windows/finger @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# finger + +> Return information about users on a specified system. +> The remote system must be running the Finger service. +> More information: . + +- Display information about a specific user: + +`finger {{user}}@{{host}}` + +- Display information about all users on the specified host: + +`finger @{{host}}` + +- Display information in a longer format: + +`finger {{user}}@{{host}} -l` + +- Display help information: + +`finger /?` diff --git a/windows/fondue b/windows/fondue new file mode 100644 index 00000000..c0486a77 --- /dev/null +++ b/windows/fondue @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# fondue + +> Install optional Windows features. +> More information: . + +- Enable a specific Windows feature: + +`fondue /enable-feature:{{feature}}` + +- Hide all output messages to the user: + +`fondue /enable-feature:{{feature}} /hide-ux:all` + +- Specify a caller process name for error reporting: + +`fondue /enable-feature:{{feature}} /caller-name:{{name}}` diff --git a/windows/for b/windows/for new file mode 100644 index 00000000..b4be58a4 --- /dev/null +++ b/windows/for @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# for + +> Conditionally execute a command several times. +> More information: . + +- Execute given commands for the specified set: + +`for %{{variable}} in ({{item_a item_b item_c}}) do ({{echo Loop is executed}})` + +- Iterate over a given range of numbers: + +`for /l %{{variable}} in ({{from}}, {{step}}, {{to}}) do ({{echo Loop is executed}})` + +- Iterate over a given list of files: + +`for %{{variable}} in ({{path o ile1.ext path o ile2.ext ...}}) do ({{echo Loop is executed}})` + +- Iterate over a given list of directories: + +`for /d %{{variable}} in ({{path o\directory1.ext path o\directory2.ext ...}}) do ({{echo Loop is executed}})` + +- Perform a given command in every directory: + +`for /d %{{variable}} in (*) do (if exist %{{variable}} {{echo Loop is executed}})` diff --git a/windows/forfiles b/windows/forfiles new file mode 100644 index 00000000..7e943df2 --- /dev/null +++ b/windows/forfiles @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# forfiles + +> Select files to execute a specified command on. +> More information: . + +- Search for files in the current directory: + +`forfiles` + +- Search for files in a specific directory: + +`forfiles /p {{path o\directory}}` + +- Run the specified command for each file: + +`forfiles /c "{{command}}"` + +- Search for files using a specific glob mask: + +`forfiles /m {{glob_pattern}}` + +- Search for files recursively: + +`forfiles /s` + +- Search for files older than 5 days: + +`forfiles /d +{{5}}` diff --git a/windows/fsutil b/windows/fsutil new file mode 100644 index 00000000..81cae5e3 --- /dev/null +++ b/windows/fsutil @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# fsutil + +> Displays information about file system volumes. +> More information: . + +- Display a list of volumes: + +`fsutil volume list` + +- Display information about a volume's file system: + +`fsutil fsInfo volumeInfo {{drive_letter|volume_path}}` + +- Display the current state of the file system auto-repair for all volumes: + +`fsutil repair state` + +- Display the dirty bit state of all volumes: + +`fsutil dirty query` + +- Set the dirty bit state of a volume: + +`fsutil dirty set {{drive_letter|volume_path}}` diff --git a/windows/ftp b/windows/ftp new file mode 100644 index 00000000..90e6cb6d --- /dev/null +++ b/windows/ftp @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ftp + +> Interactively transfer files between a local and remote FTP server. +> More information: . + +- Connect to a remote FTP server interactively: + +`ftp {{host}}` + +- Log in as an anonymous user: + +`ftp -A {{host}}` + +- Disable automatic login upon initial connection: + +`ftp -n {{host}}` + +- Run a file containing a list of FTP commands: + +`ftp -s:{{path o ile}} {{host}}` + +- Download multiple files (glob expression): + +`mget {{*.png}}` + +- Upload multiple files (glob expression): + +`mput {{*.zip}}` + +- Delete multiple files on the remote server: + +`mdelete {{*.txt}}` + +- Display help: + +`ftp --help` diff --git a/windows/ftype b/windows/ftype new file mode 100644 index 00000000..382a32ba --- /dev/null +++ b/windows/ftype @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ftype + +> Display or modify file types used for file extension association. +> More information: . + +- Display a list of all file types: + +`ftype` + +- Display the associated program for a specific file type: + +`ftype {{file_type}}` + +- Set the associated program for a specific file type: + +`ftype {{file_type}}="{{path/to/executable_file}}"` diff --git a/windows/gal b/windows/gal new file mode 100644 index 00000000..c66de771 --- /dev/null +++ b/windows/gal @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# gal + +> In PowerShell, this command is an alias of `Get-Alias`. +> More information: . + +- View documentation for the original command: + +`tldr get-alias` diff --git a/windows/get-acl b/windows/get-acl new file mode 100644 index 00000000..9a77d436 --- /dev/null +++ b/windows/get-acl @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Acl + +> Gets the security descriptor for a resource, such as a file or registry key. +> This command can only be used through PowerShell. +> More information: . + +- Display the ACL for a specific directory: + +`Get-Acl {{path o\directory}}` + +- Get an ACL for a registry key: + +`Get-Acl -Path {{HKLM:\System\CurrentControlSet\Control}} | Format-List` diff --git a/windows/get-alias b/windows/get-alias new file mode 100644 index 00000000..74396579 --- /dev/null +++ b/windows/get-alias @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Alias + +> List and get command aliases in the current PowerShell session. +> This command can only be run under PowerShell. +> More information: . + +- List all aliases in the current session: + +`Get-Alias` + +- Get the aliased command name: + +`Get-Alias {{command_alias}}` + +- List all aliases assigned to a specific command: + +`Get-Alias -Definition {{command}}` + +- List aliases that begins with `abc`, excluding those which ends at `def`: + +`Get-Alias {{abc}}* -Exclude *{{def}}` diff --git a/windows/get-childitem b/windows/get-childitem new file mode 100644 index 00000000..f438af94 --- /dev/null +++ b/windows/get-childitem @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-ChildItem + +> List items in a directory. +> This command can only be used through PowerShell. +> More information: . + +- List all non-hidden items in the current directory: + +`Get-ChildItem` + +- List only directories in the current directory: + +`Get-ChildItem -Directory` + +- List only files in the current directory: + +`Get-ChildItem -File` + +- List items in the current directory, including hidden items: + +`Get-ChildItem -Hidden` + +- List items in a directory other than the current one: + +`Get-ChildItem -Path {{path o\directory}}` diff --git a/windows/get-command b/windows/get-command new file mode 100644 index 00000000..67cbf5f9 --- /dev/null +++ b/windows/get-command @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Command + +> List and get available commands in the current PowerShell session. +> This command can only be run through PowerShell. +> More information: . + +- List all available PowerShell commands (aliases, cmdlets, functions) in the current computer: + +`Get-Command` + +- List all available PowerShell commands in the current session: + +`Get-Command -ListImported` + +- List only PowerShell aliases/cmdlets/functions available in the computer: + +`Get-Command -Type {{Alias|Cmdlet|Function}}` + +- List only programs or commands available on PATH in the current session: + +`Get-Command -Type Application` + +- List only PowerShell commands by the module name, e.g. `Microsoft.PowerShell.Utility` for utility-related commands: + +`Get-Command -Module {{module}}` + +- Get the command information (e.g. version number or module name) by its name: + +`Get-Command {{command}}` diff --git a/windows/get-content b/windows/get-content new file mode 100644 index 00000000..a2560fb2 --- /dev/null +++ b/windows/get-content @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Content + +> Get the content of the item at the specified location. +> This command can only be used through PowerShell. +> More information: . + +- Display the content of a file: + +`Get-Content -Path {{path o ile}}` + +- Display the first few lines of a file: + +`Get-Content -Path {{path o ile}} -TotalCount {{10}}` + +- Display the content of the file and keep reading from it until `Ctrl + C` is pressed: + +`Get-Content -Path {{path o ile}} -Wait` diff --git a/windows/get-date b/windows/get-date new file mode 100644 index 00000000..e9271480 --- /dev/null +++ b/windows/get-date @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Date + +> Gets the current date and time. +> This command can only be used through PowerShell. +> More information: . + +- Display the current date and time: + +`Get-Date` + +- Display the current date and time with a .NET format specifier: + +`Get-Date -Format "{{yyyy-MM-dd HH:mm:ss}}"` + +- Display the current date and time in UTC and ISO 8601 format: + +`(Get-Date).ToUniversalTime()` + +- Convert a Unix timestamp: + +`Get-Date -UnixTimeSeconds {{1577836800}}` diff --git a/windows/get-filehash b/windows/get-filehash new file mode 100644 index 00000000..4394a573 --- /dev/null +++ b/windows/get-filehash @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-FileHash + +> Calculate a hash for a file. +> This command can only be used through PowerShell. +> More information: . + +- Calculate a hash for a specified file using the SHA256 algorithm: + +`Get-FileHash {{path o ile}}` + +- Calculate a hash for a specified file using a specified algorithm: + +`Get-FileHash {{path o ile}} -Algorithm {{SHA1|SHA384|SHA256|SHA512|MD5}}` diff --git a/windows/get-help b/windows/get-help new file mode 100644 index 00000000..e6c2be04 --- /dev/null +++ b/windows/get-help @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Help + +> Display help information and documentation for PowerShell commands (aliases, cmdlets, and functions). +> This command can only be run through PowerShell. +> More information: . + +- Display general help information for a specific PowerShell command: + +`Get-Help {{command}}` + +- Display a more detailed documentation for a specific PowerShell command: + +`Get-Help {{command}} -Detailed` + +- Display the full technical documentation for a specific PowerShell command: + +`Get-Help {{command}} -Full` + +- Print only the documentation for a specific parameter of the PowerShell command (use `*` to show all parameters), if available: + +`Get-Help {{command}} -Parameter {{parameter}}` + +- Print only the examples of the cmdlet, if available: + +`Get-Help {{command}} -Examples` + +- List all available cmdlet help pages: + +`Get-Help *` + +- Update the current help and documentation knowledge base using `Update-Help`: + +`Update-Help` + +- View an online version of PowerShell command documentation in the default web browser: + +`Get-Help {{command}} -Online` diff --git a/windows/get-history b/windows/get-history new file mode 100644 index 00000000..1b6e2d0e --- /dev/null +++ b/windows/get-history @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-History + +> Display PowerShell command history. +> This command can only be used through PowerShell. +> More information: . + +- Display the commands history list with ID: + +`Get-History` + +- Get PowerShell history item by ID: + +`Get-History -Id {{id}}` + +- Display the last N commands: + +`Get-History -Count {{10}}` diff --git a/windows/get-location b/windows/get-location new file mode 100644 index 00000000..b9770e62 --- /dev/null +++ b/windows/get-location @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-Location + +> Print name of current/working directory. +> This command can only be run through PowerShell. +> More information: . + +- Print the current directory: + +`Get-Location` diff --git a/windows/get-wuapiversion b/windows/get-wuapiversion new file mode 100644 index 00000000..6bf29078 --- /dev/null +++ b/windows/get-wuapiversion @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-WUApiVersion + +> Get the Windows Update Agent version. Part of external `PSWindowsUpdate` module. +> This command can only be run under PowerShell. +> More information: . + +- Get the currently-installed Windows Update Agent version: + +`Get-WUApiVersion` + +- Send the current configuration data via email (SMTP): + +`Get-WUApiVersion -SendReport -PSWUSettings @{SmtpServer="{{smtp_server}}"; Port={{smtp_port}} From="{{sender_email}}" To="{{receiver_email}}"}` diff --git a/windows/get-wuhistory b/windows/get-wuhistory new file mode 100644 index 00000000..72cf318e --- /dev/null +++ b/windows/get-wuhistory @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-WUHistory + +> Get the history of installed updates from Windows Update. Part of external `PSWindowsUpdate` module. +> This command can only be run under PowerShell. +> More information: . + +- Get list of update history: + +`Get-WUHistory` + +- List the last 10 installed updates: + +`Get-WUHistory -Last {{10}}` + +- List all updates installed from a specific date to today: + +`Get-WUHistory -MaxDate {{date}}` + +- List all updates installed in the past 24 hours: + +`Get-WUHistory -MaxDate (Get-Date).AddDays(-1)` + +- Send the results via email (SMTP): + +`Get-WUHistory -SendReport -PSWUSettings @{SmtpServer="{{smtp_server}}"; Port={{smtp_port}} From="{{sender_email}}" To="{{receiver_email}}"}` diff --git a/windows/get-wusettings b/windows/get-wusettings new file mode 100644 index 00000000..a236dfef --- /dev/null +++ b/windows/get-wusettings @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Get-WUSettings + +> Get the current Windows Update Agent configuration. Part of external `PSWindowsUpdate` module. +> This command can only be run under PowerShell. +> More information: . + +- Get the current Windows Update Agent configuration: + +`Get-WUSettings` + +- Send the current configuration data via email (SMTP): + +`Get-WUSettings -SendReport -PSWUSettings @{SmtpServer="{{smtp_server}}"; Port={{smtp_port}} From="{{sender_email}}" To="{{receiver_email}}"}` diff --git a/windows/getmac b/windows/getmac new file mode 100644 index 00000000..ed2fa2f8 --- /dev/null +++ b/windows/getmac @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# getmac + +> Display the MAC addresses of a system. +> More information: . + +- Display the MAC addresses for the current system: + +`getmac` + +- Display the details in a specific format: + +`getmac /fo {{table|list|csv}}` + +- Exclude the header in the output list: + +`getmac /nh` + +- Display the MAC addresses for a remote machine: + +`getmac /s {{hostname}} /u {{username}} /p {{password}}` + +- Display the MAC addresses with verbose information: + +`getmac /v` + +- Display help: + +`getmac /?` diff --git a/windows/gl b/windows/gl new file mode 100644 index 00000000..fafed9fb --- /dev/null +++ b/windows/gl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# gl + +> In PowerShell, this command is an alias of `Get-Location`. +> More information: . + +- View documentation for the original command: + +`tldr get-location` diff --git a/windows/gpupdate b/windows/gpupdate new file mode 100644 index 00000000..ae6e57fe --- /dev/null +++ b/windows/gpupdate @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# gpupdate + +> A tool to check and apply Windows Group Policy settings. +> More information: . + +- Check and apply updated Group Policy settings: + +`gpupdate` + +- Specify the target Group Policy settings to check for update: + +`gpupdate /target:{{computer|user}}` + +- Force all Group Policy settings to be reapplied: + +`gpupdate /force` + +- Display help: + +`gpupdate /?` diff --git a/windows/if b/windows/if new file mode 100644 index 00000000..a2c6b038 --- /dev/null +++ b/windows/if @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# if + +> Performs conditional processing in batch scripts. +> More information: . + +- Execute the specified commands if the condition is true: + +`if {{condition}} ({{echo Condition is true}})` + +- Execute the specified commands if the condition is false: + +`if not {{condition}} ({{echo Condition is true}})` + +- Execute the first specified commands if the condition is true otherwise execute the second specified commands: + +`if {{condition}} ({{echo Condition is true}}) else ({{echo Condition is false}})` + +- Check whether `%errorlevel%` is greater than or equal to the specified exit code: + +`if errorlevel {{2}} ({{echo Condition is true}})` + +- Check whether two strings are equal: + +`if %{{variable}}% == {{string}} ({{echo Condition is true}})` + +- Check whether two strings are equal without respecting letter case: + +`if /i %{{variable}}% == {{string}} ({{echo Condition is true}})` + +- Check whether a file exist: + +`if exist {{path o ile}} ({{echo Condition is true}})` diff --git a/windows/install-module b/windows/install-module new file mode 100644 index 00000000..56e51618 --- /dev/null +++ b/windows/install-module @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Install-Module + +> Install PowerShell modules from PowerShell Gallery, NuGet, and other repositories. +> More information: . + +- Install a module, or update it to the latest available version: + +`Install-Module {{module}}` + +- Install a module with a specific version: + +`Install-Module {{module}} -RequiredVersion {{version}}` + +- Install a module no earlier than a specific version: + +`Install-Module {{module}} -MinimumVersion {{version}}` + +- Specify a range of supported versions (inclusive) of the required module: + +`Install-Module {{module}} -MinimumVersion {{minimum_version}} -MaximumVersion {{maximum_version}}` + +- Install module from a specific repository: + +`Install-Module {{module}} -Repository {{repository}}` + +- Install module from specific repositories: + +`Install-Module {{module}} -Repository {{repository1 , repository2 , ...}}` + +- Install the module for all/current user: + +`Install-Module {{module}} -Scope {{AllUsers|CurrentUser}}` + +- Perform a dry run to determine which modules will be installed, upgraded, or removed through `Install-Module`: + +`Install-Module {{module}} -WhatIf` diff --git a/windows/invoke-item b/windows/invoke-item new file mode 100644 index 00000000..d3e2da06 --- /dev/null +++ b/windows/invoke-item @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Invoke-Item + +> Open files in their respective default programs. +> This command can only be used through PowerShell. +> More information: . + +- Open a file in its default program: + +`Invoke-Item -Path {{path o ile}}` + +- Open all files inside a directory: + +`Invoke-Item -Path {{path o\directory}}\*` + +- Open all PNGs inside a directory: + +`Invoke-Item -Path {{path o\directory}}\*.png` + +- Open all files inside a directory containing a specific keyword: + +`Invoke-Item -Path {{path o\directory}}\* -Include {{*keyword*}}` + +- Open all files inside a directory except those containing a specific keyword: + +`Invoke-Item -Path {{path o\directory}}\* -Exclude {{*keyword*}}` + +- Perform a dry run to determine which files will be opened inside a directory through `Invoke-Item`: + +`Invoke-Item -Path {{path o\directory}}\* -WhatIf` diff --git a/windows/invoke-webrequest b/windows/invoke-webrequest new file mode 100644 index 00000000..3dbcb11d --- /dev/null +++ b/windows/invoke-webrequest @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Invoke-WebRequest + +> Performs a HTTP/HTTPS request to the Web. +> This command can only be used through PowerShell. +> More information: . + +- Download the contents of a URL to a file: + +`Invoke-WebRequest {{http://example.com}} -OutFile {{path o ile}}` + +- Send form-encoded data (POST request of type `application/x-www-form-urlencoded`): + +`Invoke-WebRequest -Method Post -Body @{ name='bob' } {{http://example.com/form}}` + +- Send a request with an extra header, using a custom HTTP method: + +`Invoke-WebRequest -Headers {{@{ X-My-Header = '123' }}} -Method {{PUT}} {{http://example.com}}` + +- Send data in JSON format, specifying the appropriate content-type header: + +`Invoke-WebRequest -Body {{'{"name":"bob"}'}} -ContentType 'application/json' {{http://example.com/users/1234}}` + +- Pass a username and password for server authentication: + +`Invoke-WebRequest -Headers @{ Authorization = "Basic "+ [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes("myusername:mypassword")) } {{http://example.com}}` diff --git a/windows/ipconfig b/windows/ipconfig new file mode 100644 index 00000000..96fb4435 --- /dev/null +++ b/windows/ipconfig @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ipconfig + +> Display and manage the network configuration of Windows. +> More information: . + +- List all network adapters: + +`ipconfig` + +- Show a detailed list of network adapters: + +`ipconfig /all` + +- Renew the IP addresses for a network adapter: + +`ipconfig /renew {{adapter}}` + +- Free up the IP addresses for a network adapter: + +`ipconfig /release {{adapter}}` + +- Show the local DNS cache: + +`ipconfig /displaydns` + +- Remove all data from the local DNS cache: + +`ipconfig /flushdns` diff --git a/windows/iscc b/windows/iscc new file mode 100644 index 00000000..b7e1b941 --- /dev/null +++ b/windows/iscc @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# iscc + +> Compiler for Inno Setup installers. +> It compiles an Inno Setup scripts into an Windows installer executable. +> More information: . + +- Compile an Inno Setup script: + +`iscc {{path o ile.iss}}` + +- Quietly compile an Inno Setup installer: + +`iscc /Q {{path o ile.iss}}` + +- Compile a signed Inno Setup installer: + +`iscc /S={{name}}={{command}} {{path o ile.iss}}` diff --git a/windows/iwr b/windows/iwr new file mode 100644 index 00000000..64fc1b0a --- /dev/null +++ b/windows/iwr @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# iwr + +> In PowerShell, this command is an alias of `Invoke-WebRequest`. +> More information: . + +- View documentation for the original command: + +`tldr invoke-webrequest` diff --git a/windows/logoff b/windows/logoff new file mode 100644 index 00000000..27316a25 --- /dev/null +++ b/windows/logoff @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# logoff + +> Terminate a login session. +> More information: . + +- Terminate the current session: + +`logoff` + +- Terminate a session by its name or id: + +`logoff {{session_name|session_id}}` + +- Terminate a session on a specific server connected through RDP: + +`logoff {{session_name|session_id}} /server:{{servername}}` diff --git a/windows/measure-command b/windows/measure-command new file mode 100644 index 00000000..346f1744 --- /dev/null +++ b/windows/measure-command @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Measure-Command + +> Measures the time it takes to run script blocks and cmdlets. +> This command can only be used through PowerShell. +> More information: . + +- Measure the time it takes to run a command: + +`Measure-Command { {{command}} }` + +- Pipe input to Measure-Command (objects that are piped to `Measure-Command` are available to the script block that is passed to the Expression parameter): + +`10, 20, 50 | Measure-Command -Expression { for ($i=0; $i -lt $_; $i++) {$i} }` diff --git a/windows/measure-object b/windows/measure-object new file mode 100644 index 00000000..765919af --- /dev/null +++ b/windows/measure-object @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Measure-Object + +> Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text. +> This command can only be used through PowerShell. +> More information: . + +- Count the files and folders in a directory: + +`Get-ChildItem | Measure-Object` + +- Pipe input to Measure-Command (objects that are piped to `Measure-Command` are available to the script block that is passed to the Expression parameter): + +`"One", "Two", "Three", "Four" | Set-Content -Path "{{path o ile}}"; Get-Content "{{path o ile}}"; | Measure-Object -Character -Line -Word` diff --git a/windows/mi b/windows/mi new file mode 100644 index 00000000..401c9c0d --- /dev/null +++ b/windows/mi @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# mi + +> In PowerShell, this command is an alias of `Move-Item`. +> More information: . + +- View documentation for the original command: + +`tldr move-item` diff --git a/windows/mkdir b/windows/mkdir new file mode 100644 index 00000000..aa04de70 --- /dev/null +++ b/windows/mkdir @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# mkdir + +> Creates a directory. +> More information: . + +- Create a directory: + +`mkdir {{path o\directory}}` + +- Create a nested directory tree recursively: + +`mkdir {{path o\sub_directory}}` diff --git a/windows/mklink b/windows/mklink new file mode 100644 index 00000000..3cd1b4d7 --- /dev/null +++ b/windows/mklink @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# mklink + +> Create symbolic links. +> More information: . + +- Create a symbolic link to a file: + +`mklink {{path o\link_file}} {{path o\source_file}}` + +- Create a symbolic link to a directory: + +`mklink /d {{path o\link_file}} {{path o\source_directory}}` + +- Create a hard link to a file: + +`mklink /h {{path o\link_file}} {{path o\source_file}}` + +- Create a directory junction: + +`mklink /j {{path o\link_file}} {{path o\source_file}}` diff --git a/windows/more b/windows/more new file mode 100644 index 00000000..35b0980a --- /dev/null +++ b/windows/more @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# more + +> Display paginated output from `stdin` or a file. +> More information: . + +- Display paginated output from `stdin`: + +`{{echo test}} | more` + +- Display paginated output from one or more files: + +`more {{path o ile}}` + +- Convert tabs to the specified number of spaces: + +`more {{path o ile}} /t{{spaces}}` + +- Clear the screen before displaying the page: + +`more {{path o ile}} /c` + +- Display the output starting at line 5: + +`more {{path o ile}} +{{5}}` + +- Enable extended interactive mode (see help for usage): + +`more {{path o ile}} /e` + +- Display help: + +`more /?` diff --git a/windows/mount b/windows/mount new file mode 100644 index 00000000..b9ab1cf6 --- /dev/null +++ b/windows/mount @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# mount + +> Mount Network File System (NFS) network shares. +> More information: . + +- Mount a share to the "Z" drive letter: + +`mount \{{computer_name}}\{{share_name}} {{Z:}}` + +- Mount a share to the next available drive letter: + +`mount \{{computer_name}}\{{share_name}} *` + +- Mount a share with a read timeout in seconds (defaults to 0.8, can be 0.9 or 1 to 60): + +`mount -o timeout={{seconds}} \{{computer_name}}\{{share_name}} {{Z:}}` + +- Mount a share and retry up to 10 times if it fails: + +`mount -o retry={{retries}} \{{computer_name}}\{{share_name}} {{Z:}}` + +- Mount a share with forced case sensitivity: + +`mount -o casesensitive \{{computer_name}}\{{share_name}} {{Z:}}` + +- Mount a share as an anonymous user: + +`mount -o anon \{{computer_name}}\{{share_name}} {{Z:}}` + +- Mount a share using a specific mount type: + +`mount -o mtype={{soft|hard}} \{{computer_name}}\{{share_name}} {{Z:}}` diff --git a/windows/move b/windows/move new file mode 100644 index 00000000..73c3fd64 --- /dev/null +++ b/windows/move @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# move + +> Move or rename files and directories. +> In PowerShell, this command is an alias of `Move-Item`. This documentation is based on the Command Prompt (`cmd`) version of `move`. +> More information: . + +- View documentation of the equivalent PowerShell command: + +`tldr move-item` + +- Rename a file or directory when the target is not an existing directory: + +`move {{path o\source}} {{path o arget}}` + +- Move a file or directory into an existing directory: + +`move {{path o\source}} {{path oxisting_directory}}` + +- Move a file or directory across drives: + +`move {{C:\path o\source}} {{D:\path o arget}}` + +- Do not prompt for confirmation before overwriting existing files: + +`move /Y {{path o\source}} {{path oxisting_directory}}` + +- Prompt for confirmation before overwriting existing files, regardless of file permissions: + +`move /-Y {{path o\source}} {{path oxisting_directory}}` diff --git a/windows/move-item b/windows/move-item new file mode 100644 index 00000000..11a657f0 --- /dev/null +++ b/windows/move-item @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Move-Item + +> Move or rename files, directories, registry keys, and other PowerShell data items. +> This command can only be run through PowerShell. +> More information: . + +- Rename a file or directory when the target is not an existing directory: + +`Move-Item {{path o\source}} {{path o arget}}` + +- Move a file or directory into an existing directory: + +`Move-Item {{path o\source}} {{path oxisting_directory}}` + +- Rename or move file(s) with specific name (do not treat special characters inside strings): + +`Move-Item -LiteralPath "{{path o\source}}" {{path o ile_or_directory}}` + +- Move multiple files into an existing directory, keeping the filenames unchanged: + +`Move-Item {{path o\source1 , path o\source2 ...}} {{path oxisting_directory}}` + +- Move or rename registry key(s): + +`Move-Item {{path o\source_key1 , path o\source_key2 ...}} {{path o +ew_or_existing_key}}` + +- Do not prompt for confirmation before overwriting existing files or registry keys: + +`mv -Force {{path o\source}} {{path o arget}}` + +- Prompt for confirmation before overwriting existing files, regardless of file permissions: + +`mv -Confirm {{path o\source}} {{path o arget}}` + +- Move files in dry-run mode, showing files and directories which could be moved without executing them: + +`mv -WhatIf {{path o\source}} {{path o arget}}` diff --git a/windows/msg b/windows/msg new file mode 100644 index 00000000..c9f69f60 --- /dev/null +++ b/windows/msg @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# msg + +> Send a message to a user or session. +> More information: . + +- Send a message to a specified user or session: + +`msg {{username|session_name|session_id}} {{message}}` + +- Send a message from `stdin`: + +`echo "{{message}}" | msg {{username|session_name|session_id}}` + +- Send a message to a specific server: + +`msg /server:{{server_name}} {{username|session_name|session_id}}` + +- Send a message to all users of the current machine: + +`msg *` + +- Set a delay in seconds for a message: + +`msg /time:{{10}}` diff --git a/windows/msiexec b/windows/msiexec new file mode 100644 index 00000000..60ab736a --- /dev/null +++ b/windows/msiexec @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# msiexec + +> Install, update, repair, or uninstall Windows programs using MSI and MSP package files. +> More information: . + +- Install a program from its MSI package: + +`msiexec /package {{path o ile.msi}}` + +- Install a MSI package from a website: + +`msiexec /package {{https://example.com/installer.msi}}` + +- Install a MSP patch file: + +`msiexec /update {{path o ile.msp}}` + +- Uninstall a program or patch using their respective MSI or MSP file: + +`msiexec /uninstall {{path o ile}}` diff --git a/windows/mv b/windows/mv new file mode 100644 index 00000000..cedd662c --- /dev/null +++ b/windows/mv @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# mv + +> In PowerShell, this command is an alias of `Move-Item`. +> However, this command is not available on the Command Prompt (`cmd`). Use `move` instead for similar functionality. +> More information: . + +- View documentation for the equivalent Command Prompt command: + +`tldr move` + +- View documentation for the original PowerShell command: + +`tldr move-item` diff --git a/windows/net b/windows/net new file mode 100644 index 00000000..4d7df5b7 --- /dev/null +++ b/windows/net @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# net + +> System utility to view and modify network-related settings. +> More information: . + +- Start or stop a Windows service synchronously: + +`net {{start|stop}} {{service}}` + +- Make sure an SMB share is available in the current console: + +`net use {{\smb_shared_folder}} /USER:{{username}}` + +- Show the folders currently shared over SMB: + +`net share` + +- Show who is using your SMB shares (run in elevated console): + +`net session` + +- Show users in a local security group: + +`net localgroup "{{Administrators}}"` + +- Add a user to the local security group (run in elevated console): + +`net localgroup "{{Administrators}}" {{username}} /add` + +- Display help for a subcommand: + +`net help {{subcommand}}` + +- Display help: + +`net help` diff --git a/windows/netsh-interface-portproxy b/windows/netsh-interface-portproxy new file mode 100644 index 00000000..aa5b2cab --- /dev/null +++ b/windows/netsh-interface-portproxy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# netsh interface portproxy + +> Configure and display the status of various network components. +> More information: . + +- Display the current port forwarding setup: + +`netsh interface portproxy show all` + +- Set up IPv4 port forwarding (run in elevated console): + +`netsh interface portproxy add v4tov4 listenaddress={{192.168.0.1}} listenport={{8080}} connectaddress={{10.0.0.1}} connectport={{80}}` + +- Remove IPv4 port forwarding (run in elevated console): + +`netsh interface portproxy delete v4tov4 listenaddress={{192.168.0.1}} listenport={{8080}}` + +- Display help: + +`netsh interface portproxy` diff --git a/windows/netstat b/windows/netstat new file mode 100644 index 00000000..fbfca761 --- /dev/null +++ b/windows/netstat @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# netstat + +> Displays active TCP connections, ports on which the computer is listening, network adapter statistics, the IP routing table, IPv4 statistics and IPv6 statistics. +> More information: . + +- Display active TCP connections: + +`netstat` + +- Display all active TCP connections and the TCP and UDP ports on which the computer is listening: + +`netstat -a` + +- Display network adapter statistics, such as the number of bytes and packets sent and received: + +`netstat -e` + +- Display active TCP connections and express addresses and port numbers numerically: + +`netstat -n` + +- Display active TCP connections and include the process ID (PID) for each connection: + +`netstat -o` + +- Display the contents of the IP routing table: + +`netstat -r` + +- Display statistics by protocol: + +`netstat -s` + +- Display a list of currently open ports and related IP addresses: + +`netstat -an` diff --git a/windows/new-item b/windows/new-item new file mode 100644 index 00000000..66d61120 --- /dev/null +++ b/windows/new-item @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# New-Item + +> Create a new file, directory, symbolic link, or a registry entry. +> This command can only be used through PowerShell. +> More information: . + +- Create a new blank file (equivalent to `touch`): + +`New-Item {{path o ile}}` + +- Create a new directory: + +`New-Item -ItemType Directory {{path o\directory}}` + +- Write a new text file with specified content: + +`New-Item {{path o ile}} -Value {{content}}` + +- Write the same text file in multiple locations: + +`New-Item {{path o ile1 , path o ile2 , ...}} -Value {{content}}` + +- Create a symbolic link\hard link\junction to a file or directory: + +`New-Item -ItemType {{SymbolicLink|HardLink|Junction}} -Path {{path o\link_file}} -Target {{path o\source_file_or_directory}}` + +- Create a new blank registry entry (in REG_SZ, use `New-ItemProperty` or `Set-ItemProperty` to fine-tune the value type): + +`New-Item {{path o egistry_key}}` + +- Create a new blank registry entry with specified value: + +`New-Item {{path o egistry_key}} -Value {{value}}` diff --git a/windows/nfsstat b/windows/nfsstat new file mode 100644 index 00000000..df012c49 --- /dev/null +++ b/windows/nfsstat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# nfsstat + +> Display or reset the number of calls made to the NFS server. +> More information: . + +- Display the recorded number of calls made to the NFS server: + +`nfsstat` + +- Reset the recorded number of calls made to the NFS server: + +`nfsstat -z` diff --git a/windows/ni b/windows/ni new file mode 100644 index 00000000..a5550e6a --- /dev/null +++ b/windows/ni @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ni + +> In PowerShell, this command is an alias of `New-Item`. +> More information: . + +- View documentation for the original command: + +`tldr new-item` diff --git a/windows/nvm b/windows/nvm new file mode 100644 index 00000000..7c64819b --- /dev/null +++ b/windows/nvm @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# nvm + +> Install, uninstall, or switch between Node.js versions. +> Supports version numbers like "12.8" or "v16.13.1", and labels like "stable", "system", etc. +> More information: . + +- Install a specific version of Node.js: + +`nvm install {{node_version}}` + +- Set the default version of Node.js (must be run as Administrator): + +`nvm use {{node_version}}` + +- List all available Node.js versions and highlight the default one: + +`nvm list` + +- List all remote Node.js versions: + +`nvm ls-remote` + +- Uninstall a given Node.js version: + +`nvm uninstall {{node_version}}` diff --git a/windows/octo b/windows/octo new file mode 100644 index 00000000..61021bdf --- /dev/null +++ b/windows/octo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# octo + +> Command-line tools for Octopus Deploy. +> More information: . + +- Create a package: + +`octo pack --id={{package}}` + +- Push a package to a repository on the Octopus server: + +`octo push --package={{package}}` + +- Create a release: + +`octo create-release --project={{project_name}} --packageversion={{version}}` + +- Deploy a release: + +`octo deploy-release --project={{project_name}} --packageversion={{version}} --deployto={{environment_name}} --tenant={{deployment_target}}` diff --git a/windows/out-string b/windows/out-string new file mode 100644 index 00000000..ffbdd10a --- /dev/null +++ b/windows/out-string @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Out-String + +> Outputs input objects as a string. +> This command can only be used through PowerShell. +> More information: . + +- Print host information as string: + +`Get-Alias | Out-String` + +- Convert each object to a string rather than concatenating all the objects into a single string: + +`Get-Alias | Out-String -Stream` + +- Use the `Width` parameter to prevent truncation: + +`@{TestKey = ('x' * 200)} | Out-String -Width {{250}}` diff --git a/windows/pabcnetcclear b/windows/pabcnetcclear new file mode 100644 index 00000000..eed6667b --- /dev/null +++ b/windows/pabcnetcclear @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pabcnetcclear + +> Preprocess and compile PascalABC.NET source files. +> More information: . + +- Compile the specified source file into an executable with the same name: + +`pabcnetcclear {{path o\source_file.pas}}` + +- Compile the specified source file into an executable with the specified name: + +`pabcnetcclear /Output:{{path o\_file.exe}} {{path o\source_file.pas}}` + +- Compile the specified source file into an executable with the same name along with/without debug information: + +`pabcnetcclear /Debug:{{0|1}} {{path o\source_file.pas}}` + +- Allow units to be searched in the specified path while compiling the source file into an executable with the same name: + +`pabcnetcclear /SearchDir:{{path o\directory}} {{path o\source_file.pas}}` + +- Compile the specified source file into an executable, defining a symbol: + +`pabcnetcclear /Define:{{symbol}} {{path o\source_file.pas}}` diff --git a/windows/path b/windows/path new file mode 100644 index 00000000..24608a38 --- /dev/null +++ b/windows/path @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# path + +> Display or set the search path for executable files. +> More information: . + +- Display the current path: + +`path` + +- Set the path to one or more semicolon-separated directories: + +`path {{path o\directory1 path o\directory2 ...}}` + +- Append a new directory to the original path: + +`path {{path o\directory}};%path%` + +- Set command prompt to only search the current directory for executables: + +`path ;` diff --git a/windows/pathping b/windows/pathping new file mode 100644 index 00000000..6c79e197 --- /dev/null +++ b/windows/pathping @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pathping + +> A trace route tool combining features of `ping` and `tracert`. +> More information: . + +- Ping and trace the route to a host: + +`pathping {{hostname}}` + +- Do not perform reverse lookup of IP address to hostname: + +`pathping {{hostname}} -n` + +- Specify the maximum number of hops to search for the target (the default is 30): + +`pathping {{hostname}} -h {{max_hops}}` + +- Specify the milliseconds to wait between pings (the default is 240): + +`pathping {{hostname}} -p {{time}}` + +- Specify the number of queries per hop (the default is 100): + +`pathping {{hostname}} -q {{queries}}` + +- Force IPV4 usage: + +`pathping {{hostname}} -4` + +- Force IPV6 usage: + +`pathping {{hostname}} -6` + +- Display help: + +`pathping /?` diff --git a/windows/pipwin b/windows/pipwin new file mode 100644 index 00000000..28aa3cce --- /dev/null +++ b/windows/pipwin @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pipwin + +> A tool to install unofficial Python package binaries on Windows. +> More information: . + +- List all available packages for download: + +`pipwin list` + +- Search packages: + +`pipwin search {{partial_name|name}}` + +- Install a package: + +`pipwin install {{package}}` + +- Uninstall a package: + +`pipwin uninstall {{package}}` + +- Download a package to a specific directory: + +`pipwin download --dest {{path o\directory}} {{package}}` + +- Install packages according to `requirements.txt`: + +`pipwin install --file {{path o equirements.txt}}` diff --git a/windows/popd b/windows/popd new file mode 100644 index 00000000..75b99f55 --- /dev/null +++ b/windows/popd @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# popd + +> Changes the current directory to the directory stored by the `pushd` command. +> More information: . + +- Switch to directory at the top of the stack: + +`popd` diff --git a/windows/powershell b/windows/powershell new file mode 100644 index 00000000..93fe0df8 --- /dev/null +++ b/windows/powershell @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# powershell + +> Command-line shell and scripting language designed especially for system administration. +> This command refers to PowerShell version 5.1 and below (also known as the legacy Windows PowerShell). To use the newer, cross-platform version of PowerShell (also known as PowerShell Core), use `pwsh` instead of `powershell`. +> More information: . + +- Start an interactive shell session: + +`powershell` + +- Start an interactive shell session without loading startup configs: + +`powershell -NoProfile` + +- Execute specific commands: + +`powershell -Command "{{echo 'powershell is executed'}}"` + +- Execute a specific script: + +`powershell -File {{path/to/script.ps1}}` + +- Start a session with a specific version of PowerShell: + +`powershell -Version {{version}}` + +- Prevent a shell from exit after running startup commands: + +`powershell -NoExit` + +- Describe the format of data sent to PowerShell: + +`powershell -InputFormat {{Text|XML}}` + +- Determine how an output from PowerShell is formatted: + +`powershell -OutputFormat {{Text|XML}}` diff --git a/windows/print b/windows/print new file mode 100644 index 00000000..408788d8 --- /dev/null +++ b/windows/print @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# print + +> Print a text file to a printer. +> More information: . + +- Print a text file to the default printer: + +`print {{path o ile}}` + +- Print a text file to a specific printer: + +`print /d:{{printer}} {{path o ile}}` diff --git a/windows/prompt b/windows/prompt new file mode 100644 index 00000000..3c710e68 --- /dev/null +++ b/windows/prompt @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# prompt + +> Change the default DOS style prompt in a command window. +> More information: . + +- Reset the prompt to the default setting: + +`prompt` + +- Set a specific prompt: + +`prompt {{prompt}}` + +- Change the prompt to show the current date first: + +`prompt $D $P$G` + +- Change the prompt to show the current time first: + +`prompt $T $P$G` + +- Change the prompt by adding a specific text first: + +`prompt {{text}} $P$G` diff --git a/windows/psexec b/windows/psexec new file mode 100644 index 00000000..3d04aaf1 --- /dev/null +++ b/windows/psexec @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# psexec + +> Execute a command-line process on a remote machine. +> This is an advanced command and it might potentially be dangerous. +> More information: . + +- Execute a command using `cmd` in a remote shell: + +`psexec \{{remote_host}} cmd` + +- Execute a command on a remote host (pre-authenticated): + +`psexec \{{remote_host}} -u {{user_name}} -p {{password}}` + +- Execute a command remotely and output the result to a file: + +`psexec \{{remote_host}} cmd /c {{command}} -an ^>{{path o ile.txt}}` + +- Execute a program to interact with users: + +`psexec \{{remote_host}} -d -i {{program_name}}` + +- Display the IP configuration of the remote host: + +`psexec \{{remote_host}} ipconfig /all` diff --git a/windows/psping b/windows/psping new file mode 100644 index 00000000..95a1c3c1 --- /dev/null +++ b/windows/psping @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# psping + +> A ping tool that includes TCP ping, latency and bandwidth measurement. +> More information: . + +- Ping a host using ICMP: + +`psping {{hostname}}` + +- Ping a host over a TCP port: + +`psping {{hostname}}:{{port}}` + +- Specify the number of pings and perform it quietly: + +`psping {{hostname}} -n {{pings}} -q` + +- Ping the target over TCP 50 times and produce a histogram of the results: + +`psping {{hostname}}:{{port}} -q -n {{50}} -h` + +- Display help: + +`psping /?` diff --git a/windows/psversiontable b/windows/psversiontable new file mode 100644 index 00000000..b0619aa4 --- /dev/null +++ b/windows/psversiontable @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# PSVersionTable + +> A read-only variable (as `$PSVersionTable`) to get the current PowerShell version. +> This command can only be run under PowerShell. +> More information: . + +- Print a summary of the currently installed PowerShell version and edition: + +`$PSVersionTable` + +- Get the detailed (major, minor, build, and revision) version number of PowerShell: + +`$PSVersionTable.PSVersion` + +- List all supported PowerShell script versions that this PowerShell version supports: + +`$PSVersionTable.PSCompatibleVersions` + +- Get the latest Git commit ID where the currently-installed PowerShell version is based on (works on PowerShell 6.0 and later): + +`$PSVersionTable.GitCommitId` + +- Check whether the user is running PowerShell Core (6.0 or later) or the original "Windows PowerShell" (version 5.1 or below): + +`$PSVersionTable.PSEdition` diff --git a/windows/pswindowsupdate b/windows/pswindowsupdate new file mode 100644 index 00000000..62923776 --- /dev/null +++ b/windows/pswindowsupdate @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# PSWindowsUpdate + +> A PowerShell external module to manage Windows Update. +> This tool provides multiple commands that all can only be run through PowerShell. +> More information: . + +- Install the module using `Install-Module`: + +`Install-Module PSWindowsUpdate` + +- List all commands available under the module: + +`Get-Command -Module PSWindowsUpdate` diff --git a/windows/pushd b/windows/pushd new file mode 100644 index 00000000..7dadac6d --- /dev/null +++ b/windows/pushd @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pushd + +> Place a directory on a stack so it can be accessed later. +> See also `popd` to switch back to original directory. +> More information: . + +- Switch to directory and push it on the stack: + +`pushd {{path o\directory}}` diff --git a/windows/pwd b/windows/pwd new file mode 100644 index 00000000..5ee19cfe --- /dev/null +++ b/windows/pwd @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pwd + +> In PowerShell, this command is an alias of `Get-Location`. +> However, this command is not available on the Command Prompt (`cmd`). Use `cd` instead for similar functionality. +> More information: . + +- View documentation for the equivalent Command Prompt command: + +`tldr cd` + +- View documentation for the original PowerShell command: + +`tldr get-location` diff --git a/windows/pwlauncher b/windows/pwlauncher new file mode 100644 index 00000000..5af90e0c --- /dev/null +++ b/windows/pwlauncher @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pwlauncher + +> Manage the Windows To Go startup options. +> More information: . + +- Display the current Windows To Go status: + +`pwlauncher` + +- Enable or disable the Windows To Go startup options: + +`pwlauncher /{{enable|disable}}` diff --git a/windows/pwsh-where b/windows/pwsh-where new file mode 100644 index 00000000..8f5eebae --- /dev/null +++ b/windows/pwsh-where @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# pwsh where + +> This command is an alias of `Where-Object`. +> More information: . + +- View documentation for the original command: + +`tldr Where-Object` diff --git a/windows/query b/windows/query new file mode 100644 index 00000000..6b811758 --- /dev/null +++ b/windows/query @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# query + +> Displays information about user sessions and process. +> More information: . + +- Display all user sessions: + +`query session` + +- Display the current user sessions on a remote computer: + +`query session /server:{{hostname}}` + +- Display logged in users: + +`query user` + +- Display all user sessions on a remote computer: + +`query session /server:{{hostname}}` + +- Display all running processes: + +`query process` + +- Display running processes by session or user name: + +`query process {{session_name|user_name}}` diff --git a/windows/rd b/windows/rd new file mode 100644 index 00000000..8acca1e8 --- /dev/null +++ b/windows/rd @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# rd + +> This command is an alias of `rmdir` on Command Prompt, and subsequently `Remove-Item` in PowerShell. +> More information: . + +- View documentation for the original Command Prompt command: + +`tldr rmdir` + +- View documentation for the original PowerShell command: + +`tldr remove-item` diff --git a/windows/rdpsign b/windows/rdpsign new file mode 100644 index 00000000..29fa31fb --- /dev/null +++ b/windows/rdpsign @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# rdpsign + +> A tool for signing Remote Desktop Protocol (RDP) files. +> More information: . + +- Sign an RDP file: + +`rdpsign {{path o ile.rdp}}` + +- Sign an RDP file using a specific sha256 hash: + +`rdpsign {{path o ile.rdp}} /sha265 {{hash}}` + +- Enable quiet output: + +`rdpsign {{path o ile.rdp}} /q` + +- Display verbose warnings, messages and statuses: + +`rdpsign {{path o ile.rdp}} /v` + +- Test the signing by displaying the output to `stdout` without updating the file: + +`rdpsign {{path o ile.rdp}} /l` diff --git a/windows/reg b/windows/reg new file mode 100644 index 00000000..30454b28 --- /dev/null +++ b/windows/reg @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg + +> Manage keys and their values in the Windows registry. +> Some subcommands such as `reg add` have their own usage documentation. +> More information: . + +- Execute a registry command: + +`reg {{command}}` + +- Display general information and list all available commands: + +`reg /?` + +- Display help for a specific command: + +`reg {{command}} /?` diff --git a/windows/reg-add b/windows/reg-add new file mode 100644 index 00000000..fb347646 --- /dev/null +++ b/windows/reg-add @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg add + +> Add new keys and their values to the registry. +> More information: . + +- Add a new registry key: + +`reg add {{key_name}}` + +- Add a new value under a specific key: + +`reg add {{key_name}} /v {{value}}` + +- Add a new value with specific data: + +`reg add {{key_name}} /d {{data}}` + +- Add a new value to a key with a specific data type: + +`reg add {{key_name}} /t {{type}}` + +- Forcefully overwrite the existing registry value without a prompt: + +`reg add {{key_name}} /f` diff --git a/windows/reg-compare b/windows/reg-compare new file mode 100644 index 00000000..477bcd57 --- /dev/null +++ b/windows/reg-compare @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg compare + +> Compare keys and their values in the registry. +> More information: . + +- Compare all values under a specific key with a second key: + +`reg compare {{first_key_name}} {{second_key_name}}` + +- Compare a specific value under two keys: + +`reg compare {{first_key_name}} {{second_key_name}} /v {{value}}` + +- Compare all sub keys and values for two keys: + +`reg compare {{first_key_name}} {{second_key_name}} /s` + +- Only output the matches between the specified keys: + +`reg compare {{first_key_name}} {{second_key_name}} /os` + +- Output the differences and matches between the specified keys: + +`reg compare {{first_key_name}} {{second_key_name}} /oa` diff --git a/windows/reg-copy b/windows/reg-copy new file mode 100644 index 00000000..6d3898df --- /dev/null +++ b/windows/reg-copy @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg copy + +> Copy keys and their values in the registry. +> More information: . + +- Copy a registry key to a new registry location: + +`reg copy {{old_key_name}} {{new_key_name}}` + +- Copy a registry key recursively to a new registry location: + +`reg copy {{old_key_name}} {{new_key_name}} /s` + +- Forcefully copy a registry key without a prompt: + +`reg copy {{old_key_name}} {{new_key_name}} /f` diff --git a/windows/reg-delete b/windows/reg-delete new file mode 100644 index 00000000..41db2836 --- /dev/null +++ b/windows/reg-delete @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg delete + +> Delete keys or their values from the registry. +> More information: . + +- Delete a specific registry key: + +`reg delete {{key_name}}` + +- Delete a value under a specific key: + +`reg delete {{key_name}} /v {{value}}` + +- Delete all values recursively under the specified key: + +`reg delete {{key_name}} /va` + +- Forcefully delete all values recursively under a key without a prompt: + +`reg delete {{key_name}} /f /va` diff --git a/windows/reg-export b/windows/reg-export new file mode 100644 index 00000000..b1420379 --- /dev/null +++ b/windows/reg-export @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg export + +> Export the specified sub keys and values into a file. +> More information: . + +- Export all sub keys and values of a specific key: + +`reg export {{key_name}} {{path o ile.reg}}` + +- Force overwriting of an existing file without prompt: + +`reg export {{key_name}} {{path o ile.reg}} /y` diff --git a/windows/reg-flags b/windows/reg-flags new file mode 100644 index 00000000..3f520fb3 --- /dev/null +++ b/windows/reg-flags @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg flags + +> Display or set flags on registry keys. +> More information: . + +- Display current flags for a specific key: + +`reg flags {{key_name}} query` + +- Set one or more flags, and unset unmentioned flags, for a specific key: + +`reg flags {{key_name}} set {{flag_name1 flag_name2 ...}}` + +- Set one or more flags for a specific key and its [s]ub keys: + +`reg flags {{key_name}} set {{flag_name1 flag_name2 ...}} /s` diff --git a/windows/reg-import b/windows/reg-import new file mode 100644 index 00000000..58d9b431 --- /dev/null +++ b/windows/reg-import @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg import + +> Import all available keys, subkeys, and values from a file. +> More information: . + +- Import all keys, subkeys and values from a file: + +`reg import {{path o ile.reg}}` diff --git a/windows/reg-load b/windows/reg-load new file mode 100644 index 00000000..b97e9009 --- /dev/null +++ b/windows/reg-load @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg load + +> Load saved sub keys into a different sub key in the registry. +> This is intended for troubleshooting and temporary keys. +> More information: . + +- Load a backup file into the specified key: + +`reg load {{key_name}} {{path o ile}}` diff --git a/windows/reg-query b/windows/reg-query new file mode 100644 index 00000000..fd9e3403 --- /dev/null +++ b/windows/reg-query @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg query + +> Display the values of keys and sub keys in the registry. +> More information: . + +- Display all values of a key: + +`reg query {{key_name}}` + +- Display a specific value of a key: + +`reg query {{key_name}} /v {{value}}` + +- Display all values of a key and its sub keys: + +`reg query {{key_name}} /s` + +- Search for keys and values matching a specific pattern: + +`reg query {{key_name}} /f "{{query_pattern}}"` + +- Display a value of a key matching a specified data type: + +`reg query {{key_name}} /t {{type}}` diff --git a/windows/reg-restore b/windows/reg-restore new file mode 100644 index 00000000..133bd58a --- /dev/null +++ b/windows/reg-restore @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg restore + +> Restore a key and its values from a backup file. +> See `reg-save` for more information. +> More information: . + +- Overwrite a specified key with data from a backup file: + +`reg restore {{key_name}} {{path o ile}}` diff --git a/windows/reg-save b/windows/reg-save new file mode 100644 index 00000000..2e8c0a28 --- /dev/null +++ b/windows/reg-save @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg save + +> Save a registry key, its sub keys and values to a file. +> More information: . + +- Save a registry key, its sub keys and values to a specific file: + +`reg save {{key_name}} {{path o ile}}` + +- Forcefully overwrite an existing file without a prompt: + +`reg save {{key_name}} {{path o ile}} /y` diff --git a/windows/reg-unload b/windows/reg-unload new file mode 100644 index 00000000..3011adc2 --- /dev/null +++ b/windows/reg-unload @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# reg unload + +> Remove data from the registry that was loaded using the `reg load` command. +> More information: . + +- Remove data from the registry for a specified key: + +`reg unload {{key_name}}` diff --git a/windows/remove-appxpackage b/windows/remove-appxpackage new file mode 100644 index 00000000..e9e5a3be --- /dev/null +++ b/windows/remove-appxpackage @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Remove-AppxPackage + +> A PowerShell utility to remove an app package from user accounts. +> More information: . + +- Remove an app package: + +`Remove-AppxPackage {{package}}` + +- Remove an app package for a specific user: + +`Remove-AppxPackage {{package}} -User {{username}}` + +- Remove an app package for all users: + +`Remove-AppxPackage {{package}} -AllUsers` + +- Remove an app package but preserve it's app data: + +`Remove-AppxPackage {{package}} -PreserveApplicationData` diff --git a/windows/remove-item b/windows/remove-item new file mode 100644 index 00000000..21b8b611 --- /dev/null +++ b/windows/remove-item @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Remove-Item + +> Delete files, folders, as well as registry keys and subkeys. +> This command can only be run through PowerShell. +> More information: . + +- Remove specific files or registry keys (without subkeys): + +`Remove-Item {{path o ile_or_key1 , path o ile_or_key2 ...}}` + +- Remove hidden or read-only files: + +`Remove-Item -Force {{path o ile1 , path o ile2 ...}}` + +- Remove specific files or registry keys interactively prompting before each removal: + +`Remove-Item -Confirm {{path o ile_or_key1 , path o ile_or_key2 ...}}` + +- Remove specific files and directories recursively (Windows 10 version 1909 or later): + +`Remove-Item -Recurse {{path o ile_or_directory1 , path o ile_or_directory2 ...}}` + +- Remove specific Windows registry keys and all its subkeys: + +`Remove-Item -Recurse {{path o\key1 , path o\key2 ...}}` + +- Perform a dry run of the deletion process: + +`Remove-Item -WhatIf {{path o ile1 , path o ile2 ...}}` diff --git a/windows/repair-bde b/windows/repair-bde new file mode 100644 index 00000000..671e57d3 --- /dev/null +++ b/windows/repair-bde @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# repair-bde + +> Attempt to repair or decrypt a damaged BitLocker-encrypted volume. +> More information: . + +- Attempt to repair a specified volume: + +`repair-bde {{C:}}` + +- Attempt to repair a specified volume and output to another volume: + +`repair-bde {{C:}} {{D:}}` + +- Attempt to repair a specified volume using the provided recovery key file: + +`repair-bde {{C:}} -RecoveryKey {{path o ile.bek}}` + +- Attempt to repair a specified volume using the provided numerical recovery password: + +`repair-bde {{C:}} -RecoveryPassword {{password}}` + +- Attempt to repair a specified volume using the provided password: + +`repair-bde {{C:}} -Password {{password}}` + +- Attempt to repair a specified volume using the provided key package: + +`repair-bde {{C:}} -KeyPackage {{path o\directory}}` + +- Log all output to a specific file: + +`repair-bde {{C:}} -LogFile {{path o ile}}` + +- Display help: + +`repair-bde /?` diff --git a/windows/replace b/windows/replace new file mode 100644 index 00000000..cb488493 --- /dev/null +++ b/windows/replace @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# replace + +> Replace files. +> See also: `robocopy`, `move`, `copy`, and `del`. +> More information: . + +- Replace the destination file with the one from the source directory: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}}` + +- Add files to the destination directory instead of replacing existing files: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /a` + +- Interactively copy multiple files, with a prompt before replacing or adding a destination file: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /p` + +- Replace even read only files: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /r` + +- Wait for you to insert a disk before it replaces files (originally to allow inserting a floppy disk): + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /w` + +- Replace all files in subdirectories of the destination: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /s` + +- Replace only files in the destination directory which are older than the files in the source directory: + +`replace {{path o ile_or_directory}} {{path o\destination_directory}} /u` + +- Display help: + +`replace /?` diff --git a/windows/resolve-path b/windows/resolve-path new file mode 100644 index 00000000..334d9858 --- /dev/null +++ b/windows/resolve-path @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Resolve-Path + +> Resolves the wildcard characters in a path, and displays the path contents. +> This command can only be used through PowerShell. +> More information: . + +- Resolve the home folder path: + +`Resolve-Path {{~}}` + +- Resolve a UNC path: + +`Resolve-Path -Path "\{{hostname}}\{{path o ile}}"` + +- Get relative paths: + +`Resolve-Path -Path {{path o ile_or_directory}} -Relative` diff --git a/windows/ri b/windows/ri new file mode 100644 index 00000000..6fdcc5c7 --- /dev/null +++ b/windows/ri @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ri + +> In PowerShell, this command is an alias of `Remove-Item`. +> More information: . + +- View documentation for the original command: + +`tldr remove-item` diff --git a/windows/rm b/windows/rm new file mode 100644 index 00000000..10a35718 --- /dev/null +++ b/windows/rm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# rm + +> In PowerShell, this command is an alias of `Remove-Item`. +> More information: . + +- View documentation for the original command: + +`tldr remove-item` diff --git a/windows/rmdir b/windows/rmdir new file mode 100644 index 00000000..c3d09883 --- /dev/null +++ b/windows/rmdir @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# rmdir + +> Remove a directory and its contents. +> In PowerShell, this command is an alias of `Remove-Item`. This documentation is based on the Command Prompt (`cmd`) version of `rmdir`. +> More information: . + +- View the documentation of the equivalent PowerShell command: + +`tldr remove-item` + +- Remove an empty directory: + +`rmdir {{path o\directory}}` + +- Remove a directory and its contents recursively: + +`rmdir {{path o\directory}} /s` + +- Remove a directory and its contents recursively without prompting: + +`rmdir {{path o\directory}} /s /q` diff --git a/windows/robocopy b/windows/robocopy new file mode 100644 index 00000000..4c3bec61 --- /dev/null +++ b/windows/robocopy @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# robocopy + +> Robust File and Folder Copy. +> By default files will only be copied if the source and destination have different time stamps or different file sizes. +> More information: . + +- Copy all `.jpg` and `.bmp` files from one directory to another: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} {{*.jpg}} {{*.bmp}}` + +- Copy all files and subdirectories, including empty ones: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} /E` + +- Mirror/Sync a directory, deleting anything not in source and include all attributes and permissions: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} /MIR /COPYALL` + +- Copy all files and subdirectories, excluding source files that are older than destination files: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} /E /XO` + +- List all files 50 MB or larger instead of copying them: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} /MIN:{{52428800}} /L` + +- Allow resuming if network connection is lost and limit retries to 5 and wait time to 15 sec: + +`robocopy {{path o\source_directory}} {{path o\destination_directory}} /Z /R:5 /W:15` + +- Display help: + +`robocopy /?` diff --git a/windows/rpcinfo b/windows/rpcinfo new file mode 100644 index 00000000..b10c3c65 --- /dev/null +++ b/windows/rpcinfo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# rpcinfo + +> List programs via RPC on remote computers. +> More information: . + +- List all programs registered on the local computer: + +`rpcinfo` + +- List all programs registered on a remote computer: + +`rpcinfo /p {{computer_name}}` + +- Call a specific program on a remote computer using TCP: + +`rpcinfo /t {{computer_name}} {{program_name}}` + +- Call a specific program on a remote computer using UDP: + +`rpcinfo /u {{computer_name}} {{program_name}}` diff --git a/windows/sc b/windows/sc new file mode 100644 index 00000000..c60a878b --- /dev/null +++ b/windows/sc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sc + +> Communicate with the Service Control Manager and services. +> More information: . + +- Show the status of a service (no service name will list all services): + +`sc.exe query {{service_name}}` + +- Start a service asynchronously: + +`sc.exe create {{service_name}} binpath= {{path o\service_binary_file}}` + +- Stop a service asynchronously: + +`sc.exe delete {{service_name}}` + +- Set the type of a service: + +`sc.exe config {{service_name}} type= {{service_type}}` diff --git a/windows/sc-config b/windows/sc-config new file mode 100644 index 00000000..59beb477 --- /dev/null +++ b/windows/sc-config @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sc config + +> This command is an alias of `sc.exe config`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/windows/sc-create b/windows/sc-create new file mode 100644 index 00000000..21897248 --- /dev/null +++ b/windows/sc-create @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sc create + +> This command is an alias of `sc.exe create`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/windows/sc-delete b/windows/sc-delete new file mode 100644 index 00000000..8a21a343 --- /dev/null +++ b/windows/sc-delete @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sc delete + +> This command is an alias of `sc.exe delete`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/windows/sc-query b/windows/sc-query new file mode 100644 index 00000000..5bd287c0 --- /dev/null +++ b/windows/sc-query @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sc query + +> This command is an alias of `sc.exe query`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/windows/scoop b/windows/scoop new file mode 100644 index 00000000..02232d1c --- /dev/null +++ b/windows/scoop @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# scoop + +> The Scoop package manager. +> More information: . + +- Install a package: + +`scoop install {{package}}` + +- Remove a package: + +`scoop uninstall {{package}}` + +- Update all installed packages: + +`scoop update --all` + +- List installed packages: + +`scoop list` + +- Display information about a package: + +`scoop info {{package}}` + +- Search for a package: + +`scoop search {{package}}` + +- Remove old versions of all packages and clear the download cache: + +`scoop cleanup --cache --all` diff --git a/windows/scoop-bucket b/windows/scoop-bucket new file mode 100644 index 00000000..59ff5c4f --- /dev/null +++ b/windows/scoop-bucket @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# scoop bucket + +> Manage buckets: Git repositories containing files which describe how scoop installs applications. +> If Scoop doesn't know where the bucket is located its repository location must be specified. +> More information: . + +- List all buckets currently in use: + +`scoop bucket list` + +- List all known buckets: + +`scoop bucket known` + +- Add a known bucket by its name: + +`scoop bucket add {{name}}` + +- Add an unknown bucket by its name and Git repository URL: + +`scoop bucket add {{name}} {{https://example.com/repository.git}}` + +- Remove a bucket by its name: + +`scoop bucket rm {{name}}` diff --git a/windows/select-string b/windows/select-string new file mode 100644 index 00000000..17e98bda --- /dev/null +++ b/windows/select-string @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Select-String + +> Finds text in strings and files in PowerShell. +> This command can only be used through PowerShell. +> You can use `Select-String` similar to `grep` in UNIX or `findstr.exe` in Windows. +> More information: . + +- Search for a pattern within a file: + +`Select-String -Path "{{path o ile}}" -Pattern '{{search_pattern}}'` + +- Search for an exact string (disables regular expressions): + +`Select-String -SimpleMatch "{{exact_string}}" {{path o ile}}` + +- Search for pattern in all `.ext` files in current dir: + +`Select-String -Path "{{*.ext}}" -Pattern '{{search_pattern}}'` + +- Capture the specified number of lines before and after the line that matches the pattern: + +`Select-String --Context {{2,3}} "{{search_pattern}}" {{path o ile}}` + +- Search `stdin` for lines that do not match a pattern: + +`Get-Content {{path o ile}} | Select-String --NotMatch "{{search_pattern}}"` diff --git a/windows/set b/windows/set new file mode 100644 index 00000000..7f1a0c2e --- /dev/null +++ b/windows/set @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# set + +> Display or set environment variables for the current instance of CMD. +> More information: . + +- List all current environment variables: + +`set` + +- Set an environment variable to a specific value: + +`set {{name}}={{value}}` + +- List environment variables starting with the specified string: + +`set {{name}}` + +- Prompt the user for a value for the specified variable: + +`set /p {{name}}={{prompt_string}}` diff --git a/windows/set-acl b/windows/set-acl new file mode 100644 index 00000000..0c774372 --- /dev/null +++ b/windows/set-acl @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-Acl + +> Changes the security descriptor of a specified item, such as a file or a registry key. +> This command can only be used through PowerShell. +> More information: . + +- Copy a security descriptor from one file to another: + +`$OriginAcl = Get-Acl -Path {{path o ile}}; Set-Acl -Path {{path o ile}} -AclObject $OriginAcl` + +- Use the pipeline operator to pass a descriptor: + +`Get-Acl -Path {{path o ile}} | Set-Acl -Path {{path o ile}}` diff --git a/windows/set-date b/windows/set-date new file mode 100644 index 00000000..71bd50c5 --- /dev/null +++ b/windows/set-date @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-Date + +> Changes the system time on the computer to a time that you specify. +> This command can only be used through PowerShell. +> More information: . + +- Add three days to the system date: + +`Set-Date -Date (Get-Date).AddDays({{3}})` + +- Set the system clock back 10 minutes: + +`Set-Date -Adjust -0:10:0 -DisplayHint Time` + +- Add 90 minutes to the system clock: + +`$90mins = New-TimeSpan -Minutes {{90}}; Set-Date -Adjust $90mins` diff --git a/windows/set-location b/windows/set-location new file mode 100644 index 00000000..9bb20656 --- /dev/null +++ b/windows/set-location @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-Location + +> Display the current working directory or move to a different directory. +> This command can only be used through PowerShell. +> More information: . + +- Go to the specified directory: + +`Set-Location {{path o\directory}}` + +- Go to a specific directory in a different drive: + +`Set-Location {{C}}:{{path o\directory}}` + +- Go and display the location of specified directory: + +`Set-Location {{path o\directory}} -PassThru` + +- Go up to the parent of the current directory: + +`Set-Location ..` + +- Go to the home directory of the current user: + +`Set-Location ~` + +- Go back/forward to the previously chosen directory: + +`Set-Location {{-|+}}` + +- Go to root of current drive: + +`Set-Location \` diff --git a/windows/set-service b/windows/set-service new file mode 100644 index 00000000..f0f59178 --- /dev/null +++ b/windows/set-service @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Set-Service + +> Starts, stops, and suspends a service, and changes its properties. +> This command can only be used through PowerShell. +> More information: . + +- Change a display name: + +`Set-Service -Name {{hostname}} -DisplayName "{{name}}"` + +- Change the startup type of services: + +`Set-Service -Name {{service_name}} -StartupType {{Automatic}}` + +- Change the description of a service: + +`Set-Service -Name {{service_name}} -Description "{{description}}"` diff --git a/windows/setx b/windows/setx new file mode 100644 index 00000000..f56dd006 --- /dev/null +++ b/windows/setx @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# setx + +> Sets persistent environment variables. +> More information: . + +- Set an environment variable for the current user: + +`setx {{variable}} {{value}}` + +- Set an environment variable for the current machine: + +`setx {{variable}} {{value}} /M` + +- Set an environment variable for a user on a remote machine: + +`setx /s {{hostname}} /u {{username}} /p {{password}} {{variable}} {{value}}` + +- Set an environment variable from a registry key value: + +`setx {{variable}} /k {{registry\key\path}}` diff --git a/windows/sfc b/windows/sfc new file mode 100644 index 00000000..a0b1c183 --- /dev/null +++ b/windows/sfc @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sfc + +> Scans the integrity of Windows system files. +> More information: . + +- Display information about the usage of the command: + +`sfc` + +- Scan all system files and, if possible, repair any problems: + +`sfc /scannow` + +- Scan all system files without attempting to repair any: + +`sfc /verifyonly` + +- Scan a specific file and, if possible, repair any problems: + +`sfc /scanfile={{path o ile}}` + +- Scan a specific file without attempting to repair it: + +`sfc /verifyfile={{path o ile}}` + +- When repairing offline, specify the boot directory: + +`sfc /offbootdir={{path o\directory}}` + +- When repairing offline, specify the Windows directory: + +`sfc /offwindir={{path o\directory}}` diff --git a/windows/show-markdown b/windows/show-markdown new file mode 100644 index 00000000..d6e817e9 --- /dev/null +++ b/windows/show-markdown @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Show-Markdown + +> Shows a Markdown file or string in the console in a friendly way using VT100 escape sequences or in a browser using HTML. +> This command can only be used through PowerShell. +> More information: . + +- Render markdown to console from a file: + +`Show-Markdown -Path {{path o ile}}` + +- Render markdown to console from string: + +`{{"# Markdown content"}} | Show-Markdown` + +- Open Markdown file in a browser: + +`Show-Markdown -Path {{path o ile}} -UseBrowser` diff --git a/windows/showmount b/windows/showmount new file mode 100644 index 00000000..65e30a66 --- /dev/null +++ b/windows/showmount @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# showmount + +> Display information about NFS filesystems on Windows Server. +> More information: . + +- Display all exported filesystems: + +`showmount -e` + +- Display all NFS clients and their mounted directories: + +`showmount -a` + +- Display all NFS mounted directories: + +`showmount -d` + +- Display all exported filesystems for a remote server: + +`showmount -e {{server_address}}` diff --git a/windows/shutdown b/windows/shutdown new file mode 100644 index 00000000..6fbe8c45 --- /dev/null +++ b/windows/shutdown @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# shutdown + +> A tool for shutting down, restarting or logging off a machine. +> More information: . + +- Shutdown the current machine: + +`shutdown /s` + +- Shutdown the current machine force-closing all apps: + +`shutdown /s /f` + +- Restart the current machine immediately: + +`shutdown /r /t 0` + +- Hibernate the current machine: + +`shutdown /h` + +- Log off the current machine: + +`shutdown /l` + +- Specify a timeout in seconds to wait before shutting down: + +`shutdown /s /t {{8}}` + +- Abort a shutdown sequence whose timeout is yet to expire: + +`shutdown /a` + +- Shutdown a remote machine: + +`shutdown /m {{\hostname}}` diff --git a/windows/sl b/windows/sl new file mode 100644 index 00000000..428951fc --- /dev/null +++ b/windows/sl @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sl + +> In PowerShell, this command is an alias of `Set-Location`. +> More information: . + +- View documentation for the original command: + +`tldr set-location` diff --git a/windows/slmgr b/windows/slmgr new file mode 100644 index 00000000..120f4a0c --- /dev/null +++ b/windows/slmgr @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# slmgr + +> This command is an alias of `slmgr.vbs`. +> More information: . + +- View documentation for the original command: + +`tldr slmgr.vbs` diff --git a/windows/slmgr.vbs b/windows/slmgr.vbs new file mode 100644 index 00000000..b80d3343 --- /dev/null +++ b/windows/slmgr.vbs @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# slmgr.vbs + +> Install, activate, and manage Windows licenses. +> This command may override, deactivate, and/or remove your current Windows license. Please proceed with caution. +> More information: . + +- [d]isplay the current Windows [l]icense [i]nformation: + +`slmgr.vbs /dli` + +- [d]isplay the ins[t]allation [i]D for the current device. Useful for offline license activation: + +`slmgr.vbs /dti` + +- Display the current license's e[xp]i[r]ation date and time: + +`slmgr.vbs /xpr` + +- [i]nstall a new Windows license [p]roduct [k]ey. Requires Administrator privileges and will override the existing license: + +`slmgr.vbs /ipk {{product_key}}` + +- [a]c[t]ivate the Windows product license [o]nline. Requires Administrator privileges to do so: + +`slmgr.vbs /ato` + +- [a]c[t]ivate the Windows [p]roduct license offline. Requires Administrator privileges and an Confirmation ID provided by Microsoft Product Activation Center: + +`slmgr.vbs /atp {{confirmation_id}}` + +- [c]lear the current license's [p]roduct [k]e[y] from the Windows Registry. This will not deactivate or uninstall the current license, but prevents the key from being stolen by malicious programs in the future: + +`slmgr.vbs /cpky` + +- [u]ninstall the current license (by its [p]roduct [k]ey): + +`slmgr.vbs /upk` diff --git a/windows/sls b/windows/sls new file mode 100644 index 00000000..e689d713 --- /dev/null +++ b/windows/sls @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# sls + +> This command is an alias of `Select-String`. +> More information: . + +- View documentation for the original command: + +`tldr select-string` diff --git a/windows/sort-object b/windows/sort-object new file mode 100644 index 00000000..35e905db --- /dev/null +++ b/windows/sort-object @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Sort-Object + +> Sorts objects by property values. +> This command can only be used through PowerShell. +> More information: . + +- Sort the current directory by name: + +`Get-ChildItem | Sort-Object` + +- Sort the current directory by name descending: + +`Get-ChildItem | Sort-Object -Descending` + +- Sort items removing duplicates: + +`"a", "b", "a" | Sort-Object -Unique` + +- Sort the current directory by file length: + +`Get-ChildItem | Sort-Object -Property Length` + +- Sort processes with the highest memory usage based on their working set (WS) size: + +`Get-Process | Sort-Object -Property WS` diff --git a/windows/start-service b/windows/start-service new file mode 100644 index 00000000..94d675c8 --- /dev/null +++ b/windows/start-service @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Start-Service + +> Starts stopped services. +> This command can only be used through PowerShell. +> More information: . + +- Start a service by using its name: + +`Start-Service -Name {{service_name}}` + +- Display information without starting a service: + +`Start-Service -DisplayName *{{name}}* -WhatIf` + +- Start a disabled service: + +`Set-Service {{service_name}} -StartupType {{manual}}; Start-Service {{service_name}}` diff --git a/windows/stop-service b/windows/stop-service new file mode 100644 index 00000000..5ec2174a --- /dev/null +++ b/windows/stop-service @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Stop-Service + +> Stops running services. +> This command can only be used through PowerShell. +> More information: . + +- Stop a service on the local computer: + +`Stop-Service -Name {{service_name}}` + +- Stop a service by using the display name: + +`Stop-Service -DisplayName "{{name}}"` + +- Stop a service that has dependent services: + +`Stop-Service -Name {{service_name}} -Force -Confirm` diff --git a/windows/subst b/windows/subst new file mode 100644 index 00000000..4c2c5410 --- /dev/null +++ b/windows/subst @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# subst + +> Associates a path with a virtual drive letter. +> More information: . + +- List active associations: + +`subst` + +- Add an association: + +`subst {{Z:}} {{C:\Python2.7}}` + +- Remove an association: + +`subst {{Z:}} /d` diff --git a/windows/systeminfo b/windows/systeminfo new file mode 100644 index 00000000..11f0ce6f --- /dev/null +++ b/windows/systeminfo @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# systeminfo + +> Display operating system configuration for a local or remote machine. +> More information: . + +- Display system configuration for the local machine: + +`systeminfo` + +- Display system configuration in a specified output format: + +`systeminfo /fo {{table|list|csv}}` + +- Display system configuration for a remote machine: + +`systeminfo /s {{remote_name}} /u {{username}} /p {{password}}` + +- Display help: + +`systeminfo /?` diff --git a/windows/takeown b/windows/takeown new file mode 100644 index 00000000..3971af7d --- /dev/null +++ b/windows/takeown @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# takeown + +> Take ownership of a file or directory. +> More information: . + +- Take ownership of the specified file: + +`takeown /f {{path o ile}}` + +- Take ownership of the specified directory: + +`takeown /d {{path o\directory}}` + +- Take ownership of the specified directory and all subdirectories: + +`takeown /r /d {{path o\directory}}` + +- Change ownership to the Administrator group instead of the current user: + +`takeown /a /f {{path o ile}}` diff --git a/windows/taskkill b/windows/taskkill new file mode 100644 index 00000000..b5e26f78 --- /dev/null +++ b/windows/taskkill @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# taskkill + +> Terminate a process by its process ID or name. +> More information: . + +- Terminate a process by its ID: + +`taskkill /pid {{process_id}}` + +- Terminate a process by its name: + +`taskkill /im {{process_name}}` + +- Forcefully terminate a specified process: + +`taskkill /pid {{process_id}} /f` + +- Terminate a process and its child processes: + +`taskkill /im {{process_name}} /t` + +- Terminate a process on a remote machine: + +`taskkill /pid {{process_id}} /s {{remote_name}}` + +- Display information about the usage of the command: + +`taskkill /?` diff --git a/windows/tasklist b/windows/tasklist new file mode 100644 index 00000000..ecf9f7f7 --- /dev/null +++ b/windows/tasklist @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# tasklist + +> Display a list of currently running processes on a local or remote machine. +> More information: . + +- Display currently running processes: + +`tasklist` + +- Display running processes in a specified output format: + +`tasklist /fo {{table|list|csv}}` + +- Display running processes using the specified `.exe` or `.dll` file name: + +`tasklist /m {{module_pattern}}` + +- Display processes running on a remote machine: + +`tasklist /s {{remote_name}} /u {{username}} /p {{password}}` + +- Display services using each process: + +`tasklist /svc` diff --git a/windows/tee-object b/windows/tee-object new file mode 100644 index 00000000..7fe1c676 --- /dev/null +++ b/windows/tee-object @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Tee-Object + +> Saves command output in a file or variable and also sends it down the pipeline. +> This command can only be used through PowerShell. +> More information: . + +- Output processes to a file and to the console: + +`Get-Process | Tee-Object -FilePath {{path o ile}}` + +- Output processes to a variable and `Select-Object`: + +`Get-Process notepad | Tee-Object -Variable {{proc}} | Select-Object processname,handles` diff --git a/windows/test-json b/windows/test-json new file mode 100644 index 00000000..2f12d664 --- /dev/null +++ b/windows/test-json @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Test-Json + +> Test whether a string is a valid JSON document. +> This command can only be used through PowerShell. +> More information: . + +- Test if a string from `stdin` is in JSON format: + +`'{{string}}' | Test-Json` + +- Test if a string JSON format: + +`Test-Json -Json '{{json_to_test}}'` + +- Test if a string from `stdin` matches a specific schema file: + +`'{{string}}' | Test-Json -SchemaFile {{path o\schema_file.json}}` diff --git a/windows/time b/windows/time new file mode 100644 index 00000000..eb9afe0a --- /dev/null +++ b/windows/time @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# time + +> Display or set the system time. +> More information: . + +- Display the current system time and prompt to enter a new time (leave empty to keep unchanged): + +`time` + +- Display the current system time without prompting for a new time: + +`time /t` diff --git a/windows/title b/windows/title new file mode 100644 index 00000000..ac48fd95 --- /dev/null +++ b/windows/title @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# title + +> Set the title of the command prompt window. +> More information: . + +- Set the title of the current command prompt window: + +`title {{new_title}}` diff --git a/windows/tracert b/windows/tracert new file mode 100644 index 00000000..106e230b --- /dev/null +++ b/windows/tracert @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# tracert + +> Receive information about each step in the route between your PC and the target. +> More information: . + +- Trace a route: + +`tracert {{IP}}` + +- Prevent `tracert` from resolving IP addresses to hostnames: + +`tracert /d {{IP}}` + +- Force `tracert` to use IPv4 only: + +`tracert /4 {{IP}}` + +- Force `tracert` to use IPv6 only: + +`tracert /6 {{IP}}` + +- Specify the maximum number of hops in the search for the target: + +`tracert /h {{max_hops}} {{IP}}` + +- Display help: + +`tracert /?` diff --git a/windows/tree b/windows/tree new file mode 100644 index 00000000..8595c927 --- /dev/null +++ b/windows/tree @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# tree + +> Display a graphical tree of the directory structure for a path. +> More information: . + +- Display the tree for the current directory: + +`tree` + +- Display the tree for a specific directory: + +`tree {{path o\directory}}` + +- Display the tree for a directory including files: + +`tree {{path o\directory}} /f` + +- Display the tree using ASCII characters instead of extended characters: + +`tree {{path o\directory}} /a` diff --git a/windows/tskill b/windows/tskill new file mode 100644 index 00000000..8d2a0bf8 --- /dev/null +++ b/windows/tskill @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# tskill + +> Ends a process running in a session on a Remote Desktop Session Host. +> More information: . + +- Terminate a process by its process identifier: + +`tskill {{process_id}}` + +- Terminate a process by its name: + +`tskill {{process_name}}` diff --git a/windows/type b/windows/type new file mode 100644 index 00000000..b3661b60 --- /dev/null +++ b/windows/type @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# type + +> Display the contents of a file. +> More information: . + +- Display the contents of a specific file: + +`type {{path o ile}}` diff --git a/windows/tzutil b/windows/tzutil new file mode 100644 index 00000000..54b32ce7 --- /dev/null +++ b/windows/tzutil @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# tzutil + +> A tool for displaying or configuring the system time zone. +> More information: . + +- Get the current time zone: + +`tzutil /g` + +- Display a list of available time zones: + +`tzutil /l` + +- Set the system time zone to the specific value: + +`tzutil /s {{timezone_id}}` diff --git a/windows/uwfmgr b/windows/uwfmgr new file mode 100644 index 00000000..77f967fa --- /dev/null +++ b/windows/uwfmgr @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# uwfmgr + +> Unified Write Filter (UWF). +> Protect drives by redirecting any writes to the drive to a virtual overlay. Writes are discarded upon reboot unless committed by default. +> More information: . + +- Get the current status: + +`uwfmgr get-config` + +- Set a drive as protected: + +`uwfmgr volume protect {{drive_letter}}:` + +- Remove a drive from protection list: + +`uwfmgr volume unprotect {{drive_letter}}:` + +- Enable or disable protection (Applies after reboot): + +`uwfmgr filter {{enable|disable}}` + +- Commit changes of a file on protected drive: + +`uwfmgr file commit {{drive_letter:\path o ile}}` + +- Commit deletion of a file on protected drive: + +`uwfmgr file commit-delete {{drive_letter:\path o ile}}` diff --git a/windows/vcvarsall b/windows/vcvarsall new file mode 100644 index 00000000..d6db5000 --- /dev/null +++ b/windows/vcvarsall @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# vcvarsall + +> Setup the environment variables required for using the Microsoft Visual Studio tools. +> The path of `vcvarsall` for a certain Visual Studio installation can be found using `vswhere`. +> More information: . + +- Setup the environment for native x64: + +`vcvarsall x64` + +- Setup the environment for cross-compiled native x86 from the x64 host: + +`vcvarsall x64_x86` + +- Setup the environment for cross-compiled native Arm x64 from the x64 host: + +`vcvarsall x64_arm64` + +- Setup the environment for native UWP x64: + +`vcvarsall x64 uwp` diff --git a/windows/ver b/windows/ver new file mode 100644 index 00000000..42aa28a9 --- /dev/null +++ b/windows/ver @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# ver + +> Display the current Windows or MS-DOS version number. +> More information: . + +- Display the current version number: + +`ver` diff --git a/windows/virtualboxvm b/windows/virtualboxvm new file mode 100644 index 00000000..b3077d1a --- /dev/null +++ b/windows/virtualboxvm @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# virtualboxvm + +> Manage VirtualBox virtual machines. +> More information: . + +- Start a virtual machine: + +`virtualboxvm --startvm {{name|uuid}}` + +- Start a virtual machine in fullscreen mode: + +`virtualboxvm --startvm {{name|uuid}} --fullscreen` + +- Mount the specified DVD image file: + +`virtualboxvm --startvm {{name|uuid}} --dvd {{path o\image_file}}` + +- Display a command-line window with debug information: + +`virtualboxvm --startvm {{name|uuid}} --debug-command-line` + +- Start a virtual machine in a paused state: + +`virtualboxvm --startvm {{name|uuid}} --start-paused` diff --git a/windows/vol b/windows/vol new file mode 100644 index 00000000..1251bb9a --- /dev/null +++ b/windows/vol @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# vol + +> Display information about volumes. +> More information: . + +- Display the label and serial number for the current drive: + +`vol` + +- Display the label and serial number for a specific volume: + +`vol {{D:}}` diff --git a/windows/vswhere b/windows/vswhere new file mode 100644 index 00000000..35e3309f --- /dev/null +++ b/windows/vswhere @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# vswhere + +> Locate Visual Studio 2017 and newer installations. +> More information: . + +- Find the path of vcvarsall.bat to set environment variables: + +`vswhere -products * -latest -prerelease -find **\VC\Auxiliary\Build cvarsall.bat` + +- Find the directory of the x64 MSVC compiler (cl.exe, etc): + +`vswhere -products * -latest -prerelease -find **\Hostx64d\*` + +- Find the directory of Clang bundled with Visual Studio bundled (clang-cl, clang-tidy, etc): + +`vswhere -products * -latest -prerelease -find **\Llvmin\*` + +- Find the path of `MSBuild.exe`: + +`vswhere -products * -latest -prerelease -find MSBuild\**\Bin\MSBuild.exe` diff --git a/windows/w32tm b/windows/w32tm new file mode 100644 index 00000000..92c04e89 --- /dev/null +++ b/windows/w32tm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# w32tm + +> Query and control the w32time time synchronization service. +> More information: . + +- Show the current status of time synchronization: + +`w32tm /query /status /verbose` + +- Show a time offset graph against a time server: + +`w32tm /stripchart /computer:{{time_server}}` + +- Show an NTP reply from a time server: + +`w32tm /stripchart /packetinfo /samples:1 /computer:{{time_server}}` + +- Show the state of the currently used time servers: + +`w32tm /query /peers` + +- Show configuration of the w32time service (run in elevated console): + +`w32tm /query /configuration` + +- Force time resynchronization immediately (run in elevated console): + +`w32tm /resync /force` + +- Write w32time debug logs into a file (run in elevated console): + +`w32tm /debug /enable /file:{{path o\debug.log}} /size:{{10000000}} /entries:{{0-300}}` diff --git a/windows/wait-process b/windows/wait-process new file mode 100644 index 00000000..f496d8e0 --- /dev/null +++ b/windows/wait-process @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Wait-Process + +> Waits for the processes to be stopped before accepting more input. +> This command can only be used through PowerShell. +> More information: . + +- Stop a process and wait: + +`Stop-Process -Id {{process_id}}; Wait-Process -Id {{process_id}}` + +- Wait for processes for a specified time: + +`Wait-Process -Name {{process_name}} -Timeout {{30}}` diff --git a/windows/wget b/windows/wget new file mode 100644 index 00000000..fa9548b7 --- /dev/null +++ b/windows/wget @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# wget + +> In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `wget` program () is not properly installed. +> Note: if version command returns an error, PowerShell may have substituted this command with `Invoke-WebRequest`. +> More information: . + +- View documentation for the original `wget` command: + +`tldr wget -p common` + +- View documentation for PowerShell's `Invoke-WebRequest` command: + +`tldr invoke-webrequest` + +- Display version: + +`wget --version` diff --git a/windows/where b/windows/where new file mode 100644 index 00000000..f9cae95e --- /dev/null +++ b/windows/where @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# where + +> Display the location of files that match the search pattern. +> Defaults to current work directory and paths in the PATH environment variable. +> More information: . + +- Display the location of file pattern: + +`where {{file_pattern}}` + +- Display the location of file pattern including file size and date: + +`where /T {{file_pattern}}` + +- Recursively search for file pattern at specified path: + +`where /R {{path o\directory}} {{file_pattern}}` + +- Silently return the error code for the location of the file pattern: + +`where /Q {{file_pattern}}` diff --git a/windows/where-object b/windows/where-object new file mode 100644 index 00000000..fad97cb2 --- /dev/null +++ b/windows/where-object @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# Where-Object + +> Selects objects from a collection based on their property values. +> This command can only be used through PowerShell. +> More information: . + +- Filter aliases by its name: + +`Get-Alias | Where-Object -{{Property}} {{Name}} -{{eq}} {{name}}` + +- List all services that are currently stopped. The `$_` automatic variable represents each object that is passed to the `Where-Object` cmdlet: + +`Get-Service | Where-Object {$_.Status -eq "Stopped"}` + +- Use multiple conditions: + +`Get-Module -ListAvailable | Where-Object { $_.Name -NotLike "Microsoft*" -And $_.Name -NotLike "PS*" }` diff --git a/windows/whoami b/windows/whoami new file mode 100644 index 00000000..fc8015ad --- /dev/null +++ b/windows/whoami @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# whoami + +> Display details about the current user. +> More information: . + +- Display the username of the current user: + +`whoami` + +- Display the groups that the current user is a member of: + +`whoami /groups` + +- Display the privileges of the current user: + +`whoami /priv` + +- Display the user principal name (UPN) of the current user: + +`whoami /upn` + +- Display the logon ID of the current user: + +`whoami /logonid` + +- Display all information for the current user: + +`whoami /all` diff --git a/windows/winget b/windows/winget new file mode 100644 index 00000000..c782faab --- /dev/null +++ b/windows/winget @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# winget + +> Windows Package Manager. +> More information: . + +- Install a package: + +`winget install {{package}}` + +- Remove a package (Note: `remove` can also be used instead of `uninstall`): + +`winget uninstall {{package}}` + +- Display information about a package: + +`winget show {{package}}` + +- Search for a package: + +`winget search {{package}}` + +- Upgrade all packages to the latest versions: + +`winget upgrade --all` + +- List all packages installed that can be managed with `winget`: + +`winget list --source winget` + +- Import packages from a file, or export installed packages to a file: + +`winget {{import|export}} {{--import-file|--output}} {{path/to/file}}` + +- Validate manifests before submitting a PR to the winget-pkgs repository: + +`winget validate {{path/to/manifest}}` diff --git a/windows/wmic b/windows/wmic new file mode 100644 index 00000000..6be4d14d --- /dev/null +++ b/windows/wmic @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# wmic + +> Interactive shell for detailed information about running processes. +> More information: . + +- Fundamental grammar: + +`wmic {{alias}} {{where_clause}} {{verb_clause}}` + +- Show brief details about the currently running processes: + +`wmic process list brief` + +- Show full details about the currently running processes: + +`wmic process list full` + +- Access specific fields such as process name, process ID and parent process ID: + +`wmic process get {{name,processid,parentprocessid}}` + +- Display information about a specific process: + +`wmic process where {{name="example.exe"}} list full` + +- Display specific fields for a specific process: + +`wmic process where processid={{pid}} get {{name,commandline}}` + +- Kill a process: + +`wmic process {{pid}} delete` diff --git a/windows/wsl b/windows/wsl new file mode 100644 index 00000000..daa296f6 --- /dev/null +++ b/windows/wsl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# wsl + +> Manage the Windows Subsystem for Linux. +> More information: . + +- Start a Linux shell (in the default distribution): + +`wsl {{shell_command}}` + +- Run a Linux command without using a shell: + +`wsl --exec {{command}} {{command_arguments}}` + +- Specify a particular distribution: + +`wsl --distribution {{distribution}} {{shell_command}}` + +- List available distributions: + +`wsl --list` + +- Export a distribution to a `.tar` file: + +`wsl --export {{distribution}} {{path o\distro_file.tar}}` + +- Import a distribution from a `.tar` file: + +`wsl --import {{distribution}} {{path o\install_location}} {{path/to/distro_file.tar}}` + +- Change the version of wsl used for the specified distribution: + +`wsl --set-version {{distribution}} {{version}}` + +- Shut down Windows Subsystem for Linux: + +`wsl --shutdown` diff --git a/windows/wsl-open b/windows/wsl-open new file mode 100644 index 00000000..6f4a538b --- /dev/null +++ b/windows/wsl-open @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# wsl-open + +> Open a file or URL from within Windows Subsystem for Linux in the user's default Windows GUI application. +> More information: . + +- Open the current directory in Windows Explorer: + +`wsl-open {{.}}` + +- Open a URL in the user's default web browser in Windows: + +`wsl-open {{https://example.com}}` + +- Open a specific file in the user's default application in Windows: + +`wsl-open {{path o ile}}` + +- Set `wsl-open` as the shell's web browser (open links with `wsl-open`): + +`wsl-open -w` + +- Display help: + +`wsl-open -h` diff --git a/windows/xcopy b/windows/xcopy new file mode 100644 index 00000000..4e95e124 --- /dev/null +++ b/windows/xcopy @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# xcopy + +> Copy files and directory trees. +> More information: . + +- Copy the file(s) to the specified destination: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}}` + +- List files that will be copied before copying: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /p` + +- Copy the directory structure only, excluding files: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /t` + +- Include empty directories when copying: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /e` + +- Keep the source ACL in the destination: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /o` + +- Allow resuming when network connection is lost: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /z` + +- Disable the prompt when the file exists in the destination: + +`xcopy {{path o ile_or_directory}} {{path o\destination_directory}} /y` + +- Display help: + +`xcopy /?` diff --git a/winicontopam b/winicontopam new file mode 100644 index 00000000..73cb3da8 --- /dev/null +++ b/winicontopam @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# winicontopam + +> Convert a Windows ICO file to a PAM file. +> More information: . + +- Read an ICO file and convert the best quality image contained therein to the PAM format: + +`winicontopam {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- Convert all images in the input file to PAM: + +`winicontopam -allimages {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- Convert the n'th image in the input file to PAM: + +`winicontopam -image {{n}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- If the image(s) to be extracted contain graded transparency data and an AND mask, write the AND mask into the fifth channel of the output PAM file: + +`winicontopam -andmasks {{path/to/input_file.ico}} > {{path/to/output.pam}}` diff --git a/winicontoppm b/winicontoppm new file mode 100644 index 00000000..fc990887 --- /dev/null +++ b/winicontoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# winicontoppm + +> This command is superseded by `winicontopam`. +> More information: . + +- View documentation for the current command: + +`tldr winicontopam` diff --git a/wipeclean b/wipeclean new file mode 100644 index 00000000..9a0e3c57 --- /dev/null +++ b/wipeclean @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wipeclean + +> Clear the terminal screen using an animated wiper. +> More information: . + +- Clear the terminal screen: + +`wipeclean` + +- Set the animation speed in frames per second (defaults to 150): + +`wipeclean --speed {{speed}}` diff --git a/wireplumber b/wireplumber new file mode 100644 index 00000000..dcbd757b --- /dev/null +++ b/wireplumber @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wireplumber + +> A modular session/policy manager for PipeWire and a GObject-based high-level library that wraps PipeWire’s API. +> See also: `wpctl`, `pipewire`. +> More information: . + +- Make WirePlumber start with the user session immediately (for systemd systems): + +`systemctl --user --now enable wireplumber` + +- Run WirePlumber, after `pipewire` is started (for non-systemd systems): + +`wireplumber` + +- Specify a different context configuration file: + +`wireplumber --config-file {{path/to/file}}` + +- Display help: + +`wireplumber --help` + +- Display version: + +`wirepumbler --version` diff --git a/wkhtmltopdf b/wkhtmltopdf new file mode 100644 index 00000000..7034f8a2 --- /dev/null +++ b/wkhtmltopdf @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wkhtmltopdf + +> An open-source command-line tool to convert HTML documents or web pages into PDF files. +> More information: . + +- Convert a HTML document into PDF: + +`wkhtmltopdf {{input.html}} {{output.pdf}}` + +- Specify the PDF page size (please see `PaperSize` of `QPrinter` for supported sizes): + +`wkhtmltopdf --page-size {{A4}} {{input.html}} {{output.pdf}}` + +- Set the PDF page margins: + +`wkhtmltopdf --margin-{{top|bottom|left|right}} {{10mm}} {{input.html}} {{output.pdf}}` + +- Set the PDF page orientation: + +`wkhtmltopdf --orientation {{Landscape|Portrait}} {{input.html}} {{output.pdf}}` + +- Generate a greyscale version of the PDF document: + +`wkhtmltopdf --grayscale {{input.html}} {{output.pdf}}` diff --git a/wondershaper b/wondershaper new file mode 100644 index 00000000..d494865f --- /dev/null +++ b/wondershaper @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wondershaper + +> Allows the user to limit the bandwidth of network adapters. +> More information: . + +- Display [h]elp: + +`wondershaper -h` + +- Show the current [s]tatus of a specific [a]dapter: + +`wondershaper -s -a {{adapter_name}}` + +- Clear limits from a specific [a]dapter: + +`wondershaper -c -a {{adapter_name}}` + +- Set a specific maximum [d]ownload rate (in Kbps): + +`wondershaper -a {{adapter_name}} -d {{1024}}` + +- Set a specific maximum [u]pload rate (in Kbps): + +`wondershaper -a {{adapter_name}} -u {{512}}` + +- Set a specific maximum [d]ownload rate and [u]pload rate (in Kpbs): + +`wondershaper -a {{adapter_name}} -d {{1024}} -u {{512}}` diff --git a/wordgrinder b/wordgrinder new file mode 100644 index 00000000..d466df0d --- /dev/null +++ b/wordgrinder @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wordgrinder + +> Command-line word processor. +> More information: . + +- Start WordGrinder (loads a blank document by default): + +`wordgrinder` + +- Open a given file: + +`wordgrinder {{path/to/file}}` + +- Show the menu: + +` + M` diff --git a/wormhole b/wormhole new file mode 100644 index 00000000..36c8ac8f --- /dev/null +++ b/wormhole @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wormhole + +> Get things from one computer to another, safely. +> More information: . + +- Send a file: + +`wormhole send {{path/to/file}}` + +- Receive a file: + +`wormhole receive {{wormhole_code}}` + +- Send raw text: + +`wormhole send` diff --git a/wp b/wp new file mode 100644 index 00000000..551cbaf9 --- /dev/null +++ b/wp @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wp + +> The official command-line interface to manage WordPress instances. +> More information: . + +- Print information about the operating system, shell, PHP, and WP-CLI (`wp`) installation: + +`wp --info` + +- Update WP-CLI: + +`wp cli update` + +- Download a fresh WordPress installation to current directory, optionally specifying the locale: + +`wp core download --locale={{locale}}` + +- Create basic `wpconfig` file (assuming database on `localhost`): + +`wp config create --dbname={{dbname}} --dbuser={{dbuser}} --dbpass={{dbpass}}` + +- Install and activate a WordPress plugin: + +`wp plugin install {{plugin}} --activate` + +- Replace all instances of a string in the database: + +`wp search-replace {{old_string}} {{new_string}}` + +- Import the contents of a WordPress Extended RSS (WXR) file: + +`wp import {{path/to/file.xml}}` diff --git a/wpa_supplicant b/wpa_supplicant new file mode 100644 index 00000000..6a21ac05 --- /dev/null +++ b/wpa_supplicant @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wpa_supplicant + +> Manage protected wireless networks. +> More information: . + +- Join a protected wireless network: + +`wpa_supplicant -i {{interface}} -c {{path/to/wpa_supplicant_conf.conf}}` + +- Join a protected wireless network and run it in a daemon: + +`wpa_supplicant -B -i {{interface}} -c {{path/to/wpa_supplicant_conf.conf}}` diff --git a/wpaclean b/wpaclean new file mode 100644 index 00000000..2e0becc1 --- /dev/null +++ b/wpaclean @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wpaclean + +> Clean capture files to get only the 4-way handshake and a beacon. +> Part of Aircrack-ng network software suite. +> More information: . + +- Clean capture and save only the 4-way handshake and a beacon in the result: + +`wpaclean {{path/to/result.cap}} {{path/to/capture.cap}}` + +- Clean multiple captures and save 4-way handshakes and beacons in the result: + +`wpaclean {{path/to/result.cap}} {{path/to/capture1.cap path/to/capture2.cap ...}}` diff --git a/wpexec b/wpexec new file mode 100644 index 00000000..e46caec0 --- /dev/null +++ b/wpexec @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wpexec + +> Run WirePlumber Lua scripts. +> See also: `wpctl`, `wireplumber`. +> More information: . + +- Run a WirePlumber script: + +`wpexec {{path/to/file.lua}}` + +- Display help: + +`wpexec --help` diff --git a/wpm b/wpm new file mode 100644 index 00000000..11a3b42a --- /dev/null +++ b/wpm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wpm + +> Typeracer-like console app for measuring your WPM. +> More information: . + +- Start `wpm`: + +`wpm` + +- Start `wpm` with short texts: + +`wpm --short` + +- Start `wpm` using a specific text file: + +`wpm --load {{path/to/file.txt}}` + +- Tag your race scores: + +`wpm --tag {{tag_name}}` + +- Show score statistics grouped by tags: + +`wpm --stats` + +- Start `wpm` with monochrome colors: + +`wpm --monochrome` diff --git a/wpscan b/wpscan new file mode 100644 index 00000000..1ce28e21 --- /dev/null +++ b/wpscan @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wpscan + +> WordPress vulnerability scanner. +> More information: . + +- Update the vulnerability database: + +`wpscan --update` + +- Scan a WordPress website: + +`wpscan --url {{url}}` + +- Scan a WordPress website, using random user agents and passive detection: + +`wpscan --url {{url}} --stealthy` + +- Scan a WordPress website, checking for vulnerable plugins and specifying the path to the `wp-content` directory: + +`wpscan --url {{url}} --enumerate {{vp}} --wp-content-dir {{remote/path/to/wp-content}}` + +- Scan a WordPress website through a proxy: + +`wpscan --url {{url}} --proxy {{protocol://ip:port}} --proxy-auth {{username:password}}` + +- Perform user identifiers enumeration on a WordPress website: + +`wpscan --url {{url}} --enumerate {{u}}` + +- Execute a password guessing attack on a WordPress website: + +`wpscan --url {{url}} --usernames {{username|path/to/usernames.txt}} --passwords {{path/to/passwords.txt}} threads {{20}}` + +- Scan a WordPress website, collecting vulnerability data from the WPVulnDB (): + +`wpscan --url {{url}} --api-token {{token}}` diff --git a/wrangler b/wrangler new file mode 100644 index 00000000..87a08727 --- /dev/null +++ b/wrangler @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wrangler + +> Cloudflare Workers command-line tool. +> More information: . + +- Initialize a project with a skeleton configuration: + +`wrangler init {{project_name}}` + +- Authenticate with Cloudflare: + +`wrangler login` + +- Start a local development server: + +`wrangler dev --host {{hostname}}` + +- Publish the worker script: + +`wrangler publish` + +- Aggregate logs from the production worker: + +`wrangler tail` diff --git a/write b/write new file mode 100644 index 00000000..47f9d843 --- /dev/null +++ b/write @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# write + +> Write a message on the terminal of a specified logged in user (ctrl-C to stop writing messages). +> Use the `who` command to find out all terminal_ids of all active users active on the system. See also `mesg`. +> More information: . + +- Send a message to a given user on a given terminal id: + +`write {{username}} {{terminal_id}}` + +- Send message to "testuser" on terminal `/dev/tty/5`: + +`write {{testuser}} {{tty/5}}` + +- Send message to "johndoe" on pseudo terminal `/dev/pts/5`: + +`write {{johndoe}} {{pts/5}}` diff --git a/wrk b/wrk new file mode 100644 index 00000000..fddbd8e0 --- /dev/null +++ b/wrk @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wrk + +> HTTP benchmarking tool. +> More information: . + +- Run a benchmark for `30` seconds, using `12` threads, and keeping `400` HTTP connections open: + +`wrk -t{{12}} -c{{400}} -d{{30s}} "{{http://127.0.0.1:8080/index.html}}"` + +- Run a benchmark with a custom header: + +`wrk -t{{2}} -c{{5}} -d{{5s}} -H "{{Host: example.com}}" "{{http://example.com/index.html}}"` + +- Run a benchmark with a request timeout of `2` seconds: + +`wrk -t{{2}} -c{{5}} -d{{5s}} --timeout {{2s}} "{{http://example.com/index.html}}"` diff --git a/wuzz b/wuzz new file mode 100644 index 00000000..837a6b87 --- /dev/null +++ b/wuzz @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wuzz + +> Interactively inspect HTTP requests and responses. +> More information: . + +- Start `wuzz`: + +`wuzz` + +- Send an HTTP request: + +` + R` + +- Switch to the next view: + +` + J, ` + +- Switch to the previous view: + +` + K, + ` + +- Display help: + +`F1` diff --git a/x11docker b/x11docker new file mode 100644 index 00000000..638fdf12 --- /dev/null +++ b/x11docker @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# x11docker + +> Securely run GUI applications and desktop UIs in Docker containers. +> See also `xephyr`. +> More information: . + +- Launch VLC in a container: + +`x11docker --pulseaudio --share={{$HOME/Videos}} {{jess/vlc}}` + +- Launch Xfce in a window: + +`x11docker --desktop {{x11docker/xfce}}` + +- Launch GNOME in a window: + +`x11docker --desktop --gpu --init={{systemd}} {{x11docker/gnome}}` + +- Launch KDE Plasma in a window: + +`x11docker --desktop --gpu --init={{systemd}} {{x11docker/kde-plasma}}` + +- Display help: + +`x11docker --help` diff --git a/x_x b/x_x new file mode 100644 index 00000000..9ff9ca27 --- /dev/null +++ b/x_x @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# x_x + +> View Excel and CSV files. +> More information: . + +- View an XLSX or CSV file: + +`x_x {{file.xlsx|file.csv}}` + +- View an XLSX or CSV file, using the first row as table headers: + +`x_x -h {{0}} {{file.xlsx|file.csv}}` + +- View a CSV file with unconventional delimiters: + +`x_x --delimiter={{';'}} --quotechar={{'|'}} {{file.csv}}` diff --git a/xar b/xar new file mode 100644 index 00000000..3e0b3467 --- /dev/null +++ b/xar @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xar + +> Manage .xar archives. +> More information: . + +- Create a xar archive of all files in a given directory: + +`xar -cf {{archive.xar}} {{path/to/directory}}` + +- List the contents of a given xar archive: + +`xar -tf {{archive.xar}}` + +- Extract the contents of a given xar archive to the current directory: + +`xar -xf {{archive.xar}}` diff --git a/xargs b/xargs new file mode 100644 index 00000000..2b0538e4 --- /dev/null +++ b/xargs @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xargs + +> Execute a command with piped arguments coming from another command, a file, etc. +> The input is treated as a single block of text and split into separate pieces on spaces, tabs, newlines and end-of-file. +> More information: . + +- Run a command using the input data as arguments: + +`{{arguments_source}} | xargs {{command}}` + +- Run multiple chained commands on the input data: + +`{{arguments_source}} | xargs sh -c "{{command1}} && {{command2}} | {{command3}}"` + +- Delete all files with a `.backup` extension (`-print0` uses a null character to split file names, and `-0` uses it as delimiter): + +`find . -name {{'*.backup'}} -print0 | xargs -0 rm -v` + +- Execute the command once for each input line, replacing any occurrences of the placeholder (here marked as `_`) with the input line: + +`{{arguments_source}} | xargs -I _ {{command}} _ {{optional_extra_arguments}}` + +- Parallel runs of up to `max-procs` processes at a time; the default is 1. If `max-procs` is 0, xargs will run as many processes as possible at a time: + +`{{arguments_source}} | xargs -P {{max-procs}} {{command}}` diff --git a/xbmtopbm b/xbmtopbm new file mode 100644 index 00000000..94d55699 --- /dev/null +++ b/xbmtopbm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xbmtopbm + +> Convert an X11 or X10 bitmap to a PBM image. +> More information: . + +- Convert an XBM image to a PPM image: + +`xbmtopbm {{path/to/input_file.xbm}} > {{path/to/output_file.pbm}}` diff --git a/xcaddy b/xcaddy new file mode 100644 index 00000000..0c212f53 --- /dev/null +++ b/xcaddy @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xcaddy + +> The custom build tool for the Caddy Web Server. +> More information: . + +- Build Caddy server from source: + +`xcaddy build` + +- Build Caddy server with a specific version (defaults to latest): + +`xcaddy build {{version}}` + +- Build Caddy with a specific module: + +`xcaddy build --with {{module_name}}` + +- Build Caddy and output to a specific file: + +`xcaddy build --output {{path/to/file}}` + +- Build and run Caddy for a development plugin in the current directory: + +`xcaddy run` + +- Build and run Caddy for a development plugin using a specific Caddy config: + +`xcaddy run --config {{path/to/file}}` diff --git a/xcv b/xcv new file mode 100644 index 00000000..83c7efc0 --- /dev/null +++ b/xcv @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xcv + +> Cut, copy, and paste in the command-line. +> More information: . + +- Cut a file: + +`xcv x {{input_file}}` + +- Copy a file: + +`xcv c {{input_file}}` + +- Paste a file: + +`xcv v {{output_file}}` + +- List files available for pasting: + +`xcv l` diff --git a/xdelta b/xdelta new file mode 100644 index 00000000..8d6e6530 --- /dev/null +++ b/xdelta @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xdelta + +> Delta encoding utility. +> Often used for applying patches to binary files. +> More information: . + +- Apply a patch: + +`xdelta -d -s {{path/to/input_file}} {{path/to/delta_file.xdelta}} {{path/to/output_file}}` + +- Create a patch: + +`xdelta -e -s {{path/to/old_file}} {{path/to/new_file}} {{path/to/output_file.xdelta}}` diff --git a/xe b/xe new file mode 100644 index 00000000..7920372b --- /dev/null +++ b/xe @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xe + +> Execute a command once for each line piped from another command or file. +> More information: . + +- Run a command once for each line of input data as arguments: + +`{{arguments_source}} | xe {{command}}` + +- Execute the commands, replacing any occurrence of the placeholder (marked as `{}`) with the input line: + +`{{arguments_source}} | xe {{command}} {} {{optional_extra_arguments}}` + +- Execute a shellscript, joining every `N` lines into a single call: + +`echo -e 'a +b' | xe -N{{2}} -s 'echo $2 $1'` + +- Delete all files with a `.backup` extension: + +`find . -name {{'*.backup'}} | xe rm -v` + +- Run up to `max-jobs` processes in parallel; the default is 1. If `max-jobs` is 0, xe will run as many processes as cpu cores: + +`{{arguments_source}} | xe -j {{max-jobs}} {{command}}` diff --git a/xephyr b/xephyr new file mode 100644 index 00000000..695d7b86 --- /dev/null +++ b/xephyr @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# Xephyr + +> A nested X server that runs as an X application. +> More information: . + +- Create a black window with display ID ":2": + +`Xephyr -br -ac -noreset -screen {{800x600}} {{:2}}` + +- Start an X application on the new screen: + +`DISPLAY=:2 {{command_name}}` diff --git a/xetex b/xetex new file mode 100644 index 00000000..d9b98f8b --- /dev/null +++ b/xetex @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xetex + +> Compile a PDF document from XeTeX source files. +> More information: . + +- Compile a PDF document: + +`xetex {{source.tex}}` + +- Compile a PDF document, specifying an output directory: + +`xetex -output-directory={{path/to/directory}} {{source.tex}}` + +- Compile a PDF document, exiting if errors occur: + +`xetex -halt-on-error {{source.tex}}` diff --git a/xev b/xev new file mode 100644 index 00000000..f5998185 --- /dev/null +++ b/xev @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xev + +> Print contents of X events. +> More information: . + +- Monitor all occurring X events: + +`xev` + +- Monitor all X events of the root window instead of creating a new one: + +`xev -root` + +- Monitor all X events of a particular window: + +`xev -id {{window_id}}` + +- Monitor X events from a given category (can be specified multiple times): + +`xev -event {{event_category}}` diff --git a/xgettext b/xgettext new file mode 100644 index 00000000..d134f691 --- /dev/null +++ b/xgettext @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xgettext + +> Extract gettext strings from code files. +> More information: . + +- Scan file and output strings to `messages.po`: + +`xgettext {{path/to/input_file}}` + +- Use a different output filename: + +`xgettext --output {{path/to/output_file}} {{path/to/input_file}}` + +- Append new strings to an existing file: + +`xgettext --join-existing --output {{path/to/output_file}} {{path/to/input_file}}` + +- Don't add a header containing metadata to the output file: + +`xgettext --omit-header {{path/to/input_file}}` diff --git a/xh b/xh new file mode 100644 index 00000000..1113f4b2 --- /dev/null +++ b/xh @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xh + +> Friendly and fast tool for sending HTTP requests. +> More information: . + +- Send a GET request: + +`xh {{httpbin.org/get}}` + +- Send a POST request with a JSON body (key-value pairs are added to a top-level JSON object - e.g. `{"name": "john", "age": 25}`): + +`xh post {{httpbin.org/post}} {{name=john}} {{age:=25}}` + +- Send a GET request with query parameters (e.g. `first_param=5&second_param=true`): + +`xh get {{httpbin.org/get}} {{first_param==5}} {{second_param==true}}` + +- Send a GET request with a custom header: + +`xh get {{httpbin.org/get}} {{header-name:header-value}}` + +- Make a GET request and save the response body to a file: + +`xh --download {{httpbin.org/json}} --output {{path/to/file}}` diff --git a/xidel b/xidel new file mode 100644 index 00000000..67cc1500 --- /dev/null +++ b/xidel @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xidel + +> Download and extract data from HTML/XML pages as well as JSON APIs. +> More information: . + +- Print all URLs found by a Google search: + +`xidel {{https://www.google.com/search?q=test}} --extract "//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']"` + +- Print the title of all pages found by a Google search and download them: + +`xidel {{https://www.google.com/search?q=test}} --follow "{{//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']}}" --extract {{//title}} --download {{'{$host}/'}}` + +- Follow all links on a page and print the titles, with XPath: + +`xidel {{https://example.org}} --follow {{//a}} --extract {{//title}}` + +- Follow all links on a page and print the titles, with CSS selectors: + +`xidel {{https://example.org}} --follow "{{css('a')}}" --css {{title}}` + +- Follow all links on a page and print the titles, with pattern matching: + +`xidel {{https://example.org}} --follow "{{{.}*}}" --extract "{{{.}}}"` + +- Read the pattern from example.xml (which will also check if the element containing "ood" is there, and fail otherwise): + +`xidel {{path/to/example.xml}} --extract "{{ood{.}}}"` + +- Print all newest Stack Overflow questions with title and URL using pattern matching on their RSS feed: + +`xidel {{http://stackoverflow.com/feeds}} --extract "{{{title:=.}{uri:=@href}+}}"` + +- Check for unread Reddit mail, Webscraping, combining CSS, XPath, JSONiq, and automatically form evaluation: + +`xidel {{https://reddit.com}} --follow "{{form(css('form.login-form')[1], {'user': '$your_username', 'passwd': '$your_password'})}}" --extract "{{css('#mail')/@title}}"` diff --git a/ximtoppm b/ximtoppm new file mode 100644 index 00000000..3460a388 --- /dev/null +++ b/ximtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ximtoppm + +> Convert a XIM file to a PPM image. +> More information: . + +- Convert an XIM image to a PPM image: + +`ximtoppm {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` + +- Store the transparency mask of the input image in the specified file: + +`ximtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` diff --git a/xkcdpass b/xkcdpass new file mode 100644 index 00000000..a4482139 --- /dev/null +++ b/xkcdpass @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xkcdpass + +> A flexible and scriptable password generator which generates strong passphrases. +> Inspired by XKCD 936. +> More information: . + +- Generate one passphrase with the default options: + +`xkcdpass` + +- Generate one passphrase whose first letters of each word match the provided argument: + +`xkcdpass -a {{acrostic}}` + +- Generate passwords interactively: + +`xkcdpass -i` diff --git a/xkill b/xkill new file mode 100644 index 00000000..c24247c0 --- /dev/null +++ b/xkill @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xkill + +> Kill a window interactively in a graphical session. +> See also: `kill`, `killall`. +> More information: . + +- Display a cursor to kill a window when pressing the left mouse button (press any other mouse button to cancel): + +`xkill` + +- Display a cursor to select a window to kill by pressing any mouse button: + +`xkill -button any` + +- Kill a window with a specific id (use `xwininfo` to get info about windows): + +`xkill -id {{id}}` diff --git a/xml b/xml new file mode 100644 index 00000000..213b06da --- /dev/null +++ b/xml @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml + +> XMLStarlet Toolkit: query, edit, check, convert and transform XML documents. +> Some subcommands such as `xml validate` have their own usage documentation. +> More information: . + +- Display general help, including the list of subcommands: + +`xml --help` + +- Execute a subcommand with input from a file or URI, printing to `stdout`: + +`xml {{subcommand}} {{options}} {{path/to/input.xml|URI}}` + +- Execute a subcommand using `stdin` and `stdout`: + +`xml {{subcommand}} {{options}}` + +- Execute a subcommand with input from a file or URI and output to a file: + +`xml {{subcommand}} {{options}} {{path/to/input.xml|URI}} > {{path/to/output}}` + +- Display help for a specific subcommand: + +`xml {{subcommand}} --help` + +- Display version: + +`xml --version` diff --git a/xml-canonic b/xml-canonic new file mode 100644 index 00000000..7550b8d8 --- /dev/null +++ b/xml-canonic @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml canonic + +> Make XML documents canonical. +> More information: . + +- Make an XML document canonical, preserving comments: + +`xml canonic {{path/to/input.xml|URI}} > {{path/to/output.xml}}` + +- Make an XML document canonical, removing comments: + +`xml canonic --without-comments {{path/to/input.xml|URI}} > {{path/to/output.xml}}` + +- Make XML exclusively canonical, using an XPATH from a file, preserving comments: + +`xml canonic --exc-with-comments {{path/to/input.xml|URI}} {{path/to/c14n.xpath}}` + +- Display help: + +`xml canonic --help` diff --git a/xml-depyx b/xml-depyx new file mode 100644 index 00000000..a8b261ec --- /dev/null +++ b/xml-depyx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml depyx + +> Convert a PYX (ESIS - ISO 8879) document to XML format. +> More information: . + +- Convert a PYX (ESIS - ISO 8879) document to XML format: + +`xml depyx {{path/to/input.pyx|URI}} > {{path/to/output.xml}}` + +- Convert a PYX document from `stdin` to XML format: + +`cat {{path/to/input.pyx}} | xml depyx > {{path/to/output.xml}}` + +- Display help: + +`xml depyx --help` diff --git a/xml-edit b/xml-edit new file mode 100644 index 00000000..aa4f277d --- /dev/null +++ b/xml-edit @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml edit + +> Edit an XML document. +> More information: . + +- Delete elements matching an XPATH from an XML document: + +`xml edit --delete "{{XPATH1}}" {{path/to/input.xml|URI}}` + +- Move an element node of an XML document from XPATH1 to XPATH2: + +`xml edit --move "{{XPATH1}}" "{{XPATH2}}" {{path/to/input.xml|URI}}` + +- Rename all attributes named "id" to "ID": + +`xml edit --rename "{{//*/@id}}" -v "{{ID}}" {{path/to/input.xml|URI}}` + +- Rename sub-elements of the element "table" that are named "rec" to "record": + +`xml edit --rename "{{/xml/table/rec}}" -v "{{record}}" {{path/to/input.xml|URI}}` + +- Update the XML table record with "id=3" to the value "id=5": + +`xml edit --update "{{xml/table/rec[@id=3]/@id}}" -v {{5}} {{path/to/input.xml|URI}}` + +- Display help: + +`xml edit --help` diff --git a/xml-elements b/xml-elements new file mode 100644 index 00000000..b3f9ed30 --- /dev/null +++ b/xml-elements @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml elements + +> Extract elements and display the structure of an XML document. +> More information: . + +- Extract elements from an XML document (producing XPATH expressions): + +`xml elements {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` + +- Extract elements and their attributes from an XML document: + +`xml elements -a {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` + +- Extract elements and their attributes and values from an XML document: + +`xml elements -v {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` + +- Print sorted unique elements from an XML document to see its structure: + +`xml elements -u {{path/to/input.xml|URI}}` + +- Print sorted unique elements from an XML document up to a depth of 3: + +`xml elements -d{{3}} {{path/to/input.xml|URI}}` + +- Display help: + +`xml elements --help` diff --git a/xml-escape b/xml-escape new file mode 100644 index 00000000..fe07c69e --- /dev/null +++ b/xml-escape @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml escape + +> Escape special XML characters, e.g. `` → `<a1>`. +> More information: . + +- Escape special XML characters in a string: + +`xml escape "{{}}"` + +- Escape special XML characters from `stdin`: + +`echo "{{}}" | xml escape` + +- Display help: + +`xml escape --help` diff --git a/xml-format b/xml-format new file mode 100644 index 00000000..81397dbf --- /dev/null +++ b/xml-format @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml format + +> Format an XML document. +> More information: . + +- Format an XML document, indenting with tabs: + +`xml format --indent-tab {{path/to/input.xml|URI}} > {{path/to/output.xml}}` + +- Format an HTML document, indenting with 4 spaces: + +`xml format --html --indent-spaces {{4}} {{path/to/input.html|URI}} > {{path/to/output.html}}` + +- Recover parsable parts of a malformed XML document, without indenting: + +`xml format --recover --noindent {{path/to/malformed.xml|URI}} > {{path/to/recovered.xml}}` + +- Format an XML document from `stdin`, removing the `DOCTYPE` declaration: + +`cat {{path o\input.xml}} | xml format --dropdtd > {{path/to/output.xml}}` + +- Format an XML document, omitting the XML declaration: + +`xml format --omit-decl {{path o\input.xml|URI}} > {{path/to/output.xml}}` + +- Display help: + +`xml format --help` diff --git a/xml-list b/xml-list new file mode 100644 index 00000000..61b77126 --- /dev/null +++ b/xml-list @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml list + +> List a directory's contents (like `ls`) in XML format. +> More information: . + +- Write the current directory's listing to an XML document: + +`xml list > {{path/to/dir_list.xml}}` + +- Write the specified directory's listing to an XML document: + +`xml list {{path/to/directory}} > {{path/to/dir_list.xml}}` + +- Display help: + +`xml list --help` diff --git a/xml-pyx b/xml-pyx new file mode 100644 index 00000000..d9704a1e --- /dev/null +++ b/xml-pyx @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml pyx + +> Convert an XML document to PYX (ESIS - ISO 8879) format. +> More information: . + +- Convert an XML document to PYX format: + +`xml pyx {{path/to/input.xml|URI}} > {{path/to/output.pyx}}` + +- Convert an XML document from `stdin` to PYX format: + +`cat {{path/to/input.xml}} | xml pyx > {{path/to/output.pyx}}` + +- Display help: + +`xml pyx --help` diff --git a/xml-select b/xml-select new file mode 100644 index 00000000..f8a4c516 --- /dev/null +++ b/xml-select @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml select + +> Select from XML documents using XPATHs. +> Tip: use `xml elements` to display the XPATHs of an XML document. +> More information: . + +- Select all elements matching "XPATH1" and print the value of their sub-element "XPATH2": + +`xml select --template --match "{{XPATH1}}" --value-of "{{XPATH2}}" {{path/to/input.xml|URI}}` + +- Match "XPATH1" and print the value of "XPATH2" as text with new-lines: + +`xml select --text --template --match "{{XPATH1}}" --value-of "{{XPATH2}}" --nl {{path/to/input.xml|URI}}` + +- Count the elements of "XPATH1": + +`xml select --template --value-of "count({{XPATH1}})" {{path/to/input.xml|URI}}` + +- Count all nodes in one or more XML documents: + +`xml select --text --template --inp-name --output " " --value-of "count(node())" --nl {{path/to/input1.xml|URI}} {{path/to/input2.xml|URI}}` + +- Display help: + +`xml select --help` diff --git a/xml-transform b/xml-transform new file mode 100644 index 00000000..5808a98e --- /dev/null +++ b/xml-transform @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml transform + +> Transform XML documents using XSLT. +> More information: . + +- Transform an XML document using an XSL stylesheet, passing one XPATH parameter and one literal string parameter: + +`xml transform {{path/to/stylesheet.xsl}} -p "{{Count='count(/xml/table/rec)'}}" -s {{Text="Count="}} {{path/to/input.xml|URI}}` + +- Display help: + +`xml transform --help` diff --git a/xml-unescape b/xml-unescape new file mode 100644 index 00000000..72e93a6c --- /dev/null +++ b/xml-unescape @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml unescape + +> Unescape special XML characters, e.g. `<a1>` → ``. +> More information: . + +- Unescape special XML characters from a string: + +`xml unescape "{{<a1>}}"` + +- Unescape special XML characters from `stdin`: + +`echo "{{<a1>}}" | xml unescape` + +- Display help: + +`xml escape --help` diff --git a/xml-validate b/xml-validate new file mode 100644 index 00000000..fc3320d3 --- /dev/null +++ b/xml-validate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml validate + +> Validate XML documents. +> More information: . + +- Validate one or more XML documents for well-formedness only: + +`xml validate {{path/to/input1.xml|URI}} {{input2.xml ...}}` + +- Validate one or more XML documents against a Document Type Definition (DTD): + +`xml validate --dtd {{path/to/schema.dtd}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` + +- Validate one or more XML documents against an XML Schema Definition (XSD): + +`xml validate --xsd {{path/to/schema.xsd}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` + +- Validate one or more XML documents against a Relax NG schema (RNG): + +`xml validate --relaxng {{path/to/schema.rng}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` + +- Display help: + +`xml validate --help` diff --git a/xmllint b/xmllint new file mode 100644 index 00000000..d6c67940 --- /dev/null +++ b/xmllint @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xmllint + +> XML parser and linter that supports XPath, a syntax for navigating XML trees. +> More information: . + +- Return all nodes (tags) named "foo": + +`xmllint --xpath "//{{foo}}" {{source_file.xml}}` + +- Return the contents of the first node named "foo" as a string: + +`xmllint --xpath "string(//{{foo}})" {{source_file.xml}}` + +- Return the href attribute of the second anchor element in an HTML file: + +`xmllint --html --xpath "string(//a[2]/@href)" webpage.xhtml` + +- Return human-readable (indented) XML from file: + +`xmllint --format {{source_file.xml}}` + +- Check that an XML file meets the requirements of its DOCTYPE declaration: + +`xmllint --valid {{source_file.xml}}` + +- Validate XML against DTD schema hosted online: + +`xmllint --dtdvalid {{URL}} {{source_file.xml}}` diff --git a/xmlstarlet b/xmlstarlet new file mode 100644 index 00000000..32240f92 --- /dev/null +++ b/xmlstarlet @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xmlstarlet + +> A command-line XML/XSLT toolkit. +> Note: You will likely need to know XPath: . +> More information: . + +- Format an XML document and print to `stdout`: + +`xmlstarlet format {{path/to/file.xml}}` + +- XML document can also be piped from `stdin`: + +`{{cat path/to/file.xml}} | xmlstarlet format` + +- Print all nodes that match a given XPath: + +`xmlstarlet select --template --copy-of {{xpath}} {{path/to/file.xml}}` + +- Insert an attribute to all matching nodes, and print to `stdout` (source file is unchanged): + +`xmlstarlet edit --insert {{xpath}} --type attr --name {{attribute_name}} --value {{attribute_value}} {{path/to/file.xml}}` + +- Update the value of all matching nodes in place (source file is changed): + +`xmlstarlet edit --inplace --update {{xpath}} --value {{new_value}} {{file.xml}}` + +- Delete all matching nodes in place (source file is changed): + +`xmlstarlet edit --inplace --delete {{xpath}} {{file.xml}}` + +- Escape or unescape special XML characters in a given string: + +`xmlstarlet [un]escape {{string}}` + +- List a given directory as XML (omit argument to list current directory): + +`xmlstarlet ls {{path/to/directory}}` diff --git a/xmlto b/xmlto new file mode 100644 index 00000000..c44a2140 --- /dev/null +++ b/xmlto @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xmlto + +> Apply an XSL stylesheet to an XML document. +> More information: . + +- Convert a DocBook XML document to PDF format: + +`xmlto {{pdf}} {{document.xml}}` + +- Convert a DocBook XML document to HTML format and store the resulting files in a separate directory: + +`xmlto -o {{path/to/html_files}} {{html}} {{document.xml}}` + +- Convert a DocBook XML document to a single HTML file: + +`xmlto {{html-nochunks}} {{document.xml}}` + +- Specify a stylesheet to use while converting a DocBook XML document: + +`xmlto -x {{stylesheet.xsl}} {{output_format}} {{document.xml}}` diff --git a/xo b/xo new file mode 100644 index 00000000..7196d80b --- /dev/null +++ b/xo @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xo + +> A pluggable, zero-configuration linting utility for JavaScript. +> More information: . + +- Lint files in the "src" directory: + +`xo` + +- Lint a given set of files: + +`xo {{path/to/file1.js path/to/file2.js ...}}` + +- Automatically fix any lint issues found: + +`xo --fix` + +- Lint using spaces as indentation instead of tabs: + +`xo --space` + +- Lint using the "prettier" code style: + +`xo --prettier` diff --git a/xonsh b/xonsh new file mode 100644 index 00000000..aea61d6d --- /dev/null +++ b/xonsh @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xonsh + +> Python-powered, cross-platform, Unix-gazing shell. +> Write and mix sh/Python code in Xonsh (pronounced conch). +> More information: . + +- Start an interactive shell session: + +`xonsh` + +- Execute a single command and then exit: + +`xonsh -c "{{command}}"` + +- Run commands from a script file and then exit: + +`xonsh {{path/to/script_file.xonsh}}` + +- Define environment variables for the shell process: + +`xonsh -D{{name1}}={{value1}} -D{{name2}}={{value2}}` + +- Load the specified `.xonsh` or `.json` configuration files: + +`xonsh --rc {{path/to/file1.xonsh}} {{path/to/file2.json}}` + +- Skip loading the `.xonshrc` configuration file: + +`xonsh --no-rc` diff --git a/xpdf b/xpdf new file mode 100644 index 00000000..116081ea --- /dev/null +++ b/xpdf @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xpdf + +> Portable Document Format (PDF) file viewer. +> More information: . + +- Open a PDF file: + +`xpdf {{path/to/file.pdf}}` + +- Open a specific page in a PDF file: + +`xpdf {{path/to/file.pdf}} :{{page_number}}` + +- Open a compressed PDF file: + +`xpdf {{path/to/file.pdf.tar}}` + +- Open a PDF file in fullscreen mode: + +`xpdf -fullscreen {{path/to/file.pdf}}` + +- Specify the initial zoom: + +`xpdf -z {{75}}% {{path/to/file.pdf}}` + +- Specify the initial zoom at page width or full page: + +`xpdf -z {{page|width}} {{path/to/file.pdf}}` diff --git a/xplr b/xplr new file mode 100644 index 00000000..da2b4db7 --- /dev/null +++ b/xplr @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xplr + +> Terminal-based file system explorer. +> More information: . + +- Open a directory: + +`xplr {{path/to/directory}}` + +- Focus on a file: + +`xplr {{path/to/file}}` + +- Focus on a directory: + +`xplr --force-focus {{path/to/directory}}` + +- Open a directory with specific files or directories selected: + +`xplr {{path/to/directory}} {{path/to/selected_file_or_directory1}} {{path/to/selected_file_or_directory2}}` diff --git a/xpmtoppm b/xpmtoppm new file mode 100644 index 00000000..20cd951c --- /dev/null +++ b/xpmtoppm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xpmtoppm + +> Convert an X11 pixmap to a PPM image. +> More information: . + +- Convert an XPM image to a PPM image: + +`xpmtoppm {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` + +- Store the transparency mask of the input image in the specified file: + +`xpmtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` diff --git a/xprop b/xprop new file mode 100644 index 00000000..813d1bb9 --- /dev/null +++ b/xprop @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xprop + +> Display window and font properties in an X server. +> More information: . + +- Display the name of the root window: + +`xprop -root WM_NAME` + +- Display the window manager hints for a window: + +`xprop -name "{{window_name}}" WM_HINTS` + +- Display the point size of a font: + +`xprop -font "{{font_name}}" POINT_SIZE` + +- Display all the properties of the window with the id 0x200007: + +`xprop -id {{0x200007}}` diff --git a/xsp b/xsp new file mode 100644 index 00000000..fd0c3285 --- /dev/null +++ b/xsp @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xsp + +> Mono ASP.NET Web Server. +> More information: . + +- Listen on all interfaces (`0.0.0.0`) and port `8080`: + +`xsp` + +- Listen on a specific IP address and port: + +`xsp --address {{127.0.0.1}} --port {{8000}}` diff --git a/xsv b/xsv new file mode 100644 index 00000000..d778492a --- /dev/null +++ b/xsv @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xsv + +> A CSV command-line toolkit written in Rust. +> More information: . + +- Inspect the headers of a file: + +`xsv headers {{path/to/file.csv}}` + +- Count the number of entries: + +`xsv count {{path/to/file.csv}}` + +- Get an overview of the shape of entries: + +`xsv stats {{path/to/file.csv}} | xsv table` + +- Select a few columns: + +`xsv select {{column1,column2}} {{path/to/file.csv}}` + +- Show 10 random entries: + +`xsv sample {{10}} {{path/to/file.csv}}` + +- Join a column from one file to another: + +`xsv join --no-case {{column1}} {{path/to/file1.csv}} {{column2}} {{path/to/file2.csv}} | xsv table` diff --git a/xteddy b/xteddy new file mode 100644 index 00000000..c8f7770f --- /dev/null +++ b/xteddy @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xteddy + +> A cuddly teddy bear for your X Windows desktop. +> More information: . + +- Display a cuddly teddy bear on your X desktop: + +`xteddy` + +- Use the window manager to display the teddy bear and ignore the "quit" (`q`) command: + +`xteddy -wm -noquit` + +- Make the teddy bear stay on top of all other windows: + +`xteddy -float` + +- Display another image [F]ile instead of the cuddly teddy bear: + +`xteddy -F {{path/to/image}}` + +- Set the initial location of the teddy bear (`width` and `height` are ignored): + +`xteddy -geometry {{width}}x{{height}}+{{x}}+{{y}}` diff --git a/xvminitoppm b/xvminitoppm new file mode 100644 index 00000000..e770f20a --- /dev/null +++ b/xvminitoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xvminitoppm + +> Convert an XV thumbnail picture to PPM. +> More information: . + +- Convert an XV thumbnail image file to PPM: + +`xvminitoppm {{path/to/input_file}} > {{path/to/output_file.ppm}}` diff --git a/xwdtopnm b/xwdtopnm new file mode 100644 index 00000000..753f5264 --- /dev/null +++ b/xwdtopnm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xwdtopnm + +> Convert an X11 or X10 window dump file to PNM. +> More information: . + +- Convert a XWD image file to PBM: + +`xwdtopnm {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` + +- Display information about the conversion process: + +`xwdtopnm -verbose {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` + +- Display the contents of the X11 header of the input file: + +`xwdtopnm -headerdump {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` diff --git a/xwininfo b/xwininfo new file mode 100644 index 00000000..e81fa6b2 --- /dev/null +++ b/xwininfo @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xwininfo + +> Display information about windows. +> See also: `xprop`, `xkill`. +> More information: . + +- Display a cursor to select a window to display its attributes (id, name, size, position, ...): + +`xwininfo` + +- Display the tree of all windows: + +`xwininfo -tree -root` + +- Display the attributes of a window with a specific ID: + +`xwininfo -id {{id}}` + +- Display the attributes of a window with a specific name: + +`xwininfo -name {{name}}` + +- Display the ID of a window searching by name: + +`xwininfo -tree -root | grep {{keyword}} | head -1 | perl -ne 'print $1 if /(0x[\da-f]+)/ig;'` diff --git a/xxd b/xxd new file mode 100644 index 00000000..5058b963 --- /dev/null +++ b/xxd @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xxd + +> Create a hexadecimal representation (hexdump) from a binary file, or vice-versa. +> More information: . + +- Generate a hexdump from a binary file and display the output: + +`xxd {{input_file}}` + +- Generate a hexdump from a binary file and save it as a text file: + +`xxd {{input_file}} {{output_file}}` + +- Display a more compact output, replacing consecutive zeros (if any) with a star: + +`xxd -a {{input_file}}` + +- Display the output with 10 columns of one octet (byte) each: + +`xxd -c {{10}} {{input_file}}` + +- Display output only up to a length of 32 bytes: + +`xxd -l {{32}} {{input_file}}` + +- Display the output in plain mode, without any gaps between the columns: + +`xxd -p {{input_file}}` + +- Revert a plaintext hexdump back into binary, and save it as a binary file: + +`xxd -r -p {{input_file}} {{output_file}}` diff --git a/xxh b/xxh new file mode 100644 index 00000000..066272cc --- /dev/null +++ b/xxh @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xxh + +> Bring your shell with all of your customizations through SSH sessions. +> Note: xxh does not install anything into system directories on the target machine; removing `~/.xxh` will clear all traces of xxh on the target machine. +> More information: . + +- Connect to a host and run the current shell: + +`xxh "{{host}}"` + +- Install the current shell into the target machine without prompting: + +`xxh "{{host}}" ++install` + +- Run the specified shell on the target machine: + +`xxh "{{host}}" ++shell {{xonsh|zsh|fish|bash|osquery}}` + +- Use a specific xxh configuration directory on the target machine: + +`xxh "{{host}}" ++host-xxh-home {{~/.xxh}}` + +- Use the specified configuration file on the host machine: + +`xxh "{{host}}" ++xxh-config {{~/.config/xxh/config.xxhc}}` + +- Specify a password to use for the SSH connection: + +`xxh "{{host}}" ++password "{{password}}"` + +- Install an xxh package on the target machine: + +`xxh "{{host}}" ++install-xxh-packages {{package}}` + +- Set an environment variable for the shell process on the target machine: + +`xxh "{{host}}" ++env {{name}}={{value}}` diff --git a/xz b/xz new file mode 100644 index 00000000..6dbb3367 --- /dev/null +++ b/xz @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xz + +> Compress or decompress `.xz` and `.lzma` files. +> More information: . + +- Compress a file using xz: + +`xz {{path/to/file}}` + +- Decompress an xz file: + +`xz --decompress {{path/to/file.xz}}` + +- Compress a file using lzma: + +`xz --format=lzma {{path/to/file}}` + +- Decompress an lzma file: + +`xz --decompress --format=lzma {{path/to/file.lzma}}` + +- Decompress a file and write to `stdout` (implies `--keep`): + +`xz --decompress --stdout {{path/to/file.xz}}` + +- Compress a file, but don't delete the original: + +`xz --keep {{path/to/file}}` + +- Compress a file using the fastest compression: + +`xz -0 {{path/to/file}}` + +- Compress a file using the best compression: + +`xz -9 {{path/to/file}}` diff --git a/xzcat b/xzcat new file mode 100644 index 00000000..d0ebf671 --- /dev/null +++ b/xzcat @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzcat + +> This command is an alias of `xz --decompress --stdout`. +> More information: . + +- View documentation for the original command: + +`tldr xz` diff --git a/xzcmp b/xzcmp new file mode 100644 index 00000000..39aa5783 --- /dev/null +++ b/xzcmp @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzcmp + +> Invokes `cmp` on files compressed with `xz`, `lzma`, `gzip`, `bzip2`, `lzop`, or `zstd`. +> All options specified are passed directly to `cmp`. +> More information: . + +- Compare two specific files: + +`xzcmp {{path/to/file1}} {{path/to/file2}}` diff --git a/xzdiff b/xzdiff new file mode 100644 index 00000000..8577a5de --- /dev/null +++ b/xzdiff @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzdiff + +> Invokes `diff` on files compressed with `xz`, `lzma`, `gzip`, `bzip2`, `lzop`, or `zstd`. +> All options specified are passed directly to `diff`. +> More information: . + +- Compare two files: + +`xzdiff {{path/to/file1}} {{path/to/file2}}` + +- Compare two files, showing the differences side by side: + +`xzdiff --side-by-side {{path/to/file1}} {{path/to/file2}}` + +- Compare two files and report only that they differ (no details on what is different): + +`xzdiff --brief {{path/to/file1}} {{path/to/file2}}` + +- Compare two files and report when the files are the same: + +`xzdiff --report-identical-files {{path/to/file1}} {{path/to/file2}}` + +- Compare two files using paginated results: + +`xzdiff --paginate {{path/to/file1}} {{path/to/file2}}` diff --git a/xzegrep b/xzegrep new file mode 100644 index 00000000..92cb34e1 --- /dev/null +++ b/xzegrep @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzegrep + +> This command is an alias of `xzgrep --extended-regexp`. +> See also: `egrep`. + +- View documentation for the original command: + +`tldr xzgrep` diff --git a/xzfgrep b/xzfgrep new file mode 100644 index 00000000..bb8980f7 --- /dev/null +++ b/xzfgrep @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzfgrep + +> This command is an alias of `xzgrep --fixed-strings`. +> See also: `fgrep`. + +- View documentation for the original command: + +`tldr xzgrep` diff --git a/xzgrep b/xzgrep new file mode 100644 index 00000000..b9fce4b0 --- /dev/null +++ b/xzgrep @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzgrep + +> Search files possibly compressed with `xz`, `lzma`, `gzip`, `bzip2`, `lzop`, or `zstd` using regular expressions. +> See also: `grep`. +> More information: . + +- Search for a pattern within a file: + +`xzgrep "{{search_pattern}}" {{path/to/file}}` + +- Search for an exact string (disables regular expressions): + +`xzgrep --fixed-strings "{{exact_string}}" {{path/to/file}}` + +- Search for a pattern in all files showing line numbers of matches: + +`xzgrep --line-number "{{search_pattern}}" {{path/to/file}}` + +- Use extended regular expressions (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: + +`xzgrep --extended-regexp --ignore-case "{{search_pattern}}" {{path/to/file}}` + +- Print 3 lines of context around, before, or after each match: + +`xzgrep --{{context|before-context|after-context}}={{3}} "{{search_pattern}}" {{path/to/file}}` + +- Print file name and line number for each match with color output: + +`xzgrep --with-filename --line-number --color=always "{{search_pattern}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`xzgrep --only-matching "{{search_pattern}}" {{path/to/file}}` diff --git a/xzless b/xzless new file mode 100644 index 00000000..5eeb6033 --- /dev/null +++ b/xzless @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzless + +> Display text from `xz` and `lzma` compressed files. +> See also: `less`. +> More information: . + +- View a compressed file: + +`xzless {{path/to/file}}` + +- View a compressed file and display line numbers: + +`xzless --LINE-NUMBERS {{path/to/file}}` + +- View a compressed file and quit if the entire file can be displayed on the first screen: + +`xzless --quit-if-one-screen {{path/to/file}}` diff --git a/xzmore b/xzmore new file mode 100644 index 00000000..4abe93f3 --- /dev/null +++ b/xzmore @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xzmore + +> Display text from `xz` or `lzma` compressed files. +> Almost equivalent to `xzless`, except it respects the `PAGER` environment variable, uses `more` by default and you cannot pass options to the pager. +> More information: . + +- View a compressed file: + +`xzmore {{path/to/file}}` diff --git a/yacas b/yacas new file mode 100644 index 00000000..c5183f5c --- /dev/null +++ b/yacas @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yacas + +> Yet Another Computer Algebra System. +> More information: . + +- Start an interactive `yacas` session: + +`yacas` + +- While in a `yacas` session, execute a statement: + +`{{Integrate(x)Cos(x)}};` + +- While in a `yacas` session, display an example: + +`{{Example()}};` + +- Quit from a `yacas` session: + +`{{quit}}` + +- Execute one or more `yacas` scripts (without terminal or prompts), then exit: + +`yacas -p -c {{path/to/script1}} {{path/to/script2}}` + +- Execute and print the result of one statement, then exit: + +`echo "{{Echo( Deriv(x)Cos(1/x) );}}" | yacas -p -c /dev/stdin` diff --git a/yacc b/yacc new file mode 100644 index 00000000..73621392 --- /dev/null +++ b/yacc @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yacc + +> Generate an LALR parser (in C) with a formal grammar specification file. +> See also: `bison`. +> More information: . + +- Create a file `y.tab.c` containing the C parser code and compile the grammar file with all necessary constant declarations for values. (Constant declarations file `y.tab.h` is created only when the `-d` flag is used): + +`yacc -d {{path/to/grammar_file.y}}` + +- Compile a grammar file containing the description of the parser and a report of conflicts generated by ambiguities in the grammar: + +`yacc -d {{path/to/grammar_file.y}} -v` + +- Compile a grammar file, and prefix output filenames with `prefix` instead of `y`: + +`yacc -d {{path/to/grammar_file.y}} -v -b {{prefix}}` diff --git a/yank b/yank new file mode 100644 index 00000000..bf41ccc4 --- /dev/null +++ b/yank @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yank + +> Read input from `stdin` and display a selection interface that allows a field to be selected and copied to the clipboard. +> More information: . + +- Yank using the default delimiters ( , +, , \s, ): + +`{{sudo dmesg}} | yank` + +- Yank an entire line: + +`{{sudo dmesg}} | yank -l` + +- Yank using a specific delimiter: + +`{{echo hello=world}} | yank -d {{=}}` + +- Only yank fields matching a specific pattern: + +`{{ps ux}} | yank -g "{{[0-9]+}}"` diff --git a/yapf b/yapf new file mode 100644 index 00000000..48bd5426 --- /dev/null +++ b/yapf @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yapf + +> Python style guide checker. +> More information: . + +- Display a diff of the changes that would be made, without making them (dry-run): + +`yapf --diff {{path/to/file}}` + +- Format the file in-place and display a diff of the changes: + +`yapf --diff --in-place {{path/to/file}}` + +- Recursively format all Python files in a directory, concurrently: + +`yapf --recursive --in-place --style {{pep8}} --parallel {{path/to/directory}}` diff --git a/yard b/yard new file mode 100644 index 00000000..94a070b9 --- /dev/null +++ b/yard @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yard + +> Documentation tool for Ruby. +> More information: . + +- Create the documentation: + +`yard` + +- Create the documentation and save it to one file: + +`yard --one-file` + +- List all undocumented objects: + +`yard stats --list-undoc` diff --git a/yarn b/yarn new file mode 100644 index 00000000..480d6f91 --- /dev/null +++ b/yarn @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yarn + +> JavaScript and Node.js package manager alternative. +> More information: . + +- Install a module globally: + +`yarn global add {{module_name}}` + +- Install all dependencies referenced in the `package.json` file (the `install` is optional): + +`yarn install` + +- Install a module and save it as a dependency to the `package.json` file (add `--dev` to save as a dev dependency): + +`yarn add {{module_name}}@{{version}}` + +- Uninstall a module and remove it from the `package.json` file: + +`yarn remove {{module_name}}` + +- Interactively create a `package.json` file: + +`yarn init` + +- Identify whether a module is a dependency and list other modules that depend upon it: + +`yarn why {{module_name}}` diff --git a/yarn-why b/yarn-why new file mode 100644 index 00000000..ca745faa --- /dev/null +++ b/yarn-why @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yarn-why + +> Identifies why a Yarn package has been installed. +> More information: . + +- Show why a Yarn package is installed: + +`yarn-why {{package}}` diff --git a/ybacklight b/ybacklight new file mode 100644 index 00000000..e10b9e91 --- /dev/null +++ b/ybacklight @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ybacklight + +> Manage screen backlight brightness. See also `xbacklight`. +> More information: . + +- Print current brightness and maximal brightness, shortened and separated by a slash: + +`ybacklight Sc/Sm` + +- Specify the brightness: + +`ybacklight s{{420}}` + +- Increase the brightness by 42 big steps (4200 by default): + +`ybacklight Si42` + +- Decrease the brightness by 300: + +`ybacklight d300` diff --git a/ybmtopbm b/ybmtopbm new file mode 100644 index 00000000..1b4cb20a --- /dev/null +++ b/ybmtopbm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ybmtopbm + +> Convert a Bennet Yee "face" file to PBM. +> More information: . + +- Convert a YBM image file to PBM: + +`ybmtopbm {{path/to/input_file.ybm}} > {{path/to/output_file.pbm}}` diff --git a/yes b/yes new file mode 100644 index 00000000..aaac098e --- /dev/null +++ b/yes @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yes + +> Output something repeatedly. +> This command is commonly used to answer yes to every prompt by install commands (such as apt-get). +> More information: . + +- Repeatedly output "message": + +`yes {{message}}` + +- Repeatedly output "y": + +`yes` + +- Accept everything prompted by the `apt-get` command: + +`yes | sudo apt-get install {{program}}` + +- Repeatedly output a newline to always accept the default option of a prompt: + +`yes ''` diff --git a/yesod b/yesod new file mode 100644 index 00000000..7663352b --- /dev/null +++ b/yesod @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yesod + +> Helper tool for Yesod, a Haskell-based web framework. +> All Yesod commands are invoked through the `stack` project manager. +> More information: . + +- Create a new scaffolded site, with SQLite as backend, in the `my-project` directory: + +`stack new {{my-project}} {{yesod-sqlite}}` + +- Install the Yesod CLI tool within a Yesod scaffolded site: + +`stack build yesod-bin cabal-install --install-ghc` + +- Start development server: + +`stack exec -- yesod devel` + +- Touch files with altered Template Haskell dependencies: + +`stack exec -- yesod touch` + +- Deploy application using Keter (Yesod's deployment manager): + +`stack exec -- yesod keter` diff --git a/ykinfo b/ykinfo new file mode 100644 index 00000000..b7c0e58a --- /dev/null +++ b/ykinfo @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykinfo + +> Get basic information from a YubiKey. +> More information: . + +- Display all information from YubiKey: + +`ykinfo -a` + +- Get only serial in decimal from YubiKey: + +`ykinfo -s -q` + +- Get capabilities from YubiKey: + +`ykinfo -c` diff --git a/ykman b/ykman new file mode 100644 index 00000000..d2d1d72d --- /dev/null +++ b/ykman @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykman + +> YubiKey Manager - configure YubiKeys. +> If there are multiple YubiKeys connected, you have to add `--device serial_number` before a subcommand. +> More information: . + +- Display general information about a YubiKey (serial number, firmware version, capabilities, etc.): + +`ykman info` + +- List connected YubiKeys with short, one-line descriptions (including the serial number): + +`ykman list` + +- View documentation for enabling and disabling applications: + +`tldr ykman config` + +- View documentation for managing the FIDO applications: + +`tldr ykman fido` + +- View documentation for managing the OATH application: + +`tldr ykman oath` + +- View documentation for managing the OpenPGP application: + +`tldr ykman openpgp` diff --git a/ykman-config b/ykman-config new file mode 100644 index 00000000..807271e0 --- /dev/null +++ b/ykman-config @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykman config + +> Enable or disable YubiKey applications. +> Note: you can use `ykman info` to see currently enabled applications. +> More information: . + +- Enable an application over USB or NFC (`--enable` can be used multiple times to specify more applications): + +`ykman config {{usb|nfc}} --enable {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` + +- Disable an application over USB or NFC (`--disable` can be used multiple times to specify more applications): + +`ykman config {{usb|nfc}} --disable {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` + +- Disable all applications over NFC: + +`ykman config nfc --disable-all` diff --git a/ykman-fido b/ykman-fido new file mode 100644 index 00000000..b15991fc --- /dev/null +++ b/ykman-fido @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykman fido + +> Manage YubiKey FIDO applications. +> More information: . + +- Display general information about the FIDO2 application: + +`ykman fido info` + +- Change the FIDO pin: + +`ykman fido access change-pin` + +- List resident credentials stored on the YubiKey: + +`ykman fido credentials list` + +- Delete a resident credential from the YubiKey: + +`ykman fido credentials delete {{id}}` + +- List fingerprints stored on the YubiKey (requires a key with a fingerprint sensor): + +`ykman fido fingerprints list` + +- Add a new fingerprint to the YubiKey: + +`ykman fido fingerprints add {{name}}` + +- Delete a fingerprint from the YubiKey: + +`ykman fido fingerprints delete {{name}}` + +- Wipe all FIDO credentials (you have to do this after exceeding the number of PIN retry attempts): + +`ykman fido reset` diff --git a/ykman-oath b/ykman-oath new file mode 100644 index 00000000..f2da074f --- /dev/null +++ b/ykman-oath @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykman oath + +> Manage the OATH YubiKey application. +> A `keyword` can be a part of the name or the issuer. +> More information: . + +- Display general information about the OATH application: + +`ykman oath info` + +- Change the password used to protect OATH accounts (add `--clear` to remove it): + +`ykman oath access change` + +- Add a new account (`--issuer` is optional): + +`ykman oath accounts add --issuer {{issuer}} {{name}}` + +- List all accounts (with their issuers): + +`ykman oath accounts list` + +- List all accounts with their current TOTP/HOTP codes (optionally filtering the list with a keyword): + +`ykman oath accounts code {{keyword}}` + +- Rename an account: + +`ykman oath accounts rename {{keyword}} {{issuer:name|name}}` + +- Delete an account: + +`ykman oath accounts delete {{keyword}}` + +- Delete all accounts and restore factory settings: + +`ykman oath reset` diff --git a/ykman-openpgp b/ykman-openpgp new file mode 100644 index 00000000..fde3fe95 --- /dev/null +++ b/ykman-openpgp @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ykman openpgp + +> Manage the OpenPGP YubiKey application. +> Note: you need to use `gpg --card-edit` for some settings. +> More information: . + +- Display general information about the OpenPGP application: + +`ykman openpgp info` + +- Set the number of retry attempts for the User PIN, Reset Code, and Admin PIN, respectively: + +`ykman openpgp access set-retries {{3}} {{3}} {{3}}` + +- Change the User PIN, Reset Code or Admin PIN: + +`ykman openpgp access change-{{pin|reset-code|admin-pin}}` + +- Factory reset the OpenPGP application (you have to do this after exceeding the number of Admin PIN retry attempts): + +`ykman openpgp reset` diff --git a/yolo b/yolo new file mode 100644 index 00000000..25ceeadb --- /dev/null +++ b/yolo @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yolo + +> The YOLO command-line interface lets you simply train, validate or infer models on various tasks and versions. +> More information: . + +- Create a copy of the default configuration in your current working directory: + +`yolo task=init` + +- Train the object detection, instance segment, or classification model with the specified configuration file: + +`yolo task={{detect|segment|classify}} mode=train cfg={{path/to/config.yaml}}` diff --git a/you-get b/you-get new file mode 100644 index 00000000..6ea9707d --- /dev/null +++ b/you-get @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# you-get + +> Download media contents (videos, audios, images) from the Web. +> More information: . + +- Print media information about a specific media on the web: + +`you-get --info {{https://example.com/video?id=value}}` + +- Download a media from a specific URL: + +`you-get {{https://example.com/video?id=value}}` + +- Search on Google Videos and download: + +`you-get {{keywords}}` + +- Download a media to a specific location: + +`you-get --output-dir {{path/to/directory}} --output-filename {{filename}} {{https://example.com/watch?v=value}}` + +- Download a media using a proxy: + +`you-get --http-proxy {{proxy_server}} {{https://example.com/watch?v=value}}` diff --git a/youtube-dl b/youtube-dl new file mode 100644 index 00000000..9fb3a8f7 --- /dev/null +++ b/youtube-dl @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# youtube-dl + +> Download videos from YouTube and other websites. +> More information: . + +- Download a video or playlist: + +`youtube-dl '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` + +- List all formats that a video or playlist is available in: + +`youtube-dl --list-formats '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` + +- Download a video or playlist at a specific quality: + +`youtube-dl --format "{{best[height<=480]}}" '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` + +- Download the audio from a video and convert it to an MP3: + +`youtube-dl -x --audio-format {{mp3}} '{{url}}'` + +- Download the best quality audio and video and merge them: + +`youtube-dl -f bestvideo+bestaudio '{{url}}'` + +- Download video(s) as MP4 files with custom filenames: + +`youtube-dl --format {{mp4}} -o "{{%(playlist_index)s-%(title)s by %(uploader)s on %(upload_date)s in %(playlist)s.%(ext)s}}" '{{url}}'` + +- Download a particular language's subtitles along with the video: + +`youtube-dl --sub-lang {{en}} --write-sub '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` + +- Download a playlist and extract MP3s from it: + +`youtube-dl -f "bestaudio" --continue --no-overwrites --ignore-errors --extract-audio --audio-format mp3 -o "%(title)s.%(ext)s" '{{url_to_playlist}}'` diff --git a/youtube-viewer b/youtube-viewer new file mode 100644 index 00000000..8fd6dd8e --- /dev/null +++ b/youtube-viewer @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# youtube-viewer + +> Command-line application for searching and playing videos from YouTube. +> More information: . + +- Search for a video: + +`youtube-viewer {{search_term}}` + +- Log in to your YouTube account: + +`youtube-viewer --login` + +- Watch a video with a specific URL in VLC: + +`youtube-viewer --player={{vlc}} {{https://youtube.com/watch?v=dQw4w9WgXcQ}}` + +- Display a search prompt and play the selected video in 720p: + +`youtube-viewer -{{7}}` diff --git a/yq b/yq new file mode 100644 index 00000000..83fcb3da --- /dev/null +++ b/yq @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yq + +> A lightweight and portable command-line YAML processor. +> More information: . + +- Output a YAML file, in pretty-print format (v4+): + +`yq eval {{path/to/file.yaml}}` + +- Output a YAML file, in pretty-print format (v3): + +`yq read {{path/to/file.yaml}} --colors` + +- Output the first element in a YAML file that contains only an array (v4+): + +`yq eval '.[0]' {{path/to/file.yaml}}` + +- Output the first element in a YAML file that contains only an array (v3): + +`yq read {{path/to/file.yaml}} '[0]'` + +- Set (or overwrite) a key to a value in a file (v4+): + +`yq eval '.{{key}} = "{{value}}"' --inplace {{path/to/file.yaml}}` + +- Set (or overwrite) a key to a value in a file (v3): + +`yq write --inplace {{path/to/file.yaml}} '{{key}}' '{{value}}'` + +- Merge two files and print to `stdout` (v4+): + +`yq eval-all 'select(filename == "{{path/to/file1.yaml}}") * select(filename == "{{path/to/file2.yaml}}")' {{path/to/file1.yaml}} {{path/to/file2.yaml}}` + +- Merge two files and print to `stdout` (v3): + +`yq merge {{path/to/file1.yaml}} {{path/to/file2.yaml}} --colors` diff --git a/yt-dlp b/yt-dlp new file mode 100644 index 00000000..5c4e0720 --- /dev/null +++ b/yt-dlp @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yt-dlp + +> A youtube-dl fork with additional features and fixes. +> Download videos from YouTube and other websites. +> More information: . + +- Download a video or playlist (with the default options from command below): + +`yt-dlp "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` + +- List the available downloadable formats for a video: + +`yt-dlp --list-formats "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` + +- Download a video with a defined format, in this case the best mp4 video available (default is "bv\*+ba/b"): + +`yt-dlp --format "{{bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4]}}" "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` + +- Extract audio from a video (requires ffmpeg or ffprobe): + +`yt-dlp --extract-audio "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` + +- Specify audio format and audio quality of extracted audio (between 0 (best) and 10 (worst), default = 5): + +`yt-dlp --extract-audio --audio-format {{mp3}} --audio-quality {{0}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` + +- Download all playlists of YouTube channel/user keeping each playlist in separate directory: + +`yt-dlp -o "{{%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s}}" "{{https://www.youtube.com/user/TheLinuxFoundation/playlists}}"` + +- Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home: + +`yt-dlp -u {{user}} -p {{password}} -P "{{~/MyVideos}}" -o "{{%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s}}" "{{https://www.udemy.com/java-tutorial}}"` + +- Download entire series season keeping each series and each season in separate directory under C:/MyVideos: + +`yt-dlp -P "{{C:/MyVideos}}" -o "{{%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s}}" "{{https://videomore.ru/kino_v_detalayah/5_sezon/367617}}"` diff --git a/yuvsplittoppm b/yuvsplittoppm new file mode 100644 index 00000000..75b41398 --- /dev/null +++ b/yuvsplittoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yuvsplittoppm + +> Convert three subsampled Abekas YUV files to one PPM image. +> More information: . + +- Read Akebas YUV bytes from three files starting with basename, merge them into a single PPM image and store it in the specified output file: + +`yuvsplittoppm {{basename}} {{width}} {{height}} > {{path/to/output_file.ppm}}` diff --git a/yuvtoppm b/yuvtoppm new file mode 100644 index 00000000..4c269540 --- /dev/null +++ b/yuvtoppm @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# yuvtoppm + +> Convert Abekas YUV bytes to PPM. +> More information: . + +- Read Akebas YUV bytes from the specified input file, convert them to a PPM image and store them in the specified output file: + +`yuvtoppm {{width}} {{height}} {{path/to/input_file.yuv}} > {{path/to/output_file.ppm}}` diff --git a/z b/z new file mode 100644 index 00000000..f08ca348 --- /dev/null +++ b/z @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# z + +> Tracks the most used (by frecency) directories and enables quickly navigating to them using string patterns or regular expressions. +> More information: . + +- Go to a directory that contains "foo" in the name: + +`z {{foo}}` + +- Go to a directory that contains "foo" and then "bar": + +`z {{foo}} {{bar}}` + +- Go to the highest-ranked directory matching "foo": + +`z -r {{foo}}` + +- Go to the most recently accessed directory matching "foo": + +`z -t {{foo}}` + +- List all directories in `z`'s database matching "foo": + +`z -l {{foo}}` + +- Remove the current directory from `z`'s database: + +`z -x .` + +- Restrict matches to subdirectories of the current directory: + +`z -c {{foo}}` diff --git a/zbarimg b/zbarimg new file mode 100644 index 00000000..3f12fdce --- /dev/null +++ b/zbarimg @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zbarimg + +> Scan and decode bar codes from image file(s). +> More information: . + +- Process an image file: + +`zbarimg {{image_file}}` diff --git a/zcat b/zcat new file mode 100644 index 00000000..6003b30e --- /dev/null +++ b/zcat @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zcat + +> Print data from `gzip` compressed files. +> More information: . + +- Print the uncompressed contents of a `gzip` archive to `stdout`: + +`zcat {{file.txt.gz}}` + +- Print compression details of a `gzip` archive to `stdout`: + +`zcat -l {{file.txt.gz}}` diff --git a/zcmp b/zcmp new file mode 100644 index 00000000..6651bc4c --- /dev/null +++ b/zcmp @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zcmp + +> Compare compressed files. +> More information: . + +- Invoke `cmp` on two files compressed via `gzip`: + +`zcmp {{path/to/file1.gz}} {{path/to/file2.gz}}` + +- Compare a file to its gzipped version (assuming `.gz` exists already): + +`zcmp {{path/to/file}}` diff --git a/zdb b/zdb new file mode 100644 index 00000000..4bd7388d --- /dev/null +++ b/zdb @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zdb + +> ZFS debugger. +> More information: . + +- Show detailed configuration of all mounted ZFS zpools: + +`zdb` + +- Show detailed configuration for a specific ZFS pool: + +`zdb -C {{poolname}}` + +- Show statistics about number, size and deduplication of blocks: + +`zdb -b {{poolname}}` diff --git a/zdiff b/zdiff new file mode 100644 index 00000000..1f2db182 --- /dev/null +++ b/zdiff @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zdiff + +> Invoke `diff` on `gzip` archives. +> More information: . + +- Compare two files, uncompressing them if necessary: + +`zdiff {{path/to/file1.gz}} {{path/to/file2.gz}}` + +- Compare a file to a `gzip` archive with the same name: + +`zdiff {{path/to/file}}` diff --git a/zeek b/zeek new file mode 100644 index 00000000..d30f3658 --- /dev/null +++ b/zeek @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zeek + +> Passive network traffic analyzer. +> Any output and log files will be saved to the current working directory. +> More information: . + +- Analyze live traffic from a network interface: + +`sudo zeek --iface {{interface}}` + +- Analyze live traffic from a network interface and load custom scripts: + +`sudo zeek --iface {{interface}} {{script1}} {{script2}}` + +- Analyze live traffic from a network interface, without loading any scripts: + +`sudo zeek --bare-mode --iface {{interface}}` + +- Analyze live traffic from a network interface, applying a `tcpdump` filter: + +`sudo zeek --filter {{path/to/filter}} --iface {{interface}}` + +- Analyze live traffic from a network interface using a watchdog timer: + +`sudo zeek --watchdog --iface {{interface}}` + +- Analyze traffic from a `pcap` file: + +`zeek --readfile {{path/to/file.trace}}` diff --git a/zegrep b/zegrep new file mode 100644 index 00000000..6bdbb35a --- /dev/null +++ b/zegrep @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zegrep + +> Find extended regular expression patterns in compressed files using `egrep`. +> More information: . + +- Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-sensitive): + +`zegrep "{{search_pattern}}" {{path/to/file}}` + +- Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-insensitive): + +`zegrep --ignore-case "{{search_pattern}}" {{path/to/file}}` + +- Search for lines that do not match a pattern: + +`zegrep --invert-match "{{search_pattern}}" {{path/to/file}}` + +- Print file name and line number for each match: + +`zegrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` + +- Search for lines matching a pattern, printing only the matched text: + +`zegrep --only-matching "{{search_pattern}}" {{path/to/file}}` + +- Recursively search files in a compressed file for a pattern: + +`zegrep --recursive "{{search_pattern}}" {{path/to/file}}` diff --git a/zeisstopnm b/zeisstopnm new file mode 100644 index 00000000..2f9d1784 --- /dev/null +++ b/zeisstopnm @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zeisstopnm + +> Convert a Zeiss confocal file to Netbpm format. +> More information: . + +- Convert a Zeiss cofocal file into either `.pgm` or `.ppm` format: + +`zeisstopnm {{path/to/file}}` + +- Convert a Zeiss cofocal file to Netbpm format while explicitly specifying the target file type: + +`zeisstopnm -{{pgm|ppm}} {{path/to/file}}` diff --git a/zek b/zek new file mode 100644 index 00000000..a105478f --- /dev/null +++ b/zek @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zek + +> Generate a Go struct from XML. +> More information: . + +- Generate a Go struct from a given XML from `stdin` and display output on `stdout`: + +`cat {{path/to/input.xml}} | zek` + +- Generate a Go struct from a given XML from `stdin` and send output to a file: + +`curl -s {{https://url/to/xml}} | zek -o {{path/to/output.go}}` + +- Generate an example Go program from a given XML from `stdin` and send output to a file: + +`cat {{path/to/input.xml}} | zek -p -o {{path/to/output.go}}` diff --git a/zellij b/zellij new file mode 100644 index 00000000..f19899cf --- /dev/null +++ b/zellij @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zellij + +> Terminal multiplexer with batteries included. +> See also `tmux` and `screen`. +> More information: . + +- Start a new named session: + +`zellij --session {{name}}` + +- List existing sessions: + +`zellij list-sessions` + +- Attach to the most recently used session: + +`zellij attach` + +- Open a new pane (inside a zellij session): + +` + N` + +- Detach from the current session (inside a zellij session): + +` + O, D` diff --git a/zfgrep b/zfgrep new file mode 100644 index 00000000..a86eadc3 --- /dev/null +++ b/zfgrep @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zfgrep + +> Matches fixed strings in possibly compressed files. +> Equivalent to `grep -F` with input decompressed first if necessary. +> More information: . + +- Search for an exact string in a file: + +`zfgrep {{search_string}} {{path/to/file}}` + +- Count the number of lines that match the given string in a file: + +`zfgrep --count {{search_string}} {{path/to/file}}` + +- Show the line number in the file along with the matching lines: + +`zfgrep --line-number {{search_string}} {{path/to/file}}` + +- Display all lines except those that contain the search string: + +`zfgrep --invert-match {{search_string}} {{path/to/file}}` + +- List only filenames whose content matches the search string at least once: + +`zfgrep --files-with-matches {{search_string}} {{path/to/file1 path/to/file2 ...}}` diff --git a/zfs b/zfs new file mode 100644 index 00000000..a64c2c7f --- /dev/null +++ b/zfs @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zfs + +> Manage ZFS filesystems. +> More information: . + +- List all available zfs filesystems: + +`zfs list` + +- Create a new ZFS filesystem: + +`zfs create {{pool_name/filesystem_name}}` + +- Delete a ZFS filesystem: + +`zfs destroy {{pool_name/filesystem_name}}` + +- Create a Snapshot of a ZFS filesystem: + +`zfs snapshot {{pool_name/filesystem_name}}@{{snapshot_name}}` + +- Enable compression on a filesystem: + +`zfs set compression=on {{pool_name/filesystem_name}}` + +- Change mountpoint for a filesystem: + +`zfs set mountpoint={{/my/mount/path}} {{pool_name/filesystem_name}}` diff --git a/zgrep b/zgrep new file mode 100644 index 00000000..59644ab9 --- /dev/null +++ b/zgrep @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zgrep + +> Grep text patterns from files within compressed file (equivalent to `grep -Z`). +> More information: . + +- Grep a pattern in a compressed file (case-sensitive): + +`zgrep {{pattern}} {{path/to/compressed/file}}` + +- Grep a pattern in a compressed file (case-insensitive): + +`zgrep -i {{pattern}} {{path/to/compressed/file}}` + +- Output count of lines containing matched pattern in a compressed file: + +`zgrep -c {{pattern}} {{path/to/compressed/file}}` + +- Display the lines which don’t have the pattern present (Invert the search function): + +`zgrep -v {{pattern}} {{path/to/compressed/file}}` + +- Grep a compressed file for multiple patterns: + +`zgrep -e "{{pattern_1}}" -e "{{pattern_2}}" {{path/to/compressed/file}}` + +- Use extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`): + +`zgrep -E {{regular_expression}} {{path/to/file}}` + +- Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: + +`zgrep -{{C|B|A}} {{3}} {{pattern}} {{path/to/compressed/file}}` diff --git a/zig b/zig new file mode 100644 index 00000000..593c0a49 --- /dev/null +++ b/zig @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zig + +> The Zig compiler and toolchain. +> More information: . + +- Compile the project in the current directory: + +`zig build` + +- Compile and run the project in the current directory: + +`zig build run` + +- Initialize a `zig build` application: + +`zig init-exe` + +- Initialize a `zig build` library: + +`zig init-lib` + +- Create and run a test build: + +`zig test {{path/to/file.zig}}` + +- Reformat Zig source into canonical form: + +`zig fmt {{path/to/file.zig}}` + +- Use Zig as a drop-in C compiler: + +`zig cc {{path/to/file.c}}` + +- Use Zig as a drop-in C++ compiler: + +`zig c++ {{path/to/file.cpp}}` diff --git a/zip b/zip new file mode 100644 index 00000000..ff3fddde --- /dev/null +++ b/zip @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zip + +> Package and compress (archive) files into `zip` archive. +> See also: `unzip`. +> More information: . + +- Add files/directories to a specific archive ([r]ecursively): + +`zip -r {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Remove files/directories from a specific archive ([d]elete): + +`zip -d {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Archive files/directories e[x]cluding specified ones: + +`zip -r {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} -x {{path/to/excluded_files_or_directories}}` + +- Archive files/directories with a specific compression level (`0` - the lowest, `9` - the highest): + +`zip -r -{{0..9}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Create an [e]ncrypted archive with a specific password: + +`zip -r -e {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Archive files/directories to a multi-part [s]plit `zip` archive (e.g. 3 GB parts): + +`zip -r -s {{3g}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` + +- Print a specific archive contents: + +`zip -sf {{path/to/compressed.zip}}` diff --git a/zip2john b/zip2john new file mode 100644 index 00000000..0d6514d0 --- /dev/null +++ b/zip2john @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zip2john + +> A tool to extract password hashes from `zip` archives for use with John the Ripper password cracker. +> This is a utility tool usually installed as part of the John the Ripper installation. +> More information: . + +- Extract the password hash from an archive, listing all files in the archive: + +`zip2john {{path/to/file.zip}}` + +- Extract the password hash using [o]nly a specific compressed file: + +`zip2john -o {{path/to/compressed_file}} {{path/to/file.zip}}` + +- Extract the password hash from a compressed file to a specific file (for use with John the Ripper): + +`zip2john -o {{path/to/compressed_file}} {{path/to/file.zip}} > {{file.hash}}` diff --git a/zipalign b/zipalign new file mode 100644 index 00000000..657c40db --- /dev/null +++ b/zipalign @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zipalign + +> Zip archive alignment tool. +> Part of the Android SDK build tools. +> More information: . + +- Align the data of a ZIP file on 4-byte boundaries: + +`zipalign {{4}} {{path/to/input.zip}} {{path/to/output.zip}}` + +- Check that a ZIP file is correctly aligned on 4-byte boundaries and display the results in a verbose manner: + +`zipalign -v -c {{4}} {{path/to/input.zip}}` diff --git a/zipgrep b/zipgrep new file mode 100644 index 00000000..e1e41be6 --- /dev/null +++ b/zipgrep @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zipgrep + +> Find patterns in files in a ZIP archive using extended regular expression (supports `?`, `+`, `{}`, `()` and `|`). +> More information: . + +- Search for a pattern within a ZIP archive: + +`zipgrep "{{search_pattern}}" {{path/to/file.zip}}` + +- Print file name and line number for each match: + +`zipgrep -H -n "{{search_pattern}}" {{path/to/file.zip}}` + +- Search for lines that do not match a pattern: + +`zipgrep -v "{{search_pattern}}" {{path/to/file.zip}}` + +- Specify files inside a ZIP archive from search: + +`zipgrep "{{search_pattern}}" {{path/to/file.zip}} {{file/to/search1}} {{file/to/search2}}` + +- Exclude files inside a ZIP archive from search: + +`zipgrep "{{search_pattern}}" {{path/to/file.zip}} -x {{file/to/exclude1}} {{file/to/exclude2}}` diff --git a/zipinfo b/zipinfo new file mode 100644 index 00000000..03894694 --- /dev/null +++ b/zipinfo @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zipinfo + +> List detailed information about the contents of a `.zip` file. +> More information: . + +- List all files in a `.zip` file in long format (permissions, ownership, size, and modification date): + +`zipinfo {{path/to/archive.zip}}` + +- List all files in a `.zip` file: + +`zipinfo -1 {{path/to/archive.zip}}` diff --git a/zipnote b/zipnote new file mode 100644 index 00000000..38863c9c --- /dev/null +++ b/zipnote @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zipnote + +> View, add, or edit a `zip` archive's comments. +> Files can also be renamed in the `zip` archive. +> More information: . + +- View the comments on a `zip` archive: + +`zipnote {{path/to/file.zip}}` + +- Extract the comments on a `zip` archive to a file: + +`zipnote {{path/to/file.zip}} > {{path/to/file.txt}}` + +- Add/Update comments in a `zip` archive from a file: + +`zipnote -w {{path/to/file.zip}} < {{path/to/file.txt}}` diff --git a/zless b/zless new file mode 100644 index 00000000..fb5e9b2b --- /dev/null +++ b/zless @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zless + +> View `gzip` and `xz` compressed files. +> More information: . + +- Page through a `gzip` compressed file with `less`: + +`zless {{file.txt.gz}}` diff --git a/zlib-flate b/zlib-flate new file mode 100644 index 00000000..33c2b47a --- /dev/null +++ b/zlib-flate @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zlib-flate + +> Raw zlib compression and decompression program. +> Part of `qpdf`. +> More information: . + +- Compress a file: + +`zlib-flate -compress < {{path/to/input_file}} > {{path/to/compressed.zlib}}` + +- Uncompress a file: + +`zlib-flate -uncompress < {{path/to/compressed.zlib}} > {{path/to/output_file}}` + +- Compress a file with a specified compression level. 0=Fastest (Worst), 9=Slowest (Best): + +`zlib-flate -compress={{compression_level}} < {{path/to/input_file}} > {{path/to/compressed.zlib}}` diff --git a/zm b/zm new file mode 100644 index 00000000..e786a558 --- /dev/null +++ b/zm @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zm + +> A tool for managing articles of newspapers and blogs. +> More information: . + +- Make a new draft: + +`zm new` + +- Edit a draft: + +`zm edit` + +- Publish a draft and commit it with git: + +`zm publish` diff --git a/zmore b/zmore new file mode 100644 index 00000000..e6b5a187 --- /dev/null +++ b/zmore @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zmore + +> View `gzip` compressed files with `more`. +> More information: . + +- Open a compressed file: + +`zmore {{path/to/file.txt.gz}}` + +- Display the next page of the file: + +`` + +- Search for a pattern in the file (press `n` to go to next match): + +`/{{regular_expression}}` + +- Exit: + +`q` + +- Display interactive command help: + +`h` diff --git a/zmv b/zmv new file mode 100644 index 00000000..219774a3 --- /dev/null +++ b/zmv @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zmv + +> Move or rename files matching a specified extended glob pattern. +> See also `zcp` and `zln`. +> More information: . + +- Move files using a regular expression-like pattern: + +`zmv '{{(*).log}}' '{{$1.txt}}'` + +- Preview the result of a move, without making any actual changes: + +`zmv -n '{{(*).log}}' '{{$1.txt}}'` + +- Interactively move files, with a prompt before every change: + +`zmv -i '{{(*).log}}' '{{$1.txt}}'` + +- Verbosely print each action as it's being executed: + +`zmv -v '{{(*).log}}' '{{$1.txt}}'` diff --git a/znew b/znew new file mode 100644 index 00000000..d1c32c9f --- /dev/null +++ b/znew @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# znew + +> Recompress files from `.Z` to `.gz` format. +> More information: . + +- Recompress a file from `.Z` to `.gz` format: + +`znew {{path/to/file1.Z}}` + +- Recompress multiple files and display the achieved size reduction % per file: + +`znew -v {{path/to/file1.Z path/to/file2.Z ...}}` + +- Recompress a file using the slowest compression method (for optimal compression): + +`znew -9 {{path/to/file1.Z}}` + +- Recompress a file, [K]eeping the `.Z` file if it is smaller than the `.gz` file: + +`znew -K {{path/to/file1.Z}}` diff --git a/zola b/zola new file mode 100644 index 00000000..f8aec594 --- /dev/null +++ b/zola @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zola + +> A static site generator in a single binary with everything built-in. +> More information: . + +- Create the directory structure used by Zola at the given directory: + +`zola init {{my_site}}` + +- Build the whole site in the `public` directory after deleting it: + +`zola build` + +- Build the whole site into a different 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`): + +`zola serve` + +- Build all pages just like the build command would, but without writing any of the results to disk: + +`zola check` diff --git a/zopflipng b/zopflipng new file mode 100644 index 00000000..8fb8b648 --- /dev/null +++ b/zopflipng @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zopflipng + +> PNG compression utility. +> More information: . + +- Optimize a PNG: + +`zopflipng {{input.png}} {{output.png}}` + +- Optimize several PNGs and save with given prefix: + +`zopflipng --prefix={{prefix}} {{image1.png}} {{image2.png}} {{image3.png}}` diff --git a/zotero b/zotero new file mode 100644 index 00000000..f0868f4c --- /dev/null +++ b/zotero @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zotero + +> Manage your bibliographies. +> More information: . + +- Run with the GUI: + +`zotero` + +- Run in headless mode: + +`zotero --headless` + +- Run with a specific profile: + +`zotero -P {{profile}}` + +- Run the Migration Assistant: + +`zotero --migration` diff --git a/zoxide b/zoxide new file mode 100644 index 00000000..0611851a --- /dev/null +++ b/zoxide @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zoxide + +> Keep track of the most frequently used directories. +> Uses a ranking algorithm to navigate to the best match. +> More information: . + +- Go to the highest-ranked directory that contains "foo" in the name: + +`zoxide query {{foo}}` + +- Go to the highest-ranked directory that contains "foo" and then "bar": + +`zoxide query {{foo}} {{bar}}` + +- Start an interactive directory search (requires `fzf`): + +`zoxide query --interactive` + +- Add a directory or increment its rank: + +`zoxide add {{path/to/directory}}` + +- Remove a directory from `zoxide`'s database interactively: + +`zoxide remove {{path/to/directory}} --interactive` + +- Generate shell configuration for command aliases (`z`, `za`, `zi`, `zq`, `zr`): + +`zoxide init {{bash|fish|zsh}}` diff --git a/zpool b/zpool new file mode 100644 index 00000000..334c8c82 --- /dev/null +++ b/zpool @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zpool + +> Manage ZFS pools. +> More information: . + +- Show the configuration and status of all ZFS zpools: + +`zpool status` + +- Check a ZFS pool for errors (verifies the checksum of EVERY block). Very CPU and disk intensive: + +`zpool scrub {{pool_name}}` + +- List zpools available for import: + +`zpool import` + +- Import a zpool: + +`zpool import {{pool_name}}` + +- Export a zpool (unmount all filesystems): + +`zpool export {{pool_name}}` + +- Show the history of all pool operations: + +`zpool history {{pool_name}}` + +- Create a mirrored pool: + +`zpool create {{pool_name}} mirror {{disk1}} {{disk2}} mirror {{disk3}} {{disk4}}` + +- Add a cache (L2ARC) device to a zpool: + +`zpool add {{pool_name}} cache {{cache_disk}}` diff --git a/zrun b/zrun new file mode 100644 index 00000000..91cdfb59 --- /dev/null +++ b/zrun @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zrun + +> Transparently uncompress argument files to a command. +> More information: . + +- Run the specified command with uncompressed versions of the compressed argument files: + +`zrun {{cat path/to/file1.gz path/to/file2.bz2 ...}}` diff --git a/zsh b/zsh new file mode 100644 index 00000000..a2972c2f --- /dev/null +++ b/zsh @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zsh + +> Z SHell, a Bash-compatible command-line interpreter. +> See also: `bash`, `histexpand`. +> More information: . + +- Start an interactive shell session: + +`zsh` + +- Execute specific [c]ommands: + +`zsh -c "{{echo Hello world}}"` + +- Execute a specific script: + +`zsh {{path/to/script.zsh}}` + +- Check a specific script for syntax errors without executing it: + +`zsh --no-exec {{path/to/script.zsh}}` + +- Execute specific commands from `stdin`: + +`{{echo Hello world}} | zsh` + +- Execute a specific script, printing each command in the script before executing it: + +`zsh --xtrace {{path/to/script.zsh}}` + +- Start an interactive shell session in verbose mode, printing each command before executing it: + +`zsh --verbose` + +- Execute a specific command inside `zsh` with disabled glob patterns: + +`noglob {{command}}` diff --git a/zstd b/zstd new file mode 100644 index 00000000..8d6827a3 --- /dev/null +++ b/zstd @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zstd + +> Compress or decompress files with Zstandard compression. +> More information: . + +- Compress a file into a new file with the `.zst` suffix: + +`zstd {{path/to/file}}` + +- Decompress a file: + +`zstd --decompress {{path/to/file.zst}}` + +- Decompress to `stdout`: + +`zstd --decompress --stdout {{path/to/file.zst}}` + +- Compress a file specifying the compression level, where 1=fastest, 19=slowest and 3=default: + +`zstd -{{level}} {{path/to/file}}` + +- Unlock higher compression levels (up to 22) using more memory (both for compression and decompression): + +`zstd --ultra -{{level}} {{path/to/file}}` diff --git a/zstdcat b/zstdcat new file mode 100644 index 00000000..2eb98f44 --- /dev/null +++ b/zstdcat @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zstdcat + +> This command is an alias of `zstd --decompress --stdout`. + +- View documentation for the original command: + +`tldr zstd` diff --git a/zstdless b/zstdless new file mode 100644 index 00000000..3cb3abdd --- /dev/null +++ b/zstdless @@ -0,0 +1,14 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zstdless + +> Open a `zstd` compressed file for interactive reading, allowing scrolling and search. +> See also: `zstd`, `less`. +> More information: . + +- Open a `zstd` compressed file: + +`zstdless {{path/to/file.zst}}` diff --git a/zstdmt b/zstdmt new file mode 100644 index 00000000..8dcd646e --- /dev/null +++ b/zstdmt @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zstdmt + +> This command is an alias of `zstd --threads 0` (which sets the number of working threads to the number of physical CPU cores). + +- View documentation for the original command: + +`tldr zstd` diff --git a/zsteg b/zsteg new file mode 100644 index 00000000..d82f924a --- /dev/null +++ b/zsteg @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# zsteg + +> Steganography detection tool for PNG and BMP file formats. +> It detects LSB steganography, ZLIB-compressed data, OpenStego, Camouflage and LSB with the Eratosthenes set. +> More information: . + +- Detect embedded data in a PNG: + +`zsteg {{path/to/image.png}}` + +- Detect embedded data in a BMP image, using all known methods: + +`zsteg --all {{path/to/image.bmp}}` + +- Detect embedded data in a PNG, iterating pixels vertically and using MSB first: + +`zsteg --msb --order yx {{path/to/image.png}}` + +- Detect embedded data in a BMP image, specifying the bits to consider: + +`zsteg --bits {{1,2,3|1-3}} {{path/to/image.bmp}}` + +- Detect embedded data in a PNG, extracting only prime pixels and inverting bits: + +`zsteg --prime --invert {{path/to/image.png}}` + +- Detect embedded data in a BMP image, specifying the minimum length of the strings to be found and the find mode: + +`zsteg --min-str-len {{10}} --strings {{first|all|longest|none}} {{path/to/image.bmp}}`