diff --git a/tldr/ack b/tldr/ack index cd0c5cd7..df2eccc1 100644 --- a/tldr/ack +++ b/tldr/ack @@ -15,27 +15,27 @@ source: https://github.com/tldr-pages/tldr.git - Search for a case-insensitive pattern: -`ack --ignore-case "{{search_pattern}}"` +`ack {{[-i|--ignore-case]}} "{{search_pattern}}"` - Search for lines matching a pattern, printing [o]nly the matched text and not the rest of the line: -`ack -o "{{search_pattern}}"` +`ack {{[-o|--output='$&']}} "{{search_pattern}}"` - Limit search to files of a specific type: -`ack --type {{ruby}} "{{search_pattern}}"` +`ack {{[-t|--type]}} {{ruby}} "{{search_pattern}}"` - Do not search in files of a specific type: -`ack --type no{{ruby}} "{{search_pattern}}"` +`ack {{[-t|--type]}} no{{ruby}} "{{search_pattern}}"` - Count the total number of matches found: -`ack --count --no-filename "{{search_pattern}}"` +`ack {{[-c|--count]}} {{[-h|--no-filename]}} "{{search_pattern}}"` - Print the file names and the number of matches for each file only: -`ack --count --files-with-matches "{{search_pattern}}"` +`ack {{[-c|--count]}} {{[-l|--files-with-matches]}} "{{search_pattern}}"` - List all the values that can be used with `--type`: diff --git a/tldr/ansible b/tldr/ansible index f1d48d0d..23854c6a 100644 --- a/tldr/ansible +++ b/tldr/ansible @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `ansible {{group}} {{[-m|--module-name]}} ping` -- Display facts about a group of hosts by invoking the setup [m]odule: +- Display facts about a group of hosts by invoking the setup module: `ansible {{group}} {{[-m|--module-name]}} setup` diff --git a/tldr/az-lock b/tldr/az-lock index 825e3a72..3bfd1e01 100644 --- a/tldr/az-lock +++ b/tldr/az-lock @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `az lock list` -- Show a subscription level lock with a specific [n]ame: +- Show a subscription level lock with a specific name: `az lock show {{[-n|--name]}} {{lock_name}}` diff --git a/tldr/az-storage-blob b/tldr/az-storage-blob index 8e0874b2..94cba3df 100644 --- a/tldr/az-storage-blob +++ b/tldr/az-storage-blob @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}} {{[-f|--file]}} {{path/to/local_file}}` -- [d]ownload blobs from a blob container recursively: +- Download blobs from a blob container recursively: `az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-s|--source]}} {{container_name}} {{[-d|--destination]}} {{path/to/remote}} --pattern {{filename_regex}} {{[-d|--destination]}} {{path/to/destination}}` diff --git a/tldr/box b/tldr/box index 4513e862..ddad00e7 100644 --- a/tldr/box +++ b/tldr/box @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `box compile` -- Compile a new Phar file using a specific [c]onfiguration file: +- Compile a new Phar file using a specific configuration file: -`box compile -c {{path/to/config}}` +`box compile {{[-c|--config]}} {{path/to/config}}` - Display information about the PHAR PHP extension: diff --git a/tldr/bzip3 b/tldr/bzip3 index 372eec18..729ce6d8 100644 --- a/tldr/bzip3 +++ b/tldr/bzip3 @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `bzip3 {{[-d|--decode]}} {{path/to/compressed_file.bz3}}` -- Decompress a file to `stdout` ([c]): +- Decompress a file to `stdout`: `bzip3 {{[-dc|--decode --stdout]}} {{path/to/compressed_file.bz3}}` diff --git a/tldr/crictl b/tldr/crictl index aee6c440..a0c154b9 100644 --- a/tldr/crictl +++ b/tldr/crictl @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List all containers (Running and Exited): -`crictl ps --all` +`crictl ps {{[-a|--all]}}` - List all images: @@ -26,15 +26,15 @@ source: https://github.com/tldr-pages/tldr.git - Open a specific shell inside a running container: -`crictl exec -it {{container_id}} {{sh}}` +`crictl exec {{[-it|--interactive --tty]}} {{container_id}} {{sh}}` - Pull a specific image from a registry: `crictl pull {{image:tag}}` -- Print and [f]ollow logs of a specific container: +- Print and follow logs of a specific container: -`crictl logs -f {{container_id}}` +`crictl logs {{[-f|--follow]}} {{container_id}}` - Remove one or more images: diff --git a/tldr/gprbuild b/tldr/gprbuild index 940a2866..29c5fc05 100644 --- a/tldr/gprbuild +++ b/tldr/gprbuild @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Build a specific [P]roject file: -`gprbuild -P{{project_name}}` +`gprbuild -P {{project_name}}` - Clean up the build workspace: diff --git a/tldr/linux/btrfs-restore b/tldr/linux/btrfs-restore index 0096d8a7..4ebc5620 100644 --- a/tldr/linux/btrfs-restore +++ b/tldr/linux/btrfs-restore @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo btrfs restore --path-regex {{regex}} -c {{path/to/btrfs_device}} {{path/to/target_directory}}` -- Restore files from a btrfs filesystem using a specific root tree `bytenr` (see `btrfs-find-root`): +- Restore files from a btrfs filesystem using a specific root [t]ree `bytenr` (see `btrfs-find-root`): `sudo btrfs restore -t {{bytenr}} {{path/to/btrfs_device}} {{path/to/target_directory}}` diff --git a/tldr/linux/caligula b/tldr/linux/caligula new file mode 100644 index 00000000..127fb35a --- /dev/null +++ b/tldr/linux/caligula @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# caligula + +> A user-friendly, lightweight TUI for disk imaging. +> More information: . + +- Flash an ISO to a drive: + +`caligula burn {{path/to/image.iso}}` + +- Flash an ISO to a drive without entering the hash interactively: + +`caligula burn {{path/to/image.iso}} {{[s|--hash]}} {{hash}}` diff --git a/tldr/linux/chage b/tldr/linux/chage index 8a7f4bf2..cc46ab1d 100644 --- a/tldr/linux/chage +++ b/tldr/linux/chage @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - List password information for the user: -`chage {{[-l|--list]]} {{username}}` +`chage {{[-l|--list]}} {{username}}` - Enable password expiration in 10 days: diff --git a/tldr/linux/fdisk b/tldr/linux/fdisk index 0960e1c7..7d687ce4 100644 --- a/tldr/linux/fdisk +++ b/tldr/linux/fdisk @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List partitions: -`sudo fdisk -l` +`sudo fdisk {{[-l|--list]}}` - Start the partition manipulator: diff --git a/tldr/linux/swww b/tldr/linux/swww index 036b9cbb..0feafa89 100644 --- a/tldr/linux/swww +++ b/tldr/linux/swww @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `swww img {{path/to/image}}` -- Set wallpaper to specified [o]utputs: +- Set wallpaper to specified outputs: -`swww img -o {{output1,output2,...}} {{path/to/image}}` +`swww img {{[-o|--outputs]}} {{output1,output2,...}} {{path/to/image}}` - Restore last wallpaper: diff --git a/tldr/linux/urpmi.removemedia b/tldr/linux/urpmi.removemedia index c9c5d9ef..5625d5dd 100644 --- a/tldr/linux/urpmi.removemedia +++ b/tldr/linux/urpmi.removemedia @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo urpmi.removemedia {{medium}}` -- Remove all media: +- Remove [a]ll media: `sudo urpmi.removemedia -a` diff --git a/tldr/linux/znc b/tldr/linux/znc new file mode 100644 index 00000000..808709bf --- /dev/null +++ b/tldr/linux/znc @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# znc + +> IRC bouncer. +> More information: . + +- Run the initial setup: + +`znc {{[-c|--makeconf]}}` + +- Start the IRC bouncer daemon: + +`znc` + +- Setup `znc` for systemd: + +`sudo {{[-u|--user]}} znc znc {{[-c|--makeconf]}} {{[-d|--datadir]}} /var/lib/znc` + +- Enable `znc` to start on boot and start it now: + +`systemctl enable znc --now` diff --git a/tldr/mpv b/tldr/mpv index 69e9028c..9505f683 100644 --- a/tldr/mpv +++ b/tldr/mpv @@ -25,6 +25,10 @@ source: https://github.com/tldr-pages/tldr.git `{{<[>|<]>}}` +- Add subtitles from a file: + +`mpv --sub-file={{path/to/file}}` + - Take a screenshot of the current frame (saved to `./mpv-shotNNNN.jpg` by default): `` @@ -36,7 +40,3 @@ source: https://github.com/tldr-pages/tldr.git - Play a file using a profile defined in the `mpv.conf` file: `mpv --profile {{profile_name}} {{path/to/file}}` - -- Display the output of webcam or other video input device: - -`mpv {{/dev/video0}}` diff --git a/tldr/poetry b/tldr/poetry index 7033ce6c..d97979b1 100644 --- a/tldr/poetry +++ b/tldr/poetry @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `poetry install` -- Interactively initialize the current directory as a new Poetry project: +- Interactively (append `-n` for non-interactively) initialize the current directory as a new Poetry project: `poetry init` diff --git a/tldr/serve b/tldr/serve index 8ab382d9..5a3f6e5c 100644 --- a/tldr/serve +++ b/tldr/serve @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Start an HTTP server with CORS enabled by including the `Access-Control-Allow-Origin: *` header in all responses: -`serve --cors` +`serve {{[-C|--cors]}}` - Start an HTTP server on the default port rewriting all not-found requests to the `index.html` file: -`serve --single` +`serve {{[-s|--single]}}` - Start an HTTPS server on the default port using the specified certificate: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Start an HTTP server on the default port using a specific configuration file: -`serve --config {{path/to/serve.json}}` +`serve {{[-c|--config]}} {{path/to/serve.json}}` - Display help: diff --git a/tldr/sfdk b/tldr/sfdk index 6cd14863..af33b315 100644 --- a/tldr/sfdk +++ b/tldr/sfdk @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`sfdk --help` +`sfdk {{[-h|--help]}}` - Display help for specific topic (`building`, `testing`, `maintaining`, `ide`, `all`): diff --git a/tldr/sfdk-check b/tldr/sfdk-check index cf2ea000..28772d72 100644 --- a/tldr/sfdk-check +++ b/tldr/sfdk-check @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Add testing level to the check: -`sfdk check -l +{{level}}` +`sfdk check {{[-l|--levels]}} +{{level}}` - Remove testing level from the check: -`sfdk check -l -{{level}}` +`sfdk check {{[-l|--levels]}} -{{level}}` - Add testing suite to the check: -`sfdk check -s +{{suite}}` +`sfdk check {{[-s|--suites]}} +{{suite}}` - Remove testing suite from the check: -`sfdk check -s -{{suite}}` +`sfdk check {{[-s|--suites]}} -{{suite}}` diff --git a/tldr/sfdk-deploy b/tldr/sfdk-deploy index 64c87dcb..8f4aa6c1 100644 --- a/tldr/sfdk-deploy +++ b/tldr/sfdk-deploy @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Preview deploy without applying the changes: -`sfdk deploy --{{method}} --dry-run` +`sfdk deploy --{{method}} {{[-n|--dry-run]}}` - Deploy files in glob pattern `package*`: diff --git a/tldr/sfdk-emulator-device-model-show b/tldr/sfdk-emulator-device-model-show index 4dab833c..a36dc35b 100644 --- a/tldr/sfdk-emulator-device-model-show +++ b/tldr/sfdk-emulator-device-model-show @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sfdk emulator device-model-show > Show emulated device model's properties. +> More information: . - Show a model properties: diff --git a/tldr/sfdk-emulator-install b/tldr/sfdk-emulator-install index c80ce03c..d060479f 100644 --- a/tldr/sfdk-emulator-install +++ b/tldr/sfdk-emulator-install @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the available emulators: -`sfdk emulator list -a` +`sfdk emulator list {{[-a|--available]}}` - Display the installed emulators: diff --git a/tldr/sfdk-emulator-start b/tldr/sfdk-emulator-start index 70dd0946..7e5a26d3 100644 --- a/tldr/sfdk-emulator-start +++ b/tldr/sfdk-emulator-start @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sfdk emulator start > Starts an emulator. +> More information: . - Start an emulator: diff --git a/tldr/sfdk-init b/tldr/sfdk-init index dbf20a14..d717312b 100644 --- a/tldr/sfdk-init +++ b/tldr/sfdk-init @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new project of the given type: -`sfdk init -t {{type}}` +`sfdk init {{[-t|--type]}} {{type}}` - Initialize a new project with a specified builder: -`sfdk init -t {{type}} -b {{builder}}` +`sfdk init {{[-t|--type]}} {{type}} {{[-b|--builder]}} {{builder}}` - Initialize a new project ignoring non-empty directory: -`sfdk init -t {{type}} --force` +`sfdk init {{[-t|--type]}} {{type}} --force` - List available project types: -`sfdk init -l` +`sfdk init {{[-l|--list-types]}}` diff --git a/tldr/sfdk-maintain b/tldr/sfdk-maintain index 810415a8..54da738b 100644 --- a/tldr/sfdk-maintain +++ b/tldr/sfdk-maintain @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sfdk maintain > Launches the interactive SDK Maintenance tool. +> More information: . - Launch SDK Maintenance tool: diff --git a/tldr/sfdk-qmltypes b/tldr/sfdk-qmltypes index ef501c32..2405c7b1 100644 --- a/tldr/sfdk-qmltypes +++ b/tldr/sfdk-qmltypes @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sfdk qmltypes > Generates qmltypes files. +> More information: . - Generate qmltypes files: diff --git a/tldr/sfdk-scrape b/tldr/sfdk-scrape index f8cea813..49eb08d8 100644 --- a/tldr/sfdk-scrape +++ b/tldr/sfdk-scrape @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sfdk scrape > Converts source code modifications to patches. +> More information: . - Save source modifications as patches: @@ -13,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Preview the list of commits to be scrapped: -`sfdk scrape --dry-run` +`sfdk scrape {{[-n|--dry-run]}}` - Scrape while preserving the original patches file names: @@ -21,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Scrape while saving patches to a specified [o]utput directory: -`sfdk scrape -o {{directory}}` +`sfdk scrape {{[-o|--output-dir]}} {{directory}}` - Scrape without removing commits from submodules after creating patches: diff --git a/tldr/sfdk-undeploy b/tldr/sfdk-undeploy index e0760262..4c661f7b 100644 --- a/tldr/sfdk-undeploy +++ b/tldr/sfdk-undeploy @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Preview undeploy without applying the changes: -`sfdk undeploy --{{method}} --dry-run` +`sfdk undeploy --{{method}} {{[-n|--dry-run]}}` - Undeploy files in glob pattern `package*`: diff --git a/tldr/shellcheck b/tldr/shellcheck index 1e75cca6..23746922 100644 --- a/tldr/shellcheck +++ b/tldr/shellcheck @@ -12,30 +12,30 @@ source: https://github.com/tldr-pages/tldr.git `shellcheck {{path/to/script.sh}}` -- Check a shell script interpreting it as the specified [s]hell dialect (overrides the shebang at the top of the script): +- Check a shell script interpreting it as the specified shell dialect (overrides the shebang at the top of the script): -`shellcheck --shell {{sh|bash|dash|ksh}} {{path/to/script.sh}}` +`shellcheck {{[-s|--shell]}} {{sh|bash|dash|ksh}} {{path/to/script.sh}}` -- Ignor[e] one or more error types: +- Ignore one or more error types: -`shellcheck --exclude {{SC1009,SC1073,...}} {{path/to/script.sh}}` +`shellcheck {{[-e|--exclude]}} {{SC1009,SC1073,...}} {{path/to/script.sh}}` - Also check any sourced shell scripts: -`shellcheck --check-sourced {{path/to/script.sh}}` +`shellcheck {{[-a|--check-sourced]}} {{path/to/script.sh}}` -- Display output in the specified [f]ormat (defaults to `tty`): +- Display output in the specified format (defaults to `tty`): -`shellcheck --format {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}` +`shellcheck {{[-f|--format]}} {{tty|checkstyle|diff|gcc|json|json1|quiet}} {{path/to/script.sh}}` - Enable one or more [o]ptional checks: -`shellcheck --enable {{add-default-case,avoid-nullary-conditions,...}} {{path/to/script.sh}}` +`shellcheck {{[-o|--enable]}} {{add-default-case,avoid-nullary-conditions,...}} {{path/to/script.sh}}` - List all available optional checks that are disabled by default: `shellcheck --list-optional` -- Adjust the level of [S]everity to consider (defaults to `style`): +- Adjust the level of severity to consider (defaults to `style`): -`shellcheck --severity {{error|warning|info|style}} {{path/to/script.sh}}` +`shellcheck {{[-S|--severity]}} {{error|warning|info|style}} {{path/to/script.sh}}` diff --git a/tldr/sops b/tldr/sops index 316736c1..56051173 100644 --- a/tldr/sops +++ b/tldr/sops @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sops > SOPS (Secrets OPerationS): a simple and flexible tool for managing secrets. -> More information: . +> More information: . - Encrypt a file: diff --git a/tldr/xidel b/tldr/xidel index 67cc1500..45342a08 100644 --- a/tldr/xidel +++ b/tldr/xidel @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Print all URLs found by a Google search: -`xidel {{https://www.google.com/search?q=test}} --extract "//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']"` +`xidel {{https://www.google.com/search?q=test}} {{[-e|--extract]}} "//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']"` - Print the title of all pages found by a Google search and download them: -`xidel {{https://www.google.com/search?q=test}} --follow "{{//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']}}" --extract {{//title}} --download {{'{$host}/'}}` +`xidel {{https://www.google.com/search?q=test}} {{[-f|--follow]}} "{{//a/extract(@href, 'url[?]q=([^&]+)&', 1)[. != '']}}" {{[-e|--extract]}} {{//title}} --download {{'{$host}/'}}` - Follow all links on a page and print the titles, with XPath: -`xidel {{https://example.org}} --follow {{//a}} --extract {{//title}}` +`xidel {{https://example.org}} {{[-f|--follow]}} {{//a}} {{[-e|--extract]}} {{//title}}` - Follow all links on a page and print the titles, with CSS selectors: -`xidel {{https://example.org}} --follow "{{css('a')}}" --css {{title}}` +`xidel {{https://example.org}} {{[-f|--follow]}} "{{css('a')}}" --css {{title}}` - Follow all links on a page and print the titles, with pattern matching: -`xidel {{https://example.org}} --follow "{{{.}*}}" --extract "{{{.}}}"` +`xidel {{https://example.org}} {{[-f|--follow]}} "{{{.}*}}" {{[-e|--extract]}} "{{{.}}}"` - Read the pattern from example.xml (which will also check if the element containing "ood" is there, and fail otherwise): -`xidel {{path/to/example.xml}} --extract "{{ood{.}}}"` +`xidel {{path/to/example.xml}} {{[-e|--extract]}} "{{ood{.}}}"` - Print all newest Stack Overflow questions with title and URL using pattern matching on their RSS feed: -`xidel {{http://stackoverflow.com/feeds}} --extract "{{{title:=.}{uri:=@href}+}}"` +`xidel {{http://stackoverflow.com/feeds}} {{[-e|--extract]}} "{{{title:=.}{uri:=@href}+}}"` - Check for unread Reddit mail, Webscraping, combining CSS, XPath, JSONiq, and automatically form evaluation: -`xidel {{https://reddit.com}} --follow "{{form(css('form.login-form')[1], {'user': '$your_username', 'passwd': '$your_password'})}}" --extract "{{css('#mail')/@title}}"` +`xidel {{https://reddit.com}} {{[-f|--follow]}} "{{form(css('form.login-form')[1], {'user': '$your_username', 'passwd': '$your_password'})}}" {{[-e|--extract]}} "{{css('#mail')/@title}}"` diff --git a/tldr/zgrep b/tldr/zgrep index 59644ab9..ea012556 100644 --- a/tldr/zgrep +++ b/tldr/zgrep @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Grep a pattern in a compressed file (case-insensitive): -`zgrep -i {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-i|--ignore-case]}} {{pattern}} {{path/to/compressed/file}}` - Output count of lines containing matched pattern in a compressed file: -`zgrep -c {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-c|--count]}} {{pattern}} {{path/to/compressed/file}}` - Display the lines which don’t have the pattern present (Invert the search function): -`zgrep -v {{pattern}} {{path/to/compressed/file}}` +`zgrep {{[-v|--invert-match]}} {{pattern}} {{path/to/compressed/file}}` - Grep a compressed file for multiple patterns: -`zgrep -e "{{pattern_1}}" -e "{{pattern_2}}" {{path/to/compressed/file}}` +`zgrep {{[-e|--regexp]}} "{{pattern_1}}" {{[-e|--regexp]}} "{{pattern_2}}" {{path/to/compressed/file}}` - Use extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`): -`zgrep -E {{regular_expression}} {{path/to/file}}` +`zgrep {{[-E|--extended-regexp]}} {{regular_expression}} {{path/to/file}}` - Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: -`zgrep -{{C|B|A}} {{3}} {{pattern}} {{path/to/compressed/file}}` +`zgrep --{{context|before-context|after-context}} {{3}} {{pattern}} {{path/to/compressed/file}}`