Simon Michael 4c291dc54e doc: use macros not divs to select web/man content

Use slightly clearer m4 macros instead of special divs to mark content
as web only/man only. The temporary doc/*.md files are no longer needed,
slightly more redundant work is done.

2016-04-16 10:09:51 -07:00

3.9 KiB

Raw Blame History

author

date

title

January 2016

hledger-api(1)

web({{ versions({{hledger-api}})

toc }}) man({{

NAME

hledger-api - web API server for the hledger accounting tool

SYNOPSIS

hledger-api [OPTIONS]
hledger api -- [OPTIONS]

DESCRIPTION

hledger is a cross-platform program for tracking money, time, or any other commodity, using double-entry accounting and a simple, editable file format. hledger is inspired by and largely compatible with ledger(1).

}})

hledger-api is a simple web API server, intended to support client-side web apps operating on hledger data. It comes with a series of simple client-side app examples, which drive it’s evolution.

Data is served from the usual hledger journal file: ~/.hledger.journal, $LEDGER_FILE, or another file specified with -f. For more about the format, see hledger(1) or hledger_journal(5).

The server listens for requests on port …

Note there is no built-in access control, so you will need to hide hledger-api behind an authenticating proxy if you want to restrict access.

man({{

ENVIRONMENT

LEDGER_FILE sets the default journal file path. If not set, it is ~/.hledger.journal.

FILES

Reads data from a hledger journal file ($LEDGER_FILE or ~/.hledger.journal by default), or a CSV file plus associated CSV rules file.

BUGS

The need to precede options with -- when invoked from hledger is awkward.

}})

3.9 KiB Raw Blame History Unescape Escape