;doc: commands: include in man pages again; simplify headings

Simplify things for now.
This commit is contained in:
Simon Michael 2020-12-20 11:04:45 -08:00
parent f42d2e2b61
commit 57a176193d
2 changed files with 46 additions and 50 deletions

View File

@ -41,7 +41,7 @@ amount of original matched posting. If the amount includes a commodity name,
the new posting amount will be in the new commodity; otherwise, it will be in the new posting amount will be in the new commodity; otherwise, it will be in
the matched posting amount's commodity. the matched posting amount's commodity.
#### Re-write rules in a file ### Re-write rules in a file
During the run this tool will execute so called During the run this tool will execute so called
["Automated Transactions"](http://ledger-cli.org/3.0/doc/ledger3.html#Automated-Transactions) ["Automated Transactions"](http://ledger-cli.org/3.0/doc/ledger3.html#Automated-Transactions)
@ -83,7 +83,7 @@ $ hledger rewrite -- -f input.journal '^income' --add-posting '(liabilities:tax)
It is important to understand that relative order of such entries in journal is It is important to understand that relative order of such entries in journal is
important. You can re-use result of previously added postings. important. You can re-use result of previously added postings.
#### Diff output format ### Diff output format
To use this tool for batch modification of your journal files you may find To use this tool for batch modification of your journal files you may find
useful output in form of unified diff. useful output in form of unified diff.
@ -123,7 +123,7 @@ See also:
https://github.com/simonmichael/hledger/issues/99 https://github.com/simonmichael/hledger/issues/99
#### rewrite vs. print --auto ### rewrite vs. print --auto
This command predates print --auto, and currently does much the same thing, This command predates print --auto, and currently does much the same thing,
but with these differences: but with these differences:

View File

@ -1582,7 +1582,16 @@ To run a command, write its name (or its abbreviation shown in the commands list
or any unambiguous prefix of the name) as hledger's first argument. or any unambiguous prefix of the name) as hledger's first argument.
Eg: `hledger balance` or `hledger bal`. Eg: `hledger balance` or `hledger bal`.
## Built-in commands m4_dnl XXX maybe later
m4_dnl Each command's detailed docs are available :
m4_dnl
m4_dnl - command line help, eg: `hledger balance --help`
m4_dnl -
m4_dnl - info manuals, eg: `hledger help --info hledger` (or possibly `info hledger`) <!-- -> m4_dnl Commands -> balance -->
m4_dnl - web manuals, eg: <https://hledger.org/hledger.html#balance>
m4_dnl <!-- - man pages, eg: `man hledger-balance` -->
Here are the built-in commands:
<!-- keep synced with Hledger.Cli.Commands.commandsList --> <!-- keep synced with Hledger.Cli.Commands.commandsList -->
**Data entry (these modify the journal file):** **Data entry (these modify the journal file):**
@ -1626,54 +1635,41 @@ Eg: `hledger balance` or `hledger bal`.
- [tags](#tags) - show tag names - [tags](#tags) - show tag names
- [test](#test) - run self tests - [test](#test) - run self tests
## Command documentation m4_dnl XXX maybe later
m4_dnl _man_({{
Each command's detailed docs are available as one or more of: m4_dnl (Detailed command docs are omitted here for brevity,
m4_dnl if you need them please use one of the other doc formats mentioned above.)
- command line help, eg: `hledger balance --help` m4_dnl }})
<!-- - man pages, eg: `man hledger-balance` --> m4_dnl _notman_({{
- info manuals, eg: `hledger help --info hledger` -> Commands -> balance m4_dnl Here are the detailed command docs, in alphabetical order:
- web manuals, eg: <https://hledger.org/hledger.html#balance>
_man_({{
(Detailed command docs are omitted here for brevity;
if you need them please use one of the above.)
}})
_notman_({{
Here are the detailed command docs, in alphabetical order:
m4_dnl commandnameheading: Commandmdfile: m4_dnl commandnameheading: Commandmdfile:
_command_({{### accounts}} ,{{Accounts}}) _command_({{## accounts}} ,{{Accounts}})
_command_({{### activity}} ,{{Activity}}) _command_({{## activity}} ,{{Activity}})
_command_({{### add}} ,{{Add}}) _command_({{## add}} ,{{Add}})
_command_({{### aregister}} ,{{Aregister}}) _command_({{## aregister}} ,{{Aregister}})
_command_({{### balance}} ,{{Balance}}) _command_({{## balance}} ,{{Balance}})
_command_({{### balancesheet}} ,{{Balancesheet}}) _command_({{## balancesheet}} ,{{Balancesheet}})
_command_({{### balancesheetequity}} ,{{Balancesheetequity}}) _command_({{## balancesheetequity}} ,{{Balancesheetequity}})
_command_({{### cashflow}} ,{{Cashflow}}) _command_({{## cashflow}} ,{{Cashflow}})
_command_({{### check}} ,{{Check}}) _command_({{## check}} ,{{Check}})
_command_({{### close}} ,{{Close}}) _command_({{## close}} ,{{Close}})
_command_({{### codes}} ,{{Codes}}) _command_({{## codes}} ,{{Codes}})
_command_({{### commodities}} ,{{Commodities}}) _command_({{## commodities}} ,{{Commodities}})
_command_({{### descriptions}} ,{{Descriptions}}) _command_({{## descriptions}} ,{{Descriptions}})
_command_({{### diff}} ,{{Diff}}) _command_({{## diff}} ,{{Diff}})
_command_({{### files}} ,{{Files}}) _command_({{## files}} ,{{Files}})
_command_({{### help}} ,{{Help}}) _command_({{## help}} ,{{Help}})
_command_({{### import}} ,{{Import}}) _command_({{## import}} ,{{Import}})
_command_({{### incomestatement}} ,{{Incomestatement}}) _command_({{## incomestatement}} ,{{Incomestatement}})
_command_({{### notes}} ,{{Notes}}) _command_({{## notes}} ,{{Notes}})
_command_({{### payees}} ,{{Payees}}) _command_({{## rewrite}} ,{{Rewrite}})
_command_({{### prices}} ,{{Prices}}) _command_({{## roi}} ,{{Roi}})
_command_({{### print}} ,{{Print}}) _command_({{## stats}} ,{{Stats}})
_command_({{### print-unique}} ,{{Printunique}}) _command_({{## tags}} ,{{Tags}})
_command_({{### register}} ,{{Register}}) _command_({{## test}} ,{{Test}})
_command_({{### register-match}} ,{{Registermatch}})
_command_({{### rewrite}} ,{{Rewrite}}) m4_dnl }})
_command_({{### roi}} ,{{Roi}})
_command_({{### stats}} ,{{Stats}})
_command_({{### tags}} ,{{Tags}})
_command_({{### test}} ,{{Test}})
}})
## Add-on commands ## Add-on commands