path: root/sconsign.1

'\" t
.\"     Title: SCONSIGN
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 07/30/2022
.\"    Manual: SCons 4.4.0
.\"    Source: SCons 4.4.0
.\"  Language: English
.\"
.TH "SCONSIGN" "1" "07/30/2022" "SCons 4\&.4\&.0" "SCons 4\&.4\&.0"
.\" -----------------------------------------------------------------
.\" * 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
Displays the contents of one or more
sconsign files, the signature database files used by the
SCons
build tool\&.
.PP
By default,
\fBsconsign\fR
dumps the entire contents of the sconsign file(s)\&. Without options, individual dependency entries are printed in the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
depfile: signature timestamp length
        implicit_dependency_1: content_signature timestamp length
        implicit_dependency_2: content_signature timestamp length
        \&.\&.\&.
        action_signature [action string]
.fi
.if n \{\
.RE
.\}
.PP
\fBNone\fR
is printed in place of any missing timestamp,
content signature
(\fBcsig\fR) or
build action signature
values for any entry or any of its dependencies\&. If the entry has no implicit dependencies, or no build action, those lines are omitted\&.
.PP
By default,
\fBsconsign\fR
assumes that any
\fIfile\fR
arguments that end with a
\&.dblite
suffix contains signature entries for more than one directory (that is, was specified by the
\fBSConsignFile\fR
function)\&. Any
\fIfile\fR
argument that has no suffix is assumed to be an old\-style sconsign 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 by default\&.
.SH "OPTIONS"
.PP
Various options control what information is printed and the format:
.PP
\fB\-a\fR, \fB\-\-act\fR, \fB\-\-action\fR
.RS 4
Prints only the build action information for all entries or the specified entries\&.
.RE
.PP
\fB\-c\fR, \fB\-\-csig\fR
.RS 4
Prints only the content signature (csig) information for all entries or the specified entries\&.
.RE
.PP
\fB\-d \fR\fB\fIDIRECTORY\fR\fR, \fB\-\-dir=\fR\fB\fIDIRECTORY\fR\fR
.RS 4
When the signatures are being read from a
\&.dblite
file, or the
\fB\-f dblite\fR
or
\fB\-\-format=dblite\fR
options are used, prints information about only the signatures for entries in the specified
\fIDIRECTORY\fR\&.
.RE
.PP
\fB\-e \fR\fB\fIENTRY\fR\fR, \fB\-\-entry=\fR\fB\fIENTRY\fR\fR
.RS 4
Prints information about only the specified
\fIENTRY\fR\&. Multiple
\fB\-e\fR
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
\fB\-f \fR\fB\fIFORMAT\fR\fR, \fB\-\-format=\fR\fB\fIFORMAT\fR\fR
.RS 4
The file(s) to be printed are in the specified
\fIFORMAT\fR\&. Legal values are
\fBdblite\fR
(the SCons\&.dblite format used by default, as well as when the
\fBSConsignFile\fR
function is called, except when a filename argument of
\fBNone\fR
is given) and
\fBsconsign\fR
(the format used for an individual
\&.sconsign
file in each directory)\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Prints a help message and exits\&.
.RE
.PP
\fB\-i\fR, \fB\-\-implicit\fR
.RS 4
Prints the list of cached implicit dependencies for all entries or for the specified entries\&.
.RE
.PP
\fB\-\-raw\fR
.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
\fB\-r\fR, \fB\-\-readable\fR
.RS 4
Prints timestamps in a human\-readable string, enclosed in single quotes\&.
.RE
.PP
\fB\-t\fR, \fB\-\-timestamp\fR
.RS 4
Prints the timestamp information for all entries or the specified entries\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Prints labels identifying each field being printed\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBSCONS_LIB_DIR\fR
.RS 4
Specifies the directory that contains the SCons Python module directory (e\&.g\&.
/home/aroach/scons\-src/SCons)\&.
.RE
.SH "SEE ALSO"
.PP

\fBscons\fR, the SCons User Guide at
\m[blue]\fB\%https://scons.org/doc/production/HTML/scons-user.html\fR\m[], the SCons source code
\m[blue]\fBon GitHub\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "AUTHORS"
.PP
Originally: Steven Knight
knight@baldmt\&.com
and Anthony Roach
aroach@electriceyeball\&.com\&.
.PP
Since 2010: The SCons Development Team
scons\-dev@scons\&.org\&.
.SH "NOTES"
.IP " 1." 4
on GitHub
.RS 4
\%https://github.com/SCons/scons
.RE