diff --git a/tldr/bun-update b/tldr/bun-update new file mode 100644 index 00000000..c023e109 --- /dev/null +++ b/tldr/bun-update @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun update + +> Update dependencies in a Bun project. +> More information: . + +- Update all dependencies: + +`bun update` + +- Update to the latest version, regardless of its compatibility: + +`bun update --latest` + +- Update a specific dependency: + +`bun update {{package_name}}` + +- Update a dependency to a specific version: + +`bun update {{package_name}}@{{version}}` + +- Update packages interactively: + +`bun update {{[-i|--interactive]}}` + +- Update dependencies recursively across all workspaces: + +`bun update {{[-r|--recursive]}}` + +- Update dependencies interactively and recursively: + +`bun update {{[-i|--interactive]}} {{[-r|--recursive]}}` diff --git a/tldr/copilot b/tldr/copilot new file mode 100644 index 00000000..be3b426e --- /dev/null +++ b/tldr/copilot @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# copilot + +> Interact with GitHub Copilot. +> More information: . + +- Start interactive mode: + +`copilot` + +- Allow all file editing: + +`copilot --allow-tool write` + +- Resume the most recent session: + +`copilot --continue` + +- Resume a previous session using session picker: + +`copilot --resume` + +- Use a specific model: + +`copilot --model "{{gpt-5}}"` + +- Allow all Git commands except `git push`: + +`copilot --allow-tool 'shell(git:*)' --deny-tool 'shell(git push)'` + +- Execute a prompt directly without interactive mode, while allowing `copilot` to run any command: + +`copilot {{[-p|--prompt]}} "{{Fix the bug in main.js}}" --allow-all-tools` diff --git a/tldr/espeak b/tldr/espeak index 85f738dd..c5ef1c12 100644 --- a/tldr/espeak +++ b/tldr/espeak @@ -5,21 +5,34 @@ source: https://github.com/tldr-pages/tldr.git --- # espeak -> Use text-to-speech to speak through the default sound device. +> A multi-lingual software speech synthesizer. +> Note: `espeak` is considered discontinued, as development has shifted to `espeak-ng`. > More information: . - Speak a phrase aloud: -`espeak "I like to ride my bike."` +`espeak "{{text}}"` -- Speak a file aloud: +- Speak text from `stdin`: + +`echo "{{text}}" | espeak` + +- Speak the contents of a [f]ile: `espeak -f {{path/to/file}}` -- Save output to a WAV audio file, rather than speaking it directly: +- Speak using a specific [v]oice: -`espeak -w {{filename.wav}} "It's GNU plus Linux"` +`espeak -v {{voice}} "{{text}}"` -- Use a different voice: +- Speak at a specific [s]peed (default is 160) and [p]itch (default is 50): -`espeak -v {{voice}}` +`espeak -s {{speed}} -p {{pitch}} "{{text}}"` + +- Output the audio to a [w]AV file instead of speaking it directly: + +`espeak -w {{path/to/output.wav}} "{{text}}"` + +- List all available voices: + +`espeak --voices` diff --git a/tldr/espeak-ng b/tldr/espeak-ng new file mode 100644 index 00000000..6de12c16 --- /dev/null +++ b/tldr/espeak-ng @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# espeak-ng + +> A multi-lingual software speech synthesizer. +> See also: `speak-ng`, `espeak`. +> More information: . + +- Speak a phrase aloud: + +`espeak-ng "{{text}}"` + +- Speak text from `stdin`: + +`echo "{{text}}" | espeak-ng` + +- Speak the contents of a [f]ile: + +`espeak-ng -f {{path/to/file}}` + +- Speak using a specific [v]oice: + +`espeak-ng -v {{voice}} "{{text}}"` + +- Speak at a specific [s]peed (default is 175) and [p]itch (default is 50): + +`espeak-ng -s {{speed}} -p {{pitch}} "{{text}}"` + +- Output the audio to a [w]AV file instead of speaking it directly: + +`espeak-ng -w {{path/to/output.wav}} "{{text}}"` + +- List all available voices: + +`espeak-ng --voices` diff --git a/tldr/gh-copilot b/tldr/gh-copilot index 10b6521b..95253d7f 100644 --- a/tldr/gh-copilot +++ b/tldr/gh-copilot @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gh copilot > Interact with GitHub Copilot. +> Note: Deprecated in favor of `copilot`. > More information: . - Suggest a command, given a description: diff --git a/tldr/hyperfine b/tldr/hyperfine index 70c65b26..1a8a1c26 100644 --- a/tldr/hyperfine +++ b/tldr/hyperfine @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hyperfine > A benchmarking tool. -> More information: . +> More information: . - Run a basic benchmark, performing at least 10 runs: diff --git a/tldr/jenv b/tldr/jenv index 730f81a7..46bb46da 100644 --- a/tldr/jenv +++ b/tldr/jenv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jenv > Manage the "JAVA_HOME" environment variable. -> More information: . +> More information: . - Add a Java version to jEnv: diff --git a/tldr/kops b/tldr/kops index cb9d063a..63d2a7c7 100644 --- a/tldr/kops +++ b/tldr/kops @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kops > Create, destroy, upgrade and maintain Kubernetes clusters. -> More information: . +> More information: . - Create a cluster from the configuration specification: diff --git a/tldr/kubectl-drain b/tldr/kubectl-drain new file mode 100644 index 00000000..7ab490ff --- /dev/null +++ b/tldr/kubectl-drain @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubectl drain + +> Drain a node in preparation for maintenance by marking it unschedulable and evicting all pods. +> See also: `kubectl cordon`, `kubectl uncordon`. +> More information: . + +- Drain a node: + +`kubectl drain {{node_name}}` + +- Drain a node, ignoring DaemonSet-managed pods: + +`kubectl drain {{node_name}} --ignore-daemonsets` + +- Drain a node and delete pods using emptyDir volumes (local data will be lost): + +`kubectl drain {{node_name}} --ignore-daemonsets --delete-emptydir-data` + +- Drain a node, forcing eviction of pods not managed by a controller: + +`kubectl drain {{node_name}} --force` + +- Drain a node with a custom grace period for pod termination: + +`kubectl drain {{node_name}} --grace-period {{seconds}}` + +- Drain a node, evicting only pods that match a label selector: + +`kubectl drain {{node_name}} --pod-selector {{label_key}}={{label_value}}` + +- Drain a node with a timeout: + +`kubectl drain {{node_name}} --timeout {{duration}}` + +- Preview the drain operation without actually evicting pods (dry run): + +`kubectl drain {{node_name}} --dry-run={{none|server|client}}` diff --git a/tldr/linux/asciiart b/tldr/linux/asciiart index f598c2f2..18e4dcc5 100644 --- a/tldr/linux/asciiart +++ b/tldr/linux/asciiart @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # asciiart > Convert images to ASCII. -> More information: . +> More information: . - Read an image from a file and print in ASCII: diff --git a/tldr/linux/aura b/tldr/linux/aura index 823a8ba2..7157ab90 100644 --- a/tldr/linux/aura +++ b/tldr/linux/aura @@ -8,34 +8,30 @@ source: https://github.com/tldr-pages/tldr.git > The Aura Package Manager: a secure, multilingual package manager for Arch Linux and the AUR. > More information: . -- Search for packages from the official repositories and AUR: +- Search for packages from the AUR: -`aura --aursync --both --search {{keyword|regex}}` +`aura {{[-As|--aursync --search]}} {{keyword|regex}}` - Install a package from the AUR: -`aura --aursync {{package}}` +`aura {{[-A|--aursync]}} {{package}}` - Update all AUR packages in a verbose mode and remove all make dependencies: -`aura --aursync --diff --sysupgrade --delmakedeps --unsuppress` +`aura {{[-Akua|--aursync --diff --sysupgrade --delmakedeps]}}` - Install a package from the official repositories: -`aura --sync {{package}}` +`aura {{[-S|--sync]}} {{package}}` - Synchronize and update all packages from the official repositories: -`aura --sync --refresh --sysupgrade` - -- Downgrade a package using the package cache: - -`aura --downgrade {{package}}` +`aura {{[-Syu|--sync --refresh --sysupgrade]}}` - Remove a package and its dependencies: -`aura --remove --recursive --unneeded {{package}}` +`aura {{[-Rsu|--remove --recursive --unneeded]}} {{package}}` - Remove orphan packages (installed as dependencies but not required by any package): -`aura --orphans --abandon` +`aura {{[-Oj|--orphans --abandon]}}` diff --git a/tldr/linux/auracle b/tldr/linux/auracle index fea8dc1b..bb26af73 100644 --- a/tldr/linux/auracle +++ b/tldr/linux/auracle @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # auracle > Interact with Arch Linux's User Repository, commonly referred to as the AUR. -> More information: . +> More information: . - Display AUR packages that match a `regex`: diff --git a/tldr/linux/aurman b/tldr/linux/aurman index 42731f38..5ce17e45 100644 --- a/tldr/linux/aurman +++ b/tldr/linux/aurman @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > An Arch Linux utility to build and install packages from the Arch User Repository. > See also: `pacman`. -> More information: . +> More information: . - Synchronize and update all packages: diff --git a/tldr/linux/aurvote b/tldr/linux/aurvote index 3ba1f865..fcdec4e1 100644 --- a/tldr/linux/aurvote +++ b/tldr/linux/aurvote @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Vote for packages in the Arch User Repository. > To be able to vote, the file `~/.config/aurvote` must exist and contain your AUR credentials. -> More information: . +> More information: . - Interactively create the file `~/.config/aurvote` containing your AUR username and password: diff --git a/tldr/linux/blight b/tldr/linux/blight index 436abb4a..77ed9d3e 100644 --- a/tldr/linux/blight +++ b/tldr/linux/blight @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # blight > Utility for changing the display brightness. -> More information: . +> More information: . - Set display brightness to 50%: diff --git a/tldr/linux/br b/tldr/linux/br index fa65ed0a..ca20e5e8 100644 --- a/tldr/linux/br +++ b/tldr/linux/br @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Navigate directory trees interactively. > See also: `broot`. -> More information: . +> More information: . - Start and navigate the current directory tree interactively: diff --git a/tldr/linux/bspc b/tldr/linux/bspc index 4c54c37c..add2a8ef 100644 --- a/tldr/linux/bspc +++ b/tldr/linux/bspc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Configure and control `bspwm`, managing nodes, desktops, monitors, and more. > See also: `bspwm`. -> More information: . +> More information: . - Define two virtual desktops: diff --git a/tldr/linux/bspwm b/tldr/linux/bspwm index d9126c9f..8d1d8382 100644 --- a/tldr/linux/bspwm +++ b/tldr/linux/bspwm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A tiling window manager based on binary space partitioning. > See also: `bspc` for controlling it. -> More information: . +> More information: . - Start `bspwm` (note that a pre-existing window manager must not be open when this command is run): diff --git a/tldr/linux/cliphist b/tldr/linux/cliphist index b530dcdc..abfe0bde 100644 --- a/tldr/linux/cliphist +++ b/tldr/linux/cliphist @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage clipboard history for Wayland compositors. > Works with `wl-copy` and `wl-paste`. -> More information: . +> More information: . - List clipboard history entries: diff --git a/tldr/linux/debtap b/tldr/linux/debtap index d68850a6..b19222d6 100644 --- a/tldr/linux/debtap +++ b/tldr/linux/debtap @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Convert Debian packages into Arch Linux packages. > See also: `pacman-upgrade`. -> More information: . +> More information: . - Update debtap database (before the first run): diff --git a/tldr/linux/dex b/tldr/linux/dex index 4d83487b..043a0e41 100644 --- a/tldr/linux/dex +++ b/tldr/linux/dex @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dex > DesktopEntry Execution is a program to generate and execute DesktopEntry files of the Application type. -> More information: . +> More information: . - Execute all programs in the autostart folders: diff --git a/tldr/linux/dnsrecon b/tldr/linux/dnsrecon index ec50fbcf..55276f1e 100644 --- a/tldr/linux/dnsrecon +++ b/tldr/linux/dnsrecon @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dnsrecon > DNS enumeration tool. -> More information: . +> More information: . - Scan a domain and save the results to an SQLite database: diff --git a/tldr/linux/expac b/tldr/linux/expac index cf336f12..a743d9f6 100644 --- a/tldr/linux/expac +++ b/tldr/linux/expac @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A data extraction tool for alpm databases, offering printf-like flexibility for pacman-based utilities. > See also: `pacman`. -> More information: . +> More information: . - List the dependencies of a package: diff --git a/tldr/linux/farge b/tldr/linux/farge index c7857091..53d03649 100644 --- a/tldr/linux/farge +++ b/tldr/linux/farge @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # farge > Display the color of a specific pixel on the screen in either hexadecimal or RGB formats. -> More information: . +> More information: . - Display a small preview window of a pixel's color with it's hexadecimal value, and copy this value to the clipboard: diff --git a/tldr/linux/feedreader b/tldr/linux/feedreader index beaddd65..675e23a6 100644 --- a/tldr/linux/feedreader +++ b/tldr/linux/feedreader @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A GUI desktop RSS client. > Note: FeedReader is no longer being maintained. -> More information: . +> More information: . - Print the count of unread articles: diff --git a/tldr/linux/kjv b/tldr/linux/kjv index 966a3272..57cb3e69 100644 --- a/tldr/linux/kjv +++ b/tldr/linux/kjv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kjv > The word of God available right on your desktop. -> More information: . +> More information: . - Display books: diff --git a/tldr/linux/larasail b/tldr/linux/larasail index 4e6627c5..628045a2 100644 --- a/tldr/linux/larasail +++ b/tldr/linux/larasail @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # larasail > Manage Laravel on Digital Ocean servers. -> More information: . +> More information: . - Set up the server with Laravel dependencies using the default PHP version: diff --git a/tldr/linux/lci b/tldr/linux/lci index a62b6b13..fbb6b84b 100644 --- a/tldr/linux/lci +++ b/tldr/linux/lci @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`lci -h` +`lci {{[-h|--help]}}` - Display version: -`lci -v` +`lci {{[-v|--version]}}` diff --git a/tldr/linux/mashtree b/tldr/linux/mashtree index 581cfb93..d5513af4 100644 --- a/tldr/linux/mashtree +++ b/tldr/linux/mashtree @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Make a fast tree from genomes. > Does not make a phylogeny. -> More information: . +> More information: . - Fastest method in mashtree to create a tree from fastq and/or fasta files using multiple threads, piping into a newick file: diff --git a/tldr/linux/mbw b/tldr/linux/mbw index 4e8d64a0..a84404e3 100644 --- a/tldr/linux/mbw +++ b/tldr/linux/mbw @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mbw > Memory Bandwidth Benchmark. -> More information: . +> More information: . - Run 3 memory bandwidth tests with 512MB size: diff --git a/tldr/linux/mokutil b/tldr/linux/mokutil index 21eb474e..d6cf4854 100644 --- a/tldr/linux/mokutil +++ b/tldr/linux/mokutil @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Configure Secure Boot Machine Owner Keys (MOK). > Some operations, such as enabling and disabling Secure Boot or enrolling keys require a reboot. -> More information: . +> More information: . - Show if Secure Boot is enabled: @@ -23,15 +23,15 @@ source: https://github.com/tldr-pages/tldr.git - List enrolled keys: -`mokutil --list-enrolled` +`mokutil {{[-l|--list-enrolled]}}` - Enroll a new key: -`mokutil --import {{path/to/key.der}}` +`mokutil {{[-i|--import]}} {{path/to/key.der}}` - List the keys to be enrolled: -`mokutil --list-new` +`mokutil {{[-N|--list-new]}}` - Set shim verbosity: diff --git a/tldr/linux/mons b/tldr/linux/mons index fa04a54f..caa66bf4 100644 --- a/tldr/linux/mons +++ b/tldr/linux/mons @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # mons > Quickly manage two displays. -> More information: . +> More information: . - Enable only the primary monitor: `mons -o` -- Enable only the secondary monitor: +- Enable only the [s]econdary monitor: `mons -s` -- Duplicate the primary monitor onto the secondary monitor, using the resolution of the primary monitor: +- [d]uplicate the primary monitor onto the secondary monitor, using the resolution of the primary monitor: `mons -d` -- Mirror the primary monitor onto the secondary monitor, using the resolution of the secondary monitor: +- [m]irror the primary monitor onto the secondary monitor, using the resolution of the secondary monitor: `mons -m` diff --git a/tldr/linux/navi b/tldr/linux/navi index 4f262cca..53e3ec29 100644 --- a/tldr/linux/navi +++ b/tldr/linux/navi @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Autoselect and execute the snippet that best matches a query: -`navi --query '{{query}}' --best-match` +`navi {{[-q|--query]}} '{{query}}' --best-match` diff --git a/tldr/linux/pacaur b/tldr/linux/pacaur index 0a12f8ce..61c8e1b3 100644 --- a/tldr/linux/pacaur +++ b/tldr/linux/pacaur @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pacaur > A utility for Arch Linux to build and install packages from the Arch User Repository. -> More information: . +> More information: . - Synchronize and update all packages (includes AUR): diff --git a/tldr/linux/pacgraph b/tldr/linux/pacgraph index d0cd7fff..fec5b6b6 100644 --- a/tldr/linux/pacgraph +++ b/tldr/linux/pacgraph @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pacgraph > Draw a graph of installed packages to PNG/SVG/GUI/console. -> More information: . +> More information: . - Produce an SVG and PNG graph: @@ -14,28 +14,28 @@ source: https://github.com/tldr-pages/tldr.git - Produce an SVG graph: -`pacgraph --svg` +`pacgraph {{[-s|--svg]}}` - Print summary to console: -`pacgraph --console` +`pacgraph {{[-c|--console]}}` - Override the default filename/location (Note: Do not specify the file extension): -`pacgraph --file={{path/to/file}}` +`pacgraph {{[-f|--file]}} {{path/to/file}}` - Change the color of packages that are not dependencies: -`pacgraph --top={{color}}` +`pacgraph {{[-t|--top]}} {{color}}` - Change the color of package dependencies: -`pacgraph --dep={{color}}` +`pacgraph {{[-d|--dep]}} {{color}}` - Change the background color of a graph: -`pacgraph --background={{color}}` +`pacgraph {{[-b|--background]}} {{color}}` - Change the color of links between packages: -`pacgraph --link={{color}}` +`pacgraph {{[-l|--link]}} {{color}}` diff --git a/tldr/linux/pacreport b/tldr/linux/pacreport new file mode 100644 index 00000000..1658792c --- /dev/null +++ b/tldr/linux/pacreport @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pacreport + +> Generate a report of installed packages. +> More information: . + +- Generate a summary of installed packages: + +`pacreport` + +- List unowned files: + +`pacreport --unowned-files` + +- List missing package files: + +`pacreport --missing-files` + +- Search for unmerged backup files (i.e. `.pacnew`, `.pacsave`) in `/etc`: + +`pacreport --backups` + +- Display packages in a specific group that are not currently installed: + +`pacreport --group {{group_name}}` diff --git a/tldr/linux/pacstall b/tldr/linux/pacstall index beb337ee..a4eabc6f 100644 --- a/tldr/linux/pacstall +++ b/tldr/linux/pacstall @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Search the package database for a package name: -`pacstall --search {{query}}` +`pacstall {{[-S|--search]}} {{query}}` - Install a package: -`pacstall --install {{package}}` +`pacstall {{[-I|--install]}} {{package}}` - Remove a package: -`pacstall --remove {{package}}` +`pacstall {{[-R|--remove]}} {{package}}` - Add a repository to the database (only GitHub and GitLab are supported): -`pacstall --add-repo {{remote_repository_location}}` +`pacstall {{[-A|--add-repo]}} {{remote_repository_location}}` - Update pacstall's scripts: -`pacstall --update` +`pacstall {{[-U|--update]}}` - Update all packages: -`pacstall --upgrade` +`pacstall {{[-Up|--upgrade]}}` - Display information about a package: -`pacstall --cache-info {{package}}` +`pacstall {{[-Ci|--cache-info]}} {{package}}` - List all installed packages: -`pacstall --list` +`pacstall {{[-L|--list]}}` diff --git a/tldr/linux/pct-clone b/tldr/linux/pct-clone index c517783f..a2000225 100644 --- a/tldr/linux/pct-clone +++ b/tldr/linux/pct-clone @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Clone a container: -`pct clone {{template_id}} {{copy_id}}` +`pct {{[cl|clone]}} {{template_id}} {{copy_id}}` - Clone a container with a custom name: diff --git a/tldr/linux/pct-mount b/tldr/linux/pct-mount new file mode 100644 index 00000000..86ee3970 --- /dev/null +++ b/tldr/linux/pct-mount @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pct mount + +> Mount a container's filesystem on the host. +> More information: . + +- Mount the filesystem of a specific container: + +`pct mount {{100}}` diff --git a/tldr/linux/pct-unmount b/tldr/linux/pct-unmount new file mode 100644 index 00000000..117a4eec --- /dev/null +++ b/tldr/linux/pct-unmount @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pct unmount + +> Unmount a container's filesystem from the host. +> More information: . + +- Unmount the filesystem of a specific container: + +`pct unmount {{100}}` diff --git a/tldr/linux/physlock b/tldr/linux/physlock index cfad53cc..7b91064d 100644 --- a/tldr/linux/physlock +++ b/tldr/linux/physlock @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # physlock > Lock all consoles and virtual terminals. -> More information: . +> More information: . - Lock every console (require current user or root to unlock): diff --git a/tldr/linux/project-zomboid b/tldr/linux/project-zomboid new file mode 100644 index 00000000..cf3d143b --- /dev/null +++ b/tldr/linux/project-zomboid @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# Project Zomboid + +> Start a headless Project Zomboid server. +> More information: . + +- Start the server: + +`{{path/to/start-server.sh}}` + +- Start a server with a specific name: + +`{{path/to/start-server.sh}} -servername {{server_name}}` diff --git a/tldr/linux/pvesh b/tldr/linux/pvesh index 133068c1..3e452f01 100644 --- a/tldr/linux/pvesh +++ b/tldr/linux/pvesh @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Display API path usage instructions: `pvesh {{[u|usage]}} {{/pools}}` + +- Add a new thinpool to Proxmox: + +`pvesh create /storage --storage {{storage_id}} --vgname {{volume_group}} --type lvmthin --thinpool {{thinpool_name}} --content {{content_type1,content_type2,...}}` diff --git a/tldr/linux/pveum b/tldr/linux/pveum index 94a8b658..99abbbcd 100644 --- a/tldr/linux/pveum +++ b/tldr/linux/pveum @@ -16,6 +16,18 @@ source: https://github.com/tldr-pages/tldr.git `pveum {{[u|user]}} {{[a|add]}} {{username}}@pve` +- Add a user with an email, description, and password: + +`pveum {{[u|user]}} {{[a|add]}} {{username}}@pve --email {{email_address}} --comment {{description}} --password {{password}}` + +- Change user password: + +`pveum {{[pa|passwd]}} {{[username}}@pve` + - Delete a user: `pveum {{[u|user]}} {{[d|delete]}} {{username}}@pve` + +- Give a user access to a specific VM with specific permissions: + +`pveum {{[a|acl]}} {{[m|modify]}} /vms/{{1000}} --user {{username}}@pve --role {{PVEVMUser}}` diff --git a/tldr/linux/radeontop b/tldr/linux/radeontop index c4de0fdc..20fa1b56 100644 --- a/tldr/linux/radeontop +++ b/tldr/linux/radeontop @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Show utilization of AMD GPUs. > May require root privileges depending on your system. -> More information: . +> More information: . - Show the utilization of the default AMD GPU: @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Enable colored output: -`radeontop --color` +`radeontop {{[-c|--color]}}` - Select a specific GPU (the bus number is the first number in the output of `lspci`): -`radeontop --bus {{bus_number}}` +`radeontop {{[-b|--bus]}} {{bus_number}}` - Specify the display refresh rate (higher means more GPU overhead): -`radeontop --ticks {{samples_per_second}}` +`radeontop {{[-t|--ticks]}} {{samples_per_second}}` diff --git a/tldr/linux/retroarch b/tldr/linux/retroarch index 4ffc4c43..89447df4 100644 --- a/tldr/linux/retroarch +++ b/tldr/linux/retroarch @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A frontend for emulators, game engines and media players. > The reference implementation of the libretro API. -> More information: . +> More information: . - Start in the menu mode: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Start in full screen mode: -`retroarch --fullscreen` +`retroarch {{[-f|--fullscreen]}}` - List all compiled features: @@ -23,11 +23,11 @@ source: https://github.com/tldr-pages/tldr.git - Set the path of a configuration file: -`retroarch --config={{path/to/config_file}}` +`retroarch {{[-c|--config]}} {{path/to/config_file}}` - Display help: -`retroarch --help` +`retroarch {{[-h|--help]}}` - Display version: diff --git a/tldr/linux/rpmconf b/tldr/linux/rpmconf index c251df52..6283e577 100644 --- a/tldr/linux/rpmconf +++ b/tldr/linux/rpmconf @@ -7,12 +7,12 @@ source: https://github.com/tldr-pages/tldr.git > Handle RPMNEW, RPMSAVE and RPMORIG files left over by package upgrades. > See also: `rpm`. -> More information: . +> More information: . - List leftover files and interactively choose what to do with each of them: -`sudo rpmconf --all` +`sudo rpmconf {{[-a|--all]}}` - Delete orphaned RPMNEW and RPMSAVE files: -`sudo rpmconf --all --clean` +`sudo rpmconf {{[-a|--all]}} {{[-c|--clean]}}` diff --git a/tldr/linux/systemctl-link b/tldr/linux/systemctl-link new file mode 100644 index 00000000..fce7133e --- /dev/null +++ b/tldr/linux/systemctl-link @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl link + +> Link a unit file located outside the unit file search path into the search path. +> See also: `systemctl disable`. +> More information: . + +- Link a unit file to make it available for systemd commands: + +`systemctl link {{path/to/service}}` + +- Link multiple unit files at once: + +`systemctl link {{path/to/service1 path/to/service2 ...}}` diff --git a/tldr/linux/tod b/tldr/linux/tod index 6a798b23..085cb248 100644 --- a/tldr/linux/tod +++ b/tldr/linux/tod @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A tiny Todoist client in Rust. > It takes simple input and dumps it in your inbox or another project. Taking advantage of natural language processing to assign due dates, tags, etc. -> More information: . +> More information: . - Import your projects (this is necessary to enable project prompts): diff --git a/tldr/linux/trashy b/tldr/linux/trashy index e804998c..b58d3178 100644 --- a/tldr/linux/trashy +++ b/tldr/linux/trashy @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # trashy > An alternative to `rm` and `trash-cli` written in Rust. -> More information: . +> More information: . - Move a specific file to the trash: diff --git a/tldr/linux/woeusb b/tldr/linux/woeusb index cd01a795..f6eaa5e5 100644 --- a/tldr/linux/woeusb +++ b/tldr/linux/woeusb @@ -6,12 +6,12 @@ source: https://github.com/tldr-pages/tldr.git # woeusb > Windows media creation tool. -> More information: . +> More information: . - Format a USB then create a bootable Windows installation drive: -`woeusb --device {{path/to/windows.iso}} {{/dev/sdX}}` +`woeusb {{[-d|--device]}} {{path/to/windows.iso}} {{/dev/sdX}}` - Copy Windows files to an existing partition of a USB storage device and make it bootable, without erasing the current data: -`woeusb --partition {{path/to/windows.iso}} {{/dev/sdXN}}` +`woeusb {{[-p|--partition]}} {{path/to/windows.iso}} {{/dev/sdXN}}` diff --git a/tldr/linux/xed b/tldr/linux/xed index 7e3ca079..f82e92d6 100644 --- a/tldr/linux/xed +++ b/tldr/linux/xed @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xed > Edit files in Cinnamon desktop environment. -> More information: . +> More information: . - Start the editor: diff --git a/tldr/linux/ytfzf b/tldr/linux/ytfzf index 273b252e..dedcd970 100644 --- a/tldr/linux/ytfzf +++ b/tldr/linux/ytfzf @@ -7,23 +7,23 @@ source: https://github.com/tldr-pages/tldr.git > Find and download videos and music. Written in POSIX shell. > See also: `youtube-dl`, `yt-dlp`, `instaloader`. -> More information: . +> More information: . - Search for videos on YouTube with thumbnail previews: -`ytfzf --show-thumbnails {{search_pattern}}` +`ytfzf {{[-t|--show-thumbnails]}} {{search_pattern}}` - Play only the audio of the first item in a loop: -`ytfzf --audio-only --auto-select --loop {{search_pattern}}` +`ytfzf {{[-m|--audio-only]}} {{[-a|--auto-select]}} {{[-l|--loop]}} {{search_pattern}}` - Download a video from the history: -`ytfzf --download --choose-from-history` +`ytfzf {{[-d|--download]}} --choose-from-history` - Play all the music found in a search: -`ytfzf --audio-only --select-all {{search_pattern}}` +`ytfzf {{[-m|--audio-only]}} {{[-A|--select-all]}} {{search_pattern}}` - See the trending videos in an external menu: diff --git a/tldr/meshnamed b/tldr/meshnamed index 61e0ebd5..b6ea2fac 100644 --- a/tldr/meshnamed +++ b/tldr/meshnamed @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # meshnamed > Distributed naming system for IPv6 mesh networks. -> More information: . +> More information: . - Start a local meshname DNS server: diff --git a/tldr/osx/tag b/tldr/osx/tag index 86a528da..b4b45ae9 100644 --- a/tldr/osx/tag +++ b/tldr/osx/tag @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # tag > Edit tags on Mac OS X files (10.9 Mavericks and above). -> More information: . +> More information: . - Add tags to a file: -`tag --add {{tag_name1,tag_name2,...}} {{path/to/file}}` +`tag {{[-a|--add]}} {{tag_name1,tag_name2,...}} {{path/to/file}}` - Remove a tag: -`tag --remove {{tag_name}} {{path/to/file}}` +`tag {{[-r|--remove]}} {{tag_name}} {{path/to/file}}` - Remove all tags from a file: -`tag --remove \* {{path/to/file}}` +`tag {{[-r|--remove]}} \* {{path/to/file}}` - Show all files with a given tag: -`tag --match {{tag_name}}` +`tag {{[-m|--match]}} {{tag_name}}` diff --git a/tldr/poetry-new b/tldr/poetry-new new file mode 100644 index 00000000..25aded7f --- /dev/null +++ b/tldr/poetry-new @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry new + +> Create a new Poetry project in a specific directory. +> More information: . + +- Create a new project (defaults to `src` layout): + +`poetry new {{path/to/directory}}` + +- Create a new project asking for configuration details interactively: + +`poetry new {{path/to/directory}} {{[-i|--interactive]}}` + +- Create a new project with a specific package name: + +`poetry new {{path/to/directory}} --name {{package_name}}` + +- Create a new project using the flat layout (without the `src` directory): + +`poetry new {{path/to/directory}} --flat` + +- Create a new project with a specific author: + +`poetry new {{path/to/directory}} --author "{{Name }}"` + +- Create a new project with a specific README format: + +`poetry new {{path/to/directory}} --readme {{md|rst|txt|...}}` diff --git a/tldr/poetry-publish b/tldr/poetry-publish new file mode 100644 index 00000000..71d62dce --- /dev/null +++ b/tldr/poetry-publish @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry publish + +> Publishes a package to a remote repository. +> More information: . + +- Publish the current package to PyPI: + +`poetry publish` + +- Build the package before publishing: + +`poetry publish --build` + +- Publish to a specific repository: + +`poetry publish {{[-r|--repository]}} {{repository_name}}` + +- Publish with specific credentials: + +`poetry publish {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` + +- Perform a dry run to see what would be done without actually publishing: + +`poetry publish --dry-run` + +- Skip files that already exist in the repository: + +`poetry publish --skip-existing` diff --git a/tldr/poetry-remove b/tldr/poetry-remove new file mode 100644 index 00000000..d7ca2e9c --- /dev/null +++ b/tldr/poetry-remove @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry remove + +> Remove a package from the project dependencies. +> More information: . + +- Remove one or more packages from the project's dependencies: + +`poetry remove {{package1 package2 ...}}` + +- Remove a package from the development dependencies: + +`poetry remove {{package}} {{[-D|--dev]}}` + +- Remove a package from a specific dependency group: + +`poetry remove {{package}} {{[-G|--group]}} {{group_name}}` + +- Remove a package without making any changes (dry-run): + +`poetry remove {{package}} --dry-run` + +- Update the lock file only, without removing the package from the environment: + +`poetry remove {{package}} --lock` diff --git a/tldr/poetry-run b/tldr/poetry-run new file mode 100644 index 00000000..74bea1dd --- /dev/null +++ b/tldr/poetry-run @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry run + +> Run a command in the project's virtual environment. +> More information: . + +- Run a command inside the virtual environment: + +`poetry run {{command}}` + +- Run a command with arguments: + +`poetry run {{command}} {{argument1 argument2 ...}}` + +- Run a script defined in `pyproject.toml`: + +`poetry run {{script_name}}` + +- Run a Python script: + +`poetry run python {{path/to/script.py}}` diff --git a/tldr/poetry-update b/tldr/poetry-update new file mode 100644 index 00000000..08621335 --- /dev/null +++ b/tldr/poetry-update @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# poetry update + +> Update the dependencies as according to the `pyproject.toml` file. +> More information: . + +- Update all dependencies: + +`poetry update` + +- Update one or more specific packages: + +`poetry update {{package1 package2 ...}}` + +- Update the lock file only, without installing the packages: + +`poetry update --lock` + +- Synchronize the environment with the locked packages: + +`poetry update --sync` + +- Update dependencies only for a specific group: + +`poetry update --only {{group_name}}` + +- Simulate the update process without making changes: + +`poetry update --dry-run` diff --git a/tldr/speak-ng b/tldr/speak-ng new file mode 100644 index 00000000..35338e4e --- /dev/null +++ b/tldr/speak-ng @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# speak-ng + +> A multi-lingual software speech synthesizer. +> See also: `espeak-ng`, `espeak`. +> More information: . + +- Speak a phrase aloud: + +`speak-ng "{{text}}"` + +- Speak text from `stdin`: + +`echo "{{text}}" | speak-ng` + +- Speak the contents of a [f]ile: + +`speak-ng -f {{path/to/file}}` + +- Speak using a specific [v]oice: + +`speak-ng -v {{voice}} "{{text}}"` + +- Speak at a specific [s]peed (default is 175) and [p]itch (default is 50): + +`speak-ng -s {{speed}} -p {{pitch}} "{{text}}"` + +- Output the audio to a [w]AV file instead of speaking it directly: + +`speak-ng -w {{path/to/output.wav}} "{{text}}"` + +- List all available voices: + +`speak-ng --voices` diff --git a/tldr/sysbench b/tldr/sysbench index 4f8c0cdc..5632ea40 100644 --- a/tldr/sysbench +++ b/tldr/sysbench @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sysbench > Benchmark a System's CPU, IO and memory. -> More information: . +> More information: . - Run a CPU benchmark with 1 thread for 10 seconds: diff --git a/tldr/transcrypt b/tldr/transcrypt index e6b94c1a..2c030034 100644 --- a/tldr/transcrypt +++ b/tldr/transcrypt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # transcrypt > Transparently encrypt files within a Git repository. -> More information: . +> More information: . - Initialize an unconfigured repository: diff --git a/tldr/transfersh b/tldr/transfersh index b0f7f9d7..1d484a95 100644 --- a/tldr/transfersh +++ b/tldr/transfersh @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Upload a file showing a progress bar (requires Python package `requests_toolbelt`): -`transfersh --progress {{path/to/file}}` +`transfersh {{[-p|--progress]}} {{path/to/file}}` - Upload a file using a different file name: -`transfersh --name {{filename}} {{path/to/file}}` +`transfersh {{[-n|--name]}} {{filename}} {{path/to/file}}` - Upload a file to a custom transfer.sh server: -`transfersh --servername {{upload.server.name}} {{path/to/file}}` +`transfersh {{[-sn|--servername]}} {{upload.server.name}} {{path/to/file}}` - Upload all files from a directory recursively: -`transfersh --recursive {{path/to/directory}}/` +`transfersh {{[-r|--recursive]}} {{path/to/directory}}/` - Upload a specific directory as an uncompressed tar: -`transfersh -rt {{path/to/directory}}` +`transfersh {{[-rt|--recursive --tar]}} {{path/to/directory}}` diff --git a/tldr/tre b/tldr/tre index 27b28331..3a66cbf9 100644 --- a/tldr/tre +++ b/tldr/tre @@ -7,36 +7,36 @@ source: https://github.com/tldr-pages/tldr.git > Show the contents of the current directory as a tree. > Respects the `.gitignore` settings by default. -> More information: . +> More information: . - Print directories only: -`tre --directories` +`tre {{[-d|--directories]}}` - Print JSON containing files in the tree hierarchy instead of the normal tree diagram: -`tre --json` +`tre {{[-j|--json]}}` - Print files and directories up to the specified depth limit (where 1 means the current directory): -`tre --limit {{depth}}` +`tre {{[-l|--limit]}} {{depth}}` - Print all hidden files and directories using the specified colorization mode: -`tre --all --color {{automatic|always|never}}` +`tre {{[-a|--all]}} {{[-c|--color]}} {{automatic|always|never}}` - Print files within the tree hierarchy, assigning a shell alias to each file that, when called, will open the associated file using the provided `command` (or in `$EDITOR` by default): -`tre --editor {{command}}` +`tre {{[-e|--editor]}} {{command}}` - Print files within the tree hierarchy, excluding all paths that match the provided `regex`: -`tre --exclude {{regex}}` +`tre {{[-E|--exclude]}} {{regex}}` - Display version: -`tre --version` +`tre {{[-V|--version]}}` - Display help: -`tre --help` +`tre {{[-h|--help]}}` diff --git a/tldr/trufflehog b/tldr/trufflehog index 1444082e..6d03695c 100644 --- a/tldr/trufflehog +++ b/tldr/trufflehog @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # trufflehog > Find and verify credentials in files, Git repositories, S3 buckets, and Docker images. -> More information: . +> More information: . - Scan a Git repository for verified secrets: diff --git a/tldr/tspin b/tldr/tspin index fbd983d7..a75abd4f 100644 --- a/tldr/tspin +++ b/tldr/tspin @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tspin > A log file highlighter based on the `less` pager and basically behaves like any pager. -> More information: . +> More information: . - Read from file and view in `less`: diff --git a/tldr/tuc b/tldr/tuc index 9dd8345a..bc4fcf53 100644 --- a/tldr/tuc +++ b/tldr/tuc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Cut text (or bytes) where a delimiter matches, then keep the desired parts. > A more user-friendly and powerful version of `cut` with sensible defaults. -> More information: . +> More information: . - Cut and rearrange fields: diff --git a/tldr/twurl b/tldr/twurl index f6cf8fa9..52cc693d 100644 --- a/tldr/twurl +++ b/tldr/twurl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # twurl > Curl-like command but tailored specifically for the Twitter API. -> More information: . +> More information: . - Authorize `twurl` to access a Twitter account: diff --git a/tldr/ugrep b/tldr/ugrep index bab015aa..a281ec89 100644 --- a/tldr/ugrep +++ b/tldr/ugrep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ugrep > Ultra fast search tool with query TUI. -> More information: . +> More information: . - Start a query TUI to search files in the current directory recursively (`` for help): diff --git a/tldr/viu b/tldr/viu index 5813ef39..107d99cd 100644 --- a/tldr/viu +++ b/tldr/viu @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # viu > View images on the terminal. -> More information: . +> More information: . - Render an image or animated GIF: diff --git a/tldr/wakeonlan b/tldr/wakeonlan index 80738fa1..74d1c181 100644 --- a/tldr/wakeonlan +++ b/tldr/wakeonlan @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wakeonlan > Send packets to wake-on-LAN (WOL) enabled PCs. -> More information: . +> More information: . - Send packets to all devices on the local network (255.255.255.255) by specifying a MAC address: diff --git a/tldr/wasm-objdump b/tldr/wasm-objdump index 941b5e7a..c80a979b 100644 --- a/tldr/wasm-objdump +++ b/tldr/wasm-objdump @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wasm-objdump > Display information from WebAssembly binaries. -> More information: . +> More information: . - Display the section headers of a given binary: diff --git a/tldr/wasm-opt b/tldr/wasm-opt index 43e7d0ce..2bbded91 100644 --- a/tldr/wasm-opt +++ b/tldr/wasm-opt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wasm-opt > Optimize WebAssembly binary files. -> More information: . +> More information: . - Apply default optimizations and write to a given file: diff --git a/tldr/wasm2c b/tldr/wasm2c index ad282aeb..1dcdc212 100644 --- a/tldr/wasm2c +++ b/tldr/wasm2c @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wasm2c > Convert a file from the WebAssembly binary format to a C source file and header. -> More information: . +> More information: . - Convert a file to a C source file and header and display it to the console: diff --git a/tldr/wasm2wat b/tldr/wasm2wat index 6be7df91..4a67b463 100644 --- a/tldr/wasm2wat +++ b/tldr/wasm2wat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wasm2wat > Convert a file from the WebAssembly binary format to the text format. -> More information: . +> More information: . - Convert a file to the text format and display it to the console: diff --git a/tldr/wat2wasm b/tldr/wat2wasm index 567d684b..26df4683 100644 --- a/tldr/wat2wasm +++ b/tldr/wat2wasm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wat2wasm > Convert a file from the WebAssembly text format to the binary format. -> More information: . +> More information: . - Parse and check a file for errors: diff --git a/tldr/whatwaf b/tldr/whatwaf index 7482f783..f7ff896e 100644 --- a/tldr/whatwaf +++ b/tldr/whatwaf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # whatwaf > Detect and bypass web application firewalls and protection systems. -> More information: . +> More information: . - Detect protection on a single URL, optionally use verbose output: diff --git a/tldr/whatweb b/tldr/whatweb index f3b6836e..01b8b0ff 100644 --- a/tldr/whatweb +++ b/tldr/whatweb @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # whatweb > Next-generation web scanner. -> More information: . +> More information: . - Scan websites/targets for web technologies: diff --git a/tldr/wikit b/tldr/wikit index 1a41e09e..117a61e1 100644 --- a/tldr/wikit +++ b/tldr/wikit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wikit > Easily get Wikipedia summaries. -> More information: . +> More information: . - Show a short summary of a specific topic on Wikipedia: diff --git a/tldr/wrk b/tldr/wrk index a0b6b3d5..6c7afbc4 100644 --- a/tldr/wrk +++ b/tldr/wrk @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wrk > HTTP benchmarking tool. -> More information: . +> More information: . - Run a benchmark for `30` seconds, using `12` threads, and keeping `400` HTTP connections open: diff --git a/tldr/wuzz b/tldr/wuzz index 25547453..47533c1e 100644 --- a/tldr/wuzz +++ b/tldr/wuzz @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wuzz > Interactively inspect HTTP requests and responses. -> More information: . +> More information: . - Start `wuzz`: diff --git a/tldr/xh b/tldr/xh index a4da5e0f..94ba7d89 100644 --- a/tldr/xh +++ b/tldr/xh @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Friendly and fast tool for sending HTTP requests. > Note: `xh`, written in rust, serves as an effective drop-in replacement for `http`. > See also: `http`, `curl`. -> More information: . +> More information: . - Send a GET request (shows response headers and content): diff --git a/tldr/ya b/tldr/ya index 55bfba14..9167e3f9 100644 --- a/tldr/ya +++ b/tldr/ya @@ -5,29 +5,37 @@ source: https://github.com/tldr-pages/tldr.git --- # ya -> Manage Yazi packages and plugins. -> More information: . +> Manage Yazi plugins and flavors, publish or subscribe to DDS messages. +> More information: . - Add a package: -`ya pack {{[-a|--all]}} {{package}}` +`ya pkg add {{package}}` + +- Delete a package: + +`ya pkg delete {{package}}` - Upgrade all packages: -`ya pack {{[-u|--upgrade]}}` +`ya pkg upgrade` -- Subscribe to messages from all remote instances: +- List all packages: -`ya sub {{kinds}}` +`ya pkg list` + +- Emit a command to be executed by the current instance: + +`ya emit {{command}} {{arguments}}` + +- Emit commands to a specific remote instance: + +`ya emit-to {{receiver}} {{command}} {{arguments}}` - Publish a message to the current instance with string body: `ya pub --str {{string_message}}` -- Publish a message to the current instance with JSON body: +- Subscribe to a specific kind of message from a remote instance: -`ya pub --json {{json_message}}` - -- Publish a message to the specified instance with string body: - -`ya pub-to --str {{message}} {{receiver}} {{kind}}` +`ya sub {{message_kind}}` diff --git a/tldr/yadm-transcrypt b/tldr/yadm-transcrypt index 7811515d..86152df8 100755 --- a/tldr/yadm-transcrypt +++ b/tldr/yadm-transcrypt @@ -8,24 +8,24 @@ source: https://github.com/tldr-pages/tldr.git > If `transcrypt` is installed, this command allows you to pass options directly to `transcrypt`. > With the environment configured to use the yadm repository. > Transcrypt enables transparent encryption and decryption of files in a Git repository. -> More information: . +> More information: . - Set the symmetric cipher to utilize for encryption: -`yadm transcrypt --cipher={{cipher}}` +`yadm transcrypt {{[-c|--cipher]}} {{cipher}}` - Pass the password to derive the key from: -`yadm transcrypt --password={{password}}` +`yadm transcrypt {{[-p|--password]}} {{password}}` - Assume yes and accept defaults for non-specified options: -`yadm transcrypt --yes` +`yadm transcrypt {{[-y|--yes]}}` - Display the current repository's cipher and password: -`yadm transcrypt --display` +`yadm transcrypt {{[-d|--display]}}` - Re -encrypt all encrypted files using new credentials: -`yadm transcrypt --rekey` +`yadm transcrypt {{[-r|--rekey]}}` diff --git a/tldr/yapf b/tldr/yapf index 19d1a569..4d553450 100644 --- a/tldr/yapf +++ b/tldr/yapf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # yapf > Python style guide checker. -> More information: . +> More information: . - Display a diff of the changes that would be made, without making them (dry-run): diff --git a/tldr/zoxide b/tldr/zoxide index bb2d277c..e3d08840 100644 --- a/tldr/zoxide +++ b/tldr/zoxide @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Keep track of the most frequently used directories. > Uses a ranking algorithm to navigate to the best match. -> More information: . +> More information: . - Go to the highest-ranked directory that contains `string` in the name: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Start an interactive directory search (requires `fzf`): -`zoxide query --interactive` +`zoxide query {{[-i|--interactive]}}` - Add a directory or increment its rank: