X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=caaf69d8b994acf9a3d1f8bbf63e7e6a256bfc6a;hb=221236a4d3aac4144529d418ce368db5c98facb0;hp=3df7b4b4988996ba27c8488ac343e03e0b69b81f;hpb=023b2219068d481cd6a300982427c99bacd88a12;p=fms.git diff --git a/readme.txt b/readme.txt index 3df7b4b..caaf69d 100644 --- a/readme.txt +++ b/readme.txt @@ -11,22 +11,25 @@ If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=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. +conversion turned on is recommended. If you would like to compile using the +alternate captchas, add a -D ALTERNATE_CAPTCHA=ON to the cmake command line. +This option requires the FreeImage library to be installed. UPGRADING --------- 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. +keep the same database unless otherwise noted in the release information. INSTALLATION ------------ -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. +Place the binary, any templates, and the fonts directory 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 ------- @@ -42,13 +45,14 @@ startup type in the service properties. If you are experiencing a problem with FMS that you can't solve, and you've already rebooted your machine, restarted FMS, and have reproduced the problem with a brand new database, follow these instructions. Set the logging option -to trace and restart FMS. Create a post on the fms group that contains the -operating system you are using, along with a description of the problem, what -you have tried already, if you are using a precompiled binary, the startup -lines from the log file as well as the portion that corresponds to the problem -you are experiencing, and any other information you have that pertains to the -problem. Make sure to anonymize any IP addresses, host names, subnet masks, -and keys from the log that you don't want people to know about. +to trace and restart FMS. Create a post on the fms group with a descriptive +subject and a body that contains the operating system you are using, along with +a description of the problem, what you have tried already, if you are using a +precompiled binary, the startup lines from the log file as well as the portion +that corresponds to the problem you are experiencing, and any other information +you have that pertains to the problem. Make sure to anonymize any IP addresses, +host names, subnet masks, and keys from the log that you don't want people to +know about. EXITING ------- @@ -71,13 +75,16 @@ is discarded when posting messages. POSTING MESSAGES ---------------- -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. +You must set your newsreader to use UTF-8 when posting messages unless you have +compiled with charset conversion turned on. All headers of the message that +aren't needed will be stripped and all headers necessary for the proper sending +of the message will be replaced with sanitized ones. 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 --------------