git.guelker.eu siggraph / master README
master

Tree @master (Download .tar.gz)

README @masterraw · history · blame

siggraph
========

siggraph is a small Ruby program that formats your GnuPG web of trust
as a Graphviz file, which you can then use as input to a tool like
twopi(1) that will draw it as a nice graph.

The basic usage is simple. Invoke the program with the ID of the key
that you want to use as the start point (centre) of the web of of
trust graph, and redirect the output to a file or directly pipe it
into one of the Graphviz tools:

    $ siggraph 1111111 > wot.dot
    $ siggraph 1111111 | twopi -Tpdf -o wot.pdf

The program supports a few options that change the graph’ſ
appearence. Invoke it with the “-h” option to get a list with
explanations.

siggraph depends only on GnuPG and the Ruby interpreter itself, no
further requirements must be met on this side. If you want to run it
on a non-POSIX platform, you’ll probably need to supply the “-g”
option, because by default it tries to redirect GnuPG’s error stream
to /dev/null otherwise.

Note that officially supported is only GnuPG version 2. The old
version 1.42 may or may not work. The gpg(1) binary must be in your
PATH for this program to work properly.

If your web of trust is large, siggraph will take some time to
generate the Graphviz file, but it should output a well-formatted
script nevertheless. Still, Graphviz may not be able to handle it; I
got twopi(1) to crash with a rather small web of trust already when I
selected PNG output. This however is not siggraph’s domain; you’ll
need to complain to the Graphviz developers for that. In the meantime,
you can try outputting the graph in another format than PNG (PDF and
SVG are nice ones), or with another tool (dot(1) seems to be more
reliable than twopi(1) for example, but the graph doesn’t look as
nice).

Links
-----

The project is hosted at <http://devel.guelkerdev.de/projects/siggraph>.
Please report any bugs you find to m-guelker@guelkerdev.de or file a
bug report at the tracker, which is available online at
<http://devel.guelkerdev.de/projects/siggraph/issues>.

License
-------

siggraph -- Format your web of trust as a Graphviz file.
Copyright © 2015 Marvin Gülker

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.