version 0.2.23

[fms.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index 4874179..038bb56 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -4,25 +4,29 @@ Compiling FMS requires CMake, pthreads and iconv if you want to do charset
 conversion.  Other required libraries are bundled with FMS.\r
 \r
 To compile, run these commands from the source directory:\r
-cmake .\r
+cmake -D I_HAVE_READ_THE_README=ON .\r
 make\r
 \r
 If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON\r
-to the cmake command.  To do charset conversion to UTF-8 when sending messages,\r
-add a -D DO_CHARSET_CONVERSION=ON.\r
+to the cmake command.  Use of the bundled SQLite3 library is on by default when\r
+compiling on a Mac.  To turn off charset conversion to UTF-8 when sending\r
+messages, add a -D DO_CHARSET_CONVERSION=OFF.  Compiling with charset\r
+conversion turned on is recommended.\r
 \r
 UPGRADING\r
 ---------\r
-It is always a good idea to make copies of your current FMS installation before\r
-continuing.  First shut down FMS and then replace the binary and templates with\r
-those from the new version.  You may keep the same database unless otherwise\r
-noted.\r
+It is always a good idea to make a copy of your current FMS installation before\r
+continuing.  First shut down FMS, make a copy of the directory, and then\r
+replace all files except the database with those from the new version.  You may\r
+keep the same database unless otherwise noted.\r
 \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
@@ -112,10 +116,13 @@ identities with NULL local trust list trust.
 NNTP EXTENSIONS\r
 ---------------\r
 The following commands are available through the NNTP connection.  The client\r
-must have authenticated for the commands to work.\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
@@ -133,11 +140,10 @@ Responses:
 5xx Syntax error\r
 \r
 XGETTRUSTLIST\r
-messagetrust and trustlisttrust will be 0 to 100 or can be the string "null"\r
-without quotes.\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\r
+userid@keypart TAB messagetrust TAB trustlisttrust TAB peermessagetrust TAB peertrustlisttrust TAB messagecomment TAB trustlistcomment\r
 .\r
 4xx other error\r