aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-scalarproduct.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-scalarproduct.1')
-rw-r--r--doc/man/gnunet-scalarproduct.143
1 files changed, 28 insertions, 15 deletions
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 0159e1eb9..4ccb2a740 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -1,17 +1,13 @@
1.TH GNUNET\-VECTORPRODUCT 1 "8 Aug 2013" "GNUnet" 1.TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-vectorproduct \- compute a vectorproduct 3gnunet\-vectorproduct \- compute a vectorproduct
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-vectorproduct 5.B gnunet\-vectorproduct
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct 8\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct
13across two peers \fBAlice\fP and \fBBob\fP. 9across two peers \fBAlice\fP and \fBBob\fP.
14 10.PP
15A client can issue one of two messages to its service: 11A client can issue one of two messages to its service:
16.TS 12.TS
17tab (@); 13tab (@);
@@ -23,17 +19,16 @@ T}
23Elements to support a peer in computing a vectorproduct (\fBBob\fP) 19Elements to support a peer in computing a vectorproduct (\fBBob\fP)
24T} 20T}
25.TE 21.TE
26
27Both requests must share the same SID, which can be an arbitrary 22Both requests must share the same SID, which can be an arbitrary
28string identifying the session. SIDs should be unique, however it is 23string identifying the session. SIDs should be unique, however it is
29sufficient to guarantee the uniqueness of the tupel element count and 24sufficient to guarantee the uniqueness of the tupel element count and
30session ID. 25session ID.
31 26.PP
32\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s 27\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
33service, it will internally be checked by the client for 28service, it will internally be checked by the client for
34validity. Invalid values here result in the client or the service 29validity. Invalid values here result in the client or the service
35failing the session. 30failing the session.
36 31.PP
37Elements are handed over as signed decimal integers, the element count 32Elements are handed over as signed decimal integers, the element count
38supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also 33supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
39supply a mask for these values to her service, which allows partial 34supply a mask for these values to her service, which allows partial
@@ -42,11 +37,10 @@ masked by setting their the corresponding mask element to zero, any
42other value means the element will not be masked. \fBAlice\fP\'s 37other value means the element will not be masked. \fBAlice\fP\'s
43client will also mask all 0-values to avoid information leakage to 38client will also mask all 0-values to avoid information leakage to
44\fBBob\fP. 39\fBBob\fP.
45 40.PP
46The protocol by definition relies on \fBAlice\fP and \fBBob\fP being 41The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
47benign, thus \fBBob\fP can arbitrarily falsify his information. Both 42benign, thus \fBBob\fP can arbitrarily falsify his information. Both
48peers collaborate to achieve a correct result. 43peers collaborate to achieve a correct result.
49
50.SH OPTIONS 44.SH OPTIONS
51.B 45.B
52.IP "\-e ELEMENTS, \-\-elements=ELEMENTS" 46.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
@@ -78,10 +72,29 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
78.B 72.B
79.IP "\-v, \-\-version" 73.IP "\-v, \-\-version"
80Print GNUnet version number. 74Print GNUnet version number.
81
82
83.SH BUGS 75.SH BUGS
84Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 76Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
85 77electronic mail to <gnunet\-developers@gnu.org>
86.SH SEE ALSO 78.SH SEE ALSO
87gnunet\-peerinfo(1) 79gnunet\-peerinfo(1)
80.PP
81The full documentation for
82.B gnunet
83is maintained as a Texinfo manual.
84If the
85.B info
86and
87.B gnunet
88programs are properly installed at your site, the command
89.IP
90.B info gnunet
91.PP
92should give you access to the complete handbook,
93.IP
94.B info gnunet-c-tutorial
95.PP
96will give you access to a tutorial for developers.
97.PP
98Depending on your installation, this information is also
99available in
100\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).