From 9c6ae790a26d8aad088f3334e0770868a366e1ec Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.de>
Date: Wed, 29 Jan 2014 19:55:57 +0100
Subject: [PATCH] Add new CLI Reference manual

This is the first version of a CLI Reference manual.

It takes content from the End User Guide.

Change-Id: I6f3ff1e56975cb7ea1af03ebd0d85f5eb8346af9
---
 doc/cli-reference/bk-cli-reference.xml     |  62 ++++++++++++
 doc/cli-reference/ch_cli.xml               |  19 ++++
 doc/cli-reference/ch_command_reference.xml |  30 ++++++
 doc/cli-reference/ch_preface.xml           |  14 +++
 doc/cli-reference/pom.xml                  |  80 ++++++++++++++++
 doc/common/section_cli_version.xml         | 105 ++++++++++-----------
 doc/pom.xml                                |   1 +
 doc/user-guide/ch_cli.xml                  |   9 +-
 8 files changed, 259 insertions(+), 61 deletions(-)
 create mode 100644 doc/cli-reference/bk-cli-reference.xml
 create mode 100644 doc/cli-reference/ch_cli.xml
 create mode 100644 doc/cli-reference/ch_command_reference.xml
 create mode 100644 doc/cli-reference/ch_preface.xml
 create mode 100644 doc/cli-reference/pom.xml

diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml
new file mode 100644
index 0000000000..e112bec9d8
--- /dev/null
+++ b/doc/cli-reference/bk-cli-reference.xml
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<book xmlns="http://docbook.org/ns/docbook"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:svg="http://www.w3.org/2000/svg"
+    xmlns:html="http://www.w3.org/1999/xhtml"
+    version="5.0"
+    xml:id="openstack-cli-reference">
+
+    <title>OpenStack Command Line Interface Reference</title>
+    <?rax title.font.size="28px" subtitle.font.size="28px"?>
+<titleabbrev>CLI Reference</titleabbrev>
+    <info>
+        <author>
+            <personname>
+                <firstname/>
+                <surname/>
+            </personname>
+            <affiliation>
+                <orgname>OpenStack Foundation</orgname>
+            </affiliation>
+        </author>
+        <copyright>
+            <year>2014</year>
+            <holder>OpenStack Foundation</holder>
+        </copyright>
+        <releaseinfo>trunk</releaseinfo>
+        <productname>OpenStack</productname>
+        <pubdate></pubdate>
+        <legalnotice role="cc-by">
+            <annotation>
+                <remark>Remaining licensing details are filled in by
+                    the template.</remark>
+            </annotation>
+        </legalnotice>
+        <abstract>
+            <para>This guide describes how to obtain, create, and
+                modify virtual machine images that are compatible with
+                OpenStack.</para>
+        </abstract>
+        <revhistory>
+            <!-- ... continue addding more revisions here as you change this document using the markup shown below... -->
+            <revision>
+                <date>2014-01-29</date>
+                <revdescription>
+                    <itemizedlist>
+                        <listitem>
+                            <para>Initial version.</para>
+                        </listitem>
+                    </itemizedlist>
+                </revdescription>
+            </revision>
+        </revhistory>
+    </info>
+
+    <xi:include href="ch_preface.xml"/>
+    <xi:include href="ch_cli.xml"/>
+    <xi:include href="ch_command_reference.xml"/>
+    <!-- Alternative 2 -->
+<!--    <xi:include href="ch_nova_cli.xml"/> -->
+    <xi:include href="../common/app_support.xml"/>
+   </book>
diff --git a/doc/cli-reference/ch_cli.xml b/doc/cli-reference/ch_cli.xml
new file mode 100644
index 0000000000..24e65ecd65
--- /dev/null
+++ b/doc/cli-reference/ch_cli.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter [
+]>
+<chapter xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
+    xml:id="ch_cli">
+    <info>
+        <title>OpenStack command-line clients</title>
+    </info>
+    <xi:include href="../common/section_cli_overview.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="../common/section_cli_install.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="../common/section_cli_version.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="../common/section_cli_openrc.xml"/>
+</chapter>
diff --git a/doc/cli-reference/ch_command_reference.xml b/doc/cli-reference/ch_command_reference.xml
new file mode 100644
index 0000000000..7b604c2434
--- /dev/null
+++ b/doc/cli-reference/ch_command_reference.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter xmlns="http://docbook.org/ns/docbook"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
+        xml:id="ch_command_reference">
+        <title>Command reference</title>
+        <xi:include
+                href="../common/section_cli_keystone_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_glance_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_neutron_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_nova_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_cinder_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_swift_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_heat_commands.xml"/>
+        <?hard page-break?>
+        <xi:include
+                href="../common/section_cli_ceilometer_commands.xml"/>
+</chapter>
diff --git a/doc/cli-reference/ch_preface.xml b/doc/cli-reference/ch_preface.xml
new file mode 100644
index 0000000000..c104dcb9b8
--- /dev/null
+++ b/doc/cli-reference/ch_preface.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<preface xmlns="http://docbook.org/ns/docbook"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:svg="http://www.w3.org/2000/svg"
+    xmlns:m="http://www.w3.org/1998/Math/MathML"
+    xmlns:html="http://www.w3.org/1999/xhtml"
+    xmlns:db="http://docbook.org/ns/docbook" version="5.0"
+    xml:id="ch_preface">
+    <title>Preface</title>
+    <?dbhtml stop-chunking?>
+
+  <xi:include href="../common/section_dochistory.xml"/>
+</preface>
diff --git a/doc/cli-reference/pom.xml b/doc/cli-reference/pom.xml
new file mode 100644
index 0000000000..06df7a4776
--- /dev/null
+++ b/doc/cli-reference/pom.xml
@@ -0,0 +1,80 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <parent>
+        <groupId>org.openstack.docs</groupId>
+        <artifactId>parent-pom</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>openstack-cli-reference</artifactId>
+    <packaging>jar</packaging>
+    <name>OpenStack Command Line Interface Reference</name>
+    <properties>
+        <!-- This is set by Jenkins according to the branch. -->
+        <release.path.name>local</release.path.name>
+        <comments.enabled>0</comments.enabled>
+    </properties>
+    <!-- ################################################ -->
+    <!-- USE "mvn clean generate-sources" to run this POM -->
+    <!-- ################################################ -->
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.rackspace.cloud.api</groupId>
+                <artifactId>clouddocs-maven-plugin</artifactId>
+                <!-- version is set in ../pom.xml file -->
+                <executions>
+                    <execution>
+                        <id>generate-webhelp</id>
+                        <goals>
+                            <goal>generate-webhelp</goal>
+                        </goals>
+                        <phase>generate-sources</phase>
+                        <configuration>
+                            <!-- These parameters only apply to webhelp -->
+                            <enableDisqus>0</enableDisqus>
+                            <disqusShortname>os-image-guide</disqusShortname>
+                            <enableGoogleAnalytics>1</enableGoogleAnalytics>
+                            <googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
+                            <generateToc>
+                                appendix  toc,title
+                                article/appendix  nop
+                                article   toc,title
+                                book      toc,title,figure,table,example,equation
+                                chapter   toc
+                                section   toc
+                                part      toc
+                                preface   toc
+                                qandadiv  toc
+                                qandaset  toc
+                                reference toc,title
+                                set       toc,title
+                            </generateToc>
+                            <!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
+                            <sectionAutolabel>0</sectionAutolabel>
+                            <formalProcedures>0</formalProcedures>
+                            <tocSectionDepth>1</tocSectionDepth>
+                            <tocChapterDepth>1</tocChapterDepth>
+                            <sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
+                            <webhelpDirname>cli-reference</webhelpDirname>
+                            <pdfFilenameBase>cli-reference</pdfFilenameBase>
+                        </configuration>
+                    </execution>
+                </executions>
+                <configuration>
+                    <!-- These parameters apply to pdf and webhelp -->
+                    <profileAudience>enduser</profileAudience>
+                    <xincludeSupported>true</xincludeSupported>
+                    <sourceDirectory>.</sourceDirectory>
+                    <includes>
+                        bk-cli-reference.xml
+                    </includes>
+                    <branding>openstack</branding>
+                    <canonicalUrlBase>http://docs.openstack.org/cli-reference/content/</canonicalUrlBase>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/doc/common/section_cli_version.xml b/doc/common/section_cli_version.xml
index 01e39ece8f..46626c95ba 100644
--- a/doc/common/section_cli_version.xml
+++ b/doc/common/section_cli_version.xml
@@ -4,60 +4,53 @@
         xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
         xml:id="checking_version_cli">
         <title>Get the version for a client</title>
