diff --git a/build.zig b/build.zig index e35676c..8ffd764 100644 --- a/build.zig +++ b/build.zig @@ -1,7 +1,7 @@ const std = @import("std"); const Allocator = std.mem.Allocator; -const VERSION = "0.0.12"; +const VERSION = "0.0.13"; fn embedData(b: *std.Build, exe: *std.Build.Step.Compile) !void { var options = b.addOptions(); diff --git a/pages/android/bugreport.md b/pages/android/bugreport.md index ff3910d..60d22ba 100644 --- a/pages/android/bugreport.md +++ b/pages/android/bugreport.md @@ -2,7 +2,7 @@ > Show an Android bug report. > This command can only be used through `adb shell`. -> More information: . +> More information: . - Display a complete bug report of an Android device: diff --git a/pages/android/bugreportz.md b/pages/android/bugreportz.md index 903a5d4..50d11bb 100644 --- a/pages/android/bugreportz.md +++ b/pages/android/bugreportz.md @@ -2,7 +2,7 @@ > Generate a zipped Android bug report. > This command can only be used through `adb shell`. -> More information: . +> More information: . - Generate a complete zipped bug report of an Android device: diff --git a/pages/android/cmd.md b/pages/android/cmd.md index 35215ba..b677563 100644 --- a/pages/android/cmd.md +++ b/pages/android/cmd.md @@ -1,7 +1,7 @@ # cmd > Android service manager. -> More information: . +> More information: . - [l]ist all running services: diff --git a/pages/common/a2ping.md b/pages/common/a2ping.md new file mode 100644 index 0000000..f907ac3 --- /dev/null +++ b/pages/common/a2ping.md @@ -0,0 +1,32 @@ +# a2ping + +> Convert images into EPS or PDF files. +> More information: . + +- Convert an image to PDF (Note: Specifying an output filename is optional): + +`a2ping {{path/to/image.ext}} {{path/to/output.pdf}}` + +- Compress the document using the specified method: + +`a2ping --nocompress {{none|zip|best|flate}} {{path/to/file}}` + +- Scan HiResBoundingBox if present (Note: It Defaults to yes): + +`a2ping --nohires {{path/to/file}}` + +- Allow page content below and left of the origin (Note: It defaults to no): + +`a2ping --below {{path/to/file}}` + +- Pass extra arguments to `gs``: + +`a2ping --gsextra {{arguments}} {{path/to/file}}` + +- Pass extra arguments to external program (i.e pdftops): + +`a2ping --extra {{arguments}} {{path/to/file}}` + +- Display help: + +`a2ping -h` diff --git a/pages/common/accelerate.md b/pages/common/accelerate.md new file mode 100644 index 0000000..740b03f --- /dev/null +++ b/pages/common/accelerate.md @@ -0,0 +1,28 @@ +# Accelerate + +> Accelerate is a library that enables the same PyTorch code to be run across any distributed configuration. +> More information: . + +- Print environment information: + +`accelerate env` + +- Interactively create a configuration file: + +`accelerate config` + +- Print the estimated GPU memory cost of running a huggingface model with different data types: + +`accelerate estimate-memory {{name/model}}` + +- Test an Accelerate configuration file: + +`accelerate test --config_file {{path/to/config.yaml}}` + +- Run a model on CPU with Accelerate: + +`accelerate launch {{path/to/script.py}} {{--cpu}}` + +- Run a model on multi-GPU with Accelerate, with 2 machines: + +`accelerate launch {{path/to/script.py}} --multi_gpu --num_machines {{2}}` diff --git a/pages/common/amass-track.md b/pages/common/amass-track.md deleted file mode 100644 index 1243b4d..0000000 --- a/pages/common/amass-track.md +++ /dev/null @@ -1,12 +0,0 @@ -# amass track - -> Track differences between enumerations of the same domain. -> More information: . - -- Show the difference between the last two enumerations of the specified domain: - -`amass track -dir {{path/to/database_directory}} -d {{domain_name}} -last 2` - -- Show the difference between a certain point in time and the last enumeration: - -`amass track -dir {{path/to/database_directory}} -d {{domain_name}} -since {{01/02 15:04:05 2006 MST}}` diff --git a/pages/common/amass-viz.md b/pages/common/amass-viz.md deleted file mode 100644 index c3dc7b9..0000000 --- a/pages/common/amass-viz.md +++ /dev/null @@ -1,24 +0,0 @@ -# amass viz - -> Visualize gathered information in a network graph. -> More information: . - -- Generate a D3.js visualization based on database data: - -`amass viz -d3 -dir {{path/to/database_directory}}` - -- Generate a DOT file based on database data: - -`amass viz -dot -dir {{path/to/database_directory}}` - -- Generate a Gephi Graph Exchange XML Format (GEXF) file based on database data: - -`amass viz -gexf -dir {{path/to/database_directory}}` - -- Generate a Graphistry JSON file based on database data: - -`amass viz -graphistry -dir {{path/to/database_directory}}` - -- Generate a Maltego CSV file based on database data: - -`amass viz -maltego -dir {{path/to/database_directory}}` diff --git a/pages/common/anytopnm.md b/pages/common/anytopnm.md new file mode 100644 index 0000000..af73819 --- /dev/null +++ b/pages/common/anytopnm.md @@ -0,0 +1,12 @@ +# anytopnm + +> Converts an arbitrary type of image file to common image formats. +> More information: . + +- Convert an input image to PBM, PGM, or PPM format irrespective of the input type: + +`anytopnm {{path/to/input}} > {{path/to/output.pnm}}` + +- Display version: + +`anytopnm -version` diff --git a/pages/common/asciitopgm.md b/pages/common/asciitopgm.md new file mode 100644 index 0000000..245aa2d --- /dev/null +++ b/pages/common/asciitopgm.md @@ -0,0 +1,12 @@ +# asciitopgm + +> Convert ASCII graphics into a PGM file. +> More information: . + +- Read ASCII data as input and produce a PGM image with pixel values that are an approximation of the "brightness" of the ASCII characters: + +`asciitopgm {{path/to/input_file}} > {{path/to/output_file.pgm}}` + +- Display version: + +`asciitopgm -version` diff --git a/pages/common/aws-codeartifact.md b/pages/common/aws-codeartifact.md new file mode 100644 index 0000000..6f82533 --- /dev/null +++ b/pages/common/aws-codeartifact.md @@ -0,0 +1,25 @@ +# aws codeartifact + +> CLI for AWS CodeArtifact. +> CodeArtifact allows you to store artifacts using popular package managers and build tools like Maven, Gradle, npm, Yarn, Twine, pip, NuGet, and SwiftPM. +> More information: . + +- List available domains for your AWS account: + +`aws codeartifact list-domains` + +- Generate credentials for a specific package manager (e.g.: npm, pip): + +`aws codeartifact login --tool {{package_manager}} --domain {{your_domain}} --repository {{repository_name}}` + +- Get the endpoint URL of a CodeArtifact repository: + +`aws codeartifact get-repository-endpoint --domain {{your_domain}} --repository {{repository_name}} --format {{npm|pypi|maven|nuget|generic}}` + +- Show list of all available CodeArtifact commands: + +`aws codeartifact help` + +- Show help for specific EC2 subcommand: + +`aws ec2 {{subcommand}} help` diff --git a/pages/common/aws-s3-rb.md b/pages/common/aws-s3-rb.md new file mode 100644 index 0000000..518258f --- /dev/null +++ b/pages/common/aws-s3-rb.md @@ -0,0 +1,12 @@ +# aws s3 rb + +> Delete an empty S3 bucket. +> More information: . + +- Delete an empty S3 bucket: + +`aws s3 rb s3://{{bucket_name}}` + +- Force delete an S3 bucket and its non-versioned objects (will crash if versioned objects are present): + +`aws s3 rb s3://{{bucket_name}} --force` diff --git a/pages/common/az-account.md b/pages/common/az-account.md index f0c9164..bd70f44 100644 --- a/pages/common/az-account.md +++ b/pages/common/az-account.md @@ -1,7 +1,7 @@ # az account > Manage Azure subscription information. -> Part of `az`, the command-line client for Microsoft Azure. +> Part of `azure-cli` (also known as `az`). > More information: . - Print a list of subscriptions for the logged in account: diff --git a/pages/common/az-acr.md b/pages/common/az-acr.md new file mode 100644 index 0000000..263a09b --- /dev/null +++ b/pages/common/az-acr.md @@ -0,0 +1,37 @@ +# az acr + +> Manage private registries with Azure Container Registries. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- Create a managed container registry: + +`az acr create --name {{registry_name}} --resource-group {{resource_group}} --sku {{sku}}` + +- Login to a registry: + +`az acr login --name {{registry_name}}` + +- Tag a local image for ACR: + +`docker tag {{image_name}} {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Push an image to a registry: + +`docker push {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Pull an image from a registry: + +`docker pull {{registry_name}}.azurecr.io/{{image_name}}:{{tag}}` + +- Delete an image from a registry: + +`az acr repository delete --name {{registry_name}} --repository {{image_name}}:{{tag}}` + +- Delete a managed container registry: + +`az acr delete --name {{registry_name}} --resource-group {{resource_group}} --yes` + +- List images within a registry: + +`az acr repository list --name {{registry_name}} --output table` diff --git a/pages/common/az-advisor.md b/pages/common/az-advisor.md new file mode 100644 index 0000000..9ed3d96 --- /dev/null +++ b/pages/common/az-advisor.md @@ -0,0 +1,25 @@ +# az advisor + +> Manage Azure subscription information. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List Azure Advisor configuration for the entire subscription: + +`az advisor configuration list` + +- Show Azure Advisor configuration for the given subscription or resource group: + +`az advisor configuration show --resource_group {{resource_group}}` + +- List Azure Advisor recommendations: + +`az advisor recommendation list` + +- Enable Azure Advisor recommendations: + +`az advisor recommendation enable --resource_group {{resource_group}}` + +- Disable Azure Advisor recommendations: + +`az advisor recommendation disable --resource_group {{resource_group}}` diff --git a/pages/common/az-aks.md b/pages/common/az-aks.md new file mode 100644 index 0000000..8654855 --- /dev/null +++ b/pages/common/az-aks.md @@ -0,0 +1,25 @@ +# az aks + +> Manage Azure Kubernetes Service (AKS) clusters. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List AKS clusters: + +`az aks list --resource-group {{resource_group}}` + +- Create a new AKS cluster: + +`az aks create --resource-group {{resource_group}} --name {{name}} --node-count {{count}} --node-vm-size {{size}}` + +- Delete an AKS cluster: + +`az aks delete --resource-group {{resource_group}} --name {{name}}` + +- Get the access credentials for an AKS cluster: + +`az aks get-credentials --resource-group {{resource_group}} --name {{name}}` + +- Get the upgrade versions available for an AKS cluster: + +`az aks get-upgrades --resource-group {{resource_group}} --name {{name}}` diff --git a/pages/common/az-apim.md b/pages/common/az-apim.md new file mode 100644 index 0000000..046b9de --- /dev/null +++ b/pages/common/az-apim.md @@ -0,0 +1,25 @@ +# az apim + +> Manage Azure API Management services. +> Part of `azure-cli` (also known as `az`). +> More information: . + +- List API Management services within a resource group: + +`az apim list --resource-group {{resource_group}}` + +- Create an API Management service instance: + +`az apim create --name {{name}} --resource-group {{resource_group}} --publisher-email {{email}} --publisher-name {{name}}` + +- Delete an API Management service: + +`az apim delete --name {{name}} --resource-group {{resource_group}}` + +- Show details of an API Management service instance: + +`az apim show --name {{name}} --resource-group {{resource_group}}` + +- Update an API Management service instance: + +`az apim update --name {{name}} --resource-group {{resource_group}}` diff --git a/pages/common/az-appconfig.md b/pages/common/az-appconfig.md index 18b27de..5d099f8 100644 --- a/pages/common/az-appconfig.md +++ b/pages/common/az-appconfig.md @@ -1,7 +1,7 @@ # az appconfig > Manage App configurations on Azure. -> Part of `az`, the command-line client for Microsoft Azure. +> Part of `azure-cli` (also known as `az`). > More information: . - Create an App Configuration: diff --git a/pages/common/az-bicep.md b/pages/common/az-bicep.md index ec5a226..c7222be 100644 --- a/pages/common/az-bicep.md +++ b/pages/common/az-bicep.md @@ -1,7 +1,7 @@ # az bicep > Bicep CLI command group. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Install Bicep CLI: diff --git a/pages/common/az-config.md b/pages/common/az-config.md index 54bec7b..5de090c 100644 --- a/pages/common/az-config.md +++ b/pages/common/az-config.md @@ -1,7 +1,7 @@ # az config > Manage Azure CLI configuration. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Print all configurations: diff --git a/pages/common/az-devops.md b/pages/common/az-devops.md index b7a3669..507baca 100644 --- a/pages/common/az-devops.md +++ b/pages/common/az-devops.md @@ -1,8 +1,8 @@ # az devops > Manage Azure DevOps organizations. -> Part of `azure-cli`. -> More information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - Set the Personal Access Token (PAT) to login to a particular organization: diff --git a/pages/common/az-feedback.md b/pages/common/az-feedback.md index 9c92ada..a7288b7 100644 --- a/pages/common/az-feedback.md +++ b/pages/common/az-feedback.md @@ -1,7 +1,7 @@ # az feedback > Send feedback to the Azure CLI Team. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Send feedback to the Azure CLI Team: diff --git a/pages/common/az-group.md b/pages/common/az-group.md index a262c83..2a01359 100644 --- a/pages/common/az-group.md +++ b/pages/common/az-group.md @@ -1,8 +1,8 @@ # az group > Manage resource groups and template deployments. -> Part of `azure-cli`. -> More information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - Create a new resource group: diff --git a/pages/common/az-lock.md b/pages/common/az-lock.md index caf574b..472560f 100644 --- a/pages/common/az-lock.md +++ b/pages/common/az-lock.md @@ -1,7 +1,7 @@ # az lock > Manage Azure locks. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a read-only subscription level lock: diff --git a/pages/common/az-login.md b/pages/common/az-login.md index 155d262..c6e9016 100644 --- a/pages/common/az-login.md +++ b/pages/common/az-login.md @@ -1,7 +1,7 @@ # az login > Log in to Azure. -> Part of `az`, the command-line client for Microsoft Azure. +> Part of `azure-cli` (also known as `az`). > More information: . - Log in interactively: diff --git a/pages/common/az-logout.md b/pages/common/az-logout.md index d69db3e..6d02046 100644 --- a/pages/common/az-logout.md +++ b/pages/common/az-logout.md @@ -1,7 +1,7 @@ # az logout > Log out from an Azure subscription. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Log out from the active account: diff --git a/pages/common/az-network.md b/pages/common/az-network.md index 34d255a..8ad2d45 100644 --- a/pages/common/az-network.md +++ b/pages/common/az-network.md @@ -1,7 +1,7 @@ # az network > Manage Azure Network resources. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - List network resources in a region that are used against a subscription quota: diff --git a/pages/common/az-pipelines.md b/pages/common/az-pipelines.md index 2048d11..7da526d 100644 --- a/pages/common/az-pipelines.md +++ b/pages/common/az-pipelines.md @@ -1,7 +1,7 @@ # az pipelines > Manage Azure Pipelines resources. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a new Azure Pipeline (YAML based): diff --git a/pages/common/az-provider.md b/pages/common/az-provider.md index 877d1ee..b9b7c59 100644 --- a/pages/common/az-provider.md +++ b/pages/common/az-provider.md @@ -1,8 +1,8 @@ # az provider > Manage resource providers. -> Part of `azure-cli`. -> More information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - Register a provider: diff --git a/pages/common/az-redis.md b/pages/common/az-redis.md index c590441..19338d7 100644 --- a/pages/common/az-redis.md +++ b/pages/common/az-redis.md @@ -1,8 +1,8 @@ # az redis > Manage Redis caches. -> Part of `azure-cli`. -> More information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - Create a new Redis cache instance: diff --git a/pages/common/az-repos.md b/pages/common/az-repos.md index dd58f36..790b7c6 100644 --- a/pages/common/az-repos.md +++ b/pages/common/az-repos.md @@ -1,8 +1,8 @@ # az repos > Manage Azure DevOps repos. -> Part of `azure-cli`. -> More information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - List all repos in a specific project: diff --git a/pages/common/az-sshkey.md b/pages/common/az-sshkey.md index 25f2a69..4a83735 100644 --- a/pages/common/az-sshkey.md +++ b/pages/common/az-sshkey.md @@ -1,7 +1,7 @@ # az sshkey > Manage ssh public keys with virtual machines. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a new SSH key: diff --git a/pages/common/az-storage-account.md b/pages/common/az-storage-account.md index 8672e5b..495fa36 100644 --- a/pages/common/az-storage-account.md +++ b/pages/common/az-storage-account.md @@ -1,7 +1,7 @@ # az storage account > Manage storage accounts in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create an storage account: diff --git a/pages/common/az-storage-blob.md b/pages/common/az-storage-blob.md index 86f7ea4..5b2ef2f 100644 --- a/pages/common/az-storage-blob.md +++ b/pages/common/az-storage-blob.md @@ -1,7 +1,7 @@ # az storage blob > Manage blob storage containers and objects in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Download a blob to a file path: diff --git a/pages/common/az-storage-container.md b/pages/common/az-storage-container.md index e751451..4526e05 100644 --- a/pages/common/az-storage-container.md +++ b/pages/common/az-storage-container.md @@ -1,7 +1,7 @@ # az storage container > Manage blob storage containers in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a container in a storage account: diff --git a/pages/common/az-storage-entity.md b/pages/common/az-storage-entity.md index 335fd76..c9327d5 100644 --- a/pages/common/az-storage-entity.md +++ b/pages/common/az-storage-entity.md @@ -1,7 +1,7 @@ # az storage entity > Manage Azure Table storage entities. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Insert an entity into a table: diff --git a/pages/common/az-storage-queue.md b/pages/common/az-storage-queue.md index e9fc6d4..ca75291 100644 --- a/pages/common/az-storage-queue.md +++ b/pages/common/az-storage-queue.md @@ -1,7 +1,7 @@ # az storage queue > Manage storage queues in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a queue: diff --git a/pages/common/az-storage-table.md b/pages/common/az-storage-table.md index 57b7ae1..a93faeb 100644 --- a/pages/common/az-storage-table.md +++ b/pages/common/az-storage-table.md @@ -1,7 +1,7 @@ # az storage table > Manage NoSQL key-value storage in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a new table in the storage account: diff --git a/pages/common/az-storage.md b/pages/common/az-storage.md index 3350501..52ab8c6 100644 --- a/pages/common/az-storage.md +++ b/pages/common/az-storage.md @@ -1,25 +1,25 @@ # az storage > Manage Azure Cloud Storage resources. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a storage account: -`az storage account create -g {{group_name}} -n {{account_name}} -l {{location}} --sku {{account_sku}}` +`az storage account create --resource-group {{group_name}} --name {{account_name}} -l {{location}} --sku {{account_sku}}` - List all storage accounts in a resource group: -`az storage account list -g {{group_name}}` +`az storage account list --resource-group {{group_name}}` - List the access keys for a storage account: -`az storage account keys list -g {{group_name}} -n {{account_name}}` +`az storage account keys list --resource-group {{group_name}} --name {{account_name}}` - Delete a storage account: -`az storage account delete -g {{group_name}} -n {{account_name}}` +`az storage account delete --resource-group {{group_name}} --name {{account_name}}` - Update the minimum tls version setting for a storage account: -`az storage account update --min-tls-version TLS1_2 -g {{group_name}} -n {{account_name}}` +`az storage account update --min-tls-version {{TLS1_0|TLS1_1|TLS1_2}} --resource-group {{group_name}} --name {{account_name}}` diff --git a/pages/common/az-tag.md b/pages/common/az-tag.md index 3e28d01..2a1d64d 100644 --- a/pages/common/az-tag.md +++ b/pages/common/az-tag.md @@ -1,7 +1,7 @@ # az tag > Manage tags on a resource. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Create a tag value: diff --git a/pages/common/az-term.md b/pages/common/az-term.md index 97010d4..30df829 100644 --- a/pages/common/az-term.md +++ b/pages/common/az-term.md @@ -1,7 +1,7 @@ # az term > Manage marketplace agreement with marketplaceordering. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - Print marketplace terms: diff --git a/pages/common/az-upgrade.md b/pages/common/az-upgrade.md index 02be2ca..0bab123 100644 --- a/pages/common/az-upgrade.md +++ b/pages/common/az-upgrade.md @@ -1,7 +1,7 @@ # az upgrade > Upgrade Azure CLI and Extensions. -> Part of `az`, the command-line client for Microsoft Azure. +> Part of `azure-cli` (also known as `az`). > More information: . - Upgrade Azure CLI: diff --git a/pages/common/az-version.md b/pages/common/az-version.md index c28c0ec..366ceb9 100644 --- a/pages/common/az-version.md +++ b/pages/common/az-version.md @@ -1,7 +1,7 @@ # az version > Shows the current version of Azure CLI modules and extensions. -> Part of `az`, the command-line client for Microsoft Azure. +> Part of `azure-cli` (also known as `az`). > More information: . - Show the current version of Azure CLI modules and extensions in JSON format: diff --git a/pages/common/az-vm.md b/pages/common/az-vm.md index 97736fe..686f66f 100644 --- a/pages/common/az-vm.md +++ b/pages/common/az-vm.md @@ -1,7 +1,7 @@ # az vm > Manage virtual machines in Azure. -> Part of `azure-cli`. +> Part of `azure-cli` (also known as `az`). > More information: . - List details of available Virtual Machines: diff --git a/pages/common/az-webapp.md b/pages/common/az-webapp.md index 3f27c79..3c85f83 100644 --- a/pages/common/az-webapp.md +++ b/pages/common/az-webapp.md @@ -1,8 +1,8 @@ # az webapp > Manage Web Applications hosted in Azure Cloud Services. -> Part of `azure-cli`. -> Mode information: . +> Part of `azure-cli` (also known as `az`). +> More information: . - List available runtimes for a web application: diff --git a/pages/common/azure-cli.md b/pages/common/azure-cli.md new file mode 100644 index 0000000..164d345 --- /dev/null +++ b/pages/common/azure-cli.md @@ -0,0 +1,8 @@ +# azure-cli + +> This command is an alias of `az`. +> More information: . + +- View documentation for the original command: + +`tldr az` diff --git a/pages/common/bioradtopgm.md b/pages/common/bioradtopgm.md new file mode 100644 index 0000000..a29dd71 --- /dev/null +++ b/pages/common/bioradtopgm.md @@ -0,0 +1,16 @@ +# bioradtopgm + +> Convert a Biorad confocal file into a PGM file. +> More information: . + +- Read a Biorad confocal file and store the n'th image contained in it to as a PGM file: + +`bioradtopgm -{{n}} {{path/to/file.pic}} > {{path/to/file.pgm}}` + +- Read a Biorad confocal file and print the number of images it contains: + +`bioradtopgm {{path/to/file.pic}}` + +- Display version: + +`bioradtopgm -version` diff --git a/pages/common/bmptopnm.md b/pages/common/bmptopnm.md new file mode 100644 index 0000000..2224cee --- /dev/null +++ b/pages/common/bmptopnm.md @@ -0,0 +1,16 @@ +# bmptopnm + +> Convert a BMP file into a PBM, PGM, or PNM image. +> More information: . + +- Generate the PBM, PGM, or PNM image as output, for Windows or OS/2 BMP file as input: + +`bmptopnm {{path/to/file.bmp}}` + +- Report contents of the BMP header to `stderr`: + +`bmptopnm -verbose {{path/to/file.bmp}}` + +- Display version: + +`bmptopnm -version` diff --git a/pages/common/brew-autoremove.md b/pages/common/brew-autoremove.md new file mode 100644 index 0000000..86c2ec7 --- /dev/null +++ b/pages/common/brew-autoremove.md @@ -0,0 +1,12 @@ +# brew autoremove + +> Remove unused formulae previously installed as dependencies. +> More information: . + +- Remove all unused formulae: + +`brew autoremove` + +- Print what would be removed, but don't actually remove anything: + +`brew autoremove --dry-run` diff --git a/pages/common/brew-cask.md b/pages/common/brew-cask.md deleted file mode 100644 index ad1ed22..0000000 --- a/pages/common/brew-cask.md +++ /dev/null @@ -1,37 +0,0 @@ -# brew --cask - -> CLI workflow for the administration of macOS applications distributed as binaries. -> This command was previously called `brew cask`, it has been deprecated in favor of the `brew --cask` flag. -> More information: . - -- Search for formulas and casks: - -`brew search {{text}}` - -- Install a cask: - -`brew install --cask {{cask_name}}` - -- List all installed casks: - -`brew list --cask` - -- List installed casks that have newer versions available: - -`brew outdated --cask` - -- Upgrade an installed cask (if no cask name is given, all installed casks are upgraded): - -`brew upgrade --cask {{cask_name}}` - -- Uninstall a cask: - -`brew uninstall --cask {{cask_name}}` - -- Uninstall a cask and remove related settings and files: - -`brew zap --cask {{cask_name}}` - -- Display information about a given cask: - -`brew info --cask {{cask_name}}` diff --git a/pages/common/brew-install.md b/pages/common/brew-install.md new file mode 100644 index 0000000..cf715ed --- /dev/null +++ b/pages/common/brew-install.md @@ -0,0 +1,16 @@ +# brew install + +> Install a Homebrew formula or cask. +> More information: . + +- Install a formula/cask: + +`brew install {{formula|cask}}` + +- Build and install a formula from source (dependencies will still be installed from bottles): + +`brew install --build-from-source {{formula}}` + +- Download the manifest, print what would be installed but don't actually install anything: + +`brew install --dry-run {{formula|cask}}` diff --git a/pages/common/brew-list.md b/pages/common/brew-list.md new file mode 100644 index 0000000..9b7e48b --- /dev/null +++ b/pages/common/brew-list.md @@ -0,0 +1,24 @@ +# brew list + +> List installed formulae/casks or their files. +> More information: . + +- List all installed formulae and casks: + +`brew list` + +- List files belonging to an installed formula: + +`brew list {{formula}}` + +- List artifacts of a cask: + +`brew list {{cask}}` + +- List only formulae: + +`brew list --formula` + +- List only casks: + +`brew list --cask` diff --git a/pages/common/brew-outdated.md b/pages/common/brew-outdated.md new file mode 100644 index 0000000..88749f6 --- /dev/null +++ b/pages/common/brew-outdated.md @@ -0,0 +1,17 @@ +# brew outdated + +> List outdated casks and formulae. +> To upgrade everything, use `brew upgrade`. +> More information: . + +- List all outdated casks and formulae: + +`brew outdated` + +- List only outdated formulae: + +`brew outdated --formula` + +- List only outdated casks: + +`brew outdated --cask` diff --git a/pages/common/brew-search.md b/pages/common/brew-search.md new file mode 100644 index 0000000..253c8ed --- /dev/null +++ b/pages/common/brew-search.md @@ -0,0 +1,24 @@ +# brew search + +> Search for casks and formulae. +> More information: . + +- Search for casks and formulae using a keyword: + +`brew search {{keyword}}` + +- Search for casks and formulae using a regular expression: + +`brew search /{{regular_expression}}/` + +- Enable searching through descriptions: + +`brew search --desc {{keyword}}` + +- Only search for formulae: + +`brew search --formula {{keyword}}` + +- Only search for casks: + +`brew search --cask {{keyword}}` diff --git a/pages/common/brew-uninstall.md b/pages/common/brew-uninstall.md new file mode 100644 index 0000000..5cabecf --- /dev/null +++ b/pages/common/brew-uninstall.md @@ -0,0 +1,13 @@ +# brew uninstall + +> Uninstall a Homebrew formula/cask. +> Use `brew autoremove` to remove unused dependencies afterwards. +> More information: . + +- Uninstall a formula/cask: + +`brew uninstall {{formula|cask}}` + +- Uninstall a cask and remove all associated files: + +`brew uninstall --zap {{cask}}` diff --git a/pages/common/brew-update.md b/pages/common/brew-update.md new file mode 100644 index 0000000..2aec460 --- /dev/null +++ b/pages/common/brew-update.md @@ -0,0 +1,9 @@ +# brew update + +> Fetch the newest version of Homebrew and all formulae from GitHub using `git` and perform any necessary migrations. +> To upgrade all installed formulae, use `brew upgrade`. +> More information: . + +- Fetch the newest version of Homebrew and all formulae: + +`brew update` diff --git a/pages/common/brew-upgrade.md b/pages/common/brew-upgrade.md new file mode 100644 index 0000000..a667301 --- /dev/null +++ b/pages/common/brew-upgrade.md @@ -0,0 +1,16 @@ +# brew upgrade + +> Upgrade outdated formulae and casks. +> More information: . + +- Upgrade all outdated casks and formulae: + +`brew upgrade` + +- Upgrade a specific formula/cask: + +`brew upgrade {{formula|cask}}` + +- Print what would be upgraded, but don't actually upgrade anything: + +`brew upgrade --dry-run` diff --git a/pages/common/brew.md b/pages/common/brew.md index 4922abf..1f1b34c 100644 --- a/pages/common/brew.md +++ b/pages/common/brew.md @@ -1,7 +1,8 @@ # brew -> Package manager for macOS and Linux. -> More information: . +> Homebrew - a package manager for macOS and Linux. +> Some subcommands such as `install` have their own usage documentation. +> More information: . - Install the latest stable version of a formula or cask (use `--devel` for development versions): @@ -23,7 +24,7 @@ `brew outdated` -- Search for available formulae (i.e. packages) and casks (i.e. native packages): +- Search for available formulae (i.e. packages) and casks (i.e. native macOS `.app` packages): `brew search {{text}}` diff --git a/pages/common/brushtopbm.md b/pages/common/brushtopbm.md new file mode 100644 index 0000000..0896fda --- /dev/null +++ b/pages/common/brushtopbm.md @@ -0,0 +1,12 @@ +# brushtopbm + +> Convert a Xerox doodle brush file into a PBM image. +> More information: . + +- Generate a PBM file as output for a Xerox doodle brush file as input: + +`brushtopbm {{path/to/file.brush}}` + +- Display version: + +`brushtopbm -version` diff --git a/pages/common/cadaver.md b/pages/common/cadaver.md new file mode 100644 index 0000000..62da170 --- /dev/null +++ b/pages/common/cadaver.md @@ -0,0 +1,16 @@ +# cadaver + +> WebDAV client for Unix. +> More information: . + +- Connect to the server , open the root collection: + +`cadaver {{http://dav.example.com/}}` + +- Connect to a server using a specific port and open the collection `/foo/bar/`: + +`cadaver {{http://dav.example.com:8022/foo/bar/}}` + +- Connect to a server using SSL: + +`cadaver {{https://davs.example.com/}}` diff --git a/pages/common/cargo-add.md b/pages/common/cargo-add.md index 021d065..275f36b 100644 --- a/pages/common/cargo-add.md +++ b/pages/common/cargo-add.md @@ -1,6 +1,6 @@ # cargo add -> Add dependencies to a Rust project's `Cargo.toml` file. +> Add dependencies to a Rust project's `Cargo.toml` manifest. > More information: . - Add the latest version of a dependency to the current project: @@ -21,7 +21,7 @@ - Add a local crate as a dependency: -`cargo add --path {{path/to/crate}}` +`cargo add --path {{path/to/crate_directory}}` - Add a development or build dependency: diff --git a/pages/common/cargo-bench.md b/pages/common/cargo-bench.md new file mode 100644 index 0000000..ed41567 --- /dev/null +++ b/pages/common/cargo-bench.md @@ -0,0 +1,36 @@ +# cargo bench + +> Compile and execute benchmarks. +> More information: . + +- Execute all benchmarks of a package: + +`cargo bench` + +- Don't stop when a benchmark fails: + +`cargo bench --no-fail-fast` + +- Compile, but don’t run benchmarks: + +`cargo bench --no-run` + +- Benchmark the specified benchmark: + +`cargo bench --bench {{benchmark}}` + +- Benchmark with the given profile (default: `bench`): + +`cargo bench --profile {{profile}}` + +- Benchmark all example targets: + +`cargo bench --examples` + +- Benchmark all binary targets: + +`cargo bench --bins` + +- Benchmark the package’s library: + +`cargo bench --lib` diff --git a/pages/common/cargo-clean.md b/pages/common/cargo-clean.md new file mode 100644 index 0000000..1500c39 --- /dev/null +++ b/pages/common/cargo-clean.md @@ -0,0 +1,20 @@ +# cargo clean + +> Remove generated artifacts in the `target` directory. +> More information: . + +- Remove the entire `target` directory: + +`cargo clean` + +- Remove documentation artifacts (the `target/doc` directory): + +`cargo clean --doc` + +- Remove release artifacts (the `target/release` directory): + +`cargo clean --release` + +- Remove artifacts in the directory of the given profile (in this case, `target/debug`): + +`cargo clean --profile {{dev}}` diff --git a/pages/common/cargo-doc.md b/pages/common/cargo-doc.md index 99e2443..1ad3e43 100644 --- a/pages/common/cargo-doc.md +++ b/pages/common/cargo-doc.md @@ -1,20 +1,20 @@ # cargo doc -> Build and view Rust package documentation offline. +> Build the documentation of Rust packages. > More information: . -- Build and view the default package documentation in the browser: +- Build the documentation for the current project and all dependencies: -`cargo doc --open` +`cargo doc` -- Build documentation without accessing the network: +- Do not build documentation for dependencies: -`cargo doc --offline` +`cargo doc --no-deps` -- View a particular package's documentation: +- Build and open the documentation in a browser: -`cargo doc --open --package {{package}}` +`cargo doc --open` -- View a particular package's documentation offline: +- Build and view the documentation of a particular package: -`cargo doc --open --offline --package {{package}}` +`cargo doc --open --package {{package}}` diff --git a/pages/common/cargo-fetch.md b/pages/common/cargo-fetch.md new file mode 100644 index 0000000..fd77020 --- /dev/null +++ b/pages/common/cargo-fetch.md @@ -0,0 +1,12 @@ +# cargo fetch + +> Fetch dependencies of a package from the network. +> More information: . + +- Fetch dependencies specified in `Cargo.lock` (for all targets): + +`cargo fetch` + +- Fetch dependencies for the specified target: + +`cargo fetch --target {{target_triple}}` diff --git a/pages/common/cargo-fix.md b/pages/common/cargo-fix.md new file mode 100644 index 0000000..6f8da65 --- /dev/null +++ b/pages/common/cargo-fix.md @@ -0,0 +1,28 @@ +# cargo fix + +> Automatically fix lint warnings reported by `rustc`. +> More information: . + +- Fix code even if it already has compiler errors: + +`cargo fix --broken-code` + +- Fix code even if the working directory has changes: + +`cargo fix --allow-dirty` + +- Migrate a package to the next Rust edition: + +`cargo fix --edition` + +- Fix the package’s library: + +`cargo fix --lib` + +- Fix the specified integration test: + +`cargo fix --test {{name}}` + +- Fix all members in the workspace: + +`cargo fix --workspace` diff --git a/pages/common/cargo-fmt.md b/pages/common/cargo-fmt.md new file mode 100644 index 0000000..478eb12 --- /dev/null +++ b/pages/common/cargo-fmt.md @@ -0,0 +1,16 @@ +# cargo fmt + +> Run `rustfmt` on all source files in a Rust project. +> More information: . + +- Format all source files: + +`cargo fmt` + +- Check for formatting errors without writing to the files: + +`cargo fmt --check` + +- Pass arguments to each `rustfmt` call: + +`cargo fmt -- {{rustfmt_args}}` diff --git a/pages/common/cargo-generate-lockfile.md b/pages/common/cargo-generate-lockfile.md new file mode 100644 index 0000000..2f6c8b4 --- /dev/null +++ b/pages/common/cargo-generate-lockfile.md @@ -0,0 +1,9 @@ +# cargo generate-lockfile + +> Generate the `Cargo.lock` file for the current package. Similar to `cargo update`, but has less options. +> If the lockfile already exists it will be rebuilt with latest version of every package. +> More information: . + +- Generate a `Cargo.lock` file with the latest version of every package: + +`cargo generate-lockfile` diff --git a/pages/common/cargo-install.md b/pages/common/cargo-install.md new file mode 100644 index 0000000..022dd83 --- /dev/null +++ b/pages/common/cargo-install.md @@ -0,0 +1,20 @@ +# cargo install + +> Build and install a Rust binary. +> More information: . + +- Install a package from (the version is optional - latest by default): + +`cargo install {{package}}@{{version}}` + +- Install a package from the specified Git repository: + +`cargo install --git {{repo_url}}` + +- Build from the specified branch/tag/commit when installing from a Git repository: + +`cargo install --git {{repo_url}} --{{branch|tag|rev}} {{branch_name|tag|commit_hash}}` + +- List all installed packages and their versions: + +`cargo install --list` diff --git a/pages/common/cargo-locate-project.md b/pages/common/cargo-locate-project.md new file mode 100644 index 0000000..edd359b --- /dev/null +++ b/pages/common/cargo-locate-project.md @@ -0,0 +1,17 @@ +# cargo locate-project + +> Print the full path to the `Cargo.toml` manifest of the current project. +> If the project is part of a workspace, the manifest of the project is shown, rather than that of the workspace. +> More information: . + +- Print the JSON object to `stdout` with full path to the `Cargo.toml` manifest: + +`cargo locate-project` + +- Print the project path in the specified format: + +`cargo locate-project --message-format {{plain|json}}` + +- Print the `Cargo.toml` manifest located at the root of the workspace as opposed to the current workspace member: + +`cargo locate-project --workspace` diff --git a/pages/common/cargo-login.md b/pages/common/cargo-login.md new file mode 100644 index 0000000..6dae761 --- /dev/null +++ b/pages/common/cargo-login.md @@ -0,0 +1,13 @@ +# cargo login + +> Save an API token from the registry locally. +> The token is used to authenticate to a package registry. You can remove it using `cargo logout`. +> More information: . + +- Add an API token to the local credential storage (located in `$CARGO_HOME/credentials.toml`): + +`cargo login` + +- Specify the name of the registry to use (registry names can be defined in the config - the default is ): + +`cargo login --registry {{name}}` diff --git a/pages/common/cargo-logout.md b/pages/common/cargo-logout.md new file mode 100644 index 0000000..fb57178 --- /dev/null +++ b/pages/common/cargo-logout.md @@ -0,0 +1,13 @@ +# cargo logout + +> Remove an API token from the registry locally. +> The token is used to authenticate to a package registry. You can add it back using `cargo login`. +> More information: . + +- Remove an API token from the local credential storage (located in `$CARGO_HOME/credentials.toml`): + +`cargo logout` + +- Specify the name of the registry to use (registry names can be defined in the config - the default is ): + +`cargo logout --registry {{name}}` diff --git a/pages/common/cargo-metadata.md b/pages/common/cargo-metadata.md new file mode 100644 index 0000000..09bd068 --- /dev/null +++ b/pages/common/cargo-metadata.md @@ -0,0 +1,21 @@ +# cargo metadata + +> Output the workspace members and resolved dependencies of current package as JSON. +> Note: The output format is subject to change in future versions of Cargo. +> More information: . + +- Print the workspace members and resolved dependencies of the current package: + +`cargo metadata` + +- Print only the workspace members and do not fetch dependencies: + +`cargo metadata --no-deps` + +- Print metadata in a specific format based on the specified version: + +`cargo metadata --format-version {{version}}` + +- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: the `packages` array will still include the dependencies for all targets): + +`cargo metadata --filter-platform {{target_triple}}` diff --git a/pages/common/cargo-owner.md b/pages/common/cargo-owner.md new file mode 100644 index 0000000..7b085e2 --- /dev/null +++ b/pages/common/cargo-owner.md @@ -0,0 +1,20 @@ +# cargo owner + +> Manage the owners of a crate on the registry. +> More information: . + +- Invite the given user or team as an owner: + +`cargo owner --add {{username|github:org_name:team_name}} {{crate}}` + +- Remove the given user or team as an owner: + +`cargo owner --remove {{username|github:org_name:team_name}} {{crate}}` + +- List owners of a crate: + +`cargo owner --list {{crate}}` + +- Specify the name of the registry to use (registry names can be defined in the config - the default is ): + +`cargo owner --registry {{name}}` diff --git a/pages/common/cargo-package.md b/pages/common/cargo-package.md new file mode 100644 index 0000000..a0f6ccf --- /dev/null +++ b/pages/common/cargo-package.md @@ -0,0 +1,13 @@ +# cargo package + +> Assemble a local package into a distributable tarball (a `.crate` file). +> Similar to `cargo publish --dry-run`, but has more options. +> More information: . + +- Perform checks and create a `.crate` file (equivalent of `cargo publish --dry-run`): + +`cargo package` + +- Display what files would be included in the tarball without actually creating it: + +`cargo package --list` diff --git a/pages/common/cargo-pkgid.md b/pages/common/cargo-pkgid.md new file mode 100644 index 0000000..1ac0e96 --- /dev/null +++ b/pages/common/cargo-pkgid.md @@ -0,0 +1,12 @@ +# cargo pkgid + +> Print the fully qualified package ID specifier for a package or dependency in the current workspace. +> More information: . + +- Print the fully qualified package specification for the current project: + +`cargo pkgid` + +- Print the fully qualified package specification for the specified package: + +`cargo pkgid {{partial_pkgspec}}` diff --git a/pages/common/cargo-publish.md b/pages/common/cargo-publish.md new file mode 100644 index 0000000..2a504f1 --- /dev/null +++ b/pages/common/cargo-publish.md @@ -0,0 +1,17 @@ +# cargo publish + +> Upload a package to a registry. +> Note: you have to add an authentication token using `cargo login` before publishing a package. +> More information: . + +- Perform checks, create a `.crate` file and upload it to the registry: + +`cargo publish` + +- Perform checks, create a `.crate` file but don't upload it (equivalent of `cargo package`): + +`cargo publish --dry-run` + +- Specify the name of the registry to use (registry names can be defined in the config - the default is ): + +`cargo publish --registry {{name}}` diff --git a/pages/common/cargo-remove.md b/pages/common/cargo-remove.md new file mode 100644 index 0000000..52ef503 --- /dev/null +++ b/pages/common/cargo-remove.md @@ -0,0 +1,16 @@ +# cargo remove + +> Remove dependencies from a Rust project's `Cargo.toml` manifest. +> More information: . + +- Remove a dependency from the current project: + +`cargo remove {{dependency}}` + +- Remove a development or build dependency: + +`cargo remove --{{dev|build}} {{dependency}}` + +- Remove a dependency of the given target platform: + +`cargo remove --target {{target}} {{dependency}}` diff --git a/pages/common/cargo-report.md b/pages/common/cargo-report.md new file mode 100644 index 0000000..80f8dea --- /dev/null +++ b/pages/common/cargo-report.md @@ -0,0 +1,16 @@ +# cargo report + +> Display various kinds of reports. +> More information: . + +- Display a report: + +`cargo report {{future-incompatibilities|...}}` + +- Display a report with the specified Cargo-generated id: + +`cargo report {{future-incompatibilities|...}} --id {{id}}` + +- Display a report for the specified package: + +`cargo report {{future-incompatibilities|...}} --package {{package}}` diff --git a/pages/common/cargo-run.md b/pages/common/cargo-run.md new file mode 100644 index 0000000..7605f9d --- /dev/null +++ b/pages/common/cargo-run.md @@ -0,0 +1,33 @@ +# cargo run + +> Run the current Cargo package. +> Note: the working directory of the executed binary will be set to the current working directory. +> More information: . + +- Run the default binary target: + +`cargo run` + +- Run the specified binary: + +`cargo run --bin {{name}}` + +- Run the specified example: + +`cargo run --example {{name}}` + +- Activate a space or comma separated list of features: + +`cargo run --features {{feature1 feature2 ...}}` + +- Disable the default features: + +`cargo run --no-default-features` + +- Activate all available features: + +`cargo run --all-features` + +- Run with the given profile: + +`cargo run --profile {{name}}` diff --git a/pages/common/cargo-rustc.md b/pages/common/cargo-rustc.md index 21f65bb..c96cd7e 100644 --- a/pages/common/cargo-rustc.md +++ b/pages/common/cargo-rustc.md @@ -1,11 +1,12 @@ # cargo rustc -> Compile a Rust package, and pass extra options to the compiler. +> Compile a Rust package. Similar to `cargo build`, but you can pass extra options to the compiler. +> See `rustc --help` for all available options. > More information: . -- Build the package or packages defined by the `Cargo.toml` manifest file in the current working directory: +- Build the package and pass options to `rustc`: -`cargo rustc` +`cargo rustc -- {{rustc_options}}` - Build artifacts in release mode, with optimizations: @@ -15,11 +16,11 @@ `cargo rustc --release -- -C target-cpu=native` -- Compile with speed optimization: +- Compile with speed optimizations: `cargo rustc -- -C opt-level {{1|2|3}}` -- Compile with [s]ize optimization (`z` also turns off loop vectorization): +- Compile with [s]ize optimizations (`z` also turns off loop vectorization): `cargo rustc -- -C opt-level {{s|z}}` diff --git a/pages/common/cargo-rustdoc.md b/pages/common/cargo-rustdoc.md new file mode 100644 index 0000000..72e4e37 --- /dev/null +++ b/pages/common/cargo-rustdoc.md @@ -0,0 +1,33 @@ +# cargo rustdoc + +> Build the documentation of Rust packages. +> Similar to `cargo doc`, but you can pass options to `rustdoc`. See `rustdoc --help` for all available options. +> More information: . + +- Pass options to `rustdoc`: + +`cargo rustdoc -- {{rustdoc_options}}` + +- Warn about a documentation lint: + +`cargo rustdoc -- --warn rustdoc::{{lint_name}}` + +- Ignore a documentation lint: + +`cargo rustdoc -- --allow rustdoc::{{lint_name}}` + +- Document the package's library: + +`cargo rustdoc --lib` + +- Document the specified binary: + +`cargo rustdoc --bin {{name}}` + +- Document the specified example: + +`cargo rustdoc --example {{name}}` + +- Document the specified integration test: + +`cargo rustdoc --test {{name}}` diff --git a/pages/common/cargo-search.md b/pages/common/cargo-search.md new file mode 100644 index 0000000..1316f6f --- /dev/null +++ b/pages/common/cargo-search.md @@ -0,0 +1,13 @@ +# cargo search + +> Search for packages on . +> The crates are displayed along with descriptions in TOML format suitable for copying into `Cargo.toml`. +> More information: . + +- Search for packages: + +`cargo search {{query}}` + +- Show `n` results (default: 10, max: 100): + +`cargo search --limit {{n}} {{query}}` diff --git a/pages/common/cargo-test.md b/pages/common/cargo-test.md index 3b6c322..b243f8d 100644 --- a/pages/common/cargo-test.md +++ b/pages/common/cargo-test.md @@ -9,11 +9,7 @@ - Set the number of simultaneous running test cases: -`cargo test -- --test-threads={{count}}` - -- Require that `Cargo.lock` is up to date: - -`cargo test --locked` +`cargo test -- --test-threads {{count}}` - Test artifacts in release mode, with optimizations: @@ -23,7 +19,7 @@ `cargo test --workspace` -- Run tests for a package: +- Run tests for a specific package: `cargo test --package {{package}}` diff --git a/pages/common/cargo-tree.md b/pages/common/cargo-tree.md new file mode 100644 index 0000000..373db97 --- /dev/null +++ b/pages/common/cargo-tree.md @@ -0,0 +1,25 @@ +# cargo tree + +> Display a tree visualization of a dependency graph. +> Note: in the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated. +> More information: . + +- Show a dependency tree of the current project: + +`cargo tree` + +- Only show dependencies up to the specified depth (e.g. when `n` is 1, display only direct dependencies): + +`cargo tree --depth {{n}}` + +- Do not display the given package (and its dependencies) in the tree: + +`cargo tree --prune {{package_spec}}` + +- Show all occurrences of repeated dependencies: + +`cargo tree --no-dedupe` + +- Only show normal/build/development dependencies: + +`cargo tree --edges {{normal|build|dev}}` diff --git a/pages/common/cargo-uninstall.md b/pages/common/cargo-uninstall.md new file mode 100644 index 0000000..3ec6937 --- /dev/null +++ b/pages/common/cargo-uninstall.md @@ -0,0 +1,8 @@ +# cargo uninstall + +> Remove a Rust binary installed using `cargo install`. +> More information: . + +- Remove an installed binary: + +`cargo remove {{package_spec}}` diff --git a/pages/common/cargo-vendor.md b/pages/common/cargo-vendor.md new file mode 100644 index 0000000..c81ec03 --- /dev/null +++ b/pages/common/cargo-vendor.md @@ -0,0 +1,8 @@ +# cargo vendor + +> Vendor all dependencies of a project into the specified directory (default: `vendor`). +> More information: . + +- Vendor dependencies and configure `cargo` to use the vendored sources in the current project: + +`cargo vendor {{path/to/directory}} > .cargo/config.toml` diff --git a/pages/common/cargo-verify-project.md b/pages/common/cargo-verify-project.md new file mode 100644 index 0000000..8212f0f --- /dev/null +++ b/pages/common/cargo-verify-project.md @@ -0,0 +1,12 @@ +# cargo verify-project + +> Check the correctness of the `Cargo.toml` manifest and print the result as a JSON object. +> More information: . + +- Check the correctness of the current project's manifest: + +`cargo verify-project` + +- Check the correctness of the specified manifest file: + +`cargo verify-project --manifest-path {{path/to/Cargo.toml}}` diff --git a/pages/common/cargo-yank.md b/pages/common/cargo-yank.md new file mode 100644 index 0000000..b4dff0a --- /dev/null +++ b/pages/common/cargo-yank.md @@ -0,0 +1,17 @@ +# cargo yank + +> Remove a pushed crate from the index. This should only be used when you accidentally release a significantly broken crate. +> Note: this does not remove any data. The crate is still present after a yank - this just prevents new projects from using it. +> More information: . + +- Yank the specified version of a crate: + +`cargo yank {{crate}}@{{version}}` + +- Undo a yank (i.e. allow downloading it again): + +`cargo yank --undo {{crate}}@{{version}}` + +- Specify the name of the registry to use (registry names can be defined in the config - the default is ): + +`cargo yank --registry {{name}} {{crate}}@{{version}}` diff --git a/pages/common/cli53.md b/pages/common/cli53.md new file mode 100644 index 0000000..79ffa8e --- /dev/null +++ b/pages/common/cli53.md @@ -0,0 +1,36 @@ +# cli53 + +> Command line tool for Amazon Route 53. +> More information: . + +- List domains: + +`cli53 list` + +- Create a domain: + +`cli53 create {{mydomain.com}} --comment "{{comment}}"` + +- Export a bind zone file to `stdout`: + +`cli53 export {{mydomain.com}}` + +- Create a `www` subdomain pointing to a relative record in the same zone: + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 CNAME lb'}}` + +- Create a `www` subdomain pointing to an external address (must end with a dot): + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 CNAME lb.externalhost.com.'}}` + +- Create a `www` subdomain pointing to an IP address: + +`cli53 {{rc|rrcreate}} {{mydomain.com}} {{'www 300 A 150.130.110.1'}}` + +- Replace a `www` subdomain pointing to a different IP: + +`cli53 {{rc|rrcreate}} --replace {{'www 300 A 150.130.110.2'}}` + +- Delete a record A: + +`cli53 {{rd|rrdelete}} {{mydomain.com}} {{www}} {{A}}` diff --git a/pages/common/compare.md b/pages/common/compare.md index c9367b0..fad9b05 100644 --- a/pages/common/compare.md +++ b/pages/common/compare.md @@ -1,12 +1,13 @@ # compare -> View the difference between 2 images. +> Create a comparison image to visually annotate the difference between two images. +> Part of ImageMagick. > More information: . -- Compare 2 images: +- Compare two images: -`compare {{image1.png}} {{image2.png}} {{diff.png}}` +`compare {{path/to/image1.png}} {{path/to/image2.png}} {{path/to/diff.png}}` -- Compare 2 images using a custom metric: +- Compare two images using the specified metric: -`compare -verbose -metric {{PSNR}} {{image1.png}} {{image2.png}} {{diff.png}}` +`compare -verbose -metric {{PSNR}} {{path/to/image1.png}} {{path/to/image2.png}} {{path/to/diff.png}}` diff --git a/pages/common/composer.md b/pages/common/composer.md index c9df510..dcb5578 100644 --- a/pages/common/composer.md +++ b/pages/common/composer.md @@ -7,7 +7,7 @@ `composer init` -- Add a package as a dependency for this project, adding it to `composer.json`: +- Add a package as a dependency for this project, adding an entry to `composer.json`: `composer require {{user/package}}` @@ -15,15 +15,15 @@ `composer install` -- Uninstall a package from this project, removing it as a dependency from `composer.json`: +- Uninstall a package from this project, removing it as a dependency from `composer.json` and `composer.lock`: `composer remove {{user/package}}` -- Update all the dependencies in this project's `composer.json` and note versions in `composer.lock` file: +- Update all the dependencies in this project's `composer.json` and note new versions in `composer.lock` file: `composer update` -- Update composer lock only after updating `composer.json` manually: +- Update only `composer.lock` after updating `composer.json` manually: `composer update --lock` diff --git a/pages/common/convert.md b/pages/common/convert.md index a1785d0..6f36954 100644 --- a/pages/common/convert.md +++ b/pages/common/convert.md @@ -1,36 +1,37 @@ # convert -> ImageMagick image conversion tool. +> Image conversion tool. +> Part of ImageMagick. > More information: . - Convert an image from JPG to PNG: -`convert {{image.jpg}} {{image.png}}` +`convert {{path/to/input_image.jpg}} {{path/to/output_image.png}}` -- Scale an image 50% its original size: +- Scale an image to 50% of its original size: -`convert {{image.png}} -resize 50% {{image2.png}}` +`convert {{path/to/input_image.png}} -resize 50% {{path/to/output_image.png}}` - Scale an image keeping the original aspect ratio to a maximum dimension of 640x480: -`convert {{image.png}} -resize 640x480 {{image2.png}}` +`convert {{path/to/input_image.png}} -resize 640x480 {{path/to/output_image.png}}` - Horizontally append images: -`convert {{image1.png}} {{image2.png}} {{image3.png}} +append {{image123.png}}` +`convert {{path/to/image1.png path/to/image2.png ...}} +append {{path/to/output_image.png}}` - Vertically append images: -`convert {{image1.png}} {{image2.png}} {{image3.png}} -append {{image123.png}}` +`convert {{path/to/image1.png path/to/image2.png ...}} -append {{path/to/output_image.png}}` - Create a GIF from a series of images with 100ms delay between them: -`convert {{image1.png}} {{image2.png}} {{image3.png}} -delay {{10}} {{animation.gif}}` +`convert {{path/to/image1.png path/to/image2.png ...}} -delay {{10}} {{path/to/animation.gif}}` -- Create an image with nothing but a solid background: +- Create an image with nothing but a solid red background: -`convert -size {{800x600}} "xc:{{#ff0000}}" {{image.png}}` +`convert -size {{800x600}} "xc:{{#ff0000}}" {{path/to/image.png}}` - Create a favicon from several images of different sizes: -`convert {{image1.png}} {{image2.png}} {{image3.png}} {{image.ico}}` +`convert {{path/to/image1.png path/to/image2.png ...}} {{path/to/favicon.ico}}` diff --git a/pages/common/crystal.md b/pages/common/crystal.md index 637a20a..05446d0 100644 --- a/pages/common/crystal.md +++ b/pages/common/crystal.md @@ -11,6 +11,18 @@ `crystal build {{path/to/file.cr}}` +- Read Crystal source code from the command line or `stdin`, and execute it: + +`crystal eval '{{code}}'` + +- Generate API documentation from inline docstrings in Crystal files: + +`crystal docs` + +- Compile and run a Crystal specification suite: + +`crystal spec` + - Start a local interactive server for testing the language: `crystal play` diff --git a/pages/common/ddgr.md b/pages/common/ddgr.md new file mode 100644 index 0000000..f3fcdb7 --- /dev/null +++ b/pages/common/ddgr.md @@ -0,0 +1,36 @@ +# ddgr + +> Search DuckDuckGo (HTML version) from the terminal. +> More information: . + +- Start in interactive mode: + +`ddgr` + +- Search DuckDuckGo for a keyword: + +`ddgr {{keyword}}` + +- Limit the number of search results to `N`: + +`ddgr -n {{N}} {{keyword}}` + +- Display the complete URL in search results: + +`ddgr -x {{keyword}}` + +- Search DuckDuckGo for a keyword and open the first result in the browser: + +`ddgr !w {{keyword}}` + +- Perform a website-specific search: + +`ddgr -w {{site}} {{keyword}}` + +- Search for a specific file type: + +`ddgr {{keyword}} filetype:{{filetype}}` + +- Display help in interactive mode: + +`?` diff --git a/pages/common/dmd.md b/pages/common/dmd.md new file mode 100644 index 0000000..dc15f2e --- /dev/null +++ b/pages/common/dmd.md @@ -0,0 +1,24 @@ +# dmd + +> Official D compiler. +> More information: . + +- Build a D source file: + +`dmd {{path/to/source.d}}` + +- Generate code for all template instantiations: + +`dmd -allinst` + +- Control bounds checking: + +`dmd -boundscheck={{on|safeonly|off}}` + +- List information on all available checks: + +`dmd -check={{h|help|?}}` + +- Turn on colored console output: + +`dmd -color` diff --git a/pages/common/docker-container-diff.md b/pages/common/docker-container-diff.md new file mode 100644 index 0000000..2a642cf --- /dev/null +++ b/pages/common/docker-container-diff.md @@ -0,0 +1,8 @@ +# docker container diff + +> This command is an alias of `docker diff`. +> More information: . + +- View documentation for the original command: + +`tldr docker diff` diff --git a/pages/common/docker-container-remove.md b/pages/common/docker-container-remove.md new file mode 100644 index 0000000..c7b7834 --- /dev/null +++ b/pages/common/docker-container-remove.md @@ -0,0 +1,8 @@ +# docker container remove + +> This command is an alias of `docker rm`. +> More information: . + +- View documentation for the original command: + +`tldr docker rm` diff --git a/pages/common/docker-container-rename.md b/pages/common/docker-container-rename.md new file mode 100644 index 0000000..2b886a5 --- /dev/null +++ b/pages/common/docker-container-rename.md @@ -0,0 +1,8 @@ +# docker container rename + +> This command is an alias of `docker rename`. +> More information: . + +- View documentation for the original command: + +`tldr docker rename` diff --git a/pages/common/docker-container-rm.md b/pages/common/docker-container-rm.md new file mode 100644 index 0000000..586c7c8 --- /dev/null +++ b/pages/common/docker-container-rm.md @@ -0,0 +1,8 @@ +# docker container rm + +> This command is an alias of `docker rm`. +> More information: . + +- View documentation for the original command: + +`tldr docker rm` diff --git a/pages/common/docker-container-top.md b/pages/common/docker-container-top.md new file mode 100644 index 0000000..089461d --- /dev/null +++ b/pages/common/docker-container-top.md @@ -0,0 +1,8 @@ +# docker container top + +> This command is an alias of `docker top`. +> More information: . + +- View documentation for the original command: + +`tldr docker top` diff --git a/pages/common/docker-diff.md b/pages/common/docker-diff.md new file mode 100644 index 0000000..bf6c2d4 --- /dev/null +++ b/pages/common/docker-diff.md @@ -0,0 +1,12 @@ +# docker diff + +> Inspect changes to files or directories on a container's filesystem. +> More information: . + +- Inspect the changes to a container since it was created: + +`docker diff {{container}}` + +- Display help: + +`docker diff --help` diff --git a/pages/common/docker-rename.md b/pages/common/docker-rename.md new file mode 100644 index 0000000..b7332f8 --- /dev/null +++ b/pages/common/docker-rename.md @@ -0,0 +1,12 @@ +# docker rename + +> Rename a container. +> More information: . + +- Rename a container: + +`docker rename {{container}} {{new_name}}` + +- Display help: + +`docker rename --help` diff --git a/pages/common/docker-rm.md b/pages/common/docker-rm.md new file mode 100644 index 0000000..cbbbb0d --- /dev/null +++ b/pages/common/docker-rm.md @@ -0,0 +1,20 @@ +# docker rm + +> Remove one or more containers. +> More information: . + +- Remove containers: + +`docker rm {{container1 container2 ...}}` + +- Force remove a container: + +`docker rm --force {{container1 container2 ...}}` + +- Remove a container and its volumes: + +`docker rm --volumes {{container}}` + +- Display help: + +`docker rm` diff --git a/pages/common/docker-top.md b/pages/common/docker-top.md new file mode 100644 index 0000000..8207c85 --- /dev/null +++ b/pages/common/docker-top.md @@ -0,0 +1,12 @@ +# docker top + +> Display the running processes of a container. +> More information: . + +- Display the running processes of a container: + +`docker top {{container}}` + +- Display help: + +`docker top --help` diff --git a/pages/common/doctl-databases-db.md b/pages/common/doctl-databases-db.md new file mode 100644 index 0000000..c033265 --- /dev/null +++ b/pages/common/doctl-databases-db.md @@ -0,0 +1,24 @@ +# doctl databases db + +> Manage specific databases that are served by a database cluster. +> More information: . + +- Run a `doctl databases db` command with an access token: + +`doctl databases db {{command}} --access-token {{access_token}}` + +- Retrieve the name of the given database hosted in the given database cluster: + +`doctl databases db get {{database_id}} {{database_name}}` + +- List existing databases hosted within a given database cluster: + +`doctl databases db list {{database_id}}` + +- Create a database with the given name in the given database cluster: + +`doctl databases db create {{database_id}} {{database_name}}` + +- Delete the database with the given name in the given database cluster: + +`doctl databases db delete {{database_id}} {{database_name}}` diff --git a/pages/common/doctl-databases-firewalls.md b/pages/common/doctl-databases-firewalls.md new file mode 100644 index 0000000..f13aef7 --- /dev/null +++ b/pages/common/doctl-databases-firewalls.md @@ -0,0 +1,20 @@ +# doctl databases firewalls + +> Manage firewalls for database clusters. +> More information: . + +- Run a `doctl databases firewalls` command with an access token: + +`doctl databases firewalls {{command}} --access-token {{access_token}}` + +- Retrieve a list of firewall rules for a given database: + +`doctl databases firewalls list` + +- Add a database firewall rule to a given database: + +`doctl databases firewalls append {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}` + +- Remove a firewall rule for a given database: + +`doctl databases firewalls remove {{database_id}} {{rule_uuid}}` diff --git a/pages/common/doctl-databases-maintenance-window.md b/pages/common/doctl-databases-maintenance-window.md new file mode 100644 index 0000000..1fd1d98 --- /dev/null +++ b/pages/common/doctl-databases-maintenance-window.md @@ -0,0 +1,16 @@ +# doctl databases maintenance-window + +> Schedule, and check the schedule of, maintenance windows for your databases. +> More information: . + +- Run a `doctl databases maintenance-window` command with an access token: + +`doctl databases maintenance-window {{command}} --access-token {{access_token}}` + +- Retrieve details about a database cluster's maintenance windows: + +`doctl databases maintenance-window get {{database_id}}` + +- Update the maintenance window for a database cluster: + +`doctl databases maintenance-window update {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}` diff --git a/pages/common/doctl-databases-options.md b/pages/common/doctl-databases-options.md new file mode 100644 index 0000000..4873f4f --- /dev/null +++ b/pages/common/doctl-databases-options.md @@ -0,0 +1,24 @@ +# doctl databases options + +> Enable the navigation of available options under each database engine. +> More information: . + +- Run a `doctl databases options` command with an access token: + +`doctl databases options {{command}} --access-token {{access_token}}` + +- Retrieve a list of the available database engines: + +`doctl databases options engines` + +- Retrieve a list of the available regions for a given database engine: + +`doctl databases options regions --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available slugs for a given database engine: + +`doctl databases options slugs --engine {{pg|mysql|redis|mongodb}}` + +- Retrieve a list of the available versions for a given database engine: + +`doctl databases options versions --engine {{pg|mysql|redis|mongodb}}` diff --git a/pages/common/doctl-databases-pool.md b/pages/common/doctl-databases-pool.md new file mode 100644 index 0000000..232b8eb --- /dev/null +++ b/pages/common/doctl-databases-pool.md @@ -0,0 +1,24 @@ +# doctl databases pool + +> Manage connection pools for your database cluster. +> More information: . + +- Run a `doctl databases pool` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a database connection pool: + +`doctl databases pool get {{database_id}} {{pool_name}}` + +- List connection pools for a database cluster: + +`doctl databases pool list {{database_id}}` + +- Create a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}} --db {{new_pool_name}} --size {{pool_size}}` + +- Delete a connection pool for a database: + +`doctl databases pool create {{database_id}} {{pool_name}}` diff --git a/pages/common/doctl-databases-replica.md b/pages/common/doctl-databases-replica.md new file mode 100644 index 0000000..b5e927f --- /dev/null +++ b/pages/common/doctl-databases-replica.md @@ -0,0 +1,24 @@ +# doctl databases replica + +> Manage read-only replicas associated with a database cluster. +> More information: . + +- Run a `doctl databases replica` command with an access token: + +`doctl databases pool {{command}} --access-token {{access_token}}` + +- Retrieve information about a read-only database replica: + +`doctl databases replica get {{database_id}} {{replica_name}}` + +- Retrieve list of read-only database replicas: + +`doctl databases replica list {{database_id}}` + +- Create a read-only database replica: + +`doctl databases replica create {{database_id}} {{replica_name}}` + +- Delete a read-only database replica: + +`doctl databases replica delete {{database_id}} {{replica_name}}` diff --git a/pages/common/doctl-databases-sql-mode.md b/pages/common/doctl-databases-sql-mode.md new file mode 100644 index 0000000..1a81ece --- /dev/null +++ b/pages/common/doctl-databases-sql-mode.md @@ -0,0 +1,16 @@ +# doctl databases sql-mode + +> View and configure a MySQL database cluster’s global SQL modes. +> More information: . + +- Run a `doctl databases sql-mode` command with an access token: + +`doctl databases sql-mode {{command}} --access-token {{access_token}}` + +- Get a MySQL database cluster's SQL modes: + +`doctl databases sql-mode get {{database_id}}` + +- Overwrite a MySQL database cluster's SQL modes to the specified modes: + +`doctl databases sql-mode set {{database_id}} {{sql_mode_1 sql_mode_2 ...}}` diff --git a/pages/common/doctl-databases-user.md b/pages/common/doctl-databases-user.md new file mode 100644 index 0000000..ce6531a --- /dev/null +++ b/pages/common/doctl-databases-user.md @@ -0,0 +1,32 @@ +# doctl databases user + +> View details for, and create, database users. +> More information: . + +- Run a `doctl databases user` command with an access token: + +`doctl databases user {{command}} --access-token {{access_token}}` + +- Retrieve details about a database user: + +`doctl databases user get {{database_id}} {{user_name}}` + +- Retrieve a list of database users for a given database: + +`doctl databases user list {{database_id}}` + +- Reset the auth password for a given user: + +`doctl databases user reset {{database id}} {{user_name}}` + +- Reset the MySQL auth plugn for a given user: + +`doctl databases user reset {{database_id}} {{user_name}} {{caching_sha2_password|mysql_native_password}}` + +- Create a user in the given database with a given username: + +`doctl databases user create {{database_id}} {{user_name}}` + +- Delete a user from the given database with the given username: + +`doctl databases user delete {{database_id}} {{user_name}}` diff --git a/pages/common/doctl-databases.md b/pages/common/doctl-databases.md new file mode 100644 index 0000000..5f7d5ef --- /dev/null +++ b/pages/common/doctl-databases.md @@ -0,0 +1,24 @@ +# doctl databases + +> Manage your MySQL, Redis, PostgreSQL, and MongoDB database services. +> More information: . + +- Run a `doctl databases` command with an access token: + +`doctl databases {{command}} --access-token {{access_token}}` + +- Get details for a database cluster: + +`doctl databases get` + +- List your database clusters: + +`doctl databases list` + +- Create a database cluster: + +`doctl databases create {{database_name}}` + +- Delete a cluster: + +`doctl databases delete {{database_id}}` diff --git a/pages/common/dotnet-add-package.md b/pages/common/dotnet-add-package.md new file mode 100644 index 0000000..bd6a18a --- /dev/null +++ b/pages/common/dotnet-add-package.md @@ -0,0 +1,28 @@ +# dotnet add package + +> Add or update a .NET package reference in a project file. +> More information: . + +- Add a package to the project in the current directory: + +`dotnet add package {{package}}` + +- Add a package to a specific project: + +`dotnet add {{path/to/file.csproj}} package {{package}}` + +- Add a specific version of a package to the project: + +`dotnet add package {{package}} --version {{1.0.0}}` + +- Add a package using a specific NuGet source: + +`dotnet add package {{package}} --source {{https://api.nuget.org/v3/index.json}}` + +- Add a package only when targeting a specific framework: + +`dotnet add package {{package}} --framework {{net7.0}}` + +- Add and specify the directory where to restore packages (`~/.nuget/packages` by default): + +`dotnet add package {{package}} --package-directory {{path/to/directory}}` diff --git a/pages/common/dotnet-add-reference.md b/pages/common/dotnet-add-reference.md new file mode 100644 index 0000000..d4c2312 --- /dev/null +++ b/pages/common/dotnet-add-reference.md @@ -0,0 +1,12 @@ +# dotnet add reference + +> Add .NET project-to-project references. +> More information: . + +- Add a reference to the project in the current directory: + +`dotnet add reference {{path/to/reference.csproj}}` + +- Add a reference to the specific project: + +`dotnet add {{path/to/project.csproj}} reference {{path/to/reference.csproj}}` diff --git a/pages/common/dotnet-run.md b/pages/common/dotnet-run.md new file mode 100644 index 0000000..a2e3201 --- /dev/null +++ b/pages/common/dotnet-run.md @@ -0,0 +1,24 @@ +# dotnet run + +> Run a .NET application without explicit compile or launch commands. +> More information: . + +- Run the project in the current directory: + +`dotnet run` + +- Run a specific project: + +`dotnet run --project {{path/to/file.csproj}}` + +- Run the project with specific arguments: + +`dotnet run -- {{arg1=foo arg2=bar ...}}` + +- Run the project using a target framework moniker: + +`dotnet run --framework {{net7.0}}` + +- Specify architecture and OS, available since .NET 6 (Don't use `--runtime` with these options): + +`dotnet run --arch {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` diff --git a/pages/common/dub.md b/pages/common/dub.md new file mode 100644 index 0000000..ba8d11d --- /dev/null +++ b/pages/common/dub.md @@ -0,0 +1,28 @@ +# dub + +> Package manager for D packages. +> More information: . + +- Interactively create a new D project: + +`dub init {{project_name}}` + +- Non-interactively create a new D project: + +`dub init {{project_name}} -n` + +- Build and run a D project: + +`dub` + +- Install dependencies specified in a D project's `dub.json` or `dub.sdl` file: + +`dub fetch` + +- Update the dependencies in a D project: + +`dub upgrade` + +- Display help: + +`dub --help` diff --git a/pages/common/duckdb.md b/pages/common/duckdb.md index 4da3a97..03e150f 100644 --- a/pages/common/duckdb.md +++ b/pages/common/duckdb.md @@ -27,7 +27,7 @@ `duckdb {{path/to/dbfile}} -init {{path/to/script.sql}}` -- Read CSV from stdin and write CSV to stdout: +- Read CSV from `stdin` and write CSV to `stdout`: `cat {{path/to/source.csv}} | duckdb -c "{{COPY (FROM read_csv_auto('/dev/stdin')) TO '/dev/stdout' WITH (FORMAT CSV, HEADER)}}"` diff --git a/pages/common/eyuvtoppm.md b/pages/common/eyuvtoppm.md new file mode 100644 index 0000000..b2d7514 --- /dev/null +++ b/pages/common/eyuvtoppm.md @@ -0,0 +1,8 @@ +# eyuvtoppm + +> Convert a Berkeley YUV file to PPM. +> More information: . + +- Read a Berkeley YUV file from the specified input file, convert it to a PPM image and store it in the specified output file: + +`eyuvtoppm --width {{width}} --height {{height}} {{path/to/input_file.eyuv}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/fastboot.md b/pages/common/fastboot.md index 5625c22..da9d0f3 100644 --- a/pages/common/fastboot.md +++ b/pages/common/fastboot.md @@ -1,7 +1,7 @@ # fastboot > Communicate with connected Android devices when in bootloader mode (the one place `adb` doesn't work). -> More information: . +> More information: . - Unlock the bootloader: diff --git a/pages/common/fio.md b/pages/common/fio.md index 95ce9cf..2be5dd9 100644 --- a/pages/common/fio.md +++ b/pages/common/fio.md @@ -6,19 +6,19 @@ - Test random reads: -`sudo fio --filename={{path/to/file}} --direct=1 --rw=randread --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` +`fio --filename={{path/to/file}} --direct=1 --rw=randread --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` - Test sequential reads: -`sudo fio --filename={{path/to/file}} --direct=1 --rw=read --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` +`fio --filename={{path/to/file}} --direct=1 --rw=read --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1 --readonly` - Test random read/write: -`sudo fio --filename={{path/to/file}} --size=500GB --direct=1 --rw=randrw --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1` +`fio --filename={{path/to/file}} --direct=1 --rw=randrw --bs=4k --ioengine=libaio --iodepth=256 --runtime=120 --numjobs=4 --time_based --group_reporting --name={{job_name}} --eta-newline=1` - Test with parameters from a job file: -`sudo fio {{path/to/job_file}}` +`fio {{path/to/job_file}}` - Convert a specific job file to command-line options: diff --git a/pages/common/flutter-pub.md b/pages/common/flutter-pub.md new file mode 100644 index 0000000..2917ace --- /dev/null +++ b/pages/common/flutter-pub.md @@ -0,0 +1,21 @@ +# flutter pub + +> Flutter's package manager. +> Note: Packages are available on . See also: `flutter`. +> More information: . + +- Download/Update all packages specified in `pubspec.yaml`: + +`flutter pub get` + +- Add a package dependency to an app: + +`flutter pub add {{package1 package2 ...}}` + +- Remove a package dependency from an app: + +`flutter pub remove {{package1 package2 ...}}` + +- Upgrade to the highest version of a package that is allowed by `pubspec.yaml`: + +`flutter pub upgrade {{package}}` diff --git a/pages/common/flutter.md b/pages/common/flutter.md index ec4d229..5eacb89 100644 --- a/pages/common/flutter.md +++ b/pages/common/flutter.md @@ -1,6 +1,7 @@ # flutter > Google's free, open source, and cross-platform mobile app SDK. +> Some subcommands such as `flutter pub` have their own usage documentation. > More information: . - Initialize a new Flutter project in a directory of the same name: @@ -19,10 +20,6 @@ `flutter run -d all` -- Download all packages specified in `pubspec.yaml`: - -`flutter pub get` - - Run tests in a terminal from the root of the project: `flutter test {{test/example_test.dart}}` diff --git a/pages/common/gdc.md b/pages/common/gdc.md new file mode 100644 index 0000000..806945f --- /dev/null +++ b/pages/common/gdc.md @@ -0,0 +1,24 @@ +# gdc + +> D compiler using GCC as a backend. +> More information: . + +- Create an executable: + +`gdc {{path/to/source.d}} -o {{path/to/output_executable}}` + +- Print information about module dependencies: + +`gdc -fdeps` + +- Generate Ddoc documentation: + +`gdc -fdoc` + +- Generate D interface files: + +`gdc -fintfc` + +- Do not link the standard GCC libraries in the compilation: + +`gdc -nostdlib` diff --git a/pages/common/gemtopbm.md b/pages/common/gemtopbm.md new file mode 100644 index 0000000..4be4af1 --- /dev/null +++ b/pages/common/gemtopbm.md @@ -0,0 +1,8 @@ +# gemtopbm + +> This command is superseded by `gemtopnm`. +> More information: . + +- View documentation for the current command: + +`tldr gemtopnm` diff --git a/pages/common/gemtopnm.md b/pages/common/gemtopnm.md new file mode 100644 index 0000000..daddecc --- /dev/null +++ b/pages/common/gemtopnm.md @@ -0,0 +1,16 @@ +# gemtopbm + +> Convert a GEM image file into a PNM image. +> More information: . + +- Convert a GEM image file to a PNM image: + +`gemtopbm {{path/to/file.img}} > {{path/to/output.pbm}}` + +- Describe the contents of the specified GEM image: + +`gemtopbm -d {{path/to/file.img}}` + +- Display version: + +`gemtopbm -version` diff --git a/pages/common/get-nodeinstalllocation.md b/pages/common/get-nodeinstalllocation.md new file mode 100644 index 0000000..6de6277 --- /dev/null +++ b/pages/common/get-nodeinstalllocation.md @@ -0,0 +1,9 @@ +# Get-NodeInstallLocation + +> Get the current Node.js installation directory for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Get the current Node.js installation directory: + +`Get-NodeInstallLocation` diff --git a/pages/common/get-nodeversions.md b/pages/common/get-nodeversions.md new file mode 100644 index 0000000..51559f2 --- /dev/null +++ b/pages/common/get-nodeversions.md @@ -0,0 +1,17 @@ +# Get-NodeVersions + +> List installed and available Node.js versions for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- List all installed Node.js versions: + +`Get-NodeVersions` + +- List all available Node.js versions: + +`Get-NodeVersions -Remote` + +- List all available Node.js 20.x versions: + +`Get-NodeVersions -Remote -Filter ">=20.0.0 <21.0.0"` diff --git a/pages/common/gh-repo.md b/pages/common/gh-repo.md index 570cda6..90b23fc 100644 --- a/pages/common/gh-repo.md +++ b/pages/common/gh-repo.md @@ -23,9 +23,9 @@ `gh repo list {{owner}}` -- List only non-forks repositories: +- List only non-forks repositories and limit the number of repositories to list (default: 30): -`gh repo list {{owner}} --non-forks` +`gh repo list {{owner}} --source -L {{limit}}` - List repositories with a specific primary coding language: diff --git a/pages/common/gh-screensaver.md b/pages/common/gh-screensaver.md index aa59c7d..7c5b1a5 100644 --- a/pages/common/gh-screensaver.md +++ b/pages/common/gh-screensaver.md @@ -10,7 +10,7 @@ - Run a specific screensaver: -`gh screensaver --saver {{fireworks|marquee|pipes|pollock|starfield}}` +`gh screensaver --saver {{fireworks|life|marquee|pipes|pollock|starfield}}` - Run the "marquee" screensaver with a specific text and font: diff --git a/pages/common/giftopnm.md b/pages/common/giftopnm.md new file mode 100644 index 0000000..8c7fe60 --- /dev/null +++ b/pages/common/giftopnm.md @@ -0,0 +1,12 @@ +# giftopnm + +> Convert a GIF file into a PNM image. +> More information: . + +- Convert a GIF image to a Netpbm image pixel-for-pixel: + +`giftopnm {{path/to/input.gif}} > {{path/to/output.pnm}}` + +- Display version: + +`giftopnm -version` diff --git a/pages/common/git-delete-squashed-branches.md b/pages/common/git-delete-squashed-branches.md new file mode 100644 index 0000000..983dadc --- /dev/null +++ b/pages/common/git-delete-squashed-branches.md @@ -0,0 +1,13 @@ +# git delete-squashed-branches + +> Delete branches that have been "squashed-merged" into a specified branch and checkout. If no branch is specified, default to the currently checked out branch. +> Part of `git-extras`. +> More information: . + +- Delete all branches that were "squash-merged" into the current checked out branch: + +`git delete-squashed-branches` + +- Delete all branches that were "squash-merged" into a specific branch: + +`git delete-squashed-branches {{branch_name}}` diff --git a/pages/common/git-diff-index.md b/pages/common/git-diff-index.md new file mode 100644 index 0000000..95ca71b --- /dev/null +++ b/pages/common/git-diff-index.md @@ -0,0 +1,20 @@ +# git diff-index + +> Compare the working directory with a specific commit or tree object. +> More information: . + +- Compare the working directory with a specific commit: + +`git diff-index {{commit}}` + +- Compare a specific file or directory in working directory with a commit: + +`git diff-index {{commit}} {{path/to/file_or_directory}}` + +- Compare the working directory with the index (staging area) to check for staged changes: + +`git diff-index --cached {{commit}}` + +- Suppress output and return an exit status to check for differences: + +`git diff-index --quiet {{commit}}` diff --git a/pages/common/git-diff-tree.md b/pages/common/git-diff-tree.md new file mode 100644 index 0000000..6c234f8 --- /dev/null +++ b/pages/common/git-diff-tree.md @@ -0,0 +1,20 @@ +# git diff-tree + +> Compares the content and mode of blobs found via two tree objects. +> More information: . + +- Compare two tree objects: + +`git diff-tree {{tree-ish1}} {{tree-ish2}}` + +- Show changes between two specific commits: + +`git diff-tree -r {{commit1}} {{commit2}}` + +- Display changes in patch format: + +`git diff-tree -p {{tree-ish1}} {{tree-ish2}}` + +- Filter changes by a specific path: + +`git diff-tree {{tree-ish1}} {{tree-ish2}} -- {{path/to/file_or_directory}}` diff --git a/pages/common/git-fresh-branch.md b/pages/common/git-fresh-branch.md new file mode 100644 index 0000000..30491ab --- /dev/null +++ b/pages/common/git-fresh-branch.md @@ -0,0 +1,9 @@ +# git fresh-branch + +> Create an empty local branch. +> Part of `git-extras`. +> More information: . + +- Create an empty local branch: + +`git fresh-branch {{branch_name}}` diff --git a/pages/common/git-guilt.md b/pages/common/git-guilt.md new file mode 100644 index 0000000..0b006e7 --- /dev/null +++ b/pages/common/git-guilt.md @@ -0,0 +1,29 @@ +# git guilt + +> Show total blame count for files with unstaged changes or calculate the change in blame between two revisions. +> Part of `git-extras`. +> More information: . + +- Show total blame count: + +`git guilt` + +- Calculate the change in blame between two revisions: + +`git guilt {{first_revision}} {{last_revision}}` + +- Show author emails instead of names: + +`git guilt --email` + +- Ignore whitespace only changes when attributing blame: + +`git guilt --ignore-whitespace` + +- Find blame delta over the last three weeks: + +`git guilt 'git log --until="3 weeks ago" --format="%H" -n 1'` + +- Find blame delta over the last three weeks (git 1.8.5+): + +`git guilt @{3.weeks.ago}` diff --git a/pages/common/git-ls-tree.md b/pages/common/git-ls-tree.md index ba67e68..6d4a0eb 100644 --- a/pages/common/git-ls-tree.md +++ b/pages/common/git-ls-tree.md @@ -14,3 +14,7 @@ - List only the filenames of the tree on a commit: `git ls-tree --name-only {{commit_hash}}` + +- Print the filenames of the current branch head in a tree structure (Note: `tree --fromfile` is not supported on Windows): + +`git ls-tree -r --name-only HEAD | tree --fromfile` diff --git a/pages/common/git-magic.md b/pages/common/git-magic.md new file mode 100644 index 0000000..846eb94 --- /dev/null +++ b/pages/common/git-magic.md @@ -0,0 +1,29 @@ +# git magic + +> Automate add, commit, and push routines. +> Part of `git-extras`. +> More information: . + +- Commit changes with a generated message: + +`git magic` + +- [a]dd untracked files and commit changes with a generated message: + +`git magic -a` + +- Commit changes with a custom [m]essage: + +`git magic -m "{{custom_commit_message}}"` + +- [e]dit the commit [m]essage before committing: + +`git magic -em "{{custom_commit_message}}"` + +- Commit changes and [p]ush to remote: + +`git magic -p` + +- Commit changes with a [f]orce [p]ush to remote: + +`git magic -fp` diff --git a/pages/common/git-paste.md b/pages/common/git-paste.md new file mode 100644 index 0000000..46ecb03 --- /dev/null +++ b/pages/common/git-paste.md @@ -0,0 +1,13 @@ +# git paste + +> Send commits to a pastebin site using `pastebinit`. +> Part of `git-extras`. +> More information: . + +- Send the patches between the current branch and its upstream to a pastebin using `pastebinit`: + +`git paste` + +- Pass options to `git format-patch` in order to select a different set of commits (`@^` selects the parent of HEAD, and so the currently checked out commit is sent): + +`git paste {{@^}}` diff --git a/pages/common/git-psykorebase.md b/pages/common/git-psykorebase.md new file mode 100644 index 0000000..5288ff8 --- /dev/null +++ b/pages/common/git-psykorebase.md @@ -0,0 +1,17 @@ +# git psykorebase + +> Rebase a branch on top of another using a merge commit and only one conflict handling. +> Part of `git-extras`. +> More information: . + +- Rebase the current branch on top of another using a merge commit and only one conflict handling: + +`git psykorebase {{upstream_branch}}` + +- Continue after conflicts have been handled: + +`git psykorebase --continue` + +- Specify the branch to rebase: + +`git psykorebase {{upstream_branch}} {{target_branch}}` diff --git a/pages/common/git-pull-request.md b/pages/common/git-pull-request.md new file mode 100644 index 0000000..bb8fca0 --- /dev/null +++ b/pages/common/git-pull-request.md @@ -0,0 +1,9 @@ +# git pull-request + +> Create a pull request for a project on GitHub. +> Part of `git-extras`. +> More information: . + +- Create a pull request for a project on GitHub: + +`git pull-request {{target_branch}}` diff --git a/pages/common/git-rebase-patch.md b/pages/common/git-rebase-patch.md new file mode 100644 index 0000000..0b72f6a --- /dev/null +++ b/pages/common/git-rebase-patch.md @@ -0,0 +1,9 @@ +# git rebase-patch + +> Find the commit the patch applies to and do a rebase. +> Part of `git-extras`. +> More information: . + +- Find the commit the patch applies to and do a rebase: + +`git rebase-patch {{patch_file}}` diff --git a/pages/common/git-rscp.md b/pages/common/git-rscp.md new file mode 100644 index 0000000..ab9a9ea --- /dev/null +++ b/pages/common/git-rscp.md @@ -0,0 +1,13 @@ +# git rscp + +> Reverse `git scp` - copy files from the working directory of a remote repository to the current working tree. +> Part of `git-extras`. +> More information: . + +- Copy specific files from a remote: + +`git rscp {{remote_name}} {{path/to/file1 path/to/file2 ...}}` + +- Copy a specific directory from a remote: + +`git rscp {{remote_name}} {{path/to/directory}}` diff --git a/pages/common/git-stage.md b/pages/common/git-stage.md index 9f3e301..ad676a1 100644 --- a/pages/common/git-stage.md +++ b/pages/common/git-stage.md @@ -1,33 +1,8 @@ # git stage -> Add file contents to the staging area. -> Synonym of `git add`. +> This command is an alias of `git add`. > More information: . -- Add a file to the index: +- View documentation for the original command: -`git stage {{path/to/file}}` - -- Add all files (tracked and untracked): - -`git stage -A` - -- Only add already tracked files: - -`git stage -u` - -- Also add ignored files: - -`git stage -f` - -- Interactively stage parts of files: - -`git stage -p` - -- Interactively stage parts of a given file: - -`git stage -p {{path/to/file}}` - -- Interactively stage a file: - -`git stage -i` +`tldr git add` diff --git a/pages/common/git-status.md b/pages/common/git-status.md index d243b66..50a0d4d 100644 --- a/pages/common/git-status.md +++ b/pages/common/git-status.md @@ -10,12 +10,20 @@ - Give output in [s]hort format: -`git status -s` +`git status --short` -- Don't show untracked files in the output: +- Show the [b]ranch and tracking info: -`git status --untracked-files=no` +`git status --branch` - Show output in [s]hort format along with [b]ranch info: -`git status -sb` +`git status --short --branch` + +- Show the number of entries currently stashed away: + +`git status --show-stash` + +- Don't show untracked files in the output: + +`git status --untracked-files=no` diff --git a/pages/common/git-subtree.md b/pages/common/git-subtree.md index a41cf64..c2e225f 100644 --- a/pages/common/git-subtree.md +++ b/pages/common/git-subtree.md @@ -1,7 +1,7 @@ # git subtree > Tool to manage project dependencies as subprojects. -> More information: . +> More information: . - Add a Git repository as a subtree: diff --git a/pages/common/gitui.md b/pages/common/gitui.md new file mode 100644 index 0000000..f45da5f --- /dev/null +++ b/pages/common/gitui.md @@ -0,0 +1,36 @@ +# gitui + +> Terminal UI for Git. +> More information: . + +- Set the color theme (defaults to `theme.ron`): + +`gitui --theme {{theme}}` + +- Store logging output into a cache directory: + +`gitui --logging` + +- Use notify-based file system watcher instead of tick-based update: + +`gitui --watcher` + +- Generate a bug report: + +`gitui --bugreport` + +- Set the Git directory: + +`gitui --directory {{path/to/directory}}` + +- Set the working directory: + +`gitui --workdir {{path/to/directory}}` + +- Display help: + +`gitui --help` + +- Display version: + +`gitui --version` diff --git a/pages/common/gladtex.md b/pages/common/gladtex.md new file mode 100644 index 0000000..1900117 --- /dev/null +++ b/pages/common/gladtex.md @@ -0,0 +1,33 @@ +# gladtex + +> A LaTeX formula preprocessor for HTML files. +> It converts LaTeX formulas to images. +> More information: . + +- Convert to html: + +`gladtex {{path/to/input.htex}}` + +- Save the converted file to a specific location: + +`gladtex {{path/to/input.htex}} -o {{path/to/output.html}}` + +- Save the generated images to a specific [d]irectory: + +`gladtex {{path/to/input.htex}} -d {{path/to/image_output_directory}}` + +- Set image [r]esolution (in dpi, default is 100): + +`gladtex {{path/to/input.htex}} -r {{resolution}}` + +- [k]eep LaTeX files after conversion: + +`gladtex {{path/to/input.htex}} -k` + +- Set [b]ackground and [f]oreground color of the images: + +`gladtex {{path/to/input.htex}} -b {{background_color}} -f {{foreground_color}}` + +- Convert Markdown to HTML using `pandoc` and `gladtex`: + +`pandoc -s -t html --gladtex {{path/to/input.md}} | gladtex -o {{path/to/output.html}}` diff --git a/pages/common/gotelemetry.md b/pages/common/gotelemetry.md new file mode 100644 index 0000000..b466736 --- /dev/null +++ b/pages/common/gotelemetry.md @@ -0,0 +1,24 @@ +# gotelemetry + +> A tool for managing Go telemetry data and settings. +> More information: . + +- Enable telemetry uploading: + +`gotelemetry on` + +- Disable telemetry uploading: + +`gotelemetry off` + +- Run a Web Viewer for local telemetry data: + +`gotelemetry view` + +- Print the current telemetry environment: + +`gotelemetry env` + +- Show details about any subcommand: + +`gotelemetry help {{subcommand}}` diff --git a/pages/common/gulp.md b/pages/common/gulp.md index 0bd57e2..18ee2ea 100644 --- a/pages/common/gulp.md +++ b/pages/common/gulp.md @@ -1,7 +1,7 @@ # gulp > JavaScript task runner and streaming build system. -> Tasks are defined within gulpfile.js at the project root. +> Tasks are defined within `gulpfile.js` at the project root. > More information: . - Run the default task: @@ -11,3 +11,7 @@ - Run individual tasks: `gulp {{task}} {{othertask}}` + +- Print the task dependency tree for the loaded gulpfile: + +`gulp --tasks` diff --git a/pages/common/hd.md b/pages/common/hd.md new file mode 100644 index 0000000..8424674 --- /dev/null +++ b/pages/common/hd.md @@ -0,0 +1,8 @@ +# hd + +> This command is an alias of `hexdump`. +> More information: . + +- View documentation for the original command: + +`tldr hexdump` diff --git a/pages/common/hipstopgm.md b/pages/common/hipstopgm.md new file mode 100644 index 0000000..186f38a --- /dev/null +++ b/pages/common/hipstopgm.md @@ -0,0 +1,17 @@ +# hipstopgm + +> Read a HIPS file as input and return a PGM image as output. +> If the HIPS file contains more than one frame in sequence, `hipstopgm` will concatenate all the frames vertically. +> More information: . + +- Convert a HIPS file into a PGM image: + +`hipstopgm {{path/to/file.hips}}` + +- Suppress all informational messages: + +`hipstopgm -quiet` + +- Display version: + +`hipstopgm -version` diff --git a/pages/common/hub-branch.md b/pages/common/hub-branch.md new file mode 100644 index 0000000..fbed103 --- /dev/null +++ b/pages/common/hub-branch.md @@ -0,0 +1,12 @@ +# hub branch + +> Create a branch or show current branch. +> See also `git branch`. + +- Show the name of the currently active branch: + +`hub branch` + +- Create a new branch: + +`hub branch {{branch_name}}` diff --git a/pages/common/hub-browse.md b/pages/common/hub-browse.md new file mode 100644 index 0000000..4f83044 --- /dev/null +++ b/pages/common/hub-browse.md @@ -0,0 +1,16 @@ +# hub browse + +> Open a GitHub repository in the browser or print the URL. +> More information: . + +- Open the homepage of the current repository in the default web browser: + +`hub browse` + +- Open the homepage of a specific repository in the default web browser: + +`hub browse {{owner}}/{{repository}}` + +- Open the subpage of a specific repository in the default web browser, subpage can be "wiki", "commits", "issues", or other (default: "tree"): + +`hub browse {{owner}}/{{repository}} {{subpage}}` diff --git a/pages/common/hub-ci-status.md b/pages/common/hub-ci-status.md new file mode 100644 index 0000000..6952e6e --- /dev/null +++ b/pages/common/hub-ci-status.md @@ -0,0 +1,12 @@ +# hub ci-status + +> Display status of GitHub checks. +> More information: . + +- Check the CI status for this branch: + +`hub ci-status --verbose` + +- Display status of GitHub checks for a commit: + +`hub ci-status --verbose {{commit_SHA}}` diff --git a/pages/common/hub-clone.md b/pages/common/hub-clone.md new file mode 100644 index 0000000..021055c --- /dev/null +++ b/pages/common/hub-clone.md @@ -0,0 +1,8 @@ +# hub clone + +> Clone an existing repository. +> More information: . + +- Clone an existing repository to current directory (If run into authentication problem, try full ssh path): + +`hub clone {{remote_repository_location}}` diff --git a/pages/common/hub-create.md b/pages/common/hub-create.md new file mode 100644 index 0000000..47d0403 --- /dev/null +++ b/pages/common/hub-create.md @@ -0,0 +1,12 @@ +# hub create + +> Create a new repository on GitHub. +> More information: . + +- Upload the current (local-only) repository to your GitHub account as public: + +`hub create` + +- Create a private repository and open the new repository in a web browser: + +`hub create --private --browse` diff --git a/pages/common/hub-delete.md b/pages/common/hub-delete.md new file mode 100644 index 0000000..26da0e1 --- /dev/null +++ b/pages/common/hub-delete.md @@ -0,0 +1,8 @@ +# hub delete + +> Delete an existing repository on GitHub. +> More information: . + +- Delete personal repo on GitHub: + +`hub delete {{repo}}` diff --git a/pages/common/hub-fork.md b/pages/common/hub-fork.md new file mode 100644 index 0000000..28f8aa8 --- /dev/null +++ b/pages/common/hub-fork.md @@ -0,0 +1,16 @@ +# hub fork + +> Fork the given GitHub repo. Like `git fork` from `git-extras`. +> More information: . + +- Fork a GitHub repository by its slug: + +`hub fork {{tldr-pages/tldr}}` + +- Fork a GitHub repository by its URL: + +`hub fork {{https://github.com/tldr-pages/tldr}}` + +- Fork current GitHub repository, set remote name to origin: + +`hub fork --remote-name {{origin}}` diff --git a/pages/common/hub-init.md b/pages/common/hub-init.md new file mode 100644 index 0000000..03fb6ab --- /dev/null +++ b/pages/common/hub-init.md @@ -0,0 +1,8 @@ +# hub init + +> Initializes a new local git repository. +> More information: . + +- Initialize a new local repository: + +`hub init` diff --git a/pages/common/hub-issue.md b/pages/common/hub-issue.md new file mode 100644 index 0000000..cd07128 --- /dev/null +++ b/pages/common/hub-issue.md @@ -0,0 +1,16 @@ +# hub issue + +> Manage Github issues. +> More information: . + +- List the last 10 issues with the `bug` label: + +`hub issue list --limit {{10}} --labels "{{bug}}" ` + +- Display a specific issue: + +`hub issue show {{issue_number}}` + +- List 10 closed issues assigneed to a specific user: + +`hub issue --state {{closed}} --assignee {{username}} --limit {{10}}` diff --git a/pages/common/hugo.md b/pages/common/hugo.md index 37fdfa1..800c7c1 100644 --- a/pages/common/hugo.md +++ b/pages/common/hugo.md @@ -23,6 +23,10 @@ `hugo --buildDrafts` +- Build a site on your local IP: + +`hugo server --bind {{local-ip}} --baseURL {{http://local-ip}}` + - Build a site to a given directory: `hugo --destination {{path/to/destination}}` diff --git a/pages/common/identify.md b/pages/common/identify.md index c133f03..b9f31cd 100644 --- a/pages/common/identify.md +++ b/pages/common/identify.md @@ -1,6 +1,7 @@ # identify -> Command-line utility of Image Magick project to describe the format and characteristics of one or more image files. +> Describe the format and characteristics of one or more image files. +> Part of ImageMagick. > More information: . - Describe the format and basic characteristics of an image: @@ -11,6 +12,6 @@ `identify -verbose {{path/to/image}}` -- Collect dimensions of all JPEG files under current directory: +- Collect dimensions of all JPEG files in the current directory and save them into a CSV file: -`identify -format "%f,%w,%h\n" *.{{jpg}} > {{path/to/filelist.csv}}` +`identify -format "{{%f,%w,%h\n}}" {{*.jpg}} > {{path/to/filelist.csv}}` diff --git a/pages/common/ifs.md b/pages/common/ifs.md new file mode 100644 index 0000000..0dc5020 --- /dev/null +++ b/pages/common/ifs.md @@ -0,0 +1,21 @@ +# IFS + +> IFS (Internal Field Separator) is a special environment variable that defines the delimiter used for word splitting in Unix shells. +> The default value of IFS is a space, tab, and newline. The three characters serve as delimiters. +> More information: . + +- View the current IFS value: + +`echo "$IFS"` + +- Change the IFS value: + +`IFS="{{:}}"` + +- Reset IFS to default: + +`IFS=$' \t\n'` + +- Temporarily change the IFS value in a subshell: + +`(IFS="{{:}}"; echo "{{one:two:three}}")` diff --git a/pages/common/imgtoppm.md b/pages/common/imgtoppm.md new file mode 100644 index 0000000..fc01e89 --- /dev/null +++ b/pages/common/imgtoppm.md @@ -0,0 +1,12 @@ +# imgtoppm + +> Converts various image file formats to the PPM (Portable Pixmap) format. +> More information: . + +- Convert an input image to PPM format: + +`imgtoppm {{path/to/input}} > {{path/to/output.ppm}}` + +- Display version: + +`imgtoppm -version` diff --git a/pages/common/import.md b/pages/common/import.md index 7546866..b643000 100644 --- a/pages/common/import.md +++ b/pages/common/import.md @@ -1,17 +1,17 @@ # import > Capture some or all of an X server screen, and save the image to a file. -> Part of the ImageMagick library. +> Part of ImageMagick. > More information: . -- Capture the entire X server screen in the PostScript image format: +- Capture the entire X server screen into a PostScript file: -`import -window root {{output.postscript}}` +`import -window root {{path/to/output.ps}}` -- Capture contents of a remote X server screen in the PNG format: +- Capture contents of a remote X server screen into a PNG image: -`import -window root -display {{remote_host}}:{{screen}}.{{display}} {{output.png}}` +`import -window root -display {{remote_host}}:{{screen}}.{{display}} {{path/to/output.png}}` -- Capture a specific window, given its ID as displayed by `xwininfo`, into the JPEG format: +- Capture a specific window given its ID as displayed by `xwininfo` into a JPEG image: -`import -window {{window_id}} {{output.jpg}}` +`import -window {{window_id}} {{path/to/output.jpg}}` diff --git a/pages/common/install-nodeversion.md b/pages/common/install-nodeversion.md new file mode 100644 index 0000000..115b55d --- /dev/null +++ b/pages/common/install-nodeversion.md @@ -0,0 +1,25 @@ +# Install-NodeVersion + +> Install Node.js runtime versions for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Install a specific Node.js version: + +`Install-NodeVersion {{node_version}}` + +- Install multiple Node.js versions: + +`Install-NodeVersion {{node_version1 , node_version2 , ...}}` + +- Install latest available version of Node.js 20: + +`Install-NodeVersion ^20` + +- Install the x86 (x86 32-bit) / x64 (x86 64-bit) / arm64 (ARM 64-bit) version of Node.js: + +`Install-NodeVersion {{node_version}} -Architecture {{x86|x64|arm64}}` + +- Use a HTTP proxy to download Node.js: + +`Install-NodeVersion {{node-version}} -Proxy {{http://example.com}}` diff --git a/pages/common/jpegtopnm.md b/pages/common/jpegtopnm.md new file mode 100644 index 0000000..48fcee5 --- /dev/null +++ b/pages/common/jpegtopnm.md @@ -0,0 +1,12 @@ +# jpegtopnm + +> Converts a JPEG/JFIF file to the PPM or PGM format. +> More information: . + +- Convert JPEG/JFIF image to a PPM or PGM image: + +`jpegtopnm {{path/to/file.jpg}} > {{path/to/file.pnm}}` + +- Display version: + +`jpegtopnm -version` diff --git a/pages/common/jq.md b/pages/common/jq.md index dbd6e69..9fa80b3 100644 --- a/pages/common/jq.md +++ b/pages/common/jq.md @@ -1,9 +1,9 @@ # jq -> A command-line JSON processor that uses a domain-specific language. +> A command-line JSON processor that uses a domain-specific language (DSL). > More information: . -- Execute a specific expression (print a colored and formatted json): +- Execute a specific expression (print a colored and formatted JSON output): `{{cat path/to/file.json}} | jq '.'` diff --git a/pages/common/just.1.md b/pages/common/just.1.md new file mode 100644 index 0000000..1a77610 --- /dev/null +++ b/pages/common/just.1.md @@ -0,0 +1,24 @@ +# just + +> Save and run project-specific commands. +> More information: . + +- Run a recipe specified in the justfile: + +`just {{recipe}}` + +- Initialize new justfile in project root: + +`just --init` + +- Edit justfile in the default editor: + +`just -e` + +- List available recipes in the justfile: + +`just -l` + +- Print justfile: + +`just --dump` diff --git a/pages/common/just.md b/pages/common/just.md index 1a77610..0f61087 100644 --- a/pages/common/just.md +++ b/pages/common/just.md @@ -1,24 +1,11 @@ # just -> Save and run project-specific commands. -> More information: . +> `just` can refer to multiple commands with the same name. -- Run a recipe specified in the justfile: +- View documentation for the command runner: -`just {{recipe}}` +`tldr just.1` -- Initialize new justfile in project root: +- View documentation for the V8 JavaScript runtime: -`just --init` - -- Edit justfile in the default editor: - -`just -e` - -- List available recipes in the justfile: - -`just -l` - -- Print justfile: - -`just --dump` +`tldr just.js` diff --git a/pages/common/k9s.md b/pages/common/k9s.md new file mode 100644 index 0000000..be49941 --- /dev/null +++ b/pages/common/k9s.md @@ -0,0 +1,20 @@ +# k9s + +> View and manage Kubernetes clusters. +> More information: . + +- Manage a cluster using a kubeconfig context: + +`k9s --context {{kubeconfig_context_name}}` + +- Manage a cluster in read-only mode (disabling all commands that may cause modifications): + +`k9s --readonly --cluster {{cluster_name}}` + +- Manage a cluster using a given kubernetes namespace: + +`k9s --namespace {{kubernetes_namespace}} --cluster {{cluster_name}}` + +- Manage a cluster launching k9s in the pod view and enable debug logging: + +`k9s --command {{pod}} --logLevel debug --cluster {{cluster_name}}` diff --git a/pages/common/kops.md b/pages/common/kops.md index d37e59a..5ea3f75 100644 --- a/pages/common/kops.md +++ b/pages/common/kops.md @@ -22,3 +22,7 @@ - Delete a cluster: `kops delete cluster {{cluster_name}} --yes` + +- Validate a cluster: + +`kops validate cluster {{cluster_name}} --wait {{wait_time_until_ready}} --count {{num_required_validations}}` diff --git a/pages/linux/krita.md b/pages/common/krita.md similarity index 84% rename from pages/linux/krita.md rename to pages/common/krita.md index 5dd3b31..f13cf5a 100644 --- a/pages/linux/krita.md +++ b/pages/common/krita.md @@ -1,6 +1,6 @@ # krita -> Krita is a sketching and painting program designed for digital artists. +> A sketching and painting program designed for digital artists. > See also: `gimp`. > More information: . diff --git a/pages/common/kubectl-apply.md b/pages/common/kubectl-apply.md new file mode 100644 index 0000000..3fbaa8a --- /dev/null +++ b/pages/common/kubectl-apply.md @@ -0,0 +1,20 @@ +# kubectl apply + +> Manages applications through files defining Kubernetes resources. It creates and updates resources in a cluster. +> More information: . + +- Apply a configuration to a resource by file name or `stdin`: + +`kubectl apply -f {{resource_filename}}` + +- Edit the latest last-applied-configuration annotations of resources from the default editor: + +`kubectl apply edit-last-applied -f {{resource_filename}}` + +- Set the latest last-applied-configuration annotations by setting it to match the contents of a file: + +`kubectl apply set-last-applied -f {{resource_filename}}` + +- View the latest last-applied-configuration annotations by type/name or file: + +`kubectl apply view-last-applied -f {{resource_filename}}` diff --git a/pages/common/kubectl-create.md b/pages/common/kubectl-create.md new file mode 100644 index 0000000..1078838 --- /dev/null +++ b/pages/common/kubectl-create.md @@ -0,0 +1,28 @@ +# kubectl create + +> Create a resource from a file or from `stdin`. +> More information: . + +- Create a resource using the resource definition file: + +`kubectl create -f {{path/to/file.yml}}` + +- Create a resource from `stdin`: + +`kubectl create -f -` + +- Create a deployment: + +`kubectl create deployment {{deployment_name}} --image={{image}}` + +- Create a deployment with replicas: + +`kubectl create deployment {{deployment_name}} --image={{image}} --replicas={{number_of_replicas}}` + +- Create a service: + +`kubectl create service {{service_type}} {{service_name}} --tcp={{port}}:{{target_port}}` + +- Create a namespace: + +`kubectl create namespace {{namespace_name}}` diff --git a/pages/common/kubectl-expose.md b/pages/common/kubectl-expose.md new file mode 100644 index 0000000..94fba84 --- /dev/null +++ b/pages/common/kubectl-expose.md @@ -0,0 +1,16 @@ +# kubectl edit + +> Expose a resource as a new Kubernetes service. +> More information: . + +- Create a service for a resource, which will be served from container port to node port: + +`kubectl expose {{resource_type}} {{resource_name}} --port={{node_port}} --target-port={{container_port}}` + +- Create a service for a resource identified by a file: + +`kubectl expose -f {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` + +- Create a service with a name, to serve to a node port which will be same for container port: + +`kubectl expose {{resource_type}} {{resource_name}} --port={{node_port}} --name={{service_name}}` diff --git a/pages/common/kubectl-label.md b/pages/common/kubectl-label.md new file mode 100644 index 0000000..1fffeda --- /dev/null +++ b/pages/common/kubectl-label.md @@ -0,0 +1,24 @@ +# kubectl edit + +> Edit Kubernetes resources. +> More information: . + +- Label a pod: + +`kubectl label pod {{pod_name}} {{key}}={{value}}` + +- Update a pod label by overwriting the existing value: + +`kubectl label --overwrite {{pod_name}} {{key}}={{value}}` + +- Label all pods in the namespace: + +`kubectl label pods --all {{key}}={{value}}` + +- Label pod identified by pod definition file: + +`kubectl label -f {{pod_defination_file}} {{key}}={{value}}` + +- Remove the label from a pod: + +`kubectl label pod {{pod_name}} {{key}}-` diff --git a/pages/common/kubectl-replace.md b/pages/common/kubectl-replace.md new file mode 100644 index 0000000..91075ca --- /dev/null +++ b/pages/common/kubectl-replace.md @@ -0,0 +1,16 @@ +# kubctl replace + +> Replace a resource by file or `stdin`. +> More information: . + +- Replace the resource using the resource definition file: + +`kubectl replace -f {{path/to/file.yml}}` + +- Replace the resource using the input passed into `stdin`: + +`kubectl replace -f -` + +- Force replace, delete and then re-create the resource: + +`kubectl replace --force -f {{path/to/file.yml}}` diff --git a/pages/common/kubectl-scale.md b/pages/common/kubectl-scale.md new file mode 100644 index 0000000..caffce5 --- /dev/null +++ b/pages/common/kubectl-scale.md @@ -0,0 +1,16 @@ +# kubectl edit + +> Set a new size for a deployment, replica set, replication controller, or stateful set. +> More information: . + +- Scale a replica set: + +`kubectl scale --replicas={{number_of_replicas}} rs/{{replica_name}}` + +- Scale a resource identified by a file: + +`kubectl scale --replicas={{number_of_replicas}} -f {{path/to/file.yml}}` + +- Scale a deployment based on current number of replicas: + +`kubectl scale --current-replicas={{current_replicas}} --replicas={{number_of_replicas}} deployment/{{deployment_name}}` diff --git a/pages/common/kubectl-taint.md b/pages/common/kubectl-taint.md new file mode 100644 index 0000000..8f31552 --- /dev/null +++ b/pages/common/kubectl-taint.md @@ -0,0 +1,16 @@ +# kubectl taint + +> Update the taints on one or more nodes. +> More information: . + +- Apply taint to a node: + +`kubectl taint nodes {{node_name}} {{label_key}}={{label_value}}:{{effect}}` + +- Remove taint from a node: + +`kubectl taint nodes {{node_name}} {{label_key}}:{{effect}}-` + +- Remove all taints from a node: + +`kubectl taint nodes {{node_name}} {{label_key}}-` diff --git a/pages/common/ldc.md b/pages/common/ldc.md new file mode 100644 index 0000000..1b820e9 --- /dev/null +++ b/pages/common/ldc.md @@ -0,0 +1,24 @@ +# ldc + +> D compiler using LLVM as a backend. +> More information: . + +- Compile a source code file into an executable binary: + +`ldc2 {{path/to/source.d}} -of={{path/to/output_executable}}` + +- Compile the source code file without linking: + +`ldc2 -c {{path/to/source.d}}` + +- Select the target architecture and OS: + +`ldc -mtriple={{architecture_OS}} -c {{path/to/source.d}}` + +- Display help: + +`ldc2 -h` + +- Display complete help: + +`ldc2 -help-hidden` diff --git a/pages/common/leaftoppm.md b/pages/common/leaftoppm.md new file mode 100644 index 0000000..95b199e --- /dev/null +++ b/pages/common/leaftoppm.md @@ -0,0 +1,12 @@ +# leaftoppm + +> Convert an Interleaf image to a PPM image. +> More information: . + +- Generate a PPM image file as output for an Interleaf image file as input: + +`leaftoppm {{path/to/file.pl}}` + +- Display version: + +`leaftoppm -version` diff --git a/pages/common/linode-cli-volumes.md b/pages/common/linode-cli-volumes.md index 997c18d..910619f 100644 --- a/pages/common/linode-cli-volumes.md +++ b/pages/common/linode-cli-volumes.md @@ -4,7 +4,7 @@ > See also: `linode-cli`. > More information: . -- List current Volumnes: +- List current Volumes: `linode-cli volumes list` diff --git a/pages/common/linode-cli.md b/pages/common/linode-cli.md index 1ccccd9..6121c8f 100644 --- a/pages/common/linode-cli.md +++ b/pages/common/linode-cli.md @@ -8,7 +8,7 @@ `linode-cli linodes list` -- View docmentation for managing Linode accounts: +- View documentation for managing Linode accounts: `tldr linode-cli account` @@ -28,7 +28,7 @@ `tldr linode-cli object-storage` -- View documentation for managing DNS domains: +- View documentation for managing domains and DNS configuration: `tldr linode-cli domains` diff --git a/pages/common/lsyncd.md b/pages/common/lsyncd.md new file mode 100644 index 0000000..428e7fa --- /dev/null +++ b/pages/common/lsyncd.md @@ -0,0 +1,13 @@ +# lsyncd + +> Watch files and directories and run `rsync` when they change. +> It is often used to keep two directories on separate systems in sync, ensuring that changes made in one directory are immediately mirrored to the other. +> More information: . + +- Watch the source for changes and run `rsync` to synchronize files to the destination on every change: + +`lsyncd -rsync {{path/to/source}} {{host::share_name}}` + +- Use SSH instead of `rsyncd` shares: + +`lsyncd -rsyncssh {{path/to/source}} {{host}} {{path/to/destination}}` diff --git a/pages/common/macptopbm.md b/pages/common/macptopbm.md new file mode 100644 index 0000000..d0b7869 --- /dev/null +++ b/pages/common/macptopbm.md @@ -0,0 +1,20 @@ +# macptopbm + +> Read a MacPaint file as input and produce a PBM image as output. +> More information: . + +- Convert a MacPaint file into a PGM image: + +`macptopbm {{path/to/file.mac}}` + +- Skip over a specified number of bytes when reading the file: + +`macptopbm -extraskip {{N}}` + +- Suppress all informational messages: + +`macptopbm -quiet` + +- Display version: + +`macptopbm -version` diff --git a/pages/common/magick.md b/pages/common/magick.md index 06702e0..48d7df4 100644 --- a/pages/common/magick.md +++ b/pages/common/magick.md @@ -1,25 +1,25 @@ # magick -> Create, edit, compose, or convert bitmap images. +> Create, edit, compose, or convert between image formats. > ImageMagick version 7+. See `convert` for versions 6 and below. > More information: . -- Convert file type: +- Convert between image formats: -`magick {{image.png}} {{image.jpg}}` +`magick {{path/to/input_image.png}} {{path/to/output_image.jpg}}` - Resize an image, making a new copy: -`magick convert -resize {{100x100}} {{image.jpg}} {{image.jpg}}` +`magick {{path/to/input_image.jpg}} -resize {{100x100}} {{path/to/output_image.jpg}}` -- Create a GIF using images: +- Create a GIF out of all JPG images in the current directory: -`magick {{*.jpg}} {{images.gif}}` +`magick {{*.jpg}} {{path/to/images.gif}}` -- Create checkerboard pattern: +- Create a checkerboard pattern: -`magick -size {{640x480}} pattern:checkerboard {{checkerboard.png}}` +`magick -size {{640x480}} pattern:checkerboard {{path/to/checkerboard.png}}` -- Convert images to individual PDF pages: +- Create a PDF file out of all JPG images in the current directory: -`magick {{*.jpg}} +adjoin {{page-%d.pdf}}` +`magick {{*.jpg}} -adjoin {{path/to/file.pdf}}` diff --git a/pages/common/mktemp.md b/pages/common/mktemp.md index 3373a12..c368554 100644 --- a/pages/common/mktemp.md +++ b/pages/common/mktemp.md @@ -1,16 +1,24 @@ # mktemp > Create a temporary file or directory. -> More information: . +> More information: . -- Create an empty temporary file and print the absolute path to it: +- Create an empty temporary file and print its absolute path: `mktemp` -- Create an empty temporary file with a given suffix and print the absolute path to file: +- Use a custom directory if `$TMPDIR` is not set (the default is platform-dependent, but usually `/tmp`): -`mktemp --suffix "{{.ext}}"` +`mktemp -p {{/path/to/tempdir}}` -- Create a temporary directory and print the absolute path to it: +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` + +- Use a custom file name template: + +`mktemp -t {{example.XXXXXXXX}}` + +- Create an empty temporary directory and print its absolute path: `mktemp -d` diff --git a/pages/common/mogrify.md b/pages/common/mogrify.md index 3f86661..b43a240 100644 --- a/pages/common/mogrify.md +++ b/pages/common/mogrify.md @@ -1,14 +1,14 @@ # mogrify > Perform operations on multiple images, such as resizing, cropping, flipping, and adding effects. -> Changes are applied directly to the original file. +> Changes are applied directly to the original file. Part of ImageMagick. > More information: . - Resize all JPEG images in the directory to 50% of their initial size: `mogrify -resize {{50%}} {{*.jpg}}` -- Resize all images starting with "DSC" to 800x600: +- Resize all images starting with `DSC` to 800x600: `mogrify -resize {{800x600}} {{DSC*}}` diff --git a/pages/common/montage.md b/pages/common/montage.md index 453ce13..660ab62 100644 --- a/pages/common/montage.md +++ b/pages/common/montage.md @@ -1,25 +1,25 @@ # montage -> ImageMagick image montage tool. -> Tiles images into a customisable grid. +> Tiles images into a customizable grid. +> Part of ImageMagick. > More information: . - Tile images into a grid, automatically resizing images larger than the grid cell size: -`montage {{image1.png}} {{image2.jpg}} {{imageN.png}} montage.jpg` +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} {{path/to/montage.jpg}}` - Tile images into a grid, automatically calculating the grid cell size from the largest image: -`montage {{image1.png}} {{image2.jpg}} {{imageN.png}} -geometry +0+0 montage.jpg` +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} {{path/to/montage.jpg}}` - Set the grid cell size and resize images to fit it before tiling: -`montage {{image1.png}} {{image2.jpg}} {{imageN.png}} -geometry 640x480+0+0 montage.jpg` +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{640x480+0+0}} {{path/to/montage.jpg}}` - Limit the number of rows and columns in the grid, causing input images to overflow into multiple output montages: -`montage {{image1.png}} {{image2.jpg}} {{imageN.png}} -geometry +0+0 -tile 2x3 montage_%d.jpg` +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} -tile {{2x3}} {{montage_%d.jpg}}` - Resize and crop images to fill their grid cells before tiling: -`montage {{image1.png}} {{image2.jpg}} {{imageN.png}} -geometry +0+0 -resize 640x480^ -gravity center -crop 640x480+0+0 montage.jpg` +`montage {{path/to/image1.jpg path/to/image2.jpg ...}} -geometry {{+0+0}} -resize {{640x480^}} -gravity {{center}} -crop {{640x480+0+0}} {{path/to/montage.jpg}}` diff --git a/pages/common/neotoppm.md b/pages/common/neotoppm.md new file mode 100644 index 0000000..e781f90 --- /dev/null +++ b/pages/common/neotoppm.md @@ -0,0 +1,12 @@ +# neotoppm + +> Convert an Atari Neochrome NEO file into a PPM image. +> More information: . + +- Generate the PPM image as output for an Atari Neochrome NEO file as input: + +`neotoppm {{path/to/file.neo}}` + +- Display version: + +`neotoppm -version` diff --git a/pages/common/npm.md b/pages/common/npm.md index 1fd4956..4ac6ab0 100644 --- a/pages/common/npm.md +++ b/pages/common/npm.md @@ -8,30 +8,30 @@ `npm init` -- Download all the packages listed as dependencies in package.json: +- Download all the packages listed as dependencies in `package.json`: `npm install` - Download a specific version of a package and add it to the list of dependencies in `package.json`: -`npm install {{module_name}}@{{version}}` +`npm install {{package_name}}@{{version}}` -- Download a package and add it to the list of dev dependencies in `package.json`: +- Download the latest version of a package and add it to the list of dev dependencies in `package.json`: -`npm install {{module_name}} --save-dev` +`npm install {{package_name}} --save-dev` -- Download a package and install it globally: +- Download the latest version of a package and install it globally: -`npm install --global {{module_name}}` +`npm install --global {{package_name}}` - Uninstall a package and remove it from the list of dependencies in `package.json`: -`npm uninstall {{module_name}}` +`npm uninstall {{package_name}}` -- Print a tree of locally installed dependencies: +- List of locally installed dependencies: `npm list` -- List top-level globally installed modules: +- List top-level globally installed packages: `npm list --global --depth={{0}}` diff --git a/pages/common/open.fish.md b/pages/common/open.fish.md new file mode 100644 index 0000000..5ae4dab --- /dev/null +++ b/pages/common/open.fish.md @@ -0,0 +1,25 @@ +# open + +> Opens files, directories, and URIs with default applications. +> This command is available through `fish` on operating systems without the built-in `open` command (e.g. Haiku and macOS). +> More information: . + +- Open a file with the associated application: + +`open {{path/to/file.ext}}` + +- Open all the files of a given extension in the current directory with the associated application: + +`open {{*.ext}}` + +- Open a directory using the default file manager: + +`open {{path/to/directory}}` + +- Open a website using the default web browser: + +`open {{https://example.com}}` + +- Open a specific URI using the default application that can handle it: + +`open {{tel:123}}` diff --git a/pages/common/open.md b/pages/common/open.md new file mode 100644 index 0000000..aa91097 --- /dev/null +++ b/pages/common/open.md @@ -0,0 +1,15 @@ +# open + +> `open` can refer to multiple commands with the same name. + +- View documentation for the command available in macOS: + +`tldr open -p osx` + +- View documentation for the macOS command in older versions of `tldr` command-line client: + +`tldr open -o osx` + +- View documentation for the command available through `fish`: + +`tldr open.fish` diff --git a/pages/common/packer.md b/pages/common/packer.md index f2c7229..53979df 100644 --- a/pages/common/packer.md +++ b/pages/common/packer.md @@ -10,3 +10,7 @@ - Check the syntax of a Packer image config: `packer validate {{path/to/config.json}}` + +- Format a Packer image config: + +`packer fmt {{path/to/config.pkr.hcl}}` diff --git a/pages/common/palmtopnm.md b/pages/common/palmtopnm.md new file mode 100644 index 0000000..1fe4d8e --- /dev/null +++ b/pages/common/palmtopnm.md @@ -0,0 +1,20 @@ +# palmtopnm + +> Convert a Palm Bitmap file to a PNM image. +> More information: . + +- Generate the PNM image as output, for a Palm Bitmap file as input: + +`palmtopnm {{path/to/file.palm}}` + +- Display various information about the input Palm Bitmap file and process: + +`palmtopnm -verbose {{path/to/file.palm}}` + +- Generate a histogram of colours in the input Palm Bitmap file to `stderr`: + +`palmtopnm -showhist {{path/to/file.palm}}` + +- Display version: + +`palmtopnm -version` diff --git a/pages/common/pamdepth.md b/pages/common/pamdepth.md new file mode 100644 index 0000000..f9cea14 --- /dev/null +++ b/pages/common/pamdepth.md @@ -0,0 +1,8 @@ +# pamdepth + +> Reduce the depth (i.e. color resolution) in an image. +> More information: . + +- Read a PBM image, set its maxval and save it to a file: + +`pamdepth {{maxval}} {{path/to/image.pbm}} > {{path/to/file.pbm}}` diff --git a/pages/common/pamditherbw.md b/pages/common/pamditherbw.md new file mode 100644 index 0000000..3ca2482 --- /dev/null +++ b/pages/common/pamditherbw.md @@ -0,0 +1,20 @@ +# pamditherbw + +> Apply dithering to a greyscale image, i.e. turn it into a pattern of black and white pixels that look the same as the original greyscale. +> More information: . + +- Read a PGM image, apply dithering and save it to a file: + +`ppmditherbw {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Use the specified quantization method: + +`ppmditherbw -{{floyd|fs|atkinson|threshold|hilbert|...}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Use the atkinson quantization method and the specified seed for a pseudo-random number generator: + +`ppmditherbw -atkinson -randomseed {{1337}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` + +- Specify the thresholding value for quantization methods that perform some sort of thresholding: + +`ppmditherbw -{{fs|atkinson|thresholding}} -value {{0.3}} {{path/to/image.pgm}} > {{path/to/file.pgm}}` diff --git a/pages/common/pamfile.md b/pages/common/pamfile.md new file mode 100644 index 0000000..03c664b --- /dev/null +++ b/pages/common/pamfile.md @@ -0,0 +1,16 @@ +# pamfile + +> Describe Netpbm (PAM or PNM) files. +> More information: . + +- Describe the specified Netpbm files: + +`pamfile {{path/to/file1 path/to/file2 ...}}` + +- Describe every image in each input file (as opposed to only the first image in each file) in a machine-readable format: + +`pamfile -allimages -machine {{path/to/file}}` + +- Display a count on how many images the input files contain: + +`pamfile -count {{path/to/file}}` diff --git a/pages/common/pamnoraw.md b/pages/common/pamnoraw.md new file mode 100644 index 0000000..562ce65 --- /dev/null +++ b/pages/common/pamnoraw.md @@ -0,0 +1,8 @@ +# pamnoraw + +> This command is an alias of `pamtopnm -plain`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pages/common/pamtopam.md b/pages/common/pamtopam.md new file mode 100644 index 0000000..dd9a1ad --- /dev/null +++ b/pages/common/pamtopam.md @@ -0,0 +1,12 @@ +# pamtopam + +> Copy a PAM image. +> More information: . + +- Copy a PAM image (i.e. a PBM, PGM, PPM or PAM image) from `stdin` to `stdout`: + +`pamtopam < {{path/to/image.pam}} > {{path/to/output.pam}}` + +- Display version: + +`pamtopam -version` diff --git a/pages/common/pamtopnm.md b/pages/common/pamtopnm.md new file mode 100644 index 0000000..ff83d8a --- /dev/null +++ b/pages/common/pamtopnm.md @@ -0,0 +1,12 @@ +# pamtopnm + +> Convert a PAM image to an equivalent PNM image. +> More information: . + +- Convert a PAM image to an equivalent PNM image, i.e. a PBM, PGM or PPM image: + +`pamtopnm {{path/to/image.pam}} > {{path/to/output.pbm|pgm|ppm}}` + +- Display version: + +`pamtopnm -version` diff --git a/pages/common/pamtoqoi.md b/pages/common/pamtoqoi.md new file mode 100644 index 0000000..ff0f8b3 --- /dev/null +++ b/pages/common/pamtoqoi.md @@ -0,0 +1,8 @@ +# pamtoqoi + +> Convert a Netpbm image to a QOI image (Quite OK Image format). +> More information: . + +- Convert a Netpbm image to the QOI format: + +`pamtoqoi {{path/to/image.pnm}} > {{path/to/output.qoi}}` diff --git a/pages/common/pamtotga.md b/pages/common/pamtotga.md new file mode 100644 index 0000000..06eac14 --- /dev/null +++ b/pages/common/pamtotga.md @@ -0,0 +1,16 @@ +# pamtotga + +> Convert a Netpbm image to a TrueVision Targa file. +> More information: . + +- Convert a Netpbm image to a TrueVision Targa file: + +`pamtotga {{path/to/file.pam}} > {{path/to/output.tga}}` + +- Specify the color map of the output image: + +`pamtotga -{{cmap|cmap16|mono|rgb}} {{path/to/file.pam}} > {{path/to/output.tga}}` + +- Display version: + +`pamtotga -version` diff --git a/pages/common/pamtotiff.md b/pages/common/pamtotiff.md new file mode 100644 index 0000000..32e6358 --- /dev/null +++ b/pages/common/pamtotiff.md @@ -0,0 +1,16 @@ +# pamtotiff + +> Convert a PAM image to a TIFF file. +> More information: . + +- Convert a PAM image to a TIFF image: + +`pamtotiff {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` + +- Explicitly specify a compression method for the output file: + +`pamtotiff -{{none|packbits|lzw|g3|g4|flate|adobeflate}} {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` + +- Always produce a color TIFF image, even if the input image is greyscale: + +`pamtotiff -color {{path/to/input_file.pam}} > {{path/to/output_file.tiff}}` diff --git a/pages/common/pamtowinicon.md b/pages/common/pamtowinicon.md new file mode 100644 index 0000000..d516f1a --- /dev/null +++ b/pages/common/pamtowinicon.md @@ -0,0 +1,16 @@ +# pamtowinicon + +> Convert a PAM image to a Windows ICO file. +> More information: . + +- Convert a PAM image file to an ICO file: + +`pamtowinicon {{path/to/input_file.pam}} > {{path/to/output.ico}}` + +- Encode images with resolutions smaller than t in the BMP format and all other images in the PNG format: + +`pamtowinicon -pngthreshold {{t}} {{path/to/input_file.pam}} > {{path/to/output.ico}}` + +- Make all pixels outside the non-opaque area black: + +`pamtowinicon -truetransparent {{path/to/input_file.pam}} > {{path/to/output.ico}}` diff --git a/pages/common/pamtoxvmini.md b/pages/common/pamtoxvmini.md new file mode 100644 index 0000000..c94cf8d --- /dev/null +++ b/pages/common/pamtoxvmini.md @@ -0,0 +1,8 @@ +# pamtoxvmini + +> Convert a Netpbm image to an XV thumbnail picture. +> More information: . + +- Convert a PAM image to an XV thumbnail picture: + +`pamtoxvmini {{path/to/input_file.pam}} > {{path/to/output_file}}` diff --git a/pages/common/pbmlife.md b/pages/common/pbmlife.md new file mode 100644 index 0000000..c0ad184 --- /dev/null +++ b/pages/common/pbmlife.md @@ -0,0 +1,12 @@ +# pbmlife + +> Apply Conway's Rules of Life to a PBM image. +> More information: . + +- Apply the Rules of Life to an input PBM image file for one generation and the output the result as a PBM image file: + +`pbmlife {{path/to/file.pbm}}` + +- Display version: + +`pbmlife -version` diff --git a/pages/common/pbmtoascii.md b/pages/common/pbmtoascii.md new file mode 100644 index 0000000..e6cb673 --- /dev/null +++ b/pages/common/pbmtoascii.md @@ -0,0 +1,20 @@ +# pbmtoascii + +> Convert a PBM image to ASCII graphics. +> More information: . + +- Read a PBM file as input and produce an ASCII output: + +`pbmtoascii {{path/to/input_file.pbm}}` + +- Read a PBM file as input and save an ASCII output into a file: + +`pbmtoascii {{path/to/input_file.pbm}} > {{path/to/output_file}}` + +- Read a PBM file as input while setting the pixel mapping (defaults to 1x2): + +`pbmtoascii -{{1x2|2x4}} {{path/to/input_file.pbm}}` + +- Display version: + +`pbmtoascii -version` diff --git a/pages/common/pbmtogem.md b/pages/common/pbmtogem.md new file mode 100644 index 0000000..f9c7a52 --- /dev/null +++ b/pages/common/pbmtogem.md @@ -0,0 +1,17 @@ +# pbmtogem + +> Read a PBM image as input and produce a compressed GEM .img file as output. +> `pbmtogem` cannot compress repeated lines. +> More information: . + +- Convert a PBM image into a GEM .img file: + +`pbmtogem {{path/to/file.pbm}} > {{path/to/file.img}}` + +- Suppress all informational messages: + +`pbmtogem -quiet` + +- Display version: + +`pbmtogem -version` diff --git a/pages/common/pbmtolj.md b/pages/common/pbmtolj.md new file mode 100644 index 0000000..763a649 --- /dev/null +++ b/pages/common/pbmtolj.md @@ -0,0 +1,16 @@ +# pbmtolj + +> Convert a PBM file to an HP LaserJet file. +> More information: . + +- Convert a PBM file to an HP LaserJet file: + +`pbmtolj {{path/to/input.pbm}} > {{path/to/output.lj}}` + +- Compress the output file using the specified method: + +`pbmtolj -{{packbits|delta|compress}} {{path/to/input.pbm}} > {{path/to/output.lj}}` + +- Specify the required resolution: + +`pbmtolj -resolution {{75|100|150|300|600}} {{path/to/input.pbm}} > {{path/to/output.lj}}` diff --git a/pages/common/pbmtowbmp.md b/pages/common/pbmtowbmp.md new file mode 100644 index 0000000..6cb3a1d --- /dev/null +++ b/pages/common/pbmtowbmp.md @@ -0,0 +1,8 @@ +# pbmtowbmp + +> Convert a PBM image to a wireless bitmap file. +> More information: . + +- Convert a PBM image to a WBMP file: + +`pbmtowbmp {{path/to/input_file.pbm}} > {{path/to/output_file.wbmp}}` diff --git a/pages/common/pbmtox10bm.md b/pages/common/pbmtox10bm.md new file mode 100644 index 0000000..e11e56d --- /dev/null +++ b/pages/common/pbmtox10bm.md @@ -0,0 +1,8 @@ +# pbmtox10bm + +> This command is superseded by `pbmtoxbm -x10`. +> More information: . + +- View documentation for the current command: + +`tldr pbmtoxbm` diff --git a/pages/common/pbmtoxbm.md b/pages/common/pbmtoxbm.md new file mode 100644 index 0000000..4e9c620 --- /dev/null +++ b/pages/common/pbmtoxbm.md @@ -0,0 +1,12 @@ +# pbmtoxbm + +> Convert a PBM image to a X11 or X10 bitmap. +> More information: . + +- Convert a PPM image to a X11 XBM file: + +`pbmtoxbm {{path/to/input_file.pbm}} > {{path/to/output_file.xbm}}` + +- Explicitly specify whether an X11 or X10 bitmap should be generated: + +`pbmtoxbm -{{x11|x10}} {{path/to/input_file.pbm}} > {{path/to/output_file.xbm}}` diff --git a/pages/common/pbmtoybm.md b/pages/common/pbmtoybm.md new file mode 100644 index 0000000..b6f08bf --- /dev/null +++ b/pages/common/pbmtoybm.md @@ -0,0 +1,8 @@ +# pbmtoybm + +> Convert a PBM file to a Bennet Yee "face" file. +> More information: . + +- Convert a PBM image file to YBM: + +`pbmtoybm {{path/to/input_file.pbm}} > {{path/to/output_file.ybm}}` diff --git a/pages/common/pbmtozinc.md b/pages/common/pbmtozinc.md new file mode 100644 index 0000000..fb6853e --- /dev/null +++ b/pages/common/pbmtozinc.md @@ -0,0 +1,8 @@ +# pbmtozinc + +> Convert a PBM image to a Zinc bitmap as used by the Zinc Interface Library Version 1.0. +> More information: . + +- Convert a PBM image to a Zinc bitmap: + +`pbmtozinc {{path/to/image.pbm}} > {{path/to/output.zinc}}` diff --git a/pages/common/perl.md b/pages/common/perl.md index 7c24ecd..8c4423c 100644 --- a/pages/common/perl.md +++ b/pages/common/perl.md @@ -3,34 +3,18 @@ > The Perl 5 language interpreter. > More information: . -- Parse and execute a Perl script: +- Print lines from `stdin` [m/] matching regex1 and case insensitive [/i] regex2: -`perl {{script.pl}}` +`perl -n -e 'print if m/{{regex1}}/ and m/{{regex2}}/i'` -- Check syntax errors on a Perl script: +- Say [-E] first match group, using a regexp, ignoring space in regex [/x] : -`perl -c {{script.pl}}` +`perl -n -E 'say $1 if m/{{before}} ( {{group_regex}} ) {{after}}/x'` -- Parse and execute a Perl statement: +- [-i]n-place, with backup, [s/] substitute all occurrence [/g] of regex with replacement: -`perl -e {{perl_statement}}` +`perl -i'.bak' -p -e 's/{{regex}}/{{replacement}}/g' {{path/to/files}}` -- Run a Perl script in debug mode, using `perldebug`: +- Use perl's inline documentation, some pages also available via man on linux: -`perl -d {{script.pl}}` - -- Edit all file lines [i]n-place with a specific replacement [e]xpression, saving a backup with a new extension: - -`perl -p -i'.{{extension}}' -e 's/{{regular_expression}}/{{replacement}}/g' {{path/to/file}}` - -- Run a multi-line replacement [e]xpression on a file, and save the result in a specific file: - -`perl -p -e 's/{{foo\nbar}}/{{foobar}}/g' {{path/to/input_file}} > {{path/to/output_file}}` - -- Run a regular [e]xpression on `stdin`, printing matching [l]ines: - -`cat {{path/to/file}} | perl -n -l -e 'print if /{{regular_expression}}/'` - -- Run a regular [e]xpression on `stdin`, printing only the first capture group for each matching [l]ine: - -`cat {{path/to/file}} | perl -n -l -e 'print $1 if /{{before}}({{regular_expression}}){{after}}/'` +`perldoc perlrun ; perldoc module ; perldoc -f splice; perldoc -q perlfaq1` diff --git a/pages/common/pgmtopgm.md b/pages/common/pgmtopgm.md new file mode 100644 index 0000000..e762add --- /dev/null +++ b/pages/common/pgmtopgm.md @@ -0,0 +1,12 @@ +# pgmtopgm + +> Copy a PGM image file. +> More information: . + +- Copy PGM file from `stdin` to `stderr`: + +`pgmtopgm` + +- Display version: + +`pgmtopgm -version` diff --git a/pages/common/pgmtosbig.md b/pages/common/pgmtosbig.md new file mode 100644 index 0000000..393a34d --- /dev/null +++ b/pages/common/pgmtosbig.md @@ -0,0 +1,8 @@ +# pgmtosbig + +> Convert a PGM image to the SBIG CCDOPS format. +> More information: . + +- Convert a PGM image file to the SBIG CCDOPS format: + +`pgmtosbig {{path/to/input_file.pgm}} > {{path/to/output.sbig}}` diff --git a/pages/common/pgmtost4.md b/pages/common/pgmtost4.md new file mode 100644 index 0000000..079ba48 --- /dev/null +++ b/pages/common/pgmtost4.md @@ -0,0 +1,8 @@ +# pgmtost4 + +> Convert a PGM image to the SBIG ST-4 format. +> More information: . + +- Convert a PGM image file to the SBIG ST-4 format: + +`pgmtost4 {{path/to/input_file.pgm}} > {{path/to/output.st4}}` diff --git a/pages/common/picttoppm.md b/pages/common/picttoppm.md new file mode 100644 index 0000000..084b073 --- /dev/null +++ b/pages/common/picttoppm.md @@ -0,0 +1,16 @@ +# picttoppm + +> Convert a Macintosh PICT file to a PPM image. +> More information: . + +- Convert a PICT file to a PPM image: + +`picttoppm {{path/to/file.pict}} > {{path/to/file.ppm}}` + +- Force any images in the PICT file to be output at full resolution: + +`picttoppm -fullres {{path/to/file.pict}} > {{path/to/file.ppm}}` + +- Do not assume that the input file contains a PICT header and execute quickdraw operations only: + +`picttoppm -noheader -quickdraw {{path/to/file.pict}} > {{path/to/file.ppm}}` diff --git a/pages/common/pjtoppm.md b/pages/common/pjtoppm.md new file mode 100644 index 0000000..b02ab14 --- /dev/null +++ b/pages/common/pjtoppm.md @@ -0,0 +1,8 @@ +# pjtoppm + +> Convert a HP PaintJet file to PPM. +> More information: . + +- Convert a HP PaintJet file to PPM: + +`pjtoppm {{path/to/input.pj}} > {{path/to/output.ppm}}` diff --git a/pages/common/pnmdepth.md b/pages/common/pnmdepth.md new file mode 100644 index 0000000..ed0252a --- /dev/null +++ b/pages/common/pnmdepth.md @@ -0,0 +1,8 @@ +# pnmdepth + +> This command is an alias of `pamdepth`. +> More information: . + +- View documentation for the original command: + +`tldr pamdepth` diff --git a/pages/common/pnmtojpeg.md b/pages/common/pnmtojpeg.md new file mode 100644 index 0000000..b81cad6 --- /dev/null +++ b/pages/common/pnmtojpeg.md @@ -0,0 +1,12 @@ +# pnmtojpeg + +> Converts a PNM image file to the JPEG/JFIF/EXIF image format. +> More information: . + +- Read a PNM image as input and produce a JPEG/JFIF/EXIF image as output: + +`pnmtojpeg {{path/to/file.pnm}} > {{path/to/file.jpg}}` + +- Display version: + +`pnmtojpeg -version` diff --git a/pages/common/pnmtopclxl.md b/pages/common/pnmtopclxl.md new file mode 100644 index 0000000..1fd9ec4 --- /dev/null +++ b/pages/common/pnmtopclxl.md @@ -0,0 +1,16 @@ +# pnmtopclxl + +> Convert a PNM file to an HP LaserJet PCL XL printer stream. +> More information: . + +- Convert PNM files to an HP LaserJet PCL XL printer stream: + +`pnmtopclxl {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` + +- Specify the resolution of the image as well as the location of the page from the upper left corner of each image: + +`pnmtopclxl -dpi {{resolution}} -xoffs {{x_offset}} -yoffs {{y_offset}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` + +- Generate a duplex printer stream for the specified paper format: + +`pnmtopclxl -duplex {{vertical|horizontal}} -format {{letter|legal|a3|a4|a5|...}} {{path/to/input1.pnm path/to/input2.pnm ...}} > {{path/to/output.pclxl}}` diff --git a/pages/common/pnmtoplainpnm.md b/pages/common/pnmtoplainpnm.md new file mode 100644 index 0000000..aad3661 --- /dev/null +++ b/pages/common/pnmtoplainpnm.md @@ -0,0 +1,8 @@ +# pnmtoplainpnm + +> This command is an alias of `pamtopnm -plain`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pages/common/pnmtopng.md b/pages/common/pnmtopng.md new file mode 100644 index 0000000..9c28ebd --- /dev/null +++ b/pages/common/pnmtopng.md @@ -0,0 +1,12 @@ +# pnmtopng + +> Converts a PNM image file to PNG image format. +> More information: . + +- Read a PNM image as input and produce a PNG image as output: + +`pnmtopng {{path/to/file.pnm}} > {{path/to/file.png}}` + +- Display version: + +`pnmtopng -version` diff --git a/pages/common/pnmtopnm.md b/pages/common/pnmtopnm.md new file mode 100644 index 0000000..08bf724 --- /dev/null +++ b/pages/common/pnmtopnm.md @@ -0,0 +1,8 @@ +# pnmtopnm + +> This command is an alias of `pamtopnm`. +> More information: . + +- View documentation for the original command: + +`tldr pamtopnm` diff --git a/pages/common/pnmtops.md b/pages/common/pnmtops.md new file mode 100644 index 0000000..5740f20 --- /dev/null +++ b/pages/common/pnmtops.md @@ -0,0 +1,16 @@ +# pnmtops + +> Convert a PNM image to a PostScript file. +> More information: . + +- Convert a PNM image to a PS file: + +`pnmtops {{path/to/file.pnm}} > {{path/to/file.ps}}` + +- Specify the dimensions of the output image in inches: + +`pnmtops -imagewidth {{imagewidth}} -imageheight {{imageheight}} {{path/to/file.pnm}} > {{path/to/file.ps}}` + +- Specify the dimensions of the page the output image resides on in inches: + +`pnmtops -width {{width}} -height {{height}} {{path/to/file.pnm}} > {{path/to/file.ps}}` diff --git a/pages/common/pnmtorast.md b/pages/common/pnmtorast.md new file mode 100644 index 0000000..3686e9c --- /dev/null +++ b/pages/common/pnmtorast.md @@ -0,0 +1,12 @@ +# pnmtorast + +> Convert a PNM file to a Sun rasterfile. +> More information: . + +- Convert a PNM image to a RAST image: + +`pnmtorast {{path/to/input.pnm}} > {{path/to/output.rast}}` + +- Force either `RT_STANDARD` or `RT_BYTE_ENCODED` form for the output: + +`pnmtorast -{{standard|rle}} {{path/to/input.pnm}} > {{path/to/output.rast}}` diff --git a/pages/common/pnmtorle.md b/pages/common/pnmtorle.md new file mode 100644 index 0000000..ef2ff4b --- /dev/null +++ b/pages/common/pnmtorle.md @@ -0,0 +1,16 @@ +# pnmtorle + +> Convert a PNM file to an Utah Raster Tools RLE image file. +> More information: . + +- Convert a PNM image to an RLE image: + +`pnmtorle {{path/to/input.pnm}} > {{path/to/output.rle}}` + +- Print PNM header information to `stdout`: + +`pnmtorle -verbose {{path/to/input.pnm}} > {{path/to/output.rle}}` + +- Include a transparency channel in the output image in which every black pixel is set to fully transparent and every other pixel is set to fully opaque: + +`pnmtorle -alpha {{path/to/input.pnm}} > {{path/to/output.rle}}` diff --git a/pages/common/pnmtosgi.md b/pages/common/pnmtosgi.md new file mode 100644 index 0000000..5d56d99 --- /dev/null +++ b/pages/common/pnmtosgi.md @@ -0,0 +1,16 @@ +# pnmtosgi + +> Convert a PNM file to an SGI image file. +> More information: . + +- Convert a PNM image to an SGI image: + +`pnmtosgi {{path/to/input.pnm}} > {{path/to/output.sgi}}` + +- Specify whether or not compression should be used: + +`pnmtosgi -{{verbatim|rle}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` + +- Write the specified string into the SGI image header's `imagename` field: + +`pnmtosgi -imagename {{string}} {{path/to/input.pnm}} > {{path/to/output.sgi}}` diff --git a/pages/common/pnmtosir.md b/pages/common/pnmtosir.md new file mode 100644 index 0000000..143f95b --- /dev/null +++ b/pages/common/pnmtosir.md @@ -0,0 +1,8 @@ +# pnmtosir + +> Convert a PNM file to a Solitaire Image Recorder file. +> More information: . + +- Convert a PNM image to a SIR image: + +`pnmtosir {{path/to/input.pnm}} > {{path/to/output.sir}}` diff --git a/pages/common/pnmtotiff.md b/pages/common/pnmtotiff.md new file mode 100644 index 0000000..f6737d9 --- /dev/null +++ b/pages/common/pnmtotiff.md @@ -0,0 +1,8 @@ +# pnmtotiff + +> This command is superseded by `pamtotiff`. +> More information: . + +- View documentation for the current command: + +`tldr pamtotiff` diff --git a/pages/common/pnmtotiffcmyk.md b/pages/common/pnmtotiffcmyk.md new file mode 100644 index 0000000..7436e78 --- /dev/null +++ b/pages/common/pnmtotiffcmyk.md @@ -0,0 +1,16 @@ +# pnmtotiffcmyk + +> Convert a PNM image to a CMYK encoded TIFF. +> More information: . + +- Convert a PNM image to a CMYK encoded TIFF: + +`pnmtotiffcmyk {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` + +- Specify the TIFF compression method: + +`pnmtotiffcmyk -{{none|packbits|lzw}} {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` + +- Control the fill order: + +`pnmtotiffcmyk -{{msb2lsb|lsb2msb}} {{path/to/input_file.pnm}} > {{path/to/output_file.tiff}}` diff --git a/pages/common/pnmtoxwd.md b/pages/common/pnmtoxwd.md new file mode 100644 index 0000000..d360812 --- /dev/null +++ b/pages/common/pnmtoxwd.md @@ -0,0 +1,16 @@ +# pnmtoxwd + +> Convert a PNM file into an X11 window dump file. +> More information: . + +- Convert a PNM image file to XWD: + +`pnmtoxwd {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` + +- Produce the output in the DirectColor format: + +`pnmtoxwd -directcolor {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` + +- Set the color depth of the output to b bits: + +`pnmtoxwd -pseudodepth {{b}} {{path/to/input_file.pnm}} > {{path/to/output_file.xwd}}` diff --git a/pages/common/ppmdither.md b/pages/common/ppmdither.md new file mode 100644 index 0000000..5efdf40 --- /dev/null +++ b/pages/common/ppmdither.md @@ -0,0 +1,16 @@ +# ppmdither + +> Reduce the number of colors in an image by applying dithering. +> More information: . + +- Read a PPM image, apply dithering and save it to a file: + +`ppmdither {{path/to/image.ppm}} > {{path/to/file.ppm}}` + +- Specify the desired number of shades for each primary color: + +`ppmdither -red {{2}} -green {{3}} -blue {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` + +- Specify the dimensions of the dithering matrix: + +`ppmdither -dim {{2}} {{path/to/image.ppm}} > {{path/to/file.ppm}}` diff --git a/pages/common/ppmflash.md b/pages/common/ppmflash.md new file mode 100644 index 0000000..b48ac4c --- /dev/null +++ b/pages/common/ppmflash.md @@ -0,0 +1,12 @@ +# ppmflash + +> Brighten a PPM image file. +> More information: . + +- Generate a PPM image as output that is `flashfactor` times brighter than the input PPM image: + +`ppmflash {{flashfactor}} {{path/to/file.ppm}} > {{path/to/file.ppm}}` + +- Display version: + +`ppmflash -version` diff --git a/pages/common/ppmhist.md b/pages/common/ppmhist.md new file mode 100644 index 0000000..461b291 --- /dev/null +++ b/pages/common/ppmhist.md @@ -0,0 +1,16 @@ +# ppmhist + +> Print a histogram of the colors present in a PPM image. +> More information: . + +- Generate the histogram for human reading: + +`ppmhist -nomap {{path/to/image_file.ppm}}` + +- Generate a PPM file of the colormap for the image, with the color histogram as comments: + +`ppmhist -map {{path/to/image_file.ppm}}` + +- Display version: + +`ppmhist -version` diff --git a/pages/common/ppmtoarbtxt.md b/pages/common/ppmtoarbtxt.md new file mode 100644 index 0000000..91e2f93 --- /dev/null +++ b/pages/common/ppmtoarbtxt.md @@ -0,0 +1,20 @@ +# ppmtoarbtxt + +> Convert a PPM image to an arbitrary text format according to a template. +> More information: . + +- Convert a PPM image to text as specified by the given template: + +`ppmtoarbtxt {{path/to/template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Convert a PPM image to text as specified by the given template, prepend the contents of the specified head template: + +`ppmtoarbtxt {{path/to/template}} -hd {{path/to/head_template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Convert a PPM image to text as specified by the given template, append the contents of the specified tail template: + +`ppmtoarbtxt {{path/to/template}} -hd {{path/to/tail_template}} {{path/to/image.ppm}} > {{path/to/output_file.txt}}` + +- Display version: + +`ppmtoarbtxt -version` diff --git a/pages/common/ppmtoeyuv.md b/pages/common/ppmtoeyuv.md new file mode 100644 index 0000000..7d03eaa --- /dev/null +++ b/pages/common/ppmtoeyuv.md @@ -0,0 +1,8 @@ +# ppmtoeyuv + +> Convert a PPM image to an Berkeley YUV file. +> More information: . + +- Read a PPM image from the input file, convert it to a Berkeley YUV image and store it in the specified output file: + +`ppmtoeyuv {{path/to/input_file.ppm}} > {{path/to/output_file.eyuv}}` diff --git a/pages/common/ppmtolj.md b/pages/common/ppmtolj.md new file mode 100644 index 0000000..c5a67b4 --- /dev/null +++ b/pages/common/ppmtolj.md @@ -0,0 +1,16 @@ +# ppmtolj + +> Convert a PPM file to an HP LaserJet PCL 5 Color file. +> More information: . + +- Convert a PPM file to an HP LaserJet PCL 5 Color file: + +`ppmtolj {{path/to/input.ppm}} > {{path/to/output.lj}}` + +- Apply a gamma correction using the specified gamma value: + +`ppmtolj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.lj}}` + +- Specify the required resolution: + +`ppmtolj -resolution {{75|100|150|300|600}} {{path/to/input.ppm}} > {{path/to/output.lj}}` diff --git a/pages/common/ppmtopgm.md b/pages/common/ppmtopgm.md new file mode 100644 index 0000000..8c7054d --- /dev/null +++ b/pages/common/ppmtopgm.md @@ -0,0 +1,12 @@ +# ppmtopgm + +> Convert a PPM image to a PGM image. +> More information: . + +- Convert PPM image to PGM image: + +`ppmtopgm {{path/to/file.ppm}} > {{path/to/file.pgm}}` + +- Display version: + +`ppmtopgm -version` diff --git a/pages/common/ppmtopict.md b/pages/common/ppmtopict.md new file mode 100644 index 0000000..67343c4 --- /dev/null +++ b/pages/common/ppmtopict.md @@ -0,0 +1,8 @@ +# ppmtopict + +> Convert a PPM image to a Macintosh PICT file. +> More information: . + +- Convert a PPM image to a PICT file: + +`ppmtopict {{path/to/file.ppm}} > {{path/to/file.pict}}` diff --git a/pages/common/ppmtopj.md b/pages/common/ppmtopj.md new file mode 100644 index 0000000..9191ceb --- /dev/null +++ b/pages/common/ppmtopj.md @@ -0,0 +1,16 @@ +# ppmtopj + +> Convert a PPM file to an HP PaintJet file. +> More information: . + +- Convert a PPM file to an HP PaintJet file: + +`ppmtopj {{path/to/input.ppm}} > {{path/to/output.pj}}` + +- Move the image in the x and y direction: + +`ppmtopj -xpos {{dx}} -ypos {{dy}} {{path/to/input.ppm}} > {{path/to/output.pj}}` + +- Explicitly specify a gamma value: + +`ppmtopj -gamma {{gamma}} {{path/to/input.ppm}} > {{path/to/output.pj}}` diff --git a/pages/common/ppmtoppm.md b/pages/common/ppmtoppm.md new file mode 100644 index 0000000..b9a2d5d --- /dev/null +++ b/pages/common/ppmtoppm.md @@ -0,0 +1,12 @@ +# ppmtoppm + +> Copy a PPM image. +> More information: . + +- Copy a PPM image (i.e. a PBM, PGM or PPM image) from `stdin` to `stdout`: + +`ppmtoppm < {{path/to/image.ppm}} > {{path/to/output.ppm}}` + +- Display version: + +`ppmtoppm -version` diff --git a/pages/common/ppmtopuzz.md b/pages/common/ppmtopuzz.md new file mode 100644 index 0000000..2631ec3 --- /dev/null +++ b/pages/common/ppmtopuzz.md @@ -0,0 +1,8 @@ +# ppmtopuzz + +> Convert a PPM image to an X11 puzzle file. +> More information: . + +- Convert a PPM image to an X11 puzzle file: + +`ppmtopuzz {{path/to/file.ppm}} > {{path/to/file.puzz}}` diff --git a/pages/common/ppmtosixel.md b/pages/common/ppmtosixel.md new file mode 100644 index 0000000..ca0ef0e --- /dev/null +++ b/pages/common/ppmtosixel.md @@ -0,0 +1,20 @@ +# ppmtosixel + +> Convert a PPM image to DEC sixel format. +> More information: . + +- Convert a PPM image to DEC sixel format: + +`ppmtosixel {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Produce an uncompressed SIXEL file that is much slower to print: + +`ppmtosixel -raw {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Add a left margin of 1.5 inches: + +`ppmtosixel -margin {{path/to/file.ppm}} > {{path/to/file.sixel}}` + +- Encode control codes in a more portable (although less space-efficient) way: + +`ppmtosixel -7bit {{path/to/file.ppm}} > {{path/to/file.sixel}}` diff --git a/pages/common/ppmtospu.md b/pages/common/ppmtospu.md new file mode 100644 index 0000000..6021e92 --- /dev/null +++ b/pages/common/ppmtospu.md @@ -0,0 +1,12 @@ +# ppmtospu + +> Convert a PPM file to an Atari Spectrum 512 image. +> More information: . + +- Convert a PPM file to an Atari Spectrum 512 image: + +`ppmtospu {{path/to/input.ppm}} > {{path/to/output.spu}}` + +- Use a dithering matrix of the specified size (0 means no dithering): + +`ppmtospu -d{{0|2|4}} {{path/to/input.ppm}} > {{path/to/output.spu}}` diff --git a/pages/common/ppmtotga.md b/pages/common/ppmtotga.md new file mode 100644 index 0000000..69facae --- /dev/null +++ b/pages/common/ppmtotga.md @@ -0,0 +1,8 @@ +# ppmtotga + +> This command is superseded by `pamtotga`. +> More information: . + +- View documentation for the current command: + +`tldr pamtotga` diff --git a/pages/common/ppmtowinicon.md b/pages/common/ppmtowinicon.md new file mode 100644 index 0000000..1655927 --- /dev/null +++ b/pages/common/ppmtowinicon.md @@ -0,0 +1,8 @@ +# ppmtowinicon + +> This command is superseded by `pamtowinicon`. +> More information: . + +- View documentation for the current command: + +`tldr pamtowinicon` diff --git a/pages/common/ppmtoxpm.md b/pages/common/ppmtoxpm.md new file mode 100644 index 0000000..60f61fa --- /dev/null +++ b/pages/common/ppmtoxpm.md @@ -0,0 +1,20 @@ +# ppmtoxpm + +> Convert a PPM image to an X11 version 3 pixmap. +> More information: . + +- Convert a PPM image to a XPM image: + +`ppmtoxpm {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- Specify the prefix string in the output XPM image: + +`ppmtoxpm -name {{prefix_string}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- In the output XPM file, specify colors by their hexadecimal code instead of their name: + +`ppmtoxpm -hexonly {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` + +- Use the specified PGM file as a transparency mask: + +`ppmtoxpm -alphamask {{path/to/alpha_file.pgm}} {{path/to/input_file.ppm}} > {{path/to/output_file.xpm}}` diff --git a/pages/common/ppmtoyuv.md b/pages/common/ppmtoyuv.md new file mode 100644 index 0000000..d64b00e --- /dev/null +++ b/pages/common/ppmtoyuv.md @@ -0,0 +1,8 @@ +# ppmtoyuv + +> Convert a PPM image to an Abekas YUV file. +> More information: . + +- Read a PPM image from the input file, convert it to an Abekas YUV image and store it in the specified output file: + +`ppmtoyuv {{path/to/input_file.ppm}} > {{path/to/output_file.yuv}}` diff --git a/pages/common/ppmtoyuvsplit.md b/pages/common/ppmtoyuvsplit.md new file mode 100644 index 0000000..11db6ea --- /dev/null +++ b/pages/common/ppmtoyuvsplit.md @@ -0,0 +1,8 @@ +# ppmtoyuvsplit + +> Convert a PPM image to three subsampled Abekas YUV files. +> More information: . + +- Read a PPM image from the input file, convert it to three subsampled Abekas YUV image and store these images to output files starting with the specified basename: + +`ppmtoyuvsplit {{basename}} {{path/to/input_file.ppm}}` diff --git a/pages/common/ppmtv.md b/pages/common/ppmtv.md new file mode 100644 index 0000000..d6c5629 --- /dev/null +++ b/pages/common/ppmtv.md @@ -0,0 +1,17 @@ +# ppmtv + +> Make a PPM Image look like taken from an American TV. +> Dim every other row of image data down by the specified dim factor (a number between 0 and 1). +> More information: . + +- Give the PPM image an American TV appearance: + +`ppmtv {{dim_factor}} {{path/to/file.ppm}} > {{path/to/output.ppm}}` + +- Suppress all informational messages: + +`ppmtv -quiet` + +- Display version: + +`ppmtv -version` diff --git a/pages/common/ps-nvm.md b/pages/common/ps-nvm.md new file mode 100644 index 0000000..8d16e8e --- /dev/null +++ b/pages/common/ps-nvm.md @@ -0,0 +1,29 @@ +# ps-nvm + +> PowerShell-based utility to manage multiple Node.js versions, inspired by `nvm`. +> This tool provides multiple commands that all can only be run through PowerShell. +> More information: . + +- View documentation for `Get-NodeInstallLocation`, a tool to get the current Node.js install location: + +`tldr get-nodeinstalllocation` + +- View documentation for `Get-NodeVersions`, a tool to list all available and currently-installed Node.js versions: + +`tldr get-nodeversions` + +- View documentation for `Install-NodeVersion`, a tool to install Node.js runtime versions: + +`tldr get-nodeversion` + +- View documentation for `Remove-NodeVersion`, a tool to uninstall an existing Node.js version: + +`tldr remove-nodeversion` + +- View documentation for `Set-NodeInstallLocation`, a tool to set the Node.js install location: + +`tldr set-nodeinstalllocation` + +- View documentation for `Set-NodeVersion`, a tool to set the default version of Node.js: + +`tldr set-nodeversion` diff --git a/pages/common/psidtopgm.md b/pages/common/psidtopgm.md new file mode 100644 index 0000000..03c0933 --- /dev/null +++ b/pages/common/psidtopgm.md @@ -0,0 +1,8 @@ +# psidtopgm + +> Convert PostScript image data to a PGM image. +> More information: . + +- Convert the image data in a PS file to a PGM image of the specified dimensions and quality: + +`psidtopgm {{width}} {{height}} {{bits_per_sample}} {{path/to/file.ps}} > {{path/to/image.pgm}}` diff --git a/pages/common/pstopnm.md b/pages/common/pstopnm.md new file mode 100644 index 0000000..b9bc0df --- /dev/null +++ b/pages/common/pstopnm.md @@ -0,0 +1,16 @@ +# pstopnm + +> Convert a PostScript file to a PNM image. +> More information: . + +- Convert a PS file to PNM images, storing page N of the input to `path/to/fileN.ppm`: + +`pstopnm {{path/to/file.ps}}` + +- Explicitly specify the output format: + +`pstopnm -{{pbm|pgm|ppm}} {{path/to/file.ps}}` + +- Specify the resolution of the output in dots per inch: + +`pstopnm -dpi {{n}} {{path/to/file.ps}}` diff --git a/pages/common/qoitopam.md b/pages/common/qoitopam.md new file mode 100644 index 0000000..49ae475 --- /dev/null +++ b/pages/common/qoitopam.md @@ -0,0 +1,8 @@ +# qoitopam + +> Convert a QOI image (Quite OK Image format) to Netpbm. +> More information: . + +- Convert a QOI image to Netpbm: + +`qoitopam {{path/to/image.qoi}} > {{path/to/output.pnm}}` diff --git a/pages/common/qrttoppm.md b/pages/common/qrttoppm.md new file mode 100644 index 0000000..74e0678 --- /dev/null +++ b/pages/common/qrttoppm.md @@ -0,0 +1,8 @@ +# qrttoppm + +> Convert a QRT ray tracer file to a PPM image. +> More information: . + +- Convert a QRT file to a PPM image: + +`qrttoppm {{path/to/file.qrt}} > {{path/to/image.ppm}}` diff --git a/pages/common/rage.md b/pages/common/rage.md new file mode 100644 index 0000000..a05c0d0 --- /dev/null +++ b/pages/common/rage.md @@ -0,0 +1,13 @@ +# rage + +> A simple, secure and modern file encryption tool (and Rust library) with small explicit keys, no config options, and UNIX-style composability. +> Rust implementation of `age`. +> More information: . + +- Encrypt a file for `user` and save it to `message.age`: + +`echo "{{Your secret message}}" | rage --encrypt --recipient {{user}} --output {{path/to/message.age}}` + +- Decrypt a file with `identity_file` and save it to `message`: + +`rage --decrypt --identity {{path/to/identity_file}} --output {{message}}` diff --git a/pages/common/rasttopnm.md b/pages/common/rasttopnm.md new file mode 100644 index 0000000..f6b3e57 --- /dev/null +++ b/pages/common/rasttopnm.md @@ -0,0 +1,12 @@ +# rasttopnm + +> Convert a Sun rasterfile to a PNM file. +> More information: . + +- Convert a RAST image to a PNM file: + +`rasttopnm {{path/to/input.rast}} > {{path/to/output.pnm}}` + +- Use the color map indices in the raster if they are color values: + +`rasttopnm -index {{path/to/input.rast}} > {{path/to/output.pnm}}` diff --git a/pages/common/rawtopgm.md b/pages/common/rawtopgm.md new file mode 100644 index 0000000..f772eaa --- /dev/null +++ b/pages/common/rawtopgm.md @@ -0,0 +1,32 @@ +# rawtopgm + +> Convert a raw greyscale image to a PGM image. +> More information: . + +- Convert a raw greyscale image to a PGM image: + +`rawtopgm {{width}} {{height}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Convert a raw greyscale image to a PGM image, assume the image to be a square: + +`rawtopgm {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Convert a raw greyscale image in which the pixels come bottom-first instead of top-first to a PGM image: + +`rawtopgm {{width}} {{height}} -bottomfirst {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Ignore the first n bytes of the specified file: + +`rawtopgm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Ignore the last m bytes of each row in the specified file: + +`rawtopgm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Specify the maxval for the grey values in the input to be equal to N: + +`rawtopgm {{width}} {{height}} -maxval {{N}} {{path/to/image.raw}} > {{path/to/output.pgm}}` + +- Specify the number of bytes that represent each sample in the input and that the byte-sequence is to be interpreted as little-endian: + +`rawtopgm {{width}} {{height}} -bpp {{1|2}} -littleendian {{path/to/image.raw}} > {{path/to/output.pgm}}` diff --git a/pages/common/rawtoppm.md b/pages/common/rawtoppm.md new file mode 100644 index 0000000..000a3cc --- /dev/null +++ b/pages/common/rawtoppm.md @@ -0,0 +1,24 @@ +# rawtoppm + +> Convert a raw RGB stream to a PPM image. +> More information: . + +- Convert a raw RGB stream to a PPM image: + +`rawtoppm {{width}} {{height}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Convert a raw RGB stream in which the pixels come bottom-first instead of top-first to a PPM image: + +`rawtoppm {{width}} {{height}} {{path/to/image.raw}} | pamflip -tb > {{path/to/output.ppm}}` + +- Ignore the first n bytes of the specified file: + +`rawtoppm {{width}} {{height}} -headerskip {{n}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Ignore the last m bytes of each row in the specified file: + +`rawtoppm {{width}} {{height}} -rowskip {{m}} {{path/to/image.raw}} > {{path/to/output.ppm}}` + +- Specify the order of color components for each pixel: + +`rawtoppm {{width}} {{height}} -{{rgb|rbg|grb|gbr|brg|bgr}} {{path/to/image.raw}} > {{path/to/output.ppm}}` diff --git a/pages/common/readonly.md b/pages/common/readonly.md new file mode 100644 index 0000000..9b66157 --- /dev/null +++ b/pages/common/readonly.md @@ -0,0 +1,17 @@ +# readonly + +> Create or modify read-only variables within a shell script, preventing the variable from being changed by subsequent commands. +> This is useful when you want to ensure that a variable retains a constant value throughout the execution of a script. +> More information: . + +- Create a read-only variable: + +`readonly {{variable_name}}={{value}}` + +- Mark a variable as read-only: + +`readonly {{existing_variable}}` + +- [p]rint the names and values of all read-only variables to `stdout`: + +`readonly -p` diff --git a/pages/common/remove-nodeversion.md b/pages/common/remove-nodeversion.md new file mode 100644 index 0000000..7c8f4f6 --- /dev/null +++ b/pages/common/remove-nodeversion.md @@ -0,0 +1,21 @@ +# Remove-NodeVersion + +> Uninstall Node.js runtime versions for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Uninstall a given Node.js version: + +`Remove-NodeVersion {{node_version}}` + +- Uninstall multiple Node.js versions: + +`Remove-NodeVersion {{node_version1 , node_version2 , ...}}` + +- Uninstall all currently-installed versions of Node.js 20.x: + +`Get-NodeVersions -Filter ">=20.0.0 <21.0.0" | Remove-NodeVersion` + +- Uninstall all currently-installed versions of Node.js: + +`Get-NodeVersions | Remove-NodeVersion` diff --git a/pages/common/resolvconf.md b/pages/common/resolvconf.md new file mode 100644 index 0000000..d74ced7 --- /dev/null +++ b/pages/common/resolvconf.md @@ -0,0 +1,30 @@ +# resolvconf + +> Manage nameserver information. +> Acts as an intermediary between programs that supply nameserver information and applications that use this information. +> This tldr documents Debian's implementation of resolvconf. +> More information: . + +- Add or override the IFACE.PROG record and run the update scripts if updating is enabled: + +`resolvconf -a {{IFACE.PROG}}` + +- Delete the IFACE.PROG record and run the update scripts if updating is enabled: + +`resolvconf -d {{IFACR.PROG}}` + +- Just run the update scripts if updating is enabled: + +`resolvconf -u` + +- Set the flag indicating whether `resolvconf` should run update scripts when invoked with `-a`, `-d` or `-u`: + +`resolvconf --enable-updates` + +- Clear the flag indicating whether to run updates: + +`resolvconf --disable-updates` + +- Check whether updates are enabled: + +`resolvconf --updates-are-enabled` diff --git a/pages/common/rletopnm.md b/pages/common/rletopnm.md new file mode 100644 index 0000000..d67bb9b --- /dev/null +++ b/pages/common/rletopnm.md @@ -0,0 +1,16 @@ +# rletopnm + +> Convert a Utah Raster Tools RLE image file to a PNM file. +> More information: . + +- Convert an RLE image to a PNM file: + +`rletopnm {{path/to/input.rle}} > {{path/to/output.pnm}}` + +- Create a PGM image containing the RLE file's alpha channel: + +`rletopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input.rle}} > {{path/to/output.pnm}}` + +- Operate in verbose mode and print the contents of the RLE header to `stdout`: + +`rletopnm -verbose {{path/to/input.rle}} > {{path/to/output.pnm}}` diff --git a/pages/common/rmlint.md b/pages/common/rmlint.md index 9abea42..95e8784 100644 --- a/pages/common/rmlint.md +++ b/pages/common/rmlint.md @@ -1,11 +1,19 @@ # rmlint -> Identify duplicate files or directories, and other filesystem issues. +> Find space waste and other broken things on your filesystem. > More information: . -- Check a directory for duplicates, empty files, and other issues: +- Check directories for duplicated, empty and broken files: -`rmlint {{path/to/directory}}` +`rmlint {{path/to/directory1 path/to/directory2 ...}}` + +- Check for space wasters, preferably keeping files in tagged directories (after the double slash): + +`rmlint {{path/to/directory}} // {{path/to/original_directory}}` + +- Check for space wasters, keeping everything in the untagged directories: + +`rmlint --keep-all-untagged {{path/to/directory}} // {{path/to/original_directory}}` - Delete duplicate files found by an execution of `rmlint`: @@ -15,18 +23,14 @@ `rmlint --merge-directories {{path/to/directory}}` -- Mark files at lower path [d]epth as originals: - -`rmlint --rank-by={{d}} {{path/to/directory}}` - -- Mark files with shortest name [l]ength as originals: +- Mark files at lower path [d]epth as originals, on tie choose shorter [l]ength: -`rmlint --rank-by={{l}} {{path/to/directory}}` +`rmlint --rank-by={{dl}} {{path/to/directory}}` - Find only duplicates that have the same filename in addition to the same contents: `rmlint --match-basename {{path/to/directory}}` -- Find all duplicates with the same extension: +- Find only duplicates that have the same extension in addition to the same contents: `rmlint --match-extension {{path/to/directory}}` diff --git a/pages/common/rsync.md b/pages/common/rsync.md index 82f389a..379f742 100644 --- a/pages/common/rsync.md +++ b/pages/common/rsync.md @@ -1,14 +1,14 @@ # rsync > Transfer files either to or from a remote host (but not between two remote hosts), by default using SSH. -> To specify a remote path, use `host:path/to/file_or_directory`. +> To specify a remote path, use `user@host:path/to/file_or_directory`. > More information: . - Transfer a file: `rsync {{path/to/source}} {{path/to/destination}}` -- Use archive mode (recursively copy directories, copy symlinks without resolving and preserve permissions, ownership and modification times): +- Use archive mode (recursively copy directories, copy symlinks without resolving, and preserve permissions, ownership and modification times): `rsync --archive {{path/to/source}} {{path/to/destination}}` @@ -24,9 +24,9 @@ `rsync --recursive {{path/to/source}}/ {{path/to/destination}}` -- Recursively copy directories, use archive mode, resolve symlinks and skip files that are newer on the destination: +- Use archive mode, resolve symlinks and skip files that are newer on the destination: -`rsync --recursive --archive --update --copy-links {{path/to/source}} {{path/to/destination}}` +`rsync --archive --update --copy-links {{path/to/source}} {{path/to/destination}}` - Transfer a directory to a remote host running `rsyncd` and delete files on the destination that do not exist on the source: diff --git a/pages/common/ruby.md b/pages/common/ruby.md index 5cf1f76..8b65caf 100644 --- a/pages/common/ruby.md +++ b/pages/common/ruby.md @@ -20,6 +20,10 @@ `ruby -run -e httpd` +- Locally execute a Ruby binary without installing the required library it depends on: + +`ruby -I {{path/to/library_folder}} -r {{library_require_name}} {{path/to/bin_folder/bin_name}}` + - Show the version of Ruby you are using: `ruby -v` diff --git a/pages/common/rustdoc.md b/pages/common/rustdoc.md new file mode 100644 index 0000000..0cc30ef --- /dev/null +++ b/pages/common/rustdoc.md @@ -0,0 +1,20 @@ +# rustdoc + +> Generate documentation for a Rust crate. +> More information: . + +- Generate documentation from the crate's root: + +`rustdoc {{src/lib.rs}}` + +- Pass a name for the project: + +`rustdoc {{src/lib.rs}} --crate-name {{name}}` + +- Generate documentation from Markdown files: + +`rustdoc {{path/to/file.md}}` + +- Specify the output directory: + +`rustdoc {{src/lib.rs}} --out-dir {{path/to/output_directory}}` diff --git a/pages/common/sbigtopgm.md b/pages/common/sbigtopgm.md new file mode 100644 index 0000000..a996a46 --- /dev/null +++ b/pages/common/sbigtopgm.md @@ -0,0 +1,8 @@ +# sbigtopgm + +> Convert an SBIG CCDOPS file to PGM. +> More information: . + +- Convert an SBIG CCDOPS image file to PGM: + +`sbigtopgm {{path/to/input_file.sbig}} > {{path/to/output.pgm}}` diff --git a/pages/common/scala-cli.md b/pages/common/scala-cli.md new file mode 100644 index 0000000..5267a59 --- /dev/null +++ b/pages/common/scala-cli.md @@ -0,0 +1,24 @@ +# scala-cli + +> Tool to interact with the Scala programming language. +> More information: . + +- Start a REPL (interactive shell) using a specific Scala and JVM version: + +`scala-cli --scala {{3.1.0}} --jvm {{temurin:17}}` + +- Compile and run a Scala script: + +`scala-cli run {{path/to/script.scala}}` + +- Compile and test a Scala script: + +`scala-cli test {{path/to/script.scala}}` + +- Format a Scala script, updating the file in-place: + +`scala-cli fmt {{path/to/script.scala}}` + +- Generate files for IDE (VSCode and IntelliJ) support: + +`scala-cli setup-ide {{path/to/script.scala}}` diff --git a/pages/common/set-nodeinstalllocation.md b/pages/common/set-nodeinstalllocation.md new file mode 100644 index 0000000..d29438e --- /dev/null +++ b/pages/common/set-nodeinstalllocation.md @@ -0,0 +1,9 @@ +# Set-NodeInstallLocation + +> Set the default Node.js installation directory for `ps-nvm`. +> This command is part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Change the Node.js install location to a specified directory (`ps-nvm` will create a new `.nvm` subdirectory to install them): + +`Set-NodeInstallLocation {{path/to/directory}}` diff --git a/pages/common/set-nodeversion.md b/pages/common/set-nodeversion.md new file mode 100644 index 0000000..5d0b650 --- /dev/null +++ b/pages/common/set-nodeversion.md @@ -0,0 +1,21 @@ +# Set-NodeVersion + +> Set the default Node.js version for `ps-nvm`. +> Part of `ps-nvm` and can only be run under PowerShell. +> More information: . + +- Use a specific version of Node.js in the current PowerShell session: + +`Set-NodeVersion {{node_version}}` + +- Use the latest installed Node.js version 20.x: + +`Set-NodeVersion ^20` + +- Set the default Node.js version for the current user (only applies to future PowerShell sessions): + +`Set-NodeVersion {{node_version}} -Persist User` + +- Set the default Node.js version for all users (must be run as Administrator/root and only applies to future PowerShell sessions): + +`Set-NodeVersion {{node_version}} -Persist Machine` diff --git a/pages/common/sgitopnm.md b/pages/common/sgitopnm.md new file mode 100644 index 0000000..5f809e6 --- /dev/null +++ b/pages/common/sgitopnm.md @@ -0,0 +1,16 @@ +# sgitopnm + +> Convert an SGI file to a PNM file. +> More information: . + +- Convert an SGI image to a PNM file: + +`sgitopnm {{path/to/input.sgi}} > {{path/to/output.pnm}}` + +- Display information about the SGI file: + +`sgitopnm -verbose {{path/to/input.sgi}} > {{path/to/output.pnm}}` + +- Extract channel n of the SGI file: + +`sgitopnm -channel {{n}} {{path/to/input.sgi}} > {{path/to/output.pnm}}` diff --git a/pages/common/sirtopnm.md b/pages/common/sirtopnm.md new file mode 100644 index 0000000..4141533 --- /dev/null +++ b/pages/common/sirtopnm.md @@ -0,0 +1,8 @@ +# sirtopnm + +> Convert a Solitaire Image Recorder file to a PNM file. +> More information: . + +- Convert a SIR image to a PNM file: + +`sirtopnm {{path/to/input.sir}} > {{path/to/output.pnm}}` diff --git a/pages/common/sldtoppm.md b/pages/common/sldtoppm.md new file mode 100644 index 0000000..0f8beb2 --- /dev/null +++ b/pages/common/sldtoppm.md @@ -0,0 +1,12 @@ +# sldtoppm + +> Convert an AutoCAD slide file to a PPM image. +> More information: . + +- Convert an SLD file to a PPM image: + +`sldtoppm {{path/to/input.sld}} > {{path/to/output.ppm}}` + +- Compensate for non-square pixels by scaling the width of the image: + +`sldtoppm -adjust {{path/to/input.sld}} > {{path/to/output.ppm}}` diff --git a/pages/common/soxi.md b/pages/common/soxi.md new file mode 100644 index 0000000..6900a70 --- /dev/null +++ b/pages/common/soxi.md @@ -0,0 +1,8 @@ +# soxi + +> SoXI - Sound eXchange Information, display sound file metadata. +> More information: . + +- Display the sound file metadata: + +`soxi {{path/to/file.wav}}` diff --git a/pages/common/spctoppm.md b/pages/common/spctoppm.md new file mode 100644 index 0000000..42116f3 --- /dev/null +++ b/pages/common/spctoppm.md @@ -0,0 +1,8 @@ +# spctoppm + +> Convert an Atari compressed Spectrum image to a PPM image. +> More information: . + +- Convert an SPC file to a PPM image: + +`spctoppm {{path/to/input.spc}} > {{path/to/output.ppm}}` diff --git a/pages/common/sputoppm.md b/pages/common/sputoppm.md new file mode 100644 index 0000000..45a1a00 --- /dev/null +++ b/pages/common/sputoppm.md @@ -0,0 +1,8 @@ +# sputoppm + +> Convert an Atari uncompressed Spectrum image to a PPM image. +> More information: . + +- Convert an SPU file to a PPM image: + +`sputoppm {{path/to/input.spu}} > {{path/to/output.ppm}}` diff --git a/pages/common/st4topgm.md b/pages/common/st4topgm.md new file mode 100644 index 0000000..b002895 --- /dev/null +++ b/pages/common/st4topgm.md @@ -0,0 +1,8 @@ +# st4topgm + +> Convert an SBIG ST-4 file to PGM. +> More information: . + +- Convert an SBIG ST-4 file to a PGM file: + +`st4topgm {{path/to/input_file.st4}} > {{path/to/output.pgm}}` diff --git a/pages/common/tar.md b/pages/common/tar.md index 287a6a9..1772b9c 100644 --- a/pages/common/tar.md +++ b/pages/common/tar.md @@ -24,7 +24,7 @@ `tar xf {{path/to/source.tar[.gz|.bz2|.xz]}} --directory={{path/to/directory}}` -- [c]reate a compressed archive and write it to a [f]ile, using [a]rchive suffix to determine the compression program: +- [c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program: `tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}` diff --git a/pages/common/telegram-desktop.md b/pages/common/telegram-desktop.md new file mode 100644 index 0000000..1c9ad3d --- /dev/null +++ b/pages/common/telegram-desktop.md @@ -0,0 +1,16 @@ +# telegram-desktop + +> Instant messenger with open source clients, chats and stickers. +> More information: . + +- Start GUI: + +`telegram-desktop` + +- Run GUI as an autostart if allowed: + +`telegram-desktop -autostart` + +- Run GUI minimized to tray: + +`telegram-desktop -startintray` diff --git a/pages/common/tgatoppm.md b/pages/common/tgatoppm.md new file mode 100644 index 0000000..63e0a52 --- /dev/null +++ b/pages/common/tgatoppm.md @@ -0,0 +1,20 @@ +# tgatoppm + +> Convert a TrueVision Targa file to a Netpbm image. +> More information: . + +- Convert a TrueVision Targa file to a PPM image: + +`tgatoppm {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Dump information from the TGA header to `stdout`: + +`tgatoppm --headerdump {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Write the transparency channel values of the input image to the specified file: + +`tgatoppm --alphaout {{path/to/transparency_file.pgm}} {{path/to/file.tga}} > {{path/to/output.ppm}}` + +- Display version: + +`tgatoppm -version` diff --git a/pages/common/thinkjettopbm.md b/pages/common/thinkjettopbm.md new file mode 100644 index 0000000..656bc22 --- /dev/null +++ b/pages/common/thinkjettopbm.md @@ -0,0 +1,12 @@ +# thinkjettopbm + +> Convert a HP ThinkJet printer commands file to a PBM file. +> More information: . + +- Convert a HP ThinkJet printer commands file to a PBM file: + +`thinkjettopbm {{path/to/input}} > {{path/to/output.pbm}}` + +- Print debug information to `stderr`: + +`thinkjettopbm -d {{path/to/input}} > {{path/to/output.pbm}}` diff --git a/pages/common/tifftopnm.md b/pages/common/tifftopnm.md new file mode 100644 index 0000000..56c6ae4 --- /dev/null +++ b/pages/common/tifftopnm.md @@ -0,0 +1,20 @@ +# tifftopnm + +> Convert a TIFF image to a PNM image. +> More information: . + +- Convert a TIFF to a PNM file: + +`tifftopnm {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Create a PGM file containing the alpha channel of the input image: + +`tifftopnm -alphaout {{path/to/alpha_file.pgm}} {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Respect the `fillorder` tag in the input TIFF image: + +`tifftopnm -respectfillorder {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` + +- Print TIFF header information to `stderr`: + +`tifftopnm -headerdump {{path/to/input_file.tiff}} > {{path/to/output_file.pnm}}` diff --git a/pages/common/tt.md b/pages/common/tt.md new file mode 100644 index 0000000..0509ae0 --- /dev/null +++ b/pages/common/tt.md @@ -0,0 +1,20 @@ +# tt + +> A terminal based typing test. +> More information: . + +- Start quote mode with the builtin quote list in English: + +`tt -quotes {{en}}` + +- Produce a test consisting of 50 randomly drawn words in 5 groups of 10 words each: + +`tt -n {{10}} -g {{5}}` + +- Start a timed test lasting 10 seconds: + +`tt -t {{10}}` + +- Start `tt` with no theming and showing your WPM as you type: + +`tt -showwpm -notheme` diff --git a/pages/common/unimatrix.md b/pages/common/unimatrix.md new file mode 100644 index 0000000..c189667 --- /dev/null +++ b/pages/common/unimatrix.md @@ -0,0 +1,25 @@ +# unimatrix + +> Simulate the Matrix look with Unicode characters. +> See also: `cmatrix`. +> More information: . + +- Mimic the default output of `cmatrix` (no unicode, works in a TTY): + +`unimatrix --no-bold --speed {{96}} --character-list {{o}}` + +- No bold characters, slowly, with emojis, numbers, and a few symbols: + +`unimatrix --no-bold --speed {{50}} --character-list {{ens}}` + +- Change the color of characters: + +`unimatrix --color {{red|green|blue|white|...}}` + +- Select character set(s) using letter codes (see `unimatrix --help` for available character sets): + +`unimatrix --character-list {{character_sets}}` + +- Change the scrolling speed: + +`unimatrix --speed {{number}}` diff --git a/pages/common/vf.md b/pages/common/vf.md new file mode 100644 index 0000000..463c76c --- /dev/null +++ b/pages/common/vf.md @@ -0,0 +1,36 @@ +# vf + +> VirtualFish is a fish shell tool for managing Python virtual environments. +> More information: . + +- Create a virtual environment: + +`vf new {{virtualenv_name}}` + +- Create a virtual environment for a specific Python version: + +`vf new --python {{/usr/local/bin/python3.8}} {{virtualenv_name}}` + +- Activate and use the specified virtual environment: + +`vf activate {{virtualenv_name}}` + +- Connect the current virtualenv to the current directory, so that it is activated automatically as soon as you enter it (and deactivated as soon as you leave): + +`vf connect` + +- Deactivate the current virtual environment: + +`vf deactivate` + +- List all virtual environments: + +`vf ls` + +- Remove a virtual environment: + +`vf rm {{virtualenv_name}}` + +- Display help: + +`vf help` diff --git a/pages/common/wbmptopbm.md b/pages/common/wbmptopbm.md new file mode 100644 index 0000000..59d056d --- /dev/null +++ b/pages/common/wbmptopbm.md @@ -0,0 +1,8 @@ +# wbmptopbm + +> Convert a wireless bitmap file to a PBM image. +> More information: . + +- Convert a WBMP file to a PBM image: + +`wbmptopbm {{path/to/input_file.wbpm}} > {{path/to/output_file.pbm}}` diff --git a/pages/common/winicontopam.md b/pages/common/winicontopam.md new file mode 100644 index 0000000..d07f727 --- /dev/null +++ b/pages/common/winicontopam.md @@ -0,0 +1,20 @@ +# winicontopam + +> Convert a Windows ICO file to a PAM file. +> More information: . + +- Read an ICO file and convert the best quality image contained therein to the PAM format: + +`winicontopam {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- Convert all images in the input file to PAM: + +`winicontopam -allimages {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- Convert the n'th image in the input file to PAM: + +`winicontopam -image {{n}} {{path/to/input_file.ico}} > {{path/to/output.pam}}` + +- If the image(s) to be extracted contain graded transparency data and an AND mask, write the AND mask into the fifth channel of the output PAM file: + +`winicontopam -andmasks {{path/to/input_file.ico}} > {{path/to/output.pam}}` diff --git a/pages/common/winicontoppm.md b/pages/common/winicontoppm.md new file mode 100644 index 0000000..d900610 --- /dev/null +++ b/pages/common/winicontoppm.md @@ -0,0 +1,8 @@ +# winicontoppm + +> This command is superseded by `winicontopam`. +> More information: . + +- View documentation for the current command: + +`tldr winicontopam` diff --git a/pages/common/wkhtmltopdf.md b/pages/common/wkhtmltopdf.md new file mode 100644 index 0000000..8cd965d --- /dev/null +++ b/pages/common/wkhtmltopdf.md @@ -0,0 +1,24 @@ +# wkhtmltopdf + +> An open-source command-line tool to convert HTML documents or web pages into PDF files. +> More information: . + +- Convert a HTML document into PDF: + +`wkhtmltopdf {{input.html}} {{output.pdf}}` + +- Specify the PDF page size (please see `PaperSize` of `QPrinter` for supported sizes): + +`wkhtmltopdf --page-size {{A4}} {{input.html}} {{output.pdf}}` + +- Set the PDF page margins: + +`wkhtmltopdf --margin-{{top|bottom|left|right}} {{10mm}} {{input.html}} {{output.pdf}}` + +- Set the PDF page orientation: + +`wkhtmltopdf --orientation {{Landscape|Portrait}} {{input.html}} {{output.pdf}}` + +- Generate a greyscale version of the PDF document: + +`wkhtmltopdf --grayscale {{input.html}} {{output.pdf}}` diff --git a/pages/common/xbmtopbm.md b/pages/common/xbmtopbm.md new file mode 100644 index 0000000..b5bcd80 --- /dev/null +++ b/pages/common/xbmtopbm.md @@ -0,0 +1,8 @@ +# xbmtopbm + +> Convert an X11 or X10 bitmap to a PBM image. +> More information: . + +- Convert an XBM image to a PPM image: + +`xbmtopbm {{path/to/input_file.xbm}} > {{path/to/output_file.pbm}}` diff --git a/pages/common/ximtoppm.md b/pages/common/ximtoppm.md new file mode 100644 index 0000000..bdbf5a2 --- /dev/null +++ b/pages/common/ximtoppm.md @@ -0,0 +1,12 @@ +# ximtoppm + +> Convert a XIM file to a PPM image. +> More information: . + +- Convert an XIM image to a PPM image: + +`ximtoppm {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` + +- Store the transparency mask of the input image in the specified file: + +`ximtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xim}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/xpmtoppm.md b/pages/common/xpmtoppm.md new file mode 100644 index 0000000..c00f8e9 --- /dev/null +++ b/pages/common/xpmtoppm.md @@ -0,0 +1,12 @@ +# xpmtoppm + +> Convert an X11 pixmap to a PPM image. +> More information: . + +- Convert an XPM image to a PPM image: + +`xpmtoppm {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` + +- Store the transparency mask of the input image in the specified file: + +`xpmtoppm --alphaout {{path/to/alpha_file.pbm}} {{path/to/input_file.xpm}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/xvminitoppm.md b/pages/common/xvminitoppm.md new file mode 100644 index 0000000..17fd98c --- /dev/null +++ b/pages/common/xvminitoppm.md @@ -0,0 +1,8 @@ +# xvminitoppm + +> Convert an XV thumbnail picture to PPM. +> More information: . + +- Convert an XV thumbnail image file to PPM: + +`xvminitoppm {{path/to/input_file}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/xwdtopnm.md b/pages/common/xwdtopnm.md new file mode 100644 index 0000000..a6d81f2 --- /dev/null +++ b/pages/common/xwdtopnm.md @@ -0,0 +1,16 @@ +# xwdtopnm + +> Convert an X11 or X10 window dump file to PNM. +> More information: . + +- Convert a XWD image file to PBM: + +`xwdtopnm {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` + +- Display information about the conversion process: + +`xwdtopnm -verbose {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` + +- Display the contents of the X11 header of the input file: + +`xwdtopnm -headerdump {{path/to/input_file.xwd}} > {{path/to/output_file.pnm}}` diff --git a/pages/common/ybmtopbm.md b/pages/common/ybmtopbm.md new file mode 100644 index 0000000..7d3231a --- /dev/null +++ b/pages/common/ybmtopbm.md @@ -0,0 +1,8 @@ +# ybmtopbm + +> Convert a Bennet Yee "face" file to PBM. +> More information: . + +- Convert a YBM image file to PBM: + +`ybmtopbm {{path/to/input_file.ybm}} > {{path/to/output_file.pbm}}` diff --git a/pages/common/yuvsplittoppm.md b/pages/common/yuvsplittoppm.md new file mode 100644 index 0000000..002650c --- /dev/null +++ b/pages/common/yuvsplittoppm.md @@ -0,0 +1,8 @@ +# yuvsplittoppm + +> Convert three subsampled Abekas YUV files to one PPM image. +> More information: . + +- Read Akebas YUV bytes from three files starting with basename, merge them into a single PPM image and store it in the specified output file: + +`yuvsplittoppm {{basename}} {{width}} {{height}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/yuvtoppm.md b/pages/common/yuvtoppm.md new file mode 100644 index 0000000..683df74 --- /dev/null +++ b/pages/common/yuvtoppm.md @@ -0,0 +1,8 @@ +# yuvtoppm + +> Convert Abekas YUV bytes to PPM. +> More information: . + +- Read Akebas YUV bytes from the specified input file, convert them to a PPM image and store them in the specified output file: + +`yuvtoppm {{width}} {{height}} {{path/to/input_file.yuv}} > {{path/to/output_file.ppm}}` diff --git a/pages/common/zeisstopnm.md b/pages/common/zeisstopnm.md new file mode 100644 index 0000000..c4993f2 --- /dev/null +++ b/pages/common/zeisstopnm.md @@ -0,0 +1,12 @@ +# zeisstopnm + +> Convert a Zeiss confocal file to Netbpm format. +> More information: . + +- Convert a Zeiss cofocal file into either `.pgm` or `.ppm` format: + +`zeisstopnm {{path/to/file}}` + +- Convert a Zeiss cofocal file to Netbpm format while explicitly specifying the target file type: + +`zeisstopnm -{{pgm|ppm}} {{path/to/file}}` diff --git a/pages/freebsd/pkg.md b/pages/freebsd/pkg.md new file mode 100644 index 0000000..f9966ab --- /dev/null +++ b/pages/freebsd/pkg.md @@ -0,0 +1,28 @@ +# pkg + +> FreeBSD package manager. +> More information: . + +- Install a new package: + +`pkg install {{package}}` + +- Delete a package: + +`pkg delete {{package}}` + +- Upgrade all packages: + +`pkg upgrade` + +- Search for a package: + +`pkg search {{keyword}}` + +- List installed packages: + +`pkg info` + +- Remove unneeded dependencies: + +`pkg autoremove` diff --git a/pages/linux/aa-complain.md b/pages/linux/aa-complain.md new file mode 100644 index 0000000..d2bdc9b --- /dev/null +++ b/pages/linux/aa-complain.md @@ -0,0 +1,13 @@ +# aa-complain + +> Set an AppArmor policy to complain mode. +> See also: `aa-disable`, `aa-enforce`, `aa-status`. +> More information: . + +- Set policy to complain mode: + +`sudo aa-complain {{path/to/profile}}` + +- Set policies to complain mode: + +`sudo aa-complain --dir {{path/to/profiles}}` diff --git a/pages/linux/aa-disable.md b/pages/linux/aa-disable.md new file mode 100644 index 0000000..a0d691c --- /dev/null +++ b/pages/linux/aa-disable.md @@ -0,0 +1,13 @@ +# aa-disable + +> Disable AppArmor security policy. +> See also: `aa-complain`, `aa-enforce`, `aa-status`. +> More information: . + +- Disable profile: + +`sudo aa-disable {{path/to/profile}}` + +- Disable profiles: + +`sudo aa-disable --dir {{path/to/profiles}}` diff --git a/pages/linux/aa-enforce.md b/pages/linux/aa-enforce.md new file mode 100644 index 0000000..d8b978e --- /dev/null +++ b/pages/linux/aa-enforce.md @@ -0,0 +1,13 @@ +# aa-enforce + +> Set an AppArmor profile to enforce mode. +> See also: `aa-complain`, `aa-disable`, `aa-status`. +> More information: . + +- Enable profile: + +`sudo aa-enforce {{path/to/profile}}` + +- Enable profiles: + +`sudo aa-enforce --dir {{path/to/profile}}` diff --git a/pages/linux/aa-status.md b/pages/linux/aa-status.md new file mode 100644 index 0000000..f3a2cab --- /dev/null +++ b/pages/linux/aa-status.md @@ -0,0 +1,25 @@ +# aa-status + +> List currently loaded AppArmor modules. +> See also: `aa-complain`, `aa-disable`, `aa-enforce`. +> More information: . + +- Check status: + +`sudo aa-status` + +- Display the number of loaded policies: + +`sudo aa-status --profiled` + +- Display the number of loaded enforicing policies: + +`sudo aa-status --enforced` + +- Display the number of loaded non-enforcing policies: + +`sudo aa-status --complaining` + +- Display the number of loaded enforcing policies that kill tasks: + +`sudo aa-status --kill` diff --git a/pages/linux/adig.md b/pages/linux/adig.md index bc922d7..b15c317 100644 --- a/pages/linux/adig.md +++ b/pages/linux/adig.md @@ -1,6 +1,6 @@ # adig -> Prints information received from Domain Name System (DNS) servers. +> Print information received from Domain Name System (DNS) servers. > More information: . - Display A (default) record from DNS for hostname(s): diff --git a/pages/linux/aptitude.md b/pages/linux/aptitude.md index 1649154..e0cb416 100644 --- a/pages/linux/aptitude.md +++ b/pages/linux/aptitude.md @@ -3,7 +3,7 @@ > Debian and Ubuntu package management utility. > More information: . -- Synchronize list of packages and versions available. This should be run first, before running subsequent aptitude commands: +- Synchronize list of packages and versions available. This should be run first, before running subsequent `aptitude` commands: `aptitude update` @@ -15,7 +15,7 @@ `aptitude search {{package}}` -- Search for an installed package (`?installed` is an aptitude search term): +- Search for an installed package (`?installed` is an `aptitude` search term): `aptitude search '?installed({{package}})'` diff --git a/pages/linux/bcachefs.md b/pages/linux/bcachefs.md new file mode 100644 index 0000000..675b39c --- /dev/null +++ b/pages/linux/bcachefs.md @@ -0,0 +1,28 @@ +# bcachefs + +> Manage `bcachefs` filesystems/devices. +> More information: . + +- Format a partition with `bcachefs`: + +`sudo bcachefs format {{path/to/partition}}` + +- Mount a `bcachefs` filesystem: + +`sudo bcachefs mount {{path/to/partition}} {{path/to/mountpoint}}` + +- Create a RAID 0 filesystem where an SSD acts as a cache and an HDD acts as a long-term storage: + +`sudo bcachefs format --label=ssd.ssd1 {{path/to/ssd/partition}} --label=hdd.hdd1 {{path/to/hdd/partition}} --replicas=1 --foreground_target=ssd --promote_target=ssd --background_target=hdd` + +- Mount a multidevice filesystem: + +`sudo bcachefs mount {{path/to/partition1}}:{{path/to/partition2}} {{path/to/mountpoint}}` + +- Display disk usage: + +`bcachefs fs usage --human-readable {{path/to/mountpoint}}` + +- Display help: + +`bcachefs` diff --git a/pages/linux/cbatticon.md b/pages/linux/cbatticon.md new file mode 100644 index 0000000..09fad11 --- /dev/null +++ b/pages/linux/cbatticon.md @@ -0,0 +1,32 @@ +# cbatticon + +> A lightweight and fast battery icon that sits in your system tray. +> More information: . + +- Show the battery icon in the system tray: + +`cbatticon` + +- Show the battery icon and set the update interval to 20 seconds: + +`cbatticon --update-interval {{20}}` + +- List available icon types: + +`cbatticon --list-icon-types` + +- Show the battery icon with a specific icon type: + +`cbatticon --icon-type {{standard|notification|symbolic}}` + +- List available power supplies: + +`cbatticon --list-power-supplies` + +- Show the battery icon for a specific battery: + +`cbatticon {{BAT0}}` + +- Show the battery icon and which command to execute when the battery level reaches the set critical level: + +`cbatticon --critical-level {{5}} --command-critical-level {{poweroff}}` diff --git a/pages/linux/compress.md b/pages/linux/compress.md new file mode 100644 index 0000000..2a6eecb --- /dev/null +++ b/pages/linux/compress.md @@ -0,0 +1,28 @@ +# compress + +> Compress files using the Unix `compress` command. +> More information: . + +- Compress specific files: + +`compress {{path/to/file1 path/to/file2 ...}}` + +- Compress specific files, ignore non-existent ones: + +`compress -f {{path/to/file1 path/to/file2 ...}}` + +- Set maximum compression bits (9-16 bits): + +`compress -b {{bits}}` + +- Write to `stdout` (no files are changed): + +`compress -c {{path/to/file}}` + +- Decompress files (functions like `uncompress`): + +`compress -d {{path/to/file}}` + +- Display compression percentage: + +`compress -v {{path/to/file}}` diff --git a/pages/linux/delpart.md b/pages/linux/delpart.md new file mode 100644 index 0000000..ef18fd8 --- /dev/null +++ b/pages/linux/delpart.md @@ -0,0 +1,8 @@ +# delpart + +> Ask the Linux kernel to forget about a partition. +> More information: . + +- Tell the kernel to forget about the first partition of `/dev/sda`: + +`sudo delpart {{/dev/sda}} {{1}}` diff --git a/pages/linux/extrepo.md b/pages/linux/extrepo.md new file mode 100644 index 0000000..905eee7 --- /dev/null +++ b/pages/linux/extrepo.md @@ -0,0 +1,21 @@ +# extrepo + +> Manage external Debian repositories. +> It is used to manage external repositories in Debian. +> More information: . + +- Search for a given package: + +`extrepo search {{package}}` + +- Enable the repository: + +`sudo extrepo enable {{repository_name}}` + +- Disable the repository: + +`sudo extrepo disable {{repository_name}}` + +- Update the repository: + +`sudo extrepo update {{repository_name}}` diff --git a/pages/linux/grub-editenv.md b/pages/linux/grub-editenv.md new file mode 100644 index 0000000..03baa0b --- /dev/null +++ b/pages/linux/grub-editenv.md @@ -0,0 +1,20 @@ +# grub-editenv + +> Edit GRUB environment variables. +> More information: . + +- Set a default boot entry (Assuming the boot entry already exists): + +`grub-editenv /boot/grub/grubenv set default={{Ubuntu}}` + +- Display the current value of the `timeout` variable: + +`grub-editenv /boot/grub/grubenv list timeout` + +- Reset the `saved_entry` variable to the default: + +`grub-editenv /boot/grub/grubenv unset saved_entry` + +- Append "quiet splash" to the kernel command line: + +`grub-editenv /boot/grub/grubenv list kernel_cmdline` diff --git a/pages/linux/gzexe.md b/pages/linux/gzexe.md new file mode 100644 index 0000000..25dc92e --- /dev/null +++ b/pages/linux/gzexe.md @@ -0,0 +1,13 @@ +# gzexe + +> Compress executable files while keeping them executable. +> Back up the original file, appending `~` to its name and create a shell script that uncompresses and executes the binary inside it. +> More information: . + +- Compress an executable file in-place: + +`gzexe {{path/to/executable}}` + +- Decompress a compressed executable in-place (i.e. convert the shell script back to an uncompressed binary): + +`gzexe -d {{path/to/compressed_executable}}` diff --git a/pages/linux/halt.md b/pages/linux/halt.md index 0abe8d9..49ed7f4 100644 --- a/pages/linux/halt.md +++ b/pages/linux/halt.md @@ -1,7 +1,7 @@ # halt > Halt the system. -> More information: . +> More information: . - Halt the system: diff --git a/pages/linux/hwinfo.md b/pages/linux/hwinfo.md index b628bd5..d3c5fd6 100644 --- a/pages/linux/hwinfo.md +++ b/pages/linux/hwinfo.md @@ -1,7 +1,7 @@ # hwinfo > Probe for the hardware present in the system. -> More information: . +> More information: . - Get graphics card information: diff --git a/pages/linux/ico.md b/pages/linux/ico.md new file mode 100644 index 0000000..e494fa9 --- /dev/null +++ b/pages/linux/ico.md @@ -0,0 +1,20 @@ +# ico + +> Displays an animation of a polyhedron. +> More information: . + +- Display the wireframe of an icosahedron that changes its position every 0.1 seconds: + +`ico -sleep {{0.1}}` + +- Display a solid icosahedron with red faces on a blue background: + +`ico -faces -noedges -colors {{red}} -bg {{blue}}` + +- Display the wireframe of a cube with size 100x100 that moves by +1+2 per frame: + +`ico -obj {{cube}} -size {{100x100}} -delta {{+1+2}}` + +- Display the inverted wireframe of an icosahedron with line width 10 using 5 threads: + +`ico -i -lw {{10}} -threads {{5}}` diff --git a/pages/linux/just-js.md b/pages/linux/just.js.md similarity index 100% rename from pages/linux/just-js.md rename to pages/linux/just.js.md diff --git a/pages/linux/kernel-install.md b/pages/linux/kernel-install.md new file mode 100644 index 0000000..8bcd7de --- /dev/null +++ b/pages/linux/kernel-install.md @@ -0,0 +1,16 @@ +# kernel-install + +> Add and remove kernel and initrd images to and from `/boot`. +> More information: . + +- Add kernel and initramfs images to bootloader partition: + +`sudo kernel-install add {{kernel-version}} {{kernel-image}} {{path/to/initrd-file ...}}` + +- Remove kernel from the bootloader partition: + +`sudo kernel-install remove {{kernel-version}}` + +- Show various paths and parameters that have been configured or auto-detected: + +`sudo kernel-install inspect {{kernel-image}}` diff --git a/pages/linux/lz.md b/pages/linux/lz.md new file mode 100644 index 0000000..49cb7a9 --- /dev/null +++ b/pages/linux/lz.md @@ -0,0 +1,8 @@ +# lz + +> List all files inside a '.tar.gz' compressed archive. +> More information: . + +- List all files inside a compressed archive: + +`lz {{path/to/file.tar.gz}}` diff --git a/pages/linux/machinectl.md b/pages/linux/machinectl.md new file mode 100644 index 0000000..330b4a6 --- /dev/null +++ b/pages/linux/machinectl.md @@ -0,0 +1,21 @@ +# machinectl + +> Control the systemd machine manager. +> Execute operations on virtual machines, containers and images. +> More information: . + +- Start a machine as a service using `systemd-nspawn`: + +`sudo machinectl start {{machine_name}}` + +- Stop a running machine: + +`sudo machinectl stop {{machine_name}}` + +- Display a list of running machines: + +`machinectl list` + +- Open an interactive shell inside the machine: + +`sudo machinectl shell {{machine_name}}` diff --git a/pages/linux/mktemp.md b/pages/linux/mktemp.md index 8ae8985..d94a3b2 100644 --- a/pages/linux/mktemp.md +++ b/pages/linux/mktemp.md @@ -1,21 +1,28 @@ # mktemp > Create a temporary file or directory. -> Note that examples here all assume `$TMPDIR` is unset. -> More information: . +> More information: . -- Create an empty temporary file in `/tmp/` and print its absolute path: +- Create an empty temporary file and print its absolute path: `mktemp` -- Create a temporary directory in `/tmp/` and print its absolute path: +- Use a custom directory (defaults to `$TMPDIR`, or `/tmp`): -`mktemp --directory` +`mktemp --tmpdir={{/path/to/tempdir}}` + +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` -- Create an empty temporary file at the specified path, with `X`s replaced with random alphanumeric characters, and print its path: +- Use a custom file name template: -`mktemp "{{path/to/file_XXXXX_name}}"` +`mktemp -t {{example.XXXXXXXX}}` -- Create an empty temporary file in `/tmp/` with the specified name, with `X`s replaced with random alphanumeric characters, and print its path: +- Create an empty temporary file with the given suffix and print its absolute path: -`mktemp -t "{{file_XXXXX_name}}"` +`mktemp --suffix {{.ext}}` + +- Create an empty temporary directory and print its absolute path: + +`mktemp --directory` diff --git a/pages/linux/nitch.md b/pages/linux/nitch.md new file mode 100644 index 0000000..7cc1b90 --- /dev/null +++ b/pages/linux/nitch.md @@ -0,0 +1,16 @@ +# nitch + +> A small and incredibly fast system fetch written fully in Nim. +> More information: . + +- Display system information (hostname, kernel, uptime, etc.): + +`nitch` + +- Display [h]elp: + +`nitch --help` + +- Display [v]ersion: + +`nitch --version` diff --git a/pages/linux/pdfcrop.md b/pages/linux/pdfcrop.md new file mode 100644 index 0000000..592eee4 --- /dev/null +++ b/pages/linux/pdfcrop.md @@ -0,0 +1,28 @@ +# pdfcrop + +> Detect and remove margins in each page in a PDF file. +> More information: . + +- Automatically detect and remove the margin for each page in a PDF file: + +`pdfcrop {{path/to/input_file.pdf}} {{path/to/output_file.pdf}}` + +- Set the margins of each page to a specific value: + +`pdfcrop {{path/to/input_file.pdf}} --margins '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Set the margins of each page to a specific value, using the same value for left, top, right and bottom: + +`pdfcrop {{path/to/input_file.pdf}} --margins {{300}} {{path/to/output_file.pdf}}` + +- Use a user-defined bounding box for cropping instead of automatically detecting it: + +`pdfcrop {{path/to/input_file.pdf}} --bbox '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Use different user-defined bounding boxes for odd and even pages: + +`pdfcrop {{path/to/input_file.pdf}} --bbox-odd '{{left}} {{top}} {{right}} {{bottom}}' --bbox-even '{{left}} {{top}} {{right}} {{bottom}}' {{path/to/output_file.pdf}}` + +- Automatically detect margins using a lower resolution for improved performance: + +`pdfcrop {{path/to/input_file.pdf}} --resolution {{72}} {{path/to/output_file.pdf}}` diff --git a/pages/linux/pkgctl-build.md b/pages/linux/pkgctl-build.md new file mode 100644 index 0000000..9329d9d --- /dev/null +++ b/pages/linux/pkgctl-build.md @@ -0,0 +1,12 @@ +# pkgctl build + +> Build packages inside a clean `chroot`. +> More information: . + +- Automatically choose the right build script to build packages in a clean `chroot`: + +`pkgctl build` + +- Manually build packages in a clean `chroot`: + +`pkgctl build --arch {{architecture}} --repo {{repository}} --clean` diff --git a/pages/linux/pkgctl-db-update.md b/pages/linux/pkgctl-db-update.md new file mode 100644 index 0000000..d9808e8 --- /dev/null +++ b/pages/linux/pkgctl-db-update.md @@ -0,0 +1,8 @@ +# pkgctl db update + +> Update the pacman database as final release step for packages that have been transfered and staged on . +> More information: . + +- Update the binary repository as final release step: + +`pkgctl db update` diff --git a/pages/linux/pkgctl-release.md b/pages/linux/pkgctl-release.md new file mode 100644 index 0000000..1cf519f --- /dev/null +++ b/pages/linux/pkgctl-release.md @@ -0,0 +1,8 @@ +# pkgctl release + +> Release step to commit, tag and upload build artifacts. +> More information: . + +- Release a build artifact: + +`pkgctl release --repo {{repository}} --message {{commit_message}}` diff --git a/pages/linux/pkgctl-version.md b/pages/linux/pkgctl-version.md deleted file mode 100644 index 2293e4a..0000000 --- a/pages/linux/pkgctl-version.md +++ /dev/null @@ -1,8 +0,0 @@ -# pkgctl version - -> Display `pkgctl` version information. -> More information: . - -- Display version: - -`pkgctl version` diff --git a/pages/linux/pkgctl.md b/pages/linux/pkgctl.md index 0bdf0a2..66513ef 100644 --- a/pages/linux/pkgctl.md +++ b/pages/linux/pkgctl.md @@ -1,8 +1,32 @@ # pkgctl -> Unified command-line devtools frontend for Arch Linux. +> Unified command-line frontend for Arch Linux devtools. > More information: . -- Download PKGBUILD of a package in a folder named `package_name`: +- View documentation for authenticating `pkgctl` with services like GitLab: -`pkgctl repo clone --protocol=https {{package_name}}` +`tldr pkgctl auth` + +- View documentation for building packages inside a clean `chroot`: + +`tldr pkgctl build` + +- View documentation for updating the binary repository as final release step: + +`tldr pkgctl db update` + +- View documentation for comparing package files using different modes: + +`tldr pkgctl diff` + +- View documentation for releasing build artifacts: + +`tldr pkgctl release` + +- View documentation for managing Git packaging repositories and their configuration: + +`tldr pkgctl repo` + +- Display version: + +`pkgctl version` diff --git a/pages/linux/portablectl.md b/pages/linux/portablectl.md new file mode 100644 index 0000000..952842b --- /dev/null +++ b/pages/linux/portablectl.md @@ -0,0 +1,24 @@ +# portablectl + +> A systemd utility for managing and deploying portable service images on Linux systems. +> More information: . + +- List available portable service images discovered in the portable image search paths: + +`portablectl list` + +- Attach a portable service image to the host system: + +`portablectl attach {{path/to/image}}` + +- Detach a portable service image from the host system: + +`portablectl detach {{path/to/image|image_name}}` + +- Display details and metadata about a specified portable service image: + +`portablectl inspect {{path/to/image}}` + +- Check if a portable service image is attached to the host system: + +`portablectl is-attached {{path/to/image|image_name}}` diff --git a/pages/linux/postconf.md b/pages/linux/postconf.md new file mode 100644 index 0000000..ae03290 --- /dev/null +++ b/pages/linux/postconf.md @@ -0,0 +1,29 @@ +# postconf + +> Postfix configuration utility. +> This command displays the values of the `main.cf` configuration parameters by default and warns about possible mistyped parameter names. It can also change the `main.cf` configuration parameter values. +> More information: . + +- Specify the directory of the `main.cf` configuration file instead of the default configuration directory: + +`postconf -c {{path/to/configuration_directory}}` + +- Edit the `main.cf` configuration file and update parameter settings with the "name=value" pairs: + +`postconf -e` + +- Print the default parameter settings of the `main.cf` instead of the actual settings: + +`postconf -d` + +- Display parameters only from the specified class. The class can be one of builtin, service, user or all: + +`postconf -C {{class}}` + +- List available SASL plug-in types for the Postfix SMTP server. The plug-in type is selected with the `smtpd_sasl_type` configuration parameter by specifying `cyrus` or `dovecot` as the name: + +`postconf -a` + +- List the names of all supported lookup table types. Lookup tables are specified as `type:name` in configuration files where the type can be `btree`, `cdb`, `hash`, `mysql`, etc: + +`postconf -m` diff --git a/pages/linux/protonvpn-cli.md b/pages/linux/protonvpn-cli.md index c8e7013..0e5bfb9 100644 --- a/pages/linux/protonvpn-cli.md +++ b/pages/linux/protonvpn-cli.md @@ -1,6 +1,7 @@ # protonvpn-cli > Official ProtonVPN client. +> See also: `protonvpn-cli-connect`. > More information: . - Log in to the ProtonVPN account: diff --git a/pages/linux/pstoedit.md b/pages/linux/pstoedit.md new file mode 100644 index 0000000..fc0f5aa --- /dev/null +++ b/pages/linux/pstoedit.md @@ -0,0 +1,12 @@ +# pstoedit + +> Convert PDF files into various image formats. +> More information: . + +- Convert a PDF page to PNG or JPEG format: + +`pstoedit -page {{page_number}} -f magick {{path/to/file.pdf}} {{page.png|page.jpg]}}` + +- Convert multiple PDF pages to numbered images: + +`pstoedit -f magick {{path/to/file}} {{page%d.png|page%d.jpg}}` diff --git a/pages/linux/pw-cat.md b/pages/linux/pw-cat.md index d77e3a1..5eb530d 100644 --- a/pages/linux/pw-cat.md +++ b/pages/linux/pw-cat.md @@ -1,20 +1,12 @@ # pw-cat -> Pipewire tool for playing and recording audio files. +> Play and record audio files through pipewire. > More information: . -- List all available playback targets: - -`pw-cat --playback --list-targets` - - Play a WAV file over the default target: `pw-cat --playback {{path/to/file.wav}}` -- List all available record targets: - -`pw-cat --record --list-targets` - - Record a sample recording at a different volume level: `pw-cat --record --volume={{0.1}} {{path/to/file.wav}}` diff --git a/pages/linux/pw-play.md b/pages/linux/pw-play.md index 670179c..c83f024 100644 --- a/pages/linux/pw-play.md +++ b/pages/linux/pw-play.md @@ -1,6 +1,7 @@ # pw-play -> Shorthand tool for pw-cat --playback. +> Record audio files through pipewire. +> Shorthand for pw-cat --playback. > More information: . - Play a wav sound file over the default target: diff --git a/pages/linux/pw-record.md b/pages/linux/pw-record.md index 09aa904..f553d7e 100644 --- a/pages/linux/pw-record.md +++ b/pages/linux/pw-record.md @@ -1,12 +1,9 @@ # pw-record -> Shorthand tool for pw-cat --playback. +> Record audio files through pipewire. +> Shorthand for pw-cat --record. > More information: . -- List all available record targets: - -`pw-record --list-targets` - - Record a sample recording using the default target: `pw-record {{path/to/file.wav}}` diff --git a/pages/linux/qm-cloud-init.md b/pages/linux/qm-cloud-init.md new file mode 100644 index 0000000..18293c5 --- /dev/null +++ b/pages/linux/qm-cloud-init.md @@ -0,0 +1,24 @@ +# qm cloud init + +> Configure cloudinit settings for virtual machines managed by Proxmox Virtual Environment (PVE). +> More information: . + +- Configure cloudinit settings for a specific user and set password for the user: + +`qm cloud-init {{vm_id}} -user={{user}} -password={{password}}` + +- Configure cloudinit settings for a specific user and set password for the user with a specific SSH key: + +`qm cloud-init {{vm_id}} -user={{user}} -password={{password}} -sshkey={{ssh_key}}` + +- Set the hostname for a specific virtual machine: + +`qm cloud-init {{vm_id}} -hostname={{hostname}}` + +- Configure the network interface settings for a specific virtual machine: + +`qm cloud-init {{vm_id}} -ipconfig {{ipconfig}}` + +- Configure a shell script to execute before `cloud-ini` is run on a virtual machine: + +`qm cloud-init {{vm_id}} -pre {{script}}` diff --git a/pages/linux/reboot.md b/pages/linux/reboot.md index 05d9511..020944f 100644 --- a/pages/linux/reboot.md +++ b/pages/linux/reboot.md @@ -11,7 +11,7 @@ `reboot --poweroff` -- Halt the system (same as `halt`): +- Halt (terminates all processes and shuts down the CPU) the system (same as `halt`): `reboot --halt` diff --git a/pages/linux/shnsplit.md b/pages/linux/shnsplit.md new file mode 100644 index 0000000..a5d929a --- /dev/null +++ b/pages/linux/shnsplit.md @@ -0,0 +1,20 @@ +# shnsplit + +> Splits audio files according to a `.cue` file. +> More information: . + +- Split a `.wav` + `.cue` file into multiple files: + +`shnsplit -f {{path/to/file.cue}} {{path/to/file.wav}}` + +- Show supported formats: + +`shnsplit -a` + +- Split a `.flac` file into multiple files: + +`shnsplit -f {{path/to/file.cue}} -o flac {{path/to/file.flac}}` + +- Split a `.wav` file into files of the form "track-number - album - title": + +`shnsplit -f {{path/to/file.cue}} {{path/to/file.wav}} -t "%n - %a - %t` diff --git a/pages/linux/shntool-split.md b/pages/linux/shntool-split.md new file mode 100644 index 0000000..558de40 --- /dev/null +++ b/pages/linux/shntool-split.md @@ -0,0 +1,7 @@ +# shntool split + +> This command is an alias of `shnsplit`. + +- View documentation for the original command: + +`tldr shnsplit` diff --git a/pages/linux/slurmctld.md b/pages/linux/slurmctld.md new file mode 100644 index 0000000..078c48a --- /dev/null +++ b/pages/linux/slurmctld.md @@ -0,0 +1,24 @@ +# slurmctld + +> Monitor all other Slurm daemons and resources, accept work (jobs), and allocate resources to those jobs. +> More information: . + +- Clear all previous `slurmctld` states from its last checkpoint: + +`slurmctld -c` + +- Set the daemon's nice value to the specified value, typically a negative number: + +`slurmctld -n {{value}}` + +- Write log messages to the specified file: + +`slurmctld -L {{path/to/output_file}}` + +- Display help: + +`slurmctld -h` + +- Display version: + +`slurmctld -V` diff --git a/pages/linux/slurmd.md b/pages/linux/slurmd.md new file mode 100644 index 0000000..7b2f6a2 --- /dev/null +++ b/pages/linux/slurmd.md @@ -0,0 +1,24 @@ +# slurmd + +> Monitors all tasks running on the compute node, accepts tasks, launches tasks, and kills running tasks upon request. +> More information: . + +- Report node rebooted when daemon restarted (Used for testing purposes): + +`slurmd -b` + +- Run the daemon with the given nodename: + +`slurmd -N {{nodename}}` + +- Write log messages to the specified file: + +`slurmd -L {{path/to/output_file}}` + +- Read configuration from the specified file: + +`slurmd -f {{path/to/file}}` + +- Display help: + +`slurmd -h` diff --git a/pages/linux/slurmdbd.md b/pages/linux/slurmdbd.md new file mode 100644 index 0000000..763b909 --- /dev/null +++ b/pages/linux/slurmdbd.md @@ -0,0 +1,20 @@ +# slurmdbd + +> Provides a secure enterprise-wide interface to a database for Slurm. +> More information: . + +- Set the daemon's nice value to the specified value, typically a negative number: + +`slurmdbd -n {{value}}` + +- Change the working directory of `slurmdbd` to the LogFile path or to `/var/tmp`: + +`slurmdbd -s` + +- Display help: + +`slurmdbd -h` + +- Display version: + +`slurmdbd -V` diff --git a/pages/linux/slurmrestd.md b/pages/linux/slurmrestd.md new file mode 100644 index 0000000..d43bce6 --- /dev/null +++ b/pages/linux/slurmrestd.md @@ -0,0 +1,28 @@ +# slurmrestd + +> Interface to Slurm via REST API. It can be used in two modes: *Inetd Mode* & *Listen Mode*. +> More information: . + +- Change the group ID (and drop supplemental groups) before processing client requests: + +`slurmrestd --g {{group_id}} {{[host]:port | unix:/path/to/socket}}` + +- Comma-delimited list of authentication plugins to load: + +`slurmrestd -a {{authentication_plugins}} {{[host]:port | unix:/path/to/socket}}` + +- Read Slurm configuration from the specified file: + +`slurmrestd -f {{path/to/file}}` + +- Change user ID before processing client request: + +`slurmrestd -u {{user_id}}` + +- Display help: + +`slurmrestd -h` + +- Display version: + +`slurmrestd -V` diff --git a/pages/linux/slurmstepd.md b/pages/linux/slurmstepd.md new file mode 100644 index 0000000..926cddb --- /dev/null +++ b/pages/linux/slurmstepd.md @@ -0,0 +1,9 @@ +# slurmstepd + +> Slurm daemon for managing and monitoring individual job steps within a multi-step job. +> It should not be invoked manually. +> More information: . + +- Start the daemon: + +`slurmstepd` diff --git a/pages/linux/systemd-ask-password.md b/pages/linux/systemd-ask-password.md new file mode 100644 index 0000000..b8f57c3 --- /dev/null +++ b/pages/linux/systemd-ask-password.md @@ -0,0 +1,28 @@ +# systemd-ask-password + +> Query the user for a system password. +> More information: . + +- Query a system password with a specific message: + +`systemd-ask-password "{{message}}"` + +- Specify an identifier for the password query: + +`systemd-ask-password --id={{identifier}} "{{message}}"` + +- Use a kernel keyring key name as a cache for the password: + +`systemd-ask-password --keyname={{key_name}} "{{message}}"` + +- Set a custom timeout for the password query: + +`systemd-ask-password --timeout={{seconds}} "{{message}}"` + +- Force the use of an agent system and never ask on current TTY: + +`systemd-ask-password --no-tty "{{message}}"` + +- Store a password in the kernel keyring without displaying it: + +`systemd-ask-password --no-output --keyname={{key_name}} "{{message}}"` diff --git a/pages/linux/systemd-cgls.md b/pages/linux/systemd-cgls.md new file mode 100644 index 0000000..e7ca91c --- /dev/null +++ b/pages/linux/systemd-cgls.md @@ -0,0 +1,16 @@ +# systemd-cgls + +> Show the contents of the selected Linux control group hierarchy in a tree. +> More information: . + +- Display the whole control group hierarchy on your system: + +`systemd-cgls` + +- Display a control group tree of a specific resource controller: + +`systemd-cgls {{cpu|memory|io}}` + +- Display the control group hierarchy of one or more systemd units: + +`systemd-cgls --unit {{unit1 unit2 ...}}` diff --git a/pages/linux/systemd-cgtop.md b/pages/linux/systemd-cgtop.md new file mode 100644 index 0000000..62b844e --- /dev/null +++ b/pages/linux/systemd-cgtop.md @@ -0,0 +1,25 @@ +# systemd-cgtop + +> Show the top control groups of the local Linux control group hierarchy, ordered by their CPU, memory, or disk I/O load. +> See also: `top`. +> More information: . + +- Start an interactive view: + +`systemd-cgtop` + +- Change the sort order: + +`systemd-cgtop --order={{cpu|memory|path|tasks|io}}` + +- Show the CPU usage by time instead of percentage: + +`systemd-cgtop --cpu=percentage` + +- Change the update interval in seconds (or one of these time units: `ms`, `us`, `min`): + +`systemd-cgtop --delay={{interval}}` + +- Only count userspace processes (without kernel threads): + +`systemd-cgtop -P` diff --git a/pages/linux/systemd-creds.md b/pages/linux/systemd-creds.md new file mode 100644 index 0000000..16a326c --- /dev/null +++ b/pages/linux/systemd-creds.md @@ -0,0 +1,24 @@ +# systemd-creds + +> List, show, encrypt and decrypt service credentials. +> More information: . + +- Encrypt a file and set a specific name: + +`systemd-creds encrypt --name={{name}} {{path/to/input_file}} {{path/to/output}}` + +- Decrypt the file again: + +`systemd-creds decrypt {{path/to/input_file}} {{path/to/output_file}}` + +- Encrypt text from `stdin`: + +`echo -n {{text}} | systemd-creds encrypt --name={{name}} - {{path/to/output}}` + +- Encrypt the text and append it to the service file (the credentials will be available in `$CREDENTIALS_DIRECTORY`): + +`echo -n {{text}} | systemd-creds encrypt --name={{name}} --pretty - - >> {{service}}` + +- Create a credential that is only valid until the given timestamp: + +`systemd-creds encrypt --not-after="{{timestamp}}" {{path/to/input_file}} {{path/to/output_file}}` diff --git a/pages/linux/systemd-cryptenroll.md b/pages/linux/systemd-cryptenroll.md new file mode 100644 index 0000000..47ccc8a --- /dev/null +++ b/pages/linux/systemd-cryptenroll.md @@ -0,0 +1,37 @@ +# systemd-cryptenroll + +> Interactively enroll or remove methods used to unlock LUKS2-encrypted partitions/block devices. +> In order to allow a partition to be unlocked during system boot using something other than a Password, also update the crypttab file and initramfs. +> More information: . + +- Unlock using Password, and enroll a new/additional Password: + +`systemd-cryptenroll --password {{path/to/luks2_block_device}}` + +- Unlock using Password, and enroll a new/additional Recovery Key: + +`systemd-cryptenroll --recovery-key {{path/to/luks2_block_device}}` + +- Unlock using Password, and list available or enroll a new/additional PKCS#11 Token: + +`systemd-cryptenroll --pkcs11-token-uri={{list|auto|pkcs11_token_uri}} {{path/to/luks2_block_device}}` + +- Unlock using Password, and list available or enroll a new FIDO2-Device (using PIN and Presence/Touch if available): + +`systemd-cryptenroll --fido2-device={{list|auto|path/to/fido2_hidraw_device}} {{path/to/luks2_block_device}}` + +- Unlock using Password, and enroll a new FIDO2-Device with User Verification (Biometrics): + +`systemd-cryptenroll --fido2-device={{auto|path/to/fido2_hidraw_device}} --fido2-with-user-verification=yes {{path/to/luks2_block_device}}` + +- Unlock using a FIDO2-Device, and enroll a new FIDO2-Device: + +`systemd-cryptenroll --unlock-fido2-device={{path/to/fido2_hidraw_unlock_device}} --fido2-device={{path/to/fido2_hidraw_enroll_device}} {{path/to/luks2_block_device}}` + +- Unlock using Password, and enroll a TPM2 Security Chip (only secure-boot-policy PCR) and require additional alphanumeric PIN: + +`systemd-cryptenroll --tpm2-device={{auto|path/to/tpm2_block_device}} --tpm2-with-pin=yes {{path/to/luks2_block_device}}` + +- Unlock using Password, and remove all empty Passwords/all Passwords/all FIDO2-Devices/all PKCS#11 Tokens/all TMP2 Security Chips/all Recovery-Keys/all Methods: + +`systemd-cryptenroll --wipe-slots={{empty|password|fido2|pkcs#11|tpm2|recovery|all}} {{path/to/luks2_block_device}}` diff --git a/pages/linux/systemd-dissect.md b/pages/linux/systemd-dissect.md new file mode 100644 index 0000000..11d52b3 --- /dev/null +++ b/pages/linux/systemd-dissect.md @@ -0,0 +1,28 @@ +# systemd-dissect + +> Introspect and interact with file system OS disk images, specifically Discoverable Disk Images (DDIs). +> More information: . + +- Show general image information about the OS image: + +`systemd-dissect {{path/to/image.raw}}` + +- Mount an OS image: + +`systemd-dissect --mount {{path/to/image.raw}} {{/mnt/image}}` + +- Unmount an OS image: + +`systemd-dissect --umount {{/mnt/image}}` + +- List files in an image: + +`systemd-dissect --list {{path/to/image.raw}}` + +- Attach an OS image to an automatically allocated loopback block device and print its path: + +`systemd-dissect --attach {{path/to/image.raw}}` + +- Detach an OS image from a loopback block device: + +`systemd-dissect --detach {{path/to/device}}` diff --git a/pages/linux/systemd-escape.md b/pages/linux/systemd-escape.md new file mode 100644 index 0000000..cc6e763 --- /dev/null +++ b/pages/linux/systemd-escape.md @@ -0,0 +1,24 @@ +# systemd-escape + +> Escape strings for usage in systemd unit names. +> More information: . + +- Escape the given text: + +`systemd-escape {{text}}` + +- Reverse the escaping process: + +`systemd-escape --unescape {{text}}` + +- Treat the given text as a path: + +`systemd-escape --path {{text}}` + +- Append the given suffix to the escaped text: + +`systemd-escape --suffix {{suffix}} {{text}}` + +- Use a template and inject the escaped text: + +`systemd-escape --template {{template}} {{text}}` diff --git a/pages/linux/systemd-inhibit.md b/pages/linux/systemd-inhibit.md new file mode 100644 index 0000000..454b76e --- /dev/null +++ b/pages/linux/systemd-inhibit.md @@ -0,0 +1,29 @@ +# systemd-inhibit + +> Prohibit the system from entering certain power states. +> Inhibitor locks may be used to block or delay system sleep and shutdown requests as well as automatic idle handling. +> More information: . + +- List all active inhibition locks and the reasons for their creation: + +`systemd-inhibit --list` + +- Block system shutdown for a specified number of seconds with the `sleep` command: + +`systemd-inhibit --what shutdown sleep {{5}}` + +- Keep the system from sleeping or idling until the download is complete: + +`systemd-inhibit --what sleep:idle wget {{https://example.com/file}}` + +- Ignore lid close switch until the script exits: + +`systemd-inhibit --what sleep:handle-lid-switch {{path/to/script}}` + +- Ignore power button press while command is running: + +`systemd-inhibit --what handle-power-key {{command}}` + +- Describe who and why created the inhibitor (default: the command and its arguments for `--who` and `Unknown reason` for `--why`): + +`systemd-inhibit --who {{$USER}} --why {{reason}} --what {{operation}} {{command}}` diff --git a/pages/linux/systemd-nspawn.md b/pages/linux/systemd-nspawn.md new file mode 100644 index 0000000..a2f7cc5 --- /dev/null +++ b/pages/linux/systemd-nspawn.md @@ -0,0 +1,20 @@ +# systemd-nspawn + +> Spawn a command or OS in a lightweight container. +> More information: . + +- Run a command in a container: + +`systemd-nspawn --directory {{path/to/container_root}}` + +- Run a full Linux-based OS in a container: + +`systemd-nspawn --boot --directory {{path/to/container_root}}` + +- Run the specified command as PID 2 in the container (as opposed to PID 1) using a stub init process: + +`systemd-nspawn --directory {{path/to/container_root}} --as-pid2` + +- Specify the machine name and hostname: + +`systemd-nspawn --machine={{container_name}} --hostname={{container_host}} --directory {{path/to/container_root}}` diff --git a/pages/linux/systemd-repart.md b/pages/linux/systemd-repart.md new file mode 100644 index 0000000..706ffe6 --- /dev/null +++ b/pages/linux/systemd-repart.md @@ -0,0 +1,18 @@ +# systemd-repart + +> Automatically grow and add partitions. +> Grows and adds partitions based on the configuration files described in repart.d. +> Does not automatically resize file system on partition. See systemd-growfs to extend file system. +> More information: . + +- Grow the root partition (/) to all available disk space: + +`systemd-repart` + +- View changes without applying: + +`systemd-repart --dry-run=yes` + +- Grow root partition size to 10 gigabytes: + +`systemd-repart --size=10G --root /` diff --git a/pages/linux/systemd-socket-activate.md b/pages/linux/systemd-socket-activate.md new file mode 100644 index 0000000..b3d7334 --- /dev/null +++ b/pages/linux/systemd-socket-activate.md @@ -0,0 +1,24 @@ +# systemd-socket-activate + +> Socket activation for systemd services. +> More information: . + +- Activate a service when a specific socket is connected: + +`systemd-socket-activate {{path/to/socket.service}}` + +- Activate multiple sockets for a service: + +`systemd-socket-activate {{path/to/socket1.service}} {{path/to/socket2.service}}` + +- Pass environment variables to the service being activated: + +`{{SYSTEMD_SOCKET_ACTIVATION=1}} systemd-socket-activate {{path/to/socket.service}}` + +- Activate a service along with a notification socket: + +`systemd-socket-activate {{path/to/socket.socket}} {{path/to/service.service}}` + +- Activate a service with a specified port: + +`systemd-socket-activate {{path/to/socket.service}} -l {{8080}}` diff --git a/pages/linux/systemd-stdio-bridge.md b/pages/linux/systemd-stdio-bridge.md new file mode 100644 index 0000000..e96569b --- /dev/null +++ b/pages/linux/systemd-stdio-bridge.md @@ -0,0 +1,21 @@ +# systemd-stdio-bridge + +> Implement a proxy between `stdin`/`stdout` and a D-Bus. +> Note: It expects to receive an open connection via `stdin`/`stdout` when started, and will create a new connection to the specified bus. +> More information: . + +- Forward `stdin`/`stdout` to the local system bus: + +`systemd-stdio-bridge` + +- Forward `stdin`/`stdout` to a specific user's D-Bus: + +`systemd-stdio-bridge --{{user}}` + +- Forward `stdin`/`stdout` to the local system bus within a specific container: + +`systemd-stdio-bridge --machine={{mycontainer}}` + +- Forward `stdin`/`stdout` to a custom D-Bus address: + +`systemd-stdio-bridge --bus-path=unix:path={{/custom/dbus/socket}}` diff --git a/pages/linux/talk.md b/pages/linux/talk.md new file mode 100644 index 0000000..120a6a6 --- /dev/null +++ b/pages/linux/talk.md @@ -0,0 +1,24 @@ +# talk + +> GNU/Talk is a visual communication program which copies lines from your terminal to that of another user. +> More information: . + +- Start a talk session with a user on the same machine: + +`talk {{username}}` + +- Start a talk session with a user on the same machine, who is logged in on tty3: + +`talk {{username}} {{tty3}}` + +- Start a talk session with a user on a remote machine: + +`talk {{username}}@{{hostname}}` + +- Clear text on both terminal screens: + +`Ctrl+D` + +- Exit the talk session: + +`Ctrl+C` diff --git a/pages/linux/tcpick.md b/pages/linux/tcpick.md new file mode 100644 index 0000000..c145916 --- /dev/null +++ b/pages/linux/tcpick.md @@ -0,0 +1,17 @@ +# tcpick + +> Packet sniffing and network traffic analysis tool. +> It can capture and display TCP connections and data. It can also monitor network traffic on a specific interface, host, or port. +> More information: . + +- Capture traffic on a specific [i]nterface, port and host:: + +`sudo tcpick -i {{interface}} -C -h {{host}} -p {{port}}` + +- Capture traffic on port 80 (HTTP) of a specific host: + +`sudo tcpick -i {{eth0}} -C -h {{192.168.1.100}} -p {{80}}` + +- Display help: + +`tcpick --help` diff --git a/pages/linux/tod.md b/pages/linux/tod.md new file mode 100644 index 0000000..11d2bb9 --- /dev/null +++ b/pages/linux/tod.md @@ -0,0 +1,33 @@ +# tod + +> A tiny Todoist client in Rust. +> It takes simple input and dumps it in your inbox or another project. Taking advantage of natural language processing to assign due dates, tags, etc. +> More information: . + +- Import your projects (this is necessary to enable project prompts): + +`tod project import` + +- Quickly create a task with due date: + +`tod --quickadd {{Buy more milk today}}` + +- Create a new task (you will be prompted for content and project): + +`tod task create` + +- Create a task in a project: + +`tod task create --content "{{Write more rust}}" --project {{code}}` + +- Get the next task for a project: + +`tod task next` + +- Get your work schedule: + +`tod task list --scheduled --project {{work}}` + +- Get all tasks for work: + +`tod task list --project {{work}}` diff --git a/pages/linux/udevadm.md b/pages/linux/udevadm.md index 178d862..f21118f 100644 --- a/pages/linux/udevadm.md +++ b/pages/linux/udevadm.md @@ -15,9 +15,9 @@ `sudo udevadm monitor --udev` -- List attributes of a device: +- List attributes of device `/dev/sda`: -`sudo udevadm info --attribute-walk --path {{/dev/sda1}}` +`sudo udevadm info --attribute-walk {{/dev/sda}}` - Reload all `udev` rules: @@ -26,3 +26,7 @@ - Trigger all `udev` rules to run: `sudo udevadm trigger` + +- Test an event run by simulating loading of `/dev/sda`: + +`sudo udevadm test {{/dev/sda}}` diff --git a/pages/linux/ufw.md b/pages/linux/ufw.md index 73a526d..68a94ca 100644 --- a/pages/linux/ufw.md +++ b/pages/linux/ufw.md @@ -1,7 +1,7 @@ # ufw > Uncomplicated Firewall. -> Frontend for iptables aiming to make configuration of a firewall easier. +> Frontend for `iptables` aiming to make configuration of a firewall easier. > More information: . - Enable ufw: diff --git a/pages/linux/uncompress.md b/pages/linux/uncompress.md new file mode 100644 index 0000000..6760ff5 --- /dev/null +++ b/pages/linux/uncompress.md @@ -0,0 +1,20 @@ +# uncompress + +> Uncompress files compressed using the Unix `compress` command. +> More information: . + +- Uncompress specific files: + +`uncompress {{path/to/file1.Z path/to/file2.Z ...}}` + +- Uncompress specific files while ignoring non-existent ones: + +`uncompress -f {{path/to/file1.Z path/to/file2.Z ...}}` + +- Write to `stdout` (no files are changed and no `.Z` files are created): + +`uncompress -c {{path/to/file1.Z path/to/file2.Z ...}}` + +- Verbose mode (write to `stderr` about percentage reduction or expansion): + +`uncompress -v {{path/to/file1.Z path/to/file2.Z ...}}` diff --git a/pages/linux/waydroid.md b/pages/linux/waydroid.md new file mode 100644 index 0000000..7520835 --- /dev/null +++ b/pages/linux/waydroid.md @@ -0,0 +1,28 @@ +# waydroid + +> A container-based approach to boot a full Android system on a regular GNU/Linux system like Ubuntu. +> More information: . + +- Start Waydroid: + +`waydroid` + +- Initialize Waydroid (required on first run or after reinstalling Android): + +`waydroid init` + +- Install a new Android app from a file: + +`waydroid app install {{path/to/file.apk}}` + +- Launch an Android app by its package name: + +`waydroid app launch {{com.example.app}}` + +- Start or stop the Waydroid session: + +`waydroid session {{start|stop}}` + +- Manage the Waydroid container: + +`waydroid container {{start|stop|restart|freeze|unfreeze}}` diff --git a/pages/linux/wl-copy.md b/pages/linux/wl-copy.md index 2f3891a..c6da305 100644 --- a/pages/linux/wl-copy.md +++ b/pages/linux/wl-copy.md @@ -16,6 +16,10 @@ `wl-copy --paste-once "{{text}}"` +- Copy an image: + +`wl-copy < {{path/to/image}}` + - Clear the clipboard: `wl-copy --clear` diff --git a/pages/linux/yplan.md b/pages/linux/yplan.md new file mode 100644 index 0000000..fb83976 --- /dev/null +++ b/pages/linux/yplan.md @@ -0,0 +1,9 @@ +# yplan + +> Generate LaTeX code for a two-page vertical daily planner for any chosen year. +> The generated output can be converted or printed using conversion tools such as `pandoc`, `pdflatex`, or `xetex`. +> More information: . + +- Create a daily planner with specified language, lettercase (uppercase or lowercase) and year: + +`yplan {{language}} {{lettercase}} {{year}} > {{path/to/file.tex}}` diff --git a/pages/linux/zbarcam.md b/pages/linux/zbarcam.md index 787fe23..1021328 100644 --- a/pages/linux/zbarcam.md +++ b/pages/linux/zbarcam.md @@ -1,9 +1,9 @@ # zbarcam -> Scans and decodes barcodes (and QR codes) from a video device. +> Scan and decode barcodes (and QR codes) from a video device. > More information: . -- Continuously read barcodes and print them to standard output: +- Continuously read barcodes and print them to `stdout`: `zbarcam` diff --git a/pages/linux/zforce.md b/pages/linux/zforce.md new file mode 100644 index 0000000..e319b61 --- /dev/null +++ b/pages/linux/zforce.md @@ -0,0 +1,8 @@ +# zforce + +> Add a `.gz` extension to files compressed using `gzip`. +> More information: . + +- Add a `.gz` extension to the supplied Gzip files (Note: other files are ignored): + +`zforce {{path/to/file1 path/to/file2 ...}}` diff --git a/pages/netbsd/pkgin.md b/pages/netbsd/pkgin.md new file mode 100644 index 0000000..a87bbd5 --- /dev/null +++ b/pages/netbsd/pkgin.md @@ -0,0 +1,28 @@ +# pkgin + +> Manage `pkgsrc` binary packages on NetBSD. +> More information: . + +- Install a package: + +`pkgin install {{package}}` + +- Remove a package and its dependencies: + +`pkgin remove {{package}}` + +- Upgrade all packages: + +`pkgin full-upgrade` + +- Search for a package: + +`pkgin search {{keyword}}` + +- List installed packages: + +`pkgin list` + +- Remove unneeded dependencies: + +`pkgin autoremove` diff --git a/pages/openbsd/pkg.md b/pages/openbsd/pkg.md new file mode 100644 index 0000000..2dac503 --- /dev/null +++ b/pages/openbsd/pkg.md @@ -0,0 +1,16 @@ +# pkg + +> OpenBSD package manager utility. +> More information: . + +- View documentation for installing/updating packages: + +`tldr pkg_add` + +- View documentation for removing packages: + +`tldr pkg_delete` + +- View documentation for viewing information about packages: + +`tldr pkg_info` diff --git a/pages/openbsd/pkg_add.md b/pages/openbsd/pkg_add.md new file mode 100644 index 0000000..7f7622a --- /dev/null +++ b/pages/openbsd/pkg_add.md @@ -0,0 +1,17 @@ +# pkg_add + +> Install/update packages in OpenBSD. +> See also: `pkg_info`, `pkg_delete`. +> More information: . + +- Update all packages, including dependencies: + +`pkg_add -u` + +- Install a new package: + +`pkg_add {{package}}` + +- Install packages from the raw output of `pkg_info`: + +`pkg_add -l {{path/to/file}}` diff --git a/pages/openbsd/pkg_delete.md b/pages/openbsd/pkg_delete.md new file mode 100644 index 0000000..7f42c73 --- /dev/null +++ b/pages/openbsd/pkg_delete.md @@ -0,0 +1,17 @@ +# pkg_delete + +> Remove packages in OpenBSD. +> See also: `pkg_add`, `pkg_info`. +> More information: . + +- Delete a package: + +`pkg_delete {{package}}` + +- Delete a package, including its unused dependencies: + +`pkg_delete -a {{package}}` + +- Dry-run deletion of a package: + +`pkg_delete -n {{package}}` diff --git a/pages/openbsd/pkg_info.md b/pages/openbsd/pkg_info.md new file mode 100644 index 0000000..f6f82de --- /dev/null +++ b/pages/openbsd/pkg_info.md @@ -0,0 +1,13 @@ +# pkg_info + +> View information about packages in OpenBSD. +> See also: `pkg_add`, `pkg_delete`. +> More information: . + +- Search for a package using the package name: + +`pkg_info -Q {{package}}` + +- Output a list of installed packages for use with `pkg_add -l`: + +`pkg_info -mz` diff --git a/pages/osx/dtrace.md b/pages/osx/dtrace.md new file mode 100644 index 0000000..3d1cdfc --- /dev/null +++ b/pages/osx/dtrace.md @@ -0,0 +1,37 @@ +# dtrace + +> A simple interface to invoke the D language compiler, retrieve buffered trace, and print traced data from the DTrace kernel facility. +> Generic front-end to DTrace facility, requiring root privileges. +> More information: . + +- Set target data model for a specific architecture: + +`dtrace -arch {{arch_name}}` + +- Claim [a]nonymous tracing state and display the traced data: + +`dtrace -a` + +- Set principal trace buffer size. Supported units are `k`, `m`, `g`, or `t`: + +`dtrace -b {{2g}}` + +- Compile the specified D Program [s]ource file: + +`dtrace -s {{D_script}}` + +- Run the specified [c]ommand and exit upon its completion: + +`dtrace -c {{command}}` + +- Specify [f]unction name to trace or list (-l option). The corresponding argument can include any of the probe description forms like `provider:module:function`, `module:function` or `function`: + +`dtrace -f {{function}}` + +- Grad the specified [p]rocess ID, cache its symbol table, and exit upon completion: + +`dtrace -p {{pid}}` + +- Combine different options for tracing function in a process: + +`dtrace -a -b {{buffer_size}} -f {{function}} -p {{pid}}` diff --git a/pages/osx/goku.md b/pages/osx/goku.md new file mode 100644 index 0000000..c2b6046 --- /dev/null +++ b/pages/osx/goku.md @@ -0,0 +1,28 @@ +# goku + +> Manage Karabiner configuration. +> More information: . + +- Generate `karabiner.json` using the default configuration: + +`goku` + +- Generate `karabiner.json` using the specific `config.edn` file: + +`goku --config {{path/to/config.edn}}` + +- Dry run the new configuration into `stdout` instead of updating `karabiner.json`: + +`goku --dry-run` + +- Dry run the whole configuration into `stdout` instead of updating `karabiner.json`: + +`goku --dry-run-all` + +- Display help: + +`goku --help` + +- Display version: + +`goku --version` diff --git a/pages/osx/mktemp.md b/pages/osx/mktemp.md new file mode 100644 index 0000000..022518d --- /dev/null +++ b/pages/osx/mktemp.md @@ -0,0 +1,24 @@ +# mktemp + +> Create a temporary file or directory. +> More information: . + +- Create an empty temporary file and print its absolute path: + +`mktemp` + +- Use a custom directory (defaults to the output of `getconf DARWIN_USER_TEMP_DIR`, or `/tmp`): + +`mktemp --tmpdir={{/path/to/tempdir}}` + +- Use a custom path template (`X`s are replaced with random alphanumeric characters): + +`mktemp {{/tmp/example.XXXXXXXX}}` + +- Use a custom file name prefix: + +`mktemp -t {{example}}` + +- Create an empty temporary directory and print its absolute path: + +`mktemp --directory` diff --git a/pages/osx/mysides.md b/pages/osx/mysides.md new file mode 100644 index 0000000..f206e4d --- /dev/null +++ b/pages/osx/mysides.md @@ -0,0 +1,24 @@ +# mysides + +> Add, list and remove finder favorites. +> More information: . + +- List sidebar favorites: + +`mysides list` + +- Add a new item to the end of the sidebar favorites: + +`mysides add {{example}} {{file:///Users/Shared/example}}` + +- Remove an item by name: + +`mysides remove {{example}}` + +- Add the current directory to the sidebar: + +`mysides add $(basename $(pwd)) file:///$(pwd)` + +- Remove the current directory from the sidebar: + +`mysides remove $(basename $(pwd))` diff --git a/pages/osx/xcodes-runtimes.md b/pages/osx/xcodes-runtimes.md index 8b50914..668d481 100644 --- a/pages/osx/xcodes-runtimes.md +++ b/pages/osx/xcodes-runtimes.md @@ -9,8 +9,20 @@ - Download a Simulator runtime: -`xcodes runtimes download {{runtime-name}}` +`xcodes runtimes download {{runtime_name}}` - Download and install a Simulator runtime: -`xcodes runtimes install {{runtime-name}}` +`xcodes runtimes install {{runtime_name}}` + +- Download/install a Simulator runtime for specific iOS/watchOS/tvOS/visionOS version (must be written as case-sensitive): + +`xcodes runtimes {{download|install}} "{{iOS|watchOS|tvOS|visionOS}} {{runtime_version}}"` + +- Set a specific location where the runtime archive will be first downloaded (defaults to `~/Downloads`): + +`xcodes runtimes {{download|install}} {{runtime_name}} --directory {{path/to/directory}}` + +- Do not delete the downloaded archive when the Simulator is successfully installed: + +`xcodes runtimes install {{runtime_name}} --keep-archive` diff --git a/pages/osx/xcodes.md b/pages/osx/xcodes.md index 7fd8c1f..89c6ac4 100644 --- a/pages/osx/xcodes.md +++ b/pages/osx/xcodes.md @@ -14,11 +14,11 @@ - Select an Xcode version by specifying a version number or a path: -`xcodes select {{xcode-version|path/to/Xcode.app}}` +`xcodes select {{xcode_version|path/to/Xcode.app}}` - Download and install a specific Xcode version: -`xcodes install {{xcode-version}}` +`xcodes install {{xcode_version}}` - Install the latest Xcode release and select it: @@ -26,4 +26,4 @@ - Download a specific Xcode version archive to a given directory without installing it: -`xcodes download {{xcode-version}} --directory {{path/to/directory}}` +`xcodes download {{xcode_version}} --directory {{path/to/directory}}` diff --git a/pages/osx/xctool.md b/pages/osx/xctool.md index 7e44084..889bb46 100644 --- a/pages/osx/xctool.md +++ b/pages/osx/xctool.md @@ -1,7 +1,7 @@ # xctool > Tool for building Xcode projects. -> More information: . +> More information: . - Build a single project without any workspace: diff --git a/pages/updated_on b/pages/updated_on index d7f90c8..d1d958c 100644 --- a/pages/updated_on +++ b/pages/updated_on @@ -1 +1 @@ -2023-09-29 +2023-11-09 diff --git a/pages/windows/add-appxpackage.md b/pages/windows/add-appxpackage.md new file mode 100644 index 0000000..941e07d --- /dev/null +++ b/pages/windows/add-appxpackage.md @@ -0,0 +1,20 @@ +# add-appxpackage + +> A PowerShell utility to add a signed app package (`.appx`, `.msix`, `.appxbundle` and `.msixbundle`) to a user account. +> More information: . + +- Add an app package: + +`add-appxpackage -Path {{path\to\package.msix}}` + +- Add an app package with dependencies: + +`add-appxpackage -Path {{path\to\package.msix}} -DependencyPath {{path\to\dependencies.msix}}` + +- Install an app using the app installer file: + +`add-appxpackage -AppInstallerFile {{path\to\app.appinstaller}}` + +- Add an unsigned package: + +`add-appxpackage -Path {{path\to\package.msix}} -DependencyPath {{path\to\dependencies.msix}} -AllowUnsigned` diff --git a/pages/windows/bcdboot.md b/pages/windows/bcdboot.md new file mode 100644 index 0000000..c509d4b --- /dev/null +++ b/pages/windows/bcdboot.md @@ -0,0 +1,24 @@ +# bcdboot + +> Configure or repair boot files. +> More information: . + +- Initialize the system partition by using BCD files from the source Windows folder: + +`bcdboot {{C:\Windows}}` + +- Enable [v]erbose mode: + +`bcdboot {{C:\Windows}} /v` + +- Specify the volume letter of the [s]ystem partition: + +`bcdboot {{C:\Windows}} /s {{S:}}` + +- Specify a [l]ocale: + +`bcdboot {{C:\Windows}} /l {{en-us}}` + +- Specify a [f]irmware type while copying the boot files to a specified volume: + +`bcdboot {{C:\Windows}} /s {{S:}} /f {{UEFI|BIOS|ALL}}` diff --git a/pages/windows/cd.md b/pages/windows/cd.md index 5643ae9..a9a18d8 100644 --- a/pages/windows/cd.md +++ b/pages/windows/cd.md @@ -1,24 +1,33 @@ # cd > Display the current working directory or move to a different directory. +> In PowerShell, this command is an alias of `Set-Location`. This documentation is based on the Command Prompt (`cmd`) version of `cd`. > More information: . +- View documentation of the equivalent PowerShell command: + +`tldr set-location` + - Display the path of the current directory: `cd` -- Go to root of current drive: +- Go to a specific directory in the same drive: -`cd \` +`cd {{path\to\directory}}` + +- Go to a specific directory in a different [d]rive: + +`cd /d {{C}}:{{path\to\directory}}` - Go up to the parent of the current directory: `cd ..` -- Go to a specific directory in the same drive: +- Go to the home directory of the current user: -`cd {{path\to\directory}}` +`cd %userprofile%` -- Go to a specific directory in a different [d]rive: +- Go to root of current drive: -`cd /d {{C}}:{{path\to\directory}}` +`cd \` diff --git a/pages/windows/certutil.md b/pages/windows/certutil.md new file mode 100644 index 0000000..825db30 --- /dev/null +++ b/pages/windows/certutil.md @@ -0,0 +1,24 @@ +# certutil + +> A tool to manage and configure certificate information. +> More information: . + +- Dump the configuration information or files: + +`certutil {{filename}}` + +- Encode a file in hexadecimal: + +`certutil -encodehex {{path\to\input_file}} {{path\to\output_file}}` + +- Encode a file to Base64: + +`certutil -encode {{path\to\input_file}} {{path\to\output_file}}` + +- Decode a Base64-encoded file: + +`certutil -decode {{path\to\input_file}} {{path\to\output_file}}` + +- Generate and display a cryptographic hash over a file: + +`certutil -hashfile {{path\to\input_file}} {{md2|md4|md5|sha1|sha256|sha384|sha512}}` diff --git a/pages/windows/chdir.md b/pages/windows/chdir.md new file mode 100644 index 0000000..7461e08 --- /dev/null +++ b/pages/windows/chdir.md @@ -0,0 +1,12 @@ +# chdir + +> This command is an alias of `cd` in Command Prompt, and subsequently `Set-Location` in PowerShell. +> More information: . + +- View documentation for the original Command Prompt command: + +`tldr cd` + +- View documentation for the original PowerShell command: + +`tldr set-location` diff --git a/pages/windows/choice.md b/pages/windows/choice.md index e9b9101..ed1bdd7 100644 --- a/pages/windows/choice.md +++ b/pages/windows/choice.md @@ -1,7 +1,7 @@ # choice > Prompt user to select a choice and return the selected choice index. -> More information: . +> More information: . - Prompt the current user to select a `Y` or `N` choice: diff --git a/pages/windows/clear-host.md b/pages/windows/clear-host.md new file mode 100644 index 0000000..910cd97 --- /dev/null +++ b/pages/windows/clear-host.md @@ -0,0 +1,9 @@ +# Clear-Host + +> Clears the screen. +> This command can only be used through PowerShell. +> More information: . + +- Clear the screen: + +`cls` diff --git a/pages/windows/clear-recyclebin.md b/pages/windows/clear-recyclebin.md new file mode 100644 index 0000000..87665c8 --- /dev/null +++ b/pages/windows/clear-recyclebin.md @@ -0,0 +1,17 @@ +# Clear-RecycleBin + +> Clear items from the Recycle Bin. +> This command can only be used through PowerShell versions 5.1 and below, or 7.1 and above. +> More information: . + +- Clear and delete all items inside the Recycle Bin: + +`Clear-RecycleBin` + +- Clear the Recycle Bin for a specific drive: + +`Clear-RecycleBin -DriveLetter {{C}}` + +- Clear the Recycle Bin without further confirmation: + +`Clear-RecycleBin -Force` diff --git a/pages/windows/clear.md b/pages/windows/clear.md new file mode 100644 index 0000000..b5edc66 --- /dev/null +++ b/pages/windows/clear.md @@ -0,0 +1,7 @@ +# clear + +> In PowerShell, this command is an alias of `Clear-Host`. + +- View documentation for the original command: + +`tldr clear-host` diff --git a/pages/windows/cls.md b/pages/windows/cls.md index 508aca9..62ac428 100644 --- a/pages/windows/cls.md +++ b/pages/windows/cls.md @@ -1,8 +1,13 @@ # cls > Clears the screen. +> In PowerShell, this command is an alias of `Clear-Host`. This documentation is based on the Command Prompt (`cmd`) version of `cls`. > More information: . +- View the documentation of the equivalent PowerShell command: + +`tldr clear-host` + - Clear the screen: `cls` diff --git a/pages/windows/cmdkey.md b/pages/windows/cmdkey.md index 9678865..895d52a 100644 --- a/pages/windows/cmdkey.md +++ b/pages/windows/cmdkey.md @@ -1,7 +1,7 @@ # cmdkey > Create, show, and delete stored user names and passwords. -> More information: . +> More information: . - Show a list of all user credentials: @@ -13,4 +13,4 @@ - Delete credentials for a specific target: -`cmdkey.exe /delete {{target_name}}` +`cmdkey /delete {{target_name}}` diff --git a/pages/windows/curl.md b/pages/windows/curl.md index 6742bde..28b7a56 100644 --- a/pages/windows/curl.md +++ b/pages/windows/curl.md @@ -1,6 +1,7 @@ # curl > In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `curl` program () is not properly installed. +> More information: . - Check whether `curl` is properly installed by printing its version number. If this command evaluates into an error, PowerShell may have substituted this command with `Invoke-WebRequest`: diff --git a/pages/windows/del.md b/pages/windows/del.md index ec97f43..a47affa 100644 --- a/pages/windows/del.md +++ b/pages/windows/del.md @@ -1,8 +1,13 @@ # del > Delete one or more files. +> In PowerShell, this command is an alias of `Remove-Item`. This documentation is based on the Command Prompt (`cmd`) version of `del`. > More information: . +- View the documentation of the equivalent PowerShell command: + +`tldr remove-item` + - Delete one or more space-separated files or patterns: `del {{file_pattern}}` diff --git a/pages/windows/dir.md b/pages/windows/dir.md index 5e38507..9aec8e4 100644 --- a/pages/windows/dir.md +++ b/pages/windows/dir.md @@ -13,8 +13,12 @@ - Show the contents of the current directory, including hidden ones: -`dir /A` +`dir /a` - Show the contents of a given directory, including hidden ones: -`dir {{path\to\directory}} /A` +`dir {{path\to\directory}} /a` + +- Show a bare list of directories and files, with no additional information: + +`dir /b` diff --git a/pages/windows/gal.md b/pages/windows/gal.md new file mode 100644 index 0000000..11336ad --- /dev/null +++ b/pages/windows/gal.md @@ -0,0 +1,8 @@ +# gal + +> In PowerShell, this command is an alias of `Get-Alias`. +> More information: . + +- View documentation for the original command: + +`tldr get-alias` diff --git a/pages/windows/get-alias.md b/pages/windows/get-alias.md new file mode 100644 index 0000000..2f06231 --- /dev/null +++ b/pages/windows/get-alias.md @@ -0,0 +1,21 @@ +# Get-Alias + +> List and get command aliases in the current PowerShell session. +> This command can only be run under PowerShell. +> More information: . + +- List all aliases in the current session: + +`Get-Alias` + +- Get the aliased command name: + +`Get-Alias {{command_alias}}` + +- List all aliases assigned to a specific command: + +`Get-Alias -Definition {{command}}` + +- List aliases that begins with `abc`, excluding those which ends at `def`: + +`Get-Alias {{abc}}* -Exclude *{{def}}` diff --git a/pages/windows/get-help.md b/pages/windows/get-help.md new file mode 100644 index 0000000..8ae34b4 --- /dev/null +++ b/pages/windows/get-help.md @@ -0,0 +1,37 @@ +# Get-Help + +> Display help information and documentation for PowerShell commands, aka. cmdlets. +> This command can only be run through PowerShell. +> More information: . + +- Display general help information for a specific cmdlet: + +`Get-Help {{cmdlet}}` + +- Display a more detailed documentation for a specific cmdlet: + +`Get-Help {{cmdlet}} -Detailed` + +- Display the full technical documentation for a specific cmdlet: + +`Get-Help {{cmdlet}} -Full` + +- Print only the documentation for a specific parameter of the cmdlet (use `*` to show all parameters), if available: + +`Get-Help {{cmdlet}} -Parameter {{parameter}}` + +- Print only the examples of the cmdlet, if available: + +`Get-Help {{cmdlet}} -Examples` + +- List all available cmdlet help pages: + +`Get-Help *` + +- Update the current help and documentation knowledge base using `Update-Help`: + +`Update-Help` + +- View an online version of cmdlet documentation in the default web browser: + +`Get-Help {{cmdlet}} -Online` diff --git a/pages/windows/get-location.md b/pages/windows/get-location.md new file mode 100644 index 0000000..066ec50 --- /dev/null +++ b/pages/windows/get-location.md @@ -0,0 +1,9 @@ +# Get-Location + +> Print name of current/working directory. +> This command can only be run through PowerShell. +> More information: . + +- Print the current directory: + +`Get-Location` diff --git a/pages/windows/gl.md b/pages/windows/gl.md new file mode 100644 index 0000000..2032ef1 --- /dev/null +++ b/pages/windows/gl.md @@ -0,0 +1,8 @@ +# gl + +> In PowerShell, this command is an alias of `Get-Location`. +> More information: . + +- View documentation for the original command: + +`tldr get-location` diff --git a/pages/windows/iwr.md b/pages/windows/iwr.md index 5a008a7..09199dc 100644 --- a/pages/windows/iwr.md +++ b/pages/windows/iwr.md @@ -1,6 +1,7 @@ # iwr -> This command is an alias of `Invoke-WebRequest` in PowerShell. +> In PowerShell, this command is an alias of `Invoke-WebRequest`. +> More information: . - View documentation for the original command: diff --git a/pages/windows/measure-object.md b/pages/windows/measure-object.md index c4950ca..e3e4715 100644 --- a/pages/windows/measure-object.md +++ b/pages/windows/measure-object.md @@ -2,7 +2,7 @@ > Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text. > This command can only be used through PowerShell. -> More information: . +> More information: . - Count the files and folders in a directory: diff --git a/pages/windows/mi.md b/pages/windows/mi.md new file mode 100644 index 0000000..8d58b4f --- /dev/null +++ b/pages/windows/mi.md @@ -0,0 +1,8 @@ +# mi + +> In PowerShell, this command is an alias of `Move-Item`. +> More information: . + +- View documentation for the original command: + +`tldr move-item` diff --git a/pages/windows/move-item.md b/pages/windows/move-item.md new file mode 100644 index 0000000..b55f112 --- /dev/null +++ b/pages/windows/move-item.md @@ -0,0 +1,37 @@ +# Move-Item + +> Move or rename files, directories, registry keys, and other PowerShell data items. +> This command can only be run through PowerShell. +> More information: . + +- Rename a file or directory when the target is not an existing directory: + +`Move-Item {{path\to\source}} {{path\to\target}}` + +- Move a file or directory into an existing directory: + +`Move-Item {{path\to\source}} {{path\to\existing_directory}}` + +- Rename or move file(s) with specific name (do not treat special characters inside strings): + +`Move-Item -LiteralPath "{{path\to\source}}" {{path\to\file_or_directory}}` + +- Move multiple files into an existing directory, keeping the filenames unchanged: + +`Move-Item {{path\to\source1 , path\to\source2 ...}} {{path\to\existing_directory}}` + +- Move or rename registry key(s): + +`Move-Item {{path\to\source_key1 , path\to\source_key2 ...}} {{path\to\new_or_existing_key}}` + +- Do not prompt for confirmation before overwriting existing files or registry keys: + +`mv -Force {{path\to\source}} {{path\to\target}}` + +- Prompt for confirmation before overwriting existing files, regardless of file permissions: + +`mv -Confirm {{path\to\source}} {{path\to\target}}` + +- Move files in dry-run mode, showing files and directories which could be moved without executing them: + +`mv -WhatIf {{path\to\source}} {{path\to\target}}` diff --git a/pages/windows/move.md b/pages/windows/move.md new file mode 100644 index 0000000..7d480de --- /dev/null +++ b/pages/windows/move.md @@ -0,0 +1,29 @@ +# move + +> Move or rename files and directories. +> In PowerShell, this command is an alias of `Move-Item`. This documentation is based on the Command Prompt (`cmd`) version of `move`. +> More information: . + +- View documentation of the equivalent PowerShell command: + +`tldr move-item` + +- Rename a file or directory when the target is not an existing directory: + +`move {{path\to\source}} {{path\to\target}}` + +- Move a file or directory into an existing directory: + +`move {{path\to\source}} {{path\to\existing_directory}}` + +- Move a file or directory across drives: + +`move {{C:\path\to\source}} {{D:\path\to\target}}` + +- Do not prompt for confirmation before overwriting existing files: + +`move /Y {{path\to\source}} {{path\to\existing_directory}}` + +- Prompt for confirmation before overwriting existing files, regardless of file permissions: + +`move /-Y {{path\to\source}} {{path\to\existing_directory}}` diff --git a/pages/windows/mv.md b/pages/windows/mv.md new file mode 100644 index 0000000..c3d1f44 --- /dev/null +++ b/pages/windows/mv.md @@ -0,0 +1,13 @@ +# mv + +> In PowerShell, this command is an alias of `Move-Item`. +> However, this command is not available on the Command Prompt (`cmd`). Use `move` instead for similar functionality. +> More information: . + +- View documentation for the equivalent Command Prompt command: + +`tldr move` + +- View documentation for the original PowerShell command: + +`tldr move-item` diff --git a/pages/windows/net.md b/pages/windows/net.md index 3ae82cb..5b85495 100644 --- a/pages/windows/net.md +++ b/pages/windows/net.md @@ -1,7 +1,7 @@ # net > System utility to view and modify network-related settings. -> More information: . +> More information: . - Start or stop a Windows service synchronously: diff --git a/pages/windows/netsh-interface-portproxy.md b/pages/windows/netsh-interface-portproxy.md index a603e51..976c6c0 100644 --- a/pages/windows/netsh-interface-portproxy.md +++ b/pages/windows/netsh-interface-portproxy.md @@ -1,7 +1,7 @@ # netsh interface portproxy > Configure and display the status of various network components. -> More information: . +> More information: . - Display the current port forwarding setup: diff --git a/pages/windows/new-item.md b/pages/windows/new-item.md new file mode 100644 index 0000000..5bf4d9f --- /dev/null +++ b/pages/windows/new-item.md @@ -0,0 +1,33 @@ +# New-Item + +> Create a new file, directory, symbolic link, or a registry entry. +> This command can only be used through PowerShell. +> More information: . + +- Create a new blank file (equivalent to `touch`): + +`New-Item {{path\to\file}}` + +- Create a new directory: + +`New-Item -ItemType Directory {{path\to\directory}}` + +- Write a new text file with specified content: + +`New-Item {{path\to\file}} -Value {{content}}` + +- Write the same text file in multiple locations: + +`New-Item {{path\to\file1 , path\to\file2 , ...}} -Value {{content}}` + +- Create a symbolic link\hard link\junction to a file or directory: + +`New-Item -ItemType {{SymbolicLink|HardLink|Junction}} -Path {{path\to\link_file}} -Target {{path\to\source_file_or_directory}}` + +- Create a new blank registry entry (in REG_SZ, use `New-ItemProperty` or `Set-ItemProperty` to fine-tune the value type): + +`New-Item {{path\to\registry_key}}` + +- Create a new blank registry entry with specified value: + +`New-Item {{path\to\registry_key}} -Value {{value}}` diff --git a/pages/windows/ni.md b/pages/windows/ni.md new file mode 100644 index 0000000..106c432 --- /dev/null +++ b/pages/windows/ni.md @@ -0,0 +1,8 @@ +# ni + +> In PowerShell, this command is an alias of `New-Item`. +> More information: . + +- View documentation for the original command: + +`tldr new-item` diff --git a/pages/windows/psexec.md b/pages/windows/psexec.md index 1faeec8..2a3060d 100644 --- a/pages/windows/psexec.md +++ b/pages/windows/psexec.md @@ -2,7 +2,7 @@ > Execute a command-line process on a remote machine. > This is an advanced command and it might potentially be dangerous. -> More information: . +> More information: . - Execute a command using `cmd` in a remote shell: diff --git a/pages/windows/psversiontable.md b/pages/windows/psversiontable.md new file mode 100644 index 0000000..b7faa54 --- /dev/null +++ b/pages/windows/psversiontable.md @@ -0,0 +1,25 @@ +# PSVersionTable + +> A read-only variable (as `$PSVersionTable`) to get the current PowerShell version. +> This command can only be run under PowerShell. +> More information: . + +- Print a summary of the currently installed PowerShell version and edition: + +`$PSVersionTable` + +- Get the detailed (major, minor, build, and revision) version number of PowerShell: + +`$PSVersionTable.PSVersion` + +- Get a list of supported PowerShell script versions that this PowerShell version supports: + +`$PSVersionTable.PSCompatibleVersions` + +- Get the latest Git commit ID where the currently-installed PowerShell version is based on (works on PowerShell 6.0 and later): + +`$PSVersionTable.GitCommitId` + +- Check whether the user is running PowerShell Core (6.0 or later) or the original "Windows PowerShell" (version 5.1 or below): + +`$PSVersionTable.PSEdition` diff --git a/pages/windows/pwd.md b/pages/windows/pwd.md new file mode 100644 index 0000000..2dd9178 --- /dev/null +++ b/pages/windows/pwd.md @@ -0,0 +1,13 @@ +# pwd + +> In PowerShell, this command is an alias of `Get-Location`. +> However, this command is not available on the Command Prompt (`cmd`). Use `cd` instead for similar functionality. +> More information: . + +- View documentation for the equivalent Command Prompt command: + +`tldr cd` + +- View documentation for the original PowerShell command: + +`tldr get-location` diff --git a/pages/windows/rd.md b/pages/windows/rd.md index 4deed77..fe9d468 100644 --- a/pages/windows/rd.md +++ b/pages/windows/rd.md @@ -1,8 +1,12 @@ # rd -> This command is an alias of `rmdir`. +> This command is an alias of `rmdir` on Command Prompt, and subsequently `Remove-Item` in PowerShell. > More information: . -- View documentation for the original command: +- View documentation for the original Command Prompt command: `tldr rmdir` + +- View documentation for the original PowerShell command: + +`tldr remove-item` diff --git a/pages/windows/remove-appxpackage.md b/pages/windows/remove-appxpackage.md new file mode 100644 index 0000000..22819a4 --- /dev/null +++ b/pages/windows/remove-appxpackage.md @@ -0,0 +1,20 @@ +# remove-appxpackage + +> A PowerShell utility to remove an app package from one or more user accounts. +> More information: . + +- Remove an app package: + +`remove-appxpackage {{package}}` + +- Remove an app package for a specific user: + +`remove-appxpackage {{package}} -User {{username}}` + +- Remove an app package for all users: + +`remove-appxpackage {{package}} -AllUsers` + +- Remove an app package but preserve it's app data: + +`remove-appxpackage {{package}} -PreserveApplicationData` diff --git a/pages/windows/remove-item.md b/pages/windows/remove-item.md new file mode 100644 index 0000000..108511e --- /dev/null +++ b/pages/windows/remove-item.md @@ -0,0 +1,29 @@ +# Remove-Item + +> Delete files, folders, as well as registry keys and subkeys. +> This command can only be run through PowerShell. +> More information: . + +- Remove specific files or registry keys (without subkeys): + +`Remove-Item {{path\to\file_or_key1 path\to\file_or_key2 ...}}` + +- Remove hidden or read-only files: + +`Remove-Item -Force {{path\to\file1 path\to\file2 ...}}` + +- Remove specific files or registry keys interactively prompting before each removal: + +`Remove-Item -Confirm {{path\to\file_or_key1 path\to\file_or_key2 ...}}` + +- Remove specific files and directories recursively (Windows 10 version 1909 or later): + +`Remove-Item -Recurse {{path\to\file_or_directory1 path\to\file_or_directory2 ...}}` + +- Remove specific Windows registry keys and all its subkeys: + +`Remove-Item -Recurse {{path\to\key1 path\to\key2 ...}}` + +- Perform a dry run of the deletion process: + +`Remove-Item -WhatIf {{path\to\file1 path\to\file2 ...}}` diff --git a/pages/windows/ri.md b/pages/windows/ri.md new file mode 100644 index 0000000..aea54a8 --- /dev/null +++ b/pages/windows/ri.md @@ -0,0 +1,8 @@ +# ri + +> In PowerShell, this command is an alias of `Remove-Item`. +> More information: . + +- View documentation for the original command: + +`tldr remove-item` diff --git a/pages/windows/rm.md b/pages/windows/rm.md new file mode 100644 index 0000000..b05d85d --- /dev/null +++ b/pages/windows/rm.md @@ -0,0 +1,8 @@ +# rm + +> In PowerShell, this command is an alias of `Remove-Item`. +> More information: . + +- View documentation for the original command: + +`tldr remove-item` diff --git a/pages/windows/rmdir.md b/pages/windows/rmdir.md index 3f23112..f20832e 100644 --- a/pages/windows/rmdir.md +++ b/pages/windows/rmdir.md @@ -1,8 +1,13 @@ # rmdir > Remove a directory and its contents. +> In PowerShell, this command is an alias of `Remove-Item`. This documentation is based on the Command Prompt (`cmd`) version of `rmdir`. > More information: . +- View the documentation of the equivalent PowerShell command: + +`tldr remove-item` + - Remove an empty directory: `rmdir {{path\to\directory}}` diff --git a/pages/windows/sc-config.md b/pages/windows/sc-config.md new file mode 100644 index 0000000..d355b88 --- /dev/null +++ b/pages/windows/sc-config.md @@ -0,0 +1,8 @@ +# sc config + +> This command is an alias of `sc.exe config`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/pages/windows/sc-create.md b/pages/windows/sc-create.md new file mode 100644 index 0000000..4bca69d --- /dev/null +++ b/pages/windows/sc-create.md @@ -0,0 +1,8 @@ +# sc create + +> This command is an alias of `sc.exe create`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/pages/windows/sc-delete.md b/pages/windows/sc-delete.md new file mode 100644 index 0000000..47eb02d --- /dev/null +++ b/pages/windows/sc-delete.md @@ -0,0 +1,8 @@ +# sc delete + +> This command is an alias of `sc.exe delete`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/pages/windows/sc-query.md b/pages/windows/sc-query.md new file mode 100644 index 0000000..603b242 --- /dev/null +++ b/pages/windows/sc-query.md @@ -0,0 +1,8 @@ +# sc query + +> This command is an alias of `sc.exe query`. +> More information: . + +- View documentation for the original command: + +`tldr sc` diff --git a/pages/windows/sc.md b/pages/windows/sc.md index 9478774..848dbb3 100644 --- a/pages/windows/sc.md +++ b/pages/windows/sc.md @@ -1,20 +1,20 @@ # sc > Communicate with the Service Control Manager and services. -> More information: . +> More information: . - Show the status of a service (no service name will list all services): -`sc queryex {{service_name}}` +`sc.exe query {{service_name}}` - Start a service asynchronously: -`sc start {{service_name}}` +`sc.exe create {{service_name}} binpath= {{path\to\service_binary_file}}` - Stop a service asynchronously: -`sc stop {{service_name}}` +`sc.exe delete {{service_name}}` - Set the type of a service: -`sc config {{service_name}} type= {{service_type}}` +`sc.exe config {{service_name}} type= {{service_type}}` diff --git a/pages/windows/set-location.md b/pages/windows/set-location.md new file mode 100644 index 0000000..320c5dd --- /dev/null +++ b/pages/windows/set-location.md @@ -0,0 +1,33 @@ +# Set-Location + +> Display the current working directory or move to a different directory. +> This command can only be used through PowerShell. +> More information: . + +- Go to the specified directory: + +`Set-Location {{path\to\directory}}` + +- Go to a specific directory in a different drive: + +`Set-Location {{C}}:{{path\to\directory}}` + +- Go and display the location of specified directory: + +`Set-Location {{path\to\directory}} -PassThru` + +- Go up to the parent of the current directory: + +`Set-Location ..` + +- Go to the home directory of the current user: + +`Set-Location ~` + +- Go back/forward to the previously chosen directory: + +`Set-Location {{-|+}}` + +- Go to root of current drive: + +`Set-Location \` diff --git a/pages/windows/sl.md b/pages/windows/sl.md new file mode 100644 index 0000000..8baa5ce --- /dev/null +++ b/pages/windows/sl.md @@ -0,0 +1,8 @@ +# sl + +> In PowerShell, this command is an alias of `Set-Location`. +> More information: . + +- View documentation for the original command: + +`tldr set-location` diff --git a/pages/windows/slmgr.md b/pages/windows/slmgr.md index 95dea23..09bf0c0 100644 --- a/pages/windows/slmgr.md +++ b/pages/windows/slmgr.md @@ -1,7 +1,7 @@ # slmgr > This command is an alias of `slmgr.vbs`. -> More information: . +> More information: . - View documentation for the original command: diff --git a/pages/windows/slmgr.vbs.md b/pages/windows/slmgr.vbs.md index 2f096c8..f96607f 100644 --- a/pages/windows/slmgr.vbs.md +++ b/pages/windows/slmgr.vbs.md @@ -2,7 +2,7 @@ > Install, activate, and manage Windows licenses. > This command may override, deactivate, and/or remove your current Windows license. Please proceed with caution. -> More information: . +> More information: . - [d]isplay the current Windows [l]icense [i]nformation: diff --git a/pages/windows/uwfmgr.md b/pages/windows/uwfmgr.md index 329736e..50bda0e 100644 --- a/pages/windows/uwfmgr.md +++ b/pages/windows/uwfmgr.md @@ -2,7 +2,7 @@ > Unified Write Filter (UWF). > Protect drives by redirecting any writes to the drive to a virtual overlay. Writes are discarded upon reboot unless committed by default. -> More information: . +> More information: . - Get the current status: diff --git a/pages/windows/w32tm.md b/pages/windows/w32tm.md index d6cb503..8f0abc3 100644 --- a/pages/windows/w32tm.md +++ b/pages/windows/w32tm.md @@ -1,7 +1,7 @@ # w32tm > Query and control the w32time time synchronization service. -> More information: . +> More information: . - Show the current status of time synchronization: diff --git a/pages/windows/wget.md b/pages/windows/wget.md index e012492..5935253 100644 --- a/pages/windows/wget.md +++ b/pages/windows/wget.md @@ -1,10 +1,11 @@ # wget > In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `wget` program () is not properly installed. +> More information: . - Check whether `wget` is properly installed by printing its version number. If this command evaluates into an error, PowerShell may have substituted this command with `Invoke-WebRequest`: -`curl --version` +`wget --version` - View documentation for the original `wget` command: diff --git a/src/main.zig b/src/main.zig index fbb502a..3756cb0 100644 --- a/src/main.zig +++ b/src/main.zig @@ -94,7 +94,15 @@ fn printPage(allocator: Allocator, stdout: File, name: []const u8) !void { try list.append(try std.fmt.allocPrint(allocator, "{s}/{s}", .{ current_os, name })); try list.append(try std.fmt.allocPrint(allocator, "common/{s}", .{name})); - const categories = [_][]const u8{ "android", "linux", "osx", "sunos", "windows" }; + const categories = [_][]const u8{ + "android", + "linux", + "osx", + "sunos", + "windows", + "freebsd", + "openbsd", + }; for (categories) |category| { if (!std.mem.eql(u8, current_os, category)) { try list.append(try std.fmt.allocPrint(allocator, "{s}/{s}", .{ category, name }));