1.\" Copyright (c) 1985, 1991, 1993 2.\" The Regents of the University of California. 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 8.1 (Berkeley) 6/4/93 33.\" 34.Dd June 4, 1993 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.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 54returns a pointer to a legal user shell as defined by the 55system manager in the file 56.Pa /etc/shells . 57If 58.Pa /etc/shells 59is unreadable or does not exist, 60.Fn getusershell 61behaves as if 62.Pa /bin/sh 63and 64.Pa /bin/csh 65were listed in the file. 66.Pp 67The 68.Fn getusershell 69function 70reads the next 71line (opening the file if necessary); 72.Fn setusershell 73rewinds the file; 74.Fn endusershell 75closes it. 76.Sh FILES 77.Bl -tag -width /etc/shells -compact 78.It Pa /etc/shells 79.El 80.Sh DIAGNOSTICS 81The routine 82.Fn getusershell 83returns a null pointer (0) on 84.Dv EOF . 85.Sh SEE ALSO 86.Xr shells 5 87.Sh HISTORY 88The 89.Fn getusershell 90function appeared in 91.Bx 4.3 . 92.Sh BUGS 93The 94.Fn getusershell 95function leaves its result in an internal static object and returns 96a pointer to that object. Subsequent calls to 97.Fn getusershell 98will modify the same object. 99