[LON-CAPA-cvs] cvs: loncom /lonnet/perl lonnet.pm

[jms]

jms		Tue Nov 25 18:20:11 2008 EDT

  Modified files:              
    /loncom/lonnet/perl	lonnet.pm 
  Log:
  Some minor POD tweaks
  
Index: loncom/lonnet/perl/lonnet.pm
diff -u loncom/lonnet/perl/lonnet.pm:1.971 loncom/lonnet/perl/lonnet.pm:1.972
--- loncom/lonnet/perl/lonnet.pm:1.971	Wed Nov 12 20:01:15 2008
+++ loncom/lonnet/perl/lonnet.pm	Tue Nov 25 18:20:11 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # TCP networking package
 #
-# $Id: lonnet.pm,v 1.971 2008/11/12 20:01:15 jms Exp $
+# $Id: lonnet.pm,v 1.972 2008/11/25 18:20:11 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -29,6 +29,25 @@
 
 =pod
 
+=head1 NAME
+
+Apache::lonnet.pm
+
+=head1 SYNOPSIS
+
+This file is an interface to the lonc processes of
+the LON-CAPA network as well as set of elaborated functions for handling information
+necessary for navigating through a given cluster of LON-CAPA machines within a
+domain. There are over 40 specialized functions in this module which handle the
+reading and transmission of metadata, user information (ids, names, environments, roles,
+logs), file information (storage, reading, directories, extensions, replication, embedded
+styles and descriptors), educational resources (course descriptions, section names and
+numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
+and from more descriptive phrases or explanations.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
 =head1 Package Variables
 
 These are largely undocumented, so if you decipher one please note it here.