ostree/man/ostree-admin.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>

SPDX-License-Identifier: LGPL-2.0+

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
-->

<refentry id="ostree">

    <refentryinfo>
        <title>ostree admin</title>
        <productname>OSTree</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Colin</firstname>
                <surname>Walters</surname>
                <email>walters@verbum.org</email>
            </author>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>ostree admin</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>ostree-admin</refname>
        <refpurpose>Use one of the ostree admin commands</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>ostree admin</command> <arg choice="req">SUBCOMMAND</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Use ostree admin subcommands.
        </para>
    </refsect1>

    <refsect1>
        <title>Subcommands</title>

        <itemizedlist>
            <listitem><para><command>cleanup</command></para></listitem>
            <listitem><para><command>config-diff</command></para></listitem>
            <listitem><para><command>deploy</command></para></listitem>
            <listitem><para><command>init-fs</command></para></listitem>
            <listitem><para><command>instutil</command></para></listitem>
            <listitem><para><command>os-init</command></para></listitem>
            <listitem><para><command>pin</command></para></listitem>
            <listitem><para><command>set-origin</command></para></listitem>
            <listitem><para><command>status</command></para></listitem>
            <listitem><para><command>switch</command></para></listitem>
            <listitem><para><command>undeploy</command></para></listitem>
            <listitem><para><command>unlock</command></para></listitem>
            <listitem><para><command>upgrade</command></para></listitem>
        </itemizedlist>

        <para>
            View manpages for each admin subcommand using, for example:
        </para>
        <para>
            <command>$ man ostree-admin cleanup</command>
        </para>
    </refsect1>
    <refsect1>
        <title>Options</title>
        <variablelist>
            <varlistentry>
                <term><option>--help</option>, <option>-h</option></term>
                <listitem><para>Usage help</para></listitem>
            </varlistentry>

<!-- What is a sysroot specifically?  More details needed here-->
            <varlistentry>
                <term><option>--sysroot</option>="PATH"</term>
                <listitem><para>Creates a new OSTree sysroot at PATH</para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--print-current-dir</option></term>
                <listitem><para>
                  Prints the full path to the deployment directory for the currently active deployment in the specified sysroot to standard out. This is incompatible with specifying a subcommand.
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
</refentry>