ostree/doc/ostree-admin-instutil.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>

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 instutil</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 instutil</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>ostree-admin-instutil</refname>
        <refpurpose>Utility functions intended primarily for operating system installation programs</refpurpose>
    </refnamediv>

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

    <refsect1>
        <title>Description</title>

        <para>
            Use the subcommands to toggle admin installation utilities for selinux policies and kernel arguments.
        </para>
    </refsect1>

<!-- Give more details on each subcommand?  They don't have separate manpages -->
    <refsect1>
        <title>Subcommands</title>

        <variablelist>
            <varlistentry>
                <term><command>selinux-ensure-labeled</command></term>

                <listitem><para>
                    Ensure all files and directories are labeled according to SELinux policy of the first deployment.  First argument is the subpath and second argument is the prefix.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><command>set-kargs <arg choice="opt">--merge</arg> <arg choice="opt">--import-proc-cmdline</arg> <arg choice="opt">--append=ARG</arg> <arg choice="opt">--replace=ARG</arg> <arg choice="opt">MORE_APPEND_ARGS</arg></command></term>

                <listitem><para>
                    Replace the kernel arguments of the default deployment. The new arguments are based
                    on an empty list (the default), the current options (--merge), or the arguments
                    of the loaded kernel (--import-proc-cmdline), and new options either are added to the
                    end (--append=ARG) or replace existing arguments of the same name (--replace=ARG).
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
</refentry>