Add man pages for deluge-console and deluge-gtk

Update the other man pages
This commit is contained in:
Andrew Resch 2009-10-09 16:26:10 +00:00
parent 11c0e9a304
commit 6274a32ca1
5 changed files with 71 additions and 6 deletions

29
docs/man/deluge-console.1 Normal file
View File

@ -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 <andrewresch@gmail.com>.
.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

28
docs/man/deluge-gtk.1 Normal file
View File

@ -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 <andrewresch@gmail.com>.
.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

View File

@ -1,4 +1,4 @@
.TH DELUGE 1 "January 2009" "1.1.2" .TH DELUGE 1 "October 2009" "1.2.0"
.SH NAME .SH NAME
deluge - a bittorrent client deluge - a bittorrent client

View File

@ -1,4 +1,4 @@
.TH DELUGED 1 "January 2009" "1.1.2" .TH DELUGED 1 "October 2009" "1.2.0"
.SH NAME .SH NAME
deluged - a bittorrent client daemon deluged - a bittorrent client daemon
@ -25,6 +25,10 @@ Show this help message and exit.
.I -p PORT, --port=PORT .I -p PORT, --port=PORT
Port daemon will listen on, default is 58846 Port daemon will listen on, default is 58846
.TP .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 .I -d, --do-not-daemonize
Do not daemonize Do not daemonize
.TP .TP
@ -48,7 +52,7 @@ Sets the log level to 'none', this is the same as `\-L none`
http://www.deluge-torrent.org/ http://www.deluge-torrent.org/
.SH AUTHOR .SH AUTHOR
This manual page was written by Andrew Resch <andrew.resch@gmail.com>. This manual page was written by Andrew Resch <andrewresch@gmail.com>.
.br .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 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 .br

View File

@ -279,7 +279,7 @@ class build_docs(BuildDoc):
def run(self): def run(self):
class FakeModule(object): class FakeModule(object):
def __init__(self, *args, **kwargs): pass def __init__(self, *args, **kwargs): pass
def __call__(self, *args, **kwargs): def __call__(self, *args, **kwargs):
return FakeModule() return FakeModule()
@ -299,7 +299,7 @@ class build_docs(BuildDoc):
print "Skipping Exception: ", e print "Skipping Exception: ", e
return FakeModule() return FakeModule()
__builtins__.__import__ = new_import __builtins__.__import__ = new_import
BuildDoc.run(self) BuildDoc.run(self)
class build(_build): class build(_build):
@ -382,7 +382,11 @@ _data_files = [
('share/icons/hicolor/96x96/apps', ['deluge/data/icons/hicolor/96x96/apps/deluge.png']), ('share/icons/hicolor/96x96/apps', ['deluge/data/icons/hicolor/96x96/apps/deluge.png']),
('share/applications', ['deluge/data/share/applications/deluge.desktop']), ('share/applications', ['deluge/data/share/applications/deluge.desktop']),
('share/pixmaps', ['deluge/data/pixmaps/deluge.png', 'deluge/data/pixmaps/deluge.xpm']), ('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 # Main setup