[Swift-commit] r2481 - trunk/docs

[noreply at svn.ci.uchicago.edu]

Author: benc
Date: 2009-01-29 09:38:45 -0600 (Thu, 29 Jan 2009)
New Revision: 2481

Modified:
   trunk/docs/userguide.xml
Log:
some more formatting

Modified: trunk/docs/userguide.xml
===================================================================
--- trunk/docs/userguide.xml	2009-01-29 15:15:46 UTC (rev 2480)
+++ trunk/docs/userguide.xml	2009-01-29 15:38:45 UTC (rev 2481)
@@ -1289,18 +1289,18 @@
 	<listitem>
 The output of the executable should consist of two columns of data, separated
 by a space. The first column should be the path of the mapped variable,
-in SwiftScript syntax (for example [2] means the 2nd element of an
-array) or the symbol $ to represent the root of the mapped variable.
+in SwiftScript syntax (for example <literal>[2]</literal> means the 2nd element of an
+array) or the symbol <literal>$</literal> to represent the root of the mapped variable.
 	</listitem>
 
 	<listitem> Example:
-With the following in mapper.sh,
-			<programlisting>
+With the following in <filename>mapper.sh</filename>,
+			<screen>
 #!/bin/bash
 echo "[2] qux"
 echo "[0] foo"
 echo "[1] bar"
-			</programlisting>
+			</screen>
 
 then a mapping statement:
 
@@ -1814,14 +1814,14 @@
 			
 				Swift properties are specified in the following format:
 				
-<programlisting>
+<screen>
 <name>=<value>
-</programlisting>
+</screen>
 			
 				The value can contain variables which will be expanded when the
 				properties file is read. Expansion is performed when the name of
-				the variable is used inside the "standard" shell dereference
-				construct: ${<varname>name</varname>}. The following variables
+				the variable is used inside the standard shell dereference
+				construct: <literal>${<varname>name</varname>}</literal>. The following variables
 				can be used in the Swift configuration file:
 				
 				<variablelist>
@@ -2023,7 +2023,7 @@
 								<link linkend="profile.swift.storagesize"><property>swift:storagesize</property></link> profile
 								entry in the sites.xml file. Example:
 								
-<programlisting>
+<screen>
 
 <pool handle="example" sysinfo="INTEL32::LINUX">
 	<gridftp url="gsiftp://example.org" storage="/scratch/swift" major="2" minor="4" patch="3"/>
@@ -2032,7 +2032,7 @@
 	<profile namespace="SWIFT" key="storagesize">20000000</profile>
 </pool>
 
-</programlisting>
+</screen>
 								
 								
 								The decision of which files to keep in the cache
@@ -2104,10 +2104,10 @@
 								url="http://www.graphviz.org">Graphviz</ulink>,
 								for example with a command-line such as:
 							</para>
-							<programlisting>
-								swift -pgraph graph1.dot q1.swift
-								dot -ograph.png -Tpng graph1.dot
-							</programlisting>
+							<screen>
+$ <userinput>swift -pgraph graph1.dot q1.swift</userinput>
+$ <userinput>dot -ograph.png -Tpng graph1.dot</userinput>
+							</screen>
 						</listitem>
 					</varlistentry>
 					
@@ -2538,11 +2538,11 @@
 				
 				Example:
 				
-<programlisting>
+<screen>
 sites.file=${vds.home}/etc/sites.xml
 tc.file=${vds.home}/etc/tc.data
 ip.address=192.168.0.1
-</programlisting>
+</screen>
 			
 			</para>
 		
@@ -2604,7 +2604,7 @@
 GRAM2 and GRAM4 providers.
 			</para>
 			<para id="profile.globus.condor_requirements"><literal>condor_requirements</literal> allows a requirements string to be specified
-when Condor is used as an LRM behind GRAM2. Example: <profile namespace="globus" key="condor_requirements">Arch == "X86_64" || Arch="INTEL"</profile>
+when Condor is used as an LRM behind GRAM2. Example: <literal><profile namespace="globus" key="condor_requirements">Arch == "X86_64" || Arch="INTEL"</profile></literal>
 			</para>
 			<para id="profile.globus.coastersPerNode"><literal>coastersPerNode</literal> specifies
 the number of coaster workers to be run on each node. This profile entry
@@ -2980,13 +2980,13 @@
 attribute to the <function>pool</function> element in the site
 catalog:
 
-<programlisting>
+<screen>
 
 <pool handle="example" gridlaunch="/usr/local/bin/kickstart" sysinfo="INTEL32::LINUX">
 [...]
 </pool>
 
-</programlisting>
+</screen>
 
 		</para>
 
@@ -3197,17 +3197,17 @@
 </para>
 <para>
 Now we define how 'mpi' will run in tc.data:
-<programlisting>
+<screen>
 tguc    mpi             /home/benc/mpi/mpi.sh   INSTALLED       INTEL32::LINUX GLOBUS::host_xcount=3
-</programlisting>
+</screen>
 </para>
 <para>
 mpi.sh is a wrapper script that launches the MPI program. It must be installed
 on the remote site:
-<programlisting>
+<screen>
 #!/bin/bash
 mpirun -np 3 -machinefile $PBS_NODEFILE /home/benc/mpi/a.out 
-</programlisting>
+</screen>
 </para>
 <para>
 Because of the way that Swift runs its server side code, provider-specific