1*2fe8fb19SBen Gras.\" $NetBSD: getusershell.3,v 1.10 2004/11/23 04:38:19 lukem Exp $ 2*2fe8fb19SBen Gras.\" 3*2fe8fb19SBen Gras.\" Copyright (c) 1985, 1991, 1993 4*2fe8fb19SBen Gras.\" The Regents of the University of California. All rights reserved. 5*2fe8fb19SBen Gras.\" 6*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without 7*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions 8*2fe8fb19SBen Gras.\" are met: 9*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright 10*2fe8fb19SBen Gras.\" notice, this list of conditions and the following disclaimer. 11*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright 12*2fe8fb19SBen Gras.\" notice, this list of conditions and the following disclaimer in the 13*2fe8fb19SBen Gras.\" documentation and/or other materials provided with the distribution. 14*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors 15*2fe8fb19SBen Gras.\" may be used to endorse or promote products derived from this software 16*2fe8fb19SBen Gras.\" without specific prior written permission. 17*2fe8fb19SBen Gras.\" 18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21*2fe8fb19SBen Gras.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28*2fe8fb19SBen Gras.\" SUCH DAMAGE. 29*2fe8fb19SBen Gras.\" 30*2fe8fb19SBen Gras.\" @(#)getusershell.3 8.1 (Berkeley) 6/4/93 31*2fe8fb19SBen Gras.\" 32*2fe8fb19SBen Gras.Dd November 23, 2004 33*2fe8fb19SBen Gras.Dt GETUSERSHELL 3 34*2fe8fb19SBen Gras.Os 35*2fe8fb19SBen Gras.Sh NAME 36*2fe8fb19SBen Gras.Nm getusershell , 37*2fe8fb19SBen Gras.Nm setusershell , 38*2fe8fb19SBen Gras.Nm endusershell 39*2fe8fb19SBen Gras.Nd get valid user shells 40*2fe8fb19SBen Gras.Sh LIBRARY 41*2fe8fb19SBen Gras.Lb libc 42*2fe8fb19SBen Gras.Sh SYNOPSIS 43*2fe8fb19SBen Gras.In unistd.h 44*2fe8fb19SBen Gras.Ft char * 45*2fe8fb19SBen Gras.Fn getusershell void 46*2fe8fb19SBen Gras.Ft void 47*2fe8fb19SBen Gras.Fn setusershell void 48*2fe8fb19SBen Gras.Ft void 49*2fe8fb19SBen Gras.Fn endusershell void 50*2fe8fb19SBen Gras.Sh DESCRIPTION 51*2fe8fb19SBen GrasThe 52*2fe8fb19SBen Gras.Fn getusershell 53*2fe8fb19SBen Grasfunction 54*2fe8fb19SBen Grasreturns a pointer to a valid user shell as defined by the 55*2fe8fb19SBen Grassystem manager in the shells database as described in 56*2fe8fb19SBen Gras.Xr shells 5 . 57*2fe8fb19SBen GrasIf the shells database is not available, 58*2fe8fb19SBen Gras.Fn getusershell 59*2fe8fb19SBen Grasbehaves as if 60*2fe8fb19SBen Gras.Pa /bin/sh 61*2fe8fb19SBen Grasand 62*2fe8fb19SBen Gras.Pa /bin/csh 63*2fe8fb19SBen Graswere listed. 64*2fe8fb19SBen Gras.Pp 65*2fe8fb19SBen GrasThe 66*2fe8fb19SBen Gras.Fn getusershell 67*2fe8fb19SBen Grasfunction 68*2fe8fb19SBen Grasreads the next 69*2fe8fb19SBen Grasline (opening the file if necessary); 70*2fe8fb19SBen Gras.Fn setusershell 71*2fe8fb19SBen Grasrewinds the file; 72*2fe8fb19SBen Gras.Fn endusershell 73*2fe8fb19SBen Grascloses it. 74*2fe8fb19SBen Gras.Sh FILES 75*2fe8fb19SBen Gras.Bl -tag -width /etc/shells -compact 76*2fe8fb19SBen Gras.It Pa /etc/shells 77*2fe8fb19SBen Gras.El 78*2fe8fb19SBen Gras.Sh DIAGNOSTICS 79*2fe8fb19SBen GrasThe routine 80*2fe8fb19SBen Gras.Fn getusershell 81*2fe8fb19SBen Grasreturns a null pointer (0) on 82*2fe8fb19SBen Gras.Dv EOF . 83*2fe8fb19SBen Gras.Sh SEE ALSO 84*2fe8fb19SBen Gras.Xr nsswitch.conf 5 , 85*2fe8fb19SBen Gras.Xr shells 5 86*2fe8fb19SBen Gras.Sh HISTORY 87*2fe8fb19SBen GrasThe 88*2fe8fb19SBen Gras.Fn getusershell 89*2fe8fb19SBen Grasfunction appeared in 90*2fe8fb19SBen Gras.Bx 4.3 . 91*2fe8fb19SBen Gras.Sh BUGS 92*2fe8fb19SBen GrasThe 93*2fe8fb19SBen Gras.Fn getusershell 94*2fe8fb19SBen Grasfunction leaves its result in an internal static object and returns 95*2fe8fb19SBen Grasa pointer to that object. 96*2fe8fb19SBen GrasSubsequent calls to 97*2fe8fb19SBen Gras.Fn getusershell 98*2fe8fb19SBen Graswill modify the same object. 99