slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: updates (#579)

Browse Source
This commit is contained in:
Simon Michael 2017-07-07 15:58:26 +01:00
parent 9195989979
commit 50977288bb
4 changed files with 92 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
hledger/doc/commands.m4.md
View File

@ -402,28 +402,6 @@ Normally incomestatement shows revenues/expenses per period, though
as with [multicolumn balance reports](#multicolumn-balance-reports) as with [multicolumn balance reports](#multicolumn-balance-reports)
you can alter the report mode with `--change`/`--cumulative`/`--historical`. you can alter the report mode with `--change`/`--cumulative`/`--historical`.
...
## info
Show any of the hledger manuals using info.
The `info` command displays any of the [hledger reference manuals](/docs.html)
using the [info](https://en.wikipedia.org/wiki/Info_(Unix)) hypertextual documentation viewer.
This can be a very efficient way to browse large manuals.
It requires the "info" program to be available in your PATH.
As with [help](#help), run it with no arguments to list available topics (manuals).
## man
Show any of the hledger manuals using man.
The `man` command displays any of the [hledger reference manuals](/docs.html)
using [man](https://en.wikipedia.org/wiki/Man_page), the standard documentation viewer on unix systems.
This will fit the text to your terminal width, and probably invoke a pager automatically.
It requires the "man" program to be available in your PATH.
As with [help](#help), run it with no arguments to list available topics (manuals).
```
## print ## print
Show transactions from the journal. Show transactions from the journal.

24
hledger/doc/hledger.1
View File

@ -1982,30 +1982,6 @@ report period.
Normally incomestatement shows revenues/expenses per period, though as Normally incomestatement shows revenues/expenses per period, though as
with multicolumn balance reports you can alter the report mode with with multicolumn balance reports you can alter the report mode with
\f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[]. \f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[].
.PP
\&...
## info Show any of the hledger manuals using info.
.PP
The \f[C]info\f[] command displays any of the hledger reference manuals
using the info hypertextual documentation viewer.
This can be a very efficient way to browse large manuals.
It requires the "info" program to be available in your PATH.
.PP
As with help, run it with no arguments to list available topics
(manuals).
.SS man
.PP
Show any of the hledger manuals using man.
.PP
The \f[C]man\f[] command displays any of the hledger reference manuals
using man, the standard documentation viewer on unix systems.
This will fit the text to your terminal width, and probably invoke a
pager automatically.
It requires the "man" program to be available in your PATH.
.PP
As with help, run it with no arguments to list available topics
(manuals).
```
.SS print .SS print
.PP .PP
Show transactions from the journal. Show transactions from the journal.

214
hledger/doc/hledger.1.info
View File

@ -786,7 +786,6 @@ displayed in the command list ('hledger is').
* cashflow:: * cashflow::
* help:: * help::
* incomestatement:: * incomestatement::
* man::
* print:: * print::
* register:: * register::
* stats:: * stats::
@ -1467,7 +1466,7 @@ SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [ARGS] hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
 
File: hledger.1.info, Node: incomestatement, Next: man, Prev: help, Up: COMMANDS File: hledger.1.info, Node: incomestatement, Next: print, Prev: help, Up: COMMANDS
4.8 incomestatement 4.8 incomestatement
=================== ===================
@ -1542,38 +1541,11 @@ each report period. Normally incomestatement shows revenues/expenses
per period, though as with multicolumn balance reports you can alter the per period, though as with multicolumn balance reports you can alter the
report mode with '--change'/'--cumulative'/'--historical'. report mode with '--change'/'--cumulative'/'--historical'.
... ## info Show any of the hledger manuals using info.
The 'info' command displays any of the hledger reference manuals
using the info hypertextual documentation viewer. This can be a very
efficient way to browse large manuals. It requires the "info" program
to be available in your PATH.
As with help, run it with no arguments to list available topics
(manuals).
 
File: hledger.1.info, Node: man, Next: print, Prev: incomestatement, Up: COMMANDS File: hledger.1.info, Node: print, Next: register, Prev: incomestatement, Up: COMMANDS
4.9 man 4.9 print
======= =========
Show any of the hledger manuals using man.
The 'man' command displays any of the hledger reference manuals using
man, the standard documentation viewer on unix systems. This will fit
the text to your terminal width, and probably invoke a pager
automatically. It requires the "man" program to be available in your
PATH.
As with help, run it with no arguments to list available topics
(manuals). "'

File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS
4.10 print
==========
Show transactions from the journal. Show transactions from the journal.
@ -1666,7 +1638,7 @@ $ hledger print -Ocsv
 
File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
4.11 register 4.10 register
============= =============
Show postings and their running total. Alias: reg. Show postings and their running total. Alias: reg.
@ -1771,7 +1743,7 @@ length and comparable to the others in the report.
 
File: hledger.1.info, Node: Custom register output, Up: register File: hledger.1.info, Node: Custom register output, Up: register
4.11.1 Custom register output 4.10.1 Custom register output
----------------------------- -----------------------------
register uses the full terminal width by default, except on windows. register uses the full terminal width by default, except on windows.
@ -1803,7 +1775,7 @@ output.
 
File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS
4.12 stats 4.11 stats
========== ==========
Show some journal statistics. Show some journal statistics.
@ -1835,7 +1807,7 @@ output destination.
 
File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS
4.13 test 4.12 test
========= =========
Run built-in unit tests. Run built-in unit tests.
@ -2133,91 +2105,89 @@ Node: QUERIES21565
Ref: #queries21669 Ref: #queries21669
Node: COMMANDS25334 Node: COMMANDS25334
Ref: #commands25448 Ref: #commands25448
Node: accounts26112 Node: accounts26104
Ref: #accounts26212 Ref: #accounts26204
Node: activity27194 Node: activity27186
Ref: #activity27306 Ref: #activity27298
Node: add27665 Node: add27657
Ref: #add27766 Ref: #add27758
Node: balance30424 Node: balance30416
Ref: #balance30537 Ref: #balance30529
Node: Flat mode33552 Node: Flat mode33544
Ref: #flat-mode33679 Ref: #flat-mode33671
Node: Depth limited balance reports34099 Node: Depth limited balance reports34091
Ref: #depth-limited-balance-reports34302 Ref: #depth-limited-balance-reports34294
Node: Multicolumn balance reports34722 Node: Multicolumn balance reports34714
Ref: #multicolumn-balance-reports34933 Ref: #multicolumn-balance-reports34925
Node: Custom balance output39581 Node: Custom balance output39573
Ref: #custom-balance-output39765 Ref: #custom-balance-output39757
Node: Colour support41858 Node: Colour support41850
Ref: #colour-support42019 Ref: #colour-support42011
Node: Output destination42192 Node: Output destination42184
Ref: #output-destination42350 Ref: #output-destination42342
Node: CSV output42620 Node: CSV output42612
Ref: #csv-output42739 Ref: #csv-output42731
Node: balancesheet43136 Node: balancesheet43128
Ref: #balancesheet43264 Ref: #balancesheet43256
Node: cashflow45171 Node: cashflow45163
Ref: #cashflow45288 Ref: #cashflow45280
Node: help47156 Node: help47148
Ref: #help47268 Ref: #help47260
Node: incomestatement48098 Node: incomestatement48090
Ref: #incomestatement48227 Ref: #incomestatement48221
Node: man50499 Node: print50113
Ref: #man50605 Ref: #print50228
Node: print51014 Node: register53984
Ref: #print51119 Ref: #register54097
Node: register54875 Node: Custom register output58593
Ref: #register54988 Ref: #custom-register-output58724
Node: Custom register output59484 Node: stats60021
Ref: #custom-register-output59615 Ref: #stats60127
Node: stats60912 Node: test61008
Ref: #stats61018 Ref: #test61095
Node: test61899 Node: ADD-ON COMMANDS61463
Ref: #test61986 Ref: #add-on-commands61575
Node: ADD-ON COMMANDS62354 Node: Official add-ons62862
Ref: #add-on-commands62466 Ref: #official-add-ons63004
Node: Official add-ons63753 Node: api63091
Ref: #official-add-ons63895 Ref: #api63182
Node: api63982 Node: ui63234
Ref: #api64073 Ref: #ui63335
Node: ui64125 Node: web63393
Ref: #ui64226 Ref: #web63484
Node: web64284 Node: Third party add-ons63530
Ref: #web64375 Ref: #third-party-add-ons63707
Node: Third party add-ons64421 Node: diff63842
Ref: #third-party-add-ons64598 Ref: #diff63941
Node: diff64733 Node: iadd64040
Ref: #diff64832 Ref: #iadd64156
Node: iadd64931 Node: interest64239
Ref: #iadd65047 Ref: #interest64362
Node: interest65130 Node: irr64457
Ref: #interest65253 Ref: #irr64557
Node: irr65348 Node: Experimental add-ons64635
Ref: #irr65448 Ref: #experimental-add-ons64789
Node: Experimental add-ons65526 Node: autosync65182
Ref: #experimental-add-ons65680 Ref: #autosync65296
Node: autosync66073 Node: budget65535
Ref: #autosync66187 Ref: #budget65659
Node: budget66426 Node: chart65725
Ref: #budget66550 Ref: #chart65844
Node: chart66616 Node: check65915
Ref: #chart66735 Ref: #check66039
Node: check66806 Node: check-dates66106
Ref: #check66930 Ref: #check-dates66248
Node: check-dates66997 Node: check-dupes66321
Ref: #check-dates67139 Ref: #check-dupes66464
Node: check-dupes67212 Node: equity66541
Ref: #check-dupes67355 Ref: #equity66669
Node: equity67432 Node: prices66788
Ref: #equity67560 Ref: #prices66917
Node: prices67679 Node: print-unique66972
Ref: #prices67808 Ref: #print-unique67121
Node: print-unique67863 Node: register-match67214
Ref: #print-unique68012 Ref: #register-match67370
Node: register-match68105 Node: rewrite67468
Ref: #register-match68261 Ref: #rewrite67589
Node: rewrite68359
Ref: #rewrite68480
 
End Tag Table End Tag Table

21
hledger/doc/hledger.1.txt
View File

@ -1380,27 +1380,6 @@ COMMANDS
period, though as with multicolumn balance reports you can alter the period, though as with multicolumn balance reports you can alter the
report mode with --change/--cumulative/--historical. report mode with --change/--cumulative/--historical.
... ## info Show any of the hledger manuals using info.
The info command displays any of the hledger reference manuals using
the info hypertextual documentation viewer. This can be a very effi-
cient way to browse large manuals. It requires the "info" program to
be available in your PATH.
As with help, run it with no arguments to list available topics (manu-
als).
man
Show any of the hledger manuals using man.
The man command displays any of the hledger reference manuals using
man, the standard documentation viewer on unix systems. This will fit
the text to your terminal width, and probably invoke a pager automati-
cally. It requires the "man" program to be available in your PATH.
As with help, run it with no arguments to list available topics (manu-
als). ```
print print
Show transactions from the journal. Show transactions from the journal.