X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn-common.git;a=blobdiff_plain;f=htsn-common.cabal;fp=htsn-common.cabal;h=06b36b069645d88dfb332fb22fe1a78f04fd5940;hp=e5f6939e49b85dd9a5bea85928005befbf81a9de;hb=364709b7a01a7c2b601ff2eae8237c815a858838;hpb=47a56f78983c6c328936e240c30d2f47d26425fe diff --git a/htsn-common.cabal b/htsn-common.cabal index e5f6939..06b36b0 100644 --- a/htsn-common.cabal +++ b/htsn-common.cabal @@ -8,7 +8,7 @@ license: GPL-3 license-file: doc/LICENSE build-type: Simple synopsis: - Library used by both htsn and htsn-import. + Display/logging facilities used by both htsn and htsn-import. description: This library contains three modules, . @@ -20,6 +20,20 @@ description: . They work together to provide \"reporting\" for the htsn and htsn-import executables which both display and log things in the same way. + . + The Network.Services.TSN.Logging module allows the application to + log to syslog, a file, or both. Four convenience functions are + provided to log messages at each priority: error, debug, info, and + warn. + . + The Network.Services.TSN.Terminal provides similar functions that + instead display messages on the console (terminal). The output is + color-coded according to the severity of the message. + . + The Network.Services.TSN.Report modules contains convenience + functions that both log and display informational message. This is + what an (optionally interactive) application will usually want to + do. library hs-source-dirs: src/