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

docs: Fix a pile of Docbook validation errors 

At least now validates with RNG mode in Emacs.
This commit is contained in:
Colin Walters 2014-11-29 12:15:21 -05:00
parent f8a3d82da8
commit 546237cc6f
31 changed files with 142 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/ostree-admin-config-diff.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin config-diff <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree admin config-diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -57,7 +57,7 @@ Boston, MA 02111-1307, USA.
<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'. Mnodified files will be prefixed with 'M', and deleted files with 'D'.
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>
@ -78,7 +78,9 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree admin config-diff</command></para>
<programlisting>
M shadow
A example.txt
</programlisting>
</refsect1>
</refentry>

8
doc/ostree-admin-deploy.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin deploy <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg> </command>
<command>ostree admin deploy</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -118,21 +118,27 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-admin-init-fs.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin init-fs <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">PATH</arg> </command>
<command>ostree admin init-fs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -67,7 +67,7 @@ Boston, MA 02111-1307, USA.
<para><command>$ ostree admin init-fs /example</command></para>
<para><command>$ ls /example </command></para>
<para>
<emphasis type="bold">boot</emphasis>&nbsp;&nbsp; <emphasis type="bold">dev</emphasis>&nbsp;&nbsp; <emphasis type="bold">home</emphasis>&nbsp;&nbsp; <emphasis type="bold">ostree</emphasis>&nbsp;&nbsp; <emphasis type="bold">proc</emphasis>&nbsp;&nbsp; <emphasis type="bold">root</emphasis>&nbsp;&nbsp; <emphasis type="bold">run</emphasis>&nbsp;&nbsp; <emphasis type="bold">sys</emphasis>&nbsp;&nbsp; <emphasis type="bold">tmp</emphasis>
<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>

7
doc/ostree-admin-instutil.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin instutil <arg choice="req">SUBCOMMAND</arg> <arg choice="opt">ARGS</arg></command>
<command>ostree admin instutil</command> <arg choice="req">SUBCOMMAND</arg> <arg choice="opt">ARGS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -67,7 +67,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><command>selinux-ensure-labeled <arg choice="opt">SUBPATH PREFIX</arg></command></term>
<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.
@ -75,7 +75,8 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><command>set-kargs <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></command></term>
<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

4
doc/ostree-admin-os-init.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin os-init <arg choice="req">OSNAME</arg></command>
<command>ostree admin os-init</command> <arg choice="req">OSNAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -64,6 +64,8 @@ Boston, MA 02111-1307, USA.
<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>

3
doc/ostree-admin-status.xml
View File

@ -64,10 +64,11 @@ Boston, MA 02111-1307, USA.
<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>

2
doc/ostree-admin-switch.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin switch <arg choice="req">REF</arg> </command>
<command>ostree admin switch</command> <arg choice="req">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>

8
doc/ostree-admin-undeploy.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin undeploy <arg choice="req">INDEX</arg></command>
<command>ostree admin undeploy</command> <arg choice="req">INDEX</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -64,16 +64,22 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-admin-upgrade.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin upgrade <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree admin upgrade</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -95,6 +95,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree admin upgrade</command></para>
<programlisting>
No update available.
</programlisting>
</refsect1>
</refentry>

26
doc/ostree-admin.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin <arg choice="req">SUBCOMMAND</arg></command>
<command>ostree admin</command> <arg choice="req">SUBCOMMAND</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -64,18 +64,18 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Subcommands</title>
<variablelist>
<varlistentry><term><command>cleanup</command></term></varlistentry>
<varlistentry><term><command>config-diff</command></term></varlistentry>
<varlistentry><term><command>deploy</command></term></varlistentry>
<varlistentry><term><command>init-fs</command></term></varlistentry>
<varlistentry><term><command>instutil</command></term></varlistentry>
<varlistentry><term><command>os-init</command></term></varlistentry>
<varlistentry><term><command>status</command></term></varlistentry>
<varlistentry><term><command>switch</command></term></varlistentry>
<varlistentry><term><command>undeploy</command></term></varlistentry>
<varlistentry><term><command>upgrade</command></term></varlistentry>
</variablelist>
<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>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:

4
doc/ostree-cat.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree cat <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">PATH</arg></command>
<command>ostree cat</command> <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -65,6 +65,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree cat my-branch helloworld.txt</command></para>
<programlisting>
Hello, world!
</programlisting>
</refsect1>
</refentry>

