userguide

最新的enhanced ctorrent源码

                       Enhanced CTorrent User's Guide

   This guide is presented to offer additional information related to
   using [1]Enhanced CTorrent.

   This document is not an introduction to BitTorrent--for that, try
   [2]this, [3]this, or an Internet search.

  Contents

     * Options
          + [4]General
          + [5]Downloading
          + [6]Create Torrent
     * [7]Examples
     * [8]Runtime Commands
          + [9]Operator Menu
     * Usage Notes
          + [10]Bandwidth Limits
          + [11]Startup
          + [12]Status Line
          + [13]Stopping CTorrent
     _________________________________________________________________

   Options

  General Options

-x          Decode metainfo (torrent) file only, don't download.

          Displays the torrent information and contents from the metainfo
          (.torrent) file. No piece checking or downloading is performed.
          This option is normally used alone.

-c          Check pieces only, don't download.

          Hash-checks all pieces of the torrent to verify completion
          status and exits. Use this when you want to verify that you've
          successfully downloaded the complete torrent, or to make sure
          the files are intact after a system crash. This option is
          normally used alone.

-v          Verbose output (for debugging).

          Generates [a lot of] extra output while CTorrrent is running.

  Downloading Options

-e int      Exit while seed <int> hours later. (default 72 hours)

          Indicate how long (in hours) you want to "seed" (continue
          uploading) after download has completed. It is considered
          polite and fair (and required by some tracker sites) to seed
          for some time after downloading.

-E num      Exit after seeding to <num> ratio (UL:DL).

          Specify a desired "seed ratio". After downloading completes,
          the client will continue seeding (uploading) until your total
          upload volume divided by your download volume equals this
          number. Fractional values (such as 1.5) are allowed. It is
          considered polite and fair (and required by some tracker sites)
          to seed until your ratio is at least 1:1.

-i ip       Listen for connections on ip. (default all IP's)

          Specify the IP address on which you want to listen for incoming
          connections. This is only useful if your system has multiple
          network interfaces and you want to restrict access or run
          multiple clients on different interfaces.

-p port     Listen port. (default 2706 -> 2106)

          Specify the TCP port number on which to listen for incoming
          connections. By default, CTorrent starts at 2706 and searches
          for an available port in decreasing order until it finds one or
          exhausts all ports down through 2106.

-s filename     Download ("save as") to a different file or directory.

          Download to a different filename or top-level directory name
          than what is given in the metainfo file.

-C cache_size   Cache size, unit MB. (default 16MB)

          Specify the maximum amount of memory to use for caching
          downloaded slices. The program may use less than this; the
          cache size is dynamically tuned based on the download and
          upload rates. You may need to use this option if running on a
          memory-constrained system such as a router or SAN device. If
          you use a value of 0, no memory cache will be used but the
          process will be more disk-intensive.

-f              Force saved bitfield or seed mode (skip hash check at startup).

          Perform a fast startup by skipping the initial (or background)
          hash verification of the files. This option is not generally
          recommended since the client now performs initial hash checking
          in the background. Use this option only if CTorrent was shut
          down cleanly when last downloading this torrent and you are
          absolutely certain that the bitfield (if download is not
          complete) and data files are intact and correct. To emulate the
          old behavior of hash-checking all pieces before beginning
          download or seeding, use -f along with the -c option.

-b filename     Specify bitfield save file (default is torrent+".bf")

          Piece completion status is saved to a bitfield file on exit if
          download has not completed. On startup the file is read to
          determine (and check) available pieces. The -b option can be
          used to specify a filename other than the default. Be
          consistent and careful with this option; it is generally not
          needed.

-M max_peers    Max peers count. (default 100)

          Set the maximum allowable number of peer connections. If this
          number is reached, no new connections will be initiated or
          accepted. If memory or upload bandwidth are constrained, you
          may want to use this option to specify a lower value.

-m min_peers    Min peers count. (default 1)

          Set the desired minimum number of peer connections. If the
          number falls below this value, the client will contact the
          tracker to request more peers.

-z slice_size   Download slice/block size, unit KB. (default 16, max 128).

          Sets the size of the basic unit of download. For greatest
          compatibility with other peer clients, use the default. This
          value can also affect the precision with which bandwidth is
          managed.

-n file_number  Specify file to download.

          Specify a file in the torrent to download as a priority; the
          file numbers can be seen with the -x option. Only pieces that
          are part of this file will be downloaded until the file is
          complete. At that point, the next file will be targeted. When
          the last (highest-numbered) file in the torrent is completed,
          this option is deactivated and the remaining pieces of the
          torrent will be downloaded.

-D rate         Max bandwidth down (unit KB/s)

          Specify a download bandwidth limit for this torrent. The client
          will maintain its short-term average download rate at or below
          this value.

-U rate         Max bandwidth up (unit KB/s)

          Specify an upload bandwidth limit for this torrent. The client
          will maintain its short-term average upload rate at or below
          this value.

-P peer_id      Set Peer ID prefix. (default "-CD0300-")

          Specify an alternate peer ID prefix. This can be useful if a
          tracker is set up to only allow client programs that it
          recognizes. (The admin may not even realize it, so you may want
          to try contacting them to request that they change their
          configuration or add Enhanced CTorrent to the list.) If you
          receive a tracker warning message that your client is out of
          date, try using this option with the prefix of another
          well-known client program (such as "-AZ2304-").

-A user_agent   Set User-Agent header. (default "Enhanced-CTorrent/dnh3")

          Specify an alternate user-agent header. This can be useful if a
          tracker is set up to only allow client programs that it
          recognizes.

-S host:port    Use CTCS server at host:port.

          Maintain a connection to CTCS for status reporting, bandwidth
          control, and client management. Using a colon at the end of the
          parameter (as in "-S localhost:2780:") will cause the client to
          prompt for a password to send to CTCS when connecting.

-a              Preallocate files on disk

          Use this if you are concerned about file fragmentation or
          out-of-order block storage. This option is only effective when
          initially creating the files and will cause startup to take
          longer as each entire file is written in order to reserve
          physical disk space. Note that all files will be created and
          preallocated even if the "-n" option is used to download a
          particular file.

  Options for Creating a New Torrent

-t              Create a new torrent file.

          Indicates that you want to create a new torrent.

-s filename     Specify metainfo file name.

          (Required) Give the name of the file to be created.

-u url          Tracker's url.

          (Required) Specify the tracker's announce URL. This usually
          looks similar to "http://tracker.example.com:port/announce".

-l piece_len    Piece length. (default 262144)

          Specify the piece size for your torrent. This will also
          determine the number of pieces in the torrent.
     _________________________________________________________________

   Examples

   List the contents of a torrent:

ctorrent -x example.torrent