1.\" $OpenBSD: getusershell.3,v 1.9 2000/12/24 00:30:49 aaron Exp $ 2.\" 3.\" Copyright (c) 1985, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd June 4, 1993 35.Dt GETUSERSHELL 3 36.Os 37.Sh NAME 38.Nm getusershell , 39.Nm setusershell , 40.Nm endusershell 41.Nd get legal user shells 42.Sh SYNOPSIS 43.Fd #include <unistd.h> 44.Ft char * 45.Fn getusershell void 46.Ft void 47.Fn setusershell void 48.Ft void 49.Fn endusershell void 50.Sh DESCRIPTION 51The 52.Fn getusershell 53function returns a pointer to a legal user shell as defined by the 54system manager in the file 55.Pa /etc/shells . 56If 57.Pa /etc/shells 58is unreadable or does not exist, 59.Fn getusershell 60behaves as if only 61.Pa /bin/sh 62and 63.Pa /bin/csh 64were listed in the file. 65.Pp 66The 67.Fn getusershell 68function reads the next 69line (opening the file if necessary); 70.Fn setusershell 71rewinds the file; 72.Fn endusershell 73closes it. 74.Sh FILES 75.Bl -tag -width /etc/shells -compact 76.It Pa /etc/shells 77.El 78.Sh DIAGNOSTICS 79The routine 80.Fn getusershell 81returns a null pointer 82.Dv EOF . 83.Sh SEE ALSO 84.Xr shells 5 85.Sh HISTORY 86The 87.Fn getusershell 88function appeared in 89.Bx 4.3 . 90.Sh BUGS 91The 92.Fn getusershell 93function leaves its result in an internal static object and returns 94a pointer to that object. 95Subsequent calls to 96.Fn getusershell 97will modify the same object. 98