mirror of
https://github.com/ostreedev/ostree.git
synced 2025-02-18 21:58:01 +03:00
9cb9a31b4f
Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
139 lines
4.8 KiB
XML
139 lines
4.8 KiB
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 deploy</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 deploy</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>ostree-admin-deploy</refname>
|
|
<refpurpose>Checkout a revision as the new default deployment</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>ostree admin deploy <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg> </command>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
Takes a commit or revision REFSPEC, and queues the new deployment as default upon reboot.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Options</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--os</option>="OSNAME"</term>
|
|
|
|
<listitem><para>
|
|
If provided, specifies the operating system root. Default is the current one.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--origin-file</option>="FILENAME"</term>
|
|
|
|
<listitem><para>
|
|
Use FILENAME as the origin, which is where OSTree will look for updated versions of the tree.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--retain</option></term>
|
|
|
|
<listitem><para>
|
|
Do not delete previous deployment.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--karg-proc-cmdline</option></term>
|
|
|
|
<listitem><para>
|
|
Import current /proc/cmdline.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--karg</option>="KEY=VALUE"</term>
|
|
|
|
<listitem><para>
|
|
Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--karg-append</option>="KEY=VALUE"</term>
|
|
|
|
<listitem><para>
|
|
Append kernel argument; useful with e.g. console= that can be used multiple times.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para><command>$ ostree admin status</command></para>
|
|
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
|
|
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
|
|
gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3.0
|
|
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
|
|
|
|
<para><command>$ ostree admin deploy gnome-ostree/buildmaster/x86_64-runtime</command></para>
|
|
ostadmin: Creating deployment /ostree/deploy/gnome-ostree/deploy/7e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
|
|
ostadmin: Processing /etc: 3 modified, 0 removed, 29 added
|
|
Transaction complete: bootconfig swap: no deployment count change: 0)
|
|
|
|
<para><command>$ ostree admin status</command></para>
|
|
gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
|
|
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
|
|
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
|
|
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
|
|
|
|
</refsect1>
|
|
</refentry>
|