[Koha-cvs] CVS: koha/misc Install.pm,1.22,1.23

[Ambrose Li]

Update of /cvsroot/koha/koha/misc
In directory sc8-pr-cvs1:/tmp/cvs-serv21755/misc

Modified Files:
	Install.pm 
Log Message:
Added POD to all functions
POD updates
Changed the kohaadmin password prompt to make it clearer


Index: Install.pm
===================================================================
RCS file: /cvsroot/koha/koha/misc/Install.pm,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -r1.22 -r1.23
*** Install.pm	25 Jan 2003 17:50:48 -0000	1.22
--- Install.pm	25 Jan 2003 18:09:51 -0000	1.23
***************
*** 798,802 ****
  This password will also be used to access Koha's INTRANET interface.
  
! Database Password: |;
  
  $messages->{'BlankPassword'}->{en} = heading('BLANK PASSWORD') . qq|
--- 798,802 ----
  This password will also be used to access Koha's INTRANET interface.
  
! Password for database user %s: |;
  
  $messages->{'BlankPassword'}->{en} = heading('BLANK PASSWORD') . qq|
***************
*** 831,835 ****
  
      while ($pass eq '') {
! 	my $message=getmessage('DatabasePassword', [$user]);
  	$pass=showmessage($message, 'free', $pass);
  	if ($pass eq '') {
--- 831,835 ----
  
      while ($pass eq '') {
! 	my $message=getmessage('DatabasePassword', [$user, $user]);
  	$pass=showmessage($message, 'free', $pass);
  	if ($pass eq '') {
***************
*** 1037,1040 ****
--- 1037,1064 ----
  }
  
+ 
+ =item updateapacheconf
+ 
+     updateapacheconf;
+ 
+ Updates the Apache config file according to parameters previously
+ specified by the user.
+ 
+ It will append fully-commented directives at the end of the original
+ Apache config file.  The old config file is renamed with an extension
+ of .prekoha.
+ 
+ If you need to uninstall Koha for any reason, the lines between
+ 
+     # Ports to listen to for Koha
+ 
+ and the block of comments beginning with
+ 
+     # If you want to use name based Virtual Hosting:
+ 
+ must be removed.
+ 
+ =cut
+ 
  $messages->{'StartUpdateApache'}->{en} =
     heading('UPDATING APACHE CONFIGURATION') . qq|
***************
*** 1187,1190 ****
--- 1211,1227 ----
  }
  
+ 
+ =item basicauthentication
+ 
+     basicauthentication;
+ 
+ Asks the user whether HTTP basic authentication is wanted, and,
+ if so, the user name and password for the basic authentication.
+ 
+ These pieces of information are saved to global variables; the
+ function does not return any values.
+ 
+ =cut
+ 
  $messages->{'IntranetAuthenticationQuestion'}->{en} =
     heading('INTRANET AUTHENTICATION') . qq|
***************
*** 1237,1240 ****
--- 1274,1291 ----
  }
  
+ 
+ =item installfiles
+ 
+     installfiles
+ 
+ Install the Koha files to the specified OPAC and INTRANET
+ directories (usually in /usr/local/koha).
+ 
+ The koha.conf file is created, but as koha.conf.tmp. The
+ caller is responsible for calling finalizeconfigfile when
+ installation is completed, to rename it back to koha.conf.
+ 
+ =cut
+ 
  $messages->{'InstallFiles'}->{en} = heading('INSTALLING FILES') . qq|
  Copying files to installation directories:
***************
*** 1300,1303 ****
--- 1351,1364 ----
  }
  
+ 
+ =item databasesetup
+ 
+     databasesetup;
+ 
+ Finds out where the MySQL utitlities are located in the system,
+ then create the Koha database structure and MySQL permissions.
+ 
+ =cut
+ 
  $messages->{'MysqlRootPassword'}->{en} =
     heading('MYSQL ROOT USER PASSWORD') . qq|
***************
*** 1417,1421 ****
  	showmessage(getmessage('CreatingDatabaseError'),'PressEnter', '', 1);
      } else {
! 	# Populate the Koha database
  	system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname < koha.mysql");
  	# Set up permissions
--- 1478,1482 ----
  	showmessage(getmessage('CreatingDatabaseError'),'PressEnter', '', 1);
      } else {
! 	# Create the database structure
  	system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname < koha.mysql");
  	# Set up permissions
***************
*** 1432,1435 ****
--- 1493,1508 ----
  }
  
+ 
+ =item updatedatabase
+ 
+     updatedatabase;
+ 
+ Updates the Koha database structure, including the addition of
+ MARC tables.
+ 
+ The MARC tables are also populated in addition to being created.
+ 
+ =cut
+ 
  $messages->{'UpdateMarcTables'}->{en} =
     heading('UPDATING MARC FIELD DEFINITION TABLES') . qq|
***************
*** 1485,1488 ****
--- 1558,1571 ----
  }
  
+ 
+ =item populatedatabase
+ 
+     populatedatabase;
+ 
+ Populate the non-MARC tables. If the user wants to install the
+ sample data, install them.
+ 
+ =cut
+ 
  sub populatedatabase {
  	my $response=showmessage(getmessage('SampleData'), 'yn', 'n');
***************
*** 1530,1533 ****
--- 1613,1630 ----
  	}
  }
+ 
+ 
+ =item restartapache
+ 
+     restartapache;
+ 
+ Asks the user whether to restart Apache, and restart it if the user
+ wants so.
+ 
+ FIXME: If the installer does not know how to restart the Apache
+ server (e.g., if the user is not actually using Apache), it still
+ asks the question.
+ 
+ =cut
  
  $messages->{'RestartApache'}->{en} = heading('RESTART APACHE') . qq|