man3/getusershell.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 19:17:53 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH GETUSERSHELL 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 getusershell, setusershell, endusershell \- get permitted user shells
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <unistd.h>
  36 .PP
  37 .B char *getusershell(void);
  38 .B void setusershell(void);
  39 .B void endusershell(void);
  40 .fi
  41 .PP
  42 .RS -4
  43 Feature Test Macro Requirements for glibc (see
  44 .BR feature_test_macros (7)):
  45 .RE
  46 .PP
  47 .BR getusershell (),
  48 .BR setusershell (),
  49 .BR endusershell ():
  50 .nf
  51     Since glibc 2.21:
  52 .\"             commit 266865c0e7b79d4196e2cc393693463f03c90bd8
  53         _DEFAULT_SOURCE
  54     In glibc 2.19 and 2.20:
  55         _DEFAULT_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  56     Up to and including glibc 2.19:
  57         _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  58 .fi
  59 .SH DESCRIPTION
  60 The
  61 .BR getusershell ()
  62 function returns the next line from the file
  63 .IR /etc/shells ,
  64 opening the file if necessary.
  65 The line should contain
  66 the pathname of a valid user shell.
  67 If
  68 .I /etc/shells
  69 does not exist or
  70 is unreadable,
  71 .BR getusershell ()
  72 behaves as if
  73 .I /bin/sh
  74 and
  75 .I /bin/csh
  76 were listed in the file.
  77 .PP
  78 The
  79 .BR setusershell ()
  80 function rewinds
  81 .IR /etc/shells .
  82 .PP
  83 The
  84 .BR endusershell ()
  85 function closes
  86 .IR /etc/shells .
  87 .SH RETURN VALUE
  88 The
  89 .BR getusershell ()
  90 function returns NULL on end-of-file.
  91 .SH FILES
  92 .I /etc/shells
  93 .SH ATTRIBUTES
  94 For an explanation of the terms used in this section, see
  95 .BR attributes (7).
  96 .ad l
  97 .nh
  98 .TS
  99 allbox;
 100 lbx lb lb
 101 l l l.
 102 Interface       Attribute       Value
 103 T{
 104 .BR getusershell (),
 105 .BR setusershell (),
 106 .BR endusershell ()
 107 T}      Thread safety   MT-Unsafe
 108 .TE
 109 .hy
 110 .ad
 111 .sp 1
 112 .SH CONFORMING TO
 113 4.3BSD.
 114 .SH SEE ALSO
 115 .BR shells (5)