Print this page
2989 Eliminate use of LOGNAME_MAX in ON
1166 useradd have warning with name more 8 chars
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man3c/getlogin.3c
+++ new/usr/src/man/man3c/getlogin.3c
1 1 '\" te
2 +.\" Copyright (c) 2013 Gary Mills
2 3 .\" Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved.
3 4 .\" Copyright 1989 AT&T
4 5 .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
5 6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
6 7 .\" http://www.opengroup.org/bookstore/.
7 8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
8 9 .\" This notice shall appear on any product containing this material.
9 10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
10 11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
11 12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
12 -.TH GETLOGIN 3C "May 18, 2004"
13 +.TH GETLOGIN 3C "Apr 19, 2013"
13 14 .SH NAME
14 15 getlogin, getlogin_r \- get login name
15 16 .SH SYNOPSIS
16 17 .LP
17 18 .nf
18 19 #include <unistd.h>
19 20
20 21 \fBchar *\fR\fBgetlogin\fR(\fBvoid\fR);
21 22 .fi
22 23
23 24 .LP
24 25 .nf
25 26 \fBchar *\fR\fBgetlogin_r\fR(\fBchar *\fR\fIname\fR, \fBint\fR \fInamelen\fR);
26 27 .fi
27 28
28 29 .SS "Standard conforming"
29 30 .LP
30 31 .nf
31 32 cc [ \fIflag \fR... ] \fIfile\fR... \fB-D_POSIX_PTHREAD_SEMANTICS\fR [ \fIlibrary \fR... ]
32 33
33 34 \fBint\fR \fBgetlogin_r\fR(\fBchar *\fR\fIname\fR, \fBsize_t\fR \fInamesize\fR);
34 35 .fi
↓ open down ↓ |
12 lines elided |
↑ open up ↑ |
35 36
36 37 .SH DESCRIPTION
37 38 .sp
38 39 .LP
39 40 The \fBgetlogin()\fR function returns a pointer to the login name as found in
40 41 \fB/var/adm/utmpx\fR. It can be used in conjunction with \fBgetpwnam\fR(3C) to
41 42 locate the correct password file entry when the same user \fBID\fR is shared by
42 43 several login names.
43 44 .sp
44 45 .LP
46 +The login name plus the terminating null byte can be up to 33 characters
47 +in length. For programs that call \fBgetlogin()\fR and expect only the
48 +legacy 9-character length, the user compatibility library
49 +\fB/usr/lib/getlogin8.so.1\fR truncates long login names to fit a
50 +9-character buffer. This library should be added to such an application
51 +at runtime using \fBLD_PRELOAD\fR.
52 +.sp
53 +.LP
45 54 If \fBgetlogin()\fR is called within a process that is not attached to a
46 55 terminal, it returns a null pointer. The correct procedure for determining the
47 56 login name is to call \fBcuserid\fR(3C), or to call \fBgetlogin()\fR and if it
48 57 fails to call \fBgetpwuid\fR(3C).
49 58 .sp
50 59 .LP
51 60 The \fBgetlogin_r()\fR function has the same functionality as \fBgetlogin()\fR
52 61 except that the caller must supply a buffer \fIname\fR with length
53 62 \fInamelen\fR to store the result. The \fIname\fR buffer must be at least
54 63 \fB_POSIX_LOGIN_NAME_MAX\fR bytes in size (defined in <\fBlimits.h\fR>). The
55 64 POSIX version (see \fBstandards\fR(5)) of \fBgetlogin_r()\fR takes a
56 65 \fInamesize\fR parameter of type \fBsize_t\fR.
57 66 .SH RETURN VALUES
58 67 .sp
59 68 .LP
60 69 Upon successful completion, \fBgetlogin()\fR returns a pointer to the login
61 70 name or a null pointer if the user's login name cannot be found. Otherwise it
62 71 returns a null pointer and sets \fBerrno\fR to indicate the error.
63 72 .sp
64 73 .LP
65 74 The standard-conforming \fBgetlogin_r()\fR returns \fB0\fR if successful, or
66 75 the error number upon failure.
67 76 .SH ERRORS
68 77 .sp
69 78 .LP
70 79 The \fBgetlogin_r()\fR function will fail if:
71 80 .sp
72 81 .ne 2
73 82 .na
74 83 \fB\fBERANGE\fR\fR
75 84 .ad
76 85 .RS 10n
77 86 The size of the buffer is smaller than the result to be returned.
78 87 .RE
79 88
80 89 .sp
81 90 .ne 2
82 91 .na
83 92 \fB\fBEINVAL\fR\fR
84 93 .ad
85 94 .RS 10n
86 95 And entry for the current user was not found in the \fB/var/adm/utmpx\fR file.
87 96 .RE
88 97
89 98 .sp
90 99 .LP
91 100 The \fBgetlogin()\fR and \fBgetlogin_r()\fR functions may fail if:
92 101 .sp
93 102 .ne 2
94 103 .na
95 104 \fB\fBEMFILE\fR\fR
96 105 .ad
97 106 .RS 10n
98 107 There are {\fBOPEN_MAX\fR} file descriptors currently open in the calling
99 108 process.
100 109 .RE
101 110
102 111 .sp
103 112 .ne 2
104 113 .na
105 114 \fB\fBENFILE\fR\fR
106 115 .ad
107 116 .RS 10n
108 117 The maximum allowable number of files is currently open in the system.
109 118 .RE
110 119
111 120 .sp
112 121 .ne 2
113 122 .na
114 123 \fB\fBENXIO\fR\fR
115 124 .ad
116 125 .RS 10n
117 126 The calling process has no controlling terminal.
118 127 .RE
119 128
120 129 .sp
121 130 .LP
122 131 The \fBgetlogin_r()\fR function may fail if:
123 132 .sp
124 133 .ne 2
125 134 .na
126 135 \fB\fBERANGE\fR\fR
127 136 .ad
128 137 .RS 10n
129 138 The size of the buffer is smaller than the result to be returned.
130 139 .RE
131 140
132 141 .SH USAGE
133 142 .sp
134 143 .LP
135 144 The return value of \fBgetlogin()\fR points to thread-specific data whose
136 145 content is overwritten on each call by the same thread.
137 146 .sp
138 147 .LP
139 148 Three names associated with the current process can be determined:
140 149 \fBgetpwuid(\fR\fBgeteuid()\fR\fB)\fR returns the name associated with the
141 150 effective user ID of the process; \fBgetlogin()\fR returns the name associated
142 151 with the current login activity; and \fBgetpwuid(\fR\fBgetuid()\fR\fB)\fR
143 152 returns the name associated with the real user ID of the process.
↓ open down ↓ |
89 lines elided |
↑ open up ↑ |
144 153 .SH FILES
145 154 .sp
146 155 .ne 2
147 156 .na
148 157 \fB\fB/var/adm/utmpx\fR\fR
149 158 .ad
150 159 .RS 18n
151 160 user access and administration information
152 161 .RE
153 162
163 +.sp
164 +.ne 2
165 +.na
166 +\fB\fB/usr/lib/getlogin8.so.1\fR\fR
167 +.ad
168 +.RS 18n
169 +A compatibility library to truncate long login names.
170 +.RE
171 +
172 +.sp
173 +.ne 2
174 +.na
175 +\fB\fB/usr/lib/64/getlogin8.so.1\fR\fR
176 +.ad
177 +.RS 18n
178 +A 64-bit compatibility library to runcate long login names.
179 +.RE
180 +
154 181 .SH ATTRIBUTES
155 182 .sp
156 183 .LP
157 184 See \fBattributes\fR(5) for descriptions of the following attributes:
158 185 .sp
159 186
160 187 .sp
161 188 .TS
162 189 box;
163 190 c | c
164 191 l | l .
165 192 ATTRIBUTE TYPE ATTRIBUTE VALUE
166 193 _
167 194 Interface Stability Standard
168 195 _
169 196 MT-Level See below.
170 197 .TE
171 198
172 199 .SH SEE ALSO
173 200 .sp
174 201 .LP
175 202 \fBgeteuid\fR(2), \fBgetuid\fR(2), \fBcuserid\fR(3C), \fBgetgrnam\fR(3C),
176 203 \fBgetpwnam\fR(3C), \fBgetpwuid\fR(3C), \fButmpx\fR(4), \fBattributes\fR(5),
177 204 \fBstandards\fR(5)
178 205 .SH NOTES
179 206 .sp
180 207 .LP
181 208 When compiling multithreaded programs, see \fBIntro\fR(3).
182 209 .sp
183 210 .LP
184 211 The \fBgetlogin()\fR function is safe to use in multithreaded applications, but
185 212 is discouraged. The \fBgetlogin_r()\fR function should be used instead.
186 213 .sp
187 214 .LP
188 215 Solaris 2.4 and earlier releases provided a \fBgetlogin_r()\fR as specified in
189 216 POSIX.1c Draft 6. The final POSIX.1c standard changed the interface as
190 217 described above. Support for the Draft 6 interface is provided for
191 218 compatibility only and may not be supported in future releases. New
192 219 applications and libraries should use the standard-conforming interface.
↓ open down ↓ |
29 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX