patchwork


SYNOPSIS
       patchwork  [-(G|N|E)name=value]  [-Tlang]  [-llibfile] [-ooutfile] [-O]
       [-P] [-v] [-V] [files]

DESCRIPTION
       patchwork draws clustered graphs using a squarified treemap layout.  As
       input,  it  takes any graph in the dot format. Each cluster is given an
       area based on the areas specified by the clusters  and  nodes  it  con-
       tains.  The  areas  of nodes and empty clusters can be specified by the
       area attribute.  The default value is 1.

       The root graph is laid out as a square. Then, recursively,  the  region
       of  a  cluster  or  graph  is partitioned among its top-level nodes and
       clusters, with each given a roughly square subregion with its specified
       area.

OUTPUT FORMATS
       Patchwork uses an extensible plugin mechanism for its output renderers,
       so to see what output formats your installation of  patchwork  supports
       you  can  use ``patchwork -Txxx'' (where xxx is an unlikely format) and
       check the warning message.  Also, The plugin mechanism supports  multi-
       ple  implementations  of  the output formats.  To see what variants are
       available, use, for example: ``patchwork -Tpng:'' and to force  a  par-
       ticular variant, use, for example: ``patchwork -Tpng:gd''

       Traditionally,  patchwork  supports  the  following: -Tps (PostScript),
       -Tsvg -Tsvgz (Structured Vector Graphics), -Tfig (XFIG graphics), -Tmif
       (FrameMaker  graphics),  -Thpgl  (HP pen plotters), and -Tpcl (Laserjet
       printers), -Tpng -Tgif (bitmap graphics), -Tdia (GTK+ based  diagrams),
       -Timap (imagemap files for httpd servers for each node or edge that has
       a non-null "href" attribute.), -Tcmapx (client-side imagemap for use in
       html and xhtml).  Additional less common or more special-purpose output
       formats  can  be  found  at   http://www.graphviz.org/cvs/doc/info/out-
       put.html.)

       Alternative  plugins providing support for a given output format can be
       found from the error message resulting from appending a ':' to the for-
       mat. e.g. -Tpng: The first plugin listed is always the default.

GRAPH FILE LANGUAGE
       Here  is  a  synopsis  of  the  graph file language, normally using the
       extension .gv, for graphs:

       [strict] (graph|digraph) name { statement-list }
       Is the top level graph. If the graph is strict then multiple edges  are
       not  allowed  between  the  same  pairs  of nodes.  If it is a directed
       graph, indicated by digraph, then the edgeop must be "->". If it is  an
       undirected graph then the edgeop must be "--".  Statements may be:

       name=val;
       node [name=val];
       edge [name=val];
       Set  default graph, node, or edge attribute name to val.  Any subgraph,
       missing, the subgraph is assigned an internal name.

       Comments may be /*C-like*/ or //C++-like.


       Attribute names and values are ordinary (C-style) strings.  The follow-
       ing sections describe attributes that control graph layout.


GRAPH ATTRIBUTES
       size="x,y" sets bounding box of drawing in inches.

       page="x,y" sets the PostScript pagination unit.

       ratio=f  sets  the aspect ratio to f which may be a floating point num-
       ber, or one of the keywords fill, compress, or auto.

       pagedir=[TBLR][TBLR] sets the major and minor order of pagination.

       rotate=90 sets landscape mode.  (orientation=land is backward  compati-
       ble but obsolete.)

       center=n a non-zero value centers the drawing on the page.

       layers="id:id:id:id"  is  a  sequence  of layer identifiers for overlay
       diagrams.  The PostScript array variable layercolorseq sets the assign-
       ment 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.

       color=colorvalue sets foreground color (bgcolor for background).

       href="url" the default url for image map files;  in  PostScript  files,
       the  base URL for all relative URLs, as recognized by Acrobat Distiller
       3.0 and up.

       URL="url" ("URL" is a synonym for "href".)

       stylesheet="file.css" includes a reference to a stylesheet in -Tsvg and
       -Tsvgz outputs.  Ignored by other formats.

       splines.  If  set to true, edges are drawn as splines.  If set to poly-
       line, edges are drawn as polylines.  If set to ortho, edges  are  drawn
       as  orthogonal  polylines.   In  all  of these cases, the nodes may not
       overlap.  If splines=false or splines=line, edges  are  drawn  as  line
       segments.  The default is false.


