aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-vectorproduct.165
2 files changed, 66 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 9e63bb243..8657c2365 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -27,6 +27,7 @@ man_MANS = \
27 gnunet-transport.1 \ 27 gnunet-transport.1 \
28 gnunet-unindex.1 \ 28 gnunet-unindex.1 \
29 gnunet-uri.1 \ 29 gnunet-uri.1 \
30 gnunet-vectorproduct.1 \
30 gnunet-vpn.1 31 gnunet-vpn.1
31 32
32EXTRA_DIST = ${man_MANS} 33EXTRA_DIST = ${man_MANS}
diff --git a/doc/man/gnunet-vectorproduct.1 b/doc/man/gnunet-vectorproduct.1
new file mode 100644
index 000000000..6852694b6
--- /dev/null
+++ b/doc/man/gnunet-vectorproduct.1
@@ -0,0 +1,65 @@
1.TH GNUNET\-VECTORPRODUCT 1 "8 Aug 2013" "GNUnet"
2
3.SH NAME
4gnunet\-vectorproduct \- compute a vectorproduct
5
6.SH SYNOPSIS
7.B gnunet\-vectorproduct
8.RI [ options ]
9.br
10
11.SH DESCRIPTION
12\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP.
13
14A client can issue one of two messages to its service:
15.TS
16tab (@);
17l lx.
181@T{
19A request to compute a vectorproduct with another peer (\fBAlice\fP)
20T}
212@T{
22Elements to support a peer in computing a vectorproduct (\fBBob\fP)
23T}
24.TE
25
26Both requests must share the same SID, which can be an arbitrary string identifying the session. SIDs should be unique, however it is sufficient to guarantee the uniqueness of the tupel element count and session ID.
27
28\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s service, it will internally be checked by the client for validity. Invalid values here result in the client or the service failing the session.
29
30Elements are handed over as signed decimal integers, the element count supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also supply a mask for these values to her service, which allows partial vector products to be computed across the vector. Elements can be masked by setting their the corresponding mask element to zero, any other value means the element will not be masked. \fBAlice\fP\'s client will also mask all 0-values to avoid information leakage to \fBBob\fP.
31
32The protocol by definition relies on \fBAlice\fP and \fBBob\fP being benign, thus \fBBob\fP can arbitrarily falsify his information. Both peers collaborate to achieve a correct result.
33
34.SH OPTIONS
35.B
36.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
37The element-vector the vectorproduct should be computed over in signed decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked.
38.B
39.IP "\-m MASK, \-\-mask=MASK"
40Elements in the vector can be masked. There must be at least two elements left in the vector to compute a vectorproduct. Non-Zero values indicate an element is not maskes.
41.B
42.IP "\-k KEY, \-\-key=KEY"
43The session key, a shared string of arbitrary length from which the SID will be generated
44.B
45.IP "\-c FILENAME, \-\-config=FILENAME"
46Use the configuration file FILENAME.
47.B
48.IP "\-p PEERID, \-\-peer=PEERID"
49The remote peer\'s ASCII-armored gnunet-peer ID as output by gnunet-peerinfo. If this option is not given, the peer will take the \fBBob\fP\'s role.
50.B
51.IP "\-h, \-\-help"
52Print short help on options.
53.B
54.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
55Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
56.B
57.IP "\-v, \-\-version"
58Print GNUnet version number.
59
60
61.SH BUGS
62Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
63
64.SH SEE ALSO
65gnunet\-peerinfo(1)