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.1127
1 files changed, 73 insertions, 54 deletions
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 34d5e4ef0..c92f62d79 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -1,13 +1,24 @@
1.TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet" 1.Dd August 8, 2013
2.SH NAME 2.Dt GNUNET-SCALARPRODUCT 1
3gnunet\-vectorproduct \- compute a vectorproduct 3.Os
4.SH SYNOPSIS 4.Sh NAME
5.B gnunet\-vectorproduct 5.Nm gnunet-scalarproduct
6.RI [ options ] 6.Nd
7.SH DESCRIPTION 7compute a vectorproduct
8\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct 8.Sh SYNOPSIS
9across two peers \fBAlice\fP and \fBBob\fP. 9.Nm
10.PP 10.Op Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
11.Op Fl m Ar MASK | Fl \-mask= Ns Ar MASK
12.Op Fl k Ar KEY | Fl \-key= Ns Ar KEY
13.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
14.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
15.Op Fl h | \-help
16.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
17.Op Fl v | \-version
18.Sh DESCRIPTION
19.Nm
20enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP.
21.Pp
11A client can issue one of two messages to its service: 22A client can issue one of two messages to its service:
12.TS 23.TS
13tab (@); 24tab (@);
@@ -23,12 +34,12 @@ Both requests must share the same SID, which can be an arbitrary
23string identifying the session. SIDs should be unique, however it is 34string identifying the session. SIDs should be unique, however it is
24sufficient to guarantee the uniqueness of the tupel element count and 35sufficient to guarantee the uniqueness of the tupel element count and
25session ID. 36session ID.
26.PP 37.Pp
27\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s 38\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
28service, it will internally be checked by the client for 39service, it will internally be checked by the client for
29validity. Invalid values here result in the client or the service 40validity. Invalid values here result in the client or the service
30failing the session. 41failing the session.
31.PP 42.Pp
32Elements are handed over as signed decimal integers, the element count 43Elements are handed over as signed decimal integers, the element count
33supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also 44supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
34supply a mask for these values to her service, which allows partial 45supply a mask for these values to her service, which allows partial
@@ -37,56 +48,64 @@ masked by setting their the corresponding mask element to zero, any
37other value means the element will not be masked. \fBAlice\fP\'s 48other value means the element will not be masked. \fBAlice\fP\'s
38client will also mask all 0-values to avoid information leakage to 49client will also mask all 0-values to avoid information leakage to
39\fBBob\fP. 50\fBBob\fP.
40.PP 51.Pp
41The protocol by definition relies on \fBAlice\fP and \fBBob\fP being 52The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
42benign, thus \fBBob\fP can arbitrarily falsify his information. Both 53benign, thus \fBBob\fP can arbitrarily falsify his information. Both
43peers collaborate to achieve a correct result. 54peers collaborate to achieve a correct result.
44.SH OPTIONS 55.Pp
45.IP "\-e ELEMENTS, \-\-elements=ELEMENTS" 56The options of
46The element-vector the vectorproduct should be computed over in signed 57.Nm
47decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked. 58are:
48.IP "\-m MASK, \-\-mask=MASK" 59.Bl -tag -width Ds
49Elements in the vector can be masked. There must be at least two 60.It Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
50elements left in the vector to compute a vectorproduct. Non-Zero 61The element-vector the vectorproduct should be computed over in signed decimal form, eg: "42,1,-3,3,7".
51values indicate an element is not maskes. 62Zero value elements will be automatically masked.
52.IP "\-k KEY, \-\-key=KEY" 63.It Fl m Ar MASK | Fl \-mask= Ns Ar MASK
53The session key, a shared string of arbitrary length from which the 64Elements in the vector can be masked.
54SID will be generated 65There must be at least two elements left in the vector to compute a vectorproduct.
55.IP "\-c FILENAME, \-\-config=FILENAME" 66Non-Zero values indicate an element is not maskes.
67.It Fl k Ar KEY | Fl \-key= Ns Ar KEY
68The session key, a shared string of arbitrary length from which the SID will be generated.
69.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
56Use the configuration file FILENAME. 70Use the configuration file FILENAME.
57.IP "\-p PEERID, \-\-peer=PEERID" 71.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
58The remote peer\'s ASCII-armored gnunet-peer ID as output by 72The remote peer's ASCII-armored gnunet-peer ID as output by
59gnunet-peerinfo. If this option is not given, the peer will take the 73.Xr gnunet-peerinfo 1 .
60\fBBob\fP\'s role. 74If this option is not given, the peer will take the \fBBob\fP\'s role.
61.IP "\-h, \-\-help" 75.It Fl h | \-help
62Print short help on options. 76Print short help on options.
63.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 77.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
64Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 78Use LOGLEVEL for logging.
65.IP "\-v, \-\-version" 79Valid values are DEBUG, INFO, WARNING and ERROR.
80.It Fl v | \-version
66Print GNUnet version number. 81Print GNUnet version number.
67.SH BUGS 82.El
83.Sh BUGS
68Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 84Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
69electronic mail to <gnunet\-developers@gnu.org> 85electronic mail to <gnunet\-developers@gnu.org>
70.SH SEE ALSO 86.Sh SEE ALSO
71gnunet\-peerinfo(1) 87.Xr gnunet-peerinfo 1
72.PP 88.sp
73The full documentation for 89The full documentation for gnunet is maintained as a Texinfo manual.
74.B gnunet
75is maintained as a Texinfo manual.
76If the 90If the
77.B info 91.Xr info 1
78and 92and gnunet programs are properly installed at your site, the command
79.B gnunet 93.Pp
80programs are properly installed at your site, the command 94.Dl info gnunet
81.IP 95.Pp
82.B info gnunet
83.PP
84should give you access to the complete handbook, 96should give you access to the complete handbook,
85.IP 97.Pp
86.B info gnunet-c-tutorial 98.Dl info gnunet-c-tutorial
87.PP 99.Pp
88will give you access to a tutorial for developers. 100will give you access to a tutorial for developers.
89.PP 101.sp
90Depending on your installation, this information is also 102Depending on your installation, this information is also available in
91available in 103.Xr gnunet 7 and
92\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 104.Xr gnunet-c-tutorial 7 .
105.\".Sh HISTORY
106.\".Sh AUTHORS
107.Sh BUGS
108Report bugs by using
109.Lk https://bugs.gnunet.org
110or by sending electronic mail to
111.Aq Mt gnunet-developers@gnu.org .