etc/rhash.readme.htm

   1 <!-- manual page source format generated by PolyglotMan v3.2, -->
   2 <!-- available at http://polyglotman.sourceforge.net/ -->
   3
   4 <html>
   5 <head>
   6 <title>RHASH(1) manual page</title>
   7 </head>
   8 <body bgcolor='white'>
   9 <a href='#toc'>Table of Contents</a><p>
  10
  11 <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12 rhash - calculate/check CRC32, MD5, SHA1, GOST, TTH, BTIH or other hash
  13 sums.
  14 <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  15 <b>rhash [</b> <i>option</i> <b>]... [</b> <i>file</i> <b>]...</b>
  16 <h2><a name='sect2' href='#toc2'>Description</a></h2>
  17 <b>RHash</b> (Recursive Hasher)
  18 computes and verifies various message digests (hash sums) of files. Supported
  19 message digests include CRC32, MD4, MD5, SHA1, SHA256, SHA512, SHA3, Tiger,
  20 DC++ TTH, BitTorrent BTIH, AICH, ED2K, GOST R 34.11-94, RIPEMD-160, HAS-160,
  21 EDON-R 256/512, Whirlpool, Snefru-128/256.
  22 <p> The program can create and verify
  23 Magnet links  and eDonkey ed2k:// links, see --magnet and --ed2k-link options.
  24
  25 <p> A dash string parameter &lsquo;-&rsquo; is interpreted as stdin file.
  26 <p> By default <b>rhash</b>
  27 prints sums in SFV format with CRC32 hash sum only. The format can be changed
  28 by options --bsd, --magnet, --simple, --printf, --template. To output all sums use
  29 the &lsquo;-a&rsquo; option.
  30 <p> The default output format can also be changed by renaming
  31 the program or placing a hardlink/symlink to it with a name containing
  32 strings &lsquo;crc32&rsquo;, &lsquo;md4&rsquo;, &lsquo;md5&rsquo;, &lsquo;sha1&rsquo;, &lsquo;sha256&rsquo; &lsquo;sha512&rsquo;, &lsquo;tiger&rsquo;, &lsquo;tth&rsquo;, &lsquo;btih&rsquo;, &lsquo;aich&rsquo;, &lsquo;ed2k&rsquo;,
  33 &lsquo;ed2k-link&rsquo;, &lsquo;gost&rsquo;, &lsquo;gost-cryptopro&rsquo;, &lsquo;ripemd160&rsquo;, &lsquo;has160&rsquo;, &lsquo;whirlpool&rsquo;, &lsquo;edonr256&rsquo;,
  34 &lsquo;edonr512&rsquo;, &lsquo;snefru128&rsquo;, &lsquo;snefru256&rsquo;, &lsquo;sfv&rsquo; or &lsquo;magnet&rsquo;.
  35 <p>
  36 <h2><a name='sect3' href='#toc3'>Program Mode Options</a></h2>
  37 The
  38 default mode is to print hash sums for all files and directory trees specified
  39 by command line. The mode can be set by the following options.
  40 <dl>
  41
  42 <dt>-c, --check</dt>
  43 <dd>Check
  44 hash files specified by command line. RHash can verify hash files in SFV
  45 and BSD formats, standard MD5 and SHA1 files, and text files containing
  46 magnet or ed2k links (one link per line). Empty lines and lines starting
  47 with &lsquo;;&rsquo; or &lsquo;#&rsquo; are skipped. In fact RHash can verify most hash files generated
  48 by itself without formating options --printf and --template. </dd>
  49
  50 <dt>-u, --update</dt>
  51 <dd>Update
  52 hash files specified by command line. The program calculates and appends
  53 hashes to the updated hash file in the format specified by formating options.
  54 Hashes are calculated for those files from the same directory as the hash
  55 file, which are yet not present in it. </dd>
  56
  57 <dt>-k, --check-embedded</dt>
  58 <dd>Verify files by crc32
  59 sum embedded in their names. </dd>
  60
  61 <dt>--torrent</dt>
  62 <dd>Create a torrent file for each processed
  63 file. </dd>
  64
  65 <dt>-h, --help</dt>
  66 <dd>Help: print help screen and exit. </dd>
  67
  68 <dt>-V, --version</dt>
  69 <dd>Version: print version
  70 and exit. </dd>
  71
  72 <dt>-B, --benchmark</dt>
  73 <dd>Run benchmark for selected algorithm(s).
  74 <p> </dd>
  75 </dl>
  76
  77 <h2><a name='sect4' href='#toc4'>Hash Sums
  78 Options</a></h2>
  79
  80 <dl>
  81
  82 <dt>-C, --crc32</dt>
  83 <dd>CRC32: calculate and print CRC32 hash sum. </dd>
  84
  85 <dt>--md4</dt>
  86 <dd>MD4: calculate
  87 and print MD4 hash sum. </dd>
  88
  89 <dt>-M, --md5</dt>
  90 <dd>MD5: calculate and print MD5 hash sum. </dd>
  91
  92 <dt>-H, --sha1</dt>
  93 <dd>SHA1:
  94 calculate and print SHA1 hash sum. </dd>
  95
  96 <dt>--sha224, --sha256, --sha384, --sha512</dt>
  97 <dd>Calculate
  98 specified SHA2 hash sum. </dd>
  99
 100 <dt>--sha3-224, --sha3-256, --sha3-384, --sha3-512</dt>
 101 <dd>Calculate specified
 102 SHA3 hash sum. </dd>
 103
 104 <dt>--tiger</dt>
 105 <dd>Tiger: calculate and print Tiger hash sum. </dd>
 106
 107 <dt>-T, --tth</dt>
 108 <dd>TTH:
 109 calculate and print DC++ TTH sum. </dd>
 110
 111 <dt>--btih</dt>
 112 <dd>BTIH: calculate and print BitTorrent
 113 Info Hash. </dd>
 114
 115 <dt>-A, --aich</dt>
 116 <dd>AICH: calculate and print AICH hash. </dd>
 117
 118 <dt>-E, --ed2k</dt>
 119 <dd>ED2K: calculate
 120 and print eDonkey 2000 hash sum. </dd>
 121
 122 <dt>-L, --ed2k-link</dt>
 123 <dd>eDonkey link: calculate and
 124 print eDonkey link. </dd>
 125
 126 <dt>-W, --whirlpool</dt>
 127 <dd>Whirlpool: calculate and print Whirlpool
 128 hash sum. </dd>
 129
 130 <dt>-G, --gost</dt>
 131 <dd>GOST: calculate and print GOST R 34.11-94 hash,  the Russian
 132 GOST standard hash function. </dd>
 133
 134 <dt>--gost-cryptopro</dt>
 135 <dd>GOST-CRYPTOPRO: calculate and print
 136 CryptoPro version of the GOST R 34.11-94 hash function. </dd>
 137
 138 <dt>--ripemd160</dt>
 139 <dd>RIPEMD-160:
 140 calculate and print RIPEMD-160 hash sum. </dd>
 141
 142 <dt>--has160</dt>
 143 <dd>HAS-160: calculate and print
 144 HAS-160 hash sum. </dd>
 145
 146 <dt>--snefru128, --snefru256</dt>
 147 <dd>SNEFRU: calculate and print SNEFRU-128/256
 148 hash sums. </dd>
 149
 150 <dt>--edonr256, --edonr512</dt>
 151 <dd>EDON-R: calculate and print EDON-R 256/512 hash
 152 sums.
 153 <p> </dd>
 154
 155 <dt>-a, --all</dt>
 156 <dd>Calculate all supported hash sums. </dd>
 157
 158 <dt>--list-hashes</dt>
 159 <dd>List names of all
 160 supported hashes, one per line.
 161 <p> </dd>
 162 </dl>
 163
 164 <h2><a name='sect5' href='#toc5'>Miscellaneous Options</a></h2>
 165
 166 <dl>
 167
 168 <dt>-r, --recursive</dt>
 169 <dd>Process
 170 directories recursively. </dd>
 171
 172 <dt>-v, --verbose</dt>
 173 <dd>Be verbose. </dd>
 174
 175 <dt>--percents</dt>
 176 <dd>Show percents, while
 177 calculating or checking sums </dd>
 178
 179 <dt>--skip-ok</dt>
 180 <dd>Don&rsquo;t print OK messages for successfully
 181 verified files. </dd>
 182
 183 <dt>-i, --ignore-case</dt>
 184 <dd>Ignore case of filenames when updating crc
 185 files. </dd>
 186
 187 <dt>--speed</dt>
 188 <dd>Print per-file and the total processing speed. </dd>
 189
 190 <dt>-e, --embed-crc</dt>
 191 <dd>Rename
 192 files by inserting crc32 sum into name. </dd>
 193
 194 <dt>--embed-crc-delimiter=&lt;delimiter&gt;</dt>
 195 <dd>Insert
 196 specified &lt;delimiter&gt; before a crc sum in the --embed-crc mode,  default is
 197 white space. The &lt;delimiter&gt; can be a character or empty string. </dd>
 198
 199 <dt>--path-separator=&lt;separator&gt;</dt>
 200 <dd>Use
 201 specified path separator to display paths. </dd>
 202
 203 <dt>-q, --accept=&lt;list&gt;</dt>
 204 <dd>Set a comma-delimited
 205 list of extensions of the files to process. </dd>
 206
 207 <dt>--exclude=&lt;list&gt;</dt>
 208 <dd>Set a comma-delimited
 209 list of extensions of the files to exclude from processing. </dd>
 210
 211 <dt>-t, --crc-accept=&lt;list&gt;</dt>
 212 <dd>Set
 213 a comma-delimited list of extensions of the hash files to verify. </dd>
 214
 215 <dt>--maxdepth=&lt;levels&gt;</dt>
 216 <dd>Descend
 217 at most &lt;levels&gt; (a non-negative integer) levels of directories below  the
 218 command line arguments. &lsquo;--maxdepth 0&rsquo; means only apply the tests and  actions
 219 to the command line arguments. </dd>
 220
 221 <dt>-o, --output=&lt;file-path&gt;</dt>
 222 <dd>Set the file to output
 223 calculated hashes and verification results to. </dd>
 224
 225 <dt>-l, --log=&lt;file-path&gt;</dt>
 226 <dd>Set the file
 227 to log errors and verbose information to. </dd>
 228
 229 <dt>--openssl=&lt;list&gt;</dt>
 230 <dd>Specify which hash
 231 functions should be calculated using the OpenSSL library. The &lt;list&gt; is a
 232 comma delimited list of hash names, but only those supported by openssl
 233 are allowed, e.g. md4, md5, sha1, sha256, ripemd160. See openssl documentation
 234 for the full list. </dd>
 235
 236 <dt>--gost-reverse</dt>
 237 <dd>Reverse bytes in hexadecimal output of the
 238 GOST hash sum. The most significant bytes of the hash will be printed first.
 239 Default order is the least significant bytes first. </dd>
 240
 241 <dt>--bt-batch=&lt;file-path&gt;</dt>
 242 <dd>Turn
 243 on torrent batch mode (implies torrent mode). Calculates batch-torrent for
 244 the files specified at command line and saves the torrent file to the file-path.
 245 The option -r &lt;directory&gt; can be useful in this mode. </dd>
 246
 247 <dt>--bt-private</dt>
 248 <dd>Generate BTIH
 249 for a private BitTorrent tracker. </dd>
 250
 251 <dt>--bt-piece-length</dt>
 252 <dd>Set the  <i>piece length</i> value
 253 for torrent file. </dd>
 254
 255 <dt>--bt-announce=&lt;announce-url&gt;</dt>
 256 <dd>Add a tracker announce URL to the
 257 created torrent file(s). Several URLs can be passed by specifying the option
 258 mutltiple times. This option doesn&rsquo;t change the BTIH hash. </dd>
 259
 260 <dt>--benchmark-raw</dt>
 261 <dd>Switch
 262 benchmark output format to be a machine-readable tab-delimited text with
 263 hash function name, speed, cpu clocks per byte. This option works only if
 264 the --benchmark option was specified. </dd>
 265
 266 <dt>-- (double dash)</dt>
 267 <dd>Mark the end of command
 268 line options. All parameters following the double dash are interpreted as
 269 files or directories. It is typically used to process filenames starting
 270 with a dash &lsquo;-&rsquo;. Alternatively you can specify &rsquo;./&rsquo; or full path before such files,
 271 so they will not look like options anymore.
 272 <p> </dd>
 273 </dl>
 274
 275 <h2><a name='sect6' href='#toc6'>Output Format Options</a></h2>
 276
 277 <dl>
 278
 279 <dt>--ansi</dt>
 280 <dd>Use
 281 Windows codepage for output. </dd>
 282
 283 <dt>--oem</dt>
 284 <dd>Use DOS (OEM) codepage for output. </dd>
 285
 286 <dt>--utf8</dt>
 287 <dd>Use
 288 UTF-8 codepage for output. </dd>
 289
 290 <dt>--sfv</dt>
 291 <dd>Print hash sums in the SFV (Simple File Verification)
 292 output format (default).  But unlike common SFV file, not only CRC32, but
 293 any hash sums specified by options can be printed. </dd>
 294
 295 <dt>-m, --magnet</dt>
 296 <dd>Print hash sums
 297 formatted as magnet links. </dd>
 298
 299 <dt>--bsd</dt>
 300 <dd>Use BSD output format. Each hash sum is printed
 301 on separate line after hash name and file&rsquo;s path, enclosed in parentheses.
 302 </dd>
 303
 304 <dt>--simple</dt>
 305 <dd>Use simple output format. Each line will consist of filename and hash
 306 sums specified by options. </dd>
 307
 308 <dt>--uppercase</dt>
 309 <dd>Print hash sums in upper case. </dd>
 310
 311 <dt>--lowercase</dt>
 312 <dd>Print
 313 hash sums in lower case. </dd>
 314
 315 <dt>--template=&lt;file&gt;</dt>
 316 <dd>Read printf-like template from given
 317 &lt;file&gt;. See the --printf option. </dd>
 318
 319 <dt>-p, --printf=&lt;format&gt;</dt>
 320 <dd>Format: print  <i>format</i> string
 321 the standard output, interpreting &lsquo;\&rsquo;  escapes and &lsquo;%&rsquo; directives. The escapes
 322 and directives are:  <blockquote></dd>
 323
 324 <dt>\n</dt>
 325 <dd>Newline. </dd>
 326
 327 <dt>\r</dt>
 328 <dd>Carriage return. </dd>
 329
 330 <dt>\t</dt>
 331 <dd>Horizontal tab. </dd>
 332
 333 <dt>\\</dt>
 334 <dd>A literal
 335 backslash (&lsquo;\&rsquo;). </dd>
 336
 337 <dt>\0</dt>
 338 <dd>ASCII NUL. </dd>
 339
 340 <dt>\NNN</dt>
 341 <dd>The character which octal ASCII code is NNN.
 342 </dd>
 343
 344 <dt>\xNN</dt>
 345 <dd>The character which hexadecimal ASCII code is NN. </dd>
 346 </dl>
 347 <p>
 348 A &lsquo;\&rsquo; character followed
 349 by any other character is treated as an ordinary character, so they both
 350 are printed.
 351 <dl>
 352
 353 <dt>%%</dt>
 354 <dd>A literal percent sign. </dd>
 355
 356 <dt>%p</dt>
 357 <dd>File&rsquo;s path. </dd>
 358
 359 <dt>%f</dt>
 360 <dd>File&rsquo;s name. </dd>
 361
 362 <dt>%u</dt>
 363 <dd>URL-encoded
 364 filename. </dd>
 365
 366 <dt>%s</dt>
 367 <dd>File&rsquo;s size in bytes. </dd>
 368
 369 <dt>%{mtime}</dt>
 370 <dd>File&rsquo;s last modification time. </dd>
 371
 372 <dt>%a
 373 or %A</dt>
 374 <dd>AICH hash sum.  </dd>
 375
 376 <dt>%c or %C</dt>
 377 <dd>CRC32 hash sum.  Use %c for lowercase and %C
 378 for uppercase characters. </dd>
 379
 380 <dt>%g or %G</dt>
 381 <dd>GOST R 34.11-94 hash. </dd>
 382
 383 <dt>%h or %H</dt>
 384 <dd>SHA1 hash. </dd>
 385
 386 <dt>%e
 387 or %E</dt>
 388 <dd>ED2K hash sum. </dd>
 389
 390 <dt>%l or %L</dt>
 391 <dd>EDonkey ed2k://... link. </dd>
 392
 393 <dt>%m or %M</dt>
 394 <dd>MD5 hash. </dd>
 395
 396 <dt>%r or
 397 %R</dt>
 398 <dd>RIPEMD-160 hash. </dd>
 399
 400 <dt>%t or %T</dt>
 401 <dd>TTH sum. </dd>
 402
 403 <dt>%w or %W</dt>
 404 <dd>Whirlpool hash. </dd>
 405
 406 <dt>%{md4}, %{sha-224},
 407 %{sha-256}, %{sha-384}, %{sha-512}, %{sha3-224},</dt>
 408 <dd> %{sha3-256}, %{sha3-384}, %{sha3-512}
 409 %{tiger}, %{btih}, %{gost-cryptopro},<br>
 410   %{has160}, %{snefru128}, %{snefru256}, %{edon-r256}, %{edon-r512}"<br>
 411  Print specified hash sum. Actually the %{&lt;hash sum&gt;} directive can print
 412 any supported hash sum. If a hash sum name starts with a capital letter
 413 then the hash is printed in uppercase, e.g. %{TTH}, %{Sha-512}. </dd>
 414
 415 <dt>%x&lt;hash&gt;, %b&lt;hash&gt;,
 416 %B&lt;hash&gt;, %@&lt;hash&gt;</dt>
 417 <dd>Use one of these prefixes to output a hash sum in hexadecimal,
 418 base32, base64 or raw (binary) format respectively, e.g. %b{md4}, %BH or
 419 %xT. </dd>
 420 </dl>
 421 </blockquote>
 422
 423 <p>
 424 <h2><a name='sect7' href='#toc7'>Config File</a></h2>
 425 RHash looks for a config file on Windows at %APPDATA%\RHash\rhashrc,
 426
 427 <p>%HOMEDRIVE%%HOMEPATH%\rhashrc
 428 <p> and on Linux/Unix at $HOME/.rhashrc and /etc/rhashrc.
 429
 430 <p> The config file consists of lines formatted as <blockquote>variable = value </blockquote>
 431
 432 <p> where
 433 the <i>variable</i> can be a name of any command line option, like <i>magnet,</i> <i>printf,</i>
 434 <i>percents,</i> etc. A boolean variable can be set to true by a value &lsquo;on&rsquo;, &lsquo;yes&rsquo;
 435 or &lsquo;true&rsquo;, any other value sets the variable to false.
 436 <p> Empty lines and lines
 437 starting with &lsquo;#&rsquo; or &lsquo;;&rsquo; are ignored.
 438 <p> Example config file: <br>
 439 <pre># This is a comment line
 440 percents = on
 441 crc-accept = .sfv,.md5,.sha1,.sha256,.sha512,.tth,.magnet
 442 </pre>
 443 <p>
 444 <h2><a name='sect8' href='#toc8'>Author</a></h2>
 445 Aleksey Kravchenko &lt;rhash.admin@gmail.com&gt;
 446 <h2><a name='sect9' href='#toc9'>See Also</a></h2>
 447 <i><b>md5sum</b>(1)</i> <i><b>cksfv</b>(1)</i>
 448 <i><b>ed2k_hash</b>(1)</i>
 449 <h2><a name='sect10' href='#toc10'>Bugs</a></h2>
 450 Bug reports are welcome! Send them by email  or post to
 451 the SourceForge Bug Tracking System <i><i>http://sourceforge.net/projects/rhash/</i></i>
 452 <p>
 453
 454 <hr><p>
 455 <a name='toc'><b>Table of Contents</b></a><p>
 456 <ul>
 457 <li><a name='toc0' href='#sect0'>Name</a></li>
 458 <li><a name='toc1' href='#sect1'>Synopsis</a></li>
 459 <li><a name='toc2' href='#sect2'>Description</a></li>
 460 <li><a name='toc3' href='#sect3'>Program Mode Options</a></li>
 461 <li><a name='toc4' href='#sect4'>Hash Sums Options</a></li>
 462 <li><a name='toc5' href='#sect5'>Miscellaneous Options</a></li>
 463 <li><a name='toc6' href='#sect6'>Output Format Options</a></li>
 464 <li><a name='toc7' href='#sect7'>Config File</a></li>
 465 <li><a name='toc8' href='#sect8'>Author</a></li>
 466 <li><a name='toc9' href='#sect9'>See Also</a></li>
 467 <li><a name='toc10' href='#sect10'>Bugs</a></li>
 468 </ul>
 469 </body>
 470 </html>