diff options
Diffstat (limited to 'doc/man/gnunet-revocation.1')
| -rw-r--r-- | doc/man/gnunet-revocation.1 | 38 |
1 files changed, 33 insertions, 5 deletions
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1 index 9043c286e..017b019fd 100644 --- a/doc/man/gnunet-revocation.1 +++ b/doc/man/gnunet-revocation.1 | |||
| @@ -9,21 +9,48 @@ gnunet\-revocation \- revoke private keys (of egos) in GNUnet | |||
| 9 | .br | 9 | .br |
| 10 | 10 | ||
| 11 | .SH DESCRIPTION | 11 | .SH DESCRIPTION |
| 12 | \fBgnunet\-revocation\fP can be used to verify if a key has been revoked, to create a revocation certificate for later revocation, to instantly revoke a key and to use a pre-generated revocation certificate to revoke a key. Upon successful revocation, all peers will be informed about the invalidity of the key. As this is an expensive operation, GNUnet requires the issuer of the revocation to perform an expensive proof-of-work computation before he will be allowed to perform the revocation. gnunet\-revocation will perform this computation. The computation can be performed ahead of time, with the resulting revocation certificate being stored in a file for later "instant" use. gnunet\-revocation also makes is possible to resume the pre-calculation of a revocation --- simply abort a running proof-of-work calculation with CTRL-C, and the existing revocation certificate file will contain the status of the computation. Note that performing a revocation proof-of-work is deliberately VERY expensive. Depending on your CPU, the calculation can take days or weeks. | 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 he 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. | ||
| 13 | 29 | ||
| 14 | .SH OPTIONS | 30 | .SH OPTIONS |
| 15 | .B | 31 | .B |
| 16 | .IP "\-t KEY, \-\-test=KEY" | 32 | .IP "\-t KEY, \-\-test=KEY" |
| 17 | Check if the given KEY (ASCII\-encoded public key required) has been revoked. | 33 | Check if the given KEY (ASCII\-encoded public key required) has been |
| 34 | revoked. | ||
| 18 | .B | 35 | .B |
| 19 | .IP "\-R NAME, \-\-revoke=NAME" | 36 | .IP "\-R NAME, \-\-revoke=NAME" |
| 20 | Calculate or perform revocation for the ego with the given NAME. | 37 | Calculate or perform revocation for the ego with the given NAME. |
| 21 | .B | 38 | .B |
| 22 | .IP "\-p, \-\-perform" | 39 | .IP "\-p, \-\-perform" |
| 23 | Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it). Must be supplied to actually perform the revocation. | 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. | ||
| 24 | .B | 43 | .B |
| 25 | .IP "\-f NAME, \-\-filename=NAME" | 44 | .IP "\-f NAME, \-\-filename=NAME" |
| 26 | Use NAME as the name of the file that is to contain the revocation certificate. Intermediate computation results will be stored here, as well as the final revocation certificate. When used together with \-p, this file will be inspected to see if it contains a valid certificate for instant revocation, in which case the revocation can be performed instantly. If the given file contains anything (a valid certificate, with or without the completed proof-of-work) there is no need to supply the "\-R" option or to still have the private key of the ego to perform the revocation. | 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. | ||
| 27 | .B | 54 | .B |
| 28 | .IP "\-c FILENAME, \-\-config=FILENAME" | 55 | .IP "\-c FILENAME, \-\-config=FILENAME" |
| 29 | Use the configuration file FILENAME. | 56 | Use the configuration file FILENAME. |
| @@ -32,7 +59,8 @@ Use the configuration file FILENAME. | |||
| 32 | Print short help on options. | 59 | Print short help on options. |
| 33 | .B | 60 | .B |
| 34 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 61 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
| 35 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 62 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
| 63 | ERROR. | ||
| 36 | .B | 64 | .B |
| 37 | .IP "\-v, \-\-version" | 65 | .IP "\-v, \-\-version" |
| 38 | Print GNUnet version number. | 66 | Print GNUnet version number. |