Sha256: d41310b4379cf65c07704e4a7c717308520009ec6333e8d5430e0932f5b248c9

Contents?: true

Size: 1.28 KB

Versions: 7

Compression:

Stored size: 1.28 KB

Contents

<h2>Special files</h2>
<p>Every directory can contain the following special files:</p>

<dl>
    <dt>help.{html,txt,md,man}</dt>
    <dd>Auto-generated files containing information about the current directory.</dd>

    <dt>.unsaved</dt>
    <dd>Contains a list of subdirectories and files that have been modified and not saved.</dd>

    <dt>.reset</dt>
    <dd>An executable that resets the current directory upon invocation, i.e. all
        descendant directories and files are dropped from memory and will have to
        be loaded again.</dd>
</dl>

<h2>Information files</h2>
<dl>
    <dt>.client_version</dt>
    <dd>Version of <code>haveapi-client</code>.</dd>

    <dt>.fs_version</dt>
    <dd>Version of this filesystem.</dd>

    <dt>.protocol_version</dt>
    <dd>Version of HaveAPI protocol that <code>haveapi-client</code> supports.
        This filesystem works only with APIs using compatible protocol.</dd>
</dl>

<h2>Resources</h2>
<table class="table table-striped table-bordered table-hover">
    <tr>
        <th>Resource</th>
        <th>Description</th>
    </tr>
    <% @c.resources.each do |name, r| %>
        <tr>
            <td><a href="<%= name %>/help.html"><%= name %></a></td>
            <td><%= r._description[:description] %></td>
        </tr>
    <% end -%>
</table>

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
haveapi-fs-0.11.0 templates/help/html/root.erb
haveapi-fs-0.10.0 templates/help/html/root.erb
haveapi-fs-0.9.0 templates/help/html/root.erb
haveapi-fs-0.8.0 templates/help/html/root.erb
haveapi-fs-0.7.1 templates/help/html/root.erb
haveapi-fs-0.7.0 templates/help/html/root.erb
haveapi-fs-0.1.0 templates/help/html/root.erb