mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-20 18:58:23 +03:00
;doc: sync command summaries between manuals and tldr, updating both
This commit is contained in:
parent
85cf808183
commit
d47513c669
@ -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: <https://hledger.org/hledger.html#aregister>.
|
||||
|
||||
- Show transactions and running balance in the `assets:bank:checking` account:
|
||||
|
@ -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: <https://hledger.org/hledger.html#balancesheet>.
|
||||
|
||||
- Show the current balances in `Asset` and `Liability` accounts, excluding zeros:
|
||||
|
@ -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: <https://hledger.org/hledger.html#incomestatement>.
|
||||
|
||||
- Show revenues and expenses (changes in `Revenue` and `Expense` accounts):
|
||||
|
@ -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: <https://hledger.org/hledger-ui.html>.
|
||||
|
||||
- Start in the main menu screen, reading from the default journal file:
|
||||
|
@ -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: <https://hledger.org/hledger-web.html>.
|
||||
|
||||
- Start the web app, and a browser if possible, for local viewing and adding only:
|
||||
|
@ -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: <https://hledger.org/hledger.html>.
|
||||
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -1,6 +1,6 @@
|
||||
## accounts
|
||||
|
||||
Show account names.
|
||||
List account names.
|
||||
|
||||
_FLAGS
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
||||
|
@ -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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## print
|
||||
|
||||
Show transaction journal entries, sorted by date.
|
||||
Show full journal entries, representing transactions.
|
||||
|
||||
_FLAGS
|
||||
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user