[Groff-commit] groff/contrib/groffer ChangeLog README README_S...

[Werner LEMBERG]

CVSROOT:        /cvsroot/groff
Module name:    groff
Branch:         
Changes by:     Werner LEMBERG <address@hidden> 05/05/20 06:12:24

Modified files:
        contrib/groffer: ChangeLog README README_SH groffer.man 
                         groffer.sh 

Log message:
        * release of groffer 0.9.13
        
        * groffer.sh:
        - first line: Add space to `#! /bin/sh'.
        - $_VIEWER_DVI: Add `kdvi'.
        - $_VIEWER_PDF: Add `kghostview', `ggv', and `kpdf'.
        - $_VIEWER_PS: Add `kghostview' and `ggv'.
        - $_modefile: For the output file name, add extension .ps for ps
        mode and .dvi for dvi mode.  This exists already for the html and
        pdf modes.
        - Update some parts of the documentation.
        
        * README, README_SH:
        - Move some parts on usage from README_SH to README.
        - Reformulate several parts of both files.
        
        * groffer.man: update

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/groffer/ChangeLog.diff?tr1=1.23&tr2=1.24&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/groffer/README.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/groffer/README_SH.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/groffer/groffer.man.diff?tr1=1.20&tr2=1.21&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/contrib/groffer/groffer.sh.diff?tr1=1.23&tr2=1.24&r1=text&r2=text

Patches:
Index: groff/contrib/groffer/ChangeLog
diff -u groff/contrib/groffer/ChangeLog:1.23 
groff/contrib/groffer/ChangeLog:1.24
--- groff/contrib/groffer/ChangeLog:1.23        Tue Nov 16 09:18:41 2004
+++ groff/contrib/groffer/ChangeLog     Fri May 20 06:12:24 2005
@@ -1,3 +1,23 @@
+2005-05-17  Bernd Warken
+       ________________________________________________________________
+       * release of groffer 0.9.13
+
+       * groffer.sh:
+       - first line: Add space to `#! /bin/sh'.
+       - $_VIEWER_DVI: Add `kdvi'.
+       - $_VIEWER_PDF: Add `kghostview', `ggv', and `kpdf'.
+       - $_VIEWER_PS: Add `kghostview' and `ggv'.
+       - $_modefile: For the output file name, add extension .ps for ps
+       mode and .dvi for dvi mode.  This exists already for the html and
+       pdf modes.
+       - Update some parts of the documentation.
+
+       * README, README_SH:
+       - Move some parts on usage from README_SH to README.
+       - Reformulate several parts of both files.
+
+       * groffer.man: update
+
 2004-11-15  Bernd Warken
        ________________________________________________________________
        * release of groffer 0.9.12
Index: groff/contrib/groffer/README
diff -u groff/contrib/groffer/README:1.3 groff/contrib/groffer/README:1.4
--- groff/contrib/groffer/README:1.3    Fri Jun  4 22:42:34 2004
+++ groff/contrib/groffer/README        Fri May 20 06:12:24 2005
@@ -1,18 +1,60 @@
+README
+
 The `groffer' program is the easiest way to read documents written in
 some `roff' language, such as the `man pages', the manual pages in
 many operating systems.
 
-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.
 
