.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SSI_Parser 3pm" .TH SSI_Parser 3pm "2022-01-08" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" CGI::SSI_Parser \- Implement SSI for Perl CGI .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use CGI::SSI_Parser; \& \& $CGI::SSI_Parser::recursive = 1; \& \& fssi($filename); \& sssi($string); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" CGI::SSI_Parser is used in \s-1CGI\s0 scripts for parsing \s-1SSI\s0 directives in files or string variables, and fully implements the functionality of apache's mod_include module. .PP It is an alternative to famous Apache::SSI modules, but it doesn't require mod_perl. This is an advantage to those who are using public hosting services. There is a disadvantage, however \- the module consumes much memory, and I don't recommend using it on heavy-loaded sites (currently it's being used on a site with 10000 hits, and I consider this as a limit). I hope to get rid of this disadvantage by the time the release comes out (currently it's beta). .SS "\s-1SSI\s0 Directives" .IX Subsection "SSI Directives" This module supports the same directives as mod_include. For methods listed below but not documented, please see mod_include's online documentation at http://httpd.apache.org/docs/mod/mod_include.html . .IP "\(bu" 4 config .IP "\(bu" 4 echo .Sp This directive is not fully supported in current version. .IP "\(bu" 4 exec .IP "\(bu" 4 fsize .IP "\(bu" 4 flastmod .IP "\(bu" 4 include .IP "\(bu" 4 printenv .IP "\(bu" 4 set .Sp This directive is not supported in current version. .IP "\(bu" 4 perl .Sp This directive is not supported in current version. .IP "\(bu" 4 if .IP "\(bu" 4 elif .IP "\(bu" 4 else .IP "\(bu" 4 endif .Sp These four directives are not supported in current version. .SS "Outline Usage" .IX Subsection "Outline Usage" First you need to load the CGI::SSI_Parser module: .PP .Vb 1 \& use CGI::SSI_Parser; .Ve .PP You need to specify the following when processing of all nested directives is needed (default value \- 0): .PP .Vb 1 \& $CGI::SSI_Parser::recursive = 1; .Ve .PP To parse file or string you need to use: .PP .Vb 2 \& fssi($filename); \& sssi($string); .Ve .PP The result is printed to \s-1STDOUT.\s0 .SH "TO DO" .IX Header "TO DO" Full implementation of all \s-1SSI\s0 directives. .PP Optimize memory consumption. .SH "AUTHOR" .IX Header "AUTHOR" Vadim Y. Ponomarenko, vp@istc.kiev.ua .SH "SEE ALSO" .IX Header "SEE ALSO" mod_include, \fBperl\fR\|(1).