summaryrefslogtreecommitdiffstats
path: root/man3/getusershell.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/getusershell.3')
-rw-r--r--man3/getusershell.360
1 files changed, 60 insertions, 0 deletions
diff --git a/man3/getusershell.3 b/man3/getusershell.3
new file mode 100644
index 000000000..95728c17f
--- /dev/null
+++ b/man3/getusershell.3
@@ -0,0 +1,60 @@
+.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
+.\"
+.\" Permission is granted to make and distribute verbatim copies of this
+.\" manual provided the copyright notice and this permission notice are
+.\" preserved on all copies.
+.\"
+.\" Permission is granted to copy and distribute modified versions of this
+.\" manual under the conditions for verbatim copying, provided that the
+.\" entire resulting derived work is distributed under the terms of a
+.\" permission notice identical to this one.
+.\"
+.\" Since the Linux kernel and libraries are constantly changing, this
+.\" manual page may be incorrect or out-of-date. The author(s) assume no
+.\" responsibility for errors or omissions, or for damages resulting from
+.\" the use of the information contained herein. The author(s) may not
+.\" have taken the same level of care in the production of this manual,
+.\" which is licensed free of charge, as they might when working
+.\" professionally.
+.\"
+.\" Formatted or processed versions of this manual, if unaccompanied by
+.\" the source, must acknowledge the copyright and authors of this work.
+.\"
+.\" References consulted:
+.\" Linux libc source code
+.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
+.\" 386BSD man pages
+.\" Modified Sat Jul 24 19:17:53 1993 by Rik Faith (faith@cs.unc.edu)
+.TH GETUSERSHELL 3 1993-07-04 "BSD" "Linux Programmer's Manual"
+.SH NAME
+getusershell, setusershell, endusershell \- get legal user shells
+.SH SYNOPSIS
+.nf
+.B #include <unistd.h>
+.sp
+.B char *getusershell(void);
+.sp
+.B void setusershell(void);
+.sp
+.B void endusershell(void);
+.fi
+.SH DESCRIPTION
+The \fBgetusershell()\fP function returns the next line from the file
+\fI/etc/shells\fP, opening the file if necessary. The line should contain
+the pathname of a valid user shell. If \fI/etc/shells\fP does not exist or
+is unreadable, \fBgetusershell()\fP behaves as if \fI/bin/sh\fP and
+\fI/bin/csh\fP were listed in the file.
+.PP
+The \fBsetusershell()\fP function rewinds \fI/etc/shells\fP.
+.PP
+The \fBendusershell()\fP function closes \fI/etc/shells\fP.
+.SH "RETURN VALUE"
+The \fBgetusershell()\fP function returns a NULL pointer on end-of-file.
+.SH FILES
+.nf
+/etc/shells
+.fi
+.SH "CONFORMING TO"
+BSD 4.3
+.SH "SEE ALSO"
+.BR shells (5)