From d90217671495ac8043d355658518e108335e1c96 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Mon, 12 May 2025 00:21:19 +0000 Subject: [PATCH] Update cheatsheets --- tldr/az-account | 4 +-- tldr/az-acr | 10 ++++---- tldr/az-advisor | 6 ++--- tldr/az-aks | 10 ++++---- tldr/az-apim | 10 ++++---- tldr/az-appconfig | 10 ++++---- tldr/az-bicep | 4 +-- tldr/az-devops | 10 ++++---- tldr/az-disk | 10 ++++---- tldr/az-group | 8 +++--- tldr/az-image | 10 ++++---- tldr/az-logicapp | 12 ++++----- tldr/az-login | 8 +++--- tldr/az-network | 4 +-- tldr/az-pipelines | 14 +++++------ tldr/az-provider | 6 ++--- tldr/az-redis | 8 +++--- tldr/az-repos | 4 +-- tldr/az-serial-console | 2 +- tldr/az-sshkey | 6 ++--- tldr/az-storage-account | 8 +++--- tldr/az-storage-container | 6 ++--- tldr/az-storage-entity | 10 ++++---- tldr/az-storage-queue | 6 ++--- tldr/az-storage-table | 6 ++--- tldr/az-tag | 8 +++--- tldr/az-upgrade | 2 +- tldr/az-version | 2 +- tldr/az-vm | 10 ++++---- tldr/az-webapp | 6 ++--- tldr/blahaj | 33 +++++++++++++++++++++++++ tldr/bzegrep | 10 ++++---- tldr/bzfgrep | 10 ++++---- tldr/bzgrep | 14 +++++------ tldr/code | 10 ++++---- tldr/cradle-install | 2 +- tldr/doctl-account | 4 +-- tldr/doctl-apps | 16 ++++++------ tldr/doctl-auth | 2 +- tldr/doctl-balance | 6 ++--- tldr/doctl-compute-droplet | 6 ++--- tldr/doctl-databases | 10 ++++---- tldr/doctl-databases-db | 10 ++++---- tldr/doctl-databases-firewalls | 8 +++--- tldr/doctl-databases-maintenance-window | 6 ++--- tldr/doctl-databases-options | 10 ++++---- tldr/doctl-databases-pool | 10 ++++---- tldr/doctl-databases-replica | 10 ++++---- tldr/doctl-databases-sql-mode | 6 ++--- tldr/doctl-databases-user | 14 +++++------ tldr/doctl-kubernetes-cluster | 12 ++++----- tldr/doctl-kubernetes-options | 6 ++--- tldr/doctl-serverless | 8 +++--- tldr/ffuf | 14 +++++------ tldr/fossil-commit | 6 ++--- tldr/glab | 6 ++--- tldr/glab-alias | 4 +-- tldr/glab-auth | 6 ++--- tldr/glab-issue | 8 +++--- tldr/glab-mr | 2 +- tldr/glab-mr-create | 8 +++--- tldr/glab-mr-merge | 6 ++--- tldr/glab-pipeline | 2 +- tldr/glab-release | 2 +- tldr/glab-repo | 2 +- tldr/hub | 2 +- tldr/hub-ci-status | 4 +-- tldr/hub-create | 2 +- tldr/hub-issue | 4 +-- tldr/ippevepcl | 2 +- tldr/ippeveps | 2 +- tldr/linux/apt-add-repository | 4 +-- tldr/linux/apt-file | 2 +- tldr/linux/btrfs-check | 4 +-- tldr/linux/btrfs-device | 6 ++--- tldr/linux/btrfs-inspect-internal | 2 +- tldr/linux/exiqgrep | 8 +++--- tldr/linux/loadkeys | 29 +++++++++++----------- tldr/linux/systemd-ac-power | 2 +- tldr/linux/systemd-cgls | 2 +- tldr/linux/systemd-cgtop | 4 +-- tldr/linux/systemd-creds | 8 +++--- tldr/linux/systemd-delta | 2 +- tldr/linux/systemd-detect-virt | 6 ++--- tldr/linux/systemd-dissect | 6 ++--- tldr/linux/systemd-escape | 4 +-- tldr/linux/systemd-firstboot | 10 ++++---- tldr/linux/systemd-hwdb | 4 +-- tldr/linux/systemd-id128 | 2 +- tldr/linux/systemd-machine-id-setup | 6 ++--- tldr/linux/systemd-mount | 8 +++--- tldr/linux/systemd-notify | 2 +- tldr/linux/systemd-nspawn | 8 +++--- tldr/linux/systemd-repart | 4 +-- tldr/linux/systemd-run | 10 ++++---- tldr/linux/systemd-socket-activate | 2 +- tldr/linux/systemd-stdio-bridge | 4 +-- tldr/linux/toolbox | 2 +- tldr/linux/toolbox-create | 10 ++++---- tldr/linux/toolbox-enter | 6 ++--- tldr/linux/toolbox-list | 4 +-- tldr/linux/toolbox-rm | 4 +-- tldr/linux/toolbox-rmi | 4 +-- tldr/linux/toolbox-run | 6 ++--- tldr/mosquitto | 8 +++--- tldr/ngrok | 2 +- tldr/olevba | 2 +- tldr/ptargrep | 4 +-- tldr/sqlmap | 8 +++--- tldr/ssh | 4 +-- tldr/ugrep | 14 +++++------ tldr/vgrep | 12 ++++----- tldr/xml | 2 +- tldr/xml-c14n | 12 +++++++++ tldr/xml-canonic | 10 ++++---- tldr/xml-depyx | 8 +++--- tldr/xml-edit | 14 +++++------ tldr/xml-elements | 14 +++++------ tldr/xml-escape | 8 +++--- tldr/xml-format | 14 +++++------ tldr/xml-list | 8 +++--- tldr/xml-p2x | 12 +++++++++ tldr/xml-pyx | 2 +- tldr/xml-select | 12 ++++----- tldr/xml-transform | 6 ++--- tldr/xml-unescape | 8 +++--- tldr/xml-validate | 12 ++++----- tldr/xml-xmln | 12 +++++++++ tldr/xzgrep | 14 +++++------ tldr/zegrep | 10 ++++---- 130 files changed, 506 insertions(+), 436 deletions(-) create mode 100644 tldr/blahaj create mode 100644 tldr/xml-c14n create mode 100644 tldr/xml-p2x create mode 100644 tldr/xml-xmln diff --git a/tldr/az-account b/tldr/az-account index e1d64126..bdcb2152 100644 --- a/tldr/az-account +++ b/tldr/az-account @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a `subscription` to be the currently active subscription: -`az account set --subscription {{subscription_id}}` +`az account set {{[-s|--subscription]}} {{subscription_id}}` - List supported regions for the currently active subscription: @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Print details of the currently active subscription in a specific format: -`az account show --output {{json|tsv|table|yaml}}` +`az account show {{[-o|--output]}} {{json|tsv|table|yaml}}` diff --git a/tldr/az-acr b/tldr/az-acr index 903688c1..b8f4b36b 100644 --- a/tldr/az-acr +++ b/tldr/az-acr @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a managed container registry: -`az acr create --name {{registry_name}} --resource-group {{resource_group}} --sku {{sku}}` +`az acr create {{[-n|--name]}} {{registry_name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{sku}}` - Login to a registry: -`az acr login --name {{registry_name}}` +`az acr login {{[-n|--name]}} {{registry_name}}` - Tag a local image for ACR: @@ -31,12 +31,12 @@ source: https://github.com/tldr-pages/tldr.git - Delete an image from a registry: -`az acr repository delete --name {{registry_name}} --repository {{image_name}}:{{tag}}` +`az acr repository delete {{[-n|--name]}} {{registry_name}} --repository {{image_name}}:{{tag}}` - Delete a managed container registry: -`az acr delete --name {{registry_name}} --resource-group {{resource_group}} --yes` +`az acr delete {{[-n|--name]}} {{registry_name}} {{[-g|--resource-group]}} {{resource_group}} {{[-y|--yes]}}` - List images within a registry: -`az acr repository list --name {{registry_name}} --output table` +`az acr repository list {{[-n|--name]}} {{registry_name}} --output table` diff --git a/tldr/az-advisor b/tldr/az-advisor index 330e06bc..1710919f 100644 --- a/tldr/az-advisor +++ b/tldr/az-advisor @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Show Azure Advisor configuration for the given subscription or resource group: -`az advisor configuration show --resource_group {{resource_group}}` +`az advisor configuration show {{[-g|--resource-group]}} {{resource_group}}` - List Azure Advisor recommendations: @@ -23,8 +23,8 @@ source: https://github.com/tldr-pages/tldr.git - Enable Azure Advisor recommendations: -`az advisor recommendation enable --resource_group {{resource_group}}` +`az advisor recommendation enable {{[-g|--resource-group]}} {{resource_group}}` - Disable Azure Advisor recommendations: -`az advisor recommendation disable --resource_group {{resource_group}}` +`az advisor recommendation disable {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/az-aks b/tldr/az-aks index 9407378d..401fde72 100644 --- a/tldr/az-aks +++ b/tldr/az-aks @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - List AKS clusters: -`az aks list --resource-group {{resource_group}}` +`az aks list {{[-g|--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}}` +`az aks create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}} {{[-c|--node-count]}} {{count}} --node-vm-size {{size}}` - Delete an AKS cluster: -`az aks delete --resource-group {{resource_group}} --name {{name}}` +`az aks delete {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` - Get the access credentials for an AKS cluster: -`az aks get-credentials --resource-group {{resource_group}} --name {{name}}` +`az aks get-credentials {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` - Get the upgrade versions available for an AKS cluster: -`az aks get-upgrades --resource-group {{resource_group}} --name {{name}}` +`az aks get-upgrades {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` diff --git a/tldr/az-apim b/tldr/az-apim index ec831670..88c8ffa6 100644 --- a/tldr/az-apim +++ b/tldr/az-apim @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - List API Management services within a resource group: -`az apim list --resource-group {{resource_group}}` +`az apim list {{[-g|--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}}` +`az apim create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --publisher-email {{email}} --publisher-name {{name}}` - Delete an API Management service: -`az apim delete --name {{name}} --resource-group {{resource_group}}` +`az apim delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Show details of an API Management service instance: -`az apim show --name {{name}} --resource-group {{resource_group}}` +`az apim show {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Update an API Management service instance: -`az apim update --name {{name}} --resource-group {{resource_group}}` +`az apim update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/az-appconfig b/tldr/az-appconfig index d7011788..190f6390 100644 --- a/tldr/az-appconfig +++ b/tldr/az-appconfig @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create an App Configuration: -`az appconfig create --name {{name}} --resource-group {{group_name}} --location {{location}}` +`az appconfig create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{group_name}} {{[-l|--location]}} {{location}}` - Delete a specific App Configuration: -`az appconfig delete --resource-group {{rg_name}} --name {{appconfig_name}}` +`az appconfig delete {{[-g|--resource-group]}} {{rg_name}} {{[-n|--name]}} {{appconfig_name}}` - List all App Configurations under the current subscription: @@ -23,12 +23,12 @@ source: https://github.com/tldr-pages/tldr.git - List all App Configurations under a specific resource group: -`az appconfig list --resource-group {{rg_name}}` +`az appconfig list {{[-g|--resource-group]}} {{rg_name}}` - Show properties of an App Configuration: -`az appconfig show --name {{appconfig_name}}` +`az appconfig show {{[-n|--name]}} {{appconfig_name}}` - Update a specific App Configuration: -`az appconfig update --resource-group {{rg_name}} --name {{appconfig_name}}` +`az appconfig update {{[-g|--resource-group]}} {{rg_name}} {{[-n|--name]}} {{appconfig_name}}` diff --git a/tldr/az-bicep b/tldr/az-bicep index dc66ddd7..945bc7de 100644 --- a/tldr/az-bicep +++ b/tldr/az-bicep @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Build a Bicep file: -`az bicep build --file {{path/to/file.bicep}}` +`az bicep build {{[-f|--file]}} {{path/to/file.bicep}}` - Attempt to decompile an ARM template file to a Bicep file: -`az bicep decompile --file {{path/to/template_file.json}}` +`az bicep decompile {{[-f|--file]}} {{path/to/template_file.json}}` - Upgrade Bicep CLI to the latest version: diff --git a/tldr/az-devops b/tldr/az-devops index 55e32ad9..06b86d1d 100644 --- a/tldr/az-devops +++ b/tldr/az-devops @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Set the Personal Access Token (PAT) to login to a particular organization: -`az devops login --organization {{organization_url}}` +`az devops login {{[--org|--organization]}} {{organization_url}}` - Open a project in the browser: -`az devops project show --project {{project_name}} --open` +`az devops project show {{[-p|--project]}} {{project_name}} --open` - List members of a specific team working on a particular project: -`az devops team list-member --project {{project_name}} --team {{team_name}}` +`az devops team list-member {{[-p|--project]}} {{project_name}} --team {{team_name}}` - Check the Azure DevOps CLI current configuration: -`az devops configure --list` +`az devops configure {{[-l|--list]}}` - Configure the Azure DevOps CLI behavior by setting a default project and a default organization: -`az devops configure --defaults project={{project_name}} organization={{organization_url}}` +`az devops configure {{[-d|--defaults]}} project={{project_name}} organization={{organization_url}}` diff --git a/tldr/az-disk b/tldr/az-disk index 7780ac92..a9fef830 100644 --- a/tldr/az-disk +++ b/tldr/az-disk @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a managed disk: -`az disk create --resource-group {{resource_group}} --name {{disk_name}} --size-gb {{size_in_gb}}` +`az disk create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[-z|--size-gb]}}{{size_in_gb}}` - List managed disks in a resource group: -`az disk list --resource-group {{resource_group}}` +`az disk list {{[-g|--resource-group]}} {{resource_group}}` - Delete a managed disk: -`az disk delete --resource-group {{resource_group}} --name {{disk_name}}` +`az disk delete {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}}` - Grant read or write access to a managed disk (for export): -`az disk grant-access --resource-group {{resource_group}} --name {{disk_name}} --access-level {{Read|Write}} --duration-in-seconds {{seconds}}` +`az disk grant-access {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[--access|--access-level]}} {{Read|Write}} --duration-in-seconds {{seconds}}` - Update disk size: -`az disk update --resource-group {{resource_group}} --name {{disk_name}} --size-gb {{new_size_in_gb}}` +`az disk update {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[-z|--size-gb]}} {{new_size_in_gb}}` diff --git a/tldr/az-group b/tldr/az-group index 84a1028f..9da790d4 100644 --- a/tldr/az-group +++ b/tldr/az-group @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a new resource group: -`az group create --name {{name}} --location {{location}}` +`az group create {{[-n|--name]}} {{name}} {{[-l|--location]}} {{location}}` - Check if a resource group exists: -`az group exists --name {{name}}` +`az group exists {{[-n|--name]}} {{name}}` - Delete a resource group: -`az group delete --name {{name}}` +`az group delete {{[-n|--name]}} {{name}}` - Wait until a condition of the resource group is met: -`az group wait --name {{name}} --{{created|deleted|exists|updated}}` +`az group wait {{[-n|--name]}} {{name}} --{{created|deleted|exists|updated}}` diff --git a/tldr/az-image b/tldr/az-image index 664f76b8..5dd0ffa3 100644 --- a/tldr/az-image +++ b/tldr/az-image @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - List the custom images under a resource group: -`az image list --resource-group {{resource_group}}` +`az image list {{[-g|--resource-group]}} {{resource_group}}` - Create a custom image from managed disks or snapshots: -`az image create --resource-group {{resource_group}} --name {{name}} --os-type {{windows|linux}} --source {{os_disk_source}}` +`az image create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}} --os-type {{windows|linux}} --source {{os_disk_source}}` - Delete a custom image: -`az image delete --name {{name}} --resource-group {{resource_group}}` +`az image delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Show details of a custom image: -`az image show --name {{name}} --resource-group {{resource_group}}` +`az image show {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Update custom images: -`az image update --name {{name}} --resource-group {{resource_group}} --set {{property=value}}` +`az image update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --set {{property=value}}` diff --git a/tldr/az-logicapp b/tldr/az-logicapp index 75295f72..90871c13 100644 --- a/tldr/az-logicapp +++ b/tldr/az-logicapp @@ -11,24 +11,24 @@ source: https://github.com/tldr-pages/tldr.git - Create a logic app: -`az logicapp create --name {{name}} --resource-group {{resource_group}} --storage-account {{storage_account}}` +`az logicapp create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} {{[-s|--storage-account]}} {{storage_account}}` - Delete a logic app: -`az logicapp delete --name {{name}} --resource-group {{resource_group}}` +`az logicapp delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - List logic apps: -`az logicapp list --resource-group {{resource_group}}` +`az logicapp list {{[-g|--resource-group]}} {{resource_group}}` - Restart a logic app: -`az logicapp restart --name {{name}} --resource-group {{resource_group}}` +`az logicapp restart {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Start a logic app: -`az logicapp start --name {{name}} --resource-group {{resource_group}}` +`az logicapp start {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Stop a logic app: -`az logicapp stop --name {{name}} --resource-group {{resource_group}}` +`az logicapp stop {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/az-login b/tldr/az-login index e5ad853e..f440ec54 100644 --- a/tldr/az-login +++ b/tldr/az-login @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Log in with a service principal using a client secret: -`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{secret}} --tenant {{someone.onmicrosoft.com}}` +`az login --service-principal {{[-u|--username]}} {{http://azure-cli-service-principal}} {{[-p|--password]}} {{secret}} --tenant {{someone.onmicrosoft.com}}` - Log in with a service principal using a client certificate: -`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{path/to/cert.pem}} --tenant {{someone.onmicrosoft.com}}` +`az login --service-principal {{[-u|--username]}} {{http://azure-cli-service-principal}} {{[-p|--password]}} {{path/to/cert.pem}} {{[-t|--tenant]}} {{someone.onmicrosoft.com}}` - Log in using a VM's system assigned identity: -`az login --identity` +`az login {{[-i|--identity]}}` - Log in using a VM's user assigned identity: -`az login --identity --username /subscriptions/{{subscription_id}}/resourcegroups/{{my_rg}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{my_id}}` +`az login {{[-i|--identity]}} {{[-u|--username]}} /subscriptions/{{subscription_id}}/resourcegroups/{{my_rg}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{my_id}}` diff --git a/tldr/az-network b/tldr/az-network index 1d89b9de..160a819e 100644 --- a/tldr/az-network +++ b/tldr/az-network @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Create a virtual network: -`az network vnet create --address-prefixes {{10.0.0.0/16}} --name {{vnet}} --resource_group {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` +`az network vnet create --address-prefixes {{10.0.0.0/16}} {{[-n|--name]}} {{vnet}} {{[-g|--resource-group]}} {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` - Enable accelerated networking for a network interface card: -`az network nic update --accelerated-networking true --name {{nic}} --resource-group {{resource_group}}` +`az network nic update --accelerated-networking true {{[-n|--name]}} {{nic}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/az-pipelines b/tldr/az-pipelines index bb2925f1..a5b93986 100644 --- a/tldr/az-pipelines +++ b/tldr/az-pipelines @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Create a new Azure Pipeline (YAML based): -`az pipelines create --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --description {{description}} --repository {{repository_name}} --branch {{branch_name}}` +`az pipelines create {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}} --description {{description}} --repository {{repository_name}} --branch {{branch_name}}` - Delete a specific pipeline: -`az pipelines delete --org {{organization_url}} --project {{project_name}} --id {{pipeline_id}}` +`az pipelines delete {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --id {{pipeline_id}}` - List pipelines: -`az pipelines list --org {{organization_url}} --project {{project_name}}` +`az pipelines list {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}}` - Enqueue a specific pipeline to run: -`az pipelines run --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` +`az pipelines run {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}}` - Get the details of a specific pipeline: -`az pipelines show --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` +`az pipelines show {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}}` - Update a specific pipeline: -`az pipelines update --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --new-name {{pipeline_new_name}} --new-folder-path {{user1/production_pipelines}}` +`az pipelines update {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}} --new-name {{pipeline_new_name}} --new-folder-path {{user1/production_pipelines}}` - List all agents in a pool: -`az pipelines agent list --org {{organization_url}} --pool-id {{agent_pool}}` +`az pipelines agent list {{[--org|--organization]}} {{organization_url}} --pool-id {{agent_pool}}` diff --git a/tldr/az-provider b/tldr/az-provider index 76f84d43..c555d412 100644 --- a/tldr/az-provider +++ b/tldr/az-provider @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Register a provider: -`az provider register --namespace {{Microsoft.PolicyInsights}}` +`az provider register {{[-n|--namespace]}} {{Microsoft.PolicyInsights}}` - Unregister a provider: -`az provider unregister --namespace {{Microsoft.Automation}}` +`az provider unregister {{[-n|--namespace]}} {{Microsoft.Automation}}` - List all providers for a subscription: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Show information about a specific provider: -`az provider show --namespace {{Microsoft.Storage}}` +`az provider show {{[-n|--namespace]}} {{Microsoft.Storage}}` - List all resource types for a specific provider: diff --git a/tldr/az-redis b/tldr/az-redis index eff71e27..7db3986f 100644 --- a/tldr/az-redis +++ b/tldr/az-redis @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a new Redis cache instance: -`az redis create --location {{location}} --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` +`az redis create --location {{location}} {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` - Update a Redis cache: -`az redis update --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` +`az redis update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` - Export data stored in a Redis cache: -`az redis export --container {{container}} --file-format {{file-format}} --name {{name}} --prefix {{prefix}} --resource-group {{resource_group}}` +`az redis export --container {{container}} --file-format {{file-format}} {{[-n|--name]}} {{name}} --prefix {{prefix}} {{[-g|--resource-group]}} {{resource_group}}` - Delete a Redis cache: -`az redis delete --name {{name}} --resource-group {{resource_group}} --yes` +`az redis delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} {{[-y|--yes]}}` diff --git a/tldr/az-repos b/tldr/az-repos index f3f18d78..eb5c1b06 100644 --- a/tldr/az-repos +++ b/tldr/az-repos @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List all repos in a specific project: -`az repos list --project {{project_name}}` +`az repos list {{[-p|--project]}} {{project_name}}` - Add policy on a specific branch of a specific repository to restrict basic merge: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - List all active Pull Requests on a specific repository within a specific project: -`az repos pr list --project {{project_name}} --repository {{repository_name}} --status active` +`az repos pr list {{[-p|--project]}} {{project_name}} {{[-r|--repository]}} {{repository_name}} --status active` diff --git a/tldr/az-serial-console b/tldr/az-serial-console index 76466945..634e9f36 100644 --- a/tldr/az-serial-console +++ b/tldr/az-serial-console @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Connect to a serial console: -`az serial-console connect --resource-group {{Resource_Group_Name}} --name {{Virtual_Machine_Name}}` +`az serial-console connect {{[-g|--resource-group]}} {{Resource_Group_Name}} {{[-n|--name]}} {{Virtual_Machine_Name}}` - Terminate the connection: diff --git a/tldr/az-sshkey b/tldr/az-sshkey index 63087c70..2565b287 100644 --- a/tldr/az-sshkey +++ b/tldr/az-sshkey @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a new SSH key: -`az sshkey create --name {{name}} --resource-group {{resource_group}}` +`az sshkey create --name {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Upload an existing SSH key: -`az sshkey create --name {{name}} --resource-group {{resource_group}} --public-key "{{@path/to/key.pub}}"` +`az sshkey create --name {{name}} {{[-g|--resource-group]}} {{resource_group}} --public-key "{{@path/to/key.pub}}"` - List all SSH public keys: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Show information about an SSH public key: -`az sshkey show --name {{name}} --resource-group {{resource_group}}` +`az sshkey show --name {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/az-storage-account b/tldr/az-storage-account index c8550449..3504e287 100644 --- a/tldr/az-storage-account +++ b/tldr/az-storage-account @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Create an storage account: -`az storage account create --name {{storage_account_name}} --resource-group {{azure_resource_group}} --location {{azure_location}} --sku {{storage_account_sku}}` +`az storage account create {{[-n|--name]}} {{storage_account_name}} {{[-g|--resource-group]}} {{azure_resource_group}} --location {{azure_location}} --sku {{storage_account_sku}}` - Generate a shared access signature for a specific storage account: -`az storage account generate-sas --account-name {{storage_account_name}} --name {{account_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --services {{storage_services}} --resource-types {{resource_types}}` +`az storage account generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{account_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --services {{storage_services}} --resource-types {{resource_types}}` - List storage accounts: -`az storage account list --resource-group {{azure_resource_group}}` +`az storage account list {{[-g|--resource-group]}} {{azure_resource_group}}` - Delete a specific storage account: -`az storage account delete --name {{storage_account_name}} --resource-group {{azure_resource_group}}` +`az storage account delete {{[-n|--name]}} {{storage_account_name}} {{[-g|--resource-group]}} {{azure_resource_group}}` diff --git a/tldr/az-storage-container b/tldr/az-storage-container index 92710310..0241ccdb 100644 --- a/tldr/az-storage-container +++ b/tldr/az-storage-container @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a container in a storage account: -`az storage container create --account-name {{storage_account_name}} --name {{container_name}} --public-access {{access_level}} --fail-on-exist` +`az storage container create --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --public-access {{access_level}} --fail-on-exist` - Generate a shared access signature for the container: -`az storage container generate-sas --account-name {{storage_account_name}} --name {{container_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` +`az storage container generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` - List containers in a storage account: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Mark the specified container for deletion: -`az storage container delete --account-name {{storage_account_name}} --name {{container_name}} --fail-not-exist` +`az storage container delete --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --fail-not-exist` diff --git a/tldr/az-storage-entity b/tldr/az-storage-entity index 3d53b046..7e521ffe 100644 --- a/tldr/az-storage-entity +++ b/tldr/az-storage-entity @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Insert an entity into a table: -`az storage entity insert --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity insert {{[-e|--entity]}} {{space_separated_key_value_pairs}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Delete an existing entity from a table: -`az storage entity delete --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity delete --partition-key {{partition_key}} --row-key {{row_key}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Update an existing entity by merging its properties: -`az storage entity merge --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity merge {{[-e|--entity]}} {{space_separated_key_value_pairs}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - List entities which satisfy a query: -`az storage entity query --filter {{query_filter}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity query --filter {{query_filter}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Get an entity from the specified table: -`az storage entity show --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity show --partition-key {{partition_key}} --row-key {{row_key}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` diff --git a/tldr/az-storage-queue b/tldr/az-storage-queue index 76e78255..f5020d3b 100644 --- a/tldr/az-storage-queue +++ b/tldr/az-storage-queue @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a queue: -`az storage queue create --account-name {{storage_account_name}} --name {{queue_name}} --metadata {{queue_metadata}}` +`az storage queue create --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --metadata {{queue_metadata}}` - Generate a shared access signature for the queue: -`az storage queue generate-sas --account-name {{storage_account_name}} --name {{queue_name}} --permissions {{queue_permissions}} --expiry {{expiry_date}} --https-only` +`az storage queue generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --permissions {{queue_permissions}} --expiry {{expiry_date}} --https-only` - List queues in a storage account: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete the specified queue and any messages it contains: -`az storage queue delete --account-name {{storage_account_name}} --name {{queue_name}} --fail-not-exist` +`az storage queue delete --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --fail-not-exist` diff --git a/tldr/az-storage-table b/tldr/az-storage-table index 349e0c63..fb5135d3 100644 --- a/tldr/az-storage-table +++ b/tldr/az-storage-table @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a new table in the storage account: -`az storage table create --account-name {{storage_account_name}} --name {{table_name}} --fail-on-exist` +`az storage table create --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --fail-on-exist` - Generate a shared access signature for the table: -`az storage table generate-sas --account-name {{storage_account_name}} --name {{table_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` +`az storage table generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` - List tables in a storage account: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete the specified table and any data it contains: -`az storage table delete --account-name {{storage_account_name}} --name {{table_name}} --fail-not-exist` +`az storage table delete --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --fail-not-exist` diff --git a/tldr/az-tag b/tldr/az-tag index 2ca0107a..2a4f54e1 100644 --- a/tldr/az-tag +++ b/tldr/az-tag @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Create a tag value: -`az tag add-value --name {{tag_name}} --value {{tag_value}}` +`az tag add-value {{[-n|--name]}} {{tag_name}} --value {{tag_value}}` - Create a tag in the subscription: -`az tag create --name {{tag_name}}` +`az tag create {{[-n|--name]}} {{tag_name}}` - Delete a tag from the subscription: -`az tag delete --name {{tag_name}}` +`az tag delete {{[-n|--name]}} {{tag_name}}` - List all tags on a subscription: @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete a tag value for a specific tag name: -`az tag remove-value --name {{tag_name}} --value {{tag_value}}` +`az tag remove-value {{[-n|--name]}} {{tag_name}} --value {{tag_value}}` diff --git a/tldr/az-upgrade b/tldr/az-upgrade index acaa2d02..11ae6a49 100644 --- a/tldr/az-upgrade +++ b/tldr/az-upgrade @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade Azure CLI and Extensions without prompting for confirmation: -`az version --all --yes` +`az version --all {{[-y|--yes]}}` diff --git a/tldr/az-version b/tldr/az-version index 97901280..5d4a2787 100644 --- a/tldr/az-version +++ b/tldr/az-version @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the current version of Azure CLI modules and extensions in a given format: -`az version --output {{json|table|tsv}}` +`az version {{[-o|--output]}} {{json|table|tsv}}` diff --git a/tldr/az-vm b/tldr/az-vm index adfe80cd..bbb8746b 100644 --- a/tldr/az-vm +++ b/tldr/az-vm @@ -15,23 +15,23 @@ source: https://github.com/tldr-pages/tldr.git - Create a virtual machine using the default Ubuntu image and generate SSH keys: -`az vm create --resource-group {{rg}} --name {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` +`az vm create {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` - Stop a Virtual Machine: -`az vm stop --resource-group {{rg}} --name {{vm_name}}` +`az vm stop {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Deallocate a Virtual Machine: -`az vm deallocate --resource-group {{rg}} --name {{vm_name}}` +`az vm deallocate {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Start a Virtual Machine: -`az vm start --resource-group {{rg}} --name {{vm_name}}` +`az vm start {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Restart a Virtual Machine: -`az vm restart --resource-group {{rg}} --name {{vm_name}}` +`az vm restart {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - List VM images available in the Azure Marketplace: diff --git a/tldr/az-webapp b/tldr/az-webapp index ace32379..2d19b8ca 100644 --- a/tldr/az-webapp +++ b/tldr/az-webapp @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - List available runtimes for a web application: -`az webapp list-runtimes --os-type {{windows|linux}}` +`az webapp list-runtimes {{[-os|--os-type]}} {{windows|linux}}` - Create a web application: -`az webapp up --name {{name}} --location {{location}} --runtime {{runtime}}` +`az webapp up {{[-n|--name]}} {{name}} {{[-l|--location]}} {{location}} {{[-r|--runtime]}} {{runtime}}` - List all web applications: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete a specific web application: -`az webapp delete --name {{name}} --resource-group {{resource_group}}` +`az webapp delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/tldr/blahaj b/tldr/blahaj new file mode 100644 index 00000000..54a97fbd --- /dev/null +++ b/tldr/blahaj @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# blahaj + +> A lolcat-like output colorizer that also prints flags and colorful sharks. +> More information: . + +- Get a list of possible flags/colors: + +`blahaj --flags` + +- Print a shark (blahaj) with default trans colors: + +`blahaj {{[-s|--shark]}}` + +- Print a random flag with a 2x size multiplier: + +`blahaj {{[-f|--flag]}} {{[-r|--random]}} {{[-m|--multiplier]}} 2` + +- Print the result of a text-producing command with lesbian colors: + +`{{cowsay "Hello, world"}} | blahaj {{[-c|--colors]}} lesbian` + +- Print text and color by individual character: + +`echo "{{Hello, world}}" | blahaj {{[-i|--individual]}}` + +- Print contents of a text document, coloring the background instead of text, by word: + +`blahaj {{[-w|--words]}} {{[-b|--background]}} {{path/to/file}}` diff --git a/tldr/bzegrep b/tldr/bzegrep index eecbf750..77e93a5c 100644 --- a/tldr/bzegrep +++ b/tldr/bzegrep @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-insensitive): -`bzegrep --ignore-case "{{search_pattern}}" {{path/to/file}}` +`bzegrep {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` - Search for lines that do not match a pattern: -`bzegrep --invert-match "{{search_pattern}}" {{path/to/file}}` +`bzegrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file}}` - Print file name and line number for each match: -`bzegrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` +`bzegrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Search for lines matching a pattern, printing only the matched text: -`bzegrep --only-matching "{{search_pattern}}" {{path/to/file}}` +`bzegrep {{[-o|--only-matching]}} "{{search_pattern}}" {{path/to/file}}` - Recursively search files in a bzip2 compressed tar archive for a pattern: -`bzegrep --recursive "{{search_pattern}}" {{path/to/file}}` +`bzegrep {{[-r|--recursive]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/bzfgrep b/tldr/bzfgrep index 50922adf..26808400 100644 --- a/tldr/bzfgrep +++ b/tldr/bzfgrep @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Search for lines matching the list of search strings separated by new lines in a compressed file (case-insensitive): -`bzfgrep --ignore-case "{{search_string}}" {{path/to/file}}` +`bzfgrep {{[-i|--ignore-case]}} "{{search_string}}" {{path/to/file}}` - Search for lines that do not match the list of search strings separated by new lines in a compressed file: -`bzfgrep --invert-match "{{search_string}}" {{path/to/file}}` +`bzfgrep {{[-v|--invert-match]}} "{{search_string}}" {{path/to/file}}` - Print file name and line number for each match: -`bzfgrep --with-filename --line-number "{{search_string}}" {{path/to/file}}` +`bzfgrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_string}}" {{path/to/file}}` - Search for lines matching a pattern, printing only the matched text: -`bzfgrep --only-matching "{{search_string}}" {{path/to/file}}` +`bzfgrep {{[-o|--only-matching]}} "{{search_string}}" {{path/to/file}}` - Recursively search files in a bzip2 compressed tar archive for the given list of strings: -`bzfgrep --recursive "{{search_string}}" {{path/to/file}}` +`bzfgrep {{[-r|--recursive]}} "{{search_string}}" {{path/to/file}}` diff --git a/tldr/bzgrep b/tldr/bzgrep index cd1d4b4b..8126334e 100644 --- a/tldr/bzgrep +++ b/tldr/bzgrep @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Use extended regular expressions (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: -`bzgrep --extended-regexp --ignore-case "{{search_pattern}}" {{path/to/file}}` +`bzgrep {{[-E|--extended-regexp]}} {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` -- Print 3 lines of context around, before, or after each match: +- Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: -`bzgrep --{{context|before-context|after-context}}={{3}} "{{search_pattern}}" {{path/to/file}}` +`bzgrep --{{context|before-context|after-context}} {{3}} "{{search_pattern}}" {{path/to/file}}` - Print file name and line number for each match: -`bzgrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` +`bzgrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Search for lines matching a pattern, printing only the matched text: -`bzgrep --only-matching "{{search_pattern}}" {{path/to/file}}` +`bzgrep {{[-o|--only-matching]}} "{{search_pattern}}" {{path/to/file}}` - Recursively search files in a bzip2 compressed tar archive for a pattern: -`bzgrep --recursive "{{search_pattern}}" {{path/to/tar/file}}` +`bzgrep {{[-r|--recursive]}} "{{search_pattern}}" {{path/to/tar/file}}` - Search `stdin` for lines that do not match a pattern: -`cat {{/path/to/bz/compressed/file}} | bzgrep --invert-match "{{search_pattern}}"` +`cat {{/path/to/bz/compressed/file}} | bzgrep {{[-v|--invert-match]}} "{{search_pattern}}"` diff --git a/tldr/code b/tldr/code index 0681fcbf..1d93a281 100644 --- a/tldr/code +++ b/tldr/code @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # code > Cross platform and extensible code editor. -> More information: . +> More information: . - Start Visual Studio Code: @@ -18,19 +18,19 @@ source: https://github.com/tldr-pages/tldr.git - Compare two specific files: -`code --diff {{path/to/file1}} {{path/to/file2}}` +`code {{[-d|--diff]}} {{path/to/file1}} {{path/to/file2}}` - Open specific files/directories in a new window: -`code --new-window {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` +`code {{[-n|--new-window]}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` - Install/uninstall a specific extension: `code --{{install|uninstall}}-extension {{publisher.extension}}` -- Print installed extensions: +- Display diagnostic and process information about the running code window: -`code --list-extensions` +`code {{[-s|--status]}}` - Print installed extensions with their versions: diff --git a/tldr/cradle-install b/tldr/cradle-install index 7e5f96a6..f92eb6a8 100644 --- a/tldr/cradle-install +++ b/tldr/cradle-install @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Forcefully overwrite files: -`cradle install --force` +`cradle install {{[-f|--force]}}` - Skip running SQL migrations: diff --git a/tldr/doctl-account b/tldr/doctl-account index 912f0b77..4193acf2 100644 --- a/tldr/doctl-account +++ b/tldr/doctl-account @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Display account info: -`doctl account get` +`doctl account {{[g|get]}}` - Show the hourly API limit, progress towards it, and when the rate limit resets: -`doctl account ratelimit` +`doctl account {{[rl|ratelimit]}}` - Display help: diff --git a/tldr/doctl-apps b/tldr/doctl-apps index 8e756fda..11456064 100644 --- a/tldr/doctl-apps +++ b/tldr/doctl-apps @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Create an app: -`doctl apps create` +`doctl {{[a|apps]}} {{[c|create]}}` - Create a deployment for a specific app: -`doctl apps create-deployment {{app_id}}` +`doctl {{[a|apps]}} {{[cd|create-deployment]}} {{app_id}}` - Delete an app interactively: -`doctl apps delete {{app_id}}` +`doctl {{[a|apps]}} {{[d|delete]}} {{app_id}}` - Get an app: -`doctl apps get` +`doctl {{[a|apps]}} {{[g|get]}}` - List all apps: -`doctl apps list` +`doctl {{[a|apps]}} {{[ls|list]}}` - List all deployments from a specific app: -`doctl apps list-deployments {{app_id}}` +`doctl {{[a|apps]}} {{[lsd|list-deployments]}} {{app_id}}` - Get logs from a specific app: -`doctl apps logs {{app_id}}` +`doctl {{[a|apps]}} {{[l|logs]}} {{app_id}}` - Update a specific app with a given app spec: -`doctl apps update {{app_id}} --spec {{path/to/spec.yml}}` +`doctl {{[a|apps]}} {{[u|update]}} {{app_id}} --spec {{path/to/spec.yml}}` diff --git a/tldr/doctl-auth b/tldr/doctl-auth index 66bf6252..d6539487 100644 --- a/tldr/doctl-auth +++ b/tldr/doctl-auth @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List authentication contexts (API tokens): -`doctl auth list` +`doctl auth {{[ls|list]}}` - Switch contexts (API tokens): diff --git a/tldr/doctl-balance b/tldr/doctl-balance index 4ce1c476..37204db8 100644 --- a/tldr/doctl-balance +++ b/tldr/doctl-balance @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Get balance of the account associated with the current context: -`doctl balance get` +`doctl balance {{[g|get]}}` - Get the balance of an account associated with an access token: -`doctl balance get {{[-t|--access-token]}} {{access_token}}` +`doctl balance {{[g|get]}} {{[-t|--access-token]}} {{access_token}}` - Get the balance of an account associated with a specified context: -`doctl balance get --context` +`doctl balance {{[g|get]}} --context` diff --git a/tldr/doctl-compute-droplet b/tldr/doctl-compute-droplet index 5da9f634..1d218268 100644 --- a/tldr/doctl-compute-droplet +++ b/tldr/doctl-compute-droplet @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a droplet: -`doctl compute droplet create --region {{region}} --image {{os_image}} --size {{vps_type}} {{droplet_name}}` +`doctl compute {{[d|droplet]}} {{[c|create]}} --region {{region}} --image {{os_image}} --size {{vps_type}} {{droplet_name}}` - Delete a droplet: -`doctl compute droplet delete {{droplet_id|droplet_name}}` +`doctl compute {{[d|droplet]}} {{[d|delete]}} {{droplet_id|droplet_name}}` - List droplets: -`doctl compute droplet list` +`doctl compute {{[d|droplet]}} {{[ls|list]}}` diff --git a/tldr/doctl-databases b/tldr/doctl-databases index 7a9e7aa2..65d41beb 100644 --- a/tldr/doctl-databases +++ b/tldr/doctl-databases @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases` command with an access token: -`doctl databases {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Get details for a database cluster: -`doctl databases get` +`doctl {{[d|databases]}} {{[g|get]}}` - List your database clusters: -`doctl databases list` +`doctl {{[d|databases]}} {{[ls|list]}}` - Create a database cluster: -`doctl databases create {{database_name}}` +`doctl {{[d|databases]}} {{[c|create]}} {{database_name}}` - Delete a cluster: -`doctl databases delete {{database_id}}` +`doctl {{[d|databases]}} {{[rm|delete]}} {{database_id}}` diff --git a/tldr/doctl-databases-db b/tldr/doctl-databases-db index 5fed7b73..b9517c74 100644 --- a/tldr/doctl-databases-db +++ b/tldr/doctl-databases-db @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases db` command with an access token: -`doctl databases db {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} db {{command}} {{[-t|--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}}` +`doctl {{[d|databases]}} db {{[g|get]}} {{database_id}} {{database_name}}` - List existing databases hosted within a given database cluster: -`doctl databases db list {{database_id}}` +`doctl {{[d|databases]}} db {{[ls|list]}} {{database_id}}` - Create a database with the given name in the given database cluster: -`doctl databases db create {{database_id}} {{database_name}}` +`doctl {{[d|databases]}} db {{[c|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}}` +`doctl {{[d|databases]}} db {{[rm|delete]}} {{database_id}} {{database_name}}` diff --git a/tldr/doctl-databases-firewalls b/tldr/doctl-databases-firewalls index 40caf372..0aae1624 100644 --- a/tldr/doctl-databases-firewalls +++ b/tldr/doctl-databases-firewalls @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases firewalls` command with an access token: -`doctl databases firewalls {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[fw|firewalls]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve a list of firewall rules for a given database: -`doctl databases firewalls list` +`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[ls|list]}}` - Add a database firewall rule to a given database: -`doctl databases firewalls append {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}` +`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[a|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}}` +`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[rm|remove]}} {{database_id}} {{rule_uuid}}` diff --git a/tldr/doctl-databases-maintenance-window b/tldr/doctl-databases-maintenance-window index 09c5e615..4027b627 100644 --- a/tldr/doctl-databases-maintenance-window +++ b/tldr/doctl-databases-maintenance-window @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases maintenance-window` command with an access token: -`doctl databases maintenance-window {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve details about a database cluster's maintenance windows: -`doctl databases maintenance-window get {{database_id}}` +`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{[g|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}}` +`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{[u|update]}} {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}` diff --git a/tldr/doctl-databases-options b/tldr/doctl-databases-options index 0f85f6e1..8378d679 100644 --- a/tldr/doctl-databases-options +++ b/tldr/doctl-databases-options @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases options` command with an access token: -`doctl databases options {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[o|options]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve a list of the available database engines: -`doctl databases options engines` +`doctl {{[d|databases]}} {{[o|options]}} {{[eng|engines]}}` - Retrieve a list of the available regions for a given database engine: -`doctl databases options regions --engine {{pg|mysql|redis|mongodb}}` +`doctl {{[d|databases]}} {{[o|options]}} {{[r|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}}` +`doctl {{[d|databases]}} {{[o|options]}} {{[s|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}}` +`doctl {{[d|databases]}} {{[o|options]}} {{[v|versions]}} --engine {{pg|mysql|redis|mongodb}}` diff --git a/tldr/doctl-databases-pool b/tldr/doctl-databases-pool index 0c43b714..8ec77b54 100644 --- a/tldr/doctl-databases-pool +++ b/tldr/doctl-databases-pool @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases pool` command with an access token: -`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve information about a database connection pool: -`doctl databases pool get {{database_id}} {{pool_name}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{[g|get]}} {{database_id}} {{pool_name}}` - List connection pools for a database cluster: -`doctl databases pool list {{database_id}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{[ls|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}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{[c|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}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{[c|create]}} {{database_id}} {{pool_name}}` diff --git a/tldr/doctl-databases-replica b/tldr/doctl-databases-replica index 98b85eeb..54eac91b 100644 --- a/tldr/doctl-databases-replica +++ b/tldr/doctl-databases-replica @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases replica` command with an access token: -`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[p|pool]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve information about a read-only database replica: -`doctl databases replica get {{database_id}} {{replica_name}}` +`doctl {{[d|databases]}} {{[r|replica]}} {{[g|get]}} {{database_id}} {{replica_name}}` - Retrieve list of read-only database replicas: -`doctl databases replica list {{database_id}}` +`doctl {{[d|databases]}} {{[r|replica]}} {{[ls|list]}} {{database_id}}` - Create a read-only database replica: -`doctl databases replica create {{database_id}} {{replica_name}}` +`doctl {{[d|databases]}} {{[r|replica]}} {{[c|create]}} {{database_id}} {{replica_name}}` - Delete a read-only database replica: -`doctl databases replica delete {{database_id}} {{replica_name}}` +`doctl {{[d|databases]}} {{[r|replica]}} {{[rm|delete]}} {{database_id}} {{replica_name}}` diff --git a/tldr/doctl-databases-sql-mode b/tldr/doctl-databases-sql-mode index 0ed8c42b..cded6a6b 100644 --- a/tldr/doctl-databases-sql-mode +++ b/tldr/doctl-databases-sql-mode @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases sql-mode` command with an access token: -`doctl databases sql-mode {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Get a MySQL database cluster's SQL modes: -`doctl databases sql-mode get {{database_id}}` +`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{[g|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 ...}}` +`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{[s|set]}} {{database_id}} {{sql_mode_1 sql_mode_2 ...}}` diff --git a/tldr/doctl-databases-user b/tldr/doctl-databases-user index e3590d53..e4bed7f3 100644 --- a/tldr/doctl-databases-user +++ b/tldr/doctl-databases-user @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases user` command with an access token: -`doctl databases user {{command}} {{[-t|--access-token]}} {{access_token}}` +`doctl {{[d|databases]}} {{[u|user]}} {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve details about a database user: -`doctl databases user get {{database_id}} {{user_name}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[g|get]}} {{database_id}} {{user_name}}` - Retrieve a list of database users for a given database: -`doctl databases user list {{database_id}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[ls|list]}} {{database_id}}` - Reset the auth password for a given user: -`doctl databases user reset {{database id}} {{user_name}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[rs|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}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[rs|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}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[c|create]}} {{database_id}} {{user_name}}` - Delete a user from the given database with the given username: -`doctl databases user delete {{database_id}} {{user_name}}` +`doctl {{[d|databases]}} {{[u|user]}} {{[rm|delete]}} {{database_id}} {{user_name}}` diff --git a/tldr/doctl-kubernetes-cluster b/tldr/doctl-kubernetes-cluster index 74c48d82..e79f1d27 100644 --- a/tldr/doctl-kubernetes-cluster +++ b/tldr/doctl-kubernetes-cluster @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Create a Kubernetes cluster: -`doctl kubernetes cluster create --count {{3}} --region {{nyc1}} --size {{s-1vcpu-2gb}} --version {{latest}} {{cluster_name}}` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[c|create]}} --count {{3}} --region {{nyc1}} --size {{s-1vcpu-2gb}} --version {{latest}} {{cluster_name}}` - List all Kubernetes clusters: -`doctl kubernetes cluster list` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[ls|list]}}` - Fetch and save the kubeconfig: -`doctl kubernetes cluster kubeconfig save {{cluster_name}}` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[cfg|kubeconfig]}} {{[s|save]}} {{cluster_name}}` - Check for available upgrades: -`doctl kubernetes cluster get-upgrades {{cluster_name}}` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[gu|get-upgrades]}} {{cluster_name}}` - Upgrade a cluster to a new Kubernetes version: -`doctl kubernetes cluster upgrade {{cluster_name}}` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} upgrade {{cluster_name}}` - Delete a cluster: -`doctl kubernetes cluster delete {{cluster_name}}` +`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[d|delete]}} {{cluster_name}}` diff --git a/tldr/doctl-kubernetes-options b/tldr/doctl-kubernetes-options index 816ce782..2bfcf27c 100644 --- a/tldr/doctl-kubernetes-options +++ b/tldr/doctl-kubernetes-options @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - List regions that support Kubernetes clusters: -`doctl kubernetes options regions` +`doctl {{[k|kubernetes]}} {{[o|options]}} {{[r|regions]}}` - List machine sizes that can be used in a Kubernetes cluster: -`doctl kubernetes options sizes` +`doctl {{[k|kubernetes]}} {{[o|options]}} {{[s|sizes]}}` - List Kubernetes versions that can be used with DigitalOcean clusters: -`doctl kubernetes options versions` +`doctl {{[k|kubernetes]}} {{[o|options]}} {{[v|versions]}}` diff --git a/tldr/doctl-serverless b/tldr/doctl-serverless index 4b79a095..58163595 100644 --- a/tldr/doctl-serverless +++ b/tldr/doctl-serverless @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Connect local serverless support to a functions namespace: -`doctl serverless connect` +`doctl {{[sls|serverless]}} connect` - Deploy a functions project to your functions namespace: -`doctl serverless deploy` +`doctl {{[sls|serverless]}} deploy` - Obtain metadata of a functions project: -`doctl serverless get-metadata` +`doctl {{[sls|serverless]}} get-metadata` - Provide information about serverless support: -`doctl serverless status` +`doctl {{[sls|serverless]}} status` diff --git a/tldr/ffuf b/tldr/ffuf index a3c05aec..eb4bb0cc 100644 --- a/tldr/ffuf +++ b/tldr/ffuf @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Enumerate directories using [c]olored output and a [w]ordlist specifying a target [u]RL: -`ffuf -c -w {{path/to/wordlist.txt}} -u {{http://target/FUZZ}}` +`ffuf -c -w {{path/to/wordlist.txt}} -u {{http://example.com/FUZZ}}` - Enumerate webservers of subdomains by changing the position of the keyword: -`ffuf -w {{path/to/subdomains.txt}} -u {{http://FUZZ.target.com}}` +`ffuf -w {{path/to/subdomains.txt}} -u {{http://FUZZ.example.com}}` - Fuzz with specified [t]hreads (default: 40) and pro[x]ying the traffic and save [o]utput to a file: -`ffuf -o -w {{path/to/wordlist.txt}} -u {{http://target/FUZZ}} -t {{500}} -x {{http://127.0.0.1:8080}}` +`ffuf -o -w {{path/to/wordlist.txt}} -u {{http://example.com/FUZZ}} -t {{500}} -x {{http://127.0.0.1:8080}}` - Fuzz a specific [H]eader ("Name: Value") and [m]atch HTTP status [c]odes: -`ffuf -w {{path/to/wordlist.txt}} -u {{http://target.com}} -H "{{Host: FUZZ}}" -mc {{200}}` +`ffuf -w {{path/to/wordlist.txt}} -u {{http://example.com}} -H "{{Host: FUZZ}}" -mc {{200}}` - Fuzz with specified HTTP method and [d]ata, while [f]iltering out comma separated status [c]odes: -`ffuf -w {{path/to/postdata.txt}} -X {{POST}} -d "{{username=admin\&password=FUZZ}}" -u {{http://target/login.php}} -fc {{401,403}}` +`ffuf -w {{path/to/postdata.txt}} -X {{POST}} -d "{{username=admin\&password=FUZZ}}" -u {{http://example.com/login.php}} -fc {{401,403}}` - Fuzz multiple positions with multiple wordlists using different modes: -`ffuf -w {{path/to/keys:KEY}} -w {{path/to/values:VALUE}} -mode {{pitchfork|clusterbomb}} -u {{http://target.com/id?KEY=VALUE}}` +`ffuf -w {{path/to/keys:KEY}} -w {{path/to/values:VALUE}} -mode {{pitchfork|clusterbomb}} -u {{http://example.com/id?KEY=VALUE}}` - Proxy requests through a HTTP MITM pro[x]y (such as Burp Suite or `mitmproxy`): -`ffuf -w {{path/to/wordlist}} -x {{http://127.0.0.1:8080}} -u {{http://target.com/FUZZ}}` +`ffuf -w {{path/to/wordlist}} -x {{http://127.0.0.1:8080}} -u {{http://example.com/FUZZ}}` diff --git a/tldr/fossil-commit b/tldr/fossil-commit index 88b95f32..d867a384 100644 --- a/tldr/fossil-commit +++ b/tldr/fossil-commit @@ -12,13 +12,13 @@ source: https://github.com/tldr-pages/tldr.git `fossil commit` -- Create a new version containing all the changes in the current checkout, using the specified comment: +- Create a new version containing all the changes in the current checkout, using the specified [m]essage: -`fossil commit --comment "{{comment}}"` +`fossil commit {{[-m|--comment]}} "{{comment}}"` - Create a new version containing all the changes in the current checkout with a comment read from a specific file: -`fossil commit --message-file {{path/to/commit_message_file}}` +`fossil commit {{[-M|--message-file]}} {{path/to/commit_message_file}}` - Create a new version containing changes from the specified files; user will be prompted for a comment: diff --git a/tldr/glab b/tldr/glab index e77c9c38..7c4b5238 100644 --- a/tldr/glab +++ b/tldr/glab @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Work seamlessly with GitLab. > Some subcommands such as `config` have their own usage documentation. -> More information: . +> More information: . - Clone a GitLab repository locally: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - View an issue in the default browser: -`glab issue view --web {{issue_number}}` +`glab issue view {{[-w|--web]}} {{issue_number}}` - Create a merge request: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - View a pull request in the default web browser: -`glab mr view --web {{pr_number}}` +`glab mr view {{[-w|--web]}} {{pr_number}}` - Check out a specific pull request locally: diff --git a/tldr/glab-alias b/tldr/glab-alias index 44a88f3a..c1e505c8 100644 --- a/tldr/glab-alias +++ b/tldr/glab-alias @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab alias > Manage GitLab CLI command aliases. -> More information: . +> More information: . - Display the subcommand help: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a shell command as a `glab` subcommand: -`glab alias set --shell {{alias_name}} {{command}}` +`glab alias set {{[-s|--shell]}} {{alias_name}} {{command}}` - Delete a command shortcut: diff --git a/tldr/glab-auth b/tldr/glab-auth index bf833f53..c9977967 100644 --- a/tldr/glab-auth +++ b/tldr/glab-auth @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab auth > Authenticate with a GitLab host. -> More information: . +> More information: . - Log in with interactive prompt: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Log in with a token: -`glab auth login --token {{token}}` +`glab auth login {{[-t|--token]}} {{token}}` - Check authentication status: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Log in to a specific GitLab instance: -`glab auth login --hostname {{gitlab.example.com}}` +`glab auth login {{[-h|--hostname]}} {{gitlab.example.com}}` diff --git a/tldr/glab-issue b/tldr/glab-issue index 7f898442..80142b1a 100644 --- a/tldr/glab-issue +++ b/tldr/glab-issue @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab issue > Manage GitLab issues. -> More information: . +> More information: . - Display a specific issue: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display a specific issue in the default web browser: -`glab issue view {{issue_number}} --web` +`glab issue view {{issue_number}} {{[-w|--web]}}` - Create a new issue in the default web browser: @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - List the last 10 issues with the `bug` label: -`glab issue list --per-page {{10}} --label "{{bug}}"` +`glab issue list {{[-P|--per-page]}} {{10}} {{[-l|--label]}} "{{bug}}"` - List closed issues made by a specific user: -`glab issue list --closed --author {{username}}` +`glab issue list {{[-c|--closed]}} --author {{username}}` - Reopen a specific issue: diff --git a/tldr/glab-mr b/tldr/glab-mr index 758d43f0..15ff8427 100644 --- a/tldr/glab-mr +++ b/tldr/glab-mr @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage GitLab merge requests. > Some subcommands such as `create` have their own usage documentation. -> More information: . +> More information: . - Create a merge request: diff --git a/tldr/glab-mr-create b/tldr/glab-mr-create index 6caf567b..d4dcd92d 100644 --- a/tldr/glab-mr-create +++ b/tldr/glab-mr-create @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab mr create > Manage GitLab merge requests. -> More information: . +> More information: . - Interactively create a merge request: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a merge request, determining the title and description from the commit messages of the current branch: -`glab mr create --fill` +`glab mr create {{[-f|--fill]}}` - Create a draft merge request: @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Create a merge request specifying the target branch, title, and description: -`glab mr create --target-branch {{target_branch}} --title "{{title}}" --description "{{description}}"` +`glab mr create {{[-b|--target-branch]}} {{target_branch}} {{[-t|--title]}} "{{title}}" {{[-d|--description]}} "{{description}}"` - Start opening a merge request in the default web browser: -`glab mr create --web` +`glab mr create {{[-w|--web]}}` diff --git a/tldr/glab-mr-merge b/tldr/glab-mr-merge index dc5c58b2..5656845f 100644 --- a/tldr/glab-mr-merge +++ b/tldr/glab-mr-merge @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab mr merge > Merge GitLab merge requests. -> More information: . +> More information: . - Merge the merge request associated with the current branch interactively: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Merge the merge request, removing the branch on both the local and the remote: -`glab mr merge --remove-source-branch` +`glab mr merge {{[-d|--remove-source-branch]}}` - Squash the current merge request into one commit with the message body and merge: -`glab mr merge --squash --message="{{commit_message_body}}"` +`glab mr merge {{[-s|--squash]}} {{[-m|--message]}} "{{commit_message_body}}"` - Display help: diff --git a/tldr/glab-pipeline b/tldr/glab-pipeline index a0a9d1ec..0305a83e 100644 --- a/tldr/glab-pipeline +++ b/tldr/glab-pipeline @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab pipeline > List, view, and run GitLab CI/CD pipelines. -> More information: . +> More information: . - View a running pipeline on the current branch: diff --git a/tldr/glab-release b/tldr/glab-release index ed77c598..9d4e6ef7 100644 --- a/tldr/glab-release +++ b/tldr/glab-release @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab release > Manage GitLab releases. -> More information: . +> More information: . - List releases in a Gitlab repository, limited to 30 items: diff --git a/tldr/glab-repo b/tldr/glab-repo index 68f7b1aa..9fdf24ed 100644 --- a/tldr/glab-repo +++ b/tldr/glab-repo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # glab repo > Work with GitLab repositories. -> More information: . +> More information: . - Create a new repository (if the repository name is not set, the default name will be the name of the current directory): diff --git a/tldr/hub b/tldr/hub index 4a7b83fb..57b7d718 100644 --- a/tldr/hub +++ b/tldr/hub @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A wrapper for Git that adds commands for working with GitHub-based projects. > If set up as instructed by `hub alias`, one can use `git` to run `hub` commands. -> More information: . +> More information: . - Clone a repository using its slug (owners can omit the username): diff --git a/tldr/hub-ci-status b/tldr/hub-ci-status index 018c6ceb..e0d02346 100644 --- a/tldr/hub-ci-status +++ b/tldr/hub-ci-status @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Check the CI status for this branch: -`hub ci-status --verbose` +`hub ci-status {{[-v|--verbose]}}` - Display status of GitHub checks for a commit: -`hub ci-status --verbose {{commit_SHA}}` +`hub ci-status {{[-v|--verbose]}} {{commit_SHA}}` diff --git a/tldr/hub-create b/tldr/hub-create index 20d0f693..e8523d0a 100644 --- a/tldr/hub-create +++ b/tldr/hub-create @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Create a private repository and open the new repository in a web browser: -`hub create --private --browse` +`hub create {{[-p|--private]}} {{[-o|--browse]}}` diff --git a/tldr/hub-issue b/tldr/hub-issue index 63014748..b42ce37f 100644 --- a/tldr/hub-issue +++ b/tldr/hub-issue @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - List the last 10 issues with the `bug` label: -`hub issue list --limit {{10}} --labels "{{bug}}"` +`hub issue list {{[-L|--limit]}} {{10}} {{[-l|--labels]}} "{{bug}}"` - Display a specific issue: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - List 10 closed issues assigneed to a specific user: -`hub issue --state {{closed}} --assignee {{username}} --limit {{10}}` +`hub issue {{[-s|--state]}} {{closed}} {{[-a|--assignee]}} {{username}} --limit {{10}}` diff --git a/tldr/ippevepcl b/tldr/ippevepcl index 6da7d1ac..fae8cd00 100644 --- a/tldr/ippevepcl +++ b/tldr/ippevepcl @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a file from `stdin` to `stdout`: -`{{wget -O - https://examplewebsite.com/file}} | ippeveps` +`{{wget -O - https://example.com/file}} | ippeveps` diff --git a/tldr/ippeveps b/tldr/ippeveps index 08453907..f171377e 100644 --- a/tldr/ippeveps +++ b/tldr/ippeveps @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a file from `stdin` to `stdout`: -`{{wget {{[-O|--output-document]}} - https://examplewebsite.com/file}} | ippeveps` +`{{wget {{[-O|--output-document]}} - https://example.com/file}} | ippeveps` diff --git a/tldr/linux/apt-add-repository b/tldr/linux/apt-add-repository index 39e8d648..e98e1e22 100644 --- a/tldr/linux/apt-add-repository +++ b/tldr/linux/apt-add-repository @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove an `apt` repository: -`apt-add-repository --remove {{repository_spec}}` +`apt-add-repository {{[-r|--remove]}} {{repository_spec}}` - Update the package cache after adding a repository: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Enable source packages: -`apt-add-repository --enable-source {{repository_spec}}` +`apt-add-repository {{[-s|--enable-source]}} {{repository_spec}}` diff --git a/tldr/linux/apt-file b/tldr/linux/apt-file index b6e5fc75..515366a8 100644 --- a/tldr/linux/apt-file +++ b/tldr/linux/apt-file @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Search for packages that match the `regular_expression`: -`apt-file {{search|find}} --regexp {{regular_expression}}` +`apt-file {{search|find}} {{[-x|--regexp]}} {{regular_expression}}` diff --git a/tldr/linux/btrfs-check b/tldr/linux/btrfs-check index 5403e211..e5fc17e3 100644 --- a/tldr/linux/btrfs-check +++ b/tldr/linux/btrfs-check @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Show the progress of the check: -`sudo btrfs check --progress {{path/to/partition}}` +`sudo btrfs check {{[-p|--progress]}} {{path/to/partition}}` - Verify the checksum of each data block (if the filesystem is good): @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Use the `n`-th superblock (`n` can be 0, 1 or 2): -`sudo btrfs check --super {{n}} {{path/to/partition}}` +`sudo btrfs check {{[-s|--super]}} {{n}} {{path/to/partition}}` - Rebuild the checksum tree: diff --git a/tldr/linux/btrfs-device b/tldr/linux/btrfs-device index a97a55e2..80a43efe 100644 --- a/tldr/linux/btrfs-device +++ b/tldr/linux/btrfs-device @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Add one or more devices to a btrfs filesystem: -`sudo btrfs device add {{path/to/block_device1}} [{{path/to/block_device2}}] {{path/to/btrfs_filesystem}}` +`sudo btrfs device add {{path/to/block_device1 path/to/block_device2 ...}} {{path/to/btrfs_filesystem}}` - Remove a device from a btrfs filesystem: -`sudo btrfs device remove {{path/to/device|device_id}} [{{...}}]` +`sudo btrfs device remove {{path/to/device1|device_id1 path/to/device2|device_id2 ...}}` - Display error statistics: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan all disks and inform the kernel of all detected btrfs filesystems: -`sudo btrfs device scan --all-devices` +`sudo btrfs device scan {{[-d|--all-devices]}}` - Display detailed per-disk allocation statistics: diff --git a/tldr/linux/btrfs-inspect-internal b/tldr/linux/btrfs-inspect-internal index eea2bfe3..f2002842 100644 --- a/tldr/linux/btrfs-inspect-internal +++ b/tldr/linux/btrfs-inspect-internal @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Print superblock's and all of its copies' information: -`sudo btrfs inspect-internal dump-super --all {{path/to/partition}}` +`sudo btrfs inspect-internal dump-super {{[-a|--all]}} {{path/to/partition}}` - Print filesystem's metadata information: diff --git a/tldr/linux/exiqgrep b/tldr/linux/exiqgrep index f2ad95e1..040da191 100644 --- a/tldr/linux/exiqgrep +++ b/tldr/linux/exiqgrep @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Match the sender address using a case-insensitive search: -`exiqgrep -f '<{{email@somedomain.com}}>'` +`exiqgrep -f '<{{email@example.com}}>'` - Match the sender address and display message IDs only: -`exiqgrep -i -f '<{{email@somedomain.com}}>'` +`exiqgrep -i -f '<{{email@example.com}}>'` - Match the recipient address: -`exiqgrep -r '{{email@somedomain.com}}'` +`exiqgrep -r '{{email@example.com}}'` - Remove all messages matching the sender address from the queue: -`exiqgrep -i -f '<{{email@somedomain.com}}>' | xargs exim -Mrm` +`exiqgrep -i -f '<{{email@example.com}}>' | xargs exim -Mrm` - Test for bounced messages: diff --git a/tldr/linux/loadkeys b/tldr/linux/loadkeys index c02f9681..71bc6d26 100644 --- a/tldr/linux/loadkeys +++ b/tldr/linux/loadkeys @@ -6,36 +6,37 @@ source: https://github.com/tldr-pages/tldr.git # loadkeys > Load the kernel keymap for the console. +> See also: `localectl`. > More information: . +- Load a specific keyboard layout for the current console: + +`sudo loadkeys {{en|de|fi|dvorak|...}}` + - Load a default keymap: -`loadkeys --default` - -- Load default keymap when an unusual keymap is loaded and `-` sign cannot be found: - -`loadkeys defmap` +`sudo loadkeys {{[-d|--default]}}` - Create a kernel source table: -`loadkeys --mktable` +`loadkeys {{[-m|--mktable]}}` - Create a binary keymap: -`loadkeys --bkeymap` +`loadkeys {{[-b|--bkeymap]}}` - Search and parse keymap without action: -`loadkeys --parse` +`loadkeys {{[-p|--parse]}}` - Load the keymap suppressing all output: -`loadkeys --quiet` +`loadkeys {{[-q|--quiet]}}` + +- Set a keymap for a specific console: + +`sudo loadkeys {{[-C|--console]}} {{/dev/ttyN}} {{uk}}` - Load a keymap from the specified file for the console: -`loadkeys --console {{/dev/ttyN}} {{/path/to/file}}` - -- Use standard names for keymaps of different locales: - -`loadkeys --console {{/dev/ttyN}} {{uk}}` +`loadkeys {{[-C|--console]}} {{/dev/ttyN}} {{/path/to/file}}` diff --git a/tldr/linux/systemd-ac-power b/tldr/linux/systemd-ac-power index 64b95272..b8f37196 100644 --- a/tldr/linux/systemd-ac-power +++ b/tldr/linux/systemd-ac-power @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Additionally print `yes` or `no` to `stdout`: -`systemd-ac-power --verbose` +`systemd-ac-power {{[-v|--verbose]}}` diff --git a/tldr/linux/systemd-cgls b/tldr/linux/systemd-cgls index 53353372..93965b65 100644 --- a/tldr/linux/systemd-cgls +++ b/tldr/linux/systemd-cgls @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the control group hierarchy of one or more systemd units: -`systemd-cgls --unit {{unit1 unit2 ...}}` +`systemd-cgls {{[-u|--unit]}} {{unit1 unit2 ...}}` diff --git a/tldr/linux/systemd-cgtop b/tldr/linux/systemd-cgtop index c188ca60..da8ee7cd 100644 --- a/tldr/linux/systemd-cgtop +++ b/tldr/linux/systemd-cgtop @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Change the sort order: -`systemd-cgtop --order={{cpu|memory|path|tasks|io}}` +`systemd-cgtop {{[-i|--order]}} {{cpu|memory|path|tasks|io}}` - Show the CPU usage by time instead of percentage: -`systemd-cgtop --cpu=percentage` +`systemd-cgtop --cpu percentage` - Change the update interval in seconds (or one of these time units: `ms`, `us`, `min`): diff --git a/tldr/linux/systemd-creds b/tldr/linux/systemd-creds index 028d4f07..479b6df8 100644 --- a/tldr/linux/systemd-creds +++ b/tldr/linux/systemd-creds @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Encrypt a file and set a specific name: -`systemd-creds encrypt --name={{name}} {{path/to/input_file}} {{path/to/output}}` +`systemd-creds encrypt --name {{name}} {{path/to/input_file}} {{path/to/output}}` - Decrypt the file again: @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Encrypt text from `stdin`: -`echo -n {{text}} | systemd-creds encrypt --name={{name}} - {{path/to/output}}` +`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}}` +`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}}` +`systemd-creds encrypt --not-after "{{timestamp}}" {{path/to/input_file}} {{path/to/output_file}}` diff --git a/tldr/linux/systemd-delta b/tldr/linux/systemd-delta index 552ec472..ed632c6c 100644 --- a/tldr/linux/systemd-delta +++ b/tldr/linux/systemd-delta @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Show only files of specific types (comma-separated list): -`systemd-delta --type {{masked|equivalent|redirected|overridden|extended|unchanged}}` +`systemd-delta {{[-t|--type]}} {{masked|equivalent|redirected|overridden|extended|unchanged}}` - Show only files whose path starts with the specified prefix (Note: A prefix is a directory containing subdirectories with systemd configuration files): diff --git a/tldr/linux/systemd-detect-virt b/tldr/linux/systemd-detect-virt index 0ed0036e..e54f6123 100644 --- a/tldr/linux/systemd-detect-virt +++ b/tldr/linux/systemd-detect-virt @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Silently check without printing anything: -`systemd-detect-virt --quiet` +`systemd-detect-virt {{[-q|--quiet]}}` - Only detect container virtualization: -`systemd-detect-virt --container` +`systemd-detect-virt {{[-c|--container]}}` - Only detect hardware virtualization: -`systemd-detect-virt --vm` +`systemd-detect-virt {{[-v|--vm]}}` diff --git a/tldr/linux/systemd-dissect b/tldr/linux/systemd-dissect index fab506ef..3ef4d388 100644 --- a/tldr/linux/systemd-dissect +++ b/tldr/linux/systemd-dissect @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Mount an OS image: -`systemd-dissect --mount {{path/to/image.raw}} {{/mnt/image}}` +`systemd-dissect {{[-m|--mount]}} {{path/to/image.raw}} {{/mnt/image}}` - Unmount an OS image: -`systemd-dissect --umount {{/mnt/image}}` +`systemd-dissect {{[-u|--umount]}} {{/mnt/image}}` - List files in an image: -`systemd-dissect --list {{path/to/image.raw}}` +`systemd-dissect {{[-l|--list]}} {{path/to/image.raw}}` - Attach an OS image to an automatically allocated loopback block device and print its path: diff --git a/tldr/linux/systemd-escape b/tldr/linux/systemd-escape index 42dae5c3..e5d8b708 100644 --- a/tldr/linux/systemd-escape +++ b/tldr/linux/systemd-escape @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Reverse the escaping process: -`systemd-escape --unescape {{text}}` +`systemd-escape {{[-u|--unescape]}} {{text}}` - Treat the given text as a path: -`systemd-escape --path {{text}}` +`systemd-escape {{[-p|--path]}} {{text}}` - Append the given suffix to the escaped text: diff --git a/tldr/linux/systemd-firstboot b/tldr/linux/systemd-firstboot index c1caaec1..f80f6685 100644 --- a/tldr/linux/systemd-firstboot +++ b/tldr/linux/systemd-firstboot @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - Operate on the specified directory instead of the root directory of the host system: -`sudo systemd-firstboot --root={{path/to/root_directory}}` +`sudo systemd-firstboot --root {{path/to/root_directory}}` - Set the system keyboard layout: -`sudo systemd-firstboot --keymap={{keymap}}` +`sudo systemd-firstboot --keymap {{keymap}}` - Set the system hostname: -`sudo systemd-firstboot --hostname={{hostname}}` +`sudo systemd-firstboot --hostname {{hostname}}` - Set the root user's password: -`sudo systemd-firstboot --root-password={{password}}` +`sudo systemd-firstboot --root-password {{password}}` - Prompt the user interactively for a specific basic setting: -`sudo systemd-firstboot --prompt={{setting}}` +`sudo systemd-firstboot --prompt {{setting}}` - Force writing configuration even if the relevant files already exist: diff --git a/tldr/linux/systemd-hwdb b/tldr/linux/systemd-hwdb index 85ae269f..2d8ac3b9 100644 --- a/tldr/linux/systemd-hwdb +++ b/tldr/linux/systemd-hwdb @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Update the binary hardware database, returning a non-zero exit value on any parsing error: -`systemd-hwdb --strict update` +`systemd-hwdb {{[-s|--strict]}} update` - Update the binary hardware database in `/usr/lib/udev`: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Update the binary hardware database in the specified root path: -`systemd-hwdb --root={{path/to/root}} update` +`systemd-hwdb {{[-r|--root]}} {{path/to/root}} update` diff --git a/tldr/linux/systemd-id128 b/tldr/linux/systemd-id128 index 0da14011..c9684a50 100644 --- a/tldr/linux/systemd-id128 +++ b/tldr/linux/systemd-id128 @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate a new random identifier and print it as a UUID (five groups of digits separated by hyphens): -`systemd-id128 new --uuid` +`systemd-id128 new {{[-u|--uuid]}}` diff --git a/tldr/linux/systemd-machine-id-setup b/tldr/linux/systemd-machine-id-setup index 674d3e12..5ce4b961 100644 --- a/tldr/linux/systemd-machine-id-setup +++ b/tldr/linux/systemd-machine-id-setup @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Specify an image policy: -`systemd-machine-id-setup --image-policy={{your_policy}}` +`systemd-machine-id-setup --image-policy {{your_policy}}` - Display the output as JSON: -`sudo systemd-machine-id-setup --json=pretty` +`sudo systemd-machine-id-setup --json pretty` - Operate on a disk image instead of a directory tree: -`systemd-machine-id-setup --image={{/path/to/image}}` +`systemd-machine-id-setup --image {{/path/to/image}}` diff --git a/tldr/linux/systemd-mount b/tldr/linux/systemd-mount index a3d74f8e..0988dffb 100644 --- a/tldr/linux/systemd-mount +++ b/tldr/linux/systemd-mount @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Create an automount point that mounts the actual file system at the time of first access: -`systemd-mount --automount=yes {{path/to/file_or_device}}` +`systemd-mount --automount yes {{path/to/file_or_device}}` - Unmount one or more devices: -`systemd-mount --umount {{path/to/mount_point_or_device1}} {{path/to/mount_point_or_device2}}` +`systemd-mount {{[-u|--umount]}} {{path/to/mount_point_or_device1}} {{path/to/mount_point_or_device2}}` - Mount a file system (image or block device) with a specific file system type: -`systemd-mount --type={{file_system_type}} {{path/to/file_or_device}} {{path/to/mount_point}}` +`systemd-mount {{[-t|--type]}} {{file_system_type}} {{path/to/file_or_device}} {{path/to/mount_point}}` - Mount a file system (image or block device) with additional mount options: -`systemd-mount --options={{mount_options}} {{path/to/file_or_device}} {{path/to/mount_point}}` +`systemd-mount {{[-o|--options]}} {{mount_options}} {{path/to/file_or_device}} {{path/to/mount_point}}` diff --git a/tldr/linux/systemd-notify b/tldr/linux/systemd-notify index 8a5efb45..e8d1cc85 100644 --- a/tldr/linux/systemd-notify +++ b/tldr/linux/systemd-notify @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Provide a custom status message to systemd (this information is shown by `systemctl status`): -`systemd-notify --status="{{Add custom status message here...}}"` +`systemd-notify --status "{{Add custom status message here...}}"` diff --git a/tldr/linux/systemd-nspawn b/tldr/linux/systemd-nspawn index 662fd44d..6adb3399 100644 --- a/tldr/linux/systemd-nspawn +++ b/tldr/linux/systemd-nspawn @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Run a command in a container: -`systemd-nspawn --directory {{path/to/container_root}}` +`systemd-nspawn {{[-D|--directory]}} {{path/to/container_root}}` - Run a full Linux-based OS in a container: -`systemd-nspawn --boot --directory {{path/to/container_root}}` +`systemd-nspawn {{[-b|--boot]}} {{[-D|--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` +`systemd-nspawn {{[-D|--directory]}} {{path/to/container_root}} {{[-a|--as-pid2]}}` - Specify the machine name and hostname: -`systemd-nspawn --machine={{container_name}} --hostname={{container_host}} --directory {{path/to/container_root}}` +`systemd-nspawn {{[-M|--machine]}} {{container_name}} --hostname {{container_host}} {{[-D|--directory]}} {{path/to/container_root}}` diff --git a/tldr/linux/systemd-repart b/tldr/linux/systemd-repart index cbc9d6e4..272021a6 100644 --- a/tldr/linux/systemd-repart +++ b/tldr/linux/systemd-repart @@ -16,8 +16,8 @@ source: https://github.com/tldr-pages/tldr.git - View changes without applying: -`systemd-repart --dry-run=yes` +`systemd-repart --dry-run yes` - Grow root partition size to 10 gigabytes: -`systemd-repart --size=10G --root /` +`systemd-repart --size 10G --root /` diff --git a/tldr/linux/systemd-run b/tldr/linux/systemd-run index ba1aa3d7..c31874ba 100644 --- a/tldr/linux/systemd-run +++ b/tldr/linux/systemd-run @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Start a transient service with a custom unit name and description: -`sudo systemd-run --unit={{name}} --description={{string}} {{command}} {{argument1 argument2 ...}}` +`sudo systemd-run {{[-u|--unit]}} {{name}} --description {{string}} {{command}} {{argument1 argument2 ...}}` - Start a transient service that does not get cleaned up after it terminates with a custom environment variable: -`sudo systemd-run --remain-after-exit --set-env={{name}}={{value}} {{command}} {{argument1 argument2 ...}}` +`sudo systemd-run {{[-r|--remain-after-exit]}} --set-env={{name}}={{value}} {{command}} {{argument1 argument2 ...}}` - Start a transient timer that periodically runs its transient service (see `man systemd.time` for calendar event format): @@ -30,12 +30,12 @@ source: https://github.com/tldr-pages/tldr.git - Share the terminal with the program (allowing interactive input/output) and make sure the execution details remain after the program exits: -`systemd-run --remain-after-exit --pty {{command}}` +`systemd-run {{[-r|--remain-after-exit]}} --pty {{command}}` - Set properties (e.g. CPUQuota, MemoryMax) of the process and wait until it exits: -`systemd-run --property MemoryMax={{memory_in_bytes}} --property CPUQuota={{percentage_of_CPU_time}}% --wait {{command}}` +`systemd-run {{[-p|--property]}} MemoryMax={{memory_in_bytes}} {{[-p|--property]}} CPUQuota={{percentage_of_CPU_time}}% --wait {{command}}` - Use the program in a shell pipeline: -`{{command1}} | systemd-run --pipe {{command2}} | {{command3}}` +`{{command1}} | systemd-run {{[-P|--pipe]}} {{command2}} | {{command3}}` diff --git a/tldr/linux/systemd-socket-activate b/tldr/linux/systemd-socket-activate index aa16304b..6430e434 100644 --- a/tldr/linux/systemd-socket-activate +++ b/tldr/linux/systemd-socket-activate @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Activate a service with a specified port: -`systemd-socket-activate {{path/to/socket.service}} {{{[-l|--listen]}}} {{8080}}` +`systemd-socket-activate {{path/to/socket.service}} {{[-l|--listen]}} {{8080}}` diff --git a/tldr/linux/systemd-stdio-bridge b/tldr/linux/systemd-stdio-bridge index 06664def..acf44118 100644 --- a/tldr/linux/systemd-stdio-bridge +++ b/tldr/linux/systemd-stdio-bridge @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Forward `stdin`/`stdout` to the local system bus within a specific container: -`systemd-stdio-bridge --machine={{mycontainer}}` +`systemd-stdio-bridge {{[-M|--machine]}} {{mycontainer}}` - Forward `stdin`/`stdout` to a custom D-Bus address: -`systemd-stdio-bridge --bus-path=unix:path={{/custom/dbus/socket}}` +`systemd-stdio-bridge {{[-p|--bus-path]}} unix:path={{/custom/dbus/socket}}` diff --git a/tldr/linux/toolbox b/tldr/linux/toolbox index 086dd4ef..ff3486f9 100644 --- a/tldr/linux/toolbox +++ b/tldr/linux/toolbox @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`toolbox --help` +`toolbox {{[-h|--help]}}` - Display version: diff --git a/tldr/linux/toolbox-create b/tldr/linux/toolbox-create index bfa3f17c..8d4d77d8 100644 --- a/tldr/linux/toolbox-create +++ b/tldr/linux/toolbox-create @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a `toolbox` container for a specific distribution: -`toolbox create --distro {{distribution}}` +`toolbox create {{[-d|--distro]}} {{distribution}}` - Create a `toolbox` container for a specific release of the current distribution: -`toolbox create --release {{release}}` +`toolbox create {{[-r|--release]}} {{release}}` - Create a `toolbox` container with a custom image: -`toolbox create --image {{name}}` +`toolbox create {{[-i|--image]}} {{name}}` - Create a `toolbox` container from a custom Fedora image: -`toolbox create --image {{registry.fedoraproject.org/fedora-toolbox:39}}` +`toolbox create {{[-i|--image]}} {{registry.fedoraproject.org/fedora-toolbox:39}}` - Create a `toolbox` container using the default image for Fedora 39: -`toolbox create --distro {{fedora}} --release {{f39}}` +`toolbox create {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} {{f39}}` diff --git a/tldr/linux/toolbox-enter b/tldr/linux/toolbox-enter index 5a0e5085..92644376 100644 --- a/tldr/linux/toolbox-enter +++ b/tldr/linux/toolbox-enter @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Enter a `toolbox` container using the default image of a specific distribution: -`toolbox enter --distro {{distribution}}` +`toolbox enter {{[-d|--distro]}} {{distribution}}` - Enter a `toolbox` container using the default image of a specific release of the current distribution: -`toolbox enter --release {{release}}` +`toolbox enter {{[-r|--release]}} {{release}}` - Enter a toolbox container using the default image for Fedora 39: -`toolbox enter --distro {{fedora}} --release {{f39}}` +`toolbox enter {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} {{f39}}` diff --git a/tldr/linux/toolbox-list b/tldr/linux/toolbox-list index 5f026ffd..36b66e81 100644 --- a/tldr/linux/toolbox-list +++ b/tldr/linux/toolbox-list @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - List only `toolbox` containers: -`toolbox list --containers` +`toolbox list {{[-c|--containers]}}` - List only `toolbox` images: -`toolbox list --images` +`toolbox list {{[-i|--images]}}` diff --git a/tldr/linux/toolbox-rm b/tldr/linux/toolbox-rm index 14065a6b..e82676a6 100644 --- a/tldr/linux/toolbox-rm +++ b/tldr/linux/toolbox-rm @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Remove all `toolbox` containers: -`toolbox rm --all` +`toolbox rm {{[-a|--all]}}` - Force the removal of a currently active `toolbox` container: -`toolbox rm --force {{container_name}}` +`toolbox rm {{[-f|--force]}} {{container_name}}` diff --git a/tldr/linux/toolbox-rmi b/tldr/linux/toolbox-rmi index 4a181ffd..ac608cee 100644 --- a/tldr/linux/toolbox-rmi +++ b/tldr/linux/toolbox-rmi @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Remove all `toolbox` images: -`toolbox rmi --all` +`toolbox rmi {{[-a|--all]}}` - Force the removal of a `toolbox` image which is currently being used by a container (the container will be removed as well): -`toolbox rmi --force {{image_name}}` +`toolbox rmi {{[-f|--force]}} {{image_name}}` diff --git a/tldr/linux/toolbox-run b/tldr/linux/toolbox-run index f3e2ea48..f45ee175 100644 --- a/tldr/linux/toolbox-run +++ b/tldr/linux/toolbox-run @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a command inside a specific `toolbox` container: -`toolbox run --container {{container_name}} {{command}}` +`toolbox run {{[-c|--container]}} {{container_name}} {{command}}` - Run a command inside a `toolbox` container for a specific release of a distribution: -`toolbox run --distro {{distribution}} --release {{release}} {{command}}` +`toolbox run {{[-d|--distro]}} {{distribution}} {{[-r|--release]}} {{release}} {{command}}` - Run `emacs` inside a `toolbox` container using the default image for Fedora 39: -`toolbox run --distro {{fedora}} --release {{f39}} {{emacs}}` +`toolbox run {{[-d|--distro]}} {{fedora}} {{[-r|--release]}} {{f39}} {{emacs}}` diff --git a/tldr/mosquitto b/tldr/mosquitto index 24e93b1a..71343f05 100644 --- a/tldr/mosquitto +++ b/tldr/mosquitto @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mosquitto > An MQTT broker. -> More information: . +> More information: . - Start Mosquitto: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Specify a configuration file to use: -`mosquitto --config-file {{path/to/file.conf}}` +`mosquitto {{[-c|--config-file]}} {{path/to/file.conf}}` - Listen on a specific port: -`mosquitto --port {{8883}}` +`mosquitto {{[-p|--port]}} {{8883}}` - Daemonize by forking into the background: -`mosquitto --daemon` +`mosquitto {{[-d|--daemon]}}` diff --git a/tldr/ngrok b/tldr/ngrok index 38ab08e1..6da11e49 100644 --- a/tldr/ngrok +++ b/tldr/ngrok @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Expose TLS traffic for a specific host and port: -`ngrok tls -hostname={{foo.com}} {{443}}` +`ngrok tls -hostname={{example.com}} {{443}}` diff --git a/tldr/olevba b/tldr/olevba index 0003c8f5..5ba12640 100644 --- a/tldr/olevba +++ b/tldr/olevba @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Parse OLE and OpenXML files (e.g., DOC, XLS, PPT, etc.) to extract VBA macros, deobfuscate, and analyze malicious code. > Part of the `python-oletools` suite. -> For more information: . +> More information: . - Analyze a file, showing both macro code and analysis results: diff --git a/tldr/ptargrep b/tldr/ptargrep index a3fcdb86..d452174c 100644 --- a/tldr/ptargrep +++ b/tldr/ptargrep @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Extract to the current directory using the basename of the file from the archive: -`ptargrep --basename "{{search_pattern}}" {{path/to/file}}` +`ptargrep {{[-b|--basename]}} "{{search_pattern}}" {{path/to/file}}` - Search for a case-insensitive pattern matching within a tar archive: -`ptargrep --ignore-case "{{search_pattern}}" {{path/to/file}}` +`ptargrep {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/sqlmap b/tldr/sqlmap index 345adeff..aca86d91 100644 --- a/tldr/sqlmap +++ b/tldr/sqlmap @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Send data in a POST request (`--data` implies POST request): -`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{id=1}}"` - Change the parameter delimiter (& is the default): -`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` - Select a random `User-Agent` from `./txt/user-agents.txt` and use it: -`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --random-agent` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --random-agent` - Provide user credentials for HTTP protocol authentication: -`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` diff --git a/tldr/ssh b/tldr/ssh index 3ded1963..365200f4 100644 --- a/tldr/ssh +++ b/tldr/ssh @@ -17,9 +17,9 @@ source: https://github.com/tldr-pages/tldr.git `ssh -i {{path/to/key_file}} {{username}}@{{remote_host}}` -- Connect to a remote server using a specific [p]ort: +- Connect to a remote server with IP `10.0.0.1` and using a specific [p]ort (Note: `10.0.0.1` can be shortened to `10.1`): -`ssh {{username}}@{{remote_host}} -p {{2222}}` +`ssh {{username}}@10.0.0.1 -p {{2222}}` - Run a command on a remote server with a [t]ty allocation allowing interaction with the remote command: diff --git a/tldr/ugrep b/tldr/ugrep index 8af70438..bf88aae7 100644 --- a/tldr/ugrep +++ b/tldr/ugrep @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Start a query TUI to search files in the current directory recursively (`` for help): -`ugrep --query` +`ugrep {{[-Q|--query]}}` - Search the current directory recursively for files containing a regex search pattern: @@ -18,24 +18,24 @@ source: https://github.com/tldr-pages/tldr.git - Search in a specific file or in all files in a specific directory, showing line numbers of matches: -`ugrep --line-number "{{search_pattern}}" {{path/to/file_or_directory}}` +`ugrep {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file_or_directory}}` - Search in all files in the current directory recursively and print the name of each matching file: -`ugrep --files-with-matches "{{search_pattern}}"` +`ugrep {{[-l|--files-with-matches]}} "{{search_pattern}}"` - Fuzzy search files with up to 3 extra, missing or mismatching characters in the pattern: -`ugrep --fuzzy={{3}} "{{search_pattern}}"` +`ugrep {{[-Z|--fuzzy=]}}{{3}} "{{search_pattern}}"` - Also search compressed files, Zip and tar archives recursively: -`ugrep --decompress "{{search_pattern}}"` +`ugrep {{[-z|--decompress]}} "{{search_pattern}}"` - Search only files whose filenames match a specific glob pattern: -`ugrep --glob="{{glob_pattern}}" "{{search_pattern}}"` +`ugrep {{[-g |--glob=]}}"{{glob_pattern}}" "{{search_pattern}}"` - Search only C++ source files (use `--file-type=list` to list all file types): -`ugrep --file-type=cpp "{{search_pattern}}"` +`ugrep {{[-t |--file-type=]}}cpp "{{search_pattern}}"` diff --git a/tldr/vgrep b/tldr/vgrep index 19f198b7..18502162 100644 --- a/tldr/vgrep +++ b/tldr/vgrep @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A user friendly pager for grep. > See also: `ugrep`, `rg`. -> More information: . +> More information: . - Recursively search the current directory for a pattern and cache it: @@ -19,20 +19,20 @@ source: https://github.com/tldr-pages/tldr.git - Open the "4th" match from the cache in the default editor: -`vgrep --show {{4}}` +`vgrep {{[-s|--show]}} {{4}}` - Display a context of "3" lines for each match in the cache: -`vgrep --show=context{{3}}` +`vgrep {{[-s|--show]}} {{[c|context]}}{{3}}` - Display the number of matches for each directory in the tree: -`vgrep --show=tree` +`vgrep {{[-s|--show]}} {{[t|tree]}}` - Display the number of matches for each file in the tree: -`vgrep --show=files` +`vgrep {{[-s|--show]}} {{[f|files]}}` - Start an interactive shell with cached matches: -`vgrep --interactive` +`vgrep {{[-i|--interactive]}}` diff --git a/tldr/xml b/tldr/xml index 8a9031e2..9f007020 100644 --- a/tldr/xml +++ b/tldr/xml @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > XMLStarlet Toolkit: query, edit, check, convert and transform XML documents. > Some subcommands such as `xml validate` have their own usage documentation. -> More information: . +> More information: . - Display general help, including the list of subcommands: diff --git a/tldr/xml-c14n b/tldr/xml-c14n new file mode 100644 index 00000000..12fdbdea --- /dev/null +++ b/tldr/xml-c14n @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml c14n + +> This command is an alias of `xml canonic`. + +- View documentation for the original command: + +`tldr xml canonic` diff --git a/tldr/xml-canonic b/tldr/xml-canonic index 4f712322..f78ee2a5 100644 --- a/tldr/xml-canonic +++ b/tldr/xml-canonic @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # xml canonic > Make XML documents canonical. -> More information: . +> More information: . - Make an XML document canonical, preserving comments: -`xml canonic {{path/to/input.xml|URI}} > {{path/to/output.xml}}` +`xml {{[c14n|canonic]}} {{path/to/input.xml|URI}} > {{path/to/output.xml}}` - Make an XML document canonical, removing comments: -`xml canonic --without-comments {{path/to/input.xml|URI}} > {{path/to/output.xml}}` +`xml {{[c14n|canonic]}} --without-comments {{path/to/input.xml|URI}} > {{path/to/output.xml}}` - Make XML exclusively canonical, using an XPATH from a file, preserving comments: -`xml canonic --exc-with-comments {{path/to/input.xml|URI}} {{path/to/c14n.xpath}}` +`xml {{[c14n|canonic]}} --exc-with-comments {{path/to/input.xml|URI}} {{path/to/c14n.xpath}}` - Display help: -`xml canonic --help` +`xml {{[c14n|canonic]}} --help` diff --git a/tldr/xml-depyx b/tldr/xml-depyx index 984b6808..1908145a 100644 --- a/tldr/xml-depyx +++ b/tldr/xml-depyx @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # xml depyx > Convert a PYX (ESIS - ISO 8879) document to XML format. -> More information: . +> More information: . - Convert a PYX (ESIS - ISO 8879) document to XML format: -`xml depyx {{path/to/input.pyx|URI}} > {{path/to/output.xml}}` +`xml {{[p2x|depyx]}} {{path/to/input.pyx|URI}} > {{path/to/output.xml}}` - Convert a PYX document from `stdin` to XML format: -`cat {{path/to/input.pyx}} | xml depyx > {{path/to/output.xml}}` +`cat {{path/to/input.pyx}} | xml {{[p2x|depyx]}} > {{path/to/output.xml}}` - Display help: -`xml depyx --help` +`xml {{[p2x|depyx]}} --help` diff --git a/tldr/xml-edit b/tldr/xml-edit index f36859d8..adff173e 100644 --- a/tldr/xml-edit +++ b/tldr/xml-edit @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # xml edit > Edit an XML document. -> More information: . +> More information: . - Delete elements matching an XPATH from an XML document: -`xml edit --delete "{{XPATH1}}" {{path/to/input.xml|URI}}` +`xml {{[ed|edit]}} {{[-d|--delete]}} "{{XPATH1}}" {{path/to/input.xml|URI}}` - Move an element node of an XML document from XPATH1 to XPATH2: -`xml edit --move "{{XPATH1}}" "{{XPATH2}}" {{path/to/input.xml|URI}}` +`xml {{[ed|edit]}} {{[-m|--move]}} "{{XPATH1}}" "{{XPATH2}}" {{path/to/input.xml|URI}}` - Rename all attributes named "id" to "ID": -`xml edit --rename "{{//*/@id}}" -v "{{ID}}" {{path/to/input.xml|URI}}` +`xml {{[ed|edit]}} {{[-r|--rename]}} "{{//*/@id}}" -v "{{ID}}" {{path/to/input.xml|URI}}` - Rename sub-elements of the element "table" that are named "rec" to "record": -`xml edit --rename "{{/xml/table/rec}}" -v "{{record}}" {{path/to/input.xml|URI}}` +`xml {{[ed|edit]}} {{[-r|--rename]}} "{{/xml/table/rec}}" -v "{{record}}" {{path/to/input.xml|URI}}` - Update the XML table record with "id=3" to the value "id=5": -`xml edit --update "{{xml/table/rec[@id=3]/@id}}" -v {{5}} {{path/to/input.xml|URI}}` +`xml {{[ed|edit]}} {{[-u|--update]}} "{{xml/table/rec[@id=3]/@id}}" {{[-v|--value]}} {{5}} {{path/to/input.xml|URI}}` - Display help: -`xml edit --help` +`xml {{[ed|edit]}} {{[-h|--help]}}` diff --git a/tldr/xml-elements b/tldr/xml-elements index c23a6b01..b1065ef0 100644 --- a/tldr/xml-elements +++ b/tldr/xml-elements @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # xml elements > Extract elements and display the structure of an XML document. -> More information: . +> More information: . - Extract elements from an XML document (producing XPATH expressions): -`xml elements {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` +`xml {{[el|elements]}} {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` - Extract elements and their attributes from an XML document: -`xml elements -a {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` +`xml {{[el|elements]}} -a {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` - Extract elements and their attributes and values from an XML document: -`xml elements -v {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` +`xml {{[el|elements]}} -v {{path/to/input.xml|URI}} > {{path/to/elements.xpath}}` - Print sorted unique elements from an XML document to see its structure: -`xml elements -u {{path/to/input.xml|URI}}` +`xml {{[el|elements]}} -u {{path/to/input.xml|URI}}` - Print sorted unique elements from an XML document up to a depth of 3: -`xml elements -d{{3}} {{path/to/input.xml|URI}}` +`xml {{[el|elements]}} -d{{3}} {{path/to/input.xml|URI}}` - Display help: -`xml elements --help` +`xml {{[el|elements]}} --help` diff --git a/tldr/xml-escape b/tldr/xml-escape index f85a074b..9a55f13a 100644 --- a/tldr/xml-escape +++ b/tldr/xml-escape @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # xml escape > Escape special XML characters, e.g. `` → `<a1>`. -> More information: . +> More information: . - Escape special XML characters in a string: -`xml escape "{{}}"` +`xml {{[esc|escape]}} "{{}}"` - Escape special XML characters from `stdin`: -`echo "{{}}" | xml escape` +`echo "{{}}" | xml {{[esc|escape]}}` - Display help: -`xml escape --help` +`xml {{[esc|escape]}} --help` diff --git a/tldr/xml-format b/tldr/xml-format index 291a21be..43e6f380 100644 --- a/tldr/xml-format +++ b/tldr/xml-format @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # xml format > Format an XML document. -> More information: . +> More information: . - Format an XML document, indenting with tabs: -`xml format --indent-tab {{path/to/input.xml|URI}} > {{path/to/output.xml}}` +`xml {{[fo|format]}} {{[-t|--indent-tab]}} {{path/to/input.xml|URI}} > {{path/to/output.xml}}` - Format an HTML document, indenting with 4 spaces: -`xml format --html --indent-spaces {{4}} {{path/to/input.html|URI}} > {{path/to/output.html}}` +`xml {{[fo|format]}} {{[-H|--html]}} {{[-s|--indent-spaces]}} {{4}} {{path/to/input.html|URI}} > {{path/to/output.html}}` - Recover parsable parts of a malformed XML document, without indenting: -`xml format --recover --noindent {{path/to/malformed.xml|URI}} > {{path/to/recovered.xml}}` +`xml {{[fo|format]}} {{[-R|--recover]}} {{[-n|--noindent]}} {{path/to/malformed.xml|URI}} > {{path/to/recovered.xml}}` - Format an XML document from `stdin`, removing the `DOCTYPE` declaration: -`cat {{path o\input.xml}} | xml format --dropdtd > {{path/to/output.xml}}` +`cat {{path o\input.xml}} | xml {{[fo|format]}} {{[-D|--dropdtd]}} > {{path/to/output.xml}}` - Format an XML document, omitting the XML declaration: -`xml format --omit-decl {{path o\input.xml|URI}} > {{path/to/output.xml}}` +`xml {{[fo|format]}} {{[-o|--omit-decl]}} {{path o\input.xml|URI}} > {{path/to/output.xml}}` - Display help: -`xml format --help` +`xml {{[fo|format]}} --help` diff --git a/tldr/xml-list b/tldr/xml-list index a50371a0..785f3639 100644 --- a/tldr/xml-list +++ b/tldr/xml-list @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # xml list > List a directory's contents (like `ls`) in XML format. -> More information: . +> More information: . - Write the current directory's listing to an XML document: -`xml list > {{path/to/dir_list.xml}}` +`xml {{[ls|list]}} > {{path/to/dir_list.xml}}` - Write the specified directory's listing to an XML document: -`xml list {{path/to/directory}} > {{path/to/dir_list.xml}}` +`xml {{[ls|list]}} {{path/to/directory}} > {{path/to/dir_list.xml}}` - Display help: -`xml list --help` +`xml {{[ls|list]}} --help` diff --git a/tldr/xml-p2x b/tldr/xml-p2x new file mode 100644 index 00000000..69028a3e --- /dev/null +++ b/tldr/xml-p2x @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml p2x + +> This command is an alias of `xml depyx`. + +- View documentation for the original command: + +`tldr xml depyx` diff --git a/tldr/xml-pyx b/tldr/xml-pyx index a0f886b7..ea695d53 100644 --- a/tldr/xml-pyx +++ b/tldr/xml-pyx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xml pyx > Convert an XML document to PYX (ESIS - ISO 8879) format. -> More information: . +> More information: . - Convert an XML document to PYX format: diff --git a/tldr/xml-select b/tldr/xml-select index af91018c..09cfa3f5 100644 --- a/tldr/xml-select +++ b/tldr/xml-select @@ -7,24 +7,24 @@ source: https://github.com/tldr-pages/tldr.git > Select from XML documents using XPATHs. > Tip: use `xml elements` to display the XPATHs of an XML document. -> More information: . +> More information: . - Select all elements matching "XPATH1" and print the value of their sub-element "XPATH2": -`xml select --template --match "{{XPATH1}}" --value-of "{{XPATH2}}" {{path/to/input.xml|URI}}` +`xml {{[sel|select]}} {{[-t|--template]}} {{[-m|--match]}} "{{XPATH1}}" {{[-v|--value-of]}} "{{XPATH2}}" {{path/to/input.xml|URI}}` - Match "XPATH1" and print the value of "XPATH2" as text with new-lines: -`xml select --text --template --match "{{XPATH1}}" --value-of "{{XPATH2}}" --nl {{path/to/input.xml|URI}}` +`xml {{[sel|select]}} {{[-T|--text]}} {{[-t|--template]}} {{[-m|--match]}} "{{XPATH1}}" {{[-v|--value-of]}} "{{XPATH2}}" {{[-n|--nl]}} {{path/to/input.xml|URI}}` - Count the elements of "XPATH1": -`xml select --template --value-of "count({{XPATH1}})" {{path/to/input.xml|URI}}` +`xml {{[sel|select]}} {{[-t|--template]}} {{[-v|--value-of]}} "count({{XPATH1}})" {{path/to/input.xml|URI}}` - Count all nodes in one or more XML documents: -`xml select --text --template --inp-name --output " " --value-of "count(node())" --nl {{path/to/input1.xml|URI}} {{path/to/input2.xml|URI}}` +`xml {{[sel|select]}} {{[-T|--text]}} {{[-t|--template]}} {{[-f|--inp-name]}} {{[-o|--output]}} " " {{[-v|--value-of]}} "count(node())" {{[-n|--nl]}} {{path/to/input1.xml|URI}} {{path/to/input2.xml|URI}}` - Display help: -`xml select --help` +`xml {{[sel|select]}} --help` diff --git a/tldr/xml-transform b/tldr/xml-transform index bed1d535..a68774cf 100644 --- a/tldr/xml-transform +++ b/tldr/xml-transform @@ -6,12 +6,12 @@ source: https://github.com/tldr-pages/tldr.git # xml transform > Transform XML documents using XSLT. -> More information: . +> More information: . - Transform an XML document using an XSL stylesheet, passing one XPATH parameter and one literal string parameter: -`xml transform {{path/to/stylesheet.xsl}} -p "{{Count='count(/xml/table/rec)'}}" -s {{Text="Count="}} {{path/to/input.xml|URI}}` +`xml {{[tr|transform]}} {{path/to/stylesheet.xsl}} -p "{{Count='count(/xml/table/rec)'}}" -s {{Text="Count="}} {{path/to/input.xml|URI}}` - Display help: -`xml transform --help` +`xml {{[tr|transform]}} --help` diff --git a/tldr/xml-unescape b/tldr/xml-unescape index d20ef375..39617787 100644 --- a/tldr/xml-unescape +++ b/tldr/xml-unescape @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # xml unescape > Unescape special XML characters, e.g. `<a1>` → ``. -> More information: . +> More information: . - Unescape special XML characters from a string: -`xml unescape "{{<a1>}}"` +`xml {{[unesc|unescape]}} "{{<a1>}}"` - Unescape special XML characters from `stdin`: -`echo "{{<a1>}}" | xml unescape` +`echo "{{<a1>}}" | xml {{[unesc|unescape]}}` - Display help: -`xml escape --help` +`xml {{[esc|escape]}} --help` diff --git a/tldr/xml-validate b/tldr/xml-validate index 981181a7..599576be 100644 --- a/tldr/xml-validate +++ b/tldr/xml-validate @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # xml validate > Validate XML documents. -> More information: . +> More information: . - Validate one or more XML documents for well-formedness only: -`xml validate {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` +`xml {{[val|validate]}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against a Document Type Definition (DTD): -`xml validate --dtd {{path/to/schema.dtd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` +`xml {{[val|validate]}} {{[-d|--dtd]}} {{path/to/schema.dtd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against an XML Schema Definition (XSD): -`xml validate --xsd {{path/to/schema.xsd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` +`xml {{[val|validate]}} {{[-s|--xsd]}} {{path/to/schema.xsd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against a Relax NG schema (RNG): -`xml validate --relaxng {{path/to/schema.rng}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` +`xml {{[val|validate]}} {{[-r|--relaxng]}} {{path/to/schema.rng}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Display help: -`xml validate --help` +`xml {{[val|validate]}} --help` diff --git a/tldr/xml-xmln b/tldr/xml-xmln new file mode 100644 index 00000000..ab7235c2 --- /dev/null +++ b/tldr/xml-xmln @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# xml xmln + +> This command is an alias of `xml pyx`. + +- View documentation for the original command: + +`tldr xml pyx` diff --git a/tldr/xzgrep b/tldr/xzgrep index b9fce4b0..5f7592af 100644 --- a/tldr/xzgrep +++ b/tldr/xzgrep @@ -15,24 +15,24 @@ source: https://github.com/tldr-pages/tldr.git - Search for an exact string (disables regular expressions): -`xzgrep --fixed-strings "{{exact_string}}" {{path/to/file}}` +`xzgrep {{[-F|--fixed-strings]}} "{{exact_string}}" {{path/to/file}}` - Search for a pattern in all files showing line numbers of matches: -`xzgrep --line-number "{{search_pattern}}" {{path/to/file}}` +`xzgrep {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Use extended regular expressions (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: -`xzgrep --extended-regexp --ignore-case "{{search_pattern}}" {{path/to/file}}` +`xzgrep {{[-E|--extended-regexp]}} {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` -- Print 3 lines of context around, before, or after each match: +- Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: -`xzgrep --{{context|before-context|after-context}}={{3}} "{{search_pattern}}" {{path/to/file}}` +`xzgrep --{{context|before-context|after-context}} {{3}} "{{search_pattern}}" {{path/to/file}}` - Print file name and line number for each match with color output: -`xzgrep --with-filename --line-number --color=always "{{search_pattern}}" {{path/to/file}}` +`xzgrep {{[-H|--with-filename]}} {{[-n|--line-number]}} --color=always "{{search_pattern}}" {{path/to/file}}` - Search for lines matching a pattern, printing only the matched text: -`xzgrep --only-matching "{{search_pattern}}" {{path/to/file}}` +`xzgrep {{[-o|--only-matching]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/zegrep b/tldr/zegrep index 6bdbb35a..edec2693 100644 --- a/tldr/zegrep +++ b/tldr/zegrep @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Search for extended regular expressions (supporting `?`, `+`, `{}`, `()` and `|`) in a compressed file (case-insensitive): -`zegrep --ignore-case "{{search_pattern}}" {{path/to/file}}` +`zegrep {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` - Search for lines that do not match a pattern: -`zegrep --invert-match "{{search_pattern}}" {{path/to/file}}` +`zegrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file}}` - Print file name and line number for each match: -`zegrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` +`zegrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Search for lines matching a pattern, printing only the matched text: -`zegrep --only-matching "{{search_pattern}}" {{path/to/file}}` +`zegrep {{[-o|--only-matching]}} "{{search_pattern}}" {{path/to/file}}` - Recursively search files in a compressed file for a pattern: -`zegrep --recursive "{{search_pattern}}" {{path/to/file}}` +`zegrep {{[-r|--recursive]}} "{{search_pattern}}" {{path/to/file}}`