packaging/ostree
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

New upstream version 2016.8

Browse Source
This commit is contained in:
Simon McVittie committed 2016-09-06 09:01:54 +01:00
2 parents 8d0c193392 73eabca5e8
commit ba02f3eb2f
250 files changed
+80671 -11685
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

man/ostree-admin-cleanup.1
+40
View File
@@ -0,0 +1,40 @@
'\" t
.\" Title: ostree admin cleanup
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin cleanup
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN CLEANUP" "1" "" "OSTree" "ostree admin cleanup"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-cleanup \- Delete untagged deployments and repository objects
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ cleanup\ \fR\ 'u
\fBostree admin cleanup \fR
.SH "DESCRIPTION"
.PP
OSTree sysroot cleans up other bootversions and old deployments\&. If/when a pull or deployment is interrupted, a partially written state may remain on disk\&. This command cleans up any such partial states\&.
.SH "EXAMPLE"
.PP
\fB$ ostree admin cleanup\fR
man/ostree-admin-cleanup.xml
-68
View File
@@ -1,68 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin cleanup</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 admin cleanup</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-cleanup</refname>
<refpurpose>Delete untagged deployments and repository objects</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin cleanup </command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
OSTree sysroot cleans up other bootversions and old deployments. If/when a pull or deployment is interrupted, a partially written state may remain on disk. This command cleans up any such partial states.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin cleanup</command></para>
</refsect1>
</refentry>
man/ostree-admin-config-diff.1
+58
View File
@@ -0,0 +1,58 @@
'\" t
.\" Title: ostree admin config-diff
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin config-diff
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN CONFIG\" "1" "" "OSTree" "ostree admin config-diff"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-config-diff \- Diff current /etc configuration versus default
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ config\-diff\fR\ 'u
\fBostree admin config\-diff\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
Prints the differences between the current /etc directory and the default configuration in /usr/etc\&. Newly added files (present in /etc but not in /usr/etc) will be prefixed with \*(AqA\*(Aq\&. Modified files will be prefixed with \*(AqM\*(Aq, and deleted files with \*(AqD\*(Aq\&.
.SH "OPTIONS"
.PP
\fB\-\-os\fR="OSNAME"
.RS 4
Use a different operating system root than the current one\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree admin config\-diff\fR
.sp
.if n \{\
.RS 4
.\}
.nf
M shadow
A example\&.txt
.fi
.if n \{\
.RE
.\}
man/ostree-admin-config-diff.xml
-86
View File
@@ -1,86 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin config-diff</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 admin config-diff</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-config-diff</refname>
<refpurpose>Diff current /etc configuration versus default</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin config-diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Prints the differences between the current /etc directory and the default configuration in /usr/etc. Newly added files (present in /etc but not in /usr/etc) will be prefixed with 'A'. Modified files will be prefixed with 'M', and deleted files with 'D'.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin config-diff</command></para>
<programlisting>
M shadow
A example.txt
</programlisting>
</refsect1>
</refentry>
man/ostree-admin-deploy.1
+113
View File
@@ -0,0 +1,113 @@
'\" t
.\" Title: ostree admin deploy
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin deploy
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN DEPLOY" "1" "" "OSTree" "ostree admin deploy"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-deploy \- Checkout a revision as the new default deployment
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ deploy\fR\ 'u
\fBostree admin deploy\fR [OPTIONS...] {REFSPEC}
.SH "DESCRIPTION"
.PP
Takes a commit or revision REFSPEC, and queues the new deployment as default upon reboot\&.
.SH "OPTIONS"
.PP
\fB\-\-os\fR="OSNAME"
.RS 4
Use a different operating system root than the current one\&.
.RE
.PP
\fB\-\-origin\-file\fR="FILENAME"
.RS 4
Use FILENAME as the origin, which is where OSTree will look for updated versions of the tree\&.
.RE
.PP
\fB\-\-retain\fR
.RS 4
Do not delete previous deployment\&.
.RE
.PP
\fB\-\-karg\-proc\-cmdline\fR
.RS 4
Import current /proc/cmdline\&.
.RE
.PP
\fB\-\-karg\fR="NAME=VALUE"
.RS 4
Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name\&.
.RE
.PP
\fB\-\-karg\-append\fR="NAME=VALUE"
.RS 4
Append kernel argument; useful with e\&.g\&. console= that can be used multiple times\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree admin status\fR
.sp
.if n \{\
.RS 4
.\}
.nf
* gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
gnome\-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree admin deploy gnome\-ostree/buildmaster/x86_64\-runtime\fR
.sp
.if n \{\
.RS 4
.\}
.nf
ostadmin: Creating deployment /ostree/deploy/gnome\-ostree/deploy/7e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.1
ostadmin: Processing /etc: 3 modified, 0 removed, 29 added
Transaction complete: bootconfig swap: no deployment count change: 0)
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree admin status\fR
.sp
.if n \{\
.RS 4
.\}
.nf
gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.1
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
* gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
man/ostree-admin-deploy.xml
-144
View File
@@ -1,144 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin deploy</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 admin deploy</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-deploy</refname>
<refpurpose>Checkout a revision as the new default deployment</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin deploy</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Takes a commit or revision REFSPEC, and queues the new deployment as default upon reboot.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--origin-file</option>="FILENAME"</term>
<listitem><para>
Use FILENAME as the origin, which is where OSTree will look for updated versions of the tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--retain</option></term>
<listitem><para>
Do not delete previous deployment.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--karg-proc-cmdline</option></term>
<listitem><para>
Import current /proc/cmdline.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--karg</option>="NAME=VALUE"</term>
<listitem><para>
Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--karg-append</option>="NAME=VALUE"</term>
<listitem><para>
Append kernel argument; useful with e.g. console= that can be used multiple times.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin status</command></para>
<programlisting>
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
<para><command>$ ostree admin deploy gnome-ostree/buildmaster/x86_64-runtime</command></para>
<programlisting>
ostadmin: Creating deployment /ostree/deploy/gnome-ostree/deploy/7e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
ostadmin: Processing /etc: 3 modified, 0 removed, 29 added
Transaction complete: bootconfig swap: no deployment count change: 0)
</programlisting>
<para><command>$ ostree admin status</command></para>
<programlisting>
gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
</refsect1>
</refentry>
man/ostree-admin-init-fs.1
+54
View File
@@ -0,0 +1,54 @@
'\" t
.\" Title: ostree admin init-fs
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin init-fs
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN INIT\-F" "1" "" "OSTree" "ostree admin init-fs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-init-fs \- Initialize a new root filesystem
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ init\-fs\fR\ 'u
\fBostree admin init\-fs\fR [OPTIONS...] {PATH}
.SH "DESCRIPTION"
.PP
Initialize an empty physical root filesystem in the designated PATH, with normal toplevels and correct permissions for each directory\&. Primarily useful for operating system installers\&.
.SH "EXAMPLE"
.PP
\fB$ mkdir /example\fR
.PP
\fB$ ostree admin init\-fs /example\fR
.PP
\fB$ ls /example \fR
.PP
\fIboot\fR\ \&\ \&
\fIdev\fR\ \&\ \&
\fIhome\fR\ \&\ \&
\fIostree\fR\ \&\ \&
\fIproc\fR\ \&\ \&
\fIroot\fR\ \&\ \&
\fIrun\fR\ \&\ \&
\fIsys\fR\ \&\ \&
\fItmp\fR
man/ostree-admin-init-fs.xml
-73
View File
@@ -1,73 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin init-fs</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 admin init-fs</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-init-fs</refname>
<refpurpose>Initialize a new root filesystem</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin init-fs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Initialize an empty physical root filesystem in the designated PATH, with normal toplevels and correct permissions for each directory. Primarily useful for operating system installers.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ mkdir /example</command></para>
<para><command>$ ostree admin init-fs /example</command></para>
<para><command>$ ls /example </command></para>
<para>
<emphasis>boot</emphasis>&nbsp;&nbsp; <emphasis>dev</emphasis>&nbsp;&nbsp; <emphasis>home</emphasis>&nbsp;&nbsp; <emphasis>ostree</emphasis>&nbsp;&nbsp; <emphasis>proc</emphasis>&nbsp;&nbsp; <emphasis>root</emphasis>&nbsp;&nbsp; <emphasis>run</emphasis>&nbsp;&nbsp; <emphasis>sys</emphasis>&nbsp;&nbsp; <emphasis>tmp</emphasis>
</para>
</refsect1>
</refentry>
man/ostree-admin-instutil.1
+48
View File
@@ -0,0 +1,48 @@
'\" t
.\" Title: ostree admin instutil
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin instutil
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN INSTUTI" "1" "" "OSTree" "ostree admin instutil"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-instutil \- Utility functions intended primarily for operating system installation programs
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ instutil\fR\ 'u
\fBostree admin instutil\fR {SUBCOMMAND} [ARGS]
.SH "DESCRIPTION"
.PP
Use the subcommands to toggle admin installation utilities for selinux policies and kernel arguments\&.
.SH "SUBCOMMANDS"
.PP
.HP \w'\fBselinux\-ensure\-labeled\fR\ 'u \fBselinux\-ensure\-labeled\fR [SUBPATH\ PREFIX]
.RS 4
Ensure all files and directories are labeled according to SELinux policy of the first deployment\&.
.RE
.PP
.HP \w'\fBset\-kargs\fR\ 'u \fBset\-kargs\fR [\-\-merge] [\-\-import\-proc\-cmdline] [\-\-append="NAME=VALUE"] [\-\-replace="NAME=VALUE"] [MORE_APPEND_ARGS]
.RS 4
Replace the kernel arguments of the default deployment\&. The new arguments are based on an empty list (the default), the current options (\-\-merge), or the arguments of the loaded kernel (\-\-import\-proc\-cmdline), and new options either are added to the end (\-\-append="NAME=VALUE") or replace existing arguments of the same name (\-\-replace="NAME=VALUE")\&.
.RE
man/ostree-admin-instutil.xml
-90
View File
@@ -1,90 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin instutil</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 admin instutil</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-instutil</refname>
<refpurpose>Utility functions intended primarily for operating system installation programs</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin instutil</command> <arg choice="req">SUBCOMMAND</arg> <arg choice="opt">ARGS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Use the subcommands to toggle admin installation utilities for selinux policies and kernel arguments.
</para>
</refsect1>
<!-- Give more details on each subcommand? They don't have separate manpages -->
<refsect1>
<title>Subcommands</title>
<variablelist>
<varlistentry>
<term><cmdsynopsis><command>selinux-ensure-labeled</command> <arg choice="opt">SUBPATH PREFIX</arg></cmdsynopsis></term>
<listitem><para>
Ensure all files and directories are labeled according to SELinux policy of the first deployment.
</para></listitem>
</varlistentry>
<varlistentry>
<term><cmdsynopsis>
<command>set-kargs</command> <arg choice="opt">--merge</arg> <arg choice="opt">--import-proc-cmdline</arg> <arg choice="opt">--append="NAME=VALUE"</arg> <arg choice="opt">--replace="NAME=VALUE"</arg> <arg choice="opt">MORE_APPEND_ARGS</arg></cmdsynopsis></term>
<listitem><para>
Replace the kernel arguments of the default deployment. The new arguments are based
on an empty list (the default), the current options (--merge), or the arguments
of the loaded kernel (--import-proc-cmdline), and new options either are added to the
end (--append="NAME=VALUE") or replace existing arguments of the same name (--replace="NAME=VALUE").
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
man/ostree-admin-os-init.1
+53
View File
@@ -0,0 +1,53 @@
'\" t
.\" Title: ostree admin os-init
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin os-init
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN OS\-INI" "1" "" "OSTree" "ostree admin os-init"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-os-init \- Initialize empty state for a given operating system
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ os\-init\fR\ 'u
\fBostree admin os\-init\fR {OSNAME}
.SH "DESCRIPTION"
.PP
Initializes an new state for an operating system\&. Ensures that the core subdirectories of /var (/tmp, /lib, /run, and /lock) exist and initialize the given OSNAME as OSTree root\&. Each deployment location is comprised of a single shared
var
and a set of deployments (chroots)\&.
.SH "EXAMPLE"
.PP
\fB$ ostree admin os\-init gnome\-ostree\fR
.sp
.if n \{\
.RS 4
.\}
.nf
ostree/deploy/gnome\-ostree initialized as OSTree root
.fi
.if n \{\
.RE
.\}
man/ostree-admin-os-init.xml
-71
View File
@@ -1,71 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin os-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 admin os-init</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-os-init</refname>
<refpurpose>Initialize empty state for a given operating system</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin os-init</command> <arg choice="req">OSNAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Initializes an new state for an operating system. Ensures that the core subdirectories of /var (/tmp, /lib, /run, and /lock) exist and initialize the given OSNAME as OSTree root. Each deployment location is comprised of a single shared <filename>var</filename> and a set of deployments (chroots).
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin os-init gnome-ostree</command></para>
<programlisting>
ostree/deploy/gnome-ostree initialized as OSTree root
</programlisting>
</refsect1>
</refentry>
man/ostree-admin-set-origin.1
+56
View File
@@ -0,0 +1,56 @@
'\" t
.\" Title: ostree admin set-origin
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin set-origin
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN SET\-OR" "1" "" "OSTree" "ostree admin set-origin"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-set-origin \- Change the "origin" (location for upgrades)
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ set\-origin\ \fR\ 'u
\fBostree admin set\-origin \fR {REMOTENAME} {URL} [BRANCH]
.SH "DESCRIPTION"
.PP
Add a new remote named
\fIREMOTENAME\fR
(if it does not already exist)\&. Then change the origin file for the current deployment\&. This is the ref that will be "tracked" and upgraded with
\fBostree admin upgrade\fR\&.
.SH "OPTIONS"
.PP
\fB\-\-set\fR=KEY=VALUE
.RS 4
Set an option for the remote\&.
.RE
.PP
\fB\-\-index\fR=INDEX
.RS 4
Change the origin of the deployment numbered
\fIINDEX\fR
(starting from 0)\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree admin set\-origin exampleos http://os\&.example\&.com/repo exampleos/10\&.0/master/router\fR
man/ostree-admin-set-origin.xml
-96
View File
@@ -1,96 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2015 Colin Walters <walters@verbum.org>
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 admin set-origin</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 admin set-origin</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-set-origin</refname>
<refpurpose>Change the "origin" (location for upgrades)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin set-origin </command> <arg choice="req">REMOTENAME</arg> <arg choice="req">URL</arg> <arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Add a new remote named
<replaceable>REMOTENAME</replaceable> (if it does not
already exist). Then change the origin file for the
current deployment. This is the ref that will be
"tracked" and upgraded with <command>ostree admin
upgrade</command>.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--set</option>=KEY=VALUE</term>
<listitem><para>
Set an option for the remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--index</option>=INDEX</term>
<listitem><para> Change the origin of the deployment
numbered <replaceable>INDEX</replaceable> (starting
from 0). </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin set-origin exampleos http://os.example.com/repo exampleos/10.0/master/router</command></para>
</refsect1>
</refentry>
man/ostree-admin-status.1
+53
View File
@@ -0,0 +1,53 @@
'\" t
.\" Title: ostree admin status
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin status
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN STATUS" "1" "" "OSTree" "ostree admin status"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-status \- List deployments
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ status\fR\ 'u
\fBostree admin status\fR
.SH "DESCRIPTION"
.PP
Lists the deployments available to be booted into\&. Includes osname, the checksum followed by the deploy serial, and the refspec\&. An asterisk indicates the current booted deployment\&.
.SH "EXAMPLE"
.PP
\fB$ ostree admin status\fR
.sp
.if n \{\
.RS 4
.\}
.nf
* gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
gnome\-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
man/ostree-admin-status.xml
-74
View File
@@ -1,74 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin status</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 admin status</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-status</refname>
<refpurpose>List deployments</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin status</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Lists the deployments available to be booted into. Includes osname, the checksum followed by the deploy serial, and the refspec. An asterisk indicates the current booted deployment.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin status</command></para>
<programlisting>
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
</refsect1>
</refentry>
man/ostree-admin-switch.1
+47
View File
@@ -0,0 +1,47 @@
'\" t
.\" Title: ostree admin switch
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin switch
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN SWITCH" "1" "" "OSTree" "ostree admin switch"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-switch \- Construct new tree from current origin and deploy it, if it changed
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ switch\fR\ 'u
\fBostree admin switch\fR {REF}
.SH "DESCRIPTION"
.PP
Choose a different REF forom the current remote to track\&. This is the ref that will be "tracked" and upgraded with
\fBostree admin upgrade\fR\&. Like an upgrade, the operating system state will be preserved\&.
.SH "OPTIONS"
.PP
\fB\-\-os\fR="OSNAME"
.RS 4
Use a different operating system root than the current one\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree admin switch fedostree/20/workstation/gnome/core\fR
man/ostree-admin-switch.xml
-83
View File
@@ -1,83 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin switch</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 admin switch</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-switch</refname>
<refpurpose>Construct new tree from current origin and deploy it, if it changed</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin switch</command> <arg choice="req">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Choose a different REF forom the current remote to track. This is the ref that will be "tracked" and upgraded with <command>ostree admin upgrade</command>. Like an upgrade, the operating system state will be preserved.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin switch fedostree/20/workstation/gnome/core</command></para>
</refsect1>
</refentry>
man/ostree-admin-undeploy.1
+80
View File
@@ -0,0 +1,80 @@
'\" t
.\" Title: ostree admin undeploy
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin undeploy
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN UNDEPLO" "1" "" "OSTree" "ostree admin undeploy"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-undeploy \- Delete deployment at a given index
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ undeploy\fR\ 'u
\fBostree admin undeploy\fR {INDEX}
.SH "DESCRIPTION"
.PP
Deletes the deployment at INDEX\&. INDEX must be in range and not reference the currently booted deployment\&.
.SH "EXAMPLE"
.PP
\fB$ ostree admin status\fR
.sp
.if n \{\
.RS 4
.\}
.nf
* gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
gnome\-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree admin undeploy 1\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Transaction complete; bootconfig swap: no deployment count change: \-1)
Freed objects: 326\&.5 kB
Deleted deployment ce19c41036cc45e49b0cecf6b157523c2105c4de1c\&.0
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree admin status\fR
.sp
.if n \{\
.RS 4
.\}
.nf
* gnome\-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07\&.0
origin refspec: gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
man/ostree-admin-undeploy.xml
-85
View File
@@ -1,85 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin undeploy</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 admin undeploy</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-undeploy</refname>
<refpurpose>Delete deployment at a given index</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin undeploy</command> <arg choice="req">INDEX</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Deletes the deployment at INDEX. INDEX must be in range and not reference the currently booted deployment.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin status</command></para>
<programlisting>
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
<para><command>$ ostree admin undeploy 1</command></para>
<programlisting>
Transaction complete; bootconfig swap: no deployment count change: -1)
Freed objects: 326.5 kB
Deleted deployment ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0
</programlisting>
<para><command>$ ostree admin status</command></para>
<programlisting>
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
origin refspec: gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
</refsect1>
</refentry>
man/ostree-admin-unlock.1
+46
View File
@@ -0,0 +1,46 @@
'\" t
.\" Title: ostree admin unlock
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin unlock
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN UNLOCK" "1" "" "OSTree" "ostree admin unlock"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-unlock \- Prepare the current deployment for hotfix or development
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ unlock\fR\ 'u
\fBostree admin unlock\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
Remove the read\-only bind mount on
/usr
and replace it with a writable overlay filesystem\&. This default invocation of "unlock" is intended for development/testing purposes\&. All changes in the overlay are lost on reboot\&. However, this command also supports "hotfixes", see below\&.
.SH "OPTIONS"
.PP
\fB\-\-hotfix\fR
.RS 4
If this option is provided, the current deployment will be cloned as a rollback target\&. This option is intended for things like emergency security updates to userspace components such as
sshd\&. The semantics here differ from the default "development" unlock mode in that reboots will retain any changes (which is what you likely want for security hotfixes)\&.
.RE
man/ostree-admin-unlock.xml
-88
View File
@@ -1,88 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2016 Colin Walters <walters@verbum.org>
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 admin unlock</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 admin unlock</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-unlock</refname>
<refpurpose>Prepare the current deployment for hotfix or development</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin unlock</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Remove the read-only bind mount on <literal>/usr</literal>
and replace it with a writable overlay filesystem. This
default invocation of "unlock" is intended for
development/testing purposes. All changes in the overlay
are lost on reboot. However, this command also supports
"hotfixes", see below.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--hotfix</option></term>
<listitem><para>If this option is provided, the
current deployment will be cloned as a rollback
target. This option is intended for things like
emergency security updates to userspace components
such as <literal>sshd</literal>. The semantics here
differ from the default "development" unlock mode
in that reboots will retain any changes (which is what
you likely want for security hotfixes).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
man/ostree-admin-upgrade.1
+71
View File
@@ -0,0 +1,71 @@
'\" t
.\" Title: ostree admin upgrade
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin upgrade
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN UPGRADE" "1" "" "OSTree" "ostree admin upgrade"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin-upgrade \- Construct new tree from current origin and deploy it, if it changed
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\ upgrade\fR\ 'u
\fBostree admin upgrade\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
Downloads the latest version of the current ref from the build server and deploys it, if it changed\&. Reboot the machine for the changes to take effect\&.
.SH "OPTIONS"
.PP
\fB\-\-os\fR="OSNAME"
.RS 4
Use a different operating system root than the current one\&.
.RE
.PP
\fB\-\-reboot\fR,\fB\-r\fR
.RS 4
Reboot after a successful upgrade\&.
.RE
.PP
\fB\-\-allow\-downgrade\fR
.RS 4
Permit deployment of chronologically older trees\&.
.RE
.PP
\fB\-\-override\-commit\fR="CHECKSUM"
.RS 4
Deploy CHECKSUM instead of the latest tree\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree admin upgrade\fR
.sp
.if n \{\
.RS 4
.\}
.nf
No update available\&.
.fi
.if n \{\
.RE
.\}
man/ostree-admin-upgrade.xml
-110
View File
@@ -1,110 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin upgrade</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 admin upgrade</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-upgrade</refname>
<refpurpose>Construct new tree from current origin and deploy it, if it changed</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin upgrade</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Downloads the latest version of the current ref from the build server and deploys it, if it changed. Reboot the machine for the changes to take effect.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--reboot</option>,<option>-r</option></term>
<listitem><para>
Reboot after a successful upgrade.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-downgrade</option></term>
<listitem><para>
Permit deployment of chronologically older trees.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--override-commit</option>="CHECKSUM"</term>
<listitem><para>
Deploy CHECKSUM instead of the latest tree.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Can we have a real example with output? -->
<refsect1>
<title>Example</title>
<para><command>$ ostree admin upgrade</command></para>
<programlisting>
No update available.
</programlisting>
</refsect1>
</refentry>
man/ostree-admin.1
+179
View File
@@ -0,0 +1,179 @@
'\" t
.\" Title: ostree admin
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree admin
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE ADMIN" "1" "" "OSTree" "ostree admin"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-admin \- Use one of the ostree admin commands
.SH "SYNOPSIS"
.HP \w'\fBostree\ admin\fR\ 'u
\fBostree admin\fR {SUBCOMMAND}
.SH "DESCRIPTION"
.PP
Use ostree admin subcommands\&.
.SH "SUBCOMMANDS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBcleanup\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBconfig\-diff\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBdeploy\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBinit\-fs\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBinstutil\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBos\-init\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBstatus\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBset\-origin\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBswitch\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBundeploy\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBupgrade\fR
.RE
.PP
View manpages for each admin subcommand using, for example:
.PP
\fB$ man ostree\-admin cleanup\fR
.SH "OPTIONS"
.PP
\fB\-\-help\fR, \fB\-h\fR
.RS 4
Usage help
.RE
.PP
\fB\-\-sysroot\fR="PATH"
.RS 4
Creates a new OSTree sysroot at PATH
.RE
.PP
\fB\-\-print\-current\-dir\fR
.RS 4
Prints the full path to the deployment directory for the currently active deployment in the specified sysroot to standard out\&. This is incompatible with specifying a subcommand\&.
.RE
man/ostree-admin.xml
-110
View File
@@ -1,110 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 admin</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 admin</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin</refname>
<refpurpose>Use one of the ostree admin commands</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin</command> <arg choice="req">SUBCOMMAND</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Use ostree admin subcommands.
</para>
</refsect1>
<refsect1>
<title>Subcommands</title>
<itemizedlist>
<listitem><para><command>cleanup</command></para></listitem>
<listitem><para><command>config-diff</command></para></listitem>
<listitem><para><command>deploy</command></para></listitem>
<listitem><para><command>init-fs</command></para></listitem>
<listitem><para><command>instutil</command></para></listitem>
<listitem><para><command>os-init</command></para></listitem>
<listitem><para><command>status</command></para></listitem>
<listitem><para><command>set-origin</command></para></listitem>
<listitem><para><command>switch</command></para></listitem>
<listitem><para><command>undeploy</command></para></listitem>
<listitem><para><command>upgrade</command></para></listitem>
</itemizedlist>
<para>
View manpages for each admin subcommand using, for example:
</para>
<para>
<command>$ man ostree-admin cleanup</command>
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--help</option>, <option>-h</option></term>
<listitem><para>Usage help</para></listitem>
</varlistentry>
<!-- What is a sysroot specifically? More details needed here-->
<varlistentry>
<term><option>--sysroot</option>="PATH"</term>
<listitem><para>Creates a new OSTree sysroot at PATH</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-current-dir</option></term>
<listitem><para>
Prints the full path to the deployment directory for the currently active deployment in the specified sysroot to standard out. This is incompatible with specifying a subcommand.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
man/ostree-cat.1
+50
View File
@@ -0,0 +1,50 @@
'\" t
.\" Title: ostree cat
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree cat
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CAT" "1" "" "OSTree" "ostree cat"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-cat \- Display or concatenate contents of files
.SH "SYNOPSIS"
.HP \w'\fBostree\ cat\fR\ 'u
\fBostree cat\fR {COMMIT} {PATH...}
.SH "DESCRIPTION"
.PP
This command functions much like the typical Unix "cat" command, in that it displays the contents of a file, or concatenates them given two or more files\&. However, this command requires the user to specify a commit \- a checksum or refspec corresponding to a given build\&. If you use a refspec, OSTree will refer to the most recent commit, unless you specify a parent build using the carat (^) at the end of the refspec\&. It will then operate the command in that given commit\&.
.SH "EXAMPLE"
.PP
\fB$ ostree cat my\-branch helloworld\&.txt\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Hello, world!
.fi
.if n \{\
.RE
.\}
man/ostree-cat.xml
-72
View File
@@ -1,72 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 cat</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 cat</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-cat</refname>
<refpurpose>Display or concatenate contents of files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree cat</command> <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This command functions much like the typical Unix "cat" command, in that it displays the contents of a file, or concatenates them given two or more files. However, this command requires the user to specify a commit - a checksum or refspec corresponding to a given build. If you use a refspec, OSTree will refer to the most recent commit, unless you specify a parent build using the carat (^) at the end of the refspec. It will then operate the command in that given commit.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree cat my-branch helloworld.txt</command></para>
<programlisting>
Hello, world!
</programlisting>
</refsect1>
</refentry>
man/ostree-checkout.1
+85
View File
@@ -0,0 +1,85 @@
'\" t
.\" Title: ostree checkout
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree checkout
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CHECKOUT" "1" "" "OSTree" "ostree checkout"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-checkout \- Check out a commit into a filesystem
.SH "SYNOPSIS"
.HP \w'\fBostree\ checkout\fR\ 'u
\fBostree checkout\fR [OPTIONS...] {COMMIT} [DESTINATION]
.SH "DESCRIPTION"
.PP
Checks out the given commit into the filesystem under directory DESTINATION\&. If DESTINATION is not specified, the COMMIT will become the destination checkout target\&. If COMMIT destination already exists, command will error unless
\fB\-\-union\fR
option is selected\&.
.SH "OPTIONS"
.PP
\fB\-\-user\-mode\fR,\fB \-u\fR
.RS 4
Do not change file ownership or initialize extended attributes\&.
.RE
.PP
\fB\-\-subpath\fR="PATH"
.RS 4
Checkout sub\-directory PATH\&.
.RE
.PP
\fB\-\-union\fR
.RS 4
Keep existing directories and unchanged files, overwrite existing files\&.
.RE
.PP
\fB\-\-allow\-noent\fR
.RS 4
Do nothing if specified path does not exist\&.
.RE
.PP
\fB\-\-from\-stdin\fR
.RS 4
Process many checkouts from standard input\&.
.RE
.PP
\fB\-\-from\-file\fR="FILE"
.RS 4
Process many checkouts from input file\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree checkout my\-branch\fR
.PP
\fB$ ls\fR
.sp
.if n \{\
.RS 4
.\}
.nf
file1\ \&\ \&\ \&\ \&file2\ \&\ \&\ \&\ \&\fImy\-branch\fR
.fi
.if n \{\
.RE
.\}
man/ostree-checkout.xml
-127
View File
@@ -1,127 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 checkout</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 checkout</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-checkout</refname>
<refpurpose>Check out a commit into a filesystem</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree checkout</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt">DESTINATION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Checks out the given commit into the filesystem under directory DESTINATION. If DESTINATION is not specified, the COMMIT will become the destination checkout target. If COMMIT destination already exists, command will error unless <option>--union</option> option is selected.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--user-mode</option>,<option> -u</option></term>
<listitem><para>
Do not change file ownership or initialize extended attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subpath</option>="PATH"</term>
<listitem><para>
Checkout sub-directory PATH.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--union</option></term>
<listitem><para>
Keep existing directories and unchanged files, overwrite existing files.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-noent</option></term>
<listitem><para>
Do nothing if specified path does not exist.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--from-stdin</option></term>
<listitem><para>
Process many checkouts from standard input.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--from-file</option>="FILE"</term>
<listitem><para>
Process many checkouts from input file.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- check this example for accuracy-->
<refsect1>
<title>Example</title>
<para><command>$ ostree checkout my-branch</command></para>
<para><command>$ ls</command></para>
<programlisting>
file1&nbsp;&nbsp;&nbsp;&nbsp;file2&nbsp;&nbsp;&nbsp;&nbsp;<emphasis>my-branch</emphasis>
</programlisting>
</refsect1>
</refentry>
man/ostree-checksum.1
+50
View File
@@ -0,0 +1,50 @@
'\" t
.\" Title: ostree checksum
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree checksum
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CHECKSUM" "1" "" "OSTree" "ostree checksum"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-checksum \- Checksum a file or directory
.SH "SYNOPSIS"
.HP \w'\fBostree\ checksum\fR\ 'u
\fBostree checksum\fR {PATH}
.SH "DESCRIPTION"
.PP
Generates a checksum for a given file or directory\&.
.SH "EXAMPLE"
.PP
\fB$ ostree checksum file1\fR
.sp
.if n \{\
.RS 4
.\}
.nf
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
.fi
.if n \{\
.RE
.\}
man/ostree-checksum.xml
-71
View File
@@ -1,71 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 checksum</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 checksum</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-checksum</refname>
<refpurpose>Checksum a file or directory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree checksum</command> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Generates a checksum for a given file or directory.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree checksum file1</command></para>
<programlisting>
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
</programlisting>
</refsect1>
</refentry>
man/ostree-commit.1
+161
View File
@@ -0,0 +1,161 @@
'\" t
.\" Title: ostree commit
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree commit
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE COMMIT" "1" "" "OSTree" "ostree commit"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-commit \- Commit a new revision
.SH "SYNOPSIS"
.HP \w'\fBostree\ commit\fR\ 'u
\fBostree commit\fR [OPTIONS...] \-\-branch= {BRANCH} [PATH]
.SH "DESCRIPTION"
.PP
This allows you to commit changes to a branch\&. The specification of the branch is required\&. The command will print the checksum of a successful commit\&.
.SH "OPTIONS"
.PP
\fB\-\-subject\fR, \fB\-s\fR="SUBJECT"
.RS 4
One line subject\&. (optional)
.RE
.PP
\fB\-\-body\fR, \fB\-m\fR="BODY"
.RS 4
Full description\&. (optional)
.RE
.PP
\fB\-\-editor\fR, \fB\-e\fR
.RS 4
Open a text editor for the commit description\&. It will use OSTREE_EDITOR, VISUAL, EDITOR, or vi, in descending order of preference\&. The commit will be aborted if the message is left empty\&.
.RE
.PP
\fB\-\-branch\fR, \fB\-b\fR="BRANCH"
.RS 4
Branch\&. Required, unless \-\-orphan is given\&.
.RE
.PP
\fB\-\-tree\fR="dir=PATH" or "tar=TARFILE" or "ref=COMMIT"
.RS 4
Overlay the given argument as a tree\&.
.RE
.PP
\fB\-\-add\-metadata\-string\fR="KEY=VALUE"
.RS 4
Add a key/value pair to metadata\&.
.RE
.PP
\fB\-\-add\-detached\-metadata\-string\fR="KEY=VALUE"
.RS 4
Add a key/value pair to detached metadata\&.
.RE
.PP
\fB\-\-owner\-uid\fR="UID"
.RS 4
Set file ownership user id\&.
.RE
.PP
\fB\-\-owner\-gid\fR="GID"
.RS 4
Set file ownership group id\&.
.RE
.PP
\fB\-\-no\-xattrs\fR
.RS 4
Do not import extended attributes\&.
.RE
.PP
\fB\-\-link\-checkout\-speedup\fR
.RS 4
Optimize for commits of trees composed of hardlinks into the repository\&.
.RE
.PP
\fB\-\-tar\-autocreate\-parents\fR
.RS 4
When loading tar archives, automatically create parent directories as needed\&.
.RE
.PP
\fB\-\-skip\-if\-unchanged\fR
.RS 4
If the contents are unchanged from previous commit, do nothing\&.
.RE
.PP
\fB\-\-statoverride\fR="PATH"
.RS 4
File containing list of modifications to make permissions (file mode, followed by space, followed by file path)\&.
.RE
.PP
\fB\-\-skip\-list\fR="PATH"
.RS 4
File containing list of file paths to skip (one path per line)\&.
.RE
.PP
\fB\-\-table\-output\fR
.RS 4
Output more information in a KEY: VALUE format\&.
.RE
.PP
\fB\-\-generate\-sizes\fR
.RS 4
Generate size information along with commit metadata\&.
.RE
.PP
\fB\-\-gpg\-sign\fR="KEY\-ID"
.RS 4
GPG Key ID with which to sign the commit (if have GPGME \- GNU Privacy Guard Made Easy)\&.
.RE
.PP
\fB\-\-gpg\-homedir\fR="HOMEDIR"
.RS 4
GPG home directory to use when looking for keyrings (if have GPGME \- GNU Privacy Guard Made Easy)\&.
.RE
.PP
\fB\-\-timestamp\fR="TIMESTAMP"
.RS 4
Override the timestamp of the commit to TIMESTAMP\&.
.RE
.PP
\fB\-\-orphan\fR
.RS 4
Create a commit without writing to a ref (branch)
.RE
.PP
\fB\-\-fsync\fR="POLICY"
.RS 4
POLICY is a boolean which specifies whether fsync should be used or not\&. Default to true\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree commit \-\-branch=my\-branch \-\-subject="Initial commit"\fR
.sp
.if n \{\
.RS 4
.\}
.nf
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
.fi
.if n \{\
.RE
.\}
man/ostree-commit.xml
-251
View File
@@ -1,251 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 commit</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 commit</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-commit</refname>
<refpurpose>Commit a new revision</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree commit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> <arg choice="opt">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This allows you to commit changes to a branch. The specification of the branch is required. The command will print the checksum of a successful commit.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--subject</option>, <option>-s</option>="SUBJECT"</term>
<listitem><para>
One line subject. (optional)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--body</option>, <option>-m</option>="BODY"</term>
<listitem><para>
Full description. (optional)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--editor</option>, <option>-e</option></term>
<listitem><para>
Open a text editor for the commit description. It will use OSTREE_EDITOR, VISUAL, EDITOR, or vi, in descending order of preference. The commit will be aborted if the message is left empty.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--branch</option>, <option>-b</option>="BRANCH"</term>
<listitem><para>
Branch. Required, unless --orphan is given.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tree</option>="dir=PATH" or "tar=TARFILE" or "ref=COMMIT"</term>
<listitem><para>
Overlay the given argument as a tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
Add a key/value pair to metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-detached-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
Add a key/value pair to detached metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-uid</option>="UID"</term>
<listitem><para>
Set file ownership user id.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-gid</option>="GID"</term>
<listitem><para>
Set file ownership group id.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-xattrs</option></term>
<listitem><para>
Do not import extended attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--link-checkout-speedup</option></term>
<listitem><para>
Optimize for commits of trees composed of hardlinks into the repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tar-autocreate-parents</option></term>
<listitem><para>
When loading tar archives, automatically create parent directories as needed.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--skip-if-unchanged</option></term>
<listitem><para>
If the contents are unchanged from previous commit, do nothing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--statoverride</option>="PATH"</term>
<listitem><para>
File containing list of modifications to make permissions (file mode, followed by space, followed by file path).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--skip-list</option>="PATH"</term>
<listitem><para>
File containing list of file paths to skip (one path per line).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--table-output</option></term>
<listitem><para>
Output more information in a KEY: VALUE format.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--generate-sizes</option></term>
<listitem><para>
Generate size information along with commit metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-sign</option>="KEY-ID"</term>
<listitem><para>
GPG Key ID with which to sign the commit (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
<listitem><para>
GPG home directory to use when looking for keyrings (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--timestamp</option>="TIMESTAMP"</term>
<listitem><para>
Override the timestamp of the commit to TIMESTAMP.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--orphan</option></term>
<listitem><para>
Create a commit without writing to a ref (branch)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--fsync</option>="POLICY"</term>
<listitem><para>
POLICY is a boolean which specifies whether fsync should be used or not. Default to true.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree commit --branch=my-branch --subject="Initial commit"</command></para>
<programlisting>
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
</programlisting>
</refsect1>
</refentry>
man/ostree-config.1
+44
View File
@@ -0,0 +1,44 @@
'\" t
.\" Title: ostree config
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree config
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CONFIG" "1" "" "OSTree" "ostree config"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-config \- Change configuration settings
.SH "SYNOPSIS"
.HP \w'\fBostree\ config\ get\fR\ 'u
\fBostree config get\fR {SECTIONNAME\&.KEYNAME}
.HP \w'\fBostree\ config\ set\fR\ 'u
\fBostree config set\fR {SECTIONNAME\&.KEYNAME} {VALUE}
.SH "DESCRIPTION"
.PP
Displays or changes a configuration setting\&.
.SH "EXAMPLE"
.PP
\fB$ ostree config get core\&.mode\fR
.PP
bare
man/ostree-config.xml
-72
View File
@@ -1,72 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 config</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 config</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-config</refname>
<refpurpose>Change configuration settings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree config get</command> <arg choice="req">SECTIONNAME.KEYNAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config set</command> <arg choice="req">SECTIONNAME.KEYNAME</arg> <arg choice="req">VALUE</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Displays or changes a configuration setting.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree config get core.mode</command></para>
<para>bare</para>
</refsect1>
</refentry>
man/ostree-diff.1
+75
View File
@@ -0,0 +1,75 @@
'\" t
.\" Title: ostree diff
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree diff
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE DIFF" "1" "" "OSTree" "ostree diff"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-diff \- Compare a directory against a revision
.SH "SYNOPSIS"
.HP \w'\fBostree\ diff\fR\ 'u
\fBostree diff\fR [OPTIONS...] {REV} {TARGETDIR}
.SH "DESCRIPTION"
.PP
Compare directory TARGETDIR against revision REV\&. Shows files and directories modified, added, and deleted\&. If there is a file in TARGETDIR not in REV, it will show with an "A" for "added"\&. If a file in REV is not in TARGETDIR, it shows "D" for "deleted"\&. "M" for "modified" will also show\&.
.SH "OPTIONS"
.PP
\fB\-\-stats\fR
.RS 4
Print various statistics\&.
.RE
.PP
\fB\-\-fs\-diff\fR
.RS 4
Print filesystem diff\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree diff my\-branch^ my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
A /testdirectory
M /helloworld\&.txt
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree diff my\-branch my\-branch^\fR
.sp
.if n \{\
.RS 4
.\}
.nf
D /testdirectory
M /helloworld\&.txt
.fi
.if n \{\
.RE
.\}
man/ostree-diff.xml
-97
View File
@@ -1,97 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 diff</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 diff</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-diff</refname>
<refpurpose>Compare a directory against a revision</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV</arg> <arg choice="req">TARGETDIR</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Compare directory TARGETDIR against revision REV. Shows files and directories modified, added, and deleted. If there is a file in TARGETDIR not in REV, it will show with an "A" for "added". If a file in REV is not in TARGETDIR, it shows "D" for "deleted". "M" for "modified" will also show.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--stats</option></term>
<listitem><para>
Print various statistics.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--fs-diff</option></term>
<listitem><para>
Print filesystem diff.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree diff my-branch^ my-branch</command></para>
<programlisting>
A /testdirectory
M /helloworld.txt
</programlisting>
<para><command>$ ostree diff my-branch my-branch^</command></para>
<programlisting>
D /testdirectory
M /helloworld.txt
</programlisting>
</refsect1>
</refentry>
man/ostree-export.1
+40
View File
@@ -0,0 +1,40 @@
'\" t
.\" Title: ostree export
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree export
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE EXPORT" "1" "" "OSTree" "ostree export"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-export \- Generate a tar archive from an OSTree commit
.SH "SYNOPSIS"
.HP \w'\fBostree\ export\fR\ 'u
\fBostree export\fR [OPTIONS...] {BRANCH}
.SH "DESCRIPTION"
.PP
This command generates a GNU tar formatted archive from an OSTree commit\&. This is useful for cases like backups, converting OSTree commits into Docker images, and the like\&.
.SH "EXAMPLE"
.PP
\fB$ ostree export exampleos/x86_64/standard | gzip > exampleos\-standard\&.tar\&.gz\fR
man/ostree-export.xml
-70
View File
@@ -1,70 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2016 Colin Walters <walters@verbum.org>
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 export</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 export</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-export</refname>
<refpurpose>Generate a tar archive from an OSTree commit</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree export</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This command generates a GNU tar formatted archive from an
OSTree commit. This is useful for cases like backups,
converting OSTree commits into Docker images, and the like.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree export exampleos/x86_64/standard | gzip > exampleos-standard.tar.gz</command></para>
</refsect1>
</refentry>
man/ostree-fsck.1
+69
View File
@@ -0,0 +1,69 @@
'\" t
.\" Title: ostree fsck
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree fsck
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE FSCK" "1" "" "OSTree" "ostree fsck"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-fsck \- Check the repository for consistency
.SH "SYNOPSIS"
.HP \w'\fBostree\ fsck\fR\ 'u
\fBostree fsck\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
Checks the repository to verify the content integrity of commit objects\&. Looks for missing and corrupted objects and metadata, and validates directory structure and metadata\&.
.SH "OPTIONS"
.PP
\fB\-\-quiet\fR,\fB\-q\fR
.RS 4
Only print error messages\&.
.RE
.PP
\fB\-\-delete\fR
.RS 4
Remove corrupted objects\&.
.RE
.PP
\fB\-\-add\-tombstones\fR
.RS 4
Add tombstone commit for referenced but missing commits\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree fsck\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Enumerating objects\&.\&.\&.
Verifying content integrity of of 2 commit objects
0/2572 objects
2571/2572 objects
.fi
.if n \{\
.RE
.\}
man/ostree-fsck.xml
-102
View File
@@ -1,102 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 fsck</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 fsck</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-fsck</refname>
<refpurpose>Check the repository for consistency</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree fsck</command><arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Checks the repository to verify the content integrity of commit objects. Looks for missing and corrupted objects and metadata, and validates directory structure and metadata.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--quiet</option>,<option>-q</option></term>
<listitem><para>
Only print error messages.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--delete</option></term>
<listitem><para>
Remove corrupted objects.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-tombstones</option></term>
<listitem><para>
Add tombstone commit for referenced but missing commits.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- What does it look like when it finds corrupted objects?-->
<refsect1>
<title>Example</title>
<para><command>$ ostree fsck</command></para>
<programlisting>
Enumerating objects...
Verifying content integrity of of 2 commit objects
0/2572 objects
2571/2572 objects
</programlisting>
</refsect1>
</refentry>
man/ostree-gpg-sign.1
+48
View File
@@ -0,0 +1,48 @@
'\" t
.\" Title: ostree gpg-sign
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree gpg-sign
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE GPG\-SIGN" "1" "" "OSTree" "ostree gpg-sign"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-gpg-sign \- Sign a commit
.SH "SYNOPSIS"
.HP \w'\fBostree\ gpg\-sign\fR\ 'u
\fBostree gpg\-sign\fR [OPTIONS...] {COMMIT} {KEY\-ID...}
.SH "DESCRIPTION"
.PP
Add a new signature to a commit for each specified GPG key\&. Note that currently, this will append a new signature even if the commit is already signed with a given key\&.
.SH "OPTIONS"
.PP
\fB\-\-delete\fR
.RS 4
Delete signatures having any of the GPG KEY\-IDs\&.
.RE
.PP
\fB\-\-gpg\-homedir\fR="HOMEDIR"
.RS 4
GPG Homedir to use when looking for keyrings\&.
.RE
man/ostree-gpg-sign.xml
-88
View File
@@ -1,88 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2015 Matthew Barnes <mbarnes@redhat.com>
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 gpg-sign</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 gpg-sign</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-gpg-sign</refname>
<refpurpose>Sign a commit</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree gpg-sign</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">KEY-ID</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Add a new signature to a commit for each specified GPG key.
Note that currently, this will append a new signature even if
the commit is already signed with a given key.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--delete</option></term>
<listitem><para>
Delete signatures having any of the GPG KEY-IDs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
<listitem><para>
GPG Homedir to use when looking for keyrings.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
man/ostree-init.1
+43
View File
@@ -0,0 +1,43 @@
'\" t
.\" Title: ostree init
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree init
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE INIT" "1" "" "OSTree" "ostree init"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-init \- Initialize a new empty repository
.SH "SYNOPSIS"
.HP \w'\fBostree\ init\fR\ 'u
\fBostree init\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
Creates a new empty repository\&.
.SH "OPTIONS"
.PP
\fB\-\-mode\fR="MODE"
.RS 4
Initialize repository in given mode (bare, archive\-z2)\&. Default is "bare"\&.
.RE
man/ostree-init.xml
-79
View File
@@ -1,79 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 (bare, archive-z2). Default is "bare".
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- This needs an example!! -->
</refentry>
man/ostree-log.1
+62
View File
@@ -0,0 +1,62 @@
'\" t
.\" Title: ostree log
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree log
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE LOG" "1" "" "OSTree" "ostree log"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-log \- Show log starting at a commit or ref
.SH "SYNOPSIS"
.HP \w'\fBostree\ log\fR\ 'u
\fBostree log\fR [OPTIONS...] {REF}
.SH "DESCRIPTION"
.PP
Shows a log of commits to a given ref or branch\&. Includes commit checksum, timestamp, and commit message\&.
.SH "OPTIONS"
.PP
\fB\-\-raw\fR
.RS 4
Show raw variant data\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree log my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
Date: 2014\-06\-12 13:42:54 +0000
This is the second commit
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
Date: 2014\-06\-12 11:20:08 +0000
Initial commit
.fi
.if n \{\
.RE
.\}
man/ostree-log.xml
-91
View File
@@ -1,91 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 log</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 log</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-log</refname>
<refpurpose>Show log starting at a commit or ref</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree log</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Shows a log of commits to a given ref or branch. Includes commit checksum, timestamp, and commit message.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
Show raw variant data.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree log my-branch</command></para>
<programlisting>
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
Date: 2014-06-12 13:42:54 +0000
This is the second commit
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
Date: 2014-06-12 11:20:08 +0000
Initial commit
</programlisting>
</refsect1>
</refentry>
man/ostree-ls.1
+80
View File
@@ -0,0 +1,80 @@
'\" t
.\" Title: ostree ls
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree ls
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE LS" "1" "" "OSTree" "ostree ls"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-ls \- List file paths
.SH "SYNOPSIS"
.HP \w'\fBostree\ ls\fR\ 'u
\fBostree ls\fR [OPTIONS...] {COMMIT} [PATHS...]
.SH "DESCRIPTION"
.PP
Prints a list of file paths within the given commit, and within the given path(s) if specified\&. The first letter of the file line output specifies the type: "\-" for regular file, "d" for directory, "l" for symbolic link\&. See EXAMPLE section for more detail on the specific output\&.
.SH "OPTIONS"
.PP
\fB\-\-dironly\fR,\fB\-d\fR
.RS 4
Do not recurse into directory arguments\&.
.RE
.PP
\fB\-\-recursive\fR,\fB\-R\fR
.RS 4
Print directories recursively\&.
.RE
.PP
\fB\-\-checksum\fR,\fB\-C\fR
.RS 4
Print checksum\&.
.RE
.PP
\fB\-\-xattrs\fR,\fB\-X\fR
.RS 4
Print extended attributes\&.
.RE
.PP
\fB\-\-nul\-filenames\-only\fR
.RS 4
Print only filenames, NUL separated\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree ls my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
d00644 0 0 0 /
\-00644 0 0 2 /helloworld\&.txt
d00755 0 0 0 /testdirectory
.fi
.if n \{\
.RE
.\}
.PP
Here, the first column is the file\-type symbol (as explained in the DESCRIPTION section) followed by the S_IFMT file type\&. The next two columns (here: 0 0) are respectively the user ID and group ID for the file\&. After the break, the next number represents that file\*(Aqs standard size\&. The final column is the file path\&.
man/ostree-ls.xml
-117
View File
@@ -1,117 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 ls</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 ls</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-ls</refname>
<refpurpose>List file paths</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree ls</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt" rep="repeat">PATHS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Prints a list of file paths within the given commit, and within the given path(s) if specified. The first letter of the file line output specifies the type: "-" for regular file, "d" for directory, "l" for symbolic link. See EXAMPLE section for more detail on the specific output.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--dironly</option>,<option>-d</option></term>
<listitem><para>
Do not recurse into directory arguments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--recursive</option>,<option>-R</option></term>
<listitem><para>
Print directories recursively.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--checksum</option>,<option>-C</option></term>
<listitem><para>
Print checksum.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--xattrs</option>,<option>-X</option></term>
<listitem><para>
Print extended attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nul-filenames-only</option></term>
<listitem><para>
Print only filenames, NUL separated.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Check this example. Are the descriptions correct?? -->
<refsect1>
<title>Example</title>
<para><command>$ ostree ls my-branch</command></para>
<programlisting>
d00644 0 0 0 /
-00644 0 0 2 /helloworld.txt
d00755 0 0 0 /testdirectory
</programlisting>
<para>Here, the first column is the file-type symbol (as explained in the DESCRIPTION section) followed by the S_IFMT file type. The next two columns (here: 0 0) are respectively the user ID and group ID for the file. After the break, the next number represents that file's standard size. The final column is the file path.</para>
</refsect1>
</refentry>
man/ostree-prune.1
+84
View File
@@ -0,0 +1,84 @@
'\" t
.\" Title: ostree prune
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree prune
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE PRUNE" "1" "" "OSTree" "ostree prune"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-prune \- Search for unreachable objects
.SH "SYNOPSIS"
.HP \w'\fBostree\ prune\fR\ 'u
\fBostree prune\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
This searches for unreachable objects in the current repository\&. If unreachable objects are found, the command delete them to free space\&. If the
\fB\-\-no\-prune\fR
option is invoked, the command will just print unreachable objects and recommend deleting them\&.
.SH "OPTIONS"
.PP
\fB\-\-no\-prune\fR
.RS 4
Only display unreachable objects; don\*(Aqt delete\&.
.RE
.PP
\fB\-\-refs\-only\fR
.RS 4
Only compute reachability via refs\&.
.RE
.PP
\fB\-\-delete\-commit\fR=COMMIT
.RS 4
Specify a COMMIT to delete\&.
.RE
.PP
\fB\-\-keep\-younger\-than\fR=DATE
.RS 4
All commits older than DATE will be pruned\&.
.RE
.PP
\fB\-\-depth\fR=DEPTH
.RS 4
Only traverse DEPTH (integer) parents for each commit (default: \-1=infinite)\&.
.RE
.PP
\fB\-\-static\-deltas\-only\fR=DEPTH
.RS 4
Change the behaviour of \-\-keep\-younger\-than and \-\-delete\-commit to prune only the static deltas files\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree prune\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Total objects: 25627
No unreachable objects
.fi
.if n \{\
.RE
.\}
man/ostree-prune.xml
-128
View File
@@ -1,128 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 prune</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 prune</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-prune</refname>
<refpurpose>Search for unreachable objects</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree prune</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This searches for unreachable objects in the current repository. If unreachable objects are found, the command delete them to free space. If the <option>--no-prune</option> option is invoked, the command will just print unreachable objects and recommend deleting them.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--no-prune</option></term>
<listitem><para>
Only display unreachable objects; don't delete.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--refs-only</option></term>
<listitem><para>
Only compute reachability via refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--delete-commit</option>=COMMIT</term>
<listitem><para>
Specify a COMMIT to delete.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--keep-younger-than</option>=DATE</term>
<listitem><para>
All commits older than DATE will be pruned.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--depth</option>=DEPTH</term>
<listitem><para>
Only traverse DEPTH (integer) parents for each commit (default: -1=infinite).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--static-deltas-only</option>=DEPTH</term>
<listitem><para>
Change the behaviour of --keep-younger-than and --delete-commit to prune only
the static deltas files.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Can we have an example for when it DOES prune? -->
<refsect1>
<title>Example</title>
<para><command>$ ostree prune</command></para>
<programlisting>
Total objects: 25627
No unreachable objects
</programlisting>
</refsect1>
</refentry>
man/ostree-pull-local.1
+68
View File
@@ -0,0 +1,68 @@
'\" t
.\" Title: ostree pull-local
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree pull-local
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE PULL\-LOCAL" "1" "" "OSTree" "ostree pull-local"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-pull-local \- Copy data from a source repository
.SH "SYNOPSIS"
.HP \w'\fBostree\ pull\-local\fR\ 'u
\fBostree pull\-local\fR [OPTIONS...] {SOURCE_REPO} [REFS...]
.SH "DESCRIPTION"
.PP
Copies data from a given repository; optimized for copies only between repositories on the same system\&.
.SH "OPTIONS"
.PP
\fB\-\-remote\fR="REMOTE"
.RS 4
Add REMOTE to refspec\&.
.RE
.PP
\fB\-\-disable\-fsync\fR
.RS 4
Do no invoke fsync()\&.
.RE
.PP
\fB\-\-untrusted\fR
.RS 4
Do not trust source, verify checksums and don\*(Aqt hardlink into source\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree pull\-local /ostree/repo\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Enumerating objects\&.\&.\&.
pull: 25709/25709 scanned, 0 objects copied
Writing 5 refs
.fi
.if n \{\
.RE
.\}
man/ostree-pull-local.xml
-104
View File
@@ -1,104 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 pull-local</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 pull-local</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-pull-local</refname>
<refpurpose>Copy data from a source repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree pull-local</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">SOURCE_REPO</arg> <arg choice="opt" rep="repeat">REFS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Copies data from a given repository; optimized for copies only between repositories on the same system.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--remote</option>="REMOTE"</term>
<listitem><para>
Add REMOTE to refspec.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-fsync</option></term>
<listitem><para>
Do no invoke fsync().
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--untrusted</option></term>
<listitem><para>
Do not trust source, verify checksums and don't hardlink into source.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- This is just copied output. Still not sure entirely what it does. Rework -->
<refsect1>
<title>Example</title>
<para><command>$ ostree pull-local /ostree/repo</command></para>
<programlisting>
Enumerating objects...
pull: 25709/25709 scanned, 0 objects copied
Writing 5 refs
</programlisting>
</refsect1>
</refentry>
man/ostree-pull.1
+98
View File
@@ -0,0 +1,98 @@
'\" t
.\" Title: ostree pull
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree pull
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE PULL" "1" "" "OSTree" "ostree pull"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-pull \- Download data from a remote repository
.SH "SYNOPSIS"
.HP \w'\fBostree\ pull\ \fR\fB{REMOTE}\fR\fB\ \fR\fB[BRANCH]\fR\ 'u
\fBostree pull \fR\fB{REMOTE}\fR\fB \fR\fB[BRANCH]\fR
.SH "OPTIONS"
.PP
\fB\-\-commit\-metadata\-only\fR
.RS 4
Fetch only the commit metadata\&.
.RE
.PP
\fB\-\-disable\-fsync\fR
.RS 4
Do no invoke fsync()\&.
.RE
.PP
\fB\-\-untrusted\fR
.RS 4
Do not trust local sources, verify checksums and don\*(Aqt hardlink into source\&.
.RE
.PP
\fB\-\-disable\-static\-deltas\fR
.RS 4
Do not use static deltas\&.
.RE
.PP
\fB\-\-mirror\fR
.RS 4
Write refs suitable for a mirror\&.
.RE
.PP
\fB\-\-subpath\fR=SUBPATH
.RS 4
Only pull the provided subpath\&.
.RE
.PP
\fB\-\-depth\fR=DEPTH
.RS 4
Traverse DEPTH parents (\-1=infinite) (default: 0)\&.
.RE
.SH "DESCRIPTION"
.PP
This command can retrieve just a specific commit, or go all the way to performing a full mirror of the remote repository\&. If no
BRANCH
is specified, all branches are retrieved\&.
.PP
A special syntax in the
@
character allows specifying a specific commit to retrieve from a branch\&. This
.SH "EXAMPLE"
.PP
\fB$ ostree \-\-repo=repo pull \-\-depth=\-1 \-\-mirror remote_name\fR
.PP
Perform a complete mirror of the remote\&. (This is likely most useful if your repository is also
archive\-z2
mode)
.PP
\fB$ ostree \-\-repo=repo pull remote_name exampleos/x86_64/standard\fR
.PP
Fetch the most recent commit to
exampleos/x86_64/standard\&.
.PP
\fB$ ostree \-\-repo=repo pull remote_name exampleos/x86_64/standard@98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4\fR
.PP
Download the specific commit starting with
98ea6e
as if it was the latest commit for
exampleos/x86_64/standard\&.
man/ostree-pull.xml
-155
View File
@@ -1,155 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 pull</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 pull</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-pull</refname>
<refpurpose>Download data from a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree pull <arg choice="req">REMOTE</arg> <arg choice="opt">BRANCH</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--commit-metadata-only</option></term>
<listitem><para>
Fetch only the commit metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-fsync</option></term>
<listitem><para>
Do no invoke fsync().
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--untrusted</option></term>
<listitem><para>
Do not trust local sources, verify checksums and don't hardlink into source.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-static-deltas</option></term>
<listitem><para>
Do not use static deltas.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--mirror</option></term>
<listitem><para>
Write refs suitable for a mirror.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subpath</option>=SUBPATH</term>
<listitem><para>
Only pull the provided subpath.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--depth</option>=DEPTH</term>
<listitem><para>
Traverse DEPTH parents (-1=infinite) (default: 0).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This command can retrieve just a specific commit, or go all
the way to performing a full mirror of the remote
repository. If no <literal>BRANCH</literal> is specified,
all branches are retrieved.
</para>
<para>
A special syntax in the <literal>@</literal> character allows
specifying a specific commit to retrieve from a branch. This
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree --repo=repo pull --depth=-1 --mirror remote_name</command></para>
<para>Perform a complete mirror of the remote. (This is
likely most useful if your repository is also
<literal>archive-z2</literal> mode)</para>
<para><command>$ ostree --repo=repo pull remote_name exampleos/x86_64/standard</command></para>
<para>Fetch the most recent commit to <literal>exampleos/x86_64/standard</literal>.</para>
<para><command>$ ostree --repo=repo pull remote_name exampleos/x86_64/standard@98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4</command></para>
<para>Download the specific commit starting with
<literal>98ea6e</literal> as if it was the latest commit for
<literal>exampleos/x86_64/standard</literal>.</para>
</refsect1>
</refentry>
man/ostree-refs.1
+67
View File
@@ -0,0 +1,67 @@
'\" t
.\" Title: ostree refs
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree refs
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE REFS" "1" "" "OSTree" "ostree refs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-refs \- List refs
.SH "SYNOPSIS"
.HP \w'\fBostree\ refs\fR\ 'u
\fBostree refs\fR [OPTIONS...] [PREFIX]
.SH "DESCRIPTION"
.PP
Lists all refs available on the host\&. If specified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs\&.
.SH "OPTIONS"
.PP
\fB\-\-list\fR
.RS 4
For historical reasons,
refs
without this option will strip the specified prefix from the output\&. Normally, one wants to see the full ref, so providing this option ensures the refs are printed in full, rather than truncated\&.
.RE
.PP
\fB\-\-delete\fR
.RS 4
Delete refs which match PREFIX, rather than listing them\&. If you are trying to reclaim space, you will then need to
\fBostree prune\fR
or
\fBostree admin cleanup\fR\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree refs\fR
.sp
.if n \{\
.RS 4
.\}
.nf
my\-branch
gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}
man/ostree-refs.xml
-97
View File
@@ -1,97 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 refs</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 refs</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-refs</refname>
<refpurpose>List refs</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree refs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg>
</cmdsynopsis>
</refsynopsisdiv>
<!-- Could this be more specific? What defines a "ref"? etc -->
<refsect1>
<title>Description</title>
<para>
Lists all refs available on the host. If specified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--list</option></term>
<listitem><para> For historical reasons, <literal>refs</literal>
without this option will strip the specified prefix
from the output. Normally, one wants to see the full
ref, so providing this option ensures the refs are
printed in full, rather than
truncated. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--delete</option></term>
<listitem><para>
Delete refs which match PREFIX, rather than listing them. If you are trying to reclaim space,
you will then need to <command>ostree prune</command> or <command>ostree admin cleanup</command>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree refs</command></para>
<programlisting>
my-branch
gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
</refsect1>
</refentry>
man/ostree-remote.1
+122
View File
@@ -0,0 +1,122 @@
'\" t
.\" Title: ostree remote
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree remote
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE REMOTE" "1" "" "OSTree" "ostree remote"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-remote \- Control remote repository configuration
.SH "SYNOPSIS"
.HP \w'\fBostree\ remote\ add\fR\ 'u
\fBostree remote add\fR [OPTIONS...] {NAME} {URL} [BRANCH...]
.HP \w'\fBostree\ remote\ delete\fR\ 'u
\fBostree remote delete\fR {NAME}
.HP \w'\fBostree\ remote\ show\-url\fR\ 'u
\fBostree remote show\-url\fR {NAME}
.HP \w'\fBostree\ remote\ list\fR\ 'u
\fBostree remote list\fR [OPTIONS...] {NAME}
.HP \w'\fBostree\ remote\ gpg\-import\fR\ 'u
\fBostree remote gpg\-import\fR [OPTIONS...] {NAME} [KEY\-ID...]
.HP \w'\fBostree\ remote\ refs\fR\ 'u
\fBostree remote refs\fR {NAME}
.HP \w'\fBostree\ remote\ summary\fR\ 'u
\fBostree remote summary\fR [OPTIONS...] {NAME}
.SH "DESCRIPTION"
.PP
Changes remote respository configurations\&. The NAME refers to the name of the remote\&.
.PP
The
\fBgpg\-import\fR
subcommand can associate GPG keys to a specific remote respository for use when pulling signed commits from that repository (if GPG verification is enabled)\&.
.PP
The GPG keys to import may be in binary OpenPGP format or ASCII armored\&. The optional
[KEY\-ID]
list can restrict which keys are imported from a keyring file or input stream\&. All keys are imported if this list is omitted\&. If neither
\fB\-\-keyring\fR
nor
\fB\-\-stdin\fR
options are given, then keys are imported from the user\*(Aqs personal GPG keyring\&.
.SH "'ADD' OPTIONS"
.PP
\fB\-\-set\fR="KEY=VALUE"
.RS 4
Set config option KEY=VALUE for remote\&.
.RE
.PP
\fB\-\-no\-gpg\-verify\fR
.RS 4
Disable GPG verification\&.
.RE
.PP
\fB\-\-gpg\-import\fR=FILE
.RS 4
Import one or more GPG keys from a file\&.
.sp
Equivalent to
\fBostree remote gpg\-import \-\-keyring=FILE\fR\&.
.RE
.SH "'LIST' OPTIONS"
.PP
\fB\-u, \-\-show\-urls\fR
.RS 4
Show remote URLs in list
.RE
.SH "'GPG-IMPORT' OPTIONS"
.PP
\fB\-k, \-\-keyring\fR=FILE
.RS 4
Import one or more keys from a file\&.
.sp
This option may be repeated to import from multiple files, but may not be used in combination with
\fB\-\-stdin\fR\&.
.RE
.PP
\fB\-\-stdin\fR
.RS 4
Import one or more keys from standard input\&.
.sp
This option may not be used in combination with
\fB\-\-keyring\fR\&.
.RE
.SH "'SUMMARY' OPTIONS"
.PP
\fB\-\-raw\fR
.RS 4
Show raw variant data
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree remote show\-url local\fR
.sp
.if n \{\
.RS 4
.\}
.nf
http://192\&.168\&.122\&.1/repo
.fi
.if n \{\
.RE
.\}
man/ostree-remote.xml
-184
View File
@@ -1,184 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 remote</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 remote</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-remote</refname>
<refpurpose>Control remote repository configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree remote add</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg> <arg choice="req">URL</arg> <arg choice="opt" rep="repeat">BRANCH</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote delete</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote show-url</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote list</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote gpg-import</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg> <arg choice="opt" rep="repeat">KEY-ID</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote refs</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Changes remote respository configurations. The NAME refers to the name of the remote.
</para>
<para>
The <command>gpg-import</command> subcommand can associate GPG keys to a specific remote respository for use when pulling signed commits from that repository (if GPG verification is enabled).
</para>
<para>
The GPG keys to import may be in binary OpenPGP format or ASCII armored. The optional <arg>KEY-ID</arg> list can restrict which keys are imported from a keyring file or input stream. All keys are imported if this list is omitted. If neither <option>--keyring</option> nor <option>--stdin</option> options are given, then keys are imported from the user's personal GPG keyring.
</para>
</refsect1>
<refsect1>
<title>'Add' Options</title>
<variablelist>
<varlistentry>
<term><option>--set</option>="KEY=VALUE"</term>
<listitem><para>
Set config option KEY=VALUE for remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-gpg-verify</option></term>
<listitem><para>
Disable GPG verification.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-import</option>=FILE</term>
<listitem><para>
Import one or more GPG keys from a file.
</para><para>
Equivalent to
<command>ostree remote gpg-import --keyring=FILE</command>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>'List' Options</title>
<variablelist>
<varlistentry>
<term><option>-u, --show-urls</option></term>
<listitem><para>
Show remote URLs in list
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>'GPG-Import' Options</title>
<variablelist>
<varlistentry>
<term><option>-k, --keyring</option>=FILE</term>
<listitem><para>
Import one or more keys from a file.
</para><para>
This option may be repeated to import from multiple files,
but may not be used in combination with
<option>--stdin</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--stdin</option></term>
<listitem><para>
Import one or more keys from standard input.
</para><para>
This option may not be used in combination with
<option>--keyring</option>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>'Summary' Options</title>
<variablelist>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
Show raw variant data
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree remote show-url local</command></para>
<programlisting>
http://192.168.122.1/repo
</programlisting>
</refsect1>
</refentry>
man/ostree-reset.1
+72
View File
@@ -0,0 +1,72 @@
'\" t
.\" Title: ostree reset
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree reset
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE RESET" "1" "" "OSTree" "ostree reset"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-reset \- Reset a ref to a previous commit
.SH "SYNOPSIS"
.HP \w'\fBostree\ reset\ \fR\ 'u
\fBostree reset \fR {REF} {REF_TO_RESET_TO}
.SH "DESCRIPTION"
.PP
Given a commit, this command will reset the ref to a previous specified commit\&.
.SH "EXAMPLE"
.PP
\fB$ ostree log my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07
Date: 2014\-06\-12 13:42:54 +0000
This is the second commit
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1c
Date: 2014\-06\-12 11:20:08 +0000
Initial commit
.fi
.if n \{\
.RE
.\}
.PP
\fB$ ostree reset my\-branch my\-branch^\fR
.PP
\fB$ ostree log my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1c
Date: 2014\-06\-12 11:20:08 +0000
Initial commit
.fi
.if n \{\
.RE
.\}
man/ostree-reset.xml
-85
View File
@@ -1,85 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 reset</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 reset</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-reset</refname>
<refpurpose>Reset a ref to a previous commit</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree reset </command> <arg choice="req">REF</arg> <arg choice="req">REF_TO_RESET_TO</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Given a commit, this command will reset the ref to a previous specified commit.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree log my-branch</command></para>
<programlisting>
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07
Date: 2014-06-12 13:42:54 +0000
This is the second commit
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1c
Date: 2014-06-12 11:20:08 +0000
Initial commit
</programlisting>
<para><command>$ ostree reset my-branch my-branch^</command></para>
<para><command>$ ostree log my-branch</command></para>
<programlisting>
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1c
Date: 2014-06-12 11:20:08 +0000
Initial commit
</programlisting>
</refsect1>
</refentry>
man/ostree-rev-parse.1
+50
View File
@@ -0,0 +1,50 @@
'\" t
.\" Title: ostree rev-parse
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree rev-parse
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE REV\-PARSE" "1" "" "OSTree" "ostree rev-parse"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-rev-parse \- Output the target of a rev
.SH "SYNOPSIS"
.HP \w'\fBostree\ rev\-parse\ \fR\ 'u
\fBostree rev\-parse \fR {REV} {PATH}
.SH "DESCRIPTION"
.PP
Given a REV, outputs the checksum of the latest commit of that revision\&.
.SH "EXAMPLE"
.PP
\fB$ ostree rev\-parse my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
.fi
.if n \{\
.RE
.\}
man/ostree-rev-parse.xml
-73
View File
@@ -1,73 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 rev-parse</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 rev-parse</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-rev-parse</refname>
<refpurpose>Output the target of a rev</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree rev-parse </command> <arg choice="req">REV</arg> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<!-- Is this accurate for all cases? This is what I observed -->
<refsect1>
<title>Description</title>
<para>
Given a REV, outputs the checksum of the latest commit of that revision.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree rev-parse my-branch</command></para>
<programlisting>
ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
</programlisting>
</refsect1>
</refentry>
man/ostree-show.1
+84
View File
@@ -0,0 +1,84 @@
'\" t
.\" Title: ostree show
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree show
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE SHOW" "1" "" "OSTree" "ostree show"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-show \- Output a metadata object
.SH "SYNOPSIS"
.HP \w'\fBostree\ show\fR\ 'u
\fBostree show\fR [OPTIONS...] {OBJECT}
.SH "DESCRIPTION"
.PP
Given an object, shows the metadata for that object\&. For a particular revision, it will show the data for the most recent commit to that revision\&.
.SH "OPTIONS"
.PP
\fB\-\-print\-related\fR
.RS 4
Show the "related" commits\&.
.RE
.PP
\fB\-\-print\-variant\-type\fR="TYPE"
.RS 4
Memory map
\fIOBJECT\fR
(in this case a filename) to the GVariant type string\&.
.RE
.PP
\fB\-\-print\-metadata\-key\fR="KEY"
.RS 4
Print string value of metadata key\&.
.RE
.PP
\fB\-\-print\-detached\-metadata\-key\fR="KEY"
.RS 4
Print string value of detached metadata key\&.
.RE
.PP
\fB\-\-raw\fR
.RS 4
Show raw variant data\&.
.RE
.PP
\fB\-\-gpg\-homedir\fR="HOMEDIR"
.RS 4
GPG home directory to use when looking for keyrings (if have GPGME \- GNU Privacy Guard Made Easy)\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree show my\-branch\fR
.sp
.if n \{\
.RS 4
.\}
.nf
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07
Date: 2014\-06\-12 13:42:54 +0000
.fi
.if n \{\
.RE
.\}
man/ostree-show.xml
-126
View File
@@ -1,126 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 show</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 show</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-show</refname>
<refpurpose>Output a metadata object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree show</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OBJECT</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Given an object, shows the metadata for that object. For a particular revision, it will show the data for the most recent commit to that revision.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--print-related</option></term>
<listitem><para>
Show the "related" commits.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-variant-type</option>="TYPE"</term>
<listitem><para>
Memory map <replaceable>OBJECT</replaceable> (in this case a filename) to the GVariant type string.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of metadata key.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-detached-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of detached metadata key.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
Show raw variant data.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
<listitem><para>
GPG home directory to use when looking for keyrings (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree show my-branch</command></para>
<programlisting>
commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07
Date: 2014-06-12 13:42:54 +0000
</programlisting>
</refsect1>
</refentry>
man/ostree-static-delta.1
+79
View File
@@ -0,0 +1,79 @@
'\" t
.\" Title: ostree static-delta
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree static-delta
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE STATIC\-DELTA" "1" "" "OSTree" "ostree static-delta"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-static-delta \- Manage static delta files
.SH "SYNOPSIS"
.HP \w'\fBostree\ static\-delta\ list\fR\ 'u
\fBostree static\-delta list\fR
.HP \w'\fBostree\ static\-delta\ show\fR\ 'u
\fBostree static\-delta show\fR
.HP \w'\fBostree\ static\-delta\ delete\fR\ 'u
\fBostree static\-delta delete\fR
.HP \w'\fBostree\ static\-delta\ generate\fR\ 'u
\fBostree static\-delta generate\fR {\-\-to=REV} [OPTIONS...]
.HP \w'\fBostree\ static\-delta\ apply\-offline\fR\ 'u
\fBostree static\-delta apply\-offline\fR {PATH}
.SH "DESCRIPTION"
.PP
List and manipulate static delta files\&.
.SH "'GENERATE' OPTIONS"
.PP
\fB\-\-from\fR="REV"
.RS 4
Create delta from revision REV\&.
.RE
.PP
\fB\-\-to\fR="REV"
.RS 4
Create delta to revision REV\&. (This option is required\&.)
.RE
.PP
\fB\-\-empty\fR
.RS 4
Create delta from scratch\&.
.RE
.PP
\fB\-\-max\-usize\fR=SIZE
.RS 4
Maximum uncompressed size in megabytes\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree static\-delta\fR
.sp
.if n \{\
.RS 4
.\}
.nf
(No static deltas)
.fi
.if n \{\
.RE
.\}
man/ostree-static-delta.xml
-123
View File
@@ -1,123 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
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 static-delta</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 static-delta</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-static-delta</refname>
<refpurpose>Manage static delta files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree static-delta list</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta show</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta delete</command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta generate</command> <arg choice="req">--to=REV</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree static-delta apply-offline</command> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
List and manipulate static delta files.
</para>
</refsect1>
<refsect1>
<title>'Generate' Options</title>
<variablelist>
<varlistentry>
<term><option>--from</option>="REV"</term>
<listitem><para>
Create delta from revision REV.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--to</option>="REV"</term>
<listitem><para>
Create delta to revision REV. (This option is required.)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--empty</option></term>
<listitem><para>
Create delta from scratch.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--max-usize</option>=SIZE</term>
<listitem><para>
Maximum uncompressed size in megabytes.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- Can we have an example for when it actually does something?-->
<refsect1>
<title>Example</title>
<para><command>$ ostree static-delta</command></para>
<programlisting>
(No static deltas)
</programlisting>
</refsect1>
</refentry>
man/ostree-summary.1
+55
View File
@@ -0,0 +1,55 @@
'\" t
.\" Title: ostree summary
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree summary
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE SUMMARY" "1" "" "OSTree" "ostree summary"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-summary \- Regenerate the summary metadata file
.SH "SYNOPSIS"
.HP \w'\fBostree\ summary\fR\ 'u
\fBostree summary\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
The
summary
file is an optional higher level form of repository metadata that describes the available branches\&. It needs to be manually regenerated after a series of commits\&. Among other things, this allows atomically updating multiple commits\&.
.SH "OPTIONS"
.PP
\fB\-u\fR
.RS 4
Update the summary file\&.
.RE
.PP
\fB\-\-gpg\-sign\fR=KEYID
.RS 4
GPG Key ID to sign the delta with\&.
.RE
.PP
\fB\-\-gpg\-homedir\fR=HOMEDIR
.RS 4
GPG Homedir to use when looking for keyrings\&.
.RE
man/ostree-summary.xml
-98
View File
@@ -1,98 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Colin Walters <walters@verbum.org>
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 summary</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 summary</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-summary</refname>
<refpurpose>Regenerate the summary metadata file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <filename>summary</filename> file is an optional higher
level form of repository metadata that describes the
available branches. It needs to be manually regenerated after
a series of commits. Among other things, this allows atomically
updating multiple commits.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-u</option></term>
<listitem><para>
Update the summary file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-sign</option>=KEYID</term>
<listitem><para>
GPG Key ID to sign the delta with.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>=HOMEDIR</term>
<listitem><para>
GPG Homedir to use when looking for keyrings.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
man/ostree-trivial-httpd.1
+66
View File
@@ -0,0 +1,66 @@
'\" t
.\" Title: ostree trivial-httpd
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree trivial-httpd
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE TRIVIAL\-HTTP" "1" "" "OSTree" "ostree trivial-httpd"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-trivial-httpd \- Simple webserver
.SH "SYNOPSIS"
.HP \w'\fBostree\ trivial\-httpd\fR\ 'u
\fBostree trivial\-httpd\fR [OPTIONS...] [DIR]
.SH "DESCRIPTION"
.PP
This runs a simple webserver and keeps it running until killed\&. If DIR is not specified, it defaults to the current directory\&.
.SH "OPTIONS"
.PP
\fB\-\-daemonize\fR,\fB\-d\fR
.RS 4
Fork into background when ready\&.
.RE
.PP
\fB\-\-autoexit\fR
.RS 4
Automatically exit when directory is deleted\&.
.RE
.PP
\fB\-\-port\-file\fR,\fB\-p\fR="PATH"
.RS 4
Write port number to PATH (\- for standard output)\&.
.RE
.PP
\fB\-\-port\fR,\fB\-P\fR
.RS 4
Use the specified TCP port to listen on\&.
.RE
.PP
\fB\-\-force\-range\-requests\fR
.RS 4
Force range requests by only serving half of files\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree trivial\-httpd\fR
man/ostree-trivial-httpd.xml
-116
View File
@@ -1,116 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2011,2013 Colin Walters <walters@verbum.org>
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 trivial-httpd</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 trivial-httpd</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-trivial-httpd</refname>
<refpurpose>Simple webserver</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree trivial-httpd</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">DIR</arg>
</cmdsynopsis>
</refsynopsisdiv>
<!-- Don't entirely understand this command. Needs details, better content-->
<refsect1>
<title>Description</title>
<para>
This runs a simple webserver and keeps it running until killed. If DIR is not specified, it defaults to the current directory.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--daemonize</option>,<option>-d</option></term>
<listitem><para>
Fork into background when ready.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--autoexit</option></term>
<listitem><para>
Automatically exit when directory is deleted.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--port-file</option>,<option>-p</option>="PATH"</term>
<listitem><para>
Write port number to PATH (- for standard output).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--port</option>,<option>-P</option></term>
<listitem><para>
Use the specified TCP port to listen on.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--force-range-requests</option></term>
<listitem><para>
Force range requests by only serving half of files.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- NEED EXAMPLE OUTPUT HERE!-->
<refsect1>
<title>Example</title>
<para><command>$ ostree trivial-httpd</command></para>
</refsect1>
</refentry>
man/ostree.1
+261
View File
@@ -0,0 +1,261 @@
'\" t
.\" Title: ostree
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE" "1" "" "OSTree" "ostree"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree \- Manage multiple bootable versioned filesystem trees
.SH "SYNOPSIS"
.HP \w'\fBostree\fR\ 'u
\fBostree\fR {COMMAND} [OPTIONS...]
.SH "DESCRIPTION"
.PP
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
/ostree
directory\&. Each installed system gets its own
/ostree/deploy/\fIosname\fR
directory\&.
.PP
Unlike
rpm
or
dpkg, OSTree is only aware of complete filesystem trees\&. It has no built\-in knowledge of what components went into creating the filesystem tree\&.
.PP
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\&.
.PP
It must be emphasized that OSTree only supports
\fIread\-only\fR
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\&.
.PP
To see the man page for a command run
\fBman ostree \fR\fB\fICOMMAND\fR\fR
or
\fBman ostree\-admin \fR\fB\fICOMMAND\fR\fR
.SH "OPTIONS"
.PP
The following options are understood:
.PP
\fB\-\-repo\fR
.RS 4
For most commands, when run as non\-root, repository is required\&. If
\fBostree\fR
is run as root, it is assumed operations will be performed on the
/sysroot/ostree/repo
repository\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Produce debug level output\&.
.RE
.SH "COMMANDS"
.PP
System administrators will primarily interact with OSTree via the subcommand
\fBostree admin\fR\&.
.PP
\fBostree-admin-cleanup\fR(1)
.RS 4
\ \&Delete untagged deployments and repository objects\&.
.RE
.PP
\fBostree-admin-config-diff\fR(1)
.RS 4
\ \&See changes to
/etc
as compared to the current default (from
/usr/etc)\&.
.RE
.PP
\fBostree-admin-deploy\fR(1)
.RS 4
\ \&Takes a particular commit or revision, and sets it up for the next boot\&.
.RE
.PP
\fBostree-admin-init-fs\fR(1)
.RS 4
\ \&Initialize a root filesystem in a specified path\&.
.RE
.PP
\fBostree-admin-instutil\fR(1)
.RS 4
\ \&Utility functions intended primarily for operating system installation programs
.RE
.PP
\fBostree-admin-os-init\fR(1)
.RS 4
\ \&Initialize the deployment location for an operating system with a specified name\&.
.RE
.PP
\fBostree-admin-status\fR(1)
.RS 4
\ \&Show and list the deployments\&.
.RE
.PP
\fBostree-admin-switch\fR(1)
.RS 4
\ \&Choose a different ref to track from the same remote as the current tree\&.
.RE
.PP
\fBostree-admin-undeploy\fR(1)
.RS 4
\ \&Remove the previously
\fIINDEX\fR
deployed tree from the bootloader configuration\&.
.RE
.PP
\fBostree-admin-upgrade\fR(1)
.RS 4
\ \&Download the latest version for the current ref, and deploy it\&.
.RE
.PP
Both administrators and operating system builders may interact with OSTree via the regular filesystem manipulation commands\&.
.PP
\fBostree-cat\fR(1)
.RS 4
\ \&Concatenate contents of files
.RE
.PP
\fBostree-checkout\fR(1)
.RS 4
\ \&Check out a commit into a filesystem tree\&.
.RE
.PP
\fBostree-checksum\fR(1)
.RS 4
\ \&Gives checksum of any file\&.
.RE
.PP
\fBostree-commit\fR(1)
.RS 4
\ \&Given one or more trees, create a new commit using those contents\&.
.RE
.PP
\fBostree-config\fR(1)
.RS 4
\ \&Change settings\&.
.RE
.PP
\fBostree-diff\fR(1)
.RS 4
\ \&Concisely list differences between the given refs\&.
.RE
.PP
\fBostree-fsck\fR(1)
.RS 4
\ \&Check a repository for consistency\&.
.RE
.PP
\fBostree-init\fR(1)
.RS 4
\ \&Initialize a new repository\&.
.RE
.PP
\fBostree-log\fR(1)
.RS 4
\ \&Show revision log\&.
.RE
.PP
\fBostree-ls\fR(1)
.RS 4
\ \&List the contents of a given commit\&.
.RE
.PP
\fBostree-prune\fR(1)
.RS 4
\ \&Search for unreachable objects\&.
.RE
.PP
\fBostree-pull-local\fR(1)
.RS 4
\ \&Copy data from source\-repo\&.
.RE
.PP
\fBostree-pull\fR(1)
.RS 4
\ \&Download data from remote repo\&. If you have libsoup\&.
.RE
.PP
\fBostree-refs\fR(1)
.RS 4
\ \&List refs\&.
.RE
.PP
\fBostree-remote\fR(1)
.RS 4
\ \&Manipulate remote archive configuration\&.
.RE
.PP
\fBostree-reset\fR(1)
.RS 4
\ \&Reset a ref to a previous commit\&.
.RE
.PP
\fBostree-rev-parse\fR(1)
.RS 4
\ \&Show the SHA256 corresponding to a given rev\&.
.RE
.PP
\fBostree-show\fR(1)
.RS 4
\ \&Given an OSTree SHA256 checksum, display its contents\&.
.RE
.PP
\fBostree-static-delta\fR(1)
.RS 4
\ \&Manage static delta files\&.
.RE
.PP
\fBostree-summary\fR(1)
.RS 4
\ \&Regenerate the repository summary metadata\&.
.RE
.PP
\fBostree-trivial-httpd\fR(1)
.RS 4
\ \&Simple webserver\&.
.RE
.SH "EXAMPLES"
.PP
For specific examples, please see the man page regarding the specific ostree command\&. For example:
.PP
\fBman ostree init\fR
or
\fBman ostree\-admin status\fR
.SH "GPG VERIFICATION"
.PP
OSTree supports signing commits with GPG\&. Operations on the system repository by default use keyring files in
/usr/share/ostree/trusted\&.gpg\&.d\&. 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\&.
.PP
In addition to the system repository, OSTree supports a per\-remote
\fIremotename\fR\&.trustedkeys\&.gpg
file stored in the toplevel of the repository (alongside
objects/
and such)\&. This is particularly useful when downloading content that may not be fully trusted (e\&.g\&. you want to inspect it but not deploy it as an OS), or use it for containers\&. This file is written via
\fBostree remote add \-\-gpg\-import\fR\&.
.SH "SEE ALSO"
.PP
\fBostree.repo\fR(5)
man/ostree.repo-config.5
+151
View File
@@ -0,0 +1,151 @@
'\" t
.\" Title: ostree.repo-config
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree.repo-config
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE\&.REPO\-CONFI" "5" "" "OSTree" "ostree.repo-config"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree.repo-config \- OSTree repository configuration
.SH "DESCRIPTION"
.PP
The
config
file in an OSTree repository is a "keyfile" in the
\m[blue]\fBXDG Desktop Entry Specification\fR\m[]\&\s-2\u[1]\d\s+2
format\&. It has several global flags, as well as zero or more remote entries which describe how to access remote repositories\&.
.PP
See
\fBostree.repo\fR(5)
for more information about OSTree repositories\&.
.SH "[CORE] SECTION OPTIONS"
.PP
Repository\-global options\&. The following entries are defined:
.PP
\fImode\fR
.RS 4
One of
bare
or
archive\-z2\&.
.RE
.PP
\fIrepo_version\fR
.RS 4
Currently, this must be set to
1\&.
.RE
.PP
\fIcommit\-update\-summary\fR
.RS 4
Boolean value controlling whether or not to automatically update the summary file after a commit\&. Defaults to
false\&.
.RE
.PP
\fIfsync\fR
.RS 4
Boolean value controlling whether or not to ensure files are on stable storage when performing operations such as commits, pulls, and checkouts\&. Defaults to
true\&.
.sp
If you disable fsync, OSTree will no longer be robust against kernel crashes or power loss\&.
.sp
You might choose to disable this for local development repositories, under the assumption they can be recreated from source\&. Similarly, you could disable for a mirror where you could re\-pull\&.
.sp
For the system repository, you might choose to disable fsync if you have uninterruptable power supplies and a well tested kernel\&.
.RE
.SH "[REMOTE "NAME"] SECTION OPTIONS"
.PP
Describes a remote repository location\&.
.PP
\fIurl\fR
.RS 4
Must be present; declares URL for accessing this remote\&. The only supported schemes are the moment are
file,
http, and
https\&.
.RE
.PP
\fIproxy\fR
.RS 4
A string value, if given should be a URL for a HTTP proxy to use for access to this repository\&.
.RE
.PP
\fIgpg\-verify\fR
.RS 4
A boolean value, defaults to true\&. Controls whether or not OSTree will require commits to be signed by a known GPG key\&. For more information, see the
\fBostree\fR(1)
manual under GPG\&.
.RE
.PP
\fIgpg\-verify\-summary\fR
.RS 4
A boolean value, defaults to false\&. Controls whether or not OSTree will check if the summary is signed by a known GPG key\&. For more information, see the
\fBostree\fR(1)
manual under GPG\&.
.RE
.PP
\fItls\-permissive\fR
.RS 4
A boolean value, defaults to false\&. By default, server TLS certificates will be checked against the system certificate store\&. If this variable is set, any certificate will be accepted\&.
.RE
.PP
\fItls\-client\-cert\-path\fR
.RS 4
Path to file for client\-side certificate, to present when making requests to this repository\&.
.RE
.PP
\fItls\-client\-key\-path\fR
.RS 4
Path to file containing client\-side certificate key, to present when making requests to this repository\&.
.RE
.PP
\fItls\-ca\-path\fR
.RS 4
Path to file containing trusted anchors instead of the system CA database\&.
.RE
.SH "/ETC/OSTREE/REMOTES.D"
.PP
In addition to the
/ostree/repo/config
file, remotes may also be specified in
/etc/ostree/remotes\&.d\&. The remote configuration file must end in
\&.conf; files whose name does not end in
\&.conf
will be ignored\&.
.SH "PER-REMOTE GPG KEYRINGS AND VERIFICATION"
.PP
OSTree supports a per\-remote GPG keyring\&. For more information see
\fBostree\fR(1)\&. in the section
GPG verification\&.
.SH "SEE ALSO"
.PP
\fBostree\fR(1),
\fBostree.repo\fR(5)
.SH "NOTES"
.IP " 1." 4
XDG Desktop Entry Specification
.RS 4
\%http://standards.freedesktop.org/desktop-entry-spec/latest/
.RE
man/ostree.repo-config.xml
-214
View File
@@ -1,214 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Colin Walters <walters@verbum.org>
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.repo-config">
<refentryinfo>
<title>ostree.repo-config</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.repo-config</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree.repo-config</refname>
<refpurpose>OSTree repository configuration</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
The <filename>config</filename> file in an OSTree
repository is a "keyfile" in the <ulink
url="http://standards.freedesktop.org/desktop-entry-spec/latest/">XDG
Desktop Entry Specification</ulink> format. It has
several global flags, as well as zero or more remote
entries which describe how to access remote
repositories.
</para>
<para>
See <citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information
about OSTree repositories.
</para>
</refsect1>
<refsect1>
<title>[core] Section Options</title>
<para>
Repository-global options. The following entries are defined:
</para>
<variablelist>
<varlistentry>
<term><varname>mode</varname></term>
<listitem><para>One of <literal>bare</literal> or <literal>archive-z2</literal>. </para></listitem>
</varlistentry>
<varlistentry>
<term><varname>repo_version</varname></term>
<listitem><para>Currently, this must be set to <literal>1</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>commit-update-summary</varname></term>
<listitem><para>Boolean value controlling whether or not to
automatically update the summary file after a commit. Defaults
to <literal>false</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>fsync</varname></term>
<listitem><para>Boolean value controlling whether or not to
ensure files are on stable storage when performing operations
such as commits, pulls, and checkouts. Defaults to
<literal>true</literal>.</para>
<para>
If you disable fsync, OSTree will no longer be robust
against kernel crashes or power loss.
</para>
<para>
You might choose to disable this for local development
repositories, under the assumption they can be recreated from
source. Similarly, you could disable for a mirror where you could
re-pull.
</para>
<para>
For the system repository, you might choose to disable fsync
if you have uninterruptable power supplies and a well tested
kernel.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[remote "name"] Section Options</title>
<para>
Describes a remote repository location.
</para>
<variablelist>
<varlistentry>
<term><varname>url</varname></term>
<listitem><para>Must be present; declares URL for accessing
this remote. The only supported schemes are the moment are
<literal>file</literal>, <literal>http</literal>, and
<literal>https</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>proxy</varname></term>
<listitem><para>A string value, if given should be a URL for a
HTTP proxy to use for access to this repository.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>gpg-verify</varname></term>
<listitem><para>A boolean value, defaults to true.
Controls whether or not OSTree will require commits to be
signed by a known GPG key. For more information, see the
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
manual under GPG.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>gpg-verify-summary</varname></term>
<listitem><para>A boolean value, defaults to false.
Controls whether or not OSTree will check if the summary
is signed by a known GPG key.
For more information, see the <citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
manual under GPG.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tls-permissive</varname></term>
<listitem><para>A boolean value, defaults to false. By
default, server TLS certificates will be checked against the
system certificate store. If this variable is set, any
certificate will be accepted.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tls-client-cert-path</varname></term>
<listitem><para>Path to file for client-side certificate, to present when making requests to this repository.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tls-client-key-path</varname></term>
<listitem><para>Path to file containing client-side certificate key, to present when making requests to this repository.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tls-ca-path</varname></term>
<listitem><para>Path to file containing trusted anchors instead of the system CA database.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>/etc/ostree/remotes.d</title>
<para>
In addition to the <filename>/ostree/repo/config</filename>
file, remotes may also be specified in
<filename>/etc/ostree/remotes.d</filename>. The remote
configuration file must end in <literal>.conf</literal>; files
whose name does not end in <literal>.conf</literal> will be
ignored.
</para>
</refsect1>
<refsect1>
<title>Per-remote GPG keyrings and verification</title>
<para>
OSTree supports a per-remote GPG keyring. For more information see
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
in the section <literal>GPG verification</literal>.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
man/ostree.repo.5
+55
View File
@@ -0,0 +1,55 @@
'\" t
.\" Title: ostree.repo
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: ostree.repo
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE\&.REPO" "5" "" "OSTree" "ostree.repo"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree.repo \- OSTree repository configuration and layout
.SH "DESCRIPTION"
.PP
An OSTree repository is structurally similar to a git repository; it is a content\-addressed object store containing filesystem trees\&. However, unlike git, ostree is designed to store operating system binaries\&. It records the Unix uid and gid, permissions, as well as extended attributes\&.
.PP
A repository can be in one of two modes;
bare, which is designed as a hard link source for operating system checkouts, and
archive\-z2, which is designed for static HTTP servers\&.
.PP
There is a system repository located at
/ostree/repo\&. If no repository is specified \-\- either by a command\-line option or the
\fBOSTREE_REPO\fR
environment variable \-\- the
\fBostree\fR
as well as many API calls will use it by default\&.
.SH "COMPONENTS OF A REPOSITORY"
.PP
The only user\-editable component is the
config
file\&. For more information, see
\fBostree.repo-config\fR(5)\&.
.SH "SEE ALSO"
.PP
\fBostree\fR(1),
\fBostree.repo-config\fR(1)
man/ostree.repo.xml
-96
View File
@@ -1,96 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Colin Walters <walters@verbum.org>
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.repo">
<refentryinfo>
<title>ostree.repo</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.repo</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree.repo</refname>
<refpurpose>OSTree repository configuration and layout</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
An OSTree repository is structurally similar to a
git repository; it is a content-addressed object
store containing filesystem trees. However, unlike
git, ostree is designed to store operating system
binaries. It records the Unix uid and gid,
permissions, as well as extended attributes.
</para>
<para>
A repository can be in one of two modes;
<literal>bare</literal>, which is designed as a hard
link source for operating system checkouts, and
<literal>archive-z2</literal>, which is designed for
static HTTP servers.
</para>
<para>
There is a system repository located at
<filename>/ostree/repo</filename>. If no repository
is specified -- either by a command-line option or the
<envar>OSTREE_REPO</envar> environment variable --
the <command>ostree</command> as well as many API
calls will use it by default.
</para>
</refsect1>
<refsect1>
<title>Components of a repository</title>
<para>
The only user-editable component is the
<filename>config</filename> file. For more
information, see <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
man/ostree.xml
-455
View File
@@ -1,455 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2011,2013 Colin Walters <walters@verbum.org>
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</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>
<command>ostree</command>
<arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</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>
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>
</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>
<varlistentry>
<term><option>-v, --verbose</option></term>
<listitem><para>
Produce debug level output.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<para>System administrators will primarily interact
with OSTree via the subcommand <command>ostree
admin</command>.</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Delete untagged
deployments and repository objects.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;See changes to
<filename>/etc</filename> as compared
to the current default (from
<filename>/usr/etc</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Takes a particular
commit or revision, and sets it up for
the next boot.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize a root filesystem
in a specified path.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Utility functions intended primarily for operating system installation programs
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize the
deployment location for an operating
system with a specified name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show and list the deployments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Choose a different ref
to track from the same remote as the
current tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Remove the previously
<replaceable>INDEX</replaceable>
deployed tree from the bootloader
configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;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>
<term><citerefentry><refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Concatenate contents of files
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Check out a commit into a filesystem tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Gives checksum of any file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Given one or more
trees, create a new commit using those contents.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Change settings.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Concisely list
differences between the given refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Check a repository for consistency.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize a new repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show revision log.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;List the contents of a given commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Search for unreachable objects.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Copy data from source-repo.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Download data from remote repo. If you have libsoup.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;List refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Manipulate remote archive configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Reset a ref to a previous commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show the SHA256 corresponding to a given rev.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Given an OSTree SHA256 checksum, display its contents.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Manage static delta files.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Regenerate the repository summary metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;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>
OSTree supports signing commits with GPG. Operations on the system
repository by default use 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.
</para>
<para>
In addition to the system repository, OSTree supports a
per-remote
<filename><replaceable>remotename</replaceable>.trustedkeys.gpg</filename>
file stored in the toplevel of the repository (alongside
<filename>objects/</filename> and such). This is
particularly useful when downloading content that may not
be fully trusted (e.g. you want to inspect it but not
deploy it as an OS), or use it for containers. This file
is written via <command>ostree remote add
--gpg-import</command>.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
man/rofiles-fuse.1
+73
View File
@@ -0,0 +1,73 @@
'\" t
.\" Title: rofiles-fuse
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 08/06/2016
.\" Manual: rofiles-fuse
.\" Source: rofiles-fuse
.\" Language: English
.\"
.TH "ROFILES\-FUSE" "1" "" "rofiles-fuse" "rofiles-fuse"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rofiles-fuse \- Use FUSE to create a view where directories are writable, files are immutable
.SH "SYNOPSIS"
.HP \w'\fBrofiles\-fuse\ SRCDIR\ MNTPOINT\fR\ 'u
\fBrofiles\-fuse SRCDIR MNTPOINT\fR
.SH "DESCRIPTION"
.PP
Creating a checkout from an OSTree repository by default uses hard links, which means an in\-place mutation to any file corrupts the repository and all checkouts\&. This can be problematic if one wishes to run arbitrary programs against such a checkout\&. For example, RPM
%post
scripts or equivalent\&.
.PP
In the case where one wants to create a tree commit derived from other content, using
\fBrofiles\-fuse\fR
in concert with
\fBostree commit \-\-link\-checkout\-speedup\fR
(or the underlying API) can ensure that only new files are checksummed\&.
.SH "EXAMPLE: UPDATE AN OSTREE COMMIT"
.sp
.if n \{\
.RS 4
.\}
.nf
# Initialize a checkout and mount
$ ostree \-\-repo=repo checkout somebranch branch\-checkout
$ mkdir mnt
$ rofiles\-fuse branch\-checkout mnt
# Now, arbitrary changes to mnt/ are reflected in branch\-checkout
$ echo somenewcontent > mnt/anewfile
$ mkdir mnt/anewdir
$ rm mnt/someoriginalcontent \-rf
# Commit and cleanup
$ fusermount \-u mnt
$ ostree \-\-repo=repo commit \-\-link\-checkout\-speedup \-b somebranch \-s \*(AqCommit new content\*(Aq \-\-tree=dir=branch\-checkout
$ rm mnt branch\-checkout \-rf
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBostree\fR(1)
man/rofiles-fuse.xml
-104
View File
@@ -1,104 +0,0 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2016 Colin Walters <walters@verbum.org>
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>rofiles-fuse</title>
<productname>rofiles-fuse</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Colin</firstname>
<surname>Walters</surname>
<email>walters@verbum.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>rofiles-fuse</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>rofiles-fuse</refname>
<refpurpose>Use FUSE to create a view where directories are writable, files are immutable</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>rofiles-fuse SRCDIR MNTPOINT</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Creating a checkout from an OSTree repository by default
uses hard links, which means an in-place mutation to any
file corrupts the repository and all checkouts. This can be
problematic if one wishes to run arbitrary programs against
such a checkout. For example, RPM <literal>%post</literal>
scripts or equivalent.
</para>
<para>
In the case where one wants to create a tree commit derived
from other content, using <command>rofiles-fuse</command> in
concert with <command>ostree commit
--link-checkout-speedup</command> (or the underlying API)
can ensure that only new files are checksummed.
</para>
</refsect1>
<refsect1>
<title>Example: Update an OSTree commit</title>
<programlisting>
# Initialize a checkout and mount
$ ostree --repo=repo checkout somebranch branch-checkout
$ mkdir mnt
$ rofiles-fuse branch-checkout mnt
# Now, arbitrary changes to mnt/ are reflected in branch-checkout
$ echo somenewcontent > mnt/anewfile
$ mkdir mnt/anewdir
$ rm mnt/someoriginalcontent -rf
# Commit and cleanup
$ fusermount -u mnt
$ ostree --repo=repo commit --link-checkout-speedup -b somebranch -s 'Commit new content' --tree=dir=branch-checkout
$ rm mnt branch-checkout -rf
</programlisting>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>