contrib/pdfmark/README

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