[groff] 01/01: gideal: rename example and doc directories; rewrite man-pages for improved correctness.

[Bernd Warken]

bwarken pushed a commit to branch master
in repository groff.

commit 95d9b400c65872c3b8bd4dafa3961b607d1ff259
Author: Bernd Warken <address@hidden>
Date:   Tue Oct 7 17:58:26 2014 +0200

    gideal: rename example and doc directories; rewrite man-pages for improved 
correctness.
---
 contrib/gideal/ChangeLog                      |   14 ++
 contrib/gideal/Makefile.sub                   |   49 +++++---
 contrib/gideal/{libfiles => doc}/103.pdf.gz   |  Bin 74766 -> 74766 bytes
 contrib/gideal/{libfiles => doc}/README.txt   |    0
 contrib/gideal/{files => examples}/README.txt |    0
 contrib/gideal/{files => examples}/test.groff |    0
 contrib/gideal/gideal.man                     |  165 +++----------------------
 contrib/gideal/gideal.pl                      |    2 +-
 contrib/gideal/ideal.man                      |   93 +++++----------
 9 files changed, 92 insertions(+), 231 deletions(-)

diff --git a/contrib/gideal/ChangeLog b/contrib/gideal/ChangeLog
index 1d539db..256b7f0 100644
--- a/contrib/gideal/ChangeLog
+++ b/contrib/gideal/ChangeLog
@@ -1,3 +1,17 @@
+2014-10-07  Bernd Warken  <address@hidden>
+
+       * gideal.pl: New version 0.9.8
+
+       * gideal.man, ideal.man: Rewrite for reasonability.
+
+       * doc/: Rename subdirectory `libfiles' into `doc', having the
+       files `103.pdf.gz' and `README.txt'.  Installation position is
+       `$(docdir)/ideal'.
+
+       * examples/: Rename subdirectory `files' into `examples', having
+       the files `test.groff' and `README.txt'.  Installation position is
+       `$(exampledir)/ideal'.
+
 2014-09-16  Bernd Warken  <address@hidden>
 
        * gideal.pl: New version 0.9.7
diff --git a/contrib/gideal/Makefile.sub b/contrib/gideal/Makefile.sub
index 5d1607e..2822fec 100644
--- a/contrib/gideal/Makefile.sub
+++ b/contrib/gideal/Makefile.sub
@@ -23,24 +23,32 @@
 
 ########################################################################
 
+# Positions:
+# $(DESTDIR) is the `prefix', e.g. `/usr/' or `/usr/local/'
+# $(bindir) is `<prefix>/bin/'
+# $(exampledir) is `<prefix>/share/doc/groff-1.22.2/examples/ideal'
+# $(datasubdir) is `<prefix>/'
+
 MAN1=gideal.n
 MAN7=ideal.n
 
-# FILES=opaque_MIT.ideal.ms 
-
-FILES=README.txt \
-       test.groff
 
+# former `libfiles'
+# now doc/
 # LIBFILES=arc.ideal \
 #      arrow.ideal \
 #      dash.ideal \
 #      rect.ideal \
 #      wavy.ideal \
 #      README.txt
-
-LIBFILES=README.txt \
+DOC=README.txt \
        103.pdf.gz
 
+# FILES=opaque_MIT.ideal.ms 
+# former `files/'
+EXAMPLES=README.txt \
+       test.groff
+
 MOSTLYCLEANADD=gideal $(MAN1) $(MAN7)
 
 # not all make programs have $(RM) predefined.
@@ -67,19 +75,19 @@ install_data: gideal
           || $(mkinstalldirs) $(DESTDIR)$(exampledir)
        -test -d $(DESTDIR)$(exampledir)/ideal \
           || $(mkinstalldirs) $(DESTDIR)$(exampledir)/ideal
-       for f in $(FILES); do \
+       for f in $(EXAMPLES); do \
          $(RM) $(DESTDIR)$(exampledir)/ideal/$$f; \
-         $(INSTALL_DATA) $(srcdir)/files/$$f \
+         $(INSTALL_DATA) $(srcdir)/examples/$$f \
            $(DESTDIR)$(exampledir)/ideal/$$f; \
        done
