|
9a0c995…
|
drh
|
1 |
<title>Fossil Settings</title> |
|
9a0c995…
|
drh
|
2 |
|
|
eec84c1…
|
drh
|
3 |
<h1>Using Fossil Settings</h1> |
|
abe1030…
|
drh
|
4 |
|
|
abe1030…
|
drh
|
5 |
Settings control the behaviour of fossil. They are set with the |
|
abe1030…
|
drh
|
6 |
<tt>fossil settings</tt> command, or through the web interface in |
|
abe1030…
|
drh
|
7 |
the Settings page in the Admin section. |
|
abe1030…
|
drh
|
8 |
|
|
f47b705…
|
jan.nijtmans
|
9 |
For a list of all settings, view the Settings page, or type |
|
abe1030…
|
drh
|
10 |
<tt>fossil help settings</tt> from the command line. |
|
abe1030…
|
drh
|
11 |
|
|
abe1030…
|
drh
|
12 |
|
|
eec84c1…
|
drh
|
13 |
<h2 id="repo">1.0 Repository settings</h2> |
|
abe1030…
|
drh
|
14 |
|
|
abe1030…
|
drh
|
15 |
Settings are set on a per-repository basis. When you clone a repository, |
|
abe1030…
|
drh
|
16 |
a subset of settings are copied to your local repository. |
|
abe1030…
|
drh
|
17 |
|
|
abe1030…
|
drh
|
18 |
If you make a change to a setting on your local repository, it is not |
|
abe1030…
|
drh
|
19 |
synced back to the server when you <tt>push</tt> or <tt>sync</tt>. If |
|
abe1030…
|
drh
|
20 |
you make a change on the server, you need to manually make the change on |
|
f47b705…
|
jan.nijtmans
|
21 |
all repositories which are cloned from this repository. |
|
abe1030…
|
drh
|
22 |
|
|
abe1030…
|
drh
|
23 |
You can also set a setting globally on your local machine. The value |
|
abe1030…
|
drh
|
24 |
will be used for all repositories cloned to your machine, unless |
|
abe1030…
|
drh
|
25 |
overridden explicitly in a particular repository. Global settings can be |
|
abe1030…
|
drh
|
26 |
set by using the <tt>-global</tt> option on the <tt>fossil settings</tt> |
|
f47b705…
|
jan.nijtmans
|
27 |
command. |
|
abe1030…
|
drh
|
28 |
|
|
eec84c1…
|
drh
|
29 |
<h2 id="versionable">2.0 "Versionable" settings</h2> |
|
abe1030…
|
drh
|
30 |
|
|
abe1030…
|
drh
|
31 |
Most of the settings control the behaviour of fossil on your local |
|
abe1030…
|
drh
|
32 |
machine, largely acting to reflect your preference on how you want to |
|
abe1030…
|
drh
|
33 |
use Fossil, how you communicate with the server, or options for hosting |
|
abe1030…
|
drh
|
34 |
a repository on the web. |
|
abe1030…
|
drh
|
35 |
|
|
abe1030…
|
drh
|
36 |
However, for historical reasons, some settings affect how you work with |
|
0f9224e…
|
danield
|
37 |
versioned files. These are <tt>clean-glob</tt>, <tt>binary-glob</tt>, |
|
0f9224e…
|
danield
|
38 |
<tt>crlf-glob</tt> (and its alias <tt>crnl-glob</tt>), <tt>empty-dirs</tt>, |
|
0f9224e…
|
danield
|
39 |
<tt>encoding-glob</tt>, <tt>ignore-glob</tt>, <tt>keep-glob</tt>, |
|
e8dc1df…
|
drh
|
40 |
<tt>manifest</tt>, and <tt>mimetypes</tt>. The most important is |
|
87320cf…
|
andygoth
|
41 |
<tt>ignore-glob</tt> which specifies which files should be ignored when |
|
87320cf…
|
andygoth
|
42 |
looking for unmanaged files with the <tt>extras</tt> command. |
|
abe1030…
|
drh
|
43 |
|
|
abe1030…
|
drh
|
44 |
Because these options can change over time, and the inconvenience of |
|
abe1030…
|
drh
|
45 |
replicating changes, these settings are "versionable". As well as being |
|
abe1030…
|
drh
|
46 |
able to be set using the <tt>settings</tt> command or the web interface, |
|
c510b74…
|
michai
|
47 |
you can create versioned files in the <tt>.fossil-settings</tt> |
|
c510b74…
|
michai
|
48 |
subdirectory of the check-out root, named with the setting name. |
|
af1456b…
|
drh
|
49 |
Each file holds the value of a setting, and these files are checked in, |
|
af1456b…
|
drh
|
50 |
committed, merged, and so on, as with any other file. |
|
abe1030…
|
drh
|
51 |
|
|
abe1030…
|
drh
|
52 |
Where a setting is a list of values, such as <tt>ignore-glob</tt>, you |
|
abe1030…
|
drh
|
53 |
can use a newline as a separator as well as a comma. |
|
abe1030…
|
drh
|
54 |
|
|
abe1030…
|
drh
|
55 |
For example, to set the list of ignored files, create a |
|
abe1030…
|
drh
|
56 |
<tt>.fossil-settings/ignore-glob</tt> file where each line contains a |
|
abe1030…
|
drh
|
57 |
glob for ignored files. |
|
abe1030…
|
drh
|
58 |
|
|
abe1030…
|
drh
|
59 |
If you set the value of a setting using the <tt>settings</tt> command as |
|
abe1030…
|
drh
|
60 |
well as a versioned file, the versioned setting will take precedence. A |
|
abe1030…
|
drh
|
61 |
warning will be displayed. |