diff --git a/doc/common.m4 b/doc/common.m4 index 79923f704..c1a1ff5f5 100644 --- a/doc/common.m4 +++ b/doc/common.m4 @@ -209,7 +209,9 @@ The journal file path when not specified with `-f`. Default: `~/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`). }} )m4_dnl m4_dnl -m4_dnl Dummy macro to strip $FLAGS$ marker in command docs. -m4_dnl Not using underscore here, because latest pandoc strips those. -m4_define({{$FLAGS$}}, {{}})m4_dnl +m4_dnl The _FLAGS marker is used in generating command help (see +m4_dnl CliOptions.parseCommandDoc), but should be removed when generating manuals. +m4_dnl Just one underscore here, so pandoc doesn't strip them +m4_dnl ($FLAGS$ and =FLAGS= didn't work, not sure why). +m4_define({{_FLAGS}}, {{}})m4_dnl m4_dnl diff --git a/hledger/Hledger/Cli/CliOptions.hs b/hledger/Hledger/Cli/CliOptions.hs index b3df4d603..4fed02a1b 100644 --- a/hledger/Hledger/Cli/CliOptions.hs +++ b/hledger/Hledger/Cli/CliOptions.hs @@ -303,9 +303,9 @@ hledgerCommandMode doc unnamedflaggroup namedflaggroups hiddenflaggroup argsdesc -- -- - First line: the command name then any aliases, as one or more space or comma-separated words -- --- - Second line to a line containing just $FLAGS$, or the end: the short help +-- - Second line to a line containing just _FLAGS, or the end: the short help -- --- - Any lines after $FLAGS$: the long help (split into lines for cmdargs) +-- - Any lines after _FLAGS: the long help (split into lines for cmdargs) -- -- The CLI help displays the short help, then the cmdargs-generated -- flags list, then the long help (which some day we might make @@ -319,7 +319,7 @@ parseCommandDoc t = (l:ls) -> Just (names, shorthelp, longhelplines) where names = words $ map (\c -> if c `elem` [',','\\'] then ' ' else c) l - (shorthelpls, longhelpls) = break (== "$FLAGS$") ls + (shorthelpls, longhelpls) = break (== "_FLAGS") ls shorthelp = unlines $ reverse $ dropWhile null $ reverse shorthelpls longhelplines = dropWhile null $ drop 1 longhelpls diff --git a/hledger/Hledger/Cli/Commands/Accounts.md b/hledger/Hledger/Cli/Commands/Accounts.md index b39539ae3..24d4129f2 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.md +++ b/hledger/Hledger/Cli/Commands/Accounts.md @@ -1,7 +1,7 @@ accounts, a\ Show account names. -$FLAGS$ +_FLAGS This command lists account names, either declared with account directives (--declared), posted to (--used), or both (the default). diff --git a/hledger/Hledger/Cli/Commands/Accounts.txt b/hledger/Hledger/Cli/Commands/Accounts.txt index 1a3274499..a2d859d4a 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.txt +++ b/hledger/Hledger/Cli/Commands/Accounts.txt @@ -1,7 +1,7 @@ accounts, a Show account names. -$FLAGS$ +_FLAGS This command lists account names, either declared with account directives (--declared), posted to (--used), or both (the default). With diff --git a/hledger/Hledger/Cli/Commands/Activity.md b/hledger/Hledger/Cli/Commands/Activity.md index bc1be6e6a..b8289a914 100644 --- a/hledger/Hledger/Cli/Commands/Activity.md +++ b/hledger/Hledger/Cli/Commands/Activity.md @@ -1,7 +1,7 @@ activity\ Show an ascii barchart of posting counts per interval. -$FLAGS$ +_FLAGS The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the diff --git a/hledger/Hledger/Cli/Commands/Activity.txt b/hledger/Hledger/Cli/Commands/Activity.txt index 9e2b7adfe..9926d7c42 100644 --- a/hledger/Hledger/Cli/Commands/Activity.txt +++ b/hledger/Hledger/Cli/Commands/Activity.txt @@ -1,7 +1,7 @@ activity Show an ascii barchart of posting counts per interval. -$FLAGS$ +_FLAGS The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the diff --git a/hledger/Hledger/Cli/Commands/Add.md b/hledger/Hledger/Cli/Commands/Add.md index 0beb7d15e..c337d746f 100644 --- a/hledger/Hledger/Cli/Commands/Add.md +++ b/hledger/Hledger/Cli/Commands/Add.md @@ -1,7 +1,7 @@ add\ Prompt for transactions and add them to the journal. -$FLAGS$ +_FLAGS Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the `add` command, diff --git a/hledger/Hledger/Cli/Commands/Add.txt b/hledger/Hledger/Cli/Commands/Add.txt index d43d38e40..c1aaaf883 100644 --- a/hledger/Hledger/Cli/Commands/Add.txt +++ b/hledger/Hledger/Cli/Commands/Add.txt @@ -1,7 +1,7 @@ add Prompt for transactions and add them to the journal. -$FLAGS$ +_FLAGS Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the diff --git a/hledger/Hledger/Cli/Commands/Balance.md b/hledger/Hledger/Cli/Commands/Balance.md index 0c227ae01..e8b7f438c 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -1,7 +1,7 @@ balance, bal, b\ Show accounts and their balances. -$FLAGS$ +_FLAGS The balance command is hledger's most versatile command. Note, despite the name, it is not always used for showing real-world account balances; diff --git a/hledger/Hledger/Cli/Commands/Balance.txt b/hledger/Hledger/Cli/Commands/Balance.txt index 933b69905..3803bebd9 100644 --- a/hledger/Hledger/Cli/Commands/Balance.txt +++ b/hledger/Hledger/Cli/Commands/Balance.txt @@ -1,7 +1,7 @@ balance, bal, b Show accounts and their balances. -$FLAGS$ +_FLAGS The balance command is hledger's most versatile command. Note, despite the name, it is not always used for showing real-world account balances; diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.md b/hledger/Hledger/Cli/Commands/Balancesheet.md index 517232b8b..f9064021b 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.md +++ b/hledger/Hledger/Cli/Commands/Balancesheet.md @@ -8,7 +8,7 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.txt b/hledger/Hledger/Cli/Commands/Balancesheet.txt index 6c72a7755..9d7557edd 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.txt +++ b/hledger/Hledger/Cli/Commands/Balancesheet.txt @@ -8,7 +8,7 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/Balancesheetequity.md b/hledger/Hledger/Cli/Commands/Balancesheetequity.md index 172459ada..81d359b69 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheetequity.md +++ b/hledger/Hledger/Cli/Commands/Balancesheetequity.md @@ -2,7 +2,7 @@ balancesheetequity, bse\ Just like [balancesheet](#balancesheet), but also reports Equity (which it assumes is under a top-level `equity` account). -$FLAGS$ +_FLAGS Example: ```shell diff --git a/hledger/Hledger/Cli/Commands/Balancesheetequity.txt b/hledger/Hledger/Cli/Commands/Balancesheetequity.txt index 3f8ca1cec..ae8418c06 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheetequity.txt +++ b/hledger/Hledger/Cli/Commands/Balancesheetequity.txt @@ -2,7 +2,7 @@ balancesheetequity, bse Just like balancesheet, but also reports Equity (which it assumes is under a top-level equity account). -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/Cashflow.md b/hledger/Hledger/Cli/Commands/Cashflow.md index aef08263c..566f5613a 100644 --- a/hledger/Hledger/Cli/Commands/Cashflow.md +++ b/hledger/Hledger/Cli/Commands/Cashflow.md @@ -7,7 +7,7 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS Example: ```shell diff --git a/hledger/Hledger/Cli/Commands/Cashflow.txt b/hledger/Hledger/Cli/Commands/Cashflow.txt index 0d9e8422b..773cc409c 100644 --- a/hledger/Hledger/Cli/Commands/Cashflow.txt +++ b/hledger/Hledger/Cli/Commands/Cashflow.txt @@ -6,7 +6,7 @@ contain receivable or A/R in their name. Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/Checkdates.md b/hledger/Hledger/Cli/Commands/Checkdates.md index 8fa8ce25a..9eff491ad 100644 --- a/hledger/Hledger/Cli/Commands/Checkdates.md +++ b/hledger/Hledger/Cli/Commands/Checkdates.md @@ -5,4 +5,4 @@ With --strict, dates must also be unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Checkdates.txt b/hledger/Hledger/Cli/Commands/Checkdates.txt index 85dfcda49..cb74a343d 100644 --- a/hledger/Hledger/Cli/Commands/Checkdates.txt +++ b/hledger/Hledger/Cli/Commands/Checkdates.txt @@ -4,4 +4,4 @@ checks secondary dates instead. With --strict, dates must also be unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Checkdupes.md b/hledger/Hledger/Cli/Commands/Checkdupes.md index 4f1ae5860..5683b099c 100644 --- a/hledger/Hledger/Cli/Commands/Checkdupes.md +++ b/hledger/Hledger/Cli/Commands/Checkdupes.md @@ -3,6 +3,6 @@ Reports account names having the same leaf but different prefixes. In other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. -$FLAGS$ +_FLAGS An example: http://stefanorodighiero.net/software/hledger-dupes.html diff --git a/hledger/Hledger/Cli/Commands/Checkdupes.txt b/hledger/Hledger/Cli/Commands/Checkdupes.txt index cba589e82..3ed4af0a2 100644 --- a/hledger/Hledger/Cli/Commands/Checkdupes.txt +++ b/hledger/Hledger/Cli/Commands/Checkdupes.txt @@ -3,6 +3,6 @@ Reports account names having the same leaf but different prefixes. In other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. -$FLAGS$ +_FLAGS An example: http://stefanorodighiero.net/software/hledger-dupes.html diff --git a/hledger/Hledger/Cli/Commands/Close.md b/hledger/Hledger/Cli/Commands/Close.md index 26e7c9471..765117089 100644 --- a/hledger/Hledger/Cli/Commands/Close.md +++ b/hledger/Hledger/Cli/Commands/Close.md @@ -5,7 +5,7 @@ Useful for bringing asset/liability balances forward into a new journal file, or for closing out revenues/expenses to retained earnings at the end of a period. -$FLAGS$ +_FLAGS The closing transaction transfers balances to "equity:closing balances", and the opening transaction transfers balances from "equity:opening balances", diff --git a/hledger/Hledger/Cli/Commands/Close.txt b/hledger/Hledger/Cli/Commands/Close.txt index 325c22570..229580d7a 100644 --- a/hledger/Hledger/Cli/Commands/Close.txt +++ b/hledger/Hledger/Cli/Commands/Close.txt @@ -5,7 +5,7 @@ Useful for bringing asset/liability balances forward into a new journal file, or for closing out revenues/expenses to retained earnings at the end of a period. -$FLAGS$ +_FLAGS The closing transaction transfers balances to "equity:closing balances", and the opening transaction transfers balances from "equity:opening diff --git a/hledger/Hledger/Cli/Commands/Commodities.md b/hledger/Hledger/Cli/Commands/Commodities.md index ddd9ea2c1..c09581712 100644 --- a/hledger/Hledger/Cli/Commands/Commodities.md +++ b/hledger/Hledger/Cli/Commands/Commodities.md @@ -1,4 +1,4 @@ commodities\ List all commodity/currency symbols used or declared in the journal. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Commodities.txt b/hledger/Hledger/Cli/Commands/Commodities.txt index b38b566fa..ac94166a1 100644 --- a/hledger/Hledger/Cli/Commands/Commodities.txt +++ b/hledger/Hledger/Cli/Commands/Commodities.txt @@ -1,4 +1,4 @@ commodities List all commodity/currency symbols used or declared in the journal. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Descriptions.md b/hledger/Hledger/Cli/Commands/Descriptions.md index daa6d466f..93a3aa7e8 100644 --- a/hledger/Hledger/Cli/Commands/Descriptions.md +++ b/hledger/Hledger/Cli/Commands/Descriptions.md @@ -1,7 +1,7 @@ descriptions Show descriptions. -$FLAGS$ +_FLAGS This command lists all descriptions that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Descriptions.txt b/hledger/Hledger/Cli/Commands/Descriptions.txt index 8bf4447e2..3f379372f 100644 --- a/hledger/Hledger/Cli/Commands/Descriptions.txt +++ b/hledger/Hledger/Cli/Commands/Descriptions.txt @@ -1,6 +1,6 @@ descriptions Show descriptions. -$FLAGS$ +_FLAGS This command lists all descriptions that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Diff.md b/hledger/Hledger/Cli/Commands/Diff.md index 3147bd500..1d38def8a 100644 --- a/hledger/Hledger/Cli/Commands/Diff.md +++ b/hledger/Hledger/Cli/Commands/Diff.md @@ -15,7 +15,7 @@ from your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. -$FLAGS$ +_FLAGS Examples: diff --git a/hledger/Hledger/Cli/Commands/Diff.txt b/hledger/Hledger/Cli/Commands/Diff.txt index 48cd771fb..bd9432ff4 100644 --- a/hledger/Hledger/Cli/Commands/Diff.txt +++ b/hledger/Hledger/Cli/Commands/Diff.txt @@ -14,7 +14,7 @@ your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. -$FLAGS$ +_FLAGS Examples: diff --git a/hledger/Hledger/Cli/Commands/Files.md b/hledger/Hledger/Cli/Commands/Files.md index e19be698b..57508bcb0 100644 --- a/hledger/Hledger/Cli/Commands/Files.md +++ b/hledger/Hledger/Cli/Commands/Files.md @@ -2,4 +2,4 @@ files\ List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Files.txt b/hledger/Hledger/Cli/Commands/Files.txt index 6a056092f..c842e986a 100644 --- a/hledger/Hledger/Cli/Commands/Files.txt +++ b/hledger/Hledger/Cli/Commands/Files.txt @@ -2,4 +2,4 @@ files List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Help.md b/hledger/Hledger/Cli/Commands/Help.md index f90e166d6..92a08cdfb 100644 --- a/hledger/Hledger/Cli/Commands/Help.md +++ b/hledger/Hledger/Cli/Commands/Help.md @@ -1,7 +1,7 @@ help\ Show any of the hledger manuals. -$FLAGS$ +_FLAGS The `help` command displays any of the main [hledger manuals](/docs.html), in one of several ways. Run it with no argument to list the manuals, or provide a full or partial manual name to select one. diff --git a/hledger/Hledger/Cli/Commands/Help.txt b/hledger/Hledger/Cli/Commands/Help.txt index 44f734545..3ff58d6d4 100644 --- a/hledger/Hledger/Cli/Commands/Help.txt +++ b/hledger/Hledger/Cli/Commands/Help.txt @@ -1,7 +1,7 @@ help Show any of the hledger manuals. -$FLAGS$ +_FLAGS The help command displays any of the main hledger manuals, in one of several ways. Run it with no argument to list the manuals, or provide a diff --git a/hledger/Hledger/Cli/Commands/Import.md b/hledger/Hledger/Cli/Commands/Import.md index cac53dfb2..56572405d 100644 --- a/hledger/Hledger/Cli/Commands/Import.md +++ b/hledger/Hledger/Cli/Commands/Import.md @@ -4,7 +4,7 @@ the main journal file. Or with --dry-run, just print the transactions that would be added. Or with --catchup, just mark all of the FILEs' transactions as imported, without actually importing any. -$FLAGS$ +_FLAGS The input files are specified as arguments - no need to write -f before each one. So eg to add new transactions from all CSV files to the main journal, it's just: diff --git a/hledger/Hledger/Cli/Commands/Import.txt b/hledger/Hledger/Cli/Commands/Import.txt index 369ce44f0..172d101ec 100644 --- a/hledger/Hledger/Cli/Commands/Import.txt +++ b/hledger/Hledger/Cli/Commands/Import.txt @@ -4,7 +4,7 @@ the main journal file. Or with --dry-run, just print the transactions that would be added. Or with --catchup, just mark all of the FILEs' transactions as imported, without actually importing any. -$FLAGS$ +_FLAGS The input files are specified as arguments - no need to write -f before each one. So eg to add new transactions from all CSV files to the main diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.md b/hledger/Hledger/Cli/Commands/Incomestatement.md index 61a10c954..79c560c1d 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.md +++ b/hledger/Hledger/Cli/Commands/Incomestatement.md @@ -7,7 +7,7 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS This command displays a simple [income statement](http://en.wikipedia.org/wiki/Income_statement). It diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.txt b/hledger/Hledger/Cli/Commands/Incomestatement.txt index 95776623e..41a546cd1 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.txt +++ b/hledger/Hledger/Cli/Commands/Incomestatement.txt @@ -6,7 +6,7 @@ forms also allowed). Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). -$FLAGS$ +_FLAGS This command displays a simple income statement. It currently assumes that you have top-level accounts named income (or revenue) and expense diff --git a/hledger/Hledger/Cli/Commands/Notes.md b/hledger/Hledger/Cli/Commands/Notes.md index 39fe97a3a..11155c0a4 100644 --- a/hledger/Hledger/Cli/Commands/Notes.md +++ b/hledger/Hledger/Cli/Commands/Notes.md @@ -1,7 +1,7 @@ notes Show notes. -$FLAGS$ +_FLAGS This command lists all notes that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Notes.txt b/hledger/Hledger/Cli/Commands/Notes.txt index 9c1a2d30a..b34c52303 100644 --- a/hledger/Hledger/Cli/Commands/Notes.txt +++ b/hledger/Hledger/Cli/Commands/Notes.txt @@ -1,6 +1,6 @@ notes Show notes. -$FLAGS$ +_FLAGS This command lists all notes that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Payees.md b/hledger/Hledger/Cli/Commands/Payees.md index 7d2985b0f..db88557c8 100644 --- a/hledger/Hledger/Cli/Commands/Payees.md +++ b/hledger/Hledger/Cli/Commands/Payees.md @@ -1,7 +1,7 @@ payees Show payee names. -$FLAGS$ +_FLAGS This command lists all payee names that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Payees.txt b/hledger/Hledger/Cli/Commands/Payees.txt index 4818deb8c..7fea382d2 100644 --- a/hledger/Hledger/Cli/Commands/Payees.txt +++ b/hledger/Hledger/Cli/Commands/Payees.txt @@ -1,6 +1,6 @@ payees Show payee names. -$FLAGS$ +_FLAGS This command lists all payee names that appear in transactions. diff --git a/hledger/Hledger/Cli/Commands/Prices.md b/hledger/Hledger/Cli/Commands/Prices.md index 0d219a833..a23a6f82d 100644 --- a/hledger/Hledger/Cli/Commands/Prices.md +++ b/hledger/Hledger/Cli/Commands/Prices.md @@ -5,4 +5,4 @@ With --inverted-costs, also print inverse prices based on transaction prices. Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Prices.txt b/hledger/Hledger/Cli/Commands/Prices.txt index 331665189..632c57f36 100644 --- a/hledger/Hledger/Cli/Commands/Prices.txt +++ b/hledger/Hledger/Cli/Commands/Prices.txt @@ -5,4 +5,4 @@ synthetic market prices based on transaction prices. With Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Print.md b/hledger/Hledger/Cli/Commands/Print.md index ca634f605..c2d2017fe 100644 --- a/hledger/Hledger/Cli/Commands/Print.md +++ b/hledger/Hledger/Cli/Commands/Print.md @@ -1,7 +1,7 @@ print, txns, p\ Show transaction journal entries, sorted by date. -$FLAGS$ +_FLAGS The print command displays full journal entries (transactions) from the journal file in date order, tidily formatted. diff --git a/hledger/Hledger/Cli/Commands/Print.txt b/hledger/Hledger/Cli/Commands/Print.txt index 7435c3585..879495c21 100644 --- a/hledger/Hledger/Cli/Commands/Print.txt +++ b/hledger/Hledger/Cli/Commands/Print.txt @@ -1,7 +1,7 @@ print, txns, p Show transaction journal entries, sorted by date. -$FLAGS$ +_FLAGS The print command displays full journal entries (transactions) from the journal file in date order, tidily formatted. With --date2, transactions diff --git a/hledger/Hledger/Cli/Commands/Printunique.md b/hledger/Hledger/Cli/Commands/Printunique.md index dd396f54c..64e5aa467 100644 --- a/hledger/Hledger/Cli/Commands/Printunique.md +++ b/hledger/Hledger/Cli/Commands/Printunique.md @@ -1,7 +1,7 @@ print-unique\ Print transactions which do not reuse an already-seen description. -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/Printunique.txt b/hledger/Hledger/Cli/Commands/Printunique.txt index 9bb4ed635..ef9d0afeb 100644 --- a/hledger/Hledger/Cli/Commands/Printunique.txt +++ b/hledger/Hledger/Cli/Commands/Printunique.txt @@ -1,7 +1,7 @@ print-unique Print transactions which do not reuse an already-seen description. -$FLAGS$ +_FLAGS Example: diff --git a/hledger/Hledger/Cli/Commands/README.md b/hledger/Hledger/Cli/Commands/README.md index e2c897c85..3989530a9 100644 --- a/hledger/Hledger/Cli/Commands/README.md +++ b/hledger/Hledger/Cli/Commands/README.md @@ -58,12 +58,12 @@ Here are more special features/conventions of command doc files (see markdown formatting though, eg to define a list. - After the short help, there should be a paragraph containing just - $FLAGS$. This marks the end of the short help, and it will be + _FLAGS. This marks the end of the short help, and it will be replaced in command line help by the flags list. (Without it, the flags list appears at the end of command line help.) The flags list will not appear in the hledger manual. -- Long help (as many paragraphs as needed) follows the $FLAGS$ marker. +- Long help (as many paragraphs as needed) follows the _FLAGS marker. This often ends with one or more examples. diff --git a/hledger/Hledger/Cli/Commands/Register.md b/hledger/Hledger/Cli/Commands/Register.md index 2156f01c5..87ed44786 100644 --- a/hledger/Hledger/Cli/Commands/Register.md +++ b/hledger/Hledger/Cli/Commands/Register.md @@ -1,7 +1,7 @@ register, reg, r\ Show postings and their running total. -$FLAGS$ +_FLAGS The register command displays postings in date order, one per line, and their running total. This is typically used with a diff --git a/hledger/Hledger/Cli/Commands/Register.txt b/hledger/Hledger/Cli/Commands/Register.txt index 81522dcaa..a9ad4f771 100644 --- a/hledger/Hledger/Cli/Commands/Register.txt +++ b/hledger/Hledger/Cli/Commands/Register.txt @@ -1,7 +1,7 @@ register, reg, r Show postings and their running total. -$FLAGS$ +_FLAGS The register command displays postings in date order, one per line, and their running total. This is typically used with a query selecting a diff --git a/hledger/Hledger/Cli/Commands/Registermatch.md b/hledger/Hledger/Cli/Commands/Registermatch.md index 5f0b23eef..e8c1e3145 100644 --- a/hledger/Hledger/Cli/Commands/Registermatch.md +++ b/hledger/Hledger/Cli/Commands/Registermatch.md @@ -5,4 +5,4 @@ If there are multiple equally good matches, it shows the most recent. Query options (options, not arguments) can be used to restrict the search space. Helps ledger-autosync detect already-seen transactions when importing. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Registermatch.txt b/hledger/Hledger/Cli/Commands/Registermatch.txt index 95d2baba1..a72db65eb 100644 --- a/hledger/Hledger/Cli/Commands/Registermatch.txt +++ b/hledger/Hledger/Cli/Commands/Registermatch.txt @@ -5,4 +5,4 @@ matches, it shows the most recent. Query options (options, not arguments) can be used to restrict the search space. Helps ledger-autosync detect already-seen transactions when importing. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Rewrite.md b/hledger/Hledger/Cli/Commands/Rewrite.md index c140fb2e7..3a1fb24a5 100644 --- a/hledger/Hledger/Cli/Commands/Rewrite.md +++ b/hledger/Hledger/Cli/Commands/Rewrite.md @@ -2,7 +2,7 @@ rewrite\ Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print --auto. -$FLAGS$ +_FLAGS This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, diff --git a/hledger/Hledger/Cli/Commands/Rewrite.txt b/hledger/Hledger/Cli/Commands/Rewrite.txt index e4a9c7cd2..03e6a6dbc 100644 --- a/hledger/Hledger/Cli/Commands/Rewrite.txt +++ b/hledger/Hledger/Cli/Commands/Rewrite.txt @@ -3,7 +3,7 @@ Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print --auto. -$FLAGS$ +_FLAGS This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, but adds diff --git a/hledger/Hledger/Cli/Commands/Roi.md b/hledger/Hledger/Cli/Commands/Roi.md index 7e7b13620..540d71dc7 100644 --- a/hledger/Hledger/Cli/Commands/Roi.md +++ b/hledger/Hledger/Cli/Commands/Roi.md @@ -2,7 +2,7 @@ roi\ Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. -$FLAGS$ +_FLAGS This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation diff --git a/hledger/Hledger/Cli/Commands/Roi.txt b/hledger/Hledger/Cli/Commands/Roi.txt index dd8150893..58e79d071 100644 --- a/hledger/Hledger/Cli/Commands/Roi.txt +++ b/hledger/Hledger/Cli/Commands/Roi.txt @@ -2,7 +2,7 @@ roi Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. -$FLAGS$ +_FLAGS This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation of these diff --git a/hledger/Hledger/Cli/Commands/Stats.md b/hledger/Hledger/Cli/Commands/Stats.md index 94d4a888d..ae44856a0 100644 --- a/hledger/Hledger/Cli/Commands/Stats.md +++ b/hledger/Hledger/Cli/Commands/Stats.md @@ -1,7 +1,7 @@ stats\ Show some journal statistics. -$FLAGS$ +_FLAGS The stats command displays summary information for the whole journal, or a matched part of it. With a [reporting interval](#reporting-interval), diff --git a/hledger/Hledger/Cli/Commands/Stats.txt b/hledger/Hledger/Cli/Commands/Stats.txt index 156bb0cc8..11e4a1cc0 100644 --- a/hledger/Hledger/Cli/Commands/Stats.txt +++ b/hledger/Hledger/Cli/Commands/Stats.txt @@ -1,7 +1,7 @@ stats Show some journal statistics. -$FLAGS$ +_FLAGS The stats command displays summary information for the whole journal, or a matched part of it. With a reporting interval, it shows a report for diff --git a/hledger/Hledger/Cli/Commands/Tags.md b/hledger/Hledger/Cli/Commands/Tags.md index 5067c174e..68cabb92c 100644 --- a/hledger/Hledger/Cli/Commands/Tags.md +++ b/hledger/Hledger/Cli/Commands/Tags.md @@ -4,4 +4,4 @@ only tag names matching the regular expression (case insensitive) are shown. With QUERY arguments, only transactions matching the query are considered. With --values flag, the tags' unique values are listed instead. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Tags.txt b/hledger/Hledger/Cli/Commands/Tags.txt index 8acc8862b..9fabb9828 100644 --- a/hledger/Hledger/Cli/Commands/Tags.txt +++ b/hledger/Hledger/Cli/Commands/Tags.txt @@ -5,4 +5,4 @@ shown. With QUERY arguments, only transactions matching the query are considered. With --values flag, the tags' unique values are listed instead. -$FLAGS$ +_FLAGS diff --git a/hledger/Hledger/Cli/Commands/Test.md b/hledger/Hledger/Cli/Commands/Test.md index 0633a0453..2709fccd6 100644 --- a/hledger/Hledger/Cli/Commands/Test.md +++ b/hledger/Hledger/Cli/Commands/Test.md @@ -1,7 +1,7 @@ test\ Run built-in unit tests. -$FLAGS$ +_FLAGS This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will diff --git a/hledger/Hledger/Cli/Commands/Test.txt b/hledger/Hledger/Cli/Commands/Test.txt index 31c380b64..5ced20f4b 100644 --- a/hledger/Hledger/Cli/Commands/Test.txt +++ b/hledger/Hledger/Cli/Commands/Test.txt @@ -1,7 +1,7 @@ test Run built-in unit tests. -$FLAGS$ +_FLAGS This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will be diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 3ae0034fa..86956795e 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1750,8 +1750,6 @@ accounts, a .PD Show account names. .PP -$FLAGS$ -.PP This command lists account names, either declared with account directives (--declared), posted to (--used), or both (the default). With query arguments, only matched account names and account names @@ -1787,8 +1785,6 @@ activity .PD Show an ascii barchart of posting counts per interval. .PP -$FLAGS$ -.PP The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the default). @@ -1813,8 +1809,6 @@ add .PD Prompt for transactions and add them to the journal. .PP -$FLAGS$ -.PP Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the \f[C]add\f[R] command, @@ -1898,8 +1892,6 @@ balance, bal, b .PD Show accounts and their balances. .PP -$FLAGS$ -.PP The balance command is hledger\[aq]s most versatile command. Note, despite the name, it is not always used for showing real-world account balances; the more accounting-aware balancesheet and @@ -2521,8 +2513,6 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). .PP -$FLAGS$ -.PP Example: .IP .nf @@ -2570,8 +2560,6 @@ balancesheetequity, bse Just like balancesheet, but also reports Equity (which it assumes is under a top-level \f[C]equity\f[R] account). .PP -$FLAGS$ -.PP Example: .IP .nf @@ -2616,8 +2604,6 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). .PP -$FLAGS$ -.PP Example: .IP .nf @@ -2659,8 +2645,6 @@ With --date2, checks secondary dates instead. With --strict, dates must also be unique. With a query, only matched transactions\[aq] dates are checked. Reads the default journal file, or another specified with -f. -.PP -$FLAGS$ .SS check-dupes .PP check-dupes @@ -2671,8 +2655,6 @@ Reports account names having the same leaf but different prefixes. In other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. .PP -$FLAGS$ -.PP An example: http://stefanorodighiero.net/software/hledger-dupes.html .SS close .PP @@ -2687,8 +2669,6 @@ Useful for bringing asset/liability balances forward into a new journal file, or for closing out revenues/expenses to retained earnings at the end of a period. .PP -$FLAGS$ -.PP The closing transaction transfers balances to \[dq]equity:closing balances\[dq], and the opening transaction transfers balances from \[dq]equity:opening balances\[dq], or you can customise these with the @@ -2794,14 +2774,10 @@ commodities .P .PD List all commodity/currency symbols used or declared in the journal. -.PP -$FLAGS$ .SS descriptions .PP descriptions Show descriptions. .PP -$FLAGS$ -.PP This command lists all descriptions that appear in transactions. .PP Examples: @@ -2835,8 +2811,6 @@ from your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. .PP -$FLAGS$ -.PP Examples: .IP .nf @@ -2861,8 +2835,6 @@ files List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. -.PP -$FLAGS$ .SS help .PP help @@ -2871,8 +2843,6 @@ help .PD Show any of the hledger manuals. .PP -$FLAGS$ -.PP The \f[C]help\f[R] command displays any of the main hledger manuals, in one of several ways. Run it with no argument to list the manuals, or provide a full or @@ -2925,8 +2895,6 @@ Or with --dry-run, just print the transactions that would be added. Or with --catchup, just mark all of the FILEs\[aq] transactions as imported, without actually importing any. .PP -$FLAGS$ -.PP The input files are specified as arguments - no need to write -f before each one. So eg to add new transactions from all CSV files to the main journal, @@ -2979,8 +2947,6 @@ Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). .PP -$FLAGS$ -.PP This command displays a simple income statement. It currently assumes that you have top-level accounts named \f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural @@ -3025,8 +2991,6 @@ selection. .PP notes Show notes. .PP -$FLAGS$ -.PP This command lists all notes that appear in transactions. .PP Examples: @@ -3042,8 +3006,6 @@ Snacks .PP payees Show payee names. .PP -$FLAGS$ -.PP This command lists all payee names that appear in transactions. .PP Examples: @@ -3069,8 +3031,6 @@ With --inverted-costs, also print inverse prices based on transaction prices. Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. -.PP -$FLAGS$ .SS print .PP print, txns, p @@ -3079,8 +3039,6 @@ print, txns, p .PD Show transaction journal entries, sorted by date. .PP -$FLAGS$ -.PP The print command displays full journal entries (transactions) from the journal file in date order, tidily formatted. With --date2, transactions are sorted by secondary date instead. @@ -3207,8 +3165,6 @@ print-unique .PD Print transactions which do not reuse an already-seen description. .PP -$FLAGS$ -.PP Example: .IP .nf @@ -3232,8 +3188,6 @@ register, reg, r .PD Show postings and their running total. .PP -$FLAGS$ -.PP The register command displays postings in date order, one per line, and their running total. This is typically used with a query selecting a particular account, to @@ -3390,8 +3344,6 @@ If there are multiple equally good matches, it shows the most recent. Query options (options, not arguments) can be used to restrict the search space. Helps ledger-autosync detect already-seen transactions when importing. -.PP -$FLAGS$ .SS rewrite .PP rewrite @@ -3402,8 +3354,6 @@ Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print --auto. .PP -$FLAGS$ -.PP This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching @@ -3575,8 +3525,6 @@ roi Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. .PP -$FLAGS$ -.PP This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation of these investments you offset unrealized profit and loss into account(s) that, @@ -3603,8 +3551,6 @@ stats .PD Show some journal statistics. .PP -$FLAGS$ -.PP The stats command displays summary information for the whole journal, or a matched part of it. With a reporting interval, it shows a report for each report period. @@ -3642,8 +3588,6 @@ With a TAGREGEX argument, only tag names matching the regular expression With QUERY arguments, only transactions matching the query are considered. With --values flag, the tags\[aq] unique values are listed instead. -.PP -$FLAGS$ .SS test .PP test @@ -3652,8 +3596,6 @@ test .PD Run built-in unit tests. .PP -$FLAGS$ -.PP This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will be non-zero. diff --git a/hledger/hledger.info b/hledger/hledger.info index 344c95561..fb45f6917 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -1348,8 +1348,6 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS accounts, a Show account names. - $FLAGS$ - This command lists account names, either declared with account directives (-declared), posted to (-used), or both (the default). With query arguments, only matched account names and account names referenced @@ -1380,8 +1378,6 @@ File: hledger.info, Node: activity, Next: add, Prev: accounts, Up: COMMANDS activity Show an ascii barchart of posting counts per interval. - $FLAGS$ - The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. @@ -1403,8 +1399,6 @@ File: hledger.info, Node: add, Next: balance, Prev: activity, Up: COMMANDS add Prompt for transactions and add them to the journal. - $FLAGS$ - Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the 'add' command, which prompts interactively on the console for new @@ -1476,8 +1470,6 @@ File: hledger.info, Node: balance, Next: balancesheet, Prev: add, Up: COMMAN balance, bal, b Show accounts and their balances. - $FLAGS$ - The balance command is hledger's most versatile command. Note, despite the name, it is not always used for showing real-world account balances; the more accounting-aware balancesheet and incomestatement may @@ -2049,8 +2041,6 @@ date). It assumes that these accounts are under a top-level 'asset' or (like conventional financial statements, unlike balance/print/register) (experimental). - $FLAGS$ - Example: $ hledger balancesheet @@ -2094,8 +2084,6 @@ balancesheetequity, bse Just like balancesheet, but also reports Equity (which it assumes is under a top-level 'equity' account). - $FLAGS$ - Example: $ hledger balancesheetequity @@ -2136,8 +2124,6 @@ contain 'receivable' or 'A/R' in their name. Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). - $FLAGS$ - Example: $ hledger cashflow @@ -2175,8 +2161,6 @@ checks secondary dates instead. With -strict, dates must also be unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. - $FLAGS$ -  File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS @@ -2188,8 +2172,6 @@ Reports account names having the same leaf but different prefixes. In other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. - $FLAGS$ - An example: http://stefanorodighiero.net/software/hledger-dupes.html  @@ -2205,8 +2187,6 @@ Useful for bringing asset/liability balances forward into a new journal file, or for closing out revenues/expenses to retained earnings at the end of a period. - $FLAGS$ - The closing transaction transfers balances to "equity:closing balances", and the opening transaction transfers balances from "equity:opening balances", or you can customise these with the @@ -2293,8 +2273,6 @@ File: hledger.info, Node: commodities, Next: descriptions, Prev: close, Up: commodities List all commodity/currency symbols used or declared in the journal. - $FLAGS$ -  File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS @@ -2303,8 +2281,6 @@ File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: C descriptions Show descriptions. - $FLAGS$ - This command lists all descriptions that appear in transactions. Examples: @@ -2337,8 +2313,6 @@ from your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. - $FLAGS$ - Examples: $ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro @@ -2361,8 +2335,6 @@ files List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. - $FLAGS$ -  File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS @@ -2372,8 +2344,6 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS help Show any of the hledger manuals. - $FLAGS$ - The 'help' command displays any of the main hledger manuals, in one of several ways. Run it with no argument to list the manuals, or provide a full or partial manual name to select one. @@ -2417,8 +2387,6 @@ the main journal file. Or with -dry-run, just print the transactions that would be added. Or with -catchup, just mark all of the FILEs' transactions as imported, without actually importing any. - $FLAGS$ - The input files are specified as arguments - no need to write -f before each one. So eg to add new transactions from all CSV files to the main journal, it's just: 'hledger import *.csv' @@ -2469,8 +2437,6 @@ plural forms also allowed). Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). - $FLAGS$ - This command displays a simple income statement. It currently assumes that you have top-level accounts named 'income' (or 'revenue') and 'expense' (plural forms also allowed.) @@ -2513,8 +2479,6 @@ File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: CO notes Show notes. - $FLAGS$ - This command lists all notes that appear in transactions. Examples: @@ -2531,8 +2495,6 @@ File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS payees Show payee names. - $FLAGS$ - This command lists all payee names that appear in transactions. Examples: @@ -2555,8 +2517,6 @@ synthetic market prices based on transaction prices. With Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. - $FLAGS$ -  File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS @@ -2566,8 +2526,6 @@ File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMA print, txns, p Show transaction journal entries, sorted by date. - $FLAGS$ - The print command displays full journal entries (transactions) from the journal file in date order, tidily formatted. With -date2, transactions are sorted by secondary date instead. @@ -2669,8 +2627,6 @@ File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COM print-unique Print transactions which do not reuse an already-seen description. - $FLAGS$ - Example: $ cat unique.journal @@ -2692,8 +2648,6 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique, register, reg, r Show postings and their running total. - $FLAGS$ - The register command displays postings in date order, one per line, and their running total. This is typically used with a query selecting a particular account, to see that account's activity: @@ -2819,8 +2773,6 @@ good matches, it shows the most recent. Query options (options, not arguments) can be used to restrict the search space. Helps ledger-autosync detect already-seen transactions when importing. - $FLAGS$ -  File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS @@ -2832,8 +2784,6 @@ Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print -auto. - $FLAGS$ - This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. @@ -2989,8 +2939,6 @@ roi Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. - $FLAGS$ - This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation of these investments you offset unrealized profit and loss into account(s) @@ -3018,8 +2966,6 @@ File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS stats Show some journal statistics. - $FLAGS$ - The stats command displays summary information for the whole journal, or a matched part of it. With a reporting interval, it shows a report for each report period. @@ -3055,8 +3001,6 @@ shown. With QUERY arguments, only transactions matching the query are considered. With -values flag, the tags' unique values are listed instead. - $FLAGS$ -  File: hledger.info, Node: test, Prev: tags, Up: COMMANDS @@ -3066,8 +3010,6 @@ File: hledger.info, Node: test, Prev: tags, Up: COMMANDS test Run built-in unit tests. - $FLAGS$ - This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will be non-zero. @@ -3287,111 +3229,111 @@ Node: COMMANDS43892 Ref: #commands44004 Node: accounts45068 Ref: #accounts45166 -Node: activity45877 -Ref: #activity45987 -Node: add46382 -Ref: #add46481 -Node: balance49232 -Ref: #balance49343 -Node: Classic balance report50813 -Ref: #classic-balance-report50986 -Node: Customising the classic balance report52355 -Ref: #customising-the-classic-balance-report52583 -Node: Colour support54659 -Ref: #colour-support54826 -Node: Flat mode54999 -Ref: #flat-mode55147 -Node: Depth limited balance reports55560 -Ref: #depth-limited-balance-reports55745 -Node: Percentages56201 -Ref: #percentages56367 -Node: Multicolumn balance report57504 -Ref: #multicolumn-balance-report57684 -Node: Budget report62998 -Ref: #budget-report63141 -Node: Nested budgets68343 -Ref: #nested-budgets68455 -Ref: #output-format-171936 -Node: balancesheet72014 -Ref: #balancesheet72150 -Node: balancesheetequity73545 -Ref: #balancesheetequity73694 -Node: cashflow74267 -Ref: #cashflow74395 -Node: check-dates75503 -Ref: #check-dates75630 -Node: check-dupes75921 -Ref: #check-dupes76045 -Node: close76350 -Ref: #close76464 -Node: commodities80142 -Ref: #commodities80269 -Node: descriptions80363 -Ref: #descriptions80491 -Node: diff80684 -Ref: #diff80790 -Node: files81849 -Ref: #files81949 -Node: help82108 -Ref: #help82208 -Node: import83301 -Ref: #import83415 -Node: Importing balance assignments84320 -Ref: #importing-balance-assignments84468 -Node: incomestatement85117 -Ref: #incomestatement85250 -Node: notes86666 -Ref: #notes86779 -Node: payees86917 -Ref: #payees87023 -Node: prices87193 -Ref: #prices87299 -Node: print87652 -Ref: #print87762 -Node: print-unique92267 -Ref: #print-unique92393 -Node: register92690 -Ref: #register92817 -Node: Custom register output97001 -Ref: #custom-register-output97130 -Node: register-match98392 -Ref: #register-match98526 -Node: rewrite98889 -Ref: #rewrite99004 -Node: Re-write rules in a file100871 -Ref: #re-write-rules-in-a-file101005 -Node: Diff output format102215 -Ref: #diff-output-format102384 -Node: rewrite vs print --auto103476 -Ref: #rewrite-vs.-print---auto103655 -Node: roi104211 -Ref: #roi104309 -Node: stats105333 -Ref: #stats105432 -Node: tags106232 -Ref: #tags106330 -Node: test106636 -Ref: #test106720 -Node: ADD-ON COMMANDS107479 -Ref: #add-on-commands107589 -Node: Official add-ons108877 -Ref: #official-add-ons109017 -Node: ui109097 -Ref: #ui109184 -Node: web109238 -Ref: #web109327 -Node: Third party add-ons109373 -Ref: #third-party-add-ons109548 -Node: iadd109667 -Ref: #iadd109768 -Node: interest109850 -Ref: #interest109959 -Node: Experimental add-ons110054 -Ref: #experimental-add-ons110206 -Node: autosync110444 -Ref: #autosync110555 -Node: chart110794 -Ref: #chart110899 +Node: activity45865 +Ref: #activity45975 +Node: add46358 +Ref: #add46457 +Node: balance49196 +Ref: #balance49307 +Node: Classic balance report50765 +Ref: #classic-balance-report50938 +Node: Customising the classic balance report52307 +Ref: #customising-the-classic-balance-report52535 +Node: Colour support54611 +Ref: #colour-support54778 +Node: Flat mode54951 +Ref: #flat-mode55099 +Node: Depth limited balance reports55512 +Ref: #depth-limited-balance-reports55697 +Node: Percentages56153 +Ref: #percentages56319 +Node: Multicolumn balance report57456 +Ref: #multicolumn-balance-report57636 +Node: Budget report62950 +Ref: #budget-report63093 +Node: Nested budgets68295 +Ref: #nested-budgets68407 +Ref: #output-format-171888 +Node: balancesheet71966 +Ref: #balancesheet72102 +Node: balancesheetequity73485 +Ref: #balancesheetequity73634 +Node: cashflow74195 +Ref: #cashflow74323 +Node: check-dates75419 +Ref: #check-dates75546 +Node: check-dupes75825 +Ref: #check-dupes75949 +Node: close76242 +Ref: #close76356 +Node: commodities80022 +Ref: #commodities80149 +Node: descriptions80231 +Ref: #descriptions80359 +Node: diff80540 +Ref: #diff80646 +Node: files81693 +Ref: #files81793 +Node: help81940 +Ref: #help82040 +Node: import83121 +Ref: #import83235 +Node: Importing balance assignments84128 +Ref: #importing-balance-assignments84276 +Node: incomestatement84925 +Ref: #incomestatement85058 +Node: notes86462 +Ref: #notes86575 +Node: payees86701 +Ref: #payees86807 +Node: prices86965 +Ref: #prices87071 +Node: print87412 +Ref: #print87522 +Node: print-unique92015 +Ref: #print-unique92141 +Node: register92426 +Ref: #register92553 +Node: Custom register output96725 +Ref: #custom-register-output96854 +Node: register-match98116 +Ref: #register-match98250 +Node: rewrite98601 +Ref: #rewrite98716 +Node: Re-write rules in a file100571 +Ref: #re-write-rules-in-a-file100705 +Node: Diff output format101915 +Ref: #diff-output-format102084 +Node: rewrite vs print --auto103176 +Ref: #rewrite-vs.-print---auto103355 +Node: roi103911 +Ref: #roi104009 +Node: stats105021 +Ref: #stats105120 +Node: tags105908 +Ref: #tags106006 +Node: test106300 +Ref: #test106384 +Node: ADD-ON COMMANDS107131 +Ref: #add-on-commands107241 +Node: Official add-ons108529 +Ref: #official-add-ons108669 +Node: ui108749 +Ref: #ui108836 +Node: web108890 +Ref: #web108979 +Node: Third party add-ons109025 +Ref: #third-party-add-ons109200 +Node: iadd109319 +Ref: #iadd109420 +Node: interest109502 +Ref: #interest109611 +Node: Experimental add-ons109706 +Ref: #experimental-add-ons109858 +Node: autosync110096 +Ref: #autosync110207 +Node: chart110446 +Ref: #chart110551  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index c1af48220..bd3810746 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -1173,8 +1173,6 @@ COMMANDS accounts, a Show account names. - $FLAGS$ - This command lists account names, either declared with account direc- tives (--declared), posted to (--used), or both (the default). With query arguments, only matched account names and account names refer- @@ -1200,8 +1198,6 @@ COMMANDS activity Show an ascii barchart of posting counts per interval. - $FLAGS$ - The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. @@ -1218,8 +1214,6 @@ COMMANDS add Prompt for transactions and add them to the journal. - $FLAGS$ - Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the add command, which prompts interactively on the console for new trans- @@ -1293,8 +1287,6 @@ COMMANDS balance, bal, b Show accounts and their balances. - $FLAGS$ - The balance command is hledger's most versatile command. Note, despite the name, it is not always used for showing real-world account bal- ances; the more accounting-aware balancesheet and incomestatement may @@ -1805,8 +1797,6 @@ COMMANDS (like conventional financial statements, unlike balance/print/register) (experimental). - $FLAGS$ - Example: $ hledger balancesheet @@ -1845,8 +1835,6 @@ COMMANDS Just like balancesheet, but also reports Equity (which it assumes is under a top-level equity account). - $FLAGS$ - Example: $ hledger balancesheetequity @@ -1882,8 +1870,6 @@ COMMANDS account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). - $FLAGS$ - Example: $ hledger cashflow @@ -1916,16 +1902,12 @@ COMMANDS unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. - $FLAGS$ - check-dupes check-dupes Reports account names having the same leaf but different prefixes. In other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. - $FLAGS$ - An example: http://stefanorodighiero.net/software/hledger-dupes.html close @@ -1936,8 +1918,6 @@ COMMANDS file, or for closing out revenues/expenses to retained earnings at the end of a period. - $FLAGS$ - The closing transaction transfers balances to "equity:closing bal- ances", and the opening transaction transfers balances from "eq- uity:opening balances", or you can customise these with the --close-to @@ -2018,13 +1998,9 @@ COMMANDS commodities List all commodity/currency symbols used or declared in the journal. - $FLAGS$ - descriptions descriptions Show descriptions. - $FLAGS$ - This command lists all descriptions that appear in transactions. Examples: @@ -2051,8 +2027,6 @@ COMMANDS the account balance, you can compare the bank data with your journal to find out the cause. - $FLAGS$ - Examples: $ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro @@ -2070,14 +2044,10 @@ COMMANDS List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. - $FLAGS$ - help help Show any of the hledger manuals. - $FLAGS$ - The help command displays any of the main hledger manuals, in one of several ways. Run it with no argument to list the manuals, or provide a full or partial manual name to select one. @@ -2116,8 +2086,6 @@ COMMANDS tions that would be added. Or with --catchup, just mark all of the FILEs' transactions as imported, without actually importing any. - $FLAGS$ - The input files are specified as arguments - no need to write -f before each one. So eg to add new transactions from all CSV files to the main journal, it's just: hledger import *.csv @@ -2154,8 +2122,6 @@ COMMANDS with normal positive sign (like conventional financial statements, un- like balance/print/register) (experimental). - $FLAGS$ - This command displays a simple income statement. It currently assumes that you have top-level accounts named income (or revenue) and expense (plural forms also allowed.) @@ -2193,8 +2159,6 @@ COMMANDS notes notes Show notes. - $FLAGS$ - This command lists all notes that appear in transactions. Examples: @@ -2206,8 +2170,6 @@ COMMANDS payees payees Show payee names. - $FLAGS$ - This command lists all payee names that appear in transactions. Examples: @@ -2225,14 +2187,10 @@ COMMANDS Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. - $FLAGS$ - print print, txns, p Show transaction journal entries, sorted by date. - $FLAGS$ - The print command displays full journal entries (transactions) from the journal file in date order, tidily formatted. With --date2, transac- tions are sorted by secondary date instead. @@ -2333,8 +2291,6 @@ COMMANDS print-unique Print transactions which do not reuse an already-seen description. - $FLAGS$ - Example: $ cat unique.journal @@ -2351,8 +2307,6 @@ COMMANDS register, reg, r Show postings and their running total. - $FLAGS$ - The register command displays postings in date order, one per line, and their running total. This is typically used with a query selecting a particular account, to see that account's activity: @@ -2463,16 +2417,12 @@ COMMANDS arguments) can be used to restrict the search space. Helps ledger-au- tosync detect already-seen transactions when importing. - $FLAGS$ - rewrite rewrite Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print --auto. - $FLAGS$ - This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. The @@ -2597,8 +2547,6 @@ COMMANDS Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. - $FLAGS$ - This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation of these investments you offset unrealized profit and loss into account(s) @@ -2621,8 +2569,6 @@ COMMANDS stats Show some journal statistics. - $FLAGS$ - The stats command displays summary information for the whole journal, or a matched part of it. With a reporting interval, it shows a report for each report period. @@ -2653,14 +2599,10 @@ COMMANDS considered. With --values flag, the tags' unique values are listed in- stead. - $FLAGS$ - test test Run built-in unit tests. - $FLAGS$ - This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will be non-zero.