Jelajahi Sumber

Some documentation tweaks.

default 3 tahun lalu
induk
melakukan
daaba2b52e
2 mengubah file dengan 13 tambahan dan 9 penghapusan
  1. 3 2
      doc/snac.5
  2. 10 7
      doc/snac.8

+ 3 - 2
doc/snac.5

@@ -60,6 +60,8 @@ The base directory contains the following files and folders:
 Server configuration.
 Server configuration.
 .It Pa user/
 .It Pa user/
 Directory holding user subdirectories.
 Directory holding user subdirectories.
+.It Pa archive/
+If this directory exists, all input and output messages are stored into.
 .El
 .El
 .Pp
 .Pp
 Each user directory is a subdirectory of 
 Each user directory is a subdirectory of 
@@ -117,8 +119,7 @@ web interface.
 This directory contains generated HTML files. They may be snapshots of the
 This directory contains generated HTML files. They may be snapshots of the
 local timeline in previous months or other cached data.
 local timeline in previous months or other cached data.
 .It Pa archive/
 .It Pa archive/
-This directory stores all input/output traffic of ActivityPub messages. There
-is a different file for each day. This information is only stored if
+This directory is no longer used in version 2.x and later. It can be deleted.
 .Nm
 .Nm
 is run with a debug level >= 1.
 is run with a debug level >= 1.
 .El
 .El

+ 10 - 7
doc/snac.8

@@ -14,8 +14,16 @@ This is the admin manual. For user operation, see
 .Xr snac 1 .
 .Xr snac 1 .
 For file and data formats, see
 For file and data formats, see
 .Xr snac 5 .
 .Xr snac 5 .
-.Ss Installation
-Install the OpenSSL and urllib3 Python3 external packages, and run as root
+.Ss Building and Installation
+A C compiler must be installed in the system, as well as the development
+headers and libraries for OpenSSL and curl. To build
+.Nm ,
+run
+.Bd -literal -offset indent
+make
+.Ed
+.Pp
+And, after that, run as root
 .Bd -literal -offset indent
 .Bd -literal -offset indent
 make install
 make install
 .Ed
 .Ed
@@ -179,11 +187,6 @@ user's crontab:
 0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data
 0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data
 .Ed
 .Ed
 .Pp
 .Pp
-Other directories, like
-.Pa archive/ ,
-can grow very quickly if the debug level is greater than 0. These
-files must be deleted manually.
-.Pp
 The user-generated data (the local timeline) is never deleted.
 The user-generated data (the local timeline) is never deleted.
 .Ss ActivityPub Support
 .Ss ActivityPub Support
 These are the following activities and objects that
 These are the following activities and objects that