aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-search.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-search.1')
-rw-r--r--doc/man/gnunet-search.149
1 files changed, 24 insertions, 25 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 59263c1b1..a1c88f869 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -26,21 +26,20 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-search 28.Nm gnunet-search
29.Nd 29.Nd a command line interface to search for content on GNUnet
30a command line interface to search for content on GNUnet
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 32.Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl h | \-help 34.Op Fl h | -help
36.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 35.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
37.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 36.Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
38.Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME 37.Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME
39.Op Fl n | \-no-network 38.Op Fl n | -no-network
40.Op Fl N Ar VALUE | Fl \-results= Ns Ar VALUE 39.Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE
41.Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY 40.Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
42.Op Fl v | \-version 41.Op Fl v | -version
43.Op Fl V | \-verbose 42.Op Fl V | -verbose
44.Ao KEYWORD Ac Ao +KEYWORD Ac | Ao Ar URI Ac Ao Ar +URI Ac 43.Ao KEYWORD Ac Ao +KEYWORD Ac | Ao Ar URI Ac Ao Ar +URI Ac
45.Sh DESCRIPTION 44.Sh DESCRIPTION
46Search for content on GNUnet. 45Search for content on GNUnet.
@@ -49,7 +48,7 @@ The keywords are case-sensitive.
49can be used both for a search in the global namespace as well as for searching a private subspace. 48can be used both for a search in the global namespace as well as for searching a private subspace.
50The options are as follows: 49The options are as follows:
51.Bl -tag -width indent 50.Bl -tag -width indent
52.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 51.It Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL
53This option can be used to specify additional anonymity constraints. 52This option can be used to specify additional anonymity constraints.
54The default is 1. 53The default is 1.
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. 54If 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.
@@ -64,37 +63,37 @@ The specific numeric 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. 63Given 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.
65The time-period is twice the average delay by which GNUnet artificially delays traffic. 64The 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. 65Note 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 66.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
68Use the configuration file 67Use the configuration file
69.Ar FILENAME 68.Ar FILENAME
70(default: 69(default:
71.Pa ~/.config/gnunet.conf ) 70.Pa ~/.config/gnunet.conf )
72.It Fl h | \-help 71.It Fl h | -help
73Print the help page. 72Print the help page.
74.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 73.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
75Change the loglevel. 74Change the loglevel.
76Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 75Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 76.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
78Write logs to 77Write logs to
79.Ar FILENAME . 78.Ar FILENAME .
80.It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME 79.It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME
81Writes a GNUnet directory containing all of the search results to 80Writes a GNUnet directory containing all of the search results to
82.Ar FILENAME . 81.Ar FILENAME .
83.It Fl n | \-no-network 82.It Fl n | -no-network
84Only search locally, do not forward requests to other peers. 83Only search locally, do not forward requests to other peers.
85.It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE 84.It Fl N Ar VALUE | Fl -results= Ns Ar VALUE
86Automatically terminate the search after receiving 85Automatically terminate the search after receiving
87.Ar VALUE 86.Ar VALUE
88results. 87results.
89.It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY 88.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
90Automatically timeout search after 89Automatically timeout search after
91.Ar DELAY . 90.Ar DELAY .
92The value given must be a number followed by a space and a time unit, for example "500 ms". 91The value given must be a number followed by a space and a time unit, for example "500 ms".
93Note that the quotes are required on the shell. 92Note that the quotes are required on the shell.
94Otherwise the search runs until gnunet-search is aborted with CTRL\-C. 93Otherwise the search runs until gnunet-search is aborted with CTRL-C.
95.It Fl v | \-version 94.It Fl v | -version
96print the version number 95print the version number
97.It Fl V | \-verbose 96.It Fl V | -verbose
98print meta data from search results as well 97print meta data from search results as well
99.El 98.El
100You can run gnunet-search with an URI instead of a keyword. 99You can run gnunet-search with an URI instead of a keyword.