<?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 fsck</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 fsck</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>ostree-fsck</refname>
        <refpurpose>Check the repository for consistency</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>ostree fsck</command><arg choice="opt" rep="repeat">OPTIONS</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Checks the repository to verify the content integrity of commit objects.  Looks for missing and corrupted objects and metadata, and validates directory structure and metadata.
        </para>
    </refsect1>

    <refsect1>
        <title>Options</title>

        <variablelist>
            <varlistentry>
                <term><option>--quiet</option>,<option>-q</option></term>
                <listitem><para>
                    Only print error messages.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--delete</option></term>
                <listitem><para>
                   Remove corrupted objects.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--add-tombstones</option></term>
                <listitem><para>
                   Add tombstone commit for referenced but missing commits.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--verify-bindings</option></term>
                <listitem><para>
                  Verify that the commits pointed to by each ref have that
                  ref in the binding set.  You should usually add this
                  option; it only defaults to off for backwards compatibility.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--verify-back-refs</option></term>
                <listitem><para>
                  Verify that all the refs listed in a commit’s ref-bindings
                  point to that commit. This cannot be used in repositories
                  where the target of refs is changed over time as new commits
                  are added, but can be used in repositories which are
                  regenerated from scratch for each commit.
                  Implies <literal>--verify-bindings</literal> as well.
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

<!-- What does it look like when it finds corrupted objects?-->
    <refsect1>
        <title>Example</title>
        <para><command>$ ostree fsck</command></para>
<programlisting>
        Enumerating objects...
        Verifying content integrity of of 2 commit objects
        0/2572 objects
        2571/2572 objects
</programlisting>
    </refsect1>
</refentry>
