ostree/man/ostree-static-delta.xml
Colin Walters 313b4720e8 build: Move man pages into man/
This is preparation for having 3 separate doc build systems (whee):

 - xsltproc for the man pages
 - gtk-doc for the API docs
 - mkdocs for a real manual
2016-01-28 09:31:34 -05:00

118 lines
3.5 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 static-delta</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 static-delta</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-static-delta</refname>
<refpurpose>Manage static delta files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree static-delta list</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta generate</command> <arg choice="req">--to=REV</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta apply-offline</command> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
List and manipulate static delta files.
</para>
</refsect1>
<refsect1>
<title>'Generate' Options</title>
<variablelist>
<varlistentry>
<term><option>--from</option>="REV"</term>
<listitem><para>
Create delta from revision REV.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--to</option>="REV"</term>
<listitem><para>
Create delta to revision REV. (This option is required.)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--empty</option></term>
<listitem><para>
Create delta from scratch.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--max-usize</option>=SIZE</term>
<listitem><para>
Maximum uncompressed size in megabytes.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Can we have an example for when it actually does something?-->
<refsect1>
<title>Example</title>
<para><command>$ ostree static-delta</command></para>
<programlisting>
(No static deltas)
</programlisting>
</refsect1>
</refentry>