xref: /openbsd/usr.sbin/user/groupinfo.8 (revision 4bdff4be)
1.\" $OpenBSD: groupinfo.8,v 1.15 2016/11/29 03:59:31 jsg Exp $
2.\" $NetBSD: groupinfo.8,v 1.3 2000/10/03 19:32:23 bjh21 Exp $
3.\"
4.\" Copyright (c) 1999 Alistair G. Crooks.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote
15.\"    products derived from this software without specific prior written
16.\"    permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
19.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
24.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\"
31.Dd $Mdocdate: November 29 2016 $
32.Dt GROUPINFO 8
33.Os
34.Sh NAME
35.Nm groupinfo
36.Nd display group information
37.Sh SYNOPSIS
38.Nm groupinfo
39.Op Fl e
40.Ar group
41.Sh DESCRIPTION
42The
43.Nm
44utility displays the name, group ID (GID),
45and members of the specified
46.Ar group .
47.Pp
48The options are as follows:
49.Bl -tag -width Ds
50.It Fl e
51Do not display anything (quiet mode).
52This form of the command is useful for
53scripts which need to check whether a particular group
54name or GID is already in use on the system.
55.El
56.Pp
57The
58.Ar group
59argument may be either a group name or a GID.
60.Sh EXIT STATUS
61The
62.Nm
63utility exits 0 if
64.Ar group
65exists, and non-zero if it does not.
66.Sh SEE ALSO
67.Xr group 5 ,
68.Xr passwd 5 ,
69.Xr group 8 ,
70.Xr userinfo 8
71.Sh HISTORY
72The
73.Nm
74utility first appeared in
75.Ox 2.7 .
76.Sh AUTHORS
77The
78.Nm
79utility was written by
80.An Alistair G. Crooks Aq Mt agc@NetBSD.org .
81.Sh CAVEATS
82If the specified
83.Ar group
84is the primary group of a user, but that user is not listed as a
85member of the
86.Ar group
87in the
88.Xr group 5
89file, the
90.Nm
91utility fails to list that user as a member of the
92.Ar group .
93