471 lines
14 KiB
HTML
471 lines
14 KiB
HTML
<!-- manual page source format generated by PolyglotMan v3.2, -->
|
|
<!-- available at http://polyglotman.sourceforge.net/ -->
|
|
|
|
<html>
|
|
<head>
|
|
<title>RHASH(1) manual page</title>
|
|
</head>
|
|
<body bgcolor='white'>
|
|
<a href='#toc'>Table of Contents</a><p>
|
|
|
|
<h2><a name='sect0' href='#toc0'>Name</a></h2>
|
|
rhash - calculate/check CRC32, MD5, SHA1, GOST, TTH, BTIH or other hash
|
|
sums.
|
|
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
|
|
<b>rhash [</b> <i>option</i> <b>]... [</b> <i>file</i> <b>]...</b>
|
|
<h2><a name='sect2' href='#toc2'>Description</a></h2>
|
|
<b>RHash</b> (Recursive Hasher)
|
|
computes and verifies various message digests (hash sums) of files. Supported
|
|
message digests include CRC32, MD4, MD5, SHA1, SHA256, SHA512, SHA3, Tiger,
|
|
DC++ TTH, BitTorrent BTIH, AICH, ED2K, GOST R 34.11-94, RIPEMD-160, HAS-160,
|
|
EDON-R 256/512, Whirlpool, Snefru-128/256.
|
|
<p> The program can create and verify
|
|
Magnet links and eDonkey ed2k:// links, see --magnet and --ed2k-link options.
|
|
|
|
<p> A dash string parameter ‘-’ is interpreted as stdin file.
|
|
<p> By default <b>rhash</b>
|
|
prints sums in SFV format with CRC32 hash sum only. The format can be changed
|
|
by options --bsd, --magnet, --simple, --printf, --template. To output all sums use
|
|
the ‘-a’ option.
|
|
<p> The default output format can also be changed by renaming
|
|
the program or placing a hardlink/symlink to it with a name containing
|
|
strings ‘crc32’, ‘md4’, ‘md5’, ‘sha1’, ‘sha256’ ‘sha512’, ‘tiger’, ‘tth’, ‘btih’, ‘aich’, ‘ed2k’,
|
|
‘ed2k-link’, ‘gost’, ‘gost-cryptopro’, ‘ripemd160’, ‘has160’, ‘whirlpool’, ‘edonr256’,
|
|
‘edonr512’, ‘snefru128’, ‘snefru256’, ‘sfv’ or ‘magnet’.
|
|
<p>
|
|
<h2><a name='sect3' href='#toc3'>Program Mode Options</a></h2>
|
|
The
|
|
default mode is to print hash sums for all files and directory trees specified
|
|
by command line. The mode can be set by the following options.
|
|
<dl>
|
|
|
|
<dt>-c, --check</dt>
|
|
<dd>Check
|
|
hash files specified by command line. RHash can verify hash files in SFV
|
|
and BSD formats, standard MD5 and SHA1 files, and text files containing
|
|
magnet or ed2k links (one link per line). Empty lines and lines starting
|
|
with ‘;’ or ‘#’ are skipped. In fact RHash can verify most hash files generated
|
|
by itself without formating options --printf and --template. </dd>
|
|
|
|
<dt>-u, --update</dt>
|
|
<dd>Update
|
|
hash files specified by command line. The program calculates and appends
|
|
hashes to the updated hash file in the format specified by formating options.
|
|
Hashes are calculated for those files from the same directory as the hash
|
|
file, which are yet not present in it. </dd>
|
|
|
|
<dt>-k, --check-embedded</dt>
|
|
<dd>Verify files by crc32
|
|
sum embedded in their names. </dd>
|
|
|
|
<dt>--torrent</dt>
|
|
<dd>Create a torrent file for each processed
|
|
file. </dd>
|
|
|
|
<dt>-h, --help</dt>
|
|
<dd>Help: print help screen and exit. </dd>
|
|
|
|
<dt>-V, --version</dt>
|
|
<dd>Version: print version
|
|
and exit. </dd>
|
|
|
|
<dt>-B, --benchmark</dt>
|
|
<dd>Run benchmark for selected algorithm(s).
|
|
<p> </dd>
|
|
</dl>
|
|
|
|
<h2><a name='sect4' href='#toc4'>Hash Sums
|
|
Options</a></h2>
|
|
|
|
<dl>
|
|
|
|
<dt>-C, --crc32</dt>
|
|
<dd>CRC32: calculate and print CRC32 hash sum. </dd>
|
|
|
|
<dt>--md4</dt>
|
|
<dd>MD4: calculate
|
|
and print MD4 hash sum. </dd>
|
|
|
|
<dt>-M, --md5</dt>
|
|
<dd>MD5: calculate and print MD5 hash sum. </dd>
|
|
|
|
<dt>-H, --sha1</dt>
|
|
<dd>SHA1:
|
|
calculate and print SHA1 hash sum. </dd>
|
|
|
|
<dt>--sha224, --sha256, --sha384, --sha512</dt>
|
|
<dd>Calculate
|
|
specified SHA2 hash sum. </dd>
|
|
|
|
<dt>--sha3-224, --sha3-256, --sha3-384, --sha3-512</dt>
|
|
<dd>Calculate specified
|
|
SHA3 hash sum. </dd>
|
|
|
|
<dt>--tiger</dt>
|
|
<dd>Tiger: calculate and print Tiger hash sum. </dd>
|
|
|
|
<dt>-T, --tth</dt>
|
|
<dd>TTH:
|
|
calculate and print DC++ TTH sum. </dd>
|
|
|
|
<dt>--btih</dt>
|
|
<dd>BTIH: calculate and print BitTorrent
|
|
Info Hash. </dd>
|
|
|
|
<dt>-A, --aich</dt>
|
|
<dd>AICH: calculate and print AICH hash. </dd>
|
|
|
|
<dt>-E, --ed2k</dt>
|
|
<dd>ED2K: calculate
|
|
and print eDonkey 2000 hash sum. </dd>
|
|
|
|
<dt>-L, --ed2k-link</dt>
|
|
<dd>eDonkey link: calculate and
|
|
print eDonkey link. </dd>
|
|
|
|
<dt>-W, --whirlpool</dt>
|
|
<dd>Whirlpool: calculate and print Whirlpool
|
|
hash sum. </dd>
|
|
|
|
<dt>-G, --gost</dt>
|
|
<dd>GOST: calculate and print GOST R 34.11-94 hash, the Russian
|
|
GOST standard hash function. </dd>
|
|
|
|
<dt>--gost-cryptopro</dt>
|
|
<dd>GOST-CRYPTOPRO: calculate and print
|
|
CryptoPro version of the GOST R 34.11-94 hash function. </dd>
|
|
|
|
<dt>--ripemd160</dt>
|
|
<dd>RIPEMD-160:
|
|
calculate and print RIPEMD-160 hash sum. </dd>
|
|
|
|
<dt>--has160</dt>
|
|
<dd>HAS-160: calculate and print
|
|
HAS-160 hash sum. </dd>
|
|
|
|
<dt>--snefru128, --snefru256</dt>
|
|
<dd>SNEFRU: calculate and print SNEFRU-128/256
|
|
hash sums. </dd>
|
|
|
|
<dt>--edonr256, --edonr512</dt>
|
|
<dd>EDON-R: calculate and print EDON-R 256/512 hash
|
|
sums.
|
|
<p> </dd>
|
|
|
|
<dt>-a, --all</dt>
|
|
<dd>Calculate all supported hash sums. </dd>
|
|
|
|
<dt>--list-hashes</dt>
|
|
<dd>List names of all
|
|
supported hashes, one per line.
|
|
<p> </dd>
|
|
</dl>
|
|
|
|
<h2><a name='sect5' href='#toc5'>Miscellaneous Options</a></h2>
|
|
|
|
<dl>
|
|
|
|
<dt>-r, --recursive</dt>
|
|
<dd>Process
|
|
directories recursively. </dd>
|
|
|
|
<dt>-v, --verbose</dt>
|
|
<dd>Be verbose. </dd>
|
|
|
|
<dt>--percents</dt>
|
|
<dd>Show percents, while
|
|
calculating or checking sums </dd>
|
|
|
|
<dt>--skip-ok</dt>
|
|
<dd>Don’t print OK messages for successfully
|
|
verified files. </dd>
|
|
|
|
<dt>-i, --ignore-case</dt>
|
|
<dd>Ignore case of filenames when updating crc
|
|
files. </dd>
|
|
|
|
<dt>--speed</dt>
|
|
<dd>Print per-file and the total processing speed. </dd>
|
|
|
|
<dt>-e, --embed-crc</dt>
|
|
<dd>Rename
|
|
files by inserting crc32 sum into name. </dd>
|
|
|
|
<dt>--embed-crc-delimiter=<delimiter></dt>
|
|
<dd>Insert
|
|
specified <delimiter> before a crc sum in the --embed-crc mode, default is
|
|
white space. The <delimiter> can be a character or empty string. </dd>
|
|
|
|
<dt>--path-separator=<separator></dt>
|
|
<dd>Use
|
|
specified path separator to display paths. </dd>
|
|
|
|
<dt>-q, --accept=<list></dt>
|
|
<dd>Set a comma-delimited
|
|
list of extensions of the files to process. </dd>
|
|
|
|
<dt>--exclude=<list></dt>
|
|
<dd>Set a comma-delimited
|
|
list of extensions of the files to exclude from processing. </dd>
|
|
|
|
<dt>-t, --crc-accept=<list></dt>
|
|
<dd>Set
|
|
a comma-delimited list of extensions of the hash files to verify. </dd>
|
|
|
|
<dt>--maxdepth=<levels></dt>
|
|
<dd>Descend
|
|
at most <levels> (a non-negative integer) levels of directories below the
|
|
command line arguments. ‘--maxdepth 0’ means only apply the tests and actions
|
|
to the command line arguments. </dd>
|
|
|
|
<dt>-o, --output=<file-path></dt>
|
|
<dd>Set the file to output
|
|
calculated hashes and verification results to. </dd>
|
|
|
|
<dt>-l, --log=<file-path></dt>
|
|
<dd>Set the file
|
|
to log errors and verbose information to. </dd>
|
|
|
|
<dt>--openssl=<list></dt>
|
|
<dd>Specify which hash
|
|
functions should be calculated using the OpenSSL library. The <list> is a
|
|
comma delimited list of hash names, but only those supported by openssl
|
|
are allowed, e.g. md4, md5, sha1, sha256, ripemd160. See openssl documentation
|
|
for the full list. </dd>
|
|
|
|
<dt>--gost-reverse</dt>
|
|
<dd>Reverse bytes in hexadecimal output of the
|
|
GOST hash sum. The most significant bytes of the hash will be printed first.
|
|
Default order is the least significant bytes first. </dd>
|
|
|
|
<dt>--bt-batch=<file-path></dt>
|
|
<dd>Turn
|
|
on torrent batch mode (implies torrent mode). Calculates batch-torrent for
|
|
the files specified at command line and saves the torrent file to the file-path.
|
|
The option -r <directory> can be useful in this mode. </dd>
|
|
|
|
<dt>--bt-private</dt>
|
|
<dd>Generate BTIH
|
|
for a private BitTorrent tracker. </dd>
|
|
|
|
<dt>--bt-piece-length</dt>
|
|
<dd>Set the <i>piece length</i> value
|
|
for torrent file. </dd>
|
|
|
|
<dt>--bt-announce=<announce-url></dt>
|
|
<dd>Add a tracker announce URL to the
|
|
created torrent file(s). Several URLs can be passed by specifying the option
|
|
mutltiple times. This option doesn’t change the BTIH hash. </dd>
|
|
|
|
<dt>--benchmark-raw</dt>
|
|
<dd>Switch
|
|
benchmark output format to be a machine-readable tab-delimited text with
|
|
hash function name, speed, cpu clocks per byte. This option works only if
|
|
the --benchmark option was specified. </dd>
|
|
|
|
<dt>-- (double dash)</dt>
|
|
<dd>Mark the end of command
|
|
line options. All parameters following the double dash are interpreted as
|
|
files or directories. It is typically used to process filenames starting
|
|
with a dash ‘-’. Alternatively you can specify ’./’ or full path before such files,
|
|
so they will not look like options anymore.
|
|
<p> </dd>
|
|
</dl>
|
|
|
|
<h2><a name='sect6' href='#toc6'>Output Format Options</a></h2>
|
|
|
|
<dl>
|
|
|
|
<dt>--ansi</dt>
|
|
<dd>Use
|
|
Windows codepage for output. </dd>
|
|
|
|
<dt>--oem</dt>
|
|
<dd>Use DOS (OEM) codepage for output. </dd>
|
|
|
|
<dt>--utf8</dt>
|
|
<dd>Use
|
|
UTF-8 codepage for output. </dd>
|
|
|
|
<dt>--sfv</dt>
|
|
<dd>Print hash sums in the SFV (Simple File Verification)
|
|
output format (default). But unlike common SFV file, not only CRC32, but
|
|
any hash sums specified by options can be printed. </dd>
|
|
|
|
<dt>-m, --magnet</dt>
|
|
<dd>Print hash sums
|
|
formatted as magnet links. </dd>
|
|
|
|
<dt>--bsd</dt>
|
|
<dd>Use BSD output format. Each hash sum is printed
|
|
on separate line after hash name and file’s path, enclosed in parentheses.
|
|
</dd>
|
|
|
|
<dt>--simple</dt>
|
|
<dd>Use simple output format. Each line will consist of filename and hash
|
|
sums specified by options. </dd>
|
|
|
|
<dt>--uppercase</dt>
|
|
<dd>Print hash sums in upper case. </dd>
|
|
|
|
<dt>--lowercase</dt>
|
|
<dd>Print
|
|
hash sums in lower case. </dd>
|
|
|
|
<dt>--template=<file></dt>
|
|
<dd>Read printf-like template from given
|
|
<file>. See the --printf option. </dd>
|
|
|
|
<dt>-p, --printf=<format></dt>
|
|
<dd>Format: print <i>format</i> string
|
|
the standard output, interpreting ‘\’ escapes and ‘%’ directives. The escapes
|
|
and directives are: <blockquote></dd>
|
|
|
|
<dt>\n</dt>
|
|
<dd>Newline. </dd>
|
|
|
|
<dt>\r</dt>
|
|
<dd>Carriage return. </dd>
|
|
|
|
<dt>\t</dt>
|
|
<dd>Horizontal tab. </dd>
|
|
|
|
<dt>\\</dt>
|
|
<dd>A literal
|
|
backslash (‘\’). </dd>
|
|
|
|
<dt>\0</dt>
|
|
<dd>ASCII NUL. </dd>
|
|
|
|
<dt>\NNN</dt>
|
|
<dd>The character which octal ASCII code is NNN.
|
|
</dd>
|
|
|
|
<dt>\xNN</dt>
|
|
<dd>The character which hexadecimal ASCII code is NN. </dd>
|
|
</dl>
|
|
<p>
|
|
A ‘\’ character followed
|
|
by any other character is treated as an ordinary character, so they both
|
|
are printed.
|
|
<dl>
|
|
|
|
<dt>%%</dt>
|
|
<dd>A literal percent sign. </dd>
|
|
|
|
<dt>%p</dt>
|
|
<dd>File’s path. </dd>
|
|
|
|
<dt>%f</dt>
|
|
<dd>File’s name. </dd>
|
|
|
|
<dt>%u</dt>
|
|
<dd>URL-encoded
|
|
filename. </dd>
|
|
|
|
<dt>%s</dt>
|
|
<dd>File’s size in bytes. </dd>
|
|
|
|
<dt>%{mtime}</dt>
|
|
<dd>File’s last modification time. </dd>
|
|
|
|
<dt>%a
|
|
or %A</dt>
|
|
<dd>AICH hash sum. </dd>
|
|
|
|
<dt>%c or %C</dt>
|
|
<dd>CRC32 hash sum. Use %c for lowercase and %C
|
|
for uppercase characters. </dd>
|
|
|
|
<dt>%g or %G</dt>
|
|
<dd>GOST R 34.11-94 hash. </dd>
|
|
|
|
<dt>%h or %H</dt>
|
|
<dd>SHA1 hash. </dd>
|
|
|
|
<dt>%e
|
|
or %E</dt>
|
|
<dd>ED2K hash sum. </dd>
|
|
|
|
<dt>%l or %L</dt>
|
|
<dd>EDonkey ed2k://... link. </dd>
|
|
|
|
<dt>%m or %M</dt>
|
|
<dd>MD5 hash. </dd>
|
|
|
|
<dt>%r or
|
|
%R</dt>
|
|
<dd>RIPEMD-160 hash. </dd>
|
|
|
|
<dt>%t or %T</dt>
|
|
<dd>TTH sum. </dd>
|
|
|
|
<dt>%w or %W</dt>
|
|
<dd>Whirlpool hash. </dd>
|
|
|
|
<dt>%{md4}, %{sha-224},
|
|
%{sha-256}, %{sha-384}, %{sha-512}, %{sha3-224},</dt>
|
|
<dd> %{sha3-256}, %{sha3-384}, %{sha3-512}
|
|
%{tiger}, %{btih}, %{gost-cryptopro},<br>
|
|
%{has160}, %{snefru128}, %{snefru256}, %{edon-r256}, %{edon-r512}"<br>
|
|
Print specified hash sum. Actually the %{<hash sum>} directive can print
|
|
any supported hash sum. If a hash sum name starts with a capital letter
|
|
then the hash is printed in uppercase, e.g. %{TTH}, %{Sha-512}. </dd>
|
|
|
|
<dt>%x<hash>, %b<hash>,
|
|
%B<hash>, %@<hash></dt>
|
|
<dd>Use one of these prefixes to output a hash sum in hexadecimal,
|
|
base32, base64 or raw (binary) format respectively, e.g. %b{md4}, %BH or
|
|
%xT. </dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<p>
|
|
<h2><a name='sect7' href='#toc7'>Config File</a></h2>
|
|
RHash looks for a config file on Windows at %APPDATA%\RHash\rhashrc,
|
|
|
|
<p>%HOMEDRIVE%%HOMEPATH%\rhashrc
|
|
<p> and on Linux/Unix at $HOME/.rhashrc and /etc/rhashrc.
|
|
|
|
<p> The config file consists of lines formatted as <blockquote>variable = value </blockquote>
|
|
|
|
<p> where
|
|
the <i>variable</i> can be a name of any command line option, like <i>magnet,</i> <i>printf,</i>
|
|
<i>percents,</i> etc. A boolean variable can be set to true by a value ‘on’, ‘yes’
|
|
or ‘true’, any other value sets the variable to false.
|
|
<p> Empty lines and lines
|
|
starting with ‘#’ or ‘;’ are ignored.
|
|
<p> Example config file: <br>
|
|
<pre># This is a comment line
|
|
percents = on
|
|
crc-accept = .sfv,.md5,.sha1,.sha256,.sha512,.tth,.magnet
|
|
</pre>
|
|
<p>
|
|
<h2><a name='sect8' href='#toc8'>Author</a></h2>
|
|
Aleksey Kravchenko <rhash.admin@gmail.com>
|
|
<h2><a name='sect9' href='#toc9'>See Also</a></h2>
|
|
<i><b>md5sum</b>(1)</i> <i><b>cksfv</b>(1)</i>
|
|
<i><b>ed2k_hash</b>(1)</i>
|
|
<h2><a name='sect10' href='#toc10'>Bugs</a></h2>
|
|
Bug reports are welcome! Send them by email or post to
|
|
the SourceForge Bug Tracking System <i><i>http://sourceforge.net/projects/rhash/</i></i>
|
|
<p>
|
|
|
|
<hr><p>
|
|
<a name='toc'><b>Table of Contents</b></a><p>
|
|
<ul>
|
|
<li><a name='toc0' href='#sect0'>Name</a></li>
|
|
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
|
|
<li><a name='toc2' href='#sect2'>Description</a></li>
|
|
<li><a name='toc3' href='#sect3'>Program Mode Options</a></li>
|
|
<li><a name='toc4' href='#sect4'>Hash Sums Options</a></li>
|
|
<li><a name='toc5' href='#sect5'>Miscellaneous Options</a></li>
|
|
<li><a name='toc6' href='#sect6'>Output Format Options</a></li>
|
|
<li><a name='toc7' href='#sect7'>Config File</a></li>
|
|
<li><a name='toc8' href='#sect8'>Author</a></li>
|
|
<li><a name='toc9' href='#sect9'>See Also</a></li>
|
|
<li><a name='toc10' href='#sect10'>Bugs</a></li>
|
|
</ul>
|
|
</body>
|
|
</html>
|