Fossil SCM
Improve description of the '--no-th-hook' command line argument.
Commit
a56f2089497d6fc5377328bbf0ff4c623e5fbcaf
Parent
95bd81f85e85077…
1 file changed
+26
-25
+26
-25
| --- www/env-opts.md | ||
| +++ www/env-opts.md | ||
| @@ -25,25 +25,25 @@ | ||
| 25 | 25 | can override the native preferences of the platform for case sensitive |
| 26 | 26 | file names: insensitive on Windows, sensitive on Unix. There are |
| 27 | 27 | probably odd interactions possible if you mix case sensitive and case |
| 28 | 28 | insensitive file systems on any single platform. This option or the |
| 29 | 29 | global setting should be used to force the case sensitivity to the |
| 30 | -most sensible condition. | |
| 30 | +most sensible condition. | |
| 31 | 31 | |
| 32 | 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | -any commands. | |
| 33 | +any commands. | |
| 34 | 34 | |
| 35 | 35 | |
| 36 | 36 | `--comfmtflags NUMBER`: Specify flags that control how check-in |
| 37 | 37 | comments and certain other text outputs are formatted for display. The |
| 38 | -flags are individual bits in `NUMBER`: | |
| 38 | +flags are individual bits in `NUMBER`: | |
| 39 | 39 | |
| 40 | - 0 no special formatting | |
| 41 | - 1 legacy algorithm (default) | |
| 42 | - 2 trim leading CR and LF | |
| 43 | - 4 trim leading and trailing spaces | |
| 44 | - 8 word break | |
| 40 | + 0 no special formatting | |
| 41 | + 1 legacy algorithm (default) | |
| 42 | + 2 trim leading CR and LF | |
| 43 | + 4 trim leading and trailing spaces | |
| 44 | + 8 word break | |
| 45 | 45 | 16 line break before comment |
| 46 | 46 | |
| 47 | 47 | |
| 48 | 48 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 49 | 49 | errors, and warnings. |
| @@ -50,24 +50,25 @@ | ||
| 50 | 50 | |
| 51 | 51 | |
| 52 | 52 | `--help`: If `--help` is found anywhere on the command line, translate |
| 53 | 53 | the command to `fossil help cmdname` where `cmdname` is the first |
| 54 | 54 | argument that does not begin with a `-` character. If all arguments |
| 55 | -start with `-`, translate to `fossil help argv[1] argv[2]...`. | |
| 55 | +start with `-`, translate to `fossil help argv[1] argv[2]...`. | |
| 56 | 56 | |
| 57 | 57 | `--httptrace`: (Sets `g.fHttpTrace`.) Trace outbound HTTP requests. |
| 58 | 58 | |
| 59 | 59 | `--localtime`: Override the `timeline-utc` option to explicitly use |
| 60 | 60 | local time. |
| 61 | 61 | |
| 62 | 62 | `--nocgi`: Prevent fossil from acting as a CGI by default even if the |
| 63 | 63 | `GATEWAY_INTERFACE` environment variable is set. |
| 64 | 64 | |
| 65 | -`--no-th-hook`: (Sets `g.fNoThHook`.) | |
| 65 | +`--no-th-hook`: (Sets `g.fNoThHook`.) Override the `th1-hooks` setting | |
| 66 | +and prevent any TH1 hooks from being executed. | |
| 66 | 67 | |
| 67 | 68 | `--quiet`: (Sets `g.fQuiet`.) Cause fossil to suppress various messages and progress |
| 68 | -indicators that would otherwise be printed. | |
| 69 | +indicators that would otherwise be printed. | |
| 69 | 70 | |
| 70 | 71 | `--sqltrace`: (Sets `g.SqlTrace`.) Implies `--sqlstats`. Trace certain |
| 71 | 72 | SQLite database activity, especially showing every SQL query |
| 72 | 73 | processed. |
| 73 | 74 | |
| @@ -95,11 +96,11 @@ | ||
| 95 | 96 | |
| 96 | 97 | `APPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 97 | 98 | environment variable found in the environment from the list |
| 98 | 99 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 99 | 100 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 100 | -used as the location of the `~/.fossil` file. | |
| 101 | +used as the location of the `~/.fossil` file. | |
| 101 | 102 | |
| 102 | 103 | `EDITOR`: Name the editor to use for check-in and stash comments. |
| 103 | 104 | Overridden by the local or global `editor` setting or the `VISUAL` |
| 104 | 105 | environment variable. |
| 105 | 106 | |
| @@ -118,11 +119,11 @@ | ||
| 118 | 119 | |
| 119 | 120 | `FOSSIL_HOME`: Location of the `~/.fossil` file. The first environment |
| 120 | 121 | variable found in the environment from the list `FOSSIL_HOME`, |
| 121 | 122 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 122 | 123 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 123 | -location of the `~/.fossil` file. | |
| 124 | +location of the `~/.fossil` file. | |
| 124 | 125 | |
| 125 | 126 | `FOSSIL_USER`: Name of the default user account if the local or global |
| 126 | 127 | `default-user` setting is not present. The first environment variable |
| 127 | 128 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 128 | 129 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -131,27 +132,27 @@ | ||
| 131 | 132 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 132 | 133 | specific file or folder containing the version of Tcl to load at run |
| 133 | 134 | time. |
| 134 | 135 | |
| 135 | 136 | |
| 136 | -`FOSSIL_VFS`: Name a VFS to load into SQLite. | |
| 137 | +`FOSSIL_VFS`: Name a VFS to load into SQLite. | |
| 137 | 138 | |
| 138 | 139 | `GATEWAY_INTERFACE`: If present and the `--nocgi` option is not, assume |
| 139 | 140 | fossil is invoked from a web server as a CGI command, and act |
| 140 | 141 | accordingly. |
| 141 | 142 | |
| 142 | 143 | `HOME`: Location of the `~/.fossil` file. The first environment |
| 143 | 144 | variable found in the environment from the list `FOSSIL_HOME`, |
| 144 | 145 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 145 | 146 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 146 | -location of the `~/.fossil` file. | |
| 147 | +location of the `~/.fossil` file. | |
| 147 | 148 | |
| 148 | 149 | `HOMEDRIVE`, `HOMEPATH`: (Windows) Location of the `~/.fossil` file. |
| 149 | 150 | The first environment variable found in the environment from the list |
| 150 | 151 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 151 | 152 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 152 | -used as the location of the `~/.fossil` file. | |
| 153 | +used as the location of the `~/.fossil` file. | |
| 153 | 154 | |
| 154 | 155 | `HTTP_HOST`: If defined, included in error log messages. |
| 155 | 156 | |
| 156 | 157 | `http_proxy`: If the global or local settings `proxy` is not set, this |
| 157 | 158 | is used as the default value for the `proxy` setting. |
| @@ -162,11 +163,11 @@ | ||
| 162 | 163 | |
| 163 | 164 | `LOCALAPPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 164 | 165 | environment variable found in the environment from the list |
| 165 | 166 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 166 | 167 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 167 | -used as the location of the `~/.fossil` file. | |
| 168 | +used as the location of the `~/.fossil` file. | |
| 168 | 169 | |
| 169 | 170 | `LOGNAME`: Name of the default user account if the local or global |
| 170 | 171 | `default-user` setting is not present. The first environment variable |
| 171 | 172 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 172 | 173 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -195,21 +196,21 @@ | ||
| 195 | 196 | |
| 196 | 197 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 197 | 198 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 198 | 199 | non-local files only. |
| 199 | 200 | |
| 200 | -`SQLITE_TMPDIR`: Names the temporary file location to SQLite. | |
| 201 | +`SQLITE_TMPDIR`: Names the temporary file location to SQLite. | |
| 201 | 202 | |
| 202 | 203 | |
| 203 | 204 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 204 | 205 | fall back comment editor. |
| 205 | 206 | |
| 206 | 207 | `TEMP`: On Windows, the location of temporary files. The first |
| 207 | 208 | environment variable found in the environment that names an existing |
| 208 | 209 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 209 | 210 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 210 | -directory (aka `.`) is the temporary folder. | |
| 211 | +directory (aka `.`) is the temporary folder. | |
| 211 | 212 | |
| 212 | 213 | `TERM`: If the linenoise library is used (almost certainly not on |
| 213 | 214 | Windows), it will check `TERM` to verify that the interactive terminal |
| 214 | 215 | is not named on a short list on terminals known to not work with |
| 215 | 216 | linenoise. Linenoise is a library that provides command history and |
| @@ -234,11 +235,11 @@ | ||
| 234 | 235 | |
| 235 | 236 | `TMP`: On Windows, the location of temporary files. The first |
| 236 | 237 | environment variable found in the environment that names an existing |
| 237 | 238 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 238 | 239 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 239 | -directory (aka `.`) is the temporary folder. | |
| 240 | +directory (aka `.`) is the temporary folder. | |
| 240 | 241 | |
| 241 | 242 | `TMPDIR`: Names the temporary file location to SQLite. |
| 242 | 243 | |
| 243 | 244 | |
| 244 | 245 | `USER`: Name of the default user account if the local or global |
| @@ -255,11 +256,11 @@ | ||
| 255 | 256 | |
| 256 | 257 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 257 | 258 | environment variable found in the environment that names an existing |
| 258 | 259 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 259 | 260 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 260 | -directory (aka `.`) is the temporary folder. | |
| 261 | +directory (aka `.`) is the temporary folder. | |
| 261 | 262 | |
| 262 | 263 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 263 | 264 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 264 | 265 | or global `editor` setting. |
| 265 | 266 | |
| @@ -310,11 +311,11 @@ | ||
| 310 | 311 | name to make the default user granted the "s" permission. |
| 311 | 312 | |
| 312 | 313 | Fossil will use the setting `default-user` if set. Normally, a local |
| 313 | 314 | setting would override a global setting, but when creating a new |
| 314 | 315 | repository it is more than a little unlikely that there is an open |
| 315 | -checkout to provide the local setting. | |
| 316 | +checkout to provide the local setting. | |
| 316 | 317 | |
| 317 | 318 | **TODO:** Any interaction caused by nesting repositories is not |
| 318 | 319 | documented, but should be. Similarly for simply having the current |
| 319 | 320 | directory inside a checkout regardless of whether the created repo |
| 320 | 321 | will be nested. |
| @@ -354,11 +355,11 @@ | ||
| 354 | 355 | ### Error logging |
| 355 | 356 | |
| 356 | 357 | If logging errors to a file, fossil will include the values of the |
| 357 | 358 | following environment variables in the error log entry if they are |
| 358 | 359 | defined: `HTTP_HOST`, `HTTP_USER_AGENT`, `PATH_INFO`, `QUERY_STRING`, |
| 359 | -`REMOTE_ADDR`, `REQUEST_METHOD`, `REQUEST_URI`, and `SCRIPT_NAME`. | |
| 360 | +`REMOTE_ADDR`, `REQUEST_METHOD`, `REQUEST_URI`, and `SCRIPT_NAME`. | |
| 360 | 361 | |
| 361 | 362 | |
| 362 | 363 | ### Home Directory |
| 363 | 364 | |
| 364 | 365 | Fossil keeps some information interesting to each user in the user's |
| @@ -366,11 +367,11 @@ | ||
| 366 | 367 | repositories and checkouts used by `fossil all`. |
| 367 | 368 | |
| 368 | 369 | The user's home directory is specified by the first environment |
| 369 | 370 | variable found in the environment from the list `FOSSIL_HOME`, |
| 370 | 371 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 371 | -`HOMEPATH` (Windows, used together), and `HOME`. | |
| 372 | +`HOMEPATH` (Windows, used together), and `HOME`. | |
| 372 | 373 | |
| 373 | 374 | SQLite has its own notion of the user's home directory, which is only |
| 374 | 375 | exposed if the interactive SQL shell is run with the "fossil |
| 375 | 376 | sqlite3" command. Being a separate library, SQLite uses many of the |
| 376 | 377 | same variables to find the home directory, but uses them in a |
| @@ -410,11 +411,11 @@ | ||
| 410 | 411 | `SystemRoot`). Since the Windows folder always exists, but in modern |
| 411 | 412 | versions of Windows is generally *not* writable by the logged in user, |
| 412 | 413 | not having `TEMP`, `TMP`, or `USERPROFILE` set is almost guaranteed to |
| 413 | 414 | cause trouble. |
| 414 | 415 | |
| 415 | -[gtp]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa364992%28v=vs.85%29.aspx | |
| 416 | +[gtp]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa364992%28v=vs.85%29.aspx | |
| 416 | 417 | |
| 417 | 418 | |
| 418 | 419 | |
| 419 | 420 | That said, it is not unusual for utilities on all platforms to assume |
| 420 | 421 | that `TEMP` or `TMP` point somewhere safe for temporary files. |
| 421 | 422 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -25,25 +25,25 @@ | |
| 25 | can override the native preferences of the platform for case sensitive |
| 26 | file names: insensitive on Windows, sensitive on Unix. There are |
| 27 | probably odd interactions possible if you mix case sensitive and case |
| 28 | insensitive file systems on any single platform. This option or the |
| 29 | global setting should be used to force the case sensitivity to the |
| 30 | most sensible condition. |
| 31 | |
| 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | any commands. |
| 34 | |
| 35 | |
| 36 | `--comfmtflags NUMBER`: Specify flags that control how check-in |
| 37 | comments and certain other text outputs are formatted for display. The |
| 38 | flags are individual bits in `NUMBER`: |
| 39 | |
| 40 | 0 no special formatting |
| 41 | 1 legacy algorithm (default) |
| 42 | 2 trim leading CR and LF |
| 43 | 4 trim leading and trailing spaces |
| 44 | 8 word break |
| 45 | 16 line break before comment |
| 46 | |
| 47 | |
| 48 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 49 | errors, and warnings. |
| @@ -50,24 +50,25 @@ | |
| 50 | |
| 51 | |
| 52 | `--help`: If `--help` is found anywhere on the command line, translate |
| 53 | the command to `fossil help cmdname` where `cmdname` is the first |
| 54 | argument that does not begin with a `-` character. If all arguments |
| 55 | start with `-`, translate to `fossil help argv[1] argv[2]...`. |
| 56 | |
| 57 | `--httptrace`: (Sets `g.fHttpTrace`.) Trace outbound HTTP requests. |
| 58 | |
| 59 | `--localtime`: Override the `timeline-utc` option to explicitly use |
| 60 | local time. |
| 61 | |
| 62 | `--nocgi`: Prevent fossil from acting as a CGI by default even if the |
| 63 | `GATEWAY_INTERFACE` environment variable is set. |
| 64 | |
| 65 | `--no-th-hook`: (Sets `g.fNoThHook`.) |
| 66 | |
| 67 | `--quiet`: (Sets `g.fQuiet`.) Cause fossil to suppress various messages and progress |
| 68 | indicators that would otherwise be printed. |
| 69 | |
| 70 | `--sqltrace`: (Sets `g.SqlTrace`.) Implies `--sqlstats`. Trace certain |
| 71 | SQLite database activity, especially showing every SQL query |
| 72 | processed. |
| 73 | |
| @@ -95,11 +96,11 @@ | |
| 95 | |
| 96 | `APPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 97 | environment variable found in the environment from the list |
| 98 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 99 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 100 | used as the location of the `~/.fossil` file. |
| 101 | |
| 102 | `EDITOR`: Name the editor to use for check-in and stash comments. |
| 103 | Overridden by the local or global `editor` setting or the `VISUAL` |
| 104 | environment variable. |
| 105 | |
| @@ -118,11 +119,11 @@ | |
| 118 | |
| 119 | `FOSSIL_HOME`: Location of the `~/.fossil` file. The first environment |
| 120 | variable found in the environment from the list `FOSSIL_HOME`, |
| 121 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 122 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 123 | location of the `~/.fossil` file. |
| 124 | |
| 125 | `FOSSIL_USER`: Name of the default user account if the local or global |
| 126 | `default-user` setting is not present. The first environment variable |
| 127 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 128 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -131,27 +132,27 @@ | |
| 131 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 132 | specific file or folder containing the version of Tcl to load at run |
| 133 | time. |
| 134 | |
| 135 | |
| 136 | `FOSSIL_VFS`: Name a VFS to load into SQLite. |
| 137 | |
| 138 | `GATEWAY_INTERFACE`: If present and the `--nocgi` option is not, assume |
| 139 | fossil is invoked from a web server as a CGI command, and act |
| 140 | accordingly. |
| 141 | |
| 142 | `HOME`: Location of the `~/.fossil` file. The first environment |
| 143 | variable found in the environment from the list `FOSSIL_HOME`, |
| 144 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 145 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 146 | location of the `~/.fossil` file. |
| 147 | |
| 148 | `HOMEDRIVE`, `HOMEPATH`: (Windows) Location of the `~/.fossil` file. |
| 149 | The first environment variable found in the environment from the list |
| 150 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 151 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 152 | used as the location of the `~/.fossil` file. |
| 153 | |
| 154 | `HTTP_HOST`: If defined, included in error log messages. |
| 155 | |
| 156 | `http_proxy`: If the global or local settings `proxy` is not set, this |
| 157 | is used as the default value for the `proxy` setting. |
| @@ -162,11 +163,11 @@ | |
| 162 | |
| 163 | `LOCALAPPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 164 | environment variable found in the environment from the list |
| 165 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 166 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 167 | used as the location of the `~/.fossil` file. |
| 168 | |
| 169 | `LOGNAME`: Name of the default user account if the local or global |
| 170 | `default-user` setting is not present. The first environment variable |
| 171 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 172 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -195,21 +196,21 @@ | |
| 195 | |
| 196 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 197 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 198 | non-local files only. |
| 199 | |
| 200 | `SQLITE_TMPDIR`: Names the temporary file location to SQLite. |
| 201 | |
| 202 | |
| 203 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 204 | fall back comment editor. |
| 205 | |
| 206 | `TEMP`: On Windows, the location of temporary files. The first |
| 207 | environment variable found in the environment that names an existing |
| 208 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 209 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 210 | directory (aka `.`) is the temporary folder. |
| 211 | |
| 212 | `TERM`: If the linenoise library is used (almost certainly not on |
| 213 | Windows), it will check `TERM` to verify that the interactive terminal |
| 214 | is not named on a short list on terminals known to not work with |
| 215 | linenoise. Linenoise is a library that provides command history and |
| @@ -234,11 +235,11 @@ | |
| 234 | |
| 235 | `TMP`: On Windows, the location of temporary files. The first |
| 236 | environment variable found in the environment that names an existing |
| 237 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 238 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 239 | directory (aka `.`) is the temporary folder. |
| 240 | |
| 241 | `TMPDIR`: Names the temporary file location to SQLite. |
| 242 | |
| 243 | |
| 244 | `USER`: Name of the default user account if the local or global |
| @@ -255,11 +256,11 @@ | |
| 255 | |
| 256 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 257 | environment variable found in the environment that names an existing |
| 258 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 259 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 260 | directory (aka `.`) is the temporary folder. |
| 261 | |
| 262 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 263 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 264 | or global `editor` setting. |
| 265 | |
| @@ -310,11 +311,11 @@ | |
| 310 | name to make the default user granted the "s" permission. |
| 311 | |
| 312 | Fossil will use the setting `default-user` if set. Normally, a local |
| 313 | setting would override a global setting, but when creating a new |
| 314 | repository it is more than a little unlikely that there is an open |
| 315 | checkout to provide the local setting. |
| 316 | |
| 317 | **TODO:** Any interaction caused by nesting repositories is not |
| 318 | documented, but should be. Similarly for simply having the current |
| 319 | directory inside a checkout regardless of whether the created repo |
| 320 | will be nested. |
| @@ -354,11 +355,11 @@ | |
| 354 | ### Error logging |
| 355 | |
| 356 | If logging errors to a file, fossil will include the values of the |
| 357 | following environment variables in the error log entry if they are |
| 358 | defined: `HTTP_HOST`, `HTTP_USER_AGENT`, `PATH_INFO`, `QUERY_STRING`, |
| 359 | `REMOTE_ADDR`, `REQUEST_METHOD`, `REQUEST_URI`, and `SCRIPT_NAME`. |
| 360 | |
| 361 | |
| 362 | ### Home Directory |
| 363 | |
| 364 | Fossil keeps some information interesting to each user in the user's |
| @@ -366,11 +367,11 @@ | |
| 366 | repositories and checkouts used by `fossil all`. |
| 367 | |
| 368 | The user's home directory is specified by the first environment |
| 369 | variable found in the environment from the list `FOSSIL_HOME`, |
| 370 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 371 | `HOMEPATH` (Windows, used together), and `HOME`. |
| 372 | |
| 373 | SQLite has its own notion of the user's home directory, which is only |
| 374 | exposed if the interactive SQL shell is run with the "fossil |
| 375 | sqlite3" command. Being a separate library, SQLite uses many of the |
| 376 | same variables to find the home directory, but uses them in a |
| @@ -410,11 +411,11 @@ | |
| 410 | `SystemRoot`). Since the Windows folder always exists, but in modern |
| 411 | versions of Windows is generally *not* writable by the logged in user, |
| 412 | not having `TEMP`, `TMP`, or `USERPROFILE` set is almost guaranteed to |
| 413 | cause trouble. |
| 414 | |
| 415 | [gtp]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa364992%28v=vs.85%29.aspx |
| 416 | |
| 417 | |
| 418 | |
| 419 | That said, it is not unusual for utilities on all platforms to assume |
| 420 | that `TEMP` or `TMP` point somewhere safe for temporary files. |
| 421 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -25,25 +25,25 @@ | |
| 25 | can override the native preferences of the platform for case sensitive |
| 26 | file names: insensitive on Windows, sensitive on Unix. There are |
| 27 | probably odd interactions possible if you mix case sensitive and case |
| 28 | insensitive file systems on any single platform. This option or the |
| 29 | global setting should be used to force the case sensitivity to the |
| 30 | most sensible condition. |
| 31 | |
| 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | any commands. |
| 34 | |
| 35 | |
| 36 | `--comfmtflags NUMBER`: Specify flags that control how check-in |
| 37 | comments and certain other text outputs are formatted for display. The |
| 38 | flags are individual bits in `NUMBER`: |
| 39 | |
| 40 | 0 no special formatting |
| 41 | 1 legacy algorithm (default) |
| 42 | 2 trim leading CR and LF |
| 43 | 4 trim leading and trailing spaces |
| 44 | 8 word break |
| 45 | 16 line break before comment |
| 46 | |
| 47 | |
| 48 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 49 | errors, and warnings. |
| @@ -50,24 +50,25 @@ | |
| 50 | |
| 51 | |
| 52 | `--help`: If `--help` is found anywhere on the command line, translate |
| 53 | the command to `fossil help cmdname` where `cmdname` is the first |
| 54 | argument that does not begin with a `-` character. If all arguments |
| 55 | start with `-`, translate to `fossil help argv[1] argv[2]...`. |
| 56 | |
| 57 | `--httptrace`: (Sets `g.fHttpTrace`.) Trace outbound HTTP requests. |
| 58 | |
| 59 | `--localtime`: Override the `timeline-utc` option to explicitly use |
| 60 | local time. |
| 61 | |
| 62 | `--nocgi`: Prevent fossil from acting as a CGI by default even if the |
| 63 | `GATEWAY_INTERFACE` environment variable is set. |
| 64 | |
| 65 | `--no-th-hook`: (Sets `g.fNoThHook`.) Override the `th1-hooks` setting |
| 66 | and prevent any TH1 hooks from being executed. |
| 67 | |
| 68 | `--quiet`: (Sets `g.fQuiet`.) Cause fossil to suppress various messages and progress |
| 69 | indicators that would otherwise be printed. |
| 70 | |
| 71 | `--sqltrace`: (Sets `g.SqlTrace`.) Implies `--sqlstats`. Trace certain |
| 72 | SQLite database activity, especially showing every SQL query |
| 73 | processed. |
| 74 | |
| @@ -95,11 +96,11 @@ | |
| 96 | |
| 97 | `APPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 98 | environment variable found in the environment from the list |
| 99 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 100 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 101 | used as the location of the `~/.fossil` file. |
| 102 | |
| 103 | `EDITOR`: Name the editor to use for check-in and stash comments. |
| 104 | Overridden by the local or global `editor` setting or the `VISUAL` |
| 105 | environment variable. |
| 106 | |
| @@ -118,11 +119,11 @@ | |
| 119 | |
| 120 | `FOSSIL_HOME`: Location of the `~/.fossil` file. The first environment |
| 121 | variable found in the environment from the list `FOSSIL_HOME`, |
| 122 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 123 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 124 | location of the `~/.fossil` file. |
| 125 | |
| 126 | `FOSSIL_USER`: Name of the default user account if the local or global |
| 127 | `default-user` setting is not present. The first environment variable |
| 128 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 129 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -131,27 +132,27 @@ | |
| 132 | `FOSSIL_TCL_PATH`: When Tcl stubs support is configured, point to a |
| 133 | specific file or folder containing the version of Tcl to load at run |
| 134 | time. |
| 135 | |
| 136 | |
| 137 | `FOSSIL_VFS`: Name a VFS to load into SQLite. |
| 138 | |
| 139 | `GATEWAY_INTERFACE`: If present and the `--nocgi` option is not, assume |
| 140 | fossil is invoked from a web server as a CGI command, and act |
| 141 | accordingly. |
| 142 | |
| 143 | `HOME`: Location of the `~/.fossil` file. The first environment |
| 144 | variable found in the environment from the list `FOSSIL_HOME`, |
| 145 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 146 | `HOMEPATH` (Windows, used together), and `HOME` is used as the |
| 147 | location of the `~/.fossil` file. |
| 148 | |
| 149 | `HOMEDRIVE`, `HOMEPATH`: (Windows) Location of the `~/.fossil` file. |
| 150 | The first environment variable found in the environment from the list |
| 151 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 152 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 153 | used as the location of the `~/.fossil` file. |
| 154 | |
| 155 | `HTTP_HOST`: If defined, included in error log messages. |
| 156 | |
| 157 | `http_proxy`: If the global or local settings `proxy` is not set, this |
| 158 | is used as the default value for the `proxy` setting. |
| @@ -162,11 +163,11 @@ | |
| 163 | |
| 164 | `LOCALAPPDATA`: (Windows) Location of the `~/.fossil` file. The first |
| 165 | environment variable found in the environment from the list |
| 166 | `FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows), |
| 167 | `HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is |
| 168 | used as the location of the `~/.fossil` file. |
| 169 | |
| 170 | `LOGNAME`: Name of the default user account if the local or global |
| 171 | `default-user` setting is not present. The first environment variable |
| 172 | found in the environment from the list `FOSSIL_USER`, `USERNAME` |
| 173 | (Windows), `USER`, and `LOGNAME` is the user name. If none of those |
| @@ -195,21 +196,21 @@ | |
| 196 | |
| 197 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 198 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 199 | non-local files only. |
| 200 | |
| 201 | `SQLITE_TMPDIR`: Names the temporary file location to SQLite. |
| 202 | |
| 203 | |
| 204 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 205 | fall back comment editor. |
| 206 | |
| 207 | `TEMP`: On Windows, the location of temporary files. The first |
| 208 | environment variable found in the environment that names an existing |
| 209 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 210 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 211 | directory (aka `.`) is the temporary folder. |
| 212 | |
| 213 | `TERM`: If the linenoise library is used (almost certainly not on |
| 214 | Windows), it will check `TERM` to verify that the interactive terminal |
| 215 | is not named on a short list on terminals known to not work with |
| 216 | linenoise. Linenoise is a library that provides command history and |
| @@ -234,11 +235,11 @@ | |
| 235 | |
| 236 | `TMP`: On Windows, the location of temporary files. The first |
| 237 | environment variable found in the environment that names an existing |
| 238 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 239 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 240 | directory (aka `.`) is the temporary folder. |
| 241 | |
| 242 | `TMPDIR`: Names the temporary file location to SQLite. |
| 243 | |
| 244 | |
| 245 | `USER`: Name of the default user account if the local or global |
| @@ -255,11 +256,11 @@ | |
| 256 | |
| 257 | `USERPROFILE`: On Windows, the location of temporary files. The first |
| 258 | environment variable found in the environment that names an existing |
| 259 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 260 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 261 | directory (aka `.`) is the temporary folder. |
| 262 | |
| 263 | `VISUAL`: Name the editor to use for check-in and stash comments. |
| 264 | Overrides the `EDITOR` environment variable. Overridden by the local |
| 265 | or global `editor` setting. |
| 266 | |
| @@ -310,11 +311,11 @@ | |
| 311 | name to make the default user granted the "s" permission. |
| 312 | |
| 313 | Fossil will use the setting `default-user` if set. Normally, a local |
| 314 | setting would override a global setting, but when creating a new |
| 315 | repository it is more than a little unlikely that there is an open |
| 316 | checkout to provide the local setting. |
| 317 | |
| 318 | **TODO:** Any interaction caused by nesting repositories is not |
| 319 | documented, but should be. Similarly for simply having the current |
| 320 | directory inside a checkout regardless of whether the created repo |
| 321 | will be nested. |
| @@ -354,11 +355,11 @@ | |
| 355 | ### Error logging |
| 356 | |
| 357 | If logging errors to a file, fossil will include the values of the |
| 358 | following environment variables in the error log entry if they are |
| 359 | defined: `HTTP_HOST`, `HTTP_USER_AGENT`, `PATH_INFO`, `QUERY_STRING`, |
| 360 | `REMOTE_ADDR`, `REQUEST_METHOD`, `REQUEST_URI`, and `SCRIPT_NAME`. |
| 361 | |
| 362 | |
| 363 | ### Home Directory |
| 364 | |
| 365 | Fossil keeps some information interesting to each user in the user's |
| @@ -366,11 +367,11 @@ | |
| 367 | repositories and checkouts used by `fossil all`. |
| 368 | |
| 369 | The user's home directory is specified by the first environment |
| 370 | variable found in the environment from the list `FOSSIL_HOME`, |
| 371 | `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and |
| 372 | `HOMEPATH` (Windows, used together), and `HOME`. |
| 373 | |
| 374 | SQLite has its own notion of the user's home directory, which is only |
| 375 | exposed if the interactive SQL shell is run with the "fossil |
| 376 | sqlite3" command. Being a separate library, SQLite uses many of the |
| 377 | same variables to find the home directory, but uses them in a |
| @@ -410,11 +411,11 @@ | |
| 411 | `SystemRoot`). Since the Windows folder always exists, but in modern |
| 412 | versions of Windows is generally *not* writable by the logged in user, |
| 413 | not having `TEMP`, `TMP`, or `USERPROFILE` set is almost guaranteed to |
| 414 | cause trouble. |
| 415 | |
| 416 | [gtp]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa364992%28v=vs.85%29.aspx |
| 417 | |
| 418 | |
| 419 | |
| 420 | That said, it is not unusual for utilities on all platforms to assume |
| 421 | that `TEMP` or `TMP` point somewhere safe for temporary files. |
| 422 |