X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fman1%2Fhtsn.1;h=2ccb43cc273d51f9c1ef6c31c2c199263170a351;hb=97168adc8c0cf7b3bc9c64f1129457e84aef2b28;hp=a2ca93c4fdd1e561138d88dde627374fea26db88;hpb=67062e7c47c1cc949a99c8cb20cd0e696c097e15;p=dead%2Fhtsn.git diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1 index a2ca93c..2ccb43c 100644 --- a/doc/man1/htsn.1 +++ b/doc/man1/htsn.1 @@ -72,15 +72,16 @@ Default: disabled .IP \fB\-\-log-file\fR If you specify a file here, logs will be written to it (possibly in addition to syslog). Can be either a relative or absolute path. It -will not be auto-rotated; use something log logrotate for that. +will not be auto-rotated; use something like logrotate for that. Default: none .IP \fB\-\-log-level\fR -How verbose should the logs be? We log notifications at three levels: -INFO, WARN, and ERROR. Specify the \(dqmost boring\(dq level of +How verbose should the logs be? We log notifications at four levels: +DEBUG, INFO, WARN, and ERROR. Specify the \(dqmost boring\(dq level of notifications you would like to receive (in all-caps); more -interesting notifications will be logged as well. +interesting notifications will be logged as well. The debug output is +extremely verbose and will not be written to syslog even if you try. Default: INFO @@ -100,7 +101,11 @@ Default: none (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. -Default: /run/htsn.pid +If necessary, its parent directory will be created with owner/group +set to the appropriate user/group, but at most one directory will be +created (that is, we won't create an entire directory tree). + +Default: /run/htsn/htsn.pid .IP \fB\-\-run\-as\-group\fR (Daemon mode only) Run as the given system group. The PID file is @@ -141,15 +146,20 @@ so there is rarely a need to do this. .SH CONFIGURATION FILE .P Any of the command-line options mentioned above can be specified in a -configuration file instead. We look for a file named \(dq.htsnrc\(dq -in the user's home directory; its syntax is given by examples in the -htsnrc.example file (included with \fBhtsn\fR). +configuration file instead. We first look for \(dqhtsnrc\(dq in the +system configuration directory. We then look for a file named +\(dq.htsnrc\(dq in the user's home directory. The latter will override +the former. +.P +The user's home directory is simply $HOME on Unix; on Windows it's +wherever %APPDATA% points. The system configuration directory is +determined by Cabal; the \(dqsysconfdir\(dq parameter during the +\(dqconfigure\(dq step is used. .P -If you are using the \fI\-\-run\-as\-user\fR 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 \fBhtsn\fR). .P -Options specified on the command-line override those in the +Options specified on the command-line override those in either configuration file. .SH BUGS