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.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 @@
-.TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet"
-.SH NAME
-gnunet\-vectorproduct \- compute a vectorproduct
-.SH SYNOPSIS
-.B gnunet\-vectorproduct
-.RI [ options ]
-.SH DESCRIPTION
-\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct
-across two peers \fBAlice\fP and \fBBob\fP.
-.PP
+.Dd August 8, 2013
+.Dt GNUNET-SCALARPRODUCT 1
+.Os
+.Sh NAME
+.Nm gnunet-scalarproduct
+.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
+.Sh DESCRIPTION
+.Nm
+enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP.
+.Pp
A client can issue one of two messages to its service:
.TS
tab (@);
@@ -23,12 +34,12 @@ 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
+.Pp
\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.
-.PP
+.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
supply 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
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.
-.PP
+.Pp
The 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.
-.SH OPTIONS
-.IP "\-e ELEMENTS, \-\-elements=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.
-.IP "\-m MASK, \-\-mask=MASK"
-Elements 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.
-.IP "\-k KEY, \-\-key=KEY"
-The session key, a shared string of arbitrary length from which the
-SID will be generated
-.IP "\-c FILENAME, \-\-config=FILENAME"
+.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".
+Zero value elements will be automatically masked.
+.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.
+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
Use the configuration file FILENAME.
-.IP "\-p PEERID, \-\-peer=PEERID"
-The 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.
-.IP "\-h, \-\-help"
+.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
Print short help on options.
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
-Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
-.IP "\-v, \-\-version"
+.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
Print GNUnet version number.
-.SH BUGS
+.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
-gnunet\-peerinfo(1)
-.PP
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual.
+.Sh SEE ALSO
+.Xr gnunet-peerinfo 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.Xr gnunet-c-tutorial 7 .
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .