ledger/doc
Bradley M. Kuhn 06356ebf90 Make reference and link to Bug Report #789 in fixed directive documentation.
Due to weirdness that's currently true with the existing next branch of
ledger, I believe it's important to tell users in the documentation that
there are some discrepancies in the 'fixed' directive behavior.

The documentation from my previous commit is written to explain what
'fixed' *should* do; adding the bug report link here is a placeholder to
tell users that it may not do what they think it does.

Obviously, if someone closes #789, they should remove this paragraph added
herein.  But, if the bug report is closed, but the documentation lags
behind, the worst that happens is some users have to click through to see
the bug is closed.
2012-09-14 16:54:12 -04:00
..
CMakeLists.txt Converted the Ledger build system to use CMake 2012-05-20 04:48:05 -05:00
Doxyfile The Doxyfile target needs to be %builddir%/doc 2012-02-19 16:07:17 -06:00
grammar.y Untabified all source files 2010-06-11 17:02:25 -04:00
INSTALL Moved several documentation files into the 'doc' directory. 2008-08-07 23:25:42 -04:00
ledger.1 Document more commands in the man page 2012-03-25 15:25:39 +01:00
ledger.texi Add warning to docs about whitespace in ledger format. 2011-09-01 17:31:49 -05:00
ledger3.texi Make reference and link to Bug Report #789 in fixed directive documentation. 2012-09-14 16:54:12 -04:00
LICENSE Increased copyright range to include 2009. 2009-01-20 01:53:31 -04:00
LICENSE-sha1 Renamed license file for sha1. 2009-01-23 19:50:08 -04:00
LICENSE-utfcpp Added support for Unicode text in Ledger files, thanks to 'utfcpp', which can 2009-01-23 19:50:00 -04:00
LICENSE.rtf Roel Vanhout's build files for Visual Studio 2008 2011-03-25 03:20:21 -04:00
Makefile makefile to build website docs 2012-01-22 16:25:33 -08:00
NEWS Added NEWS entries for 2.6.2 and 2.6.3 2010-06-19 13:34:03 -04:00
README Untabified all source files 2010-06-11 17:02:25 -04:00

                          Welcome to Ledger

                 the command-line accounting program

Introduction
============

Ledger is an accounting program which is invoked from the command-line using a
textual ledger file.  To start using Ledger, you will need to create such a
file containing your financial postings.  A sample has been provided in the
file "sample.dat".  See the documentation (ledger.pdf, or ledger.info) for
full documentation on creating a ledger file and using Ledger to generate
reports.

Once you have such a file -- you might call it "ledger.dat" -- you can start
looking at balances and account registers using commands like the following:

  ledger -f ledger.dat balance assets:checking
  ledger -f ledger.dat register expenses:food

This assumes, of course, that like the sample file you use account names such
as "Assets:Checking" and "Expenses:Food".  If you use other account names, you
will need to vary the reporting commands you use accordingly.


Building
========

To build Ledger, you will need a fairly modern C++ compiler (gcc 2.95 will not
work), and at least these two libraries installed:

    gmp        GNU multi-precision library
    pcre       Perl regular expression library

(On some GNU/Linux systems, the packages you need to install are called
"gmp-dev" and "pcre-dev").

Once you have determined where the headers and libraries for the above
packages are installed, run the script "configure", passing those paths.  If
you installed everything under /usr/local, you can probably just type
"./configure".  Otherwise, do this:

    ./configure CPPFLAGS=-I<INCLUDE-PATH>  LDFLAGS=-L<LIBRARY-PATH>

If you need to specify multiple include or library paths, then do this:

    ./configure CPPFLAGS="-I<PATH1> -I<PATH2>"  LDFLAGS="-L<PATH1> -L<PATH2>"

Once configure is done running, just type:

    make install


Mailing List and IRC
====================

If you need help on how to use Ledger, or run into problems, you can join the
Ledger mailing list at the following Web address:

    http://groups.google.com/group/ledger-cli

You can also find help at the #ledger channel on the IRC server
irc.freenode.net.