diff options
| author | Anne LoVerso <aelv13@gmail.com> | 2014-06-17 15:24:08 -0400 |
|---|---|---|
| committer | Colin Walters <walters@verbum.org> | 2014-06-23 16:02:37 -0400 |
| commit | 9cb9a31b4f516d01370ccfcfc1213d558ac0f441 (patch) | |
| tree | 40af3ba363433f0057383d40be3f131c6a4f333b | |
| parent | 40f99f764e9c7be5e4ee49fdcf7cf1af1b4afa2d (diff) | |
| download | ostree-9cb9a31b4f516d01370ccfcfc1213d558ac0f441.tar.gz | |
manpage: Add separate manpages for each command
Using docker as a model, this update creates separate manpages
for each OSTree command, such that the main manpage is not
cluttered and the separate pages can provide more in-depth detail
and exanples that might be useful to a user. Each page includes
synopsis, description, example, and a list of options if needd.
This update also alphabetizes the usage error output for ostree
and ostree admin so that it matches the list on the manpage.
35 files changed, 3311 insertions, 290 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 40fa5620..228de4f3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -108,7 +108,8 @@ include $(top_srcdir)/gtk-doc.make man1_MANS = if ENABLE_GTK_DOC -man1_MANS += ostree.1 ostree.repo.5 ostree.repo-config.5 +man1_MANS += ostree.1 ostree.repo.5 ostree.repo-config.5 ostree-admin-cleanup.1 ostree-admin-config-diff.1 ostree-admin-deploy.1 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1 ostree-admin-status.1 ostree-admin-switch.1 ostree-admin-undeploy.1 ostree-admin-upgrade.1 ostree-admin.1 ostree-cat.1 ostree-checkout.1 ostree-checksum.1 ostree-commit.1 ostree-config.1 ostree-diff.1 ostree-fsck.1 ostree-init.1 ostree-log.1 ostree-ls.1 ostree-prune.1 ostree-pull-local.1 ostree-pull.1 ostree-refs.1 ostree-remote.1 ostree-reset.1 ostree-rev-parse.1 ostree-show.1 ostree-static-delta.1 ostree-trivial-httpd.1 + XSLTPROC_FLAGS = \ --nonet \ diff --git a/doc/ostree-admin-cleanup.xml b/doc/ostree-admin-cleanup.xml new file mode 100644 index 00000000..e91e1c46 --- /dev/null +++ b/doc/ostree-admin-cleanup.xml @@ -0,0 +1,68 @@ +<?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> diff --git a/doc/ostree-admin-config-diff.xml b/doc/ostree-admin-config-diff.xml new file mode 100644 index 00000000..dd1d17a8 --- /dev/null +++ b/doc/ostree-admin-config-diff.xml @@ -0,0 +1,84 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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'. Mnodified 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> + If provided, specifies the operating system root. Default is the current one. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree admin config-diff</command></para> + M shadow + A example.txt + </refsect1> +</refentry> diff --git a/doc/ostree-admin-deploy.xml b/doc/ostree-admin-deploy.xml new file mode 100644 index 00000000..2754122a --- /dev/null +++ b/doc/ostree-admin-deploy.xml @@ -0,0 +1,138 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg> </command> + </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> + If provided, specifies the operating system root. Default is 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>="KEY=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>="KEY=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> + * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + +<para><command>$ ostree admin deploy gnome-ostree/buildmaster/x86_64-runtime</command></para> + 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) + +<para><command>$ ostree admin status</command></para> + gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.1 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + + </refsect1> +</refentry> diff --git a/doc/ostree-admin-init-fs.xml b/doc/ostree-admin-init-fs.xml new file mode 100644 index 00000000..bac7ca42 --- /dev/null +++ b/doc/ostree-admin-init-fs.xml @@ -0,0 +1,73 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">PATH</arg> </command> + </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 type="bold">boot</emphasis> <emphasis type="bold">dev</emphasis> <emphasis type="bold">home</emphasis> <emphasis type="bold">ostree</emphasis> <emphasis type="bold">proc</emphasis> <emphasis type="bold">root</emphasis> <emphasis type="bold">run</emphasis> <emphasis type="bold">sys</emphasis> <emphasis type="bold">tmp</emphasis> + </para> + </refsect1> +</refentry> diff --git a/doc/ostree-admin-instutil.xml b/doc/ostree-admin-instutil.xml new file mode 100644 index 00000000..349ced2d --- /dev/null +++ b/doc/ostree-admin-instutil.xml @@ -0,0 +1,86 @@ +<?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 <arg choice="req">SUBCOMMAND</arg> <arg choice="opt">ARGS</arg></command> + </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><command>selinux-ensure-labeled</command></term> + + <listitem><para> + Ensure all files and directories are labeled according to SELinux policy of the first deployment. First argument is the subpath and second argument is the prefix. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><command>set-kargs</command></term> + + <listitem><para> + Replace the kernel arguments of the default deployment. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> diff --git a/doc/ostree-admin-os-init.xml b/doc/ostree-admin-os-init.xml new file mode 100644 index 00000000..3dbc900c --- /dev/null +++ b/doc/ostree-admin-os-init.xml @@ -0,0 +1,69 @@ +<?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 <arg choice="req">OSNAME</arg></command> + </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> + ostree/deploy/gnome-ostree initialized as OSTree root + </refsect1> +</refentry> diff --git a/doc/ostree-admin-status.xml b/doc/ostree-admin-status.xml new file mode 100644 index 00000000..599d47fd --- /dev/null +++ b/doc/ostree-admin-status.xml @@ -0,0 +1,73 @@ +<?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> + * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + + </refsect1> +</refentry> diff --git a/doc/ostree-admin-switch.xml b/doc/ostree-admin-switch.xml new file mode 100644 index 00000000..4a09b711 --- /dev/null +++ b/doc/ostree-admin-switch.xml @@ -0,0 +1,83 @@ +<?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 <arg choice="req">REF</arg> </command> + </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> + If provided, specifies the operating system root. Default is 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> diff --git a/doc/ostree-admin-undeploy.xml b/doc/ostree-admin-undeploy.xml new file mode 100644 index 00000000..98e72f1c --- /dev/null +++ b/doc/ostree-admin-undeploy.xml @@ -0,0 +1,79 @@ +<?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 <arg choice="req">INDEX</arg></command> + </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> + * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime +<para><command>$ ostree admin undeploy 1</command></para> + Transaction complete; bootconfig swap: no deployment count change: -1) + Freed objects: 326.5 kB + Deleted deployment ce19c41036cc45e49b0cecf6b157523c2105c4de1c.0 +<para><command>$ ostree admin status</command></para> + * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0 + origin refspec: gnome-ostree/buildmaster/x86_64-runtime + </refsect1> +</refentry> diff --git a/doc/ostree-admin-upgrade.xml b/doc/ostree-admin-upgrade.xml new file mode 100644 index 00000000..ab2672b4 --- /dev/null +++ b/doc/ostree-admin-upgrade.xml @@ -0,0 +1,100 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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> + If provided, specifies the operating system root. Default is 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> + </variablelist> + </refsect1> + +<!-- Can we have a real example with output? --> + <refsect1> + <title>Example</title> + <para><command>$ ostree admin upgrade</command></para> + No update available. + </refsect1> +</refentry> diff --git a/doc/ostree-admin.xml b/doc/ostree-admin.xml new file mode 100644 index 00000000..88a63edd --- /dev/null +++ b/doc/ostree-admin.xml @@ -0,0 +1,102 @@ +<?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 <arg choice="req">SUBCOMMAND</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + Use ostree admin subcommands. + </para> + </refsect1> + + <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> + + <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> + </variablelist> + </refsect1> +</refentry> diff --git a/doc/ostree-cat.xml b/doc/ostree-cat.xml new file mode 100644 index 00000000..c8ec1c9c --- /dev/null +++ b/doc/ostree-cat.xml @@ -0,0 +1,70 @@ +<?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 <arg choice="req">COMMIT</arg> <arg choice="req">PATH</arg> <arg choice="opt">PATH</arg></command> + </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> + Hello, world! + </refsect1> +</refentry> diff --git a/doc/ostree-checkout.xml b/doc/ostree-checkout.xml new file mode 100644 index 00000000..d1205e1f --- /dev/null +++ b/doc/ostree-checkout.xml @@ -0,0 +1,125 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt">DESTINATION</arg></command> + </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> + file1 file2 <emphasis type="bold">my-branch</emphasis> + </refsect1> +</refentry> diff --git a/doc/ostree-checksum.xml b/doc/ostree-checksum.xml new file mode 100644 index 00000000..a6ed8956 --- /dev/null +++ b/doc/ostree-checksum.xml @@ -0,0 +1,69 @@ +<?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 <arg choice="req">FILE</arg></command> + </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> + 67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc + </refsect1> +</refentry> diff --git a/doc/ostree-commit.xml b/doc/ostree-commit.xml new file mode 100644 index 00000000..4469ce51 --- /dev/null +++ b/doc/ostree-commit.xml @@ -0,0 +1,209 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> </command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + This allows you to commit changes to a branch. The specification of the branch is required. If no commit message is specified with <option>--subject</option> then a text editor will be opened. The commit will be aborted if the commit subject is left empty. 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. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--body</option>, <option>-m</option>="body"</term> + + <listitem><para> + Full description. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--branch</option>, <option>-b</option>="branch"</term> + + <listitem><para> + Branch. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--tree</option>="NAME"</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> + Append given key and value (in string format) to metadata. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--add-detached-metadata-string</option>="KEY=VALUE"</term> + + <listitem><para> + Append given key and value (in string format) 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. + </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> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree commit --branch=my-branch --subject="Initial commit"</command></para> + 67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc + </refsect1> +</refentry> diff --git a/doc/ostree-config.xml b/doc/ostree-config.xml new file mode 100644 index 00000000..c2b2f09d --- /dev/null +++ b/doc/ostree-config.xml @@ -0,0 +1,70 @@ +<?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 <arg choice="req">OPERATION</arg> <arg choice="opt">KEY</arg> <arg choice="opt">VALUE</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + Changes the configuration settings. Possible operations inlclude either "set" or "get". If OPERATION is "set", KEY and VALUE are required. If OPERATION is "get", only KEY is necessary. KEY must be of the form "sectionname.keyname". + </para> + </refsect1> + +<!-- Need a REAL example here - what is an example of a section name and a key name?--> + <refsect1> + <title>Example</title> + <para><command>$ ostree config get sectionname.keyname</command></para> + keyvalue + </refsect1> +</refentry> diff --git a/doc/ostree-diff.xml b/doc/ostree-diff.xml new file mode 100644 index 00000000..baaa343a --- /dev/null +++ b/doc/ostree-diff.xml @@ -0,0 +1,93 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REV</arg> <arg choice="req">TARGETDIR</arg></command> + </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> + A /testdirectory + M /helloworld.txt +<para><command>$ ostree diff my-branch my-branch^</command></para> + D /testdirectory + M /helloworld.txt + </refsect1> +</refentry>
\ No newline at end of file diff --git a/doc/ostree-fsck.xml b/doc/ostree-fsck.xml new file mode 100644 index 00000000..c93166b8 --- /dev/null +++ b/doc/ostree-fsck.xml @@ -0,0 +1,93 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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> + </variablelist> + </refsect1> + +<!-- What does it look like when it finds corrupted objects?--> + <refsect1> + <title>Example</title> + <para><command>$ ostree fsck</command></para> + Enumerating objects... + Verifying content integrity of of 2 commit objects + 0/2572 objects + 2571/2572 objects + </refsect1> +</refentry> diff --git a/doc/ostree-init.xml b/doc/ostree-init.xml new file mode 100644 index 00000000..ec1962c0 --- /dev/null +++ b/doc/ostree-init.xml @@ -0,0 +1,79 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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> diff --git a/doc/ostree-log.xml b/doc/ostree-log.xml new file mode 100644 index 00000000..51d2caf0 --- /dev/null +++ b/doc/ostree-log.xml @@ -0,0 +1,89 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REF</arg></command> + </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> + 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 + + </refsect1> +</refentry> diff --git a/doc/ostree-ls.xml b/doc/ostree-ls.xml new file mode 100644 index 00000000..d67e7d74 --- /dev/null +++ b/doc/ostree-ls.xml @@ -0,0 +1,115 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="opt" rep="repeat">PATHS</arg></command> + </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> + d00644 0 0 0 / + -00644 0 0 2 /helloworld.txt + d00755 0 0 0 /testdirectory + +<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> diff --git a/doc/ostree-prune.xml b/doc/ostree-prune.xml new file mode 100644 index 00000000..08bd8c22 --- /dev/null +++ b/doc/ostree-prune.xml @@ -0,0 +1,101 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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>--depth</option>=DEPTH</term> + + <listitem><para> + Only traverse DEPTH (integer) parents for each commit (default: -1=infinite). + </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> + Total objects: 25627 + No unreachable objects + </refsect1> +</refentry> diff --git a/doc/ostree-pull-local.xml b/doc/ostree-pull-local.xml new file mode 100644 index 00000000..662bbaa8 --- /dev/null +++ b/doc/ostree-pull-local.xml @@ -0,0 +1,94 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">SOURCE_REPO</arg> <arg choice="opt" rep="repeat">REFS</arg> </command> + </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> + </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> + Enumerating objects... + pull: 25709/25709 scanned, 0 objects copied + Writing 5 refs + </refsect1> +</refentry> diff --git a/doc/ostree-pull.xml b/doc/ostree-pull.xml new file mode 100644 index 00000000..e513461f --- /dev/null +++ b/doc/ostree-pull.xml @@ -0,0 +1,70 @@ +<?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>Description</title> + + <para> + Downloads all content corresponding to the provided branch or commit from the given remote. + </para> + </refsect1> + + <refsect1> + <title>Example</title> + + <para><command>$ ostree pull remote_name</command></para> + </refsect1> + +</refentry> diff --git a/doc/ostree-refs.xml b/doc/ostree-refs.xml new file mode 100644 index 00000000..77f226be --- /dev/null +++ b/doc/ostree-refs.xml @@ -0,0 +1,84 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg></command> + </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 pecified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <variablelist> + <varlistentry> + <term><option>--delete</option></term> + + <listitem><para> + Delete refs which match PREFIX, rather than listing them. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree refs</command></para> + my-branch + gnome-ostree/buildmaster/x86_64-runtime + </refsect1> +</refentry> diff --git a/doc/ostree-remote.xml b/doc/ostree-remote.xml new file mode 100644 index 00000000..6d594c69 --- /dev/null +++ b/doc/ostree-remote.xml @@ -0,0 +1,91 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OPERATION</arg> <arg choice="req">NAME</arg> <arg choice="opt">args</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + Changes remote respository configurations. Possible operations include either "add" or "show-url". If OPERATION is "add", a URL must be specified in [args]. The NAME refers to the name of the remote. + </para> + </refsect1> + + <refsect1> + <title>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> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree remote show-url local</command></para> + http://192.168.122.1/repo + </refsect1> +</refentry> diff --git a/doc/ostree-reset.xml b/doc/ostree-reset.xml new file mode 100644 index 00000000..5d2d6b9a --- /dev/null +++ b/doc/ostree-reset.xml @@ -0,0 +1,81 @@ +<?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 <arg choice="req">REF</arg> <arg choice="req">REF_TO_RESET_TO</arg> </command> + </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> + 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 + +<para><command>$ ostree reset my-branch my-branch^</command></para> + <para><command>$ ostree log my-branch</command></para> + commit ce19c41036cc45e49b0cecf6b157523c2105c4de1c + Date: 2014-06-12 11:20:08 +0000 + Initial commit + </refsect1> +</refentry> diff --git a/doc/ostree-rev-parse.xml b/doc/ostree-rev-parse.xml new file mode 100644 index 00000000..a66fa709 --- /dev/null +++ b/doc/ostree-rev-parse.xml @@ -0,0 +1,71 @@ +<?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 <arg choice="req">REV</arg> <arg choice="req">PATH</arg> </command> + </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> + ce19c41036cc45e49b0cecf6b157523c2105c4de1ce30101def1f759daafcc3e + </refsect1> +</refentry> diff --git a/doc/ostree-show.xml b/doc/ostree-show.xml new file mode 100644 index 00000000..b2ee463d --- /dev/null +++ b/doc/ostree-show.xml @@ -0,0 +1,116 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OBJECT</arg></command> + </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>="FILENAME"</term> + + <listitem><para> + Argument should be a filename and it will be interpreted as this type. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--print-metadata-key</option>="KEY"</term> + + <listitem><para> + Print string value of metadata key KEY for given commit. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--print-detached-metadata-key</option>="KEY"</term> + + <listitem><para> + Print string value of detached metadata key KEY for given commit. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--raw</option></term> + + <listitem><para> + Show raw variant data. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Example</title> + <para><command>$ ostree show my-branch</command></para> + commit 67e382b11d213a402a5313e61cbc69dfd5ab93cb07 + Date: 2014-06-12 13:42:54 +0000 + </refsect1> +</refentry> diff --git a/doc/ostree-static-delta.xml b/doc/ostree-static-delta.xml new file mode 100644 index 00000000..b28b4ed6 --- /dev/null +++ b/doc/ostree-static-delta.xml @@ -0,0 +1,100 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">REV</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + If no options are selected, this command will list the static deltas in this repo. The options allow creating and applying delta fles. + </para> + </refsect1> + + <refsect1> + <title>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. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--apply</option>="PATH"</term> + + <listitem><para> + Apply delta from PATH. + </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> + (No static deltas) + </refsect1> +</refentry> diff --git a/doc/ostree-trivial-httpd.xml b/doc/ostree-trivial-httpd.xml new file mode 100644 index 00000000..0b6a3056 --- /dev/null +++ b/doc/ostree-trivial-httpd.xml @@ -0,0 +1,108 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">DIR</arg></command> + </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>--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> diff --git a/doc/ostree.xml b/doc/ostree.xml index 82eaf063..00ca7f74 100644 --- a/doc/ostree.xml +++ b/doc/ostree.xml @@ -1,287 +1,424 @@ <?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"> + "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. +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 <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command> - </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> - </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> - - </variablelist> - - <para>System administrators will primarily interact - with OSTree via the subcommand <command>ostree - admin</command>.</para> - - <variablelist> - <varlistentry> - <term><command>admin os-init NAME</command></term> - - <listitem><para>Initialize the - deployment location for an operating - system with name - <replaceable>NAME</replaceable>. Each - deployment location is comprised of a - single shared <filename>var</filename> - and a set of - deployments (chroots).</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin init-fs PATH</command></term> - - <listitem><para>Initialize a root filesystem - in PATH by creating top level directories with - proper permissions.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin deploy</command></term> - - <listitem><para>This is a relatively - low level command - takes a particular - commit or revision, and sets it up for - the next boot.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin undeploy INDEX</command></term> - - <listitem><para>Remove the previously - <replaceable>INDEX</replaceable> - deployed tree from the bootloader - configuration.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin cleanup</command></term> - - <listitem><para>Delete untagged - deployments and repository objects.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><command>admin upgrade</command></term> - - <listitem><para>If you are replicating - from a build server, this command will - download the latest version for the - current ref, and deploy it. Reboot - the system for the changes to take - effect.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin status</command></term> - - <listitem><para>Show and list the deployments. - </para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin switch</command></term> - - <listitem><para>Choose a different ref - to track from the same remote as the - current tree.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>admin config-diff</command></term> - - <listitem><para>See changes to - <filename>/etc</filename> as compared - to the current default (from - <filename>/usr/etc</filename>). - </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><command>init</command></term> - - <listitem><para>Initialize a new - repository. Must be given the path to - an existing (empty) directory. If you - want to serve a repository over plain - HTTP, use - <literal>archive-z2</literal> for - <option>--mode</option></para></listitem> - </varlistentry> - <varlistentry> - <term><command>diff</command></term> - - <listitem><para>Concisely list - differences between the given refs, - without checking them out into the - physical filesystem. If only one ref - is provided, the parent commit will be - assumed to be the diff source. - </para></listitem> - </varlistentry> - <varlistentry> - <term><command>commit</command></term> - - <listitem><para>Given one or more - trees (from the local filesystem, a - tarball, or a specified revision for - example), create a new commit using those contents. - </para></listitem> - </varlistentry> - <varlistentry> - <term><command>log</command></term> - - <listitem><para>Show revision log.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>ls</command></term> - - <listitem><para>List the contents of a given commit.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>fsck</command></term> - - <listitem><para>Check a repository for consistency.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>remote</command></term> - - <listitem><para>Manipulate remote archive configuration.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>rev-parse</command></term> - - <listitem><para>Show the SHA256 corresponding to a given rev.</para></listitem> - </varlistentry> - <varlistentry> - <term><command>show</command></term> - - <listitem><para>Given an OSTree SHA256 checksum, display its contents.</para></listitem> - </varlistentry> - </variablelist> - - </refsect1> - - <refsect1> - <title>GPG verification</title> - - <para>OSTree supports signing commits with GPG. The - set of trusted keys is stored as keyring files in - <filename>/usr/share/ostree/trusted.gpg.d</filename>. Any key in - any keyring in that directory may be used to sign commits. - </para> - </refsect1> - - <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> - </refsect1> - + <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 <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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 <arg choice="req">COMMAND</arg></command> or <command>man ostree-admin <arg choice="req">COMMAND</arg></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> + </variablelist> + </refsect1> + + <refsect1> + <title>Commands</title> + + <para>System administrators will primarily interact + with OSTree via the subcommand <command>ostree + admin</command>.</para> + + <variablelist> + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Delete untagged + deployments and repository objects. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + See changes to + <filename>/etc</filename> as compared + to the current default (from + <filename>/usr/etc</filename>). + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Takes a particular + commit or revision, and sets it up for + the next boot. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Initialize a root filesystem + in a specified path. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Utility functions intended primarily for operating system installation programs + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Initialize the + deployment location for an operating + system with a specified name. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Show and list the deployments. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Choose a different ref + to track from the same remote as the + current tree. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Remove the previously + <replaceable>INDEX</replaceable> + deployed tree from the bootloader + configuration. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Download the latest version for the + current ref, and deploy it. + </para></listitem> + </varlistentry> + </variablelist> + + <para>Both administrators and operating system + builders may interact with OSTree via the regular + filesystem manipulation commands. + </para> + + <variablelist> + <varlistentry> + <citerefentry><refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Concatenate contents of files + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Check out a commit into a filesystem tree. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Gives checksum of any file. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Given one or more + trees, create a new commit using those contents. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Change settings. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Concisely list + differences between the given refs. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Check a repository for consistency. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Initialize a new repository. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Show revision log. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + List the contents of a given commit. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Search for unreachable objects. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Copy data from source-repo. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Download data from remote repo. If you have libsoup. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + List refs. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Manipulate remote archive configuration. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Reset a ref to a previous commit. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Show the SHA256 corresponding to a given rev. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Given an OSTree SHA256 checksum, display its contents. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Manage static delta files. + </para></listitem> + </varlistentry> + + <varlistentry> + <citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Simple webserver. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + <para> + For specific examples, please see the man page regarding the specific ostree command. For example: + </para> + <para> + <command>man ostree init</command> or <command>man ostree-admin status</command> + </para> + </refsect1> + + <refsect1> + <title>GPG verification</title> + + <para> + OSTree supports signing commits with GPG. The + set of trusted keys is stored as keyring files in + <filename>/usr/share/ostree/trusted.gpg.d</filename>. Any key in + any keyring in that directory may be used to sign commits. + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry> + </para> + </refsect1> </refentry> diff --git a/src/ostree/main.c b/src/ostree/main.c index 5463ce1b..b16d8c12 100644 --- a/src/ostree/main.c +++ b/src/ostree/main.c @@ -35,23 +35,23 @@ static OstreeCommand commands[] = { { "admin", ostree_builtin_admin, OSTREE_BUILTIN_FLAG_NO_REPO }, { "cat", ostree_builtin_cat, 0 }, - { "commit", ostree_builtin_commit, 0 }, - { "config", ostree_builtin_config, 0 }, { "checkout", ostree_builtin_checkout, 0 }, { "checksum", ostree_builtin_checksum, OSTREE_BUILTIN_FLAG_NO_REPO }, + { "commit", ostree_builtin_commit, 0 }, + { "config", ostree_builtin_config, 0 }, { "diff", ostree_builtin_diff, 0 }, { "fsck", ostree_builtin_fsck, 0 }, { "init", ostree_builtin_init, OSTREE_BUILTIN_FLAG_NO_CHECK }, { "log", ostree_builtin_log, 0 }, { "ls", ostree_builtin_ls, 0 }, - { "refs", ostree_builtin_refs, 0 }, - { "reset", ostree_builtin_reset, 0 }, { "prune", ostree_builtin_prune, 0 }, + { "pull-local", ostree_builtin_pull_local, 0 }, #ifdef HAVE_LIBSOUP { "pull", ostree_builtin_pull, 0 }, #endif - { "pull-local", ostree_builtin_pull_local, 0 }, + { "refs", ostree_builtin_refs, 0 }, { "remote", ostree_builtin_remote, 0 }, + { "reset", ostree_builtin_reset, 0 }, { "rev-parse", ostree_builtin_rev_parse, 0 }, { "show", ostree_builtin_show, 0 }, { "static-delta", ostree_builtin_static_delta, 0 }, diff --git a/src/ostree/ot-builtin-admin.c b/src/ostree/ot-builtin-admin.c index 9da8f77b..f7dce93a 100644 --- a/src/ostree/ot-builtin-admin.c +++ b/src/ostree/ot-builtin-admin.c @@ -38,16 +38,16 @@ typedef struct { } OstreeAdminCommand; static OstreeAdminCommand admin_subcommands[] = { - { "os-init", ot_admin_builtin_os_init }, + { "cleanup", ot_admin_builtin_cleanup }, + { "config-diff", ot_admin_builtin_diff }, + { "deploy", ot_admin_builtin_deploy }, { "init-fs", ot_admin_builtin_init_fs }, { "instutil", ot_admin_builtin_instutil }, - { "deploy", ot_admin_builtin_deploy }, - { "undeploy", ot_admin_builtin_undeploy }, - { "upgrade", ot_admin_builtin_upgrade }, - { "cleanup", ot_admin_builtin_cleanup }, + { "os-init", ot_admin_builtin_os_init }, { "status", ot_admin_builtin_status }, { "switch", ot_admin_builtin_switch }, - { "config-diff", ot_admin_builtin_diff }, + { "undeploy", ot_admin_builtin_undeploy }, + { "upgrade", ot_admin_builtin_upgrade }, { NULL, NULL } }; |