From aa594e72aff5bed594f7d2ac2ec414d59fec9a08 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Fri, 17 Oct 2025 00:19:47 +0000 Subject: [PATCH] Update cheatsheets --- tldr/adb-kill-server | 13 ++++++++++ tldr/adb-start-server | 13 ++++++++++ tldr/anki | 10 ++++---- tldr/ansiweather | 2 +- tldr/apropos | 2 +- tldr/argon2 | 2 +- tldr/arping | 2 +- tldr/beanstalkd | 2 +- tldr/brew-leaves | 25 +++++++++++++++++++ tldr/cancel | 2 +- tldr/certutil | 2 +- tldr/chmod | 2 +- tldr/csh | 2 +- tldr/cupsd | 10 ++++---- tldr/freeze | 43 ++++++++++++++++++++++++++++++++ tldr/gammastep | 2 +- tldr/gettext | 2 +- tldr/git-browse-ci | 2 +- tldr/git-delete-submodule | 2 +- tldr/git-get-tar-commit-id | 13 ++++++++++ tldr/gladtex | 4 +-- tldr/gnatmake | 2 +- tldr/goimports | 2 +- tldr/history | 4 +++ tldr/hub-init | 2 +- tldr/ifdata | 6 ++--- tldr/in-toto-record | 4 +-- tldr/in-toto-run | 6 ++--- tldr/ipcs | 2 +- tldr/iproxy | 2 +- tldr/jira | 4 +-- tldr/k8s-unused-secret-detector | 2 +- tldr/ksh | 2 +- tldr/kubeseal | 2 +- tldr/kustomize | 2 +- tldr/linux/createrepo | 2 +- tldr/linux/dnf-versionlock | 31 +++++++++++++++++++++++ tldr/linux/impala | 2 +- tldr/linux/iw-dev | 4 +-- tldr/linux/pw-mididump | 25 +++++++++++++++++++ tldr/linux/rnm | 2 +- tldr/linux/slurmrestd | 16 ++++++------ tldr/linux/slurp | 4 +-- tldr/linux/systemctl-list-timers | 25 +++++++++++++++++++ tldr/linux/vncviewer | 2 +- tldr/mdk4 | 6 ++--- tldr/mvn-package | 21 ++++++++++++++++ tldr/nmap | 8 +++--- tldr/nnn | 6 ++--- tldr/open.fish | 2 +- tldr/osx/xed | 2 +- tldr/perldoc | 2 +- tldr/php | 6 ++--- tldr/pkg-config | 2 +- tldr/poetry-sync | 41 ++++++++++++++++++++++++++++++ tldr/pueue-completions | 2 +- tldr/qmake | 33 ++++++++++++++++++++++++ tldr/redis-cli | 2 +- tldr/rga | 2 +- tldr/rustup-init.sh | 4 +-- tldr/sfdk-apply | 2 +- tldr/sfdk-build-init | 2 +- tldr/sfdk-build-requires | 2 +- tldr/sfdk-build-shell | 2 +- tldr/sfdk-check | 2 +- tldr/sfdk-cmake | 2 +- tldr/sfdk-config | 2 +- tldr/sfdk-deploy | 2 +- tldr/sfdk-device | 2 +- tldr/sfdk-emulator | 2 +- tldr/sfdk-emulator-install | 2 +- tldr/sfdk-engine | 2 +- tldr/sfdk-init | 2 +- tldr/sfdk-maintain | 2 +- tldr/sfdk-make | 2 +- tldr/sfdk-make-install | 2 +- tldr/sfdk-package | 2 +- tldr/sfdk-prepare | 2 +- tldr/sfdk-qmake | 2 +- tldr/sfdk-scrape | 4 +-- tldr/sfdk-undeploy | 2 +- tldr/silicon | 9 ++++--- tldr/smbmap | 2 +- tldr/ssh | 2 +- tldr/subfinder | 2 +- tldr/windows/resolve-path | 2 +- tldr/ytmdl | 42 +++++++++++++++++++++++++++++++ tldr/zek | 4 +-- 88 files changed, 444 insertions(+), 114 deletions(-) create mode 100644 tldr/adb-kill-server create mode 100644 tldr/adb-start-server create mode 100644 tldr/brew-leaves create mode 100644 tldr/freeze create mode 100644 tldr/git-get-tar-commit-id create mode 100644 tldr/linux/dnf-versionlock create mode 100644 tldr/linux/pw-mididump create mode 100644 tldr/linux/systemctl-list-timers create mode 100644 tldr/mvn-package create mode 100644 tldr/poetry-sync create mode 100644 tldr/qmake create mode 100644 tldr/ytmdl diff --git a/tldr/adb-kill-server b/tldr/adb-kill-server new file mode 100644 index 00000000..10f76360 --- /dev/null +++ b/tldr/adb-kill-server @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb kill-server + +> Stop the Android Debug Bridge (adb) server, disconnecting devices and emulators. +> More information: . + +- Kill the adb server if it is running: + +`adb kill-server` diff --git a/tldr/adb-start-server b/tldr/adb-start-server new file mode 100644 index 00000000..c95c158b --- /dev/null +++ b/tldr/adb-start-server @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# adb start-server + +> Start the Android Debug Bridge (adb) server to allow adb connections from devices or emulators. +> More information: . + +- Start the adb server if it is not running: + +`adb start-server` diff --git a/tldr/anki b/tldr/anki index 4a518e64..b60a911f 100644 --- a/tldr/anki +++ b/tldr/anki @@ -12,14 +12,14 @@ source: https://github.com/tldr-pages/tldr.git `anki` -- Use a specific [p]rofile: +- Use a specific profile: -`anki -p {{profile_name}}` +`anki {{[-p|--profile]}} {{profile_name}}` -- Use a specific [l]anguage: +- Use a specific language: -`anki -l {{language}}` +`anki {{[-l|--lang]}} {{language}}` - Use a non-default directory (`~/Anki` for default): -`anki -b {{path/to/directory}}` +`anki {{[-b|--base]}} {{path/to/directory}}` diff --git a/tldr/ansiweather b/tldr/ansiweather index e3f049af..766399f6 100644 --- a/tldr/ansiweather +++ b/tldr/ansiweather @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Display the current weather conditions in your terminal. > More information: . -- Display a [f]orecast using metric [u]nits for the next seven days for a specific [l]ocation: +- Display a [f]orecast for the next seven days using metric [u]nits for a specific [l]ocation: `ansiweather -u metric -f 7 -l {{Rzeszow,PL}}` diff --git a/tldr/apropos b/tldr/apropos index 9ef05535..395c064b 100644 --- a/tldr/apropos +++ b/tldr/apropos @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `apropos {{regex}}` -- Search without restricting the output to the terminal width ([l]ong output): +- Search without restricting the output to the terminal width (long output): `apropos {{[-l|--long]}} {{regex}}` diff --git a/tldr/argon2 b/tldr/argon2 index 4c24a37d..f0cc1bae 100644 --- a/tldr/argon2 +++ b/tldr/argon2 @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `echo "{{password}}" | argon2 "{{salt_text}}" -{{d|i|id}}` -- Display the output hash without additional information: +- Display the output [e]ncoded hash without additional information: `echo "{{password}}" | argon2 "{{salt_text}}" -e` diff --git a/tldr/arping b/tldr/arping index ecc72566..5b39562f 100644 --- a/tldr/arping +++ b/tldr/arping @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `arping {{host_ip}}` -- Ping a host on a specific interface: +- Ping a host on a specific [I]nterface: `arping -I {{interface}} {{host_ip}}` diff --git a/tldr/beanstalkd b/tldr/beanstalkd index d4d7979b..a5e1e253 100644 --- a/tldr/beanstalkd +++ b/tldr/beanstalkd @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `beanstalkd` -- Listen on a specific [p]ort and address: +- [l]isten on a specific [p]ort and address: `beanstalkd -l {{ip_address}} -p {{port_number}}` diff --git a/tldr/brew-leaves b/tldr/brew-leaves new file mode 100644 index 00000000..4a44cac9 --- /dev/null +++ b/tldr/brew-leaves @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# brew leaves + +> List installed formulas that are not dependencies of another installed formula or cask. +> More information: . + +- List installed formulas that are not dependent on other installed formulas or casks: + +`brew leaves` + +- Only list leaves that were manually installed: + +`brew leaves {{[-r|--installed-on-request]}}` + +- Only list leaves that were installed as dependencies: + +`brew leaves {{[-p|--installed-as-dependency]}}` + +- Display help: + +`brew leaves {{[-h|--help]}}` diff --git a/tldr/cancel b/tldr/cancel index 2b5230c3..e441f969 100644 --- a/tldr/cancel +++ b/tldr/cancel @@ -33,6 +33,6 @@ source: https://github.com/tldr-pages/tldr.git `cancel -a {{printer}}` -- Cancel the current job of a specific server and then delete ([x]) job data files: +- Cancel the current job of a specific [h]ost server and then delete ([x]) job data files: `cancel -h {{server}} -x` diff --git a/tldr/certutil b/tldr/certutil index 31ee40c3..b9e1f3ea 100644 --- a/tldr/certutil +++ b/tldr/certutil @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `certutil -N -d .` -- List all certificates in a database: +- [L]ist all certificates in a database: `certutil -L -d .` diff --git a/tldr/chmod b/tldr/chmod index fca349af..2d929676 100644 --- a/tldr/chmod +++ b/tldr/chmod @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `chmod {{[-R|--recursive]}} g+w,o+w {{path/to/directory}}` -- Recursively give [a]ll users [r]ead permissions to files and e[X]ecute permissions to sub-directories within a directory: +- Recursively give [a]ll users [r]ead permissions to files. Also give e[X]ecute permissions to files that have at least one execution permission and to all sub-directories: `chmod {{[-R|--recursive]}} a+rX {{path/to/directory}}` diff --git a/tldr/csh b/tldr/csh index 35c66ce4..b83b9ddf 100644 --- a/tldr/csh +++ b/tldr/csh @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `csh` -- Start an interactive shell session without loading startup configs: +- Start an interactive shell session [f]aster without loading startup configs: `csh -f` diff --git a/tldr/cupsd b/tldr/cupsd index 0b5c0278..c756817f 100644 --- a/tldr/cupsd +++ b/tldr/cupsd @@ -20,22 +20,22 @@ source: https://github.com/tldr-pages/tldr.git `cupsd -l` -- Start `cupsd` using the specified [`c`]`upsd.conf` configuration file: +- Start `cupsd` using the specified `cupsd.conf` [c]onfiguration file: `cupsd -c {{path/to/cupsd.conf}}` -- Start `cupsd` using the specified `cups-file`[`s`]`.conf` configuration file: +- Start `cupsd` using the specified `cups-files.conf` configuration file: `cupsd -s {{path/to/cups-files.conf}}` -- [t]est the [`c`]`upsd.conf` configuration file for errors: +- [t]est the `cupsd.conf` [c]onfiguration file for errors: `cupsd -t -c {{path/to/cupsd.conf}}` -- [t]est the `cups-file`[`s`]`.conf` configuration file for errors: +- [t]est the `cups-files.conf` configuration file for errors: `cupsd -t -s {{path/to/cups-files.conf}}` -- Display help: +- Display [h]elp: `cupsd -h` diff --git a/tldr/freeze b/tldr/freeze new file mode 100644 index 00000000..d89ec1e5 --- /dev/null +++ b/tldr/freeze @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# freeze + +> Generate images of code and terminal output. +> Supported formats are PNG, SVG, and WebP. +> See also: `silicon`. +> More information: . + +- Generate an image of code based on a file: + +`freeze {{path/to/file}}` + +- Specify the output path: + +`freeze {{path/to/file}} {{[-o|--output]}} {{path/to/output_image.png}}` + +- Generate an image of terminal output: + +`freeze {{[-x|--execute]}} {{command}}` + +- Interactively customize the output image: + +`freeze {{path/to/file}} {{[-i|--interactive]}}` + +- Select a theme for syntax highlighting: + +`freeze {{path/to/file}} {{[-t|--theme]}} {{dracula}}` + +- Use a base configuration template: + +`freeze {{path/to/file}} {{[-c|--config]}} {{base|full|user}}` + +- Capture a specific range of line numbers: + +`freeze {{path/to/file}} --lines {{start}},{{end}}` + +- Show line numbers: + +`freeze {{path/to/file}} --show-line-numbers` diff --git a/tldr/gammastep b/tldr/gammastep index 04decbf1..192c731d 100644 --- a/tldr/gammastep +++ b/tldr/gammastep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gammastep > Adjust the screen's color temperature according to the time of day. -> More information: . +> More information: . - Turn on Gammastep with a specific [t]emperature during the day (e.g. 5700k) and at night (e.g. 3600k): diff --git a/tldr/gettext b/tldr/gettext index e92aade4..f1f9dc18 100644 --- a/tldr/gettext +++ b/tldr/gettext @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gettext > Translates a string using stored translations in a compiled `.mo` file. -> Translations are stored in `/usr/share/locale//LC_MESSAGES/` with `domain` being the filename without its extension. +> Translations are stored in `/usr/share/locale/locale_name/LC_MESSAGES/` with `domain` being the filename without its extension. > See also: `msgfmt`, `msgunfmt`. > More information: . diff --git a/tldr/git-browse-ci b/tldr/git-browse-ci index 92227e8b..63c1eb64 100644 --- a/tldr/git-browse-ci +++ b/tldr/git-browse-ci @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # git browse-ci -> Open the current `git` repository's CI website in the default web browser. +> Open the current Git repository's CI website in the default web browser. > Part of `git-extras`. > More information: . diff --git a/tldr/git-delete-submodule b/tldr/git-delete-submodule index ceb44264..69671775 100644 --- a/tldr/git-delete-submodule +++ b/tldr/git-delete-submodule @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # git delete-submodule -> Delete a submodule from a `git` repository. +> Delete a submodule from a Git repository. > Part of `git-extras`. > More information: . diff --git a/tldr/git-get-tar-commit-id b/tldr/git-get-tar-commit-id new file mode 100644 index 00000000..4b6f3e1c --- /dev/null +++ b/tldr/git-get-tar-commit-id @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# git get-tar-commit-id + +> Extract commit ID from an archive created using `git archive`. +> More information: . + +- Extract commit hash ID or quietly exit with a return code of 1: + +`git < {{path/to/archive.tar}} get-tar-commit-id` diff --git a/tldr/gladtex b/tldr/gladtex index 2426e855..97f5c84f 100644 --- a/tldr/gladtex +++ b/tldr/gladtex @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `gladtex {{path/to/input.htex}}` -- Save the converted file to a specific location: +- Save the converted file to a specific [o]utput file: `gladtex {{path/to/input.htex}} -o {{path/to/output.html}}` @@ -35,4 +35,4 @@ source: https://github.com/tldr-pages/tldr.git - Convert Markdown to HTML using `pandoc` and `gladtex`: -`pandoc -s -t html --gladtex {{path/to/input.md}} | gladtex -o {{path/to/output.html}}` +`pandoc {{[-s|--standalone]}} {{[-t|--to]}} html --gladtex {{path/to/input.md}} | gladtex -o {{path/to/output.html}}` diff --git a/tldr/gnatmake b/tldr/gnatmake index 7343b0b1..b5c369e8 100644 --- a/tldr/gnatmake +++ b/tldr/gnatmake @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `gnatmake {{source_file1.adb source_file2.adb ...}}` -- Set a custom executable name: +- Set a custom [o]utput executable name: `gnatmake -o {{executable_name}} {{source_file.adb}}` diff --git a/tldr/goimports b/tldr/goimports index 7264ec14..b8221d63 100644 --- a/tldr/goimports +++ b/tldr/goimports @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # goimports -> Updates Go import lines, adding missing ones and removing unreferenced ones. +> Update Go import lines, adding missing ones and removing unreferenced ones. > More information: . - Display the completed import source file: diff --git a/tldr/history b/tldr/history index eac0bbe7..f1a300d8 100644 --- a/tldr/history +++ b/tldr/history @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Add a command to history without running it: `history -s {{command}}` + +- Run a command without adding it to history by adding a leading space: + +`{{command}}` diff --git a/tldr/hub-init b/tldr/hub-init index 06014275..42912b65 100644 --- a/tldr/hub-init +++ b/tldr/hub-init @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # hub init -> Initializes a new local Git repository. +> Initialize a new local Git repository. > More information: . - Initialize a new local repository: diff --git a/tldr/ifdata b/tldr/ifdata index d4028968..8091975e 100644 --- a/tldr/ifdata +++ b/tldr/ifdata @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Display information about a network interface. > More information: . -- Display the whole configuration of the specified interface: +- [p]rint the whole configuration of the specified interface: `ifdata -p {{eth0}}` @@ -16,11 +16,11 @@ source: https://github.com/tldr-pages/tldr.git `ifdata -e {{eth0}}` -- Display the IPv4 [a]dress and the [n]etmask of the specified interface: +- [p]rint the IPv4 [a]dress and the [n]etmask of the specified interface: `ifdata -pa -pn {{eth0}}` -- Display the [N]etwork adress, the [b]roadcast adress, and the MTU of the specified interface: +- [p]rint the [N]etwork adress, the [b]roadcast adress, and the [m]TU of the specified interface: `ifdata -pN -pb -pm {{eth0}}` diff --git a/tldr/in-toto-record b/tldr/in-toto-record index 3d5026fb..520da2af 100644 --- a/tldr/in-toto-record +++ b/tldr/in-toto-record @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Start the record (creates a preliminary link file): -`in-toto-record start {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-m|--materials]}} {{.}}` +`in-toto-record start {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} --signing-key {{path/to/key_file}} {{[-m|--materials]}} {{.}}` - Stop the record (expects a preliminary link file): -`in-toto-record stop {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-p|--products]}} {{.}}` +`in-toto-record stop {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} --signing-key {{path/to/key_file}} {{[-p|--products]}} {{.}}` diff --git a/tldr/in-toto-run b/tldr/in-toto-run index 945b750b..1caaf427 100644 --- a/tldr/in-toto-run +++ b/tldr/in-toto-run @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Tag a Git repo and signing the resulting link file: -`in-toto-run {{[-n|--step-name]}} {{tag}} {{[-p|--products]}} {{.}} -k {{key_file}} -- {{git tag v1.0}}` +`in-toto-run {{[-n|--step-name]}} {{tag}} {{[-p|--products]}} {{.}} --signing-key {{key_file}} -- {{git tag v1.0}}` - Create a tarball, storing files as materials and the tarball as product: @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Generate signed attestations for review work: -`in-toto-run {{[-n|--step-name]}} {{review}} -k {{key_file}} {{[-m|--materials]}} {{document.pdf}} {{[-x|--no-command]}}` +`in-toto-run {{[-n|--step-name]}} {{review}} --signing-key {{key_file}} {{[-m|--materials]}} {{document.pdf}} {{[-x|--no-command]}}` - Scan the image using Trivy and generate link file: -`in-toto-run {{[-n|--step-name]}} {{scan}} -k {{key_file}} {{[-p|--products]}} {{report.json}} -- {{/bin/sh -c "trivy --output report.json --format json "}}` +`in-toto-run {{[-n|--step-name]}} {{scan}} --signing-key {{key_file}} {{[-p|--products]}} {{report.json}} -- /bin/sh -c "trivy --output report.json --format json {{path/to/image}}"` diff --git a/tldr/ipcs b/tldr/ipcs index d62f2f97..4fc6c50d 100644 --- a/tldr/ipcs +++ b/tldr/ipcs @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Show information about the usage of XSI IPC facilities: shared memory segments, message queues, and semaphore arrays. > More information: . -- Show information about all the IPC: +- Show information about [a]ll the IPC: `ipcs -a` diff --git a/tldr/iproxy b/tldr/iproxy index 0541cab7..612c4c15 100644 --- a/tldr/iproxy +++ b/tldr/iproxy @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `iproxy --udid {{device_udid}} {{local_port}}:{{device_port}}` -- Bind a local port and forward it to a network-connected device with WiFi sync enabled: +- Bind a local port and forward it to a network-connected device with Wi-Fi sync enabled: `iproxy --network {{local_port}}:{{device_port}}` diff --git a/tldr/jira b/tldr/jira index b422ae28..8c473231 100644 --- a/tldr/jira +++ b/tldr/jira @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - List issues from the current sprint, assigned to me: -`jira sprint list --current -a$(jira me)` +`jira sprint list --current {{[-a|--assignee]}} $(jira me)` - Create a new issue, optionally set a parent issue: -`jira issue create --parent {{parent}}` +`jira issue create {{[-P|--parent]}} {{parent}}` diff --git a/tldr/k8s-unused-secret-detector b/tldr/k8s-unused-secret-detector index 2e19cd77..d1ca1ac1 100644 --- a/tldr/k8s-unused-secret-detector +++ b/tldr/k8s-unused-secret-detector @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete unused secrets in a specific namespace: -`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}} | kubectl delete secret {{[-n|--namespace]}} {{namespace}}` +`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}} | kubectl delete secrets {{[-n|--namespace]}} {{namespace}}` diff --git a/tldr/ksh b/tldr/ksh index 4aaf4a3d..97b1df32 100644 --- a/tldr/ksh +++ b/tldr/ksh @@ -25,6 +25,6 @@ source: https://github.com/tldr-pages/tldr.git `ksh -n {{path/to/script.ksh}}` -- Execute a specific script, printing each command in the script before executing it: +- E[x]ecute a specific script, printing each command in the script before executing it: `ksh -x {{path/to/script.ksh}}` diff --git a/tldr/kubeseal b/tldr/kubeseal index 57c60d49..683515ba 100644 --- a/tldr/kubeseal +++ b/tldr/kubeseal @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Client-side utility for encrypting Kubernetes secrets using the Bitnami Sealed Secrets controller. > Creates SealedSecret resources that can be safely stored in version control. -> Requires a controller running in the cluster (e.g., installed via `kubectl apply -f controller.yaml`). +> Requires a controller running in the cluster (e.g., installed via `kubectl apply --filename controller.yaml`). > More information: . - Encrypt a Kubernetes secret from a YAML file into a SealedSecret (default JSON output): diff --git a/tldr/kustomize b/tldr/kustomize index f7e72430..771e717d 100644 --- a/tldr/kustomize +++ b/tldr/kustomize @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kustomize > Easily deploy resources for Kubernetes. -> More information: . +> More information: . - Create a kustomization file with resources and namespace: diff --git a/tldr/linux/createrepo b/tldr/linux/createrepo index 275025b9..7b8e1502 100644 --- a/tldr/linux/createrepo +++ b/tldr/linux/createrepo @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # createrepo -> Initializes an RPM repository in a directory, including all XML and SQLite files. +> Initialize an RPM repository in a directory, including all XML and SQLite files. > More information: . - Initialize a basic repository in a directory: diff --git a/tldr/linux/dnf-versionlock b/tldr/linux/dnf-versionlock new file mode 100644 index 00000000..070424b9 --- /dev/null +++ b/tldr/linux/dnf-versionlock @@ -0,0 +1,31 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# dnf versionlock + +> Protect packages from updates to newer versions. +> Not default to `dnf` but supported via `dnf-plugins-core`. +> See also: `dnf`. +> More information: . + +- List the current versionlock entries: + +`dnf versionlock` + +- Add a versionlock for all available packages matching the spec: + +`dnf versionlock add {{package}}` + +- Add an exclude (within versionlock) for the available packages matching the spec: + +`dnf versionlock exclude {{package}}` + +- Remove any matching versionlock entries: + +`dnf versionlock delete {{package}}` + +- Remove all versionlock entries: + +`dnf versionlock clear` diff --git a/tldr/linux/impala b/tldr/linux/impala index 3a4357f6..26b183e6 100644 --- a/tldr/linux/impala +++ b/tldr/linux/impala @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # impala -> Manage WiFi networks through a TUI. +> Manage Wi-Fi networks through a TUI. > More information: . - Launch `impala` in station mode: diff --git a/tldr/linux/iw-dev b/tldr/linux/iw-dev index aacc43ff..e3693492 100644 --- a/tldr/linux/iw-dev +++ b/tldr/linux/iw-dev @@ -17,11 +17,11 @@ source: https://github.com/tldr-pages/tldr.git `sudo iw dev {{wlp}} set type managed` -- Set device WiFi channel (device must first be in monitor mode with the interface up): +- Set device Wi-Fi channel (device must first be in monitor mode with the interface up): `sudo iw dev {{wlp}} set channel {{channel_number}}` -- Set device WiFi frequency in Mhz (device must first be in monitor mode with the interface up): +- Set device Wi-Fi frequency in Mhz (device must first be in monitor mode with the interface up): `sudo iw dev {{wlp}} set freq {{freq_in_mhz}}` diff --git a/tldr/linux/pw-mididump b/tldr/linux/pw-mididump new file mode 100644 index 00000000..0b2c86ce --- /dev/null +++ b/tldr/linux/pw-mididump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pw-mididump + +> Dump MIDI messages to `stdout`. +> More information: . + +- Listen for and dump all incoming MIDI events: + +`pw-mididump` + +- Dump MIDI events from a specific file: + +`pw-mididump {{path/to/file.mid}}` + +- Connect to a specific remote PipeWire instance: + +`pw-mididump {{[-r|--remote]}} {{remote_instance_name}}` + +- Display help: + +`pw-mididump {{[-h|--help]}}` diff --git a/tldr/linux/rnm b/tldr/linux/rnm index 70e0a79a..b88f2241 100644 --- a/tldr/linux/rnm +++ b/tldr/linux/rnm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rnm > Bulk Rename Utility. -> More information: . +> More information: . - Replace a search string with a replacement string in filenames: diff --git a/tldr/linux/slurmrestd b/tldr/linux/slurmrestd index f299ea5e..81bbead6 100644 --- a/tldr/linux/slurmrestd +++ b/tldr/linux/slurmrestd @@ -8,26 +8,26 @@ source: https://github.com/tldr-pages/tldr.git > Interface to Slurm via REST API. It can be used in two modes: *Inetd Mode* & *Listen Mode*. > More information: . -- Change the group ID (and drop supplemental groups) before processing client requests: +- Change the [g]roup ID (and drop supplemental groups) before processing client requests: -`slurmrestd -g {{group_id}} {{[host]:port | unix:/path/to/socket}}` +`slurmrestd -g {{group_id}} {{[host]:port|unix:/path/to/socket}}` -- Comma-delimited list of authentication plugins to load: +- Comma-delimited list of [a]uthentication plugins to load: -`slurmrestd -a {{authentication_plugins}} {{[host]:port | unix:/path/to/socket}}` +`slurmrestd -a {{authentication_plugins}} {{[host]:port|unix:/path/to/socket}}` -- Read Slurm configuration from the specified file: +- Read Slurm configuration from the specified [f]ile: `slurmrestd -f {{path/to/file}}` -- Change user ID before processing client request: +- Change [u]ser ID before processing client request: `slurmrestd -u {{user_id}}` -- Display help: +- Display [h]elp: `slurmrestd -h` -- Display version: +- Display [V]ersion: `slurmrestd -V` diff --git a/tldr/linux/slurp b/tldr/linux/slurp index 5d8f85d8..77046533 100644 --- a/tldr/linux/slurp +++ b/tldr/linux/slurp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # slurp > Select a region in a Wayland compositor. -> More information: . +> More information: . - Select a region and print it to `stdout`: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Select a specific region and take a borderless video of it, using `wf-recorder`: -`wf-recorder --geometry "$(slurp -w 0)"` +`wf-recorder {{[-g|--geometry]}} "$(slurp -w 0)"` diff --git a/tldr/linux/systemctl-list-timers b/tldr/linux/systemctl-list-timers new file mode 100644 index 00000000..c842103e --- /dev/null +++ b/tldr/linux/systemctl-list-timers @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl list-timers + +> List all active systemd timers. +> More information: . + +- List all active timers: + +`systemctl list-timers` + +- List all timers, including inactive ones: + +`systemctl list-timers {{[-a|--all]}}` + +- List timers matching a pattern: + +`systemctl list-timers {{pattern}}` + +- List timers matching a specific state: + +`systemctl list-timers --state {{active|inactive|failed|...}}` diff --git a/tldr/linux/vncviewer b/tldr/linux/vncviewer index db2a995d..442ed081 100644 --- a/tldr/linux/vncviewer +++ b/tldr/linux/vncviewer @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # vncviewer -> Launches a VNC (Virtual Network Computing) client. +> Launch a VNC (Virtual Network Computing) client. > More information: . - Launch a VNC client which connects to a host on a given display: diff --git a/tldr/mdk4 b/tldr/mdk4 index dcfd54c1..3f9f41c8 100644 --- a/tldr/mdk4 +++ b/tldr/mdk4 @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # mdk4 > A proof-of-concept tool to exploit common IEEE 802.11 protocol weaknesses. -> Note: Exercise extreme caution as this tool can disrupt WiFi networks and disconnect nearby users. +> Note: Exercise extreme caution as this tool can disrupt Wi-Fi networks and disconnect nearby users. > See also: `airodump-ng`, `airmon-ng`. > More information: . -- Flood access points with beacon frames to create fake networks (set interface to monitor mode with `sudo airmon-ng start ` if needed): +- Flood access points with beacon frames to create fake networks (set interface to monitor mode with `sudo airmon-ng start wifi_interface` if needed): `sudo mdk4 {{wifi_interface}} b -f {{path/to/beacons.txt}}` @@ -18,6 +18,6 @@ source: https://github.com/tldr-pages/tldr.git `sudo mdk4 {{wifi_interface}} d` -- Perform deauthentication attack on a specific BSSID (list BSSIDs using `sudo airodump-ng `): +- Perform deauthentication attack on a specific BSSID (list BSSIDs using `sudo airodump-ng wifi_interface`): `sudo mdk4 {{wifi_interface}} d -B {{BSSID}}` diff --git a/tldr/mvn-package b/tldr/mvn-package new file mode 100644 index 00000000..6b75f481 --- /dev/null +++ b/tldr/mvn-package @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# mvn package + +> Package the compiled code of a Maven project into its distributable format (such as a JAR or WAR). +> More information: . + +- Package a project: + +`mvn package` + +- Package a project while skipping test execution: + +`mvn package {{[-D|--define]}} skipTests` + +- Package a project and force Maven to update all dependencies: + +`mvn package {{[-U|--update-snapshots]}}` diff --git a/tldr/nmap b/tldr/nmap index 2cad2458..5da4a31f 100644 --- a/tldr/nmap +++ b/tldr/nmap @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `nmap -v{{1|2|3}} {{ip_or_hostname}}` -- Run a ping sweep over an entire subnet or individual hosts very aggressively: +- Run a ping sweep over an entire [s]ub[n]et or individual hosts very aggressively: `nmap -T5 -sn {{192.168.0.0/24|ip_or_hostname1,ip_or_hostname2,...}}` @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo nmap -A -iL {{path/to/file.txt}}` -- Scan a specific list of ports (use `-p-` for all ports from 1 to 65535): +- Scan a specific list of [p]orts (use `-p-` for all ports from 1 to 65535): `nmap -p {{port1,port2,...}} {{ip_or_host1,ip_or_host2,...}}` @@ -33,10 +33,10 @@ source: https://github.com/tldr-pages/tldr.git `nmap --script "default and safe" {{ip_or_host1,ip_or_host2,...}}` -- Scan for web servers running on standard ports 80 and 443 using all available `http-*` NSE scripts: +- Scan for web servers running on standard [p]orts 80 and 443 using all available `http-*` NSE scripts: `nmap --script "http-*" {{ip_or_host1,ip_or_host2,...}} -p 80,443` -- Attempt evading IDS/IPS detection by using an extremely slow scan (`-T0`), decoy source addresses (`-D`), [f]ragmented packets, random data and other methods: +- Attempt evading IDS/IPS detection by using an extremely slow scan (`-T0`), [D]ecoy source addresses, [f]ragmented packets, random data and other methods: `sudo nmap -T0 -D {{decoy_ip1,decoy_ip2,...}} --source-port {{53}} -f --data-length {{16}} -Pn {{ip_or_host}}` diff --git a/tldr/nnn b/tldr/nnn index f616b6cb..d834e620 100644 --- a/tldr/nnn +++ b/tldr/nnn @@ -12,15 +12,15 @@ source: https://github.com/tldr-pages/tldr.git `nnn` -- Start in detailed mode: +- Start in [d]etailed mode: `nnn -d` -- Show hidden files: +- Show [H]idden files: `nnn -H` -- Open an existing bookmark (defined in the `NNN_BMS` environment variable): +- Open an existing [b]ookmark (defined in the `NNN_BMS` environment variable): `nnn -b {{bookmark_name}}` diff --git a/tldr/open.fish b/tldr/open.fish index 3927487e..9e7ccb04 100644 --- a/tldr/open.fish +++ b/tldr/open.fish @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # open -> Opens files, directories, and URIs with default applications. +> Open files, directories, and URIs with default applications. > This command is available through fish on operating systems without the built-in `open` command (e.g. Haiku and macOS). > More information: . diff --git a/tldr/osx/xed b/tldr/osx/xed index 204b1352..c358b2e3 100644 --- a/tldr/osx/xed +++ b/tldr/osx/xed @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # xed -> Opens files for editing in Xcode. +> Open files for editing in Xcode. > More information: . - Open file in Xcode: diff --git a/tldr/perldoc b/tldr/perldoc index 8265d515..7a635b27 100644 --- a/tldr/perldoc +++ b/tldr/perldoc @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `perldoc -{{f|v|a}} {{name}}` -- Search in the question headings of Perl FAQ: +- Search in the [q]uestion headings of Perl FAQ: `perldoc -q {{regex}}` diff --git a/tldr/php b/tldr/php index 6946c1cf..bdc7102a 100644 --- a/tldr/php +++ b/tldr/php @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # php > PHP command-line interface. -> More information: . +> More information: . - Parse and execute a PHP script: @@ -20,11 +20,11 @@ source: https://github.com/tldr-pages/tldr.git `php {{[-a|--interactive]}}` -- Run PHP code (Notes: Don't use tags; escape double quotes with backslash): +- Run PHP code (Notes: Don't use `` tags; escape double quotes with backslash): `php {{[-r|--run]}} "{{code}}"` -- Start a PHP built-in web [S]erver in the current directory: +- Start a PHP built-in web server in the current directory: `php {{[-S|--server]}} {{host}}:{{port}}` diff --git a/tldr/pkg-config b/tldr/pkg-config index 9f4f346e..f32445fa 100644 --- a/tldr/pkg-config +++ b/tldr/pkg-config @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pkg-config > Provide the details of installed libraries for compiling applications. -> More information: . +> More information: . - Get the list of libraries and their dependencies: diff --git a/tldr/poetry-sync b/tldr/poetry-sync new file mode 100644 index 00000000..29314927 --- /dev/null +++ b/tldr/poetry-sync @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry sync + +> Syncs your project's environment with the `poetry.lock` file. +> More information: . + +- Sync your project’s environment with the `poetry.lock` file: + +`poetry sync` + +- Exclude one or more dependency groups for the installation: + +`poetry sync --without {{test|docs|...}}` + +- Select optional dependency groups: + +`poetry sync --with {{test|docs|...}}` + +- Install all dependency groups including optional groups: + +`poetry sync --all-groups` + +- Install specific dependency groups: + +`poetry sync --only {{test|docs|...}}` + +- Install project without dependencies: + +`poetry sync --only-root` + +- Specify extras to install: + +`poetry sync {{[-E|--extras]}}` + +- Skip the defaulted package installation for your project: + +`poetry sync --no-root` diff --git a/tldr/pueue-completions b/tldr/pueue-completions index 43f49941..8c3d568c 100644 --- a/tldr/pueue-completions +++ b/tldr/pueue-completions @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pueue completions -> Generate shell completion files for Bash, Elvish, Fish, PowerShell, and Zsh. +> Generate shell completion files for Bash, Elvish, fish, PowerShell, and Zsh. > More information: . - Generate completions for Bash: diff --git a/tldr/qmake b/tldr/qmake new file mode 100644 index 00000000..98b13b79 --- /dev/null +++ b/tldr/qmake @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# qmake + +> Generate Makefiles from Qt project files. +> More information: . + +- Generate a `Makefile` from a project file in the current directory: + +`qmake` + +- Specify `Makefile` and project file locations: + +`qmake -o {{path/to/Makefile}} {{path/to/project_file.pro}}` + +- Generate a default project file: + +`qmake -project` + +- Compile a project: + +`qmake && make` + +- Enable debug mode: + +`qmake -d` + +- Display help: + +`qmake -help` diff --git a/tldr/redis-cli b/tldr/redis-cli index 0b7368a8..484a7dc1 100644 --- a/tldr/redis-cli +++ b/tldr/redis-cli @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # redis-cli -> Opens a connection to a Redis server. +> Open a connection to a Redis server. > More information: . - Connect to the local server: diff --git a/tldr/rga b/tldr/rga index d7e4b2f7..e957c7c2 100644 --- a/tldr/rga +++ b/tldr/rga @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `rga --rga-list-adapters` -- Change which adapters to use (e.g. ffmpeg, pandoc, poppler etc.): +- Change which adapters to use (e.g. `ffmpeg`, `pandoc`, `poppler` etc.): `rga --rga-adapters={{adapter1,adapter2}} {{regex}}` diff --git a/tldr/rustup-init.sh b/tldr/rustup-init.sh index c33f0dd1..a9bf828a 100644 --- a/tldr/rustup-init.sh +++ b/tldr/rustup-init.sh @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Download and run `rustup-init` to install `rustup` and the default Rust toolchain: -`curl https://sh.rustup.rs -sSf | sh -s` +`curl https://sh.rustup.rs {{[-sSf|--silent --show-error --fail]}} | sh -s` - Download and run `rustup-init` and pass arguments to it: -`curl https://sh.rustup.rs -sSf | sh -s -- {{arguments}}` +`curl https://sh.rustup.rs {{[-sSf|--silent --show-error --fail]}} | sh -s -- {{arguments}}` - Run `rustup-init` and specify additional components or targets to install: diff --git a/tldr/sfdk-apply b/tldr/sfdk-apply index 143a1cad..1c697b32 100644 --- a/tldr/sfdk-apply +++ b/tldr/sfdk-apply @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk apply -> Applies patches from RPM SPEC file. +> Apply patches from RPM SPEC file. > More information: . - Apply all patches: diff --git a/tldr/sfdk-build-init b/tldr/sfdk-build-init index 7ac19ab1..b33b89fc 100644 --- a/tldr/sfdk-build-init +++ b/tldr/sfdk-build-init @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk build-init -> Initializes build directory. +> Initialize build directory. > More information: . - Initialize the current directory as the build directory: diff --git a/tldr/sfdk-build-requires b/tldr/sfdk-build-requires index ec75d0af..f5f05e00 100644 --- a/tldr/sfdk-build-requires +++ b/tldr/sfdk-build-requires @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk build-requires -> Updates build time dependencies. +> Update build time dependencies. > More information: . - Run a subcommand refreshing the cache: diff --git a/tldr/sfdk-build-shell b/tldr/sfdk-build-shell index 80de5eaf..bee6408c 100644 --- a/tldr/sfdk-build-shell +++ b/tldr/sfdk-build-shell @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk build-shell -> Executes custom steps in build engine. +> Execute custom steps in build engine. > See also: `sfdk config` for configuring the build target and `sfdk build-init` for initializing build tree. > More information: . diff --git a/tldr/sfdk-check b/tldr/sfdk-check index c98478db..7c095245 100644 --- a/tldr/sfdk-check +++ b/tldr/sfdk-check @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk check -> Performs quality checks. +> Perform quality checks. > More information: . - Display test suites: diff --git a/tldr/sfdk-cmake b/tldr/sfdk-cmake index 42d53a58..7f4197e3 100644 --- a/tldr/sfdk-cmake +++ b/tldr/sfdk-cmake @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk cmake -> Executes cmake build step. +> Execute cmake build step. > More information: . - Run cmake: diff --git a/tldr/sfdk-config b/tldr/sfdk-config index 8e3149df..b8c7668a 100644 --- a/tldr/sfdk-config +++ b/tldr/sfdk-config @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk config -> Configures sfdk. +> Configure sfdk. > More information: . - Show configuration in all scopes: diff --git a/tldr/sfdk-deploy b/tldr/sfdk-deploy index 07c9fc98..0318f3f2 100644 --- a/tldr/sfdk-deploy +++ b/tldr/sfdk-deploy @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk deploy -> Deploys build results to a device. +> Deploy build results to a device. > More information: . - Deploy using a specified method (`pkcon`, `rsync`, `sdk`, `zypper`, `zypper-dup` or `manual`): diff --git a/tldr/sfdk-device b/tldr/sfdk-device index 032d11e2..b49bf5cf 100644 --- a/tldr/sfdk-device +++ b/tldr/sfdk-device @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk device -> Maintains and controls registered devices. +> Maintain and control registered devices. > More information: . - Display the registered devices: diff --git a/tldr/sfdk-emulator b/tldr/sfdk-emulator index 3d700369..d202cd9d 100644 --- a/tldr/sfdk-emulator +++ b/tldr/sfdk-emulator @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk emulator -> Maintains and controls emulators. +> Maintain and control emulators. > More information: . - Display the installed emulators: diff --git a/tldr/sfdk-emulator-install b/tldr/sfdk-emulator-install index d060479f..4d34dc6f 100644 --- a/tldr/sfdk-emulator-install +++ b/tldr/sfdk-emulator-install @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk emulator install -> Installs emulators. +> Install emulators. > More information: . - Install an emulator: diff --git a/tldr/sfdk-engine b/tldr/sfdk-engine index 26bedbbe..066db853 100644 --- a/tldr/sfdk-engine +++ b/tldr/sfdk-engine @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk engine -> Maintains and controls the build engine. +> Maintain and control the build engine. > More information: . - Start the build engine: diff --git a/tldr/sfdk-init b/tldr/sfdk-init index 589799da..2d126ec1 100644 --- a/tldr/sfdk-init +++ b/tldr/sfdk-init @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk init -> Initializes a new project. +> Initialize a new project. > More information: . - Initialize a new project of the given type: diff --git a/tldr/sfdk-maintain b/tldr/sfdk-maintain index d6a09df0..4c4cbfde 100644 --- a/tldr/sfdk-maintain +++ b/tldr/sfdk-maintain @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk maintain -> Launches the interactive SDK Maintenance tool. +> Launch the interactive SDK Maintenance tool. > More information: . - Launch SDK Maintenance tool: diff --git a/tldr/sfdk-make b/tldr/sfdk-make index d29de5dd..75c2c1d8 100644 --- a/tldr/sfdk-make +++ b/tldr/sfdk-make @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk make -> Executes make build step. +> Execute make build step. > More information: . - Run make build: diff --git a/tldr/sfdk-make-install b/tldr/sfdk-make-install index 75ceb1cc..99af0877 100644 --- a/tldr/sfdk-make-install +++ b/tldr/sfdk-make-install @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk make-install -> Executes make-install build step. +> Execute make-install build step. > More information: . - Run make-install section of RPM SPEC file: diff --git a/tldr/sfdk-package b/tldr/sfdk-package index 15010a99..a5a310c1 100644 --- a/tldr/sfdk-package +++ b/tldr/sfdk-package @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk package -> Executes package creation build step. +> Execute package creation build step. > More information: . - Create a package: diff --git a/tldr/sfdk-prepare b/tldr/sfdk-prepare index e6802cf3..5e2ad3a1 100644 --- a/tldr/sfdk-prepare +++ b/tldr/sfdk-prepare @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk prepare -> Executes preparation build step. +> Execute preparation build step. > More information: . - Prepare sources using the recipe from RPM SPEC file: diff --git a/tldr/sfdk-qmake b/tldr/sfdk-qmake index 6345221e..eeb9b8f9 100644 --- a/tldr/sfdk-qmake +++ b/tldr/sfdk-qmake @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk qmake -> Executes qmake build step. +> Execute qmake build step. > More information: . - Run qmake build: diff --git a/tldr/sfdk-scrape b/tldr/sfdk-scrape index be87e620..ffd83a72 100644 --- a/tldr/sfdk-scrape +++ b/tldr/sfdk-scrape @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk scrape -> Converts source code modifications to patches. +> Convert source code modifications to patches. > More information: . - Save source modifications as patches: @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `sfdk scrape --stable` -- Scrape while saving patches to a specified [o]utput directory: +- Scrape while saving patches to a specified output directory: `sfdk scrape {{[-o|--output-dir]}} {{directory}}` diff --git a/tldr/sfdk-undeploy b/tldr/sfdk-undeploy index 3bd7a125..2731f981 100644 --- a/tldr/sfdk-undeploy +++ b/tldr/sfdk-undeploy @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk undeploy -> Undeploys build results from a device. +> Undeploy build results from a device. > More information: . - Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk` or `zypper`): diff --git a/tldr/silicon b/tldr/silicon index 103758e5..57d57204 100644 --- a/tldr/silicon +++ b/tldr/silicon @@ -6,16 +6,17 @@ source: https://github.com/tldr-pages/tldr.git # silicon > Create an image of source code. -> More information: . +> See also: `freeze`. +> More information: . - Generate an image from a specific source file: -`silicon {{path/to/source_file}} --output {{path/to/output_image}}` +`silicon {{path/to/source_file}} {{[-o|--output]}} {{path/to/output_image}}` - Generate an image from a source file with a specific programming language syntax highlighting (e.g. `rust`, `py`, `js`, etc.): -`silicon {{path/to/source_file}} --output {{path/to/output_image}} --language {{language|extension}}` +`silicon {{path/to/source_file}} {{[-o|--output]}} {{path/to/output_image}} {{[-l|--language]}} {{language|extension}}` - Generate an image from `stdin`: -`{{command}} | silicon --output {{path/to/output_image}}` +`{{command}} | silicon {{[-o|--output]}} {{path/to/output_image}}` diff --git a/tldr/smbmap b/tldr/smbmap index 3d62d216..7f5d36b8 100644 --- a/tldr/smbmap +++ b/tldr/smbmap @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `smbmap --host-file {{path/to/file}}` -- Display SMB shares and permissions on a host, prompting for user's password or NTLM hash: +- Display SMB shares and permissions on a [H]ost, prompting for user's password or NTLM hash: `smbmap {{[-u|--username]}} {{username}} --prompt -H {{ip}}` diff --git a/tldr/ssh b/tldr/ssh index 365200f4..54a8e92e 100644 --- a/tldr/ssh +++ b/tldr/ssh @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `ssh {{username}}@{{remote_host}}` -- Connect to a remote server with a specific identity (private key): +- Connect to a remote server with a specific [i]dentity (private key): `ssh -i {{path/to/key_file}} {{username}}@{{remote_host}}` diff --git a/tldr/subfinder b/tldr/subfinder index 9c75de93..d093649f 100644 --- a/tldr/subfinder +++ b/tldr/subfinder @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Discover valid subdomains for websites. > Designed as a passive framework to be useful for bug bounties and safe for penetration testing. -> More information: . +> More information: . - Find subdomains for a specific domain: diff --git a/tldr/windows/resolve-path b/tldr/windows/resolve-path index 2d0d325e..ad7796ed 100644 --- a/tldr/windows/resolve-path +++ b/tldr/windows/resolve-path @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # Resolve-Path -> Resolves the wildcard characters in a path, and displays the path contents. +> Resolve the wildcard characters in a path, and display the path contents. > Note: This command can only be used through PowerShell. > More information: . diff --git a/tldr/ytmdl b/tldr/ytmdl new file mode 100644 index 00000000..e5663f71 --- /dev/null +++ b/tldr/ytmdl @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ytmdl + +> Download songs from YouTube and automatically add metadata. +> Fetch song information (artist, album, cover art) from iTunes, Spotify, and other sources. +> More information: . + +- Download a song by name (with interactive selection): + +`ytmdl {{song_name}}` + +- Download the first result without prompting: + +`ytmdl {{[-q|--quiet]}} {{song_name}}` + +- Download a song to a specific directory: + +`ytmdl {{[-o|--output-dir]}} {{path/to/directory}} {{song_name}}` + +- Download a song from a YouTube URL: + +`ytmdl --url https://www.youtube.com/watch?v={{oHg5SJYRHA0}}` + +- Download a song in a specific format (mp3, m4a, or opus): + +`ytmdl --format {{mp3|m4a|opus}} {{song_name}}` + +- Download a song with artist and album information: + +`ytmdl --artist {{artist_name}} --album {{album_name}} {{song_name}}` + +- Download a list of songs from a text file: + +`ytmdl --list {{path/to/list.txt}}` + +- Display help: + +`ytmdl {{[-h|--help]}}` diff --git a/tldr/zek b/tldr/zek index a105478f..f296ed6a 100644 --- a/tldr/zek +++ b/tldr/zek @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # zek > Generate a Go struct from XML. -> More information: . +> More information: . - Generate a Go struct from a given XML from `stdin` and display output on `stdout`: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a Go struct from a given XML from `stdin` and send output to a file: -`curl -s {{https://url/to/xml}} | zek -o {{path/to/output.go}}` +`curl {{[-s|--silent]}} {{https://url/to/xml}} | zek -o {{path/to/output.go}}` - Generate an example Go program from a given XML from `stdin` and send output to a file: