README

Mon, 14 Dec 2009 16:18:21 +0000

author
Philip Pemberton <philpem@philpem.me.uk>
date
Mon, 14 Dec 2009 16:18:21 +0000
changeset 172
2fae6df568f6
parent 141
752599b50ff3
permissions
-rw-r--r--

remove erroneous 0.33-philpem1 tag

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