add system_property("property_name")
[scilab.git] / scilab / modules / jvm / help / en_US / system_getproperty.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5
6   <TITLE>system_getproperty</TITLE>
7
8   <TYPE>Scilab Function</TYPE>
9
10   <DATE>$LastChangedDate: 2007-05-10 09:26:08 +0200$</DATE>
11
12   <SHORT_DESCRIPTION name="system_getproperty">gets the system property
13   indicated by a specified key.</SHORT_DESCRIPTION>
14
15   <CALLING_SEQUENCE>
16     <CALLING_SEQUENCE_ITEM>res=system_getproperty(key)</CALLING_SEQUENCE_ITEM>
17
18     <CALLING_SEQUENCE_ITEM>javaclasspath(path)</CALLING_SEQUENCE_ITEM>
19   </CALLING_SEQUENCE>
20
21   <PARAM>
22     <PARAM_INDENT>
23       <PARAM_ITEM>
24         <PARAM_NAME>res</PARAM_NAME>
25
26         <PARAM_DESCRIPTION>
27           <SP>: a string value</SP>
28         </PARAM_DESCRIPTION>
29       </PARAM_ITEM>
30
31       <PARAM_ITEM>
32         <PARAM_NAME>key</PARAM_NAME>
33
34         <PARAM_DESCRIPTION>
35           <SP>: a string</SP>
36         </PARAM_DESCRIPTION>
37       </PARAM_ITEM>
38     </PARAM_INDENT>
39   </PARAM>
40
41   <DESCRIPTION>
42     <P>gets the system property indicated by a specified key.</P>
43
44     <TABLE>
45       
46       <TABLE_NEW_ROW>
47         <TABLE_NEW_COLUMN>java.version</TABLE_NEW_COLUMN>
48         <TABLE_NEW_COLUMN>Java Runtime Environment version</TABLE_NEW_COLUMN>
49       </TABLE_NEW_ROW> 
50
51       <TABLE_NEW_ROW>
52         <TABLE_NEW_COLUMN>java.vendor</TABLE_NEW_COLUMN>
53         <TABLE_NEW_COLUMN>Java Runtime Environment vendor</TABLE_NEW_COLUMN>
54       </TABLE_NEW_ROW> 
55
56       <TABLE_NEW_ROW>
57         <TABLE_NEW_COLUMN>java.vendor.url</TABLE_NEW_COLUMN>
58         <TABLE_NEW_COLUMN>Java vendor URL</TABLE_NEW_COLUMN>
59       </TABLE_NEW_ROW> 
60
61       <TABLE_NEW_ROW>
62         <TABLE_NEW_COLUMN>java.home</TABLE_NEW_COLUMN>
63         <TABLE_NEW_COLUMN>Java installation directory</TABLE_NEW_COLUMN>
64       </TABLE_NEW_ROW> 
65
66       <TABLE_NEW_ROW>
67         <TABLE_NEW_COLUMN>java.vm.specification.version</TABLE_NEW_COLUMN>
68         <TABLE_NEW_COLUMN>Java Virtual Machine specification version</TABLE_NEW_COLUMN>
69       </TABLE_NEW_ROW> 
70
71       <TABLE_NEW_ROW>
72         <TABLE_NEW_COLUMN>java.vm.specification.vendor</TABLE_NEW_COLUMN>
73         <TABLE_NEW_COLUMN>Java Virtual Machine specification vendor</TABLE_NEW_COLUMN>
74       </TABLE_NEW_ROW> 
75
76       <TABLE_NEW_ROW>
77         <TABLE_NEW_COLUMN>java.vm.specification.name</TABLE_NEW_COLUMN>
78         <TABLE_NEW_COLUMN>Java Virtual Machine specification name</TABLE_NEW_COLUMN>
79       </TABLE_NEW_ROW> 
80
81       <TABLE_NEW_ROW>
82         <TABLE_NEW_COLUMN>java.vm.version</TABLE_NEW_COLUMN>
83         <TABLE_NEW_COLUMN>Java Virtual Machine implementation version</TABLE_NEW_COLUMN>
84       </TABLE_NEW_ROW> 
85
86       <TABLE_NEW_ROW>
87         <TABLE_NEW_COLUMN>java.vm.vendor</TABLE_NEW_COLUMN>
88         <TABLE_NEW_COLUMN>Java Virtual Machine implementation vendor</TABLE_NEW_COLUMN>
89       </TABLE_NEW_ROW> 
90
91       <TABLE_NEW_ROW>
92         <TABLE_NEW_COLUMN>java.vm.name</TABLE_NEW_COLUMN>
93         <TABLE_NEW_COLUMN>Java Virtual Machine implementation name</TABLE_NEW_COLUMN>
94       </TABLE_NEW_ROW> 
95
96       <TABLE_NEW_ROW>
97         <TABLE_NEW_COLUMN>java.specification.version</TABLE_NEW_COLUMN>
98         <TABLE_NEW_COLUMN>Java Runtime Environment specification version</TABLE_NEW_COLUMN>
99       </TABLE_NEW_ROW> 
100
101       <TABLE_NEW_ROW>
102         <TABLE_NEW_COLUMN>java.specification.vendor</TABLE_NEW_COLUMN>
103         <TABLE_NEW_COLUMN>Java Runtime Environment specification vendor</TABLE_NEW_COLUMN>
104       </TABLE_NEW_ROW> 
105
106       <TABLE_NEW_ROW>
107         <TABLE_NEW_COLUMN>java.specification.name</TABLE_NEW_COLUMN>
108         <TABLE_NEW_COLUMN>Java Runtime Environment specification name</TABLE_NEW_COLUMN>
109       </TABLE_NEW_ROW> 
110
111       <TABLE_NEW_ROW>
112         <TABLE_NEW_COLUMN>java.class.version</TABLE_NEW_COLUMN>
113         <TABLE_NEW_COLUMN>Java class format version number</TABLE_NEW_COLUMN>
114       </TABLE_NEW_ROW> 
115
116       <TABLE_NEW_ROW>
117         <TABLE_NEW_COLUMN>java.class.path</TABLE_NEW_COLUMN>
118         <TABLE_NEW_COLUMN>Java class path</TABLE_NEW_COLUMN>
119       </TABLE_NEW_ROW> 
120
121       <TABLE_NEW_ROW>
122         <TABLE_NEW_COLUMN>java.library.path</TABLE_NEW_COLUMN>
123         <TABLE_NEW_COLUMN>List of paths to search when loading libraries</TABLE_NEW_COLUMN>
124       </TABLE_NEW_ROW> 
125
126       <TABLE_NEW_ROW>
127         <TABLE_NEW_COLUMN>java.io.tmpdir</TABLE_NEW_COLUMN>
128         <TABLE_NEW_COLUMN>Default temp file path</TABLE_NEW_COLUMN>
129       </TABLE_NEW_ROW> 
130
131       <TABLE_NEW_ROW>
132         <TABLE_NEW_COLUMN>java.compiler</TABLE_NEW_COLUMN>
133         <TABLE_NEW_COLUMN>Name of JIT compiler to use</TABLE_NEW_COLUMN>
134       </TABLE_NEW_ROW> 
135
136       <TABLE_NEW_ROW>
137         <TABLE_NEW_COLUMN>java.ext.dirs</TABLE_NEW_COLUMN>
138         <TABLE_NEW_COLUMN>Path of extension directory or directories</TABLE_NEW_COLUMN>
139       </TABLE_NEW_ROW> 
140
141       <TABLE_NEW_ROW>
142         <TABLE_NEW_COLUMN>os.name</TABLE_NEW_COLUMN>
143         <TABLE_NEW_COLUMN>Operating system name</TABLE_NEW_COLUMN>
144       </TABLE_NEW_ROW> 
145
146       <TABLE_NEW_ROW>
147         <TABLE_NEW_COLUMN>os.arch</TABLE_NEW_COLUMN>
148         <TABLE_NEW_COLUMN>Operating system architecture</TABLE_NEW_COLUMN>
149       </TABLE_NEW_ROW> 
150
151       <TABLE_NEW_ROW>
152         <TABLE_NEW_COLUMN>os.version</TABLE_NEW_COLUMN>
153         <TABLE_NEW_COLUMN>Operating system version</TABLE_NEW_COLUMN>
154       </TABLE_NEW_ROW> 
155
156       <TABLE_NEW_ROW>
157         <TABLE_NEW_COLUMN>file.separator</TABLE_NEW_COLUMN>
158         <TABLE_NEW_COLUMN>File separator ("/" on UNIX)</TABLE_NEW_COLUMN>
159       </TABLE_NEW_ROW> 
160
161       <TABLE_NEW_ROW>
162         <TABLE_NEW_COLUMN>path.separator</TABLE_NEW_COLUMN>
163         <TABLE_NEW_COLUMN>Path separator (":" on UNIX)</TABLE_NEW_COLUMN>
164       </TABLE_NEW_ROW> 
165
166       <TABLE_NEW_ROW>
167         <TABLE_NEW_COLUMN>line.separator Line separator</TABLE_NEW_COLUMN>
168         <TABLE_NEW_COLUMN>("\n" on UNIX)</TABLE_NEW_COLUMN>
169       </TABLE_NEW_ROW> 
170
171       <TABLE_NEW_ROW>
172         <TABLE_NEW_COLUMN>user.name</TABLE_NEW_COLUMN>
173         <TABLE_NEW_COLUMN>User's account name</TABLE_NEW_COLUMN>
174       </TABLE_NEW_ROW> 
175
176       <TABLE_NEW_ROW>
177         <TABLE_NEW_COLUMN>user.home</TABLE_NEW_COLUMN>
178         <TABLE_NEW_COLUMN>User's home directory</TABLE_NEW_COLUMN>
179       </TABLE_NEW_ROW> 
180
181       <TABLE_NEW_ROW>
182         <TABLE_NEW_COLUMN>user.dir</TABLE_NEW_COLUMN>
183         <TABLE_NEW_COLUMN>User's current working directory</TABLE_NEW_COLUMN>
184       </TABLE_NEW_ROW> 
185       
186     </TABLE>
187   </DESCRIPTION>
188
189   <EXAMPLE><![CDATA[system_getproperty('awt.toolkit')
190 system_getproperty('file.encoding')
191 system_getproperty('file.encoding.pkg')
192 system_getproperty('java.awt.graphicsenv=sun.awt.Win32GraphicsEnvironment')
193 system_getproperty('java.awt.printerjob=sun.awt.windows.WPrinterJob')
194 system_getproperty('java.class.path')
195 system_getproperty('java.class.version')
196 system_getproperty('java.endorsed.dirs')
197 system_getproperty('java.ext.dirs')
198 system_getproperty('java.home')
199 system_getproperty('java.io.tmpdir')
200 system_getproperty('java.library.path')
201 system_getproperty('java.runtime.name')
202 system_getproperty('java.runtime.version')
203 system_getproperty('java.specification.name')
204 system_getproperty('java.specification.vendor')
205 system_getproperty('java.specification.version')
206 system_getproperty('java.vendor')
207 system_getproperty('java.vendor.url')
208 system_getproperty('java.vendor.url.bug')
209 system_getproperty('java.version')
210 system_getproperty('java.vm.info')
211 system_getproperty('java.vm.name')
212 system_getproperty('java.vm.specification.name')
213 system_getproperty('java.vm.specification.vendor')
214 system_getproperty('java.vm.specification.version')
215 system_getproperty('java.vm.vendor')
216 system_getproperty('java.vm.version')
217 system_getproperty('line.separator')
218 system_getproperty('os.arch')
219 system_getproperty('os.name')
220 system_getproperty('os.version')
221 system_getproperty('path.separator')
222 system_getproperty('sun.arch.data.model')
223 system_getproperty('sun.boot.class.path')
224 system_getproperty('sun.boot.library.path')
225 system_getproperty('sun.cpu.endian')
226 system_getproperty('sun.cpu.isalist')
227 system_getproperty('sun.desktop')
228 system_getproperty('sun.io.unicode.encoding')
229 system_getproperty('sun.jnu.encoding')
230 system_getproperty('sun.management.compiler')
231 system_getproperty('sun.os.patch.level')
232 system_getproperty('user.country')
233 system_getproperty('user.dir')
234 system_getproperty('user.home')
235 system_getproperty('user.language')
236 system_getproperty('user.name')
237 system_getproperty('user.timezone')
238 system_getproperty('user.variant')
239 ]]></EXAMPLE>
240
241   <AUTHOR>A.C</AUTHOR>
242 </MAN>