Merge pull request #3285 from zowe/anax-v2.12-newenvvar-cli

adding env variable doc
zowe · Dec 4, 2023 · 43d3feb · 43d3feb
2 parents 7599d48 + 87ae627
commit 43d3feb
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/docs/user-guide/cli-using-formatting-environment-variables.md b/docs/user-guide/cli-using-formatting-environment-variables.md
@@ -6,13 +6,17 @@ Transform an option into the proper format for a Zowe CLI environment variable,
 * Convert lowercase letters in arguments/options to uppercase letters.
 * Convert hyphens in arguments/options to underscores.
 
-**Tip:** Refer to your operating system documentation for information about how to set and get environment variables. The procedure varies between Windows, Mac, and various versions of Linux.
+:::tip
+Refer to your operating system documentation for information about how to set and get environment variables. The procedure varies between Windows, Mac, and various versions of Linux.
+:::
 
-**Examples:**
+## Examples of transformed CLI options
 
 The following table provides examples of CLI options and the corresponding environment variable to which you can define a value:
 
 | Command Option          | Environment Variable           | Use Case   |
-| ----------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `--user`                | `ZOWE_OPT_USER`                | Define your mainframe username to an environment variable to avoid specifying it on all commands or profiles.                           |
-| `--reject-unauthorized` | `ZOWE_OPT_REJECT_UNAUTHORIZED` | Define a value of `true` to the `--reject-unauthorized` flag when you always require the flag and do not want to specify it on all commands or profiles. |
+| `--reject-unauthorized` | `ZOWE_OPT_REJECT_UNAUTHORIZED` | Define a value of `true` to the `--reject-unauthorized` flag when you always require the flag and do not want to specify it on all commands or profiles. |
+| `--editor`              | `ZOWE_OPT_EDITOR`              | Define an editor that Zowe CLI uses to open files. The value can be either the editor's executable file location or the name of a program (for example, *notepad* on Windows or *nano* on Linux).|
+