findfile.1.html

<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>datatools</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<a href="#main-content" class="visually-hidden">skip to main content</a>
<nav>
<ul>
    <li><a href="/">All Library Apps</a></li>
    <li><a href="index.html">Home</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <!-- <li><a href="about.html">About</a></li> -->
    <!-- <li><a href="search.html">Search</a></li> -->
    <li><a href="https://github.com/caltechlibrary/datatools">Code Repository</a></li>
</ul>
</nav>
<section id="main-content">
<h1 id="name">NAME</h1>
<p>findfile</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>findfile <a href="#options">OPTIONS</a> [TARGET]
[DIRECTORIES_TO_SEARCH]</p>
<h1 id="description">DESCRIPTION</h1>
<p>findfile finds files based on matching prefix, suffix or contained
text in base filename.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display this help message
</dd>
<dt>-license</dt>
<dd>
display license information
</dd>
<dt>-version</dt>
<dd>
display version message
</dd>
<dt>-c, -contains</dt>
<dd>
find file(s) based on basename containing text
</dd>
<dt>-d, -depth</dt>
<dd>
Limit depth of directories walked
</dd>
<dt>-error, -stop-on-error</dt>
<dd>
Stop walk on file system errors (e.g. permissions)
</dd>
<dt>-f, -full-path</dt>
<dd>
list full path for files found
</dd>
<dt>-m, -mod-time</dt>
<dd>
display file modification time before the path
</dd>
<dt>-nl, -newline</dt>
<dd>
if true add a trailing newline
</dd>
<dt>-o, -output</dt>
<dd>
output filename
</dd>
<dt>-p, -prefix</dt>
<dd>
find file(s) based on basename prefix
</dd>
<dt>-quiet</dt>
<dd>
suppress error messages
</dd>
<dt>-s, -suffix</dt>
<dd>
find file(s) based on basename suffix
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Search the current directory and subdirectories for Markdown files
with extension of “.md”.</p>
<pre><code>    findfile -s .md</code></pre>
<p>findfile 1.3.5</p>
</section>
<footer-global></footer-global>
</body>
</html>