From 4135d9ca1e67eb77cff93282003b600818af9120 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Mon, 1 Dec 2025 08:11:52 +0200 Subject: [PATCH] *: unify environment variable notation (#19702) --- pages/common/bash-it.md | 2 +- pages/common/clear.md | 2 +- pages/common/compgen.md | 2 +- pages/common/complete.md | 2 +- pages/common/conda-init.md | 2 +- pages/common/crane-registry.md | 2 +- pages/common/cvs.md | 2 +- pages/common/dircolors.md | 6 +++--- pages/common/docker-context.md | 2 +- pages/common/export.md | 2 +- pages/common/flask.md | 2 +- pages/common/gdm.md | 2 +- pages/common/github-label-sync.md | 2 +- pages/common/man.md | 2 +- pages/common/nix-edit.md | 2 +- pages/common/nixpkgs-review.md | 2 +- pages/common/nnn.md | 2 +- pages/common/pulumi-state.md | 2 +- pages/common/virsh.md | 2 +- pages/common/whence.md | 2 +- pages/common/where.md | 2 +- pages/common/which.md | 2 +- pages/common/xzmore.md | 2 +- pages/linux/agetty.md | 2 +- pages/linux/eselect-locale.md | 2 +- pages/linux/torsocks.md | 2 +- 26 files changed, 28 insertions(+), 28 deletions(-) diff --git a/pages/common/bash-it.md b/pages/common/bash-it.md index 0bd9cada0d..5722e34b79 100644 --- a/pages/common/bash-it.md +++ b/pages/common/bash-it.md @@ -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` diff --git a/pages/common/clear.md b/pages/common/clear.md index 7572098841..27ec62730b 100644 --- a/pages/common/clear.md +++ b/pages/common/clear.md @@ -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}}` diff --git a/pages/common/compgen.md b/pages/common/compgen.md index 16779e233c..d057116c70 100644 --- a/pages/common/compgen.md +++ b/pages/common/compgen.md @@ -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}}` diff --git a/pages/common/complete.md b/pages/common/complete.md index a289c8707d..3d6ed4819f 100644 --- a/pages/common/complete.md +++ b/pages/common/complete.md @@ -5,7 +5,7 @@ > See also: `compgen`, `compopt`. > More information: . -- 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}}` diff --git a/pages/common/conda-init.md b/pages/common/conda-init.md index 81805b84b0..caffb9e0a4 100644 --- a/pages/common/conda-init.md +++ b/pages/common/conda-init.md @@ -20,7 +20,7 @@ `conda init --no-user` -- Add `condabin/` directory to PATH: +- Add `condabin/` directory to `$PATH`: `conda init --condabin` diff --git a/pages/common/crane-registry.md b/pages/common/crane-registry.md index 571453fa0e..e2d9bda111 100644 --- a/pages/common/crane-registry.md +++ b/pages/common/crane-registry.md @@ -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: . diff --git a/pages/common/cvs.md b/pages/common/cvs.md index 462195728d..0993615420 100644 --- a/pages/common/cvs.md +++ b/pages/common/cvs.md @@ -3,7 +3,7 @@ > Concurrent Versions System, a revision control system. > More information: . -- 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` diff --git a/pages/common/dircolors.md b/pages/common/dircolors.md index bdbad6d1a2..c5a35aedb2 100644 --- a/pages/common/dircolors.md +++ b/pages/common/dircolors.md @@ -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: . -- 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}}` diff --git a/pages/common/docker-context.md b/pages/common/docker-context.md index 60ca757bcc..092109d8be 100644 --- a/pages/common/docker-context.md +++ b/pages/common/docker-context.md @@ -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}}` diff --git a/pages/common/export.md b/pages/common/export.md index 33cd5ffe44..9f53cf6d38 100644 --- a/pages/common/export.md +++ b/pages/common/export.md @@ -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}}` diff --git a/pages/common/flask.md b/pages/common/flask.md index 21e1e4b07b..016820c834 100644 --- a/pages/common/flask.md +++ b/pages/common/flask.md @@ -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: . - Run a development server: diff --git a/pages/common/gdm.md b/pages/common/gdm.md index a83d35fd91..af79e4abf5 100644 --- a/pages/common/gdm.md +++ b/pages/common/gdm.md @@ -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` diff --git a/pages/common/github-label-sync.md b/pages/common/github-label-sync.md index cc6567908d..c635659ad8 100644 --- a/pages/common/github-label-sync.md +++ b/pages/common/github-label-sync.md @@ -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}}` diff --git a/pages/common/man.md b/pages/common/man.md index b84623a1f2..2c4af735b3 100644 --- a/pages/common/man.md +++ b/pages/common/man.md @@ -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}}` diff --git a/pages/common/nix-edit.md b/pages/common/nix-edit.md index 1ff3d06465..cd5c075eb0 100644 --- a/pages/common/nix-edit.md +++ b/pages/common/nix-edit.md @@ -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: . - Open the source of the Nix expression of a package from nixpkgs in your `$EDITOR`: diff --git a/pages/common/nixpkgs-review.md b/pages/common/nixpkgs-review.md index 4fcbf94d84..cb3d1ce5f8 100644 --- a/pages/common/nixpkgs-review.md +++ b/pages/common/nixpkgs-review.md @@ -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}}` diff --git a/pages/common/nnn.md b/pages/common/nnn.md index 23e4764bd9..bd5d45701c 100644 --- a/pages/common/nnn.md +++ b/pages/common/nnn.md @@ -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}}` diff --git a/pages/common/pulumi-state.md b/pages/common/pulumi-state.md index da879a19ff..1b9f645a55 100644 --- a/pages/common/pulumi-state.md +++ b/pages/common/pulumi-state.md @@ -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}}` diff --git a/pages/common/virsh.md b/pages/common/virsh.md index 56e861b579..bf447aadc8 100644 --- a/pages/common/virsh.md +++ b/pages/common/virsh.md @@ -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}}` diff --git a/pages/common/whence.md b/pages/common/whence.md index 129f051881..85c243836e 100644 --- a/pages/common/whence.md +++ b/pages/common/whence.md @@ -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}}"` diff --git a/pages/common/where.md b/pages/common/where.md index 7de89d9533..3b3893fd77 100644 --- a/pages/common/where.md +++ b/pages/common/where.md @@ -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: . - Find all instances of a command: diff --git a/pages/common/which.md b/pages/common/which.md index 296682ca38..6d3855c7da 100644 --- a/pages/common/which.md +++ b/pages/common/which.md @@ -4,7 +4,7 @@ > See also: `whereis`, `whatis`, `type`. > More information: . -- 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}}` diff --git a/pages/common/xzmore.md b/pages/common/xzmore.md index 1edae1aee2..aa0bb6ed18 100644 --- a/pages/common/xzmore.md +++ b/pages/common/xzmore.md @@ -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: . - View a compressed file: diff --git a/pages/linux/agetty.md b/pages/linux/agetty.md index f2e978214d..38ef9af0a9 100644 --- a/pages/linux/agetty.md +++ b/pages/linux/agetty.md @@ -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}}` diff --git a/pages/linux/eselect-locale.md b/pages/linux/eselect-locale.md index 9ce7881996..378afde05b 100644 --- a/pages/linux/eselect-locale.md +++ b/pages/linux/eselect-locale.md @@ -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: . - List available locales: diff --git a/pages/linux/torsocks.md b/pages/linux/torsocks.md index 59f0d29ad9..b2d96df952 100644 --- a/pages/linux/torsocks.md +++ b/pages/linux/torsocks.md @@ -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`