1 files changed, 91 insertions, 76 deletions
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1
index 6fae373e7..24780ac0b 100644
--- a/doc/man/gnunet-revocation.1
+++ b/doc/man/gnunet-revocation.1
@@ -1,82 +1,97 @@
-.TH GNUNET\-REVOCATION 1 "March 15, 2012" "GNUnet"
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
-.SH NAME
+.\"
-gnunet\-revocation \- revoke private keys (of egos) in GNUnet
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
-.SH SYNOPSIS
+.\" any later version published by the Free Software Foundation; with no
-.B gnunet\-revocation
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
-.RI [ options ]
+.\" copy of the license is included in the file
-.br
+.\" ``FDL-1.3''.
+.\"
-.SH DESCRIPTION
+.\" A copy of the license is also available from the Free Software
-\fBgnunet\-revocation\fP can be used to verify if a key has been
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
-revoked, to create a revocation certificate for later revocation, to
+.\"
-instantly revoke a key and to use a pre-generated revocation
+.\" Alternately, this document is also available under the General
-certificate to revoke a key.  Upon successful revocation, all peers
+.\" Public License, version 3 or later, as published by the Free Software
-will be informed about the invalidity of the key.  As this is an
+.\" Foundation.  A copy of the license is included in the file
-expensive operation, GNUnet requires the issuer of the revocation to
+.\" ``GPL3''.
-perform an expensive proof-of-work computation before they will be
+.\"
-allowed to perform the revocation.  gnunet\-revocation will perform
+.\" A copy of the license is also available from the Free Software
-this computation.  The computation can be performed ahead of time,
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
-with the resulting revocation certificate being stored in a file for
+.\"
-later "instant" use.  gnunet\-revocation also makes is possible to
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
-resume the pre-calculation of a revocation --- simply abort a running
+.\"
-proof-of-work calculation with CTRL-C, and the existing revocation
+.Dd March 15, 2012
-certificate file will contain the status of the computation.  Note
+.Dt GNUNET-REVOCATION 1
-that performing a revocation proof-of-work is deliberately VERY
+.Os
-expensive.  Depending on your CPU, the calculation can take days or
+.Sh NAME
-weeks.
+.Nm gnunet-revocation
+.Nd
-.SH OPTIONS
+revoke private keys (of egos) in GNUnet
-.IP "\-t KEY, \-\-test=KEY"
+.Sh SYNOPSIS
-Check if the given KEY (ASCII\-encoded public key required) has been
+.Nm
-revoked.
+.Op Fl t Ar KEY | Fl \-test= Ns Ar KEY
-.IP "\-R NAME, \-\-revoke=NAME"
+.Op Fl R Ar NAME | Fl \-revoke= Ns Ar NAME
+.Op Fl p | \-perform
+.Op Fl f Ar NAME | Fl \-filename= Ns Ar NAME
+.Op Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
+.Op Fl h | \-help
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl v | \-version
+.Sh DESCRIPTION
+.Nm
+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 they 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.
+.Bl -tag -width Ds
+.It Fl t Ar KEY | Fl \-test= Ns Ar KEY
+Check if the given KEY (ASCII\-encoded public key required) has been revoked.
+.It Fl R Ar NAME | Fl \-revoke= Ns Ar NAME
 Calculate or perform revocation for the ego with the given NAME.
-.IP "\-p, \-\-perform"
+.It Fl p | \-perform
-Actually perform the revocation as soon as possible (do not just
+Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it).
-generate a revocation certificate, use it).  Must be supplied to
+Must be supplied to actually perform the revocation.
-actually perform the revocation.
+.It Fl f Ar NAME | Fl \-filename= Ns Ar NAME
-.IP "\-f NAME, \-\-filename=NAME"
+Use NAME as the name of the file that is to contain the revocation certificate.
-Use NAME as the name of the file that is to contain the revocation
+Intermediate computation results will be stored here, as well as the final revocation certificate.
-certificate.  Intermediate computation results will be stored here, as
+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.
-well as the final revocation certificate.  When used together with
+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.
-\-p, this file will be inspected to see if it contains a valid
+.It Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
-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.
-.IP "\-c FILENAME,  \-\-config=FILENAME"
 Use the configuration file FILENAME.
