summaryrefslogtreecommitdiff
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.189
1 files changed, 43 insertions, 46 deletions
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index a5c7413ad..88ebb93e7 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -26,86 +26,83 @@
.Os
.Sh NAME
.Nm gnunet-scalarproduct
-.Nd
-compute a vectorproduct
+.Nd compute a vectorproduct
.Sh SYNOPSIS
.Nm
-.Op Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
-.Op Fl m Ar MASK | Fl \-mask= Ns Ar MASK
-.Op Fl k Ar KEY | Fl \-key= Ns Ar KEY
-.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
-.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
-.Op Fl h | \-help
-.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
-.Op Fl v | \-version
+.Op Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
+.Op Fl m Ar MASK | Fl -mask= Ns Ar MASK
+.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
+.Op Fl c Ar FILENAME | -config= Ns Ar FILENAME
+.Op Fl p Ar PEERID | Fl -peer= Ns Ar PEERID
+.Op Fl h | -help
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl v | -version
.Sh DESCRIPTION
.Nm
-enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP.
+enables you to compute a vectorproduct across two peers
+.Sy Alice
+and
+.Sy Bob .
.Pp
A client can issue one of two messages to its service:
-.TS
-tab (@);
-l lx.
-1@T{
-A request to compute a vectorproduct with another peer (\fBAlice\fP)
-T}
-2@T{
-Elements to support a peer in computing a vectorproduct (\fBBob\fP)
-T}
-.TE
+.Bl -enum -width 3n -offset indent
+.It
+A request to compute a vectorproduct with another peer (Alice)
+.It
+Elements to support a peer in computing a vectorproduct (Bob)
+.El
+.Pp
Both 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.
.Pp
-\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
+Alice'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.
.Pp
Elements are handed over as signed decimal integers, the element count
-supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
+supplied by Alice and Bob must match. Alice 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
+other value means the element will not be masked. Alice's
client will also mask all 0-values to avoid information leakage to
-\fBBob\fP.
+Bob.
.Pp
-The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
-benign, thus \fBBob\fP can arbitrarily falsify his information. Both
+The protocol by definition relies on Alice and Bob being
+benign, thus Bob can arbitrarily falsify his information. Both
peers collaborate to achieve a correct result.
.Pp
-The options of
-.Nm
-are:
-.Bl -tag -width Ds
-.It Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
-The element-vector the vectorproduct should be computed over in signed decimal form, eg: "42,1,-3,3,7".
+The options are as follows:
+.Bl -tag -width indent
+.It Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
+The 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.
-.It Fl m Ar MASK | Fl \-mask= Ns Ar MASK
+.It Fl m Ar MASK | Fl -mask= Ns Ar MASK
Elements in the vector can be masked.
-There must be at least two elements left in the vector to compute a vectorproduct.
+There must be at least two elements left in the vector to
+compute a vectorproduct.
Non-Zero values indicate an element is not maskes.
-.It Fl k Ar KEY | Fl \-key= Ns Ar KEY
-The session key, a shared string of arbitrary length from which the SID will be generated.
-.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.It Fl k Ar KEY | Fl -key= Ns Ar KEY
+The session key, a shared string of arbitrary length from which
+the SID will be generated.
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration file FILENAME.
-.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
+.It Fl p Ar PEERID | Fl -peer= Ns Ar PEERID
The remote peer's ASCII-armored gnunet-peer ID as output by
.Xr gnunet-peerinfo 1 .
-If this option is not given, the peer will take the \fBBob\fP\'s role.
-.It Fl h | \-help
+If this option is not given, the peer will take the Bob's role.
+.It Fl h | -help
Print short help on options.
-.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
-.It Fl v | \-version
+.It Fl v | -version
Print GNUnet version number.
.El
-.Sh BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <gnunet\-developers@gnu.org>
.Sh SEE ALSO
.Xr gnunet-peerinfo 1
.sp