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 > output-file.png
  22 .br
  23 .SH DESCRIPTION
  24 This manual page documents briefly the
  25 .B springgraph
  26 command.
  27 This manual page was written for the Debian distribution
  28 because the original program does not have a manual page.
  29 .PP
  30 Springgraph will read in a .dot file description of a graph, which,
  31 for each node, specifies its name and which other nodes it is
  32 connected to, and then renders a graph. The output is a PNG
  33 file. Each node is drawn as an
  34 ellipse, and each connection is drawn as an arrow. The node placement
  35 is a result of all of the nodes moving away from each other, while all
  36 nodes which are connected move toward each other. This movement is
  37 repeated until it stabilizes.
  38
  39 Springgraph was written as an alternative to neato, which is part of
  40 graphviz. It attempts to read the same .dot files used by graphviz,
  41 but currently only supports a limited number of node attributes (label
  42 and fillcolor) and can only handle two nodes per edge definition ("node1 ->
  43 node2", not "node1 -> node2 -> node3").
  44 .SH OPTIONS
  45 \fIspringgraph\fP
  46 accepts the following options:
  47 .TP 16
  48 .B \-p
  49 Create a file that can be rendered with POV-Ray
  50 .TP 16
  51 .B \-v
  52 create a VRML file
  53 .TP 16
  54 .B \-s
  55 this option specifies the scale. All of the node locations
  56 are multiplied by this. Increase the scale to eliminate node
  57 overlaps. Decrease the scale to make the graph smaller.
  58 .TP 16
  59 .B \-t
  60 make the background of the resulting image transparent.
  61 .TP 16
  62 .B \-b
  63 set background color of image, specify it in the form RRGGBB,
  64 in hex digits, e.g. FFFFFF is white, 000000 is black, FF0000
  65 is red, ...
  66 .TP 16
  67 .B \-l
  68 set the line color, same format as the background color
  69 .TP 16
  70 .B \-h
  71 display usage synopsis
  72 .SH EXAMPLE
  73  digraph {
  74   "rene" -> "myon";
  75   "mvo" -> "rene";
  76  }
  77 .SH SEE ALSO
  78 neato(1)
  79 sig2dot(1)
  80 http://www.graphviz.org/Documentation.php
  81 http://www.graphviz.org/cvs/doc/info/lang.html
  82 .SH AUTHOR
  83 This manual page was written by Kevin M. Rosenberg <kmr@debian.org>,
  84 for the Debian GNU/Linux system (but may be used by others).