.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CGI::Application::Plugin::ViewCode 3pm"
.TH CGI::Application::Plugin::ViewCode 3pm "2015-06-13" "perl v5.20.2" "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::Application::Plugin::ViewCode \- View the source of the running application
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your CGI::Application based class
.PP
.Vb 1
\&    use CGI::Application::Plugin::ViewCode;
.Ve
.PP
Then you can view your module's source (or pod) as it's running by changing the url
.PP
.Vb 4
\&    ?rm=view_code
\&    ?rm=view_code#215
\&    ?rm=view_code&pod=0&line_no=0
\&    ?rm=view_code&module=CGI\-Application
\&
\&    ?rm=view_pod
\&    ?rm=view_pod&module=CGI\-Application
.Ve
.SH "INTERFACE"
.IX Header "INTERFACE"
This plugin works by adding extra run modes (named \f(CW\*(C`view_code\*(C'\fR and \f(CW\*(C` view_pod \*(C'\fR) to the
application. By calling this run mode you can see the source or \s-1POD\s0 of the running module
(by default) or you can specify which module you would like to view (see \s-1SECURITY\s0).
.SS "view_code"
.IX Subsection "view_code"
This extra run mode will accept the following arguments in the query string:
.IP "module" 4
.IX Item "module"
The name of the module to view. By default it is the module currently being run. Also,
since colons (':') aren't simply typed into \s-1URL\s0's, you can just substitute '\-' for '::'.
.Sp
.Vb 1
\&    ?rm=view_code?module=My\-Base\-Class
.Ve
.IP "highlight" 4
.IX Item "highlight"
Boolean indicates whether syntax highlighting (using Syntax::Highlight::Perl::Improved) 
is \f(CW\*(C`on\*(C'\fR or \f(CW\*(C`off\*(C'\fR. By default it is \f(CW\*(C`on\*(C'\fR.
.IP "line_no" 4
.IX Item "line_no"
Boolean indicates whether the viewing of line numbers is \f(CW\*(C`on\*(C'\fR or \f(CW\*(C`off\*(C'\fR. By default it is \f(CW\*(C`on\*(C'\fR.
It \f(CW\*(C`line_no\*(C'\fR is on, you can also specify which line number you want to see by adding an anchor
to the link:
.Sp
.Vb 1
\&    ?rm=view_code#215
.Ve
.Sp
This will take you immediately to line 215 of the current application module.
.IP "pod" 4
.IX Item "pod"
Boolean indicates whether \s-1POD\s0 is seen or not. By default it is seen>.
.SS "view_pod"
.IX Subsection "view_pod"
This extra run mode will accept the following arguments in the query string:
.IP "module" 4
.IX Item "module"
The name of the module to view. By default it is the module currently being run. Also,
since colons (':') aren't simply typed into \s-1URL\s0's, you can just substitute '\-' for '::'.
.Sp
.Vb 1
\&    ?rm=view_pod?module=My\-Base\-Class
.Ve
.SH "AS A POPUP WINDOW"
.IX Header "AS A POPUP WINDOW"
This plugin can be used in conjunction with CGI::Application::Plugin::DevPopup. If we detect
that CGI::Application::Plugin::DevPopup is running and turned on, we will create a sub-report
that includes the highlighted source code.
.PP
So you can simply do the following:
.PP
.Vb 3
\&    BEGIN { $ENV{CAP_DEVPOPUP_EXEC} = 1; } # turn it on for real
\&    use CGI::Application::Plugin::DevPopup;
\&    use CGI::Application::Plugin::ViewCode;
.Ve
.PP
Befault, this report will be the same thing produced by \f(CW\*(C`view_code\*(C'\fR. If you want this
report to include the \f(CW\*(C`view_pod\*(C'\fR report, simply set the the \f(CW$ENV{CAP_VIEWCODE_POPUP_POD}\fR
to true. You can also turn off the \f(CW\*(C`view_code\*(C'\fR report but setting 
\&\f(CW$ENV{CAP_VIEWCODE_POPUP_CODE}\fR to false.
.PP
.Vb 8
\&    # have the POD report, but not the code in the dev popup window
\&    BEGIN { 
\&        $ENV{CAP_DEVPOPUP_EXEC} = 1;       # turn it on for real
\&        $ENV{CAP_VIEWCODE_POPUP_POD} = 1;  # turn on POD report
\&        $ENV{CAP_VIEWCODE_POPUP_CODE} = 0; # turn off code report
\&    }
\&    use CGI::Application::Plugin::DevPopup;
\&    use CGI::Application::Plugin::ViewCode;
.Ve
.SH "SECURITY"
.IX Header "SECURITY"
This plugin is designed to be used for development only. Please do not use it in a
production system as it will allow anyone to see the source code for any loaded module.
Consider yourself warned.
.SH "AUTHOR"
.IX Header "AUTHOR"
Michael Peters, \f(CW\*(C`<mpeters@plusthree.com>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-cgi\-application\-plugin\-viewsource@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI\-Application\-Plugin\-ViewCode>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2005 Michael Peters, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.