X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=021bc834e910c784d886e2300db18062fd985b9f;hb=6836fbb5db8464f56e682989996b2210b14231d0;hp=593a99f14e07361bf2837443fbf08a9e3c33eb0a;hpb=107bd97018964d48425306026d06afd038e84db0;p=fms.git

diff --git a/readme.txt b/readme.txt
index 593a99f..021bc83 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,14 +1,15 @@
 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
 ---------
@@ -50,10 +51,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 +75,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 <ul> 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,6 +94,13 @@ 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 at or
@@ -90,3 +108,34 @@ 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.
+
+XSETTRUST MESSAGE userid@keypart val
+XSETTRUST TRUSTLIST userid@keypart val
+
+Responses:
+2xx Trust Set
+4xx Unknown ID or other error
+5xx Syntax error
+
+XGETTRUST MESSAGE userid@keypart
+XGETTRUST TRUSTLIST userid@keypart
+
+Responses:
+2xx val
+4xx Unknown ID or other error
+5xx Syntax error
+
+XGETTRUSTLIST
+messagetrust and trustlisttrust will be 0 to 100 or can be the string "null"
+without quotes.
+
+Responses:
+2xx Trust List Follows
+userid@keypart TAB messagetrust TAB trustlisttrust
+.
+4xx other error