usr/src/tools/scripts/mapfilechk.1onbld

   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 .TH MAPFILECHK 1ONBLD "Jan 27, 2009"
  23 .SH NAME
  24 mapfilechk \- Check for valid link-editor mapfile header blocks
  25 .SH SYNOPSIS
  26 .nf
  27 \fBmapfilechk \fR [\fB-v\fR] [\fB-x\fR \fIexceptions_file\fR] [\fIpath\fR...]
  28 .fi
  29 .SH DESCRIPTION
  30 mapfilechk inspects link-editor mapfiles for missing, obsolete,
  31 or corrupt mapfile header blocks.
  32 .SH OPTIONS
  33 .TP 4
  34 .B \-v
  35 Report on all files, not just those with invalid headers
  36 .TP 4
  37 .B \-x \fIexceptions_file\fR
  38 Load an exceptions file containing a list of files, directories and
  39 file extensions to be ignored.
  40 Exceptions may be one of three types:
  41 .RS +4
  42 .TP
  43 .ie t \(bu
  44 .el o
  45 File paths
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 Directories, specified with a trailing '/'
  52 .RE
  53 .RS +4
  54 .TP
  55 .ie t \(bu
  56 .el o
  57 File extensions, specified with a leading '*.'
  58 .RE
  59 .SH EXIT STATUS
  60 .TP 4
  61 .B 0
  62 The command completed successfully.
  63 No errors or warnings were reported
  64 .TP 4
  65 .B 1
  66 The command completed unsuccessfully.
  67 One or more errors or warnings were reported.
  68 .TP 4
  69 .B 2
  70 Invalid command-line arguments were specified to the command.