lib/libc/gen/getusershell.3

   1 .\"     $NetBSD: getusershell.3,v 1.6 1999/03/22 19:44:42 garbled 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 .\" $FreeBSD: src/lib/libc/gen/getusershell.3,v 1.12 2007/01/09 00:27:54 imp Exp $
  32 .\" $DragonFly: src/lib/libc/gen/getusershell.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  33 .\"
  34 .Dd January 16, 1999
  35 .Dt GETUSERSHELL 3
  36 .Os
  37 .Sh NAME
  38 .Nm getusershell ,
  39 .Nm setusershell ,
  40 .Nm endusershell
  41 .Nd get valid user shells
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft char *
  47 .Fn getusershell void
  48 .Ft void
  49 .Fn setusershell void
  50 .Ft void
  51 .Fn endusershell void
  52 .Sh DESCRIPTION
  53 The
  54 .Fn getusershell
  55 function
  56 returns a pointer to a valid user shell as defined by the
  57 system manager in the shells database as described in
  58 .Xr shells 5 .
  59 If the shells database is not available,
  60 .Fn getusershell
  61 behaves as if
  62 .Pa /bin/sh
  63 and
  64 .Pa /bin/csh
  65 were listed.
  66 .Pp
  67 The
  68 .Fn getusershell
  69 function
  70 reads the next
  71 line (opening the file if necessary);
  72 .Fn setusershell
  73 rewinds the file;
  74 .Fn endusershell
  75 closes it.
  76 .Sh FILES
  77 .Bl -tag -width /etc/shells -compact
  78 .It Pa /etc/shells
  79 .El
  80 .Sh DIAGNOSTICS
  81 The routine
  82 .Fn getusershell
  83 returns a null pointer (0) on
  84 .Dv EOF .
  85 .Sh SEE ALSO
  86 .Xr nsswitch.conf 5 ,
  87 .Xr shells 5
  88 .Sh HISTORY
  89 The
  90 .Fn getusershell
  91 function appeared in
  92 .Bx 4.3 .
  93 .Sh BUGS
  94 The
  95 .Fn getusershell
  96 function leaves its result in an internal static object and returns
  97 a pointer to that object.
  98 Subsequent calls to
  99 .Fn getusershell
 100 will modify the same object.