gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [gnunet] branch master updated: manpages


From: gnunet
Subject: [GNUnet-SVN] [gnunet] branch master updated: manpages
Date: Tue, 09 Apr 2019 18:55:57 +0200

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository gnunet.

The following commit(s) were added to refs/heads/master by this push:
     new c2e1ab0e1 manpages
     new 6e626937f Merge branch 'master' of gnunet.org:gnunet
c2e1ab0e1 is described below

commit c2e1ab0e17a7b76e66be1b4fff0d02f196cba34a
Author: ng0 <address@hidden>
AuthorDate: Tue Apr 9 16:54:55 2019 +0000

    manpages
---
 doc/man/gnunet-auto-share.1 | 232 ++++++++++++++++++++++----------------------
 doc/man/gnunet-bcd.1        | 119 +++++++++++++++--------
 doc/man/gnunet-config.1     | 116 ++++++++++++----------
 doc/man/gnunet-fs.1         | 131 +++++++++++++++----------
 doc/man/gnunet-revocation.1 | 167 ++++++++++++++++---------------
 5 files changed, 429 insertions(+), 336 deletions(-)

diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index a2965b19f..00b627d87 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,126 +1,126 @@
-.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet"
-.SH NAME
-gnunet\-auto\-share \- a command line tool to automatically share an
-entire directory with other users
-.SH SYNOPSIS
-.B gnunet\-auto\-share
-[\fIOPTIONS\fR] DIRNAME
-.SH DESCRIPTION
-In order to share files with other GNUnet users, the files must first be made
-available to GNUnet.  This tool can be used to automatically share all files
-from a certain directory.  The program will periodically scan the directory
-for changes and publish files that are new or that changed on GNUnet.
-Which files have already been shared is remembered in a ".auto-share" file
-in the shared directory.  You can run the tool by hand or automatically by
-adding the respective options to your configuration.  gnunet\-auto\-share
-has many options in common with gnunet\-publish, but can only be used to
-index files.
-.PP
+.Dd June 18, 2012
+.Dt GNUNET-AUTO-SHARE 1
+.Os
+.Sh NAME
+.Nm gnunet-auto-share
+.Nd
+a command line tool to automatically share an entire directory with other users
+.Sh SYNOPSIS
+.Nm
+.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
+.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.Op Fl D | \-disable-extractor
+.Op Fl d | \-disable-creation-time
+.Op Fl h | \-help
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
+.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
+.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
+.Op Fl V | \-verbose
+.Op Fl v | \-version
+.Ao Ar DIRNAME Ac
+.Sh DESCRIPTION
+In order to share files with other GNUnet users, the files must first be made 
available to GNUnet.
+This tool can be used to automatically share all files from a certain 
directory.
+The program will periodically scan the directory for changes and publish files 
that are new or that changed on GNUnet.
+Which files have already been shared is remembered in a ".auto-share" file in 
the shared directory.
+You can run the tool by hand or automatically by adding the respective options 
to your configuration.
+gnunet\-auto\-share has many options in common with gnunet\-publish, but can 
only be used to index files.
+.Pp
 You can use automatic meta\-data extraction (based on libextractor).
-.TP
-\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-Use alternate config file (if this option is not specified, the
-default is ~/.config/gnunet.conf).
-.TP
-\fB\-D\fR, \fB\-\-disable\-extractor\fR
+.Bl -tag -width Ds
+.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
+The \fB\-a\fR option can be used to specify additional anonymity constraints.
+If set to 0, GNUnet will publish the file non-anonymously and in fact sign the 
advertisement for the file using your peer's private key.
+This will allow other users to download the file as fast as possible, 
including using non-anonymous methods (DHT, direct transfer).
+If you set it to 1 (default), you use the standard anonymous routing algorithm 
(which does not explicitly leak your identity).
+However, a powerful adversary may still be able to perform traffic analysis 
(statistics) to over time infer data about your identity.
+You can gain better privacy by specifying a higher level of anonymity, which 
increases the amount of cover traffic your own traffic will get, at the expense 
of performance.
+Note that regardless of the anonymity level you choose, peers that cache 
content in the network always use anonymity level 1.
+.Pp
+The definition of the ANONYMITY LEVEL is the following.
+0 means no anonymity is required.
+Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic 
can be from the local user, leaving 'v-1' bytes of cover traffic per byte on 
the wire.
+Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous 
routing), it may originate n/(v-1) bytes of data in the same time\-period.
+The time\-period is twice the average delay that GNUnet defers forwarded 
queries.
+.Pp
+The default is 1 and this should be fine for most users.
+Also notice that if you choose very large values, you may end up having no 
throughput at all, especially if many of your fellow GNUnet\-peers all do the 
same.
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+Use alternate config file (if this option is not specified, the default is 
~/.config/gnunet.conf).
+.It Fl D | \-disable-extractor
 Disable use of GNU libextractor for finding additional keywords and metadata.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
