chiark / gitweb /
Manpages: Move manpages (back?) into the top-level directory.
[mLib] / base32.3
1c4fa429 1.\" -*-nroff-*-
2.TH base32 3 "28 September 2004" "Straylight/Edgeware" "mLib utilities library"
4base32 \- conversion to and from base32 encoding
5.\" @base32_encode
6.\" @base32_decode
7.\" @base32_init
10.B "#include <mLib/base32.h>"
12.BI "void base32_encode(base32_ctx *" ctx ,
13.BI " const void *" p ", size_t " sz ,
14.BI " dstr *" d );
15.BI "void base32_decode(base32_ctx *" ctx ,
16.BI " const void *" p ", size_t " sz ,
17.BI " dstr *" d );
18.BI "void base32_init(base32_ctx *" ctx );
22.B base32
23functions perform base32 encoding and decoding of arbitrary binary
24strings. The base32 encoding is defined by RFC2938.
26Before encoding or decoding a string, a
27.I context
28(of type
29.BR base32_ctx )
30must be initialized, by passing it to
31.BR base32_init .
32The context contains data which must be retained between calls to encode
33or decode substrings. The
34.B base32_init
35function sets up initial values for the data, and sets up defaults for
36the output formatting settings (see below).
38Encoding of a string is performed by the
39.B base32_encode
40function. It is passed a pointer to a context block
41.IR ctx ,
42the input substring to encode passed by address
43.I p
44and length
45.IR sz ,
46and a pointer to a dynamic string
47.I d
48in which to write its output (see
49.BR dstr (3)
50for details on dynamic strings). Once all the input data has been
51passed through
52.B base32_encode
53it is necessary to flush the final few bytes of output. This is
54achieved by passing
55.B base32_encode
56a null pointer as its source argument. It is an error to attempt to
57continue encoding after flushing output.
59The output of the
60.B base32_encode
61function is formatted into lines using values from the context
62structure. The
63.B indent
64member is a pointer to a null-terminated string which is used to
65separate the output lines. The default indent string contains only a
66newline character. The
67.B maxline
68member gives the maximum length of line that
69.B base32_encode
70is allowed to produce. If this is not a multiple of 4, it is rounded
71up to the next highest multiple of four before use. A value of zero
73.B base32_encode
74not to perform line splitting: the output will be a single (possibly
75very long) output line. The default maximum line length is 72
76characters. You may set these parameters by direct assignment to the
77context structure once it has been initialized.
79Decoding is performed similarly by the
80.B base32_decode
81function. The comments above about flushing output apply equally to
84Decoding ignores all whitespace characters in the encoded string. It
85also ignores
86.RB ` = '
87characters in the string and works out the final block length
88automatically based on the input size.
90.BR base64 (3),
91.BR dstr (3),
92.BR hex (3),
93.BR mLib (3).
9b5ac6ff 95Mark Wooding, <>