12:50 a.m.
Author: rdickens
Date: 2013-02-13 01:50:29 -0500 (Wed, 13 Feb 2013)
New Revision: 9143
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
Log:
Grammatical corrections and replacement of 'programlisting' with 'screen'
DocBook tag as appropriate.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
---
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-12
05:26:16 UTC (rev 9142)
+++
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-13
06:50:29 UTC (rev 9143)
@@ -29,11 +29,11 @@
<para>After deploying the CLI web application you can connect to the CLI over
SSH as follows</para>
<example>
<title>SSH Syntax</title>
- <programlisting>ssh -p <port>
<user>@<host></programlisting>
+ <scree>ssh -p <port>
<user>@<host></screen>
</example>
<example>
<title>SSH Example</title>
- <programlisting>ssh -p 2000 root@localhost</programlisting>
+ <screen>ssh -p 2000 root@localhost</screen>
</example>
<remark>Added full path for clarity.</remark>
<para>
@@ -76,7 +76,7 @@
</para>
<example>
<title>mgmt help</title>
- <programlisting>% mgmt -h
+ <screen>% mgmt -h
usage: mgmt[-h | --help] COMMAND [ARGS]
The most commonly used mgmt commands are:
@@ -92,7 +92,7 @@
[-p | --password] the user passowrd
[-c | --container] portal container name (default is portal)
-%</programlisting>
+%</screen>
</example>
<para>
The
@@ -101,19 +101,19 @@
</para>
<example>
<title>Connecting to default portal container</title>
- <programlisting>% mgmt connect
+ <screen>% mgmt connect
Password:
Successfully connected to gatein management system: [user=root,
container='portal', host='127.0.0.1']
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Connecting to portal container 'sample-portal' as
user john</title>
- <programlisting>% mgmt connect -u john -c sample-portal
+ <screen>% mgmt connect -u john -c sample-portal
Password:
Successfully connected to gatein management system: [user=john,
container='sample-portal', host='127.0.0.1']
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<para>
The
@@ -122,7 +122,7 @@
</para>
<example>
<title>mgmt exec help</title>
- <programlisting>[ /]% mgmt exec -h
+ <screen>[ /]% mgmt exec -h
usage: mgmt [-h | --help] exec [-c | --contentType] [-f | --file] [-a | --attribute] [-o
| --operation] path
[-h | --help] command usage
@@ -132,15 +132,15 @@
[-o | --operation] Operation name
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Executing operation read-config-as-xml on managed component
foo</title>
- <programlisting>[ /]% mgmt exec --operation read-config-as-xml
--contentType xml /foo
+ <screen>[ /]% mgmt exec --operation read-config-as-xml --contentType xml
/foo
<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-cat">
@@ -150,13 +150,13 @@
<code>cat</code>
command executes the
<code>read-config-as-xml</code>
- operation on a managed resource and outputs the xml data to the shell.
Obviously the managed resource must support the
+ operation on a managed resource and outputs the XML data to the shell. The
managed resource must support the
<code>read-config-as-xml</code>
operation.
</para>
<example>
<title>cat help</title>
- <programlisting>[ /]% cat -h
+ <screen>[ /]% cat -h
usage: cat [-h | --help] path
   [-h | --help] command usage
@@ -166,7 +166,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-cd">
@@ -174,19 +174,19 @@
<para>The cd command changes the current path of the CLI.</para>
<example>
<title>cd help</title>
- <programlisting>[ /]% cd -h
+ <screen>[ /]% cd -h
usage: cd [-h | --help] path
   [-h | --help] command usage
   path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Change path to /foo/bar</title>
