honk/docs/vim.3.html
2022-11-13 16:19:53 +01:00

112 lines
3.9 KiB
HTML

<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2019 Ted Unangst
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-->
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
<title>VIM(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">VIM(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">VIM(3)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">vim</code> &#x2014; <span class="Nd">vital
improvements module</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The vital improvements module, <code class="Nm">vim</code>, is
used to customize and extend honk in such rare cases as the existing
functionality proves insufficient.</p>
<section class="Ss">
<h2 class="Ss" id="Files"><a class="permalink" href="#Files">Files</a></h2>
<dl class="Bl-tag">
<dt>activity.go</dt>
<dd>Conversion to and from ActivityPub format and interop with other
implementations.</dd>
<dt>admin.go</dt>
<dd>The console admin interface.</dd>
<dt>avatar.go</dt>
<dd>Code to generate blocky avatar images.</dd>
<dt>backend.go</dt>
<dd>Interface to the image resizing backend helper process.</dd>
<dt>bloat.go</dt>
<dd>Bad stuff.</dd>
<dt>database.go</dt>
<dd>Loading and saving things to database.</dd>
<dt>deliverator.go</dt>
<dd>Sending messages and handling retries.</dd>
<dt>fun.go</dt>
<dd>All sorts of fun stuff.</dd>
<dt>hfcs.go</dt>
<dd>Filtering framework.</dd>
<dt>honk.go</dt>
<dd>Just a few data types.</dd>
<dt>hoot.go</dt>
<dd>Twitter scraper.</dd>
<dt>import.go</dt>
<dd>Importers from other service data dumps.</dd>
<dt>markitzero.go</dt>
<dd>Markdown converter.</dd>
<dt>schema.go</dt>
<dd>Generated from schema.sql.</dd>
<dt>sensors.go</dt>
<dd>Monitor memory and CPU.</dd>
<dt>skulduggery.go</dt>
<dd>Reduce some stupidity.</dd>
<dt>unveil.go</dt>
<dd>OpenBSD pledge and unveil.</dd>
<dt>upgradedb.go</dt>
<dd>Upgrade between schema versions.</dd>
<dt>util.go</dt>
<dd>Boring code.</dd>
<dt>web.go</dt>
<dd>The web interface.</dd>
</dl>
</section>
<section class="Ss">
<h2 class="Ss" id="Schema"><a class="permalink" href="#Schema">Schema</a></h2>
<p class="Pp">The current schema is stored in
<span class="Pa">schema.sql</span>.</p>
<p class="Pp">After changing the schema, edit
<span class="Pa">upgradedb.go</span> to update
<var class="Va">myVersion</var> and add relevant update statements to the
bottom of the large switch.</p>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr" href="honk.3.html">honk(3)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">May 31, 2022</td>
<td class="foot-os">OpenBSD 7.1</td>
</tr>
</table>
</body>
</html>