cli: doc: sync/update manual & cli command lists

This commit is contained in:
Simon Michael 2020-12-23 10:28:31 -08:00
parent f43ab0029d
commit 9c7a87da57
2 changed files with 20 additions and 11 deletions

View File

@ -156,7 +156,7 @@ builtinCommands = [
-- --
commandsList :: String -> [String] -> [String] commandsList :: String -> [String] -> [String]
commandsList progversion othercmds = [ commandsList progversion othercmds = [
-- keep synced with hledger.m4.md -> Commands --> -- keep synced with hledger.m4.md -> Commands, commands.m4 -->
"-------------------------------------------------------------------------------" "-------------------------------------------------------------------------------"
,progversion ,progversion
,"Usage: hledger COMMAND [OPTIONS] [-- ADDONCMDOPTIONS]" ,"Usage: hledger COMMAND [OPTIONS] [-- ADDONCMDOPTIONS]"
@ -176,6 +176,7 @@ commandsList progversion othercmds = [
," diff compare account transactions in two journal files" ," diff compare account transactions in two journal files"
,"+interest generate interest transactions" ,"+interest generate interest transactions"
," rewrite generate extra postings, similar to print --auto" ," rewrite generate extra postings, similar to print --auto"
,"+stockquotes download market prices from AlphaVantage"
,"" ,""
,"Financial reports:" ,"Financial reports:"
," aregister (areg) show transactions in a particular account" ," aregister (areg) show transactions in a particular account"
@ -205,14 +206,15 @@ commandsList progversion othercmds = [
," test run self tests" ," test run self tests"
,"" ,""
,"Alternate user interfaces:" ,"Alternate user interfaces:"
,"+ui run curses ui" ,"+ui run terminal UI"
,"+web run web ui" ,"+web run web UI"
,"" ,""
,"Other:" ,"Other:"
] ++ ] ++
othercmds othercmds
++ ++
["Help:" [""
,"Help:"
," (no arguments) show this commands list" ," (no arguments) show this commands list"
," -h show general flags" ," -h show general flags"
," COMMAND -h show flags & docs for COMMAND" ," COMMAND -h show flags & docs for COMMAND"

View File

@ -1,12 +1,6 @@
m4_dnl _command_(NAME, MDFILE)
m4_dnl Create a command heading and include its doc.
m4_define({{_command_}},
{{$1
_include_(hledger/Hledger/Cli/Commands/$2.md)
}})m4_dnl
m4_dnl
m4_dnl _commands_(HEADINGHASHES) m4_dnl _commands_(HEADINGHASHES)
m4_dnl Used in the hledger manual to include all command docs. m4_dnl Used in the hledger manual to include all command docs.
m4_dnl Keep synced with Hledger.Cli.Commands.commandsList, hledger.m4.md
m4_define({{_commands_}}, m4_define({{_commands_}},
{{ {{
_command_({{$1 accounts}} ,{{Accounts}}) _command_({{$1 accounts}} ,{{Accounts}})
@ -28,9 +22,22 @@ _command_({{$1 help}} ,{{Help}})
_command_({{$1 import}} ,{{Import}}) _command_({{$1 import}} ,{{Import}})
_command_({{$1 incomestatement}} ,{{Incomestatement}}) _command_({{$1 incomestatement}} ,{{Incomestatement}})
_command_({{$1 notes}} ,{{Notes}}) _command_({{$1 notes}} ,{{Notes}})
_command_({{$1 payees}} ,{{Payees}})
_command_({{$1 prices}} ,{{Prices}})
_command_({{$1 print}} ,{{Print}})
_command_({{$1 print-unique}} ,{{Printunique}})
_command_({{$1 register}} ,{{Register}})
_command_({{$1 register-match}} ,{{Registermatch}})
_command_({{$1 rewrite}} ,{{Rewrite}}) _command_({{$1 rewrite}} ,{{Rewrite}})
_command_({{$1 roi}} ,{{Roi}}) _command_({{$1 roi}} ,{{Roi}})
_command_({{$1 stats}} ,{{Stats}}) _command_({{$1 stats}} ,{{Stats}})
_command_({{$1 tags}} ,{{Tags}}) _command_({{$1 tags}} ,{{Tags}})
_command_({{$1 test}} ,{{Test}}) _command_({{$1 test}} ,{{Test}})
}})m4_dnl }})m4_dnl
m4_dnl
m4_dnl _command_(NAME, MDFILE)
m4_dnl Create a command heading and include its doc.
m4_define({{_command_}},
{{$1
_include_(hledger/Hledger/Cli/Commands/$2.md)
}})m4_dnl