version 0.2.20

[fms.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index be55508..420fdf1 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -1,7 +1,7 @@
 COMPILING\r
 ---------\r
-Compiling FMS requires CMake, and pthreads.  Other required libraries are\r
-bundled with FMS.\r
+Compiling FMS requires CMake, pthreads and iconv if you want to do charset\r
+conversion.  Other required libraries are bundled with FMS.\r
 \r
 To compile, run these commands from the source directory:\r
 cmake .\r
@@ -20,9 +20,11 @@ noted.
 \r
 INSTALLATION\r
 ------------\r
-Place the binary and any templates in a directory of your choice.  On the first\r
-run, a database file will also be created in this directory.  Make sure the\r
-user that runs FMS has read/write access to this directory.\r
+Place the binary and any templates in a directory of your choice.  Windows\r
+users may need to download the runtime DLLs available from the fms Freesite and\r
+place in the fms directory if they are not already installed on the system.  On\r
+the first run, a database file will also be created in this directory.  Make\r
+sure the user that runs FMS has read/write access to this directory.\r
 \r
 RUNNING\r
 -------\r
@@ -51,10 +53,13 @@ is discarded when posting messages.
 \r
 POSTING MESSAGES\r
 ----------------\r
-Use must set your newsreader to use UTF-8 when posting messages.  Any non-text\r
-attachment to the message will be stripped.  Text attachments will be inlined\r
-with the message body.  Cross posting is fine, but remember that each identity\r
-can set a limit to the number of boards each message may be cross posted to.\r
+You must set your newsreader to use UTF-8 when posting messages.  Any non-text\r
+attachment to the message will be inserted as a regular file and the key added\r
+to the body of the message when received.  Keep the attachments small, as the\r
+message can't be inserted until all attachments are inserted.  Text attachments\r
+will be inlined with the message body.  Cross posting is fine, but remember\r
+that each identity can set a limit to the number of boards each message may be\r
+cross posted to.\r
 \r
 CONTROL BOARDS\r
 --------------\r
@@ -72,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\r
 directory as the fms binary.  In the template, the string [LINKS] will be\r
 replaced by a <ul> list of links and [CONTENT] will be replaced by the page\r
-content.  The Freesite will be inserted once a day and contain your last 10\r
-posts and your trust list if you are publishing it.  The site will be inserted\r
-to a USK accessible via: USK@yourpublickey.../fms/0/\r
+content.  [IDENTITYNAME] will be replaced by the name of the identity inserting\r
+the Freesite.  The Freesite will be inserted once a day and contain your last\r
+10 posts and your trust list if you are publishing it.  The site will be\r
+inserted to a USK accessible via: USK@yourpublickey.../fms/0/\r
+\r
+You may add extra files to your Freesite by creating a file called identityname-\r
+files.txt that contains a list of files to add to the Freesite.  There should\r
+be one file per line, and the path to each file may be absolute or relative to\r
+the working directory, but you MUST use / as the path separator.  Files cannot\r
+be named index.htm, trustlist.htm, or files.htm.\r
 \r
 TRUST\r
 -----\r
@@ -98,3 +110,38 @@ 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\r
 configured minimum as well), but you will not download trust lists from\r
 identities with NULL local trust list trust.\r
+\r
+NNTP EXTENSIONS\r
+---------------\r
+The following commands are available through the NNTP connection.  The client\r
+must have authenticated for the commands to work.  Comments MUST be surrounded\r
+by ".\r
+\r
+XSETTRUST MESSAGE userid@keypart val\r
+XSETTRUST TRUSTLIST userid@keypart val\r
+XSETTRUST MESSAGECOMMENT userid@keypart "comment"\r
+XSETTRUST TRUSTLISTCOMMENT userid@keypart "comment"\r
+\r
+Responses:\r
+2xx Trust Set\r
+4xx Unknown ID or other error\r
+5xx Syntax error\r
+\r
+XGETTRUST MESSAGE userid@keypart\r
+XGETTRUST TRUSTLIST userid@keypart\r
+XGETTRUST PEERMESSAGE userid@keypart\r
+XGETTRUST PEERTRUSTLIST userid@keypart\r
+\r
+Responses:\r
+2xx val\r
+4xx Unknown ID or other error\r
+5xx Syntax error\r
+\r
+XGETTRUSTLIST\r
+trust values will be 0 to 100 or can be the string "null" without quotes.\r
+\r
+Responses:\r
+2xx Trust List Follows\r
+userid@keypart TAB messagetrust TAB trustlisttrust TAB peermessagetrust TAB peertrustlisttrust TAB messagecomment TAB trustlistcomment\r
+.\r
+4xx other error\r