esvsearch.1: document -m

This commit is contained in:
Jeremy Baxter 2025-05-01 19:42:57 +12:00
parent 67171b71dc
commit bc342d0415

View file

@ -7,7 +7,7 @@
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm esvsearch .Nm esvsearch
.Bk -words .Bk -words
.Op Fl eV .Op Fl emV
.Op Fl c Ar config .Op Fl c Ar config
.Ar query .Ar query
.Ek .Ek
@ -45,6 +45,12 @@ for more information.
Instead of showing loose matches for Instead of showing loose matches for
.Ar query , .Ar query ,
only show exact matches. only show exact matches.
.It Fl m
Print matches in a machine-readable format,
where each result takes up just one line.
Any spaces in the book name are replaced with underscores
and a slash character separates the passage reference
from the passage content.
.It Fl V .It Fl V
Print the version number and exit. Print the version number and exit.
.El .El
@ -65,13 +71,7 @@ Part of the
distribution found at distribution found at
.Lk https://reformers.dev/esv .Lk https://reformers.dev/esv
.Sh BUGS .Sh BUGS
.Nm Currently there are no known bugs in
outputs search results in a human-readable manner, .Nm .
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, If you think you've found a potential bug,
please report it to my email address above. please report it to my email address above.