[graywolf] 01/01: Generate man page with txt2man

[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 7f14f14ecb0ccf6fe3b1babf200f3f9dd4e7b7b4
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Wed Jul 22 17:38:25 2015 +0200

    Generate man page with txt2man
---
 debian/graywolf.1         | 47 ---------------------------------------------
 debian/graywolf.manpages  |  2 +-
 debian/man/genmanpages.sh |  4 ++++
 debian/man/graywolf.1     | 49 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/man/graywolf.txt   | 24 +++++++++++++++++++++++
 5 files changed, 78 insertions(+), 48 deletions(-)

diff --git a/debian/graywolf.1 b/debian/graywolf.1
deleted file mode 100644
index fe63f90..0000000
--- a/debian/graywolf.1
+++ /dev/null
@@ -1,47 +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 GRAYWOLF 1 "October 14, 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
-graywolf \- digital placement tool 
-.SH SYNOPSIS
-.B graywolf
-.RI [ options ] " files" ...
-.br
-.B bar
-.RI [ options ] " files" ...
-.SH DESCRIPTION
-This manual page documents briefly the
-.B graywolf
-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.
-\fBgraywolf\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/graywolf.manpages b/debian/graywolf.manpages
index 50cad74..8541ade 100644
--- a/debian/graywolf.manpages
+++ b/debian/graywolf.manpages
@@ -1 +1 @@
-debian/graywolf.1
+debian/man/graywolf.1
diff --git a/debian/man/genmanpages.sh b/debian/man/genmanpages.sh
new file mode 100755
index 0000000..c9ece6c
--- /dev/null
+++ b/debian/man/genmanpages.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+
+txt2man -t GRAYWOLF               -s 1 graywolf.txt             > graywolf.1
diff --git a/debian/man/graywolf.1 b/debian/man/graywolf.1
new file mode 100644
index 0000000..074eac7
--- /dev/null
+++ b/debian/man/graywolf.1
@@ -0,0 +1,49 @@
+.\" Text automatically generated by txt2man
+.TH GRAYWOLF 1 "22 July 2015" "" ""
+.SH NAME
+\fBgraywolf \fP- placement tool for digital VLSI design
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBgraywolf\fP [\fIoptions\fP] \fIdesignName\fP [\fIwindowId\fP] [\fIflowdirectory\fP]
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+This is an utility used to perform placement of digital VLSI designs. It is
+based on some code from the early 90s and it is one of the building blocks
+of the open source qflow digital design flow.
+.RE
+.PP
+
+.SH OPTIONS
+.TP
+.B
+\fB-g\fP
+general mode
+.TP
+.B
+\fB-p\fP
+pick mode
+.TP
+.B
+\fB-n\fP
+no graphics
+.TP
+.B
+\fB-d\fP
+prints debug info and performs extensive error checking
+.TP
+.B
+\fB-w\fP
+parasite mode will inherit a window
+.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/graywolf.txt b/debian/man/graywolf.txt
new file mode 100644
index 0000000..10573b2
--- /dev/null
+++ b/debian/man/graywolf.txt
@@ -0,0 +1,24 @@
+NAME
+  graywolf - placement tool for digital VLSI design
+
+SYNOPSIS
+  graywolf [options] designName [windowId] [flowdirectory]
+
+DESCRIPTION
+ This is an utility used to perform placement of digital VLSI designs. It is
+ based on some code from the early 90s and it is one of the building blocks
+ of the open source qflow digital design flow.
+
+
+OPTIONS
+  -g            general mode
+  -p            pick mode
+  -n            no graphics
+  -d            prints debug info and performs extensive error checking
+  -w            parasite mode will inherit a window
+
+
+
+
+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/graywolf.git