diff --git a/tldr/crane b/tldr/crane new file mode 100644 index 00000000..3977cdec --- /dev/null +++ b/tldr/crane @@ -0,0 +1,34 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane + +> Container images managing tool. +> Some subcommands such as `pull`, `push`, `copy`, etc. have their own usage documentation. +> More information: . + +- Execute a `crane` subcommand: + +`crane {{subcommand}}` + +- Allow pushing non-distributable (foreign) layers: + +`crane --allow-nondistributable-artifacts {{subcommand}}` + +- Allow image references to be fetched without TLS: + +`crane --insecure {{subcommand}}` + +- Specify the platform in the form os/arch{{/variant}}{{:osversion}} (e.g. linux/amd64). (default all): + +`crane --platform {{platform}} {{subcommand}}` + +- Enable debug logs for a subcommand: + +`crane {{-v|--verbose}} {{subcommand}}` + +- Display help for a subcommand: + +`crane {{-h|--help}} {{subcommand}}` diff --git a/tldr/crane-append b/tldr/crane-append new file mode 100644 index 00000000..2986d9e9 --- /dev/null +++ b/tldr/crane-append @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane append + +> Push an image based on an (optional) base image. +> Appends layers containing the contents of the provided tarballs. +> More information: . + +- Push image based on a base image: + +`crane append {{-b|--base}} {{image_name}}` + +- Push image with appended layer from tarball: + +`crane append {{-f|--new_layer}} {{layer_name1 layer_name2 ...}}` + +- Push image with appended layer with new tag: + +`crane append {{-t|--new_tag}} {{tag_name}}` + +- Push resulting image to new tarball: + +`crane append {{-o|--output}} {{path/to/tarball}}` + +- Use empty base image of type OCI media instead of Docker: + +`crane append --oci-empty-base` + +- Annotate resulting image as being based on the base image: + +`crane append --set-base-image-annotations` + +- Display help: + +`crane append {{-h|--help}}` diff --git a/tldr/crane-auth b/tldr/crane-auth new file mode 100644 index 00000000..4c752a7d --- /dev/null +++ b/tldr/crane-auth @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane auth + +> Log in or access credentials. +> More information: . + +- Execute `crane auth` subcommand: + +`crane auth {{subcommand}}` + +- Implement credential helper: + +`crane auth get {{registry_address}} {{-h|--help}}` + +- Log in to a registry: + +`crane auth login {{registry_address}} {{-h|--help}} {{-p|--password}} {{password}} {{-password-stdin}} {{-u|--username}} {{username}}` + +- Log out of a registry: + +`crane auth logout {{registry_address}} {{-h|--help}}` + +- Retrieve a token for a remote repository: + +`crane auth token {{registry_address}} {{-H|--header}} {{-h|--help}} {{-m|--mount}} {{scope1 scope2 ...}} --push` + +- Display help: + +`crane auth {{-h|--help}}` diff --git a/tldr/crane-blob b/tldr/crane-blob new file mode 100644 index 00000000..bcd39099 --- /dev/null +++ b/tldr/crane-blob @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane blob + +> Read a blob from a registry. +> More information: . + +- Read the blob from a registry: + +`crane blob {{blob_identifier}}` + +- Display help: + +`crane blob {{-h|--help}}` diff --git a/tldr/crane-catalog b/tldr/crane-catalog new file mode 100644 index 00000000..1f0c396e --- /dev/null +++ b/tldr/crane-catalog @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane catalog + +> List the repositories in a registry. +> More information: . + +- List the repositories in a registry: + +`crane catalog {{registry_address}}` + +- Print the full image reference: + +`crane catalog {{registry_address}} --full-ref` + +- Display help: + +`crane catalog {{-h|--help}}` diff --git a/tldr/crane-config b/tldr/crane-config new file mode 100644 index 00000000..c20aa551 --- /dev/null +++ b/tldr/crane-config @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane config + +> Get the configuration of an image. +> More information: . + +- Get the configuration of an image: + +`crane config {{image_name}}` + +- Display help: + +`crane config {{-h|--help}}` diff --git a/tldr/crane-copy b/tldr/crane-copy new file mode 100644 index 00000000..e36952b5 --- /dev/null +++ b/tldr/crane-copy @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane copy + +> Efficiently copy a remote image from source to target while retaining the digest value. +> More information: . + +- Copy an image from source to target: + +`crane copy {{source}} {{target}}` + +- Copy all tags: + +`crane copy {{source}} {{target}} {{-a|--all-tags}}` + +- Set the maximum number of concurrent copies, defaults to GOMAXPROCS: + +`crane copy {{source}} {{target}} {{-j|--jobs}} {{int}}` + +- Avoid overwriting existing tags in target: + +`crane copy {{source}} {{target}} {{-n|--no-clobber}}` + +- Display help: + +`crane copy {{-h|--help}}` diff --git a/tldr/crane-delete b/tldr/crane-delete new file mode 100644 index 00000000..5f67172b --- /dev/null +++ b/tldr/crane-delete @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane delete + +> Delete an image reference from its registry. +> More information: . + +- Delete an image reference from its registry: + +`crane delete {{image_name}}` + +- Display help: + +`crane delete {{-h|--help}}` diff --git a/tldr/crane-digest b/tldr/crane-digest new file mode 100644 index 00000000..9a20440f --- /dev/null +++ b/tldr/crane-digest @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane digest + +> Get the digest of an image. +> More information: . + +- Get the digest of an image: + +`crane digest {{image_name}}` + +- Print the full image reference by digest: + +`crane digest {{image_name}} --full-ref` + +- Specify path to tarball containing the image: + +`crane digest {{image_name}} --tarball {{path/to/tarball}}` + +- Display help: + +`crane digest {{-h|--help}}` diff --git a/tldr/crane-export b/tldr/crane-export new file mode 100644 index 00000000..ba417f5f --- /dev/null +++ b/tldr/crane-export @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane export + +> Export filesystem of a container image as a tarball. +> More information: . + +- Write tarball to stdout: + +`crane export {{image_name}} -` + +- Write tarball to file: + +`crane export {{image_name}} {{path/to/tarball}}` + +- Read image from stdin: + +`crane export - {{path/to/filename}}` diff --git a/tldr/crane-flatten b/tldr/crane-flatten new file mode 100644 index 00000000..8d340cce --- /dev/null +++ b/tldr/crane-flatten @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane flatten + +> Flatten an image's layers into a single layer. +> Pushes digest to original image repository if no tags are specified. +> More information: . + +- Flatten an image: + +`crane flatten` + +- Apply new tag to flattened image: + +`crane flatten {{-t|--tag}} {{tag_name}}` + +- Display help: + +`crane flatten {{-h|--help}}` diff --git a/tldr/crane-index b/tldr/crane-index new file mode 100644 index 00000000..e661e16b --- /dev/null +++ b/tldr/crane-index @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane index + +> Modify an image index. +> The subcommands `append` and `filter` have their own usage documentation. +> More information: . + +- Modify an image index: + +`crane index` + +- Modify an image index with subcommand: + +`crane index {{subcommand}}` + +- Display help: + +`crane index {{-h|--help}}` diff --git a/tldr/crane-index-append b/tldr/crane-index-append new file mode 100644 index 00000000..ddd9c984 --- /dev/null +++ b/tldr/crane-index-append @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane index append + +> Append manifest to a remote index. +> This sub-command pushes an index based on an (optional) base index, with appended manifests. +> The platform for appended manifests is inferred from the config file or omitted if that is infeasible. +> More information: . + +- Append manifest to a remote index: + +`crane index append` + +- Reference to manifests to append to the base index: + +`crane index append {{-m|--manifest}} {{manifest_name1 manifest_name2 ...}}` + +- Tag to apply to resulting image: + +`crane index append {{-t|--tag}} {{tag_name}}` + +- Empty base index will have Docker media types instead of OCI: + +`crane index append --docker-empty-base` + +- Append each of its children rather than the index itself (defaults true): + +`crane index append --flatten` + +- Display help: + +`crane index append {{-h|--help}}` diff --git a/tldr/crane-index-filter b/tldr/crane-index-filter new file mode 100644 index 00000000..86c41985 --- /dev/null +++ b/tldr/crane-index-filter @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane index filter + +> Modifies a remote index by filtering based on platform. +> More information: . + +- Modify remote index: + +`crane index filter` + +- Specify the platform(s) to keep from base in the form os/arch{{/variant}}{{:osversion}}{{,}}: + +`crane index filter --platform {{platform1 platform2 ...}}` + +- Tag to apply to resulting image: + +`crane index filter {{-t|--tags}} {{tag_name}}` + +- Display help: + +`crane index filter {{-h|--help}}` diff --git a/tldr/crane-ls b/tldr/crane-ls new file mode 100644 index 00000000..3d1e32db --- /dev/null +++ b/tldr/crane-ls @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane ls + +> List the tags in a repository. +> More information: . + +- List the tags: + +`crane ls {{repository}}` + +- Print the full image reference: + +`crane ls {{repository}} --full-ref` + +- Omit digest tags: + +`crane ls {{-o|--omit-digest-tags}}` + +- Display help: + +`crane ls {{-h|--help}}` diff --git a/tldr/crane-manifest b/tldr/crane-manifest new file mode 100644 index 00000000..0e41ce58 --- /dev/null +++ b/tldr/crane-manifest @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane manifest + +> Get the manifest of an image. +> More information: . + +- Get the manifest: + +`crane manifest {{image_name}}` + +- Display help: + +`crane manifest {{-h|--help}}` diff --git a/tldr/crane-mutate b/tldr/crane-mutate new file mode 100644 index 00000000..e1928f4c --- /dev/null +++ b/tldr/crane-mutate @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane mutate + +> Modify image labels and annotations. +> The container must be pushed to a registry, and the manifest is updated there. +> More information: . + +- New annotations to set (default []): + +`crane mutate {{-a|--annotation}}/{{-l|--label}} {{annotation/label}}` + +- Path to tarball/command/entrypoint/environment variable/exposed-ports to append to image: + +`crane mutate {{--append}}/{{--cmd}}/{{--entrypoint}}/{{-e|--env}}/{{--exposed-ports}} {{var1 var2 ...}}` + +- Path to new tarball of resulting image: + +`crane mutate {{-o|--output}} {{path/to/tarball}}` + +- Repository in the form os/arch{{/variant}}{{:osversion}}{{,}} to push mutated image: + +`crane mutate --set-platform {{platform_name}}` + +- New tag reference to apply to mutated image: + +`crane mutate {{-t|--tag}} {{tag_name}}` + +- New user to set: + +`crane mutate {{-u|--user}} {{username}}` + +- New working dir to set: + +`crane mutate {{-w|--workdir}} {{path/to/workdir}}` + +- Display help: + +`crane mutate {{-h|--help}}` diff --git a/tldr/crane-pull b/tldr/crane-pull new file mode 100644 index 00000000..92ba8df8 --- /dev/null +++ b/tldr/crane-pull @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane pull + +> Pull remote images by reference and store their contents locally. +> More information: . + +- Pull remote image: + +`crane pull {{image_name}} {{path/to/tarball}}` + +- Preserve image reference used to pull as an annotation when used with --format=oci: + +`crane pull {{image_name}} {{path/to/tarball}} --annotate-ref` + +- Path to cache image layers: + +`crane pull {{image_name}} {{path/to/tarball}} {{-c|--cache_path}} {{path/to/cache}}` + +- Format in which to save images (default 'tarball'): + +`crane pull {{image_name}} {{path/to/tarball}} {{-format}} {{format_name}}` + +- Display help: + +`crane pull {{-h|--help}}` diff --git a/tldr/crane-push b/tldr/crane-push new file mode 100644 index 00000000..5d379b41 --- /dev/null +++ b/tldr/crane-push @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane push + +> Push local image contents to a remote registry. +> More information: . + +- Push local image to remote registry: + +`crane push {{path/to/tarball}} {{image_name}}` + +- Path to file with list of published image references: + +`crane push {{path/to/tarball}} {{image_name}} --image-refs {{path/to/filename}}` + +- Push a collection of images as a single index (required if path has multiple images): + +`crane push {{path/to/tarball}} {{image_name}} --index` + +- Display help: + +`crane push {{-h|--help}}` diff --git a/tldr/crane-rebase b/tldr/crane-rebase new file mode 100644 index 00000000..034b2448 --- /dev/null +++ b/tldr/crane-rebase @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane rebase + +> Rebase an image onto a new base image. +> More information: . + +- Rebase image: + +`crane rebase` + +- New base image to insert: + +`crane rebase --new_base {{image_name}}` + +- Old base image to remove: + +`crane rebase --old_base {{image_name}}` + +- Tag to apply to rebased image: + +`crane rebase {{-t|--tag}} {{tag_name}}` + +- Display help: + +`crane rebase {{-h|--help}}` diff --git a/tldr/crane-registry b/tldr/crane-registry new file mode 100644 index 00000000..405cef97 --- /dev/null +++ b/tldr/crane-registry @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane registry + +> This command serves a registry implementation on an automatically chosen port (:0), $PORT or --address. +> The command blocks while the server accepts pushes and pulls and contents are can be stored in memory, and disk. +> More information: . + +- Serve a registry implementation: + +`crane registry serve` + +- Address to listen on: + +`crane registry serve --address {{address_name}}` + +- Path to a directory where blobs will be stored: + +`crane registry serve --disk {{path/to/store_dir}}` + +- Display help: + +`crane registry {{-h|--help}}` + +- Display help: + +`crane registry serve {{-h|--help}}` diff --git a/tldr/crane-tag b/tldr/crane-tag new file mode 100644 index 00000000..2b07524f --- /dev/null +++ b/tldr/crane-tag @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane tag + +> Efficiently tag a remote image without downloading it, which differs from the `copy` command. +> It skips the layer existence checks because we know the manifest already exists making it slightly faster. +> More information: . + +- Tag remote image: + +`crane tag {{image_name}} {{tag_name}}` + +- Display help: + +`crane tag {{-h|--help}}` diff --git a/tldr/crane-validate b/tldr/crane-validate new file mode 100644 index 00000000..d1002b2f --- /dev/null +++ b/tldr/crane-validate @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane validate + +> Validate that an image is well-formed. +> More information: . + +- Validate an image: + +`crane validate` + +- Skip downloading/digesting layers: + +`crane validate --fast` + +- Name of remote image to validate: + +`crane validate --remote {{image_name}}` + +- Path to tarball to validate: + +`crane validate --tarball {{path/to/tarball}}` + +- Display help: + +`crane validate {{-h|--help}}` diff --git a/tldr/crane-version b/tldr/crane-version new file mode 100644 index 00000000..0155a808 --- /dev/null +++ b/tldr/crane-version @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# crane version + +> Print the version of a binary. +> The version string is completely dependent on how the binary was built, so you should not depend on the version format. It may change without notice. +> More information: . + +- Display version: + +`crane version` + +- Display help: + +`crane version {{-h|--help}}` diff --git a/tldr/emacsclient b/tldr/emacsclient index fdc809b4..00bafe8c 100644 --- a/tldr/emacsclient +++ b/tldr/emacsclient @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Open files in an existing Emacs server. > See also `emacs`. -> More information: . +> More information: . - Open a file in an existing Emacs server (using GUI if available): diff --git a/tldr/enable b/tldr/enable new file mode 100644 index 00000000..0ba0e470 --- /dev/null +++ b/tldr/enable @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# enable + +> Enable and disable shell builtins. +> More information: . + +- Print the list of builtins: + +`enable` + +- Disable a builtin (works in `bash` only): + +`enable -n {{command}}` diff --git a/tldr/fping b/tldr/fping index 986c9974..d637ef35 100644 --- a/tldr/fping +++ b/tldr/fping @@ -8,14 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > A more powerful ping which can ping multiple hosts. > More information: . +- List the status of all hosts within a range: + +`fping {{192.168.1.{1..254}}}` + - List alive hosts within a subnet generated from a netmask: -`fping {{-a|--alive}} {{-g|--generate}} 192.168.1.0/24` +`fping {{-a|--alive}} {{-g|--generate}} {{192.168.1.0/24}}` -- List alive hosts within a subnet generated from an IP range: +- List alive hosts within a subnet generated from an IP range and prune per-probe results: -`fping {{-a|--alive}} {{-g|--generate}} 192.168.1.1 192.168.1.254` +`fping {{-q|--quiet}} {{-a|--alive}} {{-g|--generate}} {{192.168.1.1}} {{192.168.1.254}}` - List unreachable hosts within a subnet generated from a netmask: -`fping {{-u|--unreach}} {{-g|--generate}} 192.168.1.0/24` +`fping {{-u|--unreach}} {{-g|--generate}} {{192.168.1.0/24}}` diff --git a/tldr/gatsby b/tldr/gatsby index 88bda4e9..d43d653f 100644 --- a/tldr/gatsby +++ b/tldr/gatsby @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gatsby > Static site generator for React. -> More information: . +> More information: . - Create a new site: diff --git a/tldr/gcrane b/tldr/gcrane new file mode 100644 index 00000000..7a1d4497 --- /dev/null +++ b/tldr/gcrane @@ -0,0 +1,36 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane + +> Container images managing tool. +> This tool implements a superset of the `crane` commands, with additional commands that are specific to `gcr.io`. +> Some subcommands such as `append`, `auth`, `copy`, etc. have their own usage documentation which can be found under `crane`. +> Some subcommands such as `completion`, `gc`, `help` are specific to gcrane and have their own usage documentation. +> More information: . + +- Execute a `gcrane` subcommand: + +`gcrane {{subcommand}}` + +- Allow pushing non-distributable (foreign) layers: + +`gcrane --allow-nondistributable-artifacts {{subcommand}}` + +- Allow image references to be fetched without TLS: + +`gcrane --insecure {{subcommand}}` + +- Specify the platform in the form os/arch{{/variant}}{{:osversion}} (e.g. linux/amd64). (default all): + +`gcrane --platform {{platform}} {{subcommand}}` + +- Enable debug logs: + +`gcrane {{-v|--verbose} {{subcommand}}` + +- Display help: + +`gcrane {{-h|--help}}` diff --git a/tldr/gcrane-copy b/tldr/gcrane-copy new file mode 100644 index 00000000..19d4480d --- /dev/null +++ b/tldr/gcrane-copy @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane copy + +> Efficiently copy a remote image from source to target while retaining the digest value. +> More information: . + +- Copy an image from source to target: + +`gcrane {{cp|copy}} {{source}} {{target}}` + +- Set the maximum number of concurrent copies, defaults to 20: + +`gcrane copy {{source}} {{target}} {{-j|--jobs}} {{nr_of_copies}}` + +- Whether to recurse through repositories: + +`grance copy {{source}} {{target}} {{-r|--recursive}}` + +- Display help: + +`gcrane copy {{-h|--help}}` diff --git a/tldr/gcrane-gc b/tldr/gcrane-gc new file mode 100644 index 00000000..edc9147a --- /dev/null +++ b/tldr/gcrane-gc @@ -0,0 +1,23 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane gc + +> List images that are not tagged. +> Will calculate images that can be garbage-collected. +> This can be composed with `gcrane delete` to actually garbage collect them. +> More information: . + +- List untagged images: + +`gcrane gc {{repository}}` + +- Whether to recurse through repositories: + +`gcrane gc {{repository}} {{-r|--recursive}}` + +- Display help: + +`gcrane gc {{-h|--help}}` diff --git a/tldr/gcrane-help b/tldr/gcrane-help new file mode 100644 index 00000000..1ea8523f --- /dev/null +++ b/tldr/gcrane-help @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane help + +> Help provides help for any command in the application. +> More information: . + +- Display help for a subcommand: + +`gcrane help {{command}}` + +- Display help: + +`grance help {{-h|--help}}` diff --git a/tldr/gcrane-ls b/tldr/gcrane-ls new file mode 100644 index 00000000..5907dbe0 --- /dev/null +++ b/tldr/gcrane-ls @@ -0,0 +1,26 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane ls + +> List the tags in a repository. +> More complex form than `crane ls`, which allows for listing tags, manifest and sub-repositories. +> More information: . + +- List the tags: + +`gcrane ls {{repository}}` + +- Format response from the registry as JSON: + +`gcrane ls {{repository}} --json` + +- Whether to recurse through repositories: + +`gcrane ls {{repository}} {{-r|--recursive}}` + +- Display help: + +`gcrane ls {{-h|--help}}` diff --git a/tldr/linux/eselect b/tldr/linux/eselect index 64eba6a3..0b1498e0 100644 --- a/tldr/linux/eselect +++ b/tldr/linux/eselect @@ -7,6 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Gentoo's multi-purpose configuration and management tool. > It consists of various modules that take care of individual administrative tasks. +> Some subcommands such as `kernel`, `locale`, `profile`, etc. have their own usage documentation. > More information: . - Display a list of installed modules: diff --git a/tldr/linux/eselect-kernel b/tldr/linux/eselect-kernel new file mode 100644 index 00000000..1eab67d4 --- /dev/null +++ b/tldr/linux/eselect-kernel @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eselect kernel + +> An `eselect` module for managing the `/usr/src/linux` symlink. +> More information: . + +- List available kernel symlink targets with their numbers: + +`eselect kernel list` + +- Set the `/usr/src/linux` symlink by name or number from the `list` command: + +`eselect kernel set {{name|number}}` + +- Show what the current kernel symlink points to: + +`eselect kernel show` + +- Set the kernel symlink to the currently running kernel: + +`eselect kernel update` diff --git a/tldr/linux/eselect-profile b/tldr/linux/eselect-profile new file mode 100644 index 00000000..0758563d --- /dev/null +++ b/tldr/linux/eselect-profile @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# eselect profile + +> An `eselect` module for managing the `/etc/portage/make.profile` symlink, which sets the system profile. +> More information: . + +- List available profile symlink targets with their numbers: + +`eselect profile list` + +- Set the `/etc/portage/make.profile` symlink by name or number from the `list` command: + +`eselect profile set {{name|number}}` + +- Show the current system profile: + +`eselect profile show` diff --git a/tldr/linux/gcrane-completion b/tldr/linux/gcrane-completion new file mode 100644 index 00000000..6c5b383c --- /dev/null +++ b/tldr/linux/gcrane-completion @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane completion + +> Generate the autocompletion script for gcrane for the specified shell. +> The available shells are `bash`, `fish`, `powershell`, and `zsh`. +> More information: . + +- Generate the autocompletion script for your shell: + +`gcrane completion {{shell_name}}` + +- Disable completion descriptions: + +`grance completion {{shell_name}} --no-descriptions` + +- Load completions in your current shell session (bash/zsh): + +`source <(gcrane completion bash/zsh)>` + +- Load completions in your current shell session (fish): + +`gcrane completion fish | source` + +- Load completions for every new session (bash): + +`gcrane completion bash > /etc/bash_completion.d/gcrane` + +- Load completions for every new session (zsh): + +`gcrane completion zsh > "${fpath[1]}/_gcrane"` + +- Load completions for every new session (fish): + +`gcrane completion fish > ~/.config/fish/completions/gcrane.fish` + +- Display help: + +`gcrane completion {{shell_name}} {{-h|--help}}` diff --git a/tldr/man b/tldr/man index b6fb66fe..29e75629 100644 --- a/tldr/man +++ b/tldr/man @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # man > Format and display manual pages. -> More information: . +> More information: . - Display the man page for a command: diff --git a/tldr/nping b/tldr/nping index d0e183e6..b363769d 100644 --- a/tldr/nping +++ b/tldr/nping @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `nping --interface {{eth0}} {{example.com}}` -- Set the Reserved/Evil bit in sent packets: +- Ping an IP range: -`nping --evil {{example.com}}` +`nping {{10.0.0.1-10}}` diff --git a/tldr/ollama b/tldr/ollama index 63604bba..c4dd94cf 100644 --- a/tldr/ollama +++ b/tldr/ollama @@ -28,9 +28,9 @@ source: https://github.com/tldr-pages/tldr.git `ollama pull {{model}}` -- Upgrade Ollama on Linux: +- List running models: -`curl -fsSL https://ollama.com/install.sh | sh` +`ollama ps` - Delete a model: diff --git a/tldr/osx/cal b/tldr/osx/cal index 0545e281..1d72a6b9 100644 --- a/tldr/osx/cal +++ b/tldr/osx/cal @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `cal` -- Display previous, current and next month: +- Display previous, current, and next month: `cal -3` diff --git a/tldr/osx/gcrane-completion b/tldr/osx/gcrane-completion new file mode 100644 index 00000000..e85f29b7 --- /dev/null +++ b/tldr/osx/gcrane-completion @@ -0,0 +1,42 @@ +--- +syntax: markdown +tags: [tldr, osx] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane completion + +> Generate the autocompletion script for gcrane for the specified shell. +> The available shells are `bash`, `fish`, `powershell`, and `zsh`. +> More information: . + +- Generate the autocompletion script for your shell: + +`gcrane completion {{shell_name}}` + +- Disable completion descriptions: + +`grance completion {{shell_name}} --no-descriptions` + +- Load completions in your current shell session (bash/zsh): + +`source <(gcrane completion bash/zsh)>` + +- Load completions in your current shell session (fish): + +`gcrane completion fish | source` + +- Load completions for every new session (bash): + +`gcrane completion bash > $(brew --prefix)/etc/bash_completion.d/gcrane` + +- Load completions for every new session (zsh): + +`gcrane completion zsh > $(brew --prefix)/share/zsh/site-functions/_gcrane` + +- Load completions for every new session (fish): + +`gcrane completion fish > ~/.config/fish/completions/gcrane.fish` + +- Display help: + +`gcrane completion {{shell_name}} {{-h|--help}}` diff --git a/tldr/windows/comp b/tldr/windows/comp index 71f517af..8105a71e 100644 --- a/tldr/windows/comp +++ b/tldr/windows/comp @@ -21,22 +21,22 @@ source: https://github.com/tldr-pages/tldr.git `comp {{path o\directory1}}\* {{path o\directory2}}\*` -- Display differences in decimal format: +- Display differences in [d]ecimal format: `comp /d {{path o ile1}} {{path o ile2}}` -- Display differences in ASCII format: +- Display differences in [a]SCII format: `comp /a {{path o ile1}} {{path o ile2}}` -- Display line numbers for differences: +- Display [l]ine numbers for differences: `comp /l {{path o ile1}} {{path o ile2}}` -- Compare files case-insensitively: +- Compare files [c]ase-insensitively: `comp /c {{path o ile1}} {{path o ile2}}` - Compare only the first 5 lines of each file: -`comp /n={{5}} {{path o ile1}} {{path o ile2}}` +`comp /n=5 {{path o ile1}} {{path o ile2}}` diff --git a/tldr/windows/gcrane-completion b/tldr/windows/gcrane-completion new file mode 100644 index 00000000..dee95bb4 --- /dev/null +++ b/tldr/windows/gcrane-completion @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, windows] +source: https://github.com/tldr-pages/tldr.git +--- +# gcrane completion + +> Generate the autocompletion script for gcrane for the specified shell. +> The available shells are `bash`, `fish`, `powershell`, and `zsh`. +> More information: . + +- Generate the autocompletion script for your shell: + +`gcrane completion {{shell_name}}` + +- Disable completion descriptions: + +`grance completion {{shell_name}} --no-descriptions` + +- Load completions in your current shell session (powershell): + +`gcrane completion powershell | Out-String | Invoke-Expression` + +- Load completions for every new session (powershell): + +`Add above command to powershell profile` + +- Display help: + +`gcrane completion {{shell_name}} {{-h|--help}}` diff --git a/tldr/windows/tree b/tldr/windows/tree index 8595c927..7899a00a 100644 --- a/tldr/windows/tree +++ b/tldr/windows/tree @@ -16,10 +16,10 @@ source: https://github.com/tldr-pages/tldr.git `tree {{path o\directory}}` -- Display the tree for a directory including files: +- Display the tree for a directory including [f]iles: `tree {{path o\directory}} /f` -- Display the tree using ASCII characters instead of extended characters: +- Display the tree using [a]SCII characters instead of extended characters: `tree {{path o\directory}} /a`