Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>


   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 findunref 1ONBLD "Oct 30, 2012"
  23 .I findunref
  24 \- find unused files in a source tree
  25 .SH SYNOPSIS
  26 findunref [\fB-s\fP \fIsubtree\fP] [\fB-t\fP \fItstampfile\fP]
  27 [\fB-S\fP \fBhg\fP|\fBtw\fP|\fBgit\fP] \fIsrcroot\fP \fIexceptfile\fP
  28 .LP
  29 .SH DESCRIPTION
  30 .IX "OS-Net build tools" "findunref" "" "\fBfindunref\fP"
  31 .LP
  32 The findunref utility lists the files in a source tree which have not been
  33 accessed more recently than a particular timestamp file.  Although
  34 findunref may be used on its own, it is usually invoked by
  35 \fBnightly\fP(1ONBLD) to find files that are never referenced during a given
  36 build (see \fB-f\fP in \fBnightly\fP(1ONBLD)).
  37 .LP
  38 The root of the source tree to examine is specified by \fIsrcroot\fP.  To
  39 simplify comparing findunref output from different source trees, findunref
  40 outputs all filenames relative to \fIsrcroot\fP.
  41 .LP
  42 Some files in a source tree may be intentionally unreferenced (e.g.,
  43 documentation) or only referenced during specialized types of builds.
  44 Accordingly, \fIexceptfile\fP names a file containing a list of pathname
  45 globs that will be ignored by findunref.  Within \fIexceptfile\fP, any
  46 lines consisting solely of whitespace or starting with \fB#\fP will be
  47 ignored.  Directory globs may also be specified, which will cause any
  48 matching directories to be skipped entirely.  If no exceptions are
  49 desired, \fIexceptfile\fP can be \fB/dev/null\fP.
  50 .LP




   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 FINDUNREF 1ONBLD "Oct 30, 2012"
  23 .I findunref
  24 \- find unused files in a source tree
  25 .SH SYNOPSIS
  26 findunref [\fB-s\fP \fIsubtree\fP] [\fB-t\fP \fItstampfile\fP]
  27 [\fB-S\fP \fBhg\fP|\fBtw\fP|\fBgit\fP] \fIsrcroot\fP \fIexceptfile\fP

  28 .SH DESCRIPTION

  29 .LP
  30 The findunref utility lists the files in a source tree which have not been
  31 accessed more recently than a particular timestamp file.  Although
  32 findunref may be used on its own, it is usually invoked by
  33 \fBnightly\fP(1ONBLD) to find files that are never referenced during a given
  34 build (see \fB-f\fP in \fBnightly\fP(1ONBLD)).
  35 .LP
  36 The root of the source tree to examine is specified by \fIsrcroot\fP.  To
  37 simplify comparing findunref output from different source trees, findunref
  38 outputs all filenames relative to \fIsrcroot\fP.
  39 .LP
  40 Some files in a source tree may be intentionally unreferenced (e.g.,
  41 documentation) or only referenced during specialized types of builds.
  42 Accordingly, \fIexceptfile\fP names a file containing a list of pathname
  43 globs that will be ignored by findunref.  Within \fIexceptfile\fP, any
  44 lines consisting solely of whitespace or starting with \fB#\fP will be
  45 ignored.  Directory globs may also be specified, which will cause any
  46 matching directories to be skipped entirely.  If no exceptions are
  47 desired, \fIexceptfile\fP can be \fB/dev/null\fP.
  48 .LP