-So far, `groffer' is a shell script.  It should run on any POSIX or
-Bourne style shell.
+Input
+
+Input comes from either standard input or command line parameters that
+represent names of exisiting roff files or standardized specifications
+for searching man pages.  All of these can be compressed in a format
+that is decompressible by `gzip', including `.gz', `bz2', and `.Z'.
+
+`groffer' 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.
+
+`groffer' bundles all filespec parameters into a single output file in
+the same way as `groff'.  The disadvantage of this is that all file
+name arguments must use the same groff language.  To change this, the
+option parsing must be revised for large parts.  It seems that this
+would create incompatibilities, so the actual option strategy is kept.
+
+
+Output
+
+All input is first sent to `grog' to determine the necessary groff
+options and then to `groff'.  So no special `groff' arguments must be
+given.  But all `groff' options can be specified when this seems to be
+appropriate.
+
+The following displaying modes for the output are available:
+- Display formatted input with
+-- the X roff viewer `gxditview',
+-- a Prostcript viewer,
+-- a PDF viewer,
+-- a DVI viewer,
+-- a web browser,
+-- a pager in a text terminal (tty).
+- Generate groff output on stdout without a viewer.
+- Generate the troff intermediate output on standard output without
+  postprocessing.
+- Output the source code without any groff processing.
+By default, the program tries to display with `gxditview' as graphical
+device in X; on non-X text terminals, the `tty' text mode with a pager
+is tried by default.
+
+
+Compatibility
+
+`groffer' is a shell script.  It should run on any POSIX or Bourne
+style shell that supports shell functions with local variables.
+
+
+Mailing lists
 
 For reporting bugs of `groffer', groff's free mailing list
 <address@hidden> can be used.  For a general discussion, the
@@ -23,7 +65,7 @@
 
 ####### License
 
-Copyright (C) 2003,2004 Free Software Foundation, Inc.
+Copyright (C) 2003,2004,2005 Free Software Foundation, Inc.
 Written by Bernd Warken
 
 This file is part of groffer, which is part of groff.
Index: groff/contrib/groffer/README_SH
diff -u groff/contrib/groffer/README_SH:1.3 groff/contrib/groffer/README_SH:1.4
--- groff/contrib/groffer/README_SH:1.3 Tue Nov 16 09:18:41 2004
+++ groff/contrib/groffer/README_SH     Fri May 20 06:12:24 2005
@@ -1,39 +1,27 @@
-Description of groffer.sh, the shell version of groffer
+Additional description for groffer.sh, the shell version of groffer
 
-Display groff files and man pages on X or tty, even when compressed.
 
+Shell Compatibility
 
