]> gitweb.michael.orlitzky.com - dead/htsn.git/blobdiff - doc/man1/htsn.1
Document the DEBUG log level.
[dead/htsn.git] / doc / man1 / htsn.1
index 9d7ebce607b170f8ce220a914149313275fae737..2ccb43cc273d51f9c1ef6c31c2c199263170a351 100644 (file)
@@ -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
 
@@ -99,8 +100,10 @@ Default: none
 .IP \fB\-\-pidfile\fR
 (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!
+
+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
 
@@ -148,7 +151,7 @@ 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 its
+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.