slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: move main haddock

Browse Source
This commit is contained in:
Simon Michael 2010-05-19 23:41:29 +00:00
parent c50c66ff14
commit 0282aa4697
2 changed files with 37 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Hledger/Cli/Main.hs
View File

@ -1,8 +1,41 @@
{-# LANGUAGE CPP #-}
{-|
The main function is in this separate module so it can be imported by
benchmark scripts. As a side benefit, this avoids a weakness of sp, which
doesn't allow both #! and \{\-\# lines.
hledger - a ledger-compatible accounting tool.
Copyright (c) 2007-2010 Simon Michael <simon@joyful.com>
Released under GPL version 3 or later.
hledger is a partial haskell clone of John Wiegley's "ledger". It
generates ledger-compatible register & balance reports from a plain text
journal, and demonstrates a functional implementation of ledger.
For more information, see http:\/\/hledger.org .
This module provides the main function for the hledger command-line
executable. It is exposed here so that it can be imported by eg benchmark
scripts.
You can use the command line:
> $ hledger --help
or ghci:
> $ ghci hledger
> > l <- readLedger "sample.ledger"
> > register [] ["income","expenses"] l
> 2008/01/01 income income:salary $-1 $-1
> 2008/06/01 gift income:gifts $-1 $-2
> 2008/06/03 eat & shop expenses:food $1 $-1
> expenses:supplies $1 0
> > balance [Depth "1"] [] l
> $-1 assets
> $2 expenses
> $-2 income
> $1 liabilities
> > l <- myLedger
> > t <- myTimelog
See "Hledger.Data.Ledger" for more examples.
-}
module Hledger.Cli.Main where

37
hledger.hs
View File

@ -1,39 +1,4 @@
#!/usr/bin/env runhaskell
{-|
hledger - a ledger-compatible text-based accounting tool.
-- the hledger command-line executable; see Hledger/Cli/Main.hs
Copyright (c) 2007-2010 Simon Michael <simon@joyful.com>
Released under GPL version 3 or later.
hledger is a partial haskell clone of John Wiegley's "ledger" text-based
accounting tool. It generates ledger-compatible register & balance
reports from a plain text journal, and demonstrates a functional
implementation of ledger. For more information, see http:\/\/hledger.org .
You can use the command line:
> $ hledger --help
or ghci:
> $ ghci hledger
> > l <- readLedger "sample.ledger"
> > register [] ["income","expenses"] l
> 2008/01/01 income income:salary $-1 $-1
> 2008/06/01 gift income:gifts $-1 $-2
> 2008/06/03 eat & shop expenses:food $1 $-1
> expenses:supplies $1 0
> > balance [Depth "1"] [] l
> $-1 assets
> $2 expenses
> $-2 income
> $1 liabilities
> > l <- myLedger
> > t <- myTimelog
See "Ledger.Ledger" for more examples.
-}
module Main where
import Hledger.Cli.Main (main)