annotate toolboxes/graph_visualisation/share/man/man1/unflatten.1 @ 0:e9a9cd732c1e tip

first hg version after svn
author wolffd
date Tue, 10 Feb 2015 15:05:51 +0000
parents
children
rev   line source
wolffd@0 1 .TH UNFLATTEN 1 "21 January 2001"
wolffd@0 2 .SH NAME
wolffd@0 3 unflatten \- adjust directed graphs to improve layout aspect ratio
wolffd@0 4 .SH SYNOPSIS
wolffd@0 5 .B unflatten
wolffd@0 6 [\fB\-f\fR]
wolffd@0 7 [\fB\-l\fIlen\fR]
wolffd@0 8 [\fB\-c\fIlen\fR
wolffd@0 9 ] [
wolffd@0 10 .B \-o
wolffd@0 11 .I outfile
wolffd@0 12 ]
wolffd@0 13 [ files ]
wolffd@0 14 .SH DESCRIPTION
wolffd@0 15 .B unflatten
wolffd@0 16 is a preprocessor to
wolffd@0 17 .B dot
wolffd@0 18 that is
wolffd@0 19 used to improve the aspect ratio of graphs having many leaves
wolffd@0 20 or disconnected nodes.
wolffd@0 21 The usual layout for such a graph is generally very wide or tall.
wolffd@0 22 .B unflatten
wolffd@0 23 inserts invisible edges or adjusts the \fBminlen\fP on edges
wolffd@0 24 to improve layout compaction.
wolffd@0 25 .SH OPTIONS
wolffd@0 26 The following options are supported:
wolffd@0 27 .TP
wolffd@0 28 .BI \-l " len"
wolffd@0 29 The minimum length of leaf edges is staggered
wolffd@0 30 between 1 and \fIlen\fP (a small integer).
wolffd@0 31 .TP
wolffd@0 32 .B \-f
wolffd@0 33 Enables the staggering of the \fB-l\fP option to fanout nodes whose
wolffd@0 34 indegree and outdegree are both 1. This helps with structures such
wolffd@0 35 as \fIa -> {w x y z} -> b\fP.
wolffd@0 36 This option only works if the \fB-l\fP flag is set.
wolffd@0 37 .TP
wolffd@0 38 .BI \-c " len"
wolffd@0 39 Form disconnected nodes into chains of up to \fIlen\fP nodes.
wolffd@0 40 .TP
wolffd@0 41 .BI \-o " outfile"
wolffd@0 42 causes the output to be written to the specified file; by default,
wolffd@0 43 output is written to \fBstdout\fP.
wolffd@0 44 .SH OPERANDS
wolffd@0 45 The following operand is supported:
wolffd@0 46 .TP 8
wolffd@0 47 .I files
wolffd@0 48 Names of files containing 1 or more graphs in dot format.
wolffd@0 49 If no
wolffd@0 50 .I files
wolffd@0 51 operand is specified,
wolffd@0 52 the standard input will be used.
wolffd@0 53 .SH AUTHORS
wolffd@0 54 Stephen C. North <north@research.att.com>
wolffd@0 55 .br
wolffd@0 56 Emden R. Gansner <erg@research.att.com>
wolffd@0 57 .SH "SEE ALSO"
wolffd@0 58 gc(1), dot(1), acyclic(1), gvpr(1), gvcolor(1), ccomps(1), tred(1), libgraph(3)