1 .\" Copyright (c) 1995 Alex Tatmanjants <alex@elvisti.kiev.ua>
2 .\" at Electronni Visti IA, Kiev, Ukraine.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: src/usr.bin/colldef/colldef.1,v 1.8.2.6 2003/02/24 23:04:38 trhodes Exp $
33 .Nd convert collation sequence source definition
42 utility converts a collation sequence source definition
43 into a format usable by the
48 It is used to define the many ways in which
49 strings can be ordered and collated.
52 its first argument and places the result in its second
54 The transformed string is such that it can be
55 correctly ordered with other transformed strings by using
61 transforms its arguments and does a
66 utility reads the collation sequence source definition
67 from the standard input and stores the converted definition in filename.
68 The output file produced contains the
69 database with collating sequence information in a form
70 usable by system commands and routines.
75 This option set directory name where
77 files can be found, current directory by default.
79 This option set output file name,
84 The collation sequence definition specifies a set of collating elements and
85 the rules defining how strings containing these should be ordered.
86 This is most useful for different language definitions.
88 The specification file can consist of three statements:
96 statement is required.
102 supplied, these statements must be ordered as above.
104 statements after the order statement are ignored.
106 Lines in the specification file beginning with a
109 treated as comments and are ignored.
113 .Ar charmap charmapfile
116 defines where a mapping of the character
117 and collating element symbols to the actual
118 character encoding can be found.
124 names are separated from their values by TAB or
125 SPACE characters. symbol-value can be specified in
126 a hexadecimal (\ex\fI??\fR) or octal (\e\fI???\fR)
127 representation, and can be only one character in length.
129 .Ar symbol-name1 symbol-value1
130 .Ar symbol-name2 symbol-value2
136 statement is optional.
145 statement substitutes the character
149 Symbol names cannot be specified in
154 statement is optional.
159 is a list of symbols, separated by semi colons, that defines the
164 specifies, in a short-hand
165 form, symbols that are sequential in machine code
168 An order list element
169 can be represented in any one of the following
173 The symbol itself (for example,
175 for the lower-case letter
178 The symbol in octal representation (for example,
183 The symbol in hexadecimal representation (for example,
188 The symbol name as defined in the
196 If character map name have
198 character, it must be escaped as
212 are permitted in its usual C-language meaning
214 The symbol chain (for example:
216 .Ar <letterA><letterB>c ,
219 The symbol range (for example,
222 Comma-separated symbols, ranges and chains enclosed in parenthesis (for example
229 same primary ordering but different secondary
232 Comma-separated symbols, ranges and chains enclosed in curly brackets (for example
238 are assigned the same primary ordering only.
241 The backslash character
243 is used for continuation.
244 In this case, no characters are permitted
245 after the backslash character.
249 utility exits with the following values:
250 .Bl -tag -width indent
252 No errors were found and the output was successfully created.
257 .Bl -tag -width ".Pa /usr/share/locale/<language>/LC_COLLATE" -compact
258 .It Pa /usr/share/locale/<language>/LC_COLLATE
259 standard shared location for collation orders
260 under the locale locale