User Commands                                  transmissioncli(1)



NAME
     transmissioncli - a command-line BitTorrent client

SYNOPSIS
     transmissioncli --help

     transmissioncli --info torrent-file

     transmissioncli --scrape torrent-file

     transmissioncli --new sourcefile [--announce url] [--comment
     text] [--private] new-torrent-file

     transmissioncli  [--blocklist--non-blocklist]  [--downlimit
     speed          --no-downlimit]    [--encryption-required--
     encryption-preferred--encryption-tolerated]       [--finish
     script]  [--config-dir directory] [--help ] [--portmap--no-
     portmap] [--tos] [--uplimit  speed--no-uplimit]  [--verify]
     [--download-dir directory] torrent-file

DESCRIPTION
     transmissioncli is a  lightweight,  command-line  BitTorrent
     client with scripting capabilities.

OPTIONS
     The following options are supported:

     -a, --announce url

         When creating a new torrent, set its announce url.



     -b, --blocklist

         Enable peer blocklists. transmissioncli understands  the
         bluetack  blocklist file format. Bluetack blocklists are
         text files that applications can load in order to  block
         access.    Bluetack    blocklists   are   available   on
         http:/www.bluetack.co.uk/. New blocklists can be  added
         by  copying them into the config-dir's "blocklists" sub-
         directory.



     -B, --no-blocklist

         disable peer blocklists.







SunOS 5.11          Last change: 17 Jul 2008                    1






User Commands                                  transmissioncli(1)



     -c, --comment text

         When creating a new torrent, set its comment field.



     -d, --downlimit speed

         Set the maximum download speed in KB/s,  which  defaults
         to no limit.



     -D, --no-downlimit

         Do not limit the download speed.



     -er, --encryption-required

         Encrypt all peer connections.



     -ep, --encryption-preferred

         Prefer encrypted peer connections.



     -et, --encryption-tolerated

         Prefer unencrypted peer connections.



     -f, --finish script

         Specify a script to run when the torrent finishes.



     -g, --conf-dir directory

         Where to look for configuration files.



     -h, --help

         Print a short usage summary.



SunOS 5.11          Last change: 17 Jul 2008                    2






User Commands                                  transmissioncli(1)



     -i, --info

         Show torrent details and exit.



     -m, --portmap

         Enable portmapping via NAT-PMP or uPnP.



     -M, --no-portmap

         Disable portmapping.



     -n, --new sourcefile

         Create torrent from the specified file or directory.



     -p, --port port

         Set the port to listen for incoming peers.  The  default
         port is 51413.



     -r, --private

         When creating a new torrent, set its "private" flag.



     -s, --scrape

         Print the current number of seeders and leechers for the
         specified torrent.



     -t, --tos

         Set the peer socket TOS for local  router-based  traffic
         shaping.







SunOS 5.11          Last change: 17 Jul 2008                    3






User Commands                                  transmissioncli(1)



     -u, --uplimit speed

         Set the maximum upload speed, Which defaults to 20KB/s.



     -U, --no-uplimit

         Do not limit the upload speed.



     -v, --verify

         Verify the torrent's downloaded data.



     -w, --download-dir directory

         Where to save download data.



     In addition to  these  options,  sending  transmissioncli  a
     SIGHUP signal will contact the tracker for more peers.

OPERANDS
     The following operands are supported:

     torrent-file            The name of the torrent file.



     sourcefile              The name of the file or directory to
                             create the new-torrent-file.



     new-torrent-file        The name of the output file  created
                             from the sourcefile.



FILES
     The following files are used by this application:

     /usr/bin/transmissioncli

         The executable for transmissioncli





SunOS 5.11          Last change: 17 Jul 2008                    4






User Commands                                  transmissioncli(1)



     $HOME/.config/transmission

         Directory where transmissioncli keeps  torrent  informa-
         tion for future seeding and resuming operations.



EXIT STATUS
     The following exit values are returned:

     0        Application exited successfully.



     >0       Application exited with failure.



ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Availability                 SUNWtransmission            
    
     Interface stability          Volatile                    
    


SEE ALSO
     transmission(1),    transmission-daemon(1),    transmission-
     remote(1), attributes(5)

     Transmission community site - http:/www.transmissionbt.org/

NOTES
     transmissioncli  program  was  written   by   Charles   Kerr