aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-21 20:08:52 +0000
committerng0 <ng0@n0.is>2019-04-21 20:08:52 +0000
commita07991f9be04ede254b6e4991c7cfda44bd53700 (patch)
tree4f85ecaaea370bb36d6e5cd4aa661cd6eb0e3f51
parentabc12a14473dc304b2388901add772ba0711f087 (diff)
downloadgnunet-a07991f9be04ede254b6e4991c7cfda44bd53700.tar.gz
gnunet-a07991f9be04ede254b6e4991c7cfda44bd53700.zip
manpages.
-rw-r--r--ChangeLog3
-rw-r--r--doc/man/gnunet-directory.1184
-rw-r--r--doc/man/gnunet-download.125
-rw-r--r--doc/man/gnunet-identity.1180
-rw-r--r--doc/man/gnunet-namestore-fcfsd.1158
-rw-r--r--doc/man/gnunet-namestore.1232
-rw-r--r--doc/man/gnunet-nat-auto.1155
-rw-r--r--doc/man/gnunet-nat-server.1170
-rw-r--r--doc/man/gnunet-publish.1152
-rw-r--r--doc/man/gnunet-search.154
10 files changed, 800 insertions, 513 deletions
diff --git a/ChangeLog b/ChangeLog
index e40e0be07..6e81551a2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,6 @@
1Sun Apr 21 22:22:22 UTC 2019
2 All manpages are now in mdoc format. -ng0
3
1Sat Apr 20 18:38:43 UTC 2019 4Sat Apr 20 18:38:43 UTC 2019
2 Remove optional gnunet-download-manager.scm and 5 Remove optional gnunet-download-manager.scm and
3 with it the optional dependency on a no longer 6 with it the optional dependency on a no longer
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index c08eca46d..e4be45b28 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -1,83 +1,109 @@
1.TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-directory \- display directories 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-directory 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6[\fIOPTIONS\fR] (FILENAME)* 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\-directory lists the contents of one or more GNUnet directories. 9.\" ``FDL-1.3''.
10A GNUnet directory is a binary file that contains a list of GNUnet 10.\"
11file\-sharing URIs and meta data. The names of the directory files must 11.\" A copy of the license is also available from the Free Software
12be passed as command\-line arguments to gnunet\-directory. 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.TP 13.\"
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 14.\" Alternately, this document is also available under the General
15configuration file to use (useless option since gnunet\-directory does not 15.\" Public License, version 3 or later, as published by the Free Software
16really depend on any configuration options) 16.\" Foundation. A copy of the license is included in the file
17.TP 17.\" ``GPL3''.
18\fB\-h\fR, \fB\-\-help\fR 18.\"
19print help page 19.\" A copy of the license is also available from the Free Software
20.TP 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 21.\"
22Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.TP 23.\"
24\fB\-v\fR, \fB\-\-version\fR 24.Dd February 25, 2012
25print the version number 25.Dt GNUNET-DIRECTORY 1
26.SH NOTES 26.Os
27.Sh NAME
28.Nm gnunet-directory
29.Nd
30display directories
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36.Op Fl v | \-version
37.Ao Ar FILENAME Ac
38.Sh DESCRIPTION
39.Nm
40lists the contents of one or more GNUnet directories.
41A GNUnet directory is a binary file that contains a list of GNUnet file-sharing URIs and meta data.
42The names of the directory files must be passed as command-line arguments to gnunet-directory.
43The options are as follows:
44.Bl -tag -width Ds
45.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
46Configuration file to use.
47This option is useless, since gnunet-directory does not really depend on any configuration options.
48.It Fl h | \-help
49Print the help page.
50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
51Change the loglevel.
52Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
53.It Fl v | \-version
54Print the version number.
55.El
56.Ss NOTES
27A GNUnet directory is a file containing a list of GNUnet URIs and meta data. 57A GNUnet directory is a file containing a list of GNUnet URIs and meta data.
28The keys can point to files, other directories or files in namespaces. In other 58The keys can point to files, other directories or files in namespaces.
29words, a GNUnet directory is similar to UNIX directories. The difference to tar 59In other words, a GNUnet directory is similar to UNIX directories.
30and zip is that GNUnet directory does not contain the actual files (except if 60The difference to tar and zip is that GNUnet directory does not contain the actual files (except if they are really small, in which case they may be inlined), just symbolic (links), similar to directories with symbolic links in UNIX filesystems.
31they are really small, in which case they may be inlined), just symbolic (links), 61The benefit is that the individual files can be retrieved separately (if desired) and if some of the files are inserted to another node in GNUnet, this just increases their availability but does not produce useless duplicates (for example, it is a better idea to publish a collection of pictures or compressed sound files using a GNUnet directory instead of processing them with archivers such as tar or zip first).
32similar to directories with symbolic links in UNIX filesystems. The benefit is 62Directories can contain arbitrary meta data for each file.
33that the individual files can be retrieved separately (if desired) and if some 63.Pp
34of the files are inserted to another node in GNUnet, this just increases their 64If a directory has missing blocks (for example, some blocks failed to download), GNUnet is typically able to retrieve information about other files in the directory.
35availability but does not produce useless duplicates (for example, it is a 65Files in a GNUnet directory have no particular order; the GNUnet code that generates a directory can reorder the entries in order to better fit the information about files into blocks of 32k.
36better idea to publish a collection of pictures or compressed sound files 66Respecting 32k boundaries where possible makes it easier for gnunet-directory (and other tools) to recover information from partially downloaded directory files.
37using a GNUnet directory instead of processing them with archivers such as 67.Pp
38tar or zip first). Directories can contain arbitrary meta data for each file. 68At the moment, directories can be created by
39.PP 69.Xr gnunet-fs-gtk 1 ,
40If a directory has missing blocks (for example, some blocks failed to download),
41GNUnet is typically able to retrieve information about other files in the
42directory. Files in a GNUnet directory have no particular order; the GNUnet
43code that generates a directory can reorder the entries in order to better
44fit the information about files into blocks of 32k. Respecting 32k boundaries
45where possible makes it easier for gnunet\-directory (and other tools) to
46recover information from partially downloaded directory files.
47.PP
48At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
49and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
50published in a namespace.
51.PP
52GNUnet directories use the (unregistered)
53mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
54search results. The directory file can be downloaded to disk
55by \fBgnunet\-download\fP(1) for later processing or be handled more directly
56by \fBgnunet\-fs\-gtk\fP(1).
57
58.SH BUGS
59Report bugs by using mantis <https://bugs.gnunet.org/> or by sending
60electronic mail to <gnunet\-developers@gnu.org>
61.SH SEE ALSO
62\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
63\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
64The full documentation for
65.B gnunet
66is maintained as a Texinfo manual.
67If the
68.B info
69and 70and
70.B gnunet 71.Xr gnunet-publish 1 .
71programs are properly installed at your site, the command 72Just like ordinary files, a directory can be published in a namespace.
72.IP 73.Pp
73.B info gnunet 74GNUnet directories use the (unregistered) mimetype "application/gnunet-directory".
74.PP 75They can show up among normal search results.
76The directory file can be downloaded to disk by
77.Xr gnunet-download 1
78for later processing or be handled more directly by
79.Xr gnunet-fs-gtk 1 .
80.\".Sh EXAMPLES
81.Sh SEE ALSO
82.Xr gnunet-download 1 ,
83.Xr gnunet-fs-gtk 1 ,
84.Xr gnunet-publish 1 ,
85.Xr gnunet-search 1
86.sp
87The full documentation for gnunet is maintained as a Texinfo manual.
88If the
89.Xr info 1
90and gnunet programs are properly installed at your site, the command
91.Pp
92.Dl info gnunet
93.Pp
75should give you access to the complete handbook, 94should give you access to the complete handbook,
76.IP 95.Pp
77.B info gnunet-c-tutorial 96.Dl info gnunet-c-tutorial
78.PP 97.Pp
79will give you access to a tutorial for developers. 98will give you access to a tutorial for developers.
80.PP 99.sp
81Depending on your installation, this information is also 100Depending on your installation, this information is also available in
82available in 101.Xr gnunet 7 and
83\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 102.Xr gnunet-c-tutorial 7 .
103.\".Sh HISTORY
104.\".Sh AUTHORS
105.Sh BUGS
106Report bugs by using
107.Lk https://bugs.gnunet.org
108or by sending electronic mail to
109.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index f278694c3..1c7776ff1 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -22,24 +22,23 @@ a command line interface for downloading files from GNUnet
22.Ao Ar GNUNET_URI Ac 22.Ao Ar GNUNET_URI Ac
23.Sh DESCRIPTION 23.Sh DESCRIPTION
24Download files from GNUnet. 24Download files from GNUnet.
25The options are as follows:
25.Bl -tag -width Ds 26.Bl -tag -width Ds
26.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 27.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
27This option can be used to specify additional anonymity constraints. The default is 1. 28This option can be used to specify additional anonymity constraints.
29The default is 1.
28If 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. 30If 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.
29This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). 31This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
30If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). 32If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
31However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. 33However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
32You can gain better privacy by specifying a higher level of anonymity (using values above 1). 34You can gain better privacy by specifying a higher level of anonymity (using values above 1).
33This tells FS that it must hide your own requests in equivalent\-looking cover traffic. 35This tells FS that it must hide your own requests in equivalent-looking cover traffic.
34This should confound an adversaries traffic analysis, increasing the time and effort it would 36This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
35take to discover your identity. However, it also can significantly reduce performance, as 37However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
36your requests will be delayed until sufficient cover traffic is available. The specific 38The specific numeric value (for anonymity levels above 1) is simple:
37numeric value (for anonymity levels above 1) is simple: 39Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
38Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent 40The time-period is twice the average delay by which GNUnet artificially delays traffic.
39requests of cover traffic (traffic your peer routes for others) in the same time\-period. 41Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
40The time\-period is twice the average delay by which GNUnet artificially delays traffic.
41Note that regardless of the anonymity level you choose, peers that cache content in the
42network always use anonymity level 1.
43.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 42.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
44Use config file (default: 43Use config file (default:
45.Pa ~/.config/gnunet.conf Ns ) 44.Pa ~/.config/gnunet.conf Ns )
@@ -89,9 +88,9 @@ must end in '.gnd' \(em otherwise, you will receive an error.
89You may want to use "DIRNAME/.gnd" for the filename, this way a directory "DIRNAME/" will be created, and GNUnet's internal directory information will be stored in "DIRNAME/.gnd". 88You may want to use "DIRNAME/.gnd" for the filename, this way a directory "DIRNAME/" will be created, and GNUnet's internal directory information will be stored in "DIRNAME/.gnd".
90However, it is also possible to specify "DIRNAME.gnd", in which case the files from the directory will end up in "DIRNAME/", while GNUnet's directory meta data will be in "DIRNAME.gnd". 89However, it is also possible to specify "DIRNAME.gnd", in which case the files from the directory will end up in "DIRNAME/", while GNUnet's directory meta data will be in "DIRNAME.gnd".
91.It Fl v | \-version 90.It Fl v | \-version
92print the version number 91Print the version number.
93.It Fl V | \-verbose 92.It Fl V | \-verbose
94print progress information 93Print progress information.
95.El 94.El
96.Ss NOTES 95.Ss NOTES
97The GNUNET_URI is typically obtained from 96The GNUNET_URI is typically obtained from
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index ca4acfebe..79004bab5 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -1,80 +1,112 @@
1.TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-identity \- create, delete or list egos 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-identity 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6[options] 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\-identity is a tool for managing egos. 9.\" ``FDL-1.3''.
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
25.Dt GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet"
26.Os
27.Sh NAME
28.Nm gnunet-identity
29.Nd
30create, delete or list egos
31.Sh SYNOPSIS
32.Nm
33.Op Fl C Ar NAME | Fl \-create= Ns Ar NAME
34.Op Fl D Ar NAME | Fl \-delete= Ns Ar NAME
35.Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME
36.Op Fl h | \-help
37.Op Fl d | \-display
38.Op Fl m | \-monitor
39.Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
40.Sh DESCRIPTION
41.Nm
42is a tool for managing egos.
10An ego is the persona that controls a namespace. 43An ego is the persona that controls a namespace.
11It is identical to a public\-private ECC key pair. 44It is identical to a public-private ECC key pair.
12.PP 45.Pp
13gnunet\-identity can be used to list all of the egos that were created 46gnunet-identity can be used to list all of the egos that were created locally, to create new egos, and to delete existing egos (the namespace will continue to exist, but it will be impossible to add additional data to it).
14locally, to create new egos, and to delete existing egos (the 47.Pp
15namespace will continue to exist, but it will be impossible to add 48Creating a new ego requires using the
16additional data to it). 49.Fl C
17.PP 50option together with an identifier (name) that is to be used for the new ego.
18Creating a new ego requires using the \-C option together with an 51This identifier is only used locally for this peer and not shared with other peers.
19identifier (name) that is to be used for the new ego. 52The options are as follows:
20This identifier is only used locally for this peer and not shared with 53.Bl -tag -width Ds
21other peers. 54.It Fl C Ar NAME | Fl \-create= Ns Ar NAME
22.TP 55Creates a new ego with the given
23\fB\-C NAME\fR, \fB\-\-create=NAME\fR 56.Ar NAME .
24Creates a new ego with the given NAME. 57.It Fl D Ar NAME | Fl \-delete= Ns Ar NAME
25.TP 58Delete the ego with the given
26\fB\-D NAME\fR, \fB\-\-delete=NAME\fR 59.Ar NAME .
27Delete the ego with the given NAME. 60.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME
28.TP
29\fB\-e NAME\fR, \fB\-\-ego=NAME\fR
30Perform "set" operation with the respective ego. 61Perform "set" operation with the respective ego.
31Needs to be used together with option \-s. 62Needs to be used together with option
32.TP 63.Fl s .
33\fB\-h\fR, \fB\-\-help\fR 64.It Fl h | \-help
34Print help page. 65Print the help page.
35.TP 66.It d | \-display
36\fB\-d\fR, \fB\-\-display\fR 67Display all of our egos.
37display all of our egos 68.It m | \-monitor
38.TP
39\fB\-m\fR, \fB\-\-monitor\fR
40Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 69Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
41Each ego is listed together with a unique pointer value; if egos are 70Each ego is listed together with a unique pointer value; if egos are renamed, that pointer value remains the same; if egos are deleted, they are listed one more time with a name of "<null>".
42renamed, that pointer value remains the same; if egos are deleted, 71.It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
43they are listed one more time with a name of "<null>". 72Perform "set" operation for the specified
44.TP 73.Ar SUBSYSTEM
45\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR 74with the respective ego.
46Perform "set" operation for the specified SUBSYSTEM with the 75Needs to be used together with option
47respective ego. 76.Fl e .
48Needs to be used together with option \-e. 77After this, the given SUBSYSTEM will use the ego with the specified NAME.
49After this, the given SUBSYSTEM will use the ego with the specified 78This will fail if
50NAME. 79.Ar NAME
51This will fail if NAME does not yet exist. 80does not yet exist.
52.SH FILES 81.El
53.TP 82.Sh FILES
54~/.local/share/gnunet/identity/egos 83.Pa ~/.local/share/gnunet/identity/egos
55Directory where the egos are stored (by default) 84Directory where the egos are stored by default
56.SH BUGS 85.\".Sh EXAMPLES
57Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 86.Sh SEE ALSO
58electronic mail to <gnunet\-developers@gnu.org> 87.Xr gnunet-gns 1 ,
59.SH SEE ALSO 88.Xr gnunet-namestore 1
60\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\fP(1) 89.sp
61The full documentation for 90The full documentation for gnunet is maintained as a Texinfo manual.
62.B gnunet
63is maintained as a Texinfo manual.
64If the 91If the
65.B info 92.Xr info 1
66and 93and gnunet programs are properly installed at your site, the command
67.B gnunet 94.Pp
68programs are properly installed at your site, the command 95.Dl info gnunet
69.IP 96.Pp
70.B info gnunet
71.PP
72should give you access to the complete handbook, 97should give you access to the complete handbook,
73.IP 98.Pp
74.B info gnunet-c-tutorial 99.Dl info gnunet-c-tutorial
75.PP 100.Pp
76will give you access to a tutorial for developers. 101will give you access to a tutorial for developers.
77.PP 102.sp
78Depending on your installation, this information is also 103Depending on your installation, this information is also available in
79available in 104.Xr gnunet 7 and
80\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 105.Xr gnunet-c-tutorial 7 .
106.\".Sh HISTORY
107.\".Sh AUTHORS
108.Sh BUGS
109Report bugs by using
110.Lk https://bugs.gnunet.org
111or by sending electronic mail to
112.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index c1eca224f..cbfe39719 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -1,66 +1,104 @@
1.TH GNUNET-NAMESTORE-FCFSD 1 "September 5, 2013" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-namestore-fcfsd 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.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8Most users will not want to run an FCFS\-zone and thus will not need 8.\" copy of the license is included in the file
9this program. 9.\" ``FDL-1.3''.
10.PP 10.\"
11\fBgnunet\-gns-fcfsd\fP runs a web server where users can register 11.\" A copy of the license is also available from the Free Software
12names to be mapped to their GNS zone. Names are made available on a 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13First Come First Served basis (hence fcfs). Registered names do not 13.\"
14expire. The HTTP server is run on the port that is specified in the 14.\" Alternately, this document is also available under the General
15configuration file in section "[fcfsd]" under the name "HTTPPORT". 15.\" Public License, version 3 or later, as published by the Free Software
16.PP 16.\" Foundation. A copy of the license is included in the file
17It is possible to manage gnunet\-gns\-fcfsd using 17.\" ``GPL3''.
18gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i 18.\"
19fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your 19.\" A copy of the license is also available from the Free Software
20configuration and the "-z ZONE" in as the "OPTION". 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.PP 21.\"
22An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23encouraged to register their zone with the gnunet.org FCFS authority. 23.\"
24.PP 24.Dd September 5, 2013
25If you want to run your own FCFS registrar, you need to first create a 25.Dt GNUNET-NAMESTORE-FCFSD 1
26pseudonym (using "gnunet\-identity \-C NAME"), and use it with the 26.Os
27"-z" option. After that, you can start the FCFSD service (possibly using 27.Sh NAME
28gnunet\-arm). 28.Nm gnunet-namestore-fcfsd
29.SH OPTIONS 29.Nd
30.IP "\-c FILENAME, \-\-config=FILENAME" 30HTTP server for GNU Name System First-Come-First-Served name registration
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36.Op Fl v | \-version
37.Op Fl z Ar EGO | \-zone= Ns Ar EGO
38.Sh DESCRIPTION
39Most users will not want to run an FCFS-zone and thus will not need this program.
40.Pp
41.Nm
42runs a web server where users can register names to be mapped to their GNS zone.
43Names are made available on a First Come First Served basis (hence fcfs).
44Registered names do not expire.
45The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT".
46.Pp
47It is possible to manage gnunet-gns-fcfsd using gnunet-(service-arm) by starting the daemon using "gnunet-arm -i fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your configuration and the "-z ZONE" in as the "OPTION".
48.Pp
49An FCFS-zone is run at
50.Lk http://gnunet.org/fcfs/ .
51GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
52.Pp
53If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet-identity -C NAME"), and use it with the
54.Fl z
55option.
56After that, you can start the FCFSD service (possibly using
57.Xr gnunet-arm 1 Ns ).
58.Pp
59The options are as follows:
60.Bl -tag -width Ds
61.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
31Use the configuration file FILENAME. 62Use the configuration file FILENAME.
32.IP "\-h, \-\-help" 63.It Fl h | \-help
33Print short help on options. 64Print short help on options.
34.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 65.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 66Use LOGLEVEL for logging.
36ERROR. 67Valid values are DEBUG, INFO, WARNING and ERROR.
37.IP "\-v, \-\-version" 68.It Fl v | \-version
38Print GNUnet version number. 69Print GNUnet version number.
39.IP "\-z EGO, \-\-zone=EGO" 70.It Fl z Ar EGO | \-zone= Ns Ar EGO
40Specifies for which EGO should FCFSD manage the zone. 71Specifies for which
41.SH BUGS 72.Ar EGO
42Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 73FCFSD should manage the zone.
43electronic mail to <bug\-gnunet@gnu.org> 74.El
44.SH SEE ALSO 75.\".Sh EXAMPLES
45gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) 76.\".Sh FILES
46.PP 77.Sh SEE ALSO
47The full documentation for 78.Xr gnunet-identity 1 ,
48.B gnunet 79.Xr gnunet-gns 1 ,
49is maintained as a Texinfo manual. 80.Xr gnunet-gns-proxy 1
81.sp
82The full documentation for gnunet is maintained as a Texinfo manual.
50If the 83If the
51.B info 84.Xr info 1
52and 85and gnunet programs are properly installed at your site, the command
53.B gnunet 86.Pp
54programs are properly installed at your site, the command 87.Dl info gnunet
55.IP 88.Pp
56.B info gnunet
57.PP
58should give you access to the complete handbook, 89should give you access to the complete handbook,
59.IP 90.Pp
60.B info gnunet-c-tutorial 91.Dl info gnunet-c-tutorial
61.PP 92.Pp
62will give you access to a tutorial for developers. 93will give you access to a tutorial for developers.
63.PP 94.sp
64Depending on your installation, this information is also 95Depending on your installation, this information is also available in
65available in 96.Xr gnunet 7 and
66\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 97.Xr gnunet-c-tutorial 7 .
98.\".Sh HISTORY
99.\".Sh AUTHORS
100.Sh BUGS
101Report bugs by using
102.Lk https://bugs.gnunet.org
103or by sending electronic mail to
104.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 6a824cc47..6a399c360 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -1,104 +1,138 @@
1.TH GNUNET\-NAMESTORE 1 "April 15, 2014" "GNUnet" 1.\" This file is part of GNUnet.
2 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.SH NAME 3.\"
4gnunet\-namestore \- manipulate GNU Name System (GNS) zone data 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\-namestore 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.RI [ options ] -z ZONEFILE 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\-namestore\fP can be used to manipulate records in a GNS zone. 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13 13.\"
14.SH OPTIONS 14.\" Alternately, this document is also available under the General
15.IP "\-a, \-\-add" 15.\" Public License, version 3 or later, as published by the Free Software
16Desired operation is adding a record 16.\" Foundation. A copy of the license is included in the file
17.IP "\-c FILENAME, \-\-config=FILENAME" 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 April 15, 2014
25.Dt GNUNET-NAMESTORE 1
26.Os
27.Sh NAME
28.Nm gnunet-namestore
29.Nd
30manipulate GNU Name System (GNS) zone data
31.Sh SYNOPSIS
32.Nm
33.Op Fl a | \-add
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
35.Op Fl d | \-delete
36.Op Fl D | \-display
37.Op Fl e Ar TIME | Fl \-expiration= Ns Ar TIME
38.Op Fl h | \-help
39.Op Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME
40.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
41.Op Fl m | \-monitor
42.Op Fl n Ar NAME | Fl \-name= Ns Ar NAME
43.Op Fl p | \-public
44.Op Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY
45.Op Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE
46.Op Fl s | \-shadow
47.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
48.Op Fl u Ar URI | Fl \-uri= Ns Ar URI
49.Op Fl v | \-version
50.Op Fl V Ar VALUE | Fl \-value= Ns Ar VALUE
51.Op Fl z Ar EGO | Fl \-zone= Ns Ar EGO
52.Sh DESCRIPTION
53.Nm
54can be used to manipulate records in a GNS zone.
55.Pp
56The options are as follows:
57.Bl -tag -width Ds
58.It Fl a | \-add
59Desired operation is adding a record.
60.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
18Use the configuration file FILENAME. 61Use the configuration file FILENAME.
19.IP "\-d, \-\-delete" 62.It Fl d | \-delete
20Desired operation is deleting records under the given name that match 63Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V).
21the specified type (\-t) and value (\-V). If type or value are not 64If type or value are not specified, it means that all types (or values) should be assumed to match (and possibly multiple or all values under the given label will be deleted).
22specified, it means that all types (or values) should be assumed to 65Specifying a label (\-n) is mandatory.
23match (and possibly multiple or all values under the given label will 66Note that matching by expiration time or flags is (currently) not supported.
24be deleted). Specifying a label (\-n) is mandatory. Note that 67.It Fl D | \-display
25matching by expiration time or flags is (currently) not supported. 68Desired operation is listing of matching records.
26.IP "\-D, \-\-display" 69.It Fl e Ar TIME | Fl \-expiration= Ns Ar TIME
27Desired operation is listing of matching records 70Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m".
28.IP "\-e TIME, \-\-expiration=TIME" 71Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years).
29Specifies expiration time of record to add; format is relative time, 72.It Fl h | \-help
30i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or
31"minutes", "h" (hours), "d" (days) and "a" (years).
32.IP "\-h, \-\-help"
33Print short help on options. 73Print short help on options.
34.IP "\-i NICKNAME, \-\-nick=NICKNAME" 74.It Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME
35Set the desired NICKNAME for the zone. The nickname will be included 75Set the desired NICKNAME for the zone.
36in all (public) records and used as the suggested name for this zone. 76The nickname will be included in all (public) records and used as the suggested name for this zone.
37.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 77.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
38Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 78Use LOGLEVEL for logging.
39ERROR. 79Valid values are DEBUG, INFO, WARNING and ERROR.
40.IP "\-m, \-\-monitor" 80.It Fl m | \-monitor
41Monitor changes to the zone on an ongoing basis (in contrast to \-D, 81Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records).
42which merely displays the current records) 82.It Fl n Ar NAME | Fl \-name= Ns Ar NAME
43.IP "\-n NAME, \-\-name=NAME" 83Label or name of the record to add/delete/display.
44Label or name of the record to add/delete/display 84.It Fl p | \-public
45.IP "\-p, \-\-public" 85Create a record that is public (shared with other users that know the label).
46Create a record that is public (shared with other users that know the 86.It Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY
47label) 87Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone.
48.IP "\-r PKEY, \-\-reverse=PKEY" 88.It Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE
49Determine our GNS name for the given public key (reverse lookup of the 89Sets record set to values given in RECORDLINE.
50PKEY) in the given zone. 90This option can be specified multiple times to provide multiple records for the record set.
51.IP "\-R RECORDLINE, \-\-replace=RECORDLINE" 91Existing records under the same label will be deleted.
52Sets record set to values given in RECORDLINE. This option can be specified multiple 92The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is the time to live in seconds (unit must not be given explicitly, seconds is always implied), TYPE is the DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
53times to provide multiple records for the record set. Existing records under the 93The VALUE follows the usual human-readable value format(s) of DNS/GNS.
54same label will be deleted. The format for the RECORDLINE is 94.It Fl s | \-shadow
55"TTL TYPE FLAGS VALUE" where TTL is the time to live in seconds (unit must not 95Create a record that is a shadow record.
56be given explicitly, seconds is always implied), TYPE is the 96Shadow records are only used once all other records of the same type under the same label have expired.
57DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE 97.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
58follows the usual human-readable value format(s) of DNS/GNS. 98Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.).
59.IP "\-s, \-\-shadow" 99.It Fl u Ar URI | Fl \-uri= Ns Ar URI
60Create a record that is a shadow record. Shadow records are only used 100Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used
61once all other records of the same type under the same label have 101.It Fl v | \-version
62expired.
63.IP "\-t TYPE, \-\-type=TYPE"
64Type of the record to add/delete/display (i.e. "A", "AAAA", "NS",
65"PKEY", "MX" etc.)
66.IP "\-u URI, \-\-uri=URI"
67Add PKEY record from gnunet://gns/-URI to our zone; the record type is
68always PKEY, if no expiration is given FOREVER is used
69.IP "\-v, \-\-version"
70Print GNUnet version number. 102Print GNUnet version number.
71.IP "\-V VALUE, \-\-value=VALUE" 103.It Fl V Ar VALUE | Fl \-value= Ns Ar VALUE
72Value to store or remove from the GNS zone. Specific format depends 104Value to store or remove from the GNS zone.
73on the record type. A records expect a dotted decimal IPv4 address, 105Specific format depends on the record type.
74AAAA records an IPv6 address, PKEY a public key in GNUnet's printable 106A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name.
75format, and CNAME and NS records should be a domain name. 107.It Fl z Ar EGO | Fl \-zone= Ns Ar EGO
76.IP "\-z EGO, \-\-zone=EGO" 108Specifies the name of the ego controlling the private key for the zone (mandatory option).
77Specifies the name of the ego controlling the private key for the zone 109.El
78(mandatory option) 110.\".Sh EXAMPLES
79 111.\".Sh FILES
80 112.Sh SEE ALSO
81.SH BUGS 113.Xr gnunet-gns 1 ,
82Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 114.Xr gnunet-namestore-gtk 1
83electronic mail to <gnunet\-developers@gnu.org> 115.sp
84.SH SEE ALSO 116The full documentation for gnunet is maintained as a Texinfo manual.
85\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1) 117If the
86The full documentation for 118.Xr info 1
87.B gnunet 119and gnunet programs are properly installed at your site, the command
88is maintained as a Texinfo manual. If the 120.Pp
89.B info 121.Dl info gnunet
90and 122.Pp
91.B gnunet
92programs are properly installed at your site, the command
93.IP
94.B info gnunet
95.PP
96should give you access to the complete handbook, 123should give you access to the complete handbook,
97.IP 124.Pp
98.B info gnunet-c-tutorial 125.Dl info gnunet-c-tutorial
99.PP 126.Pp
100will give you access to a tutorial for developers. 127will give you access to a tutorial for developers.
101.PP 128.sp
102Depending on your installation, this information is also 129Depending on your installation, this information is also available in
103available in 130.Xr gnunet 7 and
104\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 131.Xr gnunet-c-tutorial 7 .
132.\".Sh HISTORY
133.\".Sh AUTHORS
134.Sh BUGS
135Report bugs by using
136.Lk https://bugs.gnunet.org
137or by sending electronic mail to
138.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index efd4b5df1..405020e37 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -1,67 +1,106 @@
1.TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-nat\-auto \- autoconfigure and test NAT traversal 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-nat\-auto 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.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8This tool allows testing various NAT traversal functions, as well 8.\" copy of the license is included in the file
9as attempting auto\-configuration. 9.\" ``FDL-1.3''.
10.SH OPTIONS 10.\"
11.IP "\-a, \-\-auto" 11.\" A copy of the license is also available from the Free Software
12Attempt auto\-configuration for NAT traversal. 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.IP "\-c FILENAME, \-\-config=FILENAME" 13.\"
14Use the configuration file FILENAME. 14.\" Alternately, this document is also available under the General
15.IP "\-S NAME, \-\-section=NAME" 15.\" Public License, version 3 or later, as published by the Free Software
16Name of the configuration section with details about the configuration 16.\" Foundation. A copy of the license is included in the file
17to test. For example "transport-tcp". 17.\" ``GPL3''.
18.IP "\-t, \-\-tcp" 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 January 6, 2017
25.Dt GNUNET-NAT-AUTO 1
26.Sh NAME
27.Nm gnunet-nat-auto
28.Nd
29autoconfigure and test NAT traversal
30.Sh SYNOPSIS
31.Nm
32.Op Fl a | \-auto
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl S Ar NAME | Fl \-section= Ns Ar NAME
35.Op Fl t | \-tcp
36.Op Fl u | \-udp
37.Op Fl w | \-write
38.Sh DESCRIPTION
39.Nm
40allows testing various NAT traversal functions, as well as attempting auto-configuration.
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl a | \-auto
44Attempt auto-configuration for NAT traversal.
45.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
46Use the configuration file
47.Ar FILENAME .
48.It Fl S Ar NAME | Fl \-section= Ns Ar NAME
49Name of the configuration section with details about the configuration to test.
50For example "transport-tcp".
51.It Fl t | \-tcp
19Use TCP. 52Use TCP.
20.IP "\-u, \-\-udp" 53.It Fl u | \-udp
21Use UDP. 54Use UDP.
22.IP "\-w, \-\-write" 55.It Fl w | \-write
23Write configuration to configuration file, useful in combination with 56Write configuration to configuration file, useful in combination with auto-configuration
24autoconfiguration (\-a). 57.Pq Fl a .
25.SH EXAMPLES 58.El
26.PP 59.Sh EXAMPLES
27\fBAutomatic configuration:\fR 60.Ss Automatic configuration:
28.TP 61.Pp
29# gnunet\-nat\-auto \-aw 62.Dl # gnunet-nat-auto -aw
63.Pp
30Probe and write result to configuration 64Probe and write result to configuration
31.PP 65.Ss Test configuration:
32\fBTest configuration:\fR 66.Pp
33.TP 67.Pp
34# gnunet\-nat\-auto -t \-S transport-tcp 68.Dl # gnunet-nat-auto -t -S transport-tcp
69.Pp
35Test TCP configuration 70Test TCP configuration
36.TP 71.Pp
37# gnunet\-nat\-auto -t \-S transport-http 72.Dl # gnunet-nat-auto -t -S transport-http
73.Pp
38Test HTTP configuration 74Test HTTP configuration
39.TP 75.Pp
40# gnunet\-nat\-auto -u \-S transport-udp 76.Dl # gnunet-nat-auto -u -S transport-udp
77.Pp
41Test UDP configuration 78Test UDP configuration
42.SH BUGS 79.\".Sh FILES
43Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 80.Sh SEE ALSO
44electronic mail to <gnunet\-developers@gnu.org> 81.Xr gnunet-nat 1 ,
45.SH SEE ALSO 82.Xr gnunet-transport 1
46gnunet\-transport(1) gnunet\-nat(1) 83.sp
47.PP 84The full documentation for gnunet is maintained as a Texinfo manual.
48The full documentation for
49.B gnunet
50is maintained as a Texinfo manual.
51If the 85If the
52.B info 86.Xr info 1
53and 87and gnunet programs are properly installed at your site, the command
54.B gnunet 88.Pp
55programs are properly installed at your site, the command 89.Dl info gnunet
56.IP 90.Pp
57.B info gnunet
58.PP
59should give you access to the complete handbook, 91should give you access to the complete handbook,
60.IP 92.Pp
61.B info gnunet-c-tutorial 93.Dl info gnunet-c-tutorial
62.PP 94.Pp
63will give you access to a tutorial for developers. 95will give you access to a tutorial for developers.
64.PP 96.sp
65Depending on your installation, this information is also 97Depending on your installation, this information is also available in
66available in 98.Xr gnunet 7 and
67\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 99.Xr gnunet-c-tutorial 7 .
100.\".Sh HISTORY
101.\".Sh AUTHORS
102.Sh BUGS
103Report bugs by using
104.Lk https://bugs.gnunet.org
105or by sending electronic mail to
106.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index 8cb995f7c..b8462d9da 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,71 +1,105 @@
1.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-nat\-server 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.RI PORT 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
9Normal GNUnet end-users should not concern themselves with 9.\" ``FDL-1.3''.
10gnunet\-nat\-server. In fact, distributions are encouraged to 10.\"
11consider not shipping it at all. Running gnunet\-nat\-server's is 11.\" A copy of the license is also available from the Free Software
12similar to running hostlist servers: it is a special service to the 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13community with special requirements and no benefit to those running 13.\"
14the service. 14.\" Alternately, this document is also available under the General
15.PP 15.\" Public License, version 3 or later, as published by the Free Software
16This program will listen on the specified PORT for incoming requests 16.\" Foundation. A copy of the license is included in the file
17to test a peer's network connectivity. Incoming requests can ask it 17.\" ``GPL3''.
18to connect to a given IPv4 address (and port) using TCP or UDP and to 18.\"
19send a 2-byte test message using the specified address. The program 19.\" A copy of the license is also available from the Free Software
20can also be asked to send a "fake" ICMP response message to a given 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21IPv4 address (for autonomous NAT traversal \-\-\- see the description 21.\"
22in the respective research paper). 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.PP 23.\"
24The idea is that gnunet\-nat\-server will be run on some trusted hosts 24.Dd February 25, 2012
25with unrestricted connectivity to allow GNUnet users to test their 25.Dt GNUNET-NAT-SERVER 1
26network configuration. As written, the code allows any user on the 26.Os
27Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary 27.Sh NAME
28data to any TCP or UDP port at any address. We believe that this is 28.Nm gnunet-nat-server
29generally harmless. 29.Nd
30.PP 30help GNUnet setup test network setup with NAT
31When running gnunet\-nat\-server, make sure to use a configuration 31.Sh SYNOPSIS
32that disables most NAT options but enables 'enable_nat_client' and 32.Nm
33sets 'internal_address' to the global IP address of your local host. 33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34Also, the gnunet\-helper\-nat\-client should be installed locally and 34.Op Fl d | \-daemonize
35run with root privileges (SUID), otherwise the gnunet\-nat\-server 35.Op Fl h | \-help
36will not work properly. 36.Op Fl L Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
37.PP 37.Op Fl v | \-version
38Note that gnunet\-nat\-server could be run via gnunet\-arm but 38.Ao Ar PORT Ac
39typically is not. Also, the name of the host and port that 39.Sh DESCRIPTION
40gnunet\-nat\-server is run on should be specified in the NATSERVER 40Running a gnunet-nat-server is similar to running a hostlist server: it is a special service to the community with special requirements and no benefit to those running the service.
41option in the [setup] section of the configuration file of hosts that 41.Pp
42are supposed to autoconfigure with this server. 42This program will listen on the specified
43.SH OPTIONS 43.Ar PORT
44.IP "\-c FILENAME, \-\-config=FILENAME" 44for incoming requests to test a peer's network connectivity.
45Use the configuration file FILENAME. 45Incoming requests can ask it to connect to a given IPv4 address (and port) using TCP or UDP and to send a 2-byte test message using the specified address.
46.SH BUGS 46The program can also be asked to send a "fake" ICMP response message to a given IPv4 address (for autonomous NAT traversal --- see the description in the respective research paper).
47Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 47.Pp
48electronic mail to <gnunet\-developers@gnu.org> 48The idea is that gnunet-nat-server will be run on some trusted hosts with unrestricted connectivity to allow GNUnet users to test their network configuration.
49.SH SEE ALSO 49As written, the code allows any user on the Internet to cause the gnunet-nat-server to send 2-bytes of arbitrary data to any TCP or UDP port at any address.
50gnunet\-transport(1) 50We believe that this is generally harmless.
51.PP 51.Pp
52The full documentation for 52When running gnunet-nat-server, make sure to use a configuration that disables most NAT options but enables 'enable_nat_client' and sets 'internal_address' to the global IP address of your local host.
53.B gnunet 53Also, the gnunet-helper-nat-client should be installed locally and run with root privileges (SUID), otherwise the gnunet-nat-server will not work properly.
54is maintained as a Texinfo manual. 54.Pp
55Note that gnunet-nat-server could be run via gnunet-arm but typically is not.
56Also, the name of the host and port that gnunet-nat-server is run on should be specified in the NATSERVER option in the [setup] section of the configuration file of hosts that are supposed to autoconfigure with this server.
57.Pp
58Normal GNUnet end-users should not concern themselves with gnunet-nat-server.
59In fact, distributions are encouraged to consider not shipping it at all.
60.Pp
61The options are as follows:
62.Bl -tag -width Ds
63.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
64Use the configuration file
65.Ar FILENAME .
66.It Fl d | \-daemonize
67Daemonize gnunet-nat-server (detach from terminal).
68.It Fl h | \-help
69Print the help page.
70.It Fl L Ar LOGLEVEL | Fl \-log= Ns Ar LOGLEVEL
71Configure logging to use
72.Ar LOGLEVEL .
73.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
74Configure logging to write logs to
75.Ar FILENAME .
76.It Fl v | \-version
77Print the GNUnet version.
78.El
79.\".Sh EXAMPLES
80.Sh SEE ALSO
81.Xr gnunet-transport 1
82.sp
83The full documentation for gnunet is maintained as a Texinfo manual.
55If the 84If the
56.B info 85.Xr info 1
57and 86and gnunet programs are properly installed at your site, the command
58.B gnunet 87.Pp
59programs are properly installed at your site, the command 88.Dl info gnunet
60.IP 89.Pp
61.B info gnunet
62.PP
63should give you access to the complete handbook, 90should give you access to the complete handbook,
64.IP 91.Pp
65.B info gnunet-c-tutorial 92.Dl info gnunet-c-tutorial
66.PP 93.Pp
67will give you access to a tutorial for developers. 94will give you access to a tutorial for developers.
68.PP 95.sp
69Depending on your installation, this information is also 96Depending on your installation, this information is also available in
70available in 97.Xr gnunet 7 and
71\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 98.Xr gnunet-c-tutorial 7 .
99.\".Sh HISTORY
100.\".Sh AUTHORS
101.Sh BUGS
102Report bugs by using
103.Lk https://bugs.gnunet.org
104or by sending electronic mail to
105.Aq Mt gnunet-developers@gnu.org .
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index b003f27e0..c41e34a8c 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -45,7 +45,7 @@ a command line interface for publishing new content into GNUnet
45.Op Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME 45.Op Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME
46.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 46.Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
47.Op Fl s | \-simulate-only 47.Op Fl s | \-simulate-only
48.Op Fl t Ar ID, \-this= Ns Ar ID 48.Op Fl t Ar ID | Fl \-this= Ns Ar ID
49.Op Fl u Ar URI | Fl \-uri= Ns Ar URI 49.Op Fl u Ar URI | Fl \-uri= Ns Ar URI
50.Op Fl v | \-version 50.Op Fl v | \-version
51.Op Fl V | \-verbose 51.Op Fl V | \-verbose
@@ -125,25 +125,24 @@ However, indexing only works if the indexed file can be read (using the same abs
125If this is not the case, indexing will fail (and gnunet-publish will automatically revert to publishing instead). 125If this is not the case, indexing will fail (and gnunet-publish will automatically revert to publishing instead).
126Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. 126Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network.
127If you publish or index a file and then leave the network, it will almost always NOT be available anymore. 127If you publish or index a file and then leave the network, it will almost always NOT be available anymore.
128.Sh OPTIONS 128.Pp
129The options are as follows:
129.Bl -tag -width Ds 130.Bl -tag -width Ds
130.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 131.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
131This option can be used to specify additional anonymity constraints. The default is 1. 132This option can be used to specify additional anonymity constraints.
133The default is 1.
132If 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. 134If 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.
133This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). 135This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
134If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). 136If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
135However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. 137However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
136You can gain better privacy by specifying a higher level of anonymity (using values above 1). 138You can gain better privacy by specifying a higher level of anonymity (using values above 1).
137This tells FS that it must hide your own requests in equivalent\-looking cover traffic. 139This tells FS that it must hide your own requests in equivalent-looking cover traffic.
138This should confound an adversaries traffic analysis, increasing the time and effort it would 140This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
139take to discover your identity. However, it also can significantly reduce performance, as 141However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
140your requests will be delayed until sufficient cover traffic is available. The specific 142The specific numeric value (for anonymity levels above 1) is simple:
141numeric value (for anonymity levels above 1) is simple: 143Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
142Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent 144The time-period is twice the average delay by which GNUnet artificially delays traffic.
143requests of cover traffic (traffic your peer routes for others) in the same time\-period. 145Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
144The time\-period is twice the average delay by which GNUnet artificially delays traffic.
145Note that regardless of the anonymity level you choose, peers that cache content in the
146network always use anonymity level 1.
147.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 146.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
148Use alternate config file FILENAME. 147Use alternate config file FILENAME.
149If this option is not specified, the default is 148If this option is not specified, the default is
@@ -174,12 +173,20 @@ Executive summary: You probably don't need it.
174Do not index, full publishing. 173Do not index, full publishing.
175Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option). 174Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option).
176With this option, every block of the actual files is stored in encrypted form in the block database of the local peer. 175With this option, every block of the actual files is stored in encrypted form in the block database of the local peer.
177While this adds security if the local node is compromised (the adversary snags your machine), it is significantly less efficient compared to on\-demand encryption and is definitely not recommended for large files. 176While this adds security if the local node is compromised (the adversary snags your machine), it is significantly less efficient compared to on-demand encryption and is definitely not recommended for large files.
178.It Fl N Ar ID | Fl \-next= Ns Ar ID 177.It Fl N Ar ID | Fl \-next= Ns Ar ID
179Specifies the next identifier of a future version of the file to be published under the same pseudonym. 178Specifies the next identifier of a future version of the file to be published under the same pseudonym.
180This option is only valid together with the \-P option. 179This option is only valid together with the
180.Fl P
181option.
181This option can be used to specify what the identifier of an updated version will look like. 182This option can be used to specify what the identifier of an updated version will look like.
182Note that specifying \-i and \-N without \-t is not allowed. 183Note that specifying
184.Fl i
185and
186.Fl N
187without
188.Fl t
189is not allowed.
183.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY 190.It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
184Executive summary: You probably don't need it. 191Executive summary: You probably don't need it.
185Set the priority of the published content (default: 365). 192Set the priority of the published content (default: 365).
@@ -187,8 +194,9 @@ If the local database is full, GNUnet will discard the content with the lowest r
187Note that ranks change over time depending on popularity. 194Note that ranks change over time depending on popularity.
188The default should be high enough to preserve the locally published content in favor of content that migrates from other peers. 195The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
189.It Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME 196.It Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME
190For the top\-level directory or file, places the file into the namespace identified by the pseudonym NAME. 197For the top-level directory or file, places the file into the namespace identified by the pseudonym NAME.
191NAME must be a valid pseudonym managed by gnunet\-identity. 198NAME must be a valid pseudonym managed by
199.Xr gnunet-identity 1 .
192.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL 200.It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
193Set the desired replication level. 201Set the desired replication level.
194If 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. 202If 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.
@@ -197,70 +205,122 @@ Note that pushing content LEVEL times into the network does not guarantee that t
197.It Fl s | \-simulate-only 205.It Fl s | \-simulate-only
198When this option is used, gnunet\-publish will not actually publish the file but just simulate what would be done. 206When this option is used, gnunet\-publish will not actually publish the file but just simulate what would be done.
199This can be used to compute the GNUnet URI for a file without actually sharing it. 207This can be used to compute the GNUnet URI for a file without actually sharing it.
200.It Fl t Ar ID, \-this= Ns Ar ID 208.It Fl t Ar ID | Fl \-this= Ns Ar ID
201Specifies the identifier under which the file is to be published under a pseudonym. 209Specifies the identifier under which the file is to be published under a pseudonym.
202This option is only valid together with the\ \-P option. 210This option is only valid together with the
211.Fl P
212option.
203.It Fl u Ar URI | Fl \-uri= Ns Ar URI 213.It Fl u Ar URI | Fl \-uri= Ns Ar URI
204This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted). 214This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted).
205Instead of publishing a file or directory and using the corresponding URI, gnunet\-publish will use this URI and perform the selected namespace or keyword operations. 215Instead of publishing a file or directory and using the corresponding URI, gnunet-publish will use this URI and perform the selected namespace or keyword operations.
206This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available. 216This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available.
207.It Fl v | \-version 217.It Fl v | \-version
208Print the version number. 218Print the version number.
209.It Fl V | \-verbose 219.It Fl V | \-verbose
210Be verbose. 220Be verbose.
211Using 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. 221Using 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.
212.El 222.El
213.Sh EXAMPLES 223.Sh EXAMPLES
214.Ss BASIC EXAMPLES 224.Ss BASIC EXAMPLES
215Index a file COPYING: 225Index a file
226.Pa COPYING :
216.Pp 227.Pp
217.Dl gnunet-publish COPYING 228.Dl gnunet-publish COPYING
218.Pp 229.Pp
219Publish a file COPYING: 230Publish a file
231.Pa COPYING :
220.Pp 232.Pp
221.Dl gnunet\-publish \-n COPYING 233.Dl gnunet-publish -n COPYING
222.Pp 234.Pp
223Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR 235Index a file
236.Pa COPYING
237with the keywords
238.Ar gpl
239and
240.Ar test :
224.Pp 241.Pp
225.Dl gnunet\-publish \-k gpl \-k test COPYING 242.Dl gnunet-publish -k gpl -k test COPYING
226.Pp 243.Pp
227Index a file COPYING with description "GNU License", mime-type "text/plain" and keywords \fBgpl\fR and \fBtest\fR 244Index a file
245.Pa COPYING
246with description
247.Ar "GNU License" ,
248mime-type
249.Ar "text/plain"
250and keywords
251.Ar gpl
252and
253.Ar test:
228.Pp 254.Pp
229.Dl gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING 255.Dl gnunet-publish -m "description:GNU License" -k gpl -k test -m "mimetype:text/plain" COPYING
230.Ss USING DIRECTORIES 256.Ss USING DIRECTORIES
231Index the files COPYING and AUTHORS with keyword \fBtest\fR and build a directory containing the two files. 257Index the files
232Make the directory itself available under keyword \fBgnu\fR and disable keyword extraction using libextractor 258.Pa COPYING
259and
260.Pa AUTHORS
261with keyword
262.Ar test
263and build a directory containing the two files.
264Make the directory itself available under keyword
265.Ar gnu
266and disable keyword extraction using libextractor:
233.Pp 267.Pp
234.Dl mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet\-publish \-k test \-k gnu \-D gnu/ 268.Dl mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet-publish -k test -k gnu -D gnu/
235.Pp 269.Pp
236Neatly publish an image gallery in \fBkittendir/\fR and its subdirs with keyword \fBkittens\fR for the directory but no keywords for the individual files or subdirs (\-n). 270Neatly publish an image gallery in
271.Pa kittendir/
272and its subdirs with keyword
273.Ar kittens
274for the directory but no keywords for the individual files or subdirs
275.Pq Fl n .
237Force description for all files. 276Force description for all files.
238.Pp 277.Pp
239.Dl gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens kittendir/ 278.Dl gnunet-publish -n -m "description:Kitten collection" -k kittens kittendir/
240.Ss SECURE PUBLISHING WITH NAMESPACES 279.Ss SECURE PUBLISHING WITH NAMESPACES
241Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier \fBgpl\fR (\-t) and no updates. 280Publish file COPYING with pseudonym RIAA-2
281.Pq Fl P
282and with identifier \fBgpl\fR
283.Pq Fl t
284and no updates.
242.Pp 285.Pp
243.Dl gnunet\-publish \-P RIAA-2 \-t gpl COPYING 286.Dl gnunet-publish -P RIAA-2 -t gpl COPYING
244.Pp 287.Pp
245Recursively index /home/ogg and build a matching directory structure. 288Recursively index
246Publish the top\-level directory into the namespace under the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise to provide an update with identifier 'VIDEOS' (\-N): 289.Pa /home/ogg
290and build a matching directory structure.
291Publish the top-level directory into the namespace under the pseudonym
292.Ar RIAA-2
293.Pq Fl P
294under identifier
295.Ar 'MUSIC'
296.Pq Fl t
297and promise to provide an update with identifier
298.Ar 'VIDEOS'
299.Pq Fl N :
247.Pp 300.Pp
248.Dl gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg 301.Dl gnunet-publish -P RIAA-2 -t MUSIC -N VIDEOS /home/ogg
249.Pp 302.Pp
250Recursively publish (\-n) /var/lib/mysql and build a matching directory structure, but disable the use of libextractor to extract keywords (\-n). 303Recursively publish
251Print the file identifiers (\-V) that can be used to retrieve the files. 304.Pq Fl n
305/var/lib/mysql and build a matching directory structure, but disable the use of libextractor to extract keywords
306.Pq Fl n .
307Print the file identifiers
308.Pq Fl V
309that can be used to retrieve the files.
252This will store a copy of the MySQL database in GNUnet but without adding any keywords to search for it. 310This will store a copy of the MySQL database in GNUnet but without adding any keywords to search for it.
253Thus only people that have been told the secret file identifiers printed with the \-V option can retrieve the (secret?) files: 311Thus only people that have been told the secret file identifiers printed with the
312.Fl V
313option can retrieve the (secret?) files:
254.Pp 314.Pp
255.Dl gnunet\-publish \-nV /var/lib/mysql 315.Dl gnunet-publish -nV /var/lib/mysql
256.Pp 316.Pp
257Create a namespace entry 'root' in namespace MPAA-1 and announce that the next update will be called 'next': 317Create a namespace entry 'root' in namespace MPAA-1 and announce that the next update will be called 'next':
258.Pp 318.Pp
259.Dl gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3 319.Dl gnunet-publish -P MPAA-1 -t root -N next noise.mp3
260.Pp 320.Pp
261Update the previous entry, do not allow any future updates: 321Update the previous entry, do not allow any future updates:
262.Pp 322.Pp
263.Dl gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3 323.Dl gnunet-publish -P MPAA-1 -t next noise_updated.mp3
264.Sh FILES 324.Sh FILES
265.Pa ~/.config/gnunet.conf 325.Pa ~/.config/gnunet.conf
266GNUnet configuration file 326GNUnet configuration file
@@ -271,7 +331,7 @@ GNUnet configuration file
271.Xr gnunet-fs-gtk 1 , 331.Xr gnunet-fs-gtk 1 ,
272.Xr gnunet-identity 1 , 332.Xr gnunet-identity 1 ,
273.Xr gnunet-search 1 , 333.Xr gnunet-search 1 ,
274.Xr gnunet.conf 5 , 334.Xr gnunet.conf 5
275.sp 335.sp
276The full documentation for gnunet is maintained as a Texinfo manual. 336The full documentation for gnunet is maintained as a Texinfo manual.
277If the 337If the
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 58e16ea7b..484bfca24 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -1,3 +1,26 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.\"
4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" ``FDL-1.3''.
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.\"
1.Dd February 25, 2012 24.Dd February 25, 2012
2.Dt GNUNET-SEARCH 1 25.Dt GNUNET-SEARCH 1
3.Os 26.Os
@@ -24,27 +47,26 @@ Search for content on GNUnet.
24The keywords are case-sensitive. 47The keywords are case-sensitive.
25.Nm 48.Nm
26can be used both for a search in the global namespace as well as for searching a private subspace. 49can be used both for a search in the global namespace as well as for searching a private subspace.
27.Sh OPTIONS 50The options are as follows:
28.Bl -tag -width Ds 51.Bl -tag -width Ds
29.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 52.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
30This option can be used to specify additional anonymity constraints. The default is 1. 53This option can be used to specify additional anonymity constraints.
54The default is 1.
31If 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. 55If 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.
32This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). 56This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
33If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). 57If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
34However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. 58However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
35You can gain better privacy by specifying a higher level of anonymity (using values above 1). 59You can gain better privacy by specifying a higher level of anonymity (using values above 1).
36This tells FS that it must hide your own requests in equivalent\-looking cover traffic. 60This tells FS that it must hide your own requests in equivalent-looking cover traffic.
37This should confound an adversaries traffic analysis, increasing the time and effort it would 61This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
38take to discover your identity. However, it also can significantly reduce performance, as 62However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
39your requests will be delayed until sufficient cover traffic is available. The specific 63The specific numeric value (for anonymity levels above 1) is simple:
40numeric value (for anonymity levels above 1) is simple: 64Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
41Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent 65The time-period is twice the average delay by which GNUnet artificially delays traffic.
42requests of cover traffic (traffic your peer routes for others) in the same time\-period. 66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
43The time\-period is twice the average delay by which GNUnet artificially delays traffic.
44Note that regardless of the anonymity level you choose, peers that cache content in the
45network always use anonymity level 1.
46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
47use config file (defaults: ~/.config/gnunet.conf) 68Use the configuration file FILENAME (default:
69.Pa ~/.config/gnunet.conf )
48.It Fl h | \-help 70.It Fl h | \-help
49print help page 71print help page
50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 72.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
@@ -62,13 +84,13 @@ Automatically terminate the search after receiving VALUE results.
62Automatically timeout search after DELAY. 84Automatically timeout search after DELAY.
63The value given must be a number followed by a space and a time unit, for example "500 ms". 85The value given must be a number followed by a space and a time unit, for example "500 ms".
64Note that the quotes are required on the shell. 86Note that the quotes are required on the shell.
65Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. 87Otherwise the search runs until gnunet-search is aborted with CTRL\-C.
66.It Fl v | \-version 88.It Fl v | \-version
67print the version number 89print the version number
68.It Fl V | \-verbose 90.It Fl V | \-verbose
69print meta data from search results as well 91print meta data from search results as well
70.El 92.El
71You can run gnunet\-search with an URI instead of a keyword. 93You can run gnunet-search with an URI instead of a keyword.
72The URI can have the format for a namespace search or for a keyword search. 94The URI can have the format for a namespace search or for a keyword search.
73For a namespace search, the format is 95For a namespace search, the format is
74.Pp 96.Pp
@@ -108,7 +130,7 @@ Search results are printed by gnunet\-search like this:
108The first line contains the command to run to download the file. 130The first line contains the command to run to download the file.
109The suggested filename in the example is COPYING. 131The suggested filename in the example is COPYING.
110The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 132The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
111After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet\-publish on how to supply meta-data by hand). 133After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet-publish on how to supply meta-data by hand).
112.Sh SEE ALSO 134.Sh SEE ALSO
113.Xr gnunet-fs-gtk 1 , 135.Xr gnunet-fs-gtk 1 ,
114.Xr gnunet\-publish 1 , 136.Xr gnunet\-publish 1 ,