usr/src/man/man1/msggen.1

   1 '\" te
   2 .\" Copyright (c) 2000-2007 AT&T Knowledge Ventures
   3 .\" To view license terms, see http://www.opensource.org/licenses/cpl1.0.txt
   4 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc.
   5 .TH MSGGEN 1 "Oct 9, 2007"
   6 .SH NAME
   7 msggen \- generate a machine independent formatted message catalog
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBmsggen\fR [\fB-fls\fR] \fIcatfile\fR [\fImsgfile\fR]
  12 .fi
  13
  14 .SH DESCRIPTION
  15 .sp
  16 .LP
  17 \fBmsggen\fR merges the message text source file \fImsgfile\fR into a machine
  18 independent formatted message catalog \fIcatfile\fR. The file \fIcatfile\fR is
  19 created if it does not already exist. If \fIcatfile\fR does exist, its messages
  20 are included in the new \fIcatfile\fR. If set and message numbers collide, the
  21 new message text defined in \fImsgfile\fR replaces the old message text
  22 currently contained in \fIcatfile\fR.
  23 .sp
  24 .LP
  25 Non-ASCII characters must be UTF-8 encoded. \fBiconv\fR(1) can be used to
  26 convert to/from UTF-8.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 The following options are supported:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-f\fR\fR
  35 .ad
  36 .br
  37 .na
  38 \fB\fB--format\fR\fR
  39 .ad
  40 .RS 12n
  41 List the \fBprintf\fR(3C) format signature for each message in \fIcatfile\fR. A
  42 format signature is one line containing one character for each format
  43 specification:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBc\fR\fR
  48 .ad
  49 .RS 5n
  50 char
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBd\fR\fR
  57 .ad
  58 .RS 5n
  59 double
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBD\fR\fR
  66 .ad
  67 .RS 5n
  68 long double
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBf\fR\fR
  75 .ad
  76 .RS 5n
  77 float
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBh\fR\fR
  84 .ad
  85 .RS 5n
  86 short
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBi\fR\fR
  93 .ad
  94 .RS 5n
  95 int
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBj\fR\fR
 102 .ad
 103 .RS 5n
 104 long long
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBl\fR\fR
 111 .ad
 112 .RS 5n
 113 long
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBp\fR\fR
 120 .ad
 121 .RS 5n
 122 void*
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBs\fR\fR
 129 .ad
 130 .RS 5n
 131 string
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBt\fR\fR
 138 .ad
 139 .RS 5n
 140 ptrdiff_t
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBz\fR\fR
 147 .ad
 148 .RS 5n
 149 size_t
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fB?\fR\fR
 156 .ad
 157 .RS 5n
 158 unknown
 159 .RE
 160
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB-l\fR\fR
 167 .ad
 168 .br
 169 .na
 170 \fB\fB--list\fR\fR
 171 .ad
 172 .RS 12n
 173 List \fIcatfile\fR in UTF-8 msgfile form.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB-s\fR\fR
 180 .ad
 181 .br
 182 .na
 183 \fB\fB--set\fR\fR
 184 .ad
 185 .RS 12n
 186 Convert the \fIcatfile\fR to a message set number and print the number on the
 187 standard output.
 188 .RE
 189
 190 .SH OPERANDS
 191 .sp
 192 .LP
 193 The following operands are supported:
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fIcatfile\fR\fR
 198 .ad
 199 .RS 11n
 200 Machine independent formatted message catalog file.
 201 .RE
 202
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fImsgfile\fR\fR
 207 .ad
 208 .RS 11n
 209 Message text source file.
 210 .RE
 211
 212 .SH USAGE
 213 .sp
 214 .LP
 215 Message text source files are in \fBgencat\fR(1) format, defined as follows.
 216 The fields of a message text source line are separated by a single blank
 217 character. Any other blank characters are considered to be part of the
 218 subsequent field. The \fBNL_*\fR constants are defined in one or both of
 219 \fB<limits.h>\fR and \fB<nl_types.h>\fR\&.
 220 .sp
 221 .ne 2
 222 .na
 223 \fB\fB$\fR \fIcomment\fR\fR
 224 .ad
 225 .sp .6
 226 .RS 4n
 227 A line beginning with a \fB$\fR followed by a blank character is treated as a
 228 comment.
 229 .RE
 230
 231 .sp
 232 .ne 2
 233 .na
 234 \fB\fB$delset\fR \fIn comment\fR\fR
 235 .ad
 236 .sp .6
 237 .RS 4n
 238 This line deletes message set \fIn\fR from an existing message catalog. \fIn\fR
 239 denotes the set number \fB[1, NL_SETMAX]\fR. Any text following the set number
 240 is treated as a comment.
 241 .RE
 242
 243 .sp
 244 .ne 2
 245 .na
 246 \fB\fB$quote\fR \fIc\fR\fR
 247 .ad
 248 .sp .6
 249 .RS 4n
 250 This line specifies an optional quote character \fIc\fR, which can be used to
 251 surround message-text so that trailing spaces or empty messages are visible in
 252 a message source line. By default, or if an empty \fB$quote\fR directive is
 253 supplied, no quoting of message-text is recognized.
 254 .RE
 255
 256 .sp
 257 .ne 2
 258 .na
 259 \fB\fB$set\fR \fIn comment\fR\fR
 260 .ad
 261 .sp .6
 262 .RS 4n
 263 This line specifies the set identifier of the following messages until the next
 264 \fB$set\fR or end-of-file (\fBEOF\fR) appears. \fIn\fR denotes the set
 265 identifier, which is defined as a number in the range \fB[1, NL_SETMAX]\fR. Set
 266 numbers need not be contiguous. Any text following the set identifier is
 267 treated as a comment. If no \fB$set\fR directive is specified in a message text
 268 source file, all messages are located in message set 1.
 269 .RE
 270
 271 .sp
 272 .ne 2
 273 .na
 274 \fB\fB$translation\fR \fIidentification YYYY-MM-DD\fR\fB[,...]\fR\fR
 275 .ad
 276 .sp .6
 277 .RS 4n
 278 Append translation information to the message catalog header. Only the newest
 279 date for a given identification is retained in the catalog. Multiple
 280 translation lines are combined into a single, comma-separated list.
 281 .RE
 282
 283 .sp
 284 .ne 2
 285 .na
 286 \fB\fBm\fR \fImessage-text\fR\fR
 287 .ad
 288 .sp .6
 289 .RS 4n
 290 \fBm\fR denotes the message identifier, which is defined as a number in the
 291 range \fB[1, NL_MSGMAX]\fR. The message-text is stored in the message catalogue
 292 with the set identifier specified by the last \fB$set\fR directive, and with
 293 message identifier \fBm\fR. If the message-text is empty, and a blank character
 294 field separator is present, an empty string is stored in the message catalogue.
 295 If a message source line has a message number, but neither a field separator
 296 nor message-text, the existing message with that number (if any) is deleted
 297 from the catalogue. Message identifiers need not be contiguous. There are no
 298 \fImessage-text\fR length restrictions.
 299 .RE
 300
 301 .SH EXIT STATUS
 302 .sp
 303 .ne 2
 304 .na
 305 \fB\fB0\fR\fR
 306 .ad
 307 .RS 6n
 308 Successful completion.
 309 .RE
 310
 311 .sp
 312 .ne 2
 313 .na
 314 \fB\fB>0\fR\fR
 315 .ad
 316 .RS 6n
 317 One or more specified jobs does not exist.
 318 .RE
 319
 320 .SH EXAMPLES
 321 .LP
 322 \fBExample 1 \fRUsing \fBmsggen\fR
 323 .sp
 324 .LP
 325 The following example generates a message catalog \fBxxx\fR from the message
 326 file \fBxxx.msg\fR:
 327
 328 .sp
 329 .in +2
 330 .nf
 331 example% msggen xxx xxx.msg
 332 .fi
 333 .in -2
 334 .sp
 335
 336 .SH AUTHORS
 337 .sp
 338 .LP
 339 Glenn Fowler, \fBgsf@research.att.com\fR
 340 .SH ATTRIBUTES
 341 .sp
 342 .LP
 343 See \fBattributes\fR(7) for descriptions of the following attributes:
 344 .sp
 345
 346 .sp
 347 .TS
 348 box;
 349 c | c
 350 l | l .
 351 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 352 _
 353 Interface Stability     Volatile
 354 .TE
 355
 356 .SH SEE ALSO
 357 .sp
 358 .LP
 359 .BR gencat (1),
 360 .BR iconv (1),
 361 .BR msgcc (1),
 362 .BR printf (3C),
 363 .BR attributes (7)