@@ -112,17 +112,21 @@
112 112 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
113 113 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
114 114 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
Environment Variables
115 115 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
---------------------
116 116 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
117 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- On most platforms, the location of the user’s account-wide `.fossil`
117 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ On most platforms, the location of the user’s account-wide
118 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ [configuration database][configdb]
118 119 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
file is either `FOSSIL_HOME`, `XDG_CONFIG_HOME`, or `HOME`, in that order.
119 120 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
This ordering lets you put this file somewhere other than at the top
120 121 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
of your user’s home directory by defining `FOSSIL_HOME` to mask
121 122 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
the always-defined `HOME`. The `XDG_CONFIG_HOME` setting is defined
122 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- by some desktop environments to be the preferred "modern" directory
123 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- in which to store configuration files.
123 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ by some desktop environments as an alternative location for
124 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ configuration files. If the `XDG_CONFIG_HOME` location is used, then
125 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ the name of the configuration database is `fossil.db` instead of
126 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ `.fossil`. See the [configuration database location][configloc] discussion
127 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ for additional information.
124 128 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
125 129 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
For native Windows builds and for Cygwin builds, the file is called
126 130 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`_fossil` instead of `.fossil` to avoid problems with old programs that
127 131 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
assume file names cannot begin with a dot, as was true in old versions
128 132 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
of Windows and in MS-DOS. (Newer Microsoft OSes and file systems don’t have a
@@ -151,17 +155,13 @@
151 155 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
local interactive user via the command line). This can be useful for
152 156 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
local (or remote) testing of the moderation subsystem and its impact
153 157 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
on the contents and status of wiki pages.
154 158 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
155 159 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
156 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `FOSSIL_HOME`: Location of the `~/.fossil` file. The first environment
157 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- variable found in the environment from the list `FOSSIL_HOME`,
158 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and
159 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `HOMEPATH` (Windows, used together), `XDG_CONFIG_HOME` (unix) and
160 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `HOME` is used as the
161 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- location of the `~/.fossil` file.
162 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
-
160 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ `FOSSIL_HOME`: Location of [configuration database][configdb].
161 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ See the [configuration database location][configloc] description
162 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ for additional information.
163 163 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
164 164 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`FOSSIL_USE_SEE_TEXTKEY`: If set, treat the encryption key string for
165 165 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
SEE as text to be hashed into the actual encryption key. This has no
166 166 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
effect if Fossil was not compiled with SEE support enabled.
167 167 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
@@ -198,15 +198,12 @@
198 198 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
199 199 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`GATEWAY_INTERFACE`: If present and the `--nocgi` option is not, assume
200 200 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
fossil is invoked from a web server as a CGI command, and act
201 201 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
accordingly.
202 202 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
203 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `HOME`: Location of the `~/.fossil` file. The first environment
204 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- variable found in the environment from the list `FOSSIL_HOME`,
205 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and
206 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `HOMEPATH` (Windows, used together), `XDG_CONFIG_HOME` (unix)
207 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- and `HOME` is used as the location of the `~/.fossil` file.
203 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ `HOME`: Potential location of the [configuration database][configdb].
204 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ See the [configuration database location][configloc] description for details.
208 205 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
209 206 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`HOMEDRIVE`, `HOMEPATH`: (Windows) Location of the `~/.fossil` file.
210 207 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
The first environment variable found in the environment from the list
211 208 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`FOSSIL_HOME`, `LOCALAPPDATA` (Windows), `APPDATA` (Windows),
212 209 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
`HOMEDRIVE` and `HOMEPATH` (Windows, used together), and `HOME` is
@@ -407,26 +404,43 @@
407 404 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
none of those are set, then the default user name is "root".
408 405 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
409 406 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
410 407 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
### Configuration Directory (often the Home Directory)
411 408 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
412 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- Fossil keeps some information interesting to each user in the user's
413 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- configuration file directory. This includes the global settings and the list of
414 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- repositories and checkouts used by `fossil all`. On many,
415 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- but not all, systems the configuration file directory is the home directory
416 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
-
417 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- The user's configuration file directory is specified by the first environment
418 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- variable found in the environment from the list `FOSSIL_HOME`,
419 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `LOCALAPPDATA` (Windows), `APPDATA` (Windows), `HOMEDRIVE` and
420 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `HOMEPATH` (Windows, used together), `XDG_CONFIG_HOME` (unix), and `HOME`.
421 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
-
422 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- SQLite has its own notion of the user's configuration file directory,
423 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- which is only exposed if the interactive SQL shell is run with the "fossil
424 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- sqlite3" command. Being a separate library, SQLite uses many of the
425 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- same variables to find the home directory, but uses them in a
426 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- different order, and does not use the `FOSSIL_HOME` nor
427 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
- `XDG_CONFIG_HOME` variables.
409 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ Fossil keeps some information pertinent to each user in the user's
410 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ [configuration database file][configdb].
411 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ The configuration database file includes the global settings
412 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ and the list of repositories and checkouts used by `fossil all`.
413 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
414 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ On Unix systems, the configuration database is called by one of the
415 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ following names (in order):
416 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
417 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `$FOSSIL_HOME/.fossil`
418 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `$XDG_CONFIG_HOME/fossil.db`
419 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `$HOME/.fossil`
420 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
421 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ The name used is the first in the above list for which the corresponding
422 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ environment varible is defined. On most systems, the third name is the
423 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ one that is used.
424 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
425 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ On Windows, the configuration database is called one of these (in order)
426 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
427 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `%FOSSIL_HOME%/_fossil`
428 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `%LOCALAPPDATA%/_fossil`
429 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `%APPDATA%/_fossil`
430 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `%USERPROFILES%/_fossil`
431 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ * `%HOMEDRIVE%%HOMEPATH%/_fossil`
432 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
433 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ As before, the first case in when the corresponding environment variables
434 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ exist is the one used. This is ususally the second case. Note that the
435 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ `FOSSIL_HOME` environment variable can always be set to determine the
436 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ location of the configuration database. Note also that the configuration
437 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ database file itself is called `.fossil` or `fossil.db` on unix but
438 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ `_fossil` on windows.
439 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
440 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ You can run the "[fossil info](/help?cmd=info)" command from an open
441 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ check-out to see the location of the configuration database.
428 442 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
429 443 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
430 444 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
### SQLite VFS to use
431 445 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
432 446 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
See [the SQLite documentation](http://www.sqlite.org/vfs.html) for an
@@ -495,5 +509,8 @@
495 509 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
On Apple platforms, it assumes that `open` is the command to open an
496 510 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
URL in the user's configured default browser.
497 511 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
498 512 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
On Windows platforms, it assumes that `start` is the command to open
499 513 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
an URL in the user's configured default browser.
514 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+
515 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ [configdb]: ./tech_overview.wiki#configdb
516 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!
+ [configloc]: ./tech_overview.wiki#configloc
500 517 { copied = false; pop = false }, 1000)" :class="copied && 'copied'">Copy link Copied!