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