README

Thu, 20 Mar 2003 06:54:08 +0000

author
eric
date
Thu, 20 Mar 2003 06:54:08 +0000
changeset 141
752599b50ff3
parent 136
82d6f19753d6
permissions
-rw-r--r--

more JPEG support. added input file handler API.

     1 tumble: build a PDF file from image files
     2 Copyright 2003 Eric Smith <eric@brouhaha.com>
     3 $Id: README,v 1.2 2003/03/19 22:54:07 eric Exp $
     5 Tumble is a utility to construct PDF files from one or more image
     6 files.  Supported input image file formats are JPEG, and black and
     7 white TIFF (single- or multi-page).  Black and white images will be
     8 encoded in the PDF output using lossless Group 4 fax compression
     9 (ITU-T recommendation T.6).  This provides a very good compression
    10 ratio for text and line art.  JPEG images will be preserved with the
    11 original coding.
    13 The current version of Tumble will only work on little-endian systems,
    14 such as x86, VAX, and Alpha.  The byte order dependencies will be fixed
    15 in a later release.
    17 The input and output files can be specified on the command line.
    18 Alternatively, a control file, typically with a ".tum" suffix, may be
    19 used which allows for more control over the files and options.
    21 The general command line syntax is:
    23     tumble [options] <input>... -o <output.pdf>
    25 The options in this mode are:
    27     -v        verbose
    28     -b <fmt>  create bookmarks
    30 If the "-b" option is given, bookmarks will be created using the
    31 format string, which may contain arbitrary text and/or the following
    32 format specifiers:
    34     %F  file name, sans suffix  e.g., "foo.tif" will just appear as "foo"
    35     %p  page number of input file, useful for multipage TIFF files
    37 There is currently no documentation for the control file syntax, as it
    38 is still being refined, and many of the options planned for use in
    39 control files are not yet fully implemented.  Features that will be
    40 available in control files include:
    42     image resolution specification - useful for input files with
    43         unspecified resolution, or to override
    44     image rotation, in units of 90 degrees
    45     image cropping
    46     grouping to allow different specifications for individual pages
    47         or groups of consecutive pages (e.g., chapters)
    48     ability to control operations independently on even and odd pages
    49         (e.g., different rotation or cropping)
    50     more flexible bookmark control
    51     page labels, so that the PDF file can present the actual document
    52         page numbers such as xvii or 3-27
    55 This program is free software; you can redistribute it and/or modify
    56 it under the terms of the GNU General Public License version 2 as
    57 published by the Free Software Foundation.  Note that permission is
    58 not granted to redistribute this program under the terms of any other
    59 version of the General Public License.
    61 This program is distributed in the hope that it will be useful, but
    62 WITHOUT ANY WARRANTY; without even the implied warranty of
    63 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    64 General Public License for more details.
    66 You should have received a copy of the GNU General Public License
    67 along with this program; if not, write to the Free Software
    68 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA