contrib/groffer/README

   1 The `groffer' program is the easiest way to read documents written in
   2 some `groff' language, such as the `man pages', the manual pages in
   3 many operating systems.  All input is sent to `grog' and then to
   4 `groff' such that no special `groff' arguments must be determined.
   5
   6 `groffer' also has many built-in `man' functionalities to find and
   7 read the manual pages on UNIX and similar operating systems.  It
   8 accepts the information from an installed `man' program, but tries to
   9 find a man path by itself if there isn't any.
  10
  11 So far, `groffer' is a shell script.  It should run on any POSIX or
  12 Bourne style shell, but it runs the fastest under the GNU `ash' shell.
  13 If this shell is available, it is started automatically.  There are
  14 efforts to port part of the shell script to C/C++ to increase the
  15 speed independent of the shell.
  16
  17 For reporting bugs of `groffer', groff's free mailing list
  18 <bug-groff@gnu.org> can be used.  For a general discussion, the
  19 <groff@gnu.org> is more useful; see the `README' file in the top
  20 directory of the `groff' source package for more details on this
  21 mailing list.
  22
  23
  24 ####### License
  25
  26 Copyright (C) 2003,2004 Free Software Foundation, Inc.
  27 Written by Bernd Warken
  28
  29 This file is part of groffer, which is part of groff.
  30
  31 groff is free software; you can redistribute it and/or modify it
  32 under the terms of the GNU General Public License as published by
  33 the Free Software Foundation; either version 2, or (at your option)
  34 any later version.
  35
  36 groff is distributed in the hope that it will be useful, but WITHOUT
  37 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  38 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  39 License for more details.
  40
  41 You should have received a copy of the GNU General Public License
  42 along with groff; see the files COPYING and LICENSE in the top
  43 directory of the groff source.  If not, write to the Free Software
  44 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.