-       -test -d $(DESTDIR)$(datasubdir) \
-          || $(mkinstalldirs) $(DESTDIR)$(datasubdir)
-       -test -d $(DESTDIR)$(datasubdir)/ideal \
-          || $(mkinstalldirs) $(DESTDIR)$(datasubdir)/ideal
-       for f in $(LIBFILES); do \
-         $(RM) $(DESTDIR)$(datasubdir)/ideal/$$f; \
-         $(INSTALL_DATA) $(srcdir)/libfiles/$$f \
-           $(DESTDIR)$(datasubdir)/ideal/$$f; \
+       -test -d $(DESTDIR)$(docdir) \
+          || $(mkinstalldirs) $(DESTDIR)$(docdir)
+       -test -d $(DESTDIR)$(docdir)/ideal \
+          || $(mkinstalldirs) $(DESTDIR)$(docdir)/ideal
+       for f in $(DOC); do \
+         $(RM) $(DESTDIR)$(docdir)/ideal/$$f; \
+         $(INSTALL_DATA) $(srcdir)/doc/$$f \
+           $(DESTDIR)$(docdir)/ideal/$$f; \
        done
 
 .PHONY: uninstall_sub
@@ -87,11 +95,12 @@ uninstall_sub: $
        $(RM) $(DESTDIR)$(bindir)/gideal
        -test -d $(DESTDIR)$(bindir) $$ \
          rmdir $(DESTDIR)$(bindir)
-       for f in $(LIBFILES); do \
-         $(RM) $(DESTDIR)$(datasubdir)/ideal/$$f; \
+
+       for f in $(DOC); do \
+         $(RM) $(DESTDIR)$(docdir)/ideal/$$f; \
        done
-       -test -d $(DESTDIR)$(datasubdir)/ideal && \
-         rmdir $(DESTDIR)$(datasubdir)/ideal
+       -test -d $(DESTDIR)$(docdir)/ideal && \
+         rmdir $(DESTDIR)$(docdir)/ideal
        for f in $(FILES); do \
          $(RM) $(DESTDIR)$(exampledir)/ideal/$$f; \
        done
diff --git a/contrib/gideal/libfiles/103.pdf.gz b/contrib/gideal/doc/103.pdf.gz
similarity index 100%
rename from contrib/gideal/libfiles/103.pdf.gz
rename to contrib/gideal/doc/103.pdf.gz
diff --git a/contrib/gideal/libfiles/README.txt b/contrib/gideal/doc/README.txt
similarity index 100%
rename from contrib/gideal/libfiles/README.txt
rename to contrib/gideal/doc/README.txt
diff --git a/contrib/gideal/files/README.txt 
b/contrib/gideal/examples/README.txt
similarity index 100%
rename from contrib/gideal/files/README.txt
rename to contrib/gideal/examples/README.txt
diff --git a/contrib/gideal/files/test.groff 
b/contrib/gideal/examples/test.groff
similarity index 100%
rename from contrib/gideal/files/test.groff
rename to contrib/gideal/examples/test.groff
diff --git a/contrib/gideal/gideal.man b/contrib/gideal/gideal.man
index c5a0b0d..a8f897c 100644
--- a/contrib/gideal/gideal.man
+++ b/contrib/gideal/gideal.man
@@ -70,17 +70,13 @@ Bernd Warken
 .SH DESCRIPTION
 .\" --------------------------------------------------------------------
 .
-.BR ideal (@MAN7EXT@)
-is a
-.I roff language
-for drawing pictures.
-.
-.
 .P
 .B gideal
 is a
 .I groff preprocessor
-for using this language within
+for using the roff language
+.BR ideal (@MAN7EXT@)
+for drawing pictures within
 .I groff files
 (to be done).
 .
@@ -112,7 +108,7 @@ The breaking options
 .B \-v
 or
 .B \-\-version
-prints information on the version number.
+print information on the version number.
 .
 .
 .P
@@ -120,17 +116,13 @@ The breaking options
 .B \-h
 or
 .B \-\-help
-prints usage information.
+print usage information.
 .
 .
 .P
-Both of these options automatically end the
-.B grog
-program.
+Both of these options automatically end the program.
 .
