--- loncom/auth/localauth.pm	2006/08/25 21:35:52	1.3
+++ loncom/auth/localauth.pm	2008/11/07 17:52:45	1.6
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy localauthentication mechnism
 #
-# $Id: localauth.pm,v 1.3 2006/08/25 21:35:52 albertel Exp $
+# $Id: localauth.pm,v 1.6 2008/11/07 17:52:45 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,18 +26,34 @@
 #
 # 8/24 Guy Albertelli
 
+=pod
+
+=head1 NAME
+
+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;
 
-# The localauth routine receives
-# - the typed in username
-# - the typed in password
-# - the optional information that was stored when the authentication 
-#   mechanism was specified 
-# It is expected to return a 1 if the user is authenticated and a 0 otherwise
+
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
-    my ($username,$password,$optional_argument) = @_;
+    my ($username,$password,$optional_argument,$domain) = @_;
     return 0;
 }
 # ----END LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE