Add basic man page
This commit is contained in:
Colin Walters
parent
60a00a8544
commit
15561dbfe5
2
.gitignore
vendored
2
.gitignore
vendored
@ -45,3 +45,5 @@ rpm-ostree-autobuilder
|
|||||||
|
|
||||||
rpm-ostree-*.tar.xz
|
rpm-ostree-*.tar.xz
|
||||||
rpm-ostree-*.rpm
|
rpm-ostree-*.rpm
|
||||||
|
|
||||||
|
rpm-ostree.1
|
||||||
|
|||||||
32
Makefile-man.am
Normal file
32
Makefile-man.am
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Copyright (C) 2014 Colin Walters <walters@verbum.org>
|
||||||
|
#
|
||||||
|
# This library is free software; you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Lesser General Public
|
||||||
|
# License as published by the Free Software Foundation; either
|
||||||
|
# version 2 of the License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This library is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Lesser General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Lesser General Public
|
||||||
|
# License along with this library; if not, write to the
|
||||||
|
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||||||
|
# Boston, MA 02111-1307, USA.
|
||||||
|
|
||||||
|
man1_MANS = rpm-ostree.1
|
||||||
|
|
||||||
|
XSLTPROC_FLAGS = \
|
||||||
|
--nonet \
|
||||||
|
--stringparam man.output.quietly 1 \
|
||||||
|
--stringparam funcsynopsis.style ansi \
|
||||||
|
--stringparam man.th.extra1.suppress 1 \
|
||||||
|
--stringparam man.authors.section.enabled 0 \
|
||||||
|
--stringparam man.copyright.section.enabled 0
|
||||||
|
|
||||||
|
XSLTPROC_FLAGS_MAN = \
|
||||||
|
$(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
|
||||||
|
|
||||||
|
rpm-ostree.1: man/rpm-ostree.xml Makefile
|
||||||
|
$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS_MAN) $<
|
||||||
@ -29,4 +29,5 @@ AM_CFLAGS += $(WARN_CFLAGS)
|
|||||||
EXTRA_DIST += autogen.sh COPYING
|
EXTRA_DIST += autogen.sh COPYING
|
||||||
|
|
||||||
include Makefile-rpm-ostree.am
|
include Makefile-rpm-ostree.am
|
||||||
|
include Makefile-man.am
|
||||||
include Makefile-autobuilder.am
|
include Makefile-autobuilder.am
|
||||||
|
|||||||
103
man/rpm-ostree.xml
Normal file
103
man/rpm-ostree.xml
Normal file
@ -0,0 +1,103 @@
|
|||||||
|
<?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,2014 Colin Walters <walters@verbum.org>
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public
|
||||||
|
License along with this library; if not, write to the
|
||||||
|
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||||||
|
Boston, MA 02111-1307, USA.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<refentry id="rpm-ostree">
|
||||||
|
|
||||||
|
<refentryinfo>
|
||||||
|
<title>rpm-ostree</title>
|
||||||
|
<productname>rpm-ostree</productname>
|
||||||
|
|
||||||
|
<authorgroup>
|
||||||
|
<author>
|
||||||
|
<contrib>Developer</contrib>
|
||||||
|
<firstname>Colin</firstname>
|
||||||
|
<surname>Walters</surname>
|
||||||
|
<email>walters@redhat.com</email>
|
||||||
|
</author>
|
||||||
|
</authorgroup>
|
||||||
|
</refentryinfo>
|
||||||
|
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>rpm-ostree</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>rpm-ostree</refname>
|
||||||
|
<refpurpose>Operating system upgrade and software management tool</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>rpm-ostree <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
rpm-ostree is a system software management tool that
|
||||||
|
combines features of both traditional RPM and
|
||||||
|
OSTree. On an rpm-ostree managed system, the rpm
|
||||||
|
tool may be used to query software state, but is not
|
||||||
|
capable of performing changes.
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options</title>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><command>upgrade</command></term>
|
||||||
|
|
||||||
|
<listitem><para>Download the latest
|
||||||
|
version of the current tree, and
|
||||||
|
deploy it, setting it up as the
|
||||||
|
default for the next boot. At
|
||||||
|
present, no changes are made live; you
|
||||||
|
must reboot for the changes to take
|
||||||
|
effect.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Exit status</title>
|
||||||
|
|
||||||
|
<para>On success 0 is returned, a non-zero failure
|
||||||
|
code otherwise.</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>See Also</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||||
|
<citerefentry><refentrytitle>rpm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
</refentry>
|
||||||
Loading…
Reference in New Issue
Block a user