diff --git a/cli/transmissioncli.1 b/cli/transmissioncli.1 index eb6090739..159127be2 100644 --- a/cli/transmissioncli.1 +++ b/cli/transmissioncli.1 @@ -34,18 +34,17 @@ .Nm .Op Fl v Ar level .Op Fl p Ar port -.Op Fl d Ar download-rate -.Op Fl u Ar upload-rate +.Op Fl d Ar number +.Op Fl u Ar number .Op Fl f Ar script .Op Fl n .Ar torrent-file .Op Ar output-dir .Nm -.Op Fl v Ar level -.Fl c Ar source-file -.Fl a Ar announce-url -.Op Fl p Ar port -.Op Fl m Ar comment +.Fl n Ar path +.Op Fl a Ar url +.Op Fl c Ar comment +.Op Fl r .Ar output-file .Ek .Sh DESCRIPTION @@ -56,49 +55,66 @@ scripting capabilities. .Pp The options are as follows: .Bl -tag -width Ds -.It Fl g, Fl -config-dir Ar directory -Where to look for configuration files. -.It Fl o, Fl -output-dir Ar directory -Where to save downloaded data. -.It Fl c, Fl -create-from Ar source-file -Create torrent from the specified source file. + .It Fl a, Fl -announce Ar announce-url -Specifies the announce-url the new torrent will use. Can only be -used in conjunction with -c or --create-from. -.It Fl r, Fl -private -Sets the private flag for the new torrent. Can only be used in -conjunction with -c or --create-from. -.It Fl m, Fl -comment Ar comment-text -This optional parameter adds a comment to the new torrent. Can only -be used in conjunction with -c or --create-from. +When creating a new torrent, set its announce URL + +.It Fl c, Fl -comment Ar comment-text +When creating a new torrent, set its comment field + +.It Fl d, -downlimit Ar number +Set the maximum download speed in KB/s + +.It Fl D, -no-downlimit +Don't limit the download speed + +.It Fl f, -finish Ar script +Set a script to run when the torrent finishes + +.It Fl g, Fl -config-dir Ar directory +Where to look for configuration files + .It Fl h, Fl -help Prints a short usage summary. + .It Fl i, Fl -info -Shows information from the specified torrent file, such as the -cryptographic hash, the tracker, announcement, file size and file -name. -.It Fl s, -scrape -Prints the number of seeders and leechers for the specified torrent -file, and exits. -.It Fl v, -verbose Ar level -Sets debugging options. You can use both many -v flags, or a -v level. The current available levels are 0-2, with the highest -level producing the most output. The default is 0. -.It Fl n, Fl -nat-traversal -Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port -mapping for allowing incoming peer connections. +Shows torrent details and exit + +.It Fl m, Fl -portmap +Enable portmapping via NAT-PMP or UPnP + +.It Fl M, Fl -no-portmap +Disable portmapping + +.It Fl n, Fl -new Ar path +Create torrent from the specified file or directory + .It Fl p, -port Ar port -Specifies an alternate port for the client to listen on. The default is -51413. -.It Fl u, -upload Ar upload-rate -Specifies the maximum upload rate in kB/s, which defaults to 20. The -level -1 may be used for unlimited uploads. -.It Fl d, -download Ar download-rate -Specifies the maximum download rate in kB/s, which defaults to -1 for -no download limit. -.It Fl f, -finish Ar script -Specifies a shell script to be executed upon successful download. -.It Fl y, Fl -recheck -Force a recheck of the torrent data. +Set the port to listen for incoming peers. (Default: 51413) + +.It Fl r, Fl -private +When creating a new torrent, set its 'private' flag + +.It Fl s, -scrape +Print the current number of seeders and leechers for the specified torrent + +.It Fl t, -tos +Set the peer socket TOS for local router-based traffic shaping. + +.It Fl u, -uplimit Ar number +Set the maximum upload speed in KB/s + +.It Fl U, -no-uplimit +Don't limit the upload speed + +.It Fl v, Fl -verify +Verify the torrent's downloaded data. + +.It Fl w, Fl -download-dir Ar directory +Where to save downloaded data. + +ccc + .Sh SIGNALS In addition to these options, sending .Nm diff --git a/cli/transmissioncli.c b/cli/transmissioncli.c index aafd23ee3..4d1d0e153 100644 --- a/cli/transmissioncli.c +++ b/cli/transmissioncli.c @@ -449,7 +449,7 @@ const struct tr_option options[] = { { 'm', "portmap", "Enable portmapping via NAT-PMP or UPnP", "m", 0, NULL }, { 'M', "no-portmap", "Disable portmapping", "M", 0, NULL }, { 'n', "new", "Create a new torrent from a file or directory", "n", 1, "" }, - { 'p', "port", "Port to listen for incoming peers (Default: "TR_DEFAULT_RPC_PORT_STR")", "p", 1, "" }, + { 'p', "port", "Port to listen for incoming peers (Default: "TR_DEFAULT_PORT_STR")", "p", 1, "" }, { 'r', "private", "When creating a new torrent, set its 'private' flag", "r", 0, NULL }, { 's', "scrape", "Scrape the torrent and exit", "s", 0, NULL }, { 't', "tos", "Peer socket TOS (0 to 255, default="TR_DEFAULT_PEER_SOCKET_TOS_STR")", "t", 1, ""}, diff --git a/daemon/daemon.c b/daemon/daemon.c index 0e5d544d5..b64838af9 100644 --- a/daemon/daemon.c +++ b/daemon/daemon.c @@ -230,11 +230,11 @@ const struct tr_option options[] = { { 'B', "no-blocklist", "Disable peer blocklists", "B", 0, NULL }, { 'f', "foreground", "Run in the foreground instead of daemonizing", "f", 0, NULL }, { 'g', "config-dir", "Where to look for configuration files", "g", 1, "" }, - { 'p', "port", "Port to listen for incoming peers (Default: "TR_DEFAULT_RPC_PORT_STR")", "p", 1, "" }, + { 'p', "port", "Port to listen for incoming peers (Default: "TR_DEFAULT_PORT_STR")", "p", 1, "" }, { 't', "auth", "Requre authentication", "t", 0, NULL }, { 'T', "no-auth", "Don't require authentication", "T", 0, NULL }, { 'u', "username", "Set username for authentication", "u", 1, "" }, - { 's', "password", "Set password for authentication", "s", 1, "" }, + { 'v', "password", "Set password for authentication", "v", 1, "" }, { 'w', "download-dir", "Where to save downloaded data", "w", 1, "" }, { 0, NULL, NULL, NULL, 0, NULL } }; @@ -249,7 +249,8 @@ showUsage( void ) static void readargs( int argc, const char ** argv, int * nofork, const char ** configDir, const char ** downloadDir, - int * rpcPort, const char ** acl, int * authRequired, const char ** username, const char ** password, + int * rpcPort, const char ** acl, + int * authRequired, const char ** username, const char ** password, int * blocklistEnabled ) { int c; @@ -267,7 +268,7 @@ readargs( int argc, const char ** argv, case 't': *authRequired = TRUE; break; case 'T': *authRequired = FALSE; break; case 'u': *username = optarg; break; - case 's': *password = optarg; break; + case 'v': *password = optarg; break; case 'w': *downloadDir = optarg; break; default: showUsage( ); break; } @@ -353,7 +354,7 @@ main( int argc, char ** argv ) signal( SIGPIPE, SIG_IGN ); signal( SIGHUP, SIG_IGN ); - readargs( argc, (const char*)argv, &nofork, &configDir, &downloadDir, + readargs( argc, (const char**)argv, &nofork, &configDir, &downloadDir, &rpcPort, &acl, &authRequired, &username, &password, &blocklistEnabled ); if( configDir == NULL ) diff --git a/daemon/transmission-daemon.1 b/daemon/transmission-daemon.1 index 4693294ba..61a384654 100644 --- a/daemon/transmission-daemon.1 +++ b/daemon/transmission-daemon.1 @@ -11,16 +11,16 @@ .Nm .Op Fl a Ar (+|-)x.x.x.x[/x],... .Op Fl b -.Op Fl b0 -.Op Fl d +.Op Fl B .Op Fl f .Op Fl g Ar directory .Op Fl h .Op Fl p Ar port .Op Fl t -.Op Fl t0 +.Op Fl T .Op Fl u Ar username -.Op Fl w Ar password +.Op Fl v Ar password +.Op Fl w Ar download-dir .Ek .Sh DESCRIPTION @@ -47,12 +47,9 @@ Default: +127.0.0.1 Enable peer blocklists. Transmission understands the bluetack blocklist file format. New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory. -.It Fl b0 Fl -blocklist=0 +.It Fl B Fl -no-blocklist Disble blocklists. -.It Fl d Fl -download-dir -Where to store downloaded data. - .It Fl f Fl -foreground Run in the foreground and print errors to stderr. @@ -68,18 +65,23 @@ Port to open and listen for RPC requests on. Default: 9091 .It Fl t Fl -auth Require clients to authenticate themselves. This doesn't do much good unless -.Ar username and -.Ar password are also set. +.Ar username +and +.Ar password +are also set. -.It Fl t0 Fl -auth=0 +.It Fl T Fl -no-auth Don't require authentication from clients. -.It Fl u Fl -username ar username +.It Fl u Fl -username Ar username Used for client authentication. -.It Fl w Fl -password ar password +.It Fl v Fl -password Ar password Used for client authentication. +.It Fl w Fl -download-dir +Where to store downloaded data. + .El .Sh ENVIRONMENT diff --git a/libtransmission/transmission.h b/libtransmission/transmission.h index fe93e3713..0bb6bb406 100644 --- a/libtransmission/transmission.h +++ b/libtransmission/transmission.h @@ -111,6 +111,8 @@ tr_proxy_type; /** @see tr_sessionInitFull */ #define TR_DEFAULT_PORT 51413 /** @see tr_sessionInitFull */ +#define TR_DEFAULT_PORT_STR "51413" +/** @see tr_sessionInitFull */ #define TR_DEFAULT_GLOBAL_PEER_LIMIT 200 /** @see tr_sessionInitFull */ #define TR_DEFAULT_PEER_SOCKET_TOS 8