← 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/atomsAutoloadAdd.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/atomsAutoloadAdd.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="atomsAutoloadAdd">
14
 
  <refnamediv>
15
 
    <refname>atomsAutoloadAdd</refname>
16
 
    <refpurpose>Add one or several modules to autoload</refpurpose>
17
 
  </refnamediv>
18
 
  <!-- ===================================================================== -->
19
 
  <!-- Calling Sequence -->
20
 
  <!-- ===================================================================== -->
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>
24
 
      nbAdd = atomsAutoloadAdd(modules[,section])
25
 
    </synopsis>
26
 
  </refsynopsisdiv>
27
 
  <!-- ===================================================================== -->
28
 
  <!-- Parameters -->
29
 
  <!-- ===================================================================== -->
30
 
  <refsection>
31
 
    <title>Arguments</title>
32
 
    <variablelist>
33
 
      <!-- 1st input parameter -->
34
 
      <varlistentry>
35
 
        <term>modules</term>
36
 
        <listitem>
37
 
          <para>
38
 
            mx1, mx2 or mx3 Matrix of strings:
39
 
          </para>
40
 
          <informaltable border="1">
41
 
            <!-- Technical name -->
42
 
            <tr>
43
 
              <td>
44
 
                <emphasis>1st Col.</emphasis>
45
 
              </td>
46
 
              <td>
47
 
                <emphasis role="strong">Technical name</emphasis>
48
 
              </td>
49
 
              <td>
50
 
                Mandatory
51
 
              </td>
52
 
              <td>
53
 
              </td>
54
 
            </tr>
55
 
            <!-- Version -->
56
 
            <tr>
57
 
              <td>
58
 
                <emphasis>2nd Col.</emphasis>
59
 
              </td>
60
 
              <td>
61
 
                <emphasis role="strong">Version</emphasis>
62
 
              </td>
63
 
              <td>
64
 
                Optional
65
 
              </td>
66
 
              <td>
67
 
                If this field is empty or is not present,
68
 
                the most recent version is used
69
 
              </td>
70
 
            </tr>
71
 
            <!-- Section -->
72
 
            <tr>
73
 
              <td>
74
 
                <emphasis>3rd Col.</emphasis>
75
 
              </td>
76
 
              <td>
77
 
                <emphasis role="strong">Installed section</emphasis>
78
 
              </td>
79
 
              <td>
80
 
                Optional
81
 
              </td>
82
 
              <td>
83
 
                If this field is empty or is not present,
84
 
                and <literal>module</literal> is installed in both "user" and
85
 
                "allusers" sections, the section of autoload list is used.
86
 
              </td>
87
 
            </tr>
88
 
          </informaltable>
89
 
        </listitem>
90
 
      </varlistentry>
91
 
      <!-- 2nd input parameter -->
92
 
      <varlistentry>
93
 
        <term>section</term>
94
 
        <listitem>
95
 
          <para>
96
 
            This argument controls which autoload list is changed.
97
 
          </para>
98
 
          <para>
99
 
            <literal>section</literal> is a single-string and its value should be :
100
 
          </para>
101
 
          <itemizedlist>
102
 
            <listitem>
103
 
              <para>
104
 
                <literal>"allusers"</literal>: modules are added to the
105
 
                "allusers" autoload list and all users of scilab are affected.
106
 
              </para>
107
 
            </listitem>
108
 
            <listitem>
109
 
              <para>
110
 
                <literal>"user"</literal>: modules are added to the
111
 
                "user" autoload list and only the current user is affected.
112
 
              </para>
113
 
            </listitem>
114
 
          </itemizedlist>
115
 
          <para>
116
 
            If SCI/contrib is write accessible, "allusers" is the default value.
117
 
            Otherwise, the default value is "user".
118
 
          </para>
119
 
        </listitem>
120
 
      </varlistentry>
121
 
      <!-- output parameter -->
122
 
      <varlistentry>
123
 
        <term>nbAdd</term>
124
 
        <listitem>
125
 
          <para>
126
 
            An integer : the number of modules successfully added.
127
 
          </para>
128
 
        </listitem>
129
 
      </varlistentry>
130
 
    </variablelist>
131
 
  </refsection>
132
 
  <!-- ===================================================================== -->
133
 
  <!-- Description -->
134
 
  <!-- ===================================================================== -->
135
 
  <refsection>
136
 
    <title>Description</title>
137
 
    <para>
138
 
      
139
 
    </para>
140
 
  </refsection>
141
 
  <!-- ===================================================================== -->
142
 
  <!-- Examples -->
143
 
  <!-- ===================================================================== -->
144
 
  <refsection>
145
 
    <title>Examples</title>
146
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>atomsAutoloadAdd</refname>
 
16
        <refpurpose>Add one or several modules to autoload</refpurpose>
 
17
    </refnamediv>
 
18
    <!-- ===================================================================== -->
 
19
    <!-- Calling Sequence -->
 
20
    <!-- ===================================================================== -->
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>
 
24
            nbAdd = atomsAutoloadAdd(modules[,section])
 
25
        </synopsis>
 
26
    </refsynopsisdiv>
 
27
    <!-- ===================================================================== -->
 
28
    <!-- Parameters -->
 
29
    <!-- ===================================================================== -->
 
30
    <refsection>
 
31
        <title>Arguments</title>
 
32
        <variablelist>
 
33
            <!-- 1st input parameter -->
 
34
            <varlistentry>
 
35
                <term>modules</term>
 
