*: unify environment variable notation (#19702)

2026-08-28 11:25:16 +08:00 · 2025-12-01 08:11:52 +02:00
parent e6fce3e2ce
commit 4135d9ca1e
26 changed files with 28 additions and 28 deletions
@@ -7,7 +7,7 @@

 `bash-it update {{stable|dev}}`

- Reload Bash profile (set `BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` to non-empty value for an automatic reload):
+- Reload Bash profile (set `$BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` to non-empty value for an automatic reload):

 `bash-it reload`

@@ -11,7 +11,7 @@

 `clear -x`

- Indicate the type of terminal to clean (defaults to the value of the environment variable `TERM`):
+- Indicate the type of terminal to clean (defaults to the value of the environment variable `$TERM`):

 `clear -T {{type_of_terminal}}`

@@ -9,7 +9,7 @@

 `compgen -c`

- List all commands that you could run that start with a specified string and save results to `COMPREPLY`:
+- List all commands that you could run that start with a specified string and save results to `$COMPREPLY`:

 `compgen -V COMPREPLY -c {{str}}`

@@ -5,7 +5,7 @@
 > See also: `compgen`, `compopt`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#index-complete>.

- Set arguments of a command to autocomplete through a function (completion response is sent in `COMPREPLY` variable):
+- Set arguments of a command to autocomplete through a function (completion response is sent in `$COMPREPLY` variable):

 `complete -F {{function}} {{command}}`

@@ -20,7 +20,7 @@

 `conda init --no-user`

- Add `condabin/` directory to PATH:
+- Add `condabin/` directory to `$PATH`:

 `conda init --condabin`

@@ -1,6 +1,6 @@
 # crane registry

-> This command serves a registry implementation on an automatically chosen port (:0), $PORT or --address.
+> This command serves a registry implementation on an automatically chosen port (:0), `$PORT` or --address.
 > The command blocks while the server accepts pushes and pulls and contents are can be stored in memory, and disk.
 > More information: <https://github.com/google/go-containerregistry/blob/main/cmd/crane/doc/crane_registry_serve.md>.

@@ -3,7 +3,7 @@
 > Concurrent Versions System, a revision control system.
 > More information: <https://manned.org/cvs>.

- Create a new repository (requires the `CVSROOT` environment variable to be set externally):
+- Create a new repository (requires the `$CVSROOT` environment variable to be set externally):

 `cvs -d {{path/to/repository}} init`

@@ -1,9 +1,9 @@
 # dircolors

-> Output commands to set the LS_COLOR environment variable and style `ls`, `dir`, etc.
+> Output commands to set the `$LS_COLOR` environment variable and style `ls`, `dir`, etc.
 > More information: <https://www.gnu.org/software/coreutils/manual/html_node/dircolors-invocation.html>.

- Output commands to set LS_COLOR using default colors:
+- Output commands to set `$LS_COLOR` using default colors:

 `dircolors`

@@ -11,7 +11,7 @@

 `dircolors --print-ls-colors`

- Output commands to set LS_COLOR using colors from a file:
+- Output commands to set `$LS_COLOR` using colors from a file:

 `dircolors {{path/to/file}}`

@@ -7,7 +7,7 @@

 `docker context create {{my_context}} --docker "host={{tcp://remote-host:2375}}"`

- Create a context based on the `DOCKER_HOST` environment variable:
+- Create a context based on the `$DOCKER_HOST` environment variable:

 `docker context create {{my_context}}`

@@ -7,6 +7,6 @@

 `export {{VARIABLE}}={{value}}`

- Append a pathname to the environment variable `PATH`:
+- Append a pathname to the environment variable `$PATH`:

 `export PATH=$PATH:{{path/to/append}}`
@@ -1,6 +1,6 @@
 # flask

-> A general utility script for Flask applications. Loads the application defined in the `FLASK_APP` environment variable.
+> A general utility script for Flask applications. Loads the application defined in the `$FLASK_APP` environment variable.
 > More information: <https://flask.palletsprojects.com/en/stable/cli/>.

 - Run a development server:
@@ -16,7 +16,7 @@

 `gdm --no-console`

- Prevent sanitizing environment variables that start with `LD_`:
+- Prevent sanitizing environment variables that start with `$LD_`:

 `gdm --preserve-ld-vars`

@@ -19,6 +19,6 @@

 `github-label-sync --access-token {{token}} --allow-added-labels {{repository_name}}`

- Synchronize using the `GITHUB_ACCESS_TOKEN` environment variable:
+- Synchronize using the `$GITHUB_ACCESS_TOKEN` environment variable:

 `github-label-sync {{repository_name}}`
@@ -7,7 +7,7 @@

 `man {{command}}`

- Open the man page for a command in a browser (`BROWSER` environment variable can replace `=browser_name`):
+- Open the man page for a command in a browser (`$BROWSER` environment variable can replace `=browser_name`):

 `man {{[-H|--html=]}}{{browser_name}} {{command}}`

@@ -1,6 +1,6 @@
 # nix edit

-> Open the Nix expression of a Nix package in $EDITOR.
+> Open the Nix expression of a Nix package in `$EDITOR`.
 > More information: <https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-edit.html>.

 - Open the source of the Nix expression of a package from nixpkgs in your `$EDITOR`:
@@ -8,7 +8,7 @@

 `nixpkgs-review pr {{pr_number|pr_url}}`

- Build changed packages and post a comment with a report (requires setting up a token in `hub`, `gh`, or the `GITHUB_TOKEN` environment variable):
+- Build changed packages and post a comment with a report (requires setting up a token in `hub`, `gh`, or the `$GITHUB_TOKEN` environment variable):

 `nixpkgs-review pr --post-result {{pr_number|pr_url}}`

@@ -15,7 +15,7 @@

 `nnn -H`

- Open an existing [b]ookmark (defined in the `NNN_BMS` environment variable):
+- Open an existing [b]ookmark (defined in the `$NNN_BMS` environment variable):

 `nnn -b {{bookmark_name}}`

@@ -19,7 +19,7 @@

 `pulumi state repair`

- Edit a stack's state in the editor specified by the `EDITOR` environment variable:
+- Edit a stack's state in the editor specified by the `$EDITOR` environment variable:

 `pulumi state edit --stack {{stack_name}}`

@@ -20,7 +20,7 @@

 `virsh create {{path/to/config_file.xml}}`

- Edit a guest's configuration file (editor can be changed with $EDITOR):
+- Edit a guest's configuration file (editor can be changed with `$EDITOR`):

 `virsh edit {{guest_id}}`

@@ -19,6 +19,6 @@

 `whence -ca "{{command}}"`

- Search only the `PATH` for `command`, ignoring builtins, aliases or shell functions (equivalent to the `where` command):
+- Search only the `$PATH` for `command`, ignoring builtins, aliases or shell functions (equivalent to the `where` command):

 `whence -p "{{command}}"`
@@ -1,7 +1,7 @@
 # where

 > Reports all known instances of a command.
-> It could be an executable in the PATH environment variable, an alias, or a shell builtin.
+> It could be an executable in the `$PATH` environment variable, an alias, or a shell builtin.
 > More information: <https://zsh.sourceforge.io/Doc/Release/Shell-Builtin-Commands.html>.

 - Find all instances of a command:
@@ -4,7 +4,7 @@
 > See also: `whereis`, `whatis`, `type`.
 > More information: <https://manned.org/which>.

- Search the PATH environment variable and display the location of any matching executables:
+- Search the `$PATH` environment variable and display the location of any matching executables:

 `which {{executable}}`

@@ -1,7 +1,7 @@
 # xzmore

 > Display text from `xz` or `lzma` compressed files.
-> Almost equivalent to `xzless`, except it respects the `PAGER` environment variable, uses `more` by default and you cannot pass options to the pager.
+> Almost equivalent to `xzless`, except it respects the `$PAGER` environment variable, uses `more` by default and you cannot pass options to the pager.
 > More information: <https://manned.org/xzmore>.

 - View a compressed file:
@@ -13,7 +13,7 @@

 `agetty {{[-t|--timeout]}} {{timeout_in_seconds}} -`

- Assume the `tty` is 8-bit, overriding the `TERM` environment variable set by `init`:
+- Assume the `tty` is 8-bit, overriding the `$TERM` environment variable set by `init`:

 `agetty {{[-8|--8bits]}} - {{term_var}}`

@@ -1,6 +1,6 @@
 # eselect locale

-> An `eselect` module for managing the `LANG` environment variable, which sets the system language.
+> An `eselect` module for managing the `$LANG` environment variable, which sets the system language.
 > More information: <https://wiki.gentoo.org/wiki/Eselect#Locale>.

 - List available locales:
@@ -16,7 +16,7 @@

 `torsocks --shell`

- Check if current shell is Tor enabled (`LD_PRELOAD` value will be empty if disabled):
+- Check if current shell is Tor enabled (`$LD_PRELOAD` value will be empty if disabled):

 `torsocks show`