diff options
author | madmurphy <madmurphy333@gmail.com> | 2022-02-11 01:32:58 +0000 |
---|---|---|
committer | madmurphy <madmurphy333@gmail.com> | 2022-02-11 01:32:58 +0000 |
commit | 3ce3d040f4dbd27f735b6f11452c99cb455e9baa (patch) | |
tree | 4d3fee1666fbac2398ef8a0eb64906980f5dc748 /doc | |
parent | 9294003d1d51814ccb03b8f1b67a706690dcad29 (diff) | |
download | gnunet-3ce3d040f4dbd27f735b6f11452c99cb455e9baa.tar.gz gnunet-3ce3d040f4dbd27f735b6f11452c99cb455e9baa.zip |
First draft of updated man page for `gnunet-search` (to be reviewed)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-search.1 | 148 |
1 files changed, 143 insertions, 5 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index 4ec5189de..56ac30122 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -63,13 +63,137 @@ The specific numeric value (for anonymity levels above 1) is simple: | |||
63 | Given 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. | 63 | Given 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. |
64 | The time-period is twice the average delay by which GNUnet artificially delays traffic. | 64 | The time-period is twice the average delay by which GNUnet artificially delays traffic. |
65 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. | 65 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. |
66 | .It Fl b | -bookmark-only | ||
67 | Do not search, print only the URI that points to the search with the given keywords. | ||
66 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 68 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
67 | Use the configuration file | 69 | Use the configuration file |
68 | .Ar FILENAME | 70 | .Ar FILENAME |
69 | (default: | 71 | (default: |
70 | .Pa ~/.config/gnunet.conf ) | 72 | .Pa ~/.config/gnunet.conf Ns |
73 | ). | ||
74 | .It Fl F Ar FORMAT | Fl -dir-printf= Ns Ar FORMAT | ||
75 | Write the search results for directories according to | ||
76 | .Ar FORMAT Ns | ||
77 | \&. The format specifiers supported here are identical to those supported in the | ||
78 | .Nm --printf | ||
79 | argument (please refer to it for more information). If missing, | ||
80 | .Nm --dir-printf | ||
81 | defaults to | ||
82 | .Nm --printf Ns | ||
83 | \&. If | ||
84 | .Nm --printf | ||
85 | is missing too | ||
86 | .Nm --dir-printf | ||
87 | defaults to | ||
88 | .Dq #%n:\engnunet-download -o "%f" -R %u\en\en Ns | ||
89 | \&. | ||
90 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT | ||
91 | Write the search results according to | ||
92 | .Ar FORMAT Ns | ||
93 | , in which | ||
94 | .Ql \e | ||
95 | and | ||
96 | .Ql % | ||
97 | directives are interpreted as follows: | ||
98 | .Bl -tag -width indent | ||
99 | .It Li \e\e | ||
100 | a literal backslash | ||
101 | .No ( Ql \e Ns ) | ||
102 | .It Li \ea | ||
103 | an alarm bell | ||
104 | .It Li \eb | ||
105 | a backspace | ||
106 | .It Li \ee | ||
107 | an escape | ||
108 | .It Li \ef | ||
109 | a form feed | ||
110 | .It Li \en | ||
111 | a newline | ||
112 | .It Li \er | ||
113 | a carriage return | ||
114 | .It Li \et | ||
115 | a horizontal tab | ||
116 | .It Li \ev | ||
117 | a vertical tab | ||
118 | .It Li \e0 | ||
119 | an ASCII NUL. | ||
120 | .It Li \eN... | ||
121 | the character whose ASCII code is N..., expressed in octal digits | ||
122 | .It Li \exX... | ||
123 | the character whose ASCII code is X..., expressed in hexadecimal digits | ||
124 | .It Li %% | ||
125 | a percent sign | ||
126 | .It Li %a | ||
127 | the complete list of all the printable metadata available, displayed according to the | ||
128 | .Nm --iter-printf | ||
129 | argument; this specifier optionally supports metatype filtering via hash sign | ||
130 | .No (e.g. | ||
131 | .Dq %2#a | ||
132 | prints all embedded file names, if present - see libextractor's metatypes for the complete list of numerical identifiers) | ||
133 | .It Li %f | ||
134 | the file's name | ||
135 | .It Li %j | ||
136 | the first printable metadatum available, displayed according to the | ||
137 | .Nm --iter-printf | ||
138 | argument; this specifier optionally supports metatype filtering via hash sign | ||
139 | .No (e.g. | ||
140 | .Dq %5#j | ||
141 | prints a book title, if present); see libextractor's metatypes for the complete list of numerical identifiers) | ||
142 | .It Li %l | ||
143 | the file name's length | ||
144 | .It Li %m | ||
145 | the file's mime type | ||
146 | .It Li %n | ||
147 | the search result number | ||
148 | .It Li %s | ||
149 | the file's size in bytes | ||
150 | .It Li %u | ||
151 | the file's URI | ||
152 | .El | ||
153 | .Pp | ||
154 | If missing, | ||
155 | .Nm --printf | ||
156 | defaults to | ||
157 | .Dq #%n:\engnunet-download -o "%f" %u\en\en Ns | ||
158 | \&. | ||
71 | .It Fl h | -help | 159 | .It Fl h | -help |
72 | Print the help page. | 160 | Print the help page. |
161 | .It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT | ||
162 | When the %a or %j format specifiers appear in | ||
163 | .Nm --printf | ||
164 | or | ||
165 | .Nm --dir-printf Ns | ||
166 | , list each metadata property according to | ||
167 | .Ar FORMAT Ns | ||
168 | , in which the | ||
169 | .Ql \e | ||
170 | directives are interpreted as in | ||
171 | .Nm --printf | ||
172 | and | ||
173 | .Nm --dir-printf Ns | ||
174 | , while the | ||
175 | .Ql % | ||
176 | directives are interpreted as follows: | ||
177 | .Bl -tag -width indent | ||
178 | .It Li %% | ||
179 | a percent sign | ||
180 | .It Li %p | ||
181 | the property's content | ||
182 | .It Li %l | ||
183 | the property content's length in bytes | ||
184 | .It Li %i | ||
185 | the property type's unique identifier | ||
186 | .It Li %n | ||
187 | the property number | ||
188 | .It Li %w | ||
189 | the name of the plugin that provided the information | ||
190 | .El | ||
191 | .Pp | ||
192 | If missing, | ||
193 | .Nm --iter-printf | ||
194 | defaults to | ||
195 | .Dq \& \& MetaType #%i: %p\en Ns | ||
196 | \&. | ||
73 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 197 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
74 | Change the loglevel. | 198 | Change the loglevel. |
75 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | 199 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
@@ -78,24 +202,38 @@ Write logs to | |||
78 | .Ar FILENAME . | 202 | .Ar FILENAME . |
79 | .It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME | 203 | .It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME |
80 | Writes a GNUnet directory containing all of the search results to | 204 | Writes a GNUnet directory containing all of the search results to |
81 | .Ar FILENAME . | 205 | .Ar FILENAME |
206 | .No (e.g. | ||
207 | .Ql gnunet-search --output=commons.gnd commons Ns | ||
208 | ). | ||
82 | .It Fl n | -no-network | 209 | .It Fl n | -no-network |
83 | Only search locally, do not forward requests to other peers. | 210 | Only search locally, do not forward requests to other peers. |
84 | .It Fl N Ar VALUE | Fl -results= Ns Ar VALUE | 211 | .It Fl N Ar VALUE | Fl -results= Ns Ar VALUE |
85 | Automatically terminate the search after receiving | 212 | Automatically terminate the search after receiving |
86 | .Ar VALUE | 213 | .Ar VALUE |
87 | results. | 214 | results. |
215 | .It Fl s | -silent | ||
216 | Enable silent mode and do not print any result (the | ||
217 | .Nm --output | ||
218 | argument is required). | ||
88 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | 219 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY |
89 | Automatically timeout search after | 220 | Automatically timeout search after |
90 | .Ar DELAY . | 221 | .Ar DELAY . |
91 | The value given must be a number followed by a space and a time unit, for example "500 ms". | 222 | The value given must be a number followed by a space and a time unit, for example "500 ms". |
92 | Note that the quotes are required on the shell. | 223 | Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1 second = 1000000). |
93 | Otherwise the search runs until gnunet-search is aborted with CTRL-C. | 224 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. |
94 | .It Fl v | -version | 225 | .It Fl v | -version |
95 | print the version number | 226 | print the version number |
96 | .It Fl V | -verbose | 227 | .It Fl V | -verbose |
97 | print meta data from search results as well | 228 | append |
229 | .Dq %a\en | ||
230 | to the default | ||
231 | .Nm --printf | ||
232 | and | ||
233 | .Nm --dir-printf | ||
234 | arguments \[u2013] ignored when these are provided by the user | ||
98 | .El | 235 | .El |
236 | .Pp | ||
99 | You can run gnunet-search with an URI instead of a keyword. | 237 | You can run gnunet-search with an URI instead of a keyword. |
100 | The URI can have the format for a namespace search or for a keyword search. | 238 | The URI can have the format for a namespace search or for a keyword search. |
101 | For a namespace search, the format is | 239 | For a namespace search, the format is |