36
                <listitem>
 
37
                    <para>
 
38
                        mx1, mx2 or mx3 Matrix of strings:
 
39
                    </para>
 
40
                    <informaltable border="1">
 
41
                        <!-- Technical name -->
 
42
                        <tr>
 
43
                            <td>
 
44
                                <emphasis>1st Col.</emphasis>
 
45
                            </td>
 
46
                            <td>
 
47
                                <emphasis role="strong">Technical name</emphasis>
 
48
                            </td>
 
49
                            <td>
 
50
                                Mandatory
 
51
                            </td>
 
52
                            <td>
 
53
                            </td>
 
54
                        </tr>
 
55
                        <!-- Version -->
 
56
                        <tr>
 
57
                            <td>
 
58
                                <emphasis>2nd Col.</emphasis>
 
59
                            </td>
 
60
                            <td>
 
61
                                <emphasis role="strong">Version</emphasis>
 
62
                            </td>
 
63
                            <td>
 
64
                                Optional
 
65
                            </td>
 
66
                            <td>
 
67
                                If this field is empty or is not present,
 
68
                                the most recent version is used
 
69
                            </td>
 
70
                        </tr>
 
71
                        <!-- Section -->
 
72
                        <tr>
 
73
                            <td>
 
74
                                <emphasis>3rd Col.</emphasis>
 
75
                            </td>
 
76
                            <td>
 
77
                                <emphasis role="strong">Installed section</emphasis>
 
78
                            </td>
 
79
                            <td>
 
80
                                Optional
 
81
                            </td>
 
82
                            <td>
 
83
                                If this field is empty or is not present,
 
84
                                and <literal>module</literal> is installed in both "user" and
 
85
                                "allusers" sections, the section of autoload list is used.
 
86
                            </td>
 
87
                        </tr>
 
88
                    </informaltable>
 
89
                </listitem>
 
90
            </varlistentry>
 
91
            <!-- 2nd input parameter -->
 
92
            <varlistentry>
 
93
                <term>section</term>
 
94
                <listitem>
 
95
                    <para>
 
96
                        This argument controls which autoload list is changed.
 
97
                    </para>
 
98
                    <para>
 
99
                        <literal>section</literal> is a single-string and its value should be :
 
100
                    </para>
 
101
                    <itemizedlist>
 
102
                        <listitem>
 
103
                            <para>
 
104
                                <literal>"allusers"</literal>: modules are added to the
 
105
                                "allusers" autoload list and all users of scilab are affected.
 
106
                            </para>
 
107
                        </listitem>
 
108
                        <listitem>
 
109
                            <para>
 
110
                                <literal>"user"</literal>: modules are added to the
 
111
                                "user" autoload list and only the current user is affected.
 
112
                            </para>
 
113
                        </listitem>
 
114
                    </itemizedlist>
 
115
                    <para>
 
116
                        If SCI/contrib is write accessible, "allusers" is the default value.
 
117
                        Otherwise, the default value is "user".
 
118
                    </para>
 
119
                </listitem>
 
120
            </varlistentry>
 
121
            <!-- output parameter -->
 
122
            <varlistentry>
 
123
                <term>nbAdd</term>
 
124
                <listitem>
 
125
                    <para>
 
126
                        An integer : the number of modules successfully added.
 
127
                    </para>
 
128
                </listitem>
 
129
            </varlistentry>
 
130
        </variablelist>
 
131
    </refsection>
 
132
    <!-- ===================================================================== -->
 
133
    <!-- Description -->
 
134
    <!-- ===================================================================== -->
 
135
    <refsection>
 
136
        <title>Description</title>
 
137
        <para>
 
138
            
 
139
        </para>
 
140
    </refsection>
 
141
    <!-- ===================================================================== -->
 
142
    <!-- Examples -->
 
143
    <!-- ===================================================================== -->
 
144
    <refsection>
 
145
        <title>Examples</title>
 
146
        <programlisting role="example"><![CDATA[
147
147
 
148
148
atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
149
149
atomsSetConfig("autoloadAddAfterInstall","False");
169
169
atomsAutoloadList()
170
170
 
171
171
 ]]></programlisting>
172
 
  </refsection>
173
 
  <!-- ===================================================================== -->
174
 
  <!-- See also -->
175
 
  <!-- ===================================================================== -->
176
 
  <refsection role="see also">
177
 
    <title>See Also</title>
178
 
    <simplelist type="inline">
179
 
      <member>
180
 
        <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
181
 
      </member>
182
 
      <member>
183
 
        <link linkend="atomsAutoloadList">atomsAutoloadList</link>
184
 
      </member>
185
 
    </simplelist>
186
 
  </refsection>
187
 
  <!-- ===================================================================== -->
188
 
  <!-- Authors -->
189
 
  <!-- ===================================================================== -->
 
172
    </refsection>
 
173
    <!-- ===================================================================== -->
 
174
    <!-- See also -->
 
175
    <!-- ===================================================================== -->
 
176
    <refsection role="see also">
 
177
        <title>See Also</title>
 
178
        <simplelist type="inline">
 
179
            <member>
 
180
                <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
 
181
            </member>
 
182
            <member>
 
183
                <link linkend="atomsAutoloadList">atomsAutoloadList</link>
 
184
            </member>
 
185
        </simplelist>
 
186
    </refsection>
 
187
    <!-- ===================================================================== -->
 
188
    <!-- Authors -->
 
189
    <!-- ===================================================================== -->
190
190
</refentry>