added README, INSTALL.

Sun, 16 Mar 2003 15:37:16 +0000

author
eric
date
Sun, 16 Mar 2003 15:37:16 +0000
changeset 136
82d6f19753d6
parent 135
5d3d2dccb3ff
child 137
ce565d98baf3

added README, INSTALL.

INSTALL file | annotate | diff | revisions
Makefile file | annotate | diff | revisions
README file | annotate | diff | revisions
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/INSTALL	Sun Mar 16 15:37:16 2003 +0000
     1.3 @@ -0,0 +1,18 @@
     1.4 +tumble: build a PDF file from image files
     1.5 +Copyright 2003 Eric Smith <eric@brouhaha.com>
     1.6 +$Id: INSTALL,v 1.1 2003/03/16 07:37:16 eric Exp $
     1.7 +
     1.8 +Tumble requires libtiff, which in turn requires libjpeg and libz:
     1.9 +
    1.10 +    http://www.libtiff.org/
    1.11 +    http://www.???.org */
    1.12 +
    1.13 +Building Tumble requires GNU Make, GCC, Bison, and Flex, all of which are
    1.14 +free software provided by the Free Software Foundation.  These are provided
    1.15 +as part of most Linux distributions, and are also avaiable for many other
    1.16 +operatng systems.  See the FSF web site for more information
    1.17 +
    1.18 +    http://www.gnu.org/
    1.19 +
    1.20 +The supplied Makefile should work on most systems with only minor
    1.21 +modifications.
     2.1 --- a/Makefile	Sun Mar 16 15:27:06 2003 +0000
     2.2 +++ b/Makefile	Sun Mar 16 15:37:16 2003 +0000
     2.3 @@ -1,6 +1,6 @@
     2.4  # tumble: build a PDF file from image files
     2.5  # Makefile
     2.6 -# $Id: Makefile,v 1.32 2003/03/14 00:24:37 eric Exp $
     2.7 +# $Id: Makefile,v 1.33 2003/03/16 07:37:16 eric Exp $
     2.8  # Copyright 2001, 2002, 2003 Eric Smith <eric@brouhaha.com>
     2.9  #
    2.10  # This program is free software; you can redistribute it and/or modify
    2.11 @@ -35,6 +35,8 @@
    2.12  ifdef DEBUG
    2.13  CFLAGS := $(CFLAGS) -g
    2.14  LDFLAGS := $(LDFLAGS) -g
    2.15 +else
    2.16 +CFLAGS := $(CFLAGS) -O3
    2.17  endif
    2.18  
    2.19  ifdef EFENCE
    2.20 @@ -55,7 +57,7 @@
    2.21  # let me know why so I can improve this Makefile.
    2.22  # -----------------------------------------------------------------------------
    2.23  
    2.24 -VERSION = 0.27
    2.25 +VERSION = 0.28
    2.26  
    2.27  PACKAGE = tumble
    2.28  
    2.29 @@ -69,7 +71,7 @@
    2.30  OSRCS = scanner.l parser.y
    2.31  HDRS = tumble.h semantics.h bitblt.h bitblt_tables.h \
    2.32  	pdf.h pdf_private.h pdf_util.h pdf_prim.h pdf_name_tree.h
    2.33 -MISC = COPYING Makefile
    2.34 +MISC = COPYING README INSTALL Makefile
    2.35  
    2.36  DISTFILES = $(MISC) $(HDRS) $(CSRCS) $(OSRCS)
    2.37  DISTNAME = $(PACKAGE)-$(VERSION)
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/README	Sun Mar 16 15:37:16 2003 +0000
     3.3 @@ -0,0 +1,69 @@
     3.4 +tumble: build a PDF file from image files
     3.5 +Copyright 2003 Eric Smith <eric@brouhaha.com>
     3.6 +$Id: README,v 1.1 2003/03/16 07:37:16 eric Exp $
     3.7 +
     3.8 +Tumble is a utility to construct PDF files from one or more image
     3.9 +files.  Currently the only input image format supported is black &
    3.10 +white TIFF files, which may be either single- or multi-page files.  In
    3.11 +the future additional file formats will be supported, including gray
    3.12 +scale and color.  Black and white images will be encoded in the PDF
    3.13 +output using lossless Group 4 fax compression (ITU-T recommendation
    3.14 +T.6).  This provides a very good compression ratio for text and line
    3.15 +art.
    3.16 +
    3.17 +The current version of Tumble will only work on little-endian systems,
    3.18 +such as x86, VAX, and Alpha.  The byte order dependencies will be fixed
    3.19 +in a later release.
    3.20 +
    3.21 +The input and output files can be specified on the command line.
    3.22 +Alternatively, a control file, typically with a ".tum" suffix, may be
    3.23 +used which allows for more control over the files and options.
    3.24 +
    3.25 +The general command line syntax is:
    3.26 +
    3.27 +    tumble [options] <input.tif>... -o <output.pdf>
    3.28 +
    3.29 +The options in this mode are:
    3.30 +
    3.31 +    -v        verbose
    3.32 +    -b <fmt>  create bookmarks
    3.33 +
    3.34 +If the "-b" option is given, bookmarks will be created using the
    3.35 +format string, which may contain arbitrary text and/or the following
    3.36 +format specifiers:
    3.37 +
    3.38 +    %F  file name, sans suffix  e.g., "foo.tif" will just appear as "foo"
    3.39 +    %p  page number of input file, useful for multipage TIFF files
    3.40 +
    3.41 +There is currently no documentation for the control file syntax, as it
    3.42 +is still being refined, and many of the options planned for use in
    3.43 +control files are not yet fully implemented.  Features that will be
    3.44 +available in control files include:
    3.45 +
    3.46 +    image resolution specification - useful for input files with
    3.47 +        unspecified resolution, or to override
    3.48 +    image rotation, in units of 90 degrees
    3.49 +    image cropping
    3.50 +    grouping to allow different specifications for individual pages
    3.51 +        or groups of consecutive pages (e.g., chapters)
    3.52 +    ability to control operations independently on even and odd pages
    3.53 +        (e.g., different rotation or cropping)
    3.54 +    more flexible bookmark control
    3.55 +    page labels, so that the PDF file can present the actual document
    3.56 +        page numbers such as xvii or 3-27
    3.57 +
    3.58 +
    3.59 +This program is free software; you can redistribute it and/or modify
    3.60 +it under the terms of the GNU General Public License version 2 as
    3.61 +published by the Free Software Foundation.  Note that permission is
    3.62 +not granted to redistribute this program under the terms of any other
    3.63 +version of the General Public License.
    3.64 +
    3.65 +This program is distributed in the hope that it will be useful, but
    3.66 +WITHOUT ANY WARRANTY; without even the implied warranty of
    3.67 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    3.68 +General Public License for more details.
    3.69 +
    3.70 +You should have received a copy of the GNU General Public License
    3.71 +along with this program; if not, write to the Free Software
    3.72 +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA