Skip to content

Commit

Permalink
Brush up manpages
Browse files Browse the repository at this point in the history
- XDG paths
- removed -c option
- Add canto-remote status
  • Loading branch information
themoken committed Jun 24, 2015
1 parent 33efc56 commit eccd1d8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
19 changes: 6 additions & 13 deletions man/canto-daemon.1
Expand Up @@ -23,19 +23,12 @@ Enable verbose logging (debug)

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

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

.TP
\-c/--cache [on|off|conn]
Control memory usage v. performance
on: keep the entire database in memory (fastest)
conn: keep the database in memory with active connections
off: keep as little information in memory as possible (default)

.TP
\-\-noplugins
Disable all plugins
Expand Down Expand Up @@ -66,9 +59,9 @@ canto-remote or a client, like canto-curses.

Plugins are packaged in <prefix>/canto/plugins (i.e. /usr/lib/canto/plugins)
and can be enabled by copying them into your configuration directory (i.e.
~/.canto-ng/plugins). Many of them have configuration in them, so you may want
to open the files to make changes. Here are a few example plugins included with
the canto-daemon source.
$XDG_CONFIG_HOME/canto/plugins). Many of them have configuration in them, so
you may want to open the files to make changes. Here are a few example plugins
included with the canto-daemon source.

.TP
reddit.py
Expand All @@ -90,12 +83,12 @@ on the web as well as various mobile devices.
.SH FILES

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

Canto-daemon log file.

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

Canto-daemon plugins directory

Expand Down
11 changes: 10 additions & 1 deletion man/canto-remote.1
Expand Up @@ -21,7 +21,7 @@ Print usage help

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

.TP
\-\-noplugins
Expand Down Expand Up @@ -66,6 +66,15 @@ List all subscribed feeds
.B delfeed [name or listfeeds index]
Unsubscribe from a feed

.TP
.B status (--tag=tag) (--read|--total|--tags)
Print the number of unread items, optionally restricted to a specific tag,
--read prints read items, --total prints total items, --tags prints the value
for all tags.

NOTE: This is still subject to filters, so if you're filtering all read items,
--read will never return anything but 0.

.TP
.B force-update
Refetch all feeds, regardless of timestamps
Expand Down

0 comments on commit eccd1d8

Please sign in to comment.