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