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

« back to all changes in this revision

Viewing changes to man/eng/pvm/pvm_config.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_config</TITLE>
 
6
  <TYPE>Scilab function</TYPE>
 
7
  <DATE>May 1998</DATE>
 
8
  <SHORT_DESCRIPTION name="pvm_config"> sends a message</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>res =  pvm_config()  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>res</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>list of 7 elements such that:</SP>
 
18
          <PARAM_INDENT>
 
19
            <PARAM_ITEM>
 
20
              <PARAM_NAME>(1)</PARAM_NAME>
 
21
              <PARAM_DESCRIPTION>
 
22
                <SP>:
 
23
     integer returning the number of hosts (pvmds) in the virtual
 
24
     machine.</SP>
 
25
              </PARAM_DESCRIPTION>
 
26
            </PARAM_ITEM>
 
27
            <PARAM_ITEM>
 
28
              <PARAM_NAME>(2)</PARAM_NAME>
 
29
              <PARAM_DESCRIPTION>
 
30
                <SP>:  integer returning the number of different data formats being used.</SP>
 
31
              </PARAM_DESCRIPTION>
 
32
            </PARAM_ITEM>
 
33
            <PARAM_ITEM>
 
34
              <PARAM_NAME>(3)</PARAM_NAME>
 
35
              <PARAM_DESCRIPTION>
 
36
                <SP>:  integer returning pvmd task ID for host.</SP>
 
37
              </PARAM_DESCRIPTION>
 
38
            </PARAM_ITEM>
 
39
            <PARAM_ITEM>
 
40
              <PARAM_NAME>(4)</PARAM_NAME>
 
41
              <PARAM_DESCRIPTION>
 
42
                <SP>:  character string returning name of host.</SP>
 
43
              </PARAM_DESCRIPTION>
 
44
            </PARAM_ITEM>
 
45
            <PARAM_ITEM>
 
46
              <PARAM_NAME>(5)</PARAM_NAME>
 
47
              <PARAM_DESCRIPTION>
 
48
                <SP>:  character string returning architecture name of host</SP>
 
49
              </PARAM_DESCRIPTION>
 
50
            </PARAM_ITEM>
 
51
            <PARAM_ITEM>
 
52
              <PARAM_NAME>(6)</PARAM_NAME>
 
53
              <PARAM_DESCRIPTION>
 
54
                <SP>:  integer returning relative speed of host. Default value is 1000.</SP>
 
55
              </PARAM_DESCRIPTION>
 
56
            </PARAM_ITEM>
 
57
            <PARAM_ITEM>
 
58
              <PARAM_NAME>(7)</PARAM_NAME>
 
59
              <PARAM_DESCRIPTION>
 
60
                <SP>:  integer status code returned by the routine.</SP>
 
61
              </PARAM_DESCRIPTION>
 
62
            </PARAM_ITEM>
 
63
          </PARAM_INDENT>
 
64
        </PARAM_DESCRIPTION>
 
65
      </PARAM_ITEM>
 
66
    </PARAM_INDENT>
 
67
  </PARAM>
 
68
  <DESCRIPTION>
 
69
    <P><VERB>pvm_config</VERB> returns information about
 
70
    the present virtual machine. The information returned is
 
71
    similar to that available from the console command.</P>
 
72
    <P>
 
73
    The <VERB>pvm_config</VERB> function returns information about the entire
 
74
    virtual machine in one call.</P>
 
75
    <P>
 
76
    The returned value <VERB>res(7)</VERB>will be zero if 
 
77
    the call is successful and will be 
 
78
    will be &lt; 0 if some error occurs.</P>
 
79
  </DESCRIPTION>
 
80
  <EXAMPLE>
 
81
<![CDATA[
 
82
res = pvm_config()
 
83
 ]]>
 
84
  </EXAMPLE>
 
85
  <SEE_ALSO>
 
86
    <SEE_ALSO_ITEM>
 
87
      <LINK>pvm_tasks</LINK>
 
88
    </SEE_ALSO_ITEM>
 
89
  </SEE_ALSO>
 
90
</MAN>