1 .\" Hey Emacs! This file is -*- nroff -*- source.
3 .\" Copyright 1995 James R. Van Zandt <jrv@vanzandt.mv.com>
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" Changed Tue Sep 19 01:49:29 1995, aeb: moved from man2 to man3
26 .\" added ref to /etc/utmp, added BUGS section, etc.
27 .\" modified 2003 Walter Harms, aeb - added getlogin_r, note on stdin use
28 .TH GETLOGIN 3 2007-07-26 "GNU" "Linux Programmer's Manual"
30 getlogin, getlogin_r, cuserid \- get user name
32 .B #include <unistd.h>
34 .B "char *getlogin(void);"
36 .BI "int getlogin_r(char *" buf ", size_t " bufsize );
40 .BI "char *cuserid(char *" string );
43 Feature Test Macro Requirements for glibc (see
44 .BR feature_test_macros (7)):
48 _REENTRANT || _POSIX_C_SOURCE\ >=\ 199506L
54 returns a pointer to a string containing the name of
55 the user logged in on the controlling terminal of the process, or a
56 null pointer if this information cannot be determined.
58 statically allocated and might be overwritten on subsequent calls to
63 returns this same user name in the array
69 returns a pointer to a string containing a user name
70 associated with the effective user ID of the process.
72 is not a null pointer, it should be an array that can hold at least
73 \fBL_cuserid\fP characters; the string is returned in this array.
74 Otherwise, a pointer to a string in a static area is returned.
76 string is statically allocated and might be overwritten on subsequent
77 calls to this function or to
80 The macro \fBL_cuserid\fP is an integer constant that indicates how
81 long an array you might need to store a user name.
82 \fBL_cuserid\fP is declared in \fI<stdio.h>\fP.
84 These functions let your program identify positively the user who is
87 or the user who logged in this session
89 (These can differ when set-user-ID programs are involved.)
91 For most purposes, it is more useful to use the environment variable
92 \fBLOGNAME\fP to find out who the user is.
94 precisely because the user can set \fBLOGNAME\fP arbitrarily.
97 returns a pointer to the user name when successful,
100 returns 0 when successful, and non-zero on failure.
105 The calling process already has the maximum allowed number of open files.
108 The system already has the maximum allowed number of open files.
111 The calling process has no controlling tty.
115 The length of the user name, including the terminating null byte,
122 There was no corresponding entry in the utmp-file.
125 Insufficient memory to allocate passwd structure.
129 password database file
132 (traditionally \fI/etc/utmp\fP;
133 some libc versions used \fI/var/adm/utmp\fP)
138 specified in POSIX.1-2001.
142 function which uses the real
143 user ID rather than the effective user ID.
147 was included in the 1988 version of POSIX,
148 but removed from the 1990 version.
149 It was present in SUSv2, but removed in POSIX.1-2001.
156 associated with a session, even if it has no controlling tty.
158 Unfortunately, it is often rather easy to fool
160 Sometimes it does not work at all, because some program messed up
162 Often, it gives only the first 8 characters of
164 The user currently logged in on the controlling tty
165 of our program need not be the user who started it.
168 for security-related purposes.
170 Note that glibc does not follow the POSIX spec and uses
175 (Other recent systems, like SunOS 5.8 and HP-UX 11.11 and FreeBSD 4.8
176 all return the login name also when
180 Nobody knows precisely what
182 does; avoid it in portable programs.
183 Or avoid it altogether: use
184 .I getpwuid(geteuid())