From a6df4e619ad4fbf22ddac20eab711dfa0e59c61c Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sat, 23 Feb 2013 17:42:25 +0000 Subject: [PATCH] docs: wip --- cgi-auth-flexible.pm | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/cgi-auth-flexible.pm b/cgi-auth-flexible.pm index bb359c1..5292075 100644 --- a/cgi-auth-flexible.pm +++ b/cgi-auth-flexible.pm @@ -1320,34 +1320,26 @@ __END__ CGI::Auth::Flexible - web authentication optionally using cookies -=head1 SYNOPSYS +=head1 SYNOPSYS - STARTUP my $verifier = CGI::Auth::Flexible->new_verifier(setting => value,...); my $authreq = $verifier->new_request($cgi_request_object); - my $authreq = CGI::Auth::Flexible->new_request($cgi_request_object, - setting => value,...); - -=head1 USAGE PATTERN FOR SIMPLE APPLICATIONS +=head1 SYNOPSYS - SIMPLE APPLICATIONS $authreq->check_ok() or return; - - blah blah blah + ... $authreq->check_mutate(); - blah blah blah + ... -=head1 USAGE PATTERN FOR FANCY APPLICATIONS +=head1 SYNOPSIS - SOPHISTICATED APPLICATIONS my $divert_kind = $authreq->check_divert(); - if ($divert_kind) { - if ($divert_kind eq 'LOGGEDOUT') { - print "goodbye you are now logged out" and quit - } elsif ($divert_kind eq 'NOCOOKIES') { - print "you need cookies" and quit - ... etc. - } - } - - blah blah blah + if ($divert_kind) { ... print diversion page and quit ... } + ... $authreq->check_mutate(); - blah blah blah + ... + +=head1 DESCRIPTION + +CGI::Auth::Flexible is a -- 2.30.2