[Swift-commit] r3496 - in usertools/swift/swiftconfig: . bin docs

[noreply at svn.ci.uchicago.edu]

Author: davidk
Date: 2010-08-01 08:23:51 -0500 (Sun, 01 Aug 2010)
New Revision: 3496

Added:
   usertools/swift/swiftconfig/docs/
   usertools/swift/swiftconfig/docs/tutorial.pdf
Modified:
   usertools/swift/swiftconfig/bin/swiftconfig
Log:
Updated perldoc and a swiftconfig multisite tutorial


Modified: usertools/swift/swiftconfig/bin/swiftconfig
===================================================================
--- usertools/swift/swiftconfig/bin/swiftconfig	2010-08-01 10:42:19 UTC (rev 3495)
+++ usertools/swift/swiftconfig/bin/swiftconfig	2010-08-01 13:23:51 UTC (rev 3496)
@@ -464,16 +464,20 @@
 
 =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.
+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
-   -templates			display all available sites in template
-   -modify site		Specifies the name of a site to modify
-
+   -add sitename	add a site from template
+   -remove site	removes a site from sites.xml
+   -templates		display all available sites in template
+   -modify site	Specifies the name of a site to modify
+   -describe site   Prints the raw XML site configuration
+   
 =head1 EXAMPLES
 
 List all templates available for adding
@@ -490,7 +494,11 @@
 
 =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.
+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.
 
-The XML library that swiftconfig uses ignores comments in XML. All comments will be stripped from sites.xml as it gets modified.
+The XML library that swiftconfig uses ignores comments in XML. All comments 
+will be stripped from sites.xml as it gets modified.
 =cut

Added: usertools/swift/swiftconfig/docs/tutorial.pdf
===================================================================
(Binary files differ)


Property changes on: usertools/swift/swiftconfig/docs/tutorial.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream