Blame tools/djvudigital.1

Packit df99a1
.\" Copyright (c) 2001-2003 Leon Bottou, Yann Le Cun, Patrick Haffner,
Packit df99a1
.\" Copyright (c) 2001 AT&T Corp., and Lizardtech, Inc.
Packit df99a1
.\"
Packit df99a1
.\" This is free documentation; you can redistribute it and/or
Packit df99a1
.\" modify it under the terms of the GNU General Public License as
Packit df99a1
.\" published by the Free Software Foundation; either version 2 of
Packit df99a1
.\" the License, or (at your option) any later version.
Packit df99a1
.\"
Packit df99a1
.\" The GNU General Public License's references to "object code"
Packit df99a1
.\" and "executables" are to be interpreted as the output of any
Packit df99a1
.\" document formatting or typesetting system, including
Packit df99a1
.\" intermediate and printed output.
Packit df99a1
.\"
Packit df99a1
.\" This manual is distributed in the hope that it will be useful,
Packit df99a1
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit df99a1
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit df99a1
.\" GNU General Public License for more details.
Packit df99a1
.\"
Packit df99a1
.\" You should have received a copy of the GNU General Public
Packit df99a1
.\" License along with this manual. Otherwise check the web site
Packit df99a1
.\" of the Free Software Foundation at http://www.fsf.org.
Packit df99a1
.TH DJVUDIGITAL 1 "1/31/2004" "DjVuLibre-3.5" "DjVuLibre-3.5"
Packit df99a1
.SH NAME
Packit df99a1
djvudigital \- creates DjVu files from PS or PDF files.
Packit df99a1
Packit df99a1
.SH SYNOPSIS
Packit df99a1
.BI "djvudigital  [" "options" "] " "inputfile" " [" "outputfile" "]"
Packit df99a1
Packit df99a1
.SH DESCRIPTION
Packit df99a1
This program creates a DjVu file
Packit df99a1
from the PostScript
Packit df99a1
.BR "" "(" ".ps" "),"
Packit df99a1
GZipped PostScript
Packit df99a1
.BR "" "(" ".ps.gz" "),"
Packit df99a1
Encapsulated PostScript
Packit df99a1
.BR "" "(" ".eps" "),"
Packit df99a1
or Portable Document Format 
Packit df99a1
.BR "" "(" ".pdf" ")"
Packit df99a1
file
Packit df99a1
.IR inputfile .
Packit df99a1
Packit df99a1
The output file name is either given by argument
Packit df99a1
.I outputfile
Packit df99a1
or generated by replacing the input file name 
Packit df99a1
suffixes by the DjVu suffix
Packit df99a1
.BR "" "(" ".djvu" ")."
Packit df99a1
Packit df99a1
.SH PREREQUISITES
Packit df99a1
Packit df99a1
This program depends on a specific GhostScript driver.
Packit df99a1
If your GhostScript program does not provide this driver,
Packit df99a1
please check
Packit df99a1
.BR http://djvu.sourceforge.net/gsdjvu.html .
Packit df99a1
Packit df99a1
.SH OPTIONS
Packit df99a1
.TP
Packit df99a1
.BR "--verbose" ", " "-v"
Packit df99a1
Displays more informational messages while
Packit df99a1
converting the file.
Packit df99a1
.TP
Packit df99a1
.BR "--quiet" ", " "-q"
Packit df99a1
Do not display informational messages while
Packit df99a1
converting the file.
Packit df99a1
.TP
Packit df99a1
.BI "--dpi=" "resolution"
Packit df99a1
Specify the desired resolution to 
Packit df99a1
.I resolution
Packit df99a1
dots per inch.
Packit df99a1
The default is 300 dpi.
Packit df99a1
.TP
Packit df99a1
.BI "--psrotate=" "angle"
Packit df99a1
Rotate the PostScript file by 
Packit df99a1
.I angle
Packit df99a1
degrees clockwise. 
Packit df99a1
Only the values
Packit df99a1
.BR 0 ", " 90 ", " 180 ", and " 270
Packit df99a1
are supported.  
Packit df99a1
This option only applies to PostScript files.
Packit df99a1
PDF files are always converted according to
Packit df99a1
their native orientation.
Packit df99a1
.TP
Packit df99a1
.BI "--epsf=" "disposition"
Packit df99a1
Specify how to handle Encapsulated PostScript files. 
Packit df99a1
Argument
Packit df99a1
.I disposition
Packit df99a1
can take the values
Packit df99a1
.BR crop ", " fit ", and " ignore "."
Packit df99a1
The default disposition
Packit df99a1
.B crop
Packit df99a1
creates a DjVu file whose size matches the bounding box of 
Packit df99a1
the Encapsulated PostScript file. Value
Packit df99a1
.B fit
Packit df99a1
rescales the graphics to the default page size. 
Packit df99a1
Value
Packit df99a1
.B ignore
Packit df99a1
disables all Encapsulated PostScript specific code.
Packit df99a1
This option requires Ghostscript 7.07 or better.
Packit df99a1
.TP
Packit df99a1
.BI "--exact-color"
Packit df99a1
Enables a more accurate rendering of the colors.
Packit df99a1
This option requires GhostScript 6.52 or better.
Packit df99a1
.TP
Packit df99a1
.BI "--threshold=" "thres"
Packit df99a1
Specify a threshold for the foreground/background separation code.
Packit df99a1
Acceptable values of
Packit df99a1
.I thres
Packit df99a1
range from 0 to 100. Larger values place more 
Packit df99a1
information into the foreground layer.
Packit df99a1
The default threshold value is 80.
Packit df99a1
.TP
Packit df99a1
.BI "--bg-subsample=" "sub"
Packit df99a1
Specify the background subsampling ratio.
Packit df99a1
Argument 
Packit df99a1
.I sub
Packit df99a1
must be an integer between 1 and 6.
Packit df99a1
The default value is 3.
Packit df99a1
.TP
Packit df99a1
.BI "--bg-slices=" "n" "+...+" "n"
Packit df99a1
Specify the encoding quality of the background layer. 
Packit df99a1
The syntax for the argument is similar to that described for the
Packit df99a1
.B -slice
Packit df99a1
option of command
Packit df99a1
.BR c44 .
Packit df99a1
The default is
Packit df99a1
.BR 72+11+10+10 .
Packit df99a1
.TP
Packit df99a1
.BI "--fg-colors=" ncolors
Packit df99a1
Specify the maximum number of distinct colors in the foreground layer.
Packit df99a1
Argument 
Packit df99a1
.I ncolors
Packit df99a1
can take integer values between 1 and 4000.
Packit df99a1
The default value is 256.
Packit df99a1
.TP
Packit df99a1
.BI "--fg-image-colors=" ncolors
Packit df99a1
Specify the maximum number of distinct colors in an image for 
Packit df99a1
considering encoding it into the foreground layer.
Packit df99a1
Argument 
Packit df99a1
.I ncolors
Packit df99a1
can take integer values between 1 and 4000.
Packit df99a1
The default value is 256.
Packit df99a1
.TP
Packit df99a1
.BI "--words"
Packit df99a1
Extract the text from the PostScript code and
Packit df99a1
incorporates this information into the DjVu file.
Packit df99a1
This option records the location of every word.
Packit df99a1
.TP
Packit df99a1
.BI "--lines"
Packit df99a1
Extract the text from the PostScript code and
Packit df99a1
incorporates this information into the DjVu file.
Packit df99a1
This option saves a few bytes by only recording the 
Packit df99a1
location of each line.
Packit df99a1
.TP
Packit df99a1
.BI "--gsarg=" arg1 "[," arg2 ",...," argN "]"
Packit df99a1
Insert extra arguments on the GhostScript command line.
Packit df99a1
.TP
Packit df99a1
.BI "--cseparg=" arg1 "[," arg2 ",...," argN "]"
Packit df99a1
Insert extra arguments on the command line of
Packit df99a1
program
Packit df99a1
.BR csepdjvu " or " msepdjvu "."
Packit df99a1
.TP
Packit df99a1
.BI "--sepfile"
Packit df99a1
Produces a separated data file instead of a DjVu file. Program
Packit df99a1
.BR csepdjvu 
Packit df99a1
can then convert the separated data file into a DjVu file.
Packit df99a1
.TP
Packit df99a1
.BI "--check"
Packit df99a1
Display the names of the two auxiliary programs found by
Packit df99a1
.BR djvudigital ,
Packit df99a1
namely a suitable ghostscript interpreter and a suitable backend encoder.
Packit df99a1
See the next two section for details.
Packit df99a1
.TP
Packit df99a1
.BI "--dryrun"
Packit df99a1
Simply display the ghostscript command line generated by
Packit df99a1
.BR djvudigital
Packit df99a1
without running it.
Packit df99a1
No output file is produced
Packit df99a1
.TP
Packit df99a1
.BI "--help"
Packit df99a1
Display the manual page for 
Packit df99a1
.BR djvudigital .
Packit df99a1
.PP
Packit df99a1
Packit df99a1
.SH GHOSTSCRIPT ISSUES
Packit df99a1
Packit df99a1
Program
Packit df99a1
.B djvudigital 
Packit df99a1
internally relies on a specific Ghostscript driver named
Packit df99a1
.BR djvusep .
Packit df99a1
This driver analyzes the logical structure of the sequence
Packit df99a1
of PostScript rendering commands and decides to execute 
Packit df99a1
each command into either the foreground or the background layer.
Packit df99a1
The GhostScript driver produces a separated data file 
Packit df99a1
that is then compressed using the DjVuLibre program
Packit df99a1
.BR csepdjvu .
Packit df99a1
Packit df99a1
Before processing the input file, program
Packit df99a1
.B djvudigital
Packit df99a1
searches a Ghostscript executable providing the
Packit df99a1
.B djvusep
Packit df99a1
driver. The search starts with the file specified
Packit df99a1
by the environment variable
Packit df99a1
.B GSDJVU
Packit df99a1
and continues with command line executables named
Packit df99a1
.BR gs " and " gsdjvu "."
Packit df99a1
Packit df99a1
The DjVuLibre source code contains instruction
Packit df99a1
to compile such a GhostScript executable.
Packit df99a1
More information can be obtained from
Packit df99a1
.BR http://djvu.sourceforge.net/gsdjvu.html .
Packit df99a1
Packit df99a1
.SH CSEPDJVU ISSUES
Packit df99a1
Packit df99a1
The output of the
Packit df99a1
.B djvusep
Packit df99a1
GhostScript driver must be processed by 
Packit df99a1
the DjVuLibre program
Packit df99a1
.BR csepdjvu .
Packit df99a1
This program can also be replaced by the 
Packit df99a1
the proprietary Lizardtech program
Packit df99a1
.BR msepdjvu .
Packit df99a1
Before processing the input file, program
Packit df99a1
.B djvudigital
Packit df99a1
searches such an executable.
Packit df99a1
The search starts with the file specified
Packit df99a1
by the environment variable
Packit df99a1
.B CSEPDJVU
Packit df99a1
and continues with command line executables named
Packit df99a1
.BR msepdjvu " and " csepdjvu "."
Packit df99a1
Packit df99a1
.SH CREDITS
Packit df99a1
Packit df99a1
The first version of this converter was written 
Packit df99a1
by L\('eon Bottou <leonb@users.sourceforge.net>
Packit df99a1
in AT&T Labs.  The DjVuLibre version is derived 
Packit df99a1
from code graciously released by Lizardtech in 
Packit df99a1
January 2004.
Packit df99a1
Packit df99a1
.SH BUGS
Packit df99a1
Packit df99a1
Program
Packit df99a1
.B djvudigital
Packit df99a1
can only process input files that GhostScript can process properly.
Packit df99a1
Packit df99a1
.SH SEE ALSO
Packit df99a1
.BR djvu (1),
Packit df99a1
.BR csepdjvu (1),
Packit df99a1
.BR c44 (1),
Packit df99a1
.BR gs (1),
Packit df99a1
.BR gzip (1)