From 3985236807ab90276d1a25b7dc80074a3fb378db Mon Sep 17 00:00:00 2001 From: Gregor Kleen Date: Sun, 21 Jun 2015 21:30:05 +0200 Subject: Even better docs --- trivmix.cabal | 2 +- trivmix.nix | 2 +- trivmix/Trivmix.hs | 7 +++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/trivmix.cabal b/trivmix.cabal index fd96124..78ec056 100644 --- a/trivmix.cabal +++ b/trivmix.cabal @@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/ name: trivmix -version: 2.6.1 +version: 2.6.2 -- synopsis: -- description: license: PublicDomain diff --git a/trivmix.nix b/trivmix.nix index be0b676..14e480e 100644 --- a/trivmix.nix +++ b/trivmix.nix @@ -6,7 +6,7 @@ cabal.mkDerivation (self: { pname = "trivmix"; - version = "2.6.1"; + version = "2.6.2"; src = ./.; isLibrary = true; isExecutable = true; diff --git a/trivmix/Trivmix.hs b/trivmix/Trivmix.hs index 8cfa1b6..fe62619 100644 --- a/trivmix/Trivmix.hs +++ b/trivmix/Trivmix.hs @@ -51,22 +51,25 @@ optionParser = Options <> metavar "STRING" <> value "in" <> showDefault + <> help "Name of the input port" ) <*> strOption ( long "output" <> metavar "STRING" <> value "out" <> showDefault + <> help "Name of the output port" ) <*> strOption ( long "client" <> metavar "STRING" + <> help "Client name to use in jack (the part before the colon in port names)" ) <*> optional ( strOption ( long "run" <> metavar "FILE" - <> help "Execute a file once setup of jacks is done (use this to autoconnect)" + <> help "Execute a file once setup of jacks is done (use this to autoconnect)\nThe executable gets passed the input port (including client name) as its first argument and the output as its second." ) ) <*> some (strArgument ( metavar "FILE..." - <> help "Files that contain levels to assume and synchronize — For deterministic behaviour use flock(2)" + <> help "Files that contain levels to assume and synchronize\nFor deterministic behaviour use flock(2).\nThe format used in these files is either a signed float, using ‘.’ as a decimal point or a signed float postfixed with ‘dB’.\nCaveat: ‘-InfinitydB’ exists and works as expected (i.e.: it is equal to ‘0.0’)" ) ) -- cgit v1.2.3