From 1c9fc237aae9afa0b8c374366562bfd52787b796 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 24 Dec 2013 11:54:07 -0500 Subject: [PATCH] Bump version to 0.0.2 and make some small documentation updates. --- doc/htsnrc.example | 15 +++++++++++---- doc/man1/htsn.1 | 11 ++++++++--- htsn.cabal | 11 ++++++++--- 3 files changed, 27 insertions(+), 10 deletions(-) diff --git a/doc/htsnrc.example b/doc/htsnrc.example index ca527fc..90212cd 100644 --- a/doc/htsnrc.example +++ b/doc/htsnrc.example @@ -1,8 +1,15 @@ # Example configuration file for htsn. For this to take effect, you -# would need to place it in either /etc/htsnrc or $HOME/.htsnrc. On -# Windows, it probably needs to go in %APPDATA%, or -# C:\Users\\Application Data. - +# would need to place it in either the user or global configuration +# directories. +# +# For a user, that's either $HOME/.htsnrc on Unix or +# %APPDATA%\.htsnrc (e.g. C:\Users\\Application +# Data\.htsnrc) on Windows. +# +# The global configuration directory is determined by Cabal. The +# "sysconfdir" parameter during the "configure" step will be used. On +# Unix, it's probably /etc, and this file will need to go in +# /etc/htsnrc. # Run in the background as a daemon? # diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1 index ee2361d..9d7ebce 100644 --- a/doc/man1/htsn.1 +++ b/doc/man1/htsn.1 @@ -144,9 +144,14 @@ so there is rarely a need to do this. .P Any of the command-line options mentioned above can be specified in a configuration file instead. We first look for \(dqhtsnrc\(dq in the -system configuration directory (/etc on Unix). We then look for a file -named \(dq.htsnrc\(dq in the user's home directory. The latter will -override the former. +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 +wherever %APPDATA% points. The system configuration directory is +determined by Cabal; the \(dqsysconfdir\(dq parameter during the +\(dqconfigure\(dq step is used. .P The file's syntax is given by examples in the htsnrc.example file (included with \fBhtsn\fR). diff --git a/htsn.cabal b/htsn.cabal index ea62ebe..fe641df 100644 --- a/htsn.cabal +++ b/htsn.cabal @@ -1,5 +1,5 @@ name: htsn -version: 0.0.1 +version: 0.0.2 cabal-version: >= 1.8 author: Michael Orlitzky maintainer: Michael Orlitzky @@ -185,10 +185,15 @@ description: . Any of the command-line options mentioned above can be specified in a 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 + system configuration directory. We then look for a file named + \".htsnrc\" in the user's home directory. The latter will override the former. . + The user's home directory is simply $HOME on Unix; on Windows its + wherever %APPDATA% points. The system configuration directory + is determined by Cabal; the /sysconfdir/ parameter during + the \"configure\" step is used. + . The file's syntax is given by examples in the htsnrc.example file (included with /htsn/). . -- 2.43.2