File	Date	Author	Commit
doc	2009-04-04	Huang Ying	[244a9b] Fix doc directory and make target
ibhtml2img	2010-10-02	Huang Ying	[0a19ad] Fix ibhtml2xxx installation
ibhtml2pdf	2010-10-02	Huang Ying	[0a19ad] Fix ibhtml2xxx installation
iblineparser	2009-04-03	Huang Ying	[8e097b] Add DESTDIR support
ibpy	2010-10-02	Huang Ying	[de91f6] Add rc (Row Condense) and rcc (Row and Column C...
ibtools	2009-05-03	Huang Ying	[37c940] Re-implement ibimb2pdf with new PDF generating ...
scripts	2009-04-04	Huang Ying	[d57d0b] Add bdist (binary distribution) target in Makefile
.gitignore	2009-04-20	Huang Ying	[fa7d9d] Add djvu meta/outline support
COPYING	2009-04-01	Huang Ying	[f64da9] Fix old documents
Makefile	2010-03-13	Huang Ying	[82647c] Remove poppler from repository
README	2010-03-13	Huang Ying	[1f1b76] Remove ibpdfinfo

Read Me

IBSUITE
-------

ibsuite stands for image book suite. It contains a set of tools to
convert ebook in various format (pdf, chm, html) into a set of images,
reformat the images (crop, embold, divide, etc), and assemble the
result images into a new ebook.


COMPONENTS
----------

ibhtml2img:
	convert html to image with xulrunner

ibhtml2pdf:
	convert html to pdf with xulrunner

iblineparser:
	parser input image, extract line information

ibpy:

	python module, which is the driver of the whole system, it
	uses above programs to convert input file to image, extract
	line information from image, dilate image, and re-assemble
	lines into a new image, generate output e-book.

ibtools:
	A set of utilities and tools, some of them are used internal
	by ibsuite, others are user command provided by ibsuite.


USAGE
-----

The most important command of ibsuite is ibreformat, the basic usage
is as follow:

  ibreformat [options] <input file>

In most cases, something like following:

  ibreformat -o <output file> --iprof=<iprof> --oprof=<oprof> \
    --pprof=<pprof> <input file>

Where <input file> is input file name, <output file> is output file
name, <iprof> is input profile, <oprof> is output profile, <pprof> is
processing profile.

Available input/output/processing profiles are as follow:

input profiles:

img: for scanned book

output profiles:

prs505p: for Sony PRS505 in portrait mode

prs505l: for Sony PRS505 in landscape mode

processing profiles:

divide2: divide one line into two line (a kind of simple reflow)

resize: Resize and dilate pages

repage: Re-page input book, without much other processing such as dilate.


For other command line options, please refer to "ibreformat -h".


Some useful command line option combinations:

For scanned book on PRS505:

  ibsuite -o <output file> -iprof=img -pprof=resize -oprof=prs505l <input file>

For chm file on PRS505:

  ibchm2imb <xxx>.chm

When it finishs, <xxx>.imb will be generated, then

  ibsuite -o <output file> -pprof=repage --oprof=prs505l <xxx>.imb


INSTALL
-------

Currently, only Linux is supported, but I think it may work on some
unix enviroment (including cygwin on Windows) after some
work. Currently only install from source code is supported.

Pre-requirement:

a. gcc, g++, bash, make
b. libfontconfig-dev, libnetpbm-dev, libgtk-dev
c. python, python-imaging, python-poppler
d. imagemagick
e. for HTML/CHM support: python-chm, xulrunner
f. for scanned book: unpaper
g. for PDF generating: python-reportlab

Build:

./configure [--prefix=<prefix>]
make [PREFIX=<prefix>] [NO_XUL=1]

Install:

# become root
make install [PREFIX=<prefix>]