date and time created 85/11/08 18:31:09 by mckusick

SCCS-vsn: lib/libc/gen/getusershell.3 6.1

diff --git a/usr/src/lib/libc/gen/getusershell.3 b/usr/src/lib/libc/gen/getusershell.3
new file mode 100644 (file)
index 0000000..8b63c64
--- /dev/null
+++ b/usr/src/lib/libc/gen/getusershell.3
@@ -0,0 +1,49 @@
+.\" Copyright (c) 1985 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)getusershell.3      6.1 (Berkeley) %G%
+.\"
+.TH GETUSERSHELL 3  ""
+.UC 6
+.SH NAME
+getusershell, setusershell, endusershell \- get legal user shells
+.SH SYNOPSIS
+.nf
+.B char *getusershell()
+.PP
+.B setusershell()
+.PP
+.B endusershell()
+.fi
+.SH DESCRIPTION
+.I Getusershell
+returns a pointer to a legal user shell as defined by the
+system manager in the file 
+.IR /etc/shells .
+If 
+.I /etc/shells
+does not exist, the two standard system shells
+.I /bin/sh
+and
+.I /bin/csh
+are returned.
+.PP
+.I Getusershell
+reads the next
+line (opening the file if necessary);
+.I setusershell
+rewinds the file;
+.I endusershell
+closes it.
+.SH FILES
+/etc/shells
+.SH DIAGNOSTICS
+The routine
+.I getusershell
+returns a null pointer (0) on EOF or error.
+.SH BUGS
+All information
+is contained in a static area
+so it must be copied if it is
+to be saved.