.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Graph::Writer::VCG 3pm"
.TH Graph::Writer::VCG 3pm "2021-09-19" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Graph::Writer::VCG \- write out directed graph in VCG format
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Graph;
\&  use Graph::Writer::VCG;
\&
\&  $graph = Graph\->new();
\&  # add edges and nodes to the graph
\&
\&  $writer = Graph::Writer::VCG\->new();
\&  $writer\->write_graph($graph, \*(Aqmygraph.vcg\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBGraph::Writer::VCG\fR is a class for writing out a directed graph
in the file format used by the \fI\s-1VCG\s0\fR tool, originally developed
for Visualising Compiler Graphs.
The graph must be an instance of the Graph class, which is
actually a set of classes developed by Jarkko Hietaniemi.
.PP
If you have defined any attributes for the graph,
nodes, or edges, they will be written out to the file,
as long as they are attributes understood by \s-1VCG.\s0
.SH "METHODS"
.IX Header "METHODS"
.SS "\fBnew()\fP"
.IX Subsection "new()"
Constructor \- generate a new writer instance.
.PP
.Vb 1
\&  $writer = Graph::Writer::VCG\->new();
.Ve
.PP
This doesn't take any arguments.
.SS "\fBwrite_graph()\fP"
.IX Subsection "write_graph()"
Write a specific graph to a named file:
.PP
.Vb 1
\&  $writer\->write_graph($graph, $file);
.Ve
.PP
The \f(CW$file\fR argument can either be a filename,
or a filehandle for a previously opened file.
.SH "KNOWN BUGS AND LIMITATIONS"
.IX Header "KNOWN BUGS AND LIMITATIONS"
.IP "\(bu" 4
Attributes with non-atomic values aren't currently handled.
This includes the \fBloc\fR, \fBclassname\fR, \fBcolorentry\fR,
and \fBinfoname\fR attributes for graphs,
and the \fBloc\fR attribute for nodes,
.IP "\(bu" 4
Can currently only handle \fBgraph\fR, \fBnode\fR, and \fBedge\fR elements
and their attributes.
So doesn't know about \fBfoldnode_defaults\fR and things like that.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "http://www.cs.uni\-sb.de/RW/users/sander/html/gsvcg1.html" 4
.IX Item "http://www.cs.uni-sb.de/RW/users/sander/html/gsvcg1.html"
The home page for \s-1VCG.\s0
.IP "Graph" 4
.IX Item "Graph"
Jarkko Hietaniemi's modules for representing directed graphs,
available from \s-1CPAN\s0 under modules/by\-module/Graph/
.IP "Algorithms in Perl" 4
.IX Item "Algorithms in Perl"
The O'Reilly book which has a chapter on directed graphs,
which is based around Jarkko's modules.
.IP "Graph::Writer" 4
.IX Item "Graph::Writer"
The base-class for Graph::Writer::VCG
.SH "REPOSITORY"
.IX Header "REPOSITORY"
<https://github.com/neilb/Graph\-ReadWrite>
.SH "AUTHOR"
.IX Header "AUTHOR"
Neil Bowers <neil@bowers.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001\-2012, Neil Bowers. All rights reserved.
Copyright (c) 2001, Canon Research Centre Europe. All rights reserved.
.PP
This script is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.