+.It Fl d | \-disable-creation-time
+Disable adding the creation time to the metadata of the uploaded file.
+.It Fl h | \-help
 Print a brief help page with all the options.
-.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
-Change the loglevel.  Possible values for LOGLEVEL are
-ERROR, WARNING, INFO and DEBUG.
-.TP
-\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+Change the loglevel.
+Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
+.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
+Configure logging to write logs to FILENAME.
+.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
 Executive summary: You probably don't need it.
-Set the priority of the published content (default: 365).  If the local
-database is full, GNUnet will discard the content with the lowest ranking.
-Note that ranks change over time depending on popularity.  The default
-should be high enough to preserve the locally published content in favor
-of content that migrates from other peers.
-.TP
-\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
-Set the desired replication level.  If CONTENT_PUSHING is set to YES, GNUnet
-will push each block (for the file) LEVEL times to other peers before doing
-normal "random" replication of all content.  This option can be used to push
-some content out into the network harder. Note that pushing content LEVEL
-times into the network does not guarantee that there will actually be LEVEL
-replicas.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
+Set the priority of the published content (default: 365).
+If the local database is full, GNUnet will discard the content with the lowest 
ranking.
+Note that ranks change over time depending on popularity.
+The default should be high enough to preserve the locally published content in 
favor of content that migrates from other peers.
+.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
+Set the desired replication level.
+If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) 
LEVEL times to other peers before doing normal "random" replication of all 
content.
+This option can be used to push some content out into the network harder.
+Note that pushing content LEVEL times into the network does not guarantee that 
there will actually be LEVEL replicas.
+.It Fl V | \-verbose
+Be verbose.
+Using this option causes gnunet\-publish to print progress information and at 
the end the file identification that can be used to download the file from 
GNUnet.
+.It Fl v | \-version
 Print the version number.
-.TP
-\fB\-V\fR, \fB\-\-verbose\fR
-Be verbose.  Using this option causes gnunet\-publish to print progress
-information and at the end the file identification that can be used to download
-the file from GNUnet.
-.SH SETTING ANONYMITY LEVEL
-The \fB\-a\fR option can be used to specify additional anonymity constraints.
-If set to 0, GNUnet will publish the file non-anonymously and in fact sign
-the advertisement for the file using your peer's private key.  This will
-allow other users to download the file as fast as possible, including using
-non-anonymous methods (DHT, direct transfer).  If you set it to 1 (default),
-you use the standard anonymous routing algorithm (which does not explicitly
-leak your identity).  However, a powerful adversary may still be able to
-perform traffic analysis (statistics) to over time infer data about your
-identity.  You can gain better privacy by specifying a higher level of
-anonymity, which increases the amount of cover traffic your own traffic will
-get, at the expense of performance.  Note that regardless of the anonymity
-level you choose, peers that cache content in the network always use anonymity
-level 1.
-.PP
-The definition of the ANONYMITY LEVEL is the following.  0 means no anonymity
-is required.  Otherwise a value of 'v' means that 1 out of v bytes of 
"anonymous"
-traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
-byte on the wire.  Thus, if GNUnet routes n bytes of messages from foreign
-peers (using anonymous routing), it may originate n/(v-1) bytes of data in
-the same time\-period. The time\-period is twice the average delay that
-GNUnet defers forwarded queries.
-.PP
-The default is 1 and this should be fine for most users.  Also notice that if
-you choose very large values, you may end up having no throughput at all,
-especially if many of your fellow GNUnet\-peers all do the same.
-.SH EXAMPLES
-\fBBasic example\fR
-.TP
-# gnunet\-auto\-share $HOME/gnunet\-share/ &
-Share a directory "$HOME/gnunet\-share/"
-.PP
-\fBBasic configuration\fR
-.PP
-Share a directory "$HOME/gnunet\-share/":
-
- [gnunet-auto-share]
- OPTIONS = $HOME/gnunet\-share
- IMMEDIATE_START = YES # start this service when the peer starts
-.SH FILES
+.El
+.Sh EXAMPLES
+.Ss Basic example
+$ gnunet-auto-share $HOME/gnunet-share/ &
+.Pp
+Share a directory "$HOME/gnunet-share/"
+.Ss Basic configuration
+$ Share a directory "$HOME/gnunet-share/":
+.Pp
+.Bd -literal -offset indent -compact
+[gnunet-auto-share]
+OPTIONS = $HOME/gnunet-share
+IMMEDIATE_START = YES # start this service when the peer starts
+.Ed
+.Sh FILES
 .TP
 ~/.config/gnunet.conf
 GNUnet configuration file
