Add a bit of usage information to man page.

The described stuff is not working yet.
This commit is contained in:
tastytea 2021-05-24 07:51:37 +02:00
parent f388dd0511
commit 78230b26e6
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07

View File

@ -57,6 +57,23 @@ Print _NUM_ words of context around matches.
== USAGE
[source,shellsession]
--------------------------------------------------------------------------------
$ epubgrep -i makhno -C 4 The_Bolshevik_Myth.epub
OPS/piece000038.xhtml, Chapter 33. Dark People, page 141: in the campaign against Makhno, and they were exchanging
--------------------------------------------------------------------------------
The output is <file path in epub>, <last headline>, <page number>: <context
before><match><context after>. <last headline> and <page number> may not be available.
=== Differences to grep
epubgrep does not operate on lines, but on whole files. This means you can
search for text spanning multiple lines. All newlines will be replaced by
spaces.
HTML will be stripped unless *--raw* is specified.
=== Configuration
Every command line switch can be used as an option in the configuration file. If