     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sun Mar 16 15:37:16 2003 +0000
     1.3 @@ -0,0 +1,69 @@
     1.4 +tumble: build a PDF file from image files
     1.5 +Copyright 2003 Eric Smith <eric@brouhaha.com>
     1.6 +$Id: README,v 1.1 2003/03/16 07:37:16 eric Exp $
     1.7 +
     1.8 +Tumble is a utility to construct PDF files from one or more image
     1.9 +files.  Currently the only input image format supported is black &
    1.10 +white TIFF files, which may be either single- or multi-page files.  In
    1.11 +the future additional file formats will be supported, including gray
    1.12 +scale and color.  Black and white images will be encoded in the PDF
    1.13 +output using lossless Group 4 fax compression (ITU-T recommendation
    1.14 +T.6).  This provides a very good compression ratio for text and line
    1.15 +art.
    1.16 +
    1.17 +The current version of Tumble will only work on little-endian systems,
    1.18 +such as x86, VAX, and Alpha.  The byte order dependencies will be fixed
    1.19 +in a later release.
    1.20 +
    1.21 +The input and output files can be specified on the command line.
    1.22 +Alternatively, a control file, typically with a ".tum" suffix, may be
    1.23 +used which allows for more control over the files and options.
    1.24 +
    1.25 +The general command line syntax is:
    1.26 +
    1.27 +    tumble [options] <input.tif>... -o <output.pdf>
    1.28 +
    1.29 +The options in this mode are:
    1.30 +
    1.31 +    -v        verbose
    1.32 +    -b <fmt>  create bookmarks
    1.33 +
    1.34 +If the "-b" option is given, bookmarks will be created using the
    1.35 +format string, which may contain arbitrary text and/or the following
    1.36 +format specifiers:
    1.37 +
    1.38 +    %F  file name, sans suffix  e.g., "foo.tif" will just appear as "foo"
    1.39 +    %p  page number of input file, useful for multipage TIFF files
    1.40 +
    1.41 +There is currently no documentation for the control file syntax, as it
    1.42 +is still being refined, and many of the options planned for use in
    1.43 +control files are not yet fully implemented.  Features that will be
    1.44 +available in control files include:
    1.45 +
    1.46 +    image resolution specification - useful for input files with
    1.47 +        unspecified resolution, or to override
    1.48 +    image rotation, in units of 90 degrees
    1.49 +    image cropping
    1.50 +    grouping to allow different specifications for individual pages
    1.51 +        or groups of consecutive pages (e.g., chapters)
    1.52 +    ability to control operations independently on even and odd pages
    1.53 +        (e.g., different rotation or cropping)
    1.54 +    more flexible bookmark control
    1.55 +    page labels, so that the PDF file can present the actual document
    1.56 +        page numbers such as xvii or 3-27
    1.57 +
    1.58 +
    1.59 +This program is free software; you can redistribute it and/or modify
    1.60 +it under the terms of the GNU General Public License version 2 as
    1.61 +published by the Free Software Foundation.  Note that permission is
    1.62 +not granted to redistribute this program under the terms of any other
    1.63 +version of the General Public License.
    1.64 +
    1.65 +This program is distributed in the hope that it will be useful, but
    1.66 +WITHOUT ANY WARRANTY; without even the implied warranty of
    1.67 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    1.68 +General Public License for more details.
    1.69 +
    1.70 +You should have received a copy of the GNU General Public License
    1.71 +along with this program; if not, write to the Free Software
    1.72 +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA