1Text::CHM(3)          User Contributed Perl Documentation         Text::CHM(3)
2
3
4

NAME

6       Text::CHM - Perl extension for handling MS Compiled HtmlHelp Files
7

SYNOPSIS

9         use Text::CHM;
10         $chm = Text::CHM->new('foobar.chm');
11         print $chm->filename(), "\n";  # It will print "foobar.chm"
12         @content = $chm->get_filelist();
13
14       # I hope you don't really do this!
15         foreach $file ( @content )
16           {
17             pring $chm->get_object($file->{path});
18           }
19
20         $chm->close();
21

DESCRIPTION

23       Text::CHM is a module that implements a (partial) support for handling
24       MS Compiled HtmlHelp Files (chm files for short) via CHMLib. CHMLib is
25       a small library designed for accessing MS ITSS files.  The ITSS file
26       format is used for chm files, which have been the predominant medium
27       for software documentation from Microsoft.
28
29       Chm is a filesystem based file format, such as MS Excel or MS Word file
30       formats, but they aren't the same.
31
32       Text::CHM allows you to open chm files, get their filelist, get the
33       content of each file and close them; at the moment, no write support is
34       available.
35

METHODS

37   "new(filename)"
38       Opens the chm file filename and returns the chm object.
39
40   "filename()"
41       Returns the name of the current working chm file.
42
43   "get_filelist()"
44       Returns a list of hash references with the following fields:
45
46       path: the path of the file in the chm object;
47       size: the size of the file;
48       title: the title of the file, if it is an html one, else undef.
49
50   "get_object(path)"
51       Returns the content of the object found at path in the chm file.
52
53   "close()"
54       Close the chm file opened with "new()".
55

SEE ALSO

57       General understanding of perl is required, see "perldoc perl" for more
58       informations.
59
60       CHMLib website is available (at the moment) at the address
61       http://66.93.236.84/~jedwin/projects/chmlib/.
62
63       For a detailed (unofficial) description of the CHM file format see
64       Pabs' unofficial chm specifications or Matthew T. Russotto's CHM site,
65       respectively at http://savannah.nongnu.org/projects/chmspec and
66       http://www.speakeasy.org/~russotto/chm/.
67
68       Text::CHM's website is http://digilander.libero.it/bash/text-chm/.
69

AUTHOR

71       Domenico Delle Side, <dds@gnulinux.it>
72

74       Copyright (C) 2005 by Domenico Delle Side
75
76       This library is free software; you can redistribute it and/or modify it
77       under the same terms as Perl itself, either Perl version 5.8.4 or, at
78       your option, any later version of Perl 5 you may have available.
79
80
81
82perl v5.28.0                      2005-03-07                      Text::CHM(3)
Impressum