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