← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/atoms/help/en_US/atomsUpdate.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/atoms/help/en_US/atomsUpdate.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="atomsUpdate">
14
 
  <refnamediv>
15
 
    <refname>atomsUpdate</refname>
16
 
    <refpurpose>Update one or several external modules</refpurpose>
17
 
  </refnamediv>
18
 
  <!-- ===================================================================== -->
19
 
  <!-- Calling Sequence -->
20
 
  <!-- ===================================================================== -->
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>
24
 
      result = atomsUpdate()
25
 
      result = atomsUpdate(name[,section]])
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <!-- ===================================================================== -->
29
 
  <!-- Parameters -->
30
 
  <!-- ===================================================================== -->
31
 
  <refsection>
32
 
    <title>Arguments</title>
33
 
    <variablelist>
34
 
      <!-- First input argument -->
35
 
      <varlistentry>
36
 
        <term>name</term>
37
 
        <listitem>
38
 
          <para>
39
 
            1xn character string matrix  : module's technical name
40
 
          </para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <!-- Second input argument -->
44
 
      <varlistentry>
45
 
        <term>section</term>
46
 
        <listitem>
47
 
          <para>
48
 
            This argument controls the list of sections where search
49
 
            modules to update.
50
 
          </para>
51
 
          <para>
52
 
            <literal>section</literal> is a single-string and its value should be :
53
 
          </para>
54
 
          <itemizedlist>
55
 
            <listitem>
56
 
              <para>
57
 
                <literal>"all"</literal>: Modules to remove are searched in both
58
 
                "user" and "allusers" sections.
59
 
              </para>
60
 
            </listitem>
61
 
            <listitem>
62
 
              <para>
63
 
                <literal>"allusers"</literal>: Modules to remove are only searched in
64
 
                the "allusers" section.
65
 
              </para>
66
 
            </listitem>
67
 
            <listitem>
68
 
              <para>
69
 
                <literal>"user"</literal>: Modules to remove are only searched in
70
 
                the "user" section.
71
 
              </para>
72
 
            </listitem>
73
 
          </itemizedlist>
74
 
          <para>
75
 
            If SCI is write accessible, "all" is the default value.
76
 
            Otherwise, the default value is "user".
77
 
          </para>
78
 
        </listitem>
79
 
      </varlistentry>
80
 
      <!-- Outpu argument -->
81
 
      <varlistentry>
82
 
        <term>result</term>
83
 
        <listitem>
84
 
          <para>
85
 
            
86
 
          </para>
87
 
        </listitem>
88
 
      </varlistentry>
89
 
    </variablelist>
90
 
  </refsection>
91
 
  <!-- ===================================================================== -->
92
 
  <!-- Description -->
93
 
  <!-- ===================================================================== -->
94
 
  <refsection>
95
 
    <title>Description</title>
96
 
    <para>
97
 
      <literal>atomsUpdate</literal> update one or more external modules.
98
 
    </para>
99
 
  </refsection>
100
 
  <!-- ===================================================================== -->
101
 
  <!-- Examples -->
102
 
  <!-- ===================================================================== -->
103
 
  <refsection>
104
 
    <title>Examples</title>
105
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>atomsUpdate</refname>
 
16
        <refpurpose>Update one or several external modules</refpurpose>
 
17
    </refnamediv>
 
18
    <!-- ===================================================================== -->
 
19
    <!-- Calling Sequence -->
 
20
    <!-- ===================================================================== -->
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>
 
24
            result = atomsUpdate()
 
25
            result = atomsUpdate(name[,section]])
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <!-- ===================================================================== -->
 
29
    <!-- Parameters -->
 
30
    <!-- ===================================================================== -->
 
31
    <refsection>
 
32
        <title>Arguments</title>
 
33
        <variablelist>
 
34
            <!-- First input argument -->
 
35
            <varlistentry>
 
36
                <term>name</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        1xn character string matrix  : module's technical name
 
40
                    </para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <!-- Second input argument -->
 
44
            <varlistentry>
 
45
                <term>section</term>
 
