contrib/groff/contrib/pdfmark/README

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