source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html @ 187

Last change on this file since 187 was 187, checked in by pinsard, 18 years ago

introducing hyperlinks in idldoc outputs (2/2)
File size: 8.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>find.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="demomode_compatibility.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="fitintobox.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>find.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 based on file_search, but it is possible to specify
65 a set of possibles names and a different set of
66 possibles directories names.
67 By default look for files included in !path
68
69 all file_search keywords can be used.
70
71
72   
73
74     
75      <a name="#_find"></a>
76
77      <h2>find  <font size="-1" color="#006633"> find a file
78</font></h2>
79
80      <p><font face="Courier"><i>result = </i>find(<i><a href="#_find_keyword_filein">filein</a></i>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<i>RECURSIVE</i>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<i>REPERTOIRE</i>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<i>NOPRO</i>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<i>ONLYPRO</i>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<i>ONLYNC</i>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<i>UNIQUE</i>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<i>FIRSTFOUND</i>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<i>LOOKALLDIR</i>, <a href="#_find_keyword_TRYFIND">TRYFIND</a>=<i>TRYFIND</i>, <a href="#_find_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
81
82   
83
84    <h3>Return value</h3> 
85 A scalar or array variable of string type, containing the
86 name (with the full path of the matching files. If no files
87 exist with names matching the input arguments, find returns
88 the scalar string : 'NOT FOUND'
89
90
91   
92    <h3>Parameters</h3>
93   
94
95    <a name="#_find_keyword_filein"></a>
96    <h4>filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
97      <font size="-1" color="#006633">in</font>
98     
99     
100      <font size="-1" color="#006633">required</font>
101     
102     
103     
104     
105    </h4>
106
107     
108 A scalar or array variable of string type, containing
109 file names to match. Input names specifications may contain
110 wildcard characters, enabling them to match multiple files
111 (see file_search for more informations). By default and if
112 necessary, find is looking for filename and also for filename
113 completed with '.pro'
114
115   
116   
117
118   
119    <h3>Keywords</h3>
120
121   
122    <a name="#_find_keyword_IODIRECTORY"></a>
123    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124     
125     
126     
127     
128     
129     
130      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>['.',!path]</i></font>
131     
132    </h4>
133
134     
135 A scalar or array variable of string type, containing
136 directories names where we are looking for the file.
137 Different directories can be separated by
138 path_sep(/search_path) (':' on unix type machine) as it is done
139 to define !path.
140 Note that if filename's dirname is different from '.', this
141 keyword is not taken into account.
142
143   
144    <a name="#_find_keyword_RECURSIVE"></a>
145    <h4>RECURSIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152     
153     
154    </h4>
155
156     
157 performs recursive searching of directory hierarchies.
158 In a recursive search, find looks recursively for any and all
159 subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
160
161   
162    <a name="#_find_keyword_REPERTOIRE"></a>
163    <h4>REPERTOIRE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169     
170     
171     
172    </h4>
173
174     
175 obsolete. keep for compatibility, use directory keyword
176
177   
178    <a name="#_find_keyword_NOPRO"></a>
179    <h4>NOPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185     
186     
187     
188    </h4>
189
190     
191 activate to avoid the automatic search of filename completed with '.pro'
192
193   
194    <a name="#_find_keyword_ONLYPRO"></a>
195    <h4>ONLYPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196     
197     
198     
199     
200     
201     
202     
203     
204    </h4>
205
206     
207 force to look only at file ending with .pro
208
209   
210    <a name="#_find_keyword_ONLYNC"></a>
211    <h4>ONLYNC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212     
213     
214     
215     
216     
217     
218     
219     
220    </h4>
221
222     
223 force to look only at file ending with .nc
224
225   
226    <a name="#_find_keyword_UNIQUE"></a>
227    <h4>UNIQUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228     
229     
230     
231     
232     
233     
234     
235     
236    </h4>
237
238     
239 activate to make sure that each element of the output vector is unique.
240
241   
242    <a name="#_find_keyword_FIRSTFOUND"></a>
243    <h4>FIRSTFOUND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244     
245     
246     
247     
248     
249     
250     
251     
252    </h4>
253
254     
255 activate this keyword to stop looking for the file as soon as we found one.
256
257   
258    <a name="#_find_keyword_LOOKALLDIR"></a>
259    <h4>LOOKALLDIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
260     
261     
262     
263     
264     
265     
266     
267     
268    </h4>
269
270     
271 activate to look for the file (with a recursive search if needed)
272 in . iodir, homedir, !path + the DATA:TestsData directory if it exists.
273
274   
275    <a name="#_find_keyword_TRYFIND"></a>
276    <h4>TRYFIND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277     
278     
279     
280     
281     
282     
283     
284     
285    </h4>
286
287     
288 if the file was not found and this keyword is activated, find will call
289 itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find
290 the file we are looking for. Note that if the file was found at the
291 first try this keyword as no effect (which is not the case with LOOKALLDIR)
292
293   
294    <a name="#_find_keyword__extra"></a>
295    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296     
297     
298     
299     
300     
301     
302     
303     
304    </h4>
305
306     
307 used to pass your keywords
308
309   
310   
311
312    <h3>Examples</h3>
313
314 IDL> print, find('*loadct')
315   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
316   /usr/local/rsi/idl_6.0/lib/loadct.pro
317 IDL> print, find('*loadct', iodir=!dir,/recursive)
318   /usr/local/rsi/idl_6.0/lib/loadct.pro
319   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
320 IDL> print, find('*loadct.pro')
321   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
322   /usr/local/rsi/idl_6.0/lib/loadct.pro
323 IDL> print, find('*loadct',/nopro)
324   NOT FOUND
325 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib')
326   /usr/local/rsi/idl_6.0/lib/loadct.pro
327 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write)
328   NOT FOUND
329 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive)
330   /usr/local/rsi/idl_6.0/lib/loadct.pro
331   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
332 IDL> print, find('mesh*', iodirectory = [iodir, !path])
333   /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc
334   /Users/sebastie/IDL/meshmaskclosesea.pro
335   /Users/sebastie/IDL/meshmaskclosesea.pro~
336   /Users/sebastie/SAXO_RD/Obsolete/meshlec.pro
337   /usr/local/rsi/idl_6.0/lib/mesh_obj.pro
338
339    <h3>Version history</h3>
340   
341    <h4>Version</h4> $Id: find.pro 163 2006-08-29 12:59:46Z navarro $
342    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
343                       28/4/1999
344                       6/7/1999: compatibility mac and windows
345 June 2005: Sebastien Masson: cleaning, use for file_* functions
346
347   
348
349   
350   
351   
352   
353   
354
355   
356   
357   
358   
359   
360   
361   
362
363    <font size="-3"><p>&nbsp;</p></font>
364    <hr size="1" color="#CCCCCC"/>
365     
366
367   
368
369    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
370
371  </body>
372</html>
Note: See TracBrowser for help on using the repository browser.