simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-20 02:37:12 +03:00
Code Issues Projects Releases Wiki Activity
a424541e38
hledger/doc/manpage.nroff

42 lines
779 B
Plaintext
Raw Normal View History

doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
$if(has-tables)$
.\"t
$endif$
;doc: man: show program name in upper case, per man-page(7)
2020-12-21 04:17:44 +03:00
.TH "$title/nowrap/uppercase$" "$section/nowrap$" "$date/nowrap$" "$footer/nowrap$" "hledger User Manuals"
doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
$for(header-includes)$
$header-includes$
$endfor$
$for(include-before)$
$include-before$
$endfor$
$body$
$for(include-after)$
$include-after$
$endfor$
.SH "REPORTING BUGS"
doc: man page template tweaks
2016-04-09 23:37:17 +03:00
Report bugs at http://bugs.hledger.org
(or on the #hledger IRC channel or hledger mail list)
doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
.SH AUTHORS
$if(author)$
$for(author)$$author$$sep$; $endfor$.
$else$
doc: man page template tweaks
2016-04-09 23:37:17 +03:00
Simon Michael <simon@joyful.com> and contributors
doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
$endif$
.SH COPYRIGHT
;doc: man page footer updates
2020-12-09 06:25:52 +03:00
Copyright (C) 2007-2020 Simon Michael.
doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
.br
doc: update man pages
2016-04-13 06:31:17 +03:00
Released under GNU GPL v3 or later.
doc: generate man pages for each package (#282) There are now six man pages, one for each main executable and file format, generated from markdown by the mighty pandoc. They are basically the content of the user manual, split up and moved into the appropriate package directory. I've also committed the generated man files. The man pages' markdown source (hledger/hledger.1.md, hledger-lib/hledger_journal.5.md etc.) are now the master documentation files. The plan is to concatenate them (with a little munging) to form the all-in-one user manual for the website, at release time. This also separates the hledger.org user manual from the latest doc commits, which should simplify website management.
2015-10-20 16:26:09 +03:00
.SH SEE ALSO
;doc: tweak man pages' See also
2020-12-20 20:04:40 +03:00
hledger(1), hledger\-ui(1), hledger\-web(1), ledger(1)
hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_timedot(5)
Reference in New Issue Copy Permalink