esvsearch.1: init man page
This commit is contained in:
parent
ec8be68b49
commit
df6abbf50c
2 changed files with 73 additions and 0 deletions
72
esvsearch.1
Normal file
72
esvsearch.1
Normal file
|
@ -0,0 +1,72 @@
|
|||
.Dd $Mdocdate: June 26 2024 $
|
||||
.Dt ESVSEARCH 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm esvsearch
|
||||
.Nd search the Bible
|
||||
.Sh SYNOPSIS
|
||||
.Nm esvsearch
|
||||
.Bk -words
|
||||
.Op Fl V
|
||||
.Op Fl c Ar config
|
||||
.Ar query
|
||||
.Ek
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
searches the Bible for the given
|
||||
.Ar query .
|
||||
.Pp
|
||||
Like
|
||||
.Xr esv 1 ,
|
||||
.Nm
|
||||
requires a configuration file to operate.
|
||||
This is required to know the API key to use
|
||||
when accessing the ESV Bible online.
|
||||
.Nm
|
||||
uses the same configuration file as esv,
|
||||
and it uses the same heuristics in determining the configuration file as well,
|
||||
except that it does not
|
||||
create a configuration file automatically
|
||||
if one does not already exist;
|
||||
you will need to invoke
|
||||
.Xr esv 1
|
||||
for the first time before running
|
||||
.Nm .
|
||||
.Bl -tag -width 123456
|
||||
.It Fl c Ar config
|
||||
Read the configuration from the path
|
||||
.Ar config .
|
||||
See the documentation on
|
||||
.Fl c
|
||||
in
|
||||
.Xr esv 1
|
||||
for more information.
|
||||
.Sx ENVIRONMENT ) .
|
||||
.It Fl V
|
||||
Print the version number and exit.
|
||||
.El
|
||||
.Sh EXAMPLES
|
||||
Search the Bible for verses containing
|
||||
.Dq rabble :
|
||||
.Pp
|
||||
.Dl esvsearch rabble
|
||||
.Pp
|
||||
.Sh SEE ALSO
|
||||
.Xr esv 1 ,
|
||||
.Xr esv.conf 5
|
||||
.Sh AUTHORS
|
||||
.An Jeremy Baxter Aq Mt jeremy@baxters.nz
|
||||
.Sh BUGS
|
||||
.Nm
|
||||
outputs search results in a human-readable manner,
|
||||
which makes it nice for humans to read but difficult
|
||||
for machines to parse and store.
|
||||
.Nm
|
||||
should support outputting results in a shell-readable format
|
||||
and the JSON format.
|
||||
.Pp
|
||||
If you think you've found a potential bug,
|
||||
please report it to me using my email address above.
|
||||
.Pp
|
||||
Existing bugs and planned features can be found on the bug tracker:
|
||||
.Lk https://todo.sr.ht/~jeremy/esv
|
Loading…
Add table
Add a link
Reference in a new issue