1151497SruREADME for pdfmark.tmac
2151497Sru=======================
3151497Sru
4151497SruCopyright (C) 2004, Free Software Foundation Inc.
5151497SruContributed by Keith Marshall (keith.d.marshall@ntlworld.com)
6151497Sru
7151497SruThis is free software.  See file COPYING, for copying permissions,
8151497Sruand warranty disclaimer.
9151497Sru
10151497SruThis is a preview release of a proposed pdfmark.tmac macro package,
11151497Srufor use with GNU troff (groff).  It is not yet complete, and should
12151497Srube considered as an alpha release;  there are a few problems to be
13151497Sruresolved (see file PROBLEMS).
14151497Sru
15151497SruPartial documentation is provided, in groff-ms format.  To convert
16151497Sruthis to PDF format, you will require a working groff installation,
17151497Srua working ghostscript installation, with the gs command in your PATH,
18151497Sruand a GNU-compatible make.  The tarball should be unpacked in the
19151497Srutop directory of your groff source tree, then:
20151497Sru
21151497Sru  cd <groff-current>/contrib/pdfmark
22151497Sru  make pdfmark
23151497Sru
24151497Sruwhere <groff-current> is the top directory of your current groff
25151497Srusource tree.
26151497Sru
27151497SruIncluded in this package, are:
28151497Sru
29151497Sru  pdfmark.tmac -- the core pdfmark macro set
30151497Sru  spdf.tmac    -- a rudimentary set of bindings for ms macros
31151497Sru  pdfmark.ms   -- preliminary documentation
32151497Sru  cover.ms     -- a template for the documentation cover sheet
33151497Sru  gnu.eps      -- the groff logo, copied from the groff distribution
34151497Sru  Makefile     -- makefile, for formatting the documentation
35151497Sru  README       -- this file
36151497Sru  PROBLEMS     -- a list of known problems
37151497Sru  TODO         -- a list of planned features, not yet implemented
38151497Sru
39151497SruTo make the pdfmark macros generally usable, copy pdfmark.tmac to the
40151497Sru'site-tmac' directory appropriate to your groff installation; (ms users
41151497Srumay also wish to copy spdf.tmac).  The macros may then be accessed, by
42151497Sruincluding the '-mpdfmark' option on the groff command line; (for ms
43151497Sruusers, '-mspdf' is equivalent to '-ms -mpdfmark', with some extra
44151497Srumacros 'thrown in').
45151497Sru
46151497SruComments, and bug reports are welcomed.  Please post to the groff
47151497Srumailing list, groff@gnu.org; (you must be subscribed to this list to
48151497Srupost mails).  To subscribe, visit
49151497Sru  
50151497Sru  http://lists.gnu.org/mailman/listinfo/groff
51