source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/AllResources/.ls/_control_.html @ 904

Last change on this file since 904 was 904, checked in by garnier, 16 years ago

ajout de la doc
File size: 4.6 KB
Line 
1<html><head><title>Commands in /control/</title></head>
2<body bgcolor="#ffffff"><h2>/control/</h2><p>
3UI control commands.<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6</dl><p><hr><p>
7<h2>Commands : </h2><dl>
8<p><br><p><dt><b>execute [<i>fileName</i>]</b>
9<p><dd>
10Execute a macro file.<br>
11<p><dd>Available at all Geant4 states.
12<p><dd>Parameters<table border=1>
13<tr><td>fileName
14<td>type s
15<td><td></table>
16<p><br><p><dt><b>loop [<i>macroFile</i>] [<i>counterName</i>] [<i>initialValue</i>] [<i>finalValue</i>] [<i>stepSize</i>]</b>
17<p><dd>
18Execute a macro file more than once.<br>
19Loop counter can be used as an aliased variable.<br>
20<p><dd>Available at all Geant4 states.
21<p><dd>Parameters<table border=1>
22<tr><td>macroFile
23<td>type s
24<td><td><tr><td>counterName
25<td>type s
26<td><td><tr><td>initialValue
27<td>type d
28<td><td><tr><td>finalValue
29<td>type d
30<td><td><tr><td>stepSize
31<td>type d
32<td>Omittable : default value = 1
33<td></table>
34<p><br><p><dt><b>foreach [<i>macroFile</i>] [<i>counterName</i>] [<i>valueList</i>]</b>
35<p><dd>
36Execute a macro file more than once.<br>
37Loop counter can be used as an aliased variable.<br>
38Values must be separated by a space.<br>
39<p><dd>Available at all Geant4 states.
40<p><dd>Parameters<table border=1>
41<tr><td>macroFile
42<td>type s
43<td><td><tr><td>counterName
44<td>type s
45<td><td><tr><td>valueList
46<td>type s
47<td><td></table>
48<p><br><p><dt><b>suppressAbortion [<i>level</i>]</b>
49<p><dd>
50Suppress the program abortion caused by G4Exception.<br>
51Suppression level = 0 : no suppression<br>
52                  = 1 : suppress during EventProc state<br>
53                  = 2 : full suppression, i.e. no abortion by G4Exception<br>
54When abortion is suppressed, you will get error messages issued by G4Exception,<br>
55and there is NO guarantee for the correct result after the G4Exception error message.<br>
56<p><dd>Range : level &gt;= 0 &amp;&amp; level &lt;= 2
57<p><dd>Available at all Geant4 states.
58<p><dd>Parameters<table border=1>
59<tr><td>level
60<td>type i
61<td>Omittable : default value = 0
62<td></table>
63<p><br><p><dt><b>verbose [<i>switch</i>]</b>
64<p><dd>
65Applied command will also be shown on screen.<br>
66This command is useful with MACRO file.<br>
67  0 : silent<br>
68  1 : only the valid commands are shown.<br>
69  2 : comment lines are also shown (default).<br>
70<p><dd>Range : switch &gt;= 0 &amp;&amp; switch &lt;=2
71<p><dd>Available at all Geant4 states.
72<p><dd>Parameters<table border=1>
73<tr><td>switch
74<td>type i
75<td>Omittable : default value = 2
76<td></table>
77<p><br><p><dt><b>saveHistory [<i>fileName</i>]</b>
78<p><dd>
79Store command history to a file.<br>
80Defaul file name is G4history.macro.<br>
81<p><dd>Available at all Geant4 states.
82<p><dd>Parameters<table border=1>
83<tr><td>fileName
84<td>type s
85<td>Omittable : default value = G4History.macro
86<td></table>
87<p><br><p><dt><b>stopSavingHistory</b>
88<p><dd>
89Stop saving history file.<br>
90<p><dd>Available at all Geant4 states.
91<p><br><p><dt><b>alias [<i>aliasName</i>] [<i>aliasValue</i>]</b>
92<p><dd>
93Set an alias.<br>
94String can be aliased by this command.<br>
95The string may contain one or more spaces,<br>
96the string must be enclosed by double quotes (").<br>
97To use an alias, enclose the alias name with<br>
98parenthis "{" and "}".<br>
99<p><dd>Available at all Geant4 states.
100<p><dd>Parameters<table border=1>
101<tr><td>aliasName
102<td>type s
103<td><td><tr><td>aliasValue
104<td>type s
105<td><td></table>
106<p><br><p><dt><b>unalias [<i>aliasName</i>]</b>
107<p><dd>
108Remove an alias.<br>
109<p><dd>Available at all Geant4 states.
110<p><dd>Parameters<table border=1>
111<tr><td>aliasName
112<td>type s
113<td><td></table>
114<p><br><p><dt><b>listAlias</b>
115<p><dd>
116List aliases.<br>
117<p><dd>Available at all Geant4 states.
118<p><br><p><dt><b>shell [<i></i>]</b>
119<p><dd>
120Execute a (Unix) SHELL command.<br>
121<p><dd>Available at all Geant4 states.
122<p><dd>Parameters<table border=1>
123<tr><td>
124<td>type s
125<td><td></table>
126<p><br><p><dt><b>manual [<i>dirPath</i>]</b>
127<p><dd>
128Display all of sub-directories and commands.<br>
129Directory path should be given by FULL-PATH.<br>
130<p><dd>Available at all Geant4 states.
131<p><dd>Parameters<table border=1>
132<tr><td>dirPath
133<td>type s
134<td>Omittable : default value = /
135<td></table>
136<p><br><p><dt><b>createHTML [<i>dirPath</i>]</b>
137<p><dd>
138Generate HTML files for all of sub-directories and commands.<br>
139Directory path should be given by FULL-PATH.<br>
140<p><dd>Available at all Geant4 states.
141<p><dd>Parameters<table border=1>
142<tr><td>dirPath
143<td>type s
144<td>Omittable : default value = /
145<td></table>
146<p><br><p><dt><b>maximumStoredHistory [<i>max</i>]</b>
147<p><dd>
148Set maximum number of stored UI commands.<br>
149<p><dd>Available at all Geant4 states.
150<p><dd>Parameters<table border=1>
151<tr><td>max
152<td>type i
153<td>Omittable : default value = 20
154<td></table>
155</dl></body></html>
Note: See TracBrowser for help on using the repository browser.