aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortradke <tradke@0888f3d4-9f52-45d2-93bc-d00801ff5e46>2004-03-13 18:31:47 +0000
committertradke <tradke@0888f3d4-9f52-45d2-93bc-d00801ff5e46>2004-03-13 18:31:47 +0000
commit2efde1f687e1c164572ff7a007a04418c575de05 (patch)
treee7bcb2a94cb9fcf41de4e307b21e658ba2beaf58
parent9060cf34aa310965a34803d4c53ca46c2e98c63f (diff)
Option strings are enclosed in curly braces.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOStreamedHDF5/trunk@101 0888f3d4-9f52-45d2-93bc-d00801ff5e46
-rw-r--r--doc/documentation.tex8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 17d5784..9da399e 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -59,7 +59,7 @@ Parameters to control the {\tt IOStreamedHDF5} I/O method are:
The variables must be given by their fully qualified variable or group
name. The special keyword {\it all} requests {\tt IOStreamedHDF5} output for
all variables. Multiple names must be separated by whitespaces.\\
- An option string can be appended in square brackets to a group/variable
+ An option string can be appended in curly braces to a group/variable
name. Supported options are {\tt out\_every} (to set the output
frequency for individual variables) and hyperslab options (see section
\ref{IOStreamedHDF5_output_hyperslabs} for details).
@@ -93,13 +93,13 @@ other grid point will be output.
\begin{verbatim}
IOStreamedHDF5::out_every = 1
- IOStreamedHDF5::out_vars = "Grid::x[ out_every = 5 ]
- Wavetoy::phi[ origin = {4 4 4}
+ IOStreamedHDF5::out_vars = "Grid::x{ out_every = 5 }
+ Wavetoy::phi{ origin = {4 4 4}
direction = {0 0 0
0 1 0
0 0 1}
extent = {10 20}
- downsample = {2 2} ]"
+ downsample = {2 2} }"
\end{verbatim}
The hyperslab parameters which can be set in an option string are: