X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=0fb3777e03f74a50b654d9a628c9c57e36c629d0;hb=dec33c63afafabf83c3039e916725cac6faef9b3;hp=be5550851376aaed9b24f98d09a8907267611057;hpb=bae54a5dae027ad0a6b0126ec9eeecd3bd2739eb;p=fms.git diff --git a/readme.txt b/readme.txt index be55508..0fb3777 100644 --- a/readme.txt +++ b/readme.txt @@ -1,34 +1,42 @@ COMPILING --------- -Compiling FMS requires CMake, and pthreads. Other required libraries are -bundled with FMS. +Compiling FMS requires CMake, Poco 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 ------- You may run FMS in console mode by running the binary directly. If you are -running *nix and would like to run as a daemon, use the -d argument. On -Windows, -i will install FMS as a service, and -u will uninstall the service. +running *nix and would like to run as a daemon, use the --daemon argument. On +Windows, /registerService will install FMS as a service, and /unregisterService +will uninstall the service. Use the /displayName=name argument when installing +the service to set the service name to whatever you want. You will need to +manually start the service unless you change the startup type in the service +properties. EXITING ------- @@ -51,10 +59,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 -------------- @@ -72,9 +83,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