Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic manpages for daemon and remote
Signed-off-by: Jack Miller <jack@codezen.org>
- Loading branch information
Showing
3 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters