From 996103819300621952df6db54a23a2c945f454c9 Mon Sep 17 00:00:00 2001 From: ellson Date: Tue, 22 May 2007 07:50:39 +0000 Subject: [PATCH] man page syntax fixes from Debian maintainer (mostly use of \(hy ) cyril.brulebois@enst-bretagne.fr --- cmd/tools/gvcolor.1 | 4 ++-- cmd/tools/gvpack.1 | 18 +++++++++--------- contrib/prune/prune.1 | 36 ++++++++++++++++++------------------ lib/graph/graph.3 | 42 +++++++++++++++++++++--------------------- lib/gvc/gvc.3 | 8 ++++---- 5 files changed, 54 insertions(+), 54 deletions(-) diff --git a/cmd/tools/gvcolor.1 b/cmd/tools/gvcolor.1 index 773f1a7eb..2355166ff 100644 --- a/cmd/tools/gvcolor.1 +++ b/cmd/tools/gvcolor.1 @@ -12,7 +12,7 @@ gvcolor \- flow colors through a ranked digraph ] .SH "USAGE" .ft 5 -dot file.dot | gvcolor | dot -T\fI\fP +dot file.dot | gvcolor | dot \-T\fI\fP .ft .SH DESCRIPTION .B gvcolor @@ -29,7 +29,7 @@ attribute of a node. It is often effective to assign colors to a few key source or sink nodes, manually setting their colors by editing the graph file. Color names are as in \fIdot(1)\fP: symbolic names or RGB triples. -It is best to choose some easily-distinguished but related colors; +It is best to choose some easily\(hydistinguished but related colors; not necessarily spaced evenly around the color wheel. For example, blue_green, green, and light_yellow looks better than red, green, blue. .PP diff --git a/cmd/tools/gvpack.1 b/cmd/tools/gvpack.1 index 9748e5187..9ab64c60f 100644 --- a/cmd/tools/gvpack.1 +++ b/cmd/tools/gvpack.1 @@ -7,13 +7,13 @@ gvpack \- merge and pack disjoint graphs .B \-nguv? ] [ -.BI -m margin +.BI \-m margin ] [ -.BI -o outfile +.BI \-o outfile ] [ -.BI -G name\fB=\fPvalue +.BI \-G name\fB=\fPvalue ] [ .I files @@ -25,14 +25,14 @@ layout, and produces a single graph serving as the union of the input graphs. The input graphs must be in dot format, and must have all necessary layout information. Acceptable input is produced by applying a Graphviz layout program, such as \fBdot\fP or \fBneato\fP, -with no \fB-T\fP flag. +with no \fB\-T\fP flag. .P By default, the packing is done at the cluster level. Thus, parts of -one graph will not intrude into any top-level clusters or overlap +one graph will not intrude into any top\(hylevel clusters or overlap any nodes or edges of another. .P The output of \fBgvpack\fP can be used to produce concrete output -by applying \fBneato -s -n2\fP with the desired \fB-T\fP flag. +by applying \fBneato \-s \-n2\fP with the desired \fB\-T\fP flag. .SH OPTIONS The following options are supported: .TP @@ -76,10 +76,10 @@ the standard input will be used. .B gvpack returns .B 0 -if there were no problems, and non-zero otherwise. +if there were no problems, and non\(hyzero otherwise. .SH EXAMPLES .EX -ccomps -x abc.dot | dot | gvpack | neato -s -n2 -Tps +ccomps \-x abc.dot | dot | gvpack | neato \-s \-n2 \-Tps .EE This pipeline decomposes the graph in \fIabc.dot\fP into its connected components, lays out each using \fBdot\fP, packs them all together @@ -93,7 +93,7 @@ An input graph should not have a label, since this will be used in its layout. Since \fBgvpack\fP ignores root graph labels, resulting layout may contain some extra space. .P -\fBgvpack\fP unsets the bounding box attribute of all non-cluster +\fBgvpack\fP unsets the bounding box attribute of all non\(hycluster subgraphs. .SH AUTHORS Emden R. Gansner diff --git a/contrib/prune/prune.1 b/contrib/prune/prune.1 index 6200d5f82..d69caf6a1 100644 --- a/contrib/prune/prune.1 +++ b/contrib/prune/prune.1 @@ -10,7 +10,7 @@ .TH prune 1 .SH NAME -prune - Prune directed graphs +prune \- Prune directed graphs .SH SYNOPSIS .B prune [ @@ -32,7 +32,7 @@ but can be given attributes so that they can be easily located by a graph stream editor such as .B gpr(1). .B prune -correctly handles cycles, loops and multi-edges. +correctly handles cycles, loops and multi\(hyedges. Both options can appear multiple times on the command line. All subgraphs rooted at the respective nodes given will then be @@ -62,31 +62,31 @@ of the form .PP digraph DG { .br - A -> B; + A \-> B; .br - A -> C; + A \-> C; .br .br - B -> D; + B \-> D; .br - B -> E; + B \-> E; .br } .br , processed by the command .PP - prune -n B test.dot + prune \-n B test.dot .PP would produce the following output (the actual code might be formatted in a slightly different way). .PP digraph DG { .br - A -> B; + A \-> B; .br - A -> C; + A \-> C; .br } .br @@ -97,19 +97,19 @@ of the form .PP digraph DG { .br - A -> B; + A \-> B; .br - A -> C; + A \-> C; .br .br - B -> D; + B \-> D; .br - B -> E; + B \-> E; .br .br - C -> E; + C \-> E; .br } .br @@ -120,7 +120,7 @@ to .I E ), processed by the command .PP - prune -n B -N color=red test.dot + prune \-n B \-N color=red test.dot .PP results in .PP @@ -128,11 +128,11 @@ results in .br B [color=red]; .br - A -> B; + A \-> B; .br - A -> C; + A \-> C; .br - C -> E; + C \-> E; .br } .br diff --git a/lib/graph/graph.3 b/lib/graph/graph.3 index e60836f7c..0d7ba91b4 100644 --- a/lib/graph/graph.3 +++ b/lib/graph/graph.3 @@ -65,16 +65,16 @@ defined at compile time. These allow efficient representation and direct access to values such as marks, weights, and pointers for writing graph algorithms. External attributes, on the other hand, are character strings -(name-value pairs) dynamically allocated at runtime and accessed +(name\(hyvalue pairs) dynamically allocated at runtime and accessed through \fIlibgraph\fP calls. External attributes are used in graph file I/O; internal attributes are not. Conversion between internal and external attributes must be explicitly programmed. The subgraphs in a main graph are represented by an auxiliary directed -graph (a meta-graph). Meta-nodes correspond to subgraphs, and meta-edges +graph (a meta\(hygraph). Meta\(hynodes correspond to subgraphs, and meta\(hyedges signify containment of one subgraph in another. \f5agmetanode\fP and \f5agusergraph\fP map between -subgraphs and meta-nodes. The nodes and edges of the meta-graph may +subgraphs and meta\(hynodes. The nodes and edges of the meta\(hygraph may be traversed by the usual \fIlibgraph\fP functions for this purpose. .SH USE @@ -86,10 +86,10 @@ including \f5\fP. (This is a macro that calls \f5aginitlib()\fP to define the sizes of Agraphinfo_t, Agnodeinfo_t, and Agedgeinfo_t.) -3. Compile with -lgraph -lcdt. +3. Compile with \-lgraph \-lcdt. Except for the \fBu\fP fields, \fIlibgraph\fP -data structures must be considered read-only. +data structures must be considered read\(hyonly. Corrupting their contents by direct updates can cause catastrophic errors. @@ -123,13 +123,13 @@ A graph \fIkind\fP is one of: AGRAPH, AGRAPHSTRICT, AGDIGRAPH, or AGDIGRAPHSTRICT. There are related macros for testing the properties of a graph: AG_IS_DIRECTED(g) and AG_IS_STRICT(g). -Strict graphs cannot have self-arcs or multi-edges. +Strict graphs cannot have self\(hyarcs or multi\(hyedges. \fBattr\fP is the array of external attribute values. \fBuniv\fP points to values shared by all subgraphs of a main graph. \fBnodes\fP, \fBinedges\fP, and \fBoutedges\fP are sets maintained by \fBcdt(3)\fP. Normally you don't access these dictionaries -directly, though the edge dictionaries may be re-ordered to support -programmer-defined ordered edges (see \f5dtreorder\fP in \fIcdt(3)\fP). +directly, though the edge dictionaries may be re\(hyordered to support +programmer\(hydefined ordered edges (see \f5dtreorder\fP in \fIcdt(3)\fP). \fBproto\fP is a stack of templates for node and edge initialization. The attributes of these nodes and edges are set in the usual way (\f5agget\fP, \f5agset\fP, etc.) to set defaults. @@ -168,7 +168,7 @@ typedef struct Agnode_t { \f5agnode\fP attempts to create a node. If one with the requested name already exists, the old node is returned unmodified. -Otherwise a new node is created, with attributed copied from g->proto->n. +Otherwise a new node is created, with attributed copied from g\->proto\->n. \f5agfstnode\fP (\f5agnxtnode\fP) return the first (next) element in the node set of a graph, respectively, or NULL. \f5aglstnode\fP (\f5agprvnode\fP) return the last (previous) element @@ -184,20 +184,20 @@ typedef struct Agedge_t { } Agedge_t; \fP .fi -\f5agedge\fP creates a new edge with the attributes of g->proto->e +\f5agedge\fP creates a new edge with the attributes of g\->proto\->e including its key if not empty. \f5agfindedge\fP finds the first (u,v) edge in \f5g\fP. \f5agfstedge\fP (\f5agnxtedge\fP) return the first (next) element in the edge set of a graph, respectively, or NULL. \f5agfstin\fP, \f5agnxtin\fP, \f5agfstout\fP, \f5agnxtout\fP -refer to in- or out-edge sets. +refer to in\(hy or out\(hyedge sets. The idiomatic usage in a directed graph is: .sp \f5 for (e = agfstout(g,n); e; e = agnextout(g,e)) your_fun(e);\fP .P An edge is uniquely identified by its endpoints and its \f5key\fP attribute (if there are multiple edges). -If the \f5key\fP of \f5g->proto->e\fP is empty, +If the \f5key\fP of \f5g\->proto\->e\fP is empty, new edges are assigned an internal value. Edges also have \f5tailport\fP and \f5headport\fP values. These have special syntax in the graph file language but are @@ -236,25 +236,25 @@ and is NULL terminated. Here is a program fragment to print node attribute names: .nf \f5attrsym_t *aptr; - for (i = 0; aptr = g->univ->nodedict->list[i]; i++) puts(aptr->name);\fP + for (i = 0; aptr = g\->univ\->nodedict\->list[i]; i++) puts(aptr\->name);\fP .fi .SH EXAMPLE GRAPH FILES .nf graph any_name { /* an undirected graph */ - a -- b; /* a simple edge */ - a -- x1 -- x2 -- x3; /* a chain of edges */ - "x3.a!" -- a; /* quotes protect special characters */ - b -- {q r s t}; /* edges that fan out */ + a \-\- b; /* a simple edge */ + a \-\- x1 \-\- x2 \-\- x3; /* a chain of edges */ + "x3.a!" \-\- a; /* quotes protect special characters */ + b \-\- {q r s t}; /* edges that fan out */ b [color="red",size=".5,.5"]; /* set various node attributes */ node [color=blue]; /* set default attributes */ - b -- c [weight=25]; /* set edge attributes */ + b \-\- c [weight=25]; /* set edge attributes */ subgraph sink_nodes {a b c}; /* make a subgraph */ } digraph G { size="8.5,11"; /* sets a graph attribute */ - a -> b; /* makes a directed edge */ - chip12.pin1 -> chip28.pin3; /* uses named node "ports" */ + a \-> b; /* makes a directed edge */ + chip12.pin1 \-> chip28.pin3; /* uses named node "ports" */ } .fi @@ -264,7 +264,7 @@ digraph G { .BR libdict (3) .br S. C. North and K. P. Vo, "Dictionary and Graph Libraries'' -1993 Winter USENIX Conference Proceedings, pp. 1-11. +1993 Winter USENIX Conference Proceedings, pp. 1\(hy11. .SH AUTHOR Stephen North (north@ulysses.att.com), AT&T Bell Laboratories. diff --git a/lib/gvc/gvc.3 b/lib/gvc/gvc.3 index 939a71cd1..f35385f0d 100644 --- a/lib/gvc/gvc.3 +++ b/lib/gvc/gvc.3 @@ -12,11 +12,11 @@ extern GVC_t *gvNEWcontext(char **info, char *user); extern char *gvUsername(void); -/* set up a graphviz context - alternative */ +/* set up a graphviz context \(hy alternative */ /* (wraps the above two functions using info built into libgvc) */ extern GVC_t *gvContext(void); -/* parse command line args - minimally argv[0] sets layout engine */ +/* parse command line args \(hy minimally argv[0] sets layout engine */ extern int gvParseArgs(GVC_t *gvc, int argc, char **argv); extern graph_t *gvNextInputGraph(GVC_t *gvc); @@ -39,10 +39,10 @@ extern int gvRender(GVC_t *gvc, graph_t *g, char *format, FILE *out); /* Render layout in a specified format to an open FILE */ extern int gvRenderFilename(GVC_t *gvc, graph_t *g, char *format, char *filename); -/* Render layout according to -T and -o options found by gvParseArgs */ +/* Render layout according to \-T and \-o options found by gvParseArgs */ extern int gvRenderJobs(GVC_t *gvc, graph_t *g); -/* Clean up layout data structures - layouts are not nestable (yet) */ +/* Clean up layout data structures \(hy layouts are not nestable (yet) */ extern int gvFreeLayout(GVC_t *gvc, graph_t *g); /* Clean up graphviz context */ -- 2.40.0