From 6c6271f795200f36b7d4c0b1671d7ab620c65274 Mon Sep 17 00:00:00 2001 From: ellson Date: Tue, 22 May 2007 07:50:38 +0000 Subject: [PATCH] man page syntax fixes from Debian maintainer (mostly use of \(hy ) cyril.brulebois@enst-bretagne.fr --- cmd/dot/dot.1 | 144 +++++++++++++++++++++++++----------------------- cmd/gvpr/gvpr.1 | 130 +++++++++++++++++++++---------------------- 2 files changed, 139 insertions(+), 135 deletions(-) diff --git a/cmd/dot/dot.1 b/cmd/dot/dot.1 index f4295a8e2..7aa0f0e59 100644 --- a/cmd/dot/dot.1 +++ b/cmd/dot/dot.1 @@ -90,50 +90,54 @@ draws graphs using a circular layout (see Six and Tollis, GD '99 and ALENEX '99, and Kaufmann and Wiese, GD '02.) The tool identifies biconnected components and draws the nodes of -the component on a circle. The block-cutpoint tree +the component on a circle. The block\(hycutpoint tree is then laid out using a recursive radial algorithm. Edge crossings within a circle are minimized by placing as many edges on the circle's perimeter as possible. In particular, if the component is outerplanar, the component will have a planar layout. .PP -If a node belongs to multiple non-trivial biconnected components, +If a node belongs to multiple non\(hytrivial biconnected components, the layout puts the node in one of them. By default, this is the first -non-trivial component found in the search from the root component. +non\(hytrivial component found in the search from the root component. .PP .I fdp draws undirected graphs using a ``spring'' model. It relies on a -force-directed approach in the spirit of Fruchterman and Reingold -(cf. Software-Practice & Experience 21(11), 1991, pp. 1129-1164). +force\(hydirected approach in the spirit of Fruchterman and Reingold +(cf. Software\(hyPractice & Experience 21(11), 1991, pp. 1129\(hy1164). .SH OUTPUT FORMATS Dot uses an extensible plugin mechanism for its output renderers, so to see what output formats your installation of dot supports -you can use ``dot -Txxx'' (where xxx is an unlikely format) +you can use ``dot \-Txxx'' (where xxx is an unlikely format) and check the warning message. Also, The plugin mechanism supports multiple implementations of the output formats. -To see what variants are available, use, for example: ``dot -Tpng:'' -and to force a particular variant, use, for example: ``dot -Tpng:gd'' +To see what variants are available, use, for example: ``dot \-Tpng:'' +and to force a particular variant, use, for example: ``dot \-Tpng:gd'' .P Traditionally, dot supports the following: -\fB-Tps\fP (PostScript), -\fB-Tsvg\fP \fB-Tsvgz\fP (Structured Vector Graphics), -\fB-Tfig\fP (XFIG graphics), -\fB-Tmif\fP (FrameMaker graphics), -\fB-Thpgl\fP (HP pen plotters), and \fB-Tpcl\fP (Laserjet printers), -\fB-Tpng\fP \fB-Tgif\fP (bitmap graphics), -\fB-Tdia\fP (GTK+ based diagrams), -\fB-Timap\fP (imagemap files for httpd servers for each node or edge -that has a non-null "href" attribute.), -\fB-Tcmapx\fP (client-side imagemap for use in html and xhtml). -Additional less common or more special-purpose output formats +\fB\-Tps\fP (PostScript), +\fB\-Tsvg\fP \fB\-Tsvgz\fP (Structured Vector Graphics), +\fB\-Tfig\fP (XFIG graphics), +\fB\-Tmif\fP (FrameMaker graphics), +\fB\-Thpgl\fP (HP pen plotters), and \fB\-Tpcl\fP (Laserjet printers), +\fB\-Tpng\fP \fB\-Tgif\fP (bitmap graphics), +\fB\-Tdia\fP (GTK+ based diagrams), +\fB\-Timap\fP (imagemap files for httpd servers for each node or edge +that has a non(hynull "href" attribute.), +\fB\-Tcmapx\fP (client\(hyside imagemap for use in html and xhtml). +Additional less common or more special\(hypurpose output formats can be found at http://www.graphviz.org/cvs/doc/info/output.html.) .SH GRAPH FILE LANGUAGE Here is a synopsis of the graph file language, traditionally using the extension \fB.dot\fR, for graphs: .PP -[\fBstrict\fR] (\fBgraph\fR|\fBdigraph\fR) \fIname\fP { \fIstatement-list\fP }\fR +[\fBstrict\fR] (\fBgraph\fR|\fBdigraph\fR) \fIname\fP { \fIstatement\(hylist\fP }\fR .br -Is the top level graph. If the graph is \fBstrict\fR then multiple edges are not allowed between the same pairs of nodes. If it is a directed graph, indicated by \fBdigraph\fR, then the \fIedgeop\fR must be "->". If it is an undirected \fBgraph\fR then the \fIedgeop\fR must be "--". +Is the top level graph. If the graph is \fBstrict\fR then multiple edges are +not allowed between the same pairs of nodes. +If it is a directed graph, indicated by \fBdigraph\fR, +then the \fIedgeop\fR must be "\->". If it is an undirected \fBgraph\fR +then the \fIedgeop\fR must be "\-\-". Statements may be: .PP \fIname\fB=\fIval\fB;\fR @@ -156,17 +160,17 @@ Creates edges between nodes \fBn0\fP, \fBn1\fP, ..., \fBnn\fP and sets their attributes according to the optional list. Creates nodes as necessary. .PP -[\fBsubgraph \fIname\fB] { \fIstatement-list \fB}\fR +[\fBsubgraph \fIname\fB] { \fIstatement\(hylist \fB}\fR .br Creates a subgraph. Subgraphs may be used in place of \fBn0\fP, ..., \fBnn\fP in the above statements to create edges. [\fBsubgraph \fIname\fR] is optional; if missing, the subgraph is assigned an internal name. .PP -Comments may be /*C-like*/ or //C++-like. +Comments may be /*C\(hylike*/ or //C++\(hylike. .PP -Attribute names and values are ordinary (C-style) strings. +Attribute names and values are ordinary (C\(hystyle) strings. The following sections describe attributes that control graph layout. .SH "GRAPH ATTRIBUTES" @@ -185,10 +189,10 @@ a floating point number, or one of the keywords \fBfill\fP, .PP \fBranksep=\fIf\fR sets the minimum separation between ranks. .PP -\fBordering=out\fR constrains order of out-edges in a subgraph +\fBordering=out\fR constrains order of out\(hyedges in a subgraph according to their file sequence. .PP -\fBrankdir=LR|RL|BT\fR requests a left-to-right, right-to-left, or bottom-to-top, drawing. +\fBrankdir=LR|RL|BT\fR requests a left\(hyto\(hyright, right\(hyto\(hyleft, or bottom\(hyto\(hytop, drawing. .PP \fBpagedir=\fR[TBLR][TBLR] sets the major and minor order of pagination. .PP @@ -200,7 +204,7 @@ a distinct rectangle of the layout. Clusters may be nested. \fBrotate=90\fR sets landscape mode. (\fBorientation=land\fR is backward compatible but obsolete.) .PP -\fBcenter=\fIn\fR a non-zero value centers the drawing on the page. +\fBcenter=\fIn\fR a non\(hyzero value centers the drawing on the page. .PP \fBnslimit=\fIf\fR or \fBmclimit=\fIf\fR adjusts the bound on the number of network simplex or mincross iterations by the given ratio. @@ -209,7 +213,7 @@ For example, \fBmclimit=2.0\fP runs twice as long. \fBlayers="\fIid:id:id:id\fR" is a sequence of layer identifiers for overlay diagrams. The PostScript array variable \fIlayercolorseq\fR sets the assignment of colors to layers. The least index is 1 and -each element must be a 3-element array to be interpreted as a color coordinate. +each element must be a 3\(hyelement array to be interpreted as a color coordinate. .PP \fBcolor=\fIcolorvalue\fR sets foreground color (\fBbgcolor\fP for background). .PP @@ -220,10 +224,10 @@ the base URL for all relative URLs, as recognized by Acrobat Distiller \fBURL=\fI"url"\fR ("URL" is a synonym for "href".) .PP \fBstylesheet=\fI"file.css"\fR includes a reference to a stylesheet -in -Tsvg and -Tsvgz outputs. Ignored by other formats. +in \-Tsvg and \-Tsvgz outputs. Ignored by other formats. .PP -\fB(neato-specific attributes)\fR +\fB(neato\(hyspecific attributes)\fR .br \fBstart=\fIval\fR. Requests random initial placement and seeds the random number generator. If \fIval\fP is not an integer, @@ -236,7 +240,7 @@ The default is 0.1. drawn as splines if nodes don't overlap. The default is \fIfalse\fR. .PP -\fB(twopi-specific attributes)\fR +\fB(twopi\(hyspecific attributes)\fR .br \fBroot=\fIctr\fR. This specifies the node to be used as the center of the layout. If not specified, \fItwopi\fP will randomly pick one of the @@ -262,7 +266,7 @@ edges are drawn as straight line segments connecting nodes. This is also the default style. .PP -\fB(circo-specific attributes)\fR +\fB(circo\(hyspecific attributes)\fR .br \fBroot=\fInodename\fR. Specifies the name of a node occurring in the root block. If the graph is disconnected, the \fBroot\fP node attribute @@ -278,7 +282,7 @@ edges are drawn as straight line segments connecting nodes. This is also the default style. .PP -\fB(fdp-specific attributes)\fR +\fB(fdp\(hyspecific attributes)\fR .br \fBK=\fIval\fR. Sets the default ideal node separation in the layout. @@ -289,7 +293,7 @@ layout the graph. \fBstart=\fIval\fR. Adjusts the random initial placement of nodes with no specified position. If \fIval\fP is is an integer, it is used as the seed for the random number generator. -If \fIval\fP is not an integer, a random system-generated integer, +If \fIval\fP is not an integer, a random system\(hygenerated integer, such as the process ID or current time, is used as the seed. .PP \fBsplines=\fIval\fR. If \fIval\fR is "true", edges are drawn @@ -344,7 +348,7 @@ The empty string means no layers (invisible). .PP The following attributes apply only to polygon shape nodes: .PP -\fBregular=\fIn\fR if \fIn\fR is non-zero then the polygon is made +\fBregular=\fIn\fR if \fIn\fR is non\(hyzero then the polygon is made regular, i.e. symmetric about the x and y axis, otherwise the polygon takes on the aspect ratio of the label. \fIbuiltin_polygons\fR that are not already regular are made regular @@ -368,13 +372,13 @@ This attribute is added to the initial orientation of \fIbuiltin_polygons.\fR .PP \fBdistortion=\fIf\fR sets the amount of broadening of the top and narrowing of the bottom of the polygon (relative to its orientation). -Floating point values between -1 and +1 are suggested. +Floating point values between \-1 and +1 are suggested. This attribute is ignored by \fIbuiltin_polygons\fR. .PP -\fBskew=\fIf\fR sets the amount of right-displacement of the top and -left-displacement of the bottom of the polygon (relative to its +\fBskew=\fIf\fR sets the amount of right\(hydisplacement of the top and +left\(hydisplacement of the bottom of the polygon (relative to its orientation). -Floating point values between -1 and +1 are suggested. +Floating point values between \-1 and +1 are suggested. This attribute is ignored by \fIbuiltin_polygons\fR. .PP \fBhref=\fI"url"\fR sets the url for the node in imagemap, PostScript and SVG @@ -384,7 +388,7 @@ for the node label attribute. .PP \fBURL=\fI"url"\fR ("URL" is a synonym for "href".) .PP -\fBtarget=\fI"target"\fR is a target string for client-side imagemaps +\fBtarget=\fI"target"\fR is a target string for client\(hyside imagemaps and SVG, effective when nodes have a URL. The target string is used to determine which window of the browser is used for the URL. Setting it to "_graphviz" will open a new window if it doesn't @@ -394,7 +398,7 @@ then no target attribute is included in the output. The substring '\\N' is substituted in the same manner as for the node label attribute. .PP -\fBtooltip=\fI"tooltip"\fR is a tooltip string for client-side imagemaps +\fBtooltip=\fI"tooltip"\fR is a tooltip string for client\(hyside imagemaps and SVG, effective when nodes have a URL. The tooltip string defaults to be the same as the label string, but this attribute permits nodes without labels to still have tooltips thus permitting denser graphs. @@ -402,13 +406,13 @@ The substring '\\N' is substituted in the same manner as for the node label attribute. .PP -\fB(circo-specific attributes)\fR +\fB(circo\(hyspecific attributes)\fR .br \fBroot=\fItrue/false\fR. This specifies that the block containing the given node be treated as the root of the spanning tree in the layout. .PP -\fB(fdp-specific attributes)\fR +\fB(fdp\(hyspecific attributes)\fR .br \fBpin=\fIval\fR. If \fIval\fR is "true", the node will remain at its initial position. @@ -426,8 +430,8 @@ edges are ignored for ordering nodes. \\\|n, \\\|l, or \\\|r for centered, left, or right justified lines. If the substring '\\T' is found in a label it will be replaced by the tail_node name. If the substring '\\H' is found in a label it will be replaced by the head_node name. -If the substring '\\E' value is found in a label it will be replaced by: tail_node_name->head_node_name -or by: tail_node_name--head_node_name for undirected graphs. +If the substring '\\E' value is found in a label it will be replaced by: tail_node_name\->head_node_name +or by: tail_node_name\-\-head_node_name for undirected graphs. .PP \fBfontsize=\fIn\fR sets the label type size to \fIn\fP points. .PP @@ -453,14 +457,14 @@ for the edge label attribute. .PP \fBURL=\fI"url"\fR ("URL" is a synonym for "href".) .PP -\fBtarget=\fI"target"\fR is a target string for client-side imagemaps +\fBtarget=\fI"target"\fR is a target string for client\(hyside imagemaps and SVG, effective when edges have a URL. If the target string is empty, the default, then no target attribute is included in the output. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as for the edge label attribute. .PP -\fBtooltip=\fI"tooltip"\fR is a tooltip string for client-side imagemaps +\fBtooltip=\fI"tooltip"\fR is a tooltip string for client\(hyside imagemaps effective when edges have a URL. The tooltip string defaults to be the same as the edge label string. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as @@ -484,7 +488,7 @@ for the edge label attribute. .PP \fBheadURL=\fI"url"\fR ("headURL" is a synonym for "headhref".) .PP -\fBheadtarget=\fI"headtarget"\fR is a target string for client-side imagemaps +\fBheadtarget=\fI"headtarget"\fR is a target string for client\(hyside imagemaps and SVG, effective when edge heads have a URL. The headtarget string is used to determine which window of the browser is used for the URL. If the headtarget string is empty, the default, @@ -492,7 +496,7 @@ then headtarget defaults to the same value as target for the edge. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as for the edge label attribute. .PP -\fBheadtooltip=\fI"tooltip"\fR is a tooltip string for client-side imagemaps +\fBheadtooltip=\fI"tooltip"\fR is a tooltip string for client\(hyside imagemaps effective when head ports have a URL. The tooltip string defaults to be the same as the headlabel string. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as @@ -504,7 +508,7 @@ for the edge label attribute. .PP \fBtailURL=\fI"url"\fR ("tailURL" is a synonym for "tailhref".) .PP -\fBtailtarget=\fI"tailtarget"\fR is a target string for client-side imagemaps +\fBtailtarget=\fI"tailtarget"\fR is a target string for client\(hyside imagemaps and SVG, effective when edge tails have a URL. The tailtarget string is used to determine which window of the browser is used for the URL. If the tailtarget string is empty, the default, @@ -512,7 +516,7 @@ then tailtarget defaults to the same value as target for the edge. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as for the edge label attribute. .PP -\fBtailtooltip=\fI"tooltip"\fR is a tooltip string for client-side imagemaps +\fBtailtooltip=\fI"tooltip"\fR is a tooltip string for client\(hyside imagemaps effective when tail ports have a URL. The tooltip string defaults to be the same as the taillabel string. The substrings '\\T', '\\H', and '\\E' are substituted in the same manner as @@ -532,7 +536,7 @@ same port, using the average landing point. The empty string means no layers (invisible). .PP -\fB(neato-specific attributes)\fR +\fB(neato\(hyspecific attributes)\fR .br \fBw=\fIf\fR sets the weight (spring constant) of an edge to the given floating point value. The default is 1.0; @@ -541,7 +545,7 @@ greater values make the edge tend more toward its optimal length. \fBlen=\fIf\fR sets the optimal length of an edge. The default is 1.0. .PP -\fB(fdp-specific attributes)\fR +\fB(fdp\(hyspecific attributes)\fR .br \fBweight=\fIf\fR sets the weight of an edge to the given floating point value. The default is 1.0; @@ -552,19 +556,19 @@ greater values make the edge tend more toward its optimal length. \fB\-N\fP sets a default node attribute. .br \fB\-E\fP sets a default edge attribute. -Example: \fB\-Gsize="7,8" -Nshape=box -Efontsize=8\fR +Example: \fB\-Gsize="7,8" \-Nshape=box \-Efontsize=8\fR .PP \fB\-l\fIfile\fR loads custom PostScript library files. Usually these define custom shapes or styles. -If \fB-l\fP is given by itself, the standard library is omitted. +If \fB\-l\fP is given by itself, the standard library is omitted. .PP \fB\-T\fIlang\fR sets the output language as described above. .PP -\fB-n\fR[\fB1\fR|\fB2\fR] (no-op) +\fB\-n\fR[\fB1\fR|\fB2\fR] (no\(hyop) If set, neato assumes nodes have already been positioned and all nodes have a pos attribute giving the positions. -It then performs an optional adjustment to remove node-node overlap, +It then performs an optional adjustment to remove node\(hynode overlap, depending on the value of the overlap attribute, computes the edge layouts, depending on the value of the \fBsplines\fR attribute, and emits the graph in the appropriate format. @@ -572,12 +576,12 @@ If num is supplied, the following actions occur: .nf num = 1 .fi -Equivalent to -n. +Equivalent to \-n. .nf num > 1 .fi Use node positions as specified, -with no adjustment to remove node-node overlaps, +with no adjustment to remove node\(hynode overlaps, and use any edge layouts already specified by the pos attribute. neato computes an edge layout for any edge that does not have a pos attribute. As usual, edge layout is guided by the \fBsplines\fR attribute. @@ -589,27 +593,27 @@ As usual, edge layout is guided by the \fBsplines\fR attribute. \fB\-?\fP prints the usage and exits. .SH "EXAMPLES" .nf -\f5digraph test123 { +digraph test123 { a \-> b \-> c; a \-> {x y}; b [shape=box]; c [label="hello\\\|nworld",color=blue,fontsize=24, - fontname="Palatino-Italic",fontcolor=red,style=filled]; + fontname="Palatino\-Italic",fontcolor=red,style=filled]; a \-> z [label="hi", weight=100]; - x \-> z [label="multi-line\\\|nlabel"]; + x \-> z [label="multi\-line\\\|nlabel"]; edge [style=dashed,color=red]; b \-> x; {rank=same; b x} -}\fP +} .fi .PP .nf -\f5graph test123 { +graph test123 { a \-\- b \-\- c; a \-\- {x y}; x \-\- c [w=10.0]; x \-\- y [w=5.0,len=3]; -}\fP +} .fi .SH "CAVEATS" Edge splines can overlap unintentionally. @@ -634,12 +638,12 @@ The bitmap driver (PNG, GIF etc) is by Thomas Boutell, \fB[\fI\fB]\fR", -where \fI\fP is "\fB->\fP" or "\fB--\fP" depending on +form "\fI\fB[\fI\fB]\fR", +where \fI\fP is "\fB\->\fP" or "\fB\-\-\fP" depending on whether the graph is directed or not. The bracket part \fB[\fI\fB]\fR -only appears if the edge has a non-trivial key. +only appears if the edge has a non\(hytrivial key. .TP \fBindegree\fR : \fBint\fR the indegree of a node. @@ -291,11 +291,11 @@ the number of edges in the graph the number of nodes in the graph .TP \fBdirected\fR : \fBint\fR -true (non-zero) if the graph is directed +true (non\(hyzero) if the graph is directed .TP \fBstrict\fR : \fBint\fR -true (non-zero) if the graph is strict -.SH "BUILT-IN FUNCTIONS" +true (non\(hyzero) if the graph is strict +.SH "BUILT\(hyIN FUNCTIONS" .PP The following functions are built into \fBgvpr\fP. Those functions returning references to graph objects return \fBNULL\fP in case of failure. @@ -304,9 +304,9 @@ returning references to graph objects return \fBNULL\fP in case of failure. \fBgraph\fP(\fIs\fP : \fBstring\fP, \fIt\fP : \fBstring\fP) : \fBgraph_t\fP creates a graph whose name is \fIs\fP and whose type is specified by the string \fIt\fP. Ignoring case, the characters -\f5U, D, S, N\fR have the interpretation undirected, directed, -strict, and non-strict, respectively. If \fIt\fP is empty, -a directed, non-strict graph is generated. +\fBU, D, S, N\fR have the interpretation undirected, directed, +strict, and non\(hystrict, respectively. If \fIt\fP is empty, +a directed, non\(hystrict graph is generated. .TP \fBsubg\fP(\fIg\fP : \fBgraph_t\fP, \fIs\fP : \fBstring\fP) : \fBgraph_t\fP creates a subgraph in graph \fIg\fP with name \fIs\fP. If the subgraph @@ -445,7 +445,7 @@ copies the attributes of object \fIsrc\fP to object \fItgt\fP, overwriting any attribute values \fItgt\fP may initially have. .TP \fBinduce\fP(\fIg\fP : \fBgraph_t\fP) : \fBvoid\fP -extends \fIg\fP to its node-induced subgraph extension in its root graph. +extends \fIg\fP to its node\(hyinduced subgraph extension in its root graph. .TP \fBaget\fP(\fIsrc\fP : \fBobj_t\fP, \fIname\fP : \fBstring\fP) : \fBstring\fP returns the value of attribute \fIname\fP in object \fIsrc\fP. This is @@ -455,7 +455,7 @@ Returns \fBNULL\fP on failure or if the attribute is not defined. .TP \fBaset\fP(\fIsrc\fP : \fBobj_t\fP, \fIname\fP : \fBstring\fP, \fIvalue\fP : \fBstring\fP) : \fBint\fP sets the value of attribute \fIname\fP in object \fIsrc\fP to \fIvalue\fP. -Returns 0 on success, non-zero on failure. See \fBaget\fP above. +Returns 0 on success, non\(hyzero on failure. See \fBaget\fP above. .TP \fBgetDflt\fP(\fIg\fP : \fBgraph_t\fP, \fIkind\fP : \fBstring\fP, \fIname\fP : \fBstring\fP) : \fBstring\fP returns the default value of attribute \fIname\fP in objects in \fIg\fP of @@ -468,7 +468,7 @@ sets the default value of attribute \fIname\fP to \fIvalue\fP in objects in \fIg\fP of the given \fIkind\fP. For nodes, edges, and graphs, \fIkind\fP should be "N", "E", and "G", respectively. -Returns 0 on success, non-zero on failure. See \fBsetDflt\fP above. +Returns 0 on success, non\(hyzero on failure. See \fBsetDflt\fP above. .TP \fBcompOf\fP(\fIg\fP : \fBgraph_t\fP, \fIn\fP : \fBnode_t\fP) : \fBgraph_t\fP returns the connected component of the graph \fIg\fP containing node \fIn\fP, @@ -529,12 +529,12 @@ returns the length of the string \fIs\fP. .TP \fBindex\fP(\fIs\fP : \fBstring\fP, \fIt\fP : \fBstring\fP) : \fBint\fP returns the index of the character in string \fIs\fP where the leftmost -copy of string \fIt\fP can be found, or -1 if \fIt\fP is not a +copy of string \fIt\fP can be found, or \-1 if \fIt\fP is not a substring of \fIs\fP. .TP \fBmatch\fP(\fIs\fP : \fBstring\fP, \fIp\fP : \fBstring\fP) : \fBint\fP returns the index of the character in string \fIs\fP where the leftmost -match of pattern \fIp\fP can be found, or -1 if no substring of \fIs\fP +match of pattern \fIp\fP can be found, or \-1 if no substring of \fIs\fP matches \fIp\fP. .TP \fBcanon\fP(\fIs\fP : \fBstring\fP) : \fBstring\fP @@ -611,7 +611,7 @@ opens the file \fIs\fP as an I/O stream. The string argument \fIt\fP specifies how the file is opened. The arguments are the same as for the C function .IR fopen (3). -It returns an integer denoting the stream, or -1 on error. +It returns an integer denoting the stream, or \-1 on error. .sp As usual, streams 0, 1 and 2 are already open as \fBstdin\fP, \fBstdout\fP, and \fBstderr\fP, respectively. Since \fBgvpr\fP may use \fBstdin\fP to @@ -647,7 +647,7 @@ returns the cosine of \fId\fP. returns the sine of \fId\fP. .TP \fBatan2\fP(\fIy\fP : \fBdouble\fP, \fIx\fP : \fBdouble\fP) : \fBdouble\fP -returns the arctangent of \fIy/x\fP in the range -pi to pi. +returns the arctangent of \fIy/x\fP in the range \-pi to pi. .SS "Miscellaneous" .TP \fBexit\fP() : \fBvoid\fP @@ -661,7 +661,7 @@ to exit with the exit code defaults to 0 if omitted. .TP \fBrand\fP() : \fBdouble\fP -returns a pseudo-random double between 0 and 1. +returns a pseudo\(hyrandom double between 0 and 1. .TP \fBsrand\fP() : \fBint\fP .TP @@ -670,10 +670,10 @@ sets a seed for the random number generator. The optional argument gives the seed; if it is omitted, the current time is used. The previous seed value is returned. \fBsrand\fP should be called before any calls to \fBrand\fP. -.SH "BUILT-IN VARIABLES" +.SH "BUILT\(hyIN VARIABLES" .PP .B gvpr -provides certain special, built-in variables, whose values are set +provides certain special, built\(hyin variables, whose values are set automatically by \fBgvpr\fP depending on the context. Except as noted, the user cannot modify their values. .TP @@ -691,7 +691,7 @@ in \fBBEGIN\fP or \fBEND\fP clauses. \fB$O\fP : \fBgraph_t\fP denotes the output graph. Before graph traversal, it is initialized to the target graph. After traversal and any \fBEND_G\fP actions, -if it refers to a non-empty graph, that graph is printed onto the output stream. +if it refers to a non\(hyempty graph, that graph is printed onto the output stream. It is only valid in \fBN\fP, \fBE\fP and \fBEND_G\fP clauses. The output graph may be set by the user. .TP @@ -701,7 +701,7 @@ and is available only in \fBN\fP, \fBE\fP and \fBEND_G\fP clauses. .TP \fB$tgtname\fP : \fBstring\fP denotes the name of the target graph. -By default, it is set to \f5"gvpr_result"\fP. +By default, it is set to \fB"gvpr_result"\fP. If used multiple times during the execution of .BR gvpr , the name will be appended with an integer. @@ -709,7 +709,7 @@ This variable may be set by the user. .TP \fB$tvroot\fP : \fBnode_t\fP indicates the starting node for a (directed or undirected) -depth-first traversal of the +depth\(hyfirst traversal of the graph (cf. \fB$tvtype\fP below). The default value is \fBNULL\fP for each input graph. .TP @@ -722,14 +722,14 @@ The meaning of these values is discussed below. .TP \fBARGC\fP : \fBint\fP denotes the number of arguments specified by the -\fB-a\fP \fIargs\fP command-line argument. +\fB\-a\fP \fIargs\fP command\(hyline argument. .TP \fBARGV\fP : \fBstring array\fP denotes the array of arguments specified by the -\fB-a\fP \fIargs\fP -command-line argument. The \fIi\fPth argument is given +\fB\-a\fP \fIargs\fP +command\(hyline argument. The \fIi\fPth argument is given by \fBARGV[\fIi\fP]\fR. -.SH "BUILT-IN CONSTANTS" +.SH "BUILT\(hyIN CONSTANTS" .PP There are several symbolic constants defined by \fBgvpr\fP. .TP @@ -749,7 +749,7 @@ a traversal which first visits all of the edges, then all of the nodes. .TP \fBTV_dfs\fR : \fItvtype_t\fR -a traversal of the graph using a depth-first search on the +a traversal of the graph using a depth\(hyfirst search on the underlying undirected graph. To do the traversal, \fBgvpr\fP will check the value of \fB$tvroot\fP. If this has the same value that it had previously @@ -761,11 +761,11 @@ if \fB$tvroot\fP is \fBNULL\fP, the traversal will stop. Note that using \fBTV_dfs\fP and \fB$tvroot\fP, it is possible to create an infinite loop. .TP \fBTV_fwd\fR : \fItvtype_t\fR -a traversal of the graph using a depth-first search on the +a traversal of the graph using a depth\(hyfirst search on the graph following only forward arcs. In .TP \fBTV_bfs\fR : \fItvtype_t\fR -a traversal of the graph using a bread-first search on the +a traversal of the graph using a bread\(hyfirst search on the graph ignoring edge directions. See the item on \fBTV_dfs\fR above for the role of \fB$tvroot\fP. .IR libagraph (3), @@ -774,7 +774,7 @@ used for this traversal. The choice of roots for the traversal is the same as described for \fBTV_dfs\fR above. .TP \fBTV_rev\fR : \fItvtype_t\fR -a traversal of the graph using a depth-first search on the +a traversal of the graph using a depth\(hyfirst search on the graph following only reverse arcs. In .IR libagraph (3), edges in undirected graphs are given an arbitrary direction, which is @@ -785,17 +785,17 @@ same as described for \fBTV_dfs\fR above. .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5gvpr -i 'N[color=="blue"]' file.dot\fP +\fBgvpr \-i 'N[color=="blue"]' file.dot\fP .fi .RE .DT .PP -Generate the node-induced subgraph of all nodes with color blue. +Generate the node\(hyinduced subgraph of all nodes with color blue. .PP .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5gvpr -c 'N[color=="blue"]{color = "red"}' file.dot\fP +\fBgvpr \-c 'N[color=="blue"]{color = "red"}' file.dot\fP .fi .RE .DT @@ -805,7 +805,7 @@ Make all blue nodes red. .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5BEGIN { int n, e; int tot_n = 0; int tot_e = 0; } +\fBBEGIN { int n, e; int tot_n = 0; int tot_e = 0; } BEG_G { n = nNodes($G); e = nEdges($G); @@ -823,7 +823,7 @@ Version of the program \fBgc\fP. .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5gvpr -c ""\fP +\fBgvpr \-c ""\fP .fi .RE .DT @@ -833,7 +833,7 @@ Equivalent to \fBnop\fP. .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5BEG_G { graph_t g = graph ("merge", "S"); } +\fBBEG_G { graph_t g = graph ("merge", "S"); } E { node_t h = clone(g,$.head); node_t t = clone(g,$.tail); @@ -851,7 +851,7 @@ of an edge indicates how many edges from the input graph the edge represents. .ta \w'\f(CWdelete array[expression]'u .RS .nf -\f5BEGIN {node_t n; int deg[]} +\fBBEGIN {node_t n; int deg[]} E{deg[head]++; deg[tail]++; } END_G { for (deg[n]) { @@ -866,8 +866,8 @@ Computes the degrees of nodes with edges. .SH ENVIRONMENT .TP .B GPRPATH -Colon-separated list of directories to be searched to find -the file specified by the -f option. +Colon\(hyseparated list of directories to be searched to find +the file specified by the \-f option. .SH BUGS When the program is given as a command line argument, the usual shell interpretation takes place, which may affect some of the -- 2.40.0