Changeset 242 for trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html

Timestamp:

04/06/07 10:35:17 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers + replace some message by some report

File:

• trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html (modified) (16 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html

@@ -67 +67 @@
  By default look for files included in !path
 
- all file_search keywords can be used.
+ all <proidl>file_search</proidl> keywords can be used.
 
 
@@ -75 +75 @@
       <a name="#_find"></a>
 
-      <h2>find  <font size="-1" color="#006633"> 
+      <h2>find  <font size="-1" color="#006633">
  find a file
 </font></h2>
 
-      <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>
-
-    
-
-
-    <h3>Return value</h3> 
+      <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>scalar string or array of strings</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>
+
+    
+
+
+    <h3>Return value</h3>
  A scalar or array variable of string type, containing the
  name (with the full path of the matching files. If no files
- exist with names matching the input arguments, find returns
+ exist with names matching the input arguments, <a href=".//find.html">find</a> returns
  the scalar string : 'NOT FOUND'
 
@@ -102 +102 @@
       <font size="-1" color="#006633">required</font>
       
-      
-      
-      
-    </h4>
-
-     
- A scalar or array variable of string type, containing
- file names to match. Input names specifications may contain
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string or array of strings</i></font>
+      
+      
+    </h4>
+
+    
+ File name[s] to match. Input names specifications may contain
  wildcard characters, enabling them to match multiple files
- (see file_search for more informations). By default and if
- necessary, find is looking for filename and also for filename
+ (see <proidl>file_search</proidl> for more informations). By default and if
+ necessary, <a href=".//find.html">find</a> is looking for filename and also for filename
  completed with '.pro'
 
@@ -129 +128 @@
       
       
-      
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string or array of strings</i></font>
       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>['.',!path]</i></font>
       
     </h4>
 
-     
- A scalar or array variable of string type, containing
- directories names where we are looking for the file.
+    
+ Directories names where we are looking for the file.
  Different directories can be separated by
  path_sep(/search_path) (':' on unix type machine) as it is done
@@ -156 +154 @@
     </h4>
 
-     
+    
  performs recursive searching of directory hierarchies.
- In a recursive search, find looks recursively for any and all
+ In a recursive search, <a href=".//find.html">find</a> looks recursively for any and all
  subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
 
@@ -174 +172 @@
     </h4>
 
-     
- obsolete. keep for compatibility, use directory keyword
+    
+ obsolete. keep for compatibility, use IODIRECTORY keyword
 
     
@@ -190 +188 @@
     </h4>
 
-     
+    
  activate to avoid the automatic search of filename completed with '.pro'
 
@@ -206 +204 @@
     </h4>
 
-     
+    
  force to look only at file ending with .pro
 
@@ -222 +220 @@
     </h4>
 
-     
+    
  force to look only at file ending with .nc
 
@@ -238 +236 @@
     </h4>
 
-     
+    
  activate to make sure that each element of the output vector is unique.
 
@@ -254 +252 @@
     </h4>
 
-     
+    
  activate this keyword to stop looking for the file as soon as we found one.
 
@@ -270 +268 @@
     </h4>
 
-     
+    
  activate to look for the file (with a recursive search if needed)
  in . iodir, homedir, !path + the DATA:TestsData directory if it exists.
@@ -287 +285 @@
     </h4>
 
-     
- if the file was not found and this keyword is activated, find will call
+    
+ if the file was not found and this keyword is activated, <a href=".//find.html">find</a> 
+ will call
  itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find
  the file we are looking for. Note that if the file was found at the
- first try this keyword as no effect (which is not the case with LOOKALLDIR) 
+ first try this keyword as no effect (which is not the case with LOOKALLDIR)
 
     
@@ -306 +305 @@
     </h4>
 
-     
+    
  Used to pass keywords
 
@@ -313 +312 @@
 
     <h3>Examples</h3><pre>
-
  IDL> print, find('*loadct')
    /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
@@ -342 +340 @@
     
     <h4>Version</h4>
- $Id: find.pro 232 2007-03-20 16:59:36Z pinsard $
+ $Id: find.pro 239 2007-03-28 06:50:03Z smasson $
+
     <h4>History</h4>
  Sebastien Masson (smasson@lodyc.jussieu.fr)