X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=0fb3777e03f74a50b654d9a628c9c57e36c629d0;hb=dec33c63afafabf83c3039e916725cac6faef9b3;hp=420fdf102256e66e2b5adbd7c33db4d8def1e3a3;hpb=3f6f19146f015fa8d2c89f1e72cd467dbc4115aa;p=fms.git diff --git a/readme.txt b/readme.txt index 420fdf1..0fb3777 100644 --- a/readme.txt +++ b/readme.txt @@ -1,22 +1,24 @@ COMPILING --------- -Compiling FMS requires CMake, pthreads and iconv if you want to do charset +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 ------------ @@ -29,8 +31,12 @@ 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 -------