1.\" $OpenBSD: gencat.1,v 1.3 1997/06/11 15:39:54 kstailey Exp $ 2.\" 3.\" Copyright (c) 1997 Ken Stailey 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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 15.\" 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. 26.\" 27.\" $FreeBSD$ 28.\" 29.Dd June 11, 1997 30.Dt GENCAT 1 31.Os 32.Sh NAME 33.Nm gencat 34.Nd NLS catalog compiler 35.Sh SYNOPSIS 36.Nm 37.Ar "output-file" 38.Ar "input-files..." 39.Sh DESCRIPTION 40The 41.Nm 42utility merges the text NLS input files 43.Ar "input-files..." 44into a formatted message catalog file 45.Ar "output-file" . 46The file 47.Ar "output-file" 48will be created if it does not already exist. 49If 50.Ar "output-file" 51does exist, its messages will be included in the new 52.Ar "output-file" . 53If set and message numbers collide, the new message text defined in 54.Ar "input-files..." 55will replace the old message text currently contained in 56.Ar "output-file" . 57.Sh INPUT FILES 58The format of a message text source file is defined below. 59Note that 60the fields of a message text source line are separated by a single space 61character: any other space characters are considered to be part of the 62field contents. 63.Bl -tag -width 3n 64.It Li $set Ar n comment 65This line specifies the set identifier of the following messages until 66the next 67.Li $set 68or end-of-file appears. 69The argument 70.Ar n 71is the set identifier which is defined as a number in the range 72[1, (NL_SETMAX)]. 73Set identifiers must occur in ascending order within 74a single source file, but need not be contiguous. 75Any string following 76a space following the set identifier is treated as a comment. 77If no 78.Li $set 79directive is specified in a given source file, all messages will 80be located in the default message set NL_SETD. 81.It Li $del Ar n comment 82This line deletes messages from set 83.Ar n 84from a message catalog. 85The 86.Ar n 87specifies a set number. 88Any string following a space following the set 89number is treated as a comment. 90.It Li $ Ar comment 91A line beginning with 92.Li $ 93followed by a space is treated as a comment. 94.It Ar m message-text 95A message line consists of a message identifier 96.Ar m 97in the range [1, (NL_MSGMAX)]. 98The 99.Ar message-text 100is stored in the message catalog with the set identifier specified by 101the last 102.Li $set 103directive, and the message identifier 104.Ar m . 105If the 106.Ar message-text 107is empty, and there is a space character following the message identifier, 108an empty string is stored in the message catalog. 109If the 110.Ar message-text 111is empty, and if there is no space character following the message 112identifier, then the existing message in the current set with the 113specified message identifier is deleted from the catalog. 114Message 115identifiers must be in ascending order within a single set, but 116need not be contiguous. 117The 118.Ar message-text 119length must be in the range [0, (NL_TEXTMAX)]. 120.It Li $quote Ar c 121This line specifies an optional quote character 122.Ar c 123which can be used to surround 124.Ar message-text 125so that trailing space or empty messages are visible in message 126source files. 127By default, or if an empty 128.Li $quote 129directive is specified, no quoting of 130.Ar message-text 131will be recognized. 132.El 133.Pp 134Empty lines in message source files are ignored. 135The effect of lines 136beginning with any character other than those described above is 137undefined. 138.Pp 139Text strings can contain the following special characters and escape 140sequences. 141In addition, if a quote character is defined, it may be 142escaped as well to embed a literal quote character. 143.Pp 144.Bl -tag -width "\eooo" -offset indent -compact 145.It Li \en 146line feed 147.It Li \et 148horizontal tab 149.It Li \ev 150vertical tab 151.It Li \eb 152backspace 153.It Li \er 154carriage return 155.It Li \ef 156form feed 157.It Li \e\e 158backslash 159.It Li \eooo 160octal number in the range [000, 377] 161.El 162.Pp 163A backslash character immediately before the end of the line in a file 164is used to continue the line onto the next line, e.g.: 165.Pp 166.Dl 1 This line is continued \e 167.Dl on this line. 168.Pp 169If the character following the backslash is not one of those specified, 170the backslash is ignored. 171.Sh EXIT STATUS 172.Ex -std 173.Sh SEE ALSO 174.Xr catclose 3 , 175.Xr catgets 3 , 176.Xr catopen 3 177.Sh STANDARDS 178The 179.Nm 180utility is compliant with the 181.St -xpg4 182standard. 183.Sh AUTHORS 184.An -nosplit 185This manual page was originally written by 186.An Ken Stailey 187and later revised by 188.An Terry Lambert . 189.Sh BUGS 190A message catalog file created from a blank input file cannot be revised; 191it must be deleted and recreated. 192