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

Improve short description and add license information to readme.
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
tastytea 2021-05-25 11:08:08 +02:00
parent b9df8a8279
commit 165d8597b6
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.adoc
View File

@ -16,7 +16,18 @@
:uri-asciidoc: http://asciidoc.org/
:uri-termcolor: https://termcolor.readthedocs.io/
*{project}* is a search tool for EPUB e-books.
:license: https://schlomp.space/tastytea/{project}/src/branch/main/LICENSE
:license-termcolor: https://schlomp.space/tastytea/{project}/src/branch/main/dist/termcolor/LICENSE
*{project}* is a search tool for EPUB e-books. It does not operate on lines, but
on whole files. All newlines will be replaced by spaces and HTML will be
stripped. This means you can search for text spanning multiple lines and don't
have to worry about HTML tags in the text.
{project} is licensed under the
link:{license}[AGPL-3.0-only]
license. The bundled link:{uri-termcolor}[Termcolor] is licensed under the
link:{license-termcolor}[BSD-3-Clause] license.
== Usage

11
man/epubgrep.1.adoc
View File

@ -2,7 +2,7 @@
:doctype: manpage
:Author: tastytea
:Email: tastytea@tastytea.de
:Date: 2021-05-24
:Date: 2021-05-25
:Revision: 0.0.0
:man source: epubgrep
:man manual: General Commands Manual
@ -68,10 +68,11 @@ before><match><context after>. <last headline> and <page number> may not be avai
=== 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
and HTML will be stripped. Use *--raw* if you want to search in the raw files
instead.
epubgrep does not operate on lines, but on whole files. All newlines will be
replaced by spaces (multiple newlines will be condensed into one space) and HTML
will be stripped. This means you can search for text spanning multiple lines and
don't have to worry about HTML tags in the text. Use *--raw* if you want to
search in the raw files instead.
=== Configuration