diff --git a/tldr/7zr b/tldr/7zr index 7f5c9778..b3dbba69 100644 --- a/tldr/7zr +++ b/tldr/7zr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # 7zr > File archiver with a high compression ratio. -> Similar to `7z` except that it only supports `.7z` files. +> Similar to `7z` except that it only supports 7z files. > More information: . - [a]rchive a file or directory: diff --git a/tldr/autossh b/tldr/autossh index 2797e539..f7698000 100644 --- a/tldr/autossh +++ b/tldr/autossh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # autossh > Run, monitor and restart SSH connections. -> Auto-reconnects to keep port forwarding tunnels up. Accepts all `ssh` flags. +> Auto-reconnects to keep port forwarding tunnels up. Accepts all SSH flags. > More information: . - Start an SSH session, restarting when the [M]onitoring port fails to return data: @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `autossh -M {{monitor_port}} -L {{local_port}}:localhost:{{remote_port}} {{user}}@{{host}}` -- Fork `autossh` into the background before executing `ssh` and do [N]ot open a remote shell: +- Fork `autossh` into the background before executing SSH and do [N]ot open a remote shell: `autossh -f -M {{monitor_port}} -N "{{ssh_command}}"` @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `autossh -f -M 0 -N -o "ServerAliveInterval 10" -o "ServerAliveCountMax 3" -o ExitOnForwardFailure=yes -L {{local_port}}:localhost:{{remote_port}} {{user}}@{{host}}` -- Run in the background, logging `autossh` debug output and `ssh` verbose output to files: +- Run in the background, logging `autossh` debug output and SSH verbose output to files: `AUTOSSH_DEBUG=1 AUTOSSH_LOGFILE={{path/to/autossh_log_file.log}} autossh -f -M {{monitor_port}} -v -E {{path/to/ssh_log_file.log}} {{ssh_command}}` diff --git a/tldr/avrdude b/tldr/avrdude index b01880c5..1185c2d6 100644 --- a/tldr/avrdude +++ b/tldr/avrdude @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Driver program for Atmel AVR microcontrollers programming. > More information: . -- [r]ead the flash ROM of a AVR microcontroller with a specific [p]art id: +- [r]ead the flash ROM of a AVR microcontroller with a specific [p]art ID: `avrdude -p {{part_no}} -c {{programmer_id}} -U flash:r:{{file.hex}}:i` diff --git a/tldr/az-sshkey b/tldr/az-sshkey index b75e14cb..63087c70 100644 --- a/tldr/az-sshkey +++ b/tldr/az-sshkey @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # az sshkey -> Manage ssh public keys with virtual machines. +> Manage SSH public keys with virtual machines. > Part of `azure-cli` (also known as `az`). > More information: . diff --git a/tldr/az-vm b/tldr/az-vm index 9275f9eb..e6fcbaa8 100644 --- a/tldr/az-vm +++ b/tldr/az-vm @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `az vm list` -- Create a virtual machine using the default Ubuntu image and generate ssh keys: +- Create a virtual machine using the default Ubuntu image and generate SSH keys: `az vm create --resource-group {{rg}} --name {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` diff --git a/tldr/bzegrep b/tldr/bzegrep index 7a89d281..eecbf750 100644 --- a/tldr/bzegrep +++ b/tldr/bzegrep @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `bzegrep --only-matching "{{search_pattern}}" {{path/to/file}}` -- Recursively search files in a `bzip2` compressed `tar` archive for a pattern: +- Recursively search files in a bzip2 compressed tar archive for a pattern: `bzegrep --recursive "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/bzfgrep b/tldr/bzfgrep index 775a0b61..50922adf 100644 --- a/tldr/bzfgrep +++ b/tldr/bzfgrep @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `bzfgrep --only-matching "{{search_string}}" {{path/to/file}}` -- Recursively search files in a `bzip2` compressed `tar` archive for the given list of strings: +- Recursively search files in a bzip2 compressed tar archive for the given list of strings: `bzfgrep --recursive "{{search_string}}" {{path/to/file}}` diff --git a/tldr/bzgrep b/tldr/bzgrep index ce108746..cd1d4b4b 100644 --- a/tldr/bzgrep +++ b/tldr/bzgrep @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `bzgrep --only-matching "{{search_pattern}}" {{path/to/file}}` -- Recursively search files in a `bzip2` compressed `tar` archive for a pattern: +- Recursively search files in a bzip2 compressed tar archive for a pattern: `bzgrep --recursive "{{search_pattern}}" {{path/to/tar/file}}` diff --git a/tldr/cargo-report b/tldr/cargo-report index 3de636ce..75d68898 100644 --- a/tldr/cargo-report +++ b/tldr/cargo-report @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `cargo report {{future-incompatibilities|...}}` -- Display a report with the specified Cargo-generated id: +- Display a report with the specified Cargo-generated ID: `cargo report {{future-incompatibilities|...}} --id {{id}}` diff --git a/tldr/circo b/tldr/circo index 9b607030..8b73060e 100644 --- a/tldr/circo +++ b/tldr/circo @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `circo -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `circo -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `circo -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{digraph {this -> that} }}" | circo -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/colima b/tldr/colima new file mode 100644 index 00000000..175ebed9 --- /dev/null +++ b/tldr/colima @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# colima + +> Container runtimes for macOS and Linux with minimal setup. +> More information: . + +- Start the daemon in the background: + +`colima start` + +- Create a configuration file and use it: + +`colima start --edit` + +- Start and setup containerd (install `nerdctl` to use containerd via `nerdctl`): + +`colima start --runtime containerd` + +- Start with Kubernetes (`kubectl` is required): + +`colima start --kubernetes` + +- Customize CPU count, RAM memory and disk space (in GiB): + +`colima start --cpu {{number}} --memory {{memory}} --disk {{storage_space}}` + +- Use Docker via Colima (Docker is required): + +`colima start` + +- List containers with their information and status: + +`colima list` + +- Show runtime status: + +`colima status` diff --git a/tldr/convert b/tldr/convert index 794d525c..ac72bdc5 100644 --- a/tldr/convert +++ b/tldr/convert @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Part of ImageMagick. > More information: . -- Convert an image from JPG to PNG: +- Convert an image from JPEG to PNG: `convert {{path/to/input_image.jpg}} {{path/to/output_image.png}}` diff --git a/tldr/datashader_cli b/tldr/datashader_cli index a7ac27ba..1458a70f 100644 --- a/tldr/datashader_cli +++ b/tldr/datashader_cli @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Quick visualization of large datasets using CLI based on datashader. > More information: . -- Create a shaded scatter plot of points and save it to a png file and set the background color: +- Create a shaded scatter plot of points and save it to a PNG file and set the background color: `datashader_cli points {{path/to/input.parquet}} --x {{pickup_x}} --y {{pickup_y}} {{path/to/output.png}} --background {{black|white|#rrggbb}}` diff --git a/tldr/dep b/tldr/dep index 933ca209..660761bc 100644 --- a/tldr/dep +++ b/tldr/dep @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `dep rollback` -- Connect to a remote host via ssh: +- Connect to a remote host via SSH: `dep ssh {{hostname}}` diff --git a/tldr/docker b/tldr/docker index 1ff4ed2e..a605c8a6 100644 --- a/tldr/docker +++ b/tldr/docker @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Some subcommands such as `docker run` have their own usage documentation. > More information: . -- List all docker containers (running and stopped): +- List all Docker containers (running and stopped): `docker ps --all` @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `docker {{start|stop}} {{container_name}}` -- Pull an image from a docker registry: +- Pull an image from a Docker registry: `docker pull {{image}}` diff --git a/tldr/docker-build b/tldr/docker-build index 8b677c99..44406ea3 100644 --- a/tldr/docker-build +++ b/tldr/docker-build @@ -8,19 +8,19 @@ source: https://github.com/tldr-pages/tldr.git > Build an image from a Dockerfile. > More information: . -- Build a docker image using the Dockerfile in the current directory: +- Build a Docker image using the Dockerfile in the current directory: `docker build .` -- Build a docker image from a Dockerfile at a specified URL: +- Build a Docker image from a Dockerfile at a specified URL: `docker build {{github.com/creack/docker-firefox}}` -- Build a docker image and tag it: +- Build a Docker image and tag it: `docker build --tag {{name:tag}} .` -- Build a docker image with no build context: +- Build a Docker image with no build context: `docker build --tag {{name:tag}} - < {{Dockerfile}}` @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `docker build --no-cache --tag {{name:tag}} .` -- Build a docker image using a specific Dockerfile: +- Build a Docker image using a specific Dockerfile: `docker build --file {{Dockerfile}} .` diff --git a/tldr/docker-compose b/tldr/docker-compose index 420c95d4..b4eddaf9 100644 --- a/tldr/docker-compose +++ b/tldr/docker-compose @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # docker compose -> Run and manage multi container docker applications. +> Run and manage multi container Docker applications. > More information: . - List all running containers: diff --git a/tldr/docker-container b/tldr/docker-container index 11f6c95c..2a684287 100644 --- a/tldr/docker-container +++ b/tldr/docker-container @@ -32,7 +32,7 @@ source: https://github.com/tldr-pages/tldr.git `docker container inspect {{container_name}}` -- Export a container's filesystem as a `tar` archive: +- Export a container's filesystem as a tar archive: `docker container export {{container_name}}` diff --git a/tldr/docker-login b/tldr/docker-login index 1304b92d..ff2512c5 100644 --- a/tldr/docker-login +++ b/tldr/docker-login @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # docker login -> Log into a docker registry. +> Log into a Docker registry. > More information: . - Interactively log into a registry: diff --git a/tldr/docker-machine b/tldr/docker-machine index efb8ade6..e8c28bc6 100644 --- a/tldr/docker-machine +++ b/tldr/docker-machine @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > Create and manage machines running Docker. > More information: . -- List currently running docker machines: +- List currently running Docker machines: `docker-machine ls` -- Create a new docker machine with specific name: +- Create a new Docker machine with specific name: `docker-machine create {{name}}` diff --git a/tldr/docker-network b/tldr/docker-network index 6e5aef2c..545e0b84 100644 --- a/tldr/docker-network +++ b/tldr/docker-network @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # docker network -> Create and manage docker networks. +> Create and manage Docker networks. > More information: . -- List all available and configured networks on docker daemon: +- List all available and configured networks on Docker daemon: `docker network ls` diff --git a/tldr/docker-ps b/tldr/docker-ps index 25049242..144ce012 100644 --- a/tldr/docker-ps +++ b/tldr/docker-ps @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > List Docker containers. > More information: . -- List currently running docker containers: +- List currently running Docker containers: `docker ps` -- List all docker containers (running and stopped): +- List all Docker containers (running and stopped): `docker ps --all` diff --git a/tldr/docker-save b/tldr/docker-save index 4e682230..923e6b57 100644 --- a/tldr/docker-save +++ b/tldr/docker-save @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > Export Docker images to archive. > More information: . -- Save an image by redirecting `stdout` to a `tar` archive: +- Save an image by redirecting `stdout` to a tar archive: `docker save {{image}}:{{tag}} > {{path/to/file.tar}}` -- Save an image to a `tar` archive: +- Save an image to a tar archive: `docker save --output {{path/to/file.tar}} {{image}}:{{tag}}` diff --git a/tldr/docker-service b/tldr/docker-service index e6f93aad..9d186823 100644 --- a/tldr/docker-service +++ b/tldr/docker-service @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # docker service -> Manage the services on a docker daemon. +> Manage the services on a Docker daemon. > More information: . -- List the services on a docker daemon: +- List the services on a Docker daemon: `docker service ls` diff --git a/tldr/docker-start b/tldr/docker-start index 1a444826..0d78e21c 100644 --- a/tldr/docker-start +++ b/tldr/docker-start @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `docker start` -- Start a docker container: +- Start a Docker container: `docker start {{container}}` diff --git a/tldr/docker-system b/tldr/docker-system index 614d8ee2..ffa597c3 100644 --- a/tldr/docker-system +++ b/tldr/docker-system @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `docker system` -- Show docker disk usage: +- Show Docker disk usage: `docker system df` diff --git a/tldr/dot b/tldr/dot index 38c0dfa7..b7100a6c 100644 --- a/tldr/dot +++ b/tldr/dot @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `dot -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `dot -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `dot -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{digraph {this -> that} }}" | dot -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/duplicity b/tldr/duplicity index 1b507141..10942abe 100644 --- a/tldr/duplicity +++ b/tldr/duplicity @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `duplicity collection-status "file://{{absolute/path/to/backup/directory}}"` -- List the files in a backup stored on a remote machine, via ssh: +- List the files in a backup stored on a remote machine, via SSH: `duplicity list-current-files --time {{YYYY-MM-DD}} scp://{{user@hostname}}/{{path/to/backup/dir}}` diff --git a/tldr/dwebp b/tldr/dwebp index be1aa4f5..6980c1c7 100644 --- a/tldr/dwebp +++ b/tldr/dwebp @@ -9,26 +9,26 @@ source: https://github.com/tldr-pages/tldr.git > Animated WebP files are not supported. > More information: . -- Convert a `webp` file into a `png` file: +- Convert a WebP file into a PNG file: `dwebp {{path/to/input.webp}} -o {{path/to/output.png}}` -- Convert a `webp` file into a specific filetype: +- Convert a WebP file into a specific filetype: `dwebp {{path/to/input.webp}} -bmp|-tiff|-pam|-ppm|-pgm|-yuv -o {{path/to/output}}` -- Convert a `webp` file, using multi-threading if possible: +- Convert a WebP file, using multi-threading if possible: `dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -mt` -- Convert a `webp` file, but also crop and scale at the same time: +- Convert a WebP file, but also crop and scale at the same time: `dwebp {{input.webp}} -o {{output.png}} -crop {{x_pos}} {{y_pos}} {{width}} {{height}} -scale {{width}} {{height}}` -- Convert a `webp` file and flip the output: +- Convert a WebP file and flip the output: `dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -flip` -- Convert a `webp` file and don't use in-loop filtering to speed up the decoding process: +- Convert a WebP file and don't use in-loop filtering to speed up the decoding process: `dwebp {{path/to/input.webp}} -o {{path/to/output.png}} -nofilter` diff --git a/tldr/ect b/tldr/ect index a0b2ca35..7d833ab0 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`, `.jpg`, `.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/fastmod b/tldr/fastmod index 73f018d6..e84a5cb5 100644 --- a/tldr/fastmod +++ b/tldr/fastmod @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `fastmod {{regex}} {{replacement}} --dir {{path/to/directory}} --iglob {{'**/*.{js,json}'}}` -- Replace for an exact string in .js or .json files: +- Replace for an exact string in `.js` or JSON files: `fastmod --fixed-strings {{exact_string}} {{replacement}} --extensions {{json,js}}` diff --git a/tldr/fdp b/tldr/fdp index 2cf23331..02a8585c 100644 --- a/tldr/fdp +++ b/tldr/fdp @@ -9,11 +9,11 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `fdp -T png -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `fdp -T svg -o {{path/to/image.svg}} {{path/to/input.gv}}` diff --git a/tldr/funzip b/tldr/funzip index 16365a01..eb4eca52 100644 --- a/tldr/funzip +++ b/tldr/funzip @@ -8,14 +8,14 @@ source: https://github.com/tldr-pages/tldr.git > Print the content of the first (non-directory) member in an archive without extraction. > More information: . -- Print the content of the first member in a `.zip` archive: +- Print the content of the first member in a Zip archive: `funzip {{path/to/archive.zip}}` -- Print the content in a `.gz` archive: +- Print the content in a gzip archive: `funzip {{path/to/archive.gz}}` -- Decrypt a `.zip` or `.gz` archive and print the content: +- Decrypt a Zip or gzip archive and print the content: `funzip -password {{password}} {{path/to/archive}}` diff --git a/tldr/gcpdiag b/tldr/gcpdiag index 8d413d86..aebdd072 100644 --- a/tldr/gcpdiag +++ b/tldr/gcpdiag @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gcpdiag > Google Cloud Platform troubleshooting and diagnostics tool. -> Run in a docker container or in GCP Cloudshell. +> Run in a Docker container or in GCP Cloudshell. > More information: . - Run `gcpdiag` on your project, returning all rules: diff --git a/tldr/git-archive-file b/tldr/git-archive-file index a5efda76..203648af 100644 --- a/tldr/git-archive-file +++ b/tldr/git-archive-file @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # git archive-file -> Export all the files of the current Git branch into a `zip` archive. +> Export all the files of the current Git branch into a Zip archive. > Part of `git-extras`. > More information: . -- Pack the currently checked out commit into a `zip` archive: +- Pack the currently checked out commit into a Zip archive: `git archive-file` diff --git a/tldr/git-init b/tldr/git-init index 171d9923..55a7ecdd 100644 --- a/tldr/git-init +++ b/tldr/git-init @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `git init --object-format={{sha256}}` -- Initialize a barebones repository, suitable for use as a remote over ssh: +- Initialize a barebones repository, suitable for use as a remote over SSH: `git init --bare` diff --git a/tldr/helm b/tldr/helm index 257e51b7..d41e643c 100644 --- a/tldr/helm +++ b/tldr/helm @@ -33,7 +33,7 @@ source: https://github.com/tldr-pages/tldr.git `helm install {{name}} {{repository_name}}/{{chart_name}}` -- Download helm chart as a `tar` archive: +- Download helm chart as a tar archive: `helm get {{chart_release_name}}` diff --git a/tldr/httpflow b/tldr/httpflow index 363b57a2..25dcad6e 100644 --- a/tldr/httpflow +++ b/tldr/httpflow @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `httpflow -u '{{regular_expression}}'` -- Read packets from pcap format binary file: +- Read packets from PCAP format binary file: `httpflow -r {{out.cap}}` diff --git a/tldr/httpry b/tldr/httpry index 6d33d296..2d5935a3 100644 --- a/tldr/httpry +++ b/tldr/httpry @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `httpry -o {{path/to/file.log}}` -- Listen on a specific interface and save output to a binary pcap format file: +- Listen on a specific interface and save output to a binary PCAP format file: `httpry {{eth0}} -b {{path/to/file.pcap}}` diff --git a/tldr/hub-clone b/tldr/hub-clone index 8f2cd4c0..a6506177 100644 --- a/tldr/hub-clone +++ b/tldr/hub-clone @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Clone an existing repository. > More information: . -- Clone an existing repository to current directory (If run into authentication problem, try full ssh path): +- Clone an existing repository to current directory (If run into authentication problem, try full SSH path): `hub clone {{remote_repository_location}}` diff --git a/tldr/ipaggcreate b/tldr/ipaggcreate index 97260f85..7f15c051 100644 --- a/tldr/ipaggcreate +++ b/tldr/ipaggcreate @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Produce aggregate statistics of TCP/IP dumps. > More information: . -- Count the number of packets sent from each source address appearing in a pcap file: +- Count the number of packets sent from each source address appearing in a PCAP file: `ipaggcreate --src {{path/to/file.pcap}}` @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `ipaggcreate --interface {{eth0}} --length` -- Count the number of bytes sent between each address pair appearing in a pcap file: +- Count the number of bytes sent between each address pair appearing in a PCAP file: `ipaggcreate --address-pairs --bytes {{path/to/file.pcap}}` diff --git a/tldr/ipsumdump b/tldr/ipsumdump index afc9d3a9..7f2b04be 100644 --- a/tldr/ipsumdump +++ b/tldr/ipsumdump @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Summarise TCP/IP dumps into a human and machine readable ASCII format. > More information: . -- Print the source and destination IP addresses of all packets in a pcap file: +- Print the source and destination IP addresses of all packets in a PCAP file: `ipsumdump --src --dst {{path/to/file.pcap}}` @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `ipsumdump --interface {{eth0}} -tsSdDp` -- Print the anonymised source address, anonymised destination address, and IP packet length of all packets in a pcap file: +- Print the anonymised source address, anonymised destination address, and IP packet length of all packets in a PCAP file: `ipsumdump --src --dst --length --anonymize {{path/to/file.pcap}}` diff --git a/tldr/jhat b/tldr/jhat index d3d0d614..15eb1d3f 100644 --- a/tldr/jhat +++ b/tldr/jhat @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `jhat {{dump_file.bin}}` -- Analyze a heap dump, specifying an alternate port for the http server: +- Analyze a heap dump, specifying an alternate port for the HTTP server: `jhat -p {{port}} {{dump_file.bin}}` diff --git a/tldr/kops b/tldr/kops index b3de2b7b..6e8ded4b 100644 --- a/tldr/kops +++ b/tldr/kops @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `kops create cluster -f {{cluster_name.yaml}}` -- Create a new ssh public key: +- Create a new SSH public key: `kops create secret sshpublickey {{key_name}} -i {{~/.ssh/id_rsa.pub}}` diff --git a/tldr/linux/apt-key b/tldr/linux/apt-key index f1c48567..33cd9a21 100644 --- a/tldr/linux/apt-key +++ b/tldr/linux/apt-key @@ -25,6 +25,6 @@ source: https://github.com/tldr-pages/tldr.git `wget -qO - {{https://host.tld/filename.key}} | apt-key add -` -- Add a key from keyserver with only key id: +- Add a key from keyserver with only key ID: `apt-key adv --keyserver {{pgp.mit.edu}} --recv {{KEYID}}` diff --git a/tldr/linux/atool b/tldr/linux/atool index 116de307..6abc05a2 100644 --- a/tldr/linux/atool +++ b/tldr/linux/atool @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage archives of various formats. > More information: . -- List files in a `zip` archive: +- List files in a Zip archive: `atool --list {{path/to/archive.zip}}` @@ -16,10 +16,10 @@ source: https://github.com/tldr-pages/tldr.git `atool --extract {{path/to/archive.tar.gz}}` -- Create a new `7z` archive with two files: +- Create a new 7z archive with two files: `atool --add {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` -- Extract all `zip` and rar archives in the current directory: +- Extract all Zip and rar archives in the current directory: `atool --each --extract {{*.zip *.rar}}` diff --git a/tldr/linux/distrobox-list b/tldr/linux/distrobox-list index 15d066cd..fb1e9ab2 100644 --- a/tldr/linux/distrobox-list +++ b/tldr/linux/distrobox-list @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # distrobox-list > List all Distrobox containers. See also: `tldr distrobox`. -> Distrobox containers are listed separately from the rest of normal podman or Docker containers. +> Distrobox containers are listed separately from the rest of normal Podman or Docker containers. > More information: . - List all Distrobox containers: diff --git a/tldr/linux/dockerd b/tldr/linux/dockerd index 9e711227..fa699c67 100644 --- a/tldr/linux/dockerd +++ b/tldr/linux/dockerd @@ -5,14 +5,14 @@ source: https://github.com/tldr-pages/tldr.git --- # dockerd -> A persistent process to start and manage docker containers. +> A persistent process to start and manage Docker containers. > More information: . -- Run docker daemon: +- Run Docker daemon: `dockerd` -- Run docker daemon and configure it to listen to specific sockets (UNIX and TCP): +- Run Docker daemon and configure it to listen to specific sockets (UNIX and TCP): `dockerd --host unix://{{path/to/tmp.sock}} --host tcp://{{ip}}` diff --git a/tldr/linux/dolphin b/tldr/linux/dolphin index 324ec349..ce72d6ac 100644 --- a/tldr/linux/dolphin +++ b/tldr/linux/dolphin @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `dolphin --split {{path/to/directory1}} {{path/to/directory2}}` -- Launch the daemon (only required to use the DBus interface): +- Launch the daemon (only required to use the D-Bus interface): `dolphin --daemon` diff --git a/tldr/linux/groupmod b/tldr/linux/groupmod index 5b7a403c..de8b13f1 100644 --- a/tldr/linux/groupmod +++ b/tldr/linux/groupmod @@ -13,6 +13,6 @@ source: https://github.com/tldr-pages/tldr.git `sudo groupmod --new-name {{new_group}} {{group_name}}` -- Change the group id: +- Change the group ID: `sudo groupmod --gid {{new_id}} {{group_name}}` diff --git a/tldr/linux/kdialog b/tldr/linux/kdialog index c68783b1..21b0f061 100644 --- a/tldr/linux/kdialog +++ b/tldr/linux/kdialog @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `kdialog --getopenfilename` -- Open a progressbar dialog and print a DBUS reference for communication to `stdout`: +- Open a progressbar dialog and print a D-Bus reference for communication to `stdout`: `kdialog --progressbar "{{message}}"` diff --git a/tldr/linux/lrztar b/tldr/linux/lrztar index 404c31c3..a042da4e 100644 --- a/tldr/linux/lrztar +++ b/tldr/linux/lrztar @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > See also: `tar`, `lrzuntar`, `lrunzip`. > More information: . -- Archive a directory with `tar`, then compress: +- Archive a directory with tar, then compress: `lrztar {{path/to/directory}}` diff --git a/tldr/linux/mksquashfs b/tldr/linux/mksquashfs index 499335f7..23a039e3 100644 --- a/tldr/linux/mksquashfs +++ b/tldr/linux/mksquashfs @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -e {{file|directory1 file|directory2 ...}}` -- Create or append files and directories to a squashfs filesystem, [e]xcluding those ending with `.gz`: +- Create or append files and directories to a squashfs filesystem, [e]xcluding those ending with gzip: `mksquashfs {{path/to/file_or_directory1 path/to/file_or_directory2 ...}} {{filesystem.squashfs}} -wildcards -e "{{*.gz}}"` diff --git a/tldr/linux/nsenter b/tldr/linux/nsenter index 299f704d..aaa0bf43 100644 --- a/tldr/linux/nsenter +++ b/tldr/linux/nsenter @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nsenter > Run a new command in a running process' namespace. -> Particularly useful for docker images or chroot jails. +> Particularly useful for Docker images or chroot jails. > More information: . - Run a specific command using the same namespaces as an existing process: diff --git a/tldr/linux/pidstat b/tldr/linux/pidstat index acbe55d2..7753ac5a 100644 --- a/tldr/linux/pidstat +++ b/tldr/linux/pidstat @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `pidstat -r` -- Show input/output usage per process id: +- Show input/output usage per process ID: `pidstat -d` diff --git a/tldr/linux/pmap b/tldr/linux/pmap index 04ad6ace..9f1f13cf 100644 --- a/tldr/linux/pmap +++ b/tldr/linux/pmap @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Report memory map of a process or processes. > More information: . -- Print memory map for a specific process id (PID): +- Print memory map for a specific process ID (PID): `pmap {{pid}}` diff --git a/tldr/linux/pngcheck b/tldr/linux/pngcheck index 5304f21d..69557c4a 100644 --- a/tldr/linux/pngcheck +++ b/tldr/linux/pngcheck @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pngcheck -> Forensics tool for validating the integrity of PNG based (`.png`, `.jng`, `.mng`) image files. +> Forensics tool for validating the integrity of PNG based (PNG, JNG, MNG) image files. > Can also extract embedded images and text from a file. > More information: . diff --git a/tldr/linux/pw-cat b/tldr/linux/pw-cat index 9505c001..6b06df82 100644 --- a/tldr/linux/pw-cat +++ b/tldr/linux/pw-cat @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pw-cat -> Play and record audio files through pipewire. +> Play and record audio files through PipeWire. > More information: . - Play a WAV file over the default target: diff --git a/tldr/linux/pw-profiler b/tldr/linux/pw-profiler index f46cb971..e1d677b5 100644 --- a/tldr/linux/pw-profiler +++ b/tldr/linux/pw-profiler @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Profile a local or remote instance. > More information: . -- Profile the default instance, logging to `profile.log` (`gnuplot` files and a `.html` file for result visualizing are also generated): +- Profile the default instance, logging to `profile.log` (`gnuplot` files and a HTML file for result visualizing are also generated): `pw-profiler` diff --git a/tldr/linux/pw-record b/tldr/linux/pw-record index 8c24fe12..06ec22a5 100644 --- a/tldr/linux/pw-record +++ b/tldr/linux/pw-record @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pw-record -> Record audio files through pipewire. +> Record audio files through PipeWire. > Shorthand for pw-cat --record. > More information: . diff --git a/tldr/linux/qm-suspend b/tldr/linux/qm-suspend index d641e882..ac7f0a62 100644 --- a/tldr/linux/qm-suspend +++ b/tldr/linux/qm-suspend @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Use `--skiplock` and `--skiplockstorage` flags with caution, as they may lead to data corruption in certain situations. > More information: . -- Suspend a virtual machine by id: +- Suspend a virtual machine by ID: `qm suspend {{vm_id}} {{integer}}` diff --git a/tldr/linux/rexec b/tldr/linux/rexec index 48d15104..917ec94d 100644 --- a/tldr/linux/rexec +++ b/tldr/linux/rexec @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rexec > Execute a command on a remote host. -> Note: Use `rexec` with caution, as it transmits data in plain text. Consider secure alternatives like `ssh` for encrypted communication. +> Note: Use `rexec` with caution, as it transmits data in plain text. Consider secure alternatives like SSH for encrypted communication. > More information: . - Execute a command on a remote [h]ost: diff --git a/tldr/linux/sacct b/tldr/linux/sacct index 19eef79a..9ed4b247 100644 --- a/tldr/linux/sacct +++ b/tldr/linux/sacct @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > Display accounting data from the Slurm service. > More information: . -- Display job id, job name, partition, account, number of allocated cpus, job state, and job exit codes for recent jobs: +- Display job ID, job name, partition, account, number of allocated cpus, job state, and job exit codes for recent jobs: `sacct` -- Display job id, job state, job exit code for recent jobs: +- Display job ID, job state, job exit code for recent jobs: `sacct --brief` diff --git a/tldr/linux/sqfstar b/tldr/linux/sqfstar index 77180879..a22a497d 100644 --- a/tldr/linux/sqfstar +++ b/tldr/linux/sqfstar @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Create a squashfs filesystem from a tar archive. > More information: . -- Create a squashfs filesystem (compressed using `gzip` by default) from an uncompressed `tar` archive: +- Create a squashfs filesystem (compressed using `gzip` by default) from an uncompressed tar archive: `sqfstar {{filesystem.squashfs}} < {{archive.tar}}` -- Create a squashfs filesystem from a `tar` archive compressed with `gzip`, and [comp]ress the filesystem using a specific algorithm: +- Create a squashfs filesystem from a tar archive compressed with `gzip`, and [comp]ress the filesystem using a specific algorithm: `zcat {{archive.tar.gz}} | sqfstar -comp {{gzip|lzo|lz4|xz|zstd|lzma}} {{filesystem.squashfs}}` -- Create a squashfs filesystem from a `tar` archive compressed with `xz`, excluding some of the files: +- Create a squashfs filesystem from a tar archive compressed with `xz`, excluding some of the files: `xzcat {{archive.tar.xz}} | sqfstar {{filesystem.squashfs}} {{file1 file2 ...}}` -- Create a squashfs filesystem from a `tar` archive compressed with `zstd`, excluding files ending with `.gz`: +- Create a squashfs filesystem from a tar archive compressed with `zstd`, excluding files ending with `.gz`: `zstdcat {{archive.tar.zst}} | sqfstar {{filesystem.squashfs}} "{{*.gz}}"` -- Create a squashfs filesystem from a `tar` archive compressed with `lz4`, excluding files matching a regular expression: +- Create a squashfs filesystem from a tar archive compressed with `lz4`, excluding files matching a regular expression: `lz4cat {{archive.tar.lz4}} | sqfstar {{filesystem.squashfs}} -regex "{{regular_expression}}"` diff --git a/tldr/linux/ss b/tldr/linux/ss index 05f21be2..b0f73bf4 100644 --- a/tldr/linux/ss +++ b/tldr/linux/ss @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `ss -lt src :{{8080}}` -- Show all TCP sockets along with processes connected to a remote ssh port: +- Show all TCP sockets along with processes connected to a remote SSH port: `ss -pt dst :{{ssh}}` diff --git a/tldr/linux/tftp b/tldr/linux/tftp index 702b3b75..3c64cdef 100644 --- a/tldr/linux/tftp +++ b/tldr/linux/tftp @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `tftp {{server_ip}} -6 -R {{port}}:{{port}}` -- Set the transfer mode to binary or ascii through the tftp client: +- Set the transfer mode to binary or ASCIi through the tftp client: `mode {{binary|ascii}}` diff --git a/tldr/linux/tlp-stat b/tldr/linux/tlp-stat index cc55aa9d..e8670080 100644 --- a/tldr/linux/tlp-stat +++ b/tldr/linux/tlp-stat @@ -13,10 +13,30 @@ source: https://github.com/tldr-pages/tldr.git `sudo tlp-stat` -- Show battery information: +- Show information about various devices: -`sudo tlp-stat -b` +`sudo tlp-stat --{{battery|disk|processor|graphics|pcie|rfkill|usb}}` + +- Show verbose information about devices that support verbosity: + +`sudo tlp-stat --verbose --{{battery|processor|pcie|usb}}` - Show configuration: -`sudo tlp-stat -c` +`sudo tlp-stat {{-c|--config}}` + +- Monitor [p]ower supply `udev` [ev]ents: + +`sudo tlp-stat {{-P|--pev}}` + +- Show [p]ower [sup]ply diagonistics: + +`sudo tlp-stat --psup` + +- Show [temp]eratures and fan speed: + +`sudo tlp-stat {{-t|--temp}}` + +- Show general system information: + +`sudo tlp-stat {{-s|--system}}` diff --git a/tldr/linux/unzipsfx b/tldr/linux/unzipsfx index c68fcaa6..6b6226d2 100644 --- a/tldr/linux/unzipsfx +++ b/tldr/linux/unzipsfx @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # unzipsfx -> Create a self-extracting compressed binary file by prepending self-extracting stubs on a `zip` file. +> Create a self-extracting compressed binary file by prepending self-extracting stubs on a Zip file. > More information: . -- Create a self-extracting binary file of a `zip` archive: +- Create a self-extracting binary file of a Zip archive: `cat unzipsfx {{path/to/archive.zip}} > {{filename}} && chmod 755 {{filename}}` @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `{{./path/to/binary)}} -c {{path/to/filename}}` -- Print comments on `zip` archive in the self-extracting binary: +- Print comments on Zip archive in the self-extracting binary: `{{./path/to/binary)}} -z` diff --git a/tldr/linux/useradd b/tldr/linux/useradd index 262e1a68..f2b1b458 100644 --- a/tldr/linux/useradd +++ b/tldr/linux/useradd @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo useradd {{username}}` -- Create a new user with the specified user id: +- Create a new user with the specified user ID: `sudo useradd --uid {{id}} {{username}}` diff --git a/tldr/linux/usermod b/tldr/linux/usermod index 33f2b336..202b4f13 100644 --- a/tldr/linux/usermod +++ b/tldr/linux/usermod @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo usermod --login {{new_username}} {{username}}` -- Change a user id: +- Change a user ID: `sudo usermod --uid {{id}} {{username}}` diff --git a/tldr/linux/zip b/tldr/linux/zip index e3910383..3e9a3476 100644 --- a/tldr/linux/zip +++ b/tldr/linux/zip @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zip -> Package and compress (archive) files into `zip` archive. +> Package and compress (archive) files into a Zip archive. > See also: `unzip`. > More information: . @@ -29,7 +29,7 @@ source: https://github.com/tldr-pages/tldr.git `zip -r --encrypt {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` -- Archive files/directories to a multi-part [s]plit `zip` archive (e.g. 3 GB parts): +- Archive files/directories to a multi-part [s]plit Zip archive (e.g. 3 GB parts): `zip -r -s {{3g}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/tldr/magick b/tldr/magick index ff4fd1d3..9354bd7c 100644 --- a/tldr/magick +++ b/tldr/magick @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `magick {{path/to/input_image.jpg}} -resize {{100x100}} {{path/to/output_image.jpg}}` -- Create a GIF out of all JPG images in the current directory: +- Create a GIF out of all JPEG images in the current directory: `magick {{*.jpg}} {{path/to/images.gif}}` @@ -25,6 +25,6 @@ source: https://github.com/tldr-pages/tldr.git `magick -size {{640x480}} pattern:checkerboard {{path/to/checkerboard.png}}` -- Create a PDF file out of all JPG images in the current directory: +- Create a PDF file out of all JPEG images in the current directory: `magick {{*.jpg}} -adjoin {{path/to/file.pdf}}` diff --git a/tldr/neato b/tldr/neato index b16e8bdc..9959152d 100644 --- a/tldr/neato +++ b/tldr/neato @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `neato -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `neato -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `neato -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{graph {this -- that} }}" | neato -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/nix3-registry b/tldr/nix3-registry index 7c199c7c..0f767502 100644 --- a/tldr/nix3-registry +++ b/tldr/nix3-registry @@ -13,11 +13,11 @@ source: https://github.com/tldr-pages/tldr.git `nix registry pin {{nixpkgs}}` -- Pin an entry to the latest version of the branch, or a particular reivision of a github repository: +- Pin an entry to the latest version of the branch, or a particular reivision of a GitHub repository: `nix registry pin {{entry}} {{github:owner/repo/branch_or_revision}}` -- Add a new entry that always points to the latest version of a github repository, updating automatically: +- Add a new entry that always points to the latest version of a GitHub repository, updating automatically: `nix registry add {{entry}} {{github:owner/repo}}` diff --git a/tldr/noti b/tldr/noti index 3c405bd2..bb126f3d 100644 --- a/tldr/noti +++ b/tldr/noti @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Monitor a process and trigger a banner notification. > More information: . -- Display a notification when `tar` finishes compressing files: +- Display a notification when tar finishes compressing files: `noti {{tar -cjf example.tar.bz2 example/}}` diff --git a/tldr/osage b/tldr/osage index 50d29d25..9345579c 100644 --- a/tldr/osage +++ b/tldr/osage @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `osage -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `osage -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `osage -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{digraph {this -> that} }}" | osage -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/osv-scanner b/tldr/osv-scanner index 4b342c9f..f05e39c9 100644 --- a/tldr/osv-scanner +++ b/tldr/osv-scanner @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Scan various mediums for dependencies and matches them against the OSV database. > More information: . -- Scan a docker image: +- Scan a Docker image: `osv-scanner -D {{docker_image_name}}` diff --git a/tldr/packwiz b/tldr/packwiz index 653a5855..4637b145 100644 --- a/tldr/packwiz +++ b/tldr/packwiz @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `packwiz refresh` -- Export as a Modrinth (`.mrpack`) or Curseforge (`.zip`) file: +- Export as a Modrinth (`.mrpack`) or Curseforge (Zip) file: `packwiz {{modrinth|curseforge}} export` diff --git a/tldr/parallel b/tldr/parallel index 2d82b7b8..4d974439 100644 --- a/tldr/parallel +++ b/tldr/parallel @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `ls *.txt | parallel -j4 gzip` -- Convert JPG images to PNG using replacement strings: +- Convert JPEG images to PNG using replacement strings: `parallel convert {} {.}.png ::: *.jpg` diff --git a/tldr/patchwork b/tldr/patchwork index dcff6be8..d01cdaf3 100644 --- a/tldr/patchwork +++ b/tldr/patchwork @@ -9,15 +9,15 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `patchwork -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `patchwork -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `patchwork -T {{format}} -O {{path/to/input.gv}}` diff --git a/tldr/pcapfix b/tldr/pcapfix index 863f6f24..34b969ce 100644 --- a/tldr/pcapfix +++ b/tldr/pcapfix @@ -5,22 +5,22 @@ source: https://github.com/tldr-pages/tldr.git --- # pcapfix -> Repair damaged or corrupted `pcap` and `pcapng` files. +> Repair damaged or corrupted PCAP and PcapNG files. > More information: . -- Repair a `pcap`/`pcapng` file (Note: for `pcap` files, only the first 262144 bytes of each packet are scanned): +- Repair a PCAP/PCapNG file (Note: for PCAP files, only the first 262144 bytes of each packet are scanned): `pcapfix {{path/to/file.pcapng}}` -- Repair an entire `pcap` file: +- Repair an entire PCAP file: `pcapfix --deep-scan {{path/to/file.pcap}}` -- Repair a `pcap`/`pcapng` file and write the repaired file to the specified location: +- Repair a PCAP/PcapNG file and write the repaired file to the specified location: `pcapfix --outfile {{path/to/repaired.pcap}} {{path/to/file.pcap}}` -- Repair a `pcapng` file and treat it as a `pcapng` file, ignoring the automatic recognition: +- Repair a PcapNG file and treat it as a PcapNG file, ignoring the automatic recognition: `pcapfix --pcapng {{path/to/file.pcapng}}` diff --git a/tldr/podman-ps b/tldr/podman-ps index 689b8424..474bf14c 100644 --- a/tldr/podman-ps +++ b/tldr/podman-ps @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > List Podman containers. > More information: . -- List currently running podman containers: +- List currently running Podman containers: `podman ps` -- List all podman containers (running and stopped): +- List all Podman containers (running and stopped): `podman ps --all` diff --git a/tldr/ptargrep b/tldr/ptargrep index dec89afc..a3fcdb86 100644 --- a/tldr/ptargrep +++ b/tldr/ptargrep @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Find regular expression patterns in tar archive files. > More information: . -- Search for a pattern within one or more `tar` archives: +- Search for a pattern within one or more tar archives: `ptargrep "{{search_pattern}}" {{path/to/file1 path/to/file2 ...}}` @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `ptargrep --basename "{{search_pattern}}" {{path/to/file}}` -- Search for a case-insensitive pattern matching within a `tar` archive: +- Search for a case-insensitive pattern matching within a tar archive: `ptargrep --ignore-case "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/pueue-send b/tldr/pueue-send index 42bcdaf8..ef80328f 100644 --- a/tldr/pueue-send +++ b/tldr/pueue-send @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `pueue send {{task_id}} "{{input}}"` -- Send confirmation to a task expecting y/N (e.g. apt, cp): +- Send confirmation to a task expecting y/N (e.g. APT, cp): `pueue send {{task_id}} {{y}}` diff --git a/tldr/pup b/tldr/pup index b71a7fd7..b9ddf71e 100644 --- a/tldr/pup +++ b/tldr/pup @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `cat {{index.html}} | pup '{{tag}}'` -- Filter HTML by id: +- Filter HTML by ID: `cat {{index.html}} | pup '{{div#id}}'` diff --git a/tldr/q b/tldr/q index f8d34984..ce9d67b2 100644 --- a/tldr/q +++ b/tldr/q @@ -5,14 +5,14 @@ source: https://github.com/tldr-pages/tldr.git --- # q -> Execute SQL-like queries on .csv and .tsv files. +> Execute SQL-like queries on CSV and TSV files. > More information: . -- Query `.csv` file by specifying the delimiter as ',': +- Query a CSV file by specifying the delimiter as ',': `q -d',' "SELECT * from {{path/to/file}}"` -- Query `.tsv` file: +- Query a TSV file: `q -t "SELECT * from {{path/to/file}}"` diff --git a/tldr/qcp b/tldr/qcp index 1a4f5684..eba6ea24 100644 --- a/tldr/qcp +++ b/tldr/qcp @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `qcp {{source_file}}` -- Copy multiple JPG files: +- Copy multiple JPEG files: `qcp {{*.jpg}}` diff --git a/tldr/qmv b/tldr/qmv index 4e507075..3cb7d01a 100644 --- a/tldr/qmv +++ b/tldr/qmv @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `qmv {{source_file}}` -- Move multiple JPG files: +- Move multiple JPEG files: `qmv {{*.jpg}}` diff --git a/tldr/rarcrack b/tldr/rarcrack index 9f458fa7..62b774a5 100644 --- a/tldr/rarcrack +++ b/tldr/rarcrack @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # rarcrack -> Password cracker for `rar`, `zip` and `7z` archives. +> Password cracker for RAR, Zip and 7z archives. - Brute force the password for an archive (tries to guess the archive type): diff --git a/tldr/sc_warts2pcap b/tldr/sc_warts2pcap index 2e824e5c..27f76cfa 100644 --- a/tldr/sc_warts2pcap +++ b/tldr/sc_warts2pcap @@ -5,14 +5,14 @@ source: https://github.com/tldr-pages/tldr.git --- # sc_warts2pcap -> Write packets included in `warts` object to a `pcap` file. +> Write packets included in `warts` object to a PCAP file. > This is only possible for tbit, sting and sniff. > More information: . -- Convert the data from several `warts` files into one `pcap` file: +- Convert the data from several `warts` files into one PCAP file: `sc_warts2pcap -o {{path/to/output.pcap}} {{path/to/file1.warts path/to/file2.warts ...}}` -- Convert the data from a `warts` file into a `pcap` file and sort the packets by timestamp: +- Convert the data from a `warts` file into a PCAP file and sort the packets by timestamp: `sc_warts2pcap -s -o {{path/to/output.pcap}} {{path/to/file.warts}}` diff --git a/tldr/scp b/tldr/scp index e0b33155..f1189e3a 100644 --- a/tldr/scp +++ b/tldr/scp @@ -33,7 +33,7 @@ source: https://github.com/tldr-pages/tldr.git `scp {{path/to/local_file}} {{remote_username}}@{{remote_host}}:{{path/to/remote_directory}}` -- Use a specific ssh private key for authentication with the remote host: +- Use a specific SSH private key for authentication with the remote host: `scp -i {{~/.ssh/private_key}} {{path/to/local_file}} {{remote_host}}:{{path/to/remote_file}}` diff --git a/tldr/sfdp b/tldr/sfdp index 41b926b0..5b77ca90 100644 --- a/tldr/sfdp +++ b/tldr/sfdp @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `sfdp -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `sfdp -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `sfdp -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{digraph {this -> that} }}" | sfdp -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/ssh b/tldr/ssh index d014e44d..10cbb733 100644 --- a/tldr/ssh +++ b/tldr/ssh @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `ssh -i {{path/to/key_file}} {{username}}@{{remote_host}}` -- Connect to a remote server using a specific port: +- Connect to a remote server using a specific [p]ort: `ssh {{username}}@{{remote_host}} -p {{2222}}` @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `ssh {{username}}@{{remote_host}} -t {{command}} {{command_arguments}}` -- SSH tunneling: Dynamic port forwarding (SOCKS proxy on `localhost:1080`): +- SSH tunneling: [D]ynamic port forwarding (SOCKS proxy on `localhost:1080`): `ssh -D {{1080}} {{username}}@{{remote_host}}` @@ -33,7 +33,7 @@ source: https://github.com/tldr-pages/tldr.git `ssh -L {{9999}}:{{example.org}}:{{80}} -N -T {{username}}@{{remote_host}}` -- SSH jumping: Connect through a jumphost to a remote server (Multiple jump hops may be specified separated by comma characters): +- SSH [J]umping: Connect through a jumphost to a remote server (Multiple jump hops may be specified separated by comma characters): `ssh -J {{username}}@{{jump_host}} {{username}}@{{remote_host}}` diff --git a/tldr/ssh-add b/tldr/ssh-add index 6a7327c3..febdf88c 100644 --- a/tldr/ssh-add +++ b/tldr/ssh-add @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Ensure that `ssh-agent` is up and running for the keys to be loaded in it. > More information: . -- Add the default ssh keys in `~/.ssh` to the ssh-agent: +- Add the default SSH keys in `~/.ssh` to the ssh-agent: `ssh-add` diff --git a/tldr/ssh-keygen b/tldr/ssh-keygen index 7367ffaa..542ad574 100644 --- a/tldr/ssh-keygen +++ b/tldr/ssh-keygen @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # ssh-keygen -> Generate ssh keys used for authentication, password-less logins, and other things. +> Generate SSH keys used for authentication, password-less logins, and other things. > More information: . - Generate a key interactively: diff --git a/tldr/ssh-keyscan b/tldr/ssh-keyscan index 76662f83..77c0c315 100644 --- a/tldr/ssh-keyscan +++ b/tldr/ssh-keyscan @@ -5,21 +5,21 @@ source: https://github.com/tldr-pages/tldr.git --- # ssh-keyscan -> Get the public ssh keys of remote hosts. +> Get the public SSH keys of remote hosts. > More information: . -- Retrieve all public ssh keys of a remote host: +- Retrieve all public SSH keys of a remote host: `ssh-keyscan {{host}}` -- Retrieve all public ssh keys of a remote host listening on a specific port: +- Retrieve all public SSH keys of a remote host listening on a specific port: `ssh-keyscan -p {{port}} {{host}}` -- Retrieve certain types of public ssh keys of a remote host: +- Retrieve certain types of public SSH keys of a remote host: `ssh-keyscan -t {{rsa,dsa,ecdsa,ed25519}} {{host}}` -- Manually update the ssh known_hosts file with the fingerprint of a given host: +- Manually update the SSH known_hosts file with the fingerprint of a given host: `ssh-keyscan -H {{host}} >> ~/.ssh/known_hosts` diff --git a/tldr/sshpass b/tldr/sshpass index 7096cc37..92b68795 100644 --- a/tldr/sshpass +++ b/tldr/sshpass @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # sshpass -> An ssh password provider. -> It works by creating a TTY, feeding the password into it, and then redirecting `stdin` to the ssh session. +> An SSH password provider. +> It works by creating a TTY, feeding the password into it, and then redirecting `stdin` to the SSH session. > More information: . - Connect to a remote server using a password supplied on a file descriptor (in this case, `stdin`): `sshpass -d {{0}} ssh {{user}}@{{hostname}}` -- Connect to a remote server with the password supplied as an option, and automatically accept unknown ssh keys: +- Connect to a remote server with the password supplied as an option, and automatically accept unknown SSH keys: `sshpass -p {{password}} ssh -o StrictHostKeyChecking=no {{user}}@{{hostname}}` -- Connect to a remote server using the first line of a file as the password, automatically accept unknown ssh keys, and launch a command: +- Connect to a remote server using the first line of a file as the password, automatically accept unknown SSH keys, and launch a command: `sshpass -f {{path/to/file}} ssh -o StrictHostKeyChecking=no {{user}}@{{hostname}} "{{command}}"` diff --git a/tldr/tar b/tldr/tar index 0ddd8639..ac76e23c 100644 --- a/tldr/tar +++ b/tldr/tar @@ -33,7 +33,7 @@ source: https://github.com/tldr-pages/tldr.git `tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}` -- Lis[t] the contents of a `tar` [f]ile [v]erbosely: +- Lis[t] the contents of a tar [f]ile [v]erbosely: `tar tvf {{path/to/source.tar}}` diff --git a/tldr/textql b/tldr/textql index 314be7db..ddc40252 100644 --- a/tldr/textql +++ b/tldr/textql @@ -5,14 +5,14 @@ source: https://github.com/tldr-pages/tldr.git --- # textql -> Execute SQL against structured text like csv or tsv files. +> Execute SQL against structured text like CSV or TSV files. > More information: . -- Print the lines in the specified `.csv` file that match an SQL query to `stdout`: +- Print the lines in the specified CSV file that match an SQL query to `stdout`: `textql -sql "{{SELECT * FROM filename}}" {{path/to/filename.csv}}` -- Query `.tsv` file: +- Query a TSV file: `textql -dlm=tab -sql "{{SELECT * FROM filename}}" {{path/to/filename.tsv}}` diff --git a/tldr/twopi b/tldr/twopi index 7697788f..24b13b53 100644 --- a/tldr/twopi +++ b/tldr/twopi @@ -9,19 +9,19 @@ source: https://github.com/tldr-pages/tldr.git > Layouts: `dot`, `neato`, `twopi`, `circo`, `fdp`, `sfdp`, `osage` & `patchwork`. > More information: . -- Render a `png` image with a filename based on the input filename and output format (uppercase -O): +- Render a PNG image with a filename based on the input filename and output format (uppercase -O): `twopi -T {{png}} -O {{path/to/input.gv}}` -- Render a `svg` image with the specified output filename (lowercase -o): +- Render a SVG image with the specified output filename (lowercase -o): `twopi -T {{svg}} -o {{path/to/image.svg}} {{path/to/input.gv}}` -- Render the output in `ps`, `pdf`, `svg`, `fig`, `png`, `gif`, `jpg`, `json`, or `dot` format: +- Render the output in PS, PDF, SVG, Fig, PNG, GIF, JPEG, JSON, or DOT format: `twopi -T {{format}} -O {{path/to/input.gv}}` -- Render a `gif` image using `stdin` and `stdout`: +- Render a GIF image using `stdin` and `stdout`: `echo "{{digraph {this -> that} }}" | twopi -T {{gif}} > {{path/to/image.gif}}` diff --git a/tldr/ufraw-batch b/tldr/ufraw-batch index 208a4fd5..e3936914 100644 --- a/tldr/ufraw-batch +++ b/tldr/ufraw-batch @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Convert RAW files from cameras into standard image files. > More information: . -- Simply convert RAW files to JPG: +- Simply convert RAW files to JPEG: `ufraw-batch --out-type=jpg {{input_file(s)}}` diff --git a/tldr/ugrep b/tldr/ugrep index ef5cc8a5..8a883d84 100644 --- a/tldr/ugrep +++ b/tldr/ugrep @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `ugrep --fuzzy={{3}} "{{search_pattern}}"` -- Also search compressed files, `zip` and `tar` archives recursively: +- Also search compressed files, Zip and tar archives recursively: `ugrep --decompress "{{search_pattern}}"` diff --git a/tldr/unzip b/tldr/unzip index 666e6c76..a150ba4f 100644 --- a/tldr/unzip +++ b/tldr/unzip @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # unzip -> Extract files/directories from ZIP archives. +> Extract files/directories from Zip archives. > See also: `zip`. > More information: . diff --git a/tldr/virsh b/tldr/virsh index 9fa4a981..3d59ff67 100644 --- a/tldr/virsh +++ b/tldr/virsh @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # virsh -> Manage virsh guest domains. (Note: 'guest_id' can be the id, name or UUID of the guest). +> Manage virsh guest domains. (Note: 'guest_id' can be the ID, name or UUID of the guest). > Some subcommands such as `virsh list` have their own usage documentation. > More information: . diff --git a/tldr/virsh-connect b/tldr/virsh-connect index 22887643..2bcce27e 100644 --- a/tldr/virsh-connect +++ b/tldr/virsh-connect @@ -21,6 +21,6 @@ source: https://github.com/tldr-pages/tldr.git `virsh connect qemu:///session` -- Connect as root to a remote hypervisor using ssh: +- Connect as root to a remote hypervisor using SSH: `virsh connect qemu+ssh://{{user_name@host_name}}/system` diff --git a/tldr/vt b/tldr/vt index ea1f6180..d2ec62d9 100644 --- a/tldr/vt +++ b/tldr/vt @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `vt analysis {{file_id|analysis_id}}` -- Download files in encrypted `.zip` format (requires premium account): +- Download files in encrypted Zip format (requires premium account): `vt download {{file_id}} --output {{path/to/directory}} --zip --zip-password {{password}}` diff --git a/tldr/warp-diag b/tldr/warp-diag index a5992227..86f2fe3e 100644 --- a/tldr/warp-diag +++ b/tldr/warp-diag @@ -9,11 +9,11 @@ source: https://github.com/tldr-pages/tldr.git > See also: `warp-cli`. > More information: . -- Generate a `zip` file with information about the system configuration and the WARP connection: +- Generate a Zip file with information about the system configuration and the WARP connection: `warp-diag` -- Generate a `zip` file with debug information including a timestamp to the output filename: +- Generate a Zip file with debug information including a timestamp to the output filename: `warp-diag --add-ts` diff --git a/tldr/webpack b/tldr/webpack index cced3ea3..c9ac20c1 100644 --- a/tldr/webpack +++ b/tldr/webpack @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `webpack {{app.js}} {{bundle.js}}` -- Load CSS files too from the JavaScript file (this uses the CSS loader for `.css` files): +- Load CSS files too from the JavaScript file (this uses the CSS loader for CSS files): `webpack {{app.js}} {{bundle.js}} --module-bind '{{css=css}}'` diff --git a/tldr/whereis b/tldr/whereis index 87012d2e..899916ec 100644 --- a/tldr/whereis +++ b/tldr/whereis @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Locate the binary, source, and manual page files for a command. > More information: . -- Locate binary, source and man pages for ssh: +- Locate binary, source and man pages for SSH: `whereis {{ssh}}` diff --git a/tldr/windows/logoff b/tldr/windows/logoff index 27316a25..8ea72649 100644 --- a/tldr/windows/logoff +++ b/tldr/windows/logoff @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `logoff` -- Terminate a session by its name or id: +- Terminate a session by its name or ID: `logoff {{session_name|session_id}}` diff --git a/tldr/write b/tldr/write index 47f9d843..045347c7 100644 --- a/tldr/write +++ b/tldr/write @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > Use the `who` command to find out all terminal_ids of all active users active on the system. See also `mesg`. > More information: . -- Send a message to a given user on a given terminal id: +- Send a message to a given user on a given terminal ID: `write {{username}} {{terminal_id}}` diff --git a/tldr/xkill b/tldr/xkill index c24247c0..b8bedd4c 100644 --- a/tldr/xkill +++ b/tldr/xkill @@ -17,6 +17,6 @@ source: https://github.com/tldr-pages/tldr.git `xkill -button any` -- Kill a window with a specific id (use `xwininfo` to get info about windows): +- Kill a window with a specific ID (use `xwininfo` to get info about windows): `xkill -id {{id}}` diff --git a/tldr/xprop b/tldr/xprop index 813d1bb9..663e2a52 100644 --- a/tldr/xprop +++ b/tldr/xprop @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `xprop -font "{{font_name}}" POINT_SIZE` -- Display all the properties of the window with the id 0x200007: +- Display all the properties of the window with the ID 0x200007: `xprop -id {{0x200007}}` diff --git a/tldr/xz b/tldr/xz index 6dbb3367..94e9d5bc 100644 --- a/tldr/xz +++ b/tldr/xz @@ -5,14 +5,14 @@ source: https://github.com/tldr-pages/tldr.git --- # xz -> Compress or decompress `.xz` and `.lzma` files. +> Compress or decompress XZ and LZMA files. > More information: . - Compress a file using xz: `xz {{path/to/file}}` -- Decompress an xz file: +- Decompress an XZ file: `xz --decompress {{path/to/file.xz}}` @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `xz --format=lzma {{path/to/file}}` -- Decompress an lzma file: +- Decompress an LZMA file: `xz --decompress --format=lzma {{path/to/file.lzma}}` diff --git a/tldr/zeek b/tldr/zeek index d30f3658..b4e2f5bd 100644 --- a/tldr/zeek +++ b/tldr/zeek @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `sudo zeek --watchdog --iface {{interface}}` -- Analyze traffic from a `pcap` file: +- Analyze traffic from a PCAP file: `zeek --readfile {{path/to/file.trace}}` diff --git a/tldr/zip b/tldr/zip index ff3fddde..278c97d7 100644 --- a/tldr/zip +++ b/tldr/zip @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zip -> Package and compress (archive) files into `zip` archive. +> Package and compress (archive) files into a Zip archive. > See also: `unzip`. > More information: . @@ -29,7 +29,7 @@ source: https://github.com/tldr-pages/tldr.git `zip -r -e {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` -- Archive files/directories to a multi-part [s]plit `zip` archive (e.g. 3 GB parts): +- Archive files/directories to a multi-part [s]plit Zip archive (e.g. 3 GB parts): `zip -r -s {{3g}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/tldr/zip2john b/tldr/zip2john index 6246e9bf..331429be 100644 --- a/tldr/zip2john +++ b/tldr/zip2john @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zip2john -> Extract password hashes from `zip` archives for use with John the Ripper password cracker. +> Extract password hashes from Zip archives for use with John the Ripper password cracker. > This is a utility tool usually installed as part of the John the Ripper installation. > More information: . diff --git a/tldr/zipalign b/tldr/zipalign index 657c40db..9d271c5f 100644 --- a/tldr/zipalign +++ b/tldr/zipalign @@ -9,10 +9,10 @@ source: https://github.com/tldr-pages/tldr.git > Part of the Android SDK build tools. > More information: . -- Align the data of a ZIP file on 4-byte boundaries: +- Align the data of a Zip file on 4-byte boundaries: `zipalign {{4}} {{path/to/input.zip}} {{path/to/output.zip}}` -- Check that a ZIP file is correctly aligned on 4-byte boundaries and display the results in a verbose manner: +- Check that a Zip file is correctly aligned on 4-byte boundaries and display the results in a verbose manner: `zipalign -v -c {{4}} {{path/to/input.zip}}` diff --git a/tldr/zipgrep b/tldr/zipgrep index e1e41be6..56201e76 100644 --- a/tldr/zipgrep +++ b/tldr/zipgrep @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # zipgrep -> Find patterns in files in a ZIP archive using extended regular expression (supports `?`, `+`, `{}`, `()` and `|`). +> Find patterns in files in a Zip archive using extended regular expression (supports `?`, `+`, `{}`, `()` and `|`). > More information: . -- Search for a pattern within a ZIP archive: +- Search for a pattern within a Zip archive: `zipgrep "{{search_pattern}}" {{path/to/file.zip}}` @@ -20,10 +20,10 @@ source: https://github.com/tldr-pages/tldr.git `zipgrep -v "{{search_pattern}}" {{path/to/file.zip}}` -- Specify files inside a ZIP archive from search: +- Specify files inside a Zip archive from search: `zipgrep "{{search_pattern}}" {{path/to/file.zip}} {{file/to/search1}} {{file/to/search2}}` -- Exclude files inside a ZIP archive from search: +- Exclude files inside a Zip archive from search: `zipgrep "{{search_pattern}}" {{path/to/file.zip}} -x {{file/to/exclude1}} {{file/to/exclude2}}` diff --git a/tldr/zipinfo b/tldr/zipinfo index 03894694..cacafdfa 100644 --- a/tldr/zipinfo +++ b/tldr/zipinfo @@ -5,13 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # zipinfo -> List detailed information about the contents of a `.zip` file. +> List detailed information about the contents of a Zip file. > More information: . -- List all files in a `.zip` file in long format (permissions, ownership, size, and modification date): +- List all files in a Zip file in long format (permissions, ownership, size, and modification date): `zipinfo {{path/to/archive.zip}}` -- List all files in a `.zip` file: +- List all files in a Zip file: `zipinfo -1 {{path/to/archive.zip}}` diff --git a/tldr/zipnote b/tldr/zipnote index 38863c9c..a21b113d 100644 --- a/tldr/zipnote +++ b/tldr/zipnote @@ -5,18 +5,18 @@ source: https://github.com/tldr-pages/tldr.git --- # zipnote -> View, add, or edit a `zip` archive's comments. -> Files can also be renamed in the `zip` archive. +> View, add, or edit a Zip archive's comments. +> Files can also be renamed in the Zip archive. > More information: . -- View the comments on a `zip` archive: +- View the comments on a Zip archive: `zipnote {{path/to/file.zip}}` -- Extract the comments on a `zip` archive to a file: +- Extract the comments on a Zip archive to a file: `zipnote {{path/to/file.zip}} > {{path/to/file.txt}}` -- Add/Update comments in a `zip` archive from a file: +- Add/Update comments in a Zip archive from a file: `zipnote -w {{path/to/file.zip}} < {{path/to/file.txt}}` diff --git a/tldr/znew b/tldr/znew index d1c32c9f..338773a1 100644 --- a/tldr/znew +++ b/tldr/znew @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # znew -> Recompress files from `.Z` to `.gz` format. +> Recompress files from `.Z` to gzip format. > More information: . -- Recompress a file from `.Z` to `.gz` format: +- Recompress a file from `.Z` to gzip format: `znew {{path/to/file1.Z}}` @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `znew -9 {{path/to/file1.Z}}` -- Recompress a file, [K]eeping the `.Z` file if it is smaller than the `.gz` file: +- Recompress a file, [K]eeping the `.Z` file if it is smaller than the gzip file: `znew -K {{path/to/file1.Z}}`