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