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

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