1.\"
 2.\" Copyright (c) 2019 Ted Unangst
 3.\"
 4.\" Permission to use, copy, modify, and distribute this software for any
 5.\" purpose with or without fee is hereby granted, provided that the above
 6.\" copyright notice and this permission notice appear in all copies.
 7.\"
 8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate$
17.Dt VIM 3
18.Os
19.Sh NAME
20.Nm vim
21.Nd vital improvements module
22.Sh DESCRIPTION
23The vital improvements module,
24.Nm ,
25is used to customize and extend honk in such rare cases as the
26existing functionality proves insufficient.
27.Ss Files
28.Bl -tag -width deliverator.go
29.It activity.go
30Conversion to and from ActivityPub format and interop with other
31implementations.
32.It admin.go
33The console admin interface.
34.It avatar.go
35Code to generate blocky avatar images.
36.It backend.go
37Interface to the image resizing backend helper process.
38.It bloat.go
39Bad stuff.
40.It database.go
41Loading and saving things to database.
42.It deliverator.go
43Sending messages and handling retries.
44.It fun.go
45All sorts of fun stuff.
46.It hfcs.go
47Filtering framework.
48.It honk.go
49Just a few data types.
50.It hoot.go
51Twitter scraper.
52.It import.go
53Importers from other service data dumps.
54.It markitzero.go
55Markdown converter.
56.It schema.go
57Generated from schema.sql.
58.It sensors.go
59Monitor memory and CPU.
60.It skulduggery.go
61Reduce some stupidity.
62.It unveil.go
63OpenBSD pledge and unveil.
64.It upgradedb.go
65Upgrade between schema versions.
66.It util.go
67Boring code.
68.It web.go
69The web interface.
70.El
71.Ss Schema
72The current schema is stored in
73.Pa schema.sql .
74.Pp
75After changing the schema, edit
76.Pa upgradedb.go
77to update
78.Va myVersion
79and add relevant update statements to the bottom of the large switch.
80.Sh SEE ALSO
81.Xr honk 3