.\"Text automatically generated by txt2man
.TH eBook-speaker 1 "09 January 2013" "" "Unix user's manual"
.SH NAME
\fBeBook-speaker \fP- read aloud eBooks using a software speech-synthesizer
.SH SYNOPSIS
.nf
.fam C
\fBeBook-speaker\fP \fIeBook_file\fP [\fB-l\fP \fIlanguage\fP]
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBeBook-speaker\fP reads the specified \fIeBook_file\fP and uses espeak for output.
.PP
A list of items on the eBook will appear. Press <ENTER> to start playing. When reading of an item has finished, \fBeBook-speaker\fP will play the next item and the cursor will automatically skip to that item, so that an attached braille-terminal will display the name of that item.
.SH OPTIONS
.TP
.B
\fIeBook_file\fP
Give an \fIeBook_file\fP as argument to \fBeBook-speaker\fP. Currently the EPUB format and the Microsoft Reader eBook format (lit) are supported.
.TP
.B
\fB-l\fP \fIlanguage\fP
\fBeBook-speaker\fP tries to detect the \fIlanguage\fP of the specified eBook. With this option the detected \fIlanguage\fP can be overridden. By some eBooks this option is mandatory.
.SH SCREEN
The name and version of this program and the name of the author will be displayed left aligned at the top of the screen. The name of the current loaded book will be displayed right aligned.
.PP
The second row of the screen will display the number of pages of the current loaded book (if any), the current selected level and the total number of levels, the current displayed screen and the total number of screens.
.PP
The next rows will display the title of the item, the first page of the item within brackets (if there are pages) and the total number of phrases in this item. Items in higher levels will be indented. (Three spaces each level.) When "just playing this item" is active, a "J" will be viewed at the first column of that item.
.SH CONTROL KEYS
\fBeBook-speaker\fP recognizes the following keyboard-commands:
.TP
.B
cursor down
move cursor to the next item
.TP
.B
cursor up
move cursor to the previous item
.TP
.B
cursor right
skip to next phrase
.TP
.B
cursor left
skip to previous phrase
.TP
.B
page-down
view next screen
.TP
.B
page-up
view previous screen
.TP
.B
enter
Start playing
.TP
.B
space
pause/resume playing
.TP
.B
home
play on normal speed
.TP
.B
/
search for a label
.TP
.B
D
decrease playing speed
.TP
.B
f
find the currently playing item and place the cursor there
.TP
.B
g
go to page number (if any)
.TP
.B
h or ?
give this help
.TP
.B
j
just play current item and place a "J" at the first column.
.TP
.B
l
switch to next level
.TP
.B
L
switch to previous level
.TP
.B
n
search forewards
.TP
.B
N
search backwards
.TP
.B
o
select next output sound device
.TP
.B
p
place a bookmark
.TP
.B
q
quit \fBeBook-speaker\fP. The playing-point will be saved as bookmark.
.TP
.B
s
stop playing
.TP
.B
U
increase playing speed
.SH FILES
.TP
.B
~/.\fBeBook-speaker\fP/
This directory contains the bookmarks. Each file has the name of the book and contains the name of the current item, the start-phrase of that item and the current level, each on a own line.
.TP
.B
~/.eBook-speaker.rc
This file contains the name of the desired audio device, the desired playing speed and the desired \fIlanguage\fP.
.SH AUTHOR
Jos Lemmens <jos@jlemmens.nl>
.SH COPYRIGHT
Copyright (C)2011 Jos Lemmens <jos@jlemmens.nl>
.PP
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 2, 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 (see the file COPYING); if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA