ActivePerl FAQ - Documentation and Support

# Documentation and Support

- NAME
- DESCRIPTION
  - Where can I get documentation on ActivePerl?
  - What kind of documentation comes with ActivePerl?
  - Is there formal support for ActivePerl or PerlIS?
  - Is there a mailing list for ActivePerl or Perl for ISAPI?
  - Is there a Usenet newsgroup devoted to ActivePerl?
  - How do I report a bug in ActivePerl?
  - Can I ask a question? ... or ... How do I ask a question?
  - Are there any live chats where I can talk about Perl stuff?
- AUTHOR AND COPYRIGHT

## NAME

Documentation and Support

## DESCRIPTION

ActivePerl Documentation and Support

## Where can I get documentation on ActivePerl?

Documentation for ActivePerl is provided in HTML format in the html directory in your perl directory. This has the documentation from the standard perl distribution, as well as the complete documentation for modules and extensions. For more information on Win32-specific extensions, see What modules come with the ActivePerl distribution?.

Note that the standard perl distribution documentation (perl*.html) has some UNIX-specific information, and lists some features/functions that will not work on the Windows version of ActivePerl. The perlwin32 and perlport pages discuss the portability issues under the Win32 platform.

You can also read the Perl documentation with the perldoc command. At the command prompt, type perldoc followed by the name of the document you want to read, as in:

        perldoc perlwin32
        perldoc perlfaq

Documentation is provided in the binary distributions (it is created during install), and can be created by install or it can be made by "make installhtml" in the source distribution.

## What kind of documentation comes with ActivePerl?

ActivePerl comes with the standard Perl documentation, as well as documentation for all Core modules.

## Is there formal support for ActivePerl or PerlIS?

Peer support is available from the Perl-related mailing lists that ActiveState hosts. You can find more information on these mailing lists at http://www.ActiveState.com/support/

Support for applications and internals is available through customized professional services. Contact us at http://www.ActiveState.com/Professional_Services for a quotation.

ActivePerl Enterprise Edition offers corporate support solutions for Perl. ActivePerl Enterprise Edition provides the comprehensive support that an enterprise needs to deploy Perl.

## Is there a mailing list for ActivePerl or Perl for ISAPI?

ActiveState hosts a variety of mailing lists for the ActivePerl community. More information can be found at http://www.ActiveState.com/support/mailing_lists.htm

Archives of the mailing lists can also be found on the ActiveState web site.

You should check the archives or a FAQ like this (see Is there a FAQ for ActivePerl?) before posting a question to the mailing list. List members are mostly overworked programmers and admins like yourself. So, for best results, be courteous, specific, and show that you really have tried to figure out your problems for yourself.

## Is there a Usenet newsgroup devoted to ActivePerl issues?

Not yet. You can use comp.lang.perl.misc for miscellaneous Perl questions; the members of most Usenet Perl newsgroups tend to concentrate on UNIX platforms.

Try the perl-win32-users mailing list (see Is there a mailing list for ActivePerl or PerlIS?) for more specific Win32 information.

For web server setup and CGI programming, try one of the following three newsgroups:

        comp.infosystems.www.servers.ms-windows
        comp.infosystems.www.authoring.cgi
        comp.infosystems.www.authoring.misc

## How do I report a bug in ActivePerl?

The ActiveState bug reporting system can be found at http://bugs.activestate.com

Before you report a bug to this location, you need to do several things:

- Make sure it's a real bug, and not a logic error in your program.

- Make sure it's a real bug, and not just a misunderstanding about how Perl works. Check the mailing list archives and FAQs, so you can see if someone else has come across this problem. ALWAYS do this first, even if you are otherwise certain that it is a real bug. Most bugs reported to ActiveState are not bugs and could be solved by looking through the list archives or FAQs.

