File chm2pdf.1 of Package chm2pdf
.\" Copyright (C) 2010 Kyrill Detinov <lazy.kent@opensuse.org>
.\"
.\" This manual page is distributed under the terms
.\" of the GNU Free Documentation License.
.\"
.TH CHM2PDF 1 2010-12-08 "chm2pdf 0.9.1" "Linux User's Manual"
.SH NAME
chm2pdf \- convert chm to pdf files
.SH SYNOPSIS
.B chm2pdf \-\-book
.RI [ options ]\ input_filename\ [ output_filename ]
.PP
.B chm2pdf \-\-continuous
.RI [ options ]\ input_filename\ [ output_filename ]
.PP
.B chm2pdf \-\-webpage
.RI [ options ]\ input_filename\ [ output_filename ]
.SH DESCRIPTION
.I chm2pdf
converts Microsoft Compiled HTML Help (CHM) files to Portable Document
Format (PDF) files. It supports formatting, fonts options, PDF security
options, password protection and compression modes.
.SH OPTIONS
.RB Either\ \-\-book\ or\ \-\-webpage\ or\ \-\-continuous
MUST be given. Only one of the three options can be present.
.SS "General options"
.TP
.B \-\-book
Specifies that the HTML sources are structured (headings, chapters,
etc.).
.TP
.B \-\-continuous
Specifies that the HTML sources are unstructured (plain web pages).
No page breaks are inserted between each file or URL in the output.
.TP
.B \-\-webpage
Specifies that the HTML sources are unstructured (plain web
pages). A page break is inserted between each file or URL in the output.
.SS "Other options"
.TP
.B \-\-beautifulsoup
Correct the HTML code of the pages before converting them to PDF.
.TP
.BI \-\-bodycolor\ color
Specifies the background color for all pages.
.PP
.BI \-\-bodyfont
.IR courier | helvetica | monospace | sans | serif | times
.RS
Default is times.
.RE
.TP
.BI \-\-bodyimage\ filename
Specifies the background image that is tiled on all pages.
.PP
.B \-\-bottom
.IR margin [ pt | in | cm | mm ]
.RS
Specifies the bottom margin in points (no suffix or ##pt), inches
(##in), centimeters (##cm), or millimeters (##mm).
.RE
.TP
.BI \-\-browserwidth\ pixels
See http://www.htmldoc.org/newsgroups.php?ghtmldoc.general+v:3465
.PP
.B \-\-charset
.IR cp-874...1258 | iso-8859-1...8859-15 | koi8-r
.RS
Specifies the ISO character set to use for the output.
.RE
.TP
.B \-\-color
Specifies that PDF output should be in color.
.PP
.BR \-\-compression [ \fI=level\fR ]
.\" No info.
.TP
.BI \-\-cookies\ name=value
.\" No info.
.TP
.BI \-\-datadir\ directory
Specifies the location of the HTMLDOC data files, usually
/usr/share/htmldoc
.TP
.B \-\-duplex
Specifies that the output should be formatted for double-sided printing.
.TP
.BI \-\-effectduration\ 0.1..10.0
Specifies the duration in seconds of PDF page transition effects.
.TP
.B \-\-embedfonts
Specifies that fonts should be embedded in PDF output.
.TP
.B \-\-encryption
Enables encryption of PDF files.
.PP
.B \-\-firstpage
.IR p1 | toc | c1
.\" No info.
.TP
.BI \-\-fontsize\ 4.0..24.0
Specifies the default font size for body text.
.TP
.BI \-\-fontspacing\ 1.0..3.0
Specifies the default line spacing for body text. The line spacing
is a multiplier for the font size, so a value of 1.2 will provide an
additional 20% of space between the lines.
.TP
.BI \-\-footer\ fff
Sets the page footer. See below for the format of fff.
.TP
.B \-\-gray
Specifies that PostScript or PDF output should be grayscale.
.TP
.BI \-\-header\ fff
Sets the page header. See below for the format of fff.
.TP
.BI \-\-header1\ fff
Sets the page header1. See below for the format of fff.
.TP
.BI \-\-headfootfont\ font
Sets the font to use on headers and footers. Available fonts:
.br
courier{-bold,-oblique,-boldoblique}
.br
helvetica{-bold,-oblique,-boldoblique}
.br
monospace{-bold,-oblique,-boldoblique}
.br
sans{-bold,-oblique,-boldoblique}
.br
serif{-bold,-italic,-bolditalic}
.br
times{-roman,-bold,-italic,-bolditalic}
.TP
.BI \-\-headfootsize\ 6.0..24.0
Sets the size of the font to use on headers and footers.
.PP
.B \-\-headingfont
.IR courier | helvetica | monospace | sans | serif | times
.RS
Sets the typeface to use for headings.
.RE
.TP
.B \-\-help
Displays a summary of command-line options.
.TP
.BI \-\-jpeg\ quality
Sets the JPEG compression level to use for large images. A value of 0
disables JPEG compression.
.TP
.B \-\-landscape
.\" No info.
.PP
.B \-\-left
.IR margin [ pt | in | cm | mm ]
.RS
Specifies the left margin in points (no suffix or ##pt), inches (##in),
centimeters (##cm), or millimeters (##mm).
.RE
.TP
.BI \-\-linkcolor\ color
Sets the color of links. You can use well-known color names like blue,
or the usual #RRGGBB notation.
.TP
.B \-\-links
Enables generation of links in PDF files (default).
.PP
.B \-\-linkstyle
.IR plain | underline
.RS
Sets the style of links.
.RE
.TP
.BI \-\-logoimage\ filename
Specifies an image to be used as a logo in the header or footer in a PDF
document. Note that you need to use the header and/or footer options
with the l parameter.
.TP
.B \-\-no-compression
Disables compression of PDF file.
.TP
.B \-\-no-duplex
Disables double-sided printing.
.TP
.B \-\-no-embedfonts
Specifies that fonts should not be embedded in PDF and PostScript
output.
.TP
.B \-\-no-encryption
Disables document encryption.
.TP
.B \-\-no-links
Disables generation of links in a PDF document.
.TP
.B \-\-no-localfiles
.\" No info.
.TP
.B \-\-no-numbered
Disables automatic heading numbering.
.TP
.B \-\-no-overflow
.\" No info.
.TP
.B \-\-no-strict
Disables strict HTML input checking.
.TP
.B \-\-no-title
Disables generation of a title page.
.TP
.B \-\-no-toc
Disables generation of a table of contents.
.TP
.B \-\-numbered
Numbers all headings in a document.
.PP
.B \-\-nup
.IR 1 | 2 | 4 | 6 | 9 | 16
.RS
Sets the number of pages that are placed on each output page. Valid
values are 1, 2, 4, 6, 9 and 16.
.RE
.TP
.BI \-\-overflow
.\" No info.
.TP
.BI \-\-owner-password\ password
Sets the owner password for encrypted PDF files.
.TP
.BI \-\-pageduration\ 1.0..60.0
Sets the view duration of a page in a PDF document.
.PP
.BI \-\-pageeffect\ effect
.RS
Specifies the page transition effect for all pages. Effects are:
none, bi, bo, d, gd, gdr, gr, hb, hsi, hso, vb, vsi, vso, wd, wl, wr, wu.
This attribute is ignored by all Adobe PDF viewers.
.RE
.PP
.B \-\-pagelayout
.IR single | one | twoleft | tworight
.RS
Specifies the initial layout of pages for a PDF file.
.RE
.PP
.B \-\-pagemode
.IR document | outline | fullscreen
.RS
Specifies the initial viewing mode for a PDF file.
.RE
.TP
.BI \-\-path\ dir1;dir2;dir3;...;dirN
Specifies a search path for files in a document.
.TP
.BI \-\-permissions\ permissions
Specifies document permissions for encrypted PDF files. Separate
multiple permissions with commas. Available permissions:
.br
all, none, annotate, copy, modify, print, no-annotate, no-copy,
no-modify, no-print
.TP
.B \-\-portrait
.\" No info.
.TP
.B \-\-quiet
Suppresses all messages, even error messages.
.PP
.B \-\-right
.IR margin [ pt | in | cm | mm ]
.RS
Specifies the right margin in points (no suffix or ##pt), inches (##in),
centimeters (##cm), or millimeters (##mm).
.RE
.PP
.B \-\-size
.IR letter | a4 | WxH { in | cm | mm } \fR|\fIetc
.RS
Specifies the page size using a standard name or in points (no suffix or
##x##pt), inches (##x##in), centimeters (##x##cm), or millimeters
(##x##mm). The standard sizes that are currently recognized are
"letter" (8.5x11in),\ legal" (8.5x14in),\ a4" (210x297mm), and
"universal" (8.27x11in).
.RE
.TP
.B \-\-strict
Enables strict HTML input checking.
.TP
.BI \-\-textcolor\ color
Specifies the default color of all text.
.PP
.BI \-\-textfont
.IR courier | helvetica | monospace | sans | serif | times
.RS
Specifies the default typeface for all normal text.
.RE
.TP
.B \-\-title
Enables the generation of a title page.
.TP
.BI \-\-titlefile\ filename
Specifies the file to use for the title page. If the file is an image
then the title page is automatically generated using the document meta
data and image title.
.TP
.BI \-\-titleimage\ filename
Specifies the image to use for the title page. The title page is
automatically generated using the document meta data and title image.
.TP
.BI \-\-tocfooter\ fff
Sets the page footer to use on table-of-contents pages. See below for
the format of fff.
.TP
.BI \-\-tocheader\ fff
Sets the page header to use on table-of-contents pages. See below for
the format of fff.
.TP
.BI \-\-toclevels\ levels
Sets the number of levels in the table-of-contents.
.TP
.BI \-\-toctitle\ string
Sets the title for the table-of-contents.
.PP
.B \-\-top
.IR margin [ pt | in | cm | mm ]
.RS
Specifies the top margin in points (no suffix or ##pt), inches (##in),
centimeters (##cm), or millimeters (##mm).
.RE
.TP
.BI \-\-user-password\ password
Specifies the user password for encryption of PDF files.
.TP
.B \-\-verbose
Displays various messages indicating the progress of the conversion
process. The verbosity depends on \fB\-\-verbositylevel\fR. If
\fB\-\-verbose\fR is not set, almost no messages will be printed.
The default is 'not set', so if you want the minimum amount of messages,
just don' use this option.
.PP
.B \-\-verbositylevel
.IR low | high
.RS
Specifies the verbosity level of the messages. Default is low. The
\fB\-\-verbose\fR option must be set, otherwise this option will have no
effect.
.RE
.TP
.B \-\-version
Displays the current version number.
.SS "Header/Footer Formats"
.TP
.B fff
Heading format string; each 'f' can be one of:
.IP
.BR .\ =\ blank
.IP
.BR /\ =\ n/N\ arabic\ page\ numbers\ (1/3,\ 2/3,\ 3/3)
.IP
.BR :\ =\ c/C\ arabic\ chapter\ page\ numbers\ (1/2,\ 2/2,\ 1/4,\ 2/4,\ ...)
.IP
.BR 1\ =\ arabic\ numbers\ (1,\ 2,\ 3,\ ...)
.IP
.BR a\ =\ lowercase\ letters
.IP
.BR A\ =\ uppercase\ letters
.IP
.BR c\ =\ current\ chapter\ heading
.IP
.BR C\ =\ current\ chapter\ page\ number\ (arabic)
.IP
.BR d\ =\ current\ date
.IP
.BR D\ =\ current\ date\ and\ time
.IP
.BR h\ =\ current\ heading
.IP
.BR i\ =\ lowercase\ roman\ numerals
.IP
.BR I\ =\ uppercase\ roman\ numerals
.IP
.BR l\ =\ logo\ image
.IP
.BR t\ =\ title\ text
.IP
.BR T\ =\ current\ time
.SH NOTES
File name must not contain spaces.
.SH REPORTING BUGS
Report bugs to http://chm2pdf.googlecode.com/
.SH SEE ALSO
.BR htmldoc (1),
.BR wvPDF (1),
.BR ps2pdf (1),
.BR tiff2pdf (1),
.BR pdftk (1)
