From 42c12fe631ff280ffd34a64ad22a41e276ff67e7 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 19 Apr 2016 14:40:58 -0700 Subject: [PATCH] cli, ui, web, api: --info, --man, info & man cmds --- hledger-api/doc/hledger-api.1 | 14 +- hledger-api/doc/hledger-api.1.m4.md | 10 +- hledger-api/doc/hledger-api.1.txt | 8 +- hledger-api/hledger-api.hs | 10 +- hledger-ui/Hledger/UI/Main.hs | 7 +- hledger-ui/doc/hledger-ui.1 | 14 +- hledger-ui/doc/hledger-ui.1.m4.md | 10 +- hledger-ui/doc/hledger-ui.1.txt | 8 +- hledger-web/Hledger/Web/Main.hs | 8 +- hledger-web/doc/hledger-web.1 | 14 +- hledger-web/doc/hledger-web.1.m4.md | 10 +- hledger-web/doc/hledger-web.1.txt | 8 +- hledger/Hledger/Cli.hs | 4 + hledger/Hledger/Cli/CliOptions.hs | 30 +- hledger/Hledger/Cli/DocFiles.hs | 97 ++++-- hledger/Hledger/Cli/Help.hs | 6 +- hledger/Hledger/Cli/Info.hs | 41 +++ hledger/Hledger/Cli/Main.hs | 63 ++-- hledger/Hledger/Cli/Man.hs | 41 +++ hledger/doc/commands.m4.md | 32 +- hledger/doc/hledger.1 | 51 ++- hledger/doc/hledger.1.txt | 495 +++++++++++++++------------- hledger/doc/options.m4.md | 10 +- hledger/future-package.yaml | 5 + hledger/hledger.cabal | 6 + 25 files changed, 661 insertions(+), 341 deletions(-) create mode 100644 hledger/Hledger/Cli/Info.hs create mode 100644 hledger/Hledger/Cli/Man.hs diff --git a/hledger-api/doc/hledger-api.1 b/hledger-api/doc/hledger-api.1 index 8b9dbd181..90f6ca006 100644 --- a/hledger-api/doc/hledger-api.1 +++ b/hledger-api/doc/hledger-api.1 @@ -74,12 +74,22 @@ show usage .RE .TP .B \f[C]\-\-help\f[] -show detailed help +show manual +.RS +.RE +.TP +.B \f[C]\-\-man\f[] +show manual with man +.RS +.RE +.TP +.B \f[C]\-\-info\f[] +show manual with info .RS .RE .TP .B \f[C]\-\-version\f[] -show version information +show version .RS .RE .SH ENVIRONMENT diff --git a/hledger-api/doc/hledger-api.1.m4.md b/hledger-api/doc/hledger-api.1.m4.md index adfd09b9e..474384759 100644 --- a/hledger-api/doc/hledger-api.1.m4.md +++ b/hledger-api/doc/hledger-api.1.m4.md @@ -66,10 +66,16 @@ Note: if invoking hledger-api as a hledger subcommand, write `--` before options : show usage `--help` -: show detailed help +: show manual + +`--man` +: show manual with man + +`--info` +: show manual with info `--version` -: show version information +: show version _man_({{ diff --git a/hledger-api/doc/hledger-api.1.txt b/hledger-api/doc/hledger-api.1.txt index 479a817e4..901981ba2 100644 --- a/hledger-api/doc/hledger-api.1.txt +++ b/hledger-api/doc/hledger-api.1.txt @@ -52,10 +52,14 @@ OOPPTTIIOONNSS --hh show usage - ----hheellpp show detailed help + ----hheellpp show manual + + ----mmaann show manual with man + + ----iinnffoo show manual with info ----vveerrssiioonn - show version information + show version EENNVVIIRROONNMMEENNTT LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is diff --git a/hledger-api/hledger-api.hs b/hledger-api/hledger-api.hs index a570e4134..26ef58f13 100644 --- a/hledger-api/hledger-api.hs +++ b/hledger-api/hledger-api.hs @@ -48,7 +48,7 @@ Usage: hledger-api --swagger print API docs in Swagger 2.0 format hledger-api --version - hledger-api --help + hledger-api -h|--help|--info Options: -f --file FILE use a different input file @@ -58,7 +58,9 @@ Options: -p --port PORT use a different TCP port (default: 8001) --version show version -h show usage - --help show detailed help + --help show manual + --man show manual with man + --info show manual with info |] swaggerSpec :: Swagger @@ -72,7 +74,9 @@ main :: IO () main = do args <- getArgs >>= parseArgsOrExit doc when (isPresent args (shortOption 'h')) $ exitWithUsage doc - when (isPresent args (longOption "help")) $ putStr (lookupDocTxt "api") >> exitSuccess + when (isPresent args (longOption "help")) $ printHelpForTopic "api" >> exitSuccess + when (isPresent args (longOption "man")) $ runManForTopic "api" >> exitSuccess + when (isPresent args (longOption "info")) $ runInfoForTopic "api" >> exitSuccess when (isPresent args (longOption "version")) $ putStrLn hledgerApiVersion >> exitSuccess when (isPresent args (longOption "swagger")) $ BL8.putStrLn (encode swaggerSpec) >> exitSuccess let defp = "8001" diff --git a/hledger-ui/Hledger/UI/Main.hs b/hledger-ui/Hledger/UI/Main.hs index d12fde3ab..78068f420 100644 --- a/hledger-ui/Hledger/UI/Main.hs +++ b/hledger-ui/Hledger/UI/Main.hs @@ -42,9 +42,10 @@ main = do run opts where run opts - | "shorthelp" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeUsage uimode) >> exitSuccess - | "longhelp" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeHelp uimode) >> exitSuccess - | "version" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn prognameandversion >> exitSuccess + | "h" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeUsage uimode) >> exitSuccess + | "help" `inRawOpts` (rawopts_ $ cliopts_ opts) = printHelpForTopic (topicForMode uimode) >> exitSuccess + | "info" `inRawOpts` (rawopts_ $ cliopts_ opts) = runInfoForTopic (topicForMode uimode) >> exitSuccess + | "version" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn prognameandversion >> exitSuccess | "binary-filename" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn (binaryfilename progname) | otherwise = withJournalDoUICommand opts runBrickUi diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1 index 126016c5c..205b706cc 100644 --- a/hledger-ui/doc/hledger-ui.1 +++ b/hledger-ui/doc/hledger-ui.1 @@ -75,12 +75,22 @@ show usage .RE .TP .B \f[C]\-\-help\f[] -show detailed help +show manual +.RS +.RE +.TP +.B \f[C]\-\-man\f[] +show manual with man +.RS +.RE +.TP +.B \f[C]\-\-info\f[] +show manual with info .RS .RE .TP .B \f[C]\-\-version\f[] -show version information +show version .RS .RE .SS hledger options diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/doc/hledger-ui.1.m4.md index a4ee9d96e..b43e8413f 100644 --- a/hledger-ui/doc/hledger-ui.1.m4.md +++ b/hledger-ui/doc/hledger-ui.1.m4.md @@ -78,10 +78,16 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data. : show usage `--help` -: show detailed help +: show manual + +`--man` +: show manual with man + +`--info` +: show manual with info `--version` -: show version information +: show version ## hledger options diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt index 82c30ad1d..d7fe59362 100644 --- a/hledger-ui/doc/hledger-ui.1.txt +++ b/hledger-ui/doc/hledger-ui.1.txt @@ -56,10 +56,14 @@ OOPPTTIIOONNSS --hh show usage - ----hheellpp show detailed help + ----hheellpp show manual + + ----mmaann show manual with man + + ----iinnffoo show manual with info ----vveerrssiioonn - show version information + show version hhlleeddggeerr ooppttiioonnss The following common hledger options should also work: diff --git a/hledger-web/Hledger/Web/Main.hs b/hledger-web/Hledger/Web/Main.hs index 33281eff1..e44aa43ee 100644 --- a/hledger-web/Hledger/Web/Main.hs +++ b/hledger-web/Hledger/Web/Main.hs @@ -43,9 +43,11 @@ hledgerWebMain = do runWith :: WebOpts -> IO () runWith opts - | "shorthelp" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeUsage webmode) >> exitSuccess - | "longhelp" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeHelp webmode) >> exitSuccess - | "version" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn prognameandversion >> exitSuccess + | "h" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeUsage webmode) >> exitSuccess + | "help" `inRawOpts` (rawopts_ $ cliopts_ opts) = printHelpForTopic (topicForMode webmode) >> exitSuccess + | "man" `inRawOpts` (rawopts_ $ cliopts_ opts) = runManForTopic (topicForMode webmode) >> exitSuccess + | "info" `inRawOpts` (rawopts_ $ cliopts_ opts) = runInfoForTopic (topicForMode webmode) >> exitSuccess + | "version" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn prognameandversion >> exitSuccess | "binary-filename" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn (binaryfilename progname) | otherwise = do requireJournalFileExists =<< (head `fmap` journalFilePathFromOpts (cliopts_ opts)) -- XXX head should be safe for now diff --git a/hledger-web/doc/hledger-web.1 b/hledger-web/doc/hledger-web.1 index b489f9e86..9ae9d504e 100644 --- a/hledger-web/doc/hledger-web.1 +++ b/hledger-web/doc/hledger-web.1 @@ -114,12 +114,22 @@ show usage .RE .TP .B \f[C]\-\-help\f[] -show detailed help +show manual +.RS +.RE +.TP +.B \f[C]\-\-man\f[] +show manual with man +.RS +.RE +.TP +.B \f[C]\-\-info\f[] +show manual with info .RS .RE .TP .B \f[C]\-\-version\f[] -show version information +show version .RS .RE .SS hledger options diff --git a/hledger-web/doc/hledger-web.1.m4.md b/hledger-web/doc/hledger-web.1.m4.md index 21351603a..d185a05a8 100644 --- a/hledger-web/doc/hledger-web.1.m4.md +++ b/hledger-web/doc/hledger-web.1.m4.md @@ -121,10 +121,16 @@ serve them from another server for efficiency, you would set the url with this. : show usage `--help` -: show detailed help +: show manual + +`--man` +: show manual with man + +`--info` +: show manual with info `--version` -: show version information +: show version ## hledger options diff --git a/hledger-web/doc/hledger-web.1.txt b/hledger-web/doc/hledger-web.1.txt index bafdb5fbf..3825c8361 100644 --- a/hledger-web/doc/hledger-web.1.txt +++ b/hledger-web/doc/hledger-web.1.txt @@ -90,10 +90,14 @@ OOPPTTIIOONNSS --hh show usage - ----hheellpp show detailed help + ----hheellpp show manual + + ----mmaann show manual with man + + ----iinnffoo show manual with info ----vveerrssiioonn - show version information + show version hhlleeddggeerr ooppttiioonnss The following common hledger options should also work: diff --git a/hledger/Hledger/Cli.hs b/hledger/Hledger/Cli.hs index 32e0e19f4..805c699b7 100644 --- a/hledger/Hledger/Cli.hs +++ b/hledger/Hledger/Cli.hs @@ -16,6 +16,8 @@ module Hledger.Cli ( module Hledger.Cli.Help, module Hledger.Cli.Histogram, module Hledger.Cli.Incomestatement, + module Hledger.Cli.Info, + module Hledger.Cli.Man, module Hledger.Cli.Print, module Hledger.Cli.Register, module Hledger.Cli.Stats, @@ -41,6 +43,8 @@ import Hledger.Cli.Cashflow import Hledger.Cli.Histogram import Hledger.Cli.Help import Hledger.Cli.Incomestatement +import Hledger.Cli.Info +import Hledger.Cli.Man import Hledger.Cli.Print import Hledger.Cli.Register import Hledger.Cli.Stats diff --git a/hledger/Hledger/Cli/CliOptions.hs b/hledger/Hledger/Cli/CliOptions.hs index 261a4a6e4..8881a3d5c 100644 --- a/hledger/Hledger/Cli/CliOptions.hs +++ b/hledger/Hledger/Cli/CliOptions.hs @@ -22,7 +22,6 @@ module Hledger.Cli.CliOptions ( defAddonCommandMode, argsFlag, showModeUsage, - showModeHelp, withAliases, -- * CLI options @@ -54,6 +53,7 @@ module Hledger.Cli.CliOptions ( -- * Other utils hledgerAddons, + topicForMode, -- * Tests tests_Hledger_Cli_CliOptions @@ -95,8 +95,10 @@ import Hledger.Cli.Version -- | Common help flags: --help, --debug, --version... helpflags :: [Flag RawOpts] helpflags = [ - flagNone ["h"] (setboolopt "shorthelp") "show general usage or (after command) command usage" - ,flagNone ["help"] (setboolopt "longhelp") "show detailed help" + flagNone ["h"] (setboolopt "h") "show general usage or (after command) command usage" + ,flagNone ["help"] (setboolopt "help") "show manual" + ,flagNone ["man"] (setboolopt "man") "show manual with man" + ,flagNone ["info"] (setboolopt "info") "show manual with info" -- ,flagNone ["browse-args"] (setboolopt "browse-args") "use a web UI to select options and build up a command line" ,flagReq ["debug"] (\s opts -> Right $ setopt "debug" s opts) "N" "show increasing amounts of debug output if N is 1-9. With no argument, show level 1" ,flagNone ["version"] (setboolopt "version") "show version information" @@ -169,7 +171,7 @@ defMode = Mode { ,modeGroupFlags = Group { groupNamed = [] ,groupUnnamed = [ - flagNone ["h"] (setboolopt "shorthelp") "Show command help." + flagNone ["h"] (setboolopt "h") "Show command usage." ] ,groupHidden = [] } @@ -230,15 +232,15 @@ showModeUsage :: Mode a -> String showModeUsage = (showText defaultWrap :: [Text] -> String) . (helpText [] HelpFormatDefault :: Mode a -> [Text]) --- | Get a mode's long help, ready for console output. Currently that --- will be the hledger, hledger-ui, hledger-web or hledger-api man page, --- formatted for 80 columns. -showModeHelp :: Mode a -> String -showModeHelp m - | n == "hledger-ui" = lookupDocTxt "ui" - | n == "hledger-web" = lookupDocTxt "web" +-- | Get the most appropriate documentation topic for a mode. +-- Currently, that is either the hledger, hledger-ui, hledger-web or +-- hledger-api manual. +topicForMode :: Mode a -> Topic +topicForMode m + | n == "hledger-ui" = "ui" + | n == "hledger-web" = "web" -- | n == "hledger-api" = lookupDocTxt "api" -- hledger-api uses docopt - | otherwise = lookupDocTxt "cli" + | otherwise = "cli" where n = headDef "" $ modeNames m -- | Add command aliases to the command's help string. @@ -362,8 +364,8 @@ getCliOpts mode' = do opts <- rawOptsToCliOpts rawopts debugArgs args' opts -- if any (`elem` args) ["--help","-h","-?"] - when ("shorthelp" `inRawOpts` rawopts_ opts) $ putStr (showModeUsage mode') >> exitSuccess - when ("longhelp" `inRawOpts` rawopts_ opts) $ putStr (showModeHelp mode') >> exitSuccess + when ("h" `inRawOpts` rawopts_ opts) $ putStr (showModeUsage mode') >> exitSuccess + when ("help" `inRawOpts` rawopts_ opts) $ printHelpForTopic (topicForMode mode') >> exitSuccess return opts where -- | Print debug info about arguments and options if --debug is present. diff --git a/hledger/Hledger/Cli/DocFiles.hs b/hledger/Hledger/Cli/DocFiles.hs index 632aeeca7..a421214a2 100644 --- a/hledger/Hledger/Cli/DocFiles.hs +++ b/hledger/Hledger/Cli/DocFiles.hs @@ -1,16 +1,21 @@ {-# LANGUAGE TemplateHaskell, OverloadedStrings #-} {-| -Embedded help files (man pages). +Embedded documentation files in various formats, and helpers for viewing them. |-} module Hledger.Cli.DocFiles ( - docFiles + Topic + ,docFiles ,docTopics ,lookupDocNroff ,lookupDocTxt + ,lookupDocInfo + ,printHelpForTopic + ,runManForTopic + ,runInfoForTopic ) where @@ -18,46 +23,90 @@ import Prelude () import Prelude.Compat import Data.FileEmbed import Data.String +import System.IO +import System.IO.Temp +import System.Process + +import Hledger.Utils (first3, second3, third3) type Topic = String -- XXX assumes cwd is the hledger package directory, for now ghci must be run from there -docFiles :: IsString a => [(Topic, (a, a))] +docFiles :: IsString a => [(Topic, (a, a, a))] docFiles = [ ("cli", - ($(embedStringFile $ "../hledger/doc/hledger.1"), - $(embedStringFile $ "../hledger/doc/hledger.1.txt"))) + ($(embedStringFile $ "../hledger/doc/hledger.1") + ,$(embedStringFile $ "../hledger/doc/hledger.1.txt") + ,$(embedStringFile $ "../hledger/doc/hledger.1.info") + )) ,("ui", - ($(embedStringFile $ "../hledger-ui/doc/hledger-ui.1"), - $(embedStringFile $ "../hledger-ui/doc/hledger-ui.1.txt"))) + ($(embedStringFile $ "../hledger-ui/doc/hledger-ui.1") + ,$(embedStringFile $ "../hledger-ui/doc/hledger-ui.1.txt") + ,$(embedStringFile $ "../hledger-ui/doc/hledger-ui.1.info") + )) ,("web", - ($(embedStringFile $ "../hledger-web/doc/hledger-web.1"), - $(embedStringFile $ "../hledger-web/doc/hledger-web.1.txt"))) + ($(embedStringFile $ "../hledger-web/doc/hledger-web.1") + ,$(embedStringFile $ "../hledger-web/doc/hledger-web.1.txt") + ,$(embedStringFile $ "../hledger-web/doc/hledger-web.1.info") + )) ,("api", - ($(embedStringFile $ "../hledger-api/doc/hledger-api.1"), - $(embedStringFile $ "../hledger-api/doc/hledger-api.1.txt"))) + ($(embedStringFile $ "../hledger-api/doc/hledger-api.1") + ,$(embedStringFile $ "../hledger-api/doc/hledger-api.1.txt") + ,$(embedStringFile $ "../hledger-api/doc/hledger-api.1.info") + )) ,("journal", - ($(embedStringFile $ "../hledger-lib/doc/hledger_journal.5"), - $(embedStringFile $ "../hledger-lib/doc/hledger_journal.5.txt"))) + ($(embedStringFile $ "../hledger-lib/doc/hledger_journal.5") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_journal.5.txt") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_journal.5.info") + )) ,("csv", - ($(embedStringFile $ "../hledger-lib/doc/hledger_csv.5"), - $(embedStringFile $ "../hledger-lib/doc/hledger_csv.5.txt"))) + ($(embedStringFile $ "../hledger-lib/doc/hledger_csv.5") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_csv.5.txt") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_csv.5.info") + )) ,("timeclock", - ($(embedStringFile $ "../hledger-lib/doc/hledger_timeclock.5"), - $(embedStringFile $ "../hledger-lib/doc/hledger_timeclock.5.txt"))) + ($(embedStringFile $ "../hledger-lib/doc/hledger_timeclock.5") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_timeclock.5.txt") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_timeclock.5.info") + )) ,("timedot", - ($(embedStringFile $ "../hledger-lib/doc/hledger_timedot.5"), - $(embedStringFile $ "../hledger-lib/doc/hledger_timedot.5.txt"))) + ($(embedStringFile $ "../hledger-lib/doc/hledger_timedot.5") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_timedot.5.txt") + ,$(embedStringFile $ "../hledger-lib/doc/hledger_timedot.5.info") + )) ] docTopics :: [Topic] docTopics = map fst docFiles -lookupDocNroff :: IsString a => Topic -> a -lookupDocNroff name = - maybe (fromString $ "No such help topic: "++name) fst $ lookup name docFiles - lookupDocTxt :: IsString a => Topic -> a lookupDocTxt name = - maybe (fromString $ "No such help topic: "++name) snd $ lookup name docFiles + maybe (fromString $ "No text manual found for topic: "++name) second3 $ lookup name docFiles + +lookupDocNroff :: IsString a => Topic -> a +lookupDocNroff name = + maybe (fromString $ "No man page found for topic: "++name) first3 $ lookup name docFiles + +lookupDocInfo :: IsString a => Topic -> a +lookupDocInfo name = + maybe (fromString $ "No info manual found for topic: "++name) third3 $ lookup name docFiles + +printHelpForTopic :: Topic -> IO () +printHelpForTopic t = + putStrLn $ lookupDocTxt t + +runManForTopic :: Topic -> IO () +runManForTopic t = + withSystemTempFile ("hledger-"++t++".nroff") $ \f h -> do + hPutStrLn h $ lookupDocNroff t + hClose h + -- the temp file path will presumably have a slash in it, so man should read it + callCommand $ "man " ++ f + +runInfoForTopic :: Topic -> IO () +runInfoForTopic t = + withSystemTempFile ("hledger-"++t++".info") $ \f h -> do + hPutStrLn h $ lookupDocInfo t + hClose h + callCommand $ "info " ++ f diff --git a/hledger/Hledger/Cli/Help.hs b/hledger/Hledger/Cli/Help.hs index 01a6b3d7f..75bfa9948 100644 --- a/hledger/Hledger/Cli/Help.hs +++ b/hledger/Hledger/Cli/Help.hs @@ -21,7 +21,7 @@ import Hledger.Cli.CliOptions import Hledger.Cli.DocFiles helpmode = (defCommandMode $ ["help"] ++ aliases) { - modeHelp = "show detailed help (the main hledger man pages)" `withAliases` aliases + modeHelp = "show manual" `withAliases` aliases ,modeGroupFlags = Group { groupUnnamed = [] ,groupHidden = [] @@ -36,7 +36,7 @@ help' opts = do let args = listofstringopt "args" $ rawopts_ opts case args of [] -> putStrLn $ - "Choose a topic, eg: hledger help ui\n" ++ + "Choose a topic, eg: hledger help cli\n" ++ intercalate ", " docTopics - topic:_ -> putStrLn $ lookupDocTxt topic + topic:_ -> printHelpForTopic topic diff --git a/hledger/Hledger/Cli/Info.hs b/hledger/Hledger/Cli/Info.hs new file mode 100644 index 000000000..ce15c3e8c --- /dev/null +++ b/hledger/Hledger/Cli/Info.hs @@ -0,0 +1,41 @@ +{-| + +The info command. + +|-} + +module Hledger.Cli.Info ( + + infomode + ,info' + + ) where + +import Prelude () +import Prelude.Compat +import Data.List +import System.Console.CmdArgs.Explicit + +import Hledger.Data.RawOptions +import Hledger.Cli.CliOptions +import Hledger.Cli.DocFiles + +infomode = (defCommandMode $ ["info"] ++ aliases) { + modeHelp = "show manual with info" `withAliases` aliases + ,modeGroupFlags = Group { + groupUnnamed = [] + ,groupHidden = [] + ,groupNamed = [] + } + } + where aliases = [] + +-- | Try to use info to view the selected manual. +info' :: CliOpts -> IO () +info' opts = do + let args = listofstringopt "args" $ rawopts_ opts + case args of + [] -> putStrLn $ + "Choose a topic, eg: hledger info cli\n" ++ + intercalate ", " docTopics + topic:_ -> runInfoForTopic topic diff --git a/hledger/Hledger/Cli/Main.hs b/hledger/Hledger/Cli/Main.hs index 3d8bc56be..62ea4ed67 100644 --- a/hledger/Hledger/Cli/Main.hs +++ b/hledger/Hledger/Cli/Main.hs @@ -55,9 +55,12 @@ import Hledger.Cli.Accounts import Hledger.Cli.Balance import Hledger.Cli.Balancesheet import Hledger.Cli.Cashflow +import Hledger.Cli.DocFiles import Hledger.Cli.Help import Hledger.Cli.Histogram import Hledger.Cli.Incomestatement +import Hledger.Cli.Info +import Hledger.Cli.Man import Hledger.Cli.Print import Hledger.Cli.Register import Hledger.Cli.Stats @@ -100,6 +103,8 @@ mainmode addons = defMode { -- modes in the unnamed group, shown first without a heading: ,groupUnnamed = [ helpmode + ,manmode + ,infomode ] -- modes handled but not shown ,groupHidden = [ @@ -247,13 +252,19 @@ main = do hasVersion = ("--version" `elem`) hasDetailedVersion = ("--version+" `elem`) printUsage = putStr $ showModeUsage $ mainmode addonDisplayNames - printHelp = putStr $ showModeHelp $ mainmode addonDisplayNames badCommandError = error' ("command "++rawcmd++" is not recognized, run with no command to see a list") >> exitFailure - hasShortHelp args = any (`elem` args) ["-h"] - hasLongHelp args = any (`elem` args) ["--help"] - hasHelp args = hasShortHelp args || hasLongHelp args - f `orShowUsage` mode = if hasShortHelp args then putStr (showModeUsage mode) else f - f `orShowHelp` mode = if hasLongHelp args then putStr (showModeHelp mode) else f + hasShortHelpFlag args = any (`elem` args) ["-h"] + hasLongHelpFlag args = any (`elem` args) ["--help"] + hasManFlag args = any (`elem` args) ["--man"] + hasInfoFlag args = any (`elem` args) ["--info"] + hasSomeHelpFlag args = hasShortHelpFlag args || hasLongHelpFlag args || hasManFlag args || hasInfoFlag args + f `orShowHelp` mode + | hasShortHelpFlag args = putStr $ showModeUsage mode + | hasLongHelpFlag args = printHelpForTopic t + | hasManFlag args = runManForTopic t + | hasInfoFlag args = runInfoForTopic t + | otherwise = f + where t = topicForMode mode dbgIO "processed opts" opts dbgIO "command matched" cmd dbgIO "isNullCommand" isNullCommand @@ -266,31 +277,35 @@ main = do dbgIO "query from opts & args" (queryFromOpts d $ reportopts_ opts) let runHledgerCommand - -- high priority flags and situations. --help should be highest priority. - | hasShortHelp argsbeforecmd = dbgIO "" "-h before command, showing general usage" >> printUsage - | hasLongHelp argsbeforecmd = dbgIO "" "--help before command, showing general help" >> printHelp - | not (hasHelp argsaftercmd) && (hasVersion argsbeforecmd || (hasVersion argsaftercmd && isInternalCommand)) + -- high priority flags and situations. -h, then --help, then --info are highest priority. + | hasShortHelpFlag argsbeforecmd = dbgIO "" "-h before command, showing general usage" >> printUsage + | hasLongHelpFlag argsbeforecmd = dbgIO "" "--help before command, showing general manual" >> printHelpForTopic (topicForMode $ mainmode addonDisplayNames) + | hasManFlag argsbeforecmd = dbgIO "" "--man before command, showing general manual with man" >> runManForTopic (topicForMode $ mainmode addonDisplayNames) + | hasInfoFlag argsbeforecmd = dbgIO "" "--info before command, showing general manual with info" >> runInfoForTopic (topicForMode $ mainmode addonDisplayNames) + | not (hasSomeHelpFlag argsaftercmd) && (hasVersion argsbeforecmd || (hasVersion argsaftercmd && isInternalCommand)) = putStrLn prognameandversion - | not (hasHelp argsaftercmd) && (hasDetailedVersion argsbeforecmd || (hasDetailedVersion argsaftercmd && isInternalCommand)) + | not (hasSomeHelpFlag argsaftercmd) && (hasDetailedVersion argsbeforecmd || (hasDetailedVersion argsaftercmd && isInternalCommand)) = putStrLn prognameanddetailedversion -- \| (null externalcmd) && "binary-filename" `inRawOpts` rawopts = putStrLn $ binaryfilename progname -- \| "--browse-args" `elem` args = System.Console.CmdArgs.Helper.execute "cmdargs-browser" mainmode' args >>= (putStr . show) - | isNullCommand = dbgIO "" "no command, showing general help" >> printUsage + | isNullCommand = dbgIO "" "no command, showing general usage" >> printUsage | isBadCommand = badCommandError -- internal commands - | cmd == "activity" = withJournalDo opts histogram `orShowUsage` activitymode `orShowHelp` activitymode - | cmd == "add" = (journalFilePathFromOpts opts >>= (ensureJournalFileExists . head) >> withJournalDo opts add) `orShowUsage` addmode `orShowHelp` addmode - | cmd == "accounts" = withJournalDo opts accounts `orShowUsage` accountsmode `orShowHelp` accountsmode - | cmd == "balance" = withJournalDo opts balance `orShowUsage` balancemode `orShowHelp` balancemode - | cmd == "balancesheet" = withJournalDo opts balancesheet `orShowUsage` balancesheetmode `orShowHelp` balancesheetmode - | cmd == "cashflow" = withJournalDo opts cashflow `orShowUsage` cashflowmode `orShowHelp` cashflowmode - | cmd == "incomestatement" = withJournalDo opts incomestatement `orShowUsage` incomestatementmode `orShowHelp` incomestatementmode - | cmd == "print" = withJournalDo opts print' `orShowUsage` printmode `orShowHelp` printmode - | cmd == "register" = withJournalDo opts register `orShowUsage` registermode `orShowHelp` registermode - | cmd == "stats" = withJournalDo opts stats `orShowUsage` statsmode `orShowHelp` statsmode - | cmd == "test" = test' opts `orShowUsage` testmode `orShowHelp` testmode - | cmd == "help" = help' opts `orShowUsage` helpmode `orShowHelp` helpmode + | cmd == "activity" = withJournalDo opts histogram `orShowHelp` activitymode + | cmd == "add" = (journalFilePathFromOpts opts >>= (ensureJournalFileExists . head) >> withJournalDo opts add) `orShowHelp` addmode + | cmd == "accounts" = withJournalDo opts accounts `orShowHelp` accountsmode + | cmd == "balance" = withJournalDo opts balance `orShowHelp` balancemode + | cmd == "balancesheet" = withJournalDo opts balancesheet `orShowHelp` balancesheetmode + | cmd == "cashflow" = withJournalDo opts cashflow `orShowHelp` cashflowmode + | cmd == "incomestatement" = withJournalDo opts incomestatement `orShowHelp` incomestatementmode + | cmd == "print" = withJournalDo opts print' `orShowHelp` printmode + | cmd == "register" = withJournalDo opts register `orShowHelp` registermode + | cmd == "stats" = withJournalDo opts stats `orShowHelp` statsmode + | cmd == "test" = test' opts `orShowHelp` testmode + | cmd == "help" = help' opts `orShowHelp` helpmode + | cmd == "man" = man opts `orShowHelp` manmode + | cmd == "info" = info' opts `orShowHelp` infomode -- an external command | isExternalCommand = do diff --git a/hledger/Hledger/Cli/Man.hs b/hledger/Hledger/Cli/Man.hs new file mode 100644 index 000000000..a15864c62 --- /dev/null +++ b/hledger/Hledger/Cli/Man.hs @@ -0,0 +1,41 @@ +{-| + +The man command. + +|-} + +module Hledger.Cli.Man ( + + manmode + ,man + + ) where + +import Prelude () +import Prelude.Compat +import Data.List +import System.Console.CmdArgs.Explicit + +import Hledger.Data.RawOptions +import Hledger.Cli.CliOptions +import Hledger.Cli.DocFiles + +manmode = (defCommandMode $ ["man"] ++ aliases) { + modeHelp = "show manual with man" `withAliases` aliases + ,modeGroupFlags = Group { + groupUnnamed = [] + ,groupHidden = [] + ,groupNamed = [] + } + } + where aliases = [] + +-- | Try to use man to view the selected manual. +man :: CliOpts -> IO () +man opts = do + let args = listofstringopt "args" $ rawopts_ opts + case args of + [] -> putStrLn $ + "Choose a topic, eg: hledger man cli\n" ++ + intercalate ", " docTopics + topic:_ -> runManForTopic topic diff --git a/hledger/doc/commands.m4.md b/hledger/doc/commands.m4.md index d7acfb283..30a518fe0 100644 --- a/hledger/doc/commands.m4.md +++ b/hledger/doc/commands.m4.md @@ -231,18 +231,20 @@ Total: ``` ## help -Show detailed help. +Show one of the hledger manuals. -The `help` command can display any of the main [hledger man pages](/docs.html), as fixed-width text. +The `help` command displays any of the main [hledger man pages](/docs.html). (Unlike `hledger --help`, which displays only the hledger man page.) Run it with no arguments to list available topics (their names are shortened for easier typing), and run `hledger help TOPIC` to select one. -The output may be long, so you may wish to pipe it into a pager. +The output is similar to a man page, but fixed width. +It may be long, so you may wish to pipe it into a pager. +See also [info](#info) and [man](#man). _shell_({{ $ hledger help -Please choose a topic, eg: hledger help ui -Topics: cli, ui, web, api, journal, csv, timeclock, timedot +Choose a topic, eg: hledger help cli +cli, ui, web, api, journal, csv, timeclock, timedot }}) _shell_({{ @@ -298,6 +300,26 @@ Total: 0 ``` +## info +Show one of the hledger manuals using info. + +The `info` command displays any of the [hledger reference manuals](/docs.html) +using the [info](https://en.wikipedia.org/wiki/Info_(Unix)) hypertextual documentation viewer. +This can be a very efficient way to browse large manuals. +It requires the "info" program to be available in your PATH. + +As with [help](#help), run it with no arguments to list available topics (manuals). + +## man +Show one of the hledger manuals using man. + +The `man` command displays any of the [hledger reference manuals](/docs.html) +using [man](https://en.wikipedia.org/wiki/Man_page), the standard documentation viewer on unix systems. +This will fit the text to your terminal width, and probably invoke a pager automatically. +It requires the "man" program to be available in your PATH. + +As with [help](#help), run it with no arguments to list available topics (manuals). + ## print Show transactions from the journal. diff --git a/hledger/doc/hledger.1 b/hledger/doc/hledger.1 index 5874ac733..f65d0bc1a 100644 --- a/hledger/doc/hledger.1 +++ b/hledger/doc/hledger.1 @@ -177,12 +177,23 @@ show general usage (or if after COMMAND, the command\[aq]s usage) .RE .TP .B \f[C]\-\-help\f[] -show detailed help (or if after COMMAND, the command\[aq]s help) +show hledger manual (or if after an add\-on COMMAND, show the +add\-on\[aq]s manual) +.RS +.RE +.TP +.B \f[C]\-\-man\f[] +show manual with man +.RS +.RE +.TP +.B \f[C]\-\-info\f[] +show manual with info .RS .RE .TP .B \f[C]\-\-version\f[] -show version information +show version .RS .RE .TP @@ -1352,21 +1363,22 @@ Total: .fi .SS help .PP -Show detailed help. +Show one of the hledger manuals. .PP -The \f[C]help\f[] command can display any of the main hledger man pages, -as fixed\-width text. +The \f[C]help\f[] command displays any of the main hledger man pages. (Unlike \f[C]hledger\ \-\-help\f[], which displays only the hledger man page.) Run it with no arguments to list available topics (their names are shortened for easier typing), and run \f[C]hledger\ help\ TOPIC\f[] to select one. -The output may be long, so you may wish to pipe it into a pager. +The output is similar to a man page, but fixed width. +It may be long, so you may wish to pipe it into a pager. +See also info and man. .IP .nf \f[C] $\ hledger\ help -Please\ choose\ a\ topic,\ eg:\ hledger\ help\ ui -Topics:\ cli,\ ui,\ web,\ api,\ journal,\ csv,\ timeclock,\ timedot +Choose\ a\ topic,\ eg:\ hledger\ help\ cli +cli,\ ui,\ web,\ api,\ journal,\ csv,\ timeclock,\ timedot \f[] .fi .IP @@ -1431,6 +1443,29 @@ Total: \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0 \f[] .fi +.SS info +.PP +Show one of the hledger manuals using info. +.PP +The \f[C]info\f[] command displays any of the hledger reference manuals +using the info hypertextual documentation viewer. +This can be a very efficient way to browse large manuals. +It requires the "info" program to be available in your PATH. +.PP +As with help, run it with no arguments to list available topics +(manuals). +.SS man +.PP +Show one of the hledger manuals using man. +.PP +The \f[C]man\f[] command displays any of the hledger reference manuals +using man, the standard documentation viewer on unix systems. +This will fit the text to your terminal width, and probably invoke a +pager automatically. +It requires the "man" program to be available in your PATH. +.PP +As with help, run it with no arguments to list available topics +(manuals). .SS print .PP Show transactions from the journal. diff --git a/hledger/doc/hledger.1.txt b/hledger/doc/hledger.1.txt index d64a7b21c..69ee53cee 100644 --- a/hledger/doc/hledger.1.txt +++ b/hledger/doc/hledger.1.txt @@ -126,16 +126,21 @@ OOPPTTIIOONNSS --hh show general usage (or if after COMMAND, the command's usage) - ----hheellpp show detailed help (or if after COMMAND, the command's help) + ----hheellpp show hledger manual (or if after an add-on COMMAND, show the + add-on's manual) + + ----mmaann show manual with man + + ----iinnffoo show manual with info ----vveerrssiioonn - show version information + show version --ff FFIILLEE ----ffiillee==FFIILLEE use a different input file. For stdin, use - ----rruulleess--ffiillee==RRUULLEESSFFIILLEE - Conversion rules file to use when reading CSV (default: + Conversion rules file to use when reading CSV (default: FILE.rules) ----aalliiaass==OOLLDD==NNEEWW @@ -147,8 +152,8 @@ OOPPTTIIOONNSS ----ddeebbuugg==NN : show debug output if N is 1-9 (default: 0) - Common reporting options are supported by most commands where applica- - ble, and individual commands may provide additional command-specific + Common reporting options are supported by most commands where applica- + ble, and individual commands may provide additional command-specific options. Both of these must be written after the command name. --bb ----bbeeggiinn==DDAATTEE @@ -173,7 +178,7 @@ OOPPTTIIOONNSS multiperiod/multicolumn report by year --pp ----ppeerriioodd==PPEERRIIOODDEEXXPP - set start date, end date, and/or reporting interval all at once + set start date, end date, and/or reporting interval all at once (overrides the flags above) ----ddaattee22 ----aauuxx--ddaattee @@ -203,7 +208,7 @@ OOPPTTIIOONNSS MMuullttiippllee ffiilleess One may specify the --file FILE option multiple times. This is equiva- lent to concatenating the files to standard input and passing --file -, - except that the add command functions normally and adds entries to the + except that the add command functions normally and adds entries to the first specified file. RReeppeeaatteedd ooppttiioonnss @@ -211,145 +216,145 @@ OOPPTTIIOONNSS dence. Eg -p jan -p feb is equivalent to -p feb. DDeepptthh lliimmiittiinngg - With the --depth N option, commands like account, balance and register - will show only the uppermost accounts in the account tree, down to + With the --depth N option, commands like account, balance and register + will show only the uppermost accounts in the account tree, down to level N. Use this when you want a summary with less detail. SSmmaarrtt ddaatteess hledger's user interfaces accept a flexible "smart date" syntax (unlike - dates in the journal file). Smart dates allow some english words, can - be relative to today's date, and can have less-significant date parts + dates in the journal file). Smart dates allow some english words, can + be relative to today's date, and can have less-significant date parts omitted (defaulting to 1). Examples: - tab(@); l l. T{ 2009/1/1, 2009/01/01, 2009-1-1, 2009.1.1 T}@T{ simple - dates, several separators allowed T} T{ 2009/1, 2009 T}@T{ same as - above - a missing day or month defaults to 1 T} T{ 1/1, january, jan, - this year T}@T{ relative dates, meaning january 1 of the current year + tab(@); l l. T{ 2009/1/1, 2009/01/01, 2009-1-1, 2009.1.1 T}@T{ simple + dates, several separators allowed T} T{ 2009/1, 2009 T}@T{ same as + above - a missing day or month defaults to 1 T} T{ 1/1, january, jan, + this year T}@T{ relative dates, meaning january 1 of the current year T} T{ next year T}@T{ january 1 of next year T} T{ this month T}@T{ the - 1st of the current month T} T{ this week T}@T{ the most recent monday - T} T{ last week T}@T{ the monday of the week before this one T} T{ - lastweek T}@T{ spaces are optional T} T{ today, yesterday, tomorrow + 1st of the current month T} T{ this week T}@T{ the most recent monday + T} T{ last week T}@T{ the monday of the week before this one T} T{ + lastweek T}@T{ spaces are optional T} T{ today, yesterday, tomorrow T}@T{ T} RReeppoorrttiinngg iinntteerrvvaall - A reporting interval can be specified so that commands like register, - balance and activity will divide their reports into multiple report - periods. The basic intervals can be selected with one of -D/--daily, - -W/--weekly, -M/--monthly, -Q/--quarterly, or -Y/--yearly. More com- + A reporting interval can be specified so that commands like register, + balance and activity will divide their reports into multiple report + periods. The basic intervals can be selected with one of -D/--daily, + -W/--weekly, -M/--monthly, -Q/--quarterly, or -Y/--yearly. More com- plex intervals may be specified with a period expression. PPeerriioodd eexxpprreessssiioonnss - The -p/--period option accepts period expressions, a shorthand way of - expressing a start date, end date, and or reporting interval all at - once. Note a period expression on the command line will cause any + The -p/--period option accepts period expressions, a shorthand way of + expressing a start date, end date, and or reporting interval all at + once. Note a period expression on the command line will cause any other date flags (-b/-e/-D/-W/-M/-Q/-Y) to be ignored. - hledger's period expressions are similar to Ledger's, though not iden- - tical. Here's a basic period expression specifying the first quarter - of 2009. Note, hledger always treats start dates as inclusive and end + hledger's period expressions are similar to Ledger's, though not iden- + tical. Here's a basic period expression specifying the first quarter + of 2009. Note, hledger always treats start dates as inclusive and end dates as exclusive: -p "from 2009/1/1 to 2009/4/1" - Keywords like "from" and "to" are optional, and so are the spaces, as - long as you don't run two dates together. "to" can also be written as + Keywords like "from" and "to" are optional, and so are the spaces, as + long as you don't run two dates together. "to" can also be written as "-". These are equivalent to the above: - tab(@); l. T{ -p "2009/1/1 2009/4/1" T} T{ -p2009/1/1to2009/4/1 T} T{ + tab(@); l. T{ -p "2009/1/1 2009/4/1" T} T{ -p2009/1/1to2009/4/1 T} T{ -p2009/1/1-2009/4/1 T} - Dates are smart dates, so if the current year is 2009, the above can + Dates are smart dates, so if the current year is 2009, the above can also be written as: - tab(@); l. T{ -p "1/1 4/1" T} T{ -p "january-apr" T} T{ + tab(@); l. T{ -p "1/1 4/1" T} T{ -p "january-apr" T} T{ -p "this year to 4/1" T} If you specify only one date, the missing start or end date will be the earliest or latest transaction in your journal: - tab(@); l l. T{ -p "from 2009/1/1" T}@T{ everything after january 1, - 2009 T} T{ -p "from 2009/1" T}@T{ the same T} T{ -p "from 2009" T}@T{ + tab(@); l l. T{ -p "from 2009/1/1" T}@T{ everything after january 1, + 2009 T} T{ -p "from 2009/1" T}@T{ the same T} T{ -p "from 2009" T}@T{ the same T} T{ -p "to 2009" T}@T{ everything before january 1, 2009 T} - A single date with no "from" or "to" defines both the start and end + A single date with no "from" or "to" defines both the start and end date like so: tab(@); l l. T{ -p "2009" T}@T{ the year 2009; equivalent to "2009/1/1 - to 2010/1/1" T} T{ -p "2009/1" T}@T{ the month of jan; equivalent to + to 2010/1/1" T} T{ -p "2009/1" T}@T{ the month of jan; equivalent to "2009/1/1 to 2009/2/1" T} T{ -p "2009/1/1" T}@T{ just that day; equiva- lent to "2009/1/1 to 2009/1/2" T} - Period expressions can also start with (or be) a reporting interval: - daily, weekly, monthly, quarterly, yearly, or one of the every ... - expressions below. Optionally the word in may appear between the + Period expressions can also start with (or be) a reporting interval: + daily, weekly, monthly, quarterly, yearly, or one of the every ... + expressions below. Optionally the word in may appear between the reporting interval and the start/end dates. Examples: - tab(@); l. T{ -p "weekly from 2009/1/1 to 2009/4/1" T} T{ - -p "monthly in 2008" T} T{ -p "bimonthly from 2008" T} T{ -p "quar- - terly" T} T{ -p "every 2 weeks" T} T{ -p "every 5 days from 1/3" T} T{ + tab(@); l. T{ -p "weekly from 2009/1/1 to 2009/4/1" T} T{ + -p "monthly in 2008" T} T{ -p "bimonthly from 2008" T} T{ -p "quar- + terly" T} T{ -p "every 2 weeks" T} T{ -p "every 5 days from 1/3" T} T{ -p "every 15th day of month" T} T{ -p "every 4th day of week" T} RReegguullaarr EExxpprreessssiioonnss hledger uses regular expressions in a number of places: - +o query terms, on the command line and in the hledger-web search form: + +o query terms, on the command line and in the hledger-web search form: REGEX, desc:REGEX, cur:REGEX, tag:...=REGEX +o CSV rules conditional blocks: if REGEX ... - +o account alias directives and options: alias /REGEX/ = REPLACEMENT, + +o account alias directives and options: alias /REGEX/ = REPLACEMENT, --alias /REGEX/=REPLACEMENT - hledger's regular expressions come from the regex-tdfa library. In + hledger's regular expressions come from the regex-tdfa library. In general they: +o are case insensitive - +o are infix matching (do not need to match the entire thing being + +o are infix matching (do not need to match the entire thing being matched) +o are POSIX extended regular expressions +o also support GNU word boundaries (\<, \>, \b, \B) - +o and parenthesised capturing groups and numeric backreferences in + +o and parenthesised capturing groups and numeric backreferences in replacement strings +o do not support mode modifiers like (?s) Some things to note: - +o In the alias directive and --alias option, regular expressions must - be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, + +o In the alias directive and --alias option, regular expressions must + be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, these are not required. +o To match a regular expression metacharacter like $ as a literal char- acter, prepend a backslash. Eg to search for amounts with the dollar sign in hledger-web, write cur:\$. - +o On the command line, some metacharacters like $ have a special mean- + +o On the command line, some metacharacters like $ have a special mean- ing to the shell and so must be escaped a second time, with single or - double quotes or another backslash. Eg, to match amounts with the + double quotes or another backslash. Eg, to match amounts with the dollar sign from the command line, write cur:'\$' or cur:\\$. QQUUEERRIIEESS - One of hledger's strengths is being able to quickly report on precise - subsets of your data. Most commands accept an optional query expres- - sion, written as arguments after the command name, to filter the data - by date, account name or other criteria. The syntax is similar to a + One of hledger's strengths is being able to quickly report on precise + subsets of your data. Most commands accept an optional query expres- + sion, written as arguments after the command name, to filter the data + by date, account name or other criteria. The syntax is similar to a web search: one or more space-separated search terms, quotes to enclose - whitespace, optional prefixes to match specific fields. Multiple + whitespace, optional prefixes to match specific fields. Multiple search terms are combined as follows: - All commands except print: show transactions/postings/accounts which + All commands except print: show transactions/postings/accounts which match (or negatively match) +o any of the description terms AND @@ -376,22 +381,22 @@ QQUUEERRIIEESS same as above aammtt::NN,, aammtt::<>NN,, aammtt::>>==NN - match postings with a single-commodity amount that is equal to, - less than, or greater than N. (Multi-commodity amounts are not + match postings with a single-commodity amount that is equal to, + less than, or greater than N. (Multi-commodity amounts are not tested, and will always match.) The comparison has two modes: if N is preceded by a + or - sign (or is 0), the two signed numbers - are compared. Otherwise, the absolute magnitudes are compared, + are compared. Otherwise, the absolute magnitudes are compared, ignoring sign. ccooddee::RREEGGEEXX match by transaction code (eg check number) ccuurr::RREEGGEEXX - match postings or transactions including any amounts whose cur- - rency/commodity symbol is fully matched by REGEX. (For a par- + match postings or transactions including any amounts whose cur- + rency/commodity symbol is fully matched by REGEX. (For a par- tial match, use .*REGEX.*). Note, to match characters which are regex-significant, like the dollar sign ($), you need to prepend - \. And when using the command line you need to add one more + \. And when using the command line you need to add one more level of quoting to hide it from the shell, so eg do: hledger print cur:'\$' or hledger print cur:\\$. @@ -399,27 +404,27 @@ QQUUEERRIIEESS match transaction descriptions ddaattee::PPEERRIIOODDEEXXPPRR - match dates within the specified period (which should not + match dates within the specified period (which should not include a reporting interval ddaattee22::PPEERRIIOODDEEXXPPRR as above, but match secondary dates ddeepptthh::NN - match (or display, depending on command) accounts at or above + match (or display, depending on command) accounts at or above this depth rreeaall::,, rreeaall::00 match real or virtual postings respectively ssttaattuuss::**,, ssttaattuuss::!!,, ssttaattuuss:: - match cleared, pending, or uncleared/pending transactions + match cleared, pending, or uncleared/pending transactions respectively ttaagg::RREEGGEEXX[[==RREEGGEEXX]] - match by tag name, and optionally also by tag value. Note a - tag: query is considered to match a transaction if it matches - any of the postings. Also remember that postings inherit the + match by tag name, and optionally also by tag value. Note a + tag: query is considered to match a transaction if it matches + any of the postings. Also remember that postings inherit the tags of their parent transaction. nnoott:: before any of the above negates the match. @@ -427,19 +432,19 @@ QQUUEERRIIEESS * * * * * Some of these can also be expressed as command-line options (eg depth:2 - is equivalent to --depth 2). Generally you can mix options and query - arguments, and the resulting query will be their intersection (perhaps + is equivalent to --depth 2). Generally you can mix options and query + arguments, and the resulting query will be their intersection (perhaps excluding the -p/--period option). CCOOMMMMAANNDDSS - hledger provides a number of subcommands; hledger with no arguments + hledger provides a number of subcommands; hledger with no arguments shows a list. If you install additional hledger-* packages, or if you put programs or - scripts named hledger-NAME in your PATH, these will also be listed as + scripts named hledger-NAME in your PATH, these will also be listed as subcommands. - Run a subcommand by writing its name as first argument (eg + Run a subcommand by writing its name as first argument (eg hledger incomestatement). You can also write any unambiguous prefix of a command name (hledger inc), or one of the standard short aliases dis- played in the command list (hledger is). @@ -454,14 +459,14 @@ CCOOMMMMAANNDDSS ----ddrroopp==NN in flat mode: omit N leading account name parts - This command lists all account names that are in use (ie, all the - accounts which have at least one transaction posting to them). With + This command lists all account names that are in use (ie, all the + accounts which have at least one transaction posting to them). With query arguments, only matched account names are shown. - It shows a flat list by default. With --tree, it uses indentation to + It shows a flat list by default. With --tree, it uses indentation to show the account hierarchy. - In flat mode you can add --drop N to omit the first few account name + In flat mode you can add --drop N to omit the first few account name components. Examples: @@ -504,8 +509,8 @@ CCOOMMMMAANNDDSS aaccttiivviittyy Show an ascii barchart of posting counts per interval. - The activity command displays an ascii histogram showing transaction - counts by day, week, month or other reporting interval (by day is the + The activity command displays an ascii histogram showing transaction + counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. $ hledger activity --quarterly @@ -518,23 +523,23 @@ CCOOMMMMAANNDDSS Prompt for transactions and add them to the journal. ----nnoo--nneeww--aaccccoouunnttss - don't allow creating new accounts; helps prevent typos when + don't allow creating new accounts; helps prevent typos when entering account names - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- - actions, and appends them to the journal file (existing transactions - are not changed). This is the only hledger command that writes to the + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- + actions, and appends them to the journal file (existing transactions + are not changed). This is the only hledger command that writes to the journal file. To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - +o add tries to provide useful defaults, using the most similar recent + +o add tries to provide useful defaults, using the most similar recent transaction (by description) as a template. +o You can also set the initial defaults with command line arguments. @@ -542,20 +547,20 @@ CCOOMMMMAANNDDSS +o Readline-style edit keys can be used during data entry. +o The tab key will auto-complete whenever possible - accounts, descrip- - tions, dates (yesterday, today, tomorrow). If the input area is + tions, dates (yesterday, today, tomorrow). If the input area is empty, it will insert the default value. - +o If the journal defines a default commodity, it will be added to any + +o If the journal defines a default commodity, it will be added to any bare numbers entered. +o A parenthesised transaction code may be entered following a date. +o Comments and tags may be entered following a description or amount. - +o If you make a mistake, enter < at any prompt to restart the transac- + +o If you make a mistake, enter < at any prompt to restart the transac- tion. - +o Input prompts are displayed in a different colour when the terminal + +o Input prompts are displayed in a different colour when the terminal supports it. Example (see the tutorial for a detailed explanation): @@ -627,7 +632,7 @@ CCOOMMMMAANNDDSS --OO FFMMTT ----oouuttppuutt--ffoorrmmaatt==FFMMTT select the output format. Supported formats: txt, csv. - The balance command displays accounts and balances. It is hledger's + The balance command displays accounts and balances. It is hledger's most featureful and most useful command. $ hledger balance @@ -644,24 +649,24 @@ CCOOMMMMAANNDDSS -------------------- 0 - More precisely, the balance command shows the _c_h_a_n_g_e to each account's + More precisely, the balance command shows the _c_h_a_n_g_e to each account's balance caused by all (matched) postings. In the common case where you - do not filter by date and your journal sets the correct opening bal- + do not filter by date and your journal sets the correct opening bal- ances, this is the same as the account's ending balance. - By default, accounts are displayed hierarchically, with subaccounts + By default, accounts are displayed hierarchically, with subaccounts indented below their parent. "Boring" accounts, which contain a single interesting subaccount and no balance of their own, are elided into the - following line for more compact output. (Use --no-elide to prevent + following line for more compact output. (Use --no-elide to prevent this.) - Each account's balance is the "inclusive" balance - it includes the + Each account's balance is the "inclusive" balance - it includes the balances of any subaccounts. - Accounts which have zero balance (and no non-zero subaccounts) are + Accounts which have zero balance (and no non-zero subaccounts) are omitted. Use -E/--empty to show them. - A final total is displayed by default; use -N/--no-total to suppress + A final total is displayed by default; use -N/--no-total to suppress it: $ hledger balance -p 2008/6 expenses --no-total @@ -671,9 +676,9 @@ CCOOMMMMAANNDDSS FFllaatt mmooddee To see a flat list of full account names instead of the default hierar- - chical display, use --flat. In this mode, accounts (unless + chical display, use --flat. In this mode, accounts (unless depth-clipped) show their "exclusive" balance, excluding any subaccount - balances. In this mode, you can also use --drop N to omit the first + balances. In this mode, you can also use --drop N to omit the first few account name components. $ hledger balance -p 2008/6 expenses -N --flat --drop 1 @@ -681,9 +686,9 @@ CCOOMMMMAANNDDSS $1 supplies DDeepptthh lliimmiitteedd bbaallaannccee rreeppoorrttss - With --depth N, balance shows accounts only to the specified depth. - This is very useful to show a complex charts of accounts in less - detail. In flat mode, balances from accounts below the depth limit + With --depth N, balance shows accounts only to the specified depth. + This is very useful to show a complex charts of accounts in less + detail. In flat mode, balances from accounts below the depth limit will be shown as part of a parent account at the depth limit. $ hledger balance -N --depth 1 @@ -693,12 +698,12 @@ CCOOMMMMAANNDDSS $1 liabilities MMuullttiiccoolluummnn bbaallaannccee rreeppoorrttss - With a reporting interval, multiple balance columns will be shown, one - for each report period. There are three types of multi-column balance + With a reporting interval, multiple balance columns will be shown, one + for each report period. There are three types of multi-column balance report, showing different information: 1. By default: each column shows the sum of postings in that period, ie - the account's change of balance in that period. This is useful eg + the account's change of balance in that period. This is useful eg for a monthly income statement: $ hledger balance --quarterly income expenses -E @@ -713,8 +718,8 @@ CCOOMMMMAANNDDSS -------------------++--------------------------------- || $-1 $1 0 0 - 2. With --cumulative: each column shows the ending balance for that - period, accumulating the changes across periods, starting from 0 at + 2. With --cumulative: each column shows the ending balance for that + period, accumulating the changes across periods, starting from 0 at the report start date: $ hledger balance --quarterly income expenses -E --cumulative @@ -730,8 +735,8 @@ CCOOMMMMAANNDDSS || $-1 0 0 0 3. With --historical/-H: each column shows the actual historical ending - balance for that period, accumulating the changes across periods, - starting from the actual balance at the report start date. This is + balance for that period, accumulating the changes across periods, + starting from the actual balance at the report start date. This is useful eg for a multi-period balance sheet, and when you are showing only the data after a certain start date: @@ -747,26 +752,26 @@ CCOOMMMMAANNDDSS ----------------------++------------------------------------- || 0 0 0 - Multi-column balance reports display accounts in flat mode by default; + Multi-column balance reports display accounts in flat mode by default; to see the hierarchy, use --tree. - With a reporting interval (like --quarterly above), the report - start/end dates will be adjusted if necessary so that they encompass + With a reporting interval (like --quarterly above), the report + start/end dates will be adjusted if necessary so that they encompass the displayed report periods. This is so that the first and last peri- ods will be "full" and comparable to the others. - The -E/--empty flag does two things in multicolumn balance reports: - first, the report will show all columns within the specified report - period (without -E, leading and trailing columns with all zeroes are - not shown). Second, all accounts which existed at the report start - date will be considered, not just the ones with activity during the + The -E/--empty flag does two things in multicolumn balance reports: + first, the report will show all columns within the specified report + period (without -E, leading and trailing columns with all zeroes are + not shown). Second, all accounts which existed at the report start + date will be considered, not just the ones with activity during the report period (use -E to include low-activity accounts which would oth- erwise would be omitted). The -T/--row-total flag adds an additional column showing the total for each row. - The -A/--average flag adds a column showing the average value in each + The -A/--average flag adds a column showing the average value in each row. Here's an example of all three: @@ -789,16 +794,16 @@ CCOOMMMMAANNDDSS MMaarrkkeett vvaalluuee The -V/--value flag converts all the reported amounts to their "current - market value" using their default market price. That is the latest - market price (P directive) found in the journal (or an included file), + market value" using their default market price. That is the latest + market price (P directive) found in the journal (or an included file), for the amount's commodity, dated on or before the report end date. Unlike Ledger, hledger's -V only uses the market prices recorded with P - directives, ignoring transaction prices recorded as part of posting + directives, ignoring transaction prices recorded as part of posting amounts (which -B/--cost uses). Using -B and -V together is allowed. CCuussttoomm bbaallaannccee oouuttppuutt - In simple (non-multi-column) balance reports, you can customise the + In simple (non-multi-column) balance reports, you can customise the output with --format FMT: $ hledger balance --format "%20(account) %12(total)" @@ -816,7 +821,7 @@ CCOOMMMMAANNDDSS 0 The FMT format string (plus a newline) specifies the formatting applied - to each account/balance pair. It may contain any suitable text, with + to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: %[MIN][.MAX](FIELDNAME) @@ -827,14 +832,14 @@ CCOOMMMMAANNDDSS +o FIELDNAME must be enclosed in parentheses, and can be one of: - +o depth_spacer - a number of spaces equal to the account's depth, or + +o depth_spacer - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. +o account - the account's name +o total - the account's balance/posted total, right justified - Also, FMT can begin with an optional prefix to control how multi-com- + Also, FMT can begin with an optional prefix to control how multi-com- modity amounts are rendered: +o %_ - render on multiple lines, bottom-aligned (the default) @@ -843,7 +848,7 @@ CCOOMMMMAANNDDSS +o %, - render on one line, comma-separated - There are some quirks. Eg in one-line mode, %(depth_spacer) has no + There are some quirks. Eg in one-line mode, %(depth_spacer) has no effect, instead %(account) has indentation built in. Experimentation may be needed to get pleasing results. @@ -851,19 +856,19 @@ CCOOMMMMAANNDDSS +o %(total) - the account's total - +o %-20.20(account) - the account's name, left justified, padded to 20 + +o %-20.20(account) - the account's name, left justified, padded to 20 characters and clipped at 20 characters - +o %,%-50(account) %25(total) - account name padded to 50 characters, - total padded to 20 characters, with multiple commodities rendered on + +o %,%-50(account) %25(total) - account name padded to 50 characters, + total padded to 20 characters, with multiple commodities rendered on one line - +o %20(total) %2(depth_spacer)%-(account) - the default format for the + +o %20(total) %2(depth_spacer)%-(account) - the default format for the single-column balance report OOuuttppuutt ddeessttiinnaattiioonn - The balance, print, register and stats commands can write their output - to a destination other than the console. This is controlled by the + The balance, print, register and stats commands can write their output + to a destination other than the console. This is controlled by the -o/--output-file option. $ hledger balance -o - # write to stdout (the default) @@ -871,8 +876,8 @@ CCOOMMMMAANNDDSS CCSSVV oouuttppuutt The balance, print and register commands can write their output as CSV. - This is useful for exporting data to other applications, eg to make - charts in a spreadsheet. This is controlled by the -O/--output-format + This is useful for exporting data to other applications, eg to make + charts in a spreadsheet. This is controlled by the -O/--output-format option, or by specifying a .csv file extension with -o/--output-file. $ hledger balance -O csv # write CSV to stdout @@ -886,8 +891,8 @@ CCOOMMMMAANNDDSS ----ddrroopp==NN in flat mode: omit N leading account name parts - This command displays a simple balance sheet. It currently assumes - that you have top-level accounts named asset and liability (plural + This command displays a simple balance sheet. It currently assumes + that you have top-level accounts named asset and liability (plural forms also allowed.) $ hledger balancesheet @@ -917,9 +922,9 @@ CCOOMMMMAANNDDSS ----ddrroopp==NN in flat mode: omit N leading account name parts - This command displays a simple cashflow statement It shows the change - in all "cash" (ie, liquid assets) accounts for the period. It cur- - rently assumes that cash accounts are under a top-level account named + This command displays a simple cashflow statement It shows the change + in all "cash" (ie, liquid assets) accounts for the period. It cur- + rently assumes that cash accounts are under a top-level account named asset and do not contain receivable or A/R (plural forms also allowed.) $ hledger cashflow @@ -937,18 +942,18 @@ CCOOMMMMAANNDDSS $-1 hheellpp - Show detailed help. + Show one of the hledger manuals. - The help command can display any of the main hledger man pages, as - fixed-width text. (Unlike hledger --help, which displays only the - hledger man page.) Run it with no arguments to list available topics - (their names are shortened for easier typing), and run - hledger help TOPIC to select one. The output may be long, so you may - wish to pipe it into a pager. + The help command displays any of the main hledger man pages. (Unlike + hledger --help, which displays only the hledger man page.) Run it with + no arguments to list available topics (their names are shortened for + easier typing), and run hledger help TOPIC to select one. The output + is similar to a man page, but fixed width. It may be long, so you may + wish to pipe it into a pager. See also info and man. $ hledger help - Please choose a topic, eg: hledger help ui - Topics: cli, ui, web, api, journal, csv, timeclock, timedot + Choose a topic, eg: hledger help cli + cli, ui, web, api, journal, csv, timeclock, timedot $ hledger help cli | less @@ -972,8 +977,8 @@ CCOOMMMMAANNDDSS ----ddrroopp==NN in flat mode: omit N leading account name parts - This command displays a simple income statement. It currently assumes - that you have top-level accounts named income (or revenue) and expense + This command displays a simple income statement. It currently assumes + that you have top-level accounts named income (or revenue) and expense (plural forms also allowed.) $ hledger incomestatement @@ -997,11 +1002,33 @@ CCOOMMMMAANNDDSS -------------------- 0 + iinnffoo + Show one of the hledger manuals using info. + + The info command displays any of the hledger reference manuals using + the info hypertextual documentation viewer. This can be a very effi- + cient way to browse large manuals. It requires the "info" program to + be available in your PATH. + + As with help, run it with no arguments to list available topics (manu- + als). + + mmaann + Show one of the hledger manuals using man. + + The man command displays any of the hledger reference manuals using + man, the standard documentation viewer on unix systems. This will fit + the text to your terminal width, and probably invoke a pager automati- + cally. It requires the "man" program to be available in your PATH. + + As with help, run it with no arguments to list available topics (manu- + als). + pprriinntt Show transactions from the journal. --mm SSTTRR ----mmaattcchh==SSTTRR - show the transaction whose description is most similar to STR, + show the transaction whose description is most similar to STR, and is most recent --oo FFIILLEE[[..FFMMTT]] ----oouuttppuutt--ffiillee==FFIILLEE[[..FFMMTT]] @@ -1033,12 +1060,12 @@ CCOOMMMMAANNDDSS liabilities:debts $1 assets:bank:checking $-1 - The print command displays full transactions from the journal file, - tidily formatted and showing all amounts explicitly. The output of - print is always a valid hledger journal, but it does always not pre- + The print command displays full transactions from the journal file, + tidily formatted and showing all amounts explicitly. The output of + print is always a valid hledger journal, but it does always not pre- serve all original content exactly (eg directives). - hledger's print command also shows all unit prices in effect, or (with + hledger's print command also shows all unit prices in effect, or (with -B/--cost) shows cost amounts. The print command also supports output destination and CSV output. @@ -1050,14 +1077,14 @@ CCOOMMMMAANNDDSS include prior postings in the running total --AA ----aavveerraaggee - show a running average instead of the running total (implies + show a running average instead of the running total (implies --empty) --rr ----rreellaatteedd show postings' siblings instead --ww NN ----wwiiddtthh==NN - set output width (default: terminal width or COLUMNS. -wN,M + set output width (default: terminal width or COLUMNS. -wN,M sets description width as well) --oo FFIILLEE[[..FFMMTT]] ----oouuttppuutt--ffiillee==FFIILLEE[[..FFMMTT]] @@ -1068,7 +1095,7 @@ CCOOMMMMAANNDDSS select the output format. Supported formats: txt, csv. The register command displays postings, one per line, and their running - total. This is typically used with a query selecting a particular + total. This is typically used with a query selecting a particular account, to see that account's activity: $ hledger register checking @@ -1077,8 +1104,8 @@ CCOOMMMMAANNDDSS 2008/06/02 save assets:bank:checking $-1 $1 2008/12/31 pay off assets:bank:checking $-1 0 - The --historical/-H flag adds the balance from any undisplayed prior - postings to the running total. This is useful when you want to see + The --historical/-H flag adds the balance from any undisplayed prior + postings to the running total. This is useful when you want to see only recent activity, with a historically accurate running balance: $ hledger register checking -b 2008/6 --historical @@ -1088,22 +1115,22 @@ CCOOMMMMAANNDDSS The --depth option limits the amount of sub-account detail displayed. - The --average/-A flag shows the running average posting amount instead + The --average/-A flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for - the whole report period). This flag implies --empty (see below). It + the whole report period). This flag implies --empty (see below). It works best when showing just one account and one commodity. - The --related/-r flag shows the _o_t_h_e_r postings in the transactions of + The --related/-r flag shows the _o_t_h_e_r postings in the transactions of the postings which would normally be shown. - With a reporting interval, register shows summary postings, one per + With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: $ hledger register --monthly income 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 - Periods with no activity, and summary postings with a zero amount, are + Periods with no activity, and summary postings with a zero amount, are not shown by default; use the --empty/-E flag to see them: $ hledger register --monthly income -E @@ -1120,7 +1147,7 @@ CCOOMMMMAANNDDSS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth + Often, you'll want to see just one line per interval. The --depth option helps with this, causing subaccounts to be aggregated: $ hledger register --monthly assets --depth 1h @@ -1128,19 +1155,19 @@ CCOOMMMMAANNDDSS 2008/06 assets $-1 0 2008/12 assets $-1 $-1 - Note when using report intervals, if you specify start/end dates these - will be adjusted outward if necessary to contain a whole number of - intervals. This ensures that the first and last intervals are full + Note when using report intervals, if you specify start/end dates these + will be adjusted outward if necessary to contain a whole number of + intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. CCuussttoomm rreeggiisstteerr oouuttppuutt - register uses the full terminal width by default, except on windows. - You can override this by setting the COLUMNS environment variable (not + register uses the full terminal width by default, except on windows. + You can override this by setting the COLUMNS environment variable (not a bash shell variable) or by using the --width/-w option. - The description and account columns normally share the space equally - (about half of (width - 40) each). You can adjust this by adding a - description width as part of --width's argument, comma-separated: + The description and account columns normally share the space equally + (about half of (width - 40) each). You can adjust this by adding a + description width as part of --width's argument, comma-separated: --width W,D . Here's a diagram: <--------------------------------- width (W) ----------------------------------> @@ -1156,7 +1183,7 @@ CCOOMMMMAANNDDSS $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, and set description width - The register command also supports the -o/--output-file and -O/--out- + The register command also supports the -o/--output-file and -O/--out- put-format options for controlling output destination and CSV output. ssttaattss @@ -1178,8 +1205,8 @@ CCOOMMMMAANNDDSS Accounts : 8 (depth 3) Commodities : 1 ($) - The stats command displays summary information for the whole journal, - or a matched part of it. With a reporting interval, it shows a report + The stats command displays summary information for the whole journal, + or a matched part of it. With a reporting interval, it shows a report for each report period. The stats command also supports -o/--output-file for controlling output @@ -1191,37 +1218,37 @@ CCOOMMMMAANNDDSS $ hledger test Cases: 74 Tried: 74 Errors: 0 Failures: 0 - This command runs hledger's built-in unit tests and displays a quick + This command runs hledger's built-in unit tests and displays a quick report. With a regular expression argument, it selects only tests with matching names. It's mainly used in development, but it's also nice to be able to check your hledger executable for smoke at any time. AADDDD--OONN CCOOMMMMAANNDDSS - Add-on commands are executables in your PATH whose name starts with - hledger- and ends with any of these file extensions: none, - .hs,.lhs,.pl,.py,.rb,.rkt,.sh,.bat,.com,.exe. Also, an add-on's name + Add-on commands are executables in your PATH whose name starts with + hledger- and ends with any of these file extensions: none, + .hs,.lhs,.pl,.py,.rb,.rkt,.sh,.bat,.com,.exe. Also, an add-on's name may not be the same as any built-in command or alias. - hledger will detect these and include them in the command list and let - you invoke them with hledger ADDONCMD. However there are some limita- + hledger will detect these and include them in the command list and let + you invoke them with hledger ADDONCMD. However there are some limita- tions: +o Options appearing before ADDONCMD will be visible only to hledger and will not be passed to the add-on. Eg: hledger -h web shows hledger's usage, hledger web -h shows hledger-web's usage. - +o Options understood only by the add-on must go after a -- argument to - hide them from hledger, which would otherwise reject them. Eg: + +o Options understood only by the add-on must go after a -- argument to + hide them from hledger, which would otherwise reject them. Eg: hledger web -- --server. - Sometimes it may be more convenient to just run the add-on directly, + Sometimes it may be more convenient to just run the add-on directly, eg: hledger-web --server. - Add-ons which are written in haskell can take advantage of the - hledger-lib library for journal parsing, reporting, command-line + Add-ons which are written in haskell can take advantage of the + hledger-lib library for journal parsing, reporting, command-line options, etc. - Here are some hledger add-ons available from Hackage, the extra direc- + Here are some hledger add-ons available from Hackage, the extra direc- tory in the hledger source, or elsewhere: aappii @@ -1279,11 +1306,11 @@ AADDDD--OONN CCOOMMMMAANNDDSS WF:4303001832 -$6.00 [assets:business:bank:wf:bchecking:banking] $6.00 - ledger-autosync, which includes a hledger-autosync alias, downloads + ledger-autosync, which includes a hledger-autosync alias, downloads transactions from your bank(s) via OFX, and prints just the new ones as journal entries which you can add to your journal. It can also operate - on .OFX files which you've downloaded manually. It can be a nice - alternative to hledger's built-in CSV reader, especially if your bank + on .OFX files which you've downloaded manually. It can be a nice + alternative to hledger's built-in CSV reader, especially if your bank supports OFX download. ddiiffff @@ -1309,9 +1336,9 @@ AADDDD--OONN CCOOMMMMAANNDDSS 2015/02/02 (acct:two) $2 - hledger-diff compares two journal files. Given an account name, it - prints out the transactions affecting that account which are in one - journal file but not in the other. This can be useful for reconciling + hledger-diff compares two journal files. Given an account name, it + prints out the transactions affecting that account which are in one + journal file but not in the other. This can be useful for reconciling existing journals with bank statements. eeqquuiittyy @@ -1338,14 +1365,14 @@ AADDDD--OONN CCOOMMMMAANNDDSS equity:opening balances 0 This prints a journal entry which zeroes out the specified accounts (or - all accounts) with a transfer to/from "equity:closing balances" (like - Ledger's equity command). Also, it prints an similar entry with oppo- + all accounts) with a transfer to/from "equity:closing balances" (like + Ledger's equity command). Also, it prints an similar entry with oppo- site sign for restoring the balances from "equity:opening balances". These can be useful for ending one journal file and starting a new one, - respectively. By zeroing your asset and liability accounts at the end + respectively. By zeroing your asset and liability accounts at the end of a file and restoring them at the start of the next one, you will see - correct asset/liability balances whether you run hledger on just one + correct asset/liability balances whether you run hledger on just one file, or on several files concatenated with include. iinntteerreesstt @@ -1426,11 +1453,11 @@ AADDDD--OONN CCOOMMMMAANNDDSS Liabilities:Bank EUR 3700.00 hledger-interest computes interests for a given account. Using command - line flags, the program can be configured to use various schemes for - day-counting, such as act/act, 30/360, 30E/360, and 30/360isda. Fur- - thermore, it supports a (small) number of interest schemes, i.e. + line flags, the program can be configured to use various schemes for + day-counting, such as act/act, 30/360, 30E/360, and 30/360isda. Fur- + thermore, it supports a (small) number of interest schemes, i.e. annual interest with a fixed rate and the scheme mandated by the German - BGB288 (Basiszins f~A1/4r Verbrauchergesch~Aoxfte). See the package page + BGB288 (Basiszins f~A1/4r Verbrauchergesch~Aoxfte). See the package page for more. iirrrr @@ -1488,11 +1515,11 @@ AADDDD--OONN CCOOMMMMAANNDDSS 2011/04/01 - 2011/05/01: 32.24% 2011/05/01 - 2011/06/01: 95.92% - hledger-irr computes the internal rate of return, also known as the - effective interest rate, of a given investment. After specifying what - account holds the investment, and what account stores the gains (or - losses, or fees, or cost), it calculates the hypothetical annual rate - of fixed rate investment that would have provided the exact same cash + hledger-irr computes the internal rate of return, also known as the + effective interest rate, of a given investment. After specifying what + account holds the investment, and what account stores the gains (or + losses, or fees, or cost), it calculates the hypothetical annual rate + of fixed rate investment that would have provided the exact same cash flow. See the package page for more. pprriinntt--uunniiqquuee @@ -1524,26 +1551,26 @@ AADDDD--OONN CCOOMMMMAANNDDSS TTRROOUUBBLLEESSHHOOOOTTIINNGG RRuunn--ttiimmee pprroobblleemmss - Here are some issues you might encounter when you run hledger (and - remember you can also seek help from the IRC channel, mail list or bug + Here are some issues you might encounter when you run hledger (and + remember you can also seek help from the IRC channel, mail list or bug tracker): SSuucccceessssffuullllyy iinnssttaalllleedd,, bbuutt ""NNoo ccoommmmaanndd ''hhlleeddggeerr'' ffoouunndd"" stack and cabal install binaries into a special directory, which should - be added to your PATH environment variable. Eg on unix-like systems, + be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. II sseett aa ccuussttoomm LLEEDDGGEERR__FFIILLEE,, bbuutt hhlleeddggeerr iiss ssttiillll uussiinngg tthhee ddeeffaauulltt ffiillee - LEDGER_FILE should be a real environment variable, not just a shell - variable. The command env | grep LEDGER_FILE should show it. You may + LEDGER_FILE should be a real environment variable, not just a shell + variable. The command env | grep LEDGER_FILE should show it. You may need to use export. Here's an explanation. - ""IIlllleeggaall bbyyttee sseeqquueennccee"" oorr ""IInnvvaalliidd oorr iinnccoommpplleettee mmuullttiibbyyttee oorr wwiiddee + ""IIlllleeggaall bbyyttee sseeqquueennccee"" oorr ""IInnvvaalliidd oorr iinnccoommpplleettee mmuullttiibbyyttee oorr wwiiddee cchhaarraacctteerr"" eerrrroorrss - In order to handle non-ascii letters and symbols (like ^A-L), hledger - needs an appropriate locale. This is usually configured system-wide; - you can also configure it temporarily. The locale may need to be one - that supports UTF-8, if you built hledger with GHC < 7.2 (or possibly + In order to handle non-ascii letters and symbols (like ^A-L), hledger + needs an appropriate locale. This is usually configured system-wide; + you can also configure it temporarily. The locale may need to be one + that supports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, I'm not sure yet). Here's an example of setting the locale temporarily, on ubuntu @@ -1562,7 +1589,7 @@ TTRROOUUBBLLEESSHHOOOOTTIINNGG $ echo "export LANG=en_US.UTF-8" >>~/.bash_profile $ bash --login - If we preferred to use eg fr_FR.utf8, we might have to install that + If we preferred to use eg fr_FR.utf8, we might have to install that first: $ apt-get install language-pack-fr @@ -1583,31 +1610,31 @@ TTRROOUUBBLLEESSHHOOOOTTIINNGG KKnnoowwnn lliimmiittaattiioonnss CCoommmmaanndd lliinnee iinntteerrffaaccee - Add-on command options, unless they are also understood by the main - hledger executable, must be written after --, like this: + Add-on command options, unless they are also understood by the main + hledger executable, must be written after --, like this: hledger web -- --server DDiiffffeerreenncceess ffrroomm LLeeddggeerr - Not all of Ledger's journal file syntax is supported. See file format + Not all of Ledger's journal file syntax is supported. See file format differences. - hledger is slower than Ledger, and uses more memory, on large data + hledger is slower than Ledger, and uses more memory, on large data files. WWiinnddoowwss lliimmiittaattiioonnss - In a windows CMD window, non-ascii characters and colours are not sup- + In a windows CMD window, non-ascii characters and colours are not sup- ported. In a windows Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. EENNVVIIRROONNMMEENNTT - LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is + LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is ~/.hledger.journal. - CCOOLLUUMMNNSS sets the default width used by the register command (normally + CCOOLLUUMMNNSS sets the default width used by the register command (normally the full terminal width). FFIILLEESS @@ -1616,10 +1643,10 @@ FFIILLEESS file. BBUUGGSS - The need to precede options with -- when invoked from hledger is awk- + The need to precede options with -- when invoked from hledger is awk- ward. - hledger can't render non-ascii characters when run from a Windows com- + hledger can't render non-ascii characters when run from a Windows com- mand prompt (up to Windows 7 at least). When input data contains non-ascii characters, a suitable system locale @@ -1629,7 +1656,7 @@ BBUUGGSS RREEPPOORRTTIINNGG BBUUGGSS - Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel + Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel or hledger mail list) @@ -1643,7 +1670,7 @@ CCOOPPYYRRIIGGHHTT SSEEEE AALLSSOO - hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), + hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- dot(5), ledger(1) diff --git a/hledger/doc/options.m4.md b/hledger/doc/options.m4.md index 524906a3f..f4eb6f2ba 100644 --- a/hledger/doc/options.m4.md +++ b/hledger/doc/options.m4.md @@ -26,10 +26,16 @@ General options are always available and can appear anywhere in the command line : show general usage (or if after COMMAND, the command's usage) `--help` -: show detailed help (or if after COMMAND, the command's help) +: show hledger manual (or if after an add-on COMMAND, show the add-on's manual) + +`--man` +: show manual with man + +`--info` +: show manual with info `--version` -: show version information +: show version `-f FILE --file=FILE` : use a different input file. For stdin, use - diff --git a/hledger/future-package.yaml b/hledger/future-package.yaml index d67180058..7769cc58c 100644 --- a/hledger/future-package.yaml +++ b/hledger/future-package.yaml @@ -81,6 +81,7 @@ dependencies: - regex-tdfa - safe >= 0.2 - split >= 0.1 && < 0.3 + - temporary - text >= 0.11 - tabular >= 0.2 && < 0.3 - utf8-string >= 0.3.5 && < 1.1 @@ -124,6 +125,7 @@ library: - Hledger.Cli - Hledger.Cli.Main - Hledger.Cli.CliOptions + - Hledger.Cli.DocFiles - Hledger.Cli.Tests - Hledger.Cli.Utils - Hledger.Cli.Version @@ -132,8 +134,11 @@ library: - Hledger.Cli.Balance - Hledger.Cli.Balancesheet - Hledger.Cli.Cashflow + - Hledger.Cli.Help - Hledger.Cli.Histogram - Hledger.Cli.Incomestatement + - Hledger.Cli.Info + - Hledger.Cli.Man - Hledger.Cli.Print - Hledger.Cli.Register - Hledger.Cli.Stats diff --git a/hledger/hledger.cabal b/hledger/hledger.cabal index 418023a3e..9de331071 100644 --- a/hledger/hledger.cabal +++ b/hledger/hledger.cabal @@ -80,6 +80,7 @@ library , regex-tdfa , safe >= 0.2 , split >= 0.1 && < 0.3 + , temporary , text >= 0.11 , tabular >= 0.2 && < 0.3 , utf8-string >= 0.3.5 && < 1.1 @@ -122,6 +123,8 @@ library Hledger.Cli.Help Hledger.Cli.Histogram Hledger.Cli.Incomestatement + Hledger.Cli.Info + Hledger.Cli.Man Hledger.Cli.Print Hledger.Cli.Register Hledger.Cli.Stats @@ -158,6 +161,7 @@ executable hledger , regex-tdfa , safe >= 0.2 , split >= 0.1 && < 0.3 + , temporary , text >= 0.11 , tabular >= 0.2 && < 0.3 , utf8-string >= 0.3.5 && < 1.1 @@ -213,6 +217,7 @@ test-suite test , regex-tdfa , safe >= 0.2 , split >= 0.1 && < 0.3 + , temporary , text >= 0.11 , tabular >= 0.2 && < 0.3 , utf8-string >= 0.3.5 && < 1.1 @@ -256,6 +261,7 @@ benchmark bench criterion, html, tabular >= 0.2 && < 0.3, + temporary, timeit, process, file-embed,