mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-08-04 02:35:32 +02:00
*: capitalize the first letter after "Note:" (#16226)
Co-authored-by: Machiavelli <145562237+MachiavelliII@users.noreply.github.com>
This commit is contained in:
parent
53b8ef4712
commit
5305776d45
89 changed files with 95 additions and 95 deletions
|
@ -7,7 +7,7 @@
|
|||
|
||||
`argospm install translate-es_en`
|
||||
|
||||
- Translate some text from Spanish (`es`) to English (`en`) (Note: only two letter language codes are supported):
|
||||
- Translate some text from Spanish (`es`) to English (`en`) (Note: Only two letter language codes are supported):
|
||||
|
||||
`argos-translate --from-lang es --to-lang en {{un texto corto}}`
|
||||
|
||||
|
@ -27,6 +27,6 @@
|
|||
|
||||
`argospm update`
|
||||
|
||||
- Translate from `ar` to `ru` (Note: this requires the translation pairs `translate-ar_en` and `translate-en_ru` to be installed):
|
||||
- Translate from `ar` to `ru` (Note: This requires the translation pairs `translate-ar_en` and `translate-en_ru` to be installed):
|
||||
|
||||
`argos-translate --from-lang ar --to-lang ru {{صورة تساوي أكثر من ألف كلمة}}`
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# bfg
|
||||
|
||||
> Remove large files or passwords from Git history like git-filter-branch.
|
||||
> Note: if your repository is connected to a remote, you will need to force push to it.
|
||||
> Note: If your repository is connected to a remote, you will need to force push to it.
|
||||
> More information: <https://rtyley.github.io/bfg-repo-cleaner/>.
|
||||
|
||||
- Remove a file with sensitive data but leave the latest commit untouched:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# calibre-server
|
||||
|
||||
> A server application to distribute e-books over a network.
|
||||
> Note: e-books must already be imported into the library using the GUI or the `calibredb` CLI.
|
||||
> Note: E-books must already be imported into the library using the GUI or the `calibredb` CLI.
|
||||
> Part of the Calibre e-book library.
|
||||
> More information: <https://manual.calibre-ebook.com/generated/en/calibre-server.html>.
|
||||
|
||||
|
|
|
@ -16,6 +16,6 @@
|
|||
|
||||
`cargo metadata --format-version {{version}}`
|
||||
|
||||
- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: the `packages` array will still include the dependencies for all targets):
|
||||
- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: The `packages` array will still include the dependencies for all targets):
|
||||
|
||||
`cargo metadata --filter-platform {{target_triple}}`
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cargo publish
|
||||
|
||||
> Upload a package to a registry.
|
||||
> Note: you have to add an authentication token using `cargo login` before publishing a package.
|
||||
> Note: You have to add an authentication token using `cargo login` before publishing a package.
|
||||
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-publish.html>.
|
||||
|
||||
- Perform checks, create a `.crate` file and upload it to the registry:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cargo run
|
||||
|
||||
> Run the current Cargo package.
|
||||
> Note: the working directory of the executed binary will be set to the current working directory.
|
||||
> Note: The working directory of the executed binary will be set to the current working directory.
|
||||
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-run.html>.
|
||||
|
||||
- Run the default binary target:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cargo tree
|
||||
|
||||
> Display a tree visualization of a dependency graph.
|
||||
> Note: in the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated.
|
||||
> Note: In the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated.
|
||||
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-tree.html>.
|
||||
|
||||
- Show a dependency tree of the current project:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cargo yank
|
||||
|
||||
> Remove a pushed crate from the index. This should only be used when you accidentally release a significantly broken crate.
|
||||
> Note: this does not remove any data. The crate is still present after a yank - this just prevents new projects from using it.
|
||||
> Note: This does not remove any data. The crate is still present after a yank - this just prevents new projects from using it.
|
||||
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-yank.html>.
|
||||
|
||||
- Yank the specified version of a crate:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# ccache
|
||||
|
||||
> C/C++ compiler cache.
|
||||
> Note: packages usually provide symlinks for compilers in `/usr/lib/ccache/bin`. Prepend this directory to `$PATH` to automatically use `ccache` for them.
|
||||
> Note: Packages usually provide symlinks for compilers in `/usr/lib/ccache/bin`. Prepend this directory to `$PATH` to automatically use `ccache` for them.
|
||||
> More information: <https://ccache.dev/manual/latest.html>.
|
||||
|
||||
- Show current cache statistics:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cksum
|
||||
|
||||
> Calculate CRC checksums and byte counts of a file.
|
||||
> Note: on old UNIX systems the CRC implementation may differ.
|
||||
> Note: On old UNIX systems the CRC implementation may differ.
|
||||
> More information: <https://www.gnu.org/software/coreutils/manual/html_node/cksum-invocation.html>.
|
||||
|
||||
- Display a 32-bit checksum, size in bytes and filename:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# convert
|
||||
|
||||
> This command is an alias of `magick convert`.
|
||||
> Note: this alias is deprecated since ImageMagick 7. It has been replaced by `magick`.
|
||||
> Note: This alias is deprecated since ImageMagick 7. It has been replaced by `magick`.
|
||||
> Use `magick convert` if you need to use the old tool in versions 7+.
|
||||
|
||||
- View documentation for the original command:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cupsaccept
|
||||
|
||||
> Accept jobs sent to destinations.
|
||||
> Note: destination is referred as a printer or a class of printers.
|
||||
> Note: Destination is referred as a printer or a class of printers.
|
||||
> See also: `cupsreject`, `cupsenable`, `cupsdisable`, `lpstat`.
|
||||
> More information: <https://www.cups.org/doc/man-cupsaccept.html>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cupsdisable
|
||||
|
||||
> Stop printers and classes.
|
||||
> Note: destination is referred as a printer or a class of printers.
|
||||
> Note: Destination is referred as a printer or a class of printers.
|
||||
> See also: `cupsenable`, `cupsaccept`, `cupsreject`, `lpstat`.
|
||||
> More information: <https://openprinting.github.io/cups/doc/man-cupsenable.html>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cupsenable
|
||||
|
||||
> Start printers and classes.
|
||||
> Note: destination is referred as a printer or a class of printers.
|
||||
> Note: Destination is referred as a printer or a class of printers.
|
||||
> See also: `cupsdisable`, `cupsaccept`, `cupsreject`, `lpstat`.
|
||||
> More information: <https://www.cups.org/doc/man-cupsenable.html>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cupsreject
|
||||
|
||||
> Reject jobs sent to printers.
|
||||
> Note: destination is referred as a printer or a class of printers.
|
||||
> Note: Destination is referred as a printer or a class of printers.
|
||||
> See also: `cupsaccept`, `cupsenable`, `cupsdisable`, `lpstat`.
|
||||
> More information: <https://www.cups.org/doc/man-cupsaccept.html>.
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
> Test conformance of PPD files to the version 4.3 of the specification.
|
||||
> Error codes (1, 2, 3 and 4, respectively): bad CLI arguments, unable to open file, unskippable format errors and non-conformance with PPD specification.
|
||||
> Note: this command is deprecated.
|
||||
> Note: This command is deprecated.
|
||||
> See also: `lpadmin`.
|
||||
> More information: <https://openprinting.github.io/cups/doc/man-cupstestppd.html>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# d2
|
||||
|
||||
> A modern diagram scripting language that turns text to diagrams.
|
||||
> Note: the output file supports SVG and PNG file formats.
|
||||
> Note: The output file supports SVG and PNG file formats.
|
||||
> More information: <https://d2lang.com/tour/man>.
|
||||
|
||||
- Compile and render a D2 source file into an output file:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# dbx
|
||||
|
||||
> Interact with the Databricks platform.
|
||||
> Note: this tool has been retired and it is recommended to use Databricks Asset Bundles instead.
|
||||
> Note: This tool has been retired and it is recommended to use Databricks Asset Bundles instead.
|
||||
> More information: <https://dbx.readthedocs.io/en/latest/reference/cli/#dbx>.
|
||||
|
||||
- Create a new `dbx` project in the current working directory:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# dnsx
|
||||
|
||||
> A fast and multi-purpose DNS toolkit to run multiple DNS queries.
|
||||
> Note: input to `dnsx` needs to be passed through `stdin` (pipe `|`) in some cases.
|
||||
> Note: Input to `dnsx` needs to be passed through `stdin` (pipe `|`) in some cases.
|
||||
> See also: `dig`, `dog`, `dnstracer`.
|
||||
> More information: <https://docs.projectdiscovery.io/tools/dnsx/running>.
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> Print given arguments.
|
||||
> More information: <https://www.gnu.org/software/coreutils/manual/html_node/echo-invocation.html>.
|
||||
|
||||
- Print a text message. Note: quotes are optional:
|
||||
- Print a text message. Note: Quotes are optional:
|
||||
|
||||
`echo "{{Hello World}}"`
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
|
||||
`echo "{{some_text}}" | FileCheck {{path/to/check_file}}`
|
||||
|
||||
- Match with the specified custom check `prefix` (Note: the default prefix is `CHECK`):
|
||||
- Match with the specified custom check `prefix` (Note: The default prefix is `CHECK`):
|
||||
|
||||
`echo "{{some_text}}" | FileCheck --check-prefix={{prefix}} {{path/to/check_file}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# ghostty
|
||||
|
||||
> A fast, feature-rich, and cross-platform terminal emulator that uses platform-native UI and GPU acceleration.
|
||||
> Note: all options from the configuration file can also be used on the command-line (using `--option=argument`).
|
||||
> Note: All options from the configuration file can also be used on the command-line (using `--option=argument`).
|
||||
> More information: <https://ghostty.org/docs/config/reference>.
|
||||
|
||||
- Open a new Ghostty window (not supported on macOS):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# git for-each-repo
|
||||
|
||||
> Run a Git command on a list of repositories.
|
||||
> Note: this command is experimental and may change.
|
||||
> Note: This command is experimental and may change.
|
||||
> More information: <https://git-scm.com/docs/git-for-each-repo>.
|
||||
|
||||
- Run maintenance on each of a list of repositories stored in the `maintenance.repo` user configuration variable:
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
`golangci-lint run`
|
||||
|
||||
- List enabled and disabled linters (Note: disabled linters are shown last, do not mistake them for enabled ones):
|
||||
- List enabled and disabled linters (Note: Disabled linters are shown last, do not mistake them for enabled ones):
|
||||
|
||||
`golangci-lint linters`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# httpx
|
||||
|
||||
> A fast and multi-purpose HTTP toolkit written in Go to run multiple probes at once.
|
||||
> Note: not to be confused with the unrelated Python's HTTPX which has the same command name.
|
||||
> Note: Not to be confused with the unrelated Python's HTTPX which has the same command name.
|
||||
> More information: <https://docs.projectdiscovery.io/tools/httpx/running>.
|
||||
|
||||
- Run a probe against a [u]RL, host, IP Address or subnet (CIDR notation) showing probe status:
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
> Lexical analyzer generator.
|
||||
> Given the specification for a lexical analyzer, generates C code implementing it.
|
||||
> Note: on most major OSes, this command is an alias for `flex`.
|
||||
> Note: On most major OSes, this command is an alias for `flex`.
|
||||
> More information: <https://manned.org/lex>.
|
||||
|
||||
- Generate an analyzer from a Lex file, storing it to the file `lex.yy.c`:
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
|
||||
`linode-cli volumes detach {{volume_id}}`
|
||||
|
||||
- Resize a Volume (Note: size can only be increased):
|
||||
- Resize a Volume (Note: Size can only be increased):
|
||||
|
||||
`linode-cli volumes resize {{volume_id}} --size {{new_size_in_GB}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# look
|
||||
|
||||
> Display lines beginning with a prefix in a sorted file.
|
||||
> Note: the lines in the file must be sorted.
|
||||
> Note: The lines in the file must be sorted.
|
||||
> See also: `grep`, `sort`.
|
||||
> More information: <https://man.openbsd.org/look>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# magick convert
|
||||
|
||||
> Convert between image formats, scale, join, and create images, and much more.
|
||||
> Note: this tool (previously `convert`) has been replaced by `magick` in ImageMagick 7+.
|
||||
> Note: This tool (previously `convert`) has been replaced by `magick` in ImageMagick 7+.
|
||||
> More information: <https://imagemagick.org/script/convert.php>.
|
||||
|
||||
- Convert an image from JPEG to PNG:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# mongo
|
||||
|
||||
> The legacy MongoDB shell. See `mongosh` for the new shell.
|
||||
> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`.
|
||||
> Note: All connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`.
|
||||
> More information: <https://docs.mongodb.com/manual/reference/program/mongo>.
|
||||
|
||||
- Connect to a local database on the default port (`mongodb://localhost:27017`):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# mongosh
|
||||
|
||||
> A new shell for MongoDB, replacement for `mongo`.
|
||||
> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`.
|
||||
> Note: All connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`.
|
||||
> More information: <https://www.mongodb.com/docs/mongodb-shell>.
|
||||
|
||||
- Connect to a local database on the default port (`mongodb://localhost:27017`):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# moreutils
|
||||
|
||||
> A collection of UNIX tools.
|
||||
> Note: moreutils isn't a command, but a set of commands.
|
||||
> Note: `moreutils` isn't a command, but a set of commands.
|
||||
> More information: <https://joeyh.name/code/moreutils/>.
|
||||
|
||||
- View documentation for pages related to standard streams:
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
|
||||
`msfconsole {{[-n|--no-database]}}`
|
||||
|
||||
- Execute console commands (Note: use `;` for passing multiple commands):
|
||||
- Execute console commands (Note: Use `;` for passing multiple commands):
|
||||
|
||||
`msfconsole {{[-x|--execute-command]}} "{{use auxiliary/server/capture/ftp; set SRVHOST 0.0.0.0; set SRVPORT 21; run}}"`
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> Repair damaged or corrupted PCAP and PcapNG files.
|
||||
> More information: <https://f00l.de/pcapfix/>.
|
||||
|
||||
- Repair a PCAP/PCapNG file (Note: for PCAP files, only the first 262144 bytes of each packet are scanned):
|
||||
- Repair a PCAP/PCapNG file (Note: For PCAP files, only the first 262144 bytes of each packet are scanned):
|
||||
|
||||
`pcapfix {{path/to/file.pcapng}}`
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
`pnmmontage {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}`
|
||||
|
||||
- Specify the quality of the packing (Note: larger values produce smaller packings but take longer to compute.):
|
||||
- Specify the quality of the packing (Note: Larger values produce smaller packings but take longer to compute.):
|
||||
|
||||
`pnmmontage -{{0..9}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# podman login
|
||||
|
||||
> Log in to a container registry.
|
||||
> Note: the default authfile path on Linux is `$XDG_RUNTIME_DIR/containers/auth.json`, which is usually stored in a `tmpfs` (in RAM).
|
||||
> Note: The default authfile path on Linux is `$XDG_RUNTIME_DIR/containers/auth.json`, which is usually stored in a `tmpfs` (in RAM).
|
||||
> More information: <https://docs.podman.io/en/latest/markdown/podman-login.1.html>.
|
||||
|
||||
- Log in to a registry (non-persistent on Linux; persistent on Windows/macOS):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# prosodyctl
|
||||
|
||||
> The control tool for the Prosody XMPP server.
|
||||
> Note: process management through `prosodyctl` is discouraged. Instead, use the tools provided by your system (e.g. `systemctl`).
|
||||
> Note: Process management through `prosodyctl` is discouraged. Instead, use the tools provided by your system (e.g. `systemctl`).
|
||||
> More information: <https://prosody.im/doc/prosodyctl>.
|
||||
|
||||
- Show the status of the Prosody server:
|
||||
|
|
|
@ -23,6 +23,6 @@
|
|||
|
||||
`q "SELECT * FROM {{path/to/file}} f1 JOIN {{path/to/other_file}} f2 ON (f1.c1 = f2.c1)"`
|
||||
|
||||
- Format output using an output delimiter with an output header line (Note: command will output column names based on the input file header or the column aliases overridden in the query):
|
||||
- Format output using an output delimiter with an output header line (Note: Command will output column names based on the input file header or the column aliases overridden in the query):
|
||||
|
||||
`q {{[-D|--output-delimiter]}} {{delimiter}} {{[-O|--output-header]}} "SELECT {{column}} as {{alias}} from {{path/to/file}}"`
|
||||
|
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
`rustc {{[-C|--codegen]}} target-cpu={{native}} {{path/to/main.rs}}`
|
||||
|
||||
- Display the target list (Note: you have to add a target using `rustup` first to be able to compile for it):
|
||||
- Display the target list (Note: You have to add a target using `rustup` first to be able to compile for it):
|
||||
|
||||
`rustc --print target-list`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# rustup run
|
||||
|
||||
> Run a command with an environment configured for a Rust toolchain.
|
||||
> Note: all commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`.
|
||||
> Note: All commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`.
|
||||
> More information: <https://rust-lang.github.io/rustup>.
|
||||
|
||||
- Run a command using a given Rust toolchain (see `rustup help toolchain` for more information):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# speedtest
|
||||
|
||||
> Official command-line interface for testing internet bandwidth using <https://speedtest.net>.
|
||||
> Note: some platforms link `speedtest` to `speedtest-cli` or other tools like `librespeed`, which can also be installed as `speedtest` on certain Linux distributions.
|
||||
> Note: Some platforms link `speedtest` to `speedtest-cli` or other tools like `librespeed`, which can also be installed as `speedtest` on certain Linux distributions.
|
||||
> These command examples apply only to the official client.
|
||||
> More information: <https://www.speedtest.net/apps/cli>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# swayidle
|
||||
|
||||
> Idle management daemon for Wayland.
|
||||
> Note: the configuration options are documented in its man page.
|
||||
> Note: The configuration options are documented in its man page.
|
||||
> More information: <https://github.com/swaywm/swayidle/blob/master/swayidle.1.scd>.
|
||||
|
||||
- Listen for idle activity using the configuration in `$XDG_CONFIG_HOME/swayidle/config` or `$HOME/swayidle/config`:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# tailscale up
|
||||
|
||||
> Connect the client to the Tailscale network.
|
||||
> Note: run `sudo tailscale set --operator $USER` to allow the current user to run these commands.
|
||||
> Note: Run `sudo tailscale set --operator $USER` to allow the current user to run these commands.
|
||||
> All options described here can be changed later using `tailscale set --option argument`. Use `--option=false` to disable options that don't require arguments.
|
||||
> More information: <https://tailscale.com/kb/1080/cli/#up>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# tarsnap
|
||||
|
||||
> Manipulate remote Tarsnap encrypted backups.
|
||||
> Note: you don't need to specify the key file and the cache directory if you configure them in `/usr/local/etc/tarsnap.conf` or `~/.tarsnaprc`.
|
||||
> Note: You don't need to specify the key file and the cache directory if you configure them in `/usr/local/etc/tarsnap.conf` or `~/.tarsnaprc`.
|
||||
> See also: `tarsnap-keygen`.
|
||||
> More information: <https://www.tarsnap.com/man-tarsnap.1.html>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# texcount
|
||||
|
||||
> Count words in TeX documents omitting macros.
|
||||
> Note: if the TeX document uses `\include` or `\input` and you want to count the included files, `texcount` must be run in the directory of the root TeX file.
|
||||
> Note: If the TeX document uses `\include` or `\input` and you want to count the included files, `texcount` must be run in the directory of the root TeX file.
|
||||
> More information: <https://app.uio.no/ifi/texcount/howto.html>.
|
||||
|
||||
- Count words in a TeX file:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# tldr
|
||||
|
||||
> Display simple help pages for command-line tools from the tldr-pages project.
|
||||
> Note: the `--language` and `--list` options are not required by the client specification, but most clients implement them.
|
||||
> Note: The `--language` and `--list` options are not required by the client specification, but most clients implement them.
|
||||
> More information: <https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#command-line-interface>.
|
||||
|
||||
- Print the tldr page for a specific command (hint: this is how you got here!):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# type
|
||||
|
||||
> Display the type of command the shell will execute.
|
||||
> Note: all examples are not POSIX compliant.
|
||||
> Note: All examples are not POSIX compliant.
|
||||
> More information: <https://www.gnu.org/software/bash/manual/bash.html#index-type>.
|
||||
|
||||
- Display the type of a command:
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> Manage extension packs for Oracle VirtualBox.
|
||||
> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-extpack>.
|
||||
|
||||
- Install extension packs to VirtualBox (Note: you need to remove the existing version of the extension pack before installing a new version.):
|
||||
- Install extension packs to VirtualBox (Note: You need to remove the existing version of the extension pack before installing a new version.):
|
||||
|
||||
`VBoxManage extpack install {{path/to/file.vbox-extpack}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# vcpkg
|
||||
|
||||
> Package manager for C/C++ libraries.
|
||||
> Note: packages are not installed in the system. To use them, you need to tell your build system (e.g. CMake) to use `vckg`.
|
||||
> Note: Packages are not installed in the system. To use them, you need to tell your build system (e.g. CMake) to use `vckg`.
|
||||
> More information: <https://learn.microsoft.com/en-us/vcpkg/>.
|
||||
|
||||
- Build and add package `libcurl` to the `vcpkg` environment:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# xxh
|
||||
|
||||
> Bring your shell with all of your customizations through SSH sessions.
|
||||
> Note: xxh does not install anything into system directories on the target machine; removing `~/.xxh` will clear all traces of xxh on the target machine.
|
||||
> Note: `xxh` does not install anything into system directories on the target machine; removing `~/.xxh` will clear all traces of xxh on the target machine.
|
||||
> More information: <https://github.com/xxh/xxh#usage>.
|
||||
|
||||
- Connect to a host and run the current shell:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# ykman config
|
||||
|
||||
> Enable or disable YubiKey applications.
|
||||
> Note: you can use `ykman info` to see currently enabled applications.
|
||||
> Note: You can use `ykman info` to see currently enabled applications.
|
||||
> More information: <https://docs.yubico.com/software/yubikey/tools/ykman/Base_Commands.html#ykman-config-options-command-args>.
|
||||
|
||||
- Enable an application over USB or NFC (`--enable` can be used multiple times to specify more applications):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# ykman openpgp
|
||||
|
||||
> Manage the OpenPGP YubiKey application.
|
||||
> Note: you need to use `gpg --card-edit` for some settings.
|
||||
> Note: You need to use `gpg --card-edit` for some settings.
|
||||
> More information: <https://docs.yubico.com/software/yubikey/tools/ykman/OpenPGP_Commands.html>.
|
||||
|
||||
- Display general information about the OpenPGP application:
|
||||
|
|
|
@ -4,11 +4,11 @@
|
|||
> Updates are performed using OCI images, to ensure that the system is always in a consistent state.
|
||||
> More information: <https://github.com/Vanilla-OS/ABRoot>.
|
||||
|
||||
- Add packages to the local image (Note: after executing this command, you need to apply these changes.):
|
||||
- Add packages to the local image (Note: After executing this command, you need to apply these changes.):
|
||||
|
||||
`sudo abroot pkg add {{package}}`
|
||||
|
||||
- Remove packages from the local image (Note: after executing this command, you need to apply these changes.):
|
||||
- Remove packages from the local image (Note: After executing this command, you need to apply these changes.):
|
||||
|
||||
`sudo abroot pkg remove {{package}}`
|
||||
|
||||
|
@ -16,7 +16,7 @@
|
|||
|
||||
`sudo abroot pkg list`
|
||||
|
||||
- Apply changes in the local image (Note: you need to reboot your system for these changes to be applied):
|
||||
- Apply changes in the local image (Note: You need to reboot your system for these changes to be applied):
|
||||
|
||||
`sudo abroot pkg apply`
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
> Alternative `getty`: Open a `tty` port, prompt for a login name, and invoke the `/bin/login` command.
|
||||
> It is normally invoked by `init`.
|
||||
> Note: the baud rate is the speed of data transfer between a terminal and a device over a serial connection.
|
||||
> Note: The baud rate is the speed of data transfer between a terminal and a device over a serial connection.
|
||||
> More information: <https://manned.org/agetty>.
|
||||
|
||||
- Connect `stdin` to a port (relative to `/dev`) and optionally specify a baud rate (defaults to 9600):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# apx pkgmanagers
|
||||
|
||||
> Manage package managers in `apx`.
|
||||
> Note: user-created package manager configurations are stored in `~/.local/share/apx/pkgmanagers`.
|
||||
> Note: User-created package manager configurations are stored in `~/.local/share/apx/pkgmanagers`.
|
||||
> More information: <https://github.com/Vanilla-OS/apx>.
|
||||
|
||||
- Interactively create a new package manager configuration:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# apx stacks
|
||||
|
||||
> Manage stacks in `apx`.
|
||||
> Note: user-created stack configurations are stored in `~/.local/share/apx/stacks`.
|
||||
> Note: User-created stack configurations are stored in `~/.local/share/apx/stacks`.
|
||||
> More information: <https://github.com/Vanilla-OS/apx>.
|
||||
|
||||
- Interactively create a new stack configuration:
|
||||
|
@ -24,6 +24,6 @@
|
|||
|
||||
`apx stacks import --input {{path/to/stack.yml}}`
|
||||
|
||||
- Export the stack configuration (Note: the output flag is optional, it is exported to the current working directory by default):
|
||||
- Export the stack configuration (Note: The output flag is optional, it is exported to the current working directory by default):
|
||||
|
||||
`apx stacks export --name {{string}} --output {{path/to/output_file}}`
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cryptsetup luksFormat
|
||||
|
||||
> Initialize a LUKS partition and the initial key slot (0) with a passphrase or keyfile.
|
||||
> Note: this operation overwrites all data on the partition.
|
||||
> Note: This operation overwrites all data on the partition.
|
||||
> More information: <https://manned.org/cryptsetup-luksFormat>.
|
||||
|
||||
- Initialize a LUKS volume with a passphrase:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# cryptsetup open
|
||||
|
||||
> Create a decrypted mapping of an encrypted volume.
|
||||
> Note: with TRIM enabled, minimal data leakage in form of freed block information, perhaps sufficient to determine the filesystem in use may occur.
|
||||
> Note: With TRIM enabled, minimal data leakage in form of freed block information, perhaps sufficient to determine the filesystem in use may occur.
|
||||
> However, you still most likely want to enable it, because the data inside is still safe and SSDs without TRIM will wear out faster.
|
||||
> More information: <https://manned.org/cryptsetup-open>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# diffimg
|
||||
|
||||
> Calculate intersection between two images.
|
||||
> Note: the supported extensions are `.png`, `.gif`, `.jpg`, `.ps`.
|
||||
> Note: The supported extensions are `.png`, `.gif`, `.jpg`, `.ps`.
|
||||
> More information: <https://manned.org/diffimg>.
|
||||
|
||||
- Calculate the intersection between images and output an image where each pixel is the difference between corresponding pixels in input images:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# dnf5 group
|
||||
|
||||
> This command is an alias of `dnf group`.
|
||||
> Note: from Fedora 37 to 40 (inclusive), `dnf` runs DNF v4 while `dnf5` runs DNF v5.
|
||||
> Note: From Fedora 37 to 40 (inclusive), `dnf` runs DNF v4 while `dnf5` runs DNF v5.
|
||||
|
||||
- View documentation for the original command:
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@
|
|||
|
||||
`dnf5 info {{package}}`
|
||||
|
||||
- Install new packages (Note: use `-y` to confirm all prompts automatically):
|
||||
- Install new packages (Note: Use `-y` to confirm all prompts automatically):
|
||||
|
||||
`sudo dnf5 install {{package1 package2 ...}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# rename
|
||||
|
||||
> Rename multiple files.
|
||||
> Note: this page refers to the command from the `rename` Debian package.
|
||||
> Note: This page refers to the command from the `rename` Debian package.
|
||||
> More information: <https://manned.org/file-rename>.
|
||||
|
||||
- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found):
|
||||
|
|
|
@ -23,6 +23,6 @@
|
|||
|
||||
`fpsync -v -n 4 -f 1000 -s $((100 * 1024 * 1024)) {{/path/to/source/}} {{/path/to/destination/}}`
|
||||
|
||||
- Recursively synchronize any directories but exclude specific `.snapshot*` files (Note: options and values must be separated by a pipe character):
|
||||
- Recursively synchronize any directories but exclude specific `.snapshot*` files (Note: Options and values must be separated by a pipe character):
|
||||
|
||||
`fpsync -v -O "-x|.snapshot*" {{/path/to/source/}} {{/path/to/destination/}}`
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# lbu
|
||||
|
||||
> Manage `apk` overlay files on a diskless Alpine Linux system.
|
||||
> Note: subcommands like `include` write to `/etc`, which is stored in RAM. You need to run `lbu commit` to save the changes.
|
||||
> Note: Subcommands like `include` write to `/etc`, which is stored in RAM. You need to run `lbu commit` to save the changes.
|
||||
> More information: <https://wiki.alpinelinux.org/wiki/Alpine_local_backup>.
|
||||
|
||||
- Commit changes to persistent storage (only files in `/etc` by default):
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> Find filenames quickly.
|
||||
> More information: <https://manned.org/locate>.
|
||||
|
||||
- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily):
|
||||
- Look for pattern in the database. Note: The database is recomputed periodically (usually weekly or daily):
|
||||
|
||||
`locate {{pattern}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# look
|
||||
|
||||
> Display lines beginning with a prefix in a file.
|
||||
> Note: the lines in the file must be sorted.
|
||||
> Note: The lines in the file must be sorted.
|
||||
> See also: `grep`, `sort`.
|
||||
> More information: <https://manned.org/look>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# mount.cifs
|
||||
|
||||
> Mount SMB (Server Message Block) or CIFS (Common Internet File System) shares.
|
||||
> Note: you can also do the same thing by passing the `-t cifs` option to `mount`.
|
||||
> Note: You can also do the same thing by passing the `-t cifs` option to `mount`.
|
||||
> More information: <https://manned.org/mount.cifs>.
|
||||
|
||||
- Connect using the specified username or `$USER` by default (you will be prompted for a password):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# mount.smb3
|
||||
|
||||
> This command is an alias of `mount.cifs`.
|
||||
> Note: for SMB versions before 3 you have to use `mount.cifs` instead.
|
||||
> Note: For SMB versions before 3 you have to use `mount.cifs` instead.
|
||||
|
||||
- View documentation for the original command:
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# rename
|
||||
|
||||
> Rename multiple files.
|
||||
> Note: this page refers to the command from the `perl-rename` Arch Linux package.
|
||||
> Note: This page refers to the command from the `perl-rename` Arch Linux package.
|
||||
> More information: <https://manned.org/rename>.
|
||||
|
||||
- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# rename
|
||||
|
||||
> Rename multiple files.
|
||||
> Note: this page refers to the command from the `prename` Fedora package.
|
||||
> Note: This page refers to the command from the `prename` Fedora package.
|
||||
> More information: <https://manned.org/prename>.
|
||||
|
||||
- Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# quickget
|
||||
|
||||
> Download and prepare materials for building a Quickemu virtual machine.
|
||||
> Note: the parameter "edition" is always optional.
|
||||
> Note: The parameter "edition" is always optional.
|
||||
> See also: `quickemu`.
|
||||
> More information: <https://github.com/quickemu-project/quickemu>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# rename
|
||||
|
||||
> Rename multiple files.
|
||||
> Note: this page refers to the command from the `util-linux` package.
|
||||
> Note: This page refers to the command from the `util-linux` package.
|
||||
> For the Perl version, see `file-rename` or `perl-rename`.
|
||||
> Warning: This command has no safeguards and will overwrite files without prompting.
|
||||
> More information: <https://manned.org/rename>.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# sbctl
|
||||
|
||||
> A user-friendly secure boot key manager.
|
||||
> Note: not enrolling Microsoft's certificates can brick your system. See <https://github.com/Foxboron/sbctl/wiki/FAQ#option-rom>.
|
||||
> Note: Not enrolling Microsoft's certificates can brick your system. See <https://github.com/Foxboron/sbctl/wiki/FAQ#option-rom>.
|
||||
> More information: <https://github.com/Foxboron/sbctl#usage>.
|
||||
|
||||
- Show the current secure boot status:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# switch_root
|
||||
|
||||
> Use a different filesystem as the root of the mount tree.
|
||||
> Note: switch_root will fail to function if the new root is not the root of a mount. Use bind-mounting as a workaround.
|
||||
> Note: `switch_root` will fail to function if the new root is not the root of a mount. Use bind-mounting as a workaround.
|
||||
> See also: `chroot`, `mount`.
|
||||
> More information: <https://manned.org/switch_root.8>.
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
`systemd-delta --type {{masked|equivalent|redirected|overridden|extended|unchanged}}`
|
||||
|
||||
- Show only files whose path starts with the specified prefix (Note: a prefix is a directory containing subdirectories with systemd configuration files):
|
||||
- Show only files whose path starts with the specified prefix (Note: A prefix is a directory containing subdirectories with systemd configuration files):
|
||||
|
||||
`systemd-delta {{/etc|/run|/usr/lib|...}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# systemd-resolve
|
||||
|
||||
> Resolve domain names, IPV4 and IPv6 addresses, DNS resource records, and services.
|
||||
> Note: this tool has been renamed to `resolvectl` in new versions of `systemd`.
|
||||
> Note: This tool has been renamed to `resolvectl` in new versions of `systemd`.
|
||||
> More information: <https://manned.org/systemd-resolve>.
|
||||
|
||||
- View documentation for `resolvectl`:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# tzselect
|
||||
|
||||
> Interactively select timezone.
|
||||
> Note: this program doesn't actually set the timezone.
|
||||
> Note: This program doesn't actually set the timezone.
|
||||
> More information: <https://manned.org/tzselect>.
|
||||
|
||||
- Open the interactive menu for timezone selection and print the selected timezone to `stdout`:
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
`sudo urpme {{package}}`
|
||||
|
||||
- Uninstall orphan packages (Note: use it with caution as it might unintentionally remove important packages):
|
||||
- Uninstall orphan packages (Note: Use it with caution as it might unintentionally remove important packages):
|
||||
|
||||
`sudo urpme --auto-orphans`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# wpctl
|
||||
|
||||
> Manage WirePlumber, a session and policy manager for PipeWire.
|
||||
> Note: you can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink.
|
||||
> Note: You can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink.
|
||||
> More information: <https://pipewire.pages.freedesktop.org/wireplumber/>.
|
||||
|
||||
- List all objects managed by WirePlumber:
|
||||
|
|
|
@ -3,6 +3,6 @@
|
|||
> Add a `.gz` extension to files compressed using `gzip`.
|
||||
> More information: <https://manned.org/zforce>.
|
||||
|
||||
- Add a `.gz` extension to the supplied Gzip files (Note: other files are ignored):
|
||||
- Add a `.gz` extension to the supplied Gzip files (Note: Other files are ignored):
|
||||
|
||||
`zforce {{path/to/file1 path/to/file2 ...}}`
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# sockstat
|
||||
|
||||
> List open Internet or UNIX domain sockets.
|
||||
> Note: this program is a rewrite for NetBSD 3.0 from FreeBSD's `sockstat`.
|
||||
> Note: This program is a rewrite for NetBSD 3.0 from FreeBSD's `sockstat`.
|
||||
> See also: `netstat`.
|
||||
> More information: <https://man.netbsd.org/sockstat.1>.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# chpass
|
||||
|
||||
> Add or change user database information, including login shell and password.
|
||||
> Note: it's not possible to change the user's password on Open Directory systems, use `passwd` instead.
|
||||
> Note: It's not possible to change the user's password on Open Directory systems, use `passwd` instead.
|
||||
> See also: `passwd`.
|
||||
> More information: <https://man.freebsd.org/cgi/man.cgi?chpass>.
|
||||
|
||||
|
|
|
@ -20,11 +20,11 @@
|
|||
|
||||
`launchctl list`
|
||||
|
||||
- Unload a currently loaded agent, e.g. to make changes (Note: the plist file is automatically loaded into `launchd` after a reboot and/or logging in):
|
||||
- Unload a currently loaded agent, e.g. to make changes (Note: The plist file is automatically loaded into `launchd` after a reboot and/or logging in):
|
||||
|
||||
`launchctl unload ~/Library/LaunchAgents/{{my_script}}.plist`
|
||||
|
||||
- Manually run a known (loaded) agent/daemon, even if it is not the right time (Note: this command uses the agent's label, rather than the filename):
|
||||
- Manually run a known (loaded) agent/daemon, even if it is not the right time (Note: This command uses the agent's label, rather than the filename):
|
||||
|
||||
`launchctl start {{script_file}}`
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> Find filenames quickly.
|
||||
> More information: <https://keith.github.io/xcode-man-pages/locate.1.html>.
|
||||
|
||||
- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily):
|
||||
- Look for pattern in the database. Note: The database is recomputed periodically (usually weekly or daily):
|
||||
|
||||
`locate "{{pattern}}"`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# shortcuts
|
||||
|
||||
> Manage shortcuts.
|
||||
> Note: you can also use the `Shortcuts` app.
|
||||
> Note: You can also use the `Shortcuts` app.
|
||||
> More information: <https://support.apple.com/guide/shortcuts-mac/run-shortcuts-from-the-command-line-apd455c82f02/mac>.
|
||||
|
||||
- Run the specified shortcut (`Count holidays`):
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# uname
|
||||
|
||||
> Print details about the current machine and the operating system running on it.
|
||||
> Note: for additional information about the operating system, try the `sw_vers` command.
|
||||
> Note: For additional information about the operating system, try the `sw_vers` command.
|
||||
> More information: <https://keith.github.io/xcode-man-pages/uname.1.html>.
|
||||
|
||||
- Print kernel name:
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
# ospp.vbs
|
||||
|
||||
> Install, activate, and manage volume licensed versions of Microsoft Office products.
|
||||
> Note: this command may override, deactivate, and/or remove your current volume of licensed Office product versions, so please proceed cautiously.
|
||||
> Note: This command may override, deactivate, and/or remove your current volume of licensed Office product versions, so please proceed cautiously.
|
||||
> More information: <https://learn.microsoft.com/deployoffice/vlactivation/tools-to-manage-volume-activation-of-office>.
|
||||
|
||||
- Install a product key (Note: it replaces the existing key):
|
||||
- Install a product key (Note: It replaces the existing key):
|
||||
|
||||
`cscript ospp.vbs /inpkey:{{product_key}}`
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# reg load
|
||||
|
||||
> Load saved subkeys into a different subkey in the registry.
|
||||
> Note: this is intended for troubleshooting and temporary keys.
|
||||
> Note: This is intended for troubleshooting and temporary keys.
|
||||
> More information: <https://learn.microsoft.com/windows-server/administration/windows-commands/reg-load>.
|
||||
|
||||
- Load a backup file into the specified key:
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# wget
|
||||
|
||||
> In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `wget` program (<https://www.gnu.org/software/wget>) is not properly installed.
|
||||
> Note: if version command returns an error, PowerShell may have substituted this command with `Invoke-WebRequest`.
|
||||
> Note: If version command returns an error, PowerShell may have substituted this command with `Invoke-WebRequest`.
|
||||
> More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/invoke-webrequest>.
|
||||
|
||||
- View documentation for the original `wget` command:
|
||||
|
|
Loading…
Add table
Reference in a new issue