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