]> matita.cs.unibo.it Git - helm.git/blob - matita/matita.conf.xml.in
tagging rc-1
[helm.git] / matita / matita.conf.xml.in
1 <?xml version="1.0" encoding="utf-8"?>
2 <helm_registry>
3   <section name="user">
4     <!-- User home directory. Here a ".matita" directory will be created
5     and used to store the part of the library developed by the user. -->
6     <key name="home">$(HOME)</key>
7     <!-- User name. It is used down in this configuration file.  If left
8     unspecified, name of the user executing matita will be used (as per
9     getent) -->
10     <key name="name">$(USER)</key>
11   </section>
12   <section name="matita">
13     <!-- Debug only. Stay away. -->
14     <!-- <key name="auto_disambiguation">true</key> -->
15     <!-- Debug only. Stay away. -->
16     <!-- <key name="environment_trust">true</key> -->
17     <key name="basedir">$(user.home)/.matita</key>
18     <!-- Where support files are installed -->
19     <key name="rt_base_dir">@RT_BASE_DIR@</key>
20     <!-- Metadata owner. It will be used to create user-specific tables
21     in the SQL database. -->
22     <key name="owner">$(user.name)</key>
23     <!-- Initial GUI font size. -->
24     <!-- <key name="font_size">10</key> -->
25   </section>
26   <section name="db">
27     <!-- 
28     Every metadata key must have the following fields:
29       1) dbhost: a file:// or a mysql:// path
30       2) database name: use extension .db for file:// dbs
31       3) username
32       4) password: use 'none' for no password
33       5) dbtype: one of the following
34            'legacy' 
35               are read only dbs, used for the Coq/contribs stuff
36            'library' 
37               is the standard library, becames writable in publish (-system)
38               mode
39            'user' 
40               is the user own db (can be the same of marked as ro, tables
41               have different names and can coexist)
42
43     Note that:
44       exactly one 'user'    db must be specified
45       exactly one 'library' db must be specified
46       exactly one 'legacy'  db can  be specified
47     -->
48
49     <!-- The following snippet is used by the helm team
50          note that user's tables are named diffrently from library tables,
51          so they can coexists on the same db -->
52
53     <key name="metadata">@DBHOST@ matita helm none legacy</key>
54     <key name="metadata">@DBHOST@ public helm none library</key>
55     <key name="metadata">@DBHOST@ matita helm none user</key>
56
57     <!-- The following snippet it what you want to use a local sqlite db
58          and acess remotely to the coq library trought mowgli
59     <key name="metadata">@DBHOST@ matita helm none legacy</key>
60     <key name="metadata">file://$(matita.rt_base_dir) metadata.db helm helm library</key>
61     <key name="metadata">file://$(matita.basedir) user.db helm helm user</key>
62     -->
63
64     <!-- 
65     If you have a large amount of metadata, you may be interested in using
66     MySql instead of Sqlite. The simplest way to create a MySql database is:
67       0) # become an user with database administration privileges
68       1) mysqladmin create matita
69       2) echo "grant all privileges on matita.* to helm;" | mysql matita
70       Note that this way the database will be open to anyone, apply
71       stricter permissions if needed.
72     -->
73   </section>
74   <section name="getter">
75     <!-- Cache dir for CIC XML documents downloaded from the net.
76     Beware that this dir may become really space-consuming. It wont be
77     used if all prefexises below are local (i.e. "file:///" URI scheme).
78     -->
79     <key name="cache_dir">$(user.home)/.matita/getter/cache</key>
80     <!-- "Prefixes", i.e.: mappings URI -> URL of the global library
81     Each prefix mapps an URI of the cic:/ namespace to an URL where the
82     documents can actually be accessed. URL can be in the "file://" or
83     "http://" scheme. Only "file://" scheme can be used to store
84     documents created by the user.
85     Each prefix may be given a list of attributes. Currently supported
86     attributes are:
87     - "legacy" for parts of the library not generated by Matita (e.g.
88       exported from Coq)
89     - "ro" for parts of the library which are not writable by the user
90       (e.g. the Matita standard library)
91     "legacy" implies "ro"
92     -->
93     <key name="prefix">
94       cic:/matita/
95       file:///projects/helm/library/matita_contribs/matita
96       ro
97     </key>
98     <key name="prefix">
99       cic:/matita/
100       file://$(matita.rt_base_dir)/xml/standard-library/
101       ro
102     </key>
103     <key name="prefix">
104       cic:/matita/
105       file://$(user.home)/.matita/xml/matita/
106     </key>
107     <key name="prefix">
108       cic:/
109       file://@RT_BASE_DIR@/xml/legacy-library/coq/
110       legacy
111     </key>
112     <key name="prefix">
113       cic:/
114       file:///projects/helm/library/coq_contribs/
115       legacy
116     </key>
117     <key name="prefix">
118       cic:/
119       http://mowgli.cs.unibo.it/xml/
120       legacy
121     </key>
122   </section>
123 </helm_registry>