Commit graph

91 commits

Author SHA1 Message Date
Alexis Hildebrandt
bc487be14b [doc] Improve example for environment variable options
[ci skip]
2015-01-29 16:23:48 +01:00
Alexis Hildebrandt
19f4f587f0 [doc] Add some expression documentation to manpage
Comment undocumented expressions, so the are reported
by test/CheckManpage.py.
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
370e44d61e [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
690e6b6cbe [doc] Add documentation of some expressions
to manpage.

[ci skip]
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
8c48ca879b [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
eca8ffc016 [doc] Improve examples in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
2664343b15 [doc] Fix typo in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
bc16de720e [doc] Improve documentation for option aliases
in mapnpage.

[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
141e7787f5 [doc] Minor typographical changes in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
fccb300044 [doc] Comment empty items in manpage
[ci skip]
2015-01-27 22:02:58 +01:00
Alexis Hildebrandt
f9f2440451 [doc] Change wording in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
6a96a4e68a [doc] Use Tn for HTTP and XML in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
d8bbc40005 [doc] Use .Nm instead of [Ll]edger in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
ce4511a220 [doc] Replace Nm with Sy, Cm, Pa in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
37777c284c [doc] Correct Ar placholders in manpage
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
7634086465 [doc] Replace Nm with more appropriate macros
in manpage such as Fl, Ar, Ev, Em, etc.

[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
0f04246e43 [doc] Improve quoting in manpage
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
91862091c0 [doc] Replace .Nm with .Ic where appropriate
According to mdoc (7) "The `.Nm' macro is used for the document title or
subject name.  It has the peculiarity of remembering the first argument
it was called with, which should always be the subject name of the page."

Therefore it should only be used the print `ledger` in the manpage

For the Ledger commands register, balance, etc The .Ic (internal
command) is much better suited.
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
2d33ddf12f [doc] Use ASCII single quote as apostrophe
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
18e5fa969f [doc] Change FILES section into a Pathname list
[ci skip]
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
185656e191 [doc] Add tests to value and format expressions
and change formatting for value expressions using @defun, @defvar.
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
c637bdded0 Merge pull request #382 from thdox/add-to-doc
Add documentation for --no-pager option.
2015-01-27 21:53:01 +01:00
thdox
97a6761ca7 Add documentation for option --permissive. 2015-01-22 01:35:14 +01:00
thdox
6b5ff2aebf Add documentation for --no-pager option.
Minor updates to --pager documentation.
[ci skip]
2015-01-22 00:57:20 +01:00
Alexis Hildebrandt
213f0341c1 [doc] Comment undocumented options in manpage
so that they are reported properly by test/CheckTests.py
2015-01-21 08:03:35 +01:00
Alexis Hildebrandt
9032f49bef [doc] Document some value expressions in manpage
[ci skip]
2015-01-20 17:18:13 +01:00
Alexis Hildebrandt
31b9964e43 [doc] Improve manpage
as suggested by:
%  mandoc -Tlint doc/ledger.1

[ci skip]
2015-01-16 22:32:20 +01:00
Alexis Hildebrandt
a3dbcae348 [doc] Document -i in manpage
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-16 10:41:13 +01:00
Alexis Hildebrandt
cd5be5f432 [doc] Add FILES section to manpage
to mention ~/.ledgerrc more prominently.
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 22:14:41 +01:00
Alexis Hildebrandt
ba207e773b [doc] Improve explanation for start-of-week option
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 22:13:08 +01:00
Alexis Hildebrandt
3bf4d05989 [doc] Minor typographical improvements to manpage
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:17 +01:00
Alexis Hildebrandt
01252035cd [doc] Add CheckTests to ctest
to check whether all available ledger options documented
and are being tested.

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:16 +01:00
Alexis Hildebrandt
78858382a5 [doc] Insert Ar to separate argument from option
for --period synonyms like --monthly, et al.
[ci skip]
2015-01-11 03:12:49 +01:00
Alexis Hildebrandt
39a5b180c7 [doc] Insert space to correct punctuation in .Xr macro
[ci skip]
2015-01-10 23:30:38 +01:00
Alexis Hildebrandt
f6fdac3c7c [doc] Insert newline to end .Nm macro
to highlight only the xact keyword

[ci skip]
2015-01-10 23:30:20 +01:00
Alexis Hildebrandt
acfc4f8a8a [doc] Remove trailing whitespace in manpage
since "troff can be confused by blank space characters
at the end of a line." -- mdoc (7)

[ci skip]
2015-01-10 23:29:47 +01:00
Jostein Berntsen
5d90ac7a1d Small doc typo fixes 2015-01-09 00:05:10 +01:00
Martin Michlmayr
8838b468df Format commands properly 2014-06-30 19:19:49 -04:00
Martin Michlmayr
cbdcf27605 Typo fix 2014-06-30 19:16:20 -04:00
Martin Michlmayr
b1a6d2ce16 Document --values 2014-06-30 19:15:35 -04:00
Martin Michlmayr
3bf82068b4 Document --unrealized 2014-06-30 19:10:36 -04:00
Jamie Nguyen
8088502eef Fix man page typo 2014-03-23 23:29:39 +00:00
Peter Feigl
977af3d27c Adding documentation of options to man-page from manual. Fixing a few minor typos and mistakes. 2014-02-27 10:24:38 +01:00
Peter Feigl
ecd5097d51 Adding option --no-aliases to completely disable alias expansion 2014-02-26 23:50:50 +01:00
Peter Feigl
75b0a5d8ff Adding option --recursive-aliases, adding documentation to man-page and manual 2014-02-26 09:29:31 +01:00
Craig Earls
e3cd1045d5 Bugs 726 and 727. Remove reference to draft and lisp commands in man page 2012-10-26 09:59:20 -07:00
Martin Michlmayr
f4e6d30736 Document more commands in the man page 2012-03-25 15:25:39 +01:00
Martin Michlmayr
8e6a3ce0d0 Update manual to say that pricesdb option has been renamed to pricedb 2012-03-23 08:51:21 +00:00
John Wiegley
f9088f8836 Added --verify-memory and missing TRACE_[CD]TOR calls 2012-03-18 01:01:30 -05:00
John Wiegley
22c1b867f0 Added option --day-break 2012-03-17 05:27:43 -05:00