From 048e3ad81e399f38e2d7921cebd9b2312346a451 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Tue, 25 Nov 2025 00:19:28 +0000 Subject: [PATCH] Update cheatsheets --- tldr/2to3 | 12 ++++++------ tldr/acme.sh | 2 +- tldr/aria2c | 10 +++++----- tldr/astyle | 10 +++++----- tldr/audacious | 14 +++++++------- tldr/bloodhound-python | 2 +- tldr/bq | 2 +- tldr/bun-create | 2 +- tldr/cake | 2 +- tldr/checksec | 2 +- tldr/chezmoi | 2 +- tldr/clang++ | 2 +- tldr/cppcheck | 2 +- tldr/diffoscope | 2 +- tldr/distccd | 2 +- tldr/docsify | 4 ++-- tldr/duc | 2 +- tldr/duckdb | 2 +- tldr/dune | 2 +- tldr/duplicity | 2 +- tldr/eksctl | 2 +- tldr/electrum | 2 +- tldr/eslint | 2 +- tldr/espeak | 2 +- tldr/exiftool | 2 +- tldr/filebrowser | 2 +- tldr/fping | 2 +- tldr/freshclam | 2 +- tldr/frpc | 4 ++-- tldr/frps | 4 ++-- tldr/git-clean | 2 +- tldr/git-cola | 2 +- tldr/gnmic | 2 +- tldr/gopass | 2 +- tldr/gource | 2 +- tldr/gradle | 2 +- tldr/httpx | 2 +- tldr/hugo | 2 +- tldr/imapsync | 2 +- tldr/infection | 6 +++--- tldr/inkscape | 2 +- tldr/iperf | 2 +- tldr/iperf3 | 2 +- tldr/ipfs | 6 +++--- tldr/ipython | 2 +- tldr/irssi | 2 +- tldr/jekyll | 2 +- tldr/jest | 4 ++-- tldr/jj-interdiff | 37 +++++++++++++++++++++++++++++++++++++ tldr/joe | 2 +- tldr/jrnl | 2 +- tldr/json5 | 10 +++++----- tldr/jupytext | 4 ++-- tldr/kdeconnect-cli | 4 ++-- tldr/ledger | 4 ++-- tldr/lerna | 2 +- tldr/lilypond | 2 +- tldr/linux/aide | 2 +- tldr/linux/archinstall | 6 +----- tldr/linux/autorecon | 2 +- tldr/linux/ctr | 2 +- tldr/linux/darling | 2 +- tldr/linux/goaccess | 2 +- tldr/linux/lsinitrd | 4 ++-- tldr/linux/ltrace | 2 +- tldr/linux/nixos-option | 2 +- tldr/linux/perf | 2 +- tldr/linux/pstoedit | 2 +- tldr/linux/slapt-get | 2 +- tldr/linux/stratis | 2 +- tldr/linux/tshark | 2 +- tldr/lmms | 6 +++--- tldr/locust | 18 +++++++++--------- tldr/magick | 2 +- tldr/mc.fm | 2 +- tldr/meteor | 2 +- tldr/mh_lint | 2 +- tldr/mh_metric | 2 +- tldr/micro | 2 +- tldr/mise | 4 ++-- tldr/mkdocs | 2 +- tldr/mlr | 2 +- tldr/mocha | 8 ++++---- tldr/molecule | 2 +- tldr/moro | 2 +- tldr/mpv | 2 +- tldr/mr | 2 +- tldr/mumble | 2 +- tldr/nextflow | 2 +- tldr/node | 2 +- tldr/offlineimap | 2 +- tldr/optipng | 2 +- tldr/osx/mate | 8 ++++---- tldr/osx/orb | 2 +- tldr/osx/valet | 2 +- tldr/osx/wacaw | 8 ++++---- tldr/p7zip | 2 +- tldr/pass | 2 +- tldr/pdfposter | 6 +++--- tldr/phpdox | 2 +- tldr/phpspec | 2 +- tldr/phpunit | 2 +- tldr/pipes.sh | 2 +- tldr/pixi | 2 +- tldr/pulumi-login | 2 +- tldr/pygbag | 2 +- tldr/surge | 2 +- tldr/vitest | 6 +++--- tldr/xh | 2 +- tldr/xml-format | 4 ++-- 110 files changed, 206 insertions(+), 173 deletions(-) create mode 100644 tldr/jj-interdiff diff --git a/tldr/2to3 b/tldr/2to3 index 01cff661..2e522f1d 100644 --- a/tldr/2to3 +++ b/tldr/2to3 @@ -16,24 +16,24 @@ source: https://github.com/tldr-pages/tldr.git - Convert a Python 2 file to Python 3: -`2to3 --write {{path/to/file.py}}` +`2to3 {{[-w|--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}}` +`2to3 {{[-w|--write]}} {{path/to/file.py}} {{[-f|--fix]}} {{raw_input}} {{[-f|--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}}` +`2to3 {{[-w|--write]}} {{path/to/file.py}} {{[-x|--nofix]}} {{has_key}} {{[-x|--nofix]}} {{isinstance}}` - List all available language features that can be converted from Python 2 to Python 3: -`2to3 --list-fixes` +`2to3 {{[-l|--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}}` +`2to3 {{[-o|--output-dir]}} {{path/to/python3_directory}} {{[-W|--write-unchanged-files]}} {{[-n|--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}}` +`2to3 {{[-j|--processes]}} {{4}} {{[-o|--output-dir]}} {{path/to/python3_directory}} {{[-w|--write]}} {{[-n|--nobackups]}} --no-diffs {{path/to/python2_directory}}` diff --git a/tldr/acme.sh b/tldr/acme.sh index e612a5f8..1e8cc114 100644 --- a/tldr/acme.sh +++ b/tldr/acme.sh @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Shell script implementing ACME client protocol, an alternative to `certbot`. > See also: `acme.sh dns`. -> More information: . +> More information: . - Issue a certificate using webroot mode: diff --git a/tldr/aria2c b/tldr/aria2c index ff01eba2..ff37d166 100644 --- a/tldr/aria2c +++ b/tldr/aria2c @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Fast download utility. > Supports HTTP(S), FTP, SFTP, BitTorrent, and Metalink. -> More information: . +> More information: . - Download a specific URI to a file: @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Download a file from a URI with a specific output name: -`aria2c --out {{path/to/file}} "{{url}}"` +`aria2c {{[-o|--out]}} {{path/to/file}} "{{url}}"` - Download multiple different files in parallel: -`aria2c --force-sequential {{false}} "{{url1 url2 ...}}"` +`aria2c {{[-Z|--force-sequential]}} {{false}} "{{url1 url2 ...}}"` - Download the same file from different mirrors and verify the checksum of the downloaded file: @@ -27,11 +27,11 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`aria2c {{[-i|--input-file]}} {{path/to/file}} {{[-j|--max-concurrent-downloads]}} {{number_of_downloads}}` - Download with multiple connections: -`aria2c --split {{number_of_connections}} "{{url}}"` +`aria2c {{[-s|--split]}} {{number_of_connections}} "{{url}}"` - FTP download with username and password: diff --git a/tldr/astyle b/tldr/astyle index 192113c2..7a8289b1 100644 --- a/tldr/astyle +++ b/tldr/astyle @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: . +> More information: . - Apply the default style of 4 spaces per indent and no formatting changes: @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Apply the Java style with attached braces: -`astyle --style=java {{path/to/file}}` +`astyle {{[-A2|--style=java]}} {{path/to/file}}` - Apply the allman style with broken braces: -`astyle --style=allman {{path/to/file}}` +`astyle {{[-A1|--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}}` +`astyle {{[-s|--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}}` +`astyle {{[-t|--indent=tab=]}}{{number_of_tabs}} {{path/to/file}}` diff --git a/tldr/audacious b/tldr/audacious index cd1ae43f..12852e40 100755 --- a/tldr/audacious +++ b/tldr/audacious @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > An open-source audio player. Indirectly based on XMMS. > See also: `audtool`, `clementine`, `mpc`, `ncmpcpp`. -> More information: . +> More information: . - Launch the GUI: @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Start a new instance and play an audio: -`audacious --new-instance {{path/to/audio}}` +`audacious {{[-N|--new-instance]}} {{path/to/audio}}` - Enqueue a specific directory of audio files: -`audacious --enqueue {{path/to/directory}}` +`audacious {{[-e|--enqueue]}} {{path/to/directory}}` - Start or stop playback: -`audacious --play-pause` +`audacious {{[-t|--play-pause]}}` - Skip forwards ([fwd]) or backwards ([rew]) in the playlist: @@ -31,12 +31,12 @@ source: https://github.com/tldr-pages/tldr.git - Stop playback: -`audacious --stop` +`audacious {{[-s|--stop]}}` - Start in CLI mode (headless): -`audacious --headless` +`audacious {{[-H|--headless]}}` - Exit as soon as playback stops or there is nothing to playback: -`audacious --quit-after-play` +`audacious {{[-q|--quit-after-play]}}` diff --git a/tldr/bloodhound-python b/tldr/bloodhound-python index 56f841b6..5681eea8 100644 --- a/tldr/bloodhound-python +++ b/tldr/bloodhound-python @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bloodhound-python > A Python ingestor for BloodHound, used to enumerate Active Directory relationships. -> More information: . +> More information: . - Collect all data using default collection methods (includes groups, sessions, and trusts): diff --git a/tldr/bq b/tldr/bq index 3050d4a1..5135ea19 100644 --- a/tldr/bq +++ b/tldr/bq @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`bq load --location {{location}} --source_format {{CSV|JSON|PARQUET|AVRO}} {{dataset}}.{{table}} {{path/to/source}}` - Copy one table to another: diff --git a/tldr/bun-create b/tldr/bun-create index ce9305c2..2bd94ef6 100644 --- a/tldr/bun-create +++ b/tldr/bun-create @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a new project from a local template: -`bun create {{./path/to/template}} {{path/to/destination}}` +`bun create {{path/to/template}} {{path/to/destination}}` - Create a new project, overwriting the destination directory if it exists: diff --git a/tldr/cake b/tldr/cake index fefcc538..860f4c73 100644 --- a/tldr/cake +++ b/tldr/cake @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cake > The processor for the CakePHP framework. -> More information: . +> More information: . - Display basic information about the current app and available commands: diff --git a/tldr/checksec b/tldr/checksec index 233e0c94..898d6f35 100644 --- a/tldr/checksec +++ b/tldr/checksec @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # checksec > Check security properties of executables. -> More information: . +> More information: . - List security properties of an executable binary file: diff --git a/tldr/chezmoi b/tldr/chezmoi index d23b3319..6d83d738 100644 --- a/tldr/chezmoi +++ b/tldr/chezmoi @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A multi-machine dotfile manager, written in Go. > See also: `stow`, `tuckr`, `vcsh`, `homeshick`. -> More information: . +> More information: . - Setup up `chezmoi`, creating a Git repository in `~/.local/share/chezmoi`: diff --git a/tldr/clang++ b/tldr/clang++ index acef1048..ba9305e0 100644 --- a/tldr/clang++ +++ b/tldr/clang++ @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Compile C++ source files. > Part of LLVM. -> More information: . +> More information: . - Compile a set of source code files into an executable binary: diff --git a/tldr/cppcheck b/tldr/cppcheck index e1c830d8..9f42fef1 100644 --- a/tldr/cppcheck +++ b/tldr/cppcheck @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: . +> More information: . - Recursively check the current directory, showing progress on the screen and logging error messages to a file: diff --git a/tldr/diffoscope b/tldr/diffoscope index 51cbf303..4c0a8826 100644 --- a/tldr/diffoscope +++ b/tldr/diffoscope @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # diffoscope > Compare files, archives, and directories. -> More information: . +> More information: . - Compare two files: diff --git a/tldr/distccd b/tldr/distccd index 7c2ba7c3..a0edde5f 100644 --- a/tldr/distccd +++ b/tldr/distccd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # distccd > Server daemon for the distcc distributed compiler. -> More information: . +> More information: . - Start a daemon with the default settings: diff --git a/tldr/docsify b/tldr/docsify index 3f40c02d..8fa26ddf 100644 --- a/tldr/docsify +++ b/tldr/docsify @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # docsify > Initialize and serve markdown documentation. -> More information: . +> More information: . - Initialize a new documentation in the current directory: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Serve local documentation on `localhost` at the specified port: -`docsify serve --port {{80}} {{path/to/directory}}` +`docsify serve {{[-p|--port]}} {{80}} {{path/to/directory}}` - Generate a sidebar markdown file in the specified directory: diff --git a/tldr/duc b/tldr/duc index ac8200df..6450ce05 100644 --- a/tldr/duc +++ b/tldr/duc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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 in this database, or creating fancy graphs to show where data is. -> More information: . +> More information: . - Index the `/usr` directory, writing to the default database location `~/.duc.db`: diff --git a/tldr/duckdb b/tldr/duckdb index a188fba3..f164a35e 100644 --- a/tldr/duckdb +++ b/tldr/duckdb @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # duckdb > Client for DuckDB, an in-process analytical SQL engine. -> More information: . +> More information: . - Start an interactive shell with a transient in-memory database: diff --git a/tldr/dune b/tldr/dune index dd490fb6..b3ea5fdf 100644 --- a/tldr/dune +++ b/tldr/dune @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dune > A build system for OCaml programs. -> More information: . +> More information: . - Build all targets: diff --git a/tldr/duplicity b/tldr/duplicity index bbf22630..51e76a6d 100644 --- a/tldr/duplicity +++ b/tldr/duplicity @@ -32,4 +32,4 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`PASSPHRASE={{gpg_key_password}} duplicity restore --encrypt-key {{gpg_key_id}} --path-to-restore {{path/to/restore_directory}} file://{{absolute/path/to/backup_directory}} {{path/to/directory_to_restore_to}}` diff --git a/tldr/eksctl b/tldr/eksctl index 3cfd95a6..b701eb2d 100644 --- a/tldr/eksctl +++ b/tldr/eksctl @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a cluster using a configuration file and skip creating nodegroups until later: -`eksctl create cluster --config-file= --without-nodegroup` +`eksctl create cluster --config-file={{path/to/file}} --without-nodegroup` - Delete a cluster: diff --git a/tldr/electrum b/tldr/electrum index f51a2354..7de6cbb9 100644 --- a/tldr/electrum +++ b/tldr/electrum @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # electrum > Ergonomic Bitcoin wallet and private key management. -> More information: . +> More information: . - Create a new wallet: diff --git a/tldr/eslint b/tldr/eslint index 288a0ab9..29ae273d 100644 --- a/tldr/eslint +++ b/tldr/eslint @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # eslint > A pluggable linting utility for JavaScript and JSX. -> More information: . +> More information: . - Create the ESLint configuration file: diff --git a/tldr/espeak b/tldr/espeak index 32fc2405..85f738dd 100644 --- a/tldr/espeak +++ b/tldr/espeak @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # espeak > Use text-to-speech to speak through the default sound device. -> More information: . +> More information: . - Speak a phrase aloud: diff --git a/tldr/exiftool b/tldr/exiftool index 7fd1f5a7..9c0255d7 100644 --- a/tldr/exiftool +++ b/tldr/exiftool @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # exiftool > Read and write meta information in files. -> More information: . +> More information: . - Print the EXIF metadata for a given file: diff --git a/tldr/filebrowser b/tldr/filebrowser index 1b6a5f92..ca89f197 100644 --- a/tldr/filebrowser +++ b/tldr/filebrowser @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # filebrowser > Simple HTTP web server to manage files and directories. -> More information: . +> More information: . - Start a new server instance serving the current directory: diff --git a/tldr/fping b/tldr/fping index 3acbef04..0b839430 100644 --- a/tldr/fping +++ b/tldr/fping @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fping > A more powerful ping which can ping multiple hosts. -> More information: . +> More information: . - List the status of all hosts within a range: diff --git a/tldr/freshclam b/tldr/freshclam index dc1df9e6..49102d4d 100644 --- a/tldr/freshclam +++ b/tldr/freshclam @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # freshclam > Update virus definitions for ClamAV antivirus program. -> More information: . +> More information: . - Update virus definitions: diff --git a/tldr/frpc b/tldr/frpc index 84501d76..dfef96d3 100644 --- a/tldr/frpc +++ b/tldr/frpc @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `frpc` -- Start the service, using the newer TOML configuration file (`frps.toml` instead of `frps.ini`) in the current directory: +- Start the service, using the newer TOML configuration file: -`frpc {{[-c|--config]}} ./frps.toml` +`frpc {{[-c|--config]}} {{path/to/frps.toml}}` - Start the service, using a specific configuration file: diff --git a/tldr/frps b/tldr/frps index 99a02bdd..dd7541e9 100644 --- a/tldr/frps +++ b/tldr/frps @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `frps` -- Start the service, using the newer TOML configuration file (`frps.toml` instead of `frps.ini`) in the current directory: +- Start the service, using the newer TOML configuration file: -`frps {{[-c|--config]}} ./frps.toml` +`frps {{[-c|--config]}} {{path/to/frps.toml}}` - Start the service, using a specified configuration file: diff --git a/tldr/git-clean b/tldr/git-clean index e757b044..3c7cec46 100644 --- a/tldr/git-clean +++ b/tldr/git-clean @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete untracked files except those matching the given patterns: -`git clean {{[-f|--force]}} {{[-e|--exclude]}} {{'*.ext'}} {{[-e|--exclude]}} {{path/to/directory/}}` +`git clean {{[-f|--force]}} {{[-e|--exclude]}} {{'*.ext'}} {{[-e|--exclude]}} {{path/to/directory}}/` - Delete untracked files and e[x]cluded files (those listed in `.gitignore` and `.git/info/exclude`): diff --git a/tldr/git-cola b/tldr/git-cola index e619f429..18c7c527 100644 --- a/tldr/git-cola +++ b/tldr/git-cola @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # git cola > A powerful Git GUI with a slick and intuitive user interface. -> More information: . +> More information: . - Start the GUI: diff --git a/tldr/gnmic b/tldr/gnmic index 9048f1e8..b8a425d0 100644 --- a/tldr/gnmic +++ b/tldr/gnmic @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A gNMI client. > Manage gNMI network device configuration and view operational data. -> More information: . +> More information: . - Request device capabilities: diff --git a/tldr/gopass b/tldr/gopass index e490101f..f19d1a73 100644 --- a/tldr/gopass +++ b/tldr/gopass @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gopass > Standard Unix Password Manager for Teams. Written in Go. -> More information: . +> More information: . - Initialize the configuration settings: diff --git a/tldr/gource b/tldr/gource index 600e948c..35fa8e13 100644 --- a/tldr/gource +++ b/tldr/gource @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: . +> More information: . - Run gource in a directory (if it isn't the repository's root directory, the root is sought up from there): diff --git a/tldr/gradle b/tldr/gradle index 54970fbe..6c90b490 100644 --- a/tldr/gradle +++ b/tldr/gradle @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gradle > An open source build automation system. -> More information: . +> More information: . - Compile a package: diff --git a/tldr/httpx b/tldr/httpx index c367ef4c..db1bcd35 100644 --- a/tldr/httpx +++ b/tldr/httpx @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `httpx {{[-u|-target]}} {{host1,host2,...}} {{[-mc|-match-code]}} {{200,301,304}}` -- Run a probe against a URL saving screenshots of certain paths, with screenshot timeouts (assets are saved in `./output`): +- Run a probe against a URL saving screenshots of certain paths, with screenshot timeouts (assets are saved in `output`): `httpx {{[-u|-target]}} {{https://www.github.com}} -path {{/tldr-pages/tldr,/projectdiscovery/httpx}} {{[-ss|-screenshot]}} {{[-st|-screenshot-timeout]}} {{10}}` diff --git a/tldr/hugo b/tldr/hugo index 172d4fdf..d8867dad 100644 --- a/tldr/hugo +++ b/tldr/hugo @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `hugo new {{section_name}}/{{page_name}}` -- Build a site to the `./public/` directory: +- Build a site to the `public` directory: `hugo` diff --git a/tldr/imapsync b/tldr/imapsync index 9590c9cd..51bc75b1 100644 --- a/tldr/imapsync +++ b/tldr/imapsync @@ -6,7 +6,7 @@ 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: . +> More information: . - Synchronize IMAP account between host1 and host2: diff --git a/tldr/infection b/tldr/infection index f0977ea4..66f5da29 100644 --- a/tldr/infection +++ b/tldr/infection @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # infection > A mutation testing framework for PHP. -> More information: . +> More information: . - Analyze code using the configuration file (or create one if it does not exist): @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a specific number of threads: -`infection --threads {{number_of_threads}}` +`infection {{[-j|--threads]}} {{number_of_threads}}` - Specify a minimum Mutation Score Indicator (MSI): @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the mutation code that has been applied: -`infection --show-mutations` +`infection {{[-s|--show-mutations]}}` - Specify the log verbosity: diff --git a/tldr/inkscape b/tldr/inkscape index cac07d1f..f0830ec3 100644 --- a/tldr/inkscape +++ b/tldr/inkscape @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > An SVG (Scalable Vector Graphics) editing program. > For Inkscape versions up to 0.92.x, use -e instead of -o. -> More information: . +> More information: . - Open an SVG file in the Inkscape GUI: diff --git a/tldr/iperf b/tldr/iperf index 543035a3..c0b2252b 100644 --- a/tldr/iperf +++ b/tldr/iperf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # iperf > Measure network bandwidth between computers. -> More information: . +> More information: . - Run on server: diff --git a/tldr/iperf3 b/tldr/iperf3 index 2350d7f6..dd5e8ed9 100644 --- a/tldr/iperf3 +++ b/tldr/iperf3 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # iperf3 > Traffic generator for testing network bandwidth. -> More information: . +> More information: . - Run iperf3 as a server: diff --git a/tldr/ipfs b/tldr/ipfs index b0140022..c791e7d8 100644 --- a/tldr/ipfs +++ b/tldr/ipfs @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Inter Planetary File System. > A peer-to-peer hypermedia protocol. Aims to make the web more open. -> More information: . +> More information: . - Add a file from local to the filesystem, pin it and print the relative hash: @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Add a directory and its files recursively from local to the filesystem and print the relative hash: -`ipfs add -r {{path/to/directory}}` +`ipfs add {{[-r|--recursive]}} {{path/to/directory}}` - Save a remote file and give it a name but not pin it: -`ipfs get {{hash}} -o {{path/to/file}}` +`ipfs get {{hash}} {{[-o|--output]}} {{path/to/file}}` - Pin a remote file locally: diff --git a/tldr/ipython b/tldr/ipython index f0e02850..74115226 100644 --- a/tldr/ipython +++ b/tldr/ipython @@ -6,7 +6,7 @@ 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: . +> More information: . - Start a REPL (interactive shell): diff --git a/tldr/irssi b/tldr/irssi index 6b504fe0..81d0d855 100644 --- a/tldr/irssi +++ b/tldr/irssi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # irssi > Text based IRC client. -> More information: . +> More information: . - Open Irssi and connect to a server with a nickname: diff --git a/tldr/jekyll b/tldr/jekyll index 3d6f0825..421619e8 100644 --- a/tldr/jekyll +++ b/tldr/jekyll @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > A simple, blog-aware, static site generator. > More information: . -- Generate a development server that will run at http://localhost:4000/: +- Generate a development server that will run at : `jekyll serve` diff --git a/tldr/jest b/tldr/jest index e6971706..f66289e4 100644 --- a/tldr/jest +++ b/tldr/jest @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jest > A zero-configuration JavaScript testing platform. -> More information: . +> More information: . - Run all available tests: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Run the test suites from files within the current and subdirectories, whose paths match the given `regex`: -`jest {{regex1}} {{regex2}}` +`jest {{regex1 regex2 ...}}` - Run the tests whose names match the given `regex`: diff --git a/tldr/jj-interdiff b/tldr/jj-interdiff new file mode 100644 index 00000000..d0dfbd16 --- /dev/null +++ b/tldr/jj-interdiff @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# jj interdiff + +> Compare changes of two revisions. +> More information: . + +- Compare changes from a revision to the working copy: + +`jj interdiff {{[-f|--from]}} {{revset}}` + +- Compare changes from a revision to another revision: + +`jj interdiff {{[-f|--from]}} {{from_revset}} {{[-t|--to]}} {{to_revset}}` + +- Compare changes in specific paths only: + +`jj interdiff {{[-f|--from]}} {{from_revset}} {{[-t|--to]}} {{to_revset}} {{filesets}}` + +- Show a summary of changes: + +`jj interdiff {{[-f|--from]}} {{revset}} {{[-s|--summary]}}` + +- Show diff statistics: + +`jj interdiff {{[-f|--from]}} {{revset}} --stat` + +- Show a Git-format diff: + +`jj interdiff {{[-f|--from]}} {{revset}} --git` + +- Show a word-level diff with changes indicated only by color: + +`jj interdiff {{[-f|--from]}} {{revset}} --color-words` diff --git a/tldr/joe b/tldr/joe index 9b2e1e5d..018bfc8e 100644 --- a/tldr/joe +++ b/tldr/joe @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # joe > Joe's own text editor. -> More information: . +> More information: . - Open a new file in JOE: diff --git a/tldr/jrnl b/tldr/jrnl index f9b86028..265a1635 100644 --- a/tldr/jrnl +++ b/tldr/jrnl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jrnl > A simple journal application. -> More information: . +> More information: . - Insert a new entry with your editor: diff --git a/tldr/json5 b/tldr/json5 index eb6bee0b..112303d7 100644 --- a/tldr/json5 +++ b/tldr/json5 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # json5 > Convert JSON5 files to JSON. -> More information: . +> More information: . - Convert JSON5 `stdin` to JSON `stdout`: @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Convert a JSON5 file to the specified JSON file: -`json5 {{path/to/input_file.json5}} --out-file {{path/to/output_file.json}}` +`json5 {{path/to/input_file.json5}} {{[-o|--out-file]}} {{path/to/output_file.json}}` - Validate a JSON5 file: -`json5 {{path/to/input_file.json5}} --validate` +`json5 {{path/to/input_file.json5}} {{[-v|--validate]}}` - Specify the number of spaces to indent by (or "t" for tabs): -`json5 --space {{indent_amount}}` +`json5 {{[-s|--space]}} {{indent_amount}}` - Display help: -`json5 --help` +`json5 {{[-h|--help]}}` diff --git a/tldr/jupytext b/tldr/jupytext index a8601021..f87afc8c 100644 --- a/tldr/jupytext +++ b/tldr/jupytext @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jupytext > Convert Jupyter notebooks to plain text documents, and back again. -> More information: . +> More information: . - Turn a notebook into a paired `.ipynb`/`.py` notebook: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Update all paired representations of a notebook: -`jupytext --sync {{notebook.ipynb}}` +`jupytext {{[-s|--sync]}} {{notebook.ipynb}}` diff --git a/tldr/kdeconnect-cli b/tldr/kdeconnect-cli index 3e42d0f0..832f1ddc 100644 --- a/tldr/kdeconnect-cli +++ b/tldr/kdeconnect-cli @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # kdeconnect-cli > Use KDE Connect for sharing files or text to a device, ringing it, unlocking it, and much more. -> More information: . +> More information: . - List all devices: -`kdeconnect-cli --list-devices` +`kdeconnect-cli {{[-l|--list-devices]}}` - List available (paired and reachable) devices: diff --git a/tldr/ledger b/tldr/ledger index 7b30a058..d14bed1f 100644 --- a/tldr/ledger +++ b/tldr/ledger @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ledger > A powerful, double-entry accounting system. -> More information: . +> More information: . - Print a balance report showing totals: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List all postings in Expenses ordered by amount: -`ledger register {{expenses}} --sorted {{amount}}` +`ledger register {{expenses}} {{[-S|--sort]}} {{amount}}` - Print total Expenses other than Drinks and Food: diff --git a/tldr/lerna b/tldr/lerna index 29a9f9cb..a0f35798 100644 --- a/tldr/lerna +++ b/tldr/lerna @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lerna > Manage JavaScript projects with multiple packages. -> More information: . +> More information: . - Initialize project files (`lerna.json`, `package.json`, `.git`, etc.): diff --git a/tldr/lilypond b/tldr/lilypond index 778c8033..d9b1c8ff 100644 --- a/tldr/lilypond +++ b/tldr/lilypond @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Typeset music and/or produce MIDI from file. > See also: `musescore`. -> More information: . +> More information: . - Compile a lilypond file into a PDF: diff --git a/tldr/linux/aide b/tldr/linux/aide index d9d55b1d..1dd07602 100644 --- a/tldr/linux/aide +++ b/tldr/linux/aide @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo aide {{[-u|--update]}}` -- Define a config file to override the default `./aide.conf`: +- Define a config file to override the default `aide.conf`: `sudo aide {{[-c|--config]}} {{path/to/config_file}}` diff --git a/tldr/linux/archinstall b/tldr/linux/archinstall index 5458dabb..288011d8 100644 --- a/tldr/linux/archinstall +++ b/tldr/linux/archinstall @@ -6,12 +6,8 @@ source: https://github.com/tldr-pages/tldr.git # archinstall > Guided Arch Linux installer with a twist. -> More information: . +> More information: . - Start the interactive installer: `archinstall` - -- Start a preset installer: - -`archinstall {{minimal|unattended}}` diff --git a/tldr/linux/autorecon b/tldr/linux/autorecon index 77f52bb1..43ebfdf9 100644 --- a/tldr/linux/autorecon +++ b/tldr/linux/autorecon @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > A multi-threaded network reconnaissance tool which performs automated enumeration of services. > More information: . -- Perform reconnaissance on target host(s) (detailed scan results will be dumped in `./results`): +- Perform reconnaissance on target host(s) (detailed scan results will be dumped in `results`): `sudo autorecon {{host_or_ip1,host_or_ip2,...}}` diff --git a/tldr/linux/ctr b/tldr/linux/ctr index c9b8fcd5..b1048a97 100644 --- a/tldr/linux/ctr +++ b/tldr/linux/ctr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ctr > Manage `containerd` containers and images. -> More information: . +> More information: . - List all containers (running and stopped): diff --git a/tldr/linux/darling b/tldr/linux/darling index ae2232ad..d2905ef1 100644 --- a/tldr/linux/darling +++ b/tldr/linux/darling @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # darling > Run macOS software on Linux. -> More information: . +> More information: . - Run a builtin command: diff --git a/tldr/linux/goaccess b/tldr/linux/goaccess index aa84f8d5..82000208 100644 --- a/tldr/linux/goaccess +++ b/tldr/linux/goaccess @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # goaccess > An open source real-time web log analyzer. -> More information: . +> More information: . - Analyze one or more log files in interactive mode: diff --git a/tldr/linux/lsinitrd b/tldr/linux/lsinitrd index 9f5f3831..ea9dfce9 100644 --- a/tldr/linux/lsinitrd +++ b/tldr/linux/lsinitrd @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Show the contents of the initramfs image for the specified kernel: -`lsinitrd --kver {{kernel_version}}` +`lsinitrd {{[-k|--kver]}} {{kernel_version}}` - Show the contents of the specified initramfs image: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - List modules included in the initramfs image: -`lsinitrd --mod` +`lsinitrd {{[-m|--mod]}}` - Unpack the initramfs to the current directory: diff --git a/tldr/linux/ltrace b/tldr/linux/ltrace index f60a29a7..4902f88f 100644 --- a/tldr/linux/ltrace +++ b/tldr/linux/ltrace @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Print (trace) library calls of a program binary: -`ltrace ./{{program}}` +`ltrace {{path/to/program}}` - Count library calls. Print a handy summary at the bottom: diff --git a/tldr/linux/nixos-option b/tldr/linux/nixos-option index f7cf7cda..3b58b9f6 100644 --- a/tldr/linux/nixos-option +++ b/tldr/linux/nixos-option @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - List all subkeys of a given key on another NixOS configuration: -`NIXOS_CONFIG={{path_to_configuration.nix}} nixos-option {{option_key}}` +`NIXOS_CONFIG={{path/to/configuration.nix}} nixos-option {{option_key}}` - Show recursively all values of a user: diff --git a/tldr/linux/perf b/tldr/linux/perf index 82793c4a..375da72a 100644 --- a/tldr/linux/perf +++ b/tldr/linux/perf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # perf > Framework for Linux performance counter measurements. -> More information: . +> More information: . - Display basic performance counter stats for a command: diff --git a/tldr/linux/pstoedit b/tldr/linux/pstoedit index 18780e10..1cceee0d 100644 --- a/tldr/linux/pstoedit +++ b/tldr/linux/pstoedit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pstoedit > Convert PDF files into various image formats. -> More information: . +> More information: . - Convert a PDF page to PNG or JPEG format: diff --git a/tldr/linux/slapt-get b/tldr/linux/slapt-get index 56c41995..6c7136a7 100644 --- a/tldr/linux/slapt-get +++ b/tldr/linux/slapt-get @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > An `apt` like system for Slackware package management. > Package sources need to be configured in the slapt-getrc file. -> More information: . +> More information: . - Update the list of available packages and versions: diff --git a/tldr/linux/stratis b/tldr/linux/stratis index 81920755..16efeaae 100644 --- a/tldr/linux/stratis +++ b/tldr/linux/stratis @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage local storage pools and volumes using the Stratis storage manager. > Stratis volumes use the XFS filesystem and require the `stratisd` service. -> More information: . +> More information: . - Start the Stratis service (must be active before managing pools or volumes): diff --git a/tldr/linux/tshark b/tldr/linux/tshark index a322c5c2..fd642ef7 100644 --- a/tldr/linux/tshark +++ b/tldr/linux/tshark @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tshark > Packet analysis tool, CLI version of Wireshark. -> More information: . +> More information: . - Monitor everything on localhost: diff --git a/tldr/lmms b/tldr/lmms index 6c769b0f..c2c4262d 100644 --- a/tldr/lmms +++ b/tldr/lmms @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Free, open source, cross-platform digital audio workstation. > Render a `.mmp` or `.mmpz` project file, dump a `.mmpz` as XML, or start the GUI. > See also: `mixxx`. -> More information: . +> More information: . - Start the GUI: @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the GUI and load external config: -`lmms --config {{path/to/config.xml}}` +`lmms {{[-c|--config]}} {{path/to/config.xml}}` - Start the GUI and import MIDI or Hydrogen file: @@ -40,4 +40,4 @@ source: https://github.com/tldr-pages/tldr.git - Render with custom samplerate, format, and as a loop: -`lmms render --samplerate {{88200}} --format {{ogg}} --loop --output {{path/to/output_file.ogg}}` +`lmms render {{[-s|--samplerate]}} {{88200}} {{[-f|--format]}} {{ogg}} {{[-l|--loop]}} {{[-o|--output]}} {{path/to/output_file.ogg}}` diff --git a/tldr/locust b/tldr/locust index c619d80b..0fe798cd 100644 --- a/tldr/locust +++ b/tldr/locust @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # locust > Load-testing tool to determine number of concurrent users a system can handle. -> More information: . +> More information: . - Load-test "example.com" with web interface using locustfile.py: -`locust --host={{http://example.com}}` +`locust {{[-H|--host]}} {{http://example.com}}` - Use a different test file: -`locust --locustfile={{test_file.py}} --host={{http://example.com}}` +`locust {{[-H|--host]}} {{http://example.com}} {{[-f|--locustfile]}} {{test_file.py}}` - 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}}` +`locust {{[-H|--host]}} {{http://example.com}} --headless {{[-u|--users]}} 100 {{[-r|--spawn-rate]}} 1` - Start Locust in master mode: -`locust --master --host={{http://example.com}}` +`locust {{[-H|--host]}} {{http://example.com}} --master` -- Connect Locust slave to master: +- Connect Locust worker to master: -`locust --slave --host={{http://example.com}}` +`locust {{[-H|--host]}} {{http://example.com}} --worker` -- Connect Locust slave to master on a different machine: +- Connect Locust worker to master on a different machine: -`locust --slave --master-host={{master_hostname}} --host={{http://example.com}}` +`locust {{[-H|--host]}} {{http://example.com}} --worker --master-host {{master_hostname}}` diff --git a/tldr/magick b/tldr/magick index febcfb55..935749a8 100644 --- a/tldr/magick +++ b/tldr/magick @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Create, edit, compose, or convert between image formats. > This tool replaces `convert` in ImageMagick 7+. See `magick convert` to use the old tool in versions 7+. > Some subcommands, such as `mogrify` have their own usage documentation. -> More information: . +> More information: . - Convert between image formats: diff --git a/tldr/mc.fm b/tldr/mc.fm index 2917e777..e3741d62 100644 --- a/tldr/mc.fm +++ b/tldr/mc.fm @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Midnight Commander, a TUI file manager. > Navigate the directory structure using the ``, the mouse or by typing the commands into the terminal. > See also: `ranger`, `clifm`, `vifm`, `nautilus`. -> More information: . +> More information: . - Start Midnight Commander: diff --git a/tldr/meteor b/tldr/meteor index ef9d28d1..e401d6a9 100644 --- a/tldr/meteor +++ b/tldr/meteor @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # meteor > Full-stack JavaScript platform for building web applications. -> More information: . +> More information: . - Run a meteor project from its root directory in development mode: diff --git a/tldr/mh_lint b/tldr/mh_lint index c7a4219d..ce68a645 100644 --- a/tldr/mh_lint +++ b/tldr/mh_lint @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Attempt to find bugs in MATLAB or Octave code. > Please note that this tool is neither sound nor complete. -> More information: . +> More information: . - Check the current directory: diff --git a/tldr/mh_metric b/tldr/mh_metric index 95677a91..88091800 100644 --- a/tldr/mh_metric +++ b/tldr/mh_metric @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mh_metric > Calculate and enforce code metrics for MATLAB or Octave code. -> More information: . +> More information: . - Print the code metrics for the specified files: diff --git a/tldr/micro b/tldr/micro index 581e0ac6..75ccb20a 100644 --- a/tldr/micro +++ b/tldr/micro @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: . +> More information: . - Open a file: diff --git a/tldr/mise b/tldr/mise index d26ce385..ea8dd5d3 100644 --- a/tldr/mise +++ b/tldr/mise @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mise > Manage language runtimes like Node.js, Python, Ruby, Go, Java, etc and various tools. -> More information: . +> More information: . - List all available plugins: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Set global version for a package: -`mise use --global {{name}}@{{version}}` +`mise use {{[-g|--global]}} {{name}}@{{version}}` - Set local version for a package: diff --git a/tldr/mkdocs b/tldr/mkdocs index a30e2096..d17cb7de 100644 --- a/tldr/mkdocs +++ b/tldr/mkdocs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mkdocs > Project documentation with Markdown. -> More information: . +> More information: . - Create a new mkdocs project: diff --git a/tldr/mlr b/tldr/mlr index 0bf2a6de..f18cb6f9 100644 --- a/tldr/mlr +++ b/tldr/mlr @@ -6,7 +6,7 @@ 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: . +> More information: . - Pretty-print a CSV file in a tabular format: diff --git a/tldr/mocha b/tldr/mocha index ca058ae0..40180795 100644 --- a/tldr/mocha +++ b/tldr/mocha @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mocha > A feature-rich JavaScript test framework. -> More information: . +> More information: . - Run tests with default configuration or as configured in `mocha.opts`: @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Run tests that match a specific `grep` pattern: -`mocha --grep {{regex}}` +`mocha {{[-g|--grep]}} {{regex}}` - Run tests on changes to JavaScript files in the current directory and once initially: -`mocha --watch` +`mocha {{[-w|--watch]}}` - Run tests with a specific reporter: -`mocha --reporter {{reporter}}` +`mocha {{[-R|--reporter]}} {{reporter}}` diff --git a/tldr/molecule b/tldr/molecule index 0d021d78..eec30458 100644 --- a/tldr/molecule +++ b/tldr/molecule @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # molecule > Molecule helps testing Ansible roles. -> More information: . +> More information: . - Create a new Ansible role: diff --git a/tldr/moro b/tldr/moro index 7776d5de..2e5d0f18 100644 --- a/tldr/moro +++ b/tldr/moro @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # moro > Track work time. -> More information: . +> More information: . - Invoke `moro` without parameters, to set the current time as the start of the working day: diff --git a/tldr/mpv b/tldr/mpv index 71c031f7..66dc5b75 100644 --- a/tldr/mpv +++ b/tldr/mpv @@ -29,7 +29,7 @@ source: https://github.com/tldr-pages/tldr.git `mpv --sub-file={{path/to/file}}` -- Take a screenshot of the current frame (saved to `./mpv-shotNNNN.jpg` by default): +- Take a screenshot of the current frame (saved to `mpv-shotNNNN.jpg` by default): `` diff --git a/tldr/mr b/tldr/mr index c3d0997c..55a9af8a 100644 --- a/tldr/mr +++ b/tldr/mr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mr > Manage all of your version control repositories at once. -> More information: . +> More information: . - Register a repository: diff --git a/tldr/mumble b/tldr/mumble index 88263506..f8320d3a 100644 --- a/tldr/mumble +++ b/tldr/mumble @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mumble > Low-latency, high quality voice chat software. -> More information: . +> More information: . - Open Mumble: diff --git a/tldr/nextflow b/tldr/nextflow index 1fcd8010..3fff1e31 100644 --- a/tldr/nextflow +++ b/tldr/nextflow @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nextflow > Run computational pipelines. Mostly used for bioinformatics workflows. -> More information: . +> More information: . - Run a pipeline, use cached results from previous runs: diff --git a/tldr/node b/tldr/node index 5f6a8ffc..c1a50f72 100644 --- a/tldr/node +++ b/tldr/node @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # node > Server-side JavaScript platform (Node.js). -> More information: . +> More information: . - Run a JavaScript file: diff --git a/tldr/offlineimap b/tldr/offlineimap index 4acb617e..33568366 100644 --- a/tldr/offlineimap +++ b/tldr/offlineimap @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # offlineimap > Synchronize a remote IMAP server with local Maildir folders. -> More information: . +> More information: . - Synchronize once, without enabling autorefresh: diff --git a/tldr/optipng b/tldr/optipng index 7fe76793..90fd611e 100644 --- a/tldr/optipng +++ b/tldr/optipng @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # optipng > PNG file optimization utility. -> More information: . +> More information: . - Compress a PNG with default settings: diff --git a/tldr/osx/mate b/tldr/osx/mate index 480ed0e2..0d665d37 100644 --- a/tldr/osx/mate +++ b/tldr/osx/mate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mate > General-purpose text editor for macOS. -> More information: . +> More information: . - Start TextMate: @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Specify the filetype of a file: -`mate --type {{filetype}} {{path/to/file}}` +`mate {{[-t|--type]}} {{filetype}} {{path/to/file}}` - Open and wait until finished editing a specific file: -`mate --wait {{path/to/file}}` +`mate {{[-w|--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}}` +`mate {{[-l|--line]}} {{line_number}}:{{column_number}} {{path/to/file}}` diff --git a/tldr/osx/orb b/tldr/osx/orb index 94c7b1c8..81ee13a5 100644 --- a/tldr/osx/orb +++ b/tldr/osx/orb @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Interface for OrbStack, a fast and lightweight container and virtual machine runtime for macOS. > Provides Docker-compatible commands and Linux VM management. -> More information: . +> More information: . - List all containers and VMs: diff --git a/tldr/osx/valet b/tldr/osx/valet index a5c2c1b6..f241f95e 100644 --- a/tldr/osx/valet +++ b/tldr/osx/valet @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # valet -> A Laravel development environment that allows hosting sites via local tunnels on `http://example.test`. +> A Laravel development environment that allows hosting sites via local tunnels on . > More information: . - Start the valet daemon: diff --git a/tldr/osx/wacaw b/tldr/osx/wacaw index a2f8f3be..ebc10e86 100644 --- a/tldr/osx/wacaw +++ b/tldr/osx/wacaw @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wacaw > Capture both still pictures and video from an attached camera. -> More information: . +> More information: . - Take a picture from webcam: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Record a video: -`wacaw --video {{filename}} --duration {{10}}` +`wacaw --video {{filename}} {{[-D|--duration]}} {{10}}` - Take a picture with custom resolution: -`wacaw --width {{width}} --height {{100}} {{filename}}` +`wacaw {{[-x|--width]}} {{width}} {{[-y|--height]}} {{100}} {{filename}}` - Copy image just taken to clipboard: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - List the devices available: -`wacaw --list-devices` +`wacaw {{[-L|--list-devices]}}` diff --git a/tldr/p7zip b/tldr/p7zip index f3d8e356..6a93f3cd 100644 --- a/tldr/p7zip +++ b/tldr/p7zip @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Wrapper of 7-Zip file archiver with high compression ratio. > Internally executes either 7za or 7zr command. -> More information: . +> More information: . - Archive a file, replacing it with a 7zipped compressed version: diff --git a/tldr/pass b/tldr/pass index b2d662fa..f4142a78 100644 --- a/tldr/pass +++ b/tldr/pass @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Store and read passwords or other sensitive data. > All data is GPG-encrypted, and managed with a Git repository. -> More information: . +> More information: . - Initialize (or re-encrypt) the storage using one or more GPG IDs: diff --git a/tldr/pdfposter b/tldr/pdfposter index 08a3eae1..b78f5337 100644 --- a/tldr/pdfposter +++ b/tldr/pdfposter @@ -6,12 +6,12 @@ source: https://github.com/tldr-pages/tldr.git # pdfposter > Convert a large-sheeted PDF into multiple A4 pages for printing. -> More information: . +> More information: . - Convert an A2 poster into 4 A4 pages: -`pdfposter --poster-size a2 {{input_file.pdf}} {{output_file.pdf}}` +`pdfposter {{[-p|--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}}` +`pdfposter {{[-s|--scale]}} 2 {{input_file.pdf}} {{output_file.pdf}}` diff --git a/tldr/phpdox b/tldr/phpdox index fc86c25c..a8564862 100644 --- a/tldr/phpdox +++ b/tldr/phpdox @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phpdox > A PHP documentation generator. -> More information: . +> More information: . - Display an annotated skeleton configuration XML file: diff --git a/tldr/phpspec b/tldr/phpspec index 98fbb725..9bf7231b 100644 --- a/tldr/phpspec +++ b/tldr/phpspec @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phpspec > A Behaviour Driven Development tool for PHP. -> More information: . +> More information: . - Create a specification for a class: diff --git a/tldr/phpunit b/tldr/phpunit index 894d69d0..a1c0340a 100644 --- a/tldr/phpunit +++ b/tldr/phpunit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phpunit > PHPUnit test runner. -> More information: . +> More information: . - Run tests in the current directory. Note: Expects you to have a 'phpunit.xml': diff --git a/tldr/pipes.sh b/tldr/pipes.sh index de1e6515..3c86e609 100644 --- a/tldr/pipes.sh +++ b/tldr/pipes.sh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pipes.sh > A Bash script which draws randomly pathed pipes over the terminal. -> More information: . +> More information: . - Change the pa[t]tern of the pipes: diff --git a/tldr/pixi b/tldr/pixi index 15f7d38c..ea2102b1 100644 --- a/tldr/pixi +++ b/tldr/pixi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pixi > Developer Workflow and Environment Management for projects. -> More information: . +> More information: . - Initialize a new project: diff --git a/tldr/pulumi-login b/tldr/pulumi-login index efe95d5d..a02f9b77 100644 --- a/tldr/pulumi-login +++ b/tldr/pulumi-login @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Log in to the Pulumi cloud. > More information: . -- Log in to the managed Pulumi Cloud backend, defaults to `https://api.pulumi.com`: +- Log in to the managed Pulumi Cloud backend, defaults to : `pulumi login` diff --git a/tldr/pygbag b/tldr/pygbag index b2bbe8b3..0dfe23dc 100644 --- a/tldr/pygbag +++ b/tldr/pygbag @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pygbag > Package Pygame projects as WebAssembly to run in web browsers. -> More information: . +> More information: . - Package a Pygame project and start a local test server: diff --git a/tldr/surge b/tldr/surge index ac81650e..6cefaa98 100644 --- a/tldr/surge +++ b/tldr/surge @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # surge > Simple web publishing. -> More information: . +> More information: . - Upload a new site to surge.sh: diff --git a/tldr/vitest b/tldr/vitest index 2814741c..a12c91d9 100644 --- a/tldr/vitest +++ b/tldr/vitest @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # vitest > Fast, modern testing framework built for Vite, offering seamless integration, TypeScript support, and a Jest-compatible API for unit, integration, and snapshot testing. -> More information: . +> More information: . - Run all available tests: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Run the test suites from files within the current and subdirectories, whose paths match the given `regex`: -`vitest run {{regex1}} {{regex2}}` +`vitest run {{regex1 regex2 ...}}` - Run the tests whose names match the given `regex`: -`vitest run --testNamePattern {{regex}}` +`vitest run {{[-t|--testNamePattern]}} {{regex}}` - Watch files for changes and automatically re-run related tests: diff --git a/tldr/xh b/tldr/xh index 70ef2418..a4da5e0f 100644 --- a/tldr/xh +++ b/tldr/xh @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git `xh post {{https://postman-echo.com/post}} {{name=john}} {{age=25}}` -- Send a GET request with query parameters (e.g. `https://postman-echo.com/response-headers?foo1=bar1&foo2=bar2`): +- Send a GET request with query parameters (e.g. ): `xh get {{https://postman-echo.com/response-headers}} {{foo1==bar1}} {{foo2==bar2}}` diff --git a/tldr/xml-format b/tldr/xml-format index 43e6f380..43d3fd42 100644 --- a/tldr/xml-format +++ b/tldr/xml-format @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Format an XML document from `stdin`, removing the `DOCTYPE` declaration: -`cat {{path o\input.xml}} | xml {{[fo|format]}} {{[-D|--dropdtd]}} > {{path/to/output.xml}}` +`cat {{path/to/input.xml}} | xml {{[fo|format]}} {{[-D|--dropdtd]}} > {{path/to/output.xml}}` - Format an XML document, omitting the XML declaration: -`xml {{[fo|format]}} {{[-o|--omit-decl]}} {{path o\input.xml|URI}} > {{path/to/output.xml}}` +`xml {{[fo|format]}} {{[-o|--omit-decl]}} {{path/to/input.xml|URI}} > {{path/to/output.xml}}` - Display help: