Note, this document is a text transcription of the web page at
http://www.rahul.net/dholmes/ctorrent/ctcs.html.  It will be much
easier to read the sample display tables there than below.
______________________________________________________________________

                          CTorrent Control Server

   CTorrent Control Server (CTCS) is an interface for monitoring and
   managing [1]Enhanced CTorrent clients. It can manage allocation of
   bandwidth, provide status information, and allow changes to the
   running configuration of each client. Communication with CTorrent is
   via a TCP connection, and the user interface is a web browser.

   The current version is implemented in [2]Perl since that was used to
   develop the original prototype. It may be reimplemented in C at some
   later date, but the Perl version is fully functional. You will need to
   install a Perl interpreter if your system does not already have one.

  Contents

     * [3]Download
     * [4]Usage
     * [5]All Torrents screen
     * [6]Torrent Details screen
     * [7]Advanced Limits screen
     * [8]Protocol
     _________________________________________________________________

   Download

   The preferred download mechanism is now the [9]SourceForge File
   Release page. All new files will be available there for convenient
   downloading from a mirror site near to you.

   [10]ctcs-1.4.1.tar.gz: CTCS version 1.4.1. List of changes:
     * Additional color-coding of peer interested/choked status
     * Fixed error displaying Torrent Details screen when a file has zero
       size.
     * Fixed problems handling POST form input.
     * Boost client's limit only if bandwidth is shared.
     * On details screen for terminated torrent, Torrent table showed
       "Start Time".

   [11]ctcs-1.4.tar.gz: CTCS version 1.4. List of changes:
     * Protocol 3 support
          + Auto-configuration of client configuration options
          + File download priority
          + Updated block start messages for consistency
     * New client configuration options as provided by client version 3.1
       and later.
     * Each file's download priority is shown in the list and can be set
       as an alternative method to changning the "-n" option value.

   [12]ctcs-1.3.tar.gz: CTCS version 1.3. List of changes:
     * Protocol 2 support
          + Cache size configuration option
          + Removal of option to exit when peers=0
          + Total seeders & leechers in the swarm, and connecting peers,
            are shown.
          + File availability is shown.
     * Bandwidth management changes
          + Works correctly with Enhanced CTorrent dnh3
          + Adjusted the threshold for increasing a limit
          + Wait a few minutes after a client becomes seed to reduce the
            download limit. This allows duplicate slices still "in
            flight" to be received and thus cleared from the connection.
          + The average bandwidth available per client is now regarded as
            an implied minimum. A client limit will generally not be
            reduced below this value, though unused bandwidth will be
            allocated to other clients. This avoids a slow and difficult
            ramp-up period when an idle client suddenly acquires an
            active peer.
     * Cosmetic updates
          + Configuration values are highlighted at certain times for
            visibility or attention.
          + Zero peer rates and transfer amounts are not shown, for
            clarity.
          + Peer completeness is shaded red by value (0%=red,
            100%=white).
          + Uninterested states are indicated in gray.
          + Peer IP address is centered in the cell.
          + Peer transfer rates and totals are shaded purple by scale
            (B/K/M).

   [13]ctcs-1.2.tar.gz: CTCS version 1.2. List of changes:
     * Version number is now displayed at bottom of main page.
     * Added a few client ID strings.
     * The maximum limit "boost" value is now based on the global limit
       and number of torrents. Previously it was always 1K; now it will
       be less if bandwidth is constrained.
     * Improved handling of minimum limits. Now a torrent's limit will
       never be reduced below its minimum, but unused bandwidth will
       still be borrowed for other torrents. This is more stable with the
       new seeding algorithm.
     * Eliminated the checkboxes to change current limits on the Advanced
       Limits screen. Each limit is changed only if a new value is
       entered for it.
     * Added an option to limit a torrent's max upload rate based on
       share ratio. (See the Advanced Limits screen.)
     * In the Advanced Limits screen, options related to downloading are
       now disabled for torrents that are seeding.
     * Message indication: An exclamation point (!) is shown next to the
       torrent title if messages are present. The torrent title is
       highlighted based on message severity.
     * Messages that include a severity (added in dnh2.2) will be
       highlighted in red (sev 1) or yellow (sev 2). Sev 3 and
       no-severity (pre-dnh2.2) messages are not highlighted.
     * Enabled a Torrent Details page for terminated torrents.
     * Avoid crashing if a user stops/reloads too quickly. Resolved with
       a SIGPIPE handler, which may not work on all platforms. If you
       know how to handle this situation on your platform, please let me
       know. I found that checking the return code from print/printf was
       not particularly reliable.
     * If the hostname is unresolvable, the program will now fall back to
       "localhost" or 127.0.0.1. Previously this could result in an
       error.
     * Cleaned up HTML print statements (code formatting).

   [14]ctcs-1.1.tar.gz: CTCS version 1.1. List of changes:
     * Use "\r\n" as newline.
     * Added a few client ID strings.
     * Fixed data sending (user interaction) on Linux.
     * Fixed error when all upload or download limits are zero.

   [15]ctcs-1.0a.tar.gz: CTCS version 1.0a

   [16]ctcs-1.0a.diff: Patch file for 1.0
   There was a minor bug in the original release that prevented the
   Messages feature from working (messages were discarded). If you
   previously downloaded version 1.0, please apply this small patch to
   enable the feature.
     _________________________________________________________________

   Usage

ctcs [-d <dlimit>] [-u <ulimit>] [-i <interval>] [-p <port>] [-P]

   -d dlimit
          Overall download bandwidth limit, in KB/s (default 100).

   -u ulimit
          Overall upload bandwidth limit, in KB/s (default 25). Use a
          value that is less than the maximum capacity of your network
          line.

   -i interval
          Bandwidth management change interval, in seconds (default 5).
          The recommended minimum value is 3. Higher values will reduce
          oscillation of individual torrent limits, but a value that is
          too high will cause very slow reactions to changes in bandwidth
          usage.

   -p port
          The TCP port on which to listen for connections (default 2780).

   -P
          Prompt for an authorization password.

   If your system does not have perl available at /usr/bin/perl, you will
   need to change the path in the first line of the file.

   To connect Enhanced CTorrent (release dnh2 or later) clients to CTCS,
   use the "-S" command-line option, e.g. "-S localhost:2780". To use a
   web browser to view or change status, enter the same host and port as
   the location, e.g. "http://localhost:2780/".

  Security

   Though there is a basic option, security is very minimal. Running CTCS
   on a computer or network with untrusted users is not recommended. It
   should go without saying that the CTCS listening port should not be
   made openly accessible from the public Internet (but there, it's said
   anyway).

   The "-P" option will cause CTCS to prompt for a password when
   starting. This password will be used to authenticate CTorrent clients.
   It is intended that the same password will be used to authenticate web
   browser connections also, but this has not yet been implemented. Using
   a colon at the end of the -S parameter to CTorrent (as in "-S
   localhost:2780:") will cause the client to prompt for a password to
   send to CTCS when connecting.
     _________________________________________________________________

   All Torrents screen

   This is the main CTCS display, which shows overall bandwidth status
   and provides a summary of each torrent.

  Bandwidth Management

   The top portion of the display provides the bandwidth management
   interface.
                    ___________________________________

             Current DL = 7 K/s       DL Limit: ____K/s Change
             Current UL = 34 K/s      UL Limit: ____K/s
                                 Change interval: ___sec

                            [17]Advanced Limits
                    ___________________________________

   The current aggregate download and upload rates are shown at the left
   (determined by adding together the rates reported by each client). To
   the right of this the overall limits and change interval can be
   changed. To do this, enter the desired values and click the Change
   button.

   The Advanced Limits function is covered further below.

  Active Torrents

   The next section of the display is a list of all active clients that
   are reporting to CTCS, and status information on the torrents they are
   running.
                    ___________________________________

   [18]Show peers

   Torrent Start Time
   Seed Leech Complete DL Rate UL Rate DL Total UL Total Limit D/U
   [19]Example 1.torrent Tue Jan 3 21:24:27 2006
   S: 0/3 L: 7/7 100% D= 0 B/s U= 11 K/s D= 393 M U= 1111 M 0 / 11 K/s
   [20]Example 2.torrent Tue Jan 3 20:24:06 2006
   S: 0/25 L: 44/52 +2 100% D= 0 B/s U= 12 K/s D= 380 M U= 972 M 0 / 12
   K/s
   [21]Example 3.torrent Wed Jan 4 22:13:55 2006
   S: 1/2 L: 1/2 20% (100% Avail) D= 7372 B/s U= 12 K/s D= 188 M U= 254 M
   100 / 12 K/s
                    ___________________________________

   Each torrent is listed in blue along with the time the client was
   started, with its status information shown below it in white. The
   first two fields are the number of seeders and leechers connected (out
   of the tracker's totals), plus connections in progress if any. This is
   followed by the percentage of the torrent that you have; if it is not
   complete then the amount that is currently available from all
   connected peers is shown in parentheses. The current download and
   upload rates are shown in bytes, kilobytes, or megabytes per second,
   as are the total amounts downloaded and uploaded by the client. The
   bandwidth allocated to the client is shown in the last column, in
   kilobytes per second. Note that bandwidth is managed to a finer degree
   than this, so if you see a zero value it just means that less than 1K
   has been allocated. This is also why it may appear that the total is
   wrong if you add the displayed values yourself.

   Clicking a torrent title will take you to the Torrent Details screen
   for that torrent. If CTCS has received any status messages from a
   client, an exclamation point (!) will be shown next to the title. If
   there are potentially severe messages, the title will be highlighted
   in yellow or red. (If the client is an older version not supporting
   severity, the title will be highlighted in yellow when any messages
   are present.) These messages can be read on the Torrent Details
   screen. Bandwidth limits may also be highlighted in yellow or green if
   they have been adjusted on the Advanced Limits screen.

   The "Show peers" option will list each torrent's peers below the
   torrent's status information. For more information, see the Torrent
   Details screen description below.

  Terminated Torrents

   Clients that have disconnected from CTCS (assumed to have terminated)
   are listed in the lower portion of the display.
                    ___________________________________

   [Del] Torrent                                                   End Time
   Seed   Leech    Complete  DL Rate   UL Rate DL Total  UL Total  Limit D/U
   [_] [22]Finished example 4.torrent              Sat Dec 24 19:09:55 2005
   S: 0/1 L: 5/5   100%     D= 0 B/s U= 16 K/s D= 720 M  U= 136 M 0 / 15 K/s
   [_] [23]Dead example 5.torrent                   Sun Jan 1 23:37:15 2006
   S: 0/2 L: 13/14 100%     D= 0 B/s U= 14 K/s D= 435 M U= 1937 M 0 / 13 K/s

   Delete Delete All
                    ___________________________________

   This is just like the list of active torrents except that the end time
   replaces the start time. The last known status information is shown,
   which is normally the final status unless the client terminated
   abnormally (crashed). The Torrent Details screen (click the title) is
   an abbreviated version, allowing you to see the share ratio and any
   messages.

   To remove a torrent from the list, check the box next to it and click
   the Delete button at the bottom left of the list. To clear the entire
   list, click the Delete All button at the bottom right.
     _________________________________________________________________

   Torrent Details

   This screen shows detailed information about a particular client.
                    ___________________________________

                        Upload/Download Ratio: 2.83
                  Seed time remaining: 54 hours 11 minutes
                    ___________________________________

   If nothing has been downloaded, the full size of the torrent is used
   as the amount downloaded; if you are only seeding, then the ratio
   effectively shows how many times you have uploaded the torrent.

   The time remaining is an estimate based on the current download rate,
   current upload rate and target ratio, or actual seed time remaining.

  Configuration

   Several configuration parameters can be changed in this part of the
   display.
                    ___________________________________

                               Configuration
           Verbose output [-v]      [_]  Disabled
           Seed time [-e]          _____ ~hours remaining (-e 72)
           Seed ratio [-E]         _____ Upload:Download
           Max peers [-M]          _____ Current peers: 5
           Min peers [-m]          _____ Current peers: 5
           Download files [-n]     ______________________________
           Cache size [-C]         _____ MB; 3552KB now in use
           Pause torrent            [_]  Stop upload/download
           Completion command [-X] ______________________________
           Normal/status output    ______________________________
           Interactive output      ______________________________
           Error/warning output    ______________________________
           Debug/verbose output    ______________________________
           Console input           ______________________________
           CTCS server             ______________________________
                                   Submit
                    ___________________________________

   Note that the available options and their descriptions are now
   determined by the client and are only presented by CTCS. For details,
   see the Enhanced CTorrent User's Guide (command-line options and
   operator menu).

   For parameters that have a corresponding command-line option, the
   option letter is shown in brackets next to the parameter name. Certain
   items may be highlighted when active or to draw attention; this does
   not indicate a problem.

   Note that for "Seed time" an approximation of the number of hours
   remaining is shown, and a new value entered will be interpreted the
   same way. While a decimal value may be shown, the current client will
   use only the integer portion of any new value entered. The total
   number of seed hours (as it would have been given on the command line
   when starting the program), of dubious usefulness, is given in
   parentheses.

   Other features are:

   Pause torrent
          This will cause the client to temporarily stop transferring
          data (uploading and downloading torrent content).

   I/O channel redirection
          The targets for the console input and output channels can be
          changed.

  Actions

   This section allows you to cause the client to perform an action.
                    ___________________________________

                                  Actions
               Update    (_) Update tracker stats & get peers
               Restart   (_) Restart the tracker session
               Terminate (_) Stop torrent (quit)
                                  Perform
                    ___________________________________

   Update
          Force a normal update connection to the tracker.

   Restart
          This may be handy if messages from the tracker indicate that
          your client is no longer registered. You will connect to the
          tracker as if the client just started.

   Terminate
          Stop the client in a normal manner (as when seeding has
          completed or the user hits control-c). This option is tinted
          red to help avoid accidental selection.

  Messages

   If any status messages have been received from the client, they are
   listed next. Messages are color-coded according to severity (supported
   with Enhanced CTorrent dnh2.2 and later).
                    ___________________________________

                                                   Messages
Tue Jan  3 23:24:47 2006 warn, connect to tracker failed:  Operation timed out
Tue Jan  3 23:19:04 2006 warn, received nothing from tracker!

                                                    Clear
                    ___________________________________

   To acknowledge the messages (which clears the list from CTCS memory),
   click the Clear button.

  Files

   The component files of the torrent are listed next.
                    ___________________________________

             File Name        Size Complete Available Priority
                 1 Main.dat   393 M       90%     100%  _____
                 2 readme.txt   2 K      100%     100%  _____
             Total           393 M                      Set
                    ___________________________________

   The file number, name, size (scaled to bytes, kilobytes, or
   megabytes), percentage complete, and percentage available are shown.
   Files which are complete (all available pieces have been downloaded)
   are tinted green. Partial availability is indicated by yellow tint;
   zero availability is indicated by red. If using the "-n" option to
   download specific files, the current files in progress are tinted
   blue.

   If the "-n" option is in use, the prority of each file is indicated in
   the rightmost column. Files with priority "1" are included in the
   first group to be downloaded; files of the same priority will be
   downloaded together. The priorities can be altered by changing the
   values and clicking the "Set" button. This is equivalent to changing
   the "-n" configuration option, and the changes will be reflected in
   that value as well.

  Status and Peers

   This section is similar to what is displayed on the All Torrents
   screen.
                    ___________________________________

   Torrent                                                          Start Time
   Seed   Leech  Complete  DL Rate     UL Rate DL Total  UL Total     Limit D/U
   [24]Example 1.torrent                               Tue Jan 3 21:24:27 2006
   S: 0/4 L: 8/9 100%     D= 0 B/s   U= 15 K/s D= 393 M U= 1113 M    0 / 17 K/s
   -BC0060-0x1B5809A843282B5EE23CEC0F          00.131.203.0       BitComet 0060
     Cn    Ci         77%        -           -        -         -
   -BC0060-5)0x9881006F56E31AA742F8              0.255.161.000    BitComet 0060
     Cn    Ci         20%        -           -        -   U= 192 K
   -BC0060-0x09645C51208ADDB8D53E29F7             00.171.219.0    BitComet 0060
     Cn    Ui          2%        - U= 2457 B/s        -   U= 496 K
   -BC0060-0x01DE4ED5BB6797CC6C58EF1E             0.48.201.000    BitComet 0060
     Cn    Ui         10%        - U= 7372 B/s        -  U= 4320 K
   -BC0059-0xE507A66333F2A020E7DBFC42             00.245.89.00    BitComet 0059
     Cn    Ci         65%        -           -        -  U= 1072 K
   exbc0x01014C4F524497240602B5B8E07B3AA3         0.95.210.00     BitLord 1.1
     Cn    Ui         23%        - U= 1638 B/s        -  U= 8592 K
   -BC0059-0x9F1995D00E3BA5EF9ABEE4F8             0.74.215.00     BitComet 0059
     Cn    Ci         49%        -           -        -    U= 11 M
   -AZ2306-kW66DYIl3XoE                           00.183.31.0     Azureus 2306
     Cn    Ui         93%        - U= 5734 B/s        -    U= 38 M
                    ___________________________________

   The currently connected peers are listed below the client status
   information. The peer ID, IP address, and software name and version
   (if identified) are tinted green. Below this (mostly in white) is
   status information for that peer. The first field shows "C" or "U" to
   indicate whether the connection is choked or unchoked for downloading,
   followed by "i" or "n" to indicate whether your client is interested
   (or not) in downloading from the peer. The second field shows the same
   information for uploading to the peer (whether you have choked the
   peer and whether he is interested in your data). The third field is
   the percentage of pieces that the peer has. The next two fields are
   your client's current download and upload rates to the peer, and the
   last two are the total amount your client has downloaded from and
   uploaded to the peer.

   Some information is color-coded to make it easier to interpret.
   Uninterested ("n") connections are shaded light gray. The percentage
   complete is shaded red according to its value, with 0% being pure red
   and 100% being white. The transfer rates and totals are shaded purple
   according to scale: white for a blank (zero) entry, light for M,
   medium for K, and dark for B. This should make it easier to visually
   compare numbers of similar magnitude.
     _________________________________________________________________

   Advanced Limits

   This screen allows fine-tuning of the client bandwidth limits.
                    ___________________________________

   Torrent Current Rate Limit Minimum Maximum Shared
   DL UL DL UL DL UL DL UL SR DL UL
   Example 2.torrent 0 13 ____ ____ ____ ____ ____ ____ [_] [_] [_]
   Example 1.torrent 0 11 ____ ____ ____ ____ ____ ____ [_] [_] [_]
   Example 3.torrent 8 12 ____ ____ ____ ____ ____ ____ [_] 0 [_] [_]

                                   Submit
                    ___________________________________

   Due to the complexity of these options, usage notes are displayed
   directly on the screen:

   Notes
     * All values are in kilobytes per second (KB/s).
     * Options related to downloading are disabled for torrents that are
       seeding.
     * Use caution when changing current limits to below the current
       rate--small increments are recommended.
     * "Minimum" and "Maximum" are soft limits. They will be enforced
       when there is competition for bandwidth; otherwise the torrent is
       free to give or take unused bandwidth.
          + Minimum: If the torrent wants bandwidth up to this level, it
            will receive it at the expense of other torrents. It will not
            be forced or held below this level if it wants (is using) the
            bandwidth. Use to high-prioritize a torrent, or to guarantee
            a bandwidth allocation amount to a torrent.
          + Maximum: The torrent will be forced down to this level if
            other torrents want bandwidth. Use to low-prioritize a
            torrent, or to limit the amount of bandwidth this torrent is
            allowed to consume at the expense of other torrents.
          + SR: The maximum upload limit will be adjusted based on the
            torrent's seed ratio ("-E" option, shown), current share
            ratio, and current download rate. It will not be increased
            above the Maximum or decreased below the Minimum, if
            specified. This option does not apply when seeding, and has
            no effect if the seed ratio is unset (zero). Use to avoid
            giving away too much upload bandwidth when you have other
            torrents running that could use it more fairly.
     * "Shared" indicates whether the torrent's bandwidth is counted
       against the shared pool represented by the global limit on the
       main CTCS page. CTCS will dynamically manage the client's
       bandwidth only if the Shared option is checked.
     * Use a value of 0 to disable/remove a limit.
     * Non-default settings are highlighted in yellow and green. The
       limit field in torrent status displays will also be highlighted as
       a reminder. Red highlight indicates an unknown value; you should
       refresh before making changes.
     * After submitting changes, you may need to refresh the page after a
       second or two in order to see the resulting updates.
     _________________________________________________________________

