simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-12-27 12:24:43 +03:00
Code Issues Projects Releases Wiki Activity

doc: manual: de-emphasize troubleshooting subtopics

Browse Source
This commit is contained in:
Simon Michael 2015-05-21 07:24:20 -07:00
parent cdc4abb497
commit e23f61b771
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/manual.md
View File

@ -1720,12 +1720,12 @@ Here are some issues you might encounter when you run hledger
[mail list](http://list.hledger.org) or [mail list](http://list.hledger.org) or
[bug tracker](http://bugs.hledger.org)): [bug tracker](http://bugs.hledger.org)):
##### Successfully installed, but "No command 'hledger' found" **Successfully installed, but "No command 'hledger' found"**
cabal installs binaries into a special directory, which should be added cabal installs binaries into a special directory, which should be added
to your PATH environment variable. On unix-like systems, it is to your PATH environment variable. On unix-like systems, it is
~/.cabal/bin. ~/.cabal/bin.
##### "Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" errors **"Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" errors**
In order to handle non-ascii letters and symbols (like £), hledger needs In order to handle non-ascii letters and symbols (like £), hledger needs
an appropriate locale. This is usually configured system-wide; you can an appropriate locale. This is usually configured system-wide; you can
also configure it temporarily. The locale may need to be one that also configure it temporarily. The locale may need to be one that
@ -1769,33 +1769,33 @@ accepts `fr_FR.UTF8`, mac osx requires exactly `fr_FR.UTF-8`).
Here are some things to be aware of. Here are some things to be aware of.
##### Add-on-specific options must follow -- **Add-on-specific options must follow --**
When invoking an add-on via hledger, add-on flags which are not also When invoking an add-on via hledger, add-on flags which are not also
understood by the main hledger executable must have a `--` argument understood by the main hledger executable must have a `--` argument
preceding them. Eg hledger-web's `--server` flag must be used like so: preceding them. Eg hledger-web's `--server` flag must be used like so:
`hledger web -- --server`. `hledger web -- --server`.
##### -w/--width and --debug options must be written without whitespace **-w/--width and --debug options must be written without whitespace**
Up to hledger 0.23, these optional-value flags [did not work](https://github.com/simonmichael/hledger/issues/149) with whitespace between the flag and value. Up to hledger 0.23, these optional-value flags [did not work](https://github.com/simonmichael/hledger/issues/149) with whitespace between the flag and value.
IE these worked: `--debug`, `-w`, `--debug=2`, `-w100`, but these did not: `--debug 2`, `-w 100`. IE these worked: `--debug`, `-w`, `--debug=2`, `-w100`, but these did not: `--debug 2`, `-w 100`.
From 0.24, a value is required and the whitespace does not matter. From 0.24, a value is required and the whitespace does not matter.
##### Not all of Ledger's journal file syntax is supported **Not all of Ledger's journal file syntax is supported**
See [file format differences](faq#file-format-differences). See [file format differences](faq#file-format-differences).
##### balance is less speedy than Ledger's on large data files **balance is less speedy than Ledger's on large data files**
hledger's balance command (in particular) takes more time, and uses more memory, than Ledger's. hledger's balance command (in particular) takes more time, and uses more memory, than Ledger's.
This becomes more noticeable with large data files. This becomes more noticeable with large data files.
##### Windows CMD.EXE **Windows CMD.EXE**
Non-ascii characters and colours are not supported. Non-ascii characters and colours are not supported.
##### Windows cygwin/msys/mintty **Windows cygwin/msys/mintty**
The tab key is not supported in hledger add. The tab key is not supported in hledger add.