]> matita.cs.unibo.it Git - helm.git/blob - matita/matita/matita.conf.xml.in
matita.basedir used consistently
[helm.git] / matita / 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     <!--  Perform heavy checks when run interactively (like duplicate check) -->
26     <!-- <key name="do_heavy_checks">false</key> -->
27   </section>
28   <section name="db">
29     <!-- 
30     Every metadata key must have the following fields:
31       1) dbhost: a file:// or a mysql:// path
32       2) database name: use extension .db for file:// dbs
33       3) username
34       4) password: use 'none' for no password
35       5) dbtype: one of the following
36            'legacy' 
37               are read only dbs, used for the Coq/contribs stuff
38            'library' 
39               is the standard library, becames writable in publish (-system)
40               mode
41            'user' 
42               is the user own db (can be the same of marked as ro, tables
43               have different names and can coexist)
44
45     Note that:
46       exactly one 'user'    db must be specified
47       exactly one 'library' db can be specified
48       exactly one 'legacy'  db can  be specified
49     -->
50
51     <!-- The following snippet is used by the helm team
52          note that user's tables are named diffrently from library tables,
53          so they can coexists on the same db -->
54
55     <key name="metadata">@DBHOST@ matita helm none library</key>
56     <key name="metadata">@DBHOST@ matita helm none user</key>
57
58     <!-- The following snippet it what you want to use a local sqlite db
59          and acess remotely to the coq library trought mowgli
60     <key name="metadata">@DBHOST@ matita helm none legacy</key>
61     <key name="metadata">file://$(matita.rt_base_dir) metadata.db helm helm library</key>
62     <key name="metadata">file://$(matita.basedir) user.db helm helm user</key>
63     -->
64
65     <!-- 
66     If you have a large amount of metadata, you may be interested in using
67     MySql instead of Sqlite. The simplest way to create a MySql database is:
68       0) # become an user with database administration privileges
69       1) mysqladmin create matita
70       2) echo "grant all privileges on matita.* to helm;" | mysql matita
71       Note that this way the database will be open to anyone, apply
72       stricter permissions if needed.
73     -->
74   </section>
75   <section name="getter">
76     <!-- Cache dir for CIC XML documents downloaded from the net.
77     Beware that this dir may become really space-consuming. It wont be
78     used if all prefexises below are local (i.e. "file:///" URI scheme).
79     -->
80     <key name="cache_dir">$(matita.basedir)/getter/cache</key>
81     <!-- "Prefixes", i.e.: mappings URI -> URL of the global library
82     Each prefix mapps an URI of the cic:/ namespace to an URL where the
83     documents can actually be accessed. URL can be in the "file://" or
84     "http://" scheme. Only "file://" scheme can be used to store
85     documents created by the user.
86     Each prefix may be given a list of attributes. Currently supported
87     attributes are:
88     - "legacy" for parts of the library not generated by Matita (e.g.
89       exported from Coq)
90     - "ro" for parts of the library which are not writable by the user
91       (e.g. the Matita standard library)
92     "legacy" implies "ro"
93     -->
94     <key name="prefix">
95       cic:/matita/
96       file://$(matita.rt_base_dir)/xml/standard-library/
97       ro
98     </key>
99     <key name="prefix">
100       cic:/matita/
101       file://$(matita.basedir)/xml/matita/
102     </key>
103     <key name="prefix">
104       cic:/
105       file://@RT_BASE_DIR@/xml/legacy-library/coq/
106       legacy
107     </key>
108     <key name="prefix">
109       cic:/
110       file:///projects/helm/library/coq_contribs/
111       legacy
112     </key>
113     <key name="prefix">
114       cic:/
115       http://mowgli.cs.unibo.it/xml/
116       legacy
117     </key>
118   </section>
119 </helm_registry>