From c186eb6084c1ad05095067230aeb94a6973521b2 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 4 Jan 2020 18:29:01 -0800 Subject: [PATCH] ;doc: change flags marker in command helps to suit latest pandoc From _FLAGS_ to $FLAGS$, since latest pandoc strips the underscores at a certain point in our docs rendering. --- doc/common.m4 | 5 +++-- hledger/Hledger/Cli/CliOptions.hs | 6 +++--- hledger/Hledger/Cli/Commands/Accounts.md | 2 +- hledger/Hledger/Cli/Commands/Accounts.txt | 2 +- hledger/Hledger/Cli/Commands/Activity.md | 2 +- hledger/Hledger/Cli/Commands/Activity.txt | 2 +- hledger/Hledger/Cli/Commands/Add.md | 2 +- hledger/Hledger/Cli/Commands/Add.txt | 2 +- hledger/Hledger/Cli/Commands/Balance.md | 2 +- hledger/Hledger/Cli/Commands/Balance.txt | 2 +- hledger/Hledger/Cli/Commands/Balancesheet.md | 2 +- hledger/Hledger/Cli/Commands/Balancesheet.txt | 2 +- hledger/Hledger/Cli/Commands/Balancesheetequity.md | 2 +- hledger/Hledger/Cli/Commands/Balancesheetequity.txt | 2 +- hledger/Hledger/Cli/Commands/Cashflow.md | 2 +- hledger/Hledger/Cli/Commands/Cashflow.txt | 2 +- hledger/Hledger/Cli/Commands/Checkdates.md | 2 +- hledger/Hledger/Cli/Commands/Checkdates.txt | 2 +- hledger/Hledger/Cli/Commands/Checkdupes.md | 2 +- hledger/Hledger/Cli/Commands/Checkdupes.txt | 2 +- hledger/Hledger/Cli/Commands/Close.md | 2 +- hledger/Hledger/Cli/Commands/Close.txt | 6 +++--- hledger/Hledger/Cli/Commands/Commodities.md | 2 +- hledger/Hledger/Cli/Commands/Commodities.txt | 2 +- hledger/Hledger/Cli/Commands/Descriptions.md | 2 +- hledger/Hledger/Cli/Commands/Descriptions.txt | 2 +- hledger/Hledger/Cli/Commands/Diff.md | 2 +- hledger/Hledger/Cli/Commands/Diff.txt | 2 +- hledger/Hledger/Cli/Commands/Files.md | 2 +- hledger/Hledger/Cli/Commands/Files.txt | 2 +- hledger/Hledger/Cli/Commands/Help.md | 2 +- hledger/Hledger/Cli/Commands/Help.txt | 2 +- hledger/Hledger/Cli/Commands/Import.md | 2 +- hledger/Hledger/Cli/Commands/Import.txt | 2 +- hledger/Hledger/Cli/Commands/Incomestatement.md | 2 +- hledger/Hledger/Cli/Commands/Incomestatement.txt | 2 +- hledger/Hledger/Cli/Commands/Notes.md | 2 +- hledger/Hledger/Cli/Commands/Notes.txt | 2 +- hledger/Hledger/Cli/Commands/Payees.md | 2 +- hledger/Hledger/Cli/Commands/Payees.txt | 2 +- hledger/Hledger/Cli/Commands/Prices.md | 2 +- hledger/Hledger/Cli/Commands/Prices.txt | 2 +- hledger/Hledger/Cli/Commands/Print.md | 2 +- hledger/Hledger/Cli/Commands/Print.txt | 2 +- hledger/Hledger/Cli/Commands/Printunique.md | 2 +- hledger/Hledger/Cli/Commands/Printunique.txt | 2 +- hledger/Hledger/Cli/Commands/README.md | 4 ++-- hledger/Hledger/Cli/Commands/Register.md | 2 +- hledger/Hledger/Cli/Commands/Register.txt | 4 ++-- hledger/Hledger/Cli/Commands/Registermatch.md | 2 +- hledger/Hledger/Cli/Commands/Registermatch.txt | 2 +- hledger/Hledger/Cli/Commands/Rewrite.md | 2 +- hledger/Hledger/Cli/Commands/Rewrite.txt | 2 +- hledger/Hledger/Cli/Commands/Roi.md | 2 +- hledger/Hledger/Cli/Commands/Roi.txt | 2 +- hledger/Hledger/Cli/Commands/Stats.md | 2 +- hledger/Hledger/Cli/Commands/Stats.txt | 2 +- hledger/Hledger/Cli/Commands/Tags.md | 2 +- hledger/Hledger/Cli/Commands/Tags.txt | 2 +- hledger/Hledger/Cli/Commands/Test.md | 2 +- hledger/Hledger/Cli/Commands/Test.txt | 2 +- 61 files changed, 69 insertions(+), 68 deletions(-) diff --git a/doc/common.m4 b/doc/common.m4 index 132fab16a..79923f704 100644 --- a/doc/common.m4 +++ b/doc/common.m4 @@ -209,6 +209,7 @@ 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_define({{_FLAGS_}}, {{}})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 diff --git a/hledger/Hledger/Cli/CliOptions.hs b/hledger/Hledger/Cli/CliOptions.hs index 1de9d4626..b3df4d603 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 8abb95296..b39539ae3 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 3530770a9..1a3274499 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 93e29c6f1..bc1be6e6a 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 d520726a5..9e2b7adfe 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 e49a2dd3b..0beb7d15e 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 468e79a29..d43d38e40 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 f8825ebb6..0c227ae01 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 76a616557..933b69905 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 d9b0fc5ad..517232b8b 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 bd8e1d287..6c72a7755 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 a221f8604..172459ada 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 2a1503bb2..3f8ca1cec 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 610580314..aef08263c 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 d1d7cf90e..0d9e8422b 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 5aa8fbe5b..8fa8ce25a 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 425411c4d..85dfcda49 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 dc0ce538b..4f1ae5860 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 3df233623..cba589e82 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 f35a105dd..26e7c9471 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 92d36bbca..325c22570 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 @@ -51,8 +51,8 @@ Examples: Carrying asset/liability balances into a new file for 2019, all from command line: -_Warning: we use >> here to append; be careful not to type a single > -which would wipe your journal!_ +Warning: we use >> here to append; be careful not to type a single > +which would wipe your journal! $ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --closing >>2018.journal diff --git a/hledger/Hledger/Cli/Commands/Commodities.md b/hledger/Hledger/Cli/Commands/Commodities.md index d7d827095..ddd9ea2c1 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 e9c627cd9..b38b566fa 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 f6fb01dbb..daa6d466f 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 d33f9e769..8bf4447e2 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 344c2ef70..3147bd500 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 24d74d609..48cd771fb 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 95e6ac358..e19be698b 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 cd87c920c..6a056092f 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 9a3b8ccfc..f90e166d6 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 3c3e41eca..44f734545 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 f4a8c0ed8..cac53dfb2 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 cf781087b..369ce44f0 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 057717702..61a10c954 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 d232e5029..95776623e 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 7ea63d421..39fe97a3a 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 36433434d..9c1a2d30a 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 798d0ac5c..7d2985b0f 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 0a1983ae5..4818deb8c 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 a5f36f6f4..0d219a833 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 0e4227e38..331665189 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 7261fcce4..ca634f605 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 3120e0ea7..7435c3585 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 e66f13c71..dd396f54c 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 e4315295e..9bb4ed635 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 34ffde947..e2c897c85 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 d5b0d752f..2156f01c5 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 a164e2f9b..81522dcaa 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 @@ -32,7 +32,7 @@ the whole report period). This flag implies --empty (see below). It is affected by --historical. It works best when showing just one account and one commodity. -The --related/-r flag shows the _other_ postings in the transactions of +The --related/-r flag shows the other postings in the transactions of the postings which would normally be shown. The --invert flag negates all amounts. For example, it can be used on an diff --git a/hledger/Hledger/Cli/Commands/Registermatch.md b/hledger/Hledger/Cli/Commands/Registermatch.md index 21fc6de5a..5f0b23eef 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 30b59c8c6..95d2baba1 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 b1c622f02..c140fb2e7 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 14eab292d..e4a9c7cd2 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 df4c63d8a..7e7b13620 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 a6d930aa6..dd8150893 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 31ee9f784..94d4a888d 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 249c46e02..156bb0cc8 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 0eda38f71..5067c174e 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 78609247a..8acc8862b 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 789bdae91..0633a0453 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 661e47fc7..31c380b64 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