From b9517b98263d215054a12d97400c225521491bac Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Tue, 15 Sep 2009 14:11:46 +0000 Subject: [PATCH] (trunk) silence manpage warnings reported by lintian and recorded at http://lintian.debian.org/full/costela@debian.org.html#transmission --- cli/transmissioncli.1 | 23 -------- daemon/transmission-daemon.1 | 32 ---------- daemon/transmission-remote.1 | 109 +++++++---------------------------- gtk/transmission.1 | 6 -- 4 files changed, 21 insertions(+), 149 deletions(-) diff --git a/cli/transmissioncli.1 b/cli/transmissioncli.1 index 386e0942c..6958eb951 100644 --- a/cli/transmissioncli.1 +++ b/cli/transmissioncli.1 @@ -58,79 +58,56 @@ scripting capabilities. .Pp The options are as follows: .Bl -tag -width Ds - .It Fl a, Fl -announce Ar announce-url When creating a new torrent, set its announce URL - .It Fl b Fl -blocklist 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 B Fl -no-blocklist Disble blocklists. - .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 er Fl -encryption-required Encrypt all peer connections. .It Fl ep Fl -encryption-preferred Prefer encrypted peer connections. .It Fl et Fl -encryption-tolerated Prefer unencrypted peer connections. - .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. This can be used to swap between using the cli, daemon, gtk, and qt clients. See http://trac.transmissionbt.com/wiki/ConfigFiles for more information. - .It Fl h, Fl -help Prints a short usage summary. - .It Fl i, Fl -info 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 sourcefile Create torrent from the specified file or directory - .It Fl p, -port Ar port 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. - .Sh SIGNALS In addition to these options, sending .Nm diff --git a/daemon/transmission-daemon.1 b/daemon/transmission-daemon.1 index c19efd6a2..1fa5f6dbb 100644 --- a/daemon/transmission-daemon.1 +++ b/daemon/transmission-daemon.1 @@ -1,6 +1,5 @@ .Dd July 21, 2008 .Dt TRANSMISSION-DAEMON 1 - .Sh NAME .Nm transmission-daemon .Nd a bittorrent client @@ -28,80 +27,61 @@ .Op Fl V .Op Fl w Ar download-dir .Ek - .Sh DESCRIPTION .Nm is a daemon-based Transmission session that can be controlled via RPC commands from transmission's web interface or .Xr transmission-remote 1 . - .Sh OPTIONS .Bl -tag -width Ds - .It Fl a Fl -allowed Ar x.x.x.x,... Allow RPC access to a comma-delimited whitelist of IP addresses. Wildcards can be specified in an address by using '*'. Default: "127.0.0.1" Example: "127.0.0.*,192.168.1.*" - .It Fl b Fl -blocklist 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 c Ar directory Directory to watch for new .torrent files to be added. As they are added to this directory, the daemon will load them into Transmission. - .It Fl C Do not watch for new .torrent files. - .It Fl B Fl -no-blocklist Disble blocklists. - .It Fl f Fl -foreground Run in the foreground and print errors to stderr. - .It Fl g Fl -config-dir Ar directory Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients. See http://trac.transmissionbt.com/wiki/ConfigFiles for more information. - - .It Fl er Fl -encryption-required Encrypt all peer connections. .It Fl ep Fl -encryption-preferred Prefer encrypted peer connections. .It Fl et Fl -encryption-tolerated Prefer unencrypted peer connections. - .It Fl h Fl -help Print command-line option descriptions. - .It Fl i Fl -bind-address-ipv4 Listen for IPv4 BitTorrent connections on a specific address. Only one IPv4 listening address is allowed. Default: 0.0.0.0 (All addresses) .It Fl I Fl -bind-address-ipv6 Listen for IPv6 BitTorrent connections on a specific address. Only one IPv6 listening address is allowed. Default: :: (All addresses) .It Fl r Fl -rpc-bind-address Listen for RPC connections on a specific address. This must be an IPv4 address. Only one RPC listening address is allowed. Default: 0.0.0.0 (All addresses) - .It Fl -paused Pause all torrents on startup - .It Fl L Fl -peerlimit-global Ar limit Overall peer limit. Useful on embedded systems where the default might be unsuitable. Default: 240 .It Fl l Fl -peerlimit-torrent Ar limit Peer limit per torrent. Useful on embedded systems where the default might be unsuitable. Default: 60 - .It Fl m Fl -portmap Enable portmapping via NAT-PMP or UPnP .It Fl M Fl -no-portmap Disable portmapping - .It Fl p Fl -port Ar port Port to open and listen for RPC requests on. Default: 9091 - .It Fl P, -peerport Ar port Port to listen for incoming peers on. Default: 51413 - .It Fl t Fl -auth Require clients to authenticate themselves. This doesn't do much good unless @@ -109,31 +89,22 @@ This doesn't do much good unless and .Ar password are also set. - .It Fl T Fl -no-auth Don't require authentication from clients. - .It Fl u Fl -username Ar username Used for client authentication. - .It Fl v Fl -password Ar password Used for client authentication. - .It Fl V Fl -version Show version number and exit - .It Fl w Fl -download-dir Where to store downloaded data. - .El - .Sh ENVIRONMENT .Bl -tag -width Fl .It Ev TRANSMISSION_HOME Sets the default config-dir. .El - - .Sh FILES .Bl -tag -width Ds -compact .It ~/.config/transmission-daemon @@ -144,8 +115,6 @@ nor is specified. See http://trac.transmissionbt.com/wiki/ConfigFiles for more information. .El - - .Sh AUTHORS .An -nosplit .An Charles Kerr , @@ -153,7 +122,6 @@ See http://trac.transmissionbt.com/wiki/ConfigFiles for more information. .An Eric Petit , and .An Mitchell Livingston . - .Sh SEE ALSO .Xr transmissioncli 1 , .Xr transmission 1 , diff --git a/daemon/transmission-remote.1 b/daemon/transmission-remote.1 index 958768078..49640814b 100644 --- a/daemon/transmission-remote.1 +++ b/daemon/transmission-remote.1 @@ -66,68 +66,52 @@ By default, .Nm connects to the transmission session at localhost:9091. Other sessions can be controlled by specifying a different host and/or port. - .Sh OPTIONS .Bl -tag -width Ds .It Fl a Fl -add Ar filenames-or-URLs Add torrents to transmission. - .It Fl b Fl -debug Enable debugging mode. - .It Fl as Fl -alt-speed Use the alternate Limits. - .It Fl AS Fl -no-alt-speed Don't use the alternate Limits. - .It Fl asd Fl -alt-speed-downlimit Ar limit Limit the alternate download speed to .Ar limit kilobytes per second. - .It Fl asu Fl -alt-speed-uplimit Ar limit Limit the alternate upload speed to .Ar limit kilobytes per second. - .It Fl asc Fl -alt-speed-scheduler Use the scheduled on/off times. - .It Fl ASC Fl -no-alt-speed-scheduler Don't use the scheduled on/off days and times. - .It Fl -alt-speed-time-begin Ar time .Ar Time to start using the alt speed limits (in hhmm). - .It Fl -alt-speed-time-end Ar time .Ar Time to stop using the alt speed limits (in hhmm). - .It Fl -alt-speed-days Ar days Set the number of .Ar days on which to enable the speed scheduler, using a list such as "2,4-6". - .It Fl d Fl -downlimit Ar limit Limit the global download speed to .Ar limit kilobytes per second. - .It Fl D Fl -no-downlimit Remove the global download limit. - .It Fl er Fl -encryption-required Encrypt all peer connections. .It Fl ep Fl -encryption-preferred Prefer encrypted peer connections. .It Fl et Fl -encryption-tolerated Prefer unencrypted peer connections. - .It Fl f Fl -files Get a file list for the current torrent(s) - .It Fl g Fl -get Ar all | file-index | files Mark file(s) for download. .Ar all @@ -136,60 +120,46 @@ marks all all of the torrent's files for downloading, adds a single file to the download list, and .Ar files adds multiple files to the download list, -such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download list. - +such as "\-g1,3-5" to add files #1, #3, #4, and #5 to the download list. .It Fl G Fl -no-get Ar all | file-index | files Mark file(s) for not downloading. - .It Fl gsr Fl -global-seedratio Ar ratio All torrents, unless overridden by a per-torrent setting, should seed until a specific .Ar ratio - .It Fl GSR Fl -no-global-seedratio All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio - .It Fl h Fl -help Print command-line option descriptions. - .It Fl i Fl -info Ar id | torrent-hash Show details of the current torrent(s) - .It Fl si Fl -session-info List session information from the server - .It Fl st Fl -session-stats List statistical information from the server - .It Fl l Fl -list List all torrents - .It Fl m Fl -portmap Enable portmapping via NAT-PMP or UPnP .It Fl M Fl -no-portmap Disable portmapping - .It Fl n Fl -auth Ar username:password Set the .Ar username and .Ar password for authentication - .It Fl N Fl -netrc Ar filename Set the authentication information from a .Ar netrc file. See netrc(5) for more information. - .It Fl o Fl -dht Enable distributed hash table (DHT). .It Fl O Fl -no-dht Disable distribued hash table (DHT). - .It Fl p Fl -port Ar port Set the .Ar port for use when listening for incoming peer connections - .It Fl pn Fl -priority-normal Ar all | file-index | files Mark file(s) as normal priority. .Ar all @@ -198,48 +168,34 @@ marks all of the torrent's files as normal priority, sets a single file's priority as normal, and .Ar files sets multiple files' priorities as normal, -such as "-pn1,3-5" to normalize files #1, #3, #4, and #5. - +such as "\-pn1,3-5" to normalize files #1, #3, #4, and #5. .It Fl ph Fl -priority-high Ar all | file-index | files Mark file(s) as high priority. - .It Fl pl Fl -priority-low Ar all | file-index | files Mark file(s) as low priority. - .It Fl pr Fl -peers Ar number Set the current torrent(s)' maximum number of peers - .It Fl gpr Fl -global-peers Ar number Set the maximum number of peers allowed globally - .It Fl r Fl -remove Remove the current torrent(s). This does not delete the downloaded data. - .It Fl -remove-and-delete Remove the current torrent(s) and delete their downloaded data. - .It Fl -move Move the current torrents' data from their current locations to the specified directory. - .It Fl -find Tell Transmission where to look for the current torrents' data. - .It Fl sr Fl -seedratio Ar ratio Let the current torrent(s) seed until a specific .Ar ratio - .It Fl SR Fl -no-seedratio Let the current torrent(s) seed regardless of ratio - .It Fl srd Fl -seedratio-default Let the current torrent(s) use the global seedratio settings - .It Fl s Fl -start Start the current torrent(s) - .It Fl S Fl -stop Stop the current torrent(s) from downloading or seeding - .It Fl t Fl -torrent Ar all | id | torrent-hash Set the current torrent(s) for use by subsequent options. .Ar all @@ -248,31 +204,25 @@ will apply following requests to all torrents, while specific torrents can be ch or .Ar hash . To set more than one current torrent, join their ids or hashes together in a list, -such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8. - +such as "\-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8. .It Fl u Fl -uplimit Ar limit Limit the global upload speed to .Ar limit kilobytes per second. .It Fl U Fl -no-uplimit Remove the global upload limit. - .It Fl v Fl -verify Verify the current torrent(s) - .It Fl V Fl -version Show version number and exit - .It Fl w Fl -download-dir Ar directory Use .Ar directory as the default location for newly added torrents to download files to. - .It Fl x Fl -pex Enable peer exchange (PEX). .It Fl X Fl -no-pex Disable peer exchange (PEX). - .It Fl pi Fl -peer-info List the current torrent's connected peers. In the `status' section of the list, the following shorthand is used: @@ -286,80 +236,65 @@ In the `status' section of the list, the following shorthand is used: .D1 u: We would upload to this peer if they asked .D1 X: Peer was discovered through Peer Exchange (PEX) .D1 ?: We unchoked this peer, but they're not interested - .El .Sh EXAMPLES - Set download and upload limits to 400 KiB/sec and 60 KiB/sec: .Bd -literal -offset indent -$ transmission-remote -d400 -u60 -$ transmission-remote --downlimit=400 --uplimit=60 +$ transmission-remote \-d400 \-u60 +$ transmission-remote \-\-downlimit=400 \-\-uplimit=60 .Ed - Set alternate download and upload limits to 100 KiB/sec and 20 KiB/sec: .Bd -literal -offset indent -$ transmission-remote -asd100 -asu20 -$ transmission-remote --alt-speed-downlimit=100 --alt-speed-uplimit=20 +$ transmission-remote \-asd100 \-asu20 +$ transmission-remote \-\-alt-speed-downlimit=100 \-\-alt-speed-uplimit=20 .Ed - Set the scheduler to use the alternate speed limits on weekdays between 10AM and 11PM .Bd -literal -offset indent -$ transmission-remote --alt-speed-time-begin=1000 -$ transmission-remote --alt-speed-time-end=2300 -$ transmission-remote --alt-speed-days=1-5 -$ transmission-remote --alt-speed-scheduler +$ transmission-remote \-\-alt-speed-time-begin=1000 +$ transmission-remote \-\-alt-speed-time-end=2300 +$ transmission-remote \-\-alt-speed-days=1-5 +$ transmission-remote \-\-alt-speed-scheduler .Ed - List all torrents' IDs and states: .Bd -literal -offset indent -$ transmission-remote -l +$ transmission-remote \-l .Ed - List all torrents from a remote session that requires authentication: .Bd -literal -offset indent -$ transmission-remote host:9091 --auth=username:password -l +$ transmission-remote host:9091 \-\-auth=username:password \-l .Ed - Start all torrents: .Bd -literal -offset indent -$ transmission-remote -tall --start +$ transmission-remote \-tall \-\-start .Ed - Add two torrents: .Bd -literal -offset indent -$ transmission-remote -a one.torrent two.torrent +$ transmission-remote \-a one.torrent two.torrent .Ed - Add all torrents in ~/Desktop: .Bd -literal -offset indent -$ transmission-remote -a ~/Desktop/*torrent +$ transmission-remote \-a ~/Desktop/*torrent .Ed - Get detailed information on the torrent whose ID is '1': .Bd -literal -offset indent -$ transmission-remote -t1 -i +$ transmission-remote \-t1 \-i .Ed - Get a list of a torrent's files: .Bd -literal -offset indent -$ transmission-remote -t1 -l +$ transmission-remote \-t1 \-l .Ed - Download only its second and fourth files: .Bd -literal -offset indent -$ transmission-remote -t1 -Gall -g2,4 +$ transmission-remote \-t1 \-Gall \-g2,4 .Ed - Set all torrents' first two files' priorities to high: .Bd -literal -offset indent -$ transmission-remote -tall -ph1,2 +$ transmission-remote \-tall \-ph1,2 .Ed - Set all torrents' files' priorities to normal: .Bd -literal -offset indent -$ transmission-remote -tall -pnall +$ transmission-remote \-tall \-pnall .Ed - .Sh AUTHORS .An -nosplit .An Charles Kerr , @@ -367,11 +302,9 @@ $ transmission-remote -tall -pnall .An Eric Petit , and .An Mitchell Livingston . - .Sh SEE ALSO .Xr transmissioncli 1 , .Xr transmission-daemon 1 , .Xr transmission 1 - .Pp http://www.transmissionbt.com/ diff --git a/gtk/transmission.1 b/gtk/transmission.1 index 67724179c..021ea6f75 100644 --- a/gtk/transmission.1 +++ b/gtk/transmission.1 @@ -19,7 +19,6 @@ .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. - .Dd May 20, 2008 .Dt TRANSMISSION-GTK 1 .Os @@ -51,7 +50,6 @@ Start minimized in system tray .It Fl g, Fl -config-dir Ar directory Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients. See http://trac.transmissionbt.com/wiki/ConfigFiles for more information. - .El .Pp Multiple .torrent files may be added at startup @@ -59,13 +57,11 @@ by appending them on the command line. If .Nm is already running, the torrents will be added to the running instance. - .Sh ENVIRONMENT .Bl -tag -width Fl .It Ev TRANSMISSION_HOME Sets the default config-dir. .El - .Sh FILES .Bl -tag -width Ds -compact .It ~/.config/transmission @@ -75,7 +71,6 @@ nor .Op Fl g is specified. .El - .Sh AUTHORS .An -nosplit .Nm @@ -85,7 +80,6 @@ was written by .An Eric Petit , and .An Mitchell Livingston . - .Sh SEE ALSO .Xr transmissioncli 1 , .Xr transmission-daemon 1 ,