torrenttool(1)

NAME
torrenttool - BitTorrent file multipurpose tool

SYNOPSIS
torrenttool [OPTION]... FILE...

DESCRIPTION
torrenttool is a program that can extract and display certain information from BitTorrent files (`.torrent' files), as well as testing and generate checksums for files listed in them. See the options below for possible commands. Multiple options can be combined, thus allowing multiple commands to be executed at the same time.

OPTIONS
These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.

-i, --info-hash
    Display the info hash of the torrent file.

-f, --field=NAME
    Display the value of the specified field in the torrent file. See section FIELD NAMES below for format of field names. Note that the value of the field info/pieces will not displayed unless the `--verbose' option is also specified.

-a, --all-fields
    Display a tree of all fields in the torrent file.

-l, --list
    List files in torrent file. File sizes will be printed when the verbosity is increased (using `--verbose').

-c, --check
    Check local files against the SHA-1 checksums in the torrent file. See CHECK RESULTS for possible results of the check command.

-g, --generate=TYPE
    Check local files against the SHA1 checksums in the torrent file, and while doing so, print checksums for these files. TYPE can be either MD5 or SHA1.

-v, --verbose
    Explain more in detail what is being done. This option can be specified multiple times to increase verbosity even more. When used once with `--list', file sizes will be printed. When used once with `--field' or `--all-fields', the value of the field `info/pieces' will be displayed in full. When used once with `--check', files that are OK will be printed as well. When used twice with `--check', number of incorrect and total pieces per file will be printed as well.

-p, --strip=NUM
    When comparing (`--check' and `--generate') and listing files (`--list'), this option specifies the number of path components that will be stripped from file paths in the torrent file. Compare this to the patch(1) option with the same name.

--help
    Show summary of options.

--version
    Output version information and exit.

FIELD NAMES
A field name is a slash-separated (/) list of key names and/or list indices. The first element in a list has index 1. There must be no leading or trailing slashes. It is possible to escape the slash character in names using a backslash (\). (Natually the backslash can be escaped too.)

Examples of possible field names are:

announce
    The announcement URL of the torrent file.

info/files/1/length
    The length of the first file (if the torrent specifies multiple files).

info/files/1/path
    The path (which is a list) of the first file.

CHECK RESULTS
These are the possible results:

MISSING
    The file is missing.

ERROR - (error details)
    A system error occured when the file was about to be opened or read from.

TOO LONG
    The file contains all valid data, but is larger than expected.

TOO SHORT
    The file contains all valid data, but is too short.

INDETERMINABLE
    The file's complete integrity cannot be determined. The file may be all valid or just partially invalid. It may also be too short. This can occur when the file itself is invalid in the beginning or the end, or when the prior or following file is not O.K.

FAILED
    The file contains invalid data.

OK  The file contains all valid data.

EXAMPLES
List files with sizes mentioned in the redhat.torrent file:
    torrenttool -lv redhat.torrent

Check local files against checksums in the redhat.torrent file.
    torrenttool -c redhat.torrent

KNOWN BUGS
There are no known bugs at the moment.

If you find a bug not listed here, please report it to <oskar@osk.mine.nu>.

AUTHOR
torrenttool was written by Oskar Liljeblad <oskar@osk.mine.nu>.