chiark
/
gitweb
/
~ian
/
cgi-auth-flexible.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
435c66d
)
docs: wip
author
Ian Jackson
<ijackson@chiark.greenend.org.uk>
Sat, 23 Feb 2013 17:42:25 +0000
(17:42 +0000)
committer
Ian Jackson
<ijackson@chiark.greenend.org.uk>
Sat, 23 Feb 2013 17:42:25 +0000
(17:42 +0000)
cgi-auth-flexible.pm
patch
|
blob
|
history
diff --git
a/cgi-auth-flexible.pm
b/cgi-auth-flexible.pm
index bb359c152ef332858e688f653783e760ca4c4ee4..52920758163f4b019abf4f6eafe0d4d76f9415d6 100644
(file)
--- a/
cgi-auth-flexible.pm
+++ b/
cgi-auth-flexible.pm
@@
-1320,34
+1320,26
@@
__END__
CGI::Auth::Flexible - web authentication optionally using cookies
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 $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;
$authreq->check_ok() or return;
-
- blah blah blah
+ ...
$authreq->check_mutate();
$authreq->check_mutate();
- blah blah blah
+ ...
-=head1
USAGE PATTERN FOR FANCY
APPLICATIONS
+=head1
SYNOPSIS - SOPHISTICATED
APPLICATIONS
my $divert_kind = $authreq->check_divert();
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();
$authreq->check_mutate();
- blah blah blah
+ ...
+
+=head1 DESCRIPTION
+
+CGI::Auth::Flexible is a