[installation] Init with inital config for global
This commit is contained in:
541
share/doc/caps/html/apps/capssds.html
Normal file
541
share/doc/caps/html/apps/capssds.html
Normal file
@ -0,0 +1,541 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>capssds — CAPS: Common Acquisition Protocol Server documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/gempa.js"></script>
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<img class="background" src="../_static/icon.png"/>
|
||||
<div class="content">
|
||||
<span class="title">CAPS: Common Acquisition Protocol Server </span>
|
||||
<span class="version">2025.254#f0c77b29e</span></h1>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="nav">
|
||||
<div class="container">
|
||||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||||
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<ul>
|
||||
<li class="right">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-0">
|
||||
<a href="../index.html">Home</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="capssds">
|
||||
<span id="id1"></span><h1>capssds<a class="headerlink" href="#capssds" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Virtual overlay file system presenting a CAPS archive directory as a
|
||||
read-only SDS archive.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">capssds</strong> is a virtual overlay file system presenting a CAPS archive
|
||||
directory as a read-only <a class="reference internal" href="../base/glossary.html#term-SDS"><span class="xref std std-term">SDS</span></a> archive with no extra disk space
|
||||
requirement.</p>
|
||||
<p>CAPS Directory and file names are mapped. An application reading from a file
|
||||
will only see <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> records ordered by record start time. You may
|
||||
connect to the virtual SDS archive using the RecordStream SDS or directly read
|
||||
the single <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> file. Other seismological software such as ObsPy or
|
||||
Seisan may read directly from the SDS archive of the files therein.</p>
|
||||
</section>
|
||||
<section id="usage">
|
||||
<span id="sec-capssds-usage"></span><h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The virtual file system may be mounted by an unprivileged system user like
|
||||
<cite>sysop</cite> or configured by the <cite>root</cite> user to be automatically mounted on machine
|
||||
startup via an <cite>/etc/fstab</cite> entry or an systemd mount script.</p>
|
||||
<p>The following sections assume that the CAPS archive is located under
|
||||
<cite>/home/sysop/seiscomp/var/lib/caps/archive</cite> and the SDS archive should appear
|
||||
under <cite>/tmp/sds</cite> with all files and directories being owned by the
|
||||
<cite>sysop</cite> user.</p>
|
||||
<p>Regardless which of the following mount strategies is chosen make sure to
|
||||
create the target directory first:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>-p<span class="w"> </span>/tmp/sds
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="unpriviledged-user">
|
||||
<span id="sec-capssds-usage-unpriv"></span><h3>Unpriviledged user<a class="headerlink" href="#unpriviledged-user" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Mount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>capssds<span class="w"> </span>~/seiscomp/var/lib/caps/archive<span class="w"> </span>/tmp/sds
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Unmount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>fusermount<span class="w"> </span>-u<span class="w"> </span>/tmp/sds
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="system-administrator-etc-fstab">
|
||||
<span id="sec-capssds-usage-fstab"></span><h3>System administrator - /etc/fstab<a class="headerlink" href="#system-administrator-etc-fstab" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Create the /etc/fstab entry:</p>
|
||||
<div class="highlight-plaintext notranslate"><div class="highlight"><pre><span></span>/home/sysop/seiscomp/var/lib/caps/archive /tmp/sds fuse.capssds defaults 0 0
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Alternatively you may define mount options, e.g., to deactivate the auto mount,
|
||||
grant the user the option to mount the directory himself or use the sloppy_size
|
||||
feature:</p>
|
||||
<div class="highlight-plaintext notranslate"><div class="highlight"><pre><span></span>/home/sysop/seiscomp/var/lib/caps/archive /tmp/sds fuse.capssds fuse.capssds noauto,exact_size,user 0 0
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Mount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mount<span class="w"> </span>/tmp/sds
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Unmount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>umount<span class="w"> </span>/tmp/sds
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="system-administrator-systemd">
|
||||
<span id="sec-capssds-usage-systemd"></span><h3>System administrator - systemd<a class="headerlink" href="#system-administrator-systemd" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Create the following file under <cite>/etc/systemd/system/tmp-sds.mount</cite>.
|
||||
Please note that the file name must match the path specified under <cite>Where</cite> with
|
||||
all slashes replaced by a dash:</p>
|
||||
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Unit]</span>
|
||||
<span class="na">Description</span><span class="o">=</span><span class="s">Mount CAPS archive as readonly miniSEED SDS</span>
|
||||
<span class="na">After</span><span class="o">=</span><span class="s">network.target</span>
|
||||
|
||||
<span class="k">[Mount]</span>
|
||||
<span class="na">What</span><span class="o">=</span><span class="s">/home/sysop/var/lib/caps/archive</span>
|
||||
<span class="na">Where</span><span class="o">=</span><span class="s">/tmp/sds</span>
|
||||
<span class="na">Type</span><span class="o">=</span><span class="s">fuse.capssds</span>
|
||||
<span class="na">Options</span><span class="o">=</span><span class="s">defaults,allow_other</span>
|
||||
|
||||
<span class="k">[Install]</span>
|
||||
<span class="na">WantedBy</span><span class="o">=</span><span class="s">multi-user.target</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Mount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span>start<span class="w"> </span>tmp-sds.mount
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Unmount the archive:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span>stop<span class="w"> </span>tmp-sds.mount
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Automatic startup:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>tmp-sds.mount
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="implementation-details">
|
||||
<span id="sec-capssds-impl"></span><h2>Implementation Details<a class="headerlink" href="#implementation-details" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">capssds</strong> makes use of the FUSE <span id="id2">[<a class="reference internal" href="../base/references.html#id145" title="Filesystem in Userspace Kernel Module. Linux Kernel Organization. URL: https://www.kernel.org/doc/html/next/filesystems/fuse.html.">2</a>]</span> is a userspace
|
||||
filesystem framework provided by the Linux kernel as well as the libfuse
|
||||
<span id="id3">[<a class="reference internal" href="../base/references.html#id160" title="Filesystem in Userspace Library. GitHub. URL: https://github.com/libfuse/libfuse.">3</a>]</span> user space library.</p>
|
||||
<p>The file system provides only read access to the data files and implements only
|
||||
<a class="reference internal" href="#sec-capssds-impl-ops"><span class="std std-ref">basic operations</span></a> required to list and read data files.
|
||||
It has to fulfill 2 main tasks, the <a class="reference internal" href="#sec-capssds-impl-pathmap"><span class="std std-ref">Path mapping</span></a>
|
||||
of CAPS and SDS directory tree entries and the <a class="reference internal" href="#sec-capssds-impl-conv"><span class="std std-ref">Data file conversion</span></a>.
|
||||
<a class="reference internal" href="#sec-capssds-impl-perf"><span class="std std-ref">Caches</span></a> are used the improve the performance.</p>
|
||||
<section id="supported-operations">
|
||||
<span id="sec-capssds-impl-ops"></span><h3>Supported operations<a class="headerlink" href="#supported-operations" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><cite>init</cite> - initializes the file system</p></li>
|
||||
<li><p><cite>getattr</cite> - get file and directory attributes such as size and access rights</p></li>
|
||||
<li><p><cite>access</cite> - check for specific access rights</p></li>
|
||||
<li><p><cite>open</cite> - open a file</p></li>
|
||||
<li><p><cite>read</cite> - read data at a specific file position</p></li>
|
||||
<li><p><cite>readdir</cite> - list directory entries</p></li>
|
||||
<li><p><cite>release</cite> - release a file handle</p></li>
|
||||
<li><p><cite>destroy</cite> - shutdown the file system</p></li>
|
||||
</ul>
|
||||
<p>Please refer to
|
||||
<a class="reference external" href="https://github.com/libfuse/libfuse/blob/master/include/fuse.h">fuse.h</a>
|
||||
for a complete list of fuse operations.</p>
|
||||
</section>
|
||||
<section id="path-mapping">
|
||||
<span id="sec-capssds-impl-pathmap"></span><h3>Path mapping<a class="headerlink" href="#path-mapping" title="Permalink to this heading">¶</a></h3>
|
||||
<p>CAPS uses a <a class="reference internal" href="../base/archive.html#sec-archive"><span class="std std-ref">comparable directory structure</span></a> to SDS with
|
||||
three differences:</p>
|
||||
<ul class="simple">
|
||||
<li><p>The channel does not use the <cite>.D</cite> prefix.</p></li>
|
||||
<li><p>The day of year index is zero-based (0-365) where as SDS uses an index
|
||||
starting with 1 (1-366).</p></li>
|
||||
<li><p>CAPS data files use the extension <cite>.data</cite>.</p></li>
|
||||
</ul>
|
||||
<p>The following example shows the translation from a CAPS data file path to an SDS
|
||||
file path for the stream AM.R0F05.00.SHZ for data on January 1st 2025:</p>
|
||||
<p><cite>2025/AM/R0F05/SHZ/AM.R0F05.00.SHZ.2025.000.data -> 2025/AM/R0F05/SHZ.D/AM.R0F05.00.SHZ.D.2025.001</cite></p>
|
||||
<p>Directories and file names not fulfilling the <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> format
|
||||
specification are not listed.</p>
|
||||
</section>
|
||||
<section id="data-file-conversion">
|
||||
<span id="sec-capssds-impl-conv"></span><h3>Data file conversion<a class="headerlink" href="#data-file-conversion" title="Permalink to this heading">¶</a></h3>
|
||||
<p>A <a class="reference internal" href="../base/archive.html#sec-caps-archive-file-format"><span class="std std-ref">CAPS data file</span></a> contains records of
|
||||
certain types in the order of their arrival together with a record index for
|
||||
record lookup and sorting. If a process reads data, only <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> records
|
||||
contained in the CAPS data file are returned in order of the records start time
|
||||
and not the order of arrival. Likewise only <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> records are counted
|
||||
for the reported file size unless the <cite>-o sloppy-size</cite> option is specified.</p>
|
||||
</section>
|
||||
<section id="performance-optimization">
|
||||
<span id="sec-capssds-impl-perf"></span><h3>Performance optimization<a class="headerlink" href="#performance-optimization" title="Permalink to this heading">¶</a></h3>
|
||||
<p>When a file is opened all <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a> records are copied to a memory
|
||||
buffer. This allows fast index based data access at the cost of main memory
|
||||
consumption. The number or simultaneously opened data files can be configured
|
||||
through the <cite>-o cached_files</cite> option and must match the available memory size.
|
||||
If an application tries to open more files than available, the action will fail.</p>
|
||||
<p>To obtain the mapped SDS file size the CAPS data file must be scanned for
|
||||
<cite>miniSEED</cite> records. Although only the header data is read this is still an
|
||||
expensive operation for hundreds of files. A file size cache is used containing
|
||||
up to <cite>-o cached_file_sizes</cite> entries each consuming 56 bytes of memory. File
|
||||
sizes recently accessed are pushed to the front of the cache. A cache item is
|
||||
invalidated if the modification time of the CAPS data file is more recent than
|
||||
the entry creation time.</p>
|
||||
<p>If your use case does not require the listing of the exact file size, you may
|
||||
use the <cite>-o sloppy-size</cite> option which will stop generating the <a class="reference internal" href="../base/glossary.html#term-miniSeed"><span class="xref std std-term">miniSEED</span></a>
|
||||
file size and will return the size of the CAPS file instead.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="command-line-options">
|
||||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">capstool [options] [capsdir] mountpoint</strong></p>
|
||||
<section id="file-system-specific-options">
|
||||
<span id="id4"></span><h3>File-system specific options<a class="headerlink" href="#file-system-specific-options" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-o">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">caps_dir=DIR</span></span><a class="headerlink" href="#cmdoption-o" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">Current</span> <span class="pre">working</span> <span class="pre">directory</span></code></p>
|
||||
<p>Path to the CAPS archive directory.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-0">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">sloppy_size</span></span><a class="headerlink" href="#cmdoption-0" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the size of the CAPS data file instead of summing
|
||||
up the size of all MSEED records. Although there is a
|
||||
cache for the MSEED file size calculating the real size is
|
||||
an expensive operation. If your use case does not depend
|
||||
on the exact size you may activate this flag for speedup.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-1">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">cached_file_sizes=int</span></span><a class="headerlink" href="#cmdoption-1" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100000</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Number of file sizes to cache. Used when sloppy_size is
|
||||
off to avoid unnecessary recomputation of MSEED sizes. A
|
||||
cache entry is valid as long as neither the mtime nor
|
||||
size of the CAPS data file changed. Each entry consumes
|
||||
56 bytes of memory.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-2">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">cached_files=int</span></span><a class="headerlink" href="#cmdoption-2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Number of CAPS data files to cache (100). The file
|
||||
handle for each cached file will be kept open to speed
|
||||
up data access.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="fuse-options">
|
||||
<span id="id5"></span><h3>FUSE Options<a class="headerlink" href="#fuse-options" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-h">
|
||||
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print this help text.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-V">
|
||||
<span id="cmdoption-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-V" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print version.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-d">
|
||||
<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable debug output (implies -f).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-3">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">debug</span></span><a class="headerlink" href="#cmdoption-3" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable debug output (implies -f).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-f">
|
||||
<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable foreground operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-s">
|
||||
<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disable multi-threaded operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-4">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">clone_fd</span></span><a class="headerlink" href="#cmdoption-4" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use separate fuse device fd for each thread (may improve performance).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-5">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">max_idle_threads=int</span></span><a class="headerlink" href="#cmdoption-5" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>The maximum number of idle worker threads allowed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-6">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">max_threads=int</span></span><a class="headerlink" href="#cmdoption-6" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>The maximum number of worker threads allowed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-7">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">kernel_cache</span></span><a class="headerlink" href="#cmdoption-7" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cache files in kernel.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-8">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">[no]auto_cache</span></span><a class="headerlink" href="#cmdoption-8" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable caching based on modification times.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-9">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">no_rofd_flush</span></span><a class="headerlink" href="#cmdoption-9" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disable flushing of read-only fd on close.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-10">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">umask=M</span></span><a class="headerlink" href="#cmdoption-10" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>octal</em></p>
|
||||
<p>Set file permissions.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-11">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">uid=N</span></span><a class="headerlink" href="#cmdoption-11" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set file owner.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-12">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">gid=N</span></span><a class="headerlink" href="#cmdoption-12" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set file group.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-13">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">entry_timeout=T</span></span><a class="headerlink" href="#cmdoption-13" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Type: <em>float</em></p>
|
||||
<p>Cache timeout for names.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-14">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">negative_timeout=T</span></span><a class="headerlink" href="#cmdoption-14" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Type: <em>float</em></p>
|
||||
<p>Cache timeout for deleted names.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-15">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">attr_timeout=T</span></span><a class="headerlink" href="#cmdoption-15" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Type: <em>float</em></p>
|
||||
<p>Cache timeout for attributes.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-16">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">ac_attr_timeout=T</span></span><a class="headerlink" href="#cmdoption-16" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">attr_timeout</span></code></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Type: <em>float</em></p>
|
||||
<p>Auto cache timeout for attributes.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-17">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">noforget</span></span><a class="headerlink" href="#cmdoption-17" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Never forget cached inodes.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-18">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">remember=T</span></span><a class="headerlink" href="#cmdoption-18" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Type: <em>float</em></p>
|
||||
<p>Remember cached inodes for T seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-19">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">modules=M1[:M2...]</span></span><a class="headerlink" href="#cmdoption-19" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Names of modules to push onto filesystem stack.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-20">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">allow_other</span></span><a class="headerlink" href="#cmdoption-20" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow access by all users.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-21">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">allow_root</span></span><a class="headerlink" href="#cmdoption-21" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow access by root.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-22">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">auto_unmount</span></span><a class="headerlink" href="#cmdoption-22" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Auto unmount on process termination.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="options-for-subdir-module">
|
||||
<span id="id6"></span><h3>Options for subdir module<a class="headerlink" href="#options-for-subdir-module" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-23">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">subdir=DIR</span></span><a class="headerlink" href="#cmdoption-23" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepend this directory to all paths (mandatory).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-24">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">[no]rellinks</span></span><a class="headerlink" href="#cmdoption-24" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Transform absolute symlinks to relative.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="options-for-iconv-module">
|
||||
<span id="id7"></span><h3>Options for iconv module<a class="headerlink" href="#options-for-iconv-module" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-25">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">from_code=CHARSET</span></span><a class="headerlink" href="#cmdoption-25" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">UTF-8</span></code></p>
|
||||
<p>Original encoding of file names.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-26">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">to_code=CHARSET</span></span><a class="headerlink" href="#cmdoption-26" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">UTF-8</span></code></p>
|
||||
<p>New encoding of the file names.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
<div id="anchors-bottom"></div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||||
<div id="anchors-top"></div>
|
||||
<div id="anchors" class="content">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
<div>
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">capssds</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a></li>
|
||||
<li><a class="reference internal" href="#usage">Usage</a><ul>
|
||||
<li><a class="reference internal" href="#unpriviledged-user">Unpriviledged user</a></li>
|
||||
<li><a class="reference internal" href="#system-administrator-etc-fstab">System administrator - /etc/fstab</a></li>
|
||||
<li><a class="reference internal" href="#system-administrator-systemd">System administrator - systemd</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#implementation-details">Implementation Details</a><ul>
|
||||
<li><a class="reference internal" href="#supported-operations">Supported operations</a></li>
|
||||
<li><a class="reference internal" href="#path-mapping">Path mapping</a></li>
|
||||
<li><a class="reference internal" href="#data-file-conversion">Data file conversion</a></li>
|
||||
<li><a class="reference internal" href="#performance-optimization">Performance optimization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
||||
<li><a class="reference internal" href="#file-system-specific-options">File-system specific options</a></li>
|
||||
<li><a class="reference internal" href="#fuse-options">FUSE Options</a></li>
|
||||
<li><a class="reference internal" href="#options-for-subdir-module">Options for subdir module</a></li>
|
||||
<li><a class="reference internal" href="#options-for-iconv-module">Options for iconv module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/capssds.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
Release <b></b> version <b>2025.254#f0c77b29e</b>
|
||||
<div class="copyright">
|
||||
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user