doc/man/sconsign.1

   1 .\" __COPYRIGHT__
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  15 .\" KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  16 .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 .\" NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18 .\" LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19 .\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20 .\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" __FILE__ __REVISION__ __DATE__ __DEVELOPER__
  23 .\"
  24 .\" ES - Example Start - indents and turns off line fill
  25 .de ES
  26 .RS
  27 .nf
  28 ..
  29 .\" EE - Example End - ends indent and turns line fill back on
  30 .de EE
  31 .RE
  32 .fi
  33 ..
  34 .TH SCONSIGN 1 "__MONTH_YEAR__"
  35 .SH NAME
  36 sconsign \- print SCons .sconsign file information
  37 .SH SYNOPSIS
  38 .B sconsign
  39 [
  40 .IR options ...
  41 ]
  42 .IR file
  43 [ ... ]
  44 .SH DESCRIPTION
  45
  46 The
  47 .B sconsign
  48 command
  49 displays the contents of one or more
  50 .B .sconsign
  51 files specified by the user.
  52
  53 By default,
  54 .B sconsign
  55 dumps the entire contents of the
  56 specified file(s).
  57 Each entry is printed in the following format:
  58
  59     file: timestamp bsig csig
  60             implicit_dependency_1
  61             implicit_dependency_2
  62
  63 If the entry has no timestamp, bsig, or csig, a dash
  64 .B None
  65 is printed.
  66 If the entry has no implicit dependencies,
  67 the lines are simply omitted.
  68
  69 By default,
  70 .B sconsign
  71 assumes that any
  72 .I file
  73 arguments that end with a
  74 .B .dbm
  75 suffix contains
  76 signature entries for
  77 more than one directory
  78 (that is,
  79 was specified by the
  80 .B SConsignFile ()
  81 function).
  82 Any
  83 .I file
  84 argument that does not end in
  85 .B .dbm
  86 is assumed to be a traditional
  87 .B .sconsign
  88 file containing the signature entries
  89 for a single directory.
  90 An explicit format
  91 may be specified using the
  92 .B -f
  93 or
  94 .B --file=
  95 options.
  96
  97 .SH OPTIONS
  98
  99 Various options control what information is printed
 100 and the format:
 101
 102 .TP
 103 -b, --bsig
 104 Prints the build signature (bsig) information
 105 for all entries or the specified entries.
 106
 107 .TP
 108 -c, --csig
 109 Prints the content signature (csig) information
 110 for all entries or the specified entries.
 111
 112 .TP
 113 -d DIRECTORY, --dir=DIRECTORY
 114 When the signatures are being
 115 read from a
 116 .B .dbm
 117 file, or the
 118 .B -f dbm
 119 or
 120 .B --format=dbm
 121 options are used,
 122 prints information about
 123 only the signatures
 124 for entries in the specified
 125 .IR DIRECTORY .
 126
 127 .TP
 128 -e ENTRY, --entry=ENTRY
 129 Prints information about only the specified
 130 .IR ENTRY .
 131 Multiple -e options may be used,
 132 in which case information about each
 133 .I ENTRY
 134 is printed in the order in which the
 135 options are specified on the command line.
 136
 137 .TP
 138 -f FORMAT, --format=FORMAT
 139 The file(s) to be printed
 140 are in the specified
 141 .IR FORMAT .
 142 Legal values are
 143 .B dbm
 144 (the DBM format used
 145 when the
 146 .BR SConsignFile ()
 147 function is used)
 148 or
 149 .B sconsign
 150 (the default format
 151 used for an individual
 152 .B .sconsign
 153 file in each directory).
 154
 155 .TP
 156 -h, --help
 157 Prints a help message and exits.
 158
 159 .TP
 160 -i, --implicit
 161 Prints the list of cached implicit dependencies
 162 for all entries or the the specified entries.
 163
 164 .TP
 165 --raw
 166 Prints a pretty-printed representation
 167 of the raw Python dictionary that holds
 168 build information about an entry.
 169
 170 .TP
 171 -r, --readable
 172 Prints timestamps in a human-readable string,
 173 enclosed in single quotes.
 174
 175 .TP
 176 -t, --timestamp
 177 Prints the timestamp information
 178 for all entries or the specified entries.
 179
 180 .TP
 181 -v, --verbose
 182 Prints labels identifying each field being printed.
 183
 184 .SH ENVIRONMENT
 185
 186 .IP SCONS_LIB_DIR
 187 Specifies the directory that contains the SCons Python module directory
 188 (e.g. /home/aroach/scons-src-0.01/src/engine).
 189 on the command line.
 190
 191 .SH "SEE ALSO"
 192 .BR scons ,
 193 .B scons
 194 User Manual,
 195 .B scons
 196 Design Document,
 197 .B scons
 198 source code.
 199
 200 .SH AUTHORS
 201 Steven Knight <knight at baldmt dot com>