Add man page for mingle.

diff --git a/cmd/mingle/Makefile.am b/cmd/mingle/Makefile.am
index 4d1c15640ac2988b64887517d009e446aa14622b..ca92b51c03e79eaa506d9dc63b640271cb259004 100644 (file)
--- a/cmd/mingle/Makefile.am
+++ b/cmd/mingle/Makefile.am
@@ -15,10 +15,8 @@ AM_CPPFLAGS = \
 if WITH_ANN
 bin_PROGRAMS = mingle
 
-#man_MANS = mingle.1
-#pdf_DATA = mingle.1.pdf
-man_MANS =
-pdf_DATA = 
+man_MANS = mingle.1
+pdf_DATA = mingle.1.pdf
 endif
 
 mingle_SOURCES = minglemain.c
@@ -35,7 +33,7 @@ mingle_LDADD = \
        $(ANN_LIBS) -lstdc++ -lm
 
 mingle.1.pdf: $(srcdir)/mingle.1
-       - @GROFF@ -Tps -man -t $(srcdir)/mingle.1 | @PS2PDF@ - - >mingle.1.pdf
+       - @GROFF@ -e -Tps -man -t $(srcdir)/mingle.1 | @PS2PDF@ - - >mingle.1.pdf
 
 EXTRA_DIST = $(man_MANS) $(pdf_DATA) mingle.vcproj
 

diff --git a/cmd/mingle/mingle.1 b/cmd/mingle/mingle.1
new file mode 100644 (file)
index 0000000..daeda4d
--- /dev/null
+++ b/cmd/mingle/mingle.1
@@ -0,0 +1,91 @@
+.EQ
+delim $$
+.EN
+.de TQ
+.  br
+.  ns
+.  TP \\$1
+..
+.TH MINGLE 1 "16 August 2013"
+.SH NAME
+mingle \- fast edge bundling
+.SH SYNOPSIS
+.B mingle
+[
+.I options
+]
+[
+.BI \-o
+.I outfile
+]
+[ 
+.I files
+]
+.SH DESCRIPTION
+.B mingle
+takes as input a graph in DOT format with node position information (the \fIpos\fP attribute) and
+bundles the edges.
+.SH OPTIONS
+The following options are supported:
+.TP
+.BI \-m " k"
+indicates which method to use for bundling. A value of 0 corresponds to a force-directed bundling.
+A value of 2 uses a cluster plus ink saving approach. If available, a value 1 denotes 
+an agglomerative ink saving method. Normally, the last is the default.
+.TP
+.BI \-a " k"
+specifies the maximum turning angle, in degrees, as a non-negative real.
+The larger the value, the more edges may bend. If the value is 0, there is no limitation on
+the turning angle. The default is 40.
+The parameter is not used in force-directed bundling.
+.TP
+.BI \-c " v"
+specifies which compatability measure to use. The value 0, the default, uses a distance metric,
+while a value of 1 relies on full compatability. This value is only used in force-directed bundling.
+.TP
+.BI \-i " k"
+gives the maximum number of iterative divisions of edges allowd in force-directed bundling.
+The default is 4.
+.TP
+.BI \-k " k"
+gives the number of neighbors to be used in forming a nearest neighbor graph. This parameter is
+only used in the agglomerative method. The default is 10.
+.TP
+.BI \-K " k"
+is a positive real value giving the force constant used in force-directed bundling. By default,
+the value is determined automatically.
+.TP
+.BI \-o " file" 
+puts output in \fIfile\fP. Default output is stdout
+.TP
+.BI \-p " k"  
+Except for the force-directed method, bundling minimizes $ink * (k - cos(turning angle))$. The larger the
+value of \fIk\fP, the less emphasis is put on avoiding sharp turning angles and the faster the bundling.
+The default value is -1.
+.TP
+.BI \-r " k"  
+is a non-negative integer giving the maximum recursion level used in the agglomerative method. The default is 100.
+.TP
+.BI \-T " fmt"  
+specifies the output format. At present, the output is always in the DOT format. If \fIfmt\fP is "simple",
+the output is a simple, schematic representation of the drawing. Only the node positions and edges are
+retained from the original graph. If \fIfmt\fP is "gv", the drawing information is attached to the
+input graph. 
+.TP
+.BI \-v " k"  
+determines the verbose level used for tracing the algorithm. The value \fIk\fP is optional; if not
+provided, the value 1 is used.
+.TP
+.BI \-? 
+Print usage and exit.
+
+.SH AUTHOR
+Emden R. Gansner <erg@research.att.com>
+Yifan Hu <yifanhu@research.att.com>
+.SH "SEE ALSO"
+.PP
+sfdp(1), neato(1), gvpr(1)
+.PP
+Emden R. Gansner, Yifan Hu, Stephen C. North and Carlos Scheidegger, 
+``Multilevel Agglomerative Edge Bundling for Visualizing Large Graphs'',
+IEEE Pacific Visualization Symposium PacificVis, pp. 187\(hy194, 2011.