diff options
author | Colin Walters <walters@verbum.org> | 2016-01-27 12:51:07 -0500 |
---|---|---|
committer | Colin Walters <walters@verbum.org> | 2016-01-28 09:31:34 -0500 |
commit | 313b4720e8b76abf8b7840e79a7a8a0662a82edb (patch) | |
tree | 95b72473f468b0ae775d41a27d9f199d36c6e890 /man/ostree-prune.xml | |
parent | 5ebe43859d284a003e240e0cfe66b5185681e993 (diff) | |
download | ostree-313b4720e8b76abf8b7840e79a7a8a0662a82edb.tar.gz |
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
Diffstat (limited to 'man/ostree-prune.xml')
-rw-r--r-- | man/ostree-prune.xml | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/man/ostree-prune.xml b/man/ostree-prune.xml new file mode 100644 index 00000000..9e8cc873 --- /dev/null +++ b/man/ostree-prune.xml @@ -0,0 +1,128 @@ +<?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 prune</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 prune</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>ostree-prune</refname> + <refpurpose>Search for unreachable objects</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ostree prune</command> <arg choice="opt" rep="repeat">OPTIONS</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + This searches for unreachable objects in the current repository. If unreachable objects are found, the command delete them to free space. If the <option>--no-prune</option> option is invoked, the command will just print unreachable objects and recommend deleting them. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <variablelist> + <varlistentry> + <term><option>--no-prune</option></term> + + <listitem><para> + Only display unreachable objects; don't delete. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--refs-only</option></term> + + <listitem><para> + Only compute reachability via refs. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--delete-commit</option>=COMMIT</term> + + <listitem><para> + Specify a COMMIT to delete. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--keep-younger-than</option>=DATE</term> + + <listitem><para> + All commits older than DATE will be pruned. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--depth</option>=DEPTH</term> + + <listitem><para> + Only traverse DEPTH (integer) parents for each commit (default: -1=infinite). + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--static-deltas-only</option>=DEPTH</term> + + <listitem><para> + Change the behaviour of --keep-younger-than and --delete-commit to prune only + the static deltas files. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + +<!-- Can we have an example for when it DOES prune? --> + <refsect1> + <title>Example</title> + <para><command>$ ostree prune</command></para> +<programlisting> + Total objects: 25627 + No unreachable objects +</programlisting> + </refsect1> +</refentry> |