[qflow] 01/02: More info to man page

[Ruben Undheim]

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

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

commit 400e51d57e6ff6c2c16d66cc09c83bb03dac5db6
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Mon Sep 28 22:25:26 2015 +0400

    More info to man page
---
 debian/changelog     |  7 +++++++
 debian/man/qflow.1   | 47 ++++++++++++++++++++++++++++++++++++++++++++---
 debian/man/qflow.txt | 31 ++++++++++++++++++++++++++++++-
 3 files changed, 81 insertions(+), 4 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 7ff4e68..a17a444 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+qflow (1.1.9-2) UNRELEASED; urgency=low
+
+  * debian/man/qflow.txt:
+    - Added much more detailed info to man page.
+
+ -- Ruben Undheim <ruben.undheim at gmail.com>  Mon, 28 Sep 2015 22:24:35 +0400
+
 qflow (1.1.9-1) unstable; urgency=low
 
   * Initial release (Closes: #761368)
diff --git a/debian/man/qflow.1 b/debian/man/qflow.1
index d9895e3..ad0033e 100644
--- a/debian/man/qflow.1
+++ b/debian/man/qflow.1
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH QFLOW 1 "26 July 2015" "" ""
+.TH QFLOW 1 "28 September 2015" "" ""
 .SH NAME
 \fBqflow \fP- Open-Source Digital Synthesis Flow
 \fB
@@ -67,15 +67,56 @@ Run scripts synthesize to display
 .TP
 .B
 \fB-T\fP, \fB--tech\fP <name>
-Use technology <name>
+Use technology <name>  (Default: osu035)
 .TP
 .B
 \fB-p\fP, \fB--project\fP <name>
 Project root directory is <name>
-.RE
+.SH USAGE
+The simplest way to use \fBqflow\fP is to be in a directory with one Verilog file called input.v and execute:
 .PP
+.nf
+.fam C
+   qflow build input.v
 
+.fam T
+.fi
+This will run all the necessary steps in order to produce a layout of the specified Verilog file. If only certain steps are desired, one may first run:
+.PP
+.nf
+.fam C
+   qflow input.v
 
+.fam T
+.fi
+and then open qflow_exec.sh and uncomment the desired steps, and at last run:
+.PP
+.nf
+.fam C
+   ./qflow_exec.sh
+
+.fam T
+.fi
+It is also possible to change other "project-specific" details in the files qflow_vars.sh and project_vars.sh which also have been created in the current directory.
+.SH TECHNOLOGY
+\fBqflow\fP looks for technology files under /usr/share/\fBqflow\fP/tech. A certain set of files must be placed in a sub-folder there:
+.PP
+.nf
+.fam C
+  /usr/share/qflow/tech/[TECHNAME]/SCN4M_SUBM.20.tech
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].magicrc
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].prm
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.v
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.lef
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].sh
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].par
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.sp
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.lib
 
+.fam T
+.fi
+If no technology name is specified on the command line with the \fB-T\fP/\fB--tech\fP option, it will attempt to use the default technology which is "osu035".
+.PP
+If the technology files are located somewhere else, this can be specified in qflow_vars.sh which is created when running \fBqflow\fP. The variables "techdir" and "techname" must be changed accordingly.
 .SH AUTHOR
 This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
diff --git a/debian/man/qflow.txt b/debian/man/qflow.txt
index ef0d220..b136dd4 100644
--- a/debian/man/qflow.txt
+++ b/debian/man/qflow.txt
@@ -32,11 +32,40 @@ PROCESSES
  all                Run scripts synthesize to display
 
 OPTIONS
-  -T, --tech <name>           Use technology <name>
+  -T, --tech <name>           Use technology <name>  (Default: osu035)
   -p, --project <name>       Project root directory is <name>
 
+USAGE
+ The simplest way to use qflow is to be in a directory with one Verilog file called input.v and execute:
 
+   qflow build input.v
 
+ This will run all the necessary steps in order to produce a layout of the specified Verilog file. If only certain steps are desired, one may first run:
+
+   qflow input.v
+
+ and then open qflow_exec.sh and uncomment the desired steps, and at last run:
+
+   ./qflow_exec.sh
+
+ It is also possible to change other "project-specific" details in the files qflow_vars.sh and project_vars.sh which also have been created in the current directory.
+
+TECHNOLOGY
+ qflow looks for technology files under /usr/share/qflow/tech. A certain set of files must be placed in a sub-folder there:
+
+  /usr/share/qflow/tech/[TECHNAME]/SCN4M_SUBM.20.tech
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].magicrc
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].prm
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.v
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.lef
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].sh
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME].par
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.sp
+  /usr/share/qflow/tech/[TECHNAME]/[TECHNAME]_stdcells.lib
+
+ If no technology name is specified on the command line with the -T/--tech option, it will attempt to use the default technology which is "osu035".
+
+ If the technology files are located somewhere else, this can be specified in qflow_vars.sh which is created when running qflow. The variables "techdir" and "techname" must be changed accordingly.
 
 AUTHOR
   This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).

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