[qflow] 02/03: Better 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 10aa938acd3bfa2493c7d027ecf67733a68f76b1
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Sun Jul 26 12:45:04 2015 +0200

    Better man page
---
 debian/man/genmanpages.sh |  4 +++
 debian/man/qflow.1        | 81 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/man/qflow.txt      | 42 ++++++++++++++++++++++++
 debian/qflow.1            | 45 --------------------------
 debian/qflow.manpages     |  2 +-
 5 files changed, 128 insertions(+), 46 deletions(-)

diff --git a/debian/man/genmanpages.sh b/debian/man/genmanpages.sh
new file mode 100755
index 0000000..2343ba0
--- /dev/null
+++ b/debian/man/genmanpages.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+
+txt2man -t QFLOW                  -s 1 qflow.txt                > qflow.1
diff --git a/debian/man/qflow.1 b/debian/man/qflow.1
new file mode 100644
index 0000000..3714eb8
--- /dev/null
+++ b/debian/man/qflow.1
@@ -0,0 +1,81 @@
+.\" Text automatically generated by txt2man
+.TH QFLOW 1 "26 July 2015" "" ""
+.SH NAME
+\fBqflow \fP- Open-Source Digital Synthesis Flow
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBqflow\fP [\fIprocesses\fP] [\fIoptions\fP] <module_name>
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+This is the main executable for a complete tool chain
+for synthesizing digital circuits starting
+from verilog source and ending in physical layout for a specific target
+fabrication process. In the world of commercial electronics, digital
+synthesis with a target application of a chip design is usually bundled
+into large EDA software systems. As commercial electronics designers need
+to maintain cutting-edge performance, these commercial toolchains get more
+and more expensive, and have largely priced themselves out of all but the
+established integrated circuit manufacturers. This leaves an unfortunate
+gap where startup companies and small businesses cannot afford to do any
+sort of integrated circuit design.
+.PP
+Qflow tries to fill this gap.
+.SH PROCESSES
+.TP
+.B
+synthesize
+Synthesize verilog source
+.TP
+.B
+place
+Run initial placement
+.TP
+.B
+sta
+Static timing analysis
+.TP
+.B
+route
+Run placement and route
+.TP
+.B
+decongest
+Run congestion analysis, final place and route
+.TP
+.B
+clean
+Remove temporary working files
+.TP
+.B
+display
+Display routed result
+.TP
+.B
+build
+Run script synthesize to route
+.TP
+.B
+all
+Run scripts synthesize to display
+.SH OPTIONS
+.TP
+.B
+\fB-T\fP, \fB--tech\fP <name>
+Use technology <name>
+.TP
+.B
+\fB-p\fP, \fB--project\fP <name>
+Project root directory is <name>
+.RE
+.PP
+
+
+
+.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
new file mode 100644
index 0000000..f8606c3
--- /dev/null
+++ b/debian/man/qflow.txt
@@ -0,0 +1,42 @@
+NAME
+  qflow - Open-Source Digital Synthesis Flow
+
+SYNOPSIS
+  qflow [processes] [options] <module_name>
+
+DESCRIPTION
+ This is the main executable for a complete tool chain
+ for synthesizing digital circuits starting
+ from verilog source and ending in physical layout for a specific target
+ fabrication process. In the world of commercial electronics, digital
+ synthesis with a target application of a chip design is usually bundled
+ into large EDA software systems. As commercial electronics designers need
+ to maintain cutting-edge performance, these commercial toolchains get more
+ and more expensive, and have largely priced themselves out of all but the
+ established integrated circuit manufacturers. This leaves an unfortunate
+ gap where startup companies and small businesses cannot afford to do any
+ sort of integrated circuit design.
+  
+ Qflow tries to fill this gap.
+  
+PROCESSES
+ synthesize         Synthesize verilog source
+ place              Run initial placement
+ sta                Static timing analysis
+ route              Run placement and route
+ decongest          Run congestion analysis, final place and route
+ clean              Remove temporary working files
+ display            Display routed result
+ 
+ build              Run script synthesize to route
+ all                Run scripts synthesize to display
+
+OPTIONS
+  -T, --tech <name>           Use technology <name>
+  -p, --project <name>       Project root directory is <name>
+
+
+
+
+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/qflow.1 b/debian/qflow.1
deleted file mode 100644
index 57a4350..0000000
--- a/debian/qflow.1
+++ /dev/null
@@ -1,45 +0,0 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2014 Ruben Undheim <ruben.undheim at gmail.com>,
-.\"
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH QFLOW 1 "April 28, 2014"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh        disable hyphenation
-.\" .hy        enable hyphenation
-.\" .ad l      left justify
-.\" .ad b      justify to both left and right margins
-.\" .nf        disable filling
-.\" .fi        enable filling
-.\" .br        insert line break
-.\" .sp <n>    insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
-.SH NAME
-qflow \- a digital synthesis flow using open source EDA tools 
-.SH SYNOPSIS
-.B qflow
-.RI [ options ] " files" ...
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.B qflow
-command.
-.PP
-.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
-.\" respectively.
-\fBqflow\fP is a program that...
-.SH OPTIONS
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-A summary of options is included below.
-For a complete description, see the Info files.
-.TP
-.B \-h, \-\-help
-Show summary of options.
-.TP
-.B \-v, \-\-version
-Show version of program.
diff --git a/debian/qflow.manpages b/debian/qflow.manpages
index d3519d0..eba59ba 100644
--- a/debian/qflow.manpages
+++ b/debian/qflow.manpages
@@ -1 +1 @@
-debian/qflow.1
+debian/man/qflow.1

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