diff --git a/pages/common/cloc.md b/pages/common/cloc.md index 722daaeed8..19ac85b02a 100644 --- a/pages/common/cloc.md +++ b/pages/common/cloc.md @@ -1,7 +1,7 @@ # cloc > Count, and compute differences of, lines of source code and comments. -> More information: . +> More information: . - Count all the lines of code in a directory: diff --git a/pages/common/croc.md b/pages/common/croc.md index 8ee77c7d44..f5729f8281 100644 --- a/pages/common/croc.md +++ b/pages/common/croc.md @@ -9,7 +9,7 @@ - Send a file or directory with a specific passphrase: -`croc send --code {{passphrase}} {{path/to/file_or_directory}}` +`croc send {{[-c|--code]}} {{passphrase}} {{path/to/file_or_directory}}` - Receive a file or directory on receiving machine: diff --git a/pages/common/delta.md b/pages/common/delta.md index 34474862d3..2f8c9d0bfb 100644 --- a/pages/common/delta.md +++ b/pages/common/delta.md @@ -1,7 +1,7 @@ # delta > A viewer for Git and diff output. -> More information: . +> More information: . - Compare files or directories: @@ -9,11 +9,11 @@ - Compare files or directories, showing the line numbers: -`delta --line-numbers {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` +`delta {{[-n|--line-numbers]}} {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` - Compare files or directories, showing the differences side by side: -`delta --side-by-side {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` +`delta {{[-s|--side-by-side]}} {{path/to/old_file_or_directory}} {{path/to/new_file_or_directory}}` - Compare files or directories, ignoring any Git configuration settings: diff --git a/pages/common/fast.md b/pages/common/fast.md index 9b5e80f6d7..fb8951ce5b 100644 --- a/pages/common/fast.md +++ b/pages/common/fast.md @@ -9,7 +9,7 @@ - Measure the current upload speed in addition to download speed: -`fast --upload` +`fast {{[-u|--upload]}}` - Display results on a single line to reduce spacing: diff --git a/pages/common/git-checkout-index.md b/pages/common/git-checkout-index.md index c1e448b923..b0ae8d9251 100644 --- a/pages/common/git-checkout-index.md +++ b/pages/common/git-checkout-index.md @@ -5,16 +5,16 @@ - Restore any files deleted since the last commit: -`git checkout-index --all` +`git checkout-index {{[-a|--all]}}` - Restore any files deleted or changed since the last commit: -`git checkout-index --all --force` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}}` - Restore any files changed since the last commit, ignoring any files that were deleted: -`git checkout-index --all --force --no-create` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}} {{[-n|--no-create]}}` - Export a copy of the entire tree at the last commit to the specified directory (the trailing slash is important): -`git checkout-index --all --force --prefix={{path/to/export_directory/}}` +`git checkout-index {{[-a|--all]}} {{[-f|--force]}} --prefix {{path/to/export_directory/}}` diff --git a/pages/common/git-commit-graph.md b/pages/common/git-commit-graph.md index ebaeb66b35..d18726e21a 100644 --- a/pages/common/git-commit-graph.md +++ b/pages/common/git-commit-graph.md @@ -9,7 +9,7 @@ - Write a commit-graph file containing all reachable commits: -`git show-ref --hash | git commit-graph write --stdin-commits` +`git show-ref {{[-s|--hash]}} | git commit-graph write --stdin-commits` - Write a commit-graph file containing all commits in the current commit-graph file along with those reachable from `HEAD`: diff --git a/pages/common/git-difftool.md b/pages/common/git-difftool.md index 38f98158d7..e0eb3736ec 100644 --- a/pages/common/git-difftool.md +++ b/pages/common/git-difftool.md @@ -18,4 +18,4 @@ - Use a specific tool (opendiff) to show changes since a given commit: -`git difftool --tool={{opendiff}} {{commit}}` +`git difftool {{[-t|--tool]}} {{opendiff}} {{commit}}` diff --git a/pages/common/git-help.md b/pages/common/git-help.md index 7d056cd21a..2471ef5f60 100644 --- a/pages/common/git-help.md +++ b/pages/common/git-help.md @@ -9,16 +9,16 @@ - Display help about a specific Git subcommand in a web browser: -`git help --web {{subcommand}}` +`git help {{[-w|--web]}} {{subcommand}}` - Display a list of all available Git subcommands: -`git help --all` +`git help {{[-a|--all]}}` - List the available guides: -`git help --guide` +`git help {{[-g|--guide]}}` - List all possible configuration variables: -`git help --config` +`git help {{[-c|--config]}}` diff --git a/pages/common/gobuster.md b/pages/common/gobuster.md index e68aa317fa..70f91ad901 100644 --- a/pages/common/gobuster.md +++ b/pages/common/gobuster.md @@ -1,28 +1,28 @@ # gobuster > Brute-forces hidden paths on web servers and more. -> More information: . +> More information: . - Discover directories and files that match in the wordlist: -`gobuster dir --url {{https://example.com/}} --wordlist {{path/to/file}}` +`gobuster dir {{[-u|--url]}} {{https://example.com/}} {{[-w|--wordlist]}} {{path/to/file}}` - Discover subdomains: -`gobuster dns --domain {{example.com}} --wordlist {{path/to/file}}` +`gobuster dns {{[-d|--domain]}} {{example.com}} {{[-w|--wordlist]}} {{path/to/file}}` - Discover Amazon S3 buckets: -`gobuster s3 --wordlist {{path/to/file}}` +`gobuster s3 {{[-w|--wordlist]}} {{path/to/file}}` - Discover other virtual hosts on the server: -`gobuster vhost --url {{https://example.com/}} --wordlist {{path/to/file}}` +`gobuster vhost {{[-u|--url]}} {{https://example.com/}} {{[-w|--wordlist]}} {{path/to/file}}` - Fuzz the value of a parameter: -`gobuster fuzz --url {{https://example.com/?parameter=FUZZ}} --wordlist {{path/to/file}}` +`gobuster fuzz {{[-u|--url]}} {{https://example.com/?parameter=FUZZ}} {{[-w|--wordlist]}} {{path/to/file}}` - Fuzz the name of a parameter: -`gobuster fuzz --url {{https://example.com/?FUZZ=value}} --wordlist {{path/to/file}}` +`gobuster fuzz {{[-u|--url]}} {{https://example.com/?FUZZ=value}} {{[-w|--wordlist]}} {{path/to/file}}` diff --git a/pages/common/hg-clone.md b/pages/common/hg-clone.md index 98be55e925..1b96bc2b79 100644 --- a/pages/common/hg-clone.md +++ b/pages/common/hg-clone.md @@ -9,16 +9,16 @@ - Clone a repository to the head of a specific branch, ignoring later commits: -`hg clone --branch {{branch}} {{remote_repository_source}}` +`hg clone {{[-b|--branch]}} {{branch}} {{remote_repository_source}}` - Clone a repository with only the `.hg` directory, without checking out files: -`hg clone --noupdate {{remote_repository_source}}` +`hg clone {{[-U|--noupdate]}} {{remote_repository_source}}` - Clone a repository to a specific revision, tag or branch, keeping the entire history: -`hg clone --updaterev {{revision}} {{remote_repository_source}}` +`hg clone {{[-u|--updaterev]}} {{revision}} {{remote_repository_source}}` - Clone a repository up to a specific revision without any newer history: -`hg clone --rev {{revision}} {{remote_repository_source}}` +`hg clone {{[-r|--rev]}} {{revision}} {{remote_repository_source}}` diff --git a/pages/common/lambo.md b/pages/common/lambo.md index 1c556d680d..989c6eccd7 100644 --- a/pages/common/lambo.md +++ b/pages/common/lambo.md @@ -2,7 +2,7 @@ > A super-powered `laravel new` for Laravel and Valet. > See also `lambo new` for additional command flags. -> More information: . +> More information: . - Create a new Laravel application: @@ -14,7 +14,7 @@ - Open the configuration in a specific editor: -`lambo edit-config --editor="{{path/to/editor}}"` +`lambo edit-config {{[-e|--editor]}} "{{path/to/editor}}"` - Open the configuration file that is run after new applications have been scaffolded: diff --git a/pages/common/mutagen.md b/pages/common/mutagen.md index 987a111142..657ca97a86 100644 --- a/pages/common/mutagen.md +++ b/pages/common/mutagen.md @@ -1,7 +1,7 @@ # mutagen > Real-time file synchronization and network forwarding tool. -> More information: . +> More information: . - Start a synchronization session between a local directory and a remote host: diff --git a/pages/common/ncc.md b/pages/common/ncc.md index f349eeeae0..34eb511a6f 100644 --- a/pages/common/ncc.md +++ b/pages/common/ncc.md @@ -10,15 +10,15 @@ - Bundle and minify a Node.js application: -`ncc build --minify {{path/to/file.js}}` +`ncc build {{[-m|--minify]}} {{path/to/file.js}}` - Bundle and minify a Node.js application and generate source maps: -`ncc build --source-map {{path/to/file.js}}` +`ncc build {{[-s|--source-map]}} {{path/to/file.js}}` - Automatically recompile on changes to source files: -`ncc build --watch {{path/to/file.js}}` +`ncc build {{[-w|--watch]}} {{path/to/file.js}}` - Bundle a Node.js application into a temporary directory and run it for testing: diff --git a/pages/common/next.md b/pages/common/next.md index 173958149b..b62d6ece44 100644 --- a/pages/common/next.md +++ b/pages/common/next.md @@ -1,7 +1,7 @@ # next > React framework that uses server-side rendering for building optimized web applications. -> More information: . +> More information: . - Start the current application in development mode: @@ -9,7 +9,7 @@ - Start the current application and listen on a specific port: -`next dev --port {{port}}` +`next dev {{[-p|--port]}} {{port}}` - Build the current application optimized for production: @@ -21,7 +21,7 @@ - Start the compiled application and listen on a specific port: -`next start --port {{port}}` +`next start {{[-p|--port]}} {{port}}` - Export the current application to static HTML pages: @@ -33,4 +33,4 @@ - Display help for a subcommand: -`next {{build|dev|export|start|telemetry}} --help` +`next {{build|dev|export|start|telemetry}} {{[-h|--help]}}` diff --git a/pages/common/php-coveralls.md b/pages/common/php-coveralls.md index 4dd4513f84..f9bf8b1363 100644 --- a/pages/common/php-coveralls.md +++ b/pages/common/php-coveralls.md @@ -1,7 +1,7 @@ # php-coveralls > A PHP client for Coveralls. -> More information: . +> More information: . - Send coverage information to Coveralls: @@ -9,15 +9,15 @@ - Send coverage information to Coveralls for a specific directory: -`php-coveralls --root_dir {{path/to/directory}}` +`php-coveralls {{[-r|--root_dir]}} {{path/to/directory}}` - Send coverage information to Coveralls with a specific config: -`php-coveralls --config {{path/to/.coveralls.yml}}` +`php-coveralls {{[-c|--config]}} {{path/to/.coveralls.yml}}` - Send coverage information to Coveralls with verbose output: -`php-coveralls --verbose` +`php-coveralls {{[-v|--verbose]}}` - Send coverage information to Coveralls excluding source files with no executable statements: @@ -25,12 +25,12 @@ - Send coverage information to Coveralls with a specific environment name: -`php-coveralls --env {{test|dev|prod}}` +`php-coveralls {{[-e|--env]}} {{test|dev|prod}}` - Specify multiple Coverage Clover XML files to upload: -`php-coveralls --coverage_clover {{path/to/first_clover.xml}} --coverage_clover {{path/to/second_clover.xml}}` +`php-coveralls {{[-x|--coverage_clover]}} {{path/to/first_clover.xml}} --coverage_clover {{path/to/second_clover.xml}}` - Output the JSON that will be sent to Coveralls to a specific file: -`php-coveralls --json_path {{path/to/coveralls-upload.json}}` +`php-coveralls {{[-o|--json_path]}} {{path/to/coveralls-upload.json}}` diff --git a/pages/common/phpbu.md b/pages/common/phpbu.md index 0dd6518573..c73b50c419 100644 --- a/pages/common/phpbu.md +++ b/pages/common/phpbu.md @@ -1,7 +1,7 @@ # phpbu > A backup utility framework for PHP. -> More information: . +> More information: . - Run backups using the default `phpbu.xml` configuration file: diff --git a/pages/common/phpdox.md b/pages/common/phpdox.md index a1f511b6c1..a614b0124d 100644 --- a/pages/common/phpdox.md +++ b/pages/common/phpdox.md @@ -13,12 +13,12 @@ - Generate documentation using a specific configuration file: -`phpdox --file {{path/to/phpdox.xml}}` +`phpdox {{[-f|--file]}} {{path/to/phpdox.xml}}` - Only run the metadata collection process: -`phpdox --collector` +`phpdox {{[-c|--collector]}}` - Only run the documentation generator process: -`phpdox --generator` +`phpdox {{[-g|--generator]}}` diff --git a/pages/common/pio-account.md b/pages/common/pio-account.md index 72b3b136c5..be3133f40e 100644 --- a/pages/common/pio-account.md +++ b/pages/common/pio-account.md @@ -5,7 +5,7 @@ - Register a new PlatformIO account: -`pio account register --username {{username}} --email {{email}} --password {{password}} --firstname {{firstname}} --lastname {{lastname}}` +`pio account register {{[-u|--username]}} {{username}} {{[-e|--email]}} {{email}} {{[-p|--password]}} {{password}} --firstname {{firstname}} --lastname {{lastname}}` - Permanently delete your PlatformIO account and related data: @@ -13,7 +13,7 @@ - Log in to your PlatformIO account: -`pio account login --username {{username}} --password {{password}}` +`pio account login {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Log out of your PlatformIO account: @@ -21,7 +21,7 @@ - Update your PlatformIO profile: -`pio account update --username {{username}} --email {{email}} --firstname {{firstname}} --lastname {{lastname}} --current-password {{password}}` +`pio account update {{[-u|--username]}} {{username}} {{[-e|--email]}} {{email}} --firstname {{firstname}} --lastname {{lastname}} --current-password {{password}}` - Show detailed information about your PlatformIO account: @@ -29,4 +29,4 @@ - Reset your password using your username or email: -`pio account forgot --username {{username_or_email}}` +`pio account forgot {{[-u|--username]}} {{username_or_email}}` diff --git a/pages/common/pio-check.md b/pages/common/pio-check.md index 2f673b2369..4a0c9e2eb7 100644 --- a/pages/common/pio-check.md +++ b/pages/common/pio-check.md @@ -9,11 +9,11 @@ - Perform a basic analysis check on a specific project: -`pio check --project-dir {{project_dir}}` +`pio check {{[-d|--project-dir]}} {{project_dir}}` - Perform an analysis check for a specific environment: -`pio check --environment {{environment}}` +`pio check {{[-e|--environment]}} {{environment}}` - Perform an analysis check and only report a specified defect severity type: @@ -21,4 +21,4 @@ - Perform an analysis check and show detailed information when processing environments: -`pio check --verbose` +`pio check {{[-v|--verbose]}}` diff --git a/pages/common/pio-ci.md b/pages/common/pio-ci.md index 8c0a1568df..20d3ea3286 100644 --- a/pages/common/pio-ci.md +++ b/pages/common/pio-ci.md @@ -10,11 +10,11 @@ - Build a PlatformIO project and specify specific libraries: -`pio ci --lib {{path/to/library_directory}} {{path/to/project}}` +`pio ci {{[-l|--lib]}} {{path/to/library_directory}} {{path/to/project}}` - Build a PlatformIO project and specify a specific board (`pio boards` lists all of them): -`pio ci --board {{board}} {{path/to/project}}` +`pio ci {{[-b|--board]}} {{board}} {{path/to/project}}` - Build a PlatformIO project in a specific directory: @@ -26,4 +26,4 @@ - Build a PlatformIO project using a specific configuration file: -`pio ci --project-conf {{path/to/platformio.ini}}` +`pio ci {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/pages/common/pio-debug.md b/pages/common/pio-debug.md index 745037df60..41b8ba7210 100644 --- a/pages/common/pio-debug.md +++ b/pages/common/pio-debug.md @@ -9,16 +9,16 @@ - Debug a specific PlatformIO project: -`pio debug --project-dir {{path/to/platformio_project}}` +`pio debug {{[-d|--project-dir]}} {{path/to/platformio_project}}` - Debug a specific environment: -`pio debug --environment {{environment}}` +`pio debug {{[-e|--environment]}} {{environment}}` - Debug a PlatformIO project using a specific configuration file: -`pio debug --project-conf {{path/to/platformio.ini}}` +`pio debug {{[-c|--project-conf]}} {{path/to/platformio.ini}}` - Debug a PlatformIO project using the `gdb` debugger: -`pio debug --interface={{gdb}} {{gdb_options}}` +`pio debug --interface {{gdb}} {{gdb_options}}` diff --git a/pages/common/pio-device.md b/pages/common/pio-device.md index 511fcf67ab..7ab9d791b0 100644 --- a/pages/common/pio-device.md +++ b/pages/common/pio-device.md @@ -17,11 +17,11 @@ - Start an interactive device monitor and listen to a specific port: -`pio device monitor --port {{/dev/ttyUSBX}}` +`pio device monitor {{[-p|--port]}} {{/dev/ttyUSBX}}` - Start an interactive device monitor and set a specific baud rate (defaults to 9600): -`pio device monitor --baud {{57600}}` +`pio device monitor {{[-b|--baud]}} {{57600}}` - Start an interactive device monitor and set a specific EOL character (defaults to `CRLF`): diff --git a/pages/common/pio-package.md b/pages/common/pio-pkg.md similarity index 64% rename from pages/common/pio-package.md rename to pages/common/pio-pkg.md index d6613d3726..51d11f82c8 100644 --- a/pages/common/pio-package.md +++ b/pages/common/pio-pkg.md @@ -1,4 +1,4 @@ -# pio package +# pio pkg > Manage packages in the registry. > Packages can only be removed within 72 hours (3 days) from the date that they are published. @@ -6,32 +6,32 @@ - Create a package tarball from the current directory: -`pio package pack --output {{path/to/package.tar.gz}}` +`pio pkg pack {{[-o|--output]}} {{path/to/package.tar.gz}}` - Create and publish a package tarball from the current directory: -`pio package publish` +`pio pkg publish` - Publish the current directory and restrict public access to it: -`pio package publish --private` +`pio pkg publish --private` - Publish a package: -`pio package publish {{path/to/package.tar.gz}}` +`pio pkg publish {{path/to/package.tar.gz}}` - Publish a package with a custom release date (UTC): -`pio package publish {{path/to/package.tar.gz}} --released-at "{{2021-04-08 21:15:38}}"` +`pio pkg publish {{path/to/package.tar.gz}} --released-at "{{2021-04-08 21:15:38}}"` - Remove all versions of a published package from the registry: -`pio package unpublish {{package}}` +`pio pkg unpublish {{package}}` - Remove a specific version of a published package from the registry: -`pio package unpublish {{package}}@{{version}}` +`pio pkg unpublish {{package}}@{{version}}` - Undo the removal, putting all versions or a specific version of the package back into the registry: -`pio package unpublish --undo {{package}}@{{version}}` +`pio pkg unpublish --undo {{package}}@{{version}}` diff --git a/pages/common/pio-project.md b/pages/common/pio-project.md index 7c323add68..344e9ca8ff 100644 --- a/pages/common/pio-project.md +++ b/pages/common/pio-project.md @@ -9,15 +9,15 @@ - Initialize a new PlatformIO project in a specific directory: -`pio project init --project-dir {{path/to/project_directory}}` +`pio project init {{[-d|--project-dir]}} {{path/to/project_directory}}` - Initialize a new PlatformIO project, specifying a board ID: -`pio project init --board {{ATmega328P|uno|...}}` +`pio project init {{[-b|--board]}} {{ATmega328P|uno|...}}` - Initialize a new PlatformIO based project, specifying one or more project options: -`pio project init --project-option="{{option}}={{value}}" --project-option="{{option}}={{value}}"` +`pio project init {{[-O|--project-option]}} "{{option}}={{value}}" {{[-O|--project-option]}} "{{option}}={{value}}"` - Print the configuration of a project: diff --git a/pages/common/pio-remote.md b/pages/common/pio-remote.md index da8c2cbc98..def9633aa1 100644 --- a/pages/common/pio-remote.md +++ b/pages/common/pio-remote.md @@ -10,7 +10,7 @@ - Start a new Remote Agent with a specific name and share it with friends: -`pio remote agent start --name {{agent_name}} --share {{example1@example.com}} --share {{example2@example.com}}` +`pio remote agent start {{[-n|--name]}} {{agent_name}} {{[-s|--share]}} {{example1@example.com}} {{[-s|--share]}} {{example2@example.com}}` - List devices from specified Agents (omit `--agent` to specify all Agents): diff --git a/pages/common/pio-run.md b/pages/common/pio-run.md index 4c01eb8995..7f1b26a769 100644 --- a/pages/common/pio-run.md +++ b/pages/common/pio-run.md @@ -9,7 +9,7 @@ - List all available project targets of a specific environment: -`pio run --list-targets --environment {{environment}}` +`pio run --list-targets {{[-e|--environment]}} {{environment}}` - Run all targets: @@ -17,12 +17,12 @@ - Run all targets of specified environments: -`pio run --environment {{environment1}} --environment {{environment2}}` +`pio run {{[-e|--environment]}} {{environment1}} {{[-e|--environment]}} {{environment2}}` - Run specified targets: -`pio run --target {{target1}} --target {{target2}}` +`pio run {{[-t|--target]}} {{target1}} {{[-t|--target]}} {{target2}}` - Run the targets of a specified configuration file: -`pio run --project-conf {{path/to/platformio.ini}}` +`pio run {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/pages/common/pio-test.md b/pages/common/pio-test.md index 49643e07d3..42fa2bfe17 100644 --- a/pages/common/pio-test.md +++ b/pages/common/pio-test.md @@ -9,15 +9,15 @@ - Test only specific environments: -`pio test --environment {{environment1}} --environment {{environment2}}` +`pio test {{[-e|--environment]}} {{environment1}} {{[-e|--environment]}} {{environment2}}` - Run only tests whose name matches a specific glob pattern: -`pio test --filter "{{pattern}}"` +`pio test {{[-f|--filter]}} "{{pattern}}"` - Ignore tests whose name matches a specific glob pattern: -`pio test --ignore "{{pattern}}"` +`pio test {{[-i|--ignore]}} "{{pattern}}"` - Specify a port for firmware uploading: @@ -25,4 +25,4 @@ - Specify a custom configuration file for running the tests: -`pio test --project-conf {{path/to/platformio.ini}}` +`pio test {{[-c|--project-conf]}} {{path/to/platformio.ini}}` diff --git a/pages/common/pio.md b/pages/common/pio.md index 274c268c81..59ca27da30 100644 --- a/pages/common/pio.md +++ b/pages/common/pio.md @@ -6,11 +6,11 @@ - Display help and list subcommands: -`pio --help` +`pio {{[-h|--help]}}` - Display help for a specific subcommand: -`pio {{subcommand}} --help` +`pio {{subcommand}} {{[-h|--help]}}` - Display version: diff --git a/pages/common/texdoc.md b/pages/common/texdoc.md index 5f5be27203..5cecc55ddd 100644 --- a/pages/common/texdoc.md +++ b/pages/common/texdoc.md @@ -1,7 +1,7 @@ # texdoc > Search for appropriate documentation for (La)TeX commands or packages. -> More information: . +> More information: . - Open the first search result in the default PDF viewer: @@ -9,7 +9,7 @@ - List the best search results: -`texdoc --list {{search}}` +`texdoc {{[-l|--list]}} {{search}}` - Open full documentation of texdoc: diff --git a/pages/common/texliveonfly.md b/pages/common/texliveonfly.md index 72da3df0a0..6ce401ef41 100644 --- a/pages/common/texliveonfly.md +++ b/pages/common/texliveonfly.md @@ -1,7 +1,7 @@ # texliveonfly > Downloads missing TeX Live packages while compiling `.tex` files. -> More information: . +> More information: . - Download missing packages while compiling: @@ -9,7 +9,7 @@ - Use a specific compiler (defaults to `pdflatex`): -`texliveonfly --compiler={{compiler}} {{source.tex}}` +`texliveonfly {{[-c|--compiler]}} {{compiler}} {{source.tex}}` - Use a custom TeX Live `bin` folder: diff --git a/pages/common/transcrypt.md b/pages/common/transcrypt.md index 675252cb22..561031e3fb 100644 --- a/pages/common/transcrypt.md +++ b/pages/common/transcrypt.md @@ -13,12 +13,12 @@ - Display the credentials of a configured repository: -`transcrypt --display` +`transcrypt {{[-d|--display]}}` - Initialize and decrypt a fresh clone of a configured repository: -`transcrypt --cipher={{cipher}}` +`transcrypt {{[-c|--cipher]}} {{cipher}}` - Rekey to change the encryption cipher or password: -`transcrypt --rekey` +`transcrypt {{[-r|--rekey]}}` diff --git a/pages/common/uvicorn.md b/pages/common/uvicorn.md index a1918d7bd4..19462d6f70 100644 --- a/pages/common/uvicorn.md +++ b/pages/common/uvicorn.md @@ -1,7 +1,7 @@ # uvicorn > Python ASGI HTTP Server, for asynchronous projects. -> More information: . +> More information: . - Run Python web app: diff --git a/pages/common/yapf.md b/pages/common/yapf.md index 75e384ca0d..8e0a545d60 100644 --- a/pages/common/yapf.md +++ b/pages/common/yapf.md @@ -5,12 +5,12 @@ - Display a diff of the changes that would be made, without making them (dry-run): -`yapf --diff {{path/to/file}}` +`yapf {{[-d|--diff]}} {{path/to/file}}` - Format the file in-place and display a diff of the changes: -`yapf --diff --in-place {{path/to/file}}` +`yapf {{[-d|--diff]}} {{[-i|--in-place]}} {{path/to/file}}` - Recursively format all Python files in a directory, concurrently: -`yapf --recursive --in-place --style {{pep8}} --parallel {{path/to/directory}}` +`yapf {{[-r|--recursive]}} {{[-i|--in-place]}} --style {{pep8}} {{[-p|--parallel]}} {{path/to/directory}}`