springgraph/springgraph.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH SPRINGGRAPH 1 "September 5, 2005"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 springgraph \- renders a graph from a .dot file
  20 .SH SYNOPSIS
  21 .B springgraph [OPTIONS] < input-file.dot > output-file.png
  22 .br
  23 .SH DESCRIPTION
  24 Springgraph will read in a .dot file description of a graph, which,
  25 for each node, specifies its name and which other nodes it is
  26 connected to, and then renders a graph. The output is a PNG
  27 file. Each node is drawn as an
  28 ellipse, and each connection is drawn as an arrow. The node placement
  29 is a result of all of the nodes moving away from each other, while all
  30 nodes which are connected move toward each other. This movement is
  31 repeated until it stabilizes.
  32
  33 Springgraph was written as an alternative to neato, which is part of
  34 graphviz. It attempts to read the same .dot files used by graphviz,
  35 but currently only supports a limited number of node attributes (label
  36 and fillcolor) and can only handle two nodes per edge definition ("node1 ->
  37 node2", not "node1 -> node2 -> node3").
  38 .SH OPTIONS
  39 \fIspringgraph\fP
  40 accepts the following options:
  41 .TP 16
  42 .B \-p
  43 Create a file that can be rendered with POV-Ray
  44 .TP 16
  45 .B \-v
  46 create a VRML file
  47 .TP 16
  48 .B \-s
  49 this option specifies the scale. All of the node locations
  50 are multiplied by this. Increase the scale to eliminate node
  51 overlaps. Decrease the scale to make the graph smaller.
  52 .TP 16
  53 .B \-t
  54 make the background of the resulting image transparent.
  55 .TP 16
  56 .B \-b
  57 set background color of image, specify it in the form RRGGBB,
  58 in hex digits, e.g. FFFFFF is white, 000000 is black, FF0000
  59 is red, ...
  60 .TP 16
  61 .B \-l
  62 set the line color, same format as the background color
  63 .TP 16
  64 .B \-h
  65 display usage synopsis
  66 .SH EXAMPLE
  67  digraph {
  68   "rene" -> "myon";
  69   "mvo" -> "rene";
  70  }
  71 .SH SEE ALSO
  72 neato(1)
  73 sig2dot(1)
  74 http://www.graphviz.org/Documentation.php
  75 http://www.graphviz.org/cvs/doc/info/lang.html
  76 .SH AUTHOR
  77 This manual page was written by Kevin M. Rosenberg <kmr@debian.org>,
  78 for the Debian GNU/Linux system (but may be used by others).