[Nms-cgi-devel] FAQ updates

[Sam S. <S...@mS...>]

Some cleanup to bits of the FAQ.

Can someone know knows something about running scripts on windows tell
me how wrong the following new FAQ is:
  I get an "Premature End of Script Headers" error. How do i fix it?


Comments on the rest of it also requested :-)

Diff against what's in CVS below.

Regards
Sam


Index: faq_nms.pod
===================================================================
RCS file: /cvsroot/nms-cgi/docs/faq_nms.pod,v
retrieving revision 1.1
diff -u -r1.1 faq_nms.pod
--- faq_nms.pod	14 Sep 2002 16:06:29 -0000	1.1
+++ faq_nms.pod	21 Sep 2002 10:48:40 -0000
@@ -175,6 +175,15 @@
 HTML let you get away with. All tags must be explicitly closed and all
 presentation information is stored in a stylesheet.

+=head2 Can I email my problem report to a developer rather than the list?
+
+There are a number of people who can answer support enquiries, and
+those people are on the mailing list.
+
+Please don't mail developer's individually, because not only may they
+not be the best person to answer your query, but they may be away, and
+so you don't get an answer for a while. It also leaves developers
+less time to actually work on improving the programs.


 =cut
Index: faq_prob.pod
===================================================================
RCS file: /cvsroot/nms-cgi/docs/faq_prob.pod,v
retrieving revision 1.1
diff -u -r1.1 faq_prob.pod
--- faq_prob.pod	14 Sep 2002 16:06:29 -0000	1.1
+++ faq_prob.pod	21 Sep 2002 10:48:40 -0000
@@ -1,14 +1,18 @@
 =head1 NAME

 Frequently Asked Questions about running the I<nms> CGI programs.
-If a question is not specific to
+If a question is not specific to running a script, please see
+the other FAQ sections referenced above.

 E<lt>-- $Date: 2002/09/14 16:06:29 $ --E<gt>

 =head1 DESCRIPTION

 These are hopefully answers to question you will have when installing
-or running our programs.
+or running our programs. If there is something that should be added
+please contact our support list through
+E<lt>http://nms-cgi.sourceforge.net/support.htmlE<gt>
+.


 =head2 How do I report a problem?
@@ -44,7 +48,6 @@
 to ignore what we know we don't need, than to ask for information we
 might.

-this on their own time.


 =head2 There is a conflict between NMS documentation and Matt's.  Which is right?
@@ -278,11 +281,18 @@
 This will stop the error message.


+=head2 I get an "Premature End of Script Headers" error. How do i fix it?
+
+This can be caused by the #! line at the top of the program
+having the wrong path to perl. Our programs expect perl to
+be in /usr/bin on a UNIX system. If your perl is elsewhere,
+or you are running on Windows, you will need to change this.
+
+
 =head2 When I try to run your program, I get an "Internal Server Error". What does that mean?

 This (rather useless) error message generally means that your webserver
-tried to execute the program, but execution failed. This is most
-likely to be caused by the Perl program not being valid Perl.
+tried to execute the program, but execution failed.

 Perl tries to run your program, finds an error, and throws up
 warnings. The webserver interprets these warnings as output from the
@@ -290,25 +300,26 @@
 Error.

 If you have access to your web server's error logs, you can probably
-get more information as to precisely what caused the problem. If not,
-try the next question.
+get more information as to precisely what caused the problem.  The
+next question tells you how to fix it.


 =head2 How do I fix this "Internal Server Error" ?

-Firstly, if the program, as you downloaded it from our website, does
-not work
+Firstly check that the scipt has the right extension for your
+server (.pl or .cgi), and has execute permissions as detailed in the
+INSTALL file. If these are right, then it is most likely to be caused
+by the Perl program not being valid Perl.

 Internal Server Errors, where you have edited the program yourself,
-are most commonly caused by typos during editing. These typos result
-in the program not being valid Perl, and errors confusing the
-webserver.
-
-What you should initially do, is check every line you edited, to check
-that you have not left a set of quotes or brackets (of any variety)
-open. Having an opening ' without a corresponding " is a very common
-problem, and not easy to spot (especially when you have one of each
-and don't notice they are different).
+are commonly caused by typos during editing. These typos result
+in the program not being valid Perl.
+
+You should check every line you edited, to ensure that you have not
+left a set of quotes or brackets (of any variety) open. Having an
+opening ' with a corresponding " is a very common problem, and not
+easy to spot (especially when you have one of each and don't notice
+they are different).

 If you really can not see what the problem is, try redownloading
 the program from our website, and uploading it to your webserver
@@ -316,8 +327,9 @@
 to the program one at a time, testing each time you make a change.
 This makes debugging much easier.

-If everything works, compare the version that works, with your
-original that didn't, and see where the original was broken.
+When everything works, compare the version that works, with your
+original that didn't, and see where the original was broken.  That
+way, you may be able to find the problem faster if it happens again

 If it still doesn't work, then contact our support list, and
 include all the information you possibly can.
@@ -375,7 +387,7 @@

 =head2 I use FormMail but want it to do something more. Will you do it?

-That depends.
+Maybe.

 You probably first want to look at TFmail which is a more advanced
 version of FormMail which includes enhanced features such as