"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 init</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 init</refentrytitle>

        <manvolnum>1</manvolnum>

    </refmeta>

    <refnamediv>

        <refname>ostree-init</refname>

        <refpurpose>Initialize a new empty repository</refpurpose>

    </refnamediv>

    <refsynopsisdiv>

            <cmdsynopsis>

                <command>ostree init</command> <arg choice="opt" rep="repeat">OPTIONS</arg>

            </cmdsynopsis>

    </refsynopsisdiv>

    <refsect1>

        <title>Description</title>

        <para>

            Creates a new empty repository.

        </para>

    </refsect1>

    <refsect1>

        <title>Options</title>

        <variablelist>

            <varlistentry>

                <term><option>--mode</option>="MODE"</term>

                <listitem><para>

                    Initialize repository in given mode

                    (<literal>bare</literal>, <literal>bare-user</literal>,

                    <literal>bare-user-only</literal>, <literal>archive</literal>).

                    The default is <literal>bare</literal>. Note that for

                    <literal>archive</literal> the repository configuration file

                    will actually have <literal>archive-z2</literal>, as that's

                    the historical name.</para>

                    <para>See the manual for differences between these modes.

                    Briefly, <literal>bare</literal> mode stores files as they

                    are, so they can be directly hardlinked,

                    <literal>bare-user</literal> uses extended attributes to

                    store ownership and xattr information, allowing non-root

                    operations, <literal>bare-user-only</literal> does not store

                    ownership information, and <literal>archive</literal> stores

                    files compressed, to be served over the network.

                </para></listitem>

            </varlistentry>

            <varlistentry>

                <term><option>--collection-id</option>=COLLECTION-ID</term>

                <listitem><para>

                    Set the collection ID of the repository. Remotes in clones

                    of this repository must configure the same value in order to

                    pull refs which originated in this repository over peer to

                    peer.</para>

                    <para>This collection ID must be persistent and globally

                    unique. It is formatted as a reverse DNS name (like a D-Bus

                    interface). It must be set to a reverse DNS domain under your

                    control.</para>

                    <para>This option may be omitted (the default) to leave

                    peer to peer distribution unsupported for the repository. A

                    collection ID may be added to an existing repository in

                    future to enable peer to peer distribution from that point

                    onwards.</para>

                    <para>If the collection ID is changed for the repository

                    in future, peer to peer distribution of refs from the

                    repository will break for all peers who do not update their

                    remote configuration to the new collection ID.

                </para></listitem>

            </varlistentry>

        </variablelist>

    </refsect1>

</refentry>