/contrib/groff/contrib/groffer/README

https://bitbucket.org/freebsd/freebsd-head/ · #! · 104 lines · 74 code · 30 blank · 0 comment · 0 complexity · 31fcb649c6bf999c79e04878b30de922 MD5 · raw file

  1. README
  2. The `groffer' program is the easiest way to read documents written in
  3. some `roff' language, such as the `man pages', the manual pages in
  4. many operating systems.
  5. Input
  6. Input comes from either standard input or command line parameters that
  7. represent names of exisiting roff files or standardized specifications
  8. for searching man pages. All of these can be compressed in a format
  9. that is decompressible by `gzip', including `.gz', `bz2', and `.Z'.
  10. `groffer' has many built-in `man' functionalities to find and read the
  11. manual pages on UNIX and similar operating systems. It accepts the
  12. information from an installed `man' program, but tries to find a man
  13. path by itself.
  14. `groffer' bundles all filespec parameters into a single output file in
  15. the same way as `groff'. The disadvantage of this is that all file
  16. name arguments must use the same groff language. To change this, the
  17. option parsing must be revised for large parts. It seems that this
  18. would create incompatibilities, so the actual option strategy is kept.
  19. Output
  20. All input is first sent to `grog' to determine the necessary `groff'
  21. options and then to `groff'. So no special `groff' arguments must be
  22. given. But all `groff' options can be specified when this seems to be
  23. appropriate.
  24. The following displaying modes for the output are available:
  25. - Display formatted input with
  26. -- the X `roff' viewer `gxditview',
  27. -- a Postcript viewer,
  28. -- a PDF viewer,
  29. -- a DVI viewer,
  30. -- a web browser,
  31. -- a pager in a text terminal (tty).
  32. - Generate `groff' output on stdout without a viewer.
  33. - Generate the `groff intermediate output' on standard output without
  34. postprocessing.
  35. - Output the source code without any `groff' processing.
  36. - There are some information outputs without `groff' processing, such
  37. as by option `-V' and the `man' like `whatis' and `apropos'
  38. outputs.
  39. By default, the program tries to display with `gxditview' as graphical
  40. device in X; on non-X text terminals, the `tty' text mode with a pager
  41. is tried by default.
  42. Compatibility
  43. `groffer' consists of two shell scripts. It should run on any POSIX
  44. or Bourne style shell that supports shell functions. See file
  45. `README_SH' for more information.
  46. Mailing lists
  47. For reporting bugs of `groffer', groff's free mailing list
  48. <bug-groff@gnu.org> can be used.
  49. For a general discussion, the mailing list <groff@gnu.org> is more
  50. useful, but one has to subscribe to this list at
  51. http://lists.gnu.org/mailman/listinfo/groff.
  52. See the `README' file in the top directory of the `groff' source
  53. package for more details on these mailing lists.
  54. ####### License
  55. Last update: 2 August 2005
  56. Copyright (C) 2003,2004,2005 Free Software Foundation, Inc.
  57. Written by Bernd Warken
  58. This file is part of `groffer', which is part of `groff'.
  59. `groff' is free software; you can redistribute it and/or modify it
  60. under the terms of the GNU General Public License as published by
  61. the Free Software Foundation; either version 2, or (at your option)
  62. any later version.
  63. `groff' is distributed in the hope that it will be useful, but WITHOUT
  64. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  65. FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  66. for more details.
  67. You should have received a copy of the GNU General Public License
  68. along with `groff'; see the files COPYING and LICENSE in the top
  69. directory of the `groff' source. If not, write to the Free Software
  70. Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
  71. ####### Emacs settings
  72. Local Variables:
  73. mode: text
  74. End: