source: trunk/gtk/transmission.1 @ 8710

Last change on this file since 8710 was 8710, checked in by charles, 13 years ago

(trunk) document the -g arg a little better

  • Property svn:keywords set to Date Rev Author Id
File size: 2.7 KB
Line 
1.\" $Id: transmission.1 8710 2009-06-16 19:50:01Z charles $
2.\"
3.\" Copyright (c) 2007 Joshua Elsasser
4.\"
5.\" Permission is hereby granted, free of charge, to any person obtaining a
6.\" copy of this software and associated documentation files (the "Software"),
7.\" to deal in the Software without restriction, including without limitation
8.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9.\" and/or sell copies of the Software, and to permit persons to whom the
10.\" Software is furnished to do so, subject to the following conditions:
11.\"
12.\" The above copyright notice and this permission notice shall be included in
13.\" all copies or substantial portions of the Software.
14.\"
15.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18.\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21.\" DEALINGS IN THE SOFTWARE.
22
23.Dd May 20, 2008
24.Dt TRANSMISSION-GTK 1
25.Os
26.Sh NAME
27.Nm transmission
28.Nd a bittorrent client
29.Sh SYNOPSIS
30.Nm transmission
31.Fl ?
32.Nm
33.Op Fl pqm
34.Op Ar torrent-file ...
35.Sh DESCRIPTION
36.Nm
37is a fast and easy BitTorrent client.
38.Pp
39BitTorrent is a peer-to-peer file transfer protocol which uses a
40metainfo file (usually with the .torrent file extension) and a central
41tracker to distribute file data amongst a group of peers.  For more
42information on the BitTorrent protocol see http://www.bittorrent.org/
43.Sh OPTIONS
44.Bl -tag -width Ds
45.It Fl ? Fl -help
46Show help options
47.It Fl p Fl -paused
48Start with all torrents paused
49.It Fl m Fl -minimized
50Start minimized in system tray
51.It Fl g, Fl -config-dir Ar directory
52Where to look for configuration files.  This can be used to swap between using the cli, daemon, gtk, and qt clients.
53See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
54
55.El
56.Pp
57Multiple .torrent files may be added at startup
58by appending them on the command line.
59If
60.Nm
61is already running, the torrents will be added to the running instance.
62
63.Sh ENVIRONMENT
64.Bl -tag -width Fl
65.It Ev TRANSMISSION_HOME
66Sets the default config-dir.
67.El
68
69.Sh FILES
70.Bl -tag -width Ds -compact
71.It ~/.config/transmission
72The config-dir used when neither
73.Op Ev TRANSMISSION_HOME
74nor
75.Op Fl g
76is specified.
77.El
78
79.Sh AUTHORS
80.An -nosplit
81.Nm
82was written by
83.An Charles Kerr ,
84.An Josh Elsasser ,
85.An Eric Petit ,
86and
87.An Mitchell Livingston .
88
89.Sh SEE ALSO
90.Xr transmissioncli 1 ,
91.Xr transmission-daemon 1 ,
92.Xr transmission-remote 1
93.Pp
94http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.