tastytea/epubgrep
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 9 Wiki Activity
Search tool for EPUB e-books
107 Commits 1 Branch 10 Tags 2.8 MiB
C++ 85.5%
CMake 14.5%
81f16bef7d
Go to file
tastytea 81f16bef7d
All checks were successful
continuous-integration/drone/push Build is passing
Details
Improve compile instructions.
2021-05-25 14:24:20 +02:00
cmake std::filesystem compatibility for older GCC. 2021-05-20 10:37:45 +02:00
dist/termcolor Merge commit '6c33fb4dcebd5464d89ca3fb98bdf23847d81fbf' as 'dist/termcolor' 2021-05-25 10:43:32 +02:00
man Add --nocolor to man page. 2021-05-25 11:56:17 +02:00
src Add --nocolor switch. 2021-05-25 11:52:13 +02:00
tests Add test for search helpers. 2021-05-24 21:38:44 +02:00
translations Update german translation. 2021-05-25 12:33:07 +02:00
.clang-format Add .clang-tify and .clang-format. 2021-05-21 03:24:28 +02:00
.clang-tidy Add .clang-tify and .clang-format. 2021-05-21 03:24:28 +02:00
.drone.yml Support CMake 3.12. 2021-05-25 07:38:07 +02:00
.editorconfig Initial commit. 2021-05-20 04:34:06 +02:00
.gitignore (Re-)generate .pot file by default, update readme. 2021-05-20 07:58:42 +02:00
AUTHORS Initial commit. 2021-05-20 04:34:06 +02:00
CMakeLists.txt Version bump 0.2.0. 2021-05-25 12:12:32 +02:00
CODE_OF_CONDUCT.adoc Initial commit. 2021-05-20 04:34:06 +02:00
CONTRIBUTING.adoc Add translator's information. 2021-05-20 08:05:34 +02:00
CREDITS Typo in readme, add Termcolor to CREDITS. 2021-05-25 11:07:37 +02:00
LICENSE Initial commit. 2021-05-20 04:34:06 +02:00
README.adoc Improve compile instructions. 2021-05-25 14:24:20 +02:00
screenshot.png Add screenshot. 2021-05-25 11:43:20 +02:00

README.adoc

epubgrep

epubgrep 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.

epubgrep is licensed under the AGPL-3.0-only. The bundled Termcolor is licensed under the BSD-3-Clause license.

Table of Contents

Usage

Screenshot of epubgrep, showing the output of 2 book searches.

See man page for more information.

Install

Packaging status

Gentoo

eselect repository enable guru
echo 'app-text/epubgrep' >> /etc/portage/package.accept_keywords/epubgrep
emaint sync -r guru
emerge -a app-text/epubgrep

From source

Dependencies

  • Tested OS: Linux

  • C++ compiler with C++17 support (tested: GCC 7/10, clang 6/11)

  • CMake (at least: 3.12)

  • Boost (tested: 1.75.0 / 1.65.0)

  • gettext (tested: 0.21 / 0.19)

  • libarchive (tested: 3.5 / 3.2)

  • fmt (tested: 7.0 / 4.0)

  • AsciiDoc (tested: 8.6 / 9.0)

  • Termcolor (tested: 2.0) (If not found, the bundled version is used.)

  • Optional

    • Tests: Catch (tested: 2.13 / 1.10)

Install dependencies in Debian or Ubuntu

Or distributions that are derived from Debian or Ubuntu. You will need at least Debian buster or Ubuntu bionic.

apt install build-essential cmake libboost-program-options-dev libboost-locale-dev libboost-regex-dev gettext libarchive-dev libfmt-dev asciidoc

Get sourcecode

Release

Download the current release at schlomp.space.

Development version
git clone https://schlomp.space/tastytea/epubgrep.git

Compile

In a terminal, go to the directory where you unpacked / cloned the source code and then:

mkdir -p build && cd build
cmake ..
cmake --build . -- --jobs=$(nproc --ignore=1)

To install, run make install. To run the tests, run cd tests && ctest.

CMake options:

  • -DCMAKE_BUILD_TYPE=Debug for a debug build.

  • -DWITH_TESTS=YES if you want to compile the tests.

  • -DXGETTEXT_CMD=String The program to use instead of xgettext.

  • -DFALLBACK_BUNDLED=NO if you don’t want to fall back on bundled libraries.