Brush up manpages
authorJack Miller <jack@codezen.org>
Thu, 25 Sep 2014 21:33:32 +0000 (16:33 -0500)
committerJack Miller <jack@codezen.org>
Thu, 25 Sep 2014 22:59:35 +0000 (17:59 -0500)
- Update daemon/remote command line usage
- Add plugin information to daemon manpage
- Remove .canto-ng/conf from "FILES" in an attempt to discourage hand use,
  although it's still just sitting where you'd expect =P
- Add remote command details

man/canto-daemon.1
man/canto-remote.1

index 12d64b6..a5a2ed4 100644 (file)
@@ -5,43 +5,88 @@ Canto-daemon \- An extensible RSS aggregation daemon.
 
 .SH COMMAND LINE USAGE
 
+canto-daemon (options)
+
+.SH OPTIONS
+
 .TP
-\-V
+\-V/--version
 Print version info and exit.
 
 .TP
-\-D/\-\-dir [directory]
-Change base directory for canto-daemon (default: ~/.canto-ng)
+\-h/--help
+Print usage help
+
+.TP
+\-v
+Enable verbose logging (debug)
 
 .TP
-\-\-nowb
-Disable database writeback. Hurts performance, saves memory.
+\-D/--dir [directory]
+Change base directory for canto-daemon (default: ~/.canto-ng)
 
 .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
+
+.TP
+\-\-enableplugins 'plugin1 plugin2...'
+Enable these plugins (overrides --noplugins)
+
+.TP
+\-\-disableplugins 'plugin1 plugin2...'
+Disable these plugins
+
+.TP
 \-a/--address [IP]
-Listen on address in addition to local Unix socket.
+Listen on address in addition to local Unix socket. Use "" for all interfaces.
+Defaults to loopback (127.0.0.1)
 
 .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-ng/manual .
+This daemon manages its own configuration, and should be manipulated through
+canto-remote or a client, like canto-curses.
+
+.SH PLUGINS
+
+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.
 
-.SH FILES
 .TP
-.I ~/.canto-ng/conf
+reddit.py
+Add content to reddit items. Includes a sort
+.B "reddit_score_sort"
+that will automatically order items by upvotes.
 
-Shared daemon configuration file.
+.TP
+sync.py
+A generic file-based sync plugin, to be used with other sync plugins.
+
+.TP
+sync-rsync.py
+An rsync based sync plugin (requires sync.py). See header for configuration,
+can be used to sync with a remote server via SSH, or with another local
+filesystem (for NFS/sshfs/Dropbox/gdrive etc.)
+
+.SH FILES
 
 .TP
 .I ~/.canto-ng/daemon-log
@@ -53,8 +98,15 @@ Canto-daemon log file.
 
 Canto-daemon plugins directory
 
+.TP
+.I /usr/lib/canto/plugins
+Default packaged plugin directory.
+
 .SH HOMEPAGE
 http://codezen.org/canto-ng
 
 .SH AUTHOR
 Jack Miller <jack@codezen.org>
+
+.SH SEE ALSO
+.BR canto-remote (1)
index 53e3baf..1551d46 100644 (file)
@@ -3,19 +3,42 @@
 .SH NAME
 Canto-remote \- A basic remote for canto-daemon
 
+This provides some capability to configure and query canto-daemon without a full client. Useful for scripting or interfacing with other programs.
+
 .SH COMMAND LINE USAGE
 
+canto-remote (options) [command] (arguments)
+
+.SH OPTIONS
+
 .TP
 \-V
 Print version info and exit.
 
 .TP
+\-h/--help
+Print usage help
+
+.TP
 \-D/--dir [directory]
 Change base directory for canto-daemon (default: ~/.canto-ng)
 
 .TP
+\-\-noplugins
+Disable all plugins
+
+.TP
+\-\-enableplugins 'plugin1 plugin2...'
+Enable these plugins (overrides --noplugins)
+
+.TP
+\-\-disableplugins 'plugin1 plugin2...'
+Disable these plugins
+
+.TP
 \-a/--address [IP]
-Attempt to connect to address instead of local Unix socket
+Attempt to connect to address instead of local Unix socket, defaults to
+loopback (127.0.0.1)
 
 .TP
 \-p/--port [port]
@@ -23,10 +46,75 @@ Use port when connecting with -a
 
 .SH COMMANDS
 
-Run canto-remote with no arguments to list usage and commands.
+Canto-remote supports various commands to configure canto-daemon, although
+using a real client is recommended.
+
+.TP
+.B help [command]
+Get help on a specific command
+
+.TP
+.B addfeed [URL] (username=user password=secret) (name="Some name")
+Subscribe to a feed, optionally with special arguments. If no name is
+specified, the feed's title will be used.
+
+.TP
+.B listfeeds
+List all subscribed feeds
+
+.TP
+.B delfeed [name or listfeeds index]
+Unsubscribe from a feed
+
+.TP
+.B force-update
+Refetch all feeds, regardless of timestamps
+
+.TP
+.B config (="value")
+Change a configuration variable
+.br
+.B (You probably don't want to do this by hand, use a client)
+
+.TP
+.B one-config (= value)
+Change a single configuration variable, assuming the entire line is one setting.
+.br
+.B (You probably don't want to do this by hand, use a client)
+
+.TP
+.B export
+.br
+Write an OPML formatted list of feeds to stdout
+.br
+(i.e. canto-remote export > feedlist.opml)
+
+.TP
+.B import
+.br
+Import an OPML formatted list of feeds from stdin
+.br
+(i.e. canto-remote import < feedlist.opml)
+
+.TP
+.B kill
+.br
+Kill the daemon you're connecting to
+
+.TP
+.B script
+.br
+Run a script (testing code)
+
+.TP
+NOTE: Plugins can also add remote commands, like 'sync', which will also be
+listed with --help (or no arguments).
 
 .SH HOMEPAGE
 http://codezen.org/canto-ng
 
 .SH AUTHOR
 Jack Miller <jack@codezen.org>
+
+.SH SEE ALSO
+.BR canto-daemon (1)