From 0df0c010e8743740a9ae713ad1098d2f3114cd20 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Thu, 18 Dec 2025 00:18:39 +0000 Subject: [PATCH] Update cheatsheets --- tldr/adb-shell-pm-list | 2 +- tldr/aireplay-ng | 2 +- tldr/alr | 2 +- tldr/archwiki-rs | 2 +- tldr/atoum | 2 +- tldr/atuin | 2 +- tldr/autossh | 2 +- tldr/biff | 4 ++-- tldr/bird | 2 +- tldr/boxes | 6 ++--- tldr/btm | 2 +- tldr/ci | 30 +++++++++++++++++++++++ tldr/co | 30 +++++++++++++++++++++++ tldr/conan | 2 +- tldr/cpan | 2 +- tldr/cpdf | 2 +- tldr/csv-diff | 2 +- tldr/ctags | 6 ++--- tldr/cupstestppd | 2 +- tldr/dcode | 2 +- tldr/devenv | 2 +- tldr/dhcpig | 14 +++++------ tldr/diffstat | 2 +- tldr/docker | 16 ++++++------- tldr/docker-container | 14 +++++------ tldr/docker-container-commit | 37 ++++++++++++++++++++++++++++ tldr/docker-container-cp | 21 ++++++++++++++++ tldr/docker-container-diff | 11 ++++++--- tldr/docker-container-exec | 33 +++++++++++++++++++++++++ tldr/docker-container-logs | 29 ++++++++++++++++++++++ tldr/docker-container-ls | 41 ++++++++++++++++++++++++++++++++ tldr/docker-container-rename | 11 ++++++--- tldr/docker-container-rm | 19 ++++++++++++--- tldr/docker-container-run | 41 ++++++++++++++++++++++++++++++++ tldr/docker-container-start | 25 +++++++++++++++++++ tldr/docker-container-stats | 29 ++++++++++++++++++++++ tldr/docker-container-top | 11 ++++++--- tldr/docker-container-update | 34 ++++++++++++++++++++++++++ tldr/docker-image | 4 ++-- tldr/docker-image-load | 21 ++++++++++++++++ tldr/docker-image-pull | 29 ++++++++++++++++++++++ tldr/docker-image-rm | 8 +++---- tldr/docker-image-save | 25 +++++++++++++++++++ tldr/docker-image-tag | 21 ++++++++++++++++ tldr/dwebp | 2 +- tldr/ect | 2 +- tldr/electron-packager | 2 +- tldr/exa | 2 +- tldr/eyuvtoppm | 2 +- tldr/eza | 2 +- tldr/fastfetch | 2 +- tldr/fd | 4 ++++ tldr/feh | 2 +- tldr/flask-unsign | 2 +- tldr/ghdl | 2 +- tldr/git-brv | 2 +- tldr/git-submodule | 6 ++--- tldr/gleam | 2 +- tldr/goenv | 2 +- tldr/holehe | 2 +- tldr/hostess | 2 +- tldr/huggingface-cli | 2 +- tldr/ibmcloud-login | 2 +- tldr/ident | 22 +++++++++++++++++ tldr/idevicediagnostics | 2 +- tldr/img2pdf | 4 ++-- tldr/incus | 2 +- tldr/linux/ark-survival-ascended | 16 ++++++------- tldr/linux/ark-survival-evolved | 16 ++++++------- tldr/linux/barotrauma | 2 +- tldr/linux/counter-strike-2 | 6 ++--- tldr/linux/factorio | 8 +++---- tldr/linux/fatrace | 8 +++++-- tldr/linux/natural-selection-2 | 14 +++++------ tldr/linux/palworld | 10 ++++---- tldr/linux/pkgctl-release | 2 +- tldr/linux/project-zomboid | 4 ++-- tldr/linux/sed | 6 ++--- tldr/linux/systemd-analyze | 6 ++--- tldr/linux/terraria | 4 ++-- tldr/linux/valheim | 2 +- tldr/ng-analytics | 33 +++++++++++++++++++++++++ tldr/nix-eval | 33 +++++++++++++++++++++++++ tldr/nix-flake | 13 +++++----- tldr/nix-flake-info | 21 ++++++++++++++++ tldr/nix-flake-init | 17 +++++++++++++ tldr/nix-flake-show | 25 +++++++++++++++++++ tldr/osx/mysides | 2 +- tldr/osx/open | 2 +- tldr/osx/systemsetup | 2 +- tldr/osx/tart | 2 +- tldr/osx/uptime | 2 +- tldr/osx/wc | 2 +- tldr/osx/xcodes | 2 +- tldr/rcs | 30 +++++++++++++++++++++++ tldr/rcsdiff | 30 +++++++++++++++++++++++ tldr/rcsmerge | 26 ++++++++++++++++++++ tldr/rlog | 30 +++++++++++++++++++++++ tldr/sunos/zoneadm | 37 ++++++++++++++++++++++++++++ tldr/whisper | 2 +- tldr/windows/rdpsign | 2 +- 101 files changed, 941 insertions(+), 154 deletions(-) create mode 100644 tldr/ci create mode 100644 tldr/co create mode 100644 tldr/docker-container-commit create mode 100644 tldr/docker-container-cp create mode 100644 tldr/docker-container-exec create mode 100644 tldr/docker-container-logs create mode 100644 tldr/docker-container-ls create mode 100644 tldr/docker-container-run create mode 100644 tldr/docker-container-start create mode 100644 tldr/docker-container-stats create mode 100644 tldr/docker-container-update create mode 100644 tldr/docker-image-load create mode 100644 tldr/docker-image-pull create mode 100644 tldr/docker-image-save create mode 100644 tldr/docker-image-tag create mode 100644 tldr/ident create mode 100644 tldr/ng-analytics create mode 100644 tldr/nix-eval create mode 100644 tldr/nix-flake-info create mode 100644 tldr/nix-flake-init create mode 100644 tldr/nix-flake-show create mode 100644 tldr/rcs create mode 100644 tldr/rcsdiff create mode 100644 tldr/rcsmerge create mode 100644 tldr/rlog create mode 100644 tldr/sunos/zoneadm diff --git a/tldr/adb-shell-pm-list b/tldr/adb-shell-pm-list index 3a8c6fed..e1fcbcd1 100644 --- a/tldr/adb-shell-pm-list +++ b/tldr/adb-shell-pm-list @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # adb shell pm list -> List users, packages, permissions, instrumentation, permission groups, features and libraries managed by the package manager. +> List users, packages, permissions, instrumentation, permission groups, features, and libraries managed by the package manager. > More information: . - List all installed packages: diff --git a/tldr/aireplay-ng b/tldr/aireplay-ng index 32eeb754..c717342e 100644 --- a/tldr/aireplay-ng +++ b/tldr/aireplay-ng @@ -9,6 +9,6 @@ source: https://github.com/tldr-pages/tldr.git > Part of Aircrack-ng network software suite. > More information: . -- Send a specific number of disassociate packets given an access point's MAC address, a client's MAC address and an interface: +- Send a specific number of disassociate packets given an access point's MAC address, a client's MAC address, and an interface: `sudo aireplay-ng --deauth {{count}} --bssid {{ap_mac}} --dmac {{client_mac}} {{interface}}` diff --git a/tldr/alr b/tldr/alr index 3b56dece..95f17e01 100644 --- a/tldr/alr +++ b/tldr/alr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # alr > Ada package manager. -> Manage Ada toolchains, dependencies, tools and libraries. +> Manage Ada toolchains, dependencies, tools, and libraries. > More information: . - Create a binary or library project: diff --git a/tldr/archwiki-rs b/tldr/archwiki-rs index f48c0ffe..3780ffc8 100644 --- a/tldr/archwiki-rs +++ b/tldr/archwiki-rs @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # archwiki-rs -> Read, search and download pages from the ArchWiki. +> Read, search, and download pages from the ArchWiki. > More information: . - Read a page from the ArchWiki: diff --git a/tldr/atoum b/tldr/atoum index 8a20fc7b..6ea1ff6d 100644 --- a/tldr/atoum +++ b/tldr/atoum @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # atoum -> A simple, modern and intuitive unit testing framework for PHP. +> A simple, modern, and intuitive unit testing framework for PHP. > More information: . - Initialize a configuration file: diff --git a/tldr/atuin b/tldr/atuin index 99786e38..8cd8a83f 100644 --- a/tldr/atuin +++ b/tldr/atuin @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `atuin search {{command}}` -- Register an account on the default sync server using the specified username, email and password: +- Register an account on the default sync server using the specified username, email, and password: `atuin register {{[-u|--username]}} {{username}} {{[-e|--email]}} {{email}} {{[-p|--password]}} {{password}}` diff --git a/tldr/autossh b/tldr/autossh index babe1119..95969951 100644 --- a/tldr/autossh +++ b/tldr/autossh @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # autossh -> Run, monitor and restart SSH connections. +> Run, monitor, and restart SSH connections. > Auto-reconnects to keep port forwarding tunnels up. Accepts all SSH flags. > More information: . diff --git a/tldr/biff b/tldr/biff index c7a21e96..73db8313 100644 --- a/tldr/biff +++ b/tldr/biff @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # biff -> A simple utility for doing datetime arithmetic, parsing and formatting. +> A simple utility for doing datetime arithmetic, parsing, and formatting. > More information: . - Print the current time in a format of your choosing: @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `biff time fmt {{[-f|--format]}} '%c' now -1d 'next sat' 'last monday' '9pm last mon'` -- Print the current time in another time zone, and round it the nearest 15 minute increment: +- Print the current time in another time zone and round it the nearest 15 minute increment: `biff time in Asia/Bangkok now | biff time round {{[-i|--increment]}} 15 {{[-s|--smallest]}} minute` diff --git a/tldr/bird b/tldr/bird index dcdd08c3..3b088150 100644 --- a/tldr/bird +++ b/tldr/bird @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bird > BIRD Internet Routing Daemon. -> Routing daemon with support for BGP, OSPF, Babel and others. +> Routing daemon with support for BGP, OSPF, Babel, and others. > More information: . - Start Bird with a specific configuration file: diff --git a/tldr/boxes b/tldr/boxes index 64de72d4..b85cfc23 100644 --- a/tldr/boxes +++ b/tldr/boxes @@ -24,14 +24,14 @@ source: https://github.com/tldr-pages/tldr.git `echo "{{string}}" | boxes {{[-s|--size]}} {{10}}x{{5}}` -- Align the box text [h]orizonally (at [l]eft, [c]enter or [r]ight): +- Align the box text [h]orizonally (at [l]eft, [c]enter, or [r]ight): `echo "{{string}}" | boxes {{[-a|--align]}} h{{l|c|r}}` -- Align the box text [v]ertically (at [t]op, [c]enter or [b]ottom): +- Align the box text [v]ertically (at [t]op, [c]enter, or [b]ottom): `echo "{{string}}" | boxes {{[-a|--align]}} v{{t|c|b}}` -- [j]ustify the box text (at [l]eft, [c]enter or [r]ight): +- [j]ustify the box text (at [l]eft, [c]enter, or [r]ight): `echo "{{string}}" | boxes {{[-a|--align]}} j{{l|c|r}}{{vt}}` diff --git a/tldr/btm b/tldr/btm index e57d3f1c..c1169488 100644 --- a/tldr/btm +++ b/tldr/btm @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # btm -> Display system information about the CPU, memory, disks, network and processes. +> Display system information about the CPU, memory, disks, network, and processes. > An enhanced alternative to `top`. > See also: `btop`, `glances`, `atop`, `htop`, `top`. > More information: . diff --git a/tldr/ci b/tldr/ci new file mode 100644 index 00000000..10021fc9 --- /dev/null +++ b/tldr/ci @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ci + +> Check in RCS revisions (store file changes in the Revision Control System). +> See also: `co`, `rcs`, `rcsdiff`, `rlog`. +> More information: . + +- Check in a file and keep the working file unlocked: + +`ci -u {{path/to/file}}` + +- Check in a file and keep the working file locked: + +`ci -l {{path/to/file}}` + +- Check in a file with a specific log message: + +`ci -m"{{log_message}}" {{path/to/file}}` + +- Check in a file, unlocking it but leaving the working file read-only: + +`ci {{path/to/file}}` + +- Force check-in even if there are no changes: + +`ci -f -u {{path/to/file}}` diff --git a/tldr/co b/tldr/co new file mode 100644 index 00000000..eb1f91a1 --- /dev/null +++ b/tldr/co @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# co + +> Check out RCS revisions (retrieve working files from the Revision Control System). +> See also: `ci`, `rcs`, `rcsdiff`, `rlog`. +> More information: . + +- Check out the latest revision of a file (retrieves a read-only copy): + +`co {{path/to/file}}` + +- Check out a file with a lock for editing: + +`co -l {{path/to/file}}` + +- Check out a specific revision of a file: + +`co -r{{revision}} {{path/to/file}}` + +- Check out a file and overwrite it if it already exists: + +`co -f -l {{path/to/file}}` + +- Print a specific revision to `stdout` without creating a file: + +`co -p -r{{revision}} {{path/to/file}}` diff --git a/tldr/conan b/tldr/conan index c4fff640..8121cfde 100644 --- a/tldr/conan +++ b/tldr/conan @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # conan -> The open source, decentralized and cross-platform package manager to create and share all your native binaries. +> The open source, decentralized, and cross-platform package manager to create and share all your native binaries. > Some subcommands such as `frogarian` have their own usage documentation. > More information: . diff --git a/tldr/cpan b/tldr/cpan index c6743051..4612e106 100644 --- a/tldr/cpan +++ b/tldr/cpan @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # cpan -> Query, download and build perl modules from CPAN sites. +> Query, download, and build perl modules from CPAN sites. > More information: . - Install a module (`-i` is optional): diff --git a/tldr/cpdf b/tldr/cpdf index 57750f85..be577350 100644 --- a/tldr/cpdf +++ b/tldr/cpdf @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Manipulate PDF files. > More information: . -- Select pages 1, 2, 3 and 6 from a source document and write those to a destination document: +- Select pages 1, 2, 3, and 6 from a source document and write those to a destination document: `cpdf {{path/to/source_document.pdf}} {{1-3,6}} -o {{path/to/destination_document.pdf}}` diff --git a/tldr/csv-diff b/tldr/csv-diff index 594373a0..19f9c7c7 100644 --- a/tldr/csv-diff +++ b/tldr/csv-diff @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # csv-diff -> View differences between two CSV, TSV or JSON files. +> View differences between two CSV, TSV, or JSON files. > More information: . - Display a human-readable summary of differences between files using a specific column as a unique identifier: diff --git a/tldr/ctags b/tldr/ctags index 73e2a847..f69eff51 100644 --- a/tldr/ctags +++ b/tldr/ctags @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > Generate an index (or tag) file of language objects found in source files for many popular programming languages. > More information: . -- Generate tags for a single file, and output them to a file named "tags" in the current directory, overwriting the file if it exists: +- Generate tags for a single file and output them to a file named "tags" in the current directory, overwriting the file if it exists: `ctags {{path/to/file}}` -- Generate tags for all files in the current directory, and output them to a specific file, overwriting the file if it exists: +- Generate tags for all files in the current directory and output them to a specific file, overwriting the file if it exists: `ctags -f {{path/to/file}} *` @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `ctags --recurse` -- Generate tags for a single file, and output them with start line number and end line number in JSON format: +- Generate tags for a single file and output them with start line number and end line number in JSON format: `ctags --fields=+ne --output-format=json {{path/to/file}}` diff --git a/tldr/cupstestppd b/tldr/cupstestppd index 16f39491..93a02f0c 100644 --- a/tldr/cupstestppd +++ b/tldr/cupstestppd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cupstestppd > 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. +> 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. > See also: `lpadmin`. > More information: . diff --git a/tldr/dcode b/tldr/dcode index 19aa6860..2ca82204 100644 --- a/tldr/dcode +++ b/tldr/dcode @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dcode > Recursively detect and decode strings, supporting hex, decimal, binary, base64, URL, FromChar encodings, Caesar ciphers, and MD5, SHA1, and SHA2 hashes. -> Warning: uses 3rd-party web services for MD5, SHA1 and SHA2 hash lookups. For sensitive data, use `-s` to avoid these services. +> Warning: uses 3rd-party web services for MD5, SHA1, and SHA2 hash lookups. For sensitive data, use `-s` to avoid these services. > More information: . - Recursively detect and decode a string: diff --git a/tldr/devenv b/tldr/devenv index 6c1ccb0a..fa5fe784 100644 --- a/tldr/devenv +++ b/tldr/devenv @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # devenv -> Fast, Declarative, Reproducible and Composable Developer Environments using Nix. +> Fast, declarative, reproducible, and composable developer environments using Nix. > More information: . - Initialize the environment: diff --git a/tldr/dhcpig b/tldr/dhcpig index ae1608e8..2a1731d6 100644 --- a/tldr/dhcpig +++ b/tldr/dhcpig @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Exhaust all of the available DHCP addresses using the specified interface: -`sudo ./pig.py {{eth0}}` +`sudo {{path/to}}/pig.py {{eth0}}` - Exhaust IPv6 addresses using eth1 interface: -`sudo ./pig.py {{[-6|--ipv6]}} {{eth1}}` +`sudo {{path/to}}/pig.py {{[-6|--ipv6]}} {{eth1}}` - Send fuzzed/malformed data packets using the interface: -`sudo ./pig.py {{[-f|--fuzz]}} {{eth1}}` +`sudo {{path/to}}/pig.py {{[-f|--fuzz]}} {{eth1}}` - Enable color output: -`sudo ./pig.py {{[-c|--color]}} {{eth1}}` +`sudo {{path/to}}/pig.py {{[-c|--color]}} {{eth1}}` - Enable minimal verbosity and color output: -`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 1 {{eth1}}` +`sudo {{path/to}}/pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 1 {{eth1}}` - Use a debug verbosity of 100 and scan network of neighboring devices using ARP packets: -`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 100 {{[-n|--neighbors-scan-arp]}} {{eth1}}` +`sudo {{path/to}}/pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 100 {{[-n|--neighbors-scan-arp]}} {{eth1}}` - Enable printing lease information, attempt to scan and release all neighbor IP addresses: -`sudo ./pig.py {{[-n|--neighbors-scan-arp]}} {{[-r|--neighbors-attack-release]}} {{[-o|--show-options]}} {{eth1}}` +`sudo {{path/to}}/pig.py {{[-n|--neighbors-scan-arp]}} {{[-r|--neighbors-attack-release]}} {{[-o|--show-options]}} {{eth1}}` diff --git a/tldr/diffstat b/tldr/diffstat index 005f5a02..dc651bba 100644 --- a/tldr/diffstat +++ b/tldr/diffstat @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `diff {{path/to/file1}} {{path/to/file2}} | diffstat` -- Display inserted, deleted and modified changes as a table: +- Display inserted, deleted, and modified changes as a table: `diff {{path/to/file1}} {{path/to/file2}} | diffstat -t` diff --git a/tldr/docker b/tldr/docker index 34ead5df..d75827e3 100644 --- a/tldr/docker +++ b/tldr/docker @@ -11,32 +11,32 @@ source: https://github.com/tldr-pages/tldr.git - List all Docker containers (running and stopped): -`docker ps {{[-a|--all]}}` +`docker {{[ps|container ls]}} {{[-a|--all]}}` - Start a container from an image, with a custom name: -`docker run --name {{container_name}} {{image}}` +`docker {{[run|container run]}} --name {{container_name}} {{image}}` - Start or stop an existing container: -`docker {{start|stop}} {{container_name}}` +`docker container {{start|stop}} {{container_name}}` - Pull an image from a Docker registry: -`docker pull {{image}}` +`docker {{[pull|image pull]}} {{image}}` - Display the list of already downloaded images: -`docker images` +`docker {{[images|image ls]}}` - Open an interactive tty with Bourne shell (`sh`) inside a running container: -`docker exec {{[-it|--interactive --tty]}} {{container_name}} {{sh}}` +`docker {{[exec|container exec]}} {{[-it|--interactive --tty]}} {{container_name}} {{sh}}` - Remove stopped containers: -`docker rm {{container1 container2 ...}}` +`docker {{[rm|container rm]}} {{container1 container2 ...}}` - Fetch and follow the logs of a container: -`docker logs {{[-f|--follow]}} {{container_name}}` +`docker {{[logs|container logs]}} {{[-f|--follow]}} {{container_name}}` diff --git a/tldr/docker-container b/tldr/docker-container index 7d9722af..8a8b4cc8 100644 --- a/tldr/docker-container +++ b/tldr/docker-container @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - List currently running Docker containers: -`docker container ls` +`docker {{[ps|container ls]}}` - Start one or more stopped containers: -`docker container start {{container1_name}} {{container2_name}}` +`docker {{[start|container start]}} {{container1_name}} {{container2_name}}` - Kill one or more running containers: -`docker container kill {{container_name}}` +`docker {{[kill|container kill]}} {{container_name}}` - Stop one or more running containers: -`docker container stop {{container_name}}` +`docker {{[stop|container stop]}} {{container_name}}` - Pause all processes within one or more containers: -`docker container pause {{container_name}}` +`docker {{[pause|container pause]}} {{container_name}}` - Display detailed information on one or more containers: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Export a container's filesystem as a tar archive: -`docker container export {{container_name}}` +`docker {{[export|container export]}} {{container_name}}` - Create a new image from a container's changes: -`docker container commit {{container_name}}` +`docker {{[commit|container commit]}} {{container_name}}` diff --git a/tldr/docker-container-commit b/tldr/docker-container-commit new file mode 100644 index 00000000..6806395b --- /dev/null +++ b/tldr/docker-container-commit @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container commit + +> Create a new image from a container's changes. +> More information: . + +- Create an image from a specific container: + +`docker {{[commit|container commit]}} {{container}} {{image}}:{{tag}}` + +- Apply a `CMD` Dockerfile instruction to the created image: + +`docker {{[commit|container commit]}} {{[-c|--change]}} "CMD {{command}}" {{container}} {{image}}:{{tag}}` + +- Apply an `ENV` Dockerfile instruction to the created image: + +`docker {{[commit|container commit]}} {{[-c|--change]}} "ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` + +- Create an image with a specific author in the metadata: + +`docker {{[commit|container commit]}} {{[-a|--author]}} "{{author}}" {{container}} {{image}}:{{tag}}` + +- Create an image with a specific comment in the metadata: + +`docker {{[commit|container commit]}} {{[-m|--message]}} "{{comment}}" {{container}} {{image}}:{{tag}}` + +- Create an image without pausing the container during commit: + +`docker {{[commit|container commit]}} {{[-p|--pause]}} {{false}} {{container}} {{image}}:{{tag}}` + +- Display help: + +`docker {{[commit|container commit]}} --help` diff --git a/tldr/docker-container-cp b/tldr/docker-container-cp new file mode 100644 index 00000000..4adaf921 --- /dev/null +++ b/tldr/docker-container-cp @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container cp + +> Copy files or directories between host and container filesystems. +> More information: . + +- Copy a file or directory from the host to a container: + +`docker {{[cp|container cp]}} {{path/to/file_or_directory_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` + +- Copy a file or directory from a container to the host: + +`docker {{[cp|container cp]}} {{container_name}}:{{path/to/file_or_directory_in_container}} {{path/to/file_or_directory_on_host}}` + +- Copy a file or directory from the host to a container, following symlinks (copies the symlinked files directly, not the symlinks themselves): + +`docker {{[cp|container cp]}} {{[-L|--follow-link]}} {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` diff --git a/tldr/docker-container-diff b/tldr/docker-container-diff index 911346e0..aa2c0478 100644 --- a/tldr/docker-container-diff +++ b/tldr/docker-container-diff @@ -5,8 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # docker container diff -> This command is an alias of `docker diff`. +> Inspect changes to files or directories on a container's filesystem. +> More information: . -- View documentation for the original command: +- Inspect the changes to a container since it was created: -`tldr docker diff` +`docker container diff {{container}}` + +- Display help: + +`docker container diff --help` diff --git a/tldr/docker-container-exec b/tldr/docker-container-exec new file mode 100644 index 00000000..f113b2de --- /dev/null +++ b/tldr/docker-container-exec @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container exec + +> Execute a command on an already running Docker container. +> More information: . + +- Enter an interactive shell session on an already-running container: + +`docker {{[exec|container exec]}} {{[-it|--interactive --tty]}} {{container_name}} {{/bin/bash}}` + +- Run a command in the background (detached) on a running container: + +`docker {{[exec|container exec]}} {{[-d|--detach]}} {{container_name}} {{command}}` + +- Select the working directory for a given command to execute into: + +`docker {{[exec|container exec]}} {{[-it|--interactive --tty]}} {{[-w|--workdir]}} {{path/to/directory}} {{container_name}} {{command}}` + +- Run a command in background on existing container but keep `stdin` open: + +`docker {{[exec|container exec]}} {{[-i|--interactive]}} {{[-d|--detach]}} {{container_name}} {{command}}` + +- Set an environment variable in a running Bash session: + +`docker {{[exec|container exec]}} {{[-it|--interactive --tty]}} {{[-e|--env]}} {{variable_name}}={{value}} {{container_name}} {{/bin/bash}}` + +- Run a command as a specific user: + +`docker {{[exec|container exec]}} {{[-u|--user]}} {{user}} {{container_name}} {{command}}` diff --git a/tldr/docker-container-logs b/tldr/docker-container-logs new file mode 100644 index 00000000..dafdbc38 --- /dev/null +++ b/tldr/docker-container-logs @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container logs + +> Print container logs. +> More information: . + +- Print logs from a container: + +`docker {{[logs|container logs]}} {{container_name}}` + +- Print logs and follow them: + +`docker {{[logs|container logs]}} {{[-f|--follow]}} {{container_name}}` + +- Print last 5 lines: + +`docker {{[logs|container logs]}} {{container_name}} {{[-n|--tail]}} {{5}}` + +- Print logs and append them with timestamps: + +`docker {{[logs|container logs]}} {{[-t|--timestamps]}} {{container_name}}` + +- Print logs from a certain point in time of container execution (i.e. 23m, 10s, 2013-01-02T13:23:37): + +`docker {{[logs|container logs]}} {{container_name}} --until {{time}}` diff --git a/tldr/docker-container-ls b/tldr/docker-container-ls new file mode 100644 index 00000000..d360b4b9 --- /dev/null +++ b/tldr/docker-container-ls @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container ls + +> List Docker containers. +> More information: . + +- List currently running Docker containers: + +`docker {{[ps|container ls]}}` + +- List all Docker containers (running and stopped): + +`docker {{[ps|container ls]}} {{[-a|--all]}}` + +- Show the latest created container (includes all states): + +`docker {{[ps|container ls]}} {{[-l|--latest]}}` + +- Filter containers that contain a substring in their name: + +`docker {{[ps|container ls]}} {{[-f|--filter]}} "name={{name}}"` + +- Filter containers that share a given image as an ancestor: + +`docker {{[ps|container ls]}} {{[-f|--filter]}} "ancestor={{image}}:{{tag}}"` + +- Filter containers by exit status code: + +`docker {{[ps|container ls]}} {{[-a|--all]}} {{[-f|--filter]}} "exited={{code}}"` + +- Filter containers by status (created, running, removing, paused, exited and dead): + +`docker {{[ps|container ls]}} {{[-f|--filter]}} "status={{status}}"` + +- Filter containers that mount a specific volume or have a volume mounted in a specific path: + +`docker ps {{[-f|--filter]}} "volume={{path/to/directory}}" --format "table {{.ID}} {{.Image}} {{.Names}} {{.Mounts}}"` diff --git a/tldr/docker-container-rename b/tldr/docker-container-rename index 785f0d06..b72d788a 100644 --- a/tldr/docker-container-rename +++ b/tldr/docker-container-rename @@ -5,8 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # docker container rename -> This command is an alias of `docker rename`. +> Rename a container. +> More information: . -- View documentation for the original command: +- Rename a container: -`tldr docker rename` +`docker {{[rename|container rename]}} {{container}} {{new_name}}` + +- Display help: + +`docker {{[rename|container rename]}} --help` diff --git a/tldr/docker-container-rm b/tldr/docker-container-rm index d984a80a..1e1a266b 100644 --- a/tldr/docker-container-rm +++ b/tldr/docker-container-rm @@ -5,8 +5,21 @@ source: https://github.com/tldr-pages/tldr.git --- # docker container rm -> This command is an alias of `docker rm`. +> Remove containers. +> More information: . -- View documentation for the original command: +- Remove containers: -`tldr docker rm` +`docker {{[rm|container rm]}} {{container1 container2 ...}}` + +- Force remove a container: + +`docker {{[rm|container rm]}} {{[-f|--force]}} {{container1 container2 ...}}` + +- Remove a container and its volumes: + +`docker {{[rm|container rm]}} {{[-v|--volumes]}} {{container}}` + +- Display help: + +`docker {{[rm|container rm]}} {{[-h|--help]}}` diff --git a/tldr/docker-container-run b/tldr/docker-container-run new file mode 100644 index 00000000..19c5a73f --- /dev/null +++ b/tldr/docker-container-run @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container run + +> Run a command in a new Docker container. +> More information: . + +- Run command in a new container from a tagged image: + +`docker {{[run|container run]}} {{image:tag}} {{command}}` + +- Run command in a new container in background and display its ID: + +`docker {{[run|container run]}} {{[-d|--detach]}} {{image}} {{command}}` + +- Run command in a one-off container in interactive mode and pseudo-TTY: + +`docker {{[run|container run]}} --rm {{[-it|--interactive --tty]}} {{image}} {{command}}` + +- Run command in a new container with passed environment variables: + +`docker {{[run|container run]}} {{[-e|--env]}} '{{variable}}={{value}}' {{[-e|--env]}} {{variable}} {{image}} {{command}}` + +- Run command in a new container with bind mounted volumes: + +`docker {{[run|container run]}} {{[-v|--volume]}} /{{path/to/host_path}}:/{{path/to/container_path}} {{image}} {{command}}` + +- Run command in a new container with published ports: + +`docker {{[run|container run]}} {{[-p|--publish]}} {{host_port}}:{{container_port}} {{image}} {{command}}` + +- Run command in a new container overwriting the entrypoint of the image: + +`docker {{[run|container run]}} --entrypoint {{command}} {{image}}` + +- Run command in a new container connecting it to a network: + +`docker run --network {{network}} {{image}}` diff --git a/tldr/docker-container-start b/tldr/docker-container-start new file mode 100644 index 00000000..2a765749 --- /dev/null +++ b/tldr/docker-container-start @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container start + +> Start stopped containers. +> More information: . + +- Start a Docker container: + +`docker {{[start|container start]}} {{container}}` + +- Start a container, attaching `stdout` and `stderr`, and forwarding signals: + +`docker {{[start|container start]}} {{[-a|--attach]}} {{container}}` + +- Start one or more containers: + +`docker {{[start|container start]}} {{container1 container2 ...}}` + +- Display help: + +`docker {{[start|container start]}} --help` diff --git a/tldr/docker-container-stats b/tldr/docker-container-stats new file mode 100644 index 00000000..7c56e20f --- /dev/null +++ b/tldr/docker-container-stats @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container stats + +> Display a live stream of resource usage statistics for containers. +> More information: . + +- Display a live stream for the statistics of all running containers: + +`docker {{[stats|container statss}}` + +- Display a live stream of statistics for one or more containers: + +`docker {{[stats|container statss}} {{container1 container2 ...}}` + +- Change the columns format to display container's CPU usage percentage: + +`docker {{[stats|container statss}} --format "{{.Name}}: {{.CPUPerc}}"` + +- Display statistics for all containers (both running and stopped): + +`docker {{[stats|container statss}} {{[-a|--all]}}` + +- Disable streaming stats and only pull the current stats: + +`docker {{[stats|container statss}} --no-stream` diff --git a/tldr/docker-container-top b/tldr/docker-container-top index ce5377ce..42a48802 100644 --- a/tldr/docker-container-top +++ b/tldr/docker-container-top @@ -5,8 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # docker container top -> This command is an alias of `docker top`. +> Display the running processes of a container. +> More information: . -- View documentation for the original command: +- Display the running processes of a container: -`tldr docker top` +`docker {{[top|container top]}} {{container}}` + +- Display help: + +`docker {{[top|container top]}} --help` diff --git a/tldr/docker-container-update b/tldr/docker-container-update new file mode 100644 index 00000000..cc532bda --- /dev/null +++ b/tldr/docker-container-update @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker container update + +> Update configuration of Docker containers. +> This command is not supported for Windows containers. +> More information: . + +- Update restart policy to apply when a specific container exits: + +`docker {{[update|container update]}} --restart {{always|no|on-failure|unless-stopped}} {{container_name}}` + +- Update the policy to restart up to three times a specific container when it exits with non-zero exit status: + +`docker {{[update|container update]}} --restart on-failure:3 {{container_name}}` + +- Update the number of CPUs available to a specific container: + +`docker {{[update|container update]}} --cpus {{count}} {{container_name}}` + +- Update the memory limit in [M]egabytes for a specific container: + +`docker {{[update|container update]}} {{[-m|--memory]}} {{limit}}M {{container_name}}` + +- Update the maximum number of process IDs allowed inside a specific container (use `-1` for unlimited): + +`docker {{[update|container update]}} --pids-limit {{count}} {{container_name}}` + +- Update the amount of memory in [M]egabytes a specific container can swap to disk (use `-1` for unlimited): + +`docker {{[update|container update]}} --memory-swap {{limit}}M {{container_name}}` diff --git a/tldr/docker-image b/tldr/docker-image index 3e405950..38c2f506 100644 --- a/tldr/docker-image +++ b/tldr/docker-image @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List local Docker images: -`docker image ls` +`docker {{[images|image ls]}}` - Delete unused local Docker images: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the history of a local Docker image: -`docker image history {{image}}` +`docker {{[history|image history]}} {{image}}` diff --git a/tldr/docker-image-load b/tldr/docker-image-load new file mode 100644 index 00000000..d8b28273 --- /dev/null +++ b/tldr/docker-image-load @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker image load + +> Load Docker images from files or `stdin`. +> More information: . + +- Load a Docker image from `stdin`: + +`docker < {{path/to/image_file.tar}} {{[load|image load]}}` + +- Load a Docker image from a specific file: + +`docker {{[load|image load]}} {{[-i|--input]}} {{path/to/image_file.tar}}` + +- Load a Docker image from a specific file in quiet mode: + +`docker {{[load|image load]}} {{[-q|--quiet]}} {{[-i|--input]}} {{path/to/image_file.tar}}` diff --git a/tldr/docker-image-pull b/tldr/docker-image-pull new file mode 100644 index 00000000..6cfc48b1 --- /dev/null +++ b/tldr/docker-image-pull @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker image pull + +> Download Docker images from a registry. +> More information: . + +- Download a specific Docker image: + +`docker {{[pull|image pull]}} {{image}}:{{tag}}` + +- Download a specific Docker image in quiet mode: + +`docker {{[pull|image pull]}} {{[-q|--quiet]}} {{image}}:{{tag}}` + +- Download all tags of a specific Docker image: + +`docker {{[pull|image pull]}} {{[-a|--all-tags]}} {{image}}` + +- Download a Docker images for a specific platform, e.g. linux/amd64: + +`docker {{[pull|image pull]}} --platform {{linux/amd64}} {{image}}:{{tag}}` + +- Display help: + +`docker {{[pull|image pull]}} {{[-h|--help]}}` diff --git a/tldr/docker-image-rm b/tldr/docker-image-rm index 545e8c71..3209356a 100644 --- a/tldr/docker-image-rm +++ b/tldr/docker-image-rm @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Remove one or more images given their names: -`docker image rm {{image1 image2 ...}}` +`docker {{[rmi|image rm]}} {{image1 image2 ...}}` - Force remove an image: -`docker image rm {{[-f|--force]}} {{image}}` +`docker {{[rmi|image rm]}} {{[-f|--force]}} {{image}}` - Remove an image without deleting untagged parents: -`docker image rm --no-prune {{image}}` +`docker {{[rmi|image rm]}} --no-prune {{image}}` - Display help: -`docker image rm` +`docker {{[rmi|image rm]}}` diff --git a/tldr/docker-image-save b/tldr/docker-image-save new file mode 100644 index 00000000..a2ce26ef --- /dev/null +++ b/tldr/docker-image-save @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker image save + +> Export Docker images to archive. +> More information: . + +- Save an image by redirecting `stdout` to a tar archive: + +`docker {{[save|image save]}} {{image}}:{{tag}} > {{path/to/file.tar}}` + +- Save an image to a tar archive: + +`docker {{[save|image save]}} {{[-o|--output]}} {{path/to/file.tar}} {{image}}:{{tag}}` + +- Save all tags of the image: + +`docker {{[save|image save]}} {{[-o|--output]}} {{path/to/file.tar}} {{image_name}}` + +- Cherry-pick particular tags of an image to save: + +`docker {{[save|image save]}} {{[-o|--output]}} {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` diff --git a/tldr/docker-image-tag b/tldr/docker-image-tag new file mode 100644 index 00000000..47664d59 --- /dev/null +++ b/tldr/docker-image-tag @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# docker image tag + +> Assign tags to existing Docker images. +> More information: . + +- Assign a name and tag to a specific image ID: + +`docker {{[tag|image tag]}} {{id}} {{name}}:{{tag}}` + +- Assign a tag to a specific image: + +`docker {{[tag|image tag]}} {{image}}:{{current_tag}} {{image}}:{{new_tag}}` + +- Display help: + +`docker {{[tag|image tag]}}` diff --git a/tldr/dwebp b/tldr/dwebp index 6980c1c7..5435364c 100644 --- a/tldr/dwebp +++ b/tldr/dwebp @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # dwebp -> `dwebp` decompresses WebP files into PNG, PAM, PPM or PGM images. +> `dwebp` decompresses WebP files into PNG, PAM, PPM, or PGM images. > Animated WebP files are not supported. > More information: . diff --git a/tldr/ect b/tldr/ect index 7d833ab0..cfbefe85 100644 --- a/tldr/ect +++ b/tldr/ect @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ect > Efficient Compression Tool. -> File optimizer written in C++. It supports PNG, JPEG, gzip and Zip files. +> File optimizer written in C++. It supports PNG, JPEG, gzip, and Zip files. > More information: . - Compress a file: diff --git a/tldr/electron-packager b/tldr/electron-packager index 7a7f004f..5322bf5e 100644 --- a/tldr/electron-packager +++ b/tldr/electron-packager @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # electron-packager -> Build Electron app executables for Windows, Linux and macOS. +> Build Electron app executables for Windows, Linux, and macOS. > Requires a valid package.json in the application directory. > More information: . diff --git a/tldr/exa b/tldr/exa index 75006e5d..3a7c7c83 100644 --- a/tldr/exa +++ b/tldr/exa @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `exa {{[-a|--all]}}` -- Long format list (permissions, ownership, size and modification date) of all files: +- Long format list (permissions, ownership, size, and modification date) of all files: `exa {{[-l|--long]}} {{[-a|--all]}}` diff --git a/tldr/eyuvtoppm b/tldr/eyuvtoppm index 511d9fce..547867d5 100644 --- a/tldr/eyuvtoppm +++ b/tldr/eyuvtoppm @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Convert a Berkeley YUV file to PPM. > More information: . -- Read a Berkeley YUV file from the specified input file, convert it to a PPM image and store it in the specified output file: +- Read a Berkeley YUV file from the specified input file, convert it to a PPM image, and store it in the specified output file: `eyuvtoppm --width {{width}} --height {{height}} {{path/to/input_file.eyuv}} > {{path/to/output_file.ppm}}` diff --git a/tldr/eza b/tldr/eza index 5254e97b..cefa2e65 100644 --- a/tldr/eza +++ b/tldr/eza @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `eza {{[-a|--all]}}` -- Long format list (permissions, ownership, size and modification date) of all files: +- Long format list (permissions, ownership, size, and modification date) of all files: `eza {{[-al|--all --long]}}` diff --git a/tldr/fastfetch b/tldr/fastfetch index d40db4c9..b2875c1f 100644 --- a/tldr/fastfetch +++ b/tldr/fastfetch @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # fastfetch -> Display information about your operating system, software and hardware. +> Display information about your operating system, software, and hardware. > More information: . - Display system information: diff --git a/tldr/fd b/tldr/fd index c9a049ff..01a7c021 100644 --- a/tldr/fd +++ b/tldr/fd @@ -36,3 +36,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a command on each search result returned: `fd "{{string|regex}}" {{[-x|--exec]}} {{command}}` + +- Find files only in the current directory: + +`fd {{[-d|--max-depth]}} 1 "{{string|regex}}"` diff --git a/tldr/feh b/tldr/feh index 041e1d5b..0f1f9690 100644 --- a/tldr/feh +++ b/tldr/feh @@ -32,7 +32,7 @@ source: https://github.com/tldr-pages/tldr.git `feh {{[-D|--slideshow-delay]}} {{seconds}} {{path/to/images}}` -- Use a specific wallpaper mode (centered, filled, maximized, scaled or tiled): +- Use a specific wallpaper mode (centered, filled, maximized, scaled, or tiled): `feh --bg-{{center|fill|max|scale|tile}} {{path/to/image}}` diff --git a/tldr/flask-unsign b/tldr/flask-unsign index 60966339..798d1345 100644 --- a/tldr/flask-unsign +++ b/tldr/flask-unsign @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # flask-unsign -> A tool to brute-force, decode and craft `Flask` session cookies. +> A tool to brute-force, decode, and craft `Flask` session cookies. > More information: . - Decode a Flask session cookie: diff --git a/tldr/ghdl b/tldr/ghdl index c6132ce9..2e5c126b 100644 --- a/tldr/ghdl +++ b/tldr/ghdl @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `ghdl -a {{filename.vhdl}}` -- Elaborate a design (where `design` is the name of a configuration unit, entity unit or architecture unit): +- Elaborate a design (where `design` is the name of a configuration unit, entity unit, or architecture unit): `ghdl -e {{design}}` diff --git a/tldr/git-brv b/tldr/git-brv index ad621a83..4f0c8062 100644 --- a/tldr/git-brv +++ b/tldr/git-brv @@ -9,6 +9,6 @@ source: https://github.com/tldr-pages/tldr.git > Part of `git-extras`. > More information: . -- List each branch showing date, latest commit hash and message: +- List each branch showing date, latest commit hash, and message: `git brv` diff --git a/tldr/git-submodule b/tldr/git-submodule index 3777a3d8..faad64de 100644 --- a/tldr/git-submodule +++ b/tldr/git-submodule @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - View existing submodules, and the checked-out commit for each one: -`git submodule status` +`git submodule` - Install a repository's submodules (listed in `.gitmodules`): @@ -24,9 +24,9 @@ source: https://github.com/tldr-pages/tldr.git `git submodule add {{repository_url}} {{path/to/directory}}` -- Update every submodule to its latest commit: +- Update submodules to their latest commits: -`git submodule update --init --recursive --remote` +`git submodule update --remote` - Change the URL of a submodule: diff --git a/tldr/gleam b/tldr/gleam index 7f5698b5..41f3d3b4 100644 --- a/tldr/gleam +++ b/tldr/gleam @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # gleam -> The compiler, build tool, package manager and code formatter for Gleam, "a friendly language for building type-safe systems that scale!". +> The compiler, build tool, package manager, and code formatter for Gleam, "a friendly language for building type-safe systems that scale!". > More information: . - Create a new gleam project: diff --git a/tldr/goenv b/tldr/goenv index 38fa9b87..e4f29d80 100644 --- a/tldr/goenv +++ b/tldr/goenv @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # goenv -> Install, uninstall or switch between Golang versions. +> Install, uninstall, or switch between Golang versions. > Supports version numbers like "1.16.15" or "1.22.8" etc. > More information: . diff --git a/tldr/holehe b/tldr/holehe index 3b5aceb1..60ef5deb 100644 --- a/tldr/holehe +++ b/tldr/holehe @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # holehe -> Check if an email is attached to an account on sites like Twitter, Instagram, Imgur and over 120 others. +> Check if an email is attached to an account on sites like Twitter, Instagram, Imgur, and over 120 others. > More information: . - Show status across all supported websites for the specified email address: diff --git a/tldr/hostess b/tldr/hostess index 224870a4..00645b97 100644 --- a/tldr/hostess +++ b/tldr/hostess @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage the `/etc/hosts` file. > More information: . -- List domains, target IP addresses and on/off status: +- List domains, target IP addresses, and on/off status: `hostess list` diff --git a/tldr/huggingface-cli b/tldr/huggingface-cli index 54f87744..fcbd3a5c 100644 --- a/tldr/huggingface-cli +++ b/tldr/huggingface-cli @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # huggingface-cli > Interact with Hugging Face Hub. -> Login, manage local cache, download or upload files. +> Login, manage local cache, download, or upload files. > More information: . - Login to Hugging Face Hub: diff --git a/tldr/ibmcloud-login b/tldr/ibmcloud-login index a0079590..1e49aa48 100644 --- a/tldr/ibmcloud-login +++ b/tldr/ibmcloud-login @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `ibmcloud login -a {{api_endpoint}}` -- Log in by providing username, password and the targeted region as parameters: +- Log in by providing username, password, and the targeted region as parameters: `ibmcloud login -u {{username}} -p {{password}} -r {{us-south}}` diff --git a/tldr/ident b/tldr/ident new file mode 100644 index 00000000..882c170f --- /dev/null +++ b/tldr/ident @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ident + +> Identify RCS keyword strings in files. +> See also: `ci`, `co`, `rcs`, `rcsdiff`, `rlog`. +> More information: . + +- Display RCS identification strings in a file: + +`ident {{path/to/file}}` + +- Display RCS identification strings, suppressing warnings if no patterns are found: + +`ident -q {{path/to/file1 path/to/file2 ...}}` + +- Display RCS identification strings from `stdin`: + +`cat {{path/to/file}} | ident` diff --git a/tldr/idevicediagnostics b/tldr/idevicediagnostics index 1d6e6951..db822205 100644 --- a/tldr/idevicediagnostics +++ b/tldr/idevicediagnostics @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `idevicediagnostics mobilegestalt {{key1}} {{key2}}` -- Shutdown, restart or sleep the device: +- Shutdown, restart, or sleep the device: `idevicediagnostics {{shutdown|restart|sleep}}` diff --git a/tldr/img2pdf b/tldr/img2pdf index 74c2f8e3..6f078c02 100644 --- a/tldr/img2pdf +++ b/tldr/img2pdf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # img2pdf > Losslessly convert raster images to a PDF file. -> Some supported image formats are: GIF, JPEG, JPEG2000, PNG, GIF and TIFF. +> Some supported image formats are: GIF, JPEG, JPEG2000, PNG, GIF, and TIFF. > More information: . - Convert one or more images to a single PDF, each image being on its own page: @@ -25,6 +25,6 @@ source: https://github.com/tldr-pages/tldr.git `img2pdf {{path/to/image.ext}} --pagesize {{30cm}}x{{20cm}} --imgsize {{10cm}}x{{15cm}} --fit {{shrink}} --output {{path/to/file.pdf}}` -- Convert an image to PDF, and specify metadata for the resulting file: +- Convert an image to PDF and specify metadata for the resulting file: `img2pdf {{path/to/image.ext}} --title {{title}} --author {{author}} --creationdate {{1970-01-31}} --keywords {{keyword1 keyword2}} --subject {{subject}} --output {{path/to/file.pdf}}` diff --git a/tldr/incus b/tldr/incus index cbce577d..2be0a97a 100644 --- a/tldr/incus +++ b/tldr/incus @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # incus -> Modern, secure and powerful system container and virtual machine manager. +> Modern, secure, and powerful system container and virtual machine manager. > More information: . - List all containers and virtual machines (both running and stopped): diff --git a/tldr/linux/ark-survival-ascended b/tldr/linux/ark-survival-ascended index 131a8c66..907bcaa1 100644 --- a/tldr/linux/ark-survival-ascended +++ b/tldr/linux/ark-survival-ascended @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Start the server with a specific map: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}}` - Start the server with a specific session name, server password, and admin password: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}}?SessionName={{session_name}}?ServerPassword={{server_password}}?ServerAdminPassword={{admin_password}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}}?SessionName={{session_name}}?ServerPassword={{server_password}}?ServerAdminPassword={{admin_password}}` - Start the server with a specific port and set a maximum player count: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -port={{7777}} -WinLiveMaxPlayers={{1..70}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}} -port={{7777}} -WinLiveMaxPlayers={{1..70}}` - Enable PvE and disabling PvP: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}}?ServerPVE=true` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}}?ServerPVE=true` - Set a multiplier to scale the server difficulty, affecting the maximum level of wild creatures: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}}?DifficultyOffset={{1.0}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}}?DifficultyOffset={{1.0}}` - Disable creature animation optimization to prevent collision issues: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -AlwaysTickDedicatedSkeletalMeshes` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}} -AlwaysTickDedicatedSkeletalMeshes` - Enable specific mods by their ID (comma-separated): -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -mods={{mod_id1,mod_id2,...}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}} -mods={{mod_id1,mod_id2,...}}` - Allow connections from specific platforms: -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -ServerPlatform={{PC+XSX+PS5}}` +`{{path/to}}/ArkAscendedServer {{TheIsland_WP}} -ServerPlatform={{PC+XSX+PS5}}` diff --git a/tldr/linux/ark-survival-evolved b/tldr/linux/ark-survival-evolved index 788500c1..723825cb 100644 --- a/tldr/linux/ark-survival-evolved +++ b/tldr/linux/ark-survival-evolved @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Start the server with a specific map: -`{{path/to/ShooterGameServer}} {{TheIsland}}` +`{{path/to}}/ShooterGameServer {{TheIsland}}` - Start the server with a specific session name, server password, and admin password: -`{{path/to/ShooterGameServer}} {{TheIsland}}?SessionName={{session_name}}?ServerPassword={{server_password}}?ServerAdminPassword={{admin_password}}` +`{{path/to}}/ShooterGameServer {{TheIsland}}?SessionName={{session_name}}?ServerPassword={{server_password}}?ServerAdminPassword={{admin_password}}` - Start the server with a specific port and set a maximum player count: -`{{path/to/ShooterGameServer}} {{TheIsland}}?Port={{7777}}?MaxPlayers={{1..70}}` +`{{path/to}}/ShooterGameServer {{TheIsland}}?Port={{7777}}?MaxPlayers={{1..70}}` - Enable PvE and disabling PvP: -`{{path/to/ShooterGameServer}} {{TheIsland}}?ServerPVE=true` +`{{path/to}}/ShooterGameServer {{TheIsland}}?ServerPVE=true` - Set a multiplier to scale the server difficulty, affecting the maximum level of wild creatures: -`{{path/to/ShooterGameServer}} {{TheIsland}}?DifficultyOffset={{1.0}}` +`{{path/to}}/ShooterGameServer {{TheIsland}}?DifficultyOffset={{1.0}}` - Enable a specific event: -`{{path/to/ShooterGameServer}} {{TheIsland}} -ActiveEvent={{Summer}}` +`{{path/to}}/ShooterGameServer {{TheIsland}} -ActiveEvent={{Summer}}` - Enable automatic mod downloading, installation, and updating (Steam only): -`{{path/to/ShooterGameServer}} {{TheIsland}} -automanagedmods` +`{{path/to}}/ShooterGameServer {{TheIsland}} -automanagedmods` - Enable crossplay between Steam and Epic Games Store: -`{{path/to/ShooterGameServer}} {{TheIsland}} -crossplay -PublicIPForEpic={{ip_address}}` +`{{path/to}}/ShooterGameServer {{TheIsland}} -crossplay -PublicIPForEpic={{ip_address}}` diff --git a/tldr/linux/barotrauma b/tldr/linux/barotrauma index ae2d5a8c..a5225bf6 100644 --- a/tldr/linux/barotrauma +++ b/tldr/linux/barotrauma @@ -11,4 +11,4 @@ source: https://github.com/tldr-pages/tldr.git - Start the server: -`{{path/to/DedicatedServer}}` +`{{path/to}}/DedicatedServer` diff --git a/tldr/linux/counter-strike-2 b/tldr/linux/counter-strike-2 index 66849ba8..f11342de 100644 --- a/tldr/linux/counter-strike-2 +++ b/tldr/linux/counter-strike-2 @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Run a game with one map: -`{{path/to/cs2}} -dedicated +map {{de_dust2}}` +`{{path/to}}/cs2 -dedicated +map {{de_dust2}}` - Run a game with specified maximum number of players: -`{{path/to/cs2}} -dedicated +map {{de_dust2}} -maxplayers {{64}}` +`{{path/to}}/cs2 -dedicated +map {{de_dust2}} -maxplayers {{64}}` - Run a game with specified server IP and port: -`{{path/to/cs2}} -dedicated +map {{de_dust2}} -ip {{1.2.3.4}} -port {{27015}}` +`{{path/to}}/cs2 -dedicated +map {{de_dust2}} -ip {{1.2.3.4}} -port {{27015}}` - Shut the server down: diff --git a/tldr/linux/factorio b/tldr/linux/factorio index c9271293..9e447dda 100644 --- a/tldr/linux/factorio +++ b/tldr/linux/factorio @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Create a new save file: -`{{path/to/factorio}} --create {{path/to/save_file.zip}}` +`{{path/to}}/factorio --create {{path/to/save_file.zip}}` - Start a Factorio server: -`{{path/to/factorio}} --start-server {{path/to/save_file.zip}}` +`{{path/to}}/factorio --start-server {{path/to/save_file.zip}}` - Create a new save file with specific settings: -`{{path/to/factorio}} --create {{path/to/save.zip}} --map-gen-settings {{path/to/map-gen-settings.json}} --map-settings {{path/to/map-settings.json}}` +`{{path/to}}/factorio --create {{path/to/save.zip}} --map-gen-settings {{path/to/map-gen-settings.json}} --map-settings {{path/to/map-settings.json}}` - Shut the server gracefully: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`{{path/to/factorio}} {{[-h|--help]}}` +`{{path/to}}/factorio {{[-h|--help]}}` diff --git a/tldr/linux/fatrace b/tldr/linux/fatrace index dbc977d9..031c5376 100644 --- a/tldr/linux/fatrace +++ b/tldr/linux/fatrace @@ -17,6 +17,10 @@ source: https://github.com/tldr-pages/tldr.git `sudo fatrace {{[-C|--command]}} {{program_name}}` -- Print file access events on the mount of the current directory, with timestamps, to `stdout`: +- Print file access events on the mount of the current directory to `stdout`: -`sudo fatrace {{[-ct|--current-mount --timestamp]}}` +`sudo fatrace {{[-c|--current-mount]}}` + +- Add timestamps to the printout: + +`sudo fatrace {{[-t|--timestamp]}}` diff --git a/tldr/linux/natural-selection-2 b/tldr/linux/natural-selection-2 index d2550159..20ef8dd3 100644 --- a/tldr/linux/natural-selection-2 +++ b/tldr/linux/natural-selection-2 @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Start a server with the default settings: -`{{path/to/server_linux}}` +`{{path/to}}/server_linux` - Give a server a custom name that shows in the server browser: -`{{path/to/server_linux}} -name '{{server_name}}'` +`{{path/to}}/server_linux -name '{{server_name}}'` - Specify a connection port for the server: -`{{path/to/server_linux}} -port {{27015}}` +`{{path/to}}/server_linux -port {{27015}}` - Specify maximum player count: -`{{path/to/server_linux}} -limit {{2..24}}` +`{{path/to}}/server_linux -limit {{2..24}}` - Specify the initial map the server starts on: -`{{path/to/server_linux}} -map {{ns2_summit}}` +`{{path/to}}/server_linux -map {{ns2_summit}}` - Limit access to the server with a password: -`{{path/to/server_linux}} -password {{password}}` +`{{path/to}}/server_linux -password {{password}}` - Start a server with webui admin interface: -`{{path/to/server_linux}} -webadmin -webport {{8080}}` +`{{path/to}}/server_linux -webadmin -webport {{8080}}` diff --git a/tldr/linux/palworld b/tldr/linux/palworld index 69faae74..4d0ee465 100644 --- a/tldr/linux/palworld +++ b/tldr/linux/palworld @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Start the server with default settings: -`{{path/to/PalServer.sh}}` +`{{path/to}}/PalServer.sh` - Start the server with a specific port and set a maximum player count: -`{{path/to/PalServer.sh}} -port={{8211}} -players={{1..32}}` +`{{path/to}}/PalServer.sh -port={{8211}} -players={{1..32}}` - Start a public lobby server: -`{{path/to/PalServer.sh}} -publiclobby` +`{{path/to}}/PalServer.sh -publiclobby` - Start the server with performance optimizations for multi-threaded CPUs: -`{{path/to/PalServer.sh}} -useperfthreads -NoAsyncLoadingThread -UseMultithreadForDS` +`{{path/to}}/PalServer.sh -useperfthreads -NoAsyncLoadingThread -UseMultithreadForDS` - Start the server with a specific public IP and port for community servers: -`{{path/to/PalServer.sh}} -publicip={{ip_address}} -publicport={{port}}` +`{{path/to}}/PalServer.sh -publicip={{ip_address}} -publicport={{port}}` diff --git a/tldr/linux/pkgctl-release b/tldr/linux/pkgctl-release index d1eba10b..ca6e9d11 100644 --- a/tldr/linux/pkgctl-release +++ b/tldr/linux/pkgctl-release @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pkgctl release -> Release step to commit, tag and upload build artifacts. +> Release step to commit, tag, and upload build artifacts. > More information: . - Release a build artifact: diff --git a/tldr/linux/project-zomboid b/tldr/linux/project-zomboid index cf3d143b..36033116 100644 --- a/tldr/linux/project-zomboid +++ b/tldr/linux/project-zomboid @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Start the server: -`{{path/to/start-server.sh}}` +`{{path/to}}/start-server.sh` - Start a server with a specific name: -`{{path/to/start-server.sh}} -servername {{server_name}}` +`{{path/to}}/start-server.sh -servername {{server_name}}` diff --git a/tldr/linux/sed b/tldr/linux/sed index 7fa9278d..b09db203 100644 --- a/tldr/linux/sed +++ b/tldr/linux/sed @@ -9,15 +9,15 @@ source: https://github.com/tldr-pages/tldr.git > See also: `awk`, `ed`. > More information: . -- Replace `apple` with `mango` on all lines using basic `regex`, print to `stdout`: +- Replace "apple" with "mango" on all lines using basic `regex`, print to `stdout`: `{{command}} | sed 's/apple/mango/g'` -- Replace `apple` with `APPLE` on all lines using extended `regex`, print to `stdout`: +- Replace "apple" with "APPLE" on all lines using extended `regex`, print to `stdout`: `{{command}} | sed {{[-E|--regexp-extended]}} 's/(apple)/\U\1/g'` -- Use basic `regex` to replace `apple` with `mango` and `orange` with `lime` in-place in a file (overwriting original file): +- Use basic `regex` to replace "apple" with "mango" and "orange" with "lime" in-place in a file (overwriting original file): `sed {{[-i|--in-place]}} -e 's/apple/mango/g' -e 's/orange/lime/g' {{path/to/file}}` diff --git a/tldr/linux/systemd-analyze b/tldr/linux/systemd-analyze index 8750ef78..bcdc0228 100644 --- a/tldr/linux/systemd-analyze +++ b/tldr/linux/systemd-analyze @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `systemd-analyze blame` -- Print a tree of the time-critical chain of units: +- Print a tree of the time-critical chain of bootup units: `systemd-analyze critical-chain` @@ -33,6 +33,6 @@ source: https://github.com/tldr-pages/tldr.git `systemd-analyze security` -- View all udev rules together: +- View all udev rules together without showing comments: -`systemd-analyze cat-config udev/rules.d` +`systemd-analyze cat-config udev/rules.d --tldr` diff --git a/tldr/linux/terraria b/tldr/linux/terraria index cb89e3e8..f85cc1a1 100644 --- a/tldr/linux/terraria +++ b/tldr/linux/terraria @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Start an interactive server setup: -`{{path/to/TerrariaServer}}` +`{{path/to}}/TerrariaServer` - Start a Terraria server: -`{{path/to/TerrariaServer}} -world {{path/to/world.wld}}` +`{{path/to}}/TerrariaServer -world {{path/to/world.wld}}` diff --git a/tldr/linux/valheim b/tldr/linux/valheim index eaff9500..2aec6418 100644 --- a/tldr/linux/valheim +++ b/tldr/linux/valheim @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the server: -`{{path/to/start_server.sh}}` +`{{path/to}}/start_server.sh` - Stop the server gracefully: diff --git a/tldr/ng-analytics b/tldr/ng-analytics new file mode 100644 index 00000000..6cbc5d34 --- /dev/null +++ b/tldr/ng-analytics @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ng analytics + +> Manage Angular CLI analytics settings. +> More information: . + +- Enable analytics for the current project: + +`ng analytics {{[on|enable]}}` + +- Enable analytics globally: + +`ng analytics {{[on|enable]}} {{[-g|--global]}}` + +- Disable analytics for the current project: + +`ng analytics {{[off|disable]}}` + +- Disable analytics globally: + +`ng analytics {{[off|disable]}} {{[-g|--global]}}` + +- Display the current analytics configuration and status: + +`ng analytics info` + +- Prompt interactively to configure analytics settings: + +`ng analytics prompt` diff --git a/tldr/nix-eval b/tldr/nix-eval new file mode 100644 index 00000000..3bf14cdb --- /dev/null +++ b/tldr/nix-eval @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix eval + +> Evaluate a Nix expression and print the result to `stdout`. +> More information: . + +- Evaluate Nix flake attributes in the current directory: + +`nix eval .#{{attributes}}` + +- Evaluate a given Nix expression: + +`nix eval --expr '{{your_expression}}'` + +- Evaluate a Nix expression from a specified file: + +`nix eval --file {{path/to/file}}` + +- Print the store path of the specified package from nixpkgs: + +`nix eval {{nixpkgs#pkg}} --raw` + +- Evaluate attributes from a flake directly from GitHub: + +`nix eval {{github:owner/repo#attributes}}` + +- Evaluate a given lambda function passing the specified package as argument: + +`nix eval {{nixpkgs#pkg}} --apply '{{lambda_function}}'` diff --git a/tldr/nix-flake b/tldr/nix-flake index eb5aabcc..d19e20a2 100644 --- a/tldr/nix-flake +++ b/tldr/nix-flake @@ -6,12 +6,9 @@ source: https://github.com/tldr-pages/tldr.git # nix flake > Manage Nix flakes. +> Some subcommands such as `init`, `show`, `info` have their own usage documentation. > More information: . -- Create a new flake (just the `flake.nix` file) from the default template, in the current directory: - -`nix flake init` - - Update all inputs (dependencies) of the flake in the current directory: `nix flake update` @@ -20,9 +17,13 @@ source: https://github.com/tldr-pages/tldr.git `nix flake update {{input}}` -- Show all the outputs of a flake on github: +- Clone a GitHub repository containing a flake: -`nix flake show {{github:owner/repo}}` +`nix flake clone {{github:owner/repo#attributes}}` + +- Create missing lock file entries for a flake in a specified directory: + +`nix flake lock {{path/to/flake}}` - Display help: diff --git a/tldr/nix-flake-info b/tldr/nix-flake-info new file mode 100644 index 00000000..1fd805af --- /dev/null +++ b/tldr/nix-flake-info @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix flake info + +> Show flake metadata. +> More information: . + +- Show flake metadata of the flake in the current directory: + +`nix flake info` + +- Show flake metadata from GitHub as a json on a single line: + +`nix flake info {{github:owner/repo}} --json --no-pretty` + +- Show flake metadata from Github as a multi-line indented json: + +`nix flake info {{github:owner/repo}} --json --pretty` diff --git a/tldr/nix-flake-init b/tldr/nix-flake-init new file mode 100644 index 00000000..27858967 --- /dev/null +++ b/tldr/nix-flake-init @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix flake init + +> Create a flake in the current directory from a template. +> More information: . + +- Create a new flake from the default template, in the current directory: + +`nix flake init` + +- Create a new flake with a specified template (see `nix flake show` for information about templates): + +`nix flake init {{[-t|--template]}} templates#{{your_template}}` diff --git a/tldr/nix-flake-show b/tldr/nix-flake-show new file mode 100644 index 00000000..4606b6b8 --- /dev/null +++ b/tldr/nix-flake-show @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# nix flake show + +> Show outputs provided by a flake. +> More information: . + +- Show all the outputs of the flake in the current directory: + +`nix flake show` + +- Show all the outputs of a flake on GitHub and print the output as a json on a single line: + +`nix flake show {{github:owner/repo}} --json --no-pretty` + +- Show all the `legacyPackages` outputs of a flake on GitHub and print the output as a multi-line indented json: + +`nix flake show {{github:owner/repo}} --json --pretty --legacy` + +- List all available flake templates for `nix flake init`: + +`nix flake show templates` diff --git a/tldr/osx/mysides b/tldr/osx/mysides index 80f1769e..dc6b530c 100644 --- a/tldr/osx/mysides +++ b/tldr/osx/mysides @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # mysides -> Add, list and remove finder favorites. +> Add, list, and remove finder favorites. > More information: . - List sidebar favorites: diff --git a/tldr/osx/open b/tldr/osx/open index 6dcf33f5..2204ea1b 100644 --- a/tldr/osx/open +++ b/tldr/osx/open @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # open -> Open files, directories and applications. +> Open files, directories, and applications. > More information: . - Open a file with the associated application: diff --git a/tldr/osx/systemsetup b/tldr/osx/systemsetup index 039adc34..37820abd 100644 --- a/tldr/osx/systemsetup +++ b/tldr/osx/systemsetup @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `systemsetup -setremotelogin on` -- Specify timezone, NTP Server and enable network time: +- Specify timezone, NTP Server, and enable network time: `systemsetup -settimezone "{{US/Pacific}}" -setnetworktimeserver {{us.pool.ntp.org}} -setusingnetworktime on` diff --git a/tldr/osx/tart b/tldr/osx/tart index 7f7a5331..9b887b4e 100644 --- a/tldr/osx/tart +++ b/tldr/osx/tart @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # tart -> Build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon. +> Build, run, and manage macOS and Linux virtual machines (VMs) on Apple Silicon. > More information: . - Pull a remote VM image: diff --git a/tldr/osx/uptime b/tldr/osx/uptime index cd05ad27..8c8d93b2 100644 --- a/tldr/osx/uptime +++ b/tldr/osx/uptime @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Tell how long the system has been running and other information. > More information: . -- Print current time, uptime, number of logged-in users and other information: +- Print current time, uptime, number of logged-in users, and other information: `uptime` diff --git a/tldr/osx/wc b/tldr/osx/wc index ddba8a58..8347b2f1 100644 --- a/tldr/osx/wc +++ b/tldr/osx/wc @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `wc -m {{path/to/file}}` -- Use `stdin` to count lines, words and characters (bytes) in that order: +- Use `stdin` to count lines, words, and characters (bytes) in that order: `{{find .}} | wc` diff --git a/tldr/osx/xcodes b/tldr/osx/xcodes index f62fbaa9..45985568 100644 --- a/tldr/osx/xcodes +++ b/tldr/osx/xcodes @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # xcodes -> Download, install and manage multiple Xcode versions. +> Download, install, and manage multiple Xcode versions. > See also: `xcodes runtimes`. > More information: . diff --git a/tldr/rcs b/tldr/rcs new file mode 100644 index 00000000..2a19bc79 --- /dev/null +++ b/tldr/rcs @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rcs + +> Revision Control System - manage RCS file attributes. +> See also: `ci`, `co`, `rcsdiff`, `rlog`. +> More information: . + +- Unlock a revision locked by another user (requires access): + +`rcs -u {{path/to/file}}` + +- Lock a specific revision of a file: + +`rcs -l{{revision}} {{path/to/file}}` + +- Set the strict locking mode (require lock for check-in): + +`rcs -L {{path/to/file}}` + +- Add or replace a log message for a specific revision: + +`rcs -m{{revision}}:"{{new_message}}" {{path/to/file}}` + +- Delete a specific revision from the RCS file: + +`rcs -o{{revision}} {{path/to/file}}` diff --git a/tldr/rcsdiff b/tldr/rcsdiff new file mode 100644 index 00000000..f53db2ff --- /dev/null +++ b/tldr/rcsdiff @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rcsdiff + +> Compare RCS revisions (show differences between revisions in RCS files). +> See also: `ci`, `co`, `rcs`, `rlog`. +> More information: . + +- Compare the working file with the latest revision: + +`rcsdiff {{path/to/file}}` + +- Compare the working file with a specific revision: + +`rcsdiff -r{{revision}} {{path/to/file}}` + +- Compare two specific revisions of a file: + +`rcsdiff -r{{revision1}} -r{{revision2}} {{path/to/file}}` + +- Show differences in unified format: + +`rcsdiff -u {{path/to/file}}` + +- Show differences with context lines: + +`rcsdiff -c {{path/to/file}}` diff --git a/tldr/rcsmerge b/tldr/rcsmerge new file mode 100644 index 00000000..897351fa --- /dev/null +++ b/tldr/rcsmerge @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rcsmerge + +> Merge RCS revisions into the working file. +> See also: `ci`, `co`, `rcs`, `rcsdiff`, `rlog`. +> More information: . + +- Merge differences between two revisions into the working file: + +`rcsmerge -r{{revision1}} -r{{revision2}} {{path/to/file}}` + +- Merge changes from a branch revision into the working file: + +`rcsmerge -r{{branch_revision}} {{path/to/file}}` + +- Perform a quiet merge (suppress diagnostics): + +`rcsmerge -q -r{{revision1}} -r{{revision2}} {{path/to/file}}` + +- Print the result to `stdout` instead of overwriting the working file: + +`rcsmerge -p -r{{revision1}} -r{{revision2}} {{path/to/file}}` diff --git a/tldr/rlog b/tldr/rlog new file mode 100644 index 00000000..f7f99683 --- /dev/null +++ b/tldr/rlog @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rlog + +> Print the revision log of RCS files. +> See also: `ci`, `co`, `rcs`, `rcsdiff`. +> More information: . + +- Display the complete revision history of a file: + +`rlog {{path/to/file}}` + +- Display only the header information (no revision details): + +`rlog -h {{path/to/file}}` + +- Display information for a specific revision: + +`rlog -r{{revision}} {{path/to/file}}` + +- Display revisions within a date range: + +`rlog -d"{{start_date}}<{{end_date}}" {{path/to/file}}` + +- Display revisions by a specific author: + +`rlog -w{{author}} {{path/to/file}}` diff --git a/tldr/sunos/zoneadm b/tldr/sunos/zoneadm new file mode 100644 index 00000000..ca9c6f05 --- /dev/null +++ b/tldr/sunos/zoneadm @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, sunos] +source: https://github.com/tldr-pages/tldr.git +--- +# zoneadm + +> Administer Oracle Solaris zones. +> More information: . + +- List all zones and their current status: + +`zoneadm list -cv` + +- Verify the configuration of a specific zone: + +`sudo zoneadm -z {{zone_name}} verify` + +- Install a zone: + +`sudo zoneadm -z {{zone_name}} install` + +- Boot (start) a zone: + +`sudo zoneadm -z {{zone_name}} boot` + +- Reboot a zone: + +`sudo zoneadm -z {{zone_name}} reboot` + +- Halt (stop) a zone, bypassing any shutdown scripts inside the zone: + +`sudo zoneadm -z {{zone_name}} halt` + +- Uninstall a zone: + +`sudo zoneadm -z {{zone_name}} uninstall` diff --git a/tldr/whisper b/tldr/whisper index 0027999e..a099adbf 100644 --- a/tldr/whisper +++ b/tldr/whisper @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # whisper -> Convert audio files to `txt`, `vtt`, `srt`, `tsv` and `json`. +> Convert audio files to `txt`, `vtt`, `srt`, `tsv`, and `json`. > More information: . - Convert a specific audio file to all of the given file formats: diff --git a/tldr/windows/rdpsign b/tldr/windows/rdpsign index 29fa31fb..84c3c687 100644 --- a/tldr/windows/rdpsign +++ b/tldr/windows/rdpsign @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `rdpsign {{path o ile.rdp}} /q` -- Display verbose warnings, messages and statuses: +- Display verbose warnings, messages, and statuses: `rdpsign {{path o ile.rdp}} /v`