aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-base32.174
2 files changed, 75 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index a0283cf44..e7045e8bf 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -50,6 +50,7 @@ man_MANS = \
50 gnunet-arm.1 \ 50 gnunet-arm.1 \
51 gnunet-ats.1 \ 51 gnunet-ats.1 \
52 gnunet-auto-share.1 \ 52 gnunet-auto-share.1 \
53 gnunet-base32.1 \
53 gnunet-bcd.1 \ 54 gnunet-bcd.1 \
54 gnunet-bugreport.1 \ 55 gnunet-bugreport.1 \
55 gnunet-config.1 \ 56 gnunet-config.1 \
diff --git a/doc/man/gnunet-base32.1 b/doc/man/gnunet-base32.1
new file mode 100644
index 000000000..2e1224279
--- /dev/null
+++ b/doc/man/gnunet-base32.1
@@ -0,0 +1,74 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2021 GNUnet e.V.
3.\"
4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd March 5, 2021
25.Dt GNUNET-BASE32 1
26.Os
27.Sh NAME
28.Nm gnunet-base32
29.Nd encode/decode to Crockford base32 encoding
30.Sh SYNOPSIS
31.Nm
32.Op Fl d | -decode
33.sp
34.Sh DESCRIPTION
35.Nm
36By default, encodes data read from standard input into
37Crockford base32 and writes the result to standard output.
38The inverse operation is performed if the option
39.Fl --decode
40is given. Note that the tool keeps all of the data in
41memory and is largely intended for quick debugging and
42not for high performance.
43.Bl -tag -width indent
44.It Fl d | -decode
45Run in decode mode instead of in encode mode.
46.It Fl h | -help
47Print short help on options.
48.It Fl v | -version
49Print GNUnet version number.
50.El
51.Sh SEE ALSO
52The full documentation for gnunet is maintained as a Texinfo manual.
53If the
54.Xr info 1
55and gnunet programs are properly installed at your site, the command
56.Pp
57.Dl info gnunet
58.Pp
59should give you access to the complete handbook,
60.Pp
61.Dl info gnunet-c-tutorial
62.Pp
63will give you access to a tutorial for developers.
64.sp
65Depending on your installation, this information is also available in
66.Xr gnunet 7 and
67.Xr gnunet-c-tutorial 7 .
68.\".Sh HISTORY
69.\".Sh AUTHORS
70.Sh BUGS
71Report bugs by using
72.Lk https://bugs.gnunet.org
73or by sending electronic mail to
74.Aq Mt gnunet-developers@gnu.org .