.\" -*- nroff -*-
.\" This manual is for graphviz, a rich set of graph drawing tools, and it
.\" can be distributed under the same terms as the graphviz package.
.\" 
.\" Copyright (C) 2006 Cyril Brulebois <cyril.brulebois@enst-bretagne.fr>
.\"
.TH GRAPHVIZ 5 "November 19, 2006"
.SH "NAME"
graphviz \- rich set of graph drawing tools

.SH "SYNOPSIS"
This manpage has been written to fulfil the need of a centralized documentation
presenting all available tools in the graphviz package.

.SH "AVAILABLE TOOLS"

.SS "Graph layout programs"
.TP
.B dot
filter for hierarchical layouts of graphs
.TP
.B neato
filter for symmetric layouts of graphs
.TP
.B twopi
filter for radial layouts of graphs
.TP
.B circo
filter for circular layout of graphs
.TP
.B fdp
filter for symmetric layouts of graphs
.PP
All of the filters work with either directed or undirected graphs, though
.B dot
is typically used for directed graphs and
.B neato
for undirected graphs.
Note also that \fBneato \-n[2]\fP can be used to render layouts produced
by the other filters.
.SS "Graph drawing programs"
.TP
.B lefty
A Programmable Graphics Editor
.TP
.B lneato
lefty + neato
.TP
.B dotty
lefty + dot


.SS "Graph layout enhancement"
.TP
.B gvcolor
flow colors through a ranked digraph
.TP
.B unflatten
adjust directed graphs to improve layout aspect ratio
.TP
.B gvpack
merge and pack disjoint graphs

.SS "Graph information and transformation"
.TP
.B gc
count graph components
.TP
.B acyclic
make directed graph acyclic
.TP
.B nop
pretty-print graph file
.TP
.B ccomps
connected components filter for graphs
.TP
.B sccmap
extract strongly connected components of directed graphs
.TP
.B tred
transitive reduction filter for directed graphs
.TP
.B dijkstra
single-source distance filter
.TP
.B bcomps
biconnected components filter for graphs
.TP
.B gvpr
graph pattern scanning and processing language
.TP
.B prune
prune directed graphs

.SS "Other"
.TP
.B "gxl2dot, dot2gxl"
GXL-DOT converters

.SH ENVIRONMENT VARIABLES
You may need to set the environment variable 
.B GVBINDIR
to the graphvis plugin directory @CLIENT_BASEDIR@/lib/graphviz if graphviz
was not installed in the default install directory /usr, so that 
graphviz is able to find all required plugins.
.PP
You may also need to adjust 
.B LEFTYPATH
and
.B LEFTYOPTIONS
 - see lefty(1).
.SH SEE ALSO
.BR acyclic (1),
.BR bcomps (1),
.BR ccomps (1),
.BR circo (1),
.BR dijkstra (1),
.BR dot (1),
.BR dotty (1),
.BR fdp (1),
.BR gc (1),
.BR gml2gv (1),
.BR gv2gxl (1),
.BR gvcolor (1),
.BR gvgen (1),
.BR gvpack (1),
.BR gvpr (1),
.BR gxl2gv (1),
.BR lefty (1),
.BR lneato (1),
.BR mm2gv (1),
.BR neato (1),
.BR nop (1),
.BR osage (1),
.BR prune (1),
.BR sccmap (1),
.BR sfdp (1),
.BR smyrna (1),
.BR tred (1),
.BR twopi (1),
.BR unflatten (1),
.BR libcdt (3),
.BR libcgraph (3),
.BR libgraph (3),
.BR libgvc (3),
.BR libpathplan (3),
.BR libxdot (3),
.BR gv (3guile),
.BR gv (3java),
.BR gv (3python),
.BR gdtclft (3tcl),
.BR gv (3tcl),
.BR tcldot (3tcl),
.BR tkspline (3tk)

.SH "AUTHOR"
This manual page was written by Cyril Brulebois
<cyril.brulebois@enst\-bretagne.fr> in november 2006, based on an initial
documentation effort by Joachim Berdal Haga <jbh@lupus.ig3.net>. It can be
distributed under the same terms as the graphviz package.