diff options
Diffstat (limited to 'man/ostree-refs.xml')
-rw-r--r-- | man/ostree-refs.xml | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/man/ostree-refs.xml b/man/ostree-refs.xml new file mode 100644 index 00000000..e97cb1c5 --- /dev/null +++ b/man/ostree-refs.xml @@ -0,0 +1,87 @@ +<?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 refs</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 refs</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>ostree-refs</refname> + <refpurpose>List refs</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ostree refs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg> + </cmdsynopsis> + </refsynopsisdiv> + +<!-- Could this be more specific? What defines a "ref"? etc --> + <refsect1> + <title>Description</title> + <para> + Lists all refs available on the host. If pecified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <variablelist> + <varlistentry> + <term><option>--delete</option></term> + + <listitem><para> + Delete refs which match PREFIX, rather than listing them. If you are trying to reclaim space, + you will then need to <command>ostree prune</command> or <command>ostree admin cleanup</command>. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree refs</command></para> +<programlisting> + my-branch + gnome-ostree/buildmaster/x86_64-runtime +</programlisting> + </refsect1> +</refentry> |