-.IP "\-h, \-\-help"
+.It Fl h | \-help
 Print short help on options.
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
-Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
+Use LOGLEVEL for logging.
-ERROR.
+Valid values are DEBUG, INFO, WARNING and ERROR.
-.IP "\-v, \-\-version"
+.It Fl v | \-version
 Print GNUnet version number.
+.El
+.Sh SEE ALSO
-.SH BUGS
+The full documentation for gnunet is maintained as a Texinfo manual.
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+If the
-.SH "SEE ALSO"
+.Xr info 1
-The full documentation for
+and gnunet programs are properly installed at your site, the command
-.B gnunet
+.Pp
-is maintained as a Texinfo manual.  If the
+.Dl info gnunet
-.B info
+.Pp
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
 should give you access to the complete handbook,
-.IP
+.Pp
-.B info gnunet-c-tutorial
+.Dl info gnunet-c-tutorial
-.PP
+.Pp
 will give you access to a tutorial for developers.
-.PP
+.sp
-Depending on your installation, this information is also
+Depending on your installation, this information is also available in
-available in
+.Xr gnunet 7 and
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.Xr gnunet-c-tutorial 7 .
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .

diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1 index 6fae373e7..24780ac0b 100644 --- a/doc/man/gnunet-revocation.1 +++ b/doc/man/gnunet-revocation.1
@@ -1,82 +1,97 @@
1	.TH GNUNET\-REVOCATION 1 "March 15, 2012" "GNUnet"	1	.\" This file is part of GNUnet.
2		2	.\" Copyright (C) 2001-2019 GNUnet e.V.
3	.SH NAME	3	.\"
4	gnunet\-revocation \- revoke private keys (of egos) in GNUnet	4	.\" Permission is granted to copy, distribute and/or modify this document
5		5	.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6	.SH SYNOPSIS	6	.\" any later version published by the Free Software Foundation; with no
7	.B gnunet\-revocation	7	.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8	.RI [ options ]	8	.\" copy of the license is included in the file
9	.br	9	.\" ``FDL-1.3''.
10		10	.\"
11	.SH DESCRIPTION	11	.\" A copy of the license is also available from the Free Software
12	\fBgnunet\-revocation\fP can be used to verify if a key has been	12	.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13	revoked, to create a revocation certificate for later revocation, to	13	.\"
14	instantly revoke a key and to use a pre-generated revocation	14	.\" Alternately, this document is also available under the General
15	certificate to revoke a key. Upon successful revocation, all peers	15	.\" Public License, version 3 or later, as published by the Free Software
16	will be informed about the invalidity of the key. As this is an	16	.\" Foundation. A copy of the license is included in the file
17	expensive operation, GNUnet requires the issuer of the revocation to	17	.\" ``GPL3''.
18	perform an expensive proof-of-work computation before they will be	18	.\"
19	allowed to perform the revocation. gnunet\-revocation will perform	19	.\" A copy of the license is also available from the Free Software
20	this computation. The computation can be performed ahead of time,	20	.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21	with the resulting revocation certificate being stored in a file for	21	.\"
22	later "instant" use. gnunet\-revocation also makes is possible to	22	.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23	resume the pre-calculation of a revocation --- simply abort a running	23	.\"
24	proof-of-work calculation with CTRL-C, and the existing revocation	24	.Dd March 15, 2012
25	certificate file will contain the status of the computation. Note	25	.Dt GNUNET-REVOCATION 1
26	that performing a revocation proof-of-work is deliberately VERY	26	.Os
27	expensive. Depending on your CPU, the calculation can take days or	27	.Sh NAME
28	weeks.	28	.Nm gnunet-revocation
29		29	.Nd
30	.SH OPTIONS	30	revoke private keys (of egos) in GNUnet
31	.IP "\-t KEY, \-\-test=KEY"	31	.Sh SYNOPSIS
32	Check if the given KEY (ASCII\-encoded public key required) has been	32	.Nm
33	revoked.	33	.Op Fl t Ar KEY \| Fl \-test= Ns Ar KEY
34	.IP "\-R NAME, \-\-revoke=NAME"	34	.Op Fl R Ar NAME \| Fl \-revoke= Ns Ar NAME
		35	.Op Fl p \| \-perform
		36	.Op Fl f Ar NAME \| Fl \-filename= Ns Ar NAME
		37	.Op Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
		38	.Op Fl h \| \-help
		39	.Op Fl L Ar LOGLEVEL \| Fl \-loglevel= Ns Ar LOGLEVEL
		40	.Op Fl v \| \-version
		41	.Sh DESCRIPTION
		42	.Nm
		43	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.
		44	Upon successful revocation, all peers will be informed about the invalidity of the key.
		45	As this is an expensive operation, GNUnet requires the issuer of the revocation to perform an expensive proof-of-work computation before they will be allowed to perform the revocation.
		46	gnunet-revocation will perform this computation.
		47	The computation can be performed ahead of time, with the resulting revocation certificate being stored in a file for later "instant" use.
		48	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.
		49	Note that performing a revocation proof-of-work is deliberately VERY expensive.
		50	Depending on your CPU, the calculation can take days or weeks.
		51	.Bl -tag -width Ds
		52	.It Fl t Ar KEY \| Fl \-test= Ns Ar KEY
		53	Check if the given KEY (ASCII\-encoded public key required) has been revoked.
		54	.It Fl R Ar NAME \| Fl \-revoke= Ns Ar NAME