- You can also use http://groups.google.com/ to search comp.lang.perl.misc. If this is a problem that has been discussed in the newsgroup, your answer may be there. After exhausting these possibilities, you may want to post to one of the mailing lists to see if other people might have an answer. See also Can I ask a question? ... or ... How do I ask a question?

- You should check the bug list to see if your bug has already been reported or fixed.

- You need to be able to reproduce the bug. If it just happens once, then it is not a bug. This needs to be clear: if it can't be repeated then it is not a bug.

- Create a short, simple script as an example of the bug. Do not send the original source code as your example - do what you can to reduce the example to the smallest possible case. This process has been known to reveal errors that have been cleverly masquerading as bugs.

- It should not be necessary to do much setup for ActiveState bug testers to reproduce your bug. If setup or example data files are required, prepare simple instructions.

- Once all this is done, you should send your bug report to ActiveState, stating clearly the nature of the bug, how to reproduce it, and what platform, operating system, and perl version is causing the problem. Remember that your goal is to give ActiveState enough information to reproduce the bug. If it is not reproducible, it can't be considered a bug.

- You should get email about the status of your bug as it goes through the process of verification and fixing.

- Do not submit the same bug more than once.

  Submit bugs here.

## Can I ask a question? ... or ... How do I ask a question?

The etiquette for asking questions is about the same whether you're working with mailing lists, newsgroups, chatrooms, or IRC channels. Here are some pointers that will help you get your questions answered.

- Do your own study before you ask a question. Buy a book (or more than one... O'Reilly has lots to choose from), read the online help, and search the web for yourself. If you don't have time to try to find find the answer yourself, these folks won't have time to answer you.

- Check the FAQ first - if the question has already been answered in the FAQ, you may not get an answer to it if you ask it in a public forum.

- Never ask, "Can I ask a question?", because that is a sure sign that the person doing the asking is a newbie. People on IRC and newsgroups get bored with newbies because they always seem to ask and never seem to do their own study.

- Read the mailing list or newsgroup for a while before you ask a question. If you need to ask a question immediately, and you've never read the newsgroup or mailing list, read the mailing list archives or use http://groups.google.com/ to read old messages posted to the newsgroup. This will familiarize you with the way people ask questions in the particular newsgroup or mailing list you want to post to. If your question has come up before, there is a good chance it has been answered before - the newsgroup or mailing list archives will turn up these answers if you search them carefully.

- Ask your question directly. Plan your question beforehand, then just come right out and ask it. It might seem rude just to blurt out a question like that, but it's the way it's done.

## Are there any live chats where I can talk about Perl stuff?

For UNIX or more general perl programming discussion, you can try out `#perl` on EFNet (the big one) and UnderNet. Be careful of EFNet `#perl` though. There are a number of discussion topics that are not tolerated there: Win32-specific Perl issues, non-programmer questions (e.g., I just downloaded this neat script - how do I make it work?), and CGI/WWW programming. EFNet `#perl` is a good place to meet some Perl masters, however, like Tom Christiansen (tchrist) and Randall Schwartz (q[merlyn]). I've never seen Larry on there but I'm told he does come on from time to time.

In any of these IRC channels, you need to do your own work, and try to solve your own problems. Don't go in expecting someone to look over some neat script you downloaded and want to get working if you "just want it to work and don't have time to learn perl". That kind of attitude is an easy way to get banned from the channel. The members of these channels are overworked Perl programmers with little tolerance for people who want others to do their work for them.

After you ask a question, you should stick around and chat for a while. It's polite, and a very good way to learn "perl style", or how perl programmers think about everyday things.

## AUTHOR AND COPYRIGHT

This FAQ was originally assembled and maintained by Evangelo Prodromou. It has been revised and updated by Brian Jepson of O'Reilly & Associates, David Grove, David Dmytryshyn and David Sparks of ActiveState.

This FAQ is in the public domain. If you use it, however, please ensure that you give credit to the original authors.

ActivePerl FAQ - Documentation and Support