eread

SYNOPSIS
DESCRIPTION

DOWNLOAD
CHANGES

AUTHOR
SEE ALSO

NAME

eread - a simple text-only epub reader

SYNOPSIS

  mv the_machine_stops.epub room_at_the_top.epub ~/epub
  mv bal_du_compte_dorgel.epub reindeer_moon.epub ~/epub
  eread

  # or by filename:
  eread /tmp/old_man_and_the_sea.epub
  # but usually this would be better:
  cp /tmp/old_man_and_the_sea.epub ~/epub/
  eread

  export EPUBDIR=/home/unusual/epub  # default is ~/epub

  eread -v        # prints the version
  perldoc eread   # read the manual

DESCRIPTION

Uses pandoc and vi -R or view to read the text of epub ebooks. Images are not displayed.

eread uses pandoc to translate the .epub file into plain text, which it keeps in the directory $HOME/.eread/ and this translation is only performed if the text file does not exist, or if the .epub file is more recent than the text file.
This makes eread very fast to display.

vim functionality remembers your cursor position from session to session.

A few vim keyboard aliases are provided:
z means zz to bring the cursor-line to the centre in one keystroke,
HOME takes you to the start of the file,
and q means :q to quit more ergonomically. After q an Enter quits, but if you change your mind, then Backspace Enter will return you to your text.

DOWNLOAD

eread is available at pjb.com.au/lua/eread
or at gitlab.com/peterbillam/pjb_lua/-/blob/master/bin/eread
You will also need to install
luarocks install commandlineui luarocks install luaposix apt install pandoc vim
The following line should be present in your /etc/vim/vimrc file, or your $HOME/.vimrc file:
au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g'\"" | endif

CHANGES

   20220909 1.2 map <HOME> to :1<CR>
   20220831 1.1 first released version
   20220807 1.0 first working version

AUTHOR

Peter Billam, www.pjb.com.au/comp/contact.html