xref: /netbsd-src/external/bsd/openpam/dist/bin/su/su.1 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: su.1,v 1.8 2017/05/06 19:50:09 christos Exp $
2.\"
3.\"-
4.\" Copyright (c) 2011-2017 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.\" 3. The name of the author may not be used to endorse or promote
16.\"    products derived from this software without specific prior written
17.\"    permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\" $OpenPAM: su.1 939 2017-04-30 21:36:50Z des $
32.\"
33.Dd April 30, 2017
34.Dt SU 1
35.Os
36.Sh NAME
37.Nm su
38.Nd switch user identity
39.Sh SYNOPSIS
40.Nm
41.Op Ar login Op Ar ...
42.Sh DESCRIPTION
43The
44.Nm
45utility starts a shell under the identity of the user specified by the
46first argument on the command line.
47If no user is specified, the default is
48.Dq root .
49.Pp
50Any additional command-line arguments are passed as-is to the shell.
51.Pp
52The requesting user is authenticated using the
53.Dq su
54PAM policy.
55.Sh IMPLEMENTATION NOTES
56The
57.Nm
58utility is provided with the OpenPAM library as a sample application
59and should not be used in production systems.
60.Sh SEE ALSO
61.Xr openpam 3 ,
62.Xr pam 3
63.Sh AUTHORS
64The
65.Nm
66utility and this manual page were written by
67.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
68