/contrib/groff/contrib/pdfmark/README

https://bitbucket.org/freebsd/freebsd-head/ · #! · 50 lines · 39 code · 11 blank · 0 comment · 0 complexity · 0156f5d01c54e14a1ce4f60dd7b3c5e0 MD5 · raw file

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