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