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