annotate toolboxes/graph_visualisation/share/man/man1/gvpack.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 GVPACK 1 "8 April 2003"
Daniel@0 2 .SH NAME
Daniel@0 3 gvpack \- merge and pack disjoint graphs
Daniel@0 4 .SH SYNOPSIS
Daniel@0 5 .B gvpack
Daniel@0 6 [
Daniel@0 7 .B \-nguv?
Daniel@0 8 ]
Daniel@0 9 [
Daniel@0 10 .BI \-m margin
Daniel@0 11 ]
Daniel@0 12 [
Daniel@0 13 .BI \-o outfile
Daniel@0 14 ]
Daniel@0 15 [
Daniel@0 16 .BI \-G name\fB=\fPvalue
Daniel@0 17 ]
Daniel@0 18 [
Daniel@0 19 .I files
Daniel@0 20 ]
Daniel@0 21 .SH DESCRIPTION
Daniel@0 22 .B gvpack
Daniel@0 23 reads in a stream of graphs, combines the graphs into a single
Daniel@0 24 layout, and produces a single graph serving as the union of the
Daniel@0 25 input graphs. The input graphs must be in dot format, and must have
Daniel@0 26 all necessary layout information. Acceptable input is produced
Daniel@0 27 by applying a Graphviz layout program, such as \fBdot\fP or \fBneato\fP,
Daniel@0 28 with no \fB\-T\fP flag.
Daniel@0 29 .P
Daniel@0 30 By default, the packing is done at the cluster level. Thus, parts of
Daniel@0 31 one graph will not intrude into any top\(hylevel clusters or overlap
Daniel@0 32 any nodes or edges of another.
Daniel@0 33 .P
Daniel@0 34 The output of \fBgvpack\fP can be used to produce concrete output
Daniel@0 35 by applying \fBneato \-s \-n2\fP with the desired \fB\-T\fP flag.
Daniel@0 36 .SH OPTIONS
Daniel@0 37 The following options are supported:
Daniel@0 38 .TP
Daniel@0 39 .B \-g
Daniel@0 40 Combines the graphs at the graph level. This uses more space, but prevents
Daniel@0 41 parts of one graph from occurring between parts of another.
Daniel@0 42 .TP
Daniel@0 43 .BI \-G "name\fB=\fPvalue"
Daniel@0 44 Specifies attributes to be added to the resulting union graph. For
Daniel@0 45 example, this can be used to specify a graph label.
Daniel@0 46 .TP
Daniel@0 47 .BI \-m "margin"
Daniel@0 48 Packs the graphs allowing a margin of \fIoutput\fP points around
Daniel@0 49 the parts.
Daniel@0 50 .TP
Daniel@0 51 .B \-n
Daniel@0 52 Combines the graphs at the node level. Clusters are ignored in the packing.
Daniel@0 53 .TP
Daniel@0 54 .BI \-o "output"
Daniel@0 55 Prints output to the file \fIoutput\fP. If not given, \fBgvpack\fP
Daniel@0 56 uses stdout.
Daniel@0 57 .TP
Daniel@0 58 .B \-u
Daniel@0 59 Don't pack the graphs. Just combine them into a single graph.
Daniel@0 60 .TP
Daniel@0 61 .B \-v
Daniel@0 62 Verbose mode.
Daniel@0 63 .TP
Daniel@0 64 .B \-?
Daniel@0 65 Prints usage information and exit.
Daniel@0 66 .SH OPERANDS
Daniel@0 67 The following operand is supported:
Daniel@0 68 .TP 8
Daniel@0 69 .I files
Daniel@0 70 Names of files containing 1 or more graphs in dot format.
Daniel@0 71 If no
Daniel@0 72 .I files
Daniel@0 73 operand is specified,
Daniel@0 74 the standard input will be used.
Daniel@0 75 .SH RETURN CODES
Daniel@0 76 .B gvpack
Daniel@0 77 returns
Daniel@0 78 .B 0
Daniel@0 79 if there were no problems, and non\(hyzero otherwise.
Daniel@0 80 .SH EXAMPLES
Daniel@0 81 .EX
Daniel@0 82 ccomps \-x abc.dot | dot | gvpack | neato \-s \-n2 \-Tps
Daniel@0 83 .EE
Daniel@0 84 This pipeline decomposes the graph in \fIabc.dot\fP into its
Daniel@0 85 connected components, lays out each using \fBdot\fP, packs them all together
Daniel@0 86 again, and produces the final drawing in PostScript. Of course,
Daniel@0 87 there is nothing to prevent one from using different layouts for
Daniel@0 88 each component.
Daniel@0 89 .SH "BUGS"
Daniel@0 90 All the input graphs must be directed or undirected.
Daniel@0 91 .P
Daniel@0 92 An input graph should not have a label, since this will be used in its
Daniel@0 93 layout. Since \fBgvpack\fP ignores root graph labels, resulting layout
Daniel@0 94 may contain some extra space.
Daniel@0 95 .P
Daniel@0 96 \fBgvpack\fP unsets the bounding box attribute of all non\(hycluster
Daniel@0 97 subgraphs.
Daniel@0 98 .SH AUTHORS
Daniel@0 99 Emden R. Gansner <erg@research.att.com>
Daniel@0 100 .SH "SEE ALSO"
Daniel@0 101 gvpr(1), dot(1), neato(1), twopi(1), ccomps(1), libpack(3)