1.\" $NetBSD: getusershell.3,v 1.10 2004/11/23 04:38:19 lukem 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 November 23, 2004 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.In 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 valid user shell as defined by the 55system manager in the shells database as described in 56.Xr shells 5 . 57If the shells database is not available, 58.Fn getusershell 59behaves as if 60.Pa /bin/sh 61and 62.Pa /bin/csh 63were listed. 64.Pp 65The 66.Fn getusershell 67function 68reads the next 69line (opening the file if necessary); 70.Fn setusershell 71rewinds the file; 72.Fn endusershell 73closes it. 74.Sh FILES 75.Bl -tag -width /etc/shells -compact 76.It Pa /etc/shells 77.El 78.Sh DIAGNOSTICS 79The routine 80.Fn getusershell 81returns a null pointer (0) on 82.Dv EOF . 83.Sh SEE ALSO 84.Xr nsswitch.conf 5 , 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. 96Subsequent calls to 97.Fn getusershell 98will modify the same object. 99