1.\" $NetBSD: getusershell.3,v 1.7 2001/09/16 02:30:24 wiz 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.\" @(#)getusershell.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd January 16, 1999 37.Dt GETUSERSHELL 3 38.Os 39.Sh NAME 40.Nm getusershell , 41.Nm setusershell , 42.Nm endusershell 43.Nd get valid user shells 44.Sh LIBRARY 45.Lb libc 46.Sh SYNOPSIS 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 valid user shell as defined by the 58system manager in the shells database as described in 59.Xr shells 5 . 60If the shells database is not available, 61.Fn getusershell 62behaves as if 63.Pa /bin/sh 64and 65.Pa /bin/csh 66were listed. 67.Pp 68The 69.Fn getusershell 70function 71reads the next 72line (opening the file if necessary); 73.Fn setusershell 74rewinds the file; 75.Fn endusershell 76closes it. 77.Sh FILES 78.Bl -tag -width /etc/shells -compact 79.It Pa /etc/shells 80.El 81.Sh DIAGNOSTICS 82The routine 83.Fn getusershell 84returns a null pointer (0) on 85.Dv EOF . 86.Sh SEE ALSO 87.Xr nsswitch.conf 5 , 88.Xr shells 5 89.Sh HISTORY 90The 91.Fn getusershell 92function appeared in 93.Bx 4.3 . 94.Sh BUGS 95The 96.Fn getusershell 97function leaves its result in an internal static object and returns 98a pointer to that object. Subsequent calls to 99.Fn getusershell 100will modify the same object. 101