summaryrefslogtreecommitdiff
path: root/sconsign.1
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2019-08-11 12:17:57 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2019-08-11 12:17:57 +0200
commitc8ea3b672655ddab746a7aea5a50217057b02b9e (patch)
tree01a0e712f4cf32c7140cf1a4ae14db4da4202253 /sconsign.1
parentca7be46fc0013fc037a045b6d4df73776461e821 (diff)
parentf6c9bffb15e04ea412db4df22a3851448221b85a (diff)
Diffstat (limited to 'sconsign.1')
-rw-r--r--sconsign.164
1 files changed, 42 insertions, 22 deletions
diff --git a/sconsign.1 b/sconsign.1
index 471caf4..e8a3de2 100644
--- a/sconsign.1
+++ b/sconsign.1
@@ -2,12 +2,12 @@
.\" Title: SCONSIGN
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 11/14/2017
-.\" Manual: SCons 3.0.1
-.\" Source: SCons 3.0.1
+.\" Date: 08/08/2019
+.\" Manual: SCons 3.1.1
+.\" Source: SCons 3.1.1
.\" Language: English
.\"
-.TH "SCONSIGN" "1" "11/14/2017" "SCons 3\&.0\&.1" "SCons 3\&.0\&.1"
+.TH "SCONSIGN" "1" "08/08/2019" "SCons 3\&.1\&.1" "SCons 3\&.1\&.1"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,26 +28,36 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-sconsign \- print SCons \&.sconsign file information
+sconsign \- print SCons signature file information
.SH "SYNOPSIS"
.HP \w'\fBsconsign\fR\ 'u
-\fBsconsign\fR [\fIoptions\fR...] \fIfile\fR [\fI\&.\&.\&.\fR]
+\fBsconsign\fR [\fIoptions\fR...] [\fIfile\fR...]
.SH "DESCRIPTION"
.PP
The
\fBsconsign\fR
-command displays the contents of one or more
-\fB\&.sconsign\fR
-files specified by the user\&.
+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)\&. Each entry is printed in the following format:
-.PP
-file: signature timestamp length implicit_dependency_1: signature timestamp length implicit_dependency_2: signature timestamp length action_signature [action string]
+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, bsig, or 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\&.
+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
@@ -56,18 +66,26 @@ assumes that any
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
+\fBSConsignFile\fR
function)\&. Any
\fIfile\fR
-argument that does not end in
-\fB\&.dbm\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\&. An explicit format may be specified using the
+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\-\-file=\fR
+\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:
@@ -108,7 +126,8 @@ 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
+\fBSConsignFile\fR
+function is used) or
\fBsconsign\fR
(the default format used for an individual
\fB\&.sconsign\fR
@@ -122,12 +141,12 @@ Prints a help message and exits\&.
.PP
\-i, \-\-implicit
.RS 4
-Prints the list of cached implicit dependencies for all entries or the the specified entries\&.
+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 entry (both the entry itself or its implicit dependencies)\&. An entry\*(Aqs build action is still printed in its usual format\&.
+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
@@ -148,7 +167,8 @@ Prints labels identifying each field being printed\&.
.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\&.
+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