Fossil SCM
Tweak descriptions of FOSSIL_USER, LOGNAME, USER, and USERNAME environment variables.
Commit
809e80a1d9e9c59b2e9cc6ba9fadce33c2163b22
Parent
83153a97b75636f…
1 file changed
+16
-25
+16
-25
| --- www/env-opts.md | ||
| +++ www/env-opts.md | ||
| @@ -122,15 +122,16 @@ | ||
| 122 | 122 | variable found in the environment from the list `FOSSIL_HOME`, |
| 123 | 123 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 124 | 124 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 125 | 125 | location of the `~/.fossil` file. |
| 126 | 126 | |
| 127 | -`FOSSIL_USER`: Name of the default user account if the local or global | |
| 128 | -`default-user` setting is not present. The first environment variable | |
| 129 | -found in the environment from the list `FOSSIL_USER`, `USERNAME` | |
| 130 | -(Windows), `USER`, and `LOGNAME` is the user name. If none of those | |
| 131 | -are set, then the default user name is "root". | |
| 127 | +`FOSSIL_USER`: Name of the default user account if the checkout, local | |
| 128 | +or global `default-user` setting is not present. The first environment | |
| 129 | +variable found in the environment from the list `FOSSIL_USER`, `USER`, | |
| 130 | +`LOGNAME`, and `USERNAME` is the user name. If none of those are set, | |
| 131 | +then the default user name is "root". See the discussion of Fossil | |
| 132 | +Username below for a lot more detail. | |
| 132 | 133 | |
| 133 | 134 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 134 | 135 | specific file or folder containing the version of Tcl to load at run |
| 135 | 136 | time. |
| 136 | 137 | |
| @@ -166,15 +167,13 @@ | ||
| 166 | 167 | environment variable found in the environment from the list |
| 167 | 168 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 168 | 169 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 169 | 170 | used as the location of the `~/.fossil` file. |
| 170 | 171 | |
| 171 | -`LOGNAME`: Name of the default user account if the local or global | |
| 172 | -`default-user` setting is not present. The first environment variable | |
| 173 | -found in the environment from the list `FOSSIL_USER`, `USERNAME` | |
| 174 | -(Windows), `USER`, and `LOGNAME` is the user name. If none of those | |
| 175 | -are set, then the default user name is "root". | |
| 172 | +`LOGNAME`: Name of the logged in user on many Unix-like platforms. | |
| 173 | +Used as the fossil user name if `FOSSIL_USER` is not specified. See | |
| 174 | +the discussion of Fossil Username below for a lot more detail. | |
| 176 | 175 | |
| 177 | 176 | `PATH`: Used by most platforms to locate programs invoked without a |
| 178 | 177 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 179 | 178 | to choose the browser to launch. |
| 180 | 179 | |
| @@ -241,21 +240,17 @@ | ||
| 241 | 240 | directory (aka `.`) is the temporary folder. |
| 242 | 241 | |
| 243 | 242 | `TMPDIR`: Names the temporary file location to SQLite. |
| 244 | 243 | |
| 245 | 244 | |
| 246 | -`USER`: Name of the default user account if the local or global | |
| 247 | -`default-user` setting is not present. The first environment variable | |
| 248 | -found in the environment from the list `FOSSIL_USER`, `USERNAME` | |
| 249 | -(Windows), `USER`, and `LOGNAME` is the user name. If none of those | |
| 250 | -are set, then the default user name is "root". | |
| 251 | - | |
| 252 | -`USERNAME`: Name of the default user account if the local or global | |
| 253 | -`default-user` setting is not present. The first environment variable | |
| 254 | -found in the environment from the list `FOSSIL_USER`, `USERNAME` | |
| 255 | -(Windows), `USER`, and `LOGNAME` is the user name. If none of those | |
| 256 | -are set, then the default user name is "root". | |
| 245 | +`USER`: Name of the logged in user on many Unix-like platforms. | |
| 246 | +Used as the fossil user name if `FOSSIL_USER` is not specified. See | |
| 247 | +the discussion of Fossil Username below for a lot more detail. | |
| 248 | + | |
| 249 | +`USERNAME`: Name of the logged in user on Windows platforms. | |
| 250 | +Used as the fossil user name if `FOSSIL_USER` is not specified. See | |
| 251 | +the discussion of Fossil Username below for a lot more detail. | |
| 257 | 252 | |
| 258 | 253 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 259 | 254 | environment variable found in the environment that names an existing |
| 260 | 255 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 261 | 256 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| @@ -262,14 +257,10 @@ | ||
| 262 | 257 | directory (aka `.`) is the temporary folder. |
| 263 | 258 | |
| 264 | 259 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 265 | 260 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 266 | 261 | or global `editor` setting. |
| 267 | - | |
| 268 | - | |
| 269 | - | |
| 270 | - | |
| 271 | 262 | |
| 272 | 263 | |
| 273 | 264 | |
| 274 | 265 | Notes on Related Values |
| 275 | 266 | ----------------------- |
| 276 | 267 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -122,15 +122,16 @@ | |
| 122 | variable found in the environment from the list `FOSSIL_HOME`, |
| 123 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 124 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 125 | location of the `~/.fossil` file. |
| 126 | |
| 127 | `FOSSIL_USER`: Name of the default user account if the local or global |
| 128 | `default-user` setting is not present. The first environment variable |
| 129 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 130 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| 131 | are set, then the default user name is "root". |
| 132 | |
| 133 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 134 | specific file or folder containing the version of Tcl to load at run |
| 135 | time. |
| 136 | |
| @@ -166,15 +167,13 @@ | |
| 166 | environment variable found in the environment from the list |
| 167 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 168 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 169 | used as the location of the `~/.fossil` file. |
| 170 | |
| 171 | `LOGNAME`: Name of the default user account if the local or global |
| 172 | `default-user` setting is not present. The first environment variable |
| 173 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 174 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| 175 | are set, then the default user name is "root". |
| 176 | |
| 177 | `PATH`: Used by most platforms to locate programs invoked without a |
| 178 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 179 | to choose the browser to launch. |
| 180 | |
| @@ -241,21 +240,17 @@ | |
| 241 | directory (aka `.`) is the temporary folder. |
| 242 | |
| 243 | `TMPDIR`: Names the temporary file location to SQLite. |
| 244 | |
| 245 | |
| 246 | `USER`: Name of the default user account if the local or global |
| 247 | `default-user` setting is not present. The first environment variable |
| 248 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 249 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| 250 | are set, then the default user name is "root". |
| 251 | |
| 252 | `USERNAME`: Name of the default user account if the local or global |
| 253 | `default-user` setting is not present. The first environment variable |
| 254 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 255 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| 256 | are set, then the default user name is "root". |
| 257 | |
| 258 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 259 | environment variable found in the environment that names an existing |
| 260 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 261 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| @@ -262,14 +257,10 @@ | |
| 262 | directory (aka `.`) is the temporary folder. |
| 263 | |
| 264 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 265 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 266 | or global `editor` setting. |
| 267 | |
| 268 | |
| 269 | |
| 270 | |
| 271 | |
| 272 | |
| 273 | |
| 274 | Notes on Related Values |
| 275 | ----------------------- |
| 276 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -122,15 +122,16 @@ | |
| 122 | variable found in the environment from the list `FOSSIL_HOME`, |
| 123 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 124 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 125 | location of the `~/.fossil` file. |
| 126 | |
| 127 | `FOSSIL_USER`: Name of the default user account if the checkout, local |
| 128 | or global `default-user` setting is not present. The first environment |
| 129 | variable found in the environment from the list `FOSSIL_USER`, `USER`, |
| 130 | `LOGNAME`, and `USERNAME` is the user name. If none of those are set, |
| 131 | then the default user name is "root". See the discussion of Fossil |
| 132 | Username below for a lot more detail. |
| 133 | |
| 134 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 135 | specific file or folder containing the version of Tcl to load at run |
| 136 | time. |
| 137 | |
| @@ -166,15 +167,13 @@ | |
| 167 | environment variable found in the environment from the list |
| 168 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 169 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 170 | used as the location of the `~/.fossil` file. |
| 171 | |
| 172 | `LOGNAME`: Name of the logged in user on many Unix-like platforms. |
| 173 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 174 | the discussion of Fossil Username below for a lot more detail. |
| 175 | |
| 176 | `PATH`: Used by most platforms to locate programs invoked without a |
| 177 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 178 | to choose the browser to launch. |
| 179 | |
| @@ -241,21 +240,17 @@ | |
| 240 | directory (aka `.`) is the temporary folder. |
| 241 | |
| 242 | `TMPDIR`: Names the temporary file location to SQLite. |
| 243 | |
| 244 | |
| 245 | `USER`: Name of the logged in user on many Unix-like platforms. |
| 246 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 247 | the discussion of Fossil Username below for a lot more detail. |
| 248 | |
| 249 | `USERNAME`: Name of the logged in user on Windows platforms. |
| 250 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 251 | the discussion of Fossil Username below for a lot more detail. |
| 252 | |
| 253 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 254 | environment variable found in the environment that names an existing |
| 255 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 256 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| @@ -262,14 +257,10 @@ | |
| 257 | directory (aka `.`) is the temporary folder. |
| 258 | |
| 259 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 260 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 261 | or global `editor` setting. |
| 262 | |
| 263 | |
| 264 | |
| 265 | Notes on Related Values |
| 266 | ----------------------- |
| 267 |