diff --git a/pages/common/dvc-commit.md b/pages/common/dvc-commit.md index c96d55b305..8fbe9e6aa1 100644 --- a/pages/common/dvc-commit.md +++ b/pages/common/dvc-commit.md @@ -13,4 +13,4 @@ - Recursively commit all DVC-tracked files in a directory: -`dvc commit --recursive {{path/to/directory}}` +`dvc commit {{[-R|--recursive]}} {{path/to/directory}}` diff --git a/pages/common/dvc-config.md b/pages/common/dvc-config.md index 324db251a2..03937650c4 100644 --- a/pages/common/dvc-config.md +++ b/pages/common/dvc-config.md @@ -14,7 +14,7 @@ - Unset the project's default remote: -`dvc config --unset core.remote` +`dvc config {{[-u|--unset]}} core.remote` - Get the configuration value for a specified key for the current project: @@ -26,7 +26,7 @@ - Unset a project level configuration value for a given key: -`dvc config --unset {{key}}` +`dvc config {{[-u|--unset]}} {{key}}` - Set a local, global, or system level configuration value: diff --git a/pages/common/dvc-destroy.md b/pages/common/dvc-destroy.md index f098c01f75..1615dc776b 100644 --- a/pages/common/dvc-destroy.md +++ b/pages/common/dvc-destroy.md @@ -9,4 +9,4 @@ - Force destroy the current project: -`dvc destroy --force` +`dvc destroy {{[-f|--force]}}` diff --git a/pages/common/dvc-fetch.md b/pages/common/dvc-fetch.md index bdf74ac604..524c544bb2 100644 --- a/pages/common/dvc-fetch.md +++ b/pages/common/dvc-fetch.md @@ -9,7 +9,7 @@ - Fetch changes from a specific remote upstream repository: -`dvc fetch --remote {{remote_name}}` +`dvc fetch {{[-r|--remote]}} {{remote_name}}` - Fetch the latest changes for a specific target/s: @@ -17,8 +17,8 @@ - Fetch changes for all branch and tags: -`dvc fetch --all-branches --all-tags` +`dvc fetch {{[-a|--all-branches]}} {{[-T|--all-tags]}}` - Fetch changes for all commits: -`dvc fetch --all-commits` +`dvc fetch {{[-A|--all-commits]}}` diff --git a/pages/common/dvc-gc.md b/pages/common/dvc-gc.md index e520842ce9..f388642971 100644 --- a/pages/common/dvc-gc.md +++ b/pages/common/dvc-gc.md @@ -5,16 +5,16 @@ - Garbage collect from the cache, keeping only versions referenced by the current workspace: -`dvc gc --workspace` +`dvc gc {{[-w|--workspace]}}` - Garbage collect from the cache, keeping only versions referenced by branch, tags, and commits: -`dvc gc --all-branches --all-tags --all-commits` +`dvc gc {{[-a|--all-branches]}} {{[-T|--all-tags]}} {{[-a|--all-commits]}}` - Garbage collect from the cache, including the default cloud remote storage (if set): -`dvc gc --all-commits --cloud` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}}` - Garbage collect from the cache, including a specific cloud remote storage: -`dvc gc --all-commits --cloud --remote {{remote_name}}` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}} {{[-r|--remote]}} {{remote_name}}` diff --git a/pages/common/dvc.md b/pages/common/dvc.md index c93b035b2a..f0145df5de 100644 --- a/pages/common/dvc.md +++ b/pages/common/dvc.md @@ -2,7 +2,7 @@ > Data Version Control: like `git` for data. > Some subcommands such as `commit` have their own usage documentation. -> More information: . +> More information: . - Execute a DVC subcommand: @@ -10,11 +10,11 @@ - Display general help: -`dvc --help` +`dvc {{[-h|--help]}}` - Display help about a specific subcommand: -`dvc {{subcommand}} --help` +`dvc {{subcommand}} {{[-h|--help]}}` - Display version: diff --git a/pages/common/env.md b/pages/common/env.md index c5faecf31c..0d04a47e5a 100644 --- a/pages/common/env.md +++ b/pages/common/env.md @@ -25,4 +25,4 @@ - Set one or more variables and run a program: -`env {{variable1}}={{value}} {{variable2}}={{value}} {{variable3}}={{value}} {{program}}` +`env {{variable1=value variable2=value variable3=value ...}} {{program}}` diff --git a/pages/common/git-fetch.md b/pages/common/git-fetch.md index 1ec53eb0a1..4d28031b75 100644 --- a/pages/common/git-fetch.md +++ b/pages/common/git-fetch.md @@ -17,8 +17,8 @@ - Also fetch tags from the remote upstream repository: -`git fetch --tags` +`git fetch {{[-t|--tags]}}` - Delete local references to remote branches that have been deleted upstream: -`git fetch --prune` +`git fetch {{[-p|--prune]}}` diff --git a/pages/common/git-sizer.md b/pages/common/git-sizer.md index eb3c704679..6ca8a90cef 100644 --- a/pages/common/git-sizer.md +++ b/pages/common/git-sizer.md @@ -1,16 +1,16 @@ -# git sizer +# git-sizer > Computes various Git repository size metrics and alerts you to any that might cause problems or inconvenience. > More information: . - Report only statistics that have a level of concern greater than 0: -`git sizer` +`git-sizer` - Report all statistics: -`git sizer -v` +`git-sizer -v` - See additional options: -`git sizer -h` +`git-sizer -h` diff --git a/pages/common/gocryptfs.md b/pages/common/gocryptfs.md index 6d3a81c1a1..81c0b01f32 100644 --- a/pages/common/gocryptfs.md +++ b/pages/common/gocryptfs.md @@ -1,7 +1,7 @@ # gocryptfs > Encrypted overlay filesystem written in Go. -> More information: . +> More information: . - Initialize an encrypted filesystem: diff --git a/pages/common/gunicorn.md b/pages/common/gunicorn.md index 443f9d9171..2e1566fd5e 100644 --- a/pages/common/gunicorn.md +++ b/pages/common/gunicorn.md @@ -1,7 +1,7 @@ # gunicorn > Python WSGI HTTP Server. -> More information: . +> More information: . - Run Python web app: @@ -9,7 +9,7 @@ - Listen on port 8080 on localhost: -`gunicorn --bind {{localhost}}:{{8080}} {{import.path:app_object}}` +`gunicorn {{[-b|--bind]}} {{localhost}}:{{8080}} {{import.path:app_object}}` - Turn on live reload: @@ -17,7 +17,7 @@ - Use 4 worker processes for handling requests: -`gunicorn --workers {{4}} {{import.path:app_object}}` +`gunicorn {{[-w|--workers]}} {{4}} {{import.path:app_object}}` - Use 4 worker threads for handling requests: diff --git a/pages/common/hg-add.md b/pages/common/hg-add.md index 9de6377b34..86c8d4b62b 100644 --- a/pages/common/hg-add.md +++ b/pages/common/hg-add.md @@ -9,16 +9,16 @@ - Add all unstaged files matching a specified pattern: -`hg add --include {{pattern}}` +`hg add {{[-I|--include]}} {{pattern}}` - Add all unstaged files, excluding those that match a specified pattern: -`hg add --exclude {{pattern}}` +`hg add {{[-X|--exclude]}} {{pattern}}` - Recursively add sub-repositories: -`hg add --subrepos` +`hg add {{[-S|--subrepos]}}` - Perform a test-run without performing any actions: -`hg add --dry-run` +`hg add {{[-n|--dry-run]}}` diff --git a/pages/common/hg-commit.md b/pages/common/hg-commit.md index 9b727e8d35..067ca2382a 100644 --- a/pages/common/hg-commit.md +++ b/pages/common/hg-commit.md @@ -13,16 +13,16 @@ - Commit with a specific message: -`hg commit --message {{message}}` +`hg commit {{[-m|--message]}} {{message}}` - Commit all files matching a specified pattern: -`hg commit --include {{pattern}}` +`hg commit {{[-I|--include]}} {{pattern}}` - Commit all files, excluding those that match a specified pattern: -`hg commit --exclude {{pattern}}` +`hg commit {{[-X|--exclude]}} {{pattern}}` - Commit using the interactive mode: -`hg commit --interactive` +`hg commit {{[-i|--interactive]}}` diff --git a/pages/common/hg-log.md b/pages/common/hg-log.md index 9e3875ecb2..2eef4e4790 100644 --- a/pages/common/hg-log.md +++ b/pages/common/hg-log.md @@ -9,28 +9,28 @@ - Display the revision history with an ASCII graph: -`hg log --graph` +`hg log {{[-G|--graph]}}` - Display the revision history with file names matching a specified pattern: -`hg log --include {{pattern}}` +`hg log {{[-I|--include]}} {{pattern}}` - Display the revision history, excluding file names that match a specified pattern: -`hg log --exclude {{pattern}}` +`hg log {{[-X|--exclude]}} {{pattern}}` - Display the log information for a specific revision: -`hg log --rev {{revision}}` +`hg log {{[-r|--rev]}} {{revision}}` - Display the revision history for a specific branch: -`hg log --branch {{branch}}` +`hg log {{[-b|--branch]}} {{branch}}` - Display the revision history for a specific date: -`hg log --date {{date}}` +`hg log {{[-d|--date]}} {{date}}` - Display revisions committed by a specific user: -`hg log --user {{user}}` +`hg log {{[-u|--user]}} {{user}}` diff --git a/pages/common/hg-pull.md b/pages/common/hg-pull.md index 762c482694..1b87b189aa 100644 --- a/pages/common/hg-pull.md +++ b/pages/common/hg-pull.md @@ -13,20 +13,20 @@ - Update the local repository to the head of the remote: -`hg pull --update` +`hg pull {{[-u|--update]}}` - Pull changes even when the remote repository is unrelated: -`hg pull --force` +`hg pull {{[-f|--force]}}` - Specify a specific revision changeset to pull up to: -`hg pull --rev {{revision}}` +`hg pull {{[-r|--rev]}} {{revision}}` - Specify a specific branch to pull: -`hg pull --branch {{branch}}` +`hg pull {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to pull: -`hg pull --bookmark {{bookmark}}` +`hg pull {{[-B|--bookmark]}} {{bookmark}}` diff --git a/pages/common/hg-push.md b/pages/common/hg-push.md index 4296da65ef..b26b393771 100644 --- a/pages/common/hg-push.md +++ b/pages/common/hg-push.md @@ -17,12 +17,12 @@ - Specify a specific revision changeset to push: -`hg push --rev {{revision}}` +`hg push {{[-r|--rev]}} {{revision}}` - Specify a specific branch to push: -`hg push --branch {{branch}}` +`hg push {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to push: -`hg push --bookmark {{bookmark}}` +`hg push {{[-B|--bookmark]}} {{bookmark}}` diff --git a/pages/common/hg-remove.md b/pages/common/hg-remove.md index 032f233612..2c937f52bb 100644 --- a/pages/common/hg-remove.md +++ b/pages/common/hg-remove.md @@ -9,16 +9,16 @@ - Remove all staged files matching a specified pattern: -`hg remove --include {{pattern}}` +`hg remove {{[-I|--include]}} {{pattern}}` - Remove all staged files, excluding those that match a specified pattern: -`hg remove --exclude {{pattern}}` +`hg remove {{[-X|--exclude]}} {{pattern}}` - Recursively remove sub-repositories: -`hg remove --subrepos` +`hg remove {{[-S|--subrepos]}}` - Remove files from the repository that have been physically removed: -`hg remove --after` +`hg remove {{[-A|--after]}}` diff --git a/pages/common/hg-serve.md b/pages/common/hg-serve.md index 40020c52f9..508fc0dc66 100644 --- a/pages/common/hg-serve.md +++ b/pages/common/hg-serve.md @@ -9,15 +9,15 @@ - Start a web server instance on the specified port: -`hg serve --port {{port}}` +`hg serve {{[-p|--port]}} {{port}}` - Start a web server instance on the specified listening address: -`hg serve --address {{address}}` +`hg serve {{[-a|--address]}} {{address}}` - Start a web server instance with a specific identifier: -`hg serve --name {{name}}` +`hg serve {{[-n|--name]}} {{name}}` - Start a web server instance using the specified theme (see the templates directory): diff --git a/pages/common/hg-status.md b/pages/common/hg-status.md index a5e6373c7f..8f29d401da 100644 --- a/pages/common/hg-status.md +++ b/pages/common/hg-status.md @@ -9,19 +9,19 @@ - Display only modified files: -`hg status --modified` +`hg status {{[-m|--modified]}}` - Display only added files: -`hg status --added` +`hg status {{[-a|--added]}}` - Display only removed files: -`hg status --removed` +`hg status {{[-r|--removed]}}` - Display only deleted (but tracked) files: -`hg status --deleted` +`hg status {{[-d|--deleted]}}` - Display changes in the working directory compared to a specified changeset: @@ -29,8 +29,8 @@ - Display only files matching a specified glob pattern: -`hg status --include {{pattern}}` +`hg status {{[-I|--include]}} {{pattern}}` - Display files, excluding those that match a specified glob pattern: -`hg status --exclude {{pattern}}` +`hg status {{[-X|--exclude]}} {{pattern}}` diff --git a/pages/common/hg-update.md b/pages/common/hg-update.md index e0a4e9823c..723d351ed1 100644 --- a/pages/common/hg-update.md +++ b/pages/common/hg-update.md @@ -9,12 +9,12 @@ - Update to the specified revision: -`hg update --rev {{revision}}` +`hg update {{[-r|--rev]}} {{revision}}` - Update and discard uncommitted changes: -`hg update --clean` +`hg update {{[-C|--clean]}}` - Update to the last commit matching a specified date: -`hg update --date {{dd-mm-yyyy}}` +`hg update {{[-d|--date]}} {{dd-mm-yyyy}}` diff --git a/pages/common/hostapd.md b/pages/common/hostapd.md index f7c3d4fbe6..a3bbe7113a 100644 --- a/pages/common/hostapd.md +++ b/pages/common/hostapd.md @@ -1,7 +1,7 @@ # hostapd > Start an access point using a wireless interface. -> More information: . +> More information: . - Start an access point: diff --git a/pages/common/jdupes.md b/pages/common/jdupes.md index 0253f69863..5fad076e4b 100644 --- a/pages/common/jdupes.md +++ b/pages/common/jdupes.md @@ -1,7 +1,7 @@ # jdupes > A powerful duplicate file finder and an enhanced fork of fdupes. -> More information: . +> More information: . - Search a single directory: @@ -25,4 +25,4 @@ - Search multiple directories and keep the directory order in result: -`jdupes -O {{directory1}} {{directory2}} {{directory3}}` +`jdupes -O {{directory1 directory2 directory3 ...}}` diff --git a/pages/common/nvidia-smi.md b/pages/common/nvidia-smi.md index ba004d01a1..0ab116db8f 100644 --- a/pages/common/nvidia-smi.md +++ b/pages/common/nvidia-smi.md @@ -9,7 +9,7 @@ - Display more detailed GPU information: -`nvidia-smi --query` +`nvidia-smi {{[-q|--query]}}` - Monitor overall GPU usage with 1-second update interval: diff --git a/pages/common/pamixer.md b/pages/common/pamixer.md index 56149ab1d9..564ccc28bf 100644 --- a/pages/common/pamixer.md +++ b/pages/common/pamixer.md @@ -1,7 +1,7 @@ # pamixer > A simple command-line mixer for PulseAudio. -> More information: . +> More information: . - List all sinks and sources with their corresponding IDs: @@ -17,11 +17,11 @@ - Increase the volume on default sink by 5%: -`pamixer --increase {{5}}` +`pamixer {{[-i|--increase]}} {{5}}` - Decrease the volume on a source by 5%: -`pamixer --decrease {{5}} --source {{ID}}` +`pamixer {{[-d|--decrease]}} {{5}} --source {{ID}}` - Use the allow boost option to increase, decrease, or set the volume above 100%: @@ -29,4 +29,4 @@ - Mute the default sink (use `--unmute` instead to unmute): -`pamixer --mute` +`pamixer {{[-m|--mute]}}` diff --git a/pages/common/pdftk.md b/pages/common/pdftk.md index c5b6ee3bd6..0fa0bd1937 100644 --- a/pages/common/pdftk.md +++ b/pages/common/pdftk.md @@ -1,7 +1,7 @@ # pdftk > PDF toolkit. -> More information: . +> More information: . - Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: diff --git a/pages/common/qmv.md b/pages/common/qmv.md index 8d8e8faaf3..27795b09dc 100644 --- a/pages/common/qmv.md +++ b/pages/common/qmv.md @@ -13,7 +13,7 @@ - Move multiple directories: -`qmv {{[-d|--directory]}} {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` +`qmv {{[-d|--directory]}} {{path/to/directory1 path/to/directory2 path/to/directory3 ...}}` - Move all files and directories inside a directory: diff --git a/pages/common/r2e.md b/pages/common/r2e.md index 0400f18226..098e26e9e8 100644 --- a/pages/common/r2e.md +++ b/pages/common/r2e.md @@ -2,7 +2,7 @@ > Forwards RSS feeds to an email address. > Requires a configured `sendmail` or smtp setup. -> More information: . +> More information: . - Create a new feed database that sends email to an email address: diff --git a/pages/common/rar.md b/pages/common/rar.md index ed333ce4df..566e4bd613 100644 --- a/pages/common/rar.md +++ b/pages/common/rar.md @@ -5,7 +5,7 @@ - Archive 1 or more files: -`rar a {{path/to/archive_name.rar}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` +`rar a {{path/to/archive_name.rar}} {{path/to/file1 path/to/file2 path/to/file3 ...}}` - Archive a directory: diff --git a/pages/common/symfony.md b/pages/common/symfony.md index 04322ae926..c9060842e6 100644 --- a/pages/common/symfony.md +++ b/pages/common/symfony.md @@ -1,7 +1,7 @@ # symfony > The console component for the Symfony framework. -> More information: . +> More information: . - Create a new Symfony project: diff --git a/pages/common/zopflipng.md b/pages/common/zopflipng.md index 0f535b8be7..3a165eb4f6 100644 --- a/pages/common/zopflipng.md +++ b/pages/common/zopflipng.md @@ -9,4 +9,4 @@ - Optimize several PNGs and save with given prefix: -`zopflipng --prefix={{prefix}} {{image1.png}} {{image2.png}} {{image3.png}}` +`zopflipng --prefix={{prefix}} {{image1.png image2.png image3.png ...}}` diff --git a/pages/linux/netselect.md b/pages/linux/netselect.md index 83b39431c5..2f9b4a741e 100644 --- a/pages/linux/netselect.md +++ b/pages/linux/netselect.md @@ -5,19 +5,19 @@ - Choose the server with the lowest latency: -`sudo netselect {{host_1}} {{host_2}}` +`sudo netselect {{host_1 host_2 ...}}` - Display nameserver resolution and statistics: -`sudo netselect -vv {{host_1}} {{host_2}}` +`sudo netselect -vv {{host_1 host_2 ...}}` - Define maximum TTL (time to live): -`sudo netselect -m {{10}} {{host_1}} {{host_2}}` +`sudo netselect -m {{10}} {{host_1 host_2 ...}}` - Print `n` fastest servers among the hosts: -`sudo netselect -s {{n}} {{host_1}} {{host_2}} {{host_3}}` +`sudo netselect -s {{n}} {{host_1 host_2 host_3 ...}}` - Display help: