--- loncom/auth/localauth.pm	2007/01/08 16:24:26	1.4
+++ loncom/auth/localauth.pm	2007/01/19 02:57:33	1.5
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy localauthentication mechnism
 #
-# $Id: localauth.pm,v 1.4 2007/01/08 16:24:26 albertel Exp $
+# $Id: localauth.pm,v 1.5 2007/01/19 02:57:33 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -34,7 +34,10 @@ package localauth;
 # - the typed in password
 # - the optional information that was stored when the authentication 
 #   mechanism was specified 
+# - the domain that was typed in
 # 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
 # ----START LOCAL CHANGES HERE ----- DON'T DELETE THIS LINE
 sub localauth {
     my ($username,$password,$optional_argument,$domain) = @_;