[GNUnet-SVN] r29908 - gnunet/doc/man

[gnunet]

Author: grothoff
Date: 2013-10-06 23:13:54 +0200 (Sun, 06 Oct 2013)
New Revision: 29908

Added:
   gnunet/doc/man/gnunet-revocation.1
Removed:
   gnunet/doc/man/gnunet-rsa.1
Modified:
   gnunet/doc/man/Makefile.am
Log:
-adding man page for revocation, removing obsolte man page for RSA

Modified: gnunet/doc/man/Makefile.am
===================================================================
--- gnunet/doc/man/Makefile.am  2013-10-06 21:05:14 UTC (rev 29907)
+++ gnunet/doc/man/Makefile.am  2013-10-06 21:13:54 UTC (rev 29908)
@@ -21,7 +21,7 @@
   gnunet-nat-server.1 \
   gnunet-peerinfo.1 \
   gnunet-publish.1 \
-  gnunet-rsa.1 \
+  gnunet-revocation.1 \
   gnunet-scalarproduct.1 \
   gnunet-search.1 \
   gnunet-statistics.1 \

Added: gnunet/doc/man/gnunet-revocation.1
===================================================================
--- gnunet/doc/man/gnunet-revocation.1                          (rev 0)
+++ gnunet/doc/man/gnunet-revocation.1  2013-10-06 21:13:54 UTC (rev 29908)
@@ -0,0 +1,43 @@
+.TH GNUNET\-REVOCATION 1 "Mar 15, 2012" "GNUnet"
+
+.SH NAME
+gnunet\-revocation \- revoke private keys (of egos) in GNUnet
+
+.SH SYNOPSIS
+.B gnunet\-revocation
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\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 delibe
 rately V
 ERY expensive.  Depending on your CPU, the calculation can take days or weeks.
+
+.SH OPTIONS
+.B
+.IP "\-t KEY, \-\-test=KEY"
+Check if the given KEY (ASCII\-encoded public key required) has been revoked.
+.B
+.IP "\-R NAME, \-\-revoke=NAME"
+Calculate or perform revocation for the ego with the given NAME.
+.B
+.IP "\-p, \-\-perform"
+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.
+.B
+.IP "\-f NAME, \-\-filename=NAME"
+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.
+.B
+.IP "\-c FILENAME,  \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
+.B
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
+

Deleted: gnunet/doc/man/gnunet-rsa.1
===================================================================
--- gnunet/doc/man/gnunet-rsa.1 2013-10-06 21:05:14 UTC (rev 29907)
+++ gnunet/doc/man/gnunet-rsa.1 2013-10-06 21:13:54 UTC (rev 29908)
@@ -1,43 +0,0 @@
-.TH GNUNET\-RSA 1 "Mar 15, 2012" "GNUnet"
-
-.SH NAME
-gnunet\-rsa \- manipulate GNUnet RSA key files
-
-.SH SYNOPSIS
-.B gnunet\-rsa
-.RI [ options ] FILENAME
-.br
-
-.SH DESCRIPTION
-\fBgnunet\-rsa\fP can be used to create an RSA private key and to print the 
corresponding public key.  You must specify a filename containing an RSA 
private key in GNUnet format as an argument.  If the file does not exist, 
gnunet\-rsa will create a key.  This may then take a while.  If the option \-p 
is given, the corresponding public key will be printed to the console.
-
-.SH OPTIONS
-.B
-.IP "\-g COUNT, \-\-generate-keys=COUNT"
-Create COUNT public-private key pairs and write them to FILENAME.  Used for 
creating a file for testing.
-.B
-.IP "\-p, \-\-print-public-key"
-Print the corresponding public key to stdout.
-.B
-.IP "\-P, \-\-print-peer-identity"
-Print the corresponding peer identity (hash of the public key) to stdout.  
This hash is used for the name of peers.
-.B
-.IP "\-s, \-\-print-short-identity"
-Print the corresponding short hash (256-bit hash of the public key) to stdout. 
 This hash is used for names in the zkey zone.
-.B
-.IP "\-c FILENAME,  \-\-config=FILENAME"
-Use the configuration file FILENAME.
-.B
-.IP "\-h, \-\-help"
-Print short help on options.
-.B
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
-.B
-.IP "\-v, \-\-version"
-Print GNUnet version number.
-
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
-