summaryrefslogtreecommitdiff
path: root/doc/snac.8
diff options
context:
space:
mode:
authorGravatar default2022-12-04 07:18:24 +0100
committerGravatar default2022-12-04 07:18:24 +0100
commit30e3f2fc3d121a5d0bdf6ed201da7965ecbca7df (patch)
treeedb947aa22acdc86705716ff23a7c9d813ff55b2 /doc/snac.8
parentUpdated TODO. (diff)
downloadsnac2-30e3f2fc3d121a5d0bdf6ed201da7965ecbca7df.tar.gz
snac2-30e3f2fc3d121a5d0bdf6ed201da7965ecbca7df.tar.xz
snac2-30e3f2fc3d121a5d0bdf6ed201da7965ecbca7df.zip
Updated documentation.
Diffstat (limited to 'doc/snac.8')
-rw-r--r--doc/snac.816
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/snac.8 b/doc/snac.8
index 60671a1..eca1420 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -29,7 +29,7 @@ link counts. Remember:
29is a very UNIXy program that loves hard links. 29is a very UNIXy program that loves hard links.
30.Ss Building and Installation 30.Ss Building and Installation
31A C compiler must be installed in the system, as well as the development 31A C compiler must be installed in the system, as well as the development
32headers and libraries for OpenSSL and curl. To build 32headers and libraries for OpenSSL (or compatible) and curl. To build
33.Nm , 33.Nm ,
34run 34run
35.Bd -literal -offset indent 35.Bd -literal -offset indent
@@ -40,7 +40,7 @@ And, after that, run as root
40.Bd -literal -offset indent 40.Bd -literal -offset indent
41make install 41make install
42.Ed 42.Ed
43.Ss Database Initialization 43.Ss Data storage Initialization
44Once 44Once
45.Nm 45.Nm
46is properly installed on the system, designate a directory where 46is properly installed on the system, designate a directory where
@@ -48,7 +48,7 @@ the server and user data are to be stored. This directory
48must not exist yet. 48must not exist yet.
49.Nm 49.Nm
50must always be run as a regular user; you can create one for 50must always be run as a regular user; you can create one for
51it or use your own. To initialize the database, execute 51it or use your own. To initialize the data storage, execute
52.Bd -literal -offset indent 52.Bd -literal -offset indent
53snac init $HOME/snac-data 53snac init $HOME/snac-data
54.Ed 54.Ed
@@ -83,13 +83,14 @@ directory.
83For other operating systems, please read the appropriate documentation 83For other operating systems, please read the appropriate documentation
84on how to install a daemon as a non-root service. 84on how to install a daemon as a non-root service.
85.Ss Upgrading to a new version 85.Ss Upgrading to a new version
86Sometimes, the database disk layout changes between versions. If there 86Sometimes, the data storage disk layout changes between versions. If there
87is such a change, 87is such a change,
88.Nm 88.Nm
89will refuse to run and require an upgrade. Do this by running 89will refuse to run and require an upgrade. Do this by running
90.Bd -literal -offset indent 90.Bd -literal -offset indent
91snac upgrade $HOME/snac-data 91snac upgrade $HOME/snac-data
92.Ed 92.Ed
93.Pp
93Take special care to execute this upgrade operation without any 94Take special care to execute this upgrade operation without any
94.Nm 95.Nm
95processes serving on the same folder. You can break everything. I know 96processes serving on the same folder. You can break everything. I know
@@ -195,10 +196,7 @@ supports:
195Complete support, on input and output. 196Complete support, on input and output.
196.It Vt Undo 197.It Vt Undo
197For 198For
198.Vt Follow , 199.Vt Follow
199.Vt Like
200and
201.Vt Announce
202objects, on input and output. 200objects, on input and output.
203.It Vt Create 201.It Vt Create
204For 202For
@@ -265,7 +263,7 @@ bloated and filled with redundant information. Using a filesystem with
265file compression enabled (like btrfs or zfs) will probably be a good 263file compression enabled (like btrfs or zfs) will probably be a good
266choice to store the 264choice to store the
267.Nm 265.Nm
268database into. 266data storage into.
269.Sh ENVIRONMENT 267.Sh ENVIRONMENT
270.Bl -tag -width Ds 268.Bl -tag -width Ds
271.It Ev DEBUG 269.It Ev DEBUG