summaryrefslogtreecommitdiff
path: root/man/ostree-init.xml
diff options
context:
space:
mode:
authorJonathan Lebon <jonathan@jlebon.com>2018-04-30 09:42:11 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-04-30 17:58:38 +0000
commita85f06952defd341f45a53a3cdfeef66d4003de0 (patch)
treed9ffb5d0dc46abac00d18f578affb0a45e4ff7c6 /man/ostree-init.xml
parent54c5ab76a94bebc647cb0d80652f8d9980a2fa4d (diff)
downloadostree-a85f06952defd341f45a53a3cdfeef66d4003de0.tar.gz
man/ostree-init: Briefly describe various modes
Closes: #1561 Closes: #1560 Approved by: cgwalters
Diffstat (limited to 'man/ostree-init.xml')
-rw-r--r--man/ostree-init.xml25
1 files changed, 18 insertions, 7 deletions
diff --git a/man/ostree-init.xml b/man/ostree-init.xml
index b74648db..b2726321 100644
--- a/man/ostree-init.xml
+++ b/man/ostree-init.xml
@@ -69,13 +69,24 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--mode</option>="MODE"</term>
- <listitem><para> Initialize repository in given mode
- (<literal>bare</literal>, <literal>bare-user</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></listitem>
+ <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>