[graywolf] 03/09: More man page content

[Ruben Undheim]

This is an automated email from the git hooks/post-receive script.

rubund-guest pushed a commit to branch master
in repository graywolf.

commit 6bc32b01e153c88e9915e2e1fed3faaef79f69db
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Wed Sep 30 19:26:37 2015 +0400

    More man page content
---
 debian/man/graywolf.1   | 33 +++++++++++++++++++++++----------
 debian/man/graywolf.txt | 16 +++++++++++++---
 2 files changed, 36 insertions(+), 13 deletions(-)

diff --git a/debian/man/graywolf.1 b/debian/man/graywolf.1
index daf6020..d5f2103 100644
--- a/debian/man/graywolf.1
+++ b/debian/man/graywolf.1
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH GRAYWOLF 1 "30 September 2015" "" ""
+.TH GRAYWOLF 1 "01 October 2015" "" ""
 .SH NAME
 \fBgraywolf \fP- placement tool for digital VLSI design
 \fB
@@ -22,14 +22,6 @@ of the open source qflow digital design flow.
 .SH OPTIONS
 .TP
 .B
-\fB-g\fP
-general mode
-.TP
-.B
-\fB-p\fP
-pick mode
-.TP
-.B
 \fB-n\fP
 no graphics
 .TP
@@ -38,10 +30,31 @@ no graphics
 prints debug info and performs extensive error checking
 .TP
 .B
+\fB-g\fP
+general mode
+.TP
+.B
+\fB-p\fP
+pick mode
+.TP
+.B
 \fB-w\fP
 parasite mode will inherit a window
+.SH USAGE
+Typically, you would be in a directory with a [DESIGN].cel file and a [DESIGN].par file and then run:
+.PP
+.nf
+.fam C
+   graywolf [DESIGN]
+
+.fam T
+.fi
+where [DESIGN] is the file name of the design. More information about the input and output files is found below.
+.PP
+However, it is recommended to use the qflow digital design flow instead of running \fBgraywolf\fP directly. qflow prepares
+the input files from standardized files, and converts the output to standardized files.
 .SH INPUT
-Two input files are necessary to run graywolf. A .cel file containing the design, and a .par file containing the parameters which define the technology. The .cel file may be created from a .blif file with the script "blif2cel.tcl" in the qflow package.
+Two input files are necessary to run graywolf. A .cel file containing the design, and a .par file containing the parameters which define the technology. The .cel file may be created from a .blif design file and a .lef library file with the script "blif2cel.tcl" in the qflow package.
 .PP
 A .cel2 file may also be given to provide information about pin placements.
 .SH OUTPUT
diff --git a/debian/man/graywolf.txt b/debian/man/graywolf.txt
index 45cfcd7..8759e9e 100644
--- a/debian/man/graywolf.txt
+++ b/debian/man/graywolf.txt
@@ -11,14 +11,24 @@ DESCRIPTION
 
 
 OPTIONS
-  -g            general mode
-  -p            pick mode
   -n            no graphics
   -d            prints debug info and performs extensive error checking
+  -g            general mode
+  -p            pick mode
   -w            parasite mode will inherit a window
 
+USAGE
+ Typically, you would be in a directory with a [DESIGN].cel file and a [DESIGN].par file and then run:
+
+   graywolf [DESIGN]
+
+ where [DESIGN] is the file name of the design. More information about the input and output files is found below.
+
+ However, it is recommended to use the qflow digital design flow instead of running graywolf directly. qflow prepares
+ the input files from standardized files, and converts the output to standardized files.
+
 INPUT
- Two input files are necessary to run graywolf. A .cel file containing the design, and a .par file containing the parameters which define the technology. The .cel file may be created from a .blif file with the script "blif2cel.tcl" in the qflow package.
+ Two input files are necessary to run graywolf. A .cel file containing the design, and a .par file containing the parameters which define the technology. The .cel file may be created from a .blif design file and a .lef library file with the script "blif2cel.tcl" in the qflow package.
 
  A .cel2 file may also be given to provide information about pin placements.
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/graywolf.git