home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / doc / groff-base / README.Debian < prev    next >
Encoding:
Text File  |  2008-05-02  |  2.5 KB  |  58 lines
  1. groff for Debian
  2. ----------------
  3.  
  4. As of version 1.17-1, Debian groff was split into three packages:
  5. groff-base, groff, and groff-x11. At version 1.18-1 the groff-x11 package
  6. was merged back into groff. The current organization is as follows:
  7.  
  8.   groff-base - a stripped-down groff package containing the components
  9.                required to read man pages in ASCII, Latin-1, UTF-8, and
  10.                PostScript
  11.   groff      - all other components
  12.  
  13. If you only need groff in order to read man pages in common formats, you can
  14. remove the main groff package and save some disk space. For more
  15. information, please see 'dpkg --print-avail <package>' or 'apt-cache show
  16. <package>'.
  17.  
  18. If you see error messages like "groff: can't find `DESC' file", make sure
  19. that you have the groff package installed as well as groff-base, as this
  20. message indicates that the requested output device is not installed.
  21.  
  22. Where is the groff documentation? It's not easy to find when you're
  23. unfamiliar with the system (as I well remember). The 'SEE ALSO' section of
  24. the roff(7) man page has a good index.
  25.  
  26. The macro path in Debian groff is as follows:
  27.  
  28.   /usr/lib/groff/site-tmac
  29.     - old directory for compatibility purposes
  30.   /usr/share/groff/site-tmac (symlink to /etc/groff)
  31.     - local macro configuration, such as man.local
  32.   /usr/share/groff/<version>/tmac
  33.     - macros installed as part of groff
  34.   /usr/share/groff/tmac
  35.     - macros installed by other Debian packages
  36.  
  37. If you're using a UTF-8 locale and are having problems searching for dashes
  38. in man pages such as those in command-line options, this may be because the
  39. man page uses "-" rather than "\-" to represent them, so they get rendered
  40. as a Unicode hyphen which isn't the one you can type conveniently on your
  41. keyboard. These man pages should be fixed. However, you can make groff use a
  42. plain ASCII dash in this case by editing both /etc/groff/man.local and
  43. /etc/groff/mdoc.local and uncommenting the final request, so that it looks
  44. like this:
  45.  
  46. .  \" Debian: Many UTF-8 man pages use "-" instead of "\-" for dashes such
  47. .  \" as those in command-line options. This is a bug in those pages, but
  48. .  \" too many fonts are missing the Unicode HYPHEN character, so we render
  49. .  \" this as the ASCII-compatible HYPHEN-MINUS instead.
  50. .  if '\*[.T]'utf8' \
  51. .    char - \N'45'
  52.  
  53. As of groff 1.18.1.1-7, this defaults to being uncommented. You can comment
  54. it out again if you want to make sure that man pages you're writing are
  55. clear of this problem.
  56.  
  57.  -- Colin Watson <cjwatson@debian.org>  Sat, 15 Nov 2003 17:42:38 +0000
  58.