[Groff-commit] groff/contrib/groffer ChangeLog groffer.man gro...

[Bernd Warken]

CVSROOT:        /cvsroot/groff
Module name:    groff
Changes by:     Bernd Warken <bwarken>  06/10/02 23:32:00

Modified files:
        contrib/groffer: ChangeLog groffer.man groffer2.sh version.sh 

Log message:
        Update groffer 0.9.29

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/groffer/ChangeLog?cvsroot=groff&r1=1.41&r2=1.42
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/groffer/groffer.man?cvsroot=groff&r1=1.32&r2=1.33
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/groffer/groffer2.sh?cvsroot=groff&r1=1.9&r2=1.10
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/groffer/version.sh?cvsroot=groff&r1=1.5&r2=1.6

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/contrib/groffer/ChangeLog,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -b -r1.41 -r1.42
--- ChangeLog   1 Oct 2006 12:27:01 -0000       1.41
+++ ChangeLog   2 Oct 2006 23:32:00 -0000       1.42
@@ -1,3 +1,23 @@
+2006-10-03  Bernd Warken
+       ________________________________________________________________
+       * release of groffer 0.9.29
+
+       * groffer2.sh:
+       - --to-stdtout: New option to display the generated mode file
+       without graphical display.
+        - main_do_fileargs(): Distribute special_filespec() in order to
+        get a better heading for `whatis'.
+       - _get_prog_args() of main_set_mode(): Make argument upper case.
+       - usage(): Add --to-stdout, remove -Q, reorder --source.
+       
+       * groffer.man:
+       - Reorder the default viewers.
+       - Move `--source' to `groffer' options.
+       - Remove `-Q'.
+       - Add `--to-stdout'.
+       - Reconfigure the sections on filespec arguments.
+       - Remove information on wildcards.
+       
 2006-10-01  Bernd Warken
        ________________________________________________________________
        * release of groffer 0.9.28

Index: groffer.man
===================================================================
RCS file: /cvsroot/groff/groff/contrib/groffer/groffer.man,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -b -r1.32 -r1.33
--- groffer.man 16 Sep 2006 16:06:23 -0000      1.32
+++ groffer.man 2 Oct 2006 23:32:00 -0000       1.33
@@ -15,7 +15,7 @@
 Source file position:  <groff_source_top>/contrib/groffer/groffer.man
 Installed position:    $prefix/share/man/man1/groffer.1
 
-Last update: 16 Sep 2006
+Last update: 3 Oct 2006
 
 Source file position: <groff-source>/contrib/groffer/groffer.man
 ..
@@ -816,7 +816,9 @@
 .Opt_[alt] -- pdf\-viewer prog
 .Opt_[alt] -- ps
 .Opt_[alt] -- ps\-viewer prog
+.Opt_[alt] -- source
 .Opt_[alt] -- text
+.Opt_[alt] -- to\-stdout
 .Opt_[alt] -- tty
 .Opt_[alt] -- tty\-viewer prog
 .Opt_[alt] -- www
@@ -911,7 +913,6 @@
 .Opt_[alt] -- do\-nothing
 .Opt_[alt] -- print text
 .Opt_[alt] -- shell prog
-.Opt_[alt] - Q -- source
 .Opt_[alt] - V
 .RE
 .
@@ -920,6 +921,40 @@
 .I \%filespec arguments
 .RS
 .P
+The
+.I \%filespec
+parameters are all arguments that are neither an option nor an option
+argument.
+.
+They usually mean a file name or a
+.I man page
+searching scheme.
+.
+.
+.P
+In the following, the term
+.I section_extension
+is used.
+.
+It means a word that consists of a
+.I man section
+that is optionally followed by an
+.IR extension .
+.
+The name of a
+.I man section
+is a single character from
+.BR \%[1-9on] ,
+the
+.I extension
+is some word.
+.
+The
+.I extension
+is mostly lacking.
+.
+.
+.P
 No
 .I \%filespec
 parameters means standard input.
@@ -936,48 +971,30 @@
 .
 .
 .TP
-.BI man: name ( section )
+.BI man: name ( section_extension )
 .TP+
-.IB name ( section )
-search the \%man\~page
-.I \%name
-in \%man\~section
-.IR section .
-.
-.
-.TP
-.BI man: name . s
+.BI man: name . section_extension
 .TP+
-.IB name . s
-if
-.I s
-is a character in
-.BR \%[1-9on] ,
-search for a \%man\~page
+.IB name ( section_extension )
+.TP+
+.IB name . section_extension
+.TP+
+.I "section_extension name"
+search the \%man\~page
 .I \%name
-in \%man\~section
-.IR s .
+in the section with optional extension
+.IR section_extension .
 .
 .
 .TP
 .BI man: name
-\%man\~page in the lowest \%man\~section that has
+\%man\~page in the lowest
+.I \%man\~section
+that has
 .IR \%name .
 .
 .
 .TP
-.I "s name"
-if
-.I s
-is a character in
-.BR \%[1-9on] ,
-search for a \%man\~page
-.I \%name
-in \%man\~section
-.IR s .
-.
-.
-.TP
 .I name
 if
 .I \%name
@@ -1388,8 +1405,8 @@
 .
 .TP
 .Header_CB source
-Display the source code of the input without formatting; equivalent to
-.Opt_short Q .
+Output the roff source code of the input files without further
+processing.
 .
 .
 .RE
@@ -1430,11 +1447,23 @@
 In each case, arguments can be provided additionally.
 .
 .
+.Opt_def -- source
+Equivalent
+.Opt_long_arg mode source .
+.
+.
 .Opt_def -- text
 Equivalent to
 .Opt_long_arg mode text .
 .
 .
+.Opt_def -- to\-stdout
+The file for the chosen mode is generated and its content is printed
+to standard output.
+.
+It will not be displayed in graphical mode.
+.
+.
 .Opt_def -- tty
 Equivalent to
 .Opt_long_arg mode tty .
@@ -2224,14 +2253,6 @@
 Some shells run considerably faster than the standard shell.
 .
 .
-.Opt_def - Q -- source
-Output the roff source code of the input files without further
-processing.
-.
-This is the equivalent
-.Opt_long_arg mode source .
-.
-.
 .Opt_def - V
 This is an advanced option for debugging only.
 .
@@ -2280,8 +2301,6 @@
 .I \%filespec
 parameter is an argument that is not an option or option argument.
 .
-It means an input source.
-.
 In
 .BR \%groffer ,
 .I \%filespec
@@ -2327,27 +2346,35 @@
 or
 .BR o .
 .
-In the following, a stand-alone character
-.I s
-stands for a
-.IR "classical man section" .
-The internal precedence of
-.B \%man
-for searching
-.I \%man\~pages
-with the same name within several sections goes according to the
-classical single-character sequence.
 .
-On some systems, this single character can be extended by a following
-string.
+.P
+This can optionally be followed by a string, the so-called
+.IR extension .
+The
+.I extension
+allows to store several
+.I man\~pages
+with the same name in the same
+.IR section .
+But the
+.I extension
+is only rarely used, usually it is omitted.
 .
-But the special
-.B \%groffer
-.I \%man\~page
-facility is based on the classical single character sections.
+Then the
+.I extensions
+are searched automatically by alphabet.
 .
 .
 .P
+In the following, we use the name
+.I section_extension
+for a word that consists of a single character
+.I section
+name or a
+.I section
+character that is followed by an
+.IR extension .
+.
 Each
 .I \%filespec
 parameter can have one of the following forms in decreasing sequence.
@@ -2382,44 +2409,15 @@
 .
 .
 .Topic
-.BI \%man: name ( section )
-and
-.IB \%name ( section )
+.BI \%man: name ( section_extension ) ,
+.BI \%man: name . section_extension,
+.IB \%name ( section_extension ) ,
+or
+.IB \%name . section_extension
 search the \%man\~page
 .I \%name
