jeremy/esv
1
Fork 0
Code Releases Activity

esv.conf.5: revise and update

Browse source 
This manual has been neglected and hasn't been touched since the initial
source code release. Ouch!
This commit is contained in:
Jeremy Baxter 2024-06-18 19:30:14 +12:00
parent b5399bc8fa
commit 98b3a385ad
1 changed files with 29 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

47
esv.conf.5
View file

@ -7,14 +7,15 @@
.Sh DESCRIPTION
The
.Xr esv 1
utility uses a configuration file to customize its behaviour.
This file uses the standard Unix configuration file format, with
section-based key-value pairs. An example is listed below:
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
Comments can be used by putting a pound
Comments can be used by putting a hashtag
.Dq #
symbol at the beginning of a line.
.Pp
@ -26,18 +27,29 @@ The
section contains settings that modify the way passages are displayed.
.Bl -tag -width keyword
.It Em footnotes
Boolean value that determines whether or not footnotes are displayed
under the text.
True/false value that determines whether
footnotes are displayed under the text.
.It Em headings
Boolean value that determines whether or not headings are displayed.
.It Em passage_references
Boolean value that determines whether or not passage references are
displayed before the text.
.It Em verse_numbers
Boolean value that determines whether or not verse numbers are displayed.
.It Em line_length
Integer value that determines the maximum length for each line of
the passage.
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
@ -49,19 +61,18 @@ passed to the ESV Bible API.
Your API key, available from
.Lk http://api.esv.org
.Pp
This key is required, and is automatically filled in.
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