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