X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=77ca2762d6bd5017dd7e58b9de698093492a7355;hb=3751f10f7127ae0905aa0b52dc6de1c782a38c99;hp=133a0aa2525f12178683d07fd264ce586b0f0f36;hpb=63376b2a82c3f6cdf2df56b1f134bd7df0aaab3a;p=fms.git diff --git a/readme.txt b/readme.txt index 133a0aa..77ca276 100644 --- a/readme.txt +++ b/readme.txt @@ -1,34 +1,43 @@ COMPILING --------- -Compiling FMS requires CMake, pthreads and iconv if you want to do charset -conversion. Other required libraries are bundled with FMS. +Compiling FMS requires CMake, Poco ( version >=1.2.9 ) 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. +You may run FMS in console mode by running the binary directly. You can view +available command line options by typing /help on Windows and --help on other +platforms. If you are 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 ------- @@ -75,9 +84,10 @@ 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