contrib/pdfmark/README

   1     Copyright 2004
   2       Free Software Foundation, Inc.
   3
   4     Copying and distribution of this file, with or without modification,
   5     are permitted in any medium without royalty provided the copyright
   6     notice and this notice are preserved.
   7
   8 README for pdfmark.tmac
   9 =======================
  10
  11 Copyright (C) 2004, Free Software Foundation Inc.
  12 Contributed by Keith Marshall (keith.d.marshall@ntlworld.com)
  13
  14 This is free software.  See file COPYING, for copying permissions,
  15 and warranty disclaimer.
  16
  17 This is a preview release of a proposed pdfmark.tmac macro package,
  18 for use with GNU troff (groff).  It is not yet complete, and should
  19 be considered as an alpha release;  there are a few problems to be
  20 resolved (see file PROBLEMS).
  21
  22 Partial documentation is provided, in groff-ms format.  To convert
  23 this to PDF format, you will require a working groff installation,
  24 a working ghostscript installation, with the gs command in your PATH,
  25 and a GNU-compatible make.  The tarball should be unpacked in the
  26 top directory of your groff source tree, then:
  27
  28   cd <groff-current>/contrib/pdfmark
  29   make pdfmark
  30
  31 where <groff-current> is the top directory of your current groff
  32 source tree.
  33
  34 Included in this package, are:
  35
  36   pdfmark.tmac -- the core pdfmark macro set
  37   spdf.tmac    -- a rudimentary set of bindings for ms macros
  38   pdfmark.ms   -- preliminary documentation
  39   cover.ms     -- a template for the documentation cover sheet
  40   Makefile     -- makefile, for formatting the documentation
  41   README       -- this file
  42   PROBLEMS     -- a list of known problems
  43   TODO         -- a list of planned features, not yet implemented
  44
  45 To make the pdfmark macros generally usable, copy pdfmark.tmac to the
  46 'site-tmac' directory appropriate to your groff installation; (ms users
  47 may also wish to copy spdf.tmac).  The macros may then be accessed, by
  48 including the '-mpdfmark' option on the groff command line; (for ms
  49 users, '-mspdf' is equivalent to '-ms -mpdfmark', with some extra
  50 macros 'thrown in').
  51
  52 Comments, and bug reports are welcomed.  Please post to the groff
  53 mailing list, groff@gnu.org; (you must be subscribed to this list to
  54 post mails).  To subscribe, visit
  55
  56   http://lists.gnu.org/mailman/listinfo/groff