tastytea/epubgrep
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 9 Wiki Activity

Update man page.

Browse Source 
- Add --basic-regexp and --grep
- Expand description
- Document configuration file syntax
This commit is contained in:
tastytea 2021-05-23 16:25:12 +02:00
parent 03e07dfc3e
commit f96f07caa7
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
man/epubgrep.1.adoc
View File

@ -18,7 +18,8 @@ epubgrep - Search tool for EPUB ebooks.
== DESCRIPTION == DESCRIPTION
*epubgrep* searches EPUB files in a similar way as grep. It uses the same names *epubgrep* searches EPUB files in a similar way as grep. It uses the same names
for command line switches. for command line switches where possible. However, not all grep switches are
implemented and some additional switches are added.
== OPTIONS == OPTIONS
@ -28,27 +29,53 @@ Display a short help message and exit.
*V*, *--version*:: *V*, *--version*::
Show version, copyright and license. Show version, copyright and license.
*-G*, *--basic-regexp*::
_PATTERN_ is a POSIX basic regular expression. This is the default.
*-E*, *--extended-regexp*:: *-E*, *--extended-regexp*::
_PATTERN_ is extended regular expression. _PATTERN_ is a POSIX extended regular expression.
*--grep*::
In combination with *--basic-regexp* or *--extended-regexp*, _PATTERN_ is
treated as a newline separated list of expressions, a match is found if any of
the expressions in the list match.
*-P*, *--perl-regexp*:: *-P*, *--perl-regexp*::
_PATTERN_ is Perl regular expression. _PATTERN_ is a Perl regular expression.
*-i*, *--ignore-case*:: *-i*, *--ignore-case*::
Ignore case distinctions in pattern and data. Ignore case distinctions in pattern and data.
*-e* _PATTERN_, *--regexp* _PATTERN_:: *-e* _PATTERN_, *--regexp* _PATTERN_::
Use _PATTERN_ for matching. Use additional _PATTERN_ for matching. Can be used more than once.
*-I* _FILE_, *--input-file* _FILE_:: == USAGE
Input file. Can be used more than once.
// == USAGE === Configuration
// === Configuration Every command line switch can be used as an option in the configuration file. If
the switch has no value (it is a simple on switch), it has to be written as
`option = 1`. Do not use quotation marks around the values, they will be taken
literally.
Command line options overwrite configuration file options. Options that can
occur more than once are merged.
==== Example configuration file
This example makes epubgrep always use Perl regular expressions and search for
mentions of the words thyme and oregano in every book.
[source,cfg]
--------------------------------------------------------------------------------
perl-regexp = 1
regexp = \b[Tt]hyme\b
regexp = \b[Oo]regano\b
--------------------------------------------------------------------------------
// == EXAMPLES // == EXAMPLES
== FILES == FILES
*Configuration file*:: *Configuration file*::