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.\" $FreeBSD$ 34.\" 35.Dd June 4, 1993 36.Dt GETUSERSHELL 3 37.Os BSD 4.3 38.Sh NAME 39.Nm getusershell , 40.Nm setusershell , 41.Nm endusershell 42.Nd get legal user shells 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.Fd #include <unistd.h> 47.Ft char * 48.Fn getusershell void 49.Ft void 50.Fn setusershell void 51.Ft void 52.Fn endusershell void 53.Sh DESCRIPTION 54The 55.Fn getusershell 56function 57returns a pointer to a legal user shell as defined by the 58system manager in the file 59.Pa /etc/shells . 60If 61.Pa /etc/shells 62is unreadable or does not exist, 63.Fn getusershell 64behaves as if 65.Pa /bin/sh 66and 67.Pa /bin/csh 68were listed in the file. 69.Pp 70The 71.Fn getusershell 72function 73reads the next 74line (opening the file if necessary); 75.Fn setusershell 76rewinds the file; 77.Fn endusershell 78closes it. 79.Sh FILES 80.Bl -tag -width /etc/shells -compact 81.It Pa /etc/shells 82.El 83.Sh DIAGNOSTICS 84The routine 85.Fn getusershell 86returns a null pointer (0) on 87.Dv EOF . 88.Sh SEE ALSO 89.Xr shells 5 90.Sh HISTORY 91The 92.Fn getusershell 93function appeared in 94.Bx 4.3 . 95.Sh BUGS 96The 97.Fn getusershell 98function leaves its result in an internal static object and returns 99a pointer to that object. 100Subsequent calls to 101.Fn getusershell 102will modify the same object. 103