-Other options are then ignored, and no
-.B groff
-command line is generated.
+Other options are then ignored.
 .
 .
 .\" --------------------------------------------------------------------
@@ -153,42 +145,13 @@ means to integrate
 The double minus
 .B \-\-
 argument means noting special by itself, but means that all following
-arguments will be interpreted as file names, even if the called file
-name starts with a minus
+arguments will be interpreted as file names, even if it starts with a
+minus
 .B \-
 character.
 .
 .
 .\" --------------------------------------------------------------------
-.SH "IDEAL PARTS"
-.\" --------------------------------------------------------------------
-.
-Within a roff file, an
-.I ideal part
-is started with the command
-.BR .IS .
-.
-.
-.P
-this part is ended with the command
-.B .IE
-or
-.BR .IF .
-.
-.
-.P
-The text between these requests is handled by the preprocessor
-.BR gideal .
-.
-By that the
-.I ideal part
-is transformed into
-.IR "pic content" ,
-belonging to another graphical preprocessor
-.BR pic (1).
-.
-.
-.\" --------------------------------------------------------------------
 .SH HISTORY
 .\" --------------------------------------------------------------------
 .
@@ -200,90 +163,24 @@ in 1981 at AT&T.
 .
 .
 .P
-A roff preprocessor for this language with the same name was also
-invented by the same programmer, but this preprocessor is very
-old-fashioned.
+Moreover, a roff preprocessor for this language with the name
+.B ideal
+was invented by the same programmer as well, but this preprocessor
+looks now quite old-fashioned.
+
 .
-That's why there is a completely new within groff is in the development.
+There is now a complitely new preprocessor for the groff system in
+development.
 .
-It is called
+It will be called
 .BR gideal (@MAN1EXT@),
-other thatn the original preprocessor.
+other than the original preprocessor.
 .
 .
 .\" --------------------------------------------------------------------
 .SH "SEE ALSO"
 .\" --------------------------------------------------------------------
 .
-.\" --------------------------------------------------------------------
-.SS "libfiles"
-.\" --------------------------------------------------------------------
-.
-.I libfiles
-are files written in
-.IR ideal .
-.
-Such a file can be included into a roff file with
-.I ideal parts
-by the ideal command
-.BR ...libfile .
-.
-A
-.I libfile
-can also serve as an example.
-.
-.
-.P
-With the installation, the available
-.I libfiles
-get into
-.B @DATASUBDIR@/ideal/libfiles
-.
-.
-.\" --------------------------------------------------------------------
-.SS "Examples"
-.\" --------------------------------------------------------------------
-.
-Some
-.I roff
-files with included 
-.I ideal parts
-will be stored at the installation into
-.BR @EXAMPLEDIR@/ideal .
-.
-.
-.\" --------------------------------------------------------------------
-.SS "Man-Pages"
-.\" --------------------------------------------------------------------
-.
-.TP
-.BR ideal (@MAN7EXT@)
-for information about the
-.I ideal language
-in
-.IR groff .
-.
-.
-.TP
-.BR groff (@MAN1EXT@),
-.TQ
-.BR groff (@MAN7EXT@),
-.TQ
-.BR grog (@MAN1EXT@),
-.TQ
-.BR pic (@MAN1EXT@),
-.TQ
-.BR gpic (@MAN1EXT@),
-.TQ
-Information about the
-.I groff
-system.
-.
-.
-.\" --------------------------------------------------------------------
-.SS "Documentation and Articles"
-.\" --------------------------------------------------------------------
-.
 .TP
 .B Unix8 preprocessor
 freely available documentation for the
@@ -302,32 +199,6 @@ as in
 .UE .
 .
 .
-.TP
-.B ACM articles for buying
-.
-.RS
-.
-.TP
-.B p99-van_wyk.pdf.gz
-.nf
-A Graphics Typesetting Language
-Christopher J. Van Wyk
-.fi
-.UR http://dl.acm.org/citation.cfm?id=806460
-.UE
-.
-.TP
-.B p163-van_wyk.pdf.gz
-.nf
-A High-Level Language for Specifying Pictures
-Christopher J. Van Wyk
-.fi
-.UR http://dl.acm.org/citation.cfm?id=357303
-.UE
-.
-.RE
-.
-.
 .\" --------------------------------------------------------------------
 .SH "COPYING"
 .\" --------------------------------------------------------------------
