Pod::Usage::CGI - generate usage message for CGI scripts
use CGI; use Pod::Usage::CGI; #Message is HTML-escaped my $necessary = CGI::param(foo) || pod2usage(message => "you forgot >>foo<<"); #Raw message is not escaped my $another = CGI::param(bar) || pod2usage(raw_message => "you forgot <b>bar</b>");
Provides pod2usage exit from CGI scripts. You may optionally supply a message. By default the message text is escaped to prevent cross-site scripting injection attacks and placed in a div container of class "message" that you can optionally format with a CSS. You can use the raw_message directive if you want to write HTML out into the page and manage your own escaping.
raw_message
The module works fine under Apache::Registry but will not work in any environments where $0 is not defined.
Displays usage and exits. Valid options are:
message - message (will be automatically escaped) raw_message - message (not escaped) css - one or more CSS URLs to be applied to the page (either a scalar or an arrayref)
Pod::XHtml and either Apache or CGI are loaded on demand if required
Generates usage messages for command line scripts
$Revision: 1.10 $ on $Date: 2005/07/15 11:25:22 $ by $Author: simonf $
John Alden <cpan _at_ bbc _dot_ co _dot_ uk>
(c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt
To install Pod::Usage::CGI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Usage::CGI
CPAN shell
perl -MCPAN -e shell install Pod::Usage::CGI
For more information on module installation, please visit the detailed CPAN module installation guide.