--- loncom/auth/localauth.pm	2001/11/29 19:12:44	1.2
+++ loncom/auth/localauth.pm	2008/11/18 19:14:34	1.7
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy localauthentication mechnism
 #
-# $Id: localauth.pm,v 1.2 2001/11/29 19:12:44 www Exp $
+# $Id: localauth.pm,v 1.7 2008/11/18 19:14:34 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,12 +26,35 @@
 #
 # 8/24 Guy Albertelli
 
+=pod
+
+=head1 NAME
+
+Apache::localauth
+
+=head1 SYNOPSIS
+
+The localauth routine receives
+ - the typed in username
+ - the typed in password
+ - the optional information that was stored when the authentication mechanism was specified 
+
+=head1 OVERVIEW
+
+It is expected to return a 1 if the user is authenticated and a 0 otherwise
+it can optionally return a negative value for an error condition. This
+negative value will get logged along with the user that caused it.
+
+=cut
+
 
 package localauth;
 
+
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
-   return 0;
+    my ($username,$password,$optional_argument,$domain) = @_;
+    return 0;
 }
 # ----END LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE