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