diff --git a/doc/ostree.xml b/doc/ostree.xml
index bc9357ba..a3be91df 100644
--- a/doc/ostree.xml
+++ b/doc/ostree.xml
@@ -62,7 +62,10 @@
short. In the OSTree model, operating systems no
longer live in the physical "/" root directory.
Instead, they parallel install to the new toplevel
- /ostree directory.
+ /ostree directory. Each
+ installed system gets its own
+ /ostree/deploy/osname
+ directory.
Unlike rpm or
@@ -71,6 +74,14 @@
knowledge of what components went into creating the
filesystem tree.
+
+ It is possible to use OSTree in several modes; the
+ most basic form is to replicate pre-built trees from
+ a build server. Usually, these pre-built trees are
+ derived from packages. You might also be using
+ OSTree underneath a higher level tool which computes
+ filesystem trees locally.
+
It must be emphasized that OSTree only supports
read-only trees. To change to
@@ -104,30 +115,74 @@
- The following commands are understood:
+ System administrators will primarily interact
+ with OSTree via the subcommand ostree
+ admin.
- checkout
+ admin upgrade
- Extract a given branch into the filesystem.
+ If you are replicating
+ from a build server, this command will
+ download the latest version for the
+ current ref, and deploy it. Reboot
+ the system for the changes to take
+ effect.
- checksum
+ admin switch
- Compute the OSTree checksum of the given files.
+ Choose a different ref
+ to track from the same remote as the
+ current tree.
+
+
+ admin deploy
+
+ This is a relatively
+ low level command - takes a particular
+ commit or revision, and sets it up for
+ the next boot.
+
+
+ config-diff
+
+ See changes to
+ /etc as compared
+ to the current default (from
+ /usr/etc).
+
+
+
+
+ Both administrators and operating system
+ builders may interact with OSTree via the regular
+ filesystem manipulation commands.
+
+
+
+
+ init
+
+ Initialize a new
+ repository. Must be given the path to
+ an existing (empty) directory. If you
+ want to serve a repository over plain
+ HTTP, use
+ archive-z2 for
+ diff
- Concisely list differences between the given branch revisions,
- without checking them out into the filesystem.
-
-
- init
-
- Initialize a repository.
-
+ Concisely list
+ differences between the given refs,
+ without checking them out into the
+ physical filesystem. If only one ref
+ is provided, the parent commit will be
+ assumed to be the diff source.
+ commit
@@ -138,22 +193,6 @@
example), create a new commit using those contents.
-
- compose
-
- A specialized type of
- commit, intended for merging together
- many separate filesystem trees such as
- build artifacts.
-
-
- local-clone
-
- Efficiently copy
- objects and references from one local
- repository into another.
-
- log
@@ -179,12 +218,6 @@
Show the SHA256 corresponding to a given rev.
-
- run-triggers
-
- Regenerate cache files in the given operating system tree.
-
-
show
@@ -212,11 +245,4 @@
-
- See Also
-
- ostbuild1
-
-
-