contrib/groffer/README

   1 README
   2
   3 The `groffer' program is the easiest way to read documents written in
   4 some `roff' language, such as the `man pages', the manual pages in
   5 many operating systems.  All `roff' preprocessors, such as `chem', are
   6 detected and executed automatically.
   7
   8
   9 Source files in this directory
  10
  11 ChangeLog       information on all changements for groffer versions 1.*
  12 Makefile.sub    make file used by groff
  13 README          this file, general description of the program
  14 version.sh      information on version number and last update
  15 perl_test.pl    test whether perl has a suitable version
  16 perl/           subdirectory for the Perl version, see perl/README_PERL
  17 shell/          subdirectory for the shell version, see shell/README_SH
  18
  19
  20 Input
  21
  22 Input comes from either standard input or command line parameters that
  23 represent names of exisiting roff files or standardized specifications
  24 for searching man pages.  All of these can be compressed in a format
  25 that is decompressible by `gzip' or `bzip2', including `.gz', `bz2',
  26 and `.Z'.
  27
  28 `groffer' has many built-in `man' functionalities to find and read the
  29 manual pages on UNIX and similar operating systems.  It accepts the
  30 information from an installed `man' program, but tries to find a man
  31 path by itself.
  32
  33 `groffer' bundles all filespec parameters into a single output file in
  34 the same way as `groff'.  The disadvantage of this is that all file
  35 name arguments must use the same groff language.  To change this, the
  36 option parsing must be revised for large parts.  It seems that this
  37 would create incompatibilities, so the actual option strategy is kept.
  38
  39
  40 Output
  41
  42 All input is first sent to `grog' to determine the necessary `groff'
  43 command and then to `groff' together with all necessary preprocessors.
  44 So no special `groff' arguments must be given.  But all `groff'
  45 options can be specified when this seems to be appropriate.
  46
  47 The following displaying modes for the output are available:
  48 - Display formatted input with
  49 -- a PDF viewer,
  50 -- a Postcript viewer,
  51 -- a web browser,
  52 -- the X `roff' viewer `gxditview',
  53 -- a DVI viewer,
  54 -- a pager in a text terminal (tty).
  55 - Generate `groff' output on stdout without a viewer.
  56 - Generate the `groff intermediate output' on standard output without
  57   postprocessing.
  58 - Output the source code without any `groff' processing.
  59 - There are some information outputs without `groff' processing, such
  60   as by option `-V' and the `man' like `whatis' and `apropos'
  61   outputs.
  62
  63 By default, the program tries to display a graphical device in X; on
  64 non-X text terminals, the `tty' text mode with a pager is tried by
  65 default.
  66
  67
  68 File access
  69
  70 The shell and the Perl version of groffer now use umask of 077.  This
  71 is a very strict security issue.  It allows only access of the
  72 temporary files by the file owner.
  73
  74
  75 Compatibility
  76
  77 `groffer' is compatible with the `man' program.  It supports .so
  78 requests based on the man path and compressed files.  That's more than
  79 `groff' does.
  80
  81
  82 Mailing lists
  83
  84 For reporting bugs of `groffer', groff's free mailing list
  85 <bug-groff@gnu.org> can be used.
  86
  87 For a general discussion, the mailing list <groff@gnu.org> is more
  88 useful, but one has to subscribe to this list at
  89 http://lists.gnu.org/mailman/listinfo/groff.
  90
  91 See the `README' file in the top directory of the `groff' source
  92 package for more details on these mailing lists.
  93
  94
  95 ####### License
  96
  97 Last update: 12 Oct 2006
  98
  99 Copyright (C) 2003,2004,2005,2006 Free Software Foundation, Inc.
 100 Written by Bernd Warken.
 101
 102 This file is part of `groffer', which is part of `groff'.
 103
 104 `groff' is free software; you can redistribute it and/or modify it
 105 under the terms of the GNU General Public License as published by
 106 the Free Software Foundation; either version 2, or (at your option)
 107 any later version.
 108
 109 `groff' is distributed in the hope that it will be useful, but WITHOUT
 110 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 111 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 112 for more details.
 113
 114 You should have received a copy of the GNU General Public License
 115 along with `groff'; see the files COPYING and LICENSE in the top
 116 directory of the `groff' source.  If not, write to the Free Software
 117 Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
 118
 119
 120 ####### Emacs settings
 121
 122 Local Variables:
 123 mode: text
 124 End: