adjust mantis url
[oweals/gnunet.git] / doc / man / gnunet-revocation.1
1 .TH GNUNET\-REVOCATION 1 "March 15, 2012" "GNUnet"
2
3 .SH NAME
4 gnunet\-revocation \- revoke private keys (of egos) in GNUnet
5
6 .SH SYNOPSIS
7 .B gnunet\-revocation
8 .RI [ options ]
9 .br
10
11 .SH DESCRIPTION
12 \fBgnunet\-revocation\fP can be used to verify if a key has been
13 revoked, to create a revocation certificate for later revocation, to
14 instantly revoke a key and to use a pre-generated revocation
15 certificate to revoke a key.  Upon successful revocation, all peers
16 will be informed about the invalidity of the key.  As this is an
17 expensive operation, GNUnet requires the issuer of the revocation to
18 perform an expensive proof-of-work computation before they will be
19 allowed to perform the revocation.  gnunet\-revocation will perform
20 this computation.  The computation can be performed ahead of time,
21 with the resulting revocation certificate being stored in a file for
22 later "instant" use.  gnunet\-revocation also makes is possible to
23 resume the pre-calculation of a revocation --- simply abort a running
24 proof-of-work calculation with CTRL-C, and the existing revocation
25 certificate file will contain the status of the computation.  Note
26 that performing a revocation proof-of-work is deliberately VERY
27 expensive.  Depending on your CPU, the calculation can take days or
28 weeks.
29
30 .SH OPTIONS
31 .B
32 .IP "\-t KEY, \-\-test=KEY"
33 Check if the given KEY (ASCII\-encoded public key required) has been
34 revoked.
35 .B
36 .IP "\-R NAME, \-\-revoke=NAME"
37 Calculate or perform revocation for the ego with the given NAME.
38 .B
39 .IP "\-p, \-\-perform"
40 Actually perform the revocation as soon as possible (do not just
41 generate a revocation certificate, use it).  Must be supplied to
42 actually perform the revocation.
43 .B
44 .IP "\-f NAME, \-\-filename=NAME"
45 Use NAME as the name of the file that is to contain the revocation
46 certificate.  Intermediate computation results will be stored here, as
47 well as the final revocation certificate.  When used together with
48 \-p, this file will be inspected to see if it contains a valid
49 certificate for instant revocation, in which case the revocation can
50 be performed instantly.  If the given file contains anything (a valid
51 certificate, with or without the completed proof-of-work) there is no
52 need to supply the "\-R" option or to still have the private key of
53 the ego to perform the revocation.
54 .B
55 .IP "\-c FILENAME,  \-\-config=FILENAME"
56 Use the configuration file FILENAME.
57 .B
58 .IP "\-h, \-\-help"
59 Print short help on options.
60 .B
61 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
62 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
63 ERROR.
64 .B
65 .IP "\-v, \-\-version"
66 Print GNUnet version number.
67
68
69 .SH BUGS
70 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>
71 .SH "SEE ALSO"
72 The full documentation for
73 .B gnunet
74 is maintained as a Texinfo manual.  If the
75 .B info
76 and
77 .B gnunet
78 programs are properly installed at your site, the command
79 .IP
80 .B info gnunet
81 .PP
82 should give you access to the complete handbook,
83 .IP
84 .B info gnunet-c-tutorial
85 .PP
86 will give you access to a tutorial for developers.
87 .PP
88 Depending on your installation, this information is also
89 available in
90 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).