Skip to content

Commit

Permalink
Add basic manpages for daemon and remote
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Miller <jack@codezen.org>
  • Loading branch information
themoken committed Jul 19, 2012
1 parent 9f9e3bb commit 01649c1
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
56 changes: 56 additions & 0 deletions man/canto-daemon.1
@@ -0,0 +1,56 @@
.TH Canto-daemon 1 "Canto-daemon"

.SH NAME
Canto-daemon \- An extensible RSS aggregation daemon.

.SH COMMAND LINE USAGE

.TP
\-D/\-\-dir [directory]
Change base directory for canto-daemon (default: ~/.canto-ng)

.TP
\-\-nowb
Disable database writeback. Hurts performance, saves memory.

.TP
\-n/--nofetch
Do not fetch new content while running (debug).

.TP
\-a/--address [IP]
Listen on address in addition to local Unix socket.

.TP
\-p/--port [port]
Use port when listening with -a

.TP
\-v
Enable verbose logging (debug)

.SH CONFIGURATION

For configuration details, please visit http://codezen.org/canto-new/manual .

.SH FILES
.TP
.I ~/.canto-ng/conf

Shared daemon configuration file.

.TP
.I ~/.canto-ng/daemon-log

Canto-daemon log file.

.TP
.I ~/.canto-ng/plugins/

Canto-daemon plugins directory

.SH HOMEPAGE
http://codezen.org/canto-new

.SH AUTHOR
Jack Miller <jack@codezen.org>
28 changes: 28 additions & 0 deletions man/canto-remote.1
@@ -0,0 +1,28 @@
.TH Canto-remote 1 "Canto-remote"

.SH NAME
Canto-remote \- A basic remote for canto-daemon

.SH COMMAND LINE USAGE

.TP
\-D/--dir [directory]
Change base directory for canto-daemon (default: ~/.canto-ng)

.TP
\-a/--address [IP]
Attempt to connect to address instead of local Unix socket

.TP
\-p/--port [port]
Use port when connecting with -a

.SH COMMANDS

Run canto-remote with no arguments to list usage and commands.

.SH HOMEPAGE
http://codezen.org/canto-new

.SH AUTHOR
Jack Miller <jack@codezen.org>
1 change: 1 addition & 0 deletions setup.py
Expand Up @@ -8,4 +8,5 @@
url='http://codezen.org/canto', url='http://codezen.org/canto',
packages=['canto_next'], packages=['canto_next'],
scripts=['bin/canto-daemon','bin/canto-remote'], scripts=['bin/canto-daemon','bin/canto-remote'],
data_files = [("share/man/man1/", ["man/canto-daemon.1", "man/canto-remote.1"])],
) )

0 comments on commit 01649c1

Please sign in to comment.