NetBSD/usr.bin/id/id.1

110 lines
3.4 KiB
Groff

.\" Copyright (c) 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)id.1 5.1 (Berkeley) 6/29/91
.\"
.Dd "June 29, 1991"
.Dt ID 1
.UC
.Sh NAME
.Nm id
.Nd return user identity
.Sh SYNOPSIS
.Nm id
.Op Ar user
.Nm id
.Fl G Op Fl n
.Op Ar user
.Nm id
.Fl g Op Fl nr
.Op Ar user
.Nm id
.Fl u Op Fl nr
.Op Ar user
.Sh DESCRIPTION
The
.Nm id
utility displays the user and group names and numeric IDs, of the
calling process, to the standard output.
If the real and effective IDs are different both are displayed,
otherwise only the real ID is displayed.
.Pp
If a
.Ar user
(login name or user ID)
is specified, the user and group IDs of that user are displayed.
In this case, the real and effective IDs are assumed to be the same.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl G
Display all of the different group IDs (effective, real and supplementary)
as white-space separated numbers.
.It Fl g
Display only the effective group ID as a number.
.It Fl n
Display the name of the user or group ID instead of the number.
.It Fl r
Display the real ID instead of the effective ID.
.It Fl u
Display only the effective user ID as a number.
.El
.Pp
If any of the ID numbers cannot be mapped into names, the number is displayed
instead.
.Pp
The
historic
.Xr groups 1
command is equivalent to:
.Nm id Fl Gn Op Ar user .
.Pp
The
.Nm id
utility exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr groups 1 ,
.Xr who 1 ,
.Xr whoami 1
.Sh STANDARDS
The
.Nm logname
function is expected to conform to
.St -p1003.2 .
.Sh HISTORY
The
.Nm
command is
.Ud .