- <programlisting>[ /]% cd /foo/bar
+ <screen>[ /]% cd /foo/bar
-[bar]%</programlisting>
+[bar]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-ls">
@@ -200,7 +200,7 @@
</para>
<example>
<title>ls help</title>
- <programlisting>[ /]% ls -h
+ <screen>[ /]% ls -h
usage: ls [-h | --help] path
[-h | --help] command usage
@@ -213,7 +213,7 @@
[ /]% ls /foo
baz
-[ /]%</programlisting>
+[ /]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-pwd">
@@ -225,7 +225,7 @@
</para>
<example>
<title>pwd help</title>
- <programlisting>[ /]% pwd -h
+ <screen>[ /]% pwd -h
usage: pwd [-h | --help]
[-h | --help] command usage
@@ -237,7 +237,7 @@
[baz]% pwd
/foo/baz
-[baz]%</programlisting>
+[baz]%</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-export">
@@ -251,11 +251,11 @@
</para>
<important>
<title>Important</title>
- <para>Since the CLI is connected to the portal server over SSH, the export
command will write to the servers file system, not the client.</para>
+ <para>Since the CLI is connected to the portal server over SSH, the export
command will write to the server's file system, not that of the client.</para>
</important>
<example>
<title>export help</title>
- <programlisting>[ /]% export -h
+ <screen>[ /]% export -h
usage: export [-h | --help] [-f | --file] [-r | --filter] path
[-h | --help] command usage
@@ -263,14 +263,14 @@
[-r | --filter] Specifies the value of the filter to use during an export for
example.
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Export resource foo to /tmp directory</title>
- <programlisting>[ /]% export --file /tmp foo
+ <screen>[ /]% export --file /tmp foo
Export complete ! File location: /tmp/foo_2011-10-21_18-29-36.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
<note>
<title>Note</title>
@@ -278,17 +278,17 @@
</note>
<example>
<title>Export resource /foo to /tmp/export-example.zip file</title>
- <programlisting>[ /]% export --file /tmp/export-example.zip foo
+ <screen>[ /]% export --file /tmp/export-example.zip foo
Export complete ! File location: /tmp/export-example.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
<example>
<title>Export resource filtering on path template variable
bar</title>
- <programlisting>[ /]% export --file /tmp/export-filter-example.zip --filter
bar:baz,foo-bar foo
+ <screen>[ /]% export --file /tmp/export-filter-example.zip --filter
bar:baz,foo-bar foo
Export complete ! File location: /tmp/export-filter-example.zip
-[ /%]</programlisting>
+[ /%]</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-import">
@@ -302,7 +302,7 @@
</para>
<example>
<title>import help</title>
- <programlisting>[ /]% import -h
+ <screen>[ /]% import -h
usage: importfile [-h | --help] [-f | --file] [-m | --importMode] path
[-h | --help] command usage
@@ -310,7 +310,7 @@
[-m | --importMode] The import mode for an import operation
path
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<important>
<title>Important</title>
@@ -318,21 +318,21 @@
</important>
<example>
<title>Import file /tmp/foo.zip to resource foo</title>
- <programlisting>[ /]% import --file /tmp/foo.zip /foo
+ <screen>[ /]% import --file /tmp/foo.zip /foo
Successfully imported file /tmp/foo.zip
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<example>
<title>Import file /tmp/foo.zip to resource foo using importMode
overwrite</title>
- <programlisting>[ /]% import --file /tmp/foo.zip --importMode overwrite
/foo
+ <screen>[ /]% import --file /tmp/foo.zip --importMode overwrite /foo
Successfully imported file /tmp/foo.zip
-[ /]%</programlisting>
+[ /]%</screen>
</example>
<note>
<title>Note</title>
- <para>You can autocomplete the import modes by typing --importMode and
hitting tab.</para>
+ <para>You can autocomplete the import modes by typing --importMode and
pressing the Tab key.</para>
</note>
</section>
<section id="sid-8094332_GateInManagement-SecureCopy">
@@ -349,11 +349,11 @@
<para>
To execute the
<code>export-resource</code>
- operation using SCP the source of the SCP command is the portal server and the
target is the local file to export to.
+ operation using SCP, the source of the SCP command is the portal server and the
target is the local file to which the resource is to be exported.
</para>
<example>
<title>Syntax</title>
- <programlisting>$ scp -P <port>
<user>@<host>:{portal-container}:{path}
<file></programlisting>
+ <screen>$ scp -P <port>
<user>@<host>:{portal-container}:{path}
<file></screen>
</example>
<para>
The
@@ -367,12 +367,12 @@
<para>So to export 'foo/bar' resource assuming the CLI is
deployed to 'example.org'.</para>
<example>
<title>Export of foo/bar resource</title>
- <programlisting>$ scp -P 2000
'root@example.org:portal:/foo/bar' bar.zip</programlisting>
+ <screen>$ scp -P 2000
'root@example.org:portal:/foo/bar' bar.zip</screen>
</example>
<para>Attributes like 'filter' can be added to the path
of the SCP command just as you would add query parameters to a URL.</para>
<example>
<title>Export of foo/bar resource with filter</title>
- <programlisting>$ scp -P 2000
'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar'
foo.zip</programlisting>
+ <screen>$ scp -P 2000
'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar'
foo.zip</screen>
</example>
</section>
<section id="sid-8094332_GateInManagement-Import">
@@ -380,11 +380,11 @@
<para>
To execute the
<code>import-resource</code>
- operation using SCP the source of the SCP command is the local file and the
target is the portal server.
+ operation using SCP, the source of the SCP command is the local file and the
target is the portal server.
</para>
<example>
<title>Syntax</title>
- <programlisting>$ scp -P <port> <file>
<user>@<host>:{portal-container}:{path}</programlisting>
+ <screen>$ scp -P <port> <file>
<user>@<host>:{portal-container}:{path}</screen>
</example>
<para>
The
@@ -397,7 +397,7 @@
</para>
<example>
<title>Import foo.zip to foo resource</title>
- <programlisting>$ scp -P 2000 foo.zip
'root@example.org:portal:/foo'</programlisting>
+ <screen>$ scp -P 2000 foo.zip
'root@example.org:portal:/foo'</screen>
</example>
<note>
<title>Note</title>