diff --git a/doc/tldr/hledger-aregister.md b/doc/tldr/hledger-aregister.md index 80a97975f..5464b63db 100644 --- a/doc/tldr/hledger-aregister.md +++ b/doc/tldr/hledger-aregister.md @@ -1,6 +1,7 @@ # hledger aregister -> Show the transactions and running balances in one account. +> Show the transactions and running balances in one account, +> with each transaction on one line. > More information: . - Show transactions and running balance in the `assets:bank:checking` account: diff --git a/doc/tldr/hledger-balancesheet.md b/doc/tldr/hledger-balancesheet.md index c3769b6e5..2d20a634b 100644 --- a/doc/tldr/hledger-balancesheet.md +++ b/doc/tldr/hledger-balancesheet.md @@ -1,6 +1,7 @@ # hledger balancesheet > Show the end balances in asset and liability accounts. +> Amounts are shown with normal positive sign, as in conventional financial statements. > More information: . - Show the current balances in `Asset` and `Liability` accounts, excluding zeros: diff --git a/doc/tldr/hledger-incomestatement.md b/doc/tldr/hledger-incomestatement.md index f6af0a043..e1d159b35 100644 --- a/doc/tldr/hledger-incomestatement.md +++ b/doc/tldr/hledger-incomestatement.md @@ -1,6 +1,7 @@ # hledger incomestatement > Show revenue inflows and expense outflows during the report period. +> Amounts are shown with normal positive sign, as in conventional financial statements. > More information: . - Show revenues and expenses (changes in `Revenue` and `Expense` accounts): diff --git a/doc/tldr/hledger-ui.md b/doc/tldr/hledger-ui.md index bd2a7f5ae..23bdce3de 100644 --- a/doc/tldr/hledger-ui.md +++ b/doc/tldr/hledger-ui.md @@ -1,7 +1,6 @@ # hledger-ui -> Terminal UI (TUI) to `hledger`. -> A robust, friendly plain text accounting app. +> A terminal interface (TUI) for `hledger`, a robust, friendly plain text accounting app. > More information: . - Start in the main menu screen, reading from the default journal file: diff --git a/doc/tldr/hledger-web.md b/doc/tldr/hledger-web.md index 76f1c1063..eb20e0425 100644 --- a/doc/tldr/hledger-web.md +++ b/doc/tldr/hledger-web.md @@ -1,7 +1,6 @@ # hledger-web -> Web interface and API to `hledger`. -> A robust, friendly plain text accounting app. +> A web interface and API for `hledger`, a robust, friendly plain text accounting app. > More information: . - Start the web app, and a browser if possible, for local viewing and adding only: diff --git a/doc/tldr/hledger.md b/doc/tldr/hledger.md index 585c84f19..db1bbf0d0 100644 --- a/doc/tldr/hledger.md +++ b/doc/tldr/hledger.md @@ -1,6 +1,6 @@ # hledger -> A robust, friendly plain text accounting app. +> A robust, friendly plain text accounting app (command line version). > See also: `hledger-ui` for TUI, `hledger-web` for web interface. > More information: . diff --git a/hledger-ui/hledger-ui.m4.md b/hledger-ui/hledger-ui.m4.md index 34dadff49..dbdf170d5 100644 --- a/hledger-ui/hledger-ui.m4.md +++ b/hledger-ui/hledger-ui.m4.md @@ -6,7 +6,7 @@ _notinfo_({{ # NAME }}) -hledger-ui - robust, friendly plain text accounting (TUI version) +hledger-ui - terminal interface (TUI) for `hledger`, a robust, friendly plain text accounting app. _notinfo_({{ # SYNOPSIS diff --git a/hledger-web/hledger-web.m4.md b/hledger-web/hledger-web.m4.md index 78a341ddb..767730083 100644 --- a/hledger-web/hledger-web.m4.md +++ b/hledger-web/hledger-web.m4.md @@ -6,7 +6,7 @@ _notinfo_({{ # NAME }}) -hledger-web - robust, friendly plain text accounting (Web version) +hledger-web - web interface and API for `hledger`, a robust, friendly plain text accounting app. _notinfo_({{ # SYNOPSIS diff --git a/hledger/Hledger/Cli/Commands/Accounts.md b/hledger/Hledger/Cli/Commands/Accounts.md index 470bfb213..287ba4109 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.md +++ b/hledger/Hledger/Cli/Commands/Accounts.md @@ -1,6 +1,6 @@ ## accounts -Show account names. +List account names. _FLAGS diff --git a/hledger/Hledger/Cli/Commands/Add.md b/hledger/Hledger/Cli/Commands/Add.md index 13129fa49..8f81775c3 100644 --- a/hledger/Hledger/Cli/Commands/Add.md +++ b/hledger/Hledger/Cli/Commands/Add.md @@ -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.md b/hledger/Hledger/Cli/Commands/Aregister.md index 4e1fd00e7..2cb9e54e1 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.md +++ b/hledger/Hledger/Cli/Commands/Aregister.md @@ -2,8 +2,8 @@ (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.md b/hledger/Hledger/Cli/Commands/Balance.md index 1b6539439..ef13e20e5 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -2,7 +2,8 @@ (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.md b/hledger/Hledger/Cli/Commands/Balancesheet.md index d4eb4ad5c..0227b13ad 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.md +++ b/hledger/Hledger/Cli/Commands/Balancesheet.md @@ -2,15 +2,16 @@ (bs) -This command displays a [balance sheet](https://en.wikipedia.org/wiki/Balance_sheet), -showing historical ending balances of asset and liability accounts. -(To see equity as well, use the [balancesheetequity](#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 +This command displays a [balance sheet](https://en.wikipedia.org/wiki/Balance_sheet), +showing historical ending balances of asset and liability accounts. +(To see equity as well, use the [balancesheetequity](#balancesheetequity) command.) + +Accounts declared with the `Asset`, `Cash` or `Liability` type are shown (see [account types](https://hledger.org/hledger.html#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. diff --git a/hledger/Hledger/Cli/Commands/Import.md b/hledger/Hledger/Cli/Commands/Import.md index dbc0571b9..d7893d1e1 100644 --- a/hledger/Hledger/Cli/Commands/Import.md +++ b/hledger/Hledger/Cli/Commands/Import.md @@ -1,25 +1,26 @@ ## 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. + +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. -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`. Note you can import from any file format, though CSV files are the most 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.md b/hledger/Hledger/Cli/Commands/Incomestatement.md index 33f56a996..37ab30309 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.md +++ b/hledger/Hledger/Cli/Commands/Incomestatement.md @@ -2,15 +2,15 @@ (is) -This command displays an -[income statement](http://en.wikipedia.org/wiki/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 +This command displays an [income statement](http://en.wikipedia.org/wiki/Income_statement), +showing revenues and expenses during one or more periods. + +It shows accounts declared with the `Revenue` or `Expense` type (see [account types](https://hledger.org/hledger.html#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. diff --git a/hledger/Hledger/Cli/Commands/Print.md b/hledger/Hledger/Cli/Commands/Print.md index bebf8e6a0..5f3dfd9c2 100644 --- a/hledger/Hledger/Cli/Commands/Print.md +++ b/hledger/Hledger/Cli/Commands/Print.md @@ -1,6 +1,6 @@ ## print -Show transaction journal entries, sorted by date. +Show full journal entries, representing transactions. _FLAGS diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index c2d1a000d..30a97ac27 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -8,7 +8,7 @@ _notinfo_({{ # NAME }}) -hledger - robust, friendly plain text accounting (CLI version) +hledger - a robust, friendly plain text accounting app (command line version). _notinfo_({{ # SYNOPSIS