185 lines
5.1 KiB
Groff
185 lines
5.1 KiB
Groff
'\" t
|
|
.\" Title: SCONSIGN
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 12/17/2019
|
|
.\" Manual: SCons 3.1.2
|
|
.\" Source: SCons 3.1.2
|
|
.\" Language: English
|
|
.\"
|
|
.TH "SCONSIGN" "1" "12/17/2019" "SCons 3\&.1\&.2" "SCons 3\&.1\&.2"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
sconsign \- print SCons signature file information
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBsconsign\fR\ 'u
|
|
\fBsconsign\fR [\fIoptions\fR...] [\fIfile\fR...]
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The
|
|
\fBsconsign\fR
|
|
command displays the contents of one or more signature ("\fBsconsign\fR") files specified by the user\&.
|
|
.PP
|
|
By default,
|
|
\fBsconsign\fR
|
|
dumps the entire contents of the specified file(s)\&. Without the verbose option, each entry is printed in the following format:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
file: signature timestamp length
|
|
implicit_dependency_1: signature timestamp length
|
|
implicit_dependency_2: signature timestamp length
|
|
\&.\&.\&.
|
|
action_signature [action string]
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
\fBNone\fR
|
|
is printed in place of any missing timestamp, build signature ("bsig"), or content signature ("csig") values for any entry or any of its dependencies\&. If the entry has no implicit dependencies, or no build action, the lines are simply omitted\&. The verbose option expands the display into a more human readable format\&.
|
|
.PP
|
|
By default,
|
|
\fBsconsign\fR
|
|
assumes that any
|
|
\fIfile\fR
|
|
arguments that end with a
|
|
\fB\&.dbm\fR
|
|
suffix contains signature entries for more than one directory (that is, was specified by the
|
|
\fBSConsignFile\fR
|
|
function)\&. Any
|
|
\fIfile\fR
|
|
argument that ends in
|
|
\fB\&.dblite\fR
|
|
is assumed to be a traditional
|
|
\fB\&.sconsign\fR
|
|
file containing the signature entries for a single directory\&. If neither of those is true,
|
|
\fBsconsign\fR
|
|
attempts to guess the format\&. If that does not work, an explicit format may be specified using the
|
|
\fB\-f\fR
|
|
or
|
|
\fB\-\-format=\fR
|
|
options\&.
|
|
.PP
|
|
If there are no
|
|
\fIfile\fR
|
|
arguments, the name
|
|
\&.sconsign\&.dblite
|
|
is assumed\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
Various options control what information is printed and the format:
|
|
.PP
|
|
\-a, \-\-act, \-\-action
|
|
.RS 4
|
|
Prints the build action information for all entries or the specified entries\&.
|
|
.RE
|
|
.PP
|
|
\-c, \-\-csig
|
|
.RS 4
|
|
Prints the content signature (csig) information for all entries or the specified entries\&.
|
|
.RE
|
|
.PP
|
|
\-d DIRECTORY, \-\-dir=DIRECTORY
|
|
.RS 4
|
|
When the signatures are being read from a
|
|
\fB\&.dbm\fR
|
|
file, or the
|
|
\fB\-f dbm\fR
|
|
or
|
|
\fB\-\-format=dbm\fR
|
|
options are used, prints information about only the signatures for entries in the specified
|
|
\fIDIRECTORY\fR\&.
|
|
.RE
|
|
.PP
|
|
\-e ENTRY, \-\-entry=ENTRY
|
|
.RS 4
|
|
Prints information about only the specified
|
|
\fIENTRY\fR\&. Multiple \-e options may be used, in which case information about each
|
|
\fIENTRY\fR
|
|
is printed in the order in which the options are specified on the command line\&.
|
|
.RE
|
|
.PP
|
|
\-f FORMAT, \-\-format=FORMAT
|
|
.RS 4
|
|
The file(s) to be printed are in the specified
|
|
\fIFORMAT\fR\&. Legal values are
|
|
\fBdbm\fR
|
|
(the DBM format used when the
|
|
\fBSConsignFile\fR
|
|
function is used) or
|
|
\fBsconsign\fR
|
|
(the default format used for an individual
|
|
\fB\&.sconsign\fR
|
|
file in each directory)\&.
|
|
.RE
|
|
.PP
|
|
\-h, \-\-help
|
|
.RS 4
|
|
Prints a help message and exits\&.
|
|
.RE
|
|
.PP
|
|
\-i, \-\-implicit
|
|
.RS 4
|
|
Prints the list of cached implicit dependencies for all entries or for the specified entries\&.
|
|
.RE
|
|
.PP
|
|
\-\-raw
|
|
.RS 4
|
|
Prints a pretty\-printed representation of the raw Python dictionary that holds build information about individual entries (both the entry itself and its implicit dependencies)\&. An entry\*(Aqs build action is still printed in its usual format\&.
|
|
.RE
|
|
.PP
|
|
\-r, \-\-readable
|
|
.RS 4
|
|
Prints timestamps in a human\-readable string, enclosed in single quotes\&.
|
|
.RE
|
|
.PP
|
|
\-t, \-\-timestamp
|
|
.RS 4
|
|
Prints the timestamp information for all entries or the specified entries\&.
|
|
.RE
|
|
.PP
|
|
\-v, \-\-verbose
|
|
.RS 4
|
|
Prints labels identifying each field being printed\&.
|
|
.RE
|
|
.SH "ENVIRONMENT"
|
|
.PP
|
|
SCONS_LIB_DIR
|
|
.RS 4
|
|
Specifies the directory that contains the SCons Python module directory (e\&.g\&.
|
|
/home/aroach/scons\-src\-0\&.01/src/engine)\&. on the command line\&.
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBscons\fR,
|
|
\fBscons\fR
|
|
User Manual,
|
|
\fBscons\fR
|
|
Design Document,
|
|
\fBscons\fR
|
|
source code\&.
|
|
.SH "AUTHORS"
|
|
.PP
|
|
Steven Knight <knight at baldmt dot com>
|