46
                <listitem>
 
47
                    <para>
 
48
                        This argument controls the list of sections where search
 
49
                        modules to update.
 
50
                    </para>
 
51
                    <para>
 
52
                        <literal>section</literal> is a single-string and its value should be :
 
53
                    </para>
 
54
                    <itemizedlist>
 
55
                        <listitem>
 
56
                            <para>
 
57
                                <literal>"all"</literal>: Modules to remove are searched in both
 
58
                                "user" and "allusers" sections.
 
59
                            </para>
 
60
                        </listitem>
 
61
                        <listitem>
 
62
                            <para>
 
63
                                <literal>"allusers"</literal>: Modules to remove are only searched in
 
64
                                the "allusers" section.
 
65
                            </para>
 
66
                        </listitem>
 
67
                        <listitem>
 
68
                            <para>
 
69
                                <literal>"user"</literal>: Modules to remove are only searched in
 
70
                                the "user" section.
 
71
                            </para>
 
72
                        </listitem>
 
73
                    </itemizedlist>
 
74
                    <para>
 
75
                        If SCI is write accessible, "all" is the default value.
 
76
                        Otherwise, the default value is "user".
 
77
                    </para>
 
78
                </listitem>
 
79
            </varlistentry>
 
80
            <!-- Outpu argument -->
 
81
            <varlistentry>
 
82
                <term>result</term>
 
83
                <listitem>
 
84
                    <para>
 
85
                        
 
86
                    </para>
 
87
                </listitem>
 
88
            </varlistentry>
 
89
        </variablelist>
 
90
    </refsection>
 
91
    <!-- ===================================================================== -->
 
92
    <!-- Description -->
 
93
    <!-- ===================================================================== -->
 
94
    <refsection>
 
95
        <title>Description</title>
 
96
        <para>
 
97
            <literal>atomsUpdate</literal> update one or more external modules.
 
98
        </para>
 
99
    </refsection>
 
100
    <!-- ===================================================================== -->
 
101
    <!-- Examples -->
 
102
    <!-- ===================================================================== -->
 
103
    <refsection>
 
104
        <title>Examples</title>
 
105
        <programlisting role="example"><![CDATA[
106
106
 
107
107
atomsSetConfig("Verbose","True");
108
108
atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
128
128
atomsRemove("toolbox_5");
129
129
 
130
130
]]></programlisting>
131
 
  </refsection>
132
 
  <!-- ===================================================================== -->
133
 
  <!-- See also -->
134
 
  <!-- ===================================================================== -->
135
 
  <refsection role="see also">
136
 
    <title>See Also</title>
137
 
    <simplelist type="inline">
138
 
      <member>
139
 
        <link linkend="atomsInstall">atomsInstall</link>
140
 
      </member>
141
 
      <member>
142
 
        <link linkend="atomsRemove">atomsRemove</link>
143
 
      </member>
144
 
      <member>
145
 
        <link linkend="atomsGetInstalled">atomsGetInstalled</link>
146
 
      </member>
147
 
    </simplelist>
148
 
  </refsection>
149
 
  <!-- ===================================================================== -->
150
 
  <!-- Authors -->
151
 
  <!-- ===================================================================== -->
 
131
    </refsection>
 
132
    <!-- ===================================================================== -->
 
133
    <!-- See also -->
 
134
    <!-- ===================================================================== -->
 
135
    <refsection role="see also">
 
136
        <title>See Also</title>
 
137
        <simplelist type="inline">
 
138
            <member>
 
139
                <link linkend="atomsInstall">atomsInstall</link>
 
140
            </member>
 
141
            <member>
 
142
                <link linkend="atomsRemove">atomsRemove</link>
 
143
            </member>
 
144
            <member>
 
145
                <link linkend="atomsGetInstalled">atomsGetInstalled</link>
 
146
            </member>
 
147
        </simplelist>
 
148
    </refsection>
 
149
    <!-- ===================================================================== -->
 
150
    <!-- Authors -->
 
151
    <!-- ===================================================================== -->
152
152
</refentry>