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