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