[Swift-commit] r3427 - usertools/swift/swiftconfig/bin

[noreply at svn.ci.uchicago.edu]

Author: davidk
Date: 2010-07-06 03:22:26 -0500 (Tue, 06 Jul 2010)
New Revision: 3427

Modified:
   usertools/swift/swiftconfig/bin/swiftconfig
Log:
perldoc

Modified: usertools/swift/swiftconfig/bin/swiftconfig
===================================================================
--- usertools/swift/swiftconfig/bin/swiftconfig	2010-07-05 08:31:54 UTC (rev 3426)
+++ usertools/swift/swiftconfig/bin/swiftconfig	2010-07-06 08:22:26 UTC (rev 3427)
@@ -52,7 +52,6 @@
     'platform=s'     => \$platform,
     'profile=s'      => \$profile,
     'tcfile=s'       => \$tcfile,
-    'overwrite'      => \$overwrite,
     'templatefile=s' => \$templatefile,
     'add=s'          => \$add,
     'sitesfile=s'    => \$sitesfile,
@@ -68,7 +67,6 @@
     'remove=s'       => \$remove,
     'templates'      => \$templates,
     'modify=s'       => \$modify,
-    'profile=s'      => \$profile,
     'key=s'          => \$key,
     'namespace=s'    => \$namespace,
     'value=s'        => \$value
@@ -253,3 +251,79 @@
     write_file( $tcfile, @tcdata );
 }
 
+__END__
+=head1 NAME
+
+swiftconfig - Utility for managing Swift configuration
+
+=head1 SYNOPSIS
+
+swiftconfig [B<-option> value]
+
+=head1 OVERVIEW
+
+The swiftconfig program allows users to configure Swift. It allows for the adding, removing, and modification of remote sites by utilizing a set of standard templates. It also provides a way to quickly add, remove and modify translation catalog entries without having to manually edit files.
+
+=head1 DESCRIPTION
+
+General operations:
+   -add sitename		add a site from template
+   -remove site		removes a site from sites.xml
+   -remove command		removes a command from the catalog
+   -templates			display all available sites in template
+   -modify site		Specifies the name of a site to modify
+
+Translation catalog settings:
+   -host hostname		hostname of the translation catalog entry
+   -name name			translation name
+   -path path			full pathname to location of program
+   -status status		installation status (deprecated)
+   -profile setting		define the profile value for an entry
+   -tcfile filename		explicitly specify a translation file
+
+Sites settings:
+   -templatefile file	explicitly set the template file to use
+   -sitesfile file		explicitly set the sites file to use
+   -gridftp GridFTPURL	GridFTP URL
+   -jobuniverse universe	job manager universe
+   -joburl URL			job manager URL
+   -jobmajor major		job mager number
+   -jobminor minor		job minor number
+   -directory dir		work directory
+   -exprovider name		execution provider
+   -exmanager name		execution job manager
+   -exurl URL			execution URL
+   -key key			profile key
+   -value value		profile value
+   -namespace name		profile namespace
+
+
+=head1 EXAMPLES
+
+List all templates available for adding
+   swiftconfig -templates
+
+Add a site from template into working sites.xml
+   swiftconfig -add teraport
+
+Modify the work directory of a site
+   swiftconfig -modify teraport -directory /var/tmp
+
+Remove a site
+   swiftconfig -remove teraport
+
+Add a new command to translation catalog
+   swiftconfig -name convert -path /usr/local/bin/convert
+
+Modify an existing command in the translation catalog
+   swiftconfig -name convert -path /usr/bin/convert
+
+Remove a command from the translation catalog
+   swiftconfig -remove convert
+
+=head1 CAVEATS
+
+Swiftconfig will attempt to automatically determine the location of swift configuration files. It first checks for an environment variable called $SWIFT_HOME. If that is not found, it will look for the location of "swift" in the path, and try to find the configuration files from there. This default behavior can be overwridden by manually specifying the location of files with -templatefile, -sitesfile, and -tcfile.
+
+The XML library that swiftconfig uses ignores comments in XML. All comments will be stripped from sites.xml as it gets modified.
+=cut