summaryrefslogtreecommitdiff
path: root/trivmix
diff options
context:
space:
mode:
authorGregor Kleen <gkleen@yggdrasil.li>2015-06-21 21:30:05 +0200
committerGregor Kleen <gkleen@yggdrasil.li>2015-06-21 21:30:05 +0200
commit3985236807ab90276d1a25b7dc80074a3fb378db (patch)
treeb919a0222531c5ad61b920d7d23ee5531be7eccc /trivmix
parent50d80b02de1582c60f06f6ccb317a53b4b20ac88 (diff)
downloadtrivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar
trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.gz
trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.bz2
trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.tar.xz
trivmix-3985236807ab90276d1a25b7dc80074a3fb378db.zip
Even better docs
Diffstat (limited to 'trivmix')
-rw-r--r--trivmix/Trivmix.hs7
1 files changed, 5 insertions, 2 deletions
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