~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/pvm/pvm_tasks.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>pvm_tasks</TITLE>
 
6
  <TYPE>Scilab function</TYPE>
 
7
  <DATE>May 1998</DATE>
 
8
  <SHORT_DESCRIPTION name="pvm_tasks"> information about the tasks running on the virtual machine.  </SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>res  = pvm_tasks([where])  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>where</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: (optional) integer, specifying what tasks to return information about. The options are:</SP>
 
18
          <VERBATIM>
 
19
<![CDATA[
 
20
 0(default) for all the tasks on the virtual machine
 
21
 pvmd tid for all tasks on a given host
 
22
   tid  for a specific task
 
23
   ]]>
 
24
          </VERBATIM>
 
25
        </PARAM_DESCRIPTION>
 
26
      </PARAM_ITEM>
 
27
      <PARAM_ITEM>
 
28
        <PARAM_NAME>res</PARAM_NAME>
 
29
        <PARAM_DESCRIPTION>
 
30
          <SP>:  list of 7 elements such that:</SP>
 
31
          <PARAM_INDENT>
 
32
            <PARAM_ITEM>
 
33
              <PARAM_NAME>res(1)  </PARAM_NAME>
 
34
              <PARAM_DESCRIPTION>
 
35
                <SP>:  integer returning task ID of one task</SP>
 
36
              </PARAM_DESCRIPTION>
 
37
            </PARAM_ITEM>
 
38
            <PARAM_ITEM>
 
39
              <PARAM_NAME>res(2)  </PARAM_NAME>
 
40
              <PARAM_DESCRIPTION>
 
41
                <SP>:  integer returning parent task ID</SP>
 
42
              </PARAM_DESCRIPTION>
 
43
            </PARAM_ITEM>
 
44
            <PARAM_ITEM>
 
45
              <PARAM_NAME>res(3)  </PARAM_NAME>
 
46
              <PARAM_DESCRIPTION>
 
47
                <SP>:  integer returning pvmd task ID of host task is on</SP>
 
48
              </PARAM_DESCRIPTION>
 
49
            </PARAM_ITEM>
 
50
            <PARAM_ITEM>
 
51
              <PARAM_NAME>res(4)  </PARAM_NAME>
 
52
              <PARAM_DESCRIPTION>
 
53
                <SP>:  integer returning status of task</SP>
 
54
              </PARAM_DESCRIPTION>
 
55
            </PARAM_ITEM>
 
56
            <PARAM_ITEM>
 
57
              <PARAM_NAME>res(5)  </PARAM_NAME>
 
58
              <PARAM_DESCRIPTION>
 
59
                <SP>:  string returning the name of spawned task. Manually started tasks return blank.</SP>
 
60
              </PARAM_DESCRIPTION>
 
61
            </PARAM_ITEM>
 
62
            <PARAM_ITEM>
 
63
              <PARAM_NAME>res(6)  </PARAM_NAME>
 
64
              <PARAM_DESCRIPTION>
 
65
                <SP>:  integer returning the number of tasks being reported on.</SP>
 
66
              </PARAM_DESCRIPTION>
 
67
            </PARAM_ITEM>
 
68
            <PARAM_ITEM>
 
69
              <PARAM_NAME>res(7)  </PARAM_NAME>
 
70
              <PARAM_DESCRIPTION>
 
71
                <SP>:  integer status code returned by the routine.</SP>
 
72
              </PARAM_DESCRIPTION>
 
73
            </PARAM_ITEM>
 
74
          </PARAM_INDENT>
 
75
        </PARAM_DESCRIPTION>
 
76
      </PARAM_ITEM>
 
77
    </PARAM_INDENT>
 
78
  </PARAM>
 
79
  <DESCRIPTION>
 
80
    <P><VERB>pvm_tasks</VERB> 
 
81
    returns information about
 
82
    tasks presently running on the virtual machine.
 
83
    The information returned is the same as
 
84
    that available from the console command</P>
 
85
    <P>
 
86
    The <VERB>pvm_tasks</VERB> function returns information about the entire
 
87
    virtual machine in one call.</P>
 
88
    <P>
 
89
    If pvm_tasks is successful,</P>
 
90
    <P>
 
91
    will be 0.
 
92
    If some error occurs then</P>
 
93
    <P>
 
94
    will be &lt; 0.</P>
 
95
    <P>
 
96
    for example:</P>
 
97
    <VERBATIM>
 
98
<![CDATA[
 
99
-->res = pvm_tasks()
 
100
 res  =
 
101
 
 
102
       res(1)
 
103
 
 
104
!   262148.    262151.    262152. !
 
105
 
 
106
       res(2)
 
107
 
 
108
!   262147.    0.    262151. !
 
109
 
 
110
       res(3)
 
111
 
 
112
!   262144.    262144.    262144. !
 
113
 
 
114
       res(4)
 
115
 
 
116
!   6.    4.    6. !
 
117
 
 
118
       res(5)
 
119
 
 
120
!pvmgs    /home/ubeda/SCILAB/scilab-2.4/bin/scilex  !
 
121
 
 
122
       res(6)
 
123
 
 
124
    3.  
 
125
 
 
126
       res(7)
 
127
 
 
128
    0. 
 
129
   ]]>
 
130
    </VERBATIM>
 
131
  </DESCRIPTION>
 
132
  <SEE_ALSO>
 
133
    <SEE_ALSO_ITEM>
 
134
      <LINK>pvm_config</LINK>
 
135
    </SEE_ALSO_ITEM>
 
136
    <SEE_ALSO_ITEM>
 
137
      <LINK>pvm_tidtohost</LINK>
 
138
    </SEE_ALSO_ITEM>
 
139
  </SEE_ALSO>
 
140
</MAN>