doc: mark up man pages for man/web rendering
And commit the latest nroff output. It'll need retesting.
This commit is contained in:
		
							parent
							
								
									e1c9e51775
								
							
						
					
					
						commit
						2dbe07a666
					
				| @ -2,6 +2,8 @@ | |||||||
| % | % | ||||||
| % January 2016 | % January 2016 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger-api - web API server for the hledger accounting tool | hledger-api - web API server for the hledger accounting tool | ||||||
| @ -17,6 +19,11 @@ hledger is a cross-platform program for tracking money, time, or any other commo | |||||||
| using double-entry accounting and a simple, editable file format. | using double-entry accounting and a simple, editable file format. | ||||||
| hledger is inspired by and largely compatible with ledger(1). | hledger is inspired by and largely compatible with ledger(1). | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | <!-- * toc --> | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger-api is a simple web API server, intended to support | hledger-api is a simple web API server, intended to support | ||||||
| client-side web apps operating on hledger data. It comes with a series | client-side web apps operating on hledger data. It comes with a series | ||||||
| of simple client-side app examples, which drive it's evolution. | of simple client-side app examples, which drive it's evolution. | ||||||
| @ -101,6 +108,8 @@ access. | |||||||
| <!-- `-B --cost` --> | <!-- `-B --cost` --> | ||||||
| <!-- : show amounts in their cost price's commodity --> | <!-- : show amounts in their cost price's commodity --> | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| **LEDGER_FILE** | **LEDGER_FILE** | ||||||
| @ -131,3 +140,4 @@ The need to precede options with `--` when invoked from hledger is awkward. | |||||||
| <!-- appear to run normally, but you will be seeing pages served from the --> | <!-- appear to run normally, but you will be seeing pages served from the --> | ||||||
| <!-- first one. --> | <!-- first one. --> | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | |||||||
| @ -8,6 +8,8 @@ | |||||||
| hledger_csv \- reading CSV files with hledger, and the CSV rules file | hledger_csv \- reading CSV files with hledger, and the CSV rules file | ||||||
| format | format | ||||||
| .SH DESCRIPTION | .SH DESCRIPTION | ||||||
|  | .IP \[bu] 2 | ||||||
|  | toc | ||||||
| .PP | .PP | ||||||
| hledger can read CSV files, converting each CSV record into a journal | hledger can read CSV files, converting each CSV record into a journal | ||||||
| entry (transaction), if you provide some conversion hints in a "rules | entry (transaction), if you provide some conversion hints in a "rules | ||||||
|  | |||||||
| @ -2,12 +2,19 @@ | |||||||
| % | % | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger_csv - reading CSV files with hledger, and the CSV rules file format | hledger_csv - reading CSV files with hledger, and the CSV rules file format | ||||||
| 
 | 
 | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger can read | hledger can read | ||||||