35	Calculate or perform revocation for the ego with the given NAME.	55	Calculate or perform revocation for the ego with the given NAME.
36	.IP "\-p, \-\-perform"	56	.It Fl p \| \-perform
37	Actually perform the revocation as soon as possible (do not just	57	Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it).
38	generate a revocation certificate, use it). Must be supplied to	58	Must be supplied to actually perform the revocation.
39	actually perform the revocation.	59	.It Fl f Ar NAME \| Fl \-filename= Ns Ar NAME
40	.IP "\-f NAME, \-\-filename=NAME"	60	Use NAME as the name of the file that is to contain the revocation certificate.
41	Use NAME as the name of the file that is to contain the revocation	61	Intermediate computation results will be stored here, as well as the final revocation certificate.
42	certificate. Intermediate computation results will be stored here, as	62	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.
43	well as the final revocation certificate. When used together with	63	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.
44	\-p, this file will be inspected to see if it contains a valid	64	.It Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
45	certificate for instant revocation, in which case the revocation can
46	be performed instantly. If the given file contains anything (a valid
47	certificate, with or without the completed proof-of-work) there is no
48	need to supply the "\-R" option or to still have the private key of
49	the ego to perform the revocation.
50	.IP "\-c FILENAME, \-\-config=FILENAME"
51	Use the configuration file FILENAME.	65	Use the configuration file FILENAME.
52	.IP "\-h, \-\-help"	66	.It Fl h \| \-help
53	Print short help on options.	67	Print short help on options.
54	.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"	68	.It Fl L Ar LOGLEVEL \| Fl \-loglevel= Ns Ar LOGLEVEL
55	Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and	69	Use LOGLEVEL for logging.
56	ERROR.	70	Valid values are DEBUG, INFO, WARNING and ERROR.
57	.IP "\-v, \-\-version"	71	.It Fl v \| \-version
58	Print GNUnet version number.	72	Print GNUnet version number.
59		73	.El
60		74	.Sh SEE ALSO
61	.SH BUGS	75	The full documentation for gnunet is maintained as a Texinfo manual.
62	Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>	76	If the
63	.SH "SEE ALSO"	77	.Xr info 1
64	The full documentation for	78	and gnunet programs are properly installed at your site, the command
65	.B gnunet	79	.Pp
66	is maintained as a Texinfo manual. If the	80	.Dl info gnunet
67	.B info	81	.Pp
68	and
69	.B gnunet
70	programs are properly installed at your site, the command
71	.IP
72	.B info gnunet
73	.PP
74	should give you access to the complete handbook,	82	should give you access to the complete handbook,
75	.IP	83	.Pp
76	.B info gnunet-c-tutorial	84	.Dl info gnunet-c-tutorial
77	.PP	85	.Pp
78	will give you access to a tutorial for developers.	86	will give you access to a tutorial for developers.
79	.PP	87	.sp
80	Depending on your installation, this information is also	88	Depending on your installation, this information is also available in
81	available in	89	.Xr gnunet 7 and
82	\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).	90	.Xr gnunet-c-tutorial 7 .
		91	.\".Sh HISTORY
		92	.\".Sh AUTHORS
		93	.Sh BUGS
		94	Report bugs by using
		95	.Lk https://bugs.gnunet.org
		96	or by sending electronic mail to
		97	.Aq Mt gnunet-developers@gnu.org .