aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-search.1
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-23 14:50:06 +0000
committerng0 <ng0@n0.is>2019-04-23 14:50:06 +0000
commit050f5f3f5d783bd080d838d04eb8837672627afb (patch)
tree9f4f67a567ddf413387290b5455f7ff8fcc9d413 /doc/man/gnunet-search.1
parentf679160f2a6689ace17e2624405148da03c795bf (diff)
downloadgnunet-050f5f3f5d783bd080d838d04eb8837672627afb.tar.gz
gnunet-050f5f3f5d783bd080d838d04eb8837672627afb.zip
doc/man: bunch of fixes
Diffstat (limited to 'doc/man/gnunet-search.1')
-rw-r--r--doc/man/gnunet-search.140
1 files changed, 25 insertions, 15 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 484bfca24..801efbe3f 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -65,23 +65,30 @@ Given an anonymity level L (above 1), each request FS makes on your behalf must
65The time-period is twice the average delay by which GNUnet artificially delays traffic. 65The time-period is twice the average delay by which GNUnet artificially delays traffic.
66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. 66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
68Use the configuration file FILENAME (default: 68Use the configuration file
69.Ar FILENAME
70(default:
69.Pa ~/.config/gnunet.conf ) 71.Pa ~/.config/gnunet.conf )
70.It Fl h | \-help 72.It Fl h | \-help
71print help page 73Print the help page.
72.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 74.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
73Change the loglevel. 75Change the loglevel.
74Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 76Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
75.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
76Write logs to FILENAME. 78Write logs to
79.Ar FILENAME .
77.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME 80.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME
78Writes a GNUnet directory containing all of the search results to FILENAME. 81Writes a GNUnet directory containing all of the search results to
82.Ar FILENAME .
79.It Fl n | \-no-network 83.It Fl n | \-no-network
80Only search locally, do not forward requests to other peers. 84Only search locally, do not forward requests to other peers.
81.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE 85.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE
82Automatically terminate the search after receiving VALUE results. 86Automatically terminate the search after receiving
87.Ar VALUE
88results.
83.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY 89.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY
84Automatically timeout search after DELAY. 90Automatically timeout search after
91.Ar DELAY .
85The value given must be a number followed by a space and a time unit, for example "500 ms". 92The value given must be a number followed by a space and a time unit, for example "500 ms".
86Note that the quotes are required on the shell. 93Note that the quotes are required on the shell.
87Otherwise the search runs until gnunet-search is aborted with CTRL\-C. 94Otherwise the search runs until gnunet-search is aborted with CTRL\-C.
@@ -102,25 +109,24 @@ For a keyword search, use
102.Pp 109.Pp
103If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. 110If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
104.sp 111.sp
105If multiple keywords are passed, gnunet-search will look for content 112If multiple keywords are passed, gnunet-search will look for content matching any of the keywords.
106matching any of the keywords.
107The prefix "+" makes a keyword mandatory. 113The prefix "+" makes a keyword mandatory.
108.Sh FILES 114.Sh FILES
109.Pa ~/.config/gnunet.conf 115.Pa ~/.config/gnunet.conf
110GNUnet configuration file; specifies the default value for the timeout 116GNUnet configuration file; specifies the default value for the timeout
111.Sh EXAMPLES 117.Sh EXAMPLES
112.Dl $ gnunet\-search "Das Kapital" 118.Dl $ gnunet-search "Das Kapital"
113.Pp 119.Pp
114Searches for content matching the keyword "Das Kapital". 120Searches for content matching the keyword "Das Kapital".
115.Pp 121.Pp
116.Dl $ gnunet\-search +Das +Kapital 122.Dl $ gnunet-search +Das +Kapital
117.Pp 123.Pp
118Searches for content matching both mandatory keywords "Das" and "Kapital". 124Searches for content matching both mandatory keywords "Das" and "Kapital".
119.sp 125.sp
120Search results are printed by gnunet\-search like this: 126Search results are printed by gnunet-search like this:
121.Pp 127.Pp
122.ad l 128.ad l
123 gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE 129 gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
124 130
125 Description: The GNU General Public License 131 Description: The GNU General Public License
126 132
@@ -130,11 +136,15 @@ Search results are printed by gnunet\-search like this:
130The first line contains the command to run to download the file. 136The first line contains the command to run to download the file.
131The suggested filename in the example is COPYING. 137The suggested filename in the example is COPYING.
132The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 138The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
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). 139After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result.
140The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain").
141See the options for
142.Xr gnunet-publish 1
143on how to supply meta-data by hand.
134.Sh SEE ALSO 144.Sh SEE ALSO
145.Xr gnunet-download 1 ,
135.Xr gnunet-fs-gtk 1 , 146.Xr gnunet-fs-gtk 1 ,
136.Xr gnunet\-publish 1 , 147.Xr gnunet-publish 1 ,
137.Xr gnunet\-download 1 ,
138.Xr gnunet.conf 5 148.Xr gnunet.conf 5
139.sp 149.sp
140The full documentation for gnunet is maintained as a Texinfo manual. 150The full documentation for gnunet is maintained as a Texinfo manual.