doc: A long overdue manpage update

Ok, just a little one, but still.  I actually updated documentation!
This commit is contained in:
Colin Walters 2013-07-16 18:40:11 -04:00
parent aac52cb9f7
commit 74c1fe1dae
1 changed files with 27 additions and 15 deletions

View File

@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- <!--
Copyright 2011 Colin Walters <walters@verbum.org> Copyright 2011,2013 Colin Walters <walters@verbum.org>
This library is free software; you can redistribute it and/or This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public modify it under the terms of the GNU Lesser General Public
@ -44,30 +44,42 @@
<refnamediv> <refnamediv>
<refname>ostree</refname> <refname>ostree</refname>
<refpurpose>Operating system build, deployment, and development tool</refpurpose> <refpurpose>Manage multiple bootable versioned filesystem trees</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>ostree <arg choice="req">--repo=REPO</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command> <command>ostree <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para>OSTree is a system for building, deploying, and <para>
developing Linux-based operating systems. For many OSTree is a tool for managing multiple bootable
cases, it can fill the role of "package managers" such versioned filesystem trees, or just "tree" for
as RPM and .deb.</para> short. In the OSTree model, operating systems no
<para>At its heart, OSTree is very similar to git - longer live in the physical "/" root directory.
but it is designed explicitly for managing files like Instead, they parallel install to the new toplevel
ELF binaries. Unlike a typical version control <literal>/ostree</literal> directory.
system, OSTree is capable of tracking file UID and </para>
GIDs, as well as all extended attributes such as ACLs <para>
and SELinux security contexts. You should think of Unlike <literal>rpm</literal> or
OSTree as a flexible but specialized userspace <literal>dpg</literal>, OSTree is only aware of
filesystem.</para> complete filesystem trees. It has no built-in
knowledge of what components went into creating the
filesystem tree.
</para>
<para>
It must be emphasized that OSTree only supports
<emphasis>read-only</emphasis> trees. To change to
a different tree (upgrade, downgrade, install
software), a new tree is checked out, and a 3-way
merge of configuration is performed. The currently
running tree is not ever modified; the new tree will
become active on a system reboot.
</para>
</refsect1> </refsect1>
<refsect1> <refsect1>