~ubuntu-branches/ubuntu/jaunty/pvm/jaunty

« back to all changes in this revision

Viewing changes to man/man3/pvm_setopt.3

  • Committer: Bazaar Package Importer
  • Author(s): Steinar H. Gunderson
  • Date: 2005-10-06 15:25:03 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20051006152503-nty60w30a9dja62m
Tags: 3.4.5-5
Use --remove-all on pvm-rsh alternative in prerm instead of --remove.
(Closes: #328366)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" $Id: pvm_setopt.3,v 1.1 1996/09/23 22:06:17 pvmsrc Exp $
 
1
.\" $Id: pvm_setopt.3,v 1.2 2000/02/11 22:28:07 pvmsrc Exp $
2
2
.TH SETOPT 3PVM "4 April, 1994" "" "PVM Version 3.4"
3
3
.SH NAME
4
4
pvm_setopt \- Sets libpvm options.
16
16
.IP what 0.8i
17
17
Integer defining what to set.  One of:
18
18
.nf
19
 
PvmRoute            1    Message routing policy
20
 
PvmDebugMask        2    Libpvm debug mask
21
 
PvmAutoErr          3    Auto error reporting
22
 
PvmOutputTid        4    Stdout destination for children
23
 
PvmOutputCode       5    Output message tag
24
 
PvmTraceTid         6    Trace data destination for children
25
 
PvmTraceCode        7    Trace message tag
26
 
PvmFragSize         8    Message fragment size
27
 
PvmResvTids         9    Allow messages to reserved tags and TIDs
28
 
PvmSelfOutputTid   10    Stdout destination
29
 
PvmSelfOutputCode  11    Output message tag
30
 
PvmSelfTraceTid    12    Trace data destination
31
 
PvmSelfTraceCode   13    Trace message tag
32
 
PvmShowTids        14    pvm_catchout prints task ids with output
33
 
PvmPollType        15    Message wait policy (shared memory)
34
 
PvmPollTime        16    Message spinwait duration
 
19
PvmRoute              1    Message routing policy
 
20
PvmDebugMask          2    Libpvm debug mask
 
21
PvmAutoErr            3    Auto error reporting
 
22
PvmOutputTid          4    Stdout destination for children
 
23
PvmOutputCode         5    Output message tag for children
 
24
PvmTraceTid           6    Trace data destination for children
 
25
PvmTraceCode          7    Trace message tag for children
 
26
PvmTraceBuffer        8    Trace buffer size for children
 
27
PvmTraceOptions       9    Trace collection options for children
 
28
PvmFragSize          10    Message fragment size
 
29
PvmResvTids          11    Allow messages to reserved tags and TIDs
 
30
PvmSelfOutputTid     12    Stdout destination
 
31
PvmSelfOutputCode    13    Output message tag
 
32
PvmSelfTraceTid      14    Trace data destination
 
33
PvmSelfTraceCode     15    Trace message tag
 
34
PvmSelfTraceBuffer   16    Trace buffer size
 
35
PvmSelfTraceOptions  17    Trace collection options
 
36
PvmShowTids          18    pvm_catchout prints task ids with output
 
37
PvmPollType          19    Message wait policy (shared memory)
 
38
PvmPollTime          20    Message spinwait duration
 
39
PvmOutputContext     21    Output message context for children
 
40
PvmTraceContext      22    Trace message context for children
 
41
PvmSelfOutputContext 23    Output message context
 
42
PvmSelfTraceContext  24    Trace message context
 
43
PvmNoReset           25    Do not kill task on reset
35
44
.fi
36
45
.br
37
46
.IP val
38
47
Integer specifying new setting of option.
 
48
.sp
39
49
Predefined values for \fIPvmRoute\fR are:
40
50
.nf
41
 
PvmDontRoute        1    Don't request or grant connections
42
 
PvmAllowDirect      2    (Default) Don't request but allow
43
 
PvmRouteDirect      3    Request and allow connections
44
 
.fi
45
 
.br
 
51
PvmDontRoute      1    Don't request or grant connections
 
52
PvmAllowDirect    2    (Default) Don't request but allow
 
53
PvmRouteDirect    3    Request and allow connections
 
54
.fi
 
55
.sp
 
56
Predefined values for \fIPvmTraceOptions\fR are:
 
57
.nf
 
58
PvmTraceFull      1    (Default) Do full trace events
 
59
PvmTraceTime      2    Only do PVM routine timings
 
60
PvmTraceCount     3    Only do PVM routine profiling (call counts)
 
61
.fi
 
62
.sp
 
63
Predefined values for \fIPvmPollType\fR are:
 
64
.nf
 
65
PvmPollConstant   1    Spin on its message queue
 
66
PvmPollSleep      2    Poll the message queue PvmPollTime times
 
67
.fi
 
68
.sp
46
69
.IP oldval
47
70
Integer returning the previous setting of the option.
48
71
 
87
110
and \fIPvmAutoErr\fR is set to 1 (the default),
88
111
an error message is automatically printed on \fIstderr\fR.
89
112
A setting of 0 disables this.
90
 
A setting of 2 causes the library to terminate the task by calling exit()
91
 
after printing the error message.
 
113
A setting of 2 causes the library to terminate the task
 
114
by calling exit() after printing the error message.
92
115
A setting of 3 causes the library to abort
93
116
after printing the error message.
94
117
.sp
123
146
Sets the message tag for trace data messages.
124
147
Should only be set when a task has \fIPvmTraceTid\fR set to itself.
125
148
.sp
 
149
.IP PvmTraceBuffer
 
150
Sets the trace buffer size for trace event collection (in bytes).
 
151
Rather than send a separate message for each trace event, the
 
152
events are written to a message buffer until the buffer reaches
 
153
PvmTraceBuffer bytes.  Then a single large trace message is sent.
 
154
This can greatly reduce tracing intrusion.  Make sure you call
 
155
pvm_exit() in your tasks to flush the trace buffer!
 
156
.sp
 
157
.IP PvmTraceOptions
 
158
Sets the PVM built-in tracing options.  This is useful for
 
159
custom trace collection tools to allow analysis of library
 
160
routine execution times and invocation counts.  By default,
 
161
tracing with \fIPvmTraceFull\fR produces full trace events with
 
162
calling arguments and return values.  Using \fIPvmTraceTime\fR
 
163
produces total time spent executing each library routine.
 
164
The \fIPvmTraceCount\fR option keep only a count of the
 
165
number of times each routine was called.
 
166
.sp
126
167
.IP PvmFragSize
127
168
\fIVal\fR specifies the message fragment size in bytes.
128
169
Default value varies with host architecture.
134
175
when a reserved identifier is specified.
135
176
.sp
136
177
.IP PvmSelfOutputTid
137
 
Sets the \fIstdout\fR destination for the task.
138
 
Everything printed on \fIstdout\fR
139
 
is
 
178
Sets the \fIstdout\fR destination for the calling task.
 
179
Everything printed on \fIstdout\fR is
140
180
packed into messages and sent to the destination.
141
 
Note:
142
 
this only works for spawned tasks,
143
 
because the pvmd doesn't get the output from tasks started by other
144
 
means.
 
181
Note: this only works for spawned tasks,
 
182
because the pvmd doesn't get the output from tasks started
 
183
by other means.
145
184
\fIval\fR is the TID of a PVM task.
146
185
Setting PvmSelfOutputTid to
147
186
0 redirects stdout to the master pvmd,
159
198
Sets the message tag for standard output messages.
160
199
.sp
161
200
.IP PvmSelfTraceTid
162
 
Sets the trace data message destination for the task.
 
201
Sets the trace data message destination for the calling task.
163
202
Libpvm trace data is sent as messages to the destination.
164
203
\fIval\fR is the TID of a PVM task.
165
204
Setting PvmSelfTraceTid to 0
176
215
.IP PvmSelfTraceCode
177
216
Sets the message tag for trace data messages.
178
217
.sp
 
218
.IP PvmSelfTraceBuffer
 
219
Sets the trace buffer size for trace event collection (in bytes).
 
220
.sp
 
221
.IP PvmSelfTraceOptions
 
222
Sets the PVM built-in tracing options for the calling task
 
223
(see PvmTraceOptions).
 
224
.sp
179
225
.IP PvmShowTids
180
226
If true (nonzero), \fIpvm_catchout\fR tags each line of output printed
181
227
by a child task with the task id.
192
238
Sets the poll count for applications checking their message queue before they
193
239
pend on the semaphore.  This option is ignored if PvmPollType is set to
194
240
PvmPollConstant.
 
241
.sp
 
242
.IP PvmOutputContext
 
243
Sets the message context for output collection messages from children.
 
244
.sp
 
245
.IP PvmTraceContext
 
246
Sets the message context for trace data messages from children.
 
247
.sp
 
248
.IP PvmSelfOutputContext
 
249
Sets the message context for output collection from the calling task.
 
250
.sp
 
251
.IP PvmSelfTraceContext
 
252
Sets the message context for trace data messages from the calling task.
 
253
.sp
 
254
.IP PvmNoReset
 
255
When set true (non-zero integer value) informs PVM *not* to kill off
 
256
the calling task when performing a "reset" command, such as issued
 
257
by the "pvm" console.
 
258
.sp
195
259
.PP
196
260
pvm_setopt returns the previous value of the option.
197
261
If an error occurs,