xref: /netbsd-src/external/bsd/openpam/dist/bin/su/su.1 (revision 9ddb6ab554e70fb9bbd90c3d96b812bc57755a14)
1.\"	$NetBSD: su.1,v 1.2 2011/12/25 22:27:55 christos Exp $
2.\"
3.\"-
4.\" Copyright (c) 2011 Dag-Erling Smørgrav
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" Id: su.1 458 2011-11-02 13:10:25Z des
29.\"
30.Dd November 2, 2011
31.Dt SU 1
32.Os
33.Sh NAME
34.Nm su
35.Nd switch user identity
36.Sh SYNOPSYS
37.Nm
38.Op Ar login Op Ar ...
39.Sh DESCRIPTION
40The
41.Nm
42utility starts a shell under the identity of the user specified by the
43first argument on the command line.
44If no user is specified, the default is
45.Dq root .
46.Pp
47Any additional command-line arguments are passed as-is to the shell.
48.Pp
49The requesting user is authenticated using the
50.Dq su
51PAM policy.
52.Sh IMPLEMENTATION NOTES
53The
54.Nm
55utility is provided with the OpenPAM library as a sample application
56and should not be used in production systems.
57.Sh SEE ALSO
58.Xr openpam 3
59.Xr pam 3
60.Sh AUTHORS
61The
62.Nm
63utility and this manual page were written by
64.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
65