Commit graph

571 commits

Author SHA1 Message Date
Alexis Hildebrandt
217193608a [doc] Use specific example to explain environment vars
[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
3b74b20edd [doc] Add texinfo reference for permissive option
to related balance assertions section.

[ci skip]
2015-01-27 21:58:41 +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
thdox
12c563614c Add documentation for bugzilla #1105, and align documentation between
ledger-reconcile.el and ledger-mode.texi.
2015-01-21 10:50:24 +01:00
thdox
37f10ab75c Minor documentation fixes 2015-01-21 10:50:22 +01:00
Alexis Hildebrandt
ba46240921 [tests] Improve option parsing in CheckTexinfo.py
* Replace @ftable @code argument with @option of @command depending
  on the documented items

* Remove @c option comment from @items documenting options
2015-01-21 08:03:53 +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
4ec3c93829 [doc] Remove unsupported value expressions
The following value expressions result in an error: A, B, g, G, I, v, V

Tested using:
% for o in A B g G I v V; do
  ledger -f test/input/sample.dat -F "%(${o}(amount))\n" reg
done
While handling posting from "test/input/sample.dat", line 17:
>     Assets:Bank:Checking                           $1,000.00
Error: The A value expression variable is no longer supported
...

[ci skip]
2015-01-20 17:20:14 +01:00
Alexis Hildebrandt
197fb6d9b6 [doc] Add more tests 2015-01-20 17:18:29 +01:00
Alexis Hildebrandt
9032f49bef [doc] Document some value expressions in manpage
[ci skip]
2015-01-20 17:18:13 +01:00
Alexis Hildebrandt
d7f4d94c88 [doc] Improve spelling and wording
[ci skip]
2015-01-20 17:17:56 +01:00
Alexis Hildebrandt
a36a7873f7 Merge pull request #378 from kain88-de/manual-install-instructions
Manual install instructions

[ci skip]
2015-01-20 16:27:09 +01:00
Max Linke
5f9d4f5bf1 Refer to INSTALL.md rather then README.md
[ci skip]
2015-01-20 15:16:59 +01:00
Alexis Hildebrandt
7dd834f843 Merge pull request #376 from thdox/add-to-index4
Add single letter directive to index

[ci skip]
2015-01-20 15:09:00 +01:00
Alexis Hildebrandt
8452fa4266 Merge pull request #377 from thdox/command-line
Make consistent the syntax of "command-line"

[ci skip]
2015-01-20 14:51:05 +01:00
Alexis Hildebrandt
35a4fa5978 [doc] Fix broken cross reference to test types
[ci skip]
2015-01-20 14:45:02 +01:00
Max Linke
fd69705917 Add hint to check README.md for build instructions
I also removed some sentences that were useful for older build systems.
[ci skip]
2015-01-20 13:50:56 +01:00
Max Linke
a21d78e60c Update install instruction in manual
[ci skip]
2015-01-20 13:45:58 +01:00
thdox
27da696c55 Make consistent the syntax of "command-line"
And other typos fixes
2015-01-20 13:44:17 +01:00
thdox
c066156f09 Add cross-ref for bucket and year.
On top of @node, @xref{} can also be linked to @anchor.
[ci skip]
2015-01-20 13:35:08 +01:00
Alexis Hildebrandt
97ee2d23d0 [doc] Use Ledger_VERSION_* make variables for version
[ci skip]
2015-01-20 11:02:56 +01:00
thdox
dbf1574ab7 Add those single letter directives to index. 2015-01-19 20:50:24 +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
012ce5ef10 [doc] Add documentation on running and writing tests
Minor wording edit
[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
Steve Purcell
d5c1e05a59 Merge remote-tracking branch 'refs/remotes/ledger/master' into next 2015-01-14 18:37:45 +00:00
aleksejrs
b7190a69a8 Typo in the manual: "legder" 2015-01-14 20:42:16 +03:00
Alexis Hildebrandt
719049a989 Merge DEVELOP.md into CONTRIBUTING.md
Improve readability of Markdown by moving links
to the bottom of the file.

[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-11 16:57:21 +01:00
Alexis Hildebrandt
64a7b13492 Move LICENSE file
The LICENSE.rtf file can be generated from LICENSE.md easily if needed,
at the moment there seems to be no use for it, since CPack isn't used
to generate binary distribution archives.

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-11 16:30:04 +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
Alexis Hildebrandt
3a1ab67092 [tests] Fix new DocTest A9349E4 2015-01-10 15:27:24 +01:00