annotate toolboxes/graph_visualisation/share/man/man3/gvc.3 @ 0:e9a9cd732c1e tip

first hg version after svn
author wolffd
date Tue, 10 Feb 2015 15:05:51 +0000
parents
children
rev   line source
wolffd@0 1 .TH LIBGVC 3
wolffd@0 2 .SH NAME
wolffd@0 3 \fBlibgvc\fR \- Graphviz context library
wolffd@0 4 .SH SYNOPSIS
wolffd@0 5 .ta .75i 1.5i 2.25i 3i 3.75i 4.5i 5.25i 6i
wolffd@0 6 .PP
wolffd@0 7 .nf
wolffd@0 8 \f5
wolffd@0 9 #include <graphviz/gvc.h>
wolffd@0 10
wolffd@0 11 /* set up a graphviz context */
wolffd@0 12 extern GVC_t *gvNEWcontext(char **info, char *user);
wolffd@0 13 extern char *gvUsername(void);
wolffd@0 14
wolffd@0 15 /* set up a graphviz context \(hy alternative */
wolffd@0 16 /* (wraps the above two functions using info built into libgvc) */
wolffd@0 17 extern GVC_t *gvContext(void);
wolffd@0 18
wolffd@0 19 /* parse command line args \(hy minimally argv[0] sets layout engine */
wolffd@0 20 extern int gvParseArgs(GVC_t *gvc, int argc, char **argv);
wolffd@0 21 extern graph_t *gvNextInputGraph(GVC_t *gvc);
wolffd@0 22
wolffd@0 23 /* Compute a layout using a specified engine */
wolffd@0 24 extern int gvLayout(GVC_t *gvc, graph_t *g, char *engine);
wolffd@0 25
wolffd@0 26 /* Compute a layout using layout engine from command line args */
wolffd@0 27 extern int gvLayoutJobs(GVC_t *gvc, graph_t *g);
wolffd@0 28
wolffd@0 29 /* Render layout into string attributes of the graph */
wolffd@0 30 extern void attach_attrs(graph_t *g);
wolffd@0 31
wolffd@0 32 /* Parse an html string */
wolffd@0 33 extern char *agstrdup_html(char *s);
wolffd@0 34 extern int aghtmlstr(char *s);
wolffd@0 35
wolffd@0 36 /* Render layout in a specified format to an open FILE */
wolffd@0 37 extern int gvRender(GVC_t *gvc, graph_t *g, char *format, FILE *out);
wolffd@0 38
wolffd@0 39 /* Render layout in a specified format to an open FILE */
wolffd@0 40 extern int gvRenderFilename(GVC_t *gvc, graph_t *g, char *format, char *filename);
wolffd@0 41
wolffd@0 42 /* Render layout according to \-T and \-o options found by gvParseArgs */
wolffd@0 43 extern int gvRenderJobs(GVC_t *gvc, graph_t *g);
wolffd@0 44
wolffd@0 45 /* Clean up layout data structures \(hy layouts are not nestable (yet) */
wolffd@0 46 extern int gvFreeLayout(GVC_t *gvc, graph_t *g);
wolffd@0 47
wolffd@0 48 /* Clean up graphviz context */
wolffd@0 49 extern int gvFreeContext(GVC_t *gvc);
wolffd@0 50
wolffd@0 51 \fP
wolffd@0 52 .fi
wolffd@0 53 .SH DESCRIPTION
wolffd@0 54 \fIlibgvc\fP provides a context for applications wishing to manipulate
wolffd@0 55 and render graphs. It provides a command line parsing, common rendering code,
wolffd@0 56 and a plugin mechanism for renderers.
wolffd@0 57
wolffd@0 58 .SH SEE ALSO
wolffd@0 59 .BR dot (1),
wolffd@0 60 .BR neato (1),
wolffd@0 61 .BR libcdt (3)
wolffd@0 62 .BR libgraph (3)
wolffd@0 63 .br
wolffd@0 64
wolffd@0 65 .SH AUTHOR
wolffd@0 66 John Ellson (ellson@research.att.com), AT&T