X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=readme.txt;h=6f278bf3fa616ae58c564e7e5c8a78a4c35f39f8;hb=dabd19d7f764b8275c9c8370c7b89675b6a78243;hp=0fb3777e03f74a50b654d9a628c9c57e36c629d0;hpb=dec33c63afafabf83c3039e916725cac6faef9b3;p=fms.git diff --git a/readme.txt b/readme.txt index 0fb3777..6f278bf 100644 --- a/readme.txt +++ b/readme.txt @@ -1,7 +1,7 @@ COMPILING --------- -Compiling FMS requires CMake, Poco 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 -D I_HAVE_READ_THE_README=ON . @@ -11,7 +11,9 @@ 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 --------- @@ -22,21 +24,35 @@ keep the same database unless otherwise noted. 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 ------- -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 --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. +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. + +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 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 -------