document options

diff --git a/scripts/gnucap2gnuplot b/scripts/gnucap2gnuplot
index 904649e20f6d5c4fa021d368151e83fe31d7ade7..9d909ca670013ff7512cdb21f516f542c25bf39e 100755 (executable)
--- a/scripts/gnucap2gnuplot
+++ b/scripts/gnucap2gnuplot
@@ -18,8 +18,10 @@
 
 # usage:
 #    gnucap2gnuplot [<options>] input-file
+#
 # Input file should be a .cir file (will be put through gnucap)
 #  or an output file from gnucap.
+#
 # Produces various output files:
 #  <input-file>.gnuplots.sh                     run this to display results
 #  <input-file>,<Kind><N>.gnuplot-cmd           gnuplot script for displaying:
@@ -30,6 +32,12 @@
 #  <N>    is the count, starting at 0, of which report this is from gnucap
 #  <M>    is the individual column of Y data
 #
+# Options
+#   -g          do run gnucap     ) default is run gnucap
+#   -G          don't run gnucap  )  if input file ends in .cir
+#   -o<prefix>  use <prefix> instead of <input-file> in output filenames
+# If the input file is `-' then you may not specify -g and must use -o.
+#
 # Limitations
 #
 #  Only Freq (.AC) and Time (.TRAN) plots have been tested.  If
@@ -187,3 +195,5 @@ close A or die $!;
 $?=0; close STDIN; $? and fail("gnucap failed (code $?)");
 $sof= "./$sof" unless $sof =~ m,/,;
 print ": generated ; $sof\n" or die $!;
+
+# $Id: gnucap2gnuplot,v 1.2 2004-03-23 23:03:06 ianmdlvl Exp $