blob: 2784d40720f11381b82ae6277510357545f36598 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<title>Rich Client Platform (RCP) help</title>
</head>
<body>
<h2>Rich Client Platform (RCP) help</h2>
<p>
The Help system is an <em>optional</em> Rich Client Platform (RCP) component. That
is, it is <em>not</em> part of the minimal RCP, but can be added to it. The following
plug-ins and all of their dependencies, including optional dependencies must be added to the RCP base in order to run the Help system:
</p>
<p>
<br>
org.eclipse.help.ui<br>
org.eclipse.help.webapp<br>
</p>
<p>
<em>Note</em>: Help contents will only be made available to the user if there is
content available. If there are no topics in the table of contents, the help will
not be available.
</p>
<h3>Setting the Help Server Port and Hostname</h3>
<p>The help server port and host name can be specified using virtual machine arguments as follows:</p><ul>
<li><b>-Dserver_port=&lt;port number&gt;</b> specifies the port number that the
help server will use. </li>
<li><b>-Dserver_host=&lt;host name&gt;</b> specifies the host name which will be used
when the help system creates URLs which reference help pages.</li>
</ul>
</body>
</html>