version 0.3.4
[fms.git] / readme.txt
index 038bb56..3df7b4b 100644 (file)
@@ -1,7 +1,7 @@
 COMPILING\r
 ---------\r
-Compiling FMS requires CMake, pthreads and iconv if you want to do charset\r
-conversion.  Other required libraries are bundled with FMS.\r
+Compiling FMS requires CMake, Poco ( version >=1.2.9 ) and iconv if you want to\r
+do charset conversion.  Other required libraries are bundled with FMS.\r
 \r
 To compile, run these commands from the source directory:\r
 cmake -D I_HAVE_READ_THE_README=ON .\r
@@ -30,9 +30,25 @@ sure the user that runs FMS has read/write access to this directory.
 \r
 RUNNING\r
 -------\r
-You may run FMS in console mode by running the binary directly.  If you are\r
-running *nix and would like to run as a daemon, use the -d argument.  On\r
-Windows, -i will install FMS as a service, and -u will uninstall the service.\r
+You may run FMS in console mode by running the binary directly.  You can view\r
+available command line options by typing /help on Windows and --help on other\r
+platforms.  If you are running *nix and would like to run as a daemon, use the \r
+--daemon argument.  On Windows, /registerService will install FMS as a service,\r
+and /unregisterService will uninstall the service.  Use the /displayName=name\r
+argument when installing the service to set the service name to whatever you\r
+want.  You will need to manually start the service unless you change the\r
+startup type in the service properties.\r
+\r
+If you are experiencing a problem with FMS that you can't solve, and you've\r
+already rebooted your machine, restarted FMS, and have reproduced the problem\r
+with a brand new database, follow these instructions.  Set the logging option\r
+to trace and restart FMS.  Create a post on the fms group that contains the\r
+operating system you are using, along with a description of the problem, what\r
+you have tried already, if you are using a precompiled binary, the startup\r
+lines from the log file as well as the portion that corresponds to the problem\r
+you are experiencing, and any other information you have that pertains to the\r
+problem.  Make sure to anonymize any IP addresses, host names, subnet masks,\r
+and keys from the log that you don't want people to know about.\r
 \r
 EXITING\r
 -------\r