- Add further functionality to check for invalid characters
[dragonfly.git] / usr.sbin / chkgrp / chkgrp.8
1 .\" Copyright (c) 1998 Dag-Erling Coïdan Smørgrav
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer
9 .\"    in this position and unchanged.
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 products
14 .\"    derived from this software without specific prior written permission
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/usr.sbin/chkgrp/chkgrp.8,v 1.7.2.3 2001/08/16 15:55:42 ru Exp $
28 .\" $DragonFly: src/usr.sbin/chkgrp/chkgrp.8,v 1.3 2005/04/24 14:36:55 liamfoy Exp $
29 .\"
30 .Dd May 5, 1998
31 .Dt CHKGRP 8
32 .Os
33 .Sh NAME
34 .Nm chkgrp
35 .Nd check the syntax of the group file
36 .Sh SYNOPSIS
37 .Nm
38 .Op Ar groupfile
39 .Sh DESCRIPTION
40 The
41 .Nm
42 utility
43 scans the given file or, failing that, the system-wide group file for
44 errors.
45 Specifically, it checks that every non-blank, non-comment
46 entry is composed of four colon-separated fields, that none of them
47 contains whitespace, and that the third field (the group ID) is
48 numeric. It will also check for invalid characters in the group names
49 and group members.
50 .Sh FILES
51 .Bl -tag -width /etc/group -compact
52 .It Pa /etc/group
53 group database file
54 .El
55 .Sh SEE ALSO
56 .Xr getgrent 3 ,
57 .Xr group 5
58 .Sh DIAGNOSTICS
59 For each error found,
60 .Nm
61 will print an error message containing the name of the file being
62 scanned and the line number on which the error was found.
63 .Pp
64 The
65 .Nm
66 utility returns
67 .Dv EX_DATAERR
68 if errors were found in the group file,
69 and
70 .Dv EX_OK
71 otherwise.
72 .Sh HISTORY
73 The
74 .Nm
75 utility appeared in
76 .Fx 3.0 .
77 .Sh AUTHORS
78 The
79 .Nm
80 utility and this manual page were written by
81 .An Dag-Erling Co\(:idan Sm\(/orgrav Aq des@FreeBSD.org .
82 .Pp
83 Further functionality was added by
84 .An Liam J. Foy Aq liamfoy@dragonflybsd.org .
85 .Sh BUGS
86 Should check the range of the group ID.