File: findFiles-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (15 lines) | stat: -rw-r--r-- 760 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
--- author(s): dan
document { 
     Key => {findFiles,(findFiles,String),(findFiles,List),[findFiles, Exclude],[findFiles, FollowLinks]},
     Headline => "find files recursively",
     Usage => "findFiles p",
     Inputs => {
	  "p" => {ofClass{String,List}, ", a directory or list of directories"},
	  Exclude => "a list of strings, regarded as regular expressions; files found whose paths
	      have base filenames matching one of these regular expressions will be excluded from the results",
	  FollowLinks => Boolean => "whether to follow symbolic links to directories and to report on files found there"
	  },
     Outputs => {
	  {"a list of paths to files found in the directory tree(s) rooted at the locations(s) specified by ", TT "p" }
	  }
     }