mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity

Update transmissioncli manpage, add transmission-gtk manpage skeleton.

This commit is contained in:
Josh Elsasser 2007-04-04 01:20:45 +00:00
parent 304d735e7d
commit fffd302c2c
3 changed files with 106 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
cli/transmissioncli.1
View File

@ -13,39 +13,48 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd April 22, 2006
.Dd April 3, 2007
.Dt TRANSMISSIONCLI 1
.Os
.Sh NAME
.Nm transmissioncli
.Nd a lightweight bittorrent client
.Nd a bittorrent client
.Sh SYNOPSIS
.Nm transmissioncli
.Bk -words
.Op Fl h
.Op Fl i Ar torrent-file
.Op Fl s Ar torrent-file
.Fl h
.Nm
.Op Fl v Ar level
.Fl i
.Ar torrent-file
.Nm
.Op Fl v Ar level
.Fl s
.Ar torrent-file
.Nm
.Op Fl v Ar level
.Op Fl n
.Op Fl p Ar port
.Op Fl d Ar download-rate
.Op Fl u Ar upload-rate
.Op Fl u Ar download-rate
.Op Fl f Ar script
.Op Fl n
.Ar torrent-file
.Ek
.Sh DESCRIPTION
The
.Nm
program is a lightweight, command-line BitTorrent client with
scripting capabilities. The options are as follows:
scripting capabilities.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h, Fl -help
Prints a short usage summary.
.It Fl i, Fl -info Ar torrent-file
.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 Ar torrent-file
.It Fl s, -scrape
Prints the number of seeders and leechers for the specified torrent
file, and exits.
.It Fl v, -verbose Ar level
@ -58,7 +67,7 @@ mapping for allowing incoming peer connections.
Specifies an alternate port for the client to listen on. The default is
9090.
.It Fl u, -upload Ar upload-rate
Specifies the maximum upload rate in kB/s, which defaults to 20. The
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
@ -77,15 +86,11 @@ The
.Nm
program was written by
.An -nosplit
.An Eric Petit Aq titer@m0k.org
.An Josh Elsasser Aq josh@elsasser.org
.An Bryan Varner Aq bryan@varnernet.com
.An Eric Petit Aq titer@m0k.org ,
.An Josh Elsasser Aq josh@elsasser.org ,
and
.An Michael Demars Aq keul@m0k.org .
.An Mitchell Livingston Aq livings124@gmail.com .
.Sh SEE ALSO
.Xr transmission-gtk 1
.Pp
http://transmission.m0k.org
.Sh CAVEATS
.Nm
currently saves its downloads into the directory from which it was
called. If this directory is not writeable by the user, the program
will terminate unexpectedly.

77
gtk/transmission-gtk.1 Normal file
View File

@ -0,0 +1,77 @@
.\" $Id$
.\"
.\" Copyright (c) 2007 Joshua Elsasser
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
.\" to deal in the Software without restriction, including without limitation
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
.\" and/or sell copies of the Software, and to permit persons to whom the
.\" Software is furnished to do so, subject to the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included in
.\" all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
.\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
.\" 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 March 30, 2007
.Dt TRANSMISSION-GTK 1
.Os
.Sh NAME
.Nm transmission-gtk
.Nd a bittorrent client
.Sh SYNOPSIS
.Nm transmission-gtk
.Fl h
.Nm
.Op Fl pq
.Op Ar torrent-file ...
.Sh DESCRIPTION
The
.Nm
program is a lightweight BitTorrent client with a simple, intuitive
GTK+ interface.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h Fl -help
Print command-line option descriptions.
.It Fl p Fl -paused
Start with all torrents paused
.It Fl q Fl -quit
Quit a running
.Nm
instance
.El
.Pp
Only one instance of
.Nm
may run at one time. Multiple torrent files may be loaded at startup
by adding them to the command line. If
.Nm
is already running, those torrents will be opened in the running
instance.
.Sh FILES
.Pa ~/.transmission
.Sh AUTHORS
.An -nosplit
The
.Nm
program was written by
.An Josh Elsasser Aq josh@elsasser.org ,
.An Eric Petit Aq titer@m0k.org ,
and
.An Mitchell Livingston Aq livings124@gmail.com .
.Sh SEE ALSO
.Xr transmissioncli 1 ,
.Xr transmission-daemon 1 ,
.Xr transmission-proxy 1 ,
.Xr transmission-remote 1
.Pp
http://transmission.m0k.org

5
mk/gtk.mk
View File

@ -34,7 +34,7 @@ clean:
.depend: $(SRCS) ../mk/config.mk ../mk/common.mk ../mk/gtk.mk
$(DEP_RULE)
install: transmission-gtk .po desktop.install icon.install
install: transmission-gtk man.install desktop.install icon.install .po
$(INSTALL_BIN_RULE)
@$(MAKE) $(MAKEARGS) -C po -f ../../mk/po.mk install
@ -44,6 +44,9 @@ desktop.install: transmission-gtk.desktop
icon.install: transmission.png
$(INSTALL_ICON_RULE)
man.install: transmission-gtk.1
$(INSTALL_MAN_RULE)
morepot: $(SRCS)
xgettext --output=po/transmission-gtk.pot --from-code=UTF-8 --add-comments --keyword=_ --keyword=N_ $^