summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2023-05-28 16:06:39 +0100
committerYann Herklotz <git@yannherklotz.com>2023-05-28 16:06:39 +0100
commitf0b6e7f46833fd0781dc875451548e342936edc1 (patch)
tree51a485003b18a3ceb765abcbff7d42db9a4350ec
parentf1cd03b703e1b9712e0b3fc156c51cc1cde1f9de (diff)
downloadzk-visual-f0b6e7f46833fd0781dc875451548e342936edc1.tar.gz
zk-visual-f0b6e7f46833fd0781dc875451548e342936edc1.zip
Add some more documentation to Options
-rw-r--r--src/Main.hs11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/Main.hs b/src/Main.hs
index 9d16c0d..2e9ebe4 100644
--- a/src/Main.hs
+++ b/src/Main.hs
@@ -218,14 +218,23 @@ import Zettel
--
data Options = Options
- { optBibliography :: Maybe FilePath,
+ { -- | Bibliography FILE (default: references.bib)
+ optBibliography :: Maybe FilePath,
+ -- | Bibliography FILE (default: bibliography.org)
optOrgBibliography :: Maybe FilePath,
+ -- | Csl FILE
optCsl :: Maybe FilePath,
+ -- | Index FILE (default: org-zettelkasten-index)
optIndex :: Maybe FilePath,
+ -- | output DIR
optOutput :: Maybe FilePath,
+ -- | Verbose output while processing files
optVerbose :: Int,
+ -- | Suppress all output
optQuiet :: Bool,
+ -- | Show current version
optShowVersion :: Bool,
+ -- | Show this help menu
optShowHelp :: Bool
}
deriving (Show, Eq)