hledger/hledger/Hledger/Cli/Commands
Simon Michael b2c1e0b0ac close: doc tweaks
[ci skip]
2019-01-23 17:26:27 -08:00
..
Accounts.hs journal: save account directives' comments, tags, declaration order 2019-01-18 16:40:35 -08:00
Activity.hs cli: refactor: move commands to a subdirectory, reinstate test command 2017-09-12 10:04:36 -07:00
Add.hs Merge branch 'master' into ExceptTLayer 2018-10-09 11:19:45 -06:00
Balance.hs budget: declaration and (actual) amount sorting for bal --budget 2018-09-24 08:31:19 -10:00
Balancesheet.hs tests: clear out old boilerplate 2018-08-31 18:12:17 -07:00
Balancesheetequity.hs bs/bse/cf/is: remove NoCPP pragma 2018-08-02 08:25:49 +01:00
Cashflow.hs tests: clear out old boilerplate 2018-08-31 18:12:17 -07:00
Checkdates.hs tests: clear out old boilerplate 2018-08-31 18:12:17 -07:00
Checkdupes.hs cli: make check-dupes a builtin command 2017-09-12 19:09:00 -07:00
Close.hs close: fix ghci build / make build working-dir-independent again 2019-01-23 17:26:27 -08:00
Close.md close: doc tweaks 2019-01-23 17:26:27 -08:00
Files.hs cli: command to list included files 2018-09-22 21:47:54 -10:00
Help.hs disambiguate the base-compat imports in hledger package too (#794) 2018-06-04 17:32:45 -07:00
Import.hs import: if there's nothing to import, be quiet 2019-01-08 15:34:19 +00:00
Incomestatement.hs bs/bse/cf/is: use account type declarations if any 2018-10-09 14:24:59 -10:00
Prices.hs lib: flip the arguments of (divide|multiply)[Mixed]Amount (api change) 2018-11-13 17:28:24 -08:00
Print.hs lib: document and test showTransaction*, posting*AsLines 2018-10-22 06:46:31 -07:00
Printunique.hs cli: make print-unique a builtin command 2017-09-12 19:37:31 -07:00
README close: doc tweaks 2019-01-23 17:26:27 -08:00
Register.hs Removed hunit 2018-09-07 13:00:20 -07:00
Registermatch.hs cli: make register-match a builtin command 2017-09-12 19:43:41 -07:00
Rewrite.hs lib: TransactionModifier: clarify 2018-11-13 16:35:46 -08:00
Roi.hs roi: use math-functions lib instead of old statistics version 2018-12-03 15:51:29 -08:00
Stats.hs cli: refactor: move commands to a subdirectory, reinstate test command 2017-09-12 10:04:36 -07:00
Tags.hs tag: first arg filters tag names, the rest filter transactions (#261) 2017-10-17 07:07:34 -07:00

hledger's built-in commands.

Each command has a similarly-named module, Somecommand.hs.

Each command's help is kept in Somecommand.md. 
This file is included by Somecommand.hs to help build the command's --help output,
and by hledger/hledger_commands.m4.md to help build the hledger manual.
It has some special features:

- The first line should specify the command name and any aliases,
  as space or comma-separated words.

- A line containing just _FLAGS_ will be replaced in --help output by
  the command's flags list. Lines above _FLAGS_ are known as the short help.
  If there's no such line, the flags will be displayed at the end. 
  In the manual, no flags list is shown.

- Markdown can be used to influence the appearance of the manuals,
  especially the html version. But the markup will also appear
  uninterpreted in the --help output, so use sparingly.

- Use only one newline on the first line (or cmdargs will display the
  short help with two newlines after each line). This also means
  cmdargs will strip out any blank lines, which prevents use of some
  markdown features.

- Keep the width of short help lines to 76 characters or less, or
  cmdargs will insert newlines. (In Emacs: C-u 77 C-x f).

- GHC, stack, cabal, ghcid etc. won't notice changes in this file;
  you have to also touch the .hs file.