Update FSF postal address.
[m17n/m17n-db.git] / FORMATS / Dir.txt
1 /* Copyright (C) 2003, 2004, 2005
2      National Institute of Advanced Industrial Science and Technology (AIST)
3      Registration Number H15PRO112
4    See the end for copying conditions.  */
5
6 /***en
7
8 @page mdbDir List of data in a database directory.
9
10 @section dir-description DESCRIPTION
11
12 The m17n library loads a list of definitions of data of the m17n
13 database from files of name "mdb.dir" in each database directory at
14 initialization time.  The plist format of this file is as follows:
15
16 @verbatim
17 MDB-DIR ::= DEFINITION *
18
19 DEFINITION ::= '(' TAG0 [ TAG1 [ TAG2 [ TAG3 ] ] ] FILE ')'
20
21 TAGn ::= SYMBOL
22
23 FILE ::= MTEXT
24 @endverbatim
25
26 If TAG0 is neither `charset' nor `char-table', and TAGn (n > 0) is a
27 symbol `*', FILE can contain a wildcard charater, and all files
28 matching FILE accoding to the rules used by the shell are the target
29 of database files.  In that case, each file must contain a plist
30 element providing the actual TAGn values by the form:
31
32 @verbatim
33 '(' TAG0 TAG1 TAG2 TAG3 ')'
34 @endverbatim
35
36 For instance, if a database directory contains these files:
37
38 @verbatim
39 zh-py.mim:
40 (input-method zh py)
41 ...
42
43 ko-han2.mim:
44 (input-method ko han2)
45 ...
46 @endverbatim
47
48 these lines in "mdb.dir":
49
50 @verbatim
51 (input-method zh py "zh-py.mim")
52 (input-method ko han2 "ko-han2.mim")
53 @endverbatim
54
55 can be shortened to this single line:
56
57 @verbatim
58 (input-method * "*.mim")
59 @endverbatim
60
61 */
62
63 /* 
64 Copyright (C) 2003, 2004, 2005
65   National Institute of Advanced Industrial Science and Technology (AIST)
66   Registration Number H15PRO112
67
68 This file is part of the m17n database; a sub-part of the m17n
69 library.
70
71 The m17n library is free software; you can redistribute it and/or
72 modify it under the terms of the GNU Lesser General Public License
73 as published by the Free Software Foundation; either version 2.1 of
74 the License, or (at your option) any later version.
75
76 The m17n library is distributed in the hope that it will be useful,
77 but WITHOUT ANY WARRANTY; without even the implied warranty of
78 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
79 Lesser General Public License for more details.
80
81 You should have received a copy of the GNU Lesser General Public
82 License along with the m17n library; if not, write to the Free
83 Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
84 Boston, MA 02110-1301, USA.
85 */