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
+.Nd compute a vectorproduct
-compute a vectorproduct
 .Sh SYNOPSIS
 .Nm
-.Op Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
+.Op Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
-.Op Fl m Ar MASK | Fl \-mask= Ns Ar MASK
+.Op Fl m Ar MASK | Fl -mask= Ns Ar MASK
-.Op Fl k Ar KEY | Fl \-key= Ns Ar KEY
+.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
-.Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME
+.Op Fl c Ar FILENAME | -config= Ns Ar FILENAME
-.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
+.Op Fl p Ar PEERID | Fl -peer= Ns Ar PEERID
-.Op Fl h | \-help
+.Op Fl h | -help
-.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
-.Op Fl v | \-version
+.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
+.Bl -enum -width 3n -offset indent
-tab (@);
+.It
-l lx.
+A request to compute a vectorproduct with another peer (Alice)
-1@T{
+.It
-A request to compute a vectorproduct with another peer (\fBAlice\fP)
+Elements to support a peer in computing a vectorproduct (Bob)
-T}
+.El
-2@T{
+.Pp
-Elements to support a peer in computing a vectorproduct (\fBBob\fP)
-T}
-.TE
 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
+The protocol by definition relies on Alice and Bob being
-benign, thus \fBBob\fP can arbitrarily falsify his information. Both
+benign, thus Bob can arbitrarily falsify his information. Both
 peers collaborate to achieve a correct result.
 .Pp
-The options of
+The options are as follows:
-.Nm
+.Bl -tag -width indent
-are:
+.It Fl e Ar ELEMENTS | Fl -elements= Ns Ar ELEMENTS
-.Bl -tag -width Ds
+The element-vector the vectorproduct should be computed over in
-.It Fl e Ar ELEMENTS | Fl \-elements= Ns Ar ELEMENTS
+signed decimal form, eg: "42,1,-3,3,7".
-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
+.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.
+The session key, a shared string of arbitrary length from which
-.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+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.
+If this option is not given, the peer will take the Bob's role.
-.It Fl h | \-help
+.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

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 @@
26	.Os	26	.Os
27	.Sh NAME	27	.Sh NAME
28	.Nm gnunet-scalarproduct	28	.Nm gnunet-scalarproduct
29	.Nd	29	.Nd compute a vectorproduct
30	compute a vectorproduct
31	.Sh SYNOPSIS	30	.Sh SYNOPSIS
32	.Nm	31	.Nm
33	.Op Fl e Ar ELEMENTS \| Fl \-elements= Ns Ar ELEMENTS	32	.Op Fl e Ar ELEMENTS \| Fl -elements= Ns Ar ELEMENTS
34	.Op Fl m Ar MASK \| Fl \-mask= Ns Ar MASK	33	.Op Fl m Ar MASK \| Fl -mask= Ns Ar MASK
35	.Op Fl k Ar KEY \| Fl \-key= Ns Ar KEY	34	.Op Fl k Ar KEY \| Fl -key= Ns Ar KEY
36	.Op Fl c Ar FILENAME \| \-config= Ns Ar FILENAME	35	.Op Fl c Ar FILENAME \| -config= Ns Ar FILENAME
37	.Op Fl p Ar PEERID \| Fl \-peer= Ns Ar PEERID	36	.Op Fl p Ar PEERID \| Fl -peer= Ns Ar PEERID
38	.Op Fl h \| \-help	37	.Op Fl h \| -help
39	.Op Fl L Ar LOGLEVEL \| Fl \-loglevel= Ns Ar LOGLEVEL	38	.Op Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
40	.Op Fl v \| \-version	39	.Op Fl v \| -version
41	.Sh DESCRIPTION	40	.Sh DESCRIPTION
42	.Nm	41	.Nm
43	enables you to compute a vectorproduct across two peers \fBAlice\fP and \fBBob\fP.	42	enables you to compute a vectorproduct across two peers
		43	.Sy Alice
		44	and
		45	.Sy Bob .