-in \%man\~section\~\c
-.IR \%section ,
-where
-.I \%section
-can be any string, but it must exist in the
-.I \%man
-system.
-.
-.
-.Topic
-Next some patterns based on the
-.I classical man sections
-are checked.
-.
-.BI \%man: name . s
-and
-.IB \%name . s
-search for a \%man\~page
-.I \%name
-in \%man\~section
-.I s
-if
-.I s
-is a
-.I classical man section
-mentioned above.
-.
-Otherwise a
-.I \%man\~page
-named
-.IR \%name.s
-is searched in the lowest
-.B man\~section .
+in \%man\~section and possibly extension of
+.IR \%section_extension .
 .
 .
 .Topic
@@ -2434,29 +2432,20 @@
 .
 .
 .Topic
-The pattern
-.I \%s\~name
-originates from a strange argument parsing of the
+.I \%section_extension\~name
+is a pattern of 2 arguments that originates from a strange argument
+parsing of the
 .B man
 program.
 .
-If
-.I s
-is a
-.I classical man section
-interpret it as a search for a
-.I \%man\~page
-called
-.I \%name
-in man\~section
-.IR s ,
-otherwise interpret both
-.I s
-and
-.I \%name
-as two independent
-.I \%filespec
-arguments.
+Again, this searches the man page
+.I name
+with 
+.IR \%section_extension ,
+a combination of a
+.I section
+character optionally followed by an
+.IR extension .
 .
 .
 .Topic
@@ -2474,16 +2463,6 @@
 .
 .
 .P
-Wildcards in
-.I \%filespec
-arguments are only accepted for
-.Opt_long apropos*
-and
-.Opt_long whatis ;
-for normal display, they are interpreted as characters.
-.
-.
-.P
 Several file name arguments can be supplied.
 .
 They are mixed by
@@ -2590,41 +2569,41 @@
 \%\f[CR]X\~Window\f[] viewer progams are
 .
 .Topic
-\%\f[CR]X\~Window\f[]
-.I roff
-viewers such as
-.BR \%gxditview (@MAN1EXT@)
-or
-.BR \%xditview (1)
-(in
-.IR \%x\~mode ),
-.
-.Topic
-in a Postscript viewer
+in a PDF viewer
 .nh
-.RI ( \%ps\~mode ),
+.RI ( \%pdf\~mode ),
 .hy
 .
 .Topic
-in a dvi viewer program
+in a web browser
 .nh
-.RI ( \%dvi\~mode ),
+.RI ( html
+or
+.IR \%www\~mode ).
 .hy
+.RE
 .
 .Topic
-in a PDF viewer
+in a Postscript viewer
 .nh
-.RI ( \%pdf\~mode ),
+.RI ( \%ps\~mode ),
 .hy
 .
 .Topic
-in a web browser
-.nh
-.RI ( html
+\%\f[CR]X\~Window\f[]
+.I roff
+viewers such as
+.BR \%gxditview (@MAN1EXT@)
 or
-.IR \%www\~mode ).
+.BR \%xditview (1)
+(in
+.IR \%x\~mode ),
+.
+.Topic
+in a dvi viewer program
+.nh
+.RI ( \%dvi\~mode ),
 .hy
-.RE
 .
 .
 .P
@@ -2719,13 +2698,20 @@
 The
 .I \%source\~mode
 with option
-.Opt_short Q
-and
 .Opt_long source
 just displays the decompressed input.
 .
 .
 .P
+Otion
+.Opt_long to\-stdout
+does not display in a graphical mode.
+.
+It just generates the file for the chosen mode and then prints its
+content to standard output.
+.
+.
+.P
 The
 .I \%groff\~mode
 passes the input to

