.\"    Title: djvubind
.\"    Author: Adam A. Zajac
.TH "djvubind" "1"

.SH "NAME"
djvubind - Create high-quality djvu files, including positional ocr, metadata, and bookmarks.
.SH "SYNOPSIS"
\fIdjvubind\fR [--quiet] [--verbose] [--no-ocr]
         [--bookmarks=<filename>] [--metadata=<filename>]
         [--cover-front=<filename>] [--cover-back=<filename>]
         [--ocr-engine=(tesseract|cuneiform)]
         [--tesseract-options=<string>] [--cuneiform-options=<string>]
         [--title-start=<filename>] [--title-uppercase] [--title-exclude=<filename>:<string>]
         \fBdirectory\fR

.SH "DESCRIPTION"
Djvubind facilitates creating high-quality djvu files, especially digital versions of scanned books. It functions as a wrapper that combines the djvulibre tools, minidjvu, and various ocr engines to provide a simple, single command creation of a djvu file.

.SH "TITLE EXAMPLES"
Suppose your directory contains the following: page_000.tif, page_001.tif, page002.tif, page_003.tif, page_004.tif

    command: djvubind --title-start=page_002.tif
    titles:  i, ii, 1, 2, 3

    command: djvubind --title-start=page_002.tif --title-exclude=page_003.tif:blank
    titles:  i, ii, 1, blank, 2

Front and back cover images, if present, are automatically given titles of "cover" and "back cover".  If --title-start is not given, no pages will be titled.

.SH "OPTIONS"
.PP
\fB--bookmarks=<filename>\fR
.RS 4
Specifies an alternate bookmarks file.  The format of this file should be similar to what is produced by "djvused -e 'print-outline'".  By default, "bookmarks" is used if present.
.RE
.PP
\fB--cover-front=<filename>\fR
.RS 4
Specifies an alternate front cover image.  By default, "cover_front.jpg" is used if present.
.RE
.PP
\fB--cover-back=<filename>\fR
.RS 4
Specifies an alternate back cover image.  By default, "cover_back.jpg" is used if present.
.RE
.PP
\fB--metadata=<filename>\fR
.RS 4
Specifies an alternate metadata file.  The format of this file should be similar to what is produced by "djvused -e 'print-meta'".  By default, "metadata" is used if present.
.RE
.PP
\fB--no-ocr\fR
.RS 4
Images will not be processed for text content.
.RE
.PP
\fB--ocr-engine=(tesseract|cuneiform)\fR
.RS 4
Specifies which ocr engine to use.  Tesseract is the default.
.RE
.PP
\fB--tesseract-options=<string>\fR
\fB--cuneiform-options=<string>\fR
.RS 4
Passes custom options to the respective ocr engine (see their manpages for options).
.RE
.PP
\fB--title-start=<filename>\fR
.RS 4
Prior to this image, pages will be titled with roman numerals (i, ii, iii...).  Starting with this page, they will be titled with arabic numerals (1, 2, 3...)
.RE
.PP
\fB--title-uppercase\fR
.RS 4
Roman numeral titles will be in uppercase (I, II, III...).
.RE
.PP
\fB--title-exclude=<filename>:<string>\fR
.RS 4
This image will not be included in sequential page titling.  If you want a unique title, append a colon and the title.
.RE
.PP
\fB-q | --quiet\fR
.RS 4
No status information will be given.
.RE
.PP
\fB-v | --verbose\fR
.RS 4
Additional information will be given, which is intended to help debugging.
.RE

.SH "AUTHOR"
Written by Adam A. Zajac <strider1551@gmail.com>