<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">[![Build Status](https://travis-ci.org/mdom/termpub.svg?branch=master)](https://travis-ci.org/mdom/termpub) [![Coverage Status](https://img.shields.io/coveralls/mdom/termpub/master.svg?style=flat)](https://coveralls.io/r/mdom/termpub?branch=master)
# NAME

App::termpub - Epubreader for the terminal

# SYNOPSIS

termpub _file_

# DESCRIPTION

termpub aims to be a full features epub reader for the terminal.
It supports internal and external links, skips the front matter and
will display images with an external viewer. Your reading position
will be saved and restored.

Many text movement commands are compatible with _less(1)_.

The text will be hyphenated if the hyphenation patterns from hunspells
libhyphen are installed.

# OPTIONS

- --\[no-\]hyphenation

    Hyphenate text. Defaults to true.

- --lang LANGUAGE\_TAG

    Set the language used for hyphenation. Defaults to the books language or
    'en-US' if not specified.

- --width WIDTH

    Set screen width. Defaults to 80.

# KEY BINDINGS

- h, ?

    Display help screen.

- n

    Go to the next chapter.

- p

    Go to the previous chapter.

- t

    Jump to the table of contents.

- m

    Followed by any lowercase letter, marks the current position with that
    letter.

- '

    Followed by any lowercase letter, returns to the position which was
    previously marked with that letter. Followed by another single quote,
    returns to the position at which the last "large" movement command was
    executed.

- \[num\] |

    Set pager width to _num_.

- \[num\] %

    Go to a line N percent into the chapter.

- \[num\] g

    Go to line _num_ in the chapter, defaults to 1.

- \[num\] G

    Go to line _num_ in the chapter, default to the end of the chapter.

- \[num\] o

    Open link _num_. _termpub_ calls _xdg-open_ with the url as first
    argument if the link references an external ressource.

- C-g

    Cancel numeric prefix _num_ argument.

- KEY\_DOWN, j, RETURN

    Scroll one line down.

- KEY\_UP, k

    Scroll one line up.

- KEY\_NPAGE, SPACE

    Scroll forward one window.

- KEY\_PPAGE, KEY\_BACKSPACE

    Scroll backward one window.

- KEY\_HOME

    Go to the beginning of the current chapter.

- KEY\_END

    Go to the ned of the current chapter.

- &lt;,&gt;

    Go back or forward in the chapter history.

- q

    Quit.

- Q

    Quit without saving the current reading position.

# CONFIGURATION FILE

When termpub is invoked, it will attempt to read a configuration file
named .termpubrc in your home directory. If this file does not exist
termpub will try to read $XDG\_CONFIG\_HOME/termpub/termpubrc.

The configuration file consists of a series of commands. Each line may
only contain one command. The hash mark is used as a comment character.
All text after the comment character to the end of the line is ignored.
The file is expected to be utf8 encoded.

The following commands are defined:

- set hyphenation on|true|off|false|0|1

    Enables or disabled hyphenation

- set language _language\_tag_

    Set the language used for hyphenation.

- set width _num_

    Set screen width to _num_.

# INSTALLATION

If you have cpanminus installed, you can simply install this program
by calling

    $ cpanm .

Otherwise you can build a standalone script with

    $ ./build-standalone

and copy the generated script _termpub_ somewhere in your path. In this
case you need to installed the dependencies yourself. Termpub depends
on the perl modules Mojolicious, Curses and Archive::Zip. On Debian the
following command will install these packages.

    $ apt-get install libmojolicious-perl libcurses-perl libarchive-zip-perl

# COPYRIGHT AND LICENSE 

Copyright 2019 Mario Domgoergen `&lt;mario@domgoergen.com&gt;` 

This program is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published by 
the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version. 

This program is distributed in the hope that it will be useful, 
but WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
GNU General Public License for more details. 

You should have received a copy of the GNU General Public License 
along with this program.  If not, see &amp;lt;http://www.gnu.org/licenses/&gt;. 
</pre></body></html>