xref: /illumos-gate/usr/src/tools/scripts/cddlchk.1onbld (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)
CDDL HEADER START

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]

CDDL HEADER END

Copyright 2009 Sun Microsystems, Inc. All rights reserved.
Use is subject to license terms.

CDDLCHK 1ONBLD "Jun 1, 2008"
NAME
cddlchk - Check for valid CDDL header blocks
SYNOPSIS
cddlchk  [-av] [-x exceptions_file] [path...]
DESCRIPTION
cddlchk inspects files for missing, obsolete, or corrupt Common Development and Distribution License (CDDL) header blocks.
OPTIONS

4 -a Check that all the specified files have a CDDL block, and report a warning if any do not. If this flag is not specified, only files containing an existing CDDL block are validated.

4 -v Report on all files, not just those with invalid headers

4 -x exceptions_file Load an exceptions file containing a list of files, directories and file extensions to be ignored. Exceptions may be one of three types:

File paths

Directories, specified with a trailing '/'

File extensions, specified with a leading '*.'

EXIT STATUS

4 0 The command completed successfully. No errors or warnings were reported

4 1 The command completed unsuccessfully. One or more errors or warnings were reported.

4 2 Invalid command-line arguments were specified to the command.