1.\" $NetBSD: getusershell.3,v 1.9 2003/08/07 16:42:51 agc 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. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" @(#)getusershell.3 8.1 (Berkeley) 6/4/93 31.\" 32.Dd January 16, 1999 33.Dt GETUSERSHELL 3 34.Os 35.Sh NAME 36.Nm getusershell , 37.Nm setusershell , 38.Nm endusershell 39.Nd get valid user shells 40.Sh LIBRARY 41.Lb libc 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 valid user shell as defined by the 54system manager in the shells database as described in 55.Xr shells 5 . 56If the shells database is not available, 57.Fn getusershell 58behaves as if 59.Pa /bin/sh 60and 61.Pa /bin/csh 62were listed. 63.Pp 64The 65.Fn getusershell 66function 67reads the next 68line (opening the file if necessary); 69.Fn setusershell 70rewinds the file; 71.Fn endusershell 72closes it. 73.Sh FILES 74.Bl -tag -width /etc/shells -compact 75.It Pa /etc/shells 76.El 77.Sh DIAGNOSTICS 78The routine 79.Fn getusershell 80returns a null pointer (0) on 81.Dv EOF . 82.Sh SEE ALSO 83.Xr nsswitch.conf 5 , 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