6
doc/ostree-checkout.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree checkout <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt">DESTINATION</arg></command>
<command>ostree checkout</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt">DESTINATION</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -120,6 +120,8 @@ Boston, MA 02111-1307, USA.
<title>Example</title>
<para><command>$ ostree checkout my-branch</command></para>
<para><command>$ ls</command></para>
file1&nbsp;&nbsp;&nbsp;&nbsp;file2&nbsp;&nbsp;&nbsp;&nbsp;<emphasis type="bold">my-branch</emphasis>
<programlisting>
file1&nbsp;&nbsp;&nbsp;&nbsp;file2&nbsp;&nbsp;&nbsp;&nbsp;<emphasis>my-branch</emphasis>
</programlisting>
</refsect1>
</refentry>

4
doc/ostree-checksum.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree checksum <arg choice="req">PATH</arg></command>
<command>ostree checksum</command> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -64,6 +64,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree checksum file1</command></para>
<programlisting>
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
</programlisting>
</refsect1>
</refentry>

4
doc/ostree-commit.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree commit <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> <arg choice="opt">PATH</arg></command>
<command>ostree commit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> <arg choice="opt">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -204,6 +204,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree commit --branch=my-branch --subject="Initial commit"</command></para>
<programlisting>
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
</programlisting>
</refsect1>
</refentry>

4
doc/ostree-config.xml
View File

@ -49,10 +49,10 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree config get <arg choice="req">SECTIONNAME.KEYNAME</arg></command>
<command>ostree config get</command> <arg choice="req">SECTIONNAME.KEYNAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config set <arg choice="req">SECTIONNAME.KEYNAME</arg> <arg choice="req">VALUE</arg></command>
<command>ostree config set</command> <arg choice="req">SECTIONNAME.KEYNAME</arg> <arg choice="req">VALUE</arg>
</cmdsynopsis>
</refsynopsisdiv>

6
doc/ostree-diff.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree diff <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV</arg> <arg choice="req">TARGETDIR</arg></command>
<command>ostree diff</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV</arg> <arg choice="req">TARGETDIR</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -84,10 +84,14 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-fsck.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree fsck <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree fsck</command><arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -85,9 +85,11 @@ Boston, MA 02111-1307, USA.
<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>

2
doc/ostree-init.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree init <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree init</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>

4
doc/ostree-log.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree log <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REF</arg></command>
<command>ostree log</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -77,6 +77,7 @@ Boston, MA 02111-1307, USA.
<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
@ -84,6 +85,7 @@ Boston, MA 02111-1307, USA.
commit ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
Date: 2014-06-12 11:20:08 +0000
Initial commit
</programlisting>
</refsect1>
</refentry>

4
doc/ostree-ls.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree ls <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt" rep="repeat">PATHS</arg></command>
<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>
@ -106,9 +106,11 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-prune.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree prune <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree prune</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -95,7 +95,9 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree prune</command></para>
<programlisting>
Total objects: 25627
No unreachable objects
</programlisting>
</refsect1>
</refentry>

4
doc/ostree-pull-local.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree pull-local <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">SOURCE_REPO</arg> <arg choice="opt" rep="repeat">REFS</arg> </command>
<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>
@ -87,8 +87,10 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-refs.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree refs <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg></command>
<command>ostree refs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -78,7 +78,9 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree refs</command></para>
<programlisting>
my-branch
gnome-ostree/buildmaster/x86_64-runtime
</programlisting>
</refsect1>
</refentry>

8
doc/ostree-remote.xml
View File

@ -49,13 +49,13 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree remote <arg choice="opt" rep="repeat">OPTIONS</arg> add <arg choice="req">NAME</arg> <arg choice="req">URL</arg> <arg choice="opt" rep="repeat">BRANCH</arg></command>
<command>ostree remote</command> <arg choice="opt" rep="repeat">OPTIONS</arg> add <arg choice="req">NAME</arg> <arg choice="req">URL</arg> <arg choice="opt" rep="repeat">BRANCH</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote delete <arg choice="req">NAME</arg></command>
<command>ostree remote delete</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote show-url <arg choice="req">NAME</arg></command>
<command>ostree remote show-url</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -92,6 +92,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree remote show-url local</command></para>
<programlisting>
http://192.168.122.1/repo
</programlisting>
</refsect1>
</refentry>

