2011-12-23 18:46:19 -05:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2014-06-17 15:24:08 -04:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2011-12-23 18:46:19 -05:00
<!--
2014-06-17 15:24:08 -04:00
Copyright 2011,2013 Colin Walters <walters @ v e r b u m . o r g >
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.
2011-12-23 18:46:19 -05:00
-->
<refentry id= "ostree" >
2014-06-17 15:24:08 -04:00
<refentryinfo >
<title > ostree</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</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > ostree</refname>
<refpurpose > Manage multiple bootable versioned filesystem trees</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2014-11-29 12:15:21 -05:00
<command > ostree</command>
<arg choice= "req" > COMMAND</arg> <arg choice= "opt" rep= "repeat" > OPTIONS</arg>
2014-06-17 15:24:08 -04:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para >
OSTree is a tool for managing multiple bootable
versioned filesystem trees, or just "tree" for
short. In the OSTree model, operating systems no
longer live in the physical "/" root directory.
Instead, they parallel install to the new toplevel
<filename > /ostree</filename> directory. Each
installed system gets its own
<filename > /ostree/deploy/<replaceable > osname</replaceable> </filename>
directory.
</para>
<para >
Unlike <literal > rpm</literal> or
<literal > dpkg</literal> , OSTree is only aware of
complete filesystem trees. It has no built-in
knowledge of what components went into creating the
filesystem tree.
</para>
<para >
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.
</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>
<para >
2014-11-29 12:15:21 -05:00
To see the man page for a command run <command > man ostree <replaceable > COMMAND</replaceable> </command> or <command > man ostree-admin <replaceable > COMMAND</replaceable> </command>
2014-06-17 15:24:08 -04:00
</para>
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
<term > <option > --repo</option> </term>
<listitem > <para >
For most commands,
when run as non-root, repository is
required. If
<command > ostree</command> is run as
root, it is assumed operations will be
performed on the
<filename > /sysroot/ostree/repo</filename>
repository.
</para> </listitem>
</varlistentry>
2014-11-25 22:25:15 +09:00
<varlistentry >
<term > <option > -v, --verbose</option> </term>
<listitem > <para >
Produce debug level output.
</para> </listitem>
</varlistentry>
2014-06-17 15:24:08 -04:00
</variablelist>
</refsect1>
<refsect1 >
<title > Commands</title>
<para > System administrators will primarily interact
with OSTree via the subcommand <command > ostree
admin</command> .</para>
<variablelist >
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-cleanup</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Delete untagged
deployments and repository objects.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-config-diff</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
See changes to
<filename > /etc</filename> as compared
to the current default (from
<filename > /usr/etc</filename> ).
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-deploy</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Takes a particular
commit or revision, and sets it up for
the next boot.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-init-fs</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Initialize a root filesystem
in a specified path.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-instutil</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Utility functions intended primarily for operating system installation programs
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-os-init</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Initialize the
deployment location for an operating
system with a specified name.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-status</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Show and list the deployments.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-switch</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Choose a different ref
to track from the same remote as the
current tree.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-undeploy</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Remove the previously
<replaceable > INDEX</replaceable>
deployed tree from the bootloader
configuration.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-admin-upgrade</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Download the latest version for the
current ref, and deploy it.
</para> </listitem>
</varlistentry>
</variablelist>
<para > Both administrators and operating system
builders may interact with OSTree via the regular
filesystem manipulation commands.
</para>
<variablelist >
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-cat</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Concatenate contents of files
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-checkout</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Check out a commit into a filesystem tree.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-checksum</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Gives checksum of any file.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-commit</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Given one or more
trees, create a new commit using those contents.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-config</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Change settings.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-diff</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Concisely list
differences between the given refs.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-fsck</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Check a repository for consistency.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-init</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Initialize a new repository.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-log</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Show revision log.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-ls</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
List the contents of a given commit.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-prune</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Search for unreachable objects.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-pull-local</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Copy data from source-repo.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-pull</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Download data from remote repo. If you have libsoup.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-refs</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
List refs.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-remote</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Manipulate remote archive configuration.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-reset</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Reset a ref to a previous commit.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-rev-parse</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Show the SHA256 corresponding to a given rev.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-show</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Given an OSTree SHA256 checksum, display its contents.
</para> </listitem>
</varlistentry>
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-static-delta</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Manage static delta files.
</para> </listitem>
</varlistentry>
2014-09-07 17:41:12 -04:00
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-summary</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-09-07 17:41:12 -04:00
<listitem > <para >
Regenerate the repository summary metadata.
</para> </listitem>
</varlistentry>
2014-06-17 15:24:08 -04:00
<varlistentry >
2014-11-29 12:15:21 -05:00
<term > <citerefentry > <refentrytitle > ostree-trivial-httpd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </term>
2014-06-17 15:24:08 -04:00
<listitem > <para >
Simple webserver.
</para> </listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Examples</title>
<para >
For specific examples, please see the man page regarding the specific ostree command. For example:
</para>
<para >
<command > man ostree init</command> or <command > man ostree-admin status</command>
</para>
</refsect1>
<refsect1 >
<title > GPG verification</title>
<para >
2015-11-07 21:15:20 -05:00
OSTree supports signing commits with GPG. The set of
trusted public keys is stored as keyring files in
<filename > /usr/share/ostree/trusted.gpg.d</filename> . Any
public key in a keyring file in that directory will be
trusted by the client. No private keys should be present
in this directory.
2014-06-17 15:24:08 -04:00
</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > ostree.repo</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
</para>
</refsect1>
2011-12-23 18:46:19 -05:00
</refentry>