| [CSV](http://en.wikipedia.org/wiki/Comma-separated_values) files, | [CSV](http://en.wikipedia.org/wiki/Comma-separated_values) files, | ||||||
| converting each CSV record into a journal entry (transaction), | converting each CSV record into a journal entry (transaction), | ||||||
|  | |||||||
| @ -7,6 +7,8 @@ | |||||||
| .PP | .PP | ||||||
| hledger_journal \- reference for hledger\[aq]s journal file format | hledger_journal \- reference for hledger\[aq]s journal file format | ||||||
| .SH DESCRIPTION | .SH DESCRIPTION | ||||||
|  | .IP \[bu] 2 | ||||||
|  | toc | ||||||
| .PP | .PP | ||||||
| hledger\[aq]s usual data source is a plain text file containing journal | hledger\[aq]s usual data source is a plain text file containing journal | ||||||
| entries in hledger journal format. | entries in hledger journal format. | ||||||
| @ -698,11 +700,11 @@ $\ hledger\ print | |||||||
| .PP | .PP | ||||||
| You can specify a parent account which will be prepended to all accounts | You can specify a parent account which will be prepended to all accounts | ||||||
| within a section of the journal. | within a section of the journal. | ||||||
| Use the \f[C]account\f[] directive like so: | Use the \f[C]apply\ account\f[] directive like so: | ||||||
| .IP | .IP | ||||||
| .nf | .nf | ||||||
| \f[C] | \f[C] | ||||||
| account\ home | apply\ account\ home | ||||||
| 
 | 
 | ||||||
| 2010/1/1 | 2010/1/1 | ||||||
| \ \ \ \ food\ \ \ \ $10 | \ \ \ \ food\ \ \ \ $10 | ||||||
| @ -712,6 +714,9 @@ end | |||||||
| \f[] | \f[] | ||||||
| .fi | .fi | ||||||
| .PP | .PP | ||||||
|  | (\f[C]!account\f[], \f[C]account\f[], and \f[C]end\ apply\ account\f[] | ||||||
|  | are also supported). | ||||||
|  | .PP | ||||||
| If \f[C]end\f[] is omitted, the effect lasts to the end of the file. | If \f[C]end\f[] is omitted, the effect lasts to the end of the file. | ||||||
| The above is equivalent to: | The above is equivalent to: | ||||||
| .IP | .IP | ||||||
| @ -775,6 +780,8 @@ include\ path/to/file.journal | |||||||
| If the path does not begin with a slash, it is relative to the current | If the path does not begin with a slash, it is relative to the current | ||||||
| file. | file. | ||||||
| .PP | .PP | ||||||
|  | Glob patterns (\f[C]*\f[]) are not currently supported. | ||||||
|  | .PP | ||||||
| The \f[C]include\f[] directive may only be used in journal files, and | The \f[C]include\f[] directive may only be used in journal files, and | ||||||
| currently it may only include other journal files (eg, not CSV or | currently it may only include other journal files (eg, not CSV or | ||||||
| timelog files.) | timelog files.) | ||||||
|  | |||||||
| @ -2,12 +2,19 @@ | |||||||
| % | % | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger_journal - reference for hledger's journal file format | hledger_journal - reference for hledger's journal file format | ||||||
| 
 | 
 | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger's usual data source is a plain text file containing journal entries in hledger journal format. | hledger's usual data source is a plain text file containing journal entries in hledger journal format. | ||||||
| This file represents a standard accounting [general journal](http://en.wikipedia.org/wiki/General_journal). | This file represents a standard accounting [general journal](http://en.wikipedia.org/wiki/General_journal). | ||||||
| I use file names ending in `.journal`, but that's not required. | I use file names ending in `.journal`, but that's not required. | ||||||
|  | |||||||
| @ -2,12 +2,19 @@ | |||||||
| % | % | ||||||
| % February 2016 | % February 2016 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger_timedot - time logging format | hledger_timedot - time logging format | ||||||
| 
 | 
 | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| Timedot is a plain text format for logging dated, categorised quantities (eg time), supported by hledger. | Timedot is a plain text format for logging dated, categorised quantities (eg time), supported by hledger. | ||||||
| It is convenient for approximate and retroactive time logging, | It is convenient for approximate and retroactive time logging, | ||||||
| eg when the real-time clock-in/out required with a timeclock file is too precise or too interruptive. | eg when the real-time clock-in/out required with a timeclock file is too precise or too interruptive. | ||||||
| @ -84,9 +91,8 @@ Balance changes in 2016/02/01-2016/02/03: | |||||||
|             ||         7.75         2.25         8.00  |             ||         7.75         2.25         8.00  | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| I'd prefer to use period for separating account components. | I prefer to use period for separating account components. | ||||||
| We can rewrite these to the colon hledger requires with an | We can make this work with an [account alias](#account-aliases): | ||||||
| [account alias](#account-aliases): |  | ||||||
| 
 | 
 | ||||||
| ```timedot | ```timedot | ||||||
| 2016/2/4 | 2016/2/4 | ||||||
|  | |||||||
| @ -2,12 +2,19 @@ | |||||||
| %  | %  | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger_timelog - hledger's timelog file format | hledger_timelog - hledger's timelog file format | ||||||
| 
 | 
 | ||||||
| # DESCRIPTION | # DESCRIPTION | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | <!-- * toc --> | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger can read timelog files. | hledger can read timelog files. | ||||||
| [As with Ledger](http://ledger-cli.org/3.0/doc/ledger3.html#Time-Keeping), | [As with Ledger](http://ledger-cli.org/3.0/doc/ledger3.html#Time-Keeping), | ||||||
| these are (a subset of) | these are (a subset of) | ||||||
|  | |||||||
| @ -19,11 +19,18 @@ hledger is a cross\-platform program for tracking money, time, or any | |||||||
| other commodity, using double\-entry accounting and a simple, editable | other commodity, using double\-entry accounting and a simple, editable | ||||||
| file format. | file format. | ||||||
| hledger is inspired by and largely compatible with ledger(1). | hledger is inspired by and largely compatible with ledger(1). | ||||||
|  | .IP \[bu] 2 | ||||||
|  | toc | ||||||
| .PP | .PP | ||||||
| hledger\-ui is hledger\[aq]s curses\-style interface. | hledger\-ui is hledger\[aq]s curses\-style interface. | ||||||
| It reads a hledger journal file (~/.hledger.journal, $LEDGER_FILE, or | It reads a hledger journal file | ||||||
| \-f FILE) and provides a simple full\-screen console interface for | .PP | ||||||
| viewing account balances and transactions. | (~/.hledger.journal, $LEDGER_FILE, or \-f FILE; see hledger(1) or | ||||||
|  | hledger_journal(5)) | ||||||
|  | .PP | ||||||
|  | and provides a simple full\-screen console interface for viewing account | ||||||
|  | balances and transactions. | ||||||
|  | .PP | ||||||
| It is simpler and more convenient for browsing than the command\-line | It is simpler and more convenient for browsing than the command\-line | ||||||
| interface, but lighter and faster than hledger\-web. | interface, but lighter and faster than hledger\-web. | ||||||
| .PP | .PP | ||||||
|  | |||||||
| @ -2,6 +2,8 @@ | |||||||
| % | % | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger-ui - curses-style interface for the hledger accounting tool | hledger-ui - curses-style interface for the hledger accounting tool | ||||||
| @ -17,10 +19,34 @@ hledger is a cross-platform program for tracking money, time, or any other commo | |||||||
| using double-entry accounting and a simple, editable file format. | using double-entry accounting and a simple, editable file format. | ||||||
| hledger is inspired by and largely compatible with ledger(1). | hledger is inspired by and largely compatible with ledger(1). | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | 
 | ||||||
|  | <style> | ||||||
|  | .highslide img {max-width:250px; float:right; margin:0 0 1em 1em;} | ||||||
|  | .highslide-caption {color:white; background-color:black;} | ||||||
|  | </style> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-sample-acc2.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc2.png" title="Accounts screen with query and depth limit" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-sample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc.png" title="Accounts screen" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" title="Accounts screen with greenterm theme" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-sample-txn.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-txn.png" title="Transaction screen" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-sample-reg.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-reg.png" title="Register screen" /></a> | ||||||
|  | <!-- <br clear=all> --> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-bcexample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc.png" title="beancount example accounts" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade:cash.png" title="beancount example's etrade cash subaccount" /></a> | ||||||
|  | <a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a> | ||||||
|  | 
 | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger-ui is hledger's curses-style interface. | hledger-ui is hledger's curses-style interface. | ||||||
| It reads a hledger journal file (~/.hledger.journal, $LEDGER_FILE, or -f FILE) and | It reads a hledger journal file | ||||||
| provides a simple full-screen console interface for viewing account | <div class="manonly"> | ||||||
| balances and transactions. It is simpler and more convenient for | (~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or hledger_journal(5)) | ||||||
|  | </div> | ||||||
|  | and provides a simple full-screen console interface for viewing account balances and transactions. | ||||||
|  | 
 | ||||||
|  | It is simpler and more convenient for | ||||||
| browsing than the command-line interface, but lighter and faster than | browsing than the command-line interface, but lighter and faster than | ||||||
| hledger-web. | hledger-web. | ||||||
| 
 | 
 | ||||||
| @ -204,6 +230,8 @@ This screen will appear if there is a problem, such as a parse error, | |||||||
| when you press g to reload. Once you have fixed the problem described, | when you press g to reload. Once you have fixed the problem described, | ||||||
| press g again to reload and restore normal operation. | press g again to reload and restore normal operation. | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| **LEDGER_FILE** | **LEDGER_FILE** | ||||||
| @ -233,3 +261,5 @@ visual indication that this is in progress. | |||||||
| The register screen's switching between historic balance and running | The register screen's switching between historic balance and running | ||||||
| total based on query arguments may be confusing, and there is no | total based on query arguments may be confusing, and there is no | ||||||
| column heading to indicate which is being displayed. | column heading to indicate which is being displayed. | ||||||
|  | 
 | ||||||
|  | </div> | ||||||
|  | |||||||
| @ -19,6 +19,8 @@ hledger is a cross\-platform program for tracking money, time, or any | |||||||
| other commodity, using double\-entry accounting and a simple, editable | other commodity, using double\-entry accounting and a simple, editable | ||||||
| file format. | file format. | ||||||
| hledger is inspired by and largely compatible with ledger(1). | hledger is inspired by and largely compatible with ledger(1). | ||||||
|  | .IP \[bu] 2 | ||||||
|  | toc | ||||||
| .PP | .PP | ||||||
| hledger\-web is hledger\[aq]s web interface. | hledger\-web is hledger\[aq]s web interface. | ||||||
| It starts a simple web application for browsing and adding transactions, | It starts a simple web application for browsing and adding transactions, | ||||||
|  | |||||||
| @ -2,6 +2,8 @@ | |||||||
| % | % | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger-web - web interface for the hledger accounting tool | hledger-web - web interface for the hledger accounting tool | ||||||
| @ -17,6 +19,11 @@ hledger is a cross-platform program for tracking money, time, or any other commo | |||||||
| using double-entry accounting and a simple, editable file format. | using double-entry accounting and a simple, editable file format. | ||||||
| hledger is inspired by and largely compatible with ledger(1). | hledger is inspired by and largely compatible with ledger(1). | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| hledger-web is hledger's web interface.  It starts a simple web | hledger-web is hledger's web interface.  It starts a simple web | ||||||
| application for browsing and adding transactions, and optionally | application for browsing and adding transactions, and optionally | ||||||
| opens it in a web browser window if possible. | opens it in a web browser window if possible. | ||||||
| @ -137,6 +144,8 @@ The following common hledger options should also work: | |||||||
| `-B --cost` | `-B --cost` | ||||||
| : show amounts in their cost price's commodity | : show amounts in their cost price's commodity | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| **LEDGER_FILE** | **LEDGER_FILE** | ||||||
| @ -167,3 +176,4 @@ If you start two instances on the same port, the second one will | |||||||
| appear to run normally, but you will be seeing pages served from the | appear to run normally, but you will be seeing pages served from the | ||||||
| first one. | first one. | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | |||||||
| @ -22,6 +22,8 @@ It is inspired by and largely compatible with ledger(1). | |||||||
| hledger aims to be a reliable, practical tool for daily use. | hledger aims to be a reliable, practical tool for daily use. | ||||||
| This man page is a quick reference and introduction; for more complete | This man page is a quick reference and introduction; for more complete | ||||||
| docs, see http://hledger.org/manual. | docs, see http://hledger.org/manual. | ||||||
|  | .IP \[bu] 2 | ||||||
|  | toc | ||||||
| .PP | .PP | ||||||
| This is hledger's command\-line interface (there are also curses and web | This is hledger's command\-line interface (there are also curses and web | ||||||
| interfaces). | interfaces). | ||||||
| @ -35,8 +37,9 @@ user's $PATH and can invoke them as subcommands. | |||||||
| .PP | .PP | ||||||
| The journal file is \f[C]~/.hledger.journal\f[] by default, or another | The journal file is \f[C]~/.hledger.journal\f[] by default, or another | ||||||
| file path specified by \f[C]$LEDGER_FILE\f[]. | file path specified by \f[C]$LEDGER_FILE\f[]. | ||||||
| You can also specify a file with \f[C]\-f\ FILE\f[], or standard input | (This should be a real environment variable, not a shell variable.) You | ||||||
| with \f[C]\-f\-\f[]. | can also specify a file with \f[C]\-f\ FILE\f[], or standard input with | ||||||
|  | \f[C]\-f\-\f[]. | ||||||
| .PP | .PP | ||||||
| Transactions are dated movements of money between two (or more) named | Transactions are dated movements of money between two (or more) named | ||||||
| accounts, and are recorded with journal entries like this: | accounts, and are recorded with journal entries like this: | ||||||
|  | |||||||
| @ -2,6 +2,8 @@ | |||||||
| % | % | ||||||
| % October 2015 | % October 2015 | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # NAME | # NAME | ||||||
| 
 | 
 | ||||||
| hledger - a command-line accounting tool | hledger - a command-line accounting tool | ||||||
| @ -20,6 +22,11 @@ hledger aims to be a reliable, practical tool for daily use. This man | |||||||
| page is a quick reference and introduction; for more complete docs, see | page is a quick reference and introduction; for more complete docs, see | ||||||
| http://hledger.org/manual. | http://hledger.org/manual. | ||||||
| 
 | 
 | ||||||
|  | </div> | ||||||
|  | <div class="webonly"> | ||||||
|  | * toc | ||||||
|  | </div> | ||||||
|  | 
 | ||||||
| This is hledger’s command-line interface (there are also curses and web | This is hledger’s command-line interface (there are also curses and web | ||||||
| interfaces). Its basic function is to read a plain text file describing | interfaces). Its basic function is to read a plain text file describing | ||||||
| financial transactions (in accounting terms, a general journal) and | financial transactions (in accounting terms, a general journal) and | ||||||
| @ -484,6 +491,8 @@ $ hledger print desc:shop                 # show transactions with shop in the d | |||||||
| $ hledger activity -W                     # show transaction counts per week as a bar chart | $ hledger activity -W                     # show transaction counts per week as a bar chart | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | <div class="manonly"> | ||||||
|  | 
 | ||||||
| # ENVIRONMENT | # ENVIRONMENT | ||||||
| 
 | 
 | ||||||
| **LEDGER_FILE** | **LEDGER_FILE** | ||||||
| @ -510,3 +519,5 @@ Eg on POSIX, set LANG to something other than C. | |||||||
| # REPORTING BUGS | # REPORTING BUGS | ||||||
| 
 | 
 | ||||||
| Report bugs at http://bugs.hledger.org. | Report bugs at http://bugs.hledger.org. | ||||||
|  | 
 | ||||||
|  | </div> | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user