* Bug 16624 fixed: fullfile() ignored forced final filesep
[scilab.git] / scilab / modules / functions / help / ja_JP / libraries / genlib.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) ????-2008 - INRIA
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17
18 <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="ja" xml:id="genlib">
19
20     <refnamediv>
21
22         <refname>genlib</refname>
23
24         <refpurpose>指定したディレクトリの関数からライブラリを構築する </refpurpose>
25
26     </refnamediv>
27
28     <refsynopsisdiv>
29
30         <title>呼び出し手順</title>
31
32         <synopsis>genlib(lib_name [[,dir_name, [ Force [,verb [,Names]]]])
33
34             genlib(lib_name [,path=dir_name] [,verbose=verb] [,force=Force] [,names=Names])
35
36         </synopsis>
37
38     </refsynopsisdiv>
39
40     <refsection>
41
42         <title>引数</title>
43
44         <variablelist>
45
46             <varlistentry>
47
48                 <term>lib_name:  </term>
49
50                 <listitem>
51
52                     <para>Scilab文字列.  (再)作成するライブラリの変数名.</para>
53
54                 </listitem>
55
56             </varlistentry>
57
58             <varlistentry>
59
60                 <term>dir_name:  </term>
61
62                 <listitem>
63
64                     <para>Scilab文字列.
65
66                         <literal>.sci</literal>-ファイルを探すディレクトリの名前.
67
68                     </para>
69
70                 </listitem>
71
72             </varlistentry>
73
74             <varlistentry>
75
76                 <term>Force</term>
77
78                 <listitem>
79
80                     <para>
81
82                         論理値 (デフォルト値は <literal>%f</literal>).
83
84                         sci-ファイルの再コンパイルを強制的に行う場合,
85
86                         <literal>%t</literal>に設定してください.
87
88                     </para>
89
90                 </listitem>
91
92             </varlistentry>
93
94             <varlistentry>
95
96                 <term>verb</term>
97
98                 <listitem>
99
100                     <para>
101
102                         論理値 (デフォルト値は <literal>%f</literal>).
103
104                         情報を取得するには <literal>%t</literal> に設定してください.
105
106                     </para>
107
108                 </listitem>
109
110             </varlistentry>
111
112             <varlistentry>
113
114                 <term>Names</term>
115
116                 <listitem>
117
118                     <para>文字列のベクトルで, ライブラリに含まれる
119
120                         関数の名前です.
121
122                         デフォルトで全ての sci-ファイルが取得されます.
123
124                     </para>
125
126                 </listitem>
127
128             </varlistentry>
129
130         </variablelist>
131
132     </refsection>
133
134     <refsection>
135
136         <title>説明</title>
137
138         <para>
139
140             <literal>dir_name</literal>にある各<literal>.sci</literal>ファイル
141
142             (または<literal>Names</literal>引数で指定されたファイルのみ)について,
143
144             <literal>genlib</literal>は<literal>exec</literal>を
145
146             実行し,対応する<literal>.bin</literal>ファイルに関数を保存します.
147
148             <literal>.sci</literal>ファイルにはScilab関数以外のものを含んでは
149
150             いけません.
151
152             ある<literal>.bin</literal>ファイルが対応する<literal>.sci</literal>ファイルよりも
153
154             新しい場合, <literal>genlib</literal>はこのファイルを変換/保存しません.
155
156         </para>
157
158         <para>
159
160             このデフォルトの動作は<literal>force</literal>が指定され,
161
162             <literal>%t</literal> に設定された場合に変更できます.
163
164             この場合, 各<literal>.sci</literal>ファイル毎に常に再コンパイルが
165
166             行われます.
167
168         </para>
169
170         <para>
171
172             全ての<literal>.sci</literal> ファイルが処理された場合,
173
174             <literal>genlib</literal>は<literal>lib_name</literal>という
175
176             名前のライブラリ変数を作成し,
177
178             <literal>dir_name</literal>の中のファイル<literal>lib</literal>に
179
180             この変数を保存します.
181
182             Scilab変数
183
184             <literal>lib_name</literal>が保護されていない場合
185
186             (<link linkend="predef">predef</link>参照),
187
188             この変数は更新されます.
189
190         </para>
191
192         <para>
193
194             <literal>verbose</literal> に <literal>%t</literal>が
195
196             指定された場合, 構築処理中に情報が表示されます.
197
198         </para>
199
200         <para>
201
202             <literal>dir_name</literal> 引数が指定されない場合に,
203
204             Scilab変数<literal>lib_name</literal>が存在し,
205
206             それがライブラリの場合,
207
208             dir_name は,
209
210             <literal>lib_name</literal>ライブラリパスに等しく
211
212             設定されます (更新モード).
213
214         </para>
215
216     </refsection>
217
218     <refsection>
219
220         <title>制約</title>
221
222         <para>
223
224             Scilab は, ファイル<literal>foo.sci</literal>が,
225
226             少なくとも<literal>foo</literal>という名前の関数を
227
228             定義すると仮定します.
229
230             補助関数が含まれる場合,これらは
231
232             関数<literal>foo</literal>が参照された後でのみ
233
234             Scilabから既知となります.
235
236         </para>
237
238     </refsection>
239
240     <refsection role="see also">
241
242         <title>参照</title>
243
244         <simplelist type="inline">
245
246             <member>
247
248                 <link linkend="getd">getd</link>
249
250             </member>
251
252             <member>
253
254                 <link linkend="exec">exec</link>
255
256             </member>
257
258             <member>
259
260                 <link linkend="save">save</link>
261
262             </member>
263
264             <member>
265
266                 <link linkend="lib">lib</link>
267
268             </member>
269
270         </simplelist>
271
272     </refsection>
273
274 </refentry>
275