summaryrefslogtreecommitdiff
path: root/modules/atoms/help/en_US/atomsSaveConfig.xml
blob: 8dc583db7870028c5b337307a7b9864ce28c7f48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) DIGITEO - Simon GARESTE <simon.gareste@scilab.org>
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="atomsSaveConfig">
    <refnamediv>
        <refname>atomsSaveConfig</refname>
        <refpurpose>Make a backup of the configuration file</refpurpose>
    </refnamediv>
    <!-- ===================================================================== -->
    <!-- Calling Sequence -->
    <!-- ===================================================================== -->
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            atomsSaveConfig([force])
        </synopsis>
    </refsynopsisdiv>
    <!-- ===================================================================== -->
    <!-- Parameters -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>force</term>
                <listitem>
                    <para>
                        <literal>force</literal> is a boolean. If set to %T (True), previously existing config.bak file
                        in SCIHOME/.atoms will be erased. Default value is %F (False);
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Examples -->
    <!-- ===================================================================== -->
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
atomsSaveConfig(%T);
ls(atomsPath("system","user"));
]]></programlisting>
    </refsection>
    <!-- ===================================================================== -->
    <!-- See also -->
    <!-- ===================================================================== -->
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="atomsRestoreConfig">atomsRestoreConfig</link>
            </member>
            <member>
                <link linkend="atomsSetConfig">atomsSetConfig</link>
            </member>
            <member>
                <link linkend="atomsGetConfig">atomsGetConfig</link>
            </member>
        </simplelist>
    </refsection>
    <!-- ===================================================================== -->
    <!-- Authors -->
    <!-- ===================================================================== -->
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.4.0</revnumber>
                <revdescription>Function added</revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>