summaryrefslogtreecommitdiff
path: root/usr/src/man/man1/msgget.1
blob: e3e1e3a1388e3a6fb40aef5c3c30821032fadb2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
'\" te
.\" Copyright (c) 2000-2007 AT&T Knowledge Ventures
.\" To view license terms, see http://www.opensource.org/licenses/cpl1.0.txt
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc.
.TH MSGGET 1 "Oct 9, 2007"
.SH NAME
msgget \- get a message from a message catalog
.SH SYNOPSIS
.LP
.nf
\fBmsgget\fR \fIlocale\fR [\fIcommand\fR\fB:\fR]\fIcatalog\fR [\fIset\fR.]\fInumber\fR [\fItext\fR]
.fi

.SH DESCRIPTION
.sp
.LP
\fBmsgget\fR gets the message corresponding to the parameters. See
\fBOPERANDS\fR.
.SH OPERANDS
.sp
.LP
The following operands are supported:
.sp
.ne 2
.na
\fB\fIcatalog\fR\fR
.ad
.RS 16n
Specifies the message catalog name.
.RE

.sp
.ne 2
.na
\fB\fIcommand\fR\fR
.ad
.RS 16n
Specifies command-specific message.
.RE

.sp
.ne 2
.na
\fB\fIlocale\fR\fR
.ad
.RS 16n
Specifies the locale. If \fIlocale\fR is \fB-\fR then the current locale is
used.
.RE

.sp
.ne 2
.na
\fB\fB[\fR\fIset\fR\fB].\fR\fInumber\fR\fR
.ad
.RS 16n
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.
.RE

.sp
.ne 2
.na
\fB\fItext\fR\fR
.ad
.RS 16n
Specifies the text of the message to be output upon error.
.RE

.SH EXIT STATUS
.sp
.ne 2
.na
\fB\fB0\fR\fR
.ad
.RS 6n
Successful completion.
.RE

.sp
.ne 2
.na
\fB\fB>0\fR\fR
.ad
.RS 6n
An error occurred.
.RE

.SH EXAMPLES
.LP
\fBExample 1 \fRGetting a Message in the Current Locale
.sp
.LP
The following example gets \fBmsg 1\fR in the current locale from message
catalog \fBhello\fR:

.sp
.in +2
.nf
example% msgget - hello 1
hello world
.fi
.in -2
.sp

.SH AUTHORS
.sp
.LP
Glenn Fowler, \fBgsf@research.att.com\fR
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Volatile
.TE

.SH SEE ALSO
.sp
.LP
\fBiconv\fR(1), \fBmsgcc\fR(1), \fBmsggen\fR(1), \fBattributes\fR(5)