.Dd $Mdocdate: May 01 2025 $
.Dt ESV.CONF 5
.Os
.Sh NAME
.Nm esv.conf
.Nd configuration file for esv
.Sh DESCRIPTION
The
.Xr esv 1
program uses a configuration file to customize its behaviour.
This file uses a basic plain text format,
with section-based key-value pairs.
An example is listed below:
.Pp
.Dl [section]
.Dl key = value
.Pp
A line beginning with a hashtag
.Dq #
will be considered a
.Dq comment
and will be ignored by
.Xr esv 1 .
.Pp
The available configuration options are as follows:
.Bl -tag -width keyword
.It Sy [passage]
The
.Sy [passage]
section contains settings that modify the way passages are displayed.
.Bl -tag -width keyword
.It Em footnotes
True/false value that determines whether
footnotes are displayed under the text.
.It Em headings
True/false value that determines whether headings are displayed.
.It Em passage-references
True/false value that determines whether
passage references are displayed before the text.
.It Em verse-numbers
True/false value that determines whether verse numbers are displayed
in the text.
.It Em line-length
Integer value that determines the line length limit.
This is related to esv's
.Fl l
option;
it can be specified as 0 for unlimited line lengths,
or it can be left out entirely to choose an appropriate value
based on your terminal's width.
See the documentation for
.Fl l
in
.Xr esv 1
for a thorough description of this heuristic.
.El
.It Sy [api]
The
.Sy [api]
section contains settings that determine information
passed to the ESV Bible API.
.Bl -tag -width -keyword
.It Em key
Your API key, available from
.Lk http://api.esv.org
.Pp
This key is required,
and is automatically filled in since esv 0.2.0.
.It Em parameters
Optional HTTP parameters passed to the API.
If you are using this, make sure it starts with an ampersand symbol
.Dq & .
.El
.El
.Sh FILES
.Bl -tag -width ~/.config/esv.conf
.It Pa ~/.config/esv.conf
default configuration file location
.El
.Sh SEE ALSO
.Xr esv 1