From 7632321b3c4ceccaf8cf5420534899238728b3d5 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 18 Mar 2023 01:14:31 -1000 Subject: [PATCH] ;imp: cli: commands list cleanups --- hledger/Hledger/Cli/Commands.hs | 49 ++++++++++++++++----------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/hledger/Hledger/Cli/Commands.hs b/hledger/Hledger/Cli/Commands.hs index e7e8cf66e..9517b7e49 100644 --- a/hledger/Hledger/Cli/Commands.hs +++ b/hledger/Hledger/Cli/Commands.hs @@ -196,20 +196,17 @@ commandsList progversion othercmds highlight0 = -- commandsFromCommandsList. Only commands should begin with space or plus. "-------------------------------------------------------------------------------" ,progversion - ,"Usage: hledger COMMAND [OPTIONS] [-- ADDONCMDOPTIONS]" - ,"Commands (+ addons found in $PATH):" + ,"Usage: hledger CMD [OPTS] [-- ADDONCMDOPTS]" + ,"Commands (builtins + addons):" ,"" - ,"Usage: " ++ bold' "hledger CMD [OPTS] [-- ADDONCMDOPTS]" - ,"" - ,"Commands:" - ,bold' "DATA ENTRY: add or edit entries in the journal file" + ,bold' "ENTERING DATA (add or edit transactions, updating the journal file)" ," add add transactions using terminal prompts" ,"+edit edit a subset of transactions" ,"+iadd add transactions using a TUI" ," import add new transactions from other files, eg CSV files" ,"" -----------------------------------------80------------------------------------- - ,bold' "DATA CREATION: create or convert entries to be added to the journal file" + ,bold' "GENERATING DATA (generate entries to be added to the journal file)" ,"+autosync download/deduplicate/convert OFX data" ," close generate balance-zeroing/restoring transactions" ,"+fifo sell generate a lot-selling transaction, using FIFO" @@ -218,16 +215,17 @@ commandsList progversion othercmds highlight0 = ,"+stockquotes download market prices from AlphaVantage" ,"" -----------------------------------------80------------------------------------- - ,bold' "DATA MANAGEMENT: help validate or manage journal files" + ,bold' "MANAGING DATA (error checking, file management, version control..)" ," check check for various kinds of error in the data" ,"+check-fancyassertions check more powerful balance assertions" ,"+check-tagfiles check file paths in tag values exist" ," diff compare account transactions in two journal files" - ,"+git record/status/log journal changes easily with git" - ,"+pijul record/status/log journal changes easily with pijul" + ," files show data files in use" + ,"+git simple version management with git" + ,"+pijul simple version management with pijul" ,"" -----------------------------------------80------------------------------------- - ,bold' "REPORTS, FINANCIAL: standard financial reports" + ,bold' "FINANCIAL REPORTS (standard financial statements)" ," aregister (areg) show transactions in a particular account" ," balancesheet (bs) show assets, liabilities and net worth" ," balancesheetequity (bse) show assets, liabilities and equity" @@ -235,7 +233,8 @@ commandsList progversion othercmds highlight0 = ," incomestatement (is) show revenues and expenses" ,"" -----------------------------------------80------------------------------------- - ,bold' "REPORTS, VERSATILE: more complex/versatile reporting commands" + ,bold' "VERSATILE REPORTS (more complex/versatile reporting commands)" + ," activity show bar charts of posting counts per period" ," balance (bal) show balance changes, end balances, budgets, gains.." ,"+fifo lots show a commodity's remaining lots, using FIFO" ,"+plot create charts from balance reports, in terminal or GUI" @@ -244,36 +243,34 @@ commandsList progversion othercmds highlight0 = ," roi show return on investments" ,"" -----------------------------------------80------------------------------------- - ,bold' "REPORTS, BASIC: simple reports" + ,bold' "BASIC REPORTS (lists and stats)" ," accounts show account names" - ," activity show bar charts of posting counts per period" ," codes show transaction codes" ," commodities show commodity/currency symbols" - ," descriptions show transaction descriptions" - ," files show input file paths" - ," notes show note parts of transaction descriptions" - ," payees show payee parts of transaction descriptions" - ," prices show market prices" + ," descriptions show full transaction descriptions (payee and note)" + ," notes show note part of transaction descriptions" + ," payees show payee names" + ," prices show historical market prices" ," stats show journal statistics" ," tags show tag names" ," test run self tests" ,"" -----------------------------------------80------------------------------------- - ,bold' "UIS: other user interfaces" + ,bold' "UIS (other user interfaces)" ,"+ui run terminal UI" ,"+web run web UI" ,"" -----------------------------------------80------------------------------------- - ,bold' "HELP: command-line help and more docs" + ,bold' "HELP (show help and docs)" ," hledger show this commands list" - ," hledger -h show hledger's general help" - ," hledger COMMAND -h show COMMAND's help" - ," hledger help [-i|-m|-p] [TOPIC] show the hledger manual with info/man/pager" - ," hledger demo [NUM|NAME|STR] [ASOPTS] show small demos of hledger" + ," hledger -h show hledger's command-line help" + ," hledger CMD -h show CMD's command-line help and manual" + ," hledger help [-i|-m|-p] [TOPIC] show hledger's manual with info, man, or pager" + ," hledger demo [DEMO] -- [ASCOPTS] show brief demos on various topics" ," https://hledger.org html manuals, tutorials, support.." ,"" -----------------------------------------80------------------------------------- - ,bold' "OTHER: other hledger-* addon commands found in PATH" + ,bold' "OTHER (more hledger-* addon commands found in PATH)" ] ++ multicol 80 (map (highlightAddon . (' ':) . drop 1) othercmds) ++ [""]