hledger/site/docs.md

<!-- * toc -->

# Documentation

<style>
h4 {
margin-bottom:0.2em;
}
/*div.col-sm-5 { border:thin solid gray; }*/
</style>

<div class="container">

<div class="row">
<div class="col-sm-5">
## Getting started

#### [Download](download.html)
How to get hledger installed.

#### [Step by Step tutorial](step-by-step.html)
Small, guided exercises introducing data entry, reporting, and accounting.

#### [Frequently Asked Questions](faq.html)
Some questions and answers, mostly comparing hledger and Ledger.

### Examples

#### [How to read CSV files](how-to-read-csv-files.html)
An example of converting bank data.

#### [How to use account aliases](how-to-use-account-aliases.html)
Aliases for account name rewriting.

#### [How to use another account separator character](how-to-use-another-account-separator-character.html)
Writing `some.sub.account` instead of `some:sub:account`.


## General info

#### [More docs](more-docs.html)
A useful collection of links, eg on accounting, being moved to:

#### [plaintextaccounting.org](http://plaintextaccounting.org)
A comprehensive survey of our larger community and common practices




</div>
<div class="col-sm-5">
## Reference

#### [User Manual](manual.html)
The comprehensive manual, all on one page.

### Tools

Here is the same manual (more or less) organized as unix man pages
(work in progress):

#### [hledger(1)](hledger.1.html)
The main reporting tool and command-line interface.

#### [hledger-ui(1)](hledger-ui.1.html)
A curses-style UI for quick exploration.

#### [hledger-web(1)](hledger-web.1.html)
A web UI for browsing and data entry, personal or shared.

#### [hledger-api(1)](hledger-api.1.html)
A REST-y JSON and file server, good for building client-side UIs.

### File formats

#### [hledger_journal(5)](hledger_journal.5.html)
hledger's primary data format, representing a general journal.

#### [hledger_csv(5)](hledger_csv.5.html)
How hledger reads Comma Separated Value data.

#### [hledger_timelog(5)](hledger_timelog.5.html)
Timeclock format, a sequence of clock-in/clock-out records.

#### [hledger_timedot(5)](hledger_timedot.5.html)
Timedot format, an alternative time logging format.

</div>
</div>

</div>