-.SH BUGS
-Report bugs to <https://bugs.gnunet.org/> or by sending electronic
-mail to <address@hidden>
-.SH SEE ALSO
-\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
-\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1),
-\fBgnunet.conf\fP(5), \fBextract\fP(1)
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.Sh SEE ALSO
+.Xr gnunet-fs-gtk 1 ,
+.Xr gnunet-publish 1 ,
+.Xr gnunet-search 1 ,
+.Xr gnunet-download 1 ,
+.Xr gnunet.conf 5 ,
+.Xr extract 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
 should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
 will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.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 address@hidden .
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1
index 9b37a097b..ca01c0d92 100644
--- a/doc/man/gnunet-bcd.1
+++ b/doc/man/gnunet-bcd.1
@@ -1,48 +1,83 @@
-.TH GNUNET\-BCD 1 "December 5, 2013" "GNUnet"
-.SH NAME
-gnunet\-bcd \- run HTTP server to create GNS business cards
-.SH SYNOPSIS
-.B gnunet\-bcd
-.RI [ options ]
-.br
-.SH DESCRIPTION
-\fBgnunet\-bcd\fP can be used to create an business card with a QR code
-containing the public key of a zone from the GNU Name System.
-gnunet\-bcd requires LaTeX (pdflatex) with various packages to be
-installed.  If it does not work for you, try installing the full
-TeXLive distribution first, for example using the package\-manager
-apt: "apt-get install texlive-full".
-.SH OPTIONS
-.IP "\-p PORT, \-\-port=PORT"
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" ``FDL-1.3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" ``GPL3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd December 5, 2013
+.Dt GNUNET-BCD 1
+.Os
+.Sh NAME
+.Nm gnunet-bcd
+.Nd
+run HTTP server to create GNS business cards
+.Sh SYNOPSIS
+.Nm
+.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT
+.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 create an business card with a QR code containing the public 
key of a zone from the GNU Name System.
+gnunet-bcd requires LaTeX (
+.Xr pdflatex 1
+) with various packages to be installed.
+If it does not work for you, try installing the full TeXLive distribution 
first, for example if you are using the package-manager
+.Xr apt 1
+execute "apt-get install texlive-full".
+.Bl -tag -width Ds
+.It Fl p Ar PORT | Fl \-port= Ns Ar PORT
 Run the HTTP server on port PORT.
-.IP "\-c FILENAME,  \-\-config=FILENAME"
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
 Use the configuration file FILENAME.
-.IP "\-h, \-\-help"
+.It Fl h | \-help
 Print short help on options.
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
-.IP "\-v, \-\-version"
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl v | \-version
 Print GNUnet version number.
-.SH BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <address@hidden>
-.SH SEE ALSO
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
 should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
 will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.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 address@hidden .
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 8eca8de10..bab9c4a21 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -1,57 +1,73 @@
-.TH GNUNET-CONFIG 1 "July 15, 2012" "GNUnet"
-.SH NAME
-gnunet\-config \- manipulate GNUnet configuration files
-.SH SYNOPSIS
-.B gnunet\-config
-.RI [ options ]
-.SH DESCRIPTION
-\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files.
-.SH OPTIONS
-.IP "\-f, \-\-filename"
-Try to perform expansions as if the option values represent filenames (will
-also be applied even if the option is not really a filename).
-.IP "\-s SECTION, \-\-section=SECTION"
-Which configuration section should be accessed or edited. Required option.
-.IP "\-S, \-\-list\-sections"
+.Dd July 15, 2012
+.Dt GNUNET-CONFIG 1
+.Os
+.Sh NAME
+.Nm gnunet-config
+.Nd
+manipulate GNUnet configuration files
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.Op Fl f | \-filename
+.Op Fl h | \-help
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
+.Op Fl S |\-list-sections
+.Op Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
+.Op Fl V Ar VALUE | Fl \-value Ar VALUE
+.Op Fl v | \-version
+.Op Fl W | \-rewrite
+.Sh DESCRIPTION
+.Nm
+can be used to read or modify GNUnet configuration files.
+.Bl -tag -width Ds
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+Use the configuration file FILENAME.
+.It Fl f | \-filename
+Try to perform expansions as if the option values represent filenames (will 
also be applied even if the option is not really a filename).
+.It Fl h | \-help
+Print short help on options.
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
+Which configuration option should be accessed or edited.
+Required to set a value.
+If not given, all values of a given section will be printed in the format 
"OPTION = VALUE".
+.It Fl S |\-list-sections
 List available configuration sections for use with \-\-section.
