OLD | NEW |
(Empty) | |
| 1 .\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The
SCons Foundation |
| 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 .\" doc/man/sconsign.1 5134 2010/08/16 23:02:40 bdeegan |
| 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 "August 2010" |
| 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: signature timestamp length |
| 60 implicit_dependency_1: signature timestamp length |
| 61 implicit_dependency_2: signature timestamp length |
| 62 action_signature [action string] |
| 63 |
| 64 .B None |
| 65 is printed |
| 66 in place of any missing timestamp, bsig, or csig |
| 67 values for |
| 68 any entry |
| 69 or any of its dependencies. |
| 70 If the entry has no implicit dependencies, |
| 71 or no build action, |
| 72 the lines are simply omitted. |
| 73 |
| 74 By default, |
| 75 .B sconsign |
| 76 assumes that any |
| 77 .I file |
| 78 arguments that end with a |
| 79 .B .dbm |
| 80 suffix contains |
| 81 signature entries for |
| 82 more than one directory |
| 83 (that is, |
| 84 was specified by the |
| 85 .B SConsignFile () |
| 86 function). |
| 87 Any |
| 88 .I file |
| 89 argument that does not end in |
| 90 .B .dbm |
| 91 is assumed to be a traditional |
| 92 .B .sconsign |
| 93 file containing the signature entries |
| 94 for a single directory. |
| 95 An explicit format |
| 96 may be specified using the |
| 97 .B -f |
| 98 or |
| 99 .B --file= |
| 100 options. |
| 101 |
| 102 .SH OPTIONS |
| 103 |
| 104 Various options control what information is printed |
| 105 and the format: |
| 106 |
| 107 .TP |
| 108 -a, --act, --action |
| 109 Prints the build action information |
| 110 for all entries or the specified entries. |
| 111 |
| 112 .TP |
| 113 -c, --csig |
| 114 Prints the content signature (csig) information |
| 115 for all entries or the specified entries. |
| 116 |
| 117 .TP |
| 118 -d DIRECTORY, --dir=DIRECTORY |
| 119 When the signatures are being |
| 120 read from a |
| 121 .B .dbm |
| 122 file, or the |
| 123 .B -f dbm |
| 124 or |
| 125 .B --format=dbm |
| 126 options are used, |
| 127 prints information about |
| 128 only the signatures |
| 129 for entries in the specified |
| 130 .IR DIRECTORY . |
| 131 |
| 132 .TP |
| 133 -e ENTRY, --entry=ENTRY |
| 134 Prints information about only the specified |
| 135 .IR ENTRY . |
| 136 Multiple -e options may be used, |
| 137 in which case information about each |
| 138 .I ENTRY |
| 139 is printed in the order in which the |
| 140 options are specified on the command line. |
| 141 |
| 142 .TP |
| 143 -f FORMAT, --format=FORMAT |
| 144 The file(s) to be printed |
| 145 are in the specified |
| 146 .IR FORMAT . |
| 147 Legal values are |
| 148 .B dbm |
| 149 (the DBM format used |
| 150 when the |
| 151 .BR SConsignFile () |
| 152 function is used) |
| 153 or |
| 154 .B sconsign |
| 155 (the default format |
| 156 used for an individual |
| 157 .B .sconsign |
| 158 file in each directory). |
| 159 |
| 160 .TP |
| 161 -h, --help |
| 162 Prints a help message and exits. |
| 163 |
| 164 .TP |
| 165 -i, --implicit |
| 166 Prints the list of cached implicit dependencies |
| 167 for all entries or the the specified entries. |
| 168 |
| 169 .TP |
| 170 --raw |
| 171 Prints a pretty-printed representation |
| 172 of the raw Python dictionary that holds |
| 173 build information about individual entry |
| 174 (both the entry itself or its implicit dependencies). |
| 175 An entry's build action is still printed in its usual format. |
| 176 |
| 177 .TP |
| 178 -r, --readable |
| 179 Prints timestamps in a human-readable string, |
| 180 enclosed in single quotes. |
| 181 |
| 182 .TP |
| 183 -t, --timestamp |
| 184 Prints the timestamp information |
| 185 for all entries or the specified entries. |
| 186 |
| 187 .TP |
| 188 -v, --verbose |
| 189 Prints labels identifying each field being printed. |
| 190 |
| 191 .SH ENVIRONMENT |
| 192 |
| 193 .IP SCONS_LIB_DIR |
| 194 Specifies the directory that contains the SCons Python module directory |
| 195 (e.g. /home/aroach/scons-src-0.01/src/engine). |
| 196 on the command line. |
| 197 |
| 198 .SH "SEE ALSO" |
| 199 .BR scons , |
| 200 .B scons |
| 201 User Manual, |
| 202 .B scons |
| 203 Design Document, |
| 204 .B scons |
| 205 source code. |
| 206 |
| 207 .SH AUTHORS |
| 208 Steven Knight <knight at baldmt dot com> |
OLD | NEW |