]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/getusershell.3
getent.1, intro.1, time.1, _exit.2, _syscall.2, accept.2, access.2, acct.2, adjtimex...
[thirdparty/man-pages.git] / man3 / getusershell.3
CommitLineData
fea681da
MK
1.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2.\"
3.\" Permission is granted to make and distribute verbatim copies of this
4.\" manual provided the copyright notice and this permission notice are
5.\" preserved on all copies.
6.\"
7.\" Permission is granted to copy and distribute modified versions of this
8.\" manual under the conditions for verbatim copying, provided that the
9.\" entire resulting derived work is distributed under the terms of a
10.\" permission notice identical to this one.
c13182ef 11.\"
fea681da
MK
12.\" Since the Linux kernel and libraries are constantly changing, this
13.\" manual page may be incorrect or out-of-date. The author(s) assume no
14.\" responsibility for errors or omissions, or for damages resulting from
15.\" the use of the information contained herein. The author(s) may not
16.\" have taken the same level of care in the production of this manual,
17.\" which is licensed free of charge, as they might when working
18.\" professionally.
c13182ef 19.\"
fea681da
MK
20.\" Formatted or processed versions of this manual, if unaccompanied by
21.\" the source, must acknowledge the copyright and authors of this work.
22.\"
23.\" References consulted:
24.\" Linux libc source code
25.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26.\" 386BSD man pages
27.\" Modified Sat Jul 24 19:17:53 1993 by Rik Faith (faith@cs.unc.edu)
cc4615cc 28.TH GETUSERSHELL 3 2007-07-26 "GNU" "Linux Programmer's Manual"
fea681da 29.SH NAME
e935e108 30getusershell, setusershell, endusershell \- get permitted user shells
fea681da
MK
31.SH SYNOPSIS
32.nf
33.B #include <unistd.h>
34.sp
35.B char *getusershell(void);
36.sp
37.B void setusershell(void);
38.sp
39.B void endusershell(void);
40.fi
cc4615cc
MK
41.sp
42.in -4n
43Feature Test Macro Requirements for glibc (see
44.BR feature_test_macros (7)):
45.in
46.sp
47.ad l
48.BR getusershell (),
49.BR setusershell (),
50.BR endusershell ():
c105dbb5 51.RS 4
cc4615cc 52_BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\ <\ 500)
c105dbb5 53.RE
cc4615cc 54.ad b
fea681da 55.SH DESCRIPTION
60a90ecd
MK
56The
57.BR getusershell ()
58function returns the next line from the file
c13182ef
MK
59\fI/etc/shells\fP, opening the file if necessary.
60The line should contain
61the pathname of a valid user shell.
62If \fI/etc/shells\fP does not exist or
60a90ecd
MK
63is unreadable,
64.BR getusershell ()
65behaves as if \fI/bin/sh\fP and
fea681da
MK
66\fI/bin/csh\fP were listed in the file.
67.PP
60a90ecd
MK
68The
69.BR setusershell ()
70function rewinds \fI/etc/shells\fP.
fea681da 71.PP
60a90ecd
MK
72The
73.BR endusershell ()
74function closes \fI/etc/shells\fP.
47297adb 75.SH RETURN VALUE
60a90ecd
MK
76The
77.BR getusershell ()
78function returns a NULL pointer on end-of-file.
fea681da
MK
79.SH FILES
80.nf
81/etc/shells
82.fi
47297adb 83.SH CONFORMING TO
44a2c328 844.3BSD.
47297adb 85.SH SEE ALSO
fea681da 86.BR shells (5)