/[groff]/groff/contrib/groffer/README
ViewVC logotype

Diff of /groff/contrib/groffer/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by wlemb, Fri Jun 4 22:42:34 2004 UTC revision 1.4 by wl, Fri May 20 06:12:24 2005 UTC
# Line 1  Line 1 
1    README
2    
3  The `groffer' program is the easiest way to read documents written in  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  some `roff' language, such as the `man pages', the manual pages in
5  many operating systems.  many operating systems.
6    
 All input is sent to `grog' and then to `groff' such that no special  
 `groff' arguments must be determined, but all `groff' options can be  
 specified.  
   
 `groffer' also has many built-in `man' functionalities to find and  
 read the manual pages on UNIX and similar operating systems.  It  
 accepts the information from an installed `man' program, but tries to  
 find a man path by itself.  
7    
8  So far, `groffer' is a shell script.  It should run on any POSIX or  Input
9  Bourne style shell.  
10    Input comes from either standard input or command line parameters that
11    represent names of exisiting roff files or standardized specifications
12    for searching man pages.  All of these can be compressed in a format
13    that is decompressible by `gzip', including `.gz', `bz2', and `.Z'.
14    
15    `groffer' has many built-in `man' functionalities to find and read the
16    manual pages on UNIX and similar operating systems.  It accepts the
17    information from an installed `man' program, but tries to find a man
18    path by itself.
19    
20    `groffer' bundles all filespec parameters into a single output file in
21    the same way as `groff'.  The disadvantage of this is that all file
22    name arguments must use the same groff language.  To change this, the
23    option parsing must be revised for large parts.  It seems that this
24    would create incompatibilities, so the actual option strategy is kept.
25    
26    
27    Output
28    
29    All input is first sent to `grog' to determine the necessary groff
30    options and then to `groff'.  So no special `groff' arguments must be
31    given.  But all `groff' options can be specified when this seems to be
32    appropriate.
33    
34    The following displaying modes for the output are available:
35    - Display formatted input with
36    -- the X roff viewer `gxditview',
37    -- a Prostcript viewer,
38    -- a PDF viewer,
39    -- a DVI viewer,
40    -- a web browser,
41    -- a pager in a text terminal (tty).
42    - Generate groff output on stdout without a viewer.
43    - Generate the troff intermediate output on standard output without
44      postprocessing.
45    - Output the source code without any groff processing.
46    By default, the program tries to display with `gxditview' as graphical
47    device in X; on non-X text terminals, the `tty' text mode with a pager
48    is tried by default.
49    
50    
51    Compatibility
52    
53    `groffer' is a shell script.  It should run on any POSIX or Bourne
54    style shell that supports shell functions with local variables.
55    
56    
57    Mailing lists
58    
59  For reporting bugs of `groffer', groff's free mailing list  For reporting bugs of `groffer', groff's free mailing list
60  <bug-groff@gnu.org> can be used.  For a general discussion, the  <bug-groff@gnu.org> can be used.  For a general discussion, the
# Line 23  these mailing lists. Line 65  these mailing lists.
65    
66  ####### License  ####### License
67    
68  Copyright (C) 2003,2004 Free Software Foundation, Inc.  Copyright (C) 2003,2004,2005 Free Software Foundation, Inc.
69  Written by Bernd Warken  Written by Bernd Warken
70    
71  This file is part of groffer, which is part of groff.  This file is part of groffer, which is part of groff.

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26