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

doc: bugs/troubleshooting cleanup

Browse Source
This commit is contained in:
Simon Michael 2017-03-29 15:45:33 -07:00
parent 0055f99c77
commit a3c3d58f75
2 changed files with 11 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
hledger/doc/hledger.1.m4.md
View File

@ -75,7 +75,6 @@ _include_(examples.m4.md)
_include_(options.m4.md)
_include_(queries.m4.md)
_include_(commands.m4.md)
_include_(troubleshooting.m4.md)
_man_({{
# ENVIRONMENT
@ -92,11 +91,19 @@ Reads _files_
# BUGS
The need to precede options with `--` when invoked from hledger is awkward.
hledger can't render non-ascii characters when run from a Windows command prompt (up to Windows 7 at least).
The need to precede addon command options with `--` when invoked from hledger is awkward.
When input data contains non-ascii characters, a suitable system locale must be configured (or there will be an unhelpful error).
Eg on POSIX, set LANG to something other than C.
In a Microsoft Windows CMD window, non-ascii characters and colours are not supported.
In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add.
Not all of Ledger's journal file syntax is supported. See [file format differences](faq#file-format-differences).
On large data files, hledger is slower and uses more memory than Ledger.
_include_(troubleshooting.m4.md)
}})

22
hledger/doc/troubleshooting.m4.md
View File

@ -1,7 +1,5 @@
# TROUBLESHOOTING
## Run-time problems
Here are some issues you might encounter when you run hledger
(and remember you can also seek help from the
[IRC channel](http://irc.hledger.org),
@ -63,23 +61,3 @@ $ LANG=fr_FR.utf8 hledger -f my.journal print
Note some platforms allow variant locale spellings, but not all (ubuntu
accepts `fr_FR.UTF8`, mac osx requires exactly `fr_FR.UTF-8`).
## Known limitations
**Command line interface**
Add-on command options, unless they are also understood by the main
hledger executable, must be written after `--`, like this:
`hledger web -- --server`
**Differences from Ledger**
Not all of Ledger's journal file syntax is supported. See [file format differences](faq#file-format-differences).
hledger is slower than Ledger, and uses more memory, on large data files.
**Windows limitations**
In a windows CMD window, non-ascii characters and colours are not supported.
In a windows Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add.