NODE ATTRIBUTES
       height=d  or  width=d  sets  minimum  height  or  width.  Adding fixed-
       size=true forces these to be the actual size (text labels are ignored).

       shape=record polygon epsf builtin_polygon
       builtin_polygon is one of: plaintext ellipse oval circle  egg  triangle
       box  diamond  trapezium  parallelogram  house  hexagon octagon note tab
       fontsize=n sets the label type size to n points.

       fontname=name sets the label font family name.

       color=colorvalue sets the outline color, and the default fill color  if
       style=filled and fillcolor is not specified.

       fillcolor=colorvalue  sets  the  fill  color when style=filled.  If not
       specified, the fillcolor when style=filled defaults to be the  same  as
       the outline color.

       fontcolor=colorvalue sets the label text color.

       A  colorvalue  may  be  "h,s,v"  (hue, saturation, brightness) floating
       point numbers between 0 and 1, or an X11 color name such as white black
       red  green  blue yellow magenta cyan or burlywood, or a "#rrggbb" (red,
       green, blue, 2 hex characters each) value.

       style=filled solid dashed dotted bold invis or any Postscript code.

       layer=id or id:id or "all" sets the node's active  layers.   The  empty
       string means no layers (invisible).

       The following attributes apply only to polygon shape nodes:

       regular=n  if n is non-zero then the polygon is made regular, i.e. sym-
       metric about the x and y axis,  otherwise  the  polygon  takes  on  the
       aspect ratio of the label.  builtin_polygons that are not already regu-
       lar are made regular by  this  attribute.   builtin_polygons  that  are
       already  regular  are  not affected (i.e.  they cannot be made asymmet-
       ric).

       peripheries=n sets the number of periphery lines drawn around the poly-
       gon.    This   value  supersedes  the  number  of  periphery  lines  of
       builtin_polygons.

       sides=n sets the number of sides to the  polygon.  n<3  results  in  an
       ellipse.  This attribute is ignored by builtin_polygons.

       orientation=f  sets  the  orientation  of the first apex of the polygon
       counterclockwise from the vertical, in degrees.  f may  be  a  floating
       point  number.   The  orientation  of  labels  is  not affected by this
       attribute.  This attribute is  added  to  the  initial  orientation  of
       builtin_polygons.

       distortion=f  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.  This attribute is
       ignored by builtin_polygons.

       skew=f sets the amount of right-displacement of the top  and  left-dis-
       placement  of  the bottom of the polygon (relative to its orientation).
       Floating point values between -1 and +1 are suggested.  This  attribute
       is ignored by builtin_polygons.
       use it if it does.  If the target string is empty, the default, then no
       target  attribute  is  included in the output.  The substrings '\N' and
       '\G' are  substituted  in  the  same  manner  as  for  the  node  label
       attribute.   Additionally  the  substring  '\L' is substituted with the
       node label string.

       tooltip="tooltip" is a tooltip string  for  client-side  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 with-
       out  labels  to still have tooltips thus permitting denser graphs.  The
       substrings '\N' and '\G' are substituted in the same manner as for  the
       node  label  attribute.  Additionally the substring '\L' is substituted
       with the node label string.



