From 77ee3fd846cbedcceb9838a0c3855267855669e4 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 29 May 2024 17:02:03 -1000 Subject: [PATCH] ;doc: update command help --- hledger/Hledger/Cli/Commands/Accounts.txt | 2 +- hledger/Hledger/Cli/Commands/Add.txt | 3 +- hledger/Hledger/Cli/Commands/Aregister.txt | 4 +-- hledger/Hledger/Cli/Commands/Balance.txt | 4 ++- hledger/Hledger/Cli/Commands/Balancesheet.txt | 18 ++++++----- hledger/Hledger/Cli/Commands/Import.txt | 30 ++++++++++--------- .../Hledger/Cli/Commands/Incomestatement.txt | 17 ++++++----- hledger/Hledger/Cli/Commands/Print.txt | 2 +- 8 files changed, 44 insertions(+), 36 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Accounts.txt b/hledger/Hledger/Cli/Commands/Accounts.txt index 419ed688f..9b624cd21 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.txt +++ b/hledger/Hledger/Cli/Commands/Accounts.txt @@ -1,6 +1,6 @@ accounts -Show account names. +List account names. _FLAGS diff --git a/hledger/Hledger/Cli/Commands/Add.txt b/hledger/Hledger/Cli/Commands/Add.txt index b4e778c3e..f3062a883 100644 --- a/hledger/Hledger/Cli/Commands/Add.txt +++ b/hledger/Hledger/Cli/Commands/Add.txt @@ -1,7 +1,6 @@ add -Prompt for transactions and add them to the journal. Any arguments will -be used as default inputs for the first N prompts. +Record new transactions with interactive prompting in the console. _FLAGS diff --git a/hledger/Hledger/Cli/Commands/Aregister.txt b/hledger/Hledger/Cli/Commands/Aregister.txt index 8ee68b384..3fa8d674b 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.txt +++ b/hledger/Hledger/Cli/Commands/Aregister.txt @@ -2,8 +2,8 @@ aregister (areg) -Show the transactions and running historical balance of a single -account, with each transaction displayed as one line. +Show the transactions and running balances in one account, with each +transaction on one line. _FLAGS diff --git a/hledger/Hledger/Cli/Commands/Balance.txt b/hledger/Hledger/Cli/Commands/Balance.txt index 3cc454c11..d4251d7d8 100644 --- a/hledger/Hledger/Cli/Commands/Balance.txt +++ b/hledger/Hledger/Cli/Commands/Balance.txt @@ -2,7 +2,9 @@ balance (bal) -Show accounts and their balances. +A flexible, general purpose "summing" report that shows accounts with +some kind of numeric data. This can be balance changes per period, end +balances, budget performance, unrealised capital gains, etc. _FLAGS diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.txt b/hledger/Hledger/Cli/Commands/Balancesheet.txt index f6b590811..1bacfc7df 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.txt +++ b/hledger/Hledger/Cli/Commands/Balancesheet.txt @@ -2,17 +2,19 @@ balancesheet (bs) -This command displays a balance sheet, showing historical ending -balances of asset and liability accounts. (To see equity as well, use -the balancesheetequity command.) Amounts are shown with normal positive -sign, as in conventional financial statements. +Show the end balances in asset and liability accounts. Amounts are shown +with normal positive sign, as in conventional financial statements. _FLAGS -This report shows accounts declared with the Asset, Cash or Liability -type (see account types). Or if no such accounts are declared, it shows -top-level accounts named asset or liability (case insensitive, plurals -allowed) and their subaccounts. +This command displays a balance sheet, showing historical ending +balances of asset and liability accounts. (To see equity as well, use +the balancesheetequity command.) + +Accounts declared with the Asset, Cash or Liability type are shown (see +account types). Or if no such accounts are declared, it shows top-level +accounts named asset or liability (case insensitive, plurals allowed) +and their subaccounts. Example: diff --git a/hledger/Hledger/Cli/Commands/Import.txt b/hledger/Hledger/Cli/Commands/Import.txt index 7636c2014..773b95def 100644 --- a/hledger/Hledger/Cli/Commands/Import.txt +++ b/hledger/Hledger/Cli/Commands/Import.txt @@ -1,25 +1,27 @@ import -Read new transactions added to each FILE provided as arguments since -last run, and add them to the journal. Or with --dry-run, just print the -transactions that would be added. Or with --catchup, just mark all of -the FILEs' current transactions as imported, without importing them. +Import new transactions from one or more data files to the main journal. _FLAGS -This command may append new transactions to the main journal file (which -should be in journal format). Existing transactions are not changed. -This is one of the few hledger commands that writes to the journal file -(see also add). +This command detects new transactions in each FILE argument since it was +last run, and appends them to the main journal. -Unlike other hledger commands, with import the journal file is an output -file, and will be modified, though only by appending (existing data will -not be changed). The input files are specified as arguments, so to -import one or more CSV files to your main journal, you will run -hledger import bank.csv or perhaps hledger import *.csv. +Or with --dry-run, it just print the transactions that would be added. + +Or with --catchup, it just marks all of the FILEs' current transactions +as already imported. + +This is one of the few hledger commands that writes to the journal file +(see also add). It only appends; existing data will not be changed. + +The input files are specified as arguments, so to import one or more CSV +files to your main journal, you will run hledger import bank.csv or +perhaps hledger import *.csv. Note you can import from any file format, though CSV files are the most -common import source, and these docs focus on that case. +common import source, and these docs focus on that case. The target file +(main journal) should be in journal format. Date skipping diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.txt b/hledger/Hledger/Cli/Commands/Incomestatement.txt index 1c661cea8..568312b90 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.txt +++ b/hledger/Hledger/Cli/Commands/Incomestatement.txt @@ -2,16 +2,19 @@ incomestatement (is) -This command displays an income statement, showing revenues and expenses -during one or more periods. Amounts are shown with normal positive sign, -as in conventional financial statements. +Show revenue inflows and expense outflows during the report period. +Amounts are shown with normal positive sign, as in conventional +financial statements. _FLAGS -This report shows accounts declared with the Revenue or Expense type -(see account types). Or if no such accounts are declared, it shows -top-level accounts named revenue or income or expense (case insensitive, -plurals allowed) and their subaccounts. +This command displays an income statement, showing revenues and expenses +during one or more periods. + +It shows accounts declared with the Revenue or Expense type (see account +types). Or if no such accounts are declared, it shows top-level accounts +named revenue or income or expense (case insensitive, plurals allowed) +and their subaccounts. Example: diff --git a/hledger/Hledger/Cli/Commands/Print.txt b/hledger/Hledger/Cli/Commands/Print.txt index d0e94d7c6..aeeba7dfd 100644 --- a/hledger/Hledger/Cli/Commands/Print.txt +++ b/hledger/Hledger/Cli/Commands/Print.txt @@ -1,6 +1,6 @@ print -Show transaction journal entries, sorted by date. +Show full journal entries, representing transactions. _FLAGS