From 9a6a6cb5dbc9495bc7fbe53fb187ebe17922552c Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 23 Dec 2013 19:40:11 -0500 Subject: [PATCH] Update cabal description again. --- htsn.cabal | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/htsn.cabal b/htsn.cabal index 3aeab95..09ac6da 100644 --- a/htsn.cabal +++ b/htsn.cabal @@ -8,7 +8,10 @@ license: GPL-3 license-file: doc/LICENSE build-type: Simple extra-source-files: - doc/man1/htsn.1 test/xml/*.xml + doc/htsnrc.example + doc/man1/htsn.1 + doc/init.openrc + test/xml/*.xml synopsis: Parse XML files from The Sports Network feed. description: @@ -95,7 +98,7 @@ description: @ . How verbose should the logs be? We log notifications at three levels: - INFO, WARN, and ERROR. Specify the "most boring" level of + INFO, WARN, and ERROR. Specify the \"most boring\" level of notifications you would like to receive (in all-caps); more interesting notifications will be logged as well. . @@ -125,8 +128,10 @@ description: . (Daemon mode only) Create a PID file in the given location. This is used by the init system on Unix to keep track of the running daemon. + Its parent directory must be writable by the user/group that we will + run as! . - Default: \/run\/htsn.pid + Default: \/run\/htsn\/htsn.pid . @ \--run-as-group @@ -179,15 +184,15 @@ description: /Configuration File/: . Any of the command-line options mentioned above can be specified in a - configuration file instead. We look for a file named ".htsnrc" - in the user's home directory; its syntax is given by examples in the - htsnrc.example file (included with /htsn/). + configuration file instead. We first look for \"htsnrc\" in the + system configuration directory (/etc on Unix). We then look for a file + named \".htsnrc\" in the user's home directory. The latter will override + the former. . - If you are using the @--run-as-user@ option, that means that - the configuration file will need to go in that user's home directory - (and not, for example, root's). + The file's syntax is given by examples in the htsnrc.example file + (included with /htsn/). . - Options specified on the command-line override those in the + Options specified on the command-line override those in either configuration file. -- 2.43.2