summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authordefault <nobody@localhost>2022-11-25 11:04:23 +0100
committerdefault <nobody@localhost>2022-11-25 11:04:23 +0100
commitde5345e5bdb4ac29b19bed57eb4de47c1dc0d5d8 (patch)
treead5329a0e38afd131b5d2008ce2ed43e17b67f8f /doc
parent1acfe8fc54da32e93758b4d93b0df56431c7ee4f (diff)
Updated documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.15
-rw-r--r--doc/snac.89
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index 5303bc8..3e34725 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -145,6 +145,11 @@ Initializes the database. This is an interactive command; necessary
information will be prompted for. The
.Ar basedir
directory must not exist.
+.It Cm upgrade Ar basedir
+Upgrades the database disk layout after installing a new version.
+Only necessary if
+.Nm
+complains and demands it.
.It Cm purge Ar basedir
Purges old data from the timeline of all users.
.It Cm adduser Ar basedir Op uid
diff --git a/doc/snac.8 b/doc/snac.8
index a241158..82ded62 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -69,6 +69,15 @@ startup scripts and configuration data in the
directory.
For other operating systems, please read the appropriate documentation
on how to install a daemon as a non-root service.
+.Ss Upgrading to a new version
+Sometimes, the database disk layout changes between versions. If there
+is such a change,
+.Nm
+will refuse to run and require an upgrade. Do this by running
+.Bd -literal -offset indent
+snac upgrade $HOME/snac-data
+.Ed
+.Pp
.Ss Server Setup
.Pp
An http server with TLS and proxying support must already be