Linux: add a debug option to launch Scilab under rr
[scilab.git] / scilab / modules / core / help / ru_RU / scilab.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
3     xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
4     xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
5     xmlns:scilab="http://www.scilab.org" xml:id="scilab" xml:lang="ru">
6     <refnamediv>
7         <refname>scilab</refname>
8         <refpurpose>
9             главный файл-сценарий для запуска Scilab'а и различных инструментов
10         </refpurpose>
11     </refnamediv>
12     <refsynopsisdiv>
13         <title>Синтаксис</title>
14         <synopsis>
15 scilab &lt;Options&gt;
16         </synopsis>
17     </refsynopsisdiv>
18     <refsection role="arguments">
19         <title>Аргументы</title>
20         <variablelist>
21             <varlistentry>
22                 <term>-args arg№1 arg№2 ..</term>
23                 <listitem>
24                     <para>
25                         Эта опция позволяет переслать  данные в сессию Scilab'а:
26                         <itemizedlist>
27                             <listitem>
28                               Последовательность данных, разделённых одним или несколькими пробелами.
29                             </listitem>
30                             <listitem>
31                               Выражение между двойными кавычками является единым куском данных.
32                             </listitem>
33                             <listitem>
34                               Чтобы внести двойные кавычки в данные, запишите <literal>\"</literal> вместо <literal>"</literal>.
35                             </listitem>
36                             <listitem>
37                               Одинарная кавычка <literal>'</literal> является обычным символом. У неё нет специального значения.
38                             </listitem>
39                         </itemizedlist>
40                     </para>
41                     <para>
42                       Внутри открытой сессии эти данные могут быть получены  виде раздельных строк с помощью <link linkend="sciargs">sciargs()</link>.
43                      </para>
44                      <para>
45                       Пример:
46                         <screen><![CDATA[C:\Users\Me> scilex -nb -noatomsautoload -args "Привет, \"%USERNAME%\"" 1.2345 \"%cd%\"]]></screen>
47                         <programlisting><![CDATA[
48 // Внутри открытой сессии:
49 a = sciargs()
50 i = find(a=="-args")
51 a(i+1)
52 evstr(a(i+2))*2
53 "Эта сессия была запущена из " + a(i+3)
54                         ]]>
55                         </programlisting>
56                         <screen><![CDATA[
57 --> // Внутри открытой сессии:
58 --> a = sciargs()
59  a  =
60 !c:\SCIdir\bin\scilex  -nw  -nb  -noatomsautoload  -args  Привет, "Иван"  1.2345  "C:\Users\Me" !
61
62 --> i = find(a=="-args")
63  i  =
64     5.
65
66 --> a(i+1)
67  ans  =
68  Привет, "Иван"
69
70 --> evstr(a(i+2))*2
71  ans  =
72     2.469
73
74 --> "Эта сессия была запущена из " + a(i+3)
75  ans  =
76  Эта сессия была запущена из "C:\Users\Me"
77 ]]></screen>
78                      </para>
79                      <para>
80                      <note>
81                        Безопаснее использовать <literal>-args</literal> в качестве <emphasis role="italic">последней</emphasis> опции командной строки.
82                      </note>
83                      </para>
84                 </listitem>
85             </varlistentry>
86             <varlistentry>
87                 <term>-display Display</term>
88                 <listitem>
89                     <para>
90                         Только для использования в системах Xwindow для установки специфичного
91                         дисплея X-сервера. Дисплей по умолчанию -- unix:0.0.
92                     </para>
93                     <para>
94                         <literal>-display</literal> можно сократить как <literal>-d</literal>.
95                     </para>
96                 </listitem>
97             </varlistentry>
98             <varlistentry>
99                 <term>-e Instructions</term>
100                 <listitem>
101                     <para>
102                         По окончании запуска всей сессии, этот вариант
103                         <itemizedlist>
104                             <listitem>
105                                 <para>
106                                   устанавливает текущий рабочий каталог в каталог оболочки, из которой Scilab был запущен.
107                                   Пожалуйста, смотрите пример, приведенный здесь ниже для опции <literal>-f</literal>. Затем,
108                                 </para>
109                             </listitem>
110                             <listitem>
111                                 <para>эта опция выполняет инструкции Scilab <literal>Instructions</literal>, указанные в строке. Пример :
112                                     <screen><![CDATA[ scilab-cli -e  "disp(\"Привет\"); a=%pi+%i; disp(exp(a)); exit;" -nb]]></screen>
113                                 </para>
114                             </listitem>
115                         </itemizedlist>
116                     </para>
117                     <warning>
118                         Опции <literal>-e</literal> и <literal>-f</literal> взаимоисключающие.
119                     </warning>
120                 </listitem>
121             </varlistentry>
122             <varlistentry>
123                 <term>-f file</term>
124                 <listitem>
125                     <para>
126                         Если эта опцпия используется, то в начале сессии Scilab, после исполнения файлов запуска Sciblab и
127                         пользовательских файлов запуска, и после установки пользовательских настроек, включая настройки рабочей директории,
128                         <itemizedlist>
129                             <listitem>
130                                 <para>
131                                     текущая рабочая директория Scilab  устаровлена в каталоге оболочки, из которой Scilab был запущен. Например,
132                                     <screen><![CDATA[ D:\users\me\scilab\dev> C:\scilab-5.5.2\bin\scilex -f ..\test.sce]]></screen>
133                                     будет исполнять <literal>cd("D:\users\me\scilab\dev")</literal>.
134                                 </para>
135                             </listitem>
136                             <listitem>
137                                 <para>
138                                     Scilab-сценарий <literal>file</literal> выполнен. Если относительный путь используется
139                                     (по умолчанию <literal>.\</literal> или как <literal>..\</literal> в примере выше), то
140                                     он отсылается в новую рабочую директорию Scilab.
141                                 </para>
142                             </listitem>
143                         </itemizedlist>
144                     </para>
145                   <para>Файл с расширением <literal>.xcos</literal> будет открыт в Xcos.</para>
146                 </listitem>
147             </varlistentry>
148             <varlistentry>
149                 <term>-quit</term>
150                 <listitem>
151                     <para>
152                         Эта опция заставляет Scilab всегда выходить после инструкций, переданных вместе с опцией
153                         <literal>-e</literal>, или  сценарий, на который ссылается оция <literal>-f</literal>,
154                         будет исполнен, даже в случае ошибки времени исполнения. Эта опция всегда должна использоваться
155                         в режиме пакетной обработки. Она игнорируется, если нет ни опции <literal>-e</literal>
156                         ни опции <literal>-f</literal>.
157                     </para>
158                 </listitem>
159             </varlistentry>
160             <varlistentry>
161                 <term>-l lang</term>
162                 <listitem>
163                     <para>
164                         Если есть эта опция, то она фиксирует язык пользователя.
165                         <emphasis>lang</emphasis> может быть: <emphasis>ca_ES de_DE en_US es_ES
166                             fr_FR ja_JP pt_BR ru_RU zh_CN zh_TW
167                         </emphasis>
168                         (начиная с Scilab 5.2).
169                     </para>
170                     <para>
171                         Другими возможными значениями <literal>lang</literal> (для совместимости) являются <literal>'fr'</literal>
172                         для французского и <literal>'en'</literal> для английского языка. По умолчанию язык английский.
173                         Это значение по умолчанию зафиксировано в файле <literal>scilab.start</literal>.
174                     </para>
175                     <para>
176                         В некоторых системах для правильного отображения шрифтов в кодировке UTF-8 локали должны быть откомпилированы.
177                     </para>
178                     <para>Scilab также может быть запущен следующим образом:</para>
179                     <screen><![CDATA[ LANG=ja_JP scilab
180  #  то же, что и
181  scilab -l ja_JP
182 ]]></screen>
183                 </listitem>
184             </varlistentry>
185             <varlistentry>
186                 <term>-nb</term>
187                 <listitem>
188                     <para>
189                         "no banner" : Если есть эта опция, то сообщение о загрузке Scilab'а не будет отображаться.
190                     </para>
191                 </listitem>
192             </varlistentry>
193             <varlistentry>
194                 <term>-ns</term>
195                 <listitem>
196                     <para>
197                         "No Startup files" :
198                         Если есть эта опция, то файл запуска <literal>SCI/etc/scilab.start</literal> и пользовательские
199                         файлы запуска <literal>SCIHOME/.scilab</literal> и <literal>SCIHOME/scilab.ini</literal> не исполняются.
200                     </para>
201                     <para>
202                         Эта опция отключит многие возможности Scilab'а (используйте, если вы знаете что делаете).
203                     </para>
204                 </listitem>
205             </varlistentry>
206             <varlistentry>
207                 <term>-nouserstartup</term>
208                 <listitem>
209                     <para>
210                         Если есть эта опция, то пользовательские файлы запуска <literal>SCIHOME/.scilab</literal> и
211                         <literal>SCIHOME/scilab.ini</literal> не исполняются.
212                     </para>
213                 </listitem>
214             </varlistentry>
215             <varlistentry>
216                 <term>-noatomsautoload</term>
217                 <listitem>
218                     <para>
219                         Если есть эта опция, то ранее установленные модули ATOMS не загружаются для данной сессии.
220                     </para>
221                 </listitem>
222             </varlistentry>
223             <varlistentry>
224                 <term>-nw</term>
225                 <listitem>
226                     <para>
227                         Если есть эта опция,то Scilab запускается как командная строка с улучшенными возможностями (графические окна, экспорт, xcos, scinotes, справочная система, ...).
228                     </para>
229                     <para>
230                         Начиная с Scilab 5.2:
231                         <itemizedlist>
232                             <listitem>
233                                 <para>
234                                     конвейеры доступны во всех операционных системах (см. примеры для дополнительной
235                                     информации).
236                                 </para>
237                             </listitem>
238                             <listitem>
239                                 <para>
240                                     Дистрибутив Scilab также предоставляет специальный бинарный файл, который
241                                     делает то же, что и <literal>-nw</literal>:
242                                     <listitem>
243                                         Windows: <literal>WScilex-cli.exe</literal>.
244                                     </listitem>
245                                     <listitem>
246                                         <literal>scilab-adv-cli</literal> (Интерпретатор Scilab с улучшенной командной строкой).
247                                     </listitem>
248                                 </para>
249                             </listitem>
250                         </itemizedlist>
251                     </para>
252                 </listitem>
253             </varlistentry>
254             <varlistentry>
255                 <term>-nwni / -nogui</term>
256                 <listitem>
257                     <important>
258                         Этот режим не загружает виртуальную машину Java (быстрее загружается и использует меньше памяти).
259                     </important>
260                     <warning>
261                         Если есть эта опция, то Scilab запускается как командная строка без улучшенных возможностей (графических окон, экспорта, xcos, scinotes, справочной системы, ...).
262                     </warning>
263                     <para>
264                         Начиная с Scilab 5.2:
265                         <itemizedlist>
266                           <listitem>
267                             <para>
268                               конвейеры доступны во всех операционных системах (см. примеры для дополнительной
269                               информации).
270                             </para>
271                           </listitem>
272                           <listitem>
273                             <para>
274                                   Дистрибутив Scilab также предоставляет специальный бинарный файл, который
275                                   делает то же, что и <literal>-nwni</literal>: 
276                             <itemizedlist>
277                                 <listitem>
278                                     Windows: <literal>Scilex.exe</literal>.
279                                 </listitem>
280                                 <listitem>
281                                     Others: <literal>scilab-cli</literal> (Интерпретатор Scilab с улучшенной командной строкой).
282                                 </listitem>
283                             </itemizedlist>
284                             </para>
285                           </listitem>
286                         </itemizedlist>
287                     </para>
288                 </listitem>
289             </varlistentry>
290             <varlistentry>
291                 <term>-scihome dir</term>
292                 <listitem>
293                     <para>Forces SCIHOME to the <literal>dir</literal> directory. If the path
294                       includes some white space, it must be specified between double-quotes (no
295                       single quotes!).
296                       if <literal>dir</literal> is a relative path, <literal>dir</literal> is add to parent standard SCIHOME folder.
297                       On Windows: %USERPROFILE%\AppData\Roaming\Scilab\<literal>dir</literal>
298                       On Linux/MacOS: ~/.Scilab/<literal>dir</literal>
299                     </para>
300                 </listitem>
301             </varlistentry>
302             <varlistentry>
303                 <term>--texmacs</term>
304                 <listitem>
305                     <para>Эта опция предназначена для TeXMacs.</para>
306                     <para>Пожалуйста, установите ATOMS-модуль TeXMacs:
307                         <code>atomsInstall('texmacs')</code>
308                     </para>
309                 </listitem>
310             </varlistentry>
311             <varlistentry>
312                 <term>-version</term>
313                 <listitem>
314                     <para>Эта опция выводит на экран версию продукта.</para>
315                 </listitem>
316             </varlistentry>
317         </variablelist>
318     </refsection>
319
320     <refsection role="arguments">
321         <title>Дополнительные опции для Unix/Linux и Mac OS X</title>
322         <para>Совет: используйте эти параметры в дереве исходников Scilab'а.</para>
323         <variablelist>
324             <varlistentry>
325                 <term>-debug</term>
326                 <listitem>
327                     <para>
328                         Запуск Scilab'а в отладчике gdb.
329                     </para>
330                     <para>
331                         Определите переменную  <literal>SCILAB_GDB_OPT</literal> для добавления
332                         пользовательских настроек в gdb.
333                     </para>
334                 </listitem>
335             </varlistentry>
336             <varlistentry>
337                 <term>-debug-rr</term>
338                 <listitem>
339                     <para>Запуск Scilab'а в <ulink url="https://rr-project.org/">rr</ulink>.</para>
340                 </listitem>
341             </varlistentry>
342             <varlistentry>
343                 <term>-debug-kdbg</term>
344                 <listitem>
345                     <para>Запуск Scilab'а в kdbg.</para>
346                 </listitem>
347             </varlistentry>
348             <varlistentry>
349                 <term>-profiling</term>
350                 <listitem>
351                     <para>Запуск Scilab'а в valgrind.</para>
352                     <para>
353                         Определите переменную  <literal>SCILAB_VALGRIND_OPT</literal>  для
354                         добавления пользовательских настроек в valgrind (и отмены существующих
355                         опций valgrind).
356                     </para>
357                 </listitem>
358             </varlistentry>
359             <varlistentry>
360                 <term>-profiling-visu</term>
361                 <listitem>
362                     <para>Запуск Scilab'а в callgrind.</para>
363                     <para>
364                         Определите переменную <literal>SCILAB_VALGRIND_OPT</literal> для
365                         добавления пользовательских настроек в callgrind (и отмены существующих
366                         опций callgrind).
367                     </para>
368                 </listitem>
369             </varlistentry>
370             <varlistentry>
371                 <term>-electric-fence</term>
372                 <listitem>
373                     <para>Запуск Scilab'а в Electric Fence.</para>
374                 </listitem>
375             </varlistentry>
376         </variablelist>
377     </refsection>
378
379     <refsection role="description">
380         <title>Описание переменных окружения</title>
381         <variablelist>
382             <varlistentry>
383                 <term>SCIVERBOSE</term>
384                 <listitem>
385                     <para>
386                         Если есть эта переменная, то файл-сценарий начального запуска Scilab'а покажет
387                         отладочную информацию начального запуска. Используется главным образом для сообщения об
388                         ошибках и отладки.
389                     </para>
390                 </listitem>
391             </varlistentry>
392             <varlistentry>
393                 <term>JAVA_HOME</term>
394                 <listitem>
395                     <para>
396                         Определяет какую Java использовать. Например,
397                         <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> запустить Scilab с Java 7.
398                     </para>
399                 </listitem>
400             </varlistentry>
401             <varlistentry>
402                 <term>SCI_DISABLE_TK</term>
403                 <listitem>
404                     <para>Отключение возможностей Tk (не не Tcl).</para>
405                 </listitem>
406             </varlistentry>
407             <varlistentry>
408                 <term>SCI_JAVA_ENABLE_HEADLESS</term>
409                 <listitem>
410                     <para>
411                         Включить Java Headless VM (т. е. без возможностей графического пользовательского интерфейса).
412                     </para>
413                 </listitem>
414             </varlistentry>
415         </variablelist>
416     </refsection>
417     <refsection role="description">
418         <title>Опции виртуальной машины Java</title>
419         <warning>
420             Опции, описаные ниже бесполезны и будут удалены, если используется опция <literal>-nwni</literal>.
421         </warning>
422         <para>
423             Начиная с Scilab 5.0, графический пользовательский интерфейс (GUI) и встроенная
424             документация основаны на возможностях Java. В некоторых случаях может оказаться
425             важным править опции JVM (Виртуальная Машина Java).
426         </para>
427         <para>
428             Эти опции доступны в файле <emphasis>jvm_options.xml</emphasis>.
429         </para>
430         <para>
431             В версиях 5.0.X и 5.1.X этот файл хранится как
432             <emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>.
433         </para>
434         <para>
435             В версии &gt;= 5.2.0 этот файл доступен в
436             <emphasis>
437                 etc/jvm_options.xml
438             </emphasis>
439             .
440         </para>
441         <para>
442             <emphasis>
443                 По умолчанию в конфигурационном файле легко доступны следующие три опции:
444             </emphasis>
445         </para>
446         <variablelist>
447             <varlistentry>
448                 <term>-XmxXXXm</term>
449                 <listitem>
450                     <para>
451                         Эта опция устанавливает количество памяти, доступной для виртуальной Java-машины. По умолчанию выделено 256 МБ. Если вы меняете это значение, убедитесь, что оно не превышает память системы.
452                     </para>
453                     <para>
454                         Начиная с Scilab 5.4.0, это значение можно менять в меню настроек.
455                     </para>
456                 </listitem>
457             </varlistentry>
458             <varlistentry>
459                 <term>-Djava.compiler=JIT</term>
460                 <listitem>
461                     <para>
462                         Эта опция с аргументом <emphasis>JIT</emphasis> задействует оперативный
463                         Java-компилятор (JIT). Он включается по умолчанию. <emphasis>NONE</emphasis> отключает
464                         оперативный Java-компилятор и чрезвычайно уменьшает производительность.
465                     </para>
466                 </listitem>
467             </varlistentry>
468             <varlistentry>
469                 <term>-verbose:jni / -Xcheck:jni</term>
470                 <listitem>
471                     <para>
472                         Эти опции задействуют больше проверок и выход из вызовов интерфейса для прямого
473                         доступа из Java. Эти опции полезны в случае отладки и по умолчанию отключены, поскольку они уменьшают производительность.
474                     </para>
475                 </listitem>
476             </varlistentry>
477         </variablelist>
478         <para>
479             Доступно очень много опций. Они могут улучшить производительность, поменять взгляды и
480             отношение, изменить способы управления памятью... Смотрите:: <ulink url="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp">http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp</ulink>
481             или <ulink url="http://blogs.sun.com/watt/resource/jvm-options-list.html">http://blogs.sun.com/watt/resource/jvm-options-list.html</ulink>.
482         </para>
483     </refsection>
484     <refsection role="examples">
485         <title>Примеры</title>
486         <screen><![CDATA[
487 # Запустим Scilab в режиме профилирования без прикрепления gdb после каждого SIGSEGV.
488 # Мы находимся в оболочке Bash
489 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
490 scilab -profiling
491
492 # Запустим Scilab в режиме отладки без остановки после каждого SIGSEGV
493 # Сначала запишем небольшой файл команд
494 echo "handle SIGSEGV nostop" > debug.txt
495 # Теперь установим пользовательские опции
496 # Мы находимся в оболочке Bash
497 export SCILAB_GDB_OPT="--command=debug.txt"
498 # Запуск Scilab'а в режиме отладки
499 scilab -debug ]]></screen>
500         <para></para>
501         <screen><![CDATA[
502 # В GNU/Linux, Mac OS X или Unix:
503 $ echo "disp(%pi)"|scilab-cli
504 или
505 $ echo "disp(%pi)"|scilab -nwni
506
507 # Открыть только окно справки Scilab:
508 $ scilab-adv-cli -e "help()"
509 или
510 $ scilab -nw -e "help()"
511
512
513 # Scilab может быть использован написания сценариев:
514 echo "if 1&lt;>2 then exit(99) end"|scilab-cli
515 echo $? ]]></screen>
516     </refsection>
517     <refsection role="see also">
518         <title>Смотрите также</title>
519         <simplelist type="inline">
520             <member>
521                 <link linkend="startup">начальный запуск</link>
522             </member>
523             <member>
524                 <link linkend="sciargs">sciargs</link>
525             </member>
526             <member>
527                 <link linkend="getpid">getpid</link>
528             </member>
529             <member>
530                 <link linkend="getenv">getenv</link>
531             </member>
532             <member>
533                 <link linkend="getversion">getversion</link>
534             </member>
535             <member>
536                 <link linkend="consolebox">consolebox</link>
537             </member>
538             <member>
539                 <link linkend="exit">exit</link>
540             </member>
541         </simplelist>
542     </refsection>
543     <refsection role="history">
544         <title>История</title>
545         <revhistory>
546             <revision>
547                 <revnumber>5.4.0</revnumber>
548                 <revremark>добавлено -noatomsautoload.</revremark>
549             </revision>
550             <revision>
551                 <revnumber>5.4.1</revnumber>
552                 <revremark>
553                     введены отдельные сценарии scinotes и xcos.
554                     См.SEP #87.
555                 </revremark>
556             </revision>
557             <revision>
558                 <revnumber>6.0.0</revnumber>
559                 <revremark>
560                     Добавлена опция <literal>-quit</literal>. Опция <literal>-mem</literal> удалена.
561                 </revremark>
562             </revision>
563             <revision>
564                 <revnumber>6.0.1</revnumber>
565                 <revremark>
566                     <literal>-scihome</literal> option added.
567                 </revremark>
568             </revision>
569         </revhistory>
570     </refsection>
571     <!--add some kewywords -->
572     <refnamediv xml:id="wscilex"></refnamediv>
573     <refnamediv xml:id="wscilex-cli"></refnamediv>
574     <refnamediv xml:id="scilex"></refnamediv>
575     <refnamediv xml:id="scilab-cli"></refnamediv>
576     <refnamediv xml:id="scilab-adv-cli"></refnamediv>
577 </refentry>