misc doc updates

This commit is contained in:
Simon Michael 2009-07-14 21:51:10 +00:00
parent 94257a2cf5
commit a1de72bea5
2 changed files with 12 additions and 9 deletions

View File

@ -1,7 +1,7 @@
# hledger project makefile # hledger project makefile
# optional features described in MANUAL, comment out if you don't have the libs # optional features described in MANUAL, comment out if you don't have the libs
OPTFLAGS=-DHAPPS -DVTY OPTFLAGS=-DHAPPS -DVTY
# command to run during "make ci" # command to run during "make ci"
CICMD=test CICMD=test
@ -85,7 +85,8 @@ hledgerlinux: setversion
continuous ci: setversion continuous ci: setversion
sp --no-exts --no-default-map -o hledger ghc --make hledger.hs $(BUILDFLAGS) --run $(CICMD) sp --no-exts --no-default-map -o hledger ghc --make hledger.hs $(BUILDFLAGS) --run $(CICMD)
# build the standalone unit test runner. Requires test-framework. # build the standalone unit test runner. Requires test-framework, which
# may not work on windows.
tools/unittest: tools/unittest.hs tools/unittest: tools/unittest.hs
ghc --make -threaded -O2 tools/unittest.hs ghc --make -threaded -O2 tools/unittest.hs
@ -230,9 +231,11 @@ sample.ledger:
###################################################################### ######################################################################
# DOCUMENTATION # DOCUMENTATION
# website/ and website/api-doc/ always exist. website contains both # Documentation source files are UPPERCASE files in the top directory.
# generated files (UPPERCASE.html) and revision-controlled resource files # website/ contains both html generated from these (UPPERCASE.html) and
# (everything else). website/api-doc contains only generated files. # revision-controlled resource files (everything else). website/api-doc
# contains only generated files.
cleandocs: cleandocs:
rm -rf website/[A-Z]*.html website/api-doc/* rm -rf website/[A-Z]*.html website/api-doc/*

View File

@ -28,16 +28,16 @@ usagehdr =
"COMMAND is one of (may be abbreviated):\n" ++ "COMMAND is one of (may be abbreviated):\n" ++
" add - prompt for new transactions and add them to the ledger\n" ++ " add - prompt for new transactions and add them to the ledger\n" ++
" balance - show accounts, with balances\n" ++ " balance - show accounts, with balances\n" ++
" convert - convert CSV data to ledger format and print on stdout\n" ++ " convert - read CSV bank data and display in ledger format\n" ++
" histogram - show transaction counts per day or other interval\n" ++ " histogram - show a barchart of transactions per day or other interval\n" ++
" print - show transactions in ledger format\n" ++ " print - show transactions in ledger format\n" ++
" register - show transactions as a register with running balance\n" ++ " register - show transactions as a register with running balance\n" ++
" stats - show various statistics for a ledger\n" ++ " stats - show various statistics for a ledger\n" ++
#ifdef VTY #ifdef VTY
" ui - run a simple curses-based text ui\n" ++ " ui - run a simple text-based UI\n" ++
#endif #endif
#ifdef HAPPS #ifdef HAPPS
" web - run a simple web ui\n" ++ " web - run a simple web-based UI\n" ++
#endif #endif
" test - run self-tests\n" ++ " test - run self-tests\n" ++
"\n" ++ "\n" ++