-.IP "\-W, \-\-rewrite"
-Consider differences to defaults only.
-.IP "\-o OPTION, \-\-option=OPTION"
-Which configuration option should be accessed or edited.  Required to set a 
value.
-If not given, all values of a given section will be printed in the
-format "OPTION = VALUE".
-.IP "\-V VALUE, \-\-value VALUE"
+.It Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
+Which configuration section should be accessed or edited.
+Required option.
+.It Fl V Ar VALUE | Fl \-value Ar VALUE
 Configuration value to store in the given section under the given option.
 Must only be given together with \-s and \-o options.
-.IP "\-c FILENAME,  \-\-config=FILENAME"
-Use the configuration file FILENAME.
-.IP "\-h, \-\-help"
-Print short help on options.
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
-.IP "\-v, \-\-version"
+.It Fl v | \-version
 Print GNUnet version number.
-.SH BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <address@hidden>
-.SH SEE ALSO
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.
+.It Fl W | \-rewrite
+Consider differences to defaults only.
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
 If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
 should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
 will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.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 address@hidden .
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index dcaf90d72..ea0bb8cb0 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -1,58 +1,85 @@
-.TH GNUNET\-FS "1" "November 2, 2011" "GNUnet"
-.SH NAME
-gnunet\-fs \- measure and control the fs subsystem
-.SH SYNOPSIS
-.B gnunet\-fs
-[\fIOPTIONS\fR]
-.SH DESCRIPTION
-.PP
-gnunet\-fs is a tool to access various functions of GNUnet's fs
-subsystem from the command\-line.
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" ``FDL-1.3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" ``GPL3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd November 2, 2011
+.Dt GNUNET-FS 1
+.Os
+.Sh NAME
+.Nm gnunet-fs
+.Nd
+measure and control the fs subsystem
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.Op Fl h | \-help
+.Op Fl i | \-list-indexed
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl v | \-version
+.Op Fl V | \-verbose
+.Sh DESCRIPTION
+.Nm
+is a tool to access various functions of GNUnet's FS subsystem from the 
command\-line.
 Most of these are not expected to be useful for end-users.
-gnunet\-fs can currently only be used to obtain a list of indexed
-files.
+gnunet\-fs can currently only be used to obtain a list of indexed files.
 Other functions should be added in the near future.
-.TP
-\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
-configuration file to use
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-print help page
-.TP
-\fB\-i\fR, \fB\-\-list-indexed\fR
-print information about files that are currently indexed by
-file-sharing
-.TP
-\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+.Bl -tag -width Ds
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+Configuration file to use.
+.It Fl h | \-help
+Print help page.
+.It Fl i | \-list-indexed
+Print information about files that are currently indexed by file-sharing.
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
 Change the loglevel.
 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
-print the version number
-.TP
-\fB\-V\fR, \fB\-\-verbose\fR
-be verbose
-.SH BUGS
-Report bugs by using mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <address@hidden>
-.SH SEE ALSO
-\fBgnunet\-publish\fP(1)
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.It Fl v | \-version
+Print the version number.
+.It Fl V | \-verbose
+Be verbose.
+.El
+.Sh SEE ALSO
+.Xr gnunet-publish 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
 should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
 will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.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 address@hidden .
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"
-
-.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 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.
-
-.SH OPTIONS
-.IP "\-t KEY, \-\-test=KEY"
-Check if the given KEY (ASCII\-encoded public key required) has been
-revoked.
-.IP "\-R NAME, \-\-revoke=NAME"
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" ``FDL-1.3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" ``GPL3''.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd March 15, 2012
+.Dt GNUNET-REVOCATION 1
+.Os
+.Sh NAME
+.Nm gnunet-revocation
+.Nd
+revoke private keys (of egos) in GNUnet
+.Sh SYNOPSIS
+.Nm
+.Op Fl t Ar KEY | Fl \-test= Ns Ar KEY
+.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"
-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.
-.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.
-.IP "\-c FILENAME,  \-\-config=FILENAME"
+.It Fl 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.
+.It Fl f Ar NAME | Fl \-filename= Ns Ar 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.
+.It Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
 Use the configuration file FILENAME.
-.IP "\-h, \-\-help"
+.It Fl h | \-help
 Print short help on options.
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
-ERROR.
-.IP "\-v, \-\-version"
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl v | \-version
 Print GNUnet version number.
-
-
-.SH BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 
electronic mail to <address@hidden>
-.SH "SEE ALSO"
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
 should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
 will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.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 address@hidden .

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]