command.html

---
layout: short-header-cmd
---
<div class="container page-content">
<div class="row">
    <div class="col-3 sidebar">
        <div class="breadcrumbs">
            <ul>
                <li><a href="{{ '/refs' | relative_url }}">References</a></li>
                <li><a href="{{ '/refs/commands' | relative_url }}">Commands</a></li>
                <li class="breadcrumb-block" style="display: block; todo: 'move this to css'"><code class="nocolor">{{ page.command }}</code></li>
            </ul>
        </div>
        {% if page.related-commands %}
        <hr>
        <div class="dropdown-list-container active">
            <p class="title">Related Commands:</p>
            {% for cmd in page.related-commands %}
                <li><a class="sidebar-page-link" href="{{ cmd | slugify }}"><code class="nocolor">{{ cmd }}</code></a></li>
            {% endfor %}
        </div>
        {% endif %}

        {% for group in page.command-groups %}
        {% if site.data.command-groups.groups[group] %}
        {% assign gdata = site.data.command-groups.groups[group] %}
        {% assign cmds = "" | split: "" %}
        {% for p in site.pages %}
            {% if p.layout == "command" %}{% if p.command-groups contains group %}
                {% assign cmds = cmds | push: p.command %}
            {% endif %}{% endif %}
        {% endfor %}
        {% assign cmds = cmds | sort %}
        {% if cmds.size > 0 %}
        <hr>
        <div class="dropdown-list-container active">
            <p class="title">{{ gdata.name }}</p>
            <ul>
            {% for cmd in cmds %}
                {% assign lcmd = cmd | downcase %}
                {% if cmd == page.command %}
                    <li><code class="nocolor">{{ cmd }}</code></li>
                {% elsif site.data.commands.info[lcmd] %}
                    <li><a class="sidebar-page-link" href="{{ cmd | slugify }}"><code class="nocolor">{{ cmd }}</code></a></li>
                {% else %}
                    <li><code class="nocolor grey">{{ cmd }}</code></li>
                {% endif %}
            {% endfor %}
            </ul>
        </div>
        {% endif %}
        {% endif %}
        {% endfor %}
        <!--<hr>
        <div class="sidebar-content-block">
            <p class="title">An information block!</p>
            <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor!</p>
            <a href="btn">Example Link Name!</a>
        </div>-->
    </div>
    <div class="col-9 main-content">
        <div class="content docs">
            {% if page.experimental %}
            <div class="alert alert-warning experimental">
                <div class="icon">
                    <i class="fas fa-flask"></i>
                </div>
                <div class="description">
                    This command is <b>experimental</b>. Check the <a href="#compatibility">compatibility table</a> before using this in production.
                </div>
            </div>
            {% endif %}

            {% if page.notstarted %}
            <p>This command is not documented</p>
            {% endif %}

            {{ content }}

            <hr>

            {% if page.examples and 0 < page.examples.size %}
            <h3><div id="examples" class="header-link-expander"></div><a href="#examples" class="internal-link">Examples<i class="fas fa-link"></i></a></h3>
            {% for e in page.examples %}
<pre class="example"><code>{{ e.content | escape }}</code></pre>
{% if e.desc %}<div class="example-desc">{{ e.desc | markdownify }}</div>{% endif %}
            {% endfor %}
            <hr>
            {% endif %}

            <h3><div id="compatibility" class="header-link-expander"></div><a href="#compatibility" class="internal-link">Compatibility<i class="fas fa-link"></i></a></h3>
            <div class="compatibility-list">
                {% for server in site.data.supported-servers.shortlist %}
                <a href="{{ '/software' | relative_url }}#{{ server.id | slugify }}" class="item">
                    <div class="name">{{ server.name }}</div>
                    {% if page.supported-by[server.id] or page.supported-by-default %}
                    <div class="status supported">
                        <i class="fas fa-check"></i>
                    </div>
                    {% else %}
                    <div class="status not-supported">
                        <td class="not-supported"><i class="fas fa-times"></i></td>
                    </div>
                    {% endif %}
                </a>
                {% endfor %}
            </div>
            <hr>

            <h3><div id="numerics" class="header-link-expander"></div><a href="#numerics" class="internal-link">Related Numerics<i class="fas fa-link"></i></a></h3>
            <ul>
            {% for num in page.numerics %}
                {% if site.data.numerics.info[num] %}
                <li><a href="../numerics/{{ num }}"><code>{% if site.data.numerics.names[num] %}{{ site.data.numerics.names[num] }}{% else %}UNKNOWN{% endif %} ({{ num }})</code></a></li>
                {% else %}
                <li><code class="nocolor grey">{% if site.data.numerics.names[num] %}{{ site.data.numerics.names[num] }}{% else %}UNKNOWN{% endif %} ({{ num }})</code></li>
                {% endif %}
            {% endfor %}
            </ul>

            <hr>
            {% if page.contributors %}
            <div class="contributors">
                Contributors to this page:
                {% for c in page.contributors %}
                    <a href="{{ '/contributors' | relative_url }}#{{ c | slugify }}">{{ site.data.contributors.people[c].name }}</a>{% if forloop.last %}{% else %},{% endif %}
                {% endfor %}
            </div>
            {% endif %}
            <p>
                You can edit and contribute changes to this page on GitHub <a href="{{ site.ghrepo }}{{ page.path }}">here</a>.
            </p>
            {% if site.pregit %}<p>
                Latest change: <a href="{{ site.ghcommit }}{{ page.commit-id }}">{{ page.commit-date | date_to_long_string }}</a>.
            </p>{% endif %}
    </div>
    </div>
</div>
</div>