Index: groffer2.sh
===================================================================
RCS file: /cvsroot/groff/groff/contrib/groffer/groffer2.sh,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- groffer2.sh 1 Oct 2006 12:27:01 -0000       1.9
+++ groffer2.sh 2 Oct 2006 23:32:00 -0000       1.10
@@ -12,7 +12,7 @@
 # Free Software Foundation, Inc.
 # Written by Bernd Warken
 
-# Last update: 1 Oct 2006
+# Last update: 3 Oct 2006
 
 # This file is part of `groffer', which is part of `groff'.
 
@@ -525,7 +525,7 @@
 'debug-params' 'debug-shell' 'debug-stacks' 'debug-tmpdir' 'debug-user' \
 'default' 'do-nothing' 'dvi' 'groff' 'help' 'intermediate-output' 'html' \
 'man' 'no-location' 'no-man' 'no-special' 'pdf' 'ps' 'rv' 'source' \
-'text' 'text-device' 'tty' 'tty-device' \
+'text' 'to-stdout' 'text-device' 'tty' 'tty-device' \
 'version' 'whatis' 'www' 'x' 'X'";
 
 _OPTS_GROFFER_LONG_ARG="\
@@ -639,39 +639,40 @@
 export _PDF_HAS_GS;
 export _PDF_HAS_PS2PDF;
 # _OPT_* as parsed from groffer command line
-export _OPT_ALL;               # display all suitable man pages.
-export _OPT_APROPOS;           # call `apropos' program.
-export _OPT_BD;                        # set border color in some modes.
-export _OPT_BG;                        # set background color in some modes.
-export _OPT_BW;                        # set border width in some modes.
-export _OPT_DEFAULT_MODES;     # `,'-list of modes when no mode given.
-export _OPT_DEVICE;            # device option.
-export _OPT_DO_NOTHING;                # do nothing in main_display().
-export _OPT_DISPLAY;           # set X display.
-export _OPT_EXTENSION;         # set extension for man page search.
-export _OPT_FG;                        # set foreground color in some modes.
-export _OPT_FN;                        # set font in some modes.
-export _OPT_GEOMETRY;          # set size and position of viewer in X.
-export _OPT_ICONIC;            # -iconic option for X viewers.
+export _OPT_ALL;               # display all suitable man pages
+export _OPT_APROPOS;           # call `apropos' program
+export _OPT_BD;                        # set border color in some modes
+export _OPT_BG;                        # set background color in some modes
+export _OPT_BW;                        # set border width in some modes
+export _OPT_DEFAULT_MODES;     # `,'-list of modes when no mode given
+export _OPT_DEVICE;            # device option
+export _OPT_DO_NOTHING;                # do nothing in main_display()
+export _OPT_DISPLAY;           # set X display
+export _OPT_EXTENSION;         # set extension for man page search
+export _OPT_FG;                        # set foreground color in some modes
+export _OPT_FN;                        # set font in some modes
+export _OPT_GEOMETRY;          # set size and position of viewer in X
+export _OPT_ICONIC;            # -iconic option for X viewers
 export _OPT_LANG;              # set language for man pages
 export _OPT_MODE;              # values: X, tty, Q, Z, ""
 export _OPT_MANPATH;           # manual setting of path for man-pages
 export _OPT_PAGER;             # specify paging program for tty mode
 export _OPT_RESOLUTION;                # set X resolution in dpi
-export _OPT_RV;                        # reverse fore- and background colors.
+export _OPT_RV;                        # reverse fore- and background colors
 export _OPT_SECTIONS;          # sections for man page search
+export _OPT_STDOUT;            # print mode file to standard output
 export _OPT_SYSTEMS;           # man pages of different OS's
 export _OPT_TITLE;             # title for gxditview window
-export _OPT_TEXT_DEVICE;       # set device for tty mode.
-export _OPT_V;                 # groff option -V.
+   export _OPT_TEXT_DEVICE;    # set device for tty mode
+export _OPT_V;                 # groff option -V
 export _OPT_VIEWER_DVI;                # viewer program for dvi mode
 export _OPT_VIEWER_HTML;       # viewer program for html mode
 export _OPT_VIEWER_PDF;                # viewer program for pdf mode
 export _OPT_VIEWER_PS;         # viewer program for ps mode
 export _OPT_VIEWER_X;          # viewer program for x mode
 export _OPT_WHATIS;            # print the man description
