Perl Guru Forums: Perl Programming Help: Beginner: Where is the documentation and examples?

CGI/Perl Guide | Learning Center | Forums | Advertise | Login

Site Search: in


	MAIN INDEX	SEARCH POSTS	WHO'S ONLINE	LOG IN

Home: Perl Programming Help: Beginner:
Where is the documentation and examples?

PapaGeek
User

Feb 9, 2014, 6:55 PM

Post #1 of 3 (1777 views)

Where is the documentation and examples?	Can't Post

I’m relatively new at this Perl thing, but I do like it. I’m used to the (pardon the dirty word) Microsoft documentation. I managed to load Win32::GUI and have started building the user interface for my first major Perl project. I’m looking for the documentation, tutorials, and examples that came with the Win32::GUI package install.

When I loaded the Win32::GUI package it created a large directory tree starting at the root
C:\Perl-5.16\cpan\build\Win32-GUI-1.06_patched3-Xs_DPg

Inside the tree at various locations there are directories called docs, tutorials, user guide, demos, examples, etc. The problem is that when I look in most of these directories I see a lot of .tpl and .pod files, and the .txt files are in UNIX format so they can’t be viewed with windows notepad.

So, again I ask; what is the proper way to view the documentation that comes with a Perl package?

Laurent_R
Veteran / Moderator

Feb 10, 2014, 10:15 AM

Post #2 of 3 (1737 views)

Re: [PapaGeek] Where is the documentation and examples? [In reply to]	Can't Post

In Reply To

The problem is that when I look in most of these directories I see a lot of .tpl and .pod files, and the .txt files are in UNIX format so they can’t be viewed with windows notepad.

So, again I ask; what is the proper way to view the documentation that comes with a Perl package?

Just get a real editor that can read Unix format text files (Notepad++, Ultraedit, Crimson, etc.).

Otherwise visit the Perldoc web site.

FishMonger
Veteran / Moderator

Feb 10, 2014, 12:12 PM

Post #3 of 3 (1731 views)

Re: [PapaGeek] Where is the documentation and examples? [In reply to]	Can't Post

You're looking in the wrong place. You need to look in the dirs where the perl modules are installed, not the temporary build dirs.

Assuming perl was installed under C:\perl, then the modules should be under C:\perl\lib and C:\perl\site\lib.

To read the POD documentation for any given module you can use the perldoc utility.

e.g.,
C:\>perldoc Win32

Code

NAME 
    Win32 - Interfaces to some Win32 API Functions 
 
DESCRIPTION 
    The Win32 module contains functions to access Win32 APIs. 
 
  Alphabetical Listing of Win32 Functions 
    It is recommended to "use Win32;" before any of these functions; 
    however, for backwards compatibility, those marked as [CORE] will 
    automatically do this for you. 
 
    In the function descriptions below the term *Unicode string* is used to 
    indicate that the string may contain characters outside the system 
    codepage. The caveat *If supported by the core Perl version* generally 
    means Perl 5.8.9 and later, though some Unicode pathname functionality 
    may work on earlier versions. 
 
... 
...

The main POD page for Win32::GUI found at this url http://search.cpan.org/~robertmay/Win32-GUI-1.06/docs/GUI.pod includes this bit of onfo:

Code

Sample Code 
 
There is a set of sample applications installed with Win32::GUI, that should be found in the .../Win32/GUI/demos/ directory under your library installtion root (by default for ActiveState perl this is at C:/Perl/site/lib/Win32/GUI/demos). There is a viewer/launcher application installed as well. Type win32-gui-demos at a command prompt.

Search for (options)

Web Applications & Managed Hosting Powered by Gossamer Threads
Visit our Mailing List Archives