6
doc/ostree-reset.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree reset <arg choice="req">REF</arg> <arg choice="req">REF_TO_RESET_TO</arg> </command>
<command>ostree reset </command> <arg choice="req">REF</arg> <arg choice="req">REF_TO_RESET_TO</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -64,6 +64,7 @@ Boston, MA 02111-1307, USA.
<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
@ -71,11 +72,14 @@ Boston, MA 02111-1307, USA.
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>

4
doc/ostree-rev-parse.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree rev-parse <arg choice="req">REV</arg> <arg choice="req">PATH</arg> </command>
<command>ostree rev-parse </command> <arg choice="req">REV</arg> <arg choice="req">PATH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -66,6 +66,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree rev-parse my-branch</command></para>
<programlisting>
ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e
</programlisting>
</refsect1>
</refentry>

6
doc/ostree-show.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree show <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OBJECT</arg></command>
<command>ostree show</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OBJECT</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -77,7 +77,7 @@ Boston, MA 02111-1307, USA.
<term><option>--print-variant-type</option>="TYPE"</term>
<listitem><para>
Memory map <arg choice="req">OBJECT</arg> (in this case a filename) to the GVariant type string.
Memory map <replaceable>OBJECT</replaceable> (in this case a filename) to the GVariant type string.
</para></listitem>
</varlistentry>
@ -110,7 +110,9 @@ Boston, MA 02111-1307, USA.
<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>

4
doc/ostree-static-delta.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree static-delta <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">REV</arg></command>
<command>ostree static-delta</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">REV</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -95,6 +95,8 @@ Boston, MA 02111-1307, USA.
<refsect1>
<title>Example</title>
<para><command>$ ostree static-delta</command></para>
<programlisting>
(No static deltas)
</programlisting>
</refsect1>
</refentry>

2
doc/ostree-summary.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree summary <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>

2
doc/ostree-trivial-httpd.xml
View File

@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree trivial-httpd <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">DIR</arg></command>
<command>ostree trivial-httpd</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">DIR</arg>
</cmdsynopsis>
</refsynopsisdiv>

67
doc/ostree.xml
View File

@ -49,7 +49,8 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
<command>ostree</command>
<arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -93,7 +94,7 @@ Boston, MA 02111-1307, USA.
</para>
<para>
To see the man page for a command run <command>man ostree <arg choice="req">COMMAND</arg></command> or <command>man ostree-admin <arg choice="req">COMMAND</arg></command>
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>
@ -129,7 +130,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Delete untagged
@ -138,7 +139,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;See changes to
@ -149,7 +150,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Takes a particular
@ -159,7 +160,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize a root filesystem
@ -168,7 +169,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Utility functions intended primarily for operating system installation programs
@ -176,7 +177,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize the
@ -186,7 +187,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show and list the deployments.
@ -194,7 +195,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Choose a different ref
@ -204,7 +205,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Remove the previously
@ -215,7 +216,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Download the latest version for the
@ -231,7 +232,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<citerefentry><refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Concatenate contents of files
@ -239,7 +240,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Check out a commit into a filesystem tree.
@ -247,7 +248,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Gives checksum of any file.
@ -255,7 +256,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Given one or more
@ -264,7 +265,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Change settings.
@ -272,7 +273,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Concisely list
@ -281,7 +282,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Check a repository for consistency.
@ -289,7 +290,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Initialize a new repository.
@ -297,7 +298,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show revision log.
@ -305,7 +306,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;List the contents of a given commit.
@ -313,7 +314,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Search for unreachable objects.
@ -321,7 +322,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Copy data from source-repo.
@ -329,7 +330,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Download data from remote repo. If you have libsoup.
@ -337,7 +338,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;List refs.
@ -345,7 +346,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Manipulate remote archive configuration.
@ -353,7 +354,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Reset a ref to a previous commit.
@ -361,7 +362,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Show the SHA256 corresponding to a given rev.
@ -369,7 +370,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Given an OSTree SHA256 checksum, display its contents.
@ -377,7 +378,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Manage static delta files.
@ -385,7 +386,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Regenerate the repository summary metadata.
@ -393,7 +394,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<term><citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
&nbsp;Simple webserver.