usr/src/tools/scripts/cddlchk.1

   1 .\" CDDL HEADER START
   2 .\"
   3 .\" The contents of this file are subject to the terms of the
   4 .\" Common Development and Distribution License (the "License").
   5 .\" You may not use this file except in compliance with the License.
   6 .\"
   7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" or http://www.opensolaris.org/os/licensing.
   9 .\" See the License for the specific language governing permissions
  10 .\" and limitations under the License.
  11 .\"
  12 .\" When distributing Covered Code, include this CDDL HEADER in each
  13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" If applicable, add the following below this CDDL HEADER, with the
  15 .\" fields enclosed by brackets "[]" replaced with your own identifying
  16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17 .\"
  18 .\" CDDL HEADER END
  19 .\"
  20 .\" Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  21 .\" Use is subject to license terms.
  22 .\"
  23 .TH CDDLCHK 1ONBLD "Jun 1, 2008"
  24 .SH NAME
  25 cddlchk \- Check for valid CDDL header blocks
  26 .SH SYNOPSIS
  27 .nf
  28 \fBcddlchk \fR [\fB-av\fR] [\fB-x\fR \fIexceptions_file\fR] [\fIpath\fR...]
  29 .fi
  30 .SH DESCRIPTION
  31 cddlchk inspects files for missing, obsolete, or corrupt Common
  32 Development and Distribution License (CDDL) header blocks.
  33 .SH OPTIONS
  34 .TP 4
  35 .B \-a
  36 Check that all the specified files have a CDDL block, and report a
  37 warning if any do not.
  38 If this flag is not specified, only files containing an existing CDDL
  39 block are validated.
  40 .TP 4
  41 .B \-v
  42 Report on all files, not just those with invalid headers
  43 .TP 4
  44 .B \-x \fIexceptions_file\fR
  45 Load an exceptions file containing a list of files, directories and
  46 file extensions to be ignored.
  47 Exceptions may be one of three types:
  48 .RS +4
  49 .TP
  50 .ie t \(bu
  51 .el o
  52 File paths
  53 .RE
  54 .RS +4
  55 .TP
  56 .ie t \(bu
  57 .el o
  58 Directories, specified with a trailing '/'
  59 .RE
  60 .RS +4
  61 .TP
  62 .ie t \(bu
  63 .el o
  64 File extensions, specified with a leading '*.'
  65 .RE
  66 .SH EXIT STATUS
  67 .TP 4
  68 .B 0
  69 The command completed successfully.
  70 No errors or warnings were reported
  71 .TP 4
  72 .B 1
  73 The command completed unsuccessfully.
  74 One or more errors or warnings were reported.
  75 .TP 4
  76 .B 2
  77 Invalid command-line arguments were specified to the command.