diff options
author | Gregor Kleen <gkleen@yggdrasil.li> | 2015-06-21 21:30:05 +0200 |
---|---|---|
committer | Gregor Kleen <gkleen@yggdrasil.li> | 2015-06-21 21:30:05 +0200 |
commit | 3985236807ab90276d1a25b7dc80074a3fb378db (patch) | |
tree | b919a0222531c5ad61b920d7d23ee5531be7eccc | |
parent | 50d80b02de1582c60f06f6ccb317a53b4b20ac88 (diff) | |
download | trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.gz trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.bz2 trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.xz trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.zip |
Even better docs
-rw-r--r-- | trivmix.cabal | 2 | ||||
-rw-r--r-- | trivmix.nix | 2 | ||||
-rw-r--r-- | 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 @@ | |||
2 | -- documentation, see http://haskell.org/cabal/users-guide/ | 2 | -- documentation, see http://haskell.org/cabal/users-guide/ |
3 | 3 | ||
4 | name: trivmix | 4 | name: trivmix |
5 | version: 2.6.1 | 5 | version: 2.6.2 |
6 | -- synopsis: | 6 | -- synopsis: |
7 | -- description: | 7 | -- description: |
8 | license: PublicDomain | 8 | license: PublicDomain |
diff --git a/trivmix.nix b/trivmix.nix index be0b676..14e480e 100644 --- a/trivmix.nix +++ b/trivmix.nix | |||
@@ -6,7 +6,7 @@ | |||
6 | 6 | ||
7 | cabal.mkDerivation (self: { | 7 | cabal.mkDerivation (self: { |
8 | pname = "trivmix"; | 8 | pname = "trivmix"; |
9 | version = "2.6.1"; | 9 | version = "2.6.2"; |
10 | src = ./.; | 10 | src = ./.; |
11 | isLibrary = true; | 11 | isLibrary = true; |
12 | isExecutable = true; | 12 | 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 | |||
51 | <> metavar "STRING" | 51 | <> metavar "STRING" |
52 | <> value "in" | 52 | <> value "in" |
53 | <> showDefault | 53 | <> showDefault |
54 | <> help "Name of the input port" | ||
54 | ) | 55 | ) |
55 | <*> strOption ( long "output" | 56 | <*> strOption ( long "output" |
56 | <> metavar "STRING" | 57 | <> metavar "STRING" |
57 | <> value "out" | 58 | <> value "out" |
58 | <> showDefault | 59 | <> showDefault |
60 | <> help "Name of the output port" | ||
59 | ) | 61 | ) |
60 | <*> strOption ( long "client" | 62 | <*> strOption ( long "client" |
61 | <> metavar "STRING" | 63 | <> metavar "STRING" |
64 | <> help "Client name to use in jack (the part before the colon in port names)" | ||
62 | ) | 65 | ) |
63 | <*> optional ( strOption ( long "run" | 66 | <*> optional ( strOption ( long "run" |
64 | <> metavar "FILE" | 67 | <> metavar "FILE" |
65 | <> help "Execute a file once setup of jacks is done (use this to autoconnect)" | 68 | <> 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." |
66 | ) | 69 | ) |
67 | ) | 70 | ) |
68 | <*> some (strArgument ( metavar "FILE..." | 71 | <*> some (strArgument ( metavar "FILE..." |
69 | <> help "Files that contain levels to assume and synchronize — For deterministic behaviour use flock(2)" | 72 | <> 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’)" |
70 | ) | 73 | ) |
71 | ) | 74 | ) |
72 | 75 | ||