ostree/man/ostree-show.xml
Dan Nicholson 97c831dd5f bin/show: Add --print-sizes option to show sizes metadata
Use the new `ostree_commit_get_object_sizes()` API to read the
`ostree.sizes` commit metadata and print a summary.
2020-01-20 20:46:31 -07:00

140 lines
4.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>
SPDX-License-Identifier: LGPL-2.0+
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 show</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 show</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-show</refname>
<refpurpose>Output a metadata object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree show</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OBJECT</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Given an object, shows the metadata for that object. For a particular revision, it will show the data for the most recent commit to that revision.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--print-related</option></term>
<listitem><para>
Show the "related" commits.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-variant-type</option>="TYPE"</term>
<listitem><para>
Memory map <replaceable>OBJECT</replaceable> (in this case a filename) to the GVariant type string.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of metadata key.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-detached-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of detached metadata key.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-sizes</option></term>
<listitem><para>
Show the commit size metadata. This in only supported for
commits that contain <varname>ostree.sizes</varname>
metadata. This can be included when creating commits with
<command>ostree commit --generate-sizes</command>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
Show raw variant data.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
<listitem><para>
GPG home directory to use when looking for keyrings (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree show my-branch</command></para>
<programlisting>
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07
Date: 2014-06-12 13:42:54 +0000
</programlisting>
</refsect1>
</refentry>