From 22447993faaa3a91fc32d5102b3325cd4d6a42b7 Mon Sep 17 00:00:00 2001 From: Andrew Resch Date: Fri, 9 Oct 2009 16:26:10 +0000 Subject: [PATCH] Add man pages for deluge-console and deluge-gtk Update the other man pages --- ChangeLog | 7 +++++-- docs/man/deluge-console.1 | 29 +++++++++++++++++++++++++++++ docs/man/deluge-gtk.1 | 28 ++++++++++++++++++++++++++++ docs/man/deluge.1 | 2 +- docs/man/deluged.1 | 8 ++++++-- setup.py | 10 +++++++--- 6 files changed, 76 insertions(+), 8 deletions(-) create mode 100644 docs/man/deluge-console.1 create mode 100644 docs/man/deluge-gtk.1 diff --git a/ChangeLog b/ChangeLog index 8584a80a2..6a89deb3d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,7 +2,10 @@ ==== GtkUI ==== * Fix path errors when adding torrents externally in Windows * Fix localclient authentication by stripping the lines read from the auth file - + +==== Misc ==== + * Add man pages for deluge-console and deluge-gtk + === Deluge 1.2.0_rc1 (07 October 2009) === ==== Core ==== * Implement new RPC protocol DelugeRPC replacing XMLRPC @@ -168,7 +171,7 @@ * Fix #729 tracker icons not being saved in the correct location * Add support for more tracker icons * Fix being able to connect to a local daemon from another user account - + === Deluge 1.1.0 - "Time gas!" (10 January 2009) === ==== Core ==== * Implement #79 ability to change outgoing port range diff --git a/docs/man/deluge-console.1 b/docs/man/deluge-console.1 new file mode 100644 index 000000000..67da41cd3 --- /dev/null +++ b/docs/man/deluge-console.1 @@ -0,0 +1,29 @@ +.TH DELUGE-CONSOLE 1 "October 2009" "1.2.0" + +.SH NAME +deluge-console - a bittorrent client curses interface + +.SH SYNOPSIS +.B deluge-console [options] + +.SH DESCRIPTION +.br +.P +Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-console' being used to launch a console user-interface. +.br +.P +You can pass console commands directly from the command line, see `deluge-console --help` for a list of commands. +Run multiple commands by separating them with a semi-colon (;). + +.SH OPTIONS +See `deluge`. + +.SH SEE ALSO +.B Homepage: +http://www.deluge-torrent.org/ + +.SH AUTHOR +This manual page was written by Andrew Resch . +.br +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation +.br diff --git a/docs/man/deluge-gtk.1 b/docs/man/deluge-gtk.1 new file mode 100644 index 000000000..0fdeef708 --- /dev/null +++ b/docs/man/deluge-gtk.1 @@ -0,0 +1,28 @@ +.TH DELUGE-GTK 1 "October 2009" "1.2.0" + +.SH NAME +deluge-gtk - a bittorrent client gtk interface + +.SH SYNOPSIS +.B deluge-gtk [options] [torrent] + +.SH DESCRIPTION +.br +.P +Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-gtk' being used to launch a GTK+ user-interface. +.br +.P +By default, Deluge will run in 'Classic' mode where the daemon functionality will be hidden. You can turn this off in the Preferences dialog. + +.SH OPTIONS +See `deluge`. + +.SH SEE ALSO +.B Homepage: +http://www.deluge-torrent.org/ + +.SH AUTHOR +This manual page was written by Andrew Resch . +.br +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation +.br diff --git a/docs/man/deluge.1 b/docs/man/deluge.1 index 7cef8b8c6..07637b30a 100644 --- a/docs/man/deluge.1 +++ b/docs/man/deluge.1 @@ -1,4 +1,4 @@ -.TH DELUGE 1 "January 2009" "1.1.2" +.TH DELUGE 1 "October 2009" "1.2.0" .SH NAME deluge - a bittorrent client diff --git a/docs/man/deluged.1 b/docs/man/deluged.1 index 44a7f0d62..d10114ba0 100644 --- a/docs/man/deluged.1 +++ b/docs/man/deluged.1 @@ -1,4 +1,4 @@ -.TH DELUGED 1 "January 2009" "1.1.2" +.TH DELUGED 1 "October 2009" "1.2.0" .SH NAME deluged - a bittorrent client daemon @@ -25,6 +25,10 @@ Show this help message and exit. .I -p PORT, --port=PORT Port daemon will listen on, default is 58846 .TP +.I -i INTERFACE, --interface=INTERFACE +Interface daemon will listen for bittorrent connections on, this should be an IP address +.I -u UI_INTERFACE, --ui-interface=UI_INTERFACE +Interface daemon will listen for UI connections on, this should be an IP address .I -d, --do-not-daemonize Do not daemonize .TP @@ -48,7 +52,7 @@ Sets the log level to 'none', this is the same as `\-L none` http://www.deluge-torrent.org/ .SH AUTHOR -This manual page was written by Andrew Resch . +This manual page was written by Andrew Resch . .br Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation .br diff --git a/setup.py b/setup.py index 7e24f3989..01a23ebd7 100644 --- a/setup.py +++ b/setup.py @@ -279,7 +279,7 @@ class build_docs(BuildDoc): def run(self): class FakeModule(object): def __init__(self, *args, **kwargs): pass - + def __call__(self, *args, **kwargs): return FakeModule() @@ -299,7 +299,7 @@ class build_docs(BuildDoc): print "Skipping Exception: ", e return FakeModule() __builtins__.__import__ = new_import - + BuildDoc.run(self) class build(_build): @@ -382,7 +382,11 @@ _data_files = [ ('share/icons/hicolor/96x96/apps', ['deluge/data/icons/hicolor/96x96/apps/deluge.png']), ('share/applications', ['deluge/data/share/applications/deluge.desktop']), ('share/pixmaps', ['deluge/data/pixmaps/deluge.png', 'deluge/data/pixmaps/deluge.xpm']), - ('share/man/man1', ['docs/man/deluge.1', 'docs/man/deluged.1']) + ('share/man/man1', [ + 'docs/man/deluge.1', + 'docs/man/deluged.1', + 'docs/man/deluge-gtk.1', + 'docs/man/deluge-console.1']) ] # Main setup