EDGE ATTRIBUTES
       label=text where text may include escaped newlines \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  If the substring '\G' is
       found in a label it will  be  replaced  by  the  graph  name.   or  by:
       tail_node_name--head_node_name for undirected graphs.

       fontsize=n sets the label type size to n points.

       fontname=name sets the label font family name.

       fontcolor=colorvalue sets the label text color.

       style=solid dashed dotted bold invis

       color=colorvalue sets the line color for edges.

       color=colorvaluelist  a ':' separated list of colorvalue creates paral-
       lel edges, one edge for each color.

       dir=forward back both none controls arrow direction.

       tailclip,headclip=false disables endpoint shape clipping.

       href="url" sets the url for the node in imagemap,  PostScript  and  SVG
       files.  The substrings '\T', '\H', '\E' and '\G' are substituted in the
       same manner as for the edge label  attribute.   Additionally  the  sub-
       string '\L' is substituted with the edge label string.

       URL="url" ("URL" is a synonym for "href".)

       target="target"  is  a target string for client-side 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 sub-
       strings '\T', '\H', '\E' and '\G' are substituted in the same manner as
       arrowsize                                 (norm_length=10,norm_width=5,
       inv_length=6,inv_width=7,dot_radius=2)

       headlabel,taillabel=string for port labels.   labelfontcolor,labelfont-
       name,labelfontsize  for  head  and  tail  labels.  The substrings '\T',
       '\H', '\E' and '\G' are substituted in the same manner as for the  edge
       label  attribute.   Additionally the substring '\L' is substituted with
       the edge label string.

       headhref="url" sets the url for the head port in  imagemap,  PostScript
       and  SVG  files.   The substrings '\T', '\H', '\E' and '\G' are substi-
       tuted in the same manner as for the edge label attribute.  Additionally
       the substring '\L' is substituted with the edge label string.

       headURL="url" ("headURL" is a synonym for "headhref".)

       headtarget="headtarget"  is  a  target string for client-side 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,  then  headtarget
       defaults  to  the  same  value  as target for the edge.  The substrings
       '\T', '\H', '\E' and '\G' are substituted in the same manner as for the
       edge  label  attribute.  Additionally the substring '\L' is substituted
       with the edge label string.

       headtooltip="tooltip" is a tooltip  string  for  client-side  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  for  the  edge label
       attribute.  Additionally the substring '\L'  is  substituted  with  the
       edge label string.

       tailhref="url"  sets  the url for the tail port in imagemap, PostScript
       and SVG files.  The substrings '\T', '\H', '\E' and  '\G'  are  substi-
       tuted in the same manner as for the edge label attribute.  Additionally
       the substring '\L' is substituted with the edge label string.

       tailURL="url" ("tailURL" is a synonym for "tailhref".)

       tailtarget="tailtarget" is a target string  for  client-side  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,  then tailtarget
       defaults to the same value as target  for  the  edge.   The  substrings
       '\T', '\H', '\E' and '\G' are substituted in the same manner as for the
       edge label attribute.  Additionally the substring '\L'  is  substituted
       with the edge label string.

       tailtooltip="tooltip"  is  a  tooltip  string for client-side imagemaps
       effective when tail ports have a URL.  The tooltip string  defaults  to
       be  the  same as the taillabel string.  The substrings '\T', '\H', '\E'
       and '\G' are substituted in the same  manner  as  for  the  edge  label
       attribute.   Additionally  the  substring  '\L' is substituted with the
       edge label string.

       (neato-specific attributes)
       w=f  sets the weight (spring constant) of an edge to the given floating
       point value.  The default is 1.0; greater values  make  the  edge  tend
       more toward its optimal length.

       len=f sets the optimal length of an edge.  The default is 1.0.

COMMAND LINE OPTIONS
       -G sets a default graph attribute.
       -N sets a default node attribute.
       -E  sets  a  default edge attribute.  Example: -Gsize="7,8" -Nshape=box
       -Efontsize=8

       -lfile loads custom PostScript library  files.   Usually  these  define
       custom  shapes  or  styles.   If  -l  is  given by itself, the standard
       library is omitted.

       -Tlang sets the output language as described above.

       -O automatically generate output filenames based on the input  filename
       and the -T format.

       -v (verbose) prints various information useful for debugging.

       -V (version) prints version information and exits.

       -? prints the usage and exits.

EXAMPLES
       graph G {
         node[style=filled]
         subgraph cluster0 {
           subgraph cluster0_0 {
             style=filled
             fillcolor=green
             a b[area=3 fillcolor=yellow]
           }
           subgraph cluster0_1 {
              area=2
              bgcolor=yellow
           }
           c [style=filled
             fillcolor=red ]
         }
         subgraph cluster1 {
           e f
         }
       }

BUGS
       At  present,  patchwork  ignores edges, and supplies no visual clues to
       indicate nesting.  Such clues might consist of nested boxes or  thicker
       rectangular  outlines.  In  addition,  it would be good if some cluster
       on-line  reference pages. Most of these documents are also available in
       the doc and doc/info subtrees in the source and binary distributions.

       dot(1)

       M. Bruls, K. Huizing and J.  van  Wijk,  "Squarified  Treemaps",  Proc.
       Eurographics and IEEE TVCG Symposium on Visualization, 1999, pp. 33-42.



                                 22 April 2011                    PATCHWORK(1)
Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2017 Hurricane Electric. All Rights Reserved.