[jboss-cvs] JBossAS SVN: r104355 - projects/docs/enterprise/5.0/Installation_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Apr 29 22:02:24 EDT 2010
Author: misty at redhat.com
Date: 2010-04-29 22:02:23 -0400 (Thu, 29 Apr 2010)
New Revision: 104355
Modified:
projects/docs/enterprise/5.0/Installation_Guide/en-US/Getting_Started.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_Using_Graphical_Installer.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RHN.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RPM_Download.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_ZIP_Download.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Post_Installation.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Test_Your_Installation.xml
projects/docs/enterprise/5.0/Installation_Guide/en-US/Uninstall_JBoss.xml
Log:
Fixing programlisting and screen issues
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Getting_Started.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Getting_Started.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Getting_Started.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -111,7 +111,7 @@
</itemizedlist>
<important>
<para>
- The JBoss Enterprise Application Platform 5 is supported on any Operating System as long as a certified JVM is used, following the JBoss Support Policy: <ulink url="http://www.jboss.com/products/platforms/application/supportedconfigurations/">http://www.jboss.com/products/platforms/application/supportedconfigurations/</ulink>. However this does not apply to the optional Native code install, which only applies to the Operating Systems included in the list above.
+ The JBoss Enterprise Application Platform 5 is supported on any Operating System using a certified JVM. Refer to the <ulink url="http://www.jboss.com/products/platforms/application/supportedconfigurations/">JBoss Support Policy</ulink> for more information. However, the optional Native code install is only available on the Operating Systems included in the list above.
</para>
</important>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_Using_Graphical_Installer.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_Using_Graphical_Installer.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_Using_Graphical_Installer.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -13,7 +13,7 @@
</listitem>
<listitem>
<para>
- On many operating systems, you can run executable JARs by double-clicking them. If your system doesn't support that, you can run the installer directly from the command line: <programlisting>[vsr]$ java -jar enterprise-installer-<replaceable><release></replaceable>.jar</programlisting>
+ On many operating systems, you can run executable JARs by double-clicking them. If your system doesn't support that, you can run the installer directly from the command line: <command>[vsr]$ java -jar enterprise-installer-<replaceable><release></replaceable>.jar</command>
</para>
</listitem>
<listitem>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RHN.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RHN.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RHN.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -87,7 +87,7 @@
<listitem>
<para>
Run the following command:
-<screen><command><!--up2date -!-installall jbappplatform-4.3.0-[i386|x86_64]-[as|es]-4-rpm-->up2date jbossas jboss-seam rh-eap-docs jboss-profiler</command></screen>
+<command><!--up2date -!-installall jbappplatform-4.3.0-[i386|x86_64]-[as|es]-4-rpm-->up2date jbossas jboss-seam rh-eap-docs jboss-profiler</command>
</para>
</listitem>
</itemizedlist>
@@ -107,7 +107,7 @@
<listitem>
<para>
Run the following command:
-<screen><command>yum install jbossas jboss-seam rh-eap-docs jboss-profiler</command></screen>
+<command>yum install jbossas jboss-seam rh-eap-docs jboss-profiler</command>
</para>
<note>
<para>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RPM_Download.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RPM_Download.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_RPM_Download.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -8,8 +8,8 @@
In this form of installation, install the RPMs to the directory of your choice. <itemizedlist>
<listitem>
<para>
- Install the rpms to the location of your choice. You can do this using the following command. <programlisting>
-[vsr]$ <literal>rpm -ivf <rpm filename></literal></programlisting>
+ Install the rpms to the location of your choice. You can do this using the following command. <command>
+[vsr]$ <literal>rpm -ivf <rpm filename></literal></command>
</para>
</listitem>
<listitem>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_ZIP_Download.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_ZIP_Download.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Installation_With_ZIP_Download.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -26,10 +26,10 @@
<listitem>
<para>
Unzip <literal>jboss-eap-<replaceable><release></replaceable>.zip</literal> to extract the archive contents into the location of your choice.</para>
-<programlisting>
+<screen>
[vsr]$ <literal>cd /directory/to/install/in</literal>
[vsr]$ <literal>unzip jboss-eap-<replaceable><release></replaceable>.zip </literal>
-</programlisting>
+</screen>
</listitem>
<listitem>
@@ -45,12 +45,9 @@
</note>
<important>
<para>
- On Windows Server 2008 when installing the JBoss Enterprise Application Platform service, open Windows Explorer and right click on <filename>C:\Windows\System32\cmd.exe</filename> and select <guimenuitem>Run As Administrator</guimenuitem>. Then change directory to the root of your installation directory (<filename>%JBOSS_HOME%\bin</filename>) and install the service using the command:
- </para>
-<programlisting>
-service install
-</programlisting>
- <para>
+ On Windows Server 2008 when installing the JBoss Enterprise Application Platform service, open Windows Explorer and right click on <filename>C:\Windows\System32\cmd.exe</filename> and select <guimenuitem>Run As Administrator</guimenuitem>. Then change directory to the root of your installation directory (<filename>%JBOSS_HOME%\bin</filename>) and install the service using the command: <command>service install</command>
+ </para>
+ <para>
This is needed because of the Windows UAC. On Windows 2003 the <guimenuitem>Run As Administrator</guimenuitem> step is not needed as long as the current user has the correct privileges to install the service.
</para>
</important>
@@ -124,20 +121,20 @@
Unzip the JBoss Native package:
</para>
- <programlisting>
+ <screen>
[vsr]$ <literal>cd /directory/to/install/in</literal>
[vsr]$ <literal>unzip jboss-eap-native-5.0.0-<replaceable><operating_system></replaceable>-<replaceable><system_architecture></replaceable>.zip </literal>
-</programlisting>
+</screen>
</listitem>
<listitem>
<para>
Once unzipped, the package will be installed in the <filename>jboss-eap-<replaceable><release></replaceable></filename> directory as a <filename>native</filename> subdirectory.
</para>
-<programlisting>jboss-eap-<replaceable><release></replaceable>
+<screen>jboss-eap-<replaceable><release></replaceable>
| `-- jboss-as
| `-- native
| `-- resteasy
-| `-- seam</programlisting>
+| `-- seam</screen>
</listitem>
</itemizedlist>
<!-- *|*|*|
@@ -148,9 +145,9 @@
<note><title>APR Packages</title>
<para>
Ensure that the APR packages (apr and apr-util) are installed on the system prior to starting the server. Determine whether the packages are installed:
- <programlisting>[vsr]$ yum list apr apr-util</programlisting>
+ <command>[vsr]$ yum list apr apr-util</command>
If they are not installed run the following command as the root user:
- <programlisting>[root]$ yum install apr apr-util</programlisting>
+ <command>[root]$ yum install apr apr-util</command>
</para>
</note>
<!-- *|*|*|
@@ -171,9 +168,9 @@
<para>
To install both 32-bit and 64-bit versions of <filename>jboss-eap-native</filename>, use the command:
</para>
-<programlisting>
+<screen>
unzip -qo jboss-eap-native-5.0.0-solaris
-</programlisting>
+</screen>
<para>
The <code>-o</code> option in the command ensures that one version of the package won't replace another during the installation.
</para>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Post_Installation.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Post_Installation.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Post_Installation.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -7,28 +7,30 @@
<title>
Set JBOSS_HOME Environment Variable
</title>
- <formalpara>
+ <example>
<title>
On a Linux Platform
</title>
<para>
Create an environment variable that points to the installation directory (<filename>JBOSS_DIST/jboss-as</filename>) and call it <literal>JBOSS_HOME</literal>. Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory.
- <programlisting>
+ </para>
+ <screen>
#In this example /home/<username>/EnterprisePlatform-5.0.0/jboss-as is the installation directory.
export JBOSS_HOME=/home/<username>/EnterprisePlatform-5.0.0/jboss-as
export PATH=$PATH:$JBOSS_HOME/bin
- </programlisting>
+ </screen>
+ <para>
Set this variable for the user account(s) that will run the server.
</para>
- </formalpara>
- <formalpara>
+ </example>
+ <example>
<title>
On Microsoft Windows
</title>
<para>
Create a System environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\EnterprisePlatform-5.0.0\jboss-as\. In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: C:\EnterprisePlatform-5.0.0\jboss-as\bin. To do this, open the Control Panel from the Start Menu, switch to Classic View if necessary, open the System Control Panel applet, select the Advanced Tab, and click on the Environment Variables button.
</para>
- </formalpara>
+ </example>
<para>
<literal>TMP</literal> and <literal>TEMP</literal> System environment variables also need to be added. By default these variables are User based, so you will have to change them to be System based. This will assure that the JBoss Enterprise Application Server uses the same location for temporary storage no mater which user account is used to run it.
</para>
@@ -46,15 +48,15 @@
The default profile for the server to start with, if no other profile is specified, is the profile called default. It is recommended to run the example Seam applications that are included with the documentation using the production profile.
</para>
<para>
- To avoid memory issues, adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> to match your application requirements. The default settings are:
-<programlisting>
+ To avoid memory issues, adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> to match your application requirements. The default settings are:
+ </para>
+<screen>
<!-- *|*|*| = Leaving these remarks in as they relate to a reviewed update performed on 26/02/10. i.e. "Waveriders" note this is current (as at Feb 10) material.
<remark>Change here: new format in the run.conf file (i.e. no -XX:PermSize=256m)</remark>
-->
-Xms1303m -Xmx1303m -XX:MaxPermSize=256m
<!-- -Xms1303m -Xmx1303m -XX:PermSize=256m -XX:MaxPermSize=256m -->
-</programlisting>
- </para>
+</screen>
<important>
<para>
If you are running the JBoss Enterprise Application Platform on a Windows operating system then you will need to update the <filename>JBOSS_DIST/jboss-as/bin/run.conf.bat</filename> file to match your application requirements.
@@ -77,27 +79,26 @@
</para>
</important>
- <formalpara><title>Set up the <literal>jmx-console</literal> users and roles</title>
+ <example><title>Set up the <literal>jmx-console</literal> users and roles</title>
<para>
Edit the <filename>jmx-console-users.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/conf/props/</filename> directory defining the username and password:
</para>
- </formalpara>
<programlisting>user=password</programlisting>
<para>
Edit the <filename>jmx-console-roles.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/conf/props/</filename> directory to define the user's roles:
</para>
<programlisting>user=JBossAdmin,HttpInvoker</programlisting>
-
- <formalpara><title>Set up the <literal>admin-console</literal> users and roles</title>
+ </example>
+ <example><title>Set up the <literal>admin-console</literal> users and roles</title>
<para>
Edit the <filename>web-console-users.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory:
</para>
- </formalpara>
<programlisting>user=password</programlisting>
<para>
Edit the <filename>web-console-roles.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory:
</para>
<programlisting>user=JBossAdmin,HttpInvoker</programlisting>
+ </example>
<note><title>$JBOSS_HOME and $CONFIG</title>
<para>
<varname>$JBOSS_HOME</varname> is the <filename>jboss-as</filename> directory, a level above the bin directory. <varname>$CONFIG</varname> is the chosen server configuration - all, default, minimal production, standard or web.
@@ -125,12 +126,12 @@
<!-- *|*|*|
<remark>SuckerPassword changed to suckerPassword</remark>
-->
- <formalpara>
+ <example>
<title>Set suckerPassword for JBoss Messaging:</title>
<para>
JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by this parameter <literal>suckerPassword</literal> in the configuration file:
</para>
- </formalpara>
+
<!-- *|*|*|
<remark>changed the path here "deploy" was not included</remark>
-->
@@ -153,6 +154,6 @@
...
...
</bean></programlisting>
-
+ </example>
</section>
</chapter>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Test_Your_Installation.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Test_Your_Installation.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Test_Your_Installation.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -10,8 +10,9 @@
<para>
After you have installed the JBoss Enterprise Application Platform, it is wise to perform a simple startup test to validate that there are no major problems with your Java VM/operating system combination. Make sure you have set the <literal>JBOSS_HOME</literal> environment variable as explained in <ulink url="Post_Installation_Configuration"/>. To test your installation, move to the <filename>$JBOSS_HOME/bin</filename> directory and execute the <filename>run.bat</filename> (for Windows) or <filename>run.sh</filename> (for Linux) script, as appropriate for your operating system. Your output should look like the following (accounting for installation directory differences) and contain no error or exception messages:
</para>
-<programlisting>
-[vrenish at vinux bin]$ ./run.sh
+<screen>
+[vrenish at vinux bin]$ <command>./run.sh</command>
+<computeroutput>
=====================================================
JBoss Bootstrap Environment
@@ -38,17 +39,19 @@
18:45:51,824 INFO [Server] Core system initialized
18:45:59,622 INFO [WebService] Using RMI server codebase: http://127.0.0.1:8083 /
18:45:59,659 INFO [Log4jService$URLWatchTimerTask] Configuring from URL: resource:jboss-log4j.xml
-</programlisting>
+</computeroutput>
+</screen>
<!-- *|*|*|
<remark>/* Added from here ... JBPAPP-3280</remark>
-->
-<formalpara><title>APR Message</title>
+<example><title>APR Message</title>
<para>
When using the JBoss Native zip installation, install apr and apr-util as discussed in <xref linkend="sect-Installation_With_Zip_Download-JBoss_Native_Installation"/> if the following message is displayed when starting the server:
- <programlisting>WARN [AprLifecycleListener] The Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: /home/user/installLocation/jboss-eap-5.0/native/lib.
- </programlisting>
</para>
-</formalpara>
+ <screen><computeroutput>
+ WARN [AprLifecycleListener] The Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: /home/user/installLocation/jboss-eap-5.0/native/lib.
+ </computeroutput></screen>
+</example>
<!-- *|*|*|
<remark>... to here */</remark>
-->
@@ -85,15 +88,16 @@
<para>
Clicking on the <guilabel>Administration Console</guilabel> link will redirect the user to a login page. Entering the username and password as configured in <xref linkend="Post-Installation"/> will result in the display of the administration console. If this is not the case, check that the server has been started in one of the <quote>out of the box</quote> supported configurations (see <xref linkend="migration.admin"/>) and that the user accounts have been correctly set up as per the instructions in <xref linkend="Post-Installation"/>.
</para>
- <formalpara><title>The Administration Console and SystemInfoFactory Messages</title>
+ <example><title>The Administration Console and SystemInfoFactory Messages</title>
<para>
When accessing the administration console, the following warnings may be displayed or logged:
- <programlisting>WARN [SystemInfoFactory] System info API not accessible on this platform (native shared library not found in java.library.path).
+ </para>
+ <screen><computeroutput>
+ WARN [SystemInfoFactory] System info API not accessible on this platform (native shared library not found in java.library.path).
INFO [PluginContainerResourceManager] Discovering Resources...
WARN [JMXDiscoveryComponent] Unable to complete base jmx server discovery (enable DEBUG for stack): java.lang.UnsupportedOperationException: No native library available - Cannot get the process table information without native support
- </programlisting>
- </para>
- </formalpara>
+</computeroutput></screen>
+ </example>
<para>
These warnings relate to the inability of <application>RHQ</application> to perform process table scans as <application>SIGAR</application>, which is used to monitor external processes, is not packaged with <application>RHQ</application>. These messages are returned due to the fact that <application>RHQ</application> is embedded in the administration console. The messages can therefore be ignored as external process monitoring is not a function performed by the administration console.
</para>
Modified: projects/docs/enterprise/5.0/Installation_Guide/en-US/Uninstall_JBoss.xml
===================================================================
--- projects/docs/enterprise/5.0/Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-30 01:28:28 UTC (rev 104354)
+++ projects/docs/enterprise/5.0/Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-30 02:02:23 UTC (rev 104355)
@@ -6,9 +6,9 @@
<title>Uninstall JBoss</title>
<para>
If you used the GUI installer to install &JBEAP;, then an automatic uninstaller is also installed. From the GUI the uninstaller can be selected from the JBoss program group, if one was created at installation time. A second option is to run this uninstaller from the command line. Within the &JBEAP; Installation directory you will find a directory called <filename>Uninstaller</filename>. Inside the <filename>Uninstaller</filename> directory you will find a jar file named <filename>uninstaller.jar</filename>. Run the uninstaller from the command line using the <literal>jar</literal> utility.
-<programlisting>
+<command>
[vsr]$ java -jar uninstaller.jar
-</programlisting>
+</command>
This command will launch the uninstaller program. If you wish to delete the installation directory and all its contents select the check box "Force the deletion of <installation_directory>" and hit the Uninstall button.
<figure id="Uninstall_JBoss-Uninstaller">
<title>Uninstaller</title>
More information about the jboss-cvs-commits
mailing list