aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/gnunet-auto-share.1232
-rw-r--r--doc/man/gnunet-bcd.1119
-rw-r--r--doc/man/gnunet-config.1116
-rw-r--r--doc/man/gnunet-fs.1131
-rw-r--r--doc/man/gnunet-revocation.1167
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 @@
1.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet" 1.Dd June 18, 2012
2.SH NAME 2.Dt GNUNET-AUTO-SHARE 1
3gnunet\-auto\-share \- a command line tool to automatically share an 3.Os
4entire directory with other users 4.Sh NAME
5.SH SYNOPSIS 5.Nm gnunet-auto-share
6.B gnunet\-auto\-share 6.Nd
7[\fIOPTIONS\fR] DIRNAME 7a command line tool to automatically share an entire directory with other users
8.SH DESCRIPTION 8.Sh SYNOPSIS
9In order to share files with other GNUnet users, the files must first be made 9.Nm
10available to GNUnet. This tool can be used to automatically share all files 10.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
11from a certain directory. The program will periodically scan the directory 11.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
12for changes and publish files that are new or that changed on GNUnet. 12.Op Fl D | \-disable-extractor
13Which files have already been shared is remembered in a ".auto-share" file 13.Op Fl d | \-disable-creation-time
14in the shared directory. You can run the tool by hand or automatically by 14.Op Fl h | \-help
15adding the respective options to your configuration. gnunet\-auto\-share 15.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
16has many options in common with gnunet\-publish, but can only be used to 16.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
17index files. 17.Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
18.PP 18.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
19.Op Fl V | \-verbose
20.Op Fl v | \-version
21.Ao Ar DIRNAME Ac
22.Sh DESCRIPTION
23In order to share files with other GNUnet users, the files must first be made available to GNUnet.
24This tool can be used to automatically share all files from a certain directory.
25The program will periodically scan the directory for changes and publish files that are new or that changed on GNUnet.
26Which files have already been shared is remembered in a ".auto-share" file in the shared directory.
27You can run the tool by hand or automatically by adding the respective options to your configuration.
28gnunet\-auto\-share has many options in common with gnunet\-publish, but can only be used to index files.
29.Pp
19You can use automatic meta\-data extraction (based on libextractor). 30You can use automatic meta\-data extraction (based on libextractor).
20.TP 31.Bl -tag -width Ds
21\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 32.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
22Use alternate config file (if this option is not specified, the 33The \fB\-a\fR option can be used to specify additional anonymity constraints.
23default is ~/.config/gnunet.conf). 34If 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.
24.TP 35This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
25\fB\-D\fR, \fB\-\-disable\-extractor\fR 36If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
37However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity.
38You 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.
39Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
40.Pp
41The definition of the ANONYMITY LEVEL is the following.
420 means no anonymity is required.
43Otherwise 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.
44Thus, 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.
45The time\-period is twice the average delay that GNUnet defers forwarded queries.
46.Pp
47The default is 1 and this should be fine for most users.
48Also 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.
49.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
50Use alternate config file (if this option is not specified, the default is ~/.config/gnunet.conf).
51.It Fl D | \-disable-extractor
26Disable use of GNU libextractor for finding additional keywords and metadata. 52Disable use of GNU libextractor for finding additional keywords and metadata.
27.TP 53.It Fl d | \-disable-creation-time
28\fB\-h\fR, \fB\-\-help\fR 54Disable adding the creation time to the metadata of the uploaded file.
55.It Fl h | \-help
29Print a brief help page with all the options. 56Print a brief help page with all the options.
30.TP 57.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
31\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR 58Change the loglevel.
32Change the loglevel. Possible values for LOGLEVEL are 59Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
33ERROR, WARNING, INFO and DEBUG. 60.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
34.TP 61Configure logging to write logs to FILENAME.
35\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 62.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
36Executive summary: You probably don't need it. 63Executive summary: You probably don't need it.
37Set the priority of the published content (default: 365). If the local 64Set the priority of the published content (default: 365).
38database is full, GNUnet will discard the content with the lowest ranking. 65If the local database is full, GNUnet will discard the content with the lowest ranking.
39Note that ranks change over time depending on popularity. The default 66Note that ranks change over time depending on popularity.
40should be high enough to preserve the locally published content in favor 67The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
41of content that migrates from other peers. 68.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
42.TP 69Set the desired replication level.
43\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR 70If 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.
44Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet 71This option can be used to push some content out into the network harder.
45will push each block (for the file) LEVEL times to other peers before doing 72Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
46normal "random" replication of all content. This option can be used to push 73.It Fl V | \-verbose
47some content out into the network harder. Note that pushing content LEVEL 74Be verbose.
48times into the network does not guarantee that there will actually be LEVEL 75Using 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.
49replicas. 76.It Fl v | \-version
50.TP
51\fB\-v\fR, \fB\-\-version\fR
52Print the version number. 77Print the version number.
53.TP 78.El
54\fB\-V\fR, \fB\-\-verbose\fR 79.Sh EXAMPLES
55Be verbose. Using this option causes gnunet\-publish to print progress 80.Ss Basic example
56information and at the end the file identification that can be used to download 81$ gnunet-auto-share $HOME/gnunet-share/ &
57the file from GNUnet. 82.Pp
58.SH SETTING ANONYMITY LEVEL 83Share a directory "$HOME/gnunet-share/"
59The \fB\-a\fR option can be used to specify additional anonymity constraints. 84.Ss Basic configuration
60If set to 0, GNUnet will publish the file non-anonymously and in fact sign 85$ Share a directory "$HOME/gnunet-share/":
61the advertisement for the file using your peer's private key. This will 86.Pp
62allow other users to download the file as fast as possible, including using 87.Bd -literal -offset indent -compact
63non-anonymous methods (DHT, direct transfer). If you set it to 1 (default), 88[gnunet-auto-share]
64you use the standard anonymous routing algorithm (which does not explicitly 89OPTIONS = $HOME/gnunet-share
65leak your identity). However, a powerful adversary may still be able to 90IMMEDIATE_START = YES # start this service when the peer starts
66perform traffic analysis (statistics) to over time infer data about your 91.Ed
67identity. You can gain better privacy by specifying a higher level of 92.Sh FILES
68anonymity, which increases the amount of cover traffic your own traffic will
69get, at the expense of performance. Note that regardless of the anonymity
70level you choose, peers that cache content in the network always use anonymity
71level 1.
72.PP
73The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity
74is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
75traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
76byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
77peers (using anonymous routing), it may originate n/(v-1) bytes of data in
78the same time\-period. The time\-period is twice the average delay that
79GNUnet defers forwarded queries.
80.PP
81The default is 1 and this should be fine for most users. Also notice that if
82you choose very large values, you may end up having no throughput at all,
83especially if many of your fellow GNUnet\-peers all do the same.
84.SH EXAMPLES
85\fBBasic example\fR
86.TP
87# gnunet\-auto\-share $HOME/gnunet\-share/ &
88Share a directory "$HOME/gnunet\-share/"
89.PP
90\fBBasic configuration\fR
91.PP
92Share a directory "$HOME/gnunet\-share/":
93
94 [gnunet-auto-share]
95 OPTIONS = $HOME/gnunet\-share
96 IMMEDIATE_START = YES # start this service when the peer starts
97.SH FILES
98.TP 93.TP
99~/.config/gnunet.conf 94~/.config/gnunet.conf
100GNUnet configuration file 95GNUnet configuration file
101.SH BUGS 96.Sh SEE ALSO
102Report bugs to <https://bugs.gnunet.org/> or by sending electronic 97.Xr gnunet-fs-gtk 1 ,
103mail to <gnunet\-developers@gnu.org> 98.Xr gnunet-publish 1 ,
104.SH SEE ALSO 99.Xr gnunet-search 1 ,
105\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), 100.Xr gnunet-download 1 ,
106\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), 101.Xr gnunet.conf 5 ,
107\fBgnunet.conf\fP(5), \fBextract\fP(1) 102.Xr extract 1
108The full documentation for 103.sp
109.B gnunet 104The full documentation for gnunet is maintained as a Texinfo manual.
110is maintained as a Texinfo manual. If the 105If the
111.B info 106.Xr info 1
112and 107and gnunet programs are properly installed at your site, the command
113.B gnunet 108.Pp
114programs are properly installed at your site, the command 109.Dl info gnunet
115.IP 110.Pp
116.B info gnunet
117.PP
118should give you access to the complete handbook, 111should give you access to the complete handbook,
119.IP 112.Pp
120.B info gnunet-c-tutorial 113.Dl info gnunet-c-tutorial
121.PP 114.Pp
122will give you access to a tutorial for developers. 115will give you access to a tutorial for developers.
123.PP 116.sp
124Depending on your installation, this information is also 117Depending on your installation, this information is also available in
125available in 118.Xr gnunet 7 and
126\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 119.Xr gnunet-c-tutorial 7 .
120.\".Sh HISTORY
121.\".Sh AUTHORS
122.Sh BUGS
123Report bugs by using
124.Lk https://bugs.gnunet.org
125or by sending electronic mail to
126.Aq Mt gnunet-developers@gnu.org .
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 @@
1.TH GNUNET\-BCD 1 "December 5, 2013" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-bcd \- run HTTP server to create GNS business cards 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-bcd 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.br 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.SH DESCRIPTION 8.\" copy of the license is included in the file
9\fBgnunet\-bcd\fP can be used to create an business card with a QR code 9.\" ``FDL-1.3''.
10containing the public key of a zone from the GNU Name System. 10.\"
11gnunet\-bcd requires LaTeX (pdflatex) with various packages to be 11.\" A copy of the license is also available from the Free Software
12installed. If it does not work for you, try installing the full 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13TeXLive distribution first, for example using the package\-manager 13.\"
14apt: "apt-get install texlive-full". 14.\" Alternately, this document is also available under the General
15.SH OPTIONS 15.\" Public License, version 3 or later, as published by the Free Software
16.IP "\-p PORT, \-\-port=PORT" 16.\" Foundation. A copy of the license is included in the file
17.\" ``GPL3''.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd December 5, 2013
25.Dt GNUNET-BCD 1
26.Os
27.Sh NAME
28.Nm gnunet-bcd
29.Nd
30run HTTP server to create GNS business cards
31.Sh SYNOPSIS
32.Nm
33.Op Fl p Ar PORT | Fl \-port= Ns Ar PORT
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
35.Op Fl h | \-help
36.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
37.Op Fl v | \-version
38.Sh DESCRIPTION
39.Nm
40can be used to create an business card with a QR code containing the public key of a zone from the GNU Name System.
41gnunet-bcd requires LaTeX (
42.Xr pdflatex 1
43) with various packages to be installed.
44If it does not work for you, try installing the full TeXLive distribution first, for example if you are using the package-manager
45.Xr apt 1
46execute "apt-get install texlive-full".
47.Bl -tag -width Ds
48.It Fl p Ar PORT | Fl \-port= Ns Ar PORT
17Run the HTTP server on port PORT. 49Run the HTTP server on port PORT.
18.IP "\-c FILENAME, \-\-config=FILENAME" 50.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
19Use the configuration file FILENAME. 51Use the configuration file FILENAME.
20.IP "\-h, \-\-help" 52.It Fl h | \-help
21Print short help on options. 53Print short help on options.
22.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 54.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
23Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 55Use LOGLEVEL for logging.
24.IP "\-v, \-\-version" 56Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl v | \-version
25Print GNUnet version number. 58Print GNUnet version number.
26.SH BUGS 59.El
27Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 60.Sh SEE ALSO
28electronic mail to <gnunet\-developers@gnu.org> 61The full documentation for gnunet is maintained as a Texinfo manual.
29.SH SEE ALSO 62If the
30The full documentation for 63.Xr info 1
31.B gnunet 64and gnunet programs are properly installed at your site, the command
32is maintained as a Texinfo manual. If the 65.Pp
33.B info 66.Dl info gnunet
34and 67.Pp
35.B gnunet
36programs are properly installed at your site, the command
37.IP
38.B info gnunet
39.PP
40should give you access to the complete handbook, 68should give you access to the complete handbook,
41.IP 69.Pp
42.B info gnunet-c-tutorial 70.Dl info gnunet-c-tutorial
43.PP 71.Pp
44will give you access to a tutorial for developers. 72will give you access to a tutorial for developers.
45.PP 73.sp
46Depending on your installation, this information is also 74Depending on your installation, this information is also available in
47available in 75.Xr gnunet 7 and
48\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 76.Xr gnunet-c-tutorial 7 .
77.\".Sh HISTORY
78.\".Sh AUTHORS
79.Sh BUGS
80Report bugs by using
81.Lk https://bugs.gnunet.org
82or by sending electronic mail to
83.Aq Mt gnunet-developers@gnu.org .
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 @@
1.TH GNUNET-CONFIG 1 "July 15, 2012" "GNUnet" 1.Dd July 15, 2012
2.SH NAME 2.Dt GNUNET-CONFIG 1
3gnunet\-config \- manipulate GNUnet configuration files 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-config 5.Nm gnunet-config
6.RI [ options ] 6.Nd
7.SH DESCRIPTION 7manipulate GNUnet configuration files
8\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. 8.Sh SYNOPSIS
9.SH OPTIONS 9.Nm
10.IP "\-f, \-\-filename" 10.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
11Try to perform expansions as if the option values represent filenames (will 11.Op Fl f | \-filename
12also be applied even if the option is not really a filename). 12.Op Fl h | \-help
13.IP "\-s SECTION, \-\-section=SECTION" 13.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
14Which configuration section should be accessed or edited. Required option. 14.Op Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
15.IP "\-S, \-\-list\-sections" 15.Op Fl S |\-list-sections
16.Op Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
17.Op Fl V Ar VALUE | Fl \-value Ar VALUE
18.Op Fl v | \-version
19.Op Fl W | \-rewrite
20.Sh DESCRIPTION
21.Nm
22can be used to read or modify GNUnet configuration files.
23.Bl -tag -width Ds
24.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
25Use the configuration file FILENAME.
26.It Fl f | \-filename
27Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename).
28.It Fl h | \-help
29Print short help on options.
30.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
31Use LOGLEVEL for logging.
32Valid values are DEBUG, INFO, WARNING and ERROR.
33.It Fl o Ar OPTION | Fl \-option= Ns Ar OPTION
34Which configuration option should be accessed or edited.
35Required to set a value.
36If not given, all values of a given section will be printed in the format "OPTION = VALUE".
37.It Fl S |\-list-sections
16List available configuration sections for use with \-\-section. 38List available configuration sections for use with \-\-section.
17.IP "\-W, \-\-rewrite" 39.It Fl s Ar SECTION | Fl \-section= Ns Ar SECTION
18Consider differences to defaults only. 40Which configuration section should be accessed or edited.
19.IP "\-o OPTION, \-\-option=OPTION" 41Required option.
20Which configuration option should be accessed or edited. Required to set a value. 42.It Fl V Ar VALUE | Fl \-value Ar VALUE
21If not given, all values of a given section will be printed in the
22format "OPTION = VALUE".
23.IP "\-V VALUE, \-\-value VALUE"
24Configuration value to store in the given section under the given option. 43Configuration value to store in the given section under the given option.
25Must only be given together with \-s and \-o options. 44Must only be given together with \-s and \-o options.
26.IP "\-c FILENAME, \-\-config=FILENAME" 45.It Fl v | \-version
27Use the configuration file FILENAME.
28.IP "\-h, \-\-help"
29Print short help on options.
30.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
31Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
32.IP "\-v, \-\-version"
33Print GNUnet version number. 46Print GNUnet version number.
34.SH BUGS 47.It Fl W | \-rewrite
35Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 48Consider differences to defaults only.
36electronic mail to <gnunet\-developers@gnu.org> 49.El
37.SH SEE ALSO 50.Sh SEE ALSO
38The full documentation for 51The full documentation for gnunet is maintained as a Texinfo manual.
39.B gnunet
40is maintained as a Texinfo manual.
41If the 52If the
42.B info 53.Xr info 1
43and 54and gnunet programs are properly installed at your site, the command
44.B gnunet 55.Pp
45programs are properly installed at your site, the command 56.Dl info gnunet
46.IP 57.Pp
47.B info gnunet
48.PP
49should give you access to the complete handbook, 58should give you access to the complete handbook,
50.IP 59.Pp
51.B info gnunet-c-tutorial 60.Dl info gnunet-c-tutorial
52.PP 61.Pp
53will give you access to a tutorial for developers. 62will give you access to a tutorial for developers.
54.PP 63.sp
55Depending on your installation, this information is also 64Depending on your installation, this information is also available in
56available in 65.Xr gnunet 7 and
57\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 66.Xr gnunet-c-tutorial 7 .
67.\".Sh HISTORY
68.\".Sh AUTHORS
69.Sh BUGS
70Report bugs by using
71.Lk https://bugs.gnunet.org
72or by sending electronic mail to
73.Aq Mt gnunet-developers@gnu.org .
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 @@
1.TH GNUNET\-FS "1" "November 2, 2011" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-fs \- measure and control the fs subsystem 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-fs 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6[\fIOPTIONS\fR] 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.PP 8.\" copy of the license is included in the file
9gnunet\-fs is a tool to access various functions of GNUnet's fs 9.\" ``FDL-1.3''.
10subsystem from the command\-line. 10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" ``GPL3''.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd November 2, 2011
25.Dt GNUNET-FS 1
26.Os
27.Sh NAME
28.Nm gnunet-fs
29.Nd
30measure and control the fs subsystem
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help
35.Op Fl i | \-list-indexed
36.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
37.Op Fl v | \-version
38.Op Fl V | \-verbose
39.Sh DESCRIPTION
40.Nm
41is a tool to access various functions of GNUnet's FS subsystem from the command\-line.
11Most of these are not expected to be useful for end-users. 42Most of these are not expected to be useful for end-users.
12gnunet\-fs can currently only be used to obtain a list of indexed 43gnunet\-fs can currently only be used to obtain a list of indexed files.
13files.
14Other functions should be added in the near future. 44Other functions should be added in the near future.
15.TP 45.Bl -tag -width Ds
16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
17configuration file to use 47Configuration file to use.
18.TP 48.It Fl h | \-help
19\fB\-h\fR, \fB\-\-help\fR 49Print help page.
20print help page 50.It Fl i | \-list-indexed
21.TP 51Print information about files that are currently indexed by file-sharing.
22\fB\-i\fR, \fB\-\-list-indexed\fR 52.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
23print information about files that are currently indexed by
24file-sharing
25.TP
26\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
27Change the loglevel. 53Change the loglevel.
28Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 54Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
29.TP 55.It Fl v | \-version
30\fB\-v\fR, \fB\-\-version\fR 56Print the version number.
31print the version number 57.It Fl V | \-verbose
32.TP 58Be verbose.
33\fB\-V\fR, \fB\-\-verbose\fR 59.El
34be verbose 60.Sh SEE ALSO
35.SH BUGS 61.Xr gnunet-publish 1
36Report bugs by using mantis <https://bugs.gnunet.org/> or by sending 62.sp
37electronic mail to <gnunet\-developers@gnu.org> 63The full documentation for gnunet is maintained as a Texinfo manual.
38.SH SEE ALSO 64If the
39\fBgnunet\-publish\fP(1) 65.Xr info 1
40The full documentation for 66and gnunet programs are properly installed at your site, the command
41.B gnunet 67.Pp
42is maintained as a Texinfo manual. If the 68.Dl info gnunet
43.B info 69.Pp
44and
45.B gnunet
46programs are properly installed at your site, the command
47.IP
48.B info gnunet
49.PP
50should give you access to the complete handbook, 70should give you access to the complete handbook,
51.IP 71.Pp
52.B info gnunet-c-tutorial 72.Dl info gnunet-c-tutorial
53.PP 73.Pp
54will give you access to a tutorial for developers. 74will give you access to a tutorial for developers.
55.PP 75.sp
56Depending on your installation, this information is also 76Depending on your installation, this information is also available in
57available in 77.Xr gnunet 7 and
58\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 78.Xr gnunet-c-tutorial 7 .
79.\".Sh HISTORY
80.\".Sh AUTHORS
81.Sh BUGS
82Report bugs by using
83.Lk https://bugs.gnunet.org
84or by sending electronic mail to
85.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.\"
4gnunet\-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}.
13revoked, to create a revocation certificate for later revocation, to 13.\"
14instantly revoke a key and to use a pre-generated revocation 14.\" Alternately, this document is also available under the General
15certificate to revoke a key. Upon successful revocation, all peers 15.\" Public License, version 3 or later, as published by the Free Software
16will be informed about the invalidity of the key. As this is an 16.\" Foundation. A copy of the license is included in the file
17expensive operation, GNUnet requires the issuer of the revocation to 17.\" ``GPL3''.
18perform an expensive proof-of-work computation before they will be 18.\"
19allowed to perform the revocation. gnunet\-revocation will perform 19.\" A copy of the license is also available from the Free Software
20this computation. The computation can be performed ahead of time, 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21with the resulting revocation certificate being stored in a file for 21.\"
22later "instant" use. gnunet\-revocation also makes is possible to 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23resume the pre-calculation of a revocation --- simply abort a running 23.\"
24proof-of-work calculation with CTRL-C, and the existing revocation 24.Dd March 15, 2012
25certificate file will contain the status of the computation. Note 25.Dt GNUNET-REVOCATION 1
26that performing a revocation proof-of-work is deliberately VERY 26.Os
27expensive. Depending on your CPU, the calculation can take days or 27.Sh NAME
28weeks. 28.Nm gnunet-revocation
29 29.Nd
30.SH OPTIONS 30revoke private keys (of egos) in GNUnet
31.IP "\-t KEY, \-\-test=KEY" 31.Sh SYNOPSIS
32Check if the given KEY (ASCII\-encoded public key required) has been 32.Nm
33revoked. 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
43can 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.
44Upon successful revocation, all peers will be informed about the invalidity of the key.
45As 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.
46gnunet-revocation will perform this computation.
47The computation can be performed ahead of time, with the resulting revocation certificate being stored in a file for later "instant" use.
48gnunet-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.
49Note that performing a revocation proof-of-work is deliberately VERY expensive.
50Depending 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
53Check if the given KEY (ASCII\-encoded public key required) has been revoked.
54.It Fl R Ar NAME | Fl \-revoke= Ns Ar NAME
35Calculate or perform revocation for the ego with the given NAME. 55Calculate or perform revocation for the ego with the given NAME.
36.IP "\-p, \-\-perform" 56.It Fl p | \-perform
37Actually perform the revocation as soon as possible (do not just 57Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it).
38generate a revocation certificate, use it). Must be supplied to 58Must be supplied to actually perform the revocation.
39actually perform the revocation. 59.It Fl f Ar NAME | Fl \-filename= Ns Ar NAME
40.IP "\-f NAME, \-\-filename=NAME" 60Use NAME as the name of the file that is to contain the revocation certificate.
41Use NAME as the name of the file that is to contain the revocation 61Intermediate computation results will be stored here, as well as the final revocation certificate.
42certificate. Intermediate computation results will be stored here, as 62When 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.
43well as the final revocation certificate. When used together with 63If 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
45certificate for instant revocation, in which case the revocation can
46be performed instantly. If the given file contains anything (a valid
47certificate, with or without the completed proof-of-work) there is no
48need to supply the "\-R" option or to still have the private key of
49the ego to perform the revocation.
50.IP "\-c FILENAME, \-\-config=FILENAME"
51Use the configuration file FILENAME. 65Use the configuration file FILENAME.
52.IP "\-h, \-\-help" 66.It Fl h | \-help
53Print short help on options. 67Print short help on options.
54.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 68.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
55Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 69Use LOGLEVEL for logging.
56ERROR. 70Valid values are DEBUG, INFO, WARNING and ERROR.
57.IP "\-v, \-\-version" 71.It Fl v | \-version
58Print GNUnet version number. 72Print GNUnet version number.
59 73.El
60 74.Sh SEE ALSO
61.SH BUGS 75The full documentation for gnunet is maintained as a Texinfo manual.
62Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> 76If the
63.SH "SEE ALSO" 77.Xr info 1
64The full documentation for 78and gnunet programs are properly installed at your site, the command
65.B gnunet 79.Pp
66is maintained as a Texinfo manual. If the 80.Dl info gnunet
67.B info 81.Pp
68and
69.B gnunet
70programs are properly installed at your site, the command
71.IP
72.B info gnunet
73.PP
74should give you access to the complete handbook, 82should 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
78will give you access to a tutorial for developers. 86will give you access to a tutorial for developers.
79.PP 87.sp
80Depending on your installation, this information is also 88Depending on your installation, this information is also available in
81available 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
94Report bugs by using
95.Lk https://bugs.gnunet.org
96or by sending electronic mail to
97.Aq Mt gnunet-developers@gnu.org .