Specifies the language code we're interested in. This is required, but can be extracted from the name of a subclass. Read below.

"inc"

This is used to override the list of Perl library directories where POD documents are searched (namely, @INC). Most of the time, you don't want to mess with that. It's handy for debugging and testing.

It must be an array ref.

If POD2::ANY is a subclass of POD2::Base, the inherited constructor will work without arguments pulling 'ANY' from the package name and using it as the intented language code.

Note that use of "inc" in the constructor freezes the list of library dirs searched by the POD2::Base instance. If this is not used, the up-to-date @INC is used at each call of pod_dirs (so that dynamic changes in the Perl library path are taken into account). That's what we meant with the "Most of the time, you don't want to mess with that" mentioned above.

The POD2::Base default behavior is to find POD2/<lang>/ directories under the current Perl library directories (@INC) or the list given as argument "inc" in the constructor.

The supported options are:

"test"

By default, the return of pod_dirs do not include POD directories which do not exist (tested with -d). If an explicit false value for this option (like test => 0) is given, such test is not done and pod_dirs includes all possible candidates POD2/<lang>/ under the library directories. (Handy for debugging this module. Not much practical use for anything else.)

To implement perldoc -f <function> the current code of Pod::Perldoc uses a hard coded string "Alphabetical Listing of Perl Functions" or the return of this method (in a regexp) to skip the introduction and reach the listing of core functions. Thus a translation package with a corresponding translated perlfunc.pod should define this method to make perldoc -L <lang> -f <function> work properly.

There are other methods documented below. However, they will probably be superseded in future versions when more general methods to find and display metadata on translated PODs are designed and implemented.