springgraph: clarify help text (Closes: 474351).

git-svn-id: svn://svn.debian.org/pgp-tools/trunk@380 b513b33f-fedd-0310-b452-c3deb5f4c849

diff --git a/debian/changelog b/debian/changelog
index 0b692c368642459a7c1af593953741e087c000c7..359da2a251ca83cc3e640ae2c4ae325f27dd37c4 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,8 +2,9 @@ signing-party (1.0-2) UNRELEASED; urgency=low
 
   * gpg-mailkeys: Fix parameter escaping of printf, thanks
     Olivier Tetard (Closes: #478151).
+  * springgraph: clarify help text (Closes: 474351).
 
- -- Thijs Kinkhorst <thijs@debian.org>  Wed, 30 Apr 2008 21:19:19 +0200
+ -- Thijs Kinkhorst <thijs@debian.org>  Wed, 30 Apr 2008 21:37:41 +0200
 
 signing-party (1.0-1) unstable; urgency=low
 

diff --git a/springgraph/springgraph b/springgraph/springgraph
index 4a179882ec36c2af45a3c95950325dd84140558a..b103c5cf8ca66e485f783ca48eeeb64c3fe330ab 100755 (executable)
--- a/springgraph/springgraph
+++ b/springgraph/springgraph
@@ -74,7 +74,6 @@
 # v0.80 Mar 19 2003 optimization patch from Marco Bodrato
 # v0.81 Aug 20 2003 Caption stderr progress notes
 
-use GD;
 use Getopt::Std;
 use strict;
 use vars qw(
@@ -180,6 +179,13 @@ $twopi = $pi * 2;
 
 getopts('s:pvhtb:l:');
 
+# -h: Show some help
+if ($opt_h) {
+  usage();
+  exit 1;
+}
+use GD;
+
 # -s: set scale
 if ($opt_s)
 {
@@ -204,11 +210,6 @@ if ($opt_v)
   $vrml = 0;
 }
 
-# -h: Show some help
-if ($opt_h) {
-  usage();
-  exit 1;
-}
 
 # -t: Make background transparent
 if ($opt_t)
@@ -880,9 +881,12 @@ sub cylinder {
 
 sub usage {
 print <<END
-springgraph - Render a .dot file into a graphic
+springgraph - Render a .dot file into a graphic, taking that dot file
+              on standard in and delivering a PNG on standard out.
 
-Usage: springgraph [-p] [-v] [-s scale] [-t] [-b color] [-l color] [-h]
+Usage:
+  springgraph [-p] [-v] [-s scale] [-t] [-b color] [-l color] [-h] \\
+  < example.dot > example.png
 
    -p   Create a file that can be rendered with POV-Ray
    -v   Create a VRML file

diff --git a/springgraph/springgraph.1 b/springgraph/springgraph.1
index e52db60a62cd24024acdc43989907b6e31595376..35618b78d39d593efb9f978b21fdfc1a6f19d5d3 100644 (file)
--- a/springgraph/springgraph.1
+++ b/springgraph/springgraph.1
@@ -18,15 +18,9 @@
 .SH NAME
 springgraph \- renders a graph from a .dot file
 .SH SYNOPSIS
-.B springgraph [OPTIONS] < input-file > output-file.png
+.B springgraph [OPTIONS] < input-file.dot > output-file.png
 .br
 .SH DESCRIPTION
-This manual page documents briefly the
-.B springgraph
-command.
-This manual page was written for the Debian distribution
-because the original program does not have a manual page.
-.PP
 Springgraph will read in a .dot file description of a graph, which,
 for each node, specifies its name and which other nodes it is
 connected to, and then renders a graph. The output is a PNG