2021-05-23 06:35:04 +02:00
|
|
|
= epubgrep(1)
|
|
|
|
|
:doctype: manpage
|
|
|
|
|
:Author: tastytea
|
|
|
|
|
:Email: tastytea@tastytea.de
|
2021-05-24 07:50:50 +02:00
|
|
|
:Date: 2021-05-24
|
2021-05-23 06:35:04 +02:00
|
|
|
:Revision: 0.0.0
|
|
|
|
|
:man source: epubgrep
|
|
|
|
|
:man manual: General Commands Manual
|
|
|
|
|
|
|
|
|
|
== NAME
|
|
|
|
|
|
|
|
|
|
epubgrep - Search tool for EPUB ebooks.
|
|
|
|
|
|
|
|
|
|
== SYNOPSIS
|
|
|
|
|
|
|
|
|
|
*epubgrep* [_OPTION_]… _PATTERN_ [_FILE_]…
|
|
|
|
|
|
|
|
|
|
== DESCRIPTION
|
|
|
|
|
|
|
|
|
|
*epubgrep* searches EPUB files in a similar way as grep. It uses the same names
|
2021-05-23 16:25:12 +02:00
|
|
|
for command line switches where possible. However, not all grep switches are
|
|
|
|
|
implemented and some additional switches are added.
|
2021-05-23 06:35:04 +02:00
|
|
|
|
|
|
|
|
== OPTIONS
|
|
|
|
|
|
|
|
|
|
*-h*, *--help*::
|
|
|
|
|
Display a short help message and exit.
|
|
|
|
|
|
|
|
|
|
*V*, *--version*::
|
|
|
|
|
Show version, copyright and license.
|
|
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
*-G*, *--basic-regexp*::
|
|
|
|
|
_PATTERN_ is a POSIX basic regular expression. This is the default.
|
|
|
|
|
|
2021-05-23 06:35:04 +02:00
|
|
|
*-E*, *--extended-regexp*::
|
2021-05-23 16:25:12 +02:00
|
|
|
_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.
|
2021-05-23 06:35:04 +02:00
|
|
|
|
|
|
|
|
*-P*, *--perl-regexp*::
|
2021-05-23 16:25:12 +02:00
|
|
|
_PATTERN_ is a Perl regular expression.
|
2021-05-23 06:35:04 +02:00
|
|
|
|
|
|
|
|
*-i*, *--ignore-case*::
|
|
|
|
|
Ignore case distinctions in pattern and data.
|
|
|
|
|
|
|
|
|
|
*-e* _PATTERN_, *--regexp* _PATTERN_::
|
2021-05-23 16:25:12 +02:00
|
|
|
Use additional _PATTERN_ for matching. Can be used more than once.
|
|
|
|
|
|
2021-05-24 07:50:50 +02:00
|
|
|
*-a*, *--raw*::
|
|
|
|
|
Do not strip HTML before searching.
|
|
|
|
|
|
|
|
|
|
*-C* _NUM_, **context* _NUM_::
|
|
|
|
|
Print _NUM_ words of context around matches.
|
|
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
== USAGE
|
|
|
|
|
|
|
|
|
|
=== Configuration
|
2021-05-23 06:35:04 +02:00
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
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.
|
2021-05-23 06:35:04 +02:00
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
Command line options overwrite configuration file options. Options that can
|
|
|
|
|
occur more than once are merged.
|
2021-05-23 06:35:04 +02:00
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
==== 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
|
|
|
|
|
--------------------------------------------------------------------------------
|
2021-05-23 06:35:04 +02:00
|
|
|
|
|
|
|
|
// == EXAMPLES
|
|
|
|
|
|
2021-05-23 16:25:12 +02:00
|
|
|
|
2021-05-23 06:35:04 +02:00
|
|
|
== FILES
|
|
|
|
|
|
|
|
|
|
*Configuration file*::
|
|
|
|
|
* If `XDG_CONFIG_HOME` is defined: `${XDG_CONFIG_HOME}/epubgrep.conf`
|
|
|
|
|
* If `HOME` is defined: `${HOME}/.config/epubgrep.conf`
|
|
|
|
|
* Otherwise: `epubgrep.conf`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
== KNOWN BUGS
|
|
|
|
|
|
|
|
|
|
EPUB files with non-ASCII file names only work reliably when the system locale
|
|
|
|
|
uses an encoding which has the necessary characters. Technically EPUBs must use
|
|
|
|
|
UTF-8 for file names but it is usually recommended to only use ASCII (ASCII is
|
|
|
|
|
valid UTF-8). If your system locale is not UTF-8, files may be silently skipped.
|
|
|
|
|
You can work around this by calling epubgrep like this:
|
|
|
|
|
`LC_ALL="C.UTF-8" epubgrep`
|
|
|
|
|
|
|
|
|
|
== REPORTING BUGS
|
|
|
|
|
|
|
|
|
|
Bugtracker: https://schlomp.space/tastytea/epubgrep/issues
|
|
|
|
|
|
|
|
|
|
E-mail: tastytea@tastytea.de
|
|
|
|
|
|
|
|
|
|
== SEE ALSO
|
|
|
|
|
|
|
|
|
|
*perlre*(1)
|
|
|
|
|
|
|
|
|
|
// LocalWords: epubgrep
|
