X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;ds=sidebyside;f=readme.txt;h=420fdf102256e66e2b5adbd7c33db4d8def1e3a3;hb=853f67b0b7b8121d572cff34d40f7b28cac8f65e;hp=e853ecb068a0ce8926357713d1af6b436bb070d4;hpb=5c0453c8697cfaa843dd7f799e5404733ee56e13;p=fms.git
diff --git a/readme.txt b/readme.txt
index e853ecb..420fdf1 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,27 +1,30 @@
COMPILING
---------
-Compiling FMS requires CMake, and pthreads. Other required libraries are
-bundled with FMS.
+Compiling FMS requires CMake, pthreads and iconv if you want to do charset
+conversion. Other required libraries are bundled with FMS.
To compile, run these commands from the source directory:
cmake .
make
If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON
-to the cmake command.
+to the cmake command. To do charset conversion to UTF-8 when sending messages,
+add a -D DO_CHARSET_CONVERSION=ON.
UPGRADING
---------
It is always a good idea to make copies of your current FMS installation before
-continuing. First shut down FMS and then replace the binary and template.htm
-with those from the new version. You may keep the same database unless
-otherwise noted.
+continuing. First shut down FMS and then replace the binary and templates with
+those from the new version. You may keep the same database unless otherwise
+noted.
INSTALLATION
------------
-Place the binary and template.htm in a directory of your choice. On the first
-run, a database file will also be created in this directory. Make sure the
-user that runs FMS has read/write access to this directory.
+Place the binary and any templates in a directory of your choice. Windows
+users may need to download the runtime DLLs available from the fms Freesite and
+place in the fms directory if they are not already installed on the system. On
+the first run, a database file will also be created in this directory. Make
+sure the user that runs FMS has read/write access to this directory.
RUNNING
-------
@@ -50,10 +53,13 @@ is discarded when posting messages.
POSTING MESSAGES
----------------
-Use must set your newsreader to use UTF-8 when posting messages. Any non-text
-attachment to the message will be stripped. Text attachments will be inlined
-with the message body. Cross posting is fine, but remember that each identity
-can set a limit to the number of boards each message may be cross posted to.
+You must set your newsreader to use UTF-8 when posting messages. Any non-text
+attachment to the message will be inserted as a regular file and the key added
+to the body of the message when received. Keep the attachments small, as the
+message can't be inserted until all attachments are inserted. Text attachments
+will be inlined with the message body. Cross posting is fine, but remember
+that each identity can set a limit to the number of boards each message may be
+cross posted to.
CONTROL BOARDS
--------------
@@ -71,9 +77,16 @@ called site-template.htm is used to insert the site. You can customize the
template by placing an HTML file called identityname-template.htm in the same
directory as the fms binary. In the template, the string [LINKS] will be
replaced by a
list of links and [CONTENT] will be replaced by the page
-content. The Freesite will be inserted once a day and contain your last 10
-posts and your trust list if you are publishing it. The site will be inserted
-to a USK accessible via: USK@yourpublickey.../fms/0/
+content. [IDENTITYNAME] will be replaced by the name of the identity inserting
+the Freesite. The Freesite will be inserted once a day and contain your last
+10 posts and your trust list if you are publishing it. The site will be
+inserted to a USK accessible via: USK@yourpublickey.../fms/0/
+
+You may add extra files to your Freesite by creating a file called identityname-
+files.txt that contains a list of files to add to the Freesite. There should
+be one file per line, and the path to each file may be absolute or relative to
+the working directory, but you MUST use / as the path separator. Files cannot
+be named index.htm, trustlist.htm, or files.htm.
TRUST
-----
@@ -83,10 +96,52 @@ trust to arbitrary identities. Pick whom you trust wisely. The settings for
minimum trust before downloading messages and trust lists can be changed on the
web interface.
+You must have a local identity created before you can set trust levels. Even
+if you don't want to post messages, you must still create an identity, but you
+do not have to announce it. This way, no-one will know about that identity and
+you will be able to set trust. If you have multiple identities, each with
+different trust levels for peers, the highest trust level set for a peer will
+determine if messages/trust lists are downloaded from them.
+
A note on NULL trust: If you neither trust or distrust an identity, they will
have NULL trust (no trust at all). You will download messages and trust lists
-from identities with NULL peer trust as long as the local trust level is above
-your configured minimum. You will also download messages from identities with
-NULL local message trust (the peer message trust must be NULL or > your
+from identities with NULL peer trust as long as the local trust level is at or
+above your configured minimum. You will also download messages from identities
+with NULL local message trust (the peer message trust must be NULL or >= your
configured minimum as well), but you will not download trust lists from
identities with NULL local trust list trust.
+
+NNTP EXTENSIONS
+---------------
+The following commands are available through the NNTP connection. The client
+must have authenticated for the commands to work. Comments MUST be surrounded
+by ".
+
+XSETTRUST MESSAGE userid@keypart val
+XSETTRUST TRUSTLIST userid@keypart val
+XSETTRUST MESSAGECOMMENT userid@keypart "comment"
+XSETTRUST TRUSTLISTCOMMENT userid@keypart "comment"
+
+Responses:
+2xx Trust Set
+4xx Unknown ID or other error
+5xx Syntax error
+
+XGETTRUST MESSAGE userid@keypart
+XGETTRUST TRUSTLIST userid@keypart
+XGETTRUST PEERMESSAGE userid@keypart
+XGETTRUST PEERTRUSTLIST userid@keypart
+
+Responses:
+2xx val
+4xx Unknown ID or other error
+5xx Syntax error
+
+XGETTRUSTLIST
+trust values will be 0 to 100 or can be the string "null" without quotes.
+
+Responses:
+2xx Trust List Follows
+userid@keypart TAB messagetrust TAB trustlisttrust TAB peermessagetrust TAB peertrustlisttrust TAB messagecomment TAB trustlistcomment
+.
+4xx other error