-        <para>After you install an OpenStack client, you can get its
-                version number.</para>
-        <procedure>
-                <step>
-                        <para>Run the following command get the
-                                version number for a client:</para>
-                        <screen><prompt>$</prompt> <userinput><replaceable>PROJECT</replaceable> --version</userinput></screen>
-                        <para>Where <replaceable>PROJECT</replaceable>
-                                is one of the following project
-                                names:</para>
-                        <itemizedlist>
-                                <listitem>
-                                   <para><literal>nova</literal>.
-                                   Compute API and extensions.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>neutron</literal>.
-                                   Networking API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>keystone</literal>.
-                                   Identity Service API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>glance</literal>.
-                                   Image Service API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>swift</literal>.
-                                   Object Storage API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>cinder</literal>.
-                                   Block Storage Service API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>heat</literal>.
-                                   Orchestration API.</para>
-                                </listitem>
-                                <listitem>
-                                   <para><literal>ceilometer</literal>.
-                                   Telemetry API.</para>
-                                </listitem>
-                        </itemizedlist>
-                        <para>For example, to see the version of the
-                                nova client, run the following
-                                command:</para>
-                        <screen><prompt>$</prompt> <userinput>nova --version</userinput></screen>
-                        <screen><computeroutput>2.14.1.17</computeroutput></screen>
-                        <para>To see the version of the keystone
-                                client, run the following
-                                command:</para>
-                        <screen><prompt>$</prompt> <userinput>keystone --version</userinput></screen>
-                        <screen><computeroutput>0.3.1.73</computeroutput></screen>
-                </step>
-        </procedure>
+        <para>Run this command get the version number for a
+                client:</para>
+        <screen><prompt>$</prompt> <userinput><replaceable>PROJECT</replaceable> --version</userinput></screen>
+        <para>Where <replaceable>PROJECT</replaceable> is a project
+                name:</para>
+        <itemizedlist>
+                <listitem>
+                        <para><literal>nova</literal>. Compute API and
+                                extensions.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>neutron</literal>. Networking
+                                API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>keystone</literal>. Identity
+                                Service API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>glance</literal>. Image Service
+                                API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>swift</literal>. Object Storage
+                                API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>cinder</literal>. Block Storage
+                                Service API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>heat</literal>. Orchestration
+                                API.</para>
+                </listitem>
+                <listitem>
+                        <para><literal>ceilometer</literal>. Telemetry
+                                API.</para>
+                </listitem>
+        </itemizedlist>
+        <para>For example, to see the version number for the
+                        <command>nova</command> client, run this
+                command:</para>
+        <screen><prompt>$</prompt> <userinput>nova --version</userinput>
+<computeroutput>2.14.1.17</computeroutput></screen>
+        <para>To see the version number for the
+                        <command>keystone</command> client, run this
+                command:</para>
+        <screen><prompt>$</prompt> <userinput>keystone --version</userinput>
+<computeroutput>0.3.1.73</computeroutput></screen>
 </section>
diff --git a/doc/pom.xml b/doc/pom.xml
index 8659558d21..5b04ffbafd 100644
--- a/doc/pom.xml
+++ b/doc/pom.xml
@@ -10,6 +10,7 @@
 
   <modules>
     <module>admin-guide-cloud</module>
+    <module>cli-reference</module>
     <module>config-reference</module>
     <module>glossary</module>
     <module>high-availability-guide</module>
diff --git a/doc/user-guide/ch_cli.xml b/doc/user-guide/ch_cli.xml
index 7d4ca9f315..170d7122cf 100644
--- a/doc/user-guide/ch_cli.xml
+++ b/doc/user-guide/ch_cli.xml
@@ -16,8 +16,8 @@
     <xi:include href="../common/section_cli_version.xml"/>
     <?hard-pagebreak?>
     <xi:include href="../common/section_cli_openrc.xml"/>
-    <xi:include
-        href="../common/section_cli_glance_manage_images.xml"/>
+    <?hard-pagebreak?>
+    <xi:include href="../common/section_cli_glance_manage_images.xml"/>
     <?hard-pagebreak?>
     <xi:include href="section_cli_nova_configure_instances.xml"/>
     <?hard-pagebreak?>
@@ -25,8 +25,6 @@
     <?hard-pagebreak?>
     <xi:include href="section_cli_nova_manage_instances.xml"/>
     <?hard-pagebreak?>
-   <!-- <xi:include href="../common/section_cli_nova_user-data.xml"/>
-    <?hard-pagebreak?>-->
     <xi:include href="../common/section_cli_nova_userdata.xml"/>
     <?hard-pagebreak?>
     <xi:include href="section_cli_nova_config-drive.xml"/>
@@ -40,5 +38,6 @@
     <?hard-pagebreak?>
     <xi:include href="section_cli_ceilometer.xml"/>
     <?hard-pagebreak?>
-    <xi:include href="../common/section_cli_cinder_manage_volumes.xml"/>
+    <xi:include href="../common/section_cli_cinder_manage_volumes.xml"
+    />
 </chapter>