~ubuntu-branches/ubuntu/feisty/pvm/feisty

« back to all changes in this revision

Viewing changes to man/man3/pvm_catchout.3

  • Committer: Bazaar Package Importer
  • Author(s): Steinar H. Gunderson
  • Date: 2006-08-09 00:00:40 UTC
  • mfrom: (2.1.5 dapper)
  • Revision ID: james.westby@ubuntu.com-20060809000040-16kh33tmxx2em716
Tags: 3.4.5-7
Build with SHELL=/bin/bash in debian/rules; fixes FTBFS when /bin/sh
isn't bash. (Closes: #379543)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" $Id: pvm_catchout.3,v 1.1 1996/09/23 22:01:06 pvmsrc Exp $
 
1
.\" $Id: pvm_catchout.3,v 1.2 2001/09/27 18:51:32 pvmsrc Exp $
2
2
.TH CATCHOUT 3PVM "13 July, 1994" "" "PVM Version 3.4"
3
3
.SH NAME
4
4
pvm_catchout \- Catch output from child tasks.
28
28
.SH DESCRIPTION
29
29
The routine \fIpvm_catchout\fR
30
30
causes the calling task (the parent)
31
 
to catch output from tasks spawned after the call to
32
 
pvm_catchout.
 
31
to catch output from any tasks spawned after the call to
 
32
\fIpvm_catchout\fR.
33
33
Characters printed on \fIstdout\fR or \fIstderr\fR in children tasks
34
34
are collected by the pvmds
35
35
and sent in control messages to the parent task,
36
36
which tags each line and appends it to the specified file.
37
37
Output from grandchildren (spawned by children) tasks
38
38
is also collected,
39
 
provided the children don't reset \fIPvmOutputTid\fR.
 
39
provided the children don't reset their \fIPvmOutputTid\fR.
40
40
.PP
41
41
If option \fIPvmShowTids\fR (see \fIpvm_setopt\fR) is true (nonzero),
42
42
output is printed as shown below,
47
47
        [txxxxx] END
48
48
.fi
49
49
 
50
 
The output from each task includes one BEGIN line and one END
51
 
line,
 
50
The output from each task includes one BEGIN line and one END line,
52
51
with whatever the task prints in between.
53
52
If PvmShowTids is false,
54
53
raw output is printed with no additional information.
55
54
.PP
56
55
In C,
57
56
the output file descriptor may be specified.
58
 
Giving a null pointer turns output collection off.
 
57
Giving a null pointer turns output collection off
 
58
for any subsequently spawned child tasks.
 
59
(Any existing output collection will still proceed at the
 
60
child tasks, until they exit or change their\fIPvmOutputTid\fR
 
61
or related settings - see man page for pvm_setopt().)
59
62
In Fortran,
60
 
output collection can only be turned on or off,
61
 
and is logged to stdout of the parent task.
 
63
output collection can only be turned on or off (again only
 
64
for subsequently spawned child tasks),
 
65
and is always logged to the stdout of the parent task.
62
66
.PP
63
67
If \fIpvm_exit\fR is called while output collection is in effect,
64
 
it will block until all tasks sending it output
65
 
have exited,
66
 
in order to print all their output.
 
68
it will block in order to print all the output,
 
69
until all tasks sending the given task output have exited.
67
70
To avoid this,
68
71
output collection can be turned off by calling pvm_catchout(0)
69
72
before calling pvm_exit.