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