-Usage
+This shell script is compatible to both the GNU and the POSIX shell
+and utilities.  Care was taken to restrict the programming technics
+used here in order to achieve POSIX compatibility as far back as POSIX
+P1003.2 Draft 11.2 of September 1991, but including the local
+variables in functions that were eliminated only in this draft.  This
+draft is available at http://www.funet.fi/pub/doc/posix/p1003.2/d11.2
+in the internet.  So `groffer' should be compatible to most actual
+Bourne style shells.
+
+The `groffer' script provides its own option parser.  It is compatible
+to the usual GNU style command line (option clusters, long option
+names with 2 `-' signs, mixing of options and non-option file names),
+except that it is not possible to abbreviate long option names.
 
-Input comes from either standard input or command line parameters that
-represent names of exisiting roff files or standardized specifications
-for searching man pages.  All of these can be compressed in a format
-that is decompressible by `gzip', including `.gz', `bz2', and `.Z'.
-
-The following displaying modes are available:
-- Display formatted input with the X roff viewer `gxditview',
-- with a Prostcript viewer,
-- with a dvi viewer,
-- with a web browser.
-- Display formatted input in plain text mode.
-- Run a pager on the formatted input in a text terminal (tty).
-- Generate output for some groff device on stdout without a viewer.
-- Output only the source code without any groff processing.
-- Generate the troff intermediate output on standard output
-  without groff postprocessing.
-By default, the program tries to display with `gxditview' as graphical
-device, `tty' mode with a pager is tried as text display.
-
-
-Several File Arguments
-
-So far, `groffer' bundles all filespec parameters into a single output
-file in the same way as `groff'.  The disadvantage of this is that all
-file name arguments must have the same groff language.
-
-To change this, the option parsing must be revised for large parts.
-It seems that this would create incompatibilities, so the actual
-option strategy is kept.
+The flexible mixing of options and file names in GNU style is always
+possible, even if the environment variable `$POSIXLY_CORRECT' is set
+to a non-empty value.  This disables the rather wicked POSIX behavior
+to terminate option parsing when the first non-option command line
+argument is found.
 
 
 Error Handling
@@ -44,31 +32,6 @@
 and error().
 
 
-Shell Compatibility
-
-This shell script is compatible to the both the GNU and the POSIX
-shell and utilities.  Care was taken to restrict the programming
-technics used here in order to achieve POSIX compatibility as far back
-as POSIX P1003.2 Draft 11.2 of September 1991.
-
-The only non-builtin used here is POSIX `sed'.  This script was tested
-under `bash', `ash', and `ksh'.  The speed under `ash' is more than
-double when compared to the larger shells.  The new version of `ash'
-taken from `dash' produces strange errors, so the automatic call of
-`ash' was removed.
-
-This script provides its own option parser.  It is compatible to the
-usual GNU style command line (option clusters, long options, mixing of
-options and non-option file names), except that it is not possible to
-abbreviate long option names.
-
-The flexible mixing of options and file names in GNU style is always
-possible, even if the environment variable `$POSIXLY_CORRECT' is set
-to a non-empty value.  This disables the rather wicked POSIX behavior
-to terminate option parsing when the first non-option command line
-argument is found.
-
-
 Survey of Functions defined in groffer.sh
 
 The elements specified within paranthesis `(<>)' give hints to what
@@ -82,11 +45,11 @@
 for some function.  The internal functions are defined just after
 their corresponding function; they are not mentioned in the following.
 
-abort (text>*)
-base_name (path)
+abort (<text>*)
+base_name (<path>)
 catz (<file>)
 clean_up ()
-diag (text>*)
+diag (<text>*)
 dirname_append (<path> [<dir...>])
 dirname_chop (<path>)
 do_filearg (<filearg>)
@@ -206,7 +169,7 @@
 
 ####### License
 
-Copyright (C) 2003,2004 Free Software Foundation, Inc.
+Copyright (C) 2003,2004,2005 Free Software Foundation, Inc.
 Written by Bernd Warken
 
 This file is part of groffer, which is part of groff.
Index: groff/contrib/groffer/groffer.man
diff -u groff/contrib/groffer/groffer.man:1.20 
groff/contrib/groffer/groffer.man:1.21
--- groff/contrib/groffer/groffer.man:1.20      Sat Jun 12 13:26:57 2004
+++ groff/contrib/groffer/groffer.man   Fri May 20 06:12:24 2005
@@ -15,7 +15,7 @@
 Source file position:  <groff_source_top>/contrib/groffer/groffer.man
 Installed position:    $prefix/share/man/man1/groffer.1
 
-Last update : 3 June 2004
+Last update : 20 May 2005
 
 Source file position: <groff-source>/contrib/groffer/groffer.man
 ..
@@ -23,7 +23,7 @@
 This file was written by Bernd Warken.
 ..
 .de copyleft
-Copyright (C) 2001,2002,2004 Free Software Foundation, Inc.
+Copyright (C) 2001,2002,2004,2005 Free Software Foundation, Inc.
 .
 .P
 This file is part of groff, a free software project.
@@ -1081,8 +1081,17 @@
 .
 .
 .Opt_def -- html-viewer
-Equivalent to
-.Opt_long www-viewer .
+Set the web browser program for viewing in
+.I html
+mode.
+.
+Each program that accepts html input and allows the
+.BI file://localhost/ dir / file
+syntax on the command line is suitable as viewer program; it can be
+the path name of an executable file or a program in
+.Env_var $PATH .
+.
+In each case, arguments can be provided additionally.
 .
 .
 .Opt_def -- mode value
@@ -1200,7 +1209,7 @@
 .TP
 .Header_CB www
 Equivalent to
-.Opt_long www .
+.Opt_long_arg mode html .
 .
 .
 .TP
@@ -1308,21 +1317,12 @@
 .
 .Opt_def -- www
 Equivalent to
-.Opt_long_arg mode www .
+.Opt_long_arg mode html .
 .
 .
 .Opt_def -- www-viewer prog
-Set the web browser program for viewing in
-.I www
-mode.
-.
-Each program that accepts html input and allows the
-.BI file://localhost/ dir / file
-syntax on the command line is suitable as viewer program; it can be
-the path name of an executable file or a program in
-.Env_var $PATH .
-.
-In each case, arguments can be provided additionally.
+Equivalent to
+.Opt_long html-viewer .
 .
 .
 .Opt_def - X -- X -- x
@@ -1687,7 +1687,7 @@
 .
 .
 .\" --------------------------------------------------------------------
-.SS "Options from man"
+.SS "Options for man"
 .\" --------------------------------------------------------------------
 .
 The long options of
@@ -1703,7 +1703,7 @@
 .
 .
 .P
-The following two options were added by
+The following two options were added to
 .I groffer
 for choosing whether the file name arguments are interpreted as names
 for local files or as a search pattern for man pages.
@@ -2847,7 +2847,7 @@
 #
 # some shell commands
 if test "$DISPLAY" = ""; then
-  DISPLAY='localhost:0.0'
+  export DISPLAY='localhost:0.0'
 fi
 date >>~/mygroffer.log
 .fi
@@ -3073,10 +3073,12 @@
 POSIX compatibility refers to
 .B IEEE P1003.2/D11.2
 of September 1991, a very early version of the POSIX standard that is
-still freely available in the internet.
+still freely available in the internet at
+.URL http://\:www.funet.fi/pub/doc/posix/p1003.2/d11.2/all \
+"POSIX P1003.2 draft 11.2" .
 .
-Unfortunately, this version of the standard has `local' for shell
-function variables removed.
+Unfortunately, this version of the standard removed `local' for shell
+function variables, but later POSIX versions restored this again.
 .
 As `local' is needed for serious programming this temporary POSIX
 deprecation was ignored.
@@ -3206,6 +3208,24 @@
 .
 .
 .TP
+.BR groff (@MAN7EXT@)
+Documentation of the
+.I groff
+language.
+.
+.
+.TP
+.BR grog (@MAN1EXT@)
+Internally, groffer tries to guess the groff command line options from
+the input using this program.
+.
+.
+.TP
+.BR groff_out (@MAN5EXT@)
+Documentation on the groff intermediate output (ditroff output).
+.
+.
+.TP
 .BR man (1)
 The standard program to diplay man\~pages.
 .
@@ -3225,33 +3245,38 @@
 .
 .
 .TP
+.BR kghostview (1)
+.TP+
+.BR ggv (1)
+.TP+
 .BR gv (1)
 .TP+
 .BR ghostview (1)
-Viewers for groffer's
-.I ps
-mode.
-.
-.
 .TP+
 .BR gs (1)
-Transformer from
-.I ps
-to
-.IR pdf ;
-and a
+Viewers for groffer's
 .I ps
-viewer.
+mode.
 .
 .
 .TP
+.BR kghostview (1)
+.TP+
+.BR ggv (1)
+.TP+
 .BR xpdf (1)
-Viewers for
+.TP+
+.BR acroread (1)
+.TP+
+.BR kpdf (1)
+Viewers for groffer's
 .I pdf
-files.
+mode.
 .
 .
 .TP
+.BR kdvi (1)
+.TP+
 .BR xdvi (1)
 .TP+
 .BR dvilx (1)
@@ -3261,6 +3286,19 @@
 .
 .
 .TP
+.BR konqueror (1)
+.TP+
+.BR mozilla (1)
+.TP+
+.BR lynx (1)
+Web-browsers for groffer's
+.I html
+or
+.I www
+mode.
+.
+.
+.TP
 .BR less (1)
 Standard pager program for the
 .I tty
@@ -3274,24 +3312,6 @@
 The decompression programs supported by groffer.
 .
 .
-.TP
-.BR groff (@MAN7EXT@)
-Documentation of the
-.I groff
-language.
-.
-.
-.TP
-.BR grog (@MAN1EXT@)
-Internally, groffer tries to guess the groff command line options from
-the input using this program.
-.
-.
-.TP
-.BR groff_out (@MAN5EXT@)
-Documentation on the groff intermediate output (ditroff output).
-.
-.
 .\" --------------------------------------------------------------------
 .SH "AUTHOR"
 .\" --------------------------------------------------------------------
Index: groff/contrib/groffer/groffer.sh
diff -u groff/contrib/groffer/groffer.sh:1.23 
groff/contrib/groffer/groffer.sh:1.24
--- groff/contrib/groffer/groffer.sh:1.23       Wed May 18 07:03:06 2005
+++ groff/contrib/groffer/groffer.sh    Fri May 20 06:12:24 2005
@@ -4,7 +4,7 @@
 
 # Source file position: <groff-source>/contrib/groffer/groffer.sh
 
-# Copyright (C) 2001,2002,2003,2004 Free Software Foundation, Inc.
+# Copyright (C) 2001,2002,2003,2004,2005 Free Software Foundation, Inc.
 # Written by Bernd Warken
 
 # This file is part of groff version @address@hidden
@@ -25,8 +25,8 @@
 # Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 _PROGRAM_NAME='groffer';
-_PROGRAM_VERSION='0.9.12';
-_LAST_UPDATE='15 November 2004';
+_PROGRAM_VERSION='0.9.13';
+_LAST_UPDATE='17 May 2005';
 
 
 ########################################################################
@@ -264,9 +264,9 @@
 export _VIEWER_PS;             # viewer program for ps mode
 export _VIEWER_HTML_X;         # viewer program for html mode in X
 export _VIEWER_HTML_TTY;       # viewer program for html mode in tty
-_VIEWER_DVI='xdvi,dvilx';
-_VIEWER_PDF='xpdf,acroread';
-_VIEWER_PS='gv,ghostview,gs_x11,gs';
+_VIEWER_DVI='kdvi,xdvi,dvilx';
+_VIEWER_PDF='kghostview,ggv,xpdf,acroread,kpdf';
+_VIEWER_PS='kghostview,ggv,gv,ghostview,gs_x11,gs';
 _VIEWER_HTML='konqueror,mozilla,netscape,opera,amaya,arena,lynx';
 _VIEWER_X='gxditview,xditview';
 
@@ -1040,7 +1040,7 @@
 
 
 ########################################################################
-#                   Definition of normal Functions
+#       Definition of normal Functions in alphabetical order
 ########################################################################
 landmark "3: functions";
 
@@ -3203,17 +3203,18 @@
 
 
 ########################################################################
-#                              main
+#                        main* Functions
 ########################################################################
 
 # The main area contains the following parts:
 # - main_init(): initialize temporary files and set exit trap
-# - parse $MANOPT
+# - main_parse_MANOPT(): parse $MANOPT
 # - main_parse_args(): argument parsing
-# - determine display mode
-# - process filespec arguments
-# - setup X resources
-# - do the displaying
+# - main_set_mode (): determine the display mode
+# - main_do_fileargs(): process filespec arguments
+# - main_set_resources(): setup X resources
+# - main_display(): do the displaying
+# - main(): the main function that calls all main_*()
 
 # These parts are implemented as functions, being defined below in the
 # sequence they are called in the main() function.
@@ -4428,6 +4429,7 @@
             "wrong device for ${_DISPLAY_MODE} mode: ${_OPT_DEVICE}";
           ;;
       esac;
+      _modefile="${_modefile}".dvi;
       _groggy="$(tmp_cat | grog -Tdvi)";
       _do_display;
       ;;
@@ -4439,7 +4441,7 @@
             "wrong device for ${_DISPLAY_MODE} mode: ${_OPT_DEVICE}";
           ;;
       esac;
-      _modefile="${_modefile}".html
+      _modefile="${_modefile}".html;
       _groggy="$(tmp_cat | grog -Thtml)";
       _do_display;
       ;;
@@ -4453,7 +4455,6 @@
             "wrong device for ${_DISPLAY_MODE} mode: ${_OPT_DEVICE}";
           ;;
       esac;
-      _modefile="${_modefile}"
       _groggy="$(tmp_cat | grog -Tps)";
       trap_clean;
       # start a new shell program to get another process ID.
@@ -4491,6 +4492,7 @@
             "wrong device for ${_DISPLAY_MODE} mode: ${_OPT_DEVICE}";
           ;;
       esac;
+      _modefile="${_modefile}".ps;
       _groggy="$(tmp_cat | grog -Tps)";
       _do_display;
       ;;