X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=038bb56f4adee381dff77035316dece4c7f431bd;hb=9b22dd53fe62e312c1647310b7ec43aa127090af;hp=021bc834e910c784d886e2300db18062fd985b9f;hpb=6836fbb5db8464f56e682989996b2210b14231d0;p=fms.git diff --git a/readme.txt b/readme.txt index 021bc83..038bb56 100644 --- 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. To compile, run these commands from the source directory: -cmake . +cmake -D I_HAVE_READ_THE_README=ON . make If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON -to the cmake command. To do charset conversion to UTF-8 when sending messages, -add a -D DO_CHARSET_CONVERSION=ON. +to the cmake command. Use of the bundled SQLite3 library is on by default when +compiling on a Mac. To turn off charset conversion to UTF-8 when sending +messages, add a -D DO_CHARSET_CONVERSION=OFF. Compiling with charset +conversion turned on is recommended. 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 templates with -those from the new version. You may keep the same database unless otherwise -noted. +It is always a good idea to make a copy of your current FMS installation before +continuing. First shut down FMS, make a copy of the directory, and then +replace all files except the database with those from the new version. You may +keep the same database unless otherwise noted. INSTALLATION ------------ -Place the binary and any templates 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 ------- @@ -112,10 +116,13 @@ 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. +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 @@ -124,6 +131,8 @@ Responses: XGETTRUST MESSAGE userid@keypart XGETTRUST TRUSTLIST userid@keypart +XGETTRUST PEERMESSAGE userid@keypart +XGETTRUST PEERTRUSTLIST userid@keypart Responses: 2xx val @@ -131,11 +140,10 @@ Responses: 5xx Syntax error XGETTRUSTLIST -messagetrust and trustlisttrust will be 0 to 100 or can be the string "null" -without quotes. +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 +userid@keypart TAB messagetrust TAB trustlisttrust TAB peermessagetrust TAB peertrustlisttrust TAB messagecomment TAB trustlistcomment . 4xx other error