File: compatibility.md

package info (click to toggle)
ledger2beancount 2.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 904 kB
  • sloc: perl: 1,920; sh: 151; makefile: 22
file content (49 lines) | stat: -rw-r--r-- 1,728 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Beancount compatibility

The syntax of beancount is quite stable but it's expected to become
slightly less restrictive as some missing features are implemented (such
as posting-level tags).

ledger2beancount aims to be compatible with the latest official release
of beancount, but some functionality may require an unreleased version of
beancount.  You can install the latest development version of beancount
directly from the beancount repository:

```shell
pip3 install git+https://github.com/beancount/beancount/
```

Currently, there are no features that require an unreleased version of
beancount.

ledger2beancount is largely compatible with Beancount 2.0.  If you
use the following features, you need Beancount 2.1:

* UTF-8 letters and digits in account names
* Full-line comments in transactions
* Transaction tags on multiple lines

# Ledger compatibility

ledger2beancount is compatible with the latest release of ledger and
supports the majority of features, as documented in the previous
section.

There is one limitation, though.  While ledger doesn't care about the
encoding of files (as long as your operating system processes them
correctly), ledger2beancount expects input to be UTF-8.  This is
because beancount files have to be UTF-8, so users are expected to
have an environment that is compatible with UTF-8 anyway.

Modern operating systems use UTF-8 by default.  On Windows, UTF-8
may need to be set explicitly for the console.  If you run into
encoding issues, you should run the following command before you
use ledger2beancount:

```shell
chcp 65001
```

This sets the code page 65001, which is [UTF-8 on Windows
systems](https://docs.microsoft.com/en-us/windows/win32/intl/code-page-identifiers).