glossaries update (24sep09)

git-svn-id: svn://tug.org/texlive/trunk@15452 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 118 insertions, 9 deletions

diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries b/Master/texmf-dist/scripts/glossaries/makeglossaries
index 609409dca74..827ec71a1db 100755
--- a/Master/texmf-dist/scripts/glossaries/makeglossaries
+++ b/Master/texmf-dist/scripts/glossaries/makeglossaries
@@ -2,7 +2,7 @@
 
 # File    : makeglossaries
 # Author  : Nicola Talbot
-# Version : 1.6 (2009/05/24)
+# Version : 1.7 (2009/09/23)
 # Description: simple Perl script that calls makeindex or xindy.
 # Intended for use with "glossaries.sty" (saves having to remember
 # all the various switches)
@@ -11,7 +11,7 @@
 # Copyright 2007 Nicola L.C. Talbot
 # This work may be distributed and/or modified under the
 # conditions of the LaTeX Project Public License, either version 1.3
-# of this license of (at your option) any later version.
+# of this license or any later version.
 # The latest version of this license is in
 #   http://www.latex-project.org/lppl.txt
 # and version 1.3 or later is part of all distributions of LaTeX
@@ -26,8 +26,13 @@
 # glossary-hypernav.sty, glossary-list.sty, glossary-long.sty,
 # glossary-super.sty, glossaries.perl.
 # Also makeglossaries and makeglossaries.
-#
+
+my $version="1.7 (2009-09-23)";
+
 # History:
+# v1.7 (2009-09-23) :
+#   * Issue warning rather than error when empty/non existant file 
+#     checks fail
 # v1.6 (2009-05-24) :
 #   * main glossary no longer automatically added
 #     (only added if information in aux file)
@@ -59,8 +64,6 @@ use vars qw($opt_q $opt_t $opt_o $opt_s $opt_p $opt_g $opt_c $opt_r
 
 $Getopt::Std::STANDARD_HELP_VERSION = 1;
 
-my $version="1.5 (2008-12-26)";
-
 # v1.5 added -L <lang> for xindy (but language can be specified in 
 # .tex file)
 # v1.5 added -n (print the command that would be issued but
@@ -170,7 +173,7 @@ if (open AUXFILE, "$name.aux")
             else
             {
                print STDERR
-                 "WARNING: Unknown ordering '$letterordering'\n",
+                 "Unknown ordering '$letterordering'\n",
                  "Assuming word ordering\n";
                $letterordering = 0;
             }
@@ -331,17 +334,19 @@ else
 
       my $inputfile = "$name.$thistype{in}";
 
+      # v1.7 print warnings to STDOUT instead of STDERR
+
       # v1.6 added file existance test
       unless (-e $inputfile)
       {
-         print STDERR "File '$inputfile' doesn't exist.\n",
+         print "Warning: File '$inputfile' doesn't exist.\n",
              "*** Skipping glossary '$type'. ***\n";
          next;
       }
 
       unless (-r $inputfile)
       {
-         print STDERR "No read access for '$inputfile' $!\n",
+         print "Warning: No read access for '$inputfile' $!\n",
              "*** Skipping glossary '$type'. ***\n";
          next;
       }
@@ -349,7 +354,7 @@ else
       # v1.6 added file empty test
       if (-z $inputfile)
       {
-         print STDERR "File '$inputfile' is empty.\n",
+         print "Warning: File '$inputfile' is empty.\n",
              "Have you used any entries defined in glossary '$type'?\n",
              "*** Skipping glossary '$type'. ***\n";
          next;
@@ -729,3 +734,107 @@ sub VERSION_MESSAGE{
 }
 
 1;
+
+=head1 NAME
+
+makeglossaries  - Calls makeindex/xindy for LaTeX documents using glossaries package
+
+=head1 SYNOPSIS
+
+B<makeglossaries> [B<-o> I<file>] [B<-q>] [B<-s> I<file>]
+[B<-t> I<file>] [B<-L> I<language>] [B<-c>] [B<-g>] [B<-l>]
+[B<-p> I<num>] [B<-r>] [B<--version>] [B<--help>] I<filename>
+
+=head1 DESCRIPTION
+
+B<makeglossaries> is designed for use with LaTeX documents that
+use the glossaries package. The mandatory argument I<filename> should
+be the name of the LaTeX document without the .tex extension. 
+B<makeglossaries> will read the auxiliary file to determine whether
+B<makeindex> or B<xindy> should be called. All the information
+required to be passed to the relevant indexing application should
+also be contained in the auxiliary file, but may be overridden by
+the option arguments to B<makeglossaries>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-q>
+
+Quiet mode. Reduces chatter to standard output.
+
+=item B<-o> I<file>
+
+Use I<file> as the output file. (Only suitable for documents 
+containing a single glossary, otherwise each glossary will be
+overridden.)
+
+=item B<-s> I<file>
+
+Use I<file> as the style file. Note that if you use this option,
+you need to know whether B<makeindex> or B<xindy> will be called, as
+they have different style files.
+
+=item B<-t> I<file>
+
+Use I<file> as the transcript file.
+
+=item B<-L> I<language>
+
+This option only has an effect if B<xindy> is called. Sets the
+language. See B<xindy> documentation for further details.
+
+=item B<-c>
+
+Compress intermediate blanks (B<makeindex> only).
+
+=item B<-g>
+
+Employ German word ordering (B<makeindex> only).
+
+=item B<-l>
+
+Letter ordering (B<makeindex> only).
+
+=item B<-p> I<num>
+
+Sets the starting page number to be I<num> (B<makeindex> only).
+
+=item B<-r>
+
+Disable implicit page range formation (B<makeindex> only).
+
+=item B<--version>
+
+Prints version number and exits.
+
+=item B<--help>
+
+Prints help message and exits.
+
+=back
+
+=head1 REQUIRES
+
+Perl, Getopt::Std, and makeindex or xindy (depending on glossaries
+package options).
+
+=head1 LICENSE
+
+This is free software distributed under the LaTeX Project Public 
+License. There is NO WARRANTY.
+See L<http://www.latex-project.org/lppl.txt> for details.
+
+=head1 AUTHOR
+
+Nicola L. C. Talbot,
+L<http://theoval.cmp.uea.ac.uk/~nlct/>
+
+=head1 RECOMMENDED READING
+
+The glossaries manual:
+
+	texdoc glossaries
+
+=cut