.\" Generated by scdoc 1.11.0
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ledger2beancount" "5" "2020-11-04"
.P
.P
.P
.SH NAME
.P
ledger2beancount - configuration file for \fBledger2beancount\fR(1)
.P
.SH INPUT OPTIONS
.P
The following options may be needed for \fBledger2beancount\fR to interpret
your \fBledger\fR files correctly.
.P
\fBdate_format\fR <string>
.RS 4
The date format used in your \fBledger\fR file (default: \fB%Y-%m-%d\fR).
.P
.RE
\fBdate_format_no_year\fR <string>
.RS 4
The date format for dates without the year when \fBledger\fR's
\fBY\fR/\fByear\fR directive is used (default: \fB%m-%d\fR).
.P
.RE
\fBledger_indent\fR <int>
.RS 4
Sets the indentation level used in your ledger file (default: \fB4\fR).
.P
.RE
\fBdecimal_comma\fR true|false
.RS 4
Parses amounts with the decimal comma (e.g. \fB10,00 EUR\fR).  Set
this option to \fBtrue\fR if you use option \fB--decimal-comma\fR in
\fBledger\fR.
.P
.RE
\fBhledger\fR true|false
.RS 4
Tells \fBledger2beancount\fR whether to attempt to parse
\fBhledger\fR(1)-specific features.
.P
.RE
.SH OTHER OPTIONS
.P
\fBbeancount_indent\fR <int>
.RS 4
Sets the indentation level for the generated beancount file
(default: \fB2\fR).
.P
.RE
\fBoperating_currencies\fR
.RS 4
A list of frequently used currencies.  This is used by
\fBfava\fR, the web UI for beancount.
.P
.RE
\fBautomatic_declarations\fR true|false
.RS 4
Emit account and commodity declarations. (Default: \fBtrue\fR)
.P
Note: the declarations done in ledger via \fBaccount\fR and
\fBcommodity\fR declarations are always converted.  If this option
is \fBtrue\fR, declarations are created for those which have not
been explicitly declared in \fBledger\fR but used.
.P
.RE
\fBaccount_open_date\fR <string>
.RS 4
The date used to open accounts (default: \fB1970-01-01\fR).
.P
.RE
\fBcommodities_date\fR <string>
.RS 4
The date used to create commodities (default: \fB1970-01-01\fR).
.P
.RE
\fBbeancount_header\fR <file>
.RS 4
Specifies a file which serves as a beancount "header", i.e. it's
put at the beginning of the converted beancount file.  You can
use such a header to specify options for beancount, such as
\fBoption "title"\fR, define \fBplugin\fR directives or beancount \fBquery\fR
information.
.P
.RE
\fBignore_marker\fR <string>
.RS 4
Specifies a marker that tells \fBledger2beancount\fR(1) to ignore
a line if the marker is found.
.P
.RE
\fBkeep_marker\fR <string>
.RS 4
Specifies a marker that tells \fBledger2beancount\fR(1) to take
a line from the input that is commented out, uncomment it and
display it in the output.
.P
.RE
\fBconvert_virtual\fR true|false
.RS 4
Specifies whether virtual postings should be converted.  If set
to \fBtrue\fR, virtual postings in brackets will be made into real
accounts.  (Virtual postings in parentheses are always ignored,
regardless of this option.)
.P
.RE
\fBaccount_map\fR
.RS 4
Specifies a hash of account names to be mapped to other account
names.
.P
.RE
\fBaccount_regex\fR
.RS 4
Specifies a hash of regular expressions to replace account
names.
.P
.RE
\fBcommodity_map\fR
.RS 4
Specifies a mapping of \fBledger\fR commodities to beancount
commodities.
.P
.RE
\fBmetadata_map\fR
.RS 4
Specifies a mapping of \fBledger\fR metadata keys to corresponding
\fBbeancount\fR keys.
.P
.RE
\fBpayee_tag\fR and \fBpayer_tag\fR
.RS 4
Specify a metadata tag (after the mapping done by \fBmetadata_map\fR)
used to set the payee.
.P
.RE
\fBpayee_split\fR
.RS 4
Specifies a list of regular expressions to split \fBledger\fR's payee
field into payee and narration.  You have to use the named capture
groups \fBpayee\fR and \fBnarration\fR.
.P
.RE
\fBpayee_match\fR
.RS 4
Specifies a list of regular expressions and corresponding payees.
The whole \fBledger\fR payee becomes the narration and the matched
payee from the regular expression becomes the payee.
.P
.RE
\fBpostdate_tag\fR <string>
.RS 4
Specifies the metadata tag to be used to store posting
dates. (Use the empty string if you don't want the metadata
to be added to beancount.)
.P
.RE
\fBauxdate_tag\fR <string>
.RS 4
Specifies the metadata tag to be used to store auxiliary dates
(also known as effective dates; or \fBdate2\fR in \fBhledger\fR).
(Use the empty string if you don't want the metadata
to be added to beancount.)
.P
.RE
\fBcode_tag\fR <string>
.RS 4
Specifies the metadata tag to be used to store transaction
codes. (Use the empty string if you don't want the metadata
to be added to beancount.)
.P
.RE
\fBlink_match\fR
.RS 4
Specifies a list of regular expressions that will cause a tag
to be rendered as a link.
.P
.RE
\fBlink_tags\fR
.RS 4
Specifies a list of metadata tags whose values should be
converted to \fBbeancount\fR links instead of metadata.
Tags are case insensitive and values must not contain whitespace.
.P
.RE
\fBcurrency_is_commodity\fR
.RS 4
Specifies a list of commodities that should be treated as
commodities rather than currencies even though they consist
of 3 characters (which is usually a characteristic of a
currency).  Expects beancount commodities (i.e. after
transformation and mapping).
.P
.RE
\fBcommodity_is_currency\fR
.RS 4
Specifies a list of commodities that should be treated as
currencies (in the sense that cost is not retained).
Expects beancount commodities (i.e. after transformation
and mapping).
.P
.RE
.SH AUTHORS
.P
Stefano Zacchiroli and Martin Michlmayr
.P
.SH SEE ALSO
.P
\fBledger2beancount\fR(1), \fBledger\fR(1), \fBhledger\fR(1)
.P
The full documentation for \fBledger2beancount\fR can be found in its manual.
.P