44	.Pp	46	.Pp
45	A client can issue one of two messages to its service:	47	A client can issue one of two messages to its service:
46	.TS	48	.Bl -enum -width 3n -offset indent
47	tab (@);	49	.It
48	l lx.	50	A request to compute a vectorproduct with another peer (Alice)
49	1@T{	51	.It
50	A request to compute a vectorproduct with another peer (\fBAlice\fP)	52	Elements to support a peer in computing a vectorproduct (Bob)
51	T}	53	.El
52	2@T{	54	.Pp
53	Elements to support a peer in computing a vectorproduct (\fBBob\fP)
54	T}
55	.TE
56	Both requests must share the same SID, which can be an arbitrary	55	Both requests must share the same SID, which can be an arbitrary
57	string identifying the session. SIDs should be unique, however it is	56	string identifying the session. SIDs should be unique, however it is
58	sufficient to guarantee the uniqueness of the tupel element count and	57	sufficient to guarantee the uniqueness of the tupel element count and
59	session ID.	58	session ID.
60	.Pp	59	.Pp
61	\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s	60	Alice's client must supply the ASCII encoded peer ID of bob's
62	service, it will internally be checked by the client for	61	service, it will internally be checked by the client for
63	validity. Invalid values here result in the client or the service	62	validity. Invalid values here result in the client or the service
64	failing the session.	63	failing the session.
65	.Pp	64	.Pp
66	Elements are handed over as signed decimal integers, the element count	65	Elements are handed over as signed decimal integers, the element count
67	supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also	66	supplied by Alice and Bob must match. Alice can also
68	supply a mask for these values to her service, which allows partial	67	supply a mask for these values to her service, which allows partial
69	vector products to be computed across the vector. Elements can be	68	vector products to be computed across the vector. Elements can be
70	masked by setting their the corresponding mask element to zero, any	69	masked by setting their the corresponding mask element to zero, any
71	other value means the element will not be masked. \fBAlice\fP\'s	70	other value means the element will not be masked. Alice's
72	client will also mask all 0-values to avoid information leakage to	71	client will also mask all 0-values to avoid information leakage to
73	\fBBob\fP.	72	Bob.
74	.Pp	73	.Pp
75	The protocol by definition relies on \fBAlice\fP and \fBBob\fP being	74	The protocol by definition relies on Alice and Bob being
76	benign, thus \fBBob\fP can arbitrarily falsify his information. Both	75	benign, thus Bob can arbitrarily falsify his information. Both
77	peers collaborate to achieve a correct result.	76	peers collaborate to achieve a correct result.
78	.Pp	77	.Pp
79	The options of	78	The options are as follows:
80	.Nm	79	.Bl -tag -width indent
81	are:	80	.It Fl e Ar ELEMENTS \| Fl -elements= Ns Ar ELEMENTS
82	.Bl -tag -width Ds	81	The element-vector the vectorproduct should be computed over in
83	.It Fl e Ar ELEMENTS \| Fl \-elements= Ns Ar ELEMENTS	82	signed decimal form, eg: "42,1,-3,3,7".
84	The element-vector the vectorproduct should be computed over in signed decimal form, eg: "42,1,-3,3,7".
85	Zero value elements will be automatically masked.	83	Zero value elements will be automatically masked.
86	.It Fl m Ar MASK \| Fl \-mask= Ns Ar MASK	84	.It Fl m Ar MASK \| Fl -mask= Ns Ar MASK
87	Elements in the vector can be masked.	85	Elements in the vector can be masked.
88	There must be at least two elements left in the vector to compute a vectorproduct.	86	There must be at least two elements left in the vector to
		87	compute a vectorproduct.
89	Non-Zero values indicate an element is not maskes.	88	Non-Zero values indicate an element is not maskes.
90	.It Fl k Ar KEY \| Fl \-key= Ns Ar KEY	89	.It Fl k Ar KEY \| Fl -key= Ns Ar KEY
91	The session key, a shared string of arbitrary length from which the SID will be generated.	90	The session key, a shared string of arbitrary length from which
92	.It Fl c Ar FILENAME \| Fl \-config= Ns Ar FILENAME	91	the SID will be generated.
		92	.It Fl c Ar FILENAME \| Fl -config= Ns Ar FILENAME
93	Use the configuration file FILENAME.	93	Use the configuration file FILENAME.
94	.It Fl p Ar PEERID \| Fl \-peer= Ns Ar PEERID	94	.It Fl p Ar PEERID \| Fl -peer= Ns Ar PEERID
95	The remote peer's ASCII-armored gnunet-peer ID as output by	95	The remote peer's ASCII-armored gnunet-peer ID as output by
96	.Xr gnunet-peerinfo 1 .	96	.Xr gnunet-peerinfo 1 .
97	If this option is not given, the peer will take the \fBBob\fP\'s role.	97	If this option is not given, the peer will take the Bob's role.
98	.It Fl h \| \-help	98	.It Fl h \| -help
99	Print short help on options.	99	Print short help on options.
100	.It Fl L Ar LOGLEVEL \| Fl \-loglevel= Ns Ar LOGLEVEL	100	.It Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
101	Use LOGLEVEL for logging.	101	Use LOGLEVEL for logging.
102	Valid values are DEBUG, INFO, WARNING and ERROR.	102	Valid values are DEBUG, INFO, WARNING and ERROR.
103	.It Fl v \| \-version	103	.It Fl v \| -version
104	Print GNUnet version number.	104	Print GNUnet version number.
105	.El	105	.El
106	.Sh BUGS
107	Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
108	electronic mail to <gnunet\-developers@gnu.org>
109	.Sh SEE ALSO	106	.Sh SEE ALSO
110	.Xr gnunet-peerinfo 1	107	.Xr gnunet-peerinfo 1
111	.sp	108	.sp