groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 01/01: gperl: correct documentation of options


From: Bernd Warken
Subject: [groff] 01/01: gperl: correct documentation of options
Date: Sun, 15 Jun 2014 22:01:57 +0000

bwarken pushed a commit to branch master
in repository groff.

commit f377aa4ab11f582c6d34d377a00978a4c56a052a
Author: Bernd Warken <address@hidden>
Date:   Mon Jun 16 00:01:49 2014 +0200

    gperl: correct documentation of options
---
 contrib/gperl/ChangeLog |    6 ++++++
 contrib/gperl/gperl.man |   45 +++++++++++++++++++++++++++++++++++----------
 contrib/gperl/gperl.pl  |   11 ++++++-----
 3 files changed, 47 insertions(+), 15 deletions(-)

diff --git a/contrib/gperl/ChangeLog b/contrib/gperl/ChangeLog
index 09900b6..589d4b1 100644
--- a/contrib/gperl/ChangeLog
+++ b/contrib/gperl/ChangeLog
@@ -1,5 +1,11 @@
 2014-06-15  Bernd Warken  <address@hidden>
 
+       * gperl.pl: Version 1.2.1.
+
+       * gperl.man: Correct the Legalese and documentation of options.
+
+2014-06-15  Bernd Warken  <address@hidden>
+
        * gperl.pl: Version 1.2.  Getting several storage variables from
        printing in `Perl' with several lines.  Accept string and number
        register variable names for `.ds' and `.nr'.
diff --git a/contrib/gperl/gperl.man b/contrib/gperl/gperl.man
index 409b1d9..0271437 100644
--- a/contrib/gperl/gperl.man
+++ b/contrib/gperl/gperl.man
@@ -12,7 +12,7 @@ gperl \- groff preprocessor for Perl parts in roff files
 .de authors
 This file was written by Bernd Warken <address@hidden>.
 .
-Latest update: 14 Jun 2014
+Latest update: 16 Jun 2014
 ..
 .
 .de copyright
@@ -107,7 +107,7 @@ The license text is available in the internet at
 .\" --------------------------------------------------------------------
 .
 .SY gperl
-.OP \fIoption \[Ellipsis]
+.OP -
 .OP --
 .OP \fI\%filespec \[Ellipsis]
 .YS
@@ -136,9 +136,11 @@ files.
 .
 The result of a
 .I Perl part
-can be stored in a
-.I groff string
-within the final line of a
+can be stored in groff
+.I strings
+or
+.I numerical registers
+based on the arguments at a final line of a
 .IR "Perl part" .
 .
 .
@@ -147,13 +149,36 @@ within the final line of a
 .\" --------------------------------------------------------------------
 .
 So far, there are only
-.IR "breaking options" ,
-that means that the program writes the asked for information and
-stops a running program line.
+.I filespec
+or
+.I breaking
+options.
+.
+.
+.P
+.I filespec
+are file names or the minus character
+.B \[em]
+character for standard input.
+.
+As usual, the argument
+.B \[em]\[em]
+can be used in order to let all fowllowing arguments mean file names,
+even if the names begin with a minus character
+.BR \[em] .
+.
+.
+.P
+An option is
+.IR breaking ,
+when the program just writes the information that was asked for and
+then stops.
 .
-All other arguments are ignored.
+All other arguments will be ignored by that.
 .
-These options are
+These
+.I breaking
+options are heree
 .
 .TP
 .B -h\~\fR|\fB\~--help
diff --git a/contrib/gperl/gperl.pl b/contrib/gperl/gperl.pl
index 2412dd5..3729819 100755
--- a/contrib/gperl/gperl.pl
+++ b/contrib/gperl/gperl.pl
@@ -10,8 +10,8 @@
 
 # Written by Bernd Warken <address@hidden>.
 
-my $Latest_Update = '15 Jun 2014';
-my $version = '1.2';
+my $Latest_Update = '16 Jun 2014';
+my $version = '1.2.1';
 
 # This file is part of `gperl', which is part of `groff'.
 
@@ -92,14 +92,15 @@ if ($before_make) {
 
 
 ########################################################################
-# breaking options
+# options
 ########################################################################
 
 foreach (@ARGV) {
   if ( /^(-h|--h|--he|--hel|--help)$/ ) {
     print q(Usage for the `gperl' program:);
-    print 'gperl [-h|--help]     gives usage information';
-    print 'gperl [-v|--version]  displays the version number';
+    print 'gperl [-] [--] [filespec...] normal file name arguments';
+    print 'gperl [-h|--help]        gives usage information';
+    print 'gperl [-v|--version]     displays the version number';
     print q(This program is a `groff' preprocessor that handles Perl ) .
       q(parts in `roff' files.);
     exit;



reply via email to

[Prev in Thread] Current Thread [Next in Thread]