X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=1f5107f288ea12aba5aa23f64e371fbfa2867c7c;hb=7ddb1aeb0b3dc7384597e75f7b3557f2d8f6d14c;hp=db879dcee38915ca963c585891c7cd873b56e6bf;hpb=b4f4686250878cdf4fcb2986a2ea6546cba867d1;p=fms.git diff --git a/readme.txt b/readme.txt index db879dc..1f5107f 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 -------------- @@ -75,6 +79,12 @@ 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/ +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 ----- Trust is the most important element of FMS. It determines which identities you @@ -97,3 +107,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