~ubuntu-branches/ubuntu/lucid/graphviz/lucid-security

« back to all changes in this revision

Viewing changes to dotneato/neato.1

  • Committer: Bazaar Package Importer
  • Author(s): Stephen M Moraco
  • Date: 2002-02-05 18:52:12 UTC
  • Revision ID: james.westby@ubuntu.com-20020205185212-8i04c70te00rc40y
Tags: upstream-1.7.16
ImportĀ upstreamĀ versionĀ 1.7.16

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH NEATO 1 "12 August 1994"
 
2
.SH NAME
 
3
neato \- preprocessor for drawing undirected graphs
 
4
.SH SYNOPSIS
 
5
\fBneato\fR [\fB\-G\fIname=value\fR]
 
6
[\fB\-N\fIname=value\fR]
 
7
[\-E\fIname=value\fR]
 
8
[\fB\-T\fIlang\fR]
 
9
[\fB\-l \fIlibfile\fR]
 
10
[\fB\-o \fIoutfile\fR]
 
11
[\fB\-v\fR]
 
12
[files]
 
13
.SH DESCRIPTION
 
14
.I neato
 
15
draws undirected graphs using ``spring'' models (see Kamada and Kawai,
 
16
Information Processing Letters 31:1, April 1989).  Input files must be
 
17
formatted in the
 
18
.I dot
 
19
attributed graph language.
 
20
By default, the output of
 
21
.I neato
 
22
is the input graph with layout coordinates appended.
 
23
To make Postscript, use the \fB\-Tps\fP option.
 
24
FrameMaker MIF (\fB-Tmif\fP), HPGL (\fB-Thpgl\fP),
 
25
and GIF (\fB-Tgif\fP) are other choices.
 
26
.PP
 
27
Here is a brief synopsis of the graph language.
 
28
.PP
 
29
\fBgraph \fIname\fP { \fIstatement-list\fP }\fR is the top level graph.
 
30
Statements may be:
 
31
.PP
 
32
\fIname\fB=\fIval\fB;\fR
 
33
.br
 
34
\fBnode [\fIname\fB=\fIval\fB];\fR
 
35
.br
 
36
\fBedge [\fIname\fB=\fIval\fB];\fR
 
37
Set the default graph, node, or edge attribute \fIname\fP to \fIval\fP.
 
38
Any subgraph, node, or edge specified after one of these statements
 
39
inherits these attributes.
 
40
.PP
 
41
\fBn0 [\fIname0=val0,name1=val1,...\fB];\fR
 
42
Creates node \fBn0\fP if it does not exist,
 
43
and sets its attributes according to the optional list. 
 
44
.PP
 
45
\fBn0 \-\- n1 \-\- \fI...\fB \-\- nn [\fIname0=val0,name1=val1,...\fB];\fR
 
46
Creates edges between nodes \fBn0\fP, \fBn1\fP, ..., \fBnn\fP and optionally
 
47
sets the given attributes.  Creates nodes as necessary.
 
48
.PP
 
49
\fBsubgraph \fIname\fB { \fIstatement-list \fB}\fR
 
50
Creates a subgraph.  A subgraph may appear in place of
 
51
an individual node within an edge statement.
 
52
The \fBsubgraph \fIname\fR part is optional. If missing,
 
53
the subgraph is given an internal name.
 
54
.PP
 
55
While attribute names and values may be arbitrary strings,
 
56
certain fixed attributes control \fIneato\fP's layout algorithm,
 
57
as next described.
 
58
.SH "GRAPH ATTRIBUTES"
 
59
Refer to \fIdot\fP(1) options to control the layout size.
 
60
In addition, \fIneato\fP recognizes the following:
 
61
.PP
 
62
\fBstart=\fIval\fR.  Requests random initial placement and seeds
 
63
the random number generator.  If \fIval\fP is not an integer,
 
64
the process ID or current time is used as the seed.
 
65
.PP
 
66
\fBepsilon=\fIn\fR.  Sets the cutoff for the solver.
 
67
The default is 0.1.
 
68
.PP
 
69
.SH "NODE ATTRIBUTES"
 
70
Refer to \fIdot\fP(1) for options to control node labels, shapes,
 
71
sizes, colors, fonts, etc.
 
72
.SH "EDGE ATTRIBUTES"
 
73
Refer to \fIdot\fP(1) for options to control edge line style
 
74
and labels.  In addition \fIneato\fP recognizes the following:
 
75
.PP
 
76
\fBw=\fIf\fR sets the weight (spring constant) of an edge
 
77
to the given floating point value.  The default is 1.0;
 
78
greater values make the edge tend more toward its optimal length.
 
79
.PP
 
80
\fBlen=\fIf\fR sets the optimal length of an edge.
 
81
The default is 1.0.
 
82
.SH "COMMAND LINE OPTIONS"
 
83
\fB\-v\fP (verbose) prints delta energy every 100th iteration.
 
84
.SH "EXAMPLE"
 
85
.nf
 
86
\f5graph test123 {
 
87
        a \-\- b \-\- c;
 
88
        a \-\- {x y};
 
89
        x \-\- c [w=10.0];
 
90
        x \-\- y [w=5.0,len=3];
 
91
}\fP
 
92
.fi
 
93
.SH "CAVEATS"
 
94
Because unconstrained optimization is employed, node boxes can
 
95
possibly overlap or touch unrelated edges.  All existing
 
96
spring embedders seem to have this limitation. 
 
97
.PP
 
98
Apparently reasonable attempts to pin nodes or adjust edge lengths
 
99
and weights can cause instability.
 
100
.SH "SEE ALSO"
 
101
.BR dot (1)
 
102
.br
 
103
S. C. North, "NEATO User's Manual".
 
104
Available on research.att.com in dist/drawdag/neatodoc.ps.Z.