summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-06-23 04:16:13 +0000
committerschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-06-23 04:16:13 +0000
commita5554988d7b607ddb66ac499f3f9ceb74a35f31d (patch)
treec030a082c7512f973e8859911a2ec74f2a969c6e /doc
parent4d5f9ed6fdc103aa509c79e14d1ec4680e643925 (diff)
Add a new command line option to select the buffering mode of stdout.
The option is "-b <mode>", or "-buffering=<mode>", where mode can be "no", "line", or "full". This option uses the ANSI C function call setvbuf() to select the corresponding buffering mode. The buffering mode can be selected only once in a portable programme, and it has to be selected before the first output occurs. This means that it has to be implemented in the flesh. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4329 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/RunningCactus.tex18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/UsersGuide/RunningCactus.tex b/doc/UsersGuide/RunningCactus.tex
index 41d8b09d..3ce4f1bf 100644
--- a/doc/UsersGuide/RunningCactus.tex
+++ b/doc/UsersGuide/RunningCactus.tex
@@ -1266,6 +1266,8 @@ Short Version & Long Version \\
\hline
-r[o|e|oe|eo] & -redirect=[o|e|oe|eo]\\
\hline
+ -b <\var{mode}> & -buffering=<\var{mode}>\\
+\hline
-i & -ignore-next \\
\hline
& -parameter-level=<\var{level}> \\
@@ -1324,6 +1326,22 @@ will abort the Cactus run.
Redirects the standard output (`\texttt{o}') and/or standard error
(`\texttt{e}') of each processor to a file. By default
the standard outputs from processors other than processor 0 are discarded.
+
+\item [\texttt{-b <\var{mode}>} or \texttt{-buffering=<\var{mode}>}]
+ Set the \texttt{stdout} buffering mode. \var{mode} can be one of
+ \texttt{no}, \texttt{line}, and \texttt{full}. Buffered I/O is a
+ standard feature of C programmes. This delays writing the actual
+ output; instead, the output is collected into an internal buffer,
+ and is then written in large chunks. This improves performance
+ considerably. Line buffering means that output is written whenever
+ a newline character is encountered; full buffering means that output
+ is written once e.g.\ 1000 characters have accmulated. The default
+ setting is line buffering for I/O that goes to a terminal, and full
+ buffering for I/O that goes to a file. For debugging purposes, it
+ is sometimes useful to reduce the amount of buffering. Error
+ messages, i.e.\ the \texttt{stderr} stream, is always unbuffered
+ (and hence usually slower than \texttt{stdout}).
+
\item [\texttt{-i} or \texttt{-ignore-next}]
Causes the next argument on the command line to be ignored.
\item [\texttt{-parameter-level=<\var{level}>}]