From 2c0f4bfdb263f669145bac2ab318504d1c7a3f4f Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Mon, 28 Apr 2025 00:20:19 +0000 Subject: [PATCH] Update cheatsheets --- tldr/ascii-image-converter | 29 +++++++++++++++++++++++ tldr/cloc | 2 +- tldr/croc | 2 +- tldr/delta | 6 ++--- tldr/fast | 2 +- tldr/git-checkout-index | 8 +++---- tldr/git-commit-graph | 2 +- tldr/git-difftool | 2 +- tldr/git-help | 8 +++---- tldr/gobuster | 14 ++++++------ tldr/hg-clone | 8 +++---- tldr/lambo | 4 ++-- tldr/linux/abbr | 6 ++--- tldr/linux/addr2line | 6 ++--- tldr/linux/ascii | 2 +- tldr/linux/asciiart | 8 +++---- tldr/linux/autopkgtest | 4 ++-- tldr/linux/blurlock | 6 ++--- tldr/linux/bpftrace | 4 ++-- tldr/linux/debsecan | 2 +- tldr/linux/eyed3 | 6 ++--- tldr/linux/fadvise | 2 +- tldr/linux/flatpak-builder | 4 ++-- tldr/linux/fprintd-delete | 2 +- tldr/linux/fprintd-enroll | 4 ++-- tldr/linux/fprintd-verify | 4 ++-- tldr/linux/gnome-terminal | 2 +- tldr/linux/gs | 2 +- tldr/linux/i3exit | 2 +- tldr/linux/i3lock | 14 ++++++------ tldr/linux/jpegtran | 6 ++--- tldr/linux/kwrite | 4 ++-- tldr/linux/ldapdomaindump | 10 ++++---- tldr/linux/logwatch | 2 +- tldr/linux/lrunzip | 24 +++---------------- tldr/linux/lrzuntar | 24 +++---------------- tldr/linux/lxc-create | 2 +- tldr/linux/lxc-network | 2 +- tldr/linux/lxc-profile | 4 ++-- tldr/linux/lxi | 10 ++++---- tldr/linux/manpath | 2 +- tldr/linux/microcom | 4 ++-- tldr/linux/mklost+found | 2 +- tldr/linux/mocp | 10 ++++---- tldr/linux/mssh | 4 ++-- tldr/linux/nitrogen | 2 +- tldr/linux/openvpn3 | 6 ++--- tldr/linux/partprobe | 4 ++-- tldr/linux/powerprofilesctl | 2 +- tldr/linux/pstree | 2 +- tldr/linux/pulseaudio | 6 ++--- tldr/linux/slapt-src | 10 ++++---- tldr/linux/spi | 8 +++---- tldr/linux/steghide | 10 ++++---- tldr/linux/tomb | 2 +- tldr/linux/tune2fs | 6 ++--- tldr/linux/updatedb | 2 +- tldr/linux/uuidd | 6 ++--- tldr/linux/wajig | 2 +- tldr/linux/wifi-menu | 4 ++-- tldr/linux/xcowsay | 8 +++---- tldr/linux/xfce4-screenshooter | 12 +++++----- tldr/linux/xwinwrap | 8 +++---- tldr/mpv | 2 +- tldr/mutagen | 2 +- tldr/ncc | 6 ++--- tldr/next | 8 +++---- tldr/php-coveralls | 14 ++++++------ tldr/phpbu | 2 +- tldr/phpdox | 6 ++--- tldr/pio | 4 ++-- tldr/pio-account | 8 +++---- tldr/pio-check | 6 ++--- tldr/pio-ci | 6 ++--- tldr/pio-debug | 8 +++---- tldr/pio-device | 4 ++-- tldr/pio-pkg | 42 ++++++++++++++++++++++++++++++++++ tldr/pio-project | 6 ++--- tldr/pio-remote | 2 +- tldr/pio-run | 8 +++---- tldr/pio-test | 8 +++---- tldr/texdoc | 4 ++-- tldr/texliveonfly | 4 ++-- tldr/transcrypt | 6 ++--- tldr/uvicorn | 2 +- tldr/webpmux | 13 +++++++++++ tldr/wlsunset | 29 +++++++++++++++++++++++ tldr/yapf | 6 ++--- 88 files changed, 330 insertions(+), 253 deletions(-) create mode 100644 tldr/ascii-image-converter create mode 100644 tldr/pio-pkg create mode 100644 tldr/webpmux create mode 100644 tldr/wlsunset diff --git a/tldr/ascii-image-converter b/tldr/ascii-image-converter new file mode 100644 index 00000000..23427fde --- /dev/null +++ b/tldr/ascii-image-converter @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ascii-image-converter + +> Convert an image into ASCII. +> More information: . + +- Convert an image into ASCII: + +`ascii-image-converter {{path/to/image|URL}}` + +- Colorize the output: + +`ascii-image-converter {{[-C|--color]}} {{path/to/image|URL}}` + +- Create a tresholded image using braille: + +`ascii-image-converter {{[-b|--braille]}} {{path/to/image|URL}}` + +- Display the image with negative colors: + +`ascii-image-converter {{[-Cn|--color --negative]}} {{path/to/image|URL}}` + +- Use a wider range of characters to display an image (may improve image accuracy): + +`ascii-image-converter {{[-c|--complex]}} {{path/to/image|URL}}` diff --git a/tldr/cloc b/tldr/cloc index 8571b5e6..8dcfa30d 100644 --- a/tldr/cloc +++ b/tldr/cloc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cloc > Count, and compute differences of, lines of source code and comments. -> More information: . +> More information: . - Count all the lines of code in a directory: diff --git a/tldr/croc b/tldr/croc index eb7d3080..c140290a 100644 --- a/tldr/croc +++ b/tldr/croc @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Send a file or directory with a specific passphrase: -`croc send --code {{passphrase}} {{path/to/file_or_directory}}` +`croc send {{[-c|--code]}} {{passphrase}} {{path/to/file_or_directory}}` - Receive a file or directory on receiving machine: diff --git a/tldr/delta b/tldr/delta index 449d4f21..83c7a043 100644 --- a/tldr/delta +++ b/tldr/delta @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # delta > A viewer for Git and diff output. -> More information: . +> More information: . - Compare files or directories: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Compare files or directories, showing the line numbers: -`delta --line-numbers {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` +`delta {{[-n|--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}}` +`delta {{[-s|--side-by-side]}} {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` - Compare files or directories, ignoring any Git configuration settings: diff --git a/tldr/fast b/tldr/fast index 608e54a9..128aba3c 100644 --- a/tldr/fast +++ b/tldr/fast @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Measure the current upload speed in addition to download speed: -`fast --upload` +`fast {{[-u|--upload]}}` - Display results on a single line to reduce spacing: diff --git a/tldr/git-checkout-index b/tldr/git-checkout-index index 5355c136..476718e5 100644 --- a/tldr/git-checkout-index +++ b/tldr/git-checkout-index @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Restore any files deleted since the last commit: -`git checkout-index --all` +`git checkout-index {{[-a|--all]}}` - Restore any files deleted or changed since the last commit: -`git checkout-index --all --force` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}}` - Restore any files changed since the last commit, ignoring any files that were deleted: -`git checkout-index --all --force --no-create` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}} {{[-n|--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/}}` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}} --prefix {{path/to/export_directory/}}` diff --git a/tldr/git-commit-graph b/tldr/git-commit-graph index d6d69b3c..fce80173 100644 --- a/tldr/git-commit-graph +++ b/tldr/git-commit-graph @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Write a commit-graph file containing all reachable commits: -`git show-ref --hash | git commit-graph write --stdin-commits` +`git show-ref {{[-s|--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`: diff --git a/tldr/git-difftool b/tldr/git-difftool index fe463884..1a10fc4c 100644 --- a/tldr/git-difftool +++ b/tldr/git-difftool @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Use a specific tool (opendiff) to show changes since a given commit: -`git difftool --tool={{opendiff}} {{commit}}` +`git difftool {{[-t|--tool]}} {{opendiff}} {{commit}}` diff --git a/tldr/git-help b/tldr/git-help index 11cbfd90..062b8019 100644 --- a/tldr/git-help +++ b/tldr/git-help @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Display help about a specific Git subcommand in a web browser: -`git help --web {{subcommand}}` +`git help {{[-w|--web]}} {{subcommand}}` - Display a list of all available Git subcommands: -`git help --all` +`git help {{[-a|--all]}}` - List the available guides: -`git help --guide` +`git help {{[-g|--guide]}}` - List all possible configuration variables: -`git help --config` +`git help {{[-c|--config]}}` diff --git a/tldr/gobuster b/tldr/gobuster index d5d25483..f4cb44ac 100644 --- a/tldr/gobuster +++ b/tldr/gobuster @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # gobuster > Brute-forces hidden paths on web servers and more. -> More information: . +> More information: . - Discover directories and files that match in the wordlist: -`gobuster dir --url {{https://example.com/}} --wordlist {{path/to/file}}` +`gobuster dir {{[-u|--url]}} {{https://example.com/}} {{[-w|--wordlist]}} {{path/to/file}}` - Discover subdomains: -`gobuster dns --domain {{example.com}} --wordlist {{path/to/file}}` +`gobuster dns {{[-d|--domain]}} {{example.com}} {{[-w|--wordlist]}} {{path/to/file}}` - Discover Amazon S3 buckets: -`gobuster s3 --wordlist {{path/to/file}}` +`gobuster s3 {{[-w|--wordlist]}} {{path/to/file}}` - Discover other virtual hosts on the server: -`gobuster vhost --url {{https://example.com/}} --wordlist {{path/to/file}}` +`gobuster vhost {{[-u|--url]}} {{https://example.com/}} {{[-w|--wordlist]}} {{path/to/file}}` - Fuzz the value of a parameter: -`gobuster fuzz --url {{https://example.com/?parameter=FUZZ}} --wordlist {{path/to/file}}` +`gobuster fuzz {{[-u|--url]}} {{https://example.com/?parameter=FUZZ}} {{[-w|--wordlist]}} {{path/to/file}}` - Fuzz the name of a parameter: -`gobuster fuzz --url {{https://example.com/?FUZZ=value}} --wordlist {{path/to/file}}` +`gobuster fuzz {{[-u|--url]}} {{https://example.com/?FUZZ=value}} {{[-w|--wordlist]}} {{path/to/file}}` diff --git a/tldr/hg-clone b/tldr/hg-clone index 5fe629dc..7440a4e8 100644 --- a/tldr/hg-clone +++ b/tldr/hg-clone @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Clone a repository to the head of a specific branch, ignoring later commits: -`hg clone --branch {{branch}} {{remote_repository_source}}` +`hg clone {{[-b|--branch]}} {{branch}} {{remote_repository_source}}` - Clone a repository with only the `.hg` directory, without checking out files: -`hg clone --noupdate {{remote_repository_source}}` +`hg clone {{[-U|--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}}` +`hg clone {{[-u|--updaterev]}} {{revision}} {{remote_repository_source}}` - Clone a repository up to a specific revision without any newer history: -`hg clone --rev {{revision}} {{remote_repository_source}}` +`hg clone {{[-r|--rev]}} {{revision}} {{remote_repository_source}}` diff --git a/tldr/lambo b/tldr/lambo index 6a46ae9d..6663a711 100644 --- a/tldr/lambo +++ b/tldr/lambo @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A super-powered `laravel new` for Laravel and Valet. > See also `lambo new` for additional command flags. -> More information: . +> More information: . - Create a new Laravel application: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Open the configuration in a specific editor: -`lambo edit-config --editor="{{path/to/editor}}"` +`lambo edit-config {{[-e|--editor]}} "{{path/to/editor}}"` - Open the configuration file that is run after new applications have been scaffolded: diff --git a/tldr/linux/abbr b/tldr/linux/abbr index ce69d736..0ab56ee2 100644 --- a/tldr/linux/abbr +++ b/tldr/linux/abbr @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Add a new abbreviation: -`abbr --add {{abbreviation_name}} {{command}} {{command_arguments}}` +`abbr {{[-a|--add]}} {{abbreviation_name}} {{command}} {{command_arguments}}` - Rename an existing abbreviation: @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Erase an existing abbreviation: -`abbr --erase {{abbreviation_name}}` +`abbr {{[-e|--erase]}} {{abbreviation_name}}` - Import the abbreviations defined on another host over SSH: -`ssh {{host_name}} abbr --show | source` +`ssh {{host_name}} abbr {{[-s|--show]}} | source` diff --git a/tldr/linux/addr2line b/tldr/linux/addr2line index 70ffd4ae..d8bcdb0c 100644 --- a/tldr/linux/addr2line +++ b/tldr/linux/addr2line @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display the filename and line number of the source code from an instruction address of an executable: -`addr2line --exe={{path/to/executable}} {{address}}` +`addr2line {{[-e|--exe]}} {{path/to/executable}} {{address}}` - Display the function name, filename and line number: -`addr2line --exe={{path/to/executable}} --functions {{address}}` +`addr2line {{[-e|--exe]}} {{path/to/executable}} {{[-f|--functions]}} {{address}}` - Demangle the function name for C++ code: -`addr2line --exe={{path/to/executable}} --functions --demangle {{address}}` +`addr2line {{[-e|--exe]}} {{path/to/executable}} {{[-f|--functions]}} {{[-C|--demangle]}} {{address}}` diff --git a/tldr/linux/ascii b/tldr/linux/ascii index 2b5ff360..f1afb51e 100644 --- a/tldr/linux/ascii +++ b/tldr/linux/ascii @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ascii > Show ASCII character aliases. -> More information: . +> More information: . - Show ASCII aliases of a character: diff --git a/tldr/linux/asciiart b/tldr/linux/asciiart index 1d496c62..f598c2f2 100644 --- a/tldr/linux/asciiart +++ b/tldr/linux/asciiart @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Choose the output width (default is 100): -`asciiart --width {{50}} {{path/to/image.jpg}}` +`asciiart {{[-w|--width]}} {{50}} {{path/to/image.jpg}}` - Colorize the ASCII output: -`asciiart --color {{path/to/image.jpg}}` +`asciiart {{[-c|--color]}} {{path/to/image.jpg}}` - Choose the output format (default format is text): -`asciiart --format {{text|html}} {{path/to/image.jpg}}` +`asciiart {{[-f|--format]}} {{text|html}} {{path/to/image.jpg}}` - Invert the character map: -`asciiart --invert-chars {{path/to/image.jpg}}` +`asciiart {{[-i|--invert-chars]}} {{path/to/image.jpg}}` diff --git a/tldr/linux/autopkgtest b/tldr/linux/autopkgtest index 72644db4..1312b2d1 100644 --- a/tldr/linux/autopkgtest +++ b/tldr/linux/autopkgtest @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # autopkgtest > Run tests on Debian packages. -> More information: . +> More information: . - Build the package in the current directory and run all tests directly on the system: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Test the package in the current directory without rebuilding it: -`autopkgtest --no-built-binaries -- {{null}}` +`autopkgtest {{[-B|--no-built-binaries]}} -- {{null}}` diff --git a/tldr/linux/blurlock b/tldr/linux/blurlock index c681a3b0..367c3dd9 100644 --- a/tldr/linux/blurlock +++ b/tldr/linux/blurlock @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Lock the screen and disable the unlock indicator (removes feedback on keypress): -`blurlock --no-unlock-indicator` +`blurlock {{[-u|--no-unlock-indicator]}}` - Lock the screen and don't hide the mouse pointer: -`blurlock --pointer {{default}}` +`blurlock {{[-p|--pointer]}} {{default}}` - Lock the screen and show the number of failed login attempts: -`blurlock --show-failed-attempts` +`blurlock {{[-f|--show-failed-attempts]}}` diff --git a/tldr/linux/bpftrace b/tldr/linux/bpftrace index 241ac510..4f7e9f03 100644 --- a/tldr/linux/bpftrace +++ b/tldr/linux/bpftrace @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # bpftrace > High-level tracing language for Linux eBPF. -> More information: . +> More information: . - Display bpftrace version: -`bpftrace -V` +`bpftrace {{[-V|--version]}}` - List all available probes: diff --git a/tldr/linux/debsecan b/tldr/linux/debsecan index 96e2a808..689b097e 100644 --- a/tldr/linux/debsecan +++ b/tldr/linux/debsecan @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # debsecan > Debian Security Analyzer, a tool to list vulnerabilities on a particular Debian installation. -> More information: . +> More information: . - List vulnerable installed packages on the current host: diff --git a/tldr/linux/eyed3 b/tldr/linux/eyed3 index daf3d0d3..9a645171 100644 --- a/tldr/linux/eyed3 +++ b/tldr/linux/eyed3 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # eyeD3 > Read and manipulate metadata of MP3 files. -> More information: . +> More information: . - View information about an MP3 file: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Set the title of an MP3 file: -`eyeD3 --title "{{A Title}}" {{filename.mp3}}` +`eyeD3 {{[-t|--title]}} "{{A Title}}" {{filename.mp3}}` - Set the album of all the MP3 files in a directory: -`eyeD3 --album "{{Album Name}}" {{*.mp3}}` +`eyeD3 {{[-A|--album]}} "{{Album Name}}" {{*.mp3}}` - Set the front cover art for an MP3 file: diff --git a/tldr/linux/fadvise b/tldr/linux/fadvise index f93948e3..bb37d92c 100644 --- a/tldr/linux/fadvise +++ b/tldr/linux/fadvise @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Preload a file into cache: -`fadvise {{[-a|--advice]}} willneed {{path/to/file}}` +`fadvise {{[-a|--advice]}} willneeded {{path/to/file}}` - Suggest dropping a file from cache: diff --git a/tldr/linux/flatpak-builder b/tldr/linux/flatpak-builder index f800a04f..9f895808 100644 --- a/tldr/linux/flatpak-builder +++ b/tldr/linux/flatpak-builder @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Build a Flatpak and export it to the specified repository: -`flatpak-builder --repo={{repository_name}} {{path/to/build_directory}} {{path/to/manifest}}` +`flatpak-builder --repo {{repository_name}} {{path/to/build_directory}} {{path/to/manifest}}` - Build a Flatpak and install it locally: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Build and sign a Flatpak and export it to the specified repository: -`flatpak-builder --gpg-sign={{key_id}} --repo={{repository_name}} {{path/to/manifest}}` +`flatpak-builder --gpg-sign {{key_id}} --repo {{repository_name}} {{path/to/manifest}}` - Run a shell inside of an application sandbox without installing it: diff --git a/tldr/linux/fprintd-delete b/tldr/linux/fprintd-delete index 1b99bee8..c659d3fc 100644 --- a/tldr/linux/fprintd-delete +++ b/tldr/linux/fprintd-delete @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`fprintd-delete {{username}} {{[-f|--finger]}} {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|...}}` - Display help: diff --git a/tldr/linux/fprintd-enroll b/tldr/linux/fprintd-enroll index a34e3aad..542ae7b2 100644 --- a/tldr/linux/fprintd-enroll +++ b/tldr/linux/fprintd-enroll @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`fprintd-enroll {{[-f|--finger]}} {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|...}}` - Enroll the right index finger for a specific user: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Enroll a specific finger for a specific user: -`fprintd-enroll --finger {{finger_name}} {{username}}` +`fprintd-enroll {{[-f|--finger]}} {{finger_name}} {{username}}` - Display help: diff --git a/tldr/linux/fprintd-verify b/tldr/linux/fprintd-verify index d1335454..de826084 100644 --- a/tldr/linux/fprintd-verify +++ b/tldr/linux/fprintd-verify @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`fprintd-verify {{[-f|--finger]}} {{left-thumb|left-index-finger|left-middle-finger|left-ring-finger|left-little-finger|right-thumb|...}}` - Verify fingerprints for a specific user: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Verify a specific fingerprint for a specific user: -`fprintd-verify --finger {{finger_name}} {{username}}` +`fprintd-verify {{[-f|--finger]}} {{finger_name}} {{username}}` - Fail the process if a fingerprint doesn't match with ones stored in the database for the current user: diff --git a/tldr/linux/gnome-terminal b/tldr/linux/gnome-terminal index ab1d1c9d..dbcdbc55 100644 --- a/tldr/linux/gnome-terminal +++ b/tldr/linux/gnome-terminal @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Set the title of the new tab: -`gnome-terminal --tab --title "{{title}}"` +`gnome-terminal --tab {{[-t|--title]}} "{{title}}"` diff --git a/tldr/linux/gs b/tldr/linux/gs index 6a48b2e1..671b1d03 100644 --- a/tldr/linux/gs +++ b/tldr/linux/gs @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # gs -> GhostScript is a PDF and PostScript interpreter. +> GhostScript, a PDF and PostScript interpreter. > More information: . - To view a file: diff --git a/tldr/linux/i3exit b/tldr/linux/i3exit index 5d0b037b..0dee7284 100644 --- a/tldr/linux/i3exit +++ b/tldr/linux/i3exit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # i3exit > Exit the i3 window manager. -> More information: . +> More information: . - Log out of i3: diff --git a/tldr/linux/i3lock b/tldr/linux/i3lock index ee9a7edf..b3151476 100644 --- a/tldr/linux/i3lock +++ b/tldr/linux/i3lock @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # i3lock > Simple screen locker built for the i3 window manager. -> More information: . +> More information: . - Lock the screen showing a white background: @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Lock the screen with a simple color background (rrggbb format): -`i3lock --color {{0000ff}}` +`i3lock {{[-c|--color]}} {{0000ff}}` - Lock the screen to a PNG background: -`i3lock --image {{path/to/file.png}}` +`i3lock {{[-i|--image]}} {{path/to/file.png}}` - Lock the screen and disable the unlock indicator (removes feedback on keypress): -`i3lock --no-unlock-indicator` +`i3lock {{[-u|--no-unlock-indicator]}}` - Lock the screen and don't hide the mouse pointer: -`i3lock --pointer {{default}}` +`i3lock {{[-p|--pointer]}} {{default}}` - Lock the screen to a PNG background tiled over all monitors: -`i3lock --image {{path/to/file.png}} --tiling` +`i3lock {{[-i|--image]}} {{path/to/file.png}} {{[-t|--tiling]}}` - Lock the screen and show the number of failed login attempts: -`i3lock --show-failed-attempts` +`i3lock {{[-f|--show-failed-attempts]}}` diff --git a/tldr/linux/jpegtran b/tldr/linux/jpegtran index a1d5affd..9046840e 100644 --- a/tldr/linux/jpegtran +++ b/tldr/linux/jpegtran @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Mirror an image horizontally or vertically: -`jpegtran -flip {{horizontal|vertical}} {{path/to/image.jpg}} > {{path/to/output.jpg}}` +`jpegtran {{[-f|-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}}` +`jpegtran {{[-ro|-rotate]}} {{90|180|270}} {{path/to/image.jpg}} > {{path/to/output.jpg}}` - Transpose the image across the upper-left to lower right axis: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Convert the image to grayscale: -`jpegtran -grayscale {{path/to/image.jpg}} > {{path/to/output.jpg}}` +`jpegtran {{[-g|-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: diff --git a/tldr/linux/kwrite b/tldr/linux/kwrite index f713c61f..0118b29d 100644 --- a/tldr/linux/kwrite +++ b/tldr/linux/kwrite @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Text editor of the KDE Desktop project. > See also `kate`. -> More information: . +> More information: . - Open a text file: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Open a text file with a specific encoding: -`kwrite --encoding={{UTF-8}} {{path/to/file}}` +`kwrite --encoding {{UTF-8}} {{path/to/file}}` - Open a text file and navigate to a specific line and column: diff --git a/tldr/linux/ldapdomaindump b/tldr/linux/ldapdomaindump index 35a24f7d..067eaa75 100644 --- a/tldr/linux/ldapdomaindump +++ b/tldr/linux/ldapdomaindump @@ -7,20 +7,20 @@ source: https://github.com/tldr-pages/tldr.git > Dump users, computers, groups, OS and membership information via LDAP to HTML, JSON and greppable output. > See also `ldapsearch`. -> More information: . +> More information: . - Dump all information using the given LDAP account: -`ldapdomaindump --user {{domain}}\{{administrator}} --password {{password|ntlm_hash}} {{hostname|ip}}` +`ldapdomaindump {{[-u|--user]}} {{domain}}\{{username}} {{[-p|--password]}} {{password|ntlm_hash}} {{hostname|ip}}` - Dump all information, resolving computer hostnames: -`ldapdomaindump --resolve --user {{domain}}\{{administrator}} --password {{password}} {{hostname|ip}}` +`ldapdomaindump {{[-r|--resolve]}} {{[-u|--user]}} {{domain}}\{{username}} {{[-p|--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}}` +`ldapdomaindump {{[-r|--resolve]}} {{[-n|--dns-server]}} {{domain_controller_ip}} {{[-u|--user]}} {{domain}}\{{username}} {{[-p|--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}}` +`ldapdomaindump --no-json {{[-o|--outdir]}} {{path/to/directory}} {{[-u|--user]}} {{domain}}\{{username}} {{[-p|--password]}}{{password}} {{hostname|ip}}` diff --git a/tldr/linux/logwatch b/tldr/linux/logwatch index 0b76f020..d90c23cb 100644 --- a/tldr/linux/logwatch +++ b/tldr/linux/logwatch @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Restrict report to only include information for a selected service: -`logwatch --range {{all}} --service {{apache|pam_unix|etc}}` +`logwatch --range {{all}} --service {{apache|pam_unix|...}}` diff --git a/tldr/linux/lrunzip b/tldr/linux/lrunzip index 7fa4268d..5cf329c9 100644 --- a/tldr/linux/lrunzip +++ b/tldr/linux/lrunzip @@ -5,26 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # lrunzip -> A large file decompression program. -> See also: `lrzip`, `lrztar`, `lrzuntar`. -> More information: . +> This command is an alias of `lrzip -d`. -- Decompress a file: +- View documentation for the original command: -`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}}` +`tldr lrzip` diff --git a/tldr/linux/lrzuntar b/tldr/linux/lrzuntar index 9e637af0..f2a0f61f 100644 --- a/tldr/linux/lrzuntar +++ b/tldr/linux/lrzuntar @@ -5,26 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # lrzuntar -> A wrapper for `lrunzip` to simplify decompression of directories. -> See also: `lrztar`, `lrzip`. -> More information: . +> This command is an alias of `lrztar -d`. -- Decompress from a file to the current directory: +- View documentation for the original command: -`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}}` +`tldr lrztar` diff --git a/tldr/linux/lxc-create b/tldr/linux/lxc-create index 9e362cff..030e8750 100644 --- a/tldr/linux/lxc-create +++ b/tldr/linux/lxc-create @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lxc-create > Create linux containers. -> More information: . +> More information: . - Create a container interactively in `/var/lib/lxc/`: diff --git a/tldr/linux/lxc-network b/tldr/linux/lxc-network index 2804ea05..6d578443 100644 --- a/tldr/linux/lxc-network +++ b/tldr/linux/lxc-network @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lxc network > Manage networks for LXD containers. -> More information: . +> More information: . - List all available networks: diff --git a/tldr/linux/lxc-profile b/tldr/linux/lxc-profile index 8e2d1221..d8912d72 100644 --- a/tldr/linux/lxc-profile +++ b/tldr/linux/lxc-profile @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lxc profile > Manage profiles for LXD containers. -> More information: . +> More information: . - List all available profiles: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch a new container with specific profiles: -`lxc launch {{container_image}} {{container_name}} --profile {{profile1}} --profile {{profile2}}` +`lxc launch {{container_image}} {{container_name}} {{[-p|--profile]}} {{profile1}} {{[-p|--profile]}} {{profile2}}` - Change the profiles of a running container: diff --git a/tldr/linux/lxi b/tldr/linux/lxi index 1c9ca656..40c0ffda 100644 --- a/tldr/linux/lxi +++ b/tldr/linux/lxi @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lxi > Control LXI compatible instruments such as oscilloscopes. -> More information: . +> More information: . - Discover LXI devices on available networks: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Capture a screenshot, detecting a plugin automatically: -`lxi screenshot --address {{ip_address}}` +`lxi screenshot {{[-a|--address]}} {{ip_address}}` - Capture a screenshot using a specified plugin: -`lxi screenshot --address {{ip_address}} --plugin {{rigol-1000z}}` +`lxi screenshot {{[-a|--address]}} {{ip_address}} {{[-p|--plugin]}} {{rigol-1000z}}` - Send an SCPI command to an instrument: -`lxi scpi --address {{ip_address}} "{{*IDN?}}"` +`lxi scpi {{[-a|--address]}} {{ip_address}} "{{*IDN?}}"` - Run a benchmark for request and response performance: -`lxi benchmark --address {{ip_address}}` +`lxi benchmark {{[-a|--address]}} {{ip_address}}` diff --git a/tldr/linux/manpath b/tldr/linux/manpath index ddaf3e98..03bbb8aa 100644 --- a/tldr/linux/manpath +++ b/tldr/linux/manpath @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the entire global manpath: -`manpath --global` +`manpath {{[-g|--global]}}` diff --git a/tldr/linux/microcom b/tldr/linux/microcom index f52de1f7..277f4afb 100644 --- a/tldr/linux/microcom +++ b/tldr/linux/microcom @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Open a serial port using the specified baud rate: -`microcom --port {{path/to/serial_port}} --speed {{baud_rate}}` +`microcom {{[-p|--port]}} {{/dev/ttyXYZ}} {{[-s|--speed]}} {{baud_rate}}` - Establish a telnet connection to the specified host: -`microcom --telnet {{hostname}}:{{port}}` +`microcom {{[-t|--telnet]}} {{hostname}}:{{port}}` diff --git a/tldr/linux/mklost+found b/tldr/linux/mklost+found index 10a5e527..c96586c3 100644 --- a/tldr/linux/mklost+found +++ b/tldr/linux/mklost+found @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mklost+found > Create a lost+found directory. -> More information: . +> More information: . - Create a `lost+found` directory in the current directory: diff --git a/tldr/linux/mocp b/tldr/linux/mocp index a9828e58..980028bc 100644 --- a/tldr/linux/mocp +++ b/tldr/linux/mocp @@ -18,19 +18,19 @@ source: https://github.com/tldr-pages/tldr.git - Start the MOC server in the background, without launching the MOC terminal UI: -`mocp --server` +`mocp {{[-S|--server]}}` - Add a specific song to the play queue while MOC is in the background: -`mocp --enqueue {{path/to/audio_file}}` +`mocp {{[-q|--enqueue]}} {{path/to/audio_file}}` - Add songs recursively to the play queue while MOC is in the background: -`mocp --append {{path/to/directory}}` +`mocp {{[-a|--append]}} {{path/to/directory}}` - Clear the play queue while MOC is in the background: -`mocp --clear` +`mocp {{[-c|--clear]}}` - Play or stop the currently queued song while MOC is in the background: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Stop the MOC server while it's in the background: -`mocp --exit` +`mocp {{[-x|--exit]}}` diff --git a/tldr/linux/mssh b/tldr/linux/mssh index 27d13f64..6b88fe74 100644 --- a/tldr/linux/mssh +++ b/tldr/linux/mssh @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Open a new window and connect to multiple SSH servers: -`mssh {{user@host1}} {{user@host2}} {{...}}` +`mssh {{user@host1 user@host2 ...}}` - Open a new window and connect to a group of servers predefined in `~/.mssh_clusters`: -`mssh --alias {{alias_name}}` +`mssh {{[-a|--alias]}} {{alias_name}}` diff --git a/tldr/linux/nitrogen b/tldr/linux/nitrogen index 942d021a..933d185a 100644 --- a/tldr/linux/nitrogen +++ b/tldr/linux/nitrogen @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nitrogen > Desktop background browser and setter for X Window. -> More information: . +> More information: . - View and set the wallpapers from a specific directory: diff --git a/tldr/linux/openvpn3 b/tldr/linux/openvpn3 index 1ee872c1..d7bd6336 100644 --- a/tldr/linux/openvpn3 +++ b/tldr/linux/openvpn3 @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Start a new VPN session: -`openvpn3 session-start --config {{path/to/config.conf}}` +`openvpn3 session-start {{[-c|--config]}} {{path/to/config.conf}}` - List established sessions: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Disconnect the currently established session started with given configuration: -`openvpn3 session-manage --config {{path/to/config.conf}} --disconnect` +`openvpn3 session-manage {{[-c|--config]}} {{path/to/config.conf}} {{[-D|--disconnect]}}` - Import VPN configuration: -`openvpn3 config-import --config {{path/to/config.conf}}` +`openvpn3 config-import {{[-c|--config]}} {{path/to/config.conf}}` - List imported configurations: diff --git a/tldr/linux/partprobe b/tldr/linux/partprobe index 357f13b1..4d88127b 100644 --- a/tldr/linux/partprobe +++ b/tldr/linux/partprobe @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Notify the kernel of partition table changes and show a summary of devices and their partitions: -`sudo partprobe --summary` +`sudo partprobe {{[-s|--summary]}}` - Show a summary of devices and their partitions but don't notify the kernel: -`sudo partprobe --summary --dry-run` +`sudo partprobe {{[-s|--summary]}} {{[-d|--dry-run]}}` diff --git a/tldr/linux/powerprofilesctl b/tldr/linux/powerprofilesctl index 54929f23..eef10bec 100644 --- a/tldr/linux/powerprofilesctl +++ b/tldr/linux/powerprofilesctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # powerprofilesctl > Make power profiles handling available over D-Bus. -> More information: . +> More information: . - List available power profiles: diff --git a/tldr/linux/pstree b/tldr/linux/pstree index 04706931..8c0896c4 100644 --- a/tldr/linux/pstree +++ b/tldr/linux/pstree @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display a tree of processes with PIDs: -`pstree -p` +`pstree {{[-p|--show-pids]}}` - Display all process trees rooted at processes owned by specified user: diff --git a/tldr/linux/pulseaudio b/tldr/linux/pulseaudio index 8cfefe35..8fbcbe89 100644 --- a/tldr/linux/pulseaudio +++ b/tldr/linux/pulseaudio @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pulseaudio > The PulseAudio sound system daemon and manager. -> More information: . +> More information: . - Check if PulseAudio is running (a non-zero exit code means it is not running): @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Kill the running PulseAudio daemon: -`pulseaudio --kill` +`pulseaudio {{[-k|--kill]}}` - List available modules: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Load a module into the currently running daemon with the specified arguments: -`pulseaudio --load="{{module_name}} {{arguments}}"` +`pulseaudio {{[-L|--load]}} "{{module_name}} {{arguments}}"` diff --git a/tldr/linux/slapt-src b/tldr/linux/slapt-src index 7c2a20b5..d4e37128 100644 --- a/tldr/linux/slapt-src +++ b/tldr/linux/slapt-src @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Update the list of available slackbuilds and versions: -`slapt-src --update` +`slapt-src {{[-u|--update]}}` - List all available slackbuilds: -`slapt-src --list` +`slapt-src {{[-l|--list]}}` - Fetch, build and install the specified slackbuild(s): -`slapt-src --install {{slackbuild_name}}` +`slapt-src {{[-i|--install]}} {{slackbuild_name}}` - Locate slackbuilds by their name or description: -`slapt-src --search {{search_term}}` +`slapt-src {{[-s|--search]}} {{search_term}}` - Display information about a slackbuild: -`slapt-src --show {{slackbuild_name}}` +`slapt-src {{[-w|--show]}} {{slackbuild_name}}` diff --git a/tldr/linux/spi b/tldr/linux/spi index eb94fac5..4be79e4a 100644 --- a/tldr/linux/spi +++ b/tldr/linux/spi @@ -6,19 +6,19 @@ source: https://github.com/tldr-pages/tldr.git # spi > A meta package manager that handles both packages and slackbuilds. -> More information: . +> More information: . - Update the list of available packages and slackbuilds: -`spi --update` +`spi {{[-u|--update]}}` - Install a package or slackbuild: -`spi --install {{package/slackbuild_name}}` +`spi {{[-i|--install]}} {{package/slackbuild_name}}` - Upgrade all installed packages to the latest versions available: -`spi --upgrade` +`spi {{[-U|--upgrade]}}` - Locate packages or slackbuilds by package name or description: diff --git a/tldr/linux/steghide b/tldr/linux/steghide index fd81561f..7ff5a0d5 100644 --- a/tldr/linux/steghide +++ b/tldr/linux/steghide @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # steghide > Steganography tool for JPEG, BMP, WAV and AU file formats. -> More information: . +> More information: . - Embed data in a PNG, prompting for a passphrase: -`steghide embed --coverfile {{path/to/image.png}} --embedfile {{path/to/data.txt}}` +`steghide embed {{[-cf|--coverfile]}} {{path/to/image.png}} {{[-ef|--embedfile]}} {{path/to/data.txt}}` - Extract data from a WAV audio file: -`steghide extract --stegofile {{path/to/sound.wav}}` +`steghide extract {{[-sf|--stegofile]}} {{path/to/sound.wav}}` - Display file information, trying to detect an embedded file: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Embed data in a JPEG image, using maximum compression: -`steghide embed --coverfile {{path/to/image.jpg}} --embedfile {{path/to/data.txt}} --compress {{9}}` +`steghide embed {{[-cf|--coverfile]}} {{path/to/image.jpg}} {{[-ef|--embedfile]}} {{path/to/data.txt}} {{[-z|--compress]}} {{9}}` - Get the list of supported encryption algorithms and modes: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - 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|...}}` +`steghide embed {{[-cf|--coverfile]}} {{path/to/image.jpg}} {{[-ef|--embedfile]}} {{path/to/data.txt}} {{[-e|--encryption]}} {{blowfish|...}} {{cbc|...}}` diff --git a/tldr/linux/tomb b/tldr/linux/tomb index ef11903c..4d794362 100644 --- a/tldr/linux/tomb +++ b/tldr/linux/tomb @@ -6,7 +6,7 @@ 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: . +> More information: . - Create a new tomb with an initial size of 100 MB: diff --git a/tldr/linux/tune2fs b/tldr/linux/tune2fs index 16b9bbb2..811cabea 100644 --- a/tldr/linux/tune2fs +++ b/tldr/linux/tune2fs @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Set the max number of counts before a filesystem is checked to 2: -`tune2fs -c {{2}} {{/dev/sdXN}}` +`tune2fs -c 2 {{/dev/sdXN}}` - Set the filesystem label to MY_LABEL: -`tune2fs -L {{'MY_LABEL'}} {{/dev/sdXN}}` +`tune2fs -L 'MY_LABEL' {{/dev/sdXN}}` - Enable discard and user-specified extended attributes for a filesystem: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Enable journaling for a filesystem: -`tune2fs -o^{{nobarrier}} {{/dev/sdXN}}` +`tune2fs -o ^{{nobarrier}} {{/dev/sdXN}}` diff --git a/tldr/linux/updatedb b/tldr/linux/updatedb index b754ae31..7bc99ae6 100644 --- a/tldr/linux/updatedb +++ b/tldr/linux/updatedb @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Display file names as soon as they are found: -`sudo updatedb --verbose` +`sudo updatedb {{[-v|--verbose]}}` diff --git a/tldr/linux/uuidd b/tldr/linux/uuidd index 35ccda0b..4411ba20 100644 --- a/tldr/linux/uuidd +++ b/tldr/linux/uuidd @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Generate a random UUID: -`uuidd --random` +`uuidd {{[-r|--random]}}` - Generate a bulk number of random UUIDs: -`uuidd --random --uuids {{number_of_uuids}}` +`uuidd {{[-r|--random]}} {{[-n|--uuids]}} {{number_of_uuids}}` - Generate a time-based UUID, based on the current time and MAC address of the system: -`uuidd --time` +`uuidd {{[-t|--time]}}` diff --git a/tldr/linux/wajig b/tldr/linux/wajig index 5252598a..6873e8d5 100644 --- a/tldr/linux/wajig +++ b/tldr/linux/wajig @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wajig > Simplified all-in-one-place system support tool for Debian-based systems. -> More information: . +> More information: . - Update the list of available packages and versions: diff --git a/tldr/linux/wifi-menu b/tldr/linux/wifi-menu index cc79b8cd..eefb98f1 100644 --- a/tldr/linux/wifi-menu +++ b/tldr/linux/wifi-menu @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Interactively set up a connection to a network and obscure the password: -`wifi-menu --obscure` +`wifi-menu {{[-o|--obscure]}}` - Display help: -`wifi-menu --help` +`wifi-menu {{[-h|--help]}}` diff --git a/tldr/linux/xcowsay b/tldr/linux/xcowsay index a425887f..834a4526 100644 --- a/tldr/linux/xcowsay +++ b/tldr/linux/xcowsay @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: . +> More information: . - Display a cow saying "hello, world": @@ -19,11 +19,11 @@ source: https://github.com/tldr-pages/tldr.git - Display a cow at the specified X and Y coordinates: -`xcowsay --at={{X}},{{Y}}` +`xcowsay --at {{X}},{{Y}}` - Display a different sized cow: -`xcowsay --cow-size={{small|med|large}}` +`xcowsay --cow-size {{small|med|large}}` - Display a thought bubble instead of a speech bubble: @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Display a different image instead of the default cow: -`xcowsay --image={{path/to/file}}` +`xcowsay --image {{path/to/file}}` diff --git a/tldr/linux/xfce4-screenshooter b/tldr/linux/xfce4-screenshooter index 52646b4f..01c3e667 100644 --- a/tldr/linux/xfce4-screenshooter +++ b/tldr/linux/xfce4-screenshooter @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Take a screenshot of the entire screen and launch the GUI to ask how to proceed: -`xfce4-screenshooter --fullscreen` +`xfce4-screenshooter {{[-f|--fullscreen]}}` - Take a screenshot of the entire screen and save it in the specified directory: -`xfce4-screenshooter --fullscreen --save {{path/to/directory}}` +`xfce4-screenshooter {{[-f|--fullscreen]}} {{[-s|--save]}} {{path/to/directory}}` - Wait some time before taking the screenshot: -`xfce4-screenshooter --delay {{seconds}}` +`xfce4-screenshooter {{[-d|--delay]}} {{seconds}}` - Take a screenshot of a region of the screen (select using the mouse): -`xfce4-screenshooter --region` +`xfce4-screenshooter {{[-r|--region]}}` - Take a screenshot of the active window, and copy it to the clipboard: -`xfce4-screenshooter --window --clipboard` +`xfce4-screenshooter {{[-w|--window]}} {{[-c|--clipboard]}}` - Take a screenshot of the active window, and open it with a chosen program: -`xfce4-screenshooter --window --open {{gimp}}` +`xfce4-screenshooter {{[-w|--window]}} {{[-o|--open]}} {{gimp}}` diff --git a/tldr/linux/xwinwrap b/tldr/linux/xwinwrap index c9b0a60c..1765858e 100644 --- a/tldr/linux/xwinwrap +++ b/tldr/linux/xwinwrap @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`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}}` +`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}}` +`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}}` +`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/tldr/mpv b/tldr/mpv index 9505f683..71c031f7 100644 --- a/tldr/mpv +++ b/tldr/mpv @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A audio/video player based on MPlayer. > See also: `mplayer`, `vlc`. -> More information: . +> More information: . - Play a video or audio from a URL or file: diff --git a/tldr/mutagen b/tldr/mutagen index 75e2a135..5dca4150 100644 --- a/tldr/mutagen +++ b/tldr/mutagen @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mutagen > Real-time file synchronization and network forwarding tool. -> More information: . +> More information: . - Start a synchronization session between a local directory and a remote host: diff --git a/tldr/ncc b/tldr/ncc index c7187ce1..25b58219 100644 --- a/tldr/ncc +++ b/tldr/ncc @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Bundle and minify a Node.js application: -`ncc build --minify {{path/to/file.js}}` +`ncc build {{[-m|--minify]}} {{path/to/file.js}}` - Bundle and minify a Node.js application and generate source maps: -`ncc build --source-map {{path/to/file.js}}` +`ncc build {{[-s|--source-map]}} {{path/to/file.js}}` - Automatically recompile on changes to source files: -`ncc build --watch {{path/to/file.js}}` +`ncc build {{[-w|--watch]}} {{path/to/file.js}}` - Bundle a Node.js application into a temporary directory and run it for testing: diff --git a/tldr/next b/tldr/next index e5c38c38..6d41d483 100644 --- a/tldr/next +++ b/tldr/next @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # next > React framework that uses server-side rendering for building optimized web applications. -> More information: . +> More information: . - Start the current application in development mode: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the current application and listen on a specific port: -`next dev --port {{port}}` +`next dev {{[-p|--port]}} {{port}}` - Build the current application optimized for production: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the compiled application and listen on a specific port: -`next start --port {{port}}` +`next start {{[-p|--port]}} {{port}}` - Export the current application to static HTML pages: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help for a subcommand: -`next {{build|dev|export|start|telemetry}} --help` +`next {{build|dev|export|start|telemetry}} {{[-h|--help]}}` diff --git a/tldr/php-coveralls b/tldr/php-coveralls index e168a235..0cf1d6c2 100644 --- a/tldr/php-coveralls +++ b/tldr/php-coveralls @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # php-coveralls > A PHP client for Coveralls. -> More information: . +> More information: . - Send coverage information to Coveralls: @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Send coverage information to Coveralls for a specific directory: -`php-coveralls --root_dir {{path/to/directory}}` +`php-coveralls {{[-r|--root_dir]}} {{path/to/directory}}` - Send coverage information to Coveralls with a specific config: -`php-coveralls --config {{path/to/.coveralls.yml}}` +`php-coveralls {{[-c|--config]}} {{path/to/.coveralls.yml}}` - Send coverage information to Coveralls with verbose output: -`php-coveralls --verbose` +`php-coveralls {{[-v|--verbose]}}` - Send coverage information to Coveralls excluding source files with no executable statements: @@ -30,12 +30,12 @@ source: https://github.com/tldr-pages/tldr.git - Send coverage information to Coveralls with a specific environment name: -`php-coveralls --env {{test|dev|prod}}` +`php-coveralls {{[-e|--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}}` +`php-coveralls {{[-x|--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}}` +`php-coveralls {{[-o|--json_path]}} {{path/to/coveralls-upload.json}}` diff --git a/tldr/phpbu b/tldr/phpbu index 4294354a..340230ae 100644 --- a/tldr/phpbu +++ b/tldr/phpbu @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phpbu > A backup utility framework for PHP. -> More information: . +> More information: . - Run backups using the default `phpbu.xml` configuration file: diff --git a/tldr/phpdox b/tldr/phpdox index f6d1c645..fc86c25c 100644 --- a/tldr/phpdox +++ b/tldr/phpdox @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Generate documentation using a specific configuration file: -`phpdox --file {{path/to/phpdox.xml}}` +`phpdox {{[-f|--file]}} {{path/to/phpdox.xml}}` - Only run the metadata collection process: -`phpdox --collector` +`phpdox {{[-c|--collector]}}` - Only run the documentation generator process: -`phpdox --generator` +`phpdox {{[-g|--generator]}}` diff --git a/tldr/pio b/tldr/pio index e098e879..36f8e88d 100644 --- a/tldr/pio +++ b/tldr/pio @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Display help and list subcommands: -`pio --help` +`pio {{[-h|--help]}}` - Display help for a specific subcommand: -`pio {{subcommand}} --help` +`pio {{subcommand}} {{[-h|--help]}}` - Display version: diff --git a/tldr/pio-account b/tldr/pio-account index a13cfbc2..06ca464e 100644 --- a/tldr/pio-account +++ b/tldr/pio-account @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Register a new PlatformIO account: -`pio account register --username {{username}} --email {{email}} --password {{password}} --firstname {{firstname}} --lastname {{lastname}}` +`pio account register {{[-u|--username]}} {{username}} {{[-e|--email]}} {{email}} {{[-p|--password]}} {{password}} --firstname {{firstname}} --lastname {{lastname}}` - Permanently delete your PlatformIO account and related data: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Log in to your PlatformIO account: -`pio account login --username {{username}} --password {{password}}` +`pio account login {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Log out of your PlatformIO account: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Update your PlatformIO profile: -`pio account update --username {{username}} --email {{email}} --firstname {{firstname}} --lastname {{lastname}} --current-password {{password}}` +`pio account update {{[-u|--username]}} {{username}} {{[-e|--email]}} {{email}} --firstname {{firstname}} --lastname {{lastname}} --current-password {{password}}` - Show detailed information about your PlatformIO account: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Reset your password using your username or email: -`pio account forgot --username {{username_or_email}}` +`pio account forgot {{[-u|--username]}} {{username_or_email}}` diff --git a/tldr/pio-check b/tldr/pio-check index bd537126..98439afa 100644 --- a/tldr/pio-check +++ b/tldr/pio-check @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Perform a basic analysis check on a specific project: -`pio check --project-dir {{project_dir}}` +`pio check {{[-d|--project-dir]}} {{project_dir}}` - Perform an analysis check for a specific environment: -`pio check --environment {{environment}}` +`pio check {{[-e|--environment]}} {{environment}}` - Perform an analysis check and only report a specified defect severity type: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Perform an analysis check and show detailed information when processing environments: -`pio check --verbose` +`pio check {{[-v|--verbose]}}` diff --git a/tldr/pio-ci b/tldr/pio-ci index 0ef8d65a..b68e761b 100644 --- a/tldr/pio-ci +++ b/tldr/pio-ci @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Build a PlatformIO project and specify specific libraries: -`pio ci --lib {{path/to/library_directory}} {{path/to/project}}` +`pio ci {{[-l|--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}}` +`pio ci {{[-b|--board]}} {{board}} {{path/to/project}}` - Build a PlatformIO project in a specific directory: @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Build a PlatformIO project using a specific configuration file: -`pio ci --project-conf {{path/to/platformio.ini}}` +`pio ci {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/tldr/pio-debug b/tldr/pio-debug index 10e1a2a4..66c0a5ba 100644 --- a/tldr/pio-debug +++ b/tldr/pio-debug @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Debug a specific PlatformIO project: -`pio debug --project-dir {{path/to/platformio_project}}` +`pio debug {{[-d|--project-dir]}} {{path/to/platformio_project}}` - Debug a specific environment: -`pio debug --environment {{environment}}` +`pio debug {{[-e|--environment]}} {{environment}}` - Debug a PlatformIO project using a specific configuration file: -`pio debug --project-conf {{path/to/platformio.ini}}` +`pio debug {{[-c|--project-conf]}} {{path/to/platformio.ini}}` - Debug a PlatformIO project using the `gdb` debugger: -`pio debug --interface={{gdb}} {{gdb_options}}` +`pio debug --interface {{gdb}} {{gdb_options}}` diff --git a/tldr/pio-device b/tldr/pio-device index fbe521c3..b39a0e4c 100644 --- a/tldr/pio-device +++ b/tldr/pio-device @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Start an interactive device monitor and listen to a specific port: -`pio device monitor --port {{/dev/ttyUSBX}}` +`pio device monitor {{[-p|--port]}} {{/dev/ttyUSBX}}` - Start an interactive device monitor and set a specific baud rate (defaults to 9600): -`pio device monitor --baud {{57600}}` +`pio device monitor {{[-b|--baud]}} {{57600}}` - Start an interactive device monitor and set a specific EOL character (defaults to `CRLF`): diff --git a/tldr/pio-pkg b/tldr/pio-pkg new file mode 100644 index 00000000..52190607 --- /dev/null +++ b/tldr/pio-pkg @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pio pkg + +> 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 pkg pack {{[-o|--output]}} {{path/to/package.tar.gz}}` + +- Create and publish a package tarball from the current directory: + +`pio pkg publish` + +- Publish the current directory and restrict public access to it: + +`pio pkg publish --private` + +- Publish a package: + +`pio pkg publish {{path/to/package.tar.gz}}` + +- Publish a package with a custom release date (UTC): + +`pio pkg 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 pkg unpublish {{package}}` + +- Remove a specific version of a published package from the registry: + +`pio pkg unpublish {{package}}@{{version}}` + +- Undo the removal, putting all versions or a specific version of the package back into the registry: + +`pio pkg unpublish --undo {{package}}@{{version}}` diff --git a/tldr/pio-project b/tldr/pio-project index b1362d77..d3f77633 100644 --- a/tldr/pio-project +++ b/tldr/pio-project @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new PlatformIO project in a specific directory: -`pio project init --project-dir {{path/to/project_directory}}` +`pio project init {{[-d|--project-dir]}} {{path/to/project_directory}}` - Initialize a new PlatformIO project, specifying a board ID: -`pio project init --board {{ATmega328P|uno|...}}` +`pio project init {{[-b|--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}}"` +`pio project init {{[-O|--project-option]}} "{{option}}={{value}}" {{[-O|--project-option]}} "{{option}}={{value}}"` - Print the configuration of a project: diff --git a/tldr/pio-remote b/tldr/pio-remote index b2f6a67b..0725ca69 100644 --- a/tldr/pio-remote +++ b/tldr/pio-remote @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - 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}}` +`pio remote agent start {{[-n|--name]}} {{agent_name}} {{[-s|--share]}} {{example1@example.com}} {{[-s|--share]}} {{example2@example.com}}` - List devices from specified Agents (omit `--agent` to specify all Agents): diff --git a/tldr/pio-run b/tldr/pio-run index e9566d06..80a745dc 100644 --- a/tldr/pio-run +++ b/tldr/pio-run @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List all available project targets of a specific environment: -`pio run --list-targets --environment {{environment}}` +`pio run --list-targets {{[-e|--environment]}} {{environment}}` - Run all targets: @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Run all targets of specified environments: -`pio run --environment {{environment1}} --environment {{environment2}}` +`pio run {{[-e|--environment]}} {{environment1}} {{[-e|--environment]}} {{environment2}}` - Run specified targets: -`pio run --target {{target1}} --target {{target2}}` +`pio run {{[-t|--target]}} {{target1}} {{[-t|--target]}} {{target2}}` - Run the targets of a specified configuration file: -`pio run --project-conf {{path/to/platformio.ini}}` +`pio run {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/tldr/pio-test b/tldr/pio-test index 5f79c5c6..59e0bb80 100644 --- a/tldr/pio-test +++ b/tldr/pio-test @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Test only specific environments: -`pio test --environment {{environment1}} --environment {{environment2}}` +`pio test {{[-e|--environment]}} {{environment1}} {{[-e|--environment]}} {{environment2}}` - Run only tests whose name matches a specific glob pattern: -`pio test --filter "{{pattern}}"` +`pio test {{[-f|--filter]}} "{{pattern}}"` - Ignore tests whose name matches a specific glob pattern: -`pio test --ignore "{{pattern}}"` +`pio test {{[-i|--ignore]}} "{{pattern}}"` - Specify a port for firmware uploading: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Specify a custom configuration file for running the tests: -`pio test --project-conf {{path/to/platformio.ini}}` +`pio test {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/tldr/texdoc b/tldr/texdoc index 88faa1f4..abcaf0a1 100644 --- a/tldr/texdoc +++ b/tldr/texdoc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # texdoc > Search for appropriate documentation for (La)TeX commands or packages. -> More information: . +> More information: . - Open the first search result in the default PDF viewer: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List the best search results: -`texdoc --list {{search}}` +`texdoc {{[-l|--list]}} {{search}}` - Open full documentation of texdoc: diff --git a/tldr/texliveonfly b/tldr/texliveonfly index bbcceadf..1703ff52 100644 --- a/tldr/texliveonfly +++ b/tldr/texliveonfly @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # texliveonfly > Downloads missing TeX Live packages while compiling `.tex` files. -> More information: . +> More information: . - Download missing packages while compiling: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a specific compiler (defaults to `pdflatex`): -`texliveonfly --compiler={{compiler}} {{source.tex}}` +`texliveonfly {{[-c|--compiler]}} {{compiler}} {{source.tex}}` - Use a custom TeX Live `bin` folder: diff --git a/tldr/transcrypt b/tldr/transcrypt index d4193cd1..e6b94c1a 100644 --- a/tldr/transcrypt +++ b/tldr/transcrypt @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Display the credentials of a configured repository: -`transcrypt --display` +`transcrypt {{[-d|--display]}}` - Initialize and decrypt a fresh clone of a configured repository: -`transcrypt --cipher={{cipher}}` +`transcrypt {{[-c|--cipher]}} {{cipher}}` - Rekey to change the encryption cipher or password: -`transcrypt --rekey` +`transcrypt {{[-r|--rekey]}}` diff --git a/tldr/uvicorn b/tldr/uvicorn index 0591d94b..69566383 100644 --- a/tldr/uvicorn +++ b/tldr/uvicorn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # uvicorn > Python ASGI HTTP Server, for asynchronous projects. -> More information: . +> More information: . - Run Python web app: diff --git a/tldr/webpmux b/tldr/webpmux new file mode 100644 index 00000000..78d99777 --- /dev/null +++ b/tldr/webpmux @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# webpmux + +> Create WebP animations. +> More information: . + +- Create a two-frame animation: + +`webpmux -frame {{path/to/frame1.webp}} +{{500}} -frame {{path/to/frame2.webp}} +{{500}} -loop {{0}} -o {{path/to/output.webp}}` diff --git a/tldr/wlsunset b/tldr/wlsunset new file mode 100644 index 00000000..7dd20cd9 --- /dev/null +++ b/tldr/wlsunset @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wlsunset + +> Adjust the color temperature in Wayland compositors depending on the sunset/sunrise times. +> More information: . + +- Automatically compute sunset/sunrise times based on the specified location: + +`wlsunset -l {{latitude}} -L {{longitude}}` + +- Manually set the sunset/sunrise times (time format: `HH:MM`): + +`wlsunset -s {{sunset_time}} -S {{sunrise_time}}` + +- Set the high and low temperatures (default: high - 6500, low - 4000): + +`wlsunset -T {{high_temp}} -t {{low_temp}}` + +- Set the animation time to `n` seconds (only applicable when using manual sunset/sunrise times): + +`wlsunset -d {{n}} -s {{sunset_time}} -S {{sunrise_time}}` + +- Set the gamma (default: 1.0): + +`wlsunset -g {{gamma_value}}` diff --git a/tldr/yapf b/tldr/yapf index 48bd5426..2ec2a8e5 100644 --- a/tldr/yapf +++ b/tldr/yapf @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display a diff of the changes that would be made, without making them (dry-run): -`yapf --diff {{path/to/file}}` +`yapf {{[-d|--diff]}} {{path/to/file}}` - Format the file in-place and display a diff of the changes: -`yapf --diff --in-place {{path/to/file}}` +`yapf {{[-d|--diff]}} {{[-i|--in-place]}} {{path/to/file}}` - Recursively format all Python files in a directory, concurrently: -`yapf --recursive --in-place --style {{pep8}} --parallel {{path/to/directory}}` +`yapf {{[-r|--recursive]}} {{[-i|--in-place]}} --style {{pep8}} {{[-p|--parallel]}} {{path/to/directory}}`