1 .\" $OpenBSD: gencat.1,v 1.3 1997/06/11 15:39:54 kstailey Exp $
3 .\" Copyright (c) 1997 Ken Stailey
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.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\" derived from this software without specific prior written permission
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\" $FreeBSD: head/usr.bin/gencat/gencat.1 213573 2010-10-08 12:40:16Z uqs $
34 .Nd NLS catalog compiler
42 utility merges the text NLS input files
44 into a formatted message catalog file
48 will be created if it does not already exist.
51 does exist, its messages will be included in the new
53 If set and message numbers collide, the new message text defined in
55 will replace the old message text currently contained in
58 The format of a message text source file is defined below.
60 the fields of a message text source line are separated by a single space
61 character: any other space characters are considered to be part of the
64 .It Li $set Ar n comment
65 This line specifies the set identifier of the following messages until
68 or end-of-file appears.
71 is the set identifier which is defined as a number in the range
73 Set identifiers must occur in ascending order within
74 a single source file, but need not be contiguous.
76 a space following the set identifier is treated as a comment.
79 directive is specified in a given source file, all messages will
80 be located in the default message set NL_SETD.
81 .It Li $del Ar n comment
82 This line deletes messages from set
84 from a message catalog.
87 specifies a set number.
88 Any string following a space following the set
89 number is treated as a comment.
93 followed by a space is treated as a comment.
95 A message line consists of a message identifier
97 in the range [1, (NL_MSGMAX)].
100 is stored in the message catalog with the set identifier specified by
103 directive, and the message identifier
107 is empty, and there is a space character following the message identifier,
108 an empty string is stored in the message catalog.
111 is empty, and if there is no space character following the message
112 identifier, then the existing message in the current set with the
113 specified message identifier is deleted from the catalog.
115 identifiers must be in ascending order within a single set, but
116 need not be contiguous.
119 length must be in the range [0, (NL_TEXTMAX)].
121 This line specifies an optional quote character
123 which can be used to surround
125 so that trailing space or empty messages are visible in message
127 By default, or if an empty
129 directive is specified, no quoting of
134 Empty lines in message source files are ignored.
136 beginning with any character other than those described above is
139 Text strings can contain the following special characters and escape
141 In addition, if a quote character is defined, it may be
142 escaped as well to embed a literal quote character.
144 .Bl -tag -width "\eooo" -offset indent -compact
160 octal number in the range [000, 377]
163 A backslash character immediately before the end of the line in a file
164 is used to continue the line onto the next line, e.g.:
166 .Dl 1 This line is continued \e
169 If the character following the backslash is not one of those specified,
170 the backslash is ignored.
180 utility is compliant with the
185 This manual page was originally written by
190 A message catalog file created from a blank input file cannot be revised;
191 it must be deleted and recreated.