-export _OPT_XRM;               # specify X resource.
-export _OPT_Z;                 # groff option -Z.
+export _OPT_XRM;               # specify X resource
+export _OPT_Z;                 # groff option -Z
 export _OUTPUT_FILE_NAME;      # output generated, see main_set_res..()
 export _VIEWER_BACKGROUND;     # viewer shall be run in the background or not
 # _TMP_* temporary directory and files
@@ -775,6 +776,7 @@
   _OPT_RV='no';
   _OPT_SECTIONS='';
   _OPT_SYSTEMS='';
+  _OPT_STDOUT='no';
   _OPT_TITLE='';
   _OPT_TEXT_DEVICE='';
   _OPT_V='no';
@@ -4611,7 +4613,6 @@
 by some more letters that are called the `extension'.
 
 -h --help         print this usage message.
--Q --source       output as roff source.
 -T --device=name  pass to groff using output device "name".
 -v --version      print version information.
 -V                display the groff execution pipe instead of formatting.
@@ -4652,7 +4653,9 @@
 --ps              display in a Postscript viewer.
 --ps-viewer=prog  choose the viewer program for ps mode.
 --shell=program   specify a shell under which to run groffer2.sh.
+--source          output as roff source.
 --text            output in a text device without a pager.
+--to-stdout       output the content of the mode file without display.
 --tty             display with a pager on text terminal even when in X.
 --tty-viewer=prog select a pager for tty mode; same as --pager.
 --whatis          display the file name and description of man pages
@@ -5704,6 +5707,9 @@
       fi;
       shift;
       ;;
+     --to-stdout)              # print mode file without display
+      _OPT_STDOUT='yes';
+      ;;
     --tty)                     # tty mode, text with pager
       _OPT_MODE=tty;
       ;;
@@ -6115,9 +6121,10 @@
 {
   func_check _get_prog_args '=' 1 "$@";
 
-  eval _gpa_opt='"${_OPT_VIEWER_'"$1"'}"';
-  _gpa_xlist=_VIEWER_"$1"_X;
-  _gpa_ttylist=_VIEWER_"$1"_TTY;
+  x="$(echo1 $1 | tr [a-z] [A-Z])";
+  eval _gpa_opt='"${_OPT_VIEWER_'"$x"'}"';
+  _gpa_xlist=_VIEWER_"$x"_X;
+  _gpa_ttylist=_VIEWER_"$x"_TTY;
 
   if obj _gpa_opt is_empty
   then
@@ -7064,6 +7071,11 @@
       eval "$1";
     fi;
     obj _TMP_CAT rm_file_with_debug;
+    if obj _OPT_STDOUT is_yes
+    then
+      cat "${md_modefile}";
+      eval "${return_ok}";
+    fi;
     if obj _VIEWER_BACKGROUND is_not_yes # for programs that run on tty
     then
       eval "'${_DISPLAY_PROG}'" ${_DISPLAY_ARGS} "\"${md_modefile}\"";

Index: version.sh
===================================================================
RCS file: /cvsroot/groff/groff/contrib/groffer/version.sh,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- version.sh  1 Oct 2006 12:27:01 -0000       1.5
+++ version.sh  2 Oct 2006 23:32:00 -0000       1.6
@@ -32,8 +32,8 @@
 export _PROGRAM_VERSION;
 export _LAST_UPDATE;
 
-_PROGRAM_VERSION='0.9.28';
-_LAST_UPDATE='1 Oct 2006';
+_PROGRAM_VERSION='0.9.29';
+_LAST_UPDATE='3 Oct 2006';
 
 # this setting of the groff version is only used before make is run,
 # otherwise @VERSION@ will set it, see groffer.sh.