Add a changelog
[pgp-tools.git] / sig2dot / sig2dot.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 SIG2DOT 1 "May 31, 2006"
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 sig2dot \- creates a .dot file from a GPG signature listing
20 .SH SYNOPSIS
21 .B sig2dot [OPTIONS] < input-file > output-file
22 .br
23 .SH DESCRIPTION
24 This manual page documents briefly the
25 .B sig2dot
26 command.
27 Sig2dot parses the output of "gpg \-\-list\-sigs" and produces a .dot file
28 that can be used as input to a graphing program.
29 .SH OPTIONS
30 \fIsig2dot\fP
31 accepts the following options:
32 .TP 16
33 .B \-b
34 Black and white / do not colorize.
35 .TP 16
36 .B \-d <date>
37 Render graph as it appeared on <date> (ignores more recent
38 signatures). Date must be in the format "YYYY\-MM\-DD".
39 Will also ignore keys that have since been revoked.
40 .TP 16
41 .B \-s <html-file-name>
42 Produces a sory HTML statistics file with the number of signatures per node.
43 .TP 16
44 .B \-a
45 Graph all keys, even if they do not have a signature
46 .TP 16
47 .B \-r "<key-revoked-string>"
48 Sets the text for the key-revoked string used by GnuPG. The default is
49 what is used in the English version. This parameter can be set for versions
50 of GnuPG localized to other languages. Default: "[revoked".
51 .TP 16
52 .TP 16
53 .B \-t "<title>"
54 Sets the title for the graph generated. Default: "Keyring Statistics".
55 .TP 16
56 .B \-u "<user-not-found-string>"
57 Sets the text for the user-not-found string used by GnuPG. The default is
58 what is used in the English version. This parameter can be set for versions
59 of GnuPG localized to other languages. Default: "[user id not found]".
60 .TP 16
61 .B \-q
62 Be quiet.
63 .TP 16
64 .B \-h
65 Print help and exit.
66 .TP 16
67 .B \-v
68 Print version and exit.
69 .SH EXAMPLE
70 gpg \-\-list\-sigs | sig2dot > sigs.dot
71 .sp 0
72 springgraph < sigs.dot > sigs.png
73 .SH SEE ALSO
74 .B springgraph(1)
75 .B gnupg(1)
76 .SH AUTHORS
77 Darxus@ChaosReigns.com with modifications by Kevin Rosenberg.
78 Versions 0.35 and later are by Christoph Berg <cb@df7cb.de>.
79 This manual page was written by Kevin M. Rosenberg <kmr@debian.org>,
80 for the Debian GNU/Linux system (but may be used by others).