References

   1. http://www.rahul.net/dholmes/ctorrent/
   2. http://www.perl.org/
   3. http://www.rahul.net/dholmes/ctorrent/ctcs.html#download
   4. http://www.rahul.net/dholmes/ctorrent/ctcs.html#usage
   5. http://www.rahul.net/dholmes/ctorrent/ctcs.html#alltorrents
   6. http://www.rahul.net/dholmes/ctorrent/ctcs.html#details
   7. http://www.rahul.net/dholmes/ctorrent/ctcs.html#alimits
   8. http://www.rahul.net/dholmes/ctorrent/ctcs-protocol.html
   9. http://sourceforge.net/project/showfiles.php?group_id=202532
  10. http://www.rahul.net/dholmes/ctorrent/ctcs-1.4.1.tar.gz
  11. http://www.rahul.net/dholmes/ctorrent/ctcs-1.4.tar.gz
  12. http://www.rahul.net/dholmes/ctorrent/ctcs-1.3.tar.gz
  13. http://www.rahul.net/dholmes/ctorrent/ctcs-1.2.tar.gz
  14. http://www.rahul.net/dholmes/ctorrent/ctcs-1.1.tar.gz
  15. http://www.rahul.net/dholmes/ctorrent/ctcs-1.0a.tar.gz
  16. http://www.rahul.net/dholmes/ctorrent/ctcs-1.0a.diff
  17. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/alimits
  18. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/peers
  19. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-%7B0xD529E46881CF5DD4E37DF6
  20. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-P0xE9C43CD51BA8C5B319601A
  21. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-0xCCEFB5B7D53349B364737755
  22. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-B0x98A9186CAB0D40611122D1
  23. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-0x834894CA549155083E4635F1
  24. http://www.rahul.net/dholmes/ctorrent/ctcs.html#/torrent/-CD0202-%7B0xD529E46881CF5DD4E37DF6
