index.md

Mon, 07 Jun 2021 21:42:09 +0200

author
David Demelier <markand@malikania.fr>
date
Mon, 07 Jun 2021 21:42:09 +0200
changeset 1
30a1f29b3316
parent 0
d450dddcd926
permissions
-rw-r--r--

misc: use mandoc to markdown

0
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 % libbase64 - base64 encoding and decoding
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 % David Demelier <markand@malikania.fr>
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 % 2021-06-07
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 libbase64 - base64 encoding and decoding
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ========================================
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 The `libbase64` is a minimal C library to decode and encore base64 in pure C89.
1
30a1f29b3316 misc: use mandoc to markdown
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
9 It does not depend on anything not portable except C standard library.
0
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 It consists of:
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - base64 encoding,
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - base64 decoding (with base64url support),
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 - no dynamic allocation required,
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 - only C89 required.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 - less than 200 lines of code.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 - 2 public functions.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 News
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ----
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 - (2021-06-07) New release: libbase64 2.0.0.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Download
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 --------
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 ### Official releases
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 - [libbase64-2.0.0.tar.xz][] ([signature][libbase64-2.0.0.tar.xz.asc])
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 ### Development version
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 You can install a development version using [Mercurial][hg]
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 hg clone http://hg.malikania.fr/libbase64
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 Installation
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 ------------
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 The library is too small to be worth being installed system wide and as such
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 there are no `install` target nor library generation. Instead, you should simply
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 copy the files `base64.c` and `base64.h` to your project and start using the
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 functions.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 You can still run the test suite using `make tests` command.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 Documentation
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 -------------
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 Manual pages:
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 - [libbase64.3](libbase64.html) ([pdf](libbase64.pdf))
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 Also have a look into the official [README.md][] file in the repository
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 which may contain additional information and a FAQ.
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 [hg]: http://mercurial-scm.org
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 [INSTALL.md]: http://hg.malikania.fr/libbase64/file/tip/INSTALL.md
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 [README.md]: http://hg.malikania.fr/libbase64/file/tip/README.md
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 [libbase64-2.0.0.tar.xz]: http://releases.malikania.fr/libbase64/2.0.0/libbase64-2.0.0.tar.xz
d450dddcd926 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 [libbase64-2.0.0.tar.xz.asc]: http://releases.malikania.fr/libbase64/2.0.0/libbase64-2.0.0.tar.xz.asc

mercurial