usr/src/man/man1/msgget.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 MSGGET 1 "Oct 9, 2007"
   6 .SH NAME
   7 msgget \- get a message from a message catalog
   8 .SH SYNOPSIS
   9 .LP
  10 .nf
  11 \fBmsgget\fR \fIlocale\fR [\fIcommand\fR\fB:\fR]\fIcatalog\fR [\fIset\fR.]\fInumber\fR [\fItext\fR]
  12 .fi
  13
  14 .SH DESCRIPTION
  15 .sp
  16 .LP
  17 \fBmsgget\fR gets the message corresponding to the parameters. See
  18 \fBOPERANDS\fR.
  19 .SH OPERANDS
  20 .sp
  21 .LP
  22 The following operands are supported:
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIcatalog\fR\fR
  27 .ad
  28 .RS 16n
  29 Specifies the message catalog name.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIcommand\fR\fR
  36 .ad
  37 .RS 16n
  38 Specifies command-specific message.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIlocale\fR\fR
  45 .ad
  46 .RS 16n
  47 Specifies the locale. If \fIlocale\fR is \fB-\fR then the current locale is
  48 used.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB[\fR\fIset\fR\fB].\fR\fInumber\fR\fR
  55 .ad
  56 .RS 16n
  57 Identifies the message by message number and an optional message set. If
  58 specified as \fB-\fR , the message set and number are determined by looking up
  59 text in the corresponding C locale message catalog.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fItext\fR\fR
  66 .ad
  67 .RS 16n
  68 Specifies the text of the message to be output upon error.
  69 .RE
  70
  71 .SH EXIT STATUS
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB0\fR\fR
  76 .ad
  77 .RS 6n
  78 Successful completion.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB>0\fR\fR
  85 .ad
  86 .RS 6n
  87 An error occurred.
  88 .RE
  89
  90 .SH EXAMPLES
  91 .LP
  92 \fBExample 1 \fRGetting a Message in the Current Locale
  93 .sp
  94 .LP
  95 The following example gets \fBmsg 1\fR in the current locale from message
  96 catalog \fBhello\fR:
  97
  98 .sp
  99 .in +2
 100 .nf
 101 example% msgget - hello 1
 102 hello world
 103 .fi
 104 .in -2
 105 .sp
 106
 107 .SH AUTHORS
 108 .sp
 109 .LP
 110 Glenn Fowler, \fBgsf@research.att.com\fR
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 Interface Stability     Volatile
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBiconv\fR(1), \fBmsgcc\fR(1), \fBmsggen\fR(1), \fBattributes\fR(5)