1# APKDOC
 2
 3Document generator for alpine's index format v2 file[^1].
 4
 5## Usage example
 6
 7```sh
 8apkdoc \
 9	-t text \
10	-u https://alpine.mirror.wearetriple.com/v3.18/main/x86_64/APKINDEX.tar.gz \
11	-f example.md \
12	-o index.txt
13```
14
15## Data 
16
17`apkdoc` offers a list of the following struct to the template:
18
19```go
20type Entry struct {
21	Checksum         string     // C
22	Version          string     // V
23	Name             string     // P
24	Architecture     *string    // A
25	PackageSize      int        // S
26	InstalledSize    int        // I
27	Description      string     // T
28	Url              string     // U
29	License          string     // L
30	Origin           *string    // o
31	Maintainer       *string    // m
32	BuildTime        *time.Time // t
33	Commit           *string    // c
34	ProviderPriority *int       // k
35	Dependencies     []string   // D
36	Provides         []string   // p
37	InstallIf        []string   // i
38}
39```
40
41## Functions
42
43`apkdoc` also offers a couple help functions.
44
45### `DerefI`
46
47Deref int pointer.
48
49### `DerefS`
50
51Deref string pointer.
52
53### `Properties`
54
55A `Entry` function that generate a map of with lower cased space separated
56property name.
57
58[^1]: https://wiki.alpinelinux.org/wiki/Apk_spec