diff --git a/contrib/gideal/gideal.pl b/contrib/gideal/gideal.pl
index 39e7493..ada7a66 100755
--- a/contrib/gideal/gideal.pl
+++ b/contrib/gideal/gideal.pl
@@ -9,7 +9,7 @@
 
 # Written by Bernd Warken <address@hidden>.
 
-my $version = '0.9.7';
+my $version = '0.9.8';
 
 # This file is part of `gideal', which is part of `groff'.
 
diff --git a/contrib/gideal/ideal.man b/contrib/gideal/ideal.man
index 65c7ff1..59252b3 100644
--- a/contrib/gideal/ideal.man
+++ b/contrib/gideal/ideal.man
@@ -40,17 +40,15 @@ Bernd Warken
 .SH DESCRIPTION
 .\" --------------------------------------------------------------------
 .
-.BR ideal (@MAN7EXT@)
+.I ideal
 is a
 .I roff
 language for drawing pictures.
 .
 .BR gideal (@MAN1EXT@)
-is the corresponding
+will be the corresponding
 .I groff
-preprocessor for using this language within
-.I groff files
-(to be done).
+preprocessor for using this language within groff files.
 .
 .
 .\" --------------------------------------------------------------------
@@ -60,19 +58,24 @@ preprocessor for using this language within
 Within a roff file, an
 .I ideal part
 is started with the command
-.BR .IS .
-.
-.
-.P
-this part is ended with the command
+.B .IS
+and is ended with one of the commands
 .B .IE
 or
 .BR .IF .
 .
 .
 .P
-The text between these requests is handled by the preprocessor
-.BR gideal (@MAN1EXT@).
+The text between these opening and closing requests is handled by the
+preprocessor
+.BR gideal .
+.
+By that the
+.I ideal part
+is transformed into
+.IR "pic content" ,
+which can be read with the graphical groff preprocessor
+.BR pic (@MAN1EXT@).
 .
 .
 .\" --------------------------------------------------------------------
@@ -111,35 +114,24 @@ bit about related Perl examles.
 .\" --------------------------------------------------------------------
 .
 .I libfiles
-are file written in
-.IR ideal .
-.
-Such a file can be included into a roff file with
-.I ideal parts
-by the ideal command
+were files written in
+.IR ideal ,
+that could be included into roff files with the command
 .BR ...libfile .
 .
-A
-.I libfile
-can also serve as an example.
-.
-.
-.P
-With the installation, the available
-.I libfiles
-will get into
-.B @DATASUBDIR@/ideal/libfiles
+They are now obsolete because of license problems.
 .
 .
 .\" --------------------------------------------------------------------
 .SS "Examples"
 .\" --------------------------------------------------------------------
 .
-Some
-.I roff
-files with included 
+It is planned to add some roff files with included
 .I ideal parts
-will be stored at the installation into
+as examples into the source subdirectory
+.BR files.
+.
+They will then be installed into
 .BR @EXAMPLEDIR@/ideal .
 .
 .
@@ -156,19 +148,12 @@ preprocessor in
 .
 .
 .TP
-.BR groff (@MAN1EXT@),
-.TQ
-.BR groff (@MAN7EXT@),
-.TQ
-.BR grog (@MAN1EXT@),
-.TQ
-.BR pic (@MAN1EXT@),
-.TQ
-.BR gpic (@MAN1EXT@),
-.TQ
-Information about the
-.I groff
-system.
+.BR pic (@MAN1EXT@)
+The
+.I ideal
+parts will be translated into
+.I pic
+roff language.
 .
 .
 .\" --------------------------------------------------------------------
@@ -176,24 +161,6 @@ system.
 .\" --------------------------------------------------------------------
 .
 .TP
-.B Unix8 preprocessor
-freely available documentation for the
-.IR "ideal preprocessor" .
-.
-The
-.I preprocessor
-there is called
-.BR ideal ,
-not
-.B gideal
-as in
-.IR groff .
-.br
-.UR http://man.cat-v.org/unix_8th/1/ideal
-.UE .
-.
-.
-.TP
 .B ACM articles for buying
 .
 .RS