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