share/man/man1/gencat.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1995, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH GENCAT 1 "Feb 1, 1995"
  11 .SH NAME
  12 gencat \- generate a formatted message catalog
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBgencat\fR \fIcatfile\fR \fImsgfile\fR...
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgencat\fR command merges the message text source file(s) \fImsgfile\fR
  23 into a formatted message database \fIcatfile\fR. The database \fIcatfile\fR is
  24 created if it does not already exist.  If \fIcatfile\fR does exist, its
  25 messages are included in the new \fIcatfile\fR. If set and message numbers
  26 collide, the new message-text defined in \fImsgfile\fR replaces the old message
  27 text currently contained in \fIcatfile\fR. The message text source file (or set
  28 of files) input to \fBgencat\fR can contain either set and message numbers or
  29 simply message numbers, in which case the set \fBNL_SETD\fR (see
  30 \fBnl_types.h\fR(3HEAD)) is assumed.
  31 .SS "Message Text Source File Format"
  32 .sp
  33 .LP
  34 The format of a message text source file is defined as follows. Note that the
  35 fields of a message text source line are separated by a single \fBASCII\fR
  36 space or tab character. Any other \fBASCII\fR spaces or tabs are considered as
  37 part of the subsequent field.
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fB$set\fR \fIn comment\fR \fR
  42 .ad
  43 .RS 22n
  44 Where \fIn\fR specifies the set identifier of the following messages until the
  45 next \fB$set\fR, \fB$delset\fR, or end-of-file appears. \fIn\fR must be a
  46 number in the range (\fB1\fR-{\fBNL_SETMAX\fR}). Set identifiers within a
  47 single source file need not be contiguous. Any string following the set
  48 identifier is treated as a comment.  If no \fB$set\fR directive is specified in
  49 a message text source file, all messages are located in the default message set
  50 \fBNL_SETD\fR.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB$delset\fR \fIn comment\fR \fR
  57 .ad
  58 .RS 22n
  59 Deletes message set \fIn\fR from an existing message catalog. Any string
  60 following the set number is treated as a comment. (\fBNote:\fR if  \fIn\fR is
  61 not a valid set it is ignored.)
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB$\fR\fIcomment\fR \fR
  68 .ad
  69 .RS 22n
  70 A line beginning with a dollar symbol  \fB$\fR followed by an \fBASCII\fR space
  71 or tab character is treated as a comment.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIm\fR \fImessage-text\fR \fR
  78 .ad
  79 .RS 22n
  80 The \fIm\fR denotes the message identifier, a number in the range
  81 (\fB1\fR-{\fBNL_MSGMAX\fR}).  The \fImessage-text\fR is stored in the message
  82 catalog with the set identifier specified by the last \fB$set\fR directive, and
  83 with message identifier \fIm\fR. If the \fImessage-text\fR is empty, and an
  84 \fBASCII\fR space or tab field separator is present, an empty string is stored
  85 in the message catalog.  If a message source line has a message number, but
  86 neither a field separator nor \fImessage-text\fR, the existing message with
  87 that number (if any) is deleted from the catalog. Message identifiers need not
  88 be contiguous.  The length of \fImessage-text\fR must be in the range
  89 (\fB0\fR-{\fBNL_TEXTMAX\fR}).
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB$quote\fR \fIc\fR \fR
  96 .ad
  97 .RS 22n
  98 This line specifies an optional quote character \fIc\fR, which can be used to
  99 surround \fImessage-text\fR so that trailing spaces or null (empty) messages
 100 are visible in a message source line.  By default, or if an empty \fB$quote\fR
 101 directive is supplied, no quoting of \fImessage-text\fR will be recognized.
 102 .RE
 103
 104 .sp
 105 .LP
 106 Empty lines in a message text source file are ignored.
 107 .sp
 108 .LP
 109 Text strings can contain the special characters and escape sequences defined in
 110 the following table:
 111 .sp
 112
 113 .sp
 114 .TS
 115 box;
 116 l l l
 117 l l l .
 118 Description     Symbol  Sequence
 119 newline NL(LF)  \en
 120 horizontal tab  HT      \et
 121 vertical tab    VT      \ev
 122 backspace       BS      \eb
 123 carriage return CR      \er
 124 form feed       FF      \ef
 125 backslash       \e      \e\e
 126 bit pattern     ddd     \eddd
 127 .TE
 128
 129 .sp
 130 .LP
 131 The escape sequence \fB\e\fR\fIddd\fR consists of backslash followed by 1, 2 or
 132 3 octal digits, which are taken to specify the value of the desired character.
 133 If the character following a backslash is not one of those specified, the
 134 backslash is ignored.
 135 .sp
 136 .LP
 137 Backslash followed by an \fBASCII\fR newline character is also used to continue
 138 a string on the following line. Thus, the following two lines describe a single
 139 message string:
 140 .sp
 141 .in +2
 142 .nf
 143 1 This line continues \e
 144 to the next line
 145 .fi
 146 .in -2
 147
 148 .sp
 149 .LP
 150 which is equivalent to:
 151 .sp
 152 .in +2
 153 .nf
 154     1 This line continues to the next line
 155 .fi
 156 .in -2
 157
 158 .SH OPERANDS
 159 .sp
 160 .LP
 161 The following operands are supported:
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fIcatfile\fR \fR
 166 .ad
 167 .RS 12n
 168 A path name of the formatted message catalog. If \(mi is specified, standard
 169 output is used.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fImsgfile\fR \fR
 176 .ad
 177 .RS 12n
 178 A path name of a message text source file. If \(mi is specified for an instance
 179 of \fImsgfile\fR, standard input is used. The format of message text source
 180 files is defined in \fBMessage Text Source File Format\fR.
 181 .RE
 182
 183 .SH ENVIRONMENT VARIABLES
 184 .sp
 185 .LP
 186 See \fBenviron\fR(5) for descriptions of the following environment variables
 187 that affect the execution of \fBgencat\fR: \fBLANG\fR, \fBLC_ALL\fR,
 188 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 189 .SH EXIT STATUS
 190 .sp
 191 .LP
 192 The following exit values are returned:
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB0\fR \fR
 197 .ad
 198 .RS 7n
 199 Successful completion.
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB>0\fR \fR
 206 .ad
 207 .RS 7n
 208 An error occurred.
 209 .RE
 210
 211 .SH ATTRIBUTES
 212 .sp
 213 .LP
 214 See \fBattributes\fR(5) for descriptions of the following attributes:
 215 .sp
 216
 217 .sp
 218 .TS
 219 box;
 220 c | c
 221 l | l .
 222 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 223 _
 224 CSI     enabled
 225 _
 226 Interface Stability     Standard
 227 .TE
 228
 229 .SH SEE ALSO
 230 .sp
 231 .LP
 232 \fBmkmsgs\fR(1), \fBcatgets\fR(3C), \fBcatopen\fR(3C), \fBgettxt\fR(3C),
 233 \fBnl_types.h\fR(3HEAD), \fBattributes\fR(5), \fBenviron\fR(5),
 234 \fBstandards\fR(5)