mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-13 12:05:21 +02:00
Code Issues Wiki Activity

Add gettingstarted guide to userdoc; Update TOC; Remove links to User Actions, compile commands and import/export features.

Browse source
This commit is contained in:
Martin Oberhuber 2006-08-19 02:09:30 +00:00
parent 98d8b37a2b
commit 9ec21d5100
12 changed files with 715 additions and 453 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
rse/doc/org.eclipse.rse.doc.user/build.properties
View file

@ -8,5 +8,6 @@ bin.includes = META-INF/,\
tasks/,\
book.css,\
notices.html,\
toc.xml
toc.xml,\
gettingstarted/

2
rse/doc/org.eclipse.rse.doc.user/concepts/cfilters.html
View file

@ -98,10 +98,12 @@ you can always create a new profile. See
the related links for more information.</p>
</div>
<div>
<!-- TODODeferred
<p><b class="relconceptshd">Related concepts</b><br/>
<a href="cuseractions.html" title="">User actions (user options)</a><br/>
<a href="cremcompile.html" title="">Compiling</a><br/>
</p>
-->
<p><b>Related Tasks</b><br/>
<a href="../tasks/tmanagepools.html" title="">Configuring filter pools</a><br/>
<a href="../tasks/tmanageedit.html"

2
rse/doc/org.eclipse.rse.doc.user/concepts/cteam.html
View file

@ -43,7 +43,7 @@ synchronizing with the repository, you will receive all the shared
Remote System
Explorer resources from your team, including their profiles. You then
use the <b>Reload Remote System Explorer</b> action, located on the
pop-up menu, to make the Remote Systems Explorer know about these
pop-up menu, to make the Remote System Explorer know about these
changes.&nbsp; You can also, of course, quit and restart the
workbench.&nbsp; See the related tasks for more information.</p>
<p>Any resources received that are in a profile that you have already

48
rse/doc/org.eclipse.rse.doc.user/gettingstarted/g1installing.html Normal file
View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2004, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" href="../book.css"/>
<title>Installing the RSE</title>
</head>
<body id="g1installing">
<a name="g1installing"><!-- --></a>
<h1 class="topictitle1">Installing the Remote System Explorer</h1>
<div>
The simplest way to get RSE is via the Update Manager: From your running instance
of Eclipse 3.2, choose <i>Help &gt; Software Updates &gt; Find and Install...</i>.
Choose "Search for New Features to Install", and add a new Remote Site named
"RSE" and pointing to <a href="http://download.eclipse.org/dsdp/tm/updates/">
http://download.eclipse.org/dsdp/tm/updates/</a>.
Select the RSE SDK feature, and perform the update process as usual.</p>
<p>If you prefer manual installation, you can download RSE SDK from the
DSDP <a href="http://download.eclipse.org/dsdp/tm/downloads/">Target
Management Download Site</a> and extract it into your installation of
Eclipse 3.2 or later, or link it as product extension.
<p>Start Eclipse Workbench, and choose <i>Window &gt; Open Perspective &gt;
Other &gt; Remote System Explorer</i>.</p>
</div>
<div>
<!--
<p><b class="relconceptshd">Related concepts</b><br/>
<a href="../concepts/cbegin.html" title="">Remote System Explorer Connections</a><br/>
</p>
<p><b class="reltaskshd">Related tasks</b><br/>
-->
<p><b class="reltaskshd">Follow-up tasks</b><br/>
<a href="g2firststeps.html" title="">First Steps with the Remote System Explorer</a><br/>
<!--
<a href="../tasks/tbeginlinux.html" title="">Connecting to a remote
Linux or UNIX server</a><br/>
<a href="../tasks/tbeginwindows.html" title="">Connecting to a remote
Windows server</a><br/>
-->
<a href="gusing.html" title="">Using Remote System Explorer Connections</a><br/>
</p>
</div>
</body>
</html>

59
rse/doc/org.eclipse.rse.doc.user/gettingstarted/g2firststeps.html Normal file
View file

@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2004, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" href="../book.css"/>
<title>First Steps with RSE</title>
</head>
<body id="g2firststeps">
<a name="g2firststeps"><!-- --></a>
<h1 class="topictitle1">First Steps with the Remote System Explorer</h1>
<div>
Even without an actual connection to a remote system, you can start experimenting
with the Remote System Explorer UI on the local host, which is shown by default
under the <i>Local</i> node:
<ul>
<li>Browse the Filesystem, choose <i>contextmenu &gt; show in Table</i>, and
observe the Properties view.</li>
<li>Create a new <a href="../concepts/cfilters.html">Filter</a> to show
specific resources in the file system only.</li>
<li>Launch an <a href="../concepts/crunremcmds.html">RSE Shell</a>
(Shells node &gt; Launch)
<ul><li>In the Shell, perform commands such as ls, dir, ps, gcc, make and see
the output interpreted</li>
<li>Use Ctrl+Space Content Assist on the shell command entry field</li>
</ul></li>
</ul>
For operations on an actual remote system, you can either
<ul>
<li>use the "<b>SSH Only</b>" system type (<i>New > Other > Remote System Explorer > Connection</i>), or</li>
<li>start a <a href="../tasks/tbeginlinux.html">dstore server daemon</a>
on the remote system and use any of the other connection types.</li>
</ul>
<p>RSE is a framework that supports plugging in many different communication protocols.
By default, the dstore, FTP and ssh protocol plug-ins are provided, with dstore being
the richest in features.<br/>
Dstore requires a server to run on the remote system. There are several methods to
get a server launched for a particular user, the most easy one to set up is the
daemon method.</p>
</div>
<div>
<p><b class="reltaskshd">Follow-up tasks</b><br/>
<a href="gusing.html" title="">Using Remote System Explorer Connections</a><br/>
</p>
<p><b class="relconceptshd">Related concepts</b><br/>
<a href="../concepts/cbegin.html" title="">Remote System Explorer Connections</a><br/>
<a href="../concepts/cfilters.html" title="">Remote System Explorer filters, filter
pools, and filter pool references</a><br/>
<a href="../concepts/cuniversal.html">Universal Systems</a><br/>
<a href="../tasks/tbeginlinux.html" title="">Connecting to a remote
Linux or UNIX server</a><br/>
<a href="../tasks/tbeginwindows.html" title="">Connecting to a remote
Windows server</a><br/>
</p>
</div>
</body>
</html>

55
rse/doc/org.eclipse.rse.doc.user/gettingstarted/g_start.html Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2004, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" href="../book.css"/>
<title>Getting Started with RSE</title>
</head>
<body id="gstart">
<a name="gstart"><!-- --></a>
<h1 class="topictitle1">Getting Started with the Remote System Explorer</h1>
<div>
<p>The Remote System Explorer (RSE) is a perspective and toolkit in Eclipse
Workbench, that allows you to connect and work with a variety of remote
systems. With the predefined plug-ins, You can look at remote file systems,
transfer files between hosts, do remote search, execute commands and work
with processes.</p>
<p>Additional capabilities may be added by Software Vendors by providing new
<i>System Types</i>, <i>Services</i> and <i>Subsystem implementations</i>
for specific remote access protocols or resource kinds respectively. The framework
helps by providing lots of predefined re-usable components, like persistence
mechanisms, filtering and team sharing.</p>
<a href="../images/RSESample.gif">
<!-- <img src="../images/RSESample.gif" alt="A sample RSE session" width="917" height="659"/><br/>
-->
<img src="../images/RSESample.gif" alt="A sample RSE session" width="459" height="330"/><br/>
</a>
<p>Here is a screenshot of a sample session with RSE (Click on the picture to
enlarge it).
This tutorial will guide you quickly through the most prominent features of
the Remote System Explorer:
<ul>
<li><a href="g1installing.html" title="">Installing the Remote System Explorer</a></li>
<li><a href="g2firststeps.html" title="">First Steps with the Remote System Explorer</a></li>
<li><a href="gusing.html" title="">Using Remote System Explorer Connections</a></li>
</ul>
</div>
<div>
<p><b class="relconceptshd">Related concepts</b><br/>
<a href="../concepts/cbegin.html" title="">Remote System Explorer Connections</a><br/>
</p>
<!--
<p><b class="reltaskshd">Related tasks</b><br/>
<a href="../tasks/tbeginlinux.html" title="">Connecting to a remote
Linux or UNIX server</a><br/>
<a href="../tasks/tbeginwindows.html" title="">Connecting to a remote
Windows server</a><br/>
</p>
-->
</div>
</body>
</html>

66
rse/doc/org.eclipse.rse.doc.user/gettingstarted/gusing.html Normal file
View file

@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2004, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" href="../book.css"/>
<title>Using Remote Connections</title>
</head>
<body id="gusing">
<a name="gusing"><!-- --></a>
<h1 class="topictitle1">Using Remote Connections</h1>
<div>
Here are a few tasks that help you get acquainted with RSE. All tasks assume that you have
switched to the Remote System Explorer Perspective in your Workbench. Some of the tasks
can not be performed on all system types, although RSE tries to provide a consistent UI
across many different kinds of remote systems..
<ul>
<li>In the RSE Perspective, Remote Systems View, press the <b>New Connection</b> button.<ul>
<li>Note: In the Preferences, you can enable displaying available new connection types in the RSE tree.</li></ul></li>
<li>Select the desired system type<ul>
<li>Coose system type "SSH Only" for ssh servers, or any other for dstore.</li></ul></li>
<li>Enter an IP address for a remote system running an ssh server or dstore server.
A connection name will be suggested automatically, but can be changed.<ul>
<li>You can also run a dstore server on the local machine for testing. In this case,
type "localhost" as address.</li>
<li>You can press Finish right away, the wizard defaults are usually fine.</li></ul></li>
<li>Fill in the username / password dialog.<ul>
<li>Note: For ssh, if you have private keys, the password here is just a dummy.
Enter anything and save it. You can setup ssh private key authentication through
the <b>Team &gt; CVS &gt; SSH2 Connection Method</b> Preference page.</li></ul></li>
<li><b>Browse remote files</b>, or open remote shells.<ul>
<li>You can <b>drag and drop</b> files between local and remote file systems, between editors and any view.
Files are transferred as needed.</li>
<li>On dstore, you can browse into remote archives (*.zip, *.tar) without having to transfer the entire contents. This works thanks
to "miners" on the remote side. Custom miners can be plugged into the dstore server.<br>
Note: Some tar formats currently fail to work. See <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=139207">bug 139207</a>.</li>
<li>On dstore, you can choose <b>Search &gt; Remote...</b>.<ul>
<li>The dstore miners support searching a remote file system
without having to transfer any data.</li></ul></li>
<li>On dstore, when the remote system is Linux, AIX or Other Unix:<ul>
<li>Browse remote <b>Processes</b>.</li>
<li>Select "My Processes" and choose context menu &gt; <b>Monitor</b>.
<li>Enable polling, choose a short wait time. See processes appear and vanish as you perform commands in a remote shell.</li></ul></li>
</ul>
</div>
<div>
<p><b class="relconceptshd">Related concepts</b><br/>
<a href="../concepts/cbegin.html" title="">Remote System Explorer Connections</a><br/>
<a href="../concepts/cfilters.html" title="">Remote System Explorer filters, filter
pools, and filter pool references</a><br/>
<a href="../concepts/crunremcmds.html" title="">Shells and commands in the
Remote Systems view</a><br/>
</p>
<p><b class="reltaskshd">Related tasks</b><br/>
<a href="../tasks/tbeginlinux.html" title="">Connecting to a remote
Linux or UNIX server</a><br/>
<a href="../tasks/tbeginwindows.html" title="">Connecting to a remote
Windows server</a><br/>
<a href="../tasks/truncmdsview.html" title="">Running and viewing
commands and shells using the Remote Commands view</a><br/>
</p>
</div>
</body>
</html>

BIN
rse/doc/org.eclipse.rse.doc.user/images/RSESample.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 45 KiB

25
rse/doc/org.eclipse.rse.doc.user/tasks/tbeginlinux.html
View file

@ -28,12 +28,17 @@ when you connect to the server.</p>
Find the package that contains the server.
The server code is usually packaged with the containing product and you should refer to that
product's documentation for finding and installing the server package.
The server is also available, however, on the Eclipse DSDP Target Management download site as the package
rseserver-&lt;version&gt;-&lt;os&gt;.tar. For example, rseserver-1.0-linux.tar contains the release 1.0 server
The server is also available, however, on the Eclipse DSDP
<a href="http://download.eclipse.org/dsdp/tm/downloads/">Target Management download site</a>
as the package <b>rseserver-&lt;version&gt;-&lt;os&gt;.tar</b>. For example, rseserver-1.0-linux.tar contains the release 1.0 server
for Linux. There are servers for Linux, AIX, a generic Unix version that can be tailored to your particular flavor
of Unix, and an experimental Mac OS X version.</li>
<li>Ensure that Perl is installed.</li>
<li>Ensure that a Java Runtime Environment (JRE) version 1.4 or higher is installed.</li>
<li>Ensure that a Java Runtime Environment (JRE) version 1.4 or higher is installed.
An IBM, Sun or equivalent JRE is required; The gcj-based jvm shipped with most Linux
distributions does not work. If in doubt, run the command <br/><tt>java -version</tt> (see
below) and check if there is a reference to gcj. You can download a Sun JRE from
<a href="http://java.sun.com">http://java.sun.com</a>.</li>
<li>Create a directory where you want to install the server code. The remainder
of these instructions will assume the directory /opt/rseserver (suitable for
team sharing), but you are free to use any directory.</li>
@ -83,7 +88,8 @@ perl ./daemon.pl</pre>
Note that the server daemon runs on port 4035. You can also start the
daemon.unix in the same way.<br></br>
<p><b>To start the server manually</b></p>
<div class="p">Run
<div class="p">If you do not have root access on a remote machine, you can
start the server manually for your particular user id only. Run
the following commands:<pre>cd /opt/rseserver
perl ./server.pl [port]</pre>
These commands run the server.pl
@ -97,6 +103,12 @@ to enter this port number in port property for the Files subsystem for your
connection in the Remote System Explorer (see <span class="uicontrol">Connecting to the
Remote Server</span>, below). Otherwise, you do not need to change this
property.</div>
<p><b>Rexec Server Launcher</b></p>
<div class="p">If you have Rexec access enabled to your remote system, you
can also have the server started automatically by an Rexec command from the
client, when you connect. To do so, use the Server Launcher Properties in
the New Connection Wizard.
</div>
<p><b>Running the daemon at startup</b></p>
<div class="p">You might instead want
to configure the daemon to run at start up for Linux. To do so, you need to
@ -104,6 +116,10 @@ append a call to the daemon to your startup script. Add the following lines
to the bottom of the /etc/rc.d/rc.local file:<pre>cd /opt/rseserver
perl ./daemon.pl &amp;</pre>
</div>
<p><b>SSL Encryption</b></p>
<div class="p">By default the RSE Dstore connection is unencrypted. You
can, however, configure it to use SSL encryption.
</div>
</div>
</div><br></br>
<p><b>Connecting to the Remote Server</b></p>
@ -142,6 +158,7 @@ you need to enter it here, for example, to work with a firewall.</div>
<p><b class="reltaskshd">Related tasks</b>
<a href="tbeginwindows.html" title="">Connecting to a remote Windows
server</a>
<!-- TODO SSL configuration -->
</p>
</div>
</body>

5
rse/doc/org.eclipse.rse.doc.user/tasks/tbeginwindows.html
View file

@ -24,8 +24,9 @@ C:\rseserver, but you are free to use any directory you choose.</li>
<li>Find the package that contains the server.
The server code is usually packaged with a containing product and you should refer to that
product's documentation for finding and installing the server package.
The server is also available, however, on the Eclipse DSDP Target Management download site as the package
rseserver-&lt;version&gt;-&lt;os&gt;.zip. For example, rseserver-1.0-windows.zip contains the release 1.0 server
The server is also available, however, on the Eclipse DSDP
<a href="http://download.eclipse.org/dsdp/tm/downloads/">Target Management download site</a>
as the package <b>rseserver-&lt;version&gt;-&lt;os&gt;.zip</b>. For example, rseserver-1.0-windows.zip contains the release 1.0 server
for Windows.</li>
<li>Copy the rseserver.zip to the C:\rseserver directory (this could be on a different machine).</li>
<li>Using an unzip utility to extract the server code to the C:\rseserver directory.</li>

2
rse/doc/org.eclipse.rse.doc.user/tasks/tteamsup1.html
View file

@ -75,7 +75,9 @@ working with active profile artifacts, or remain in the Team view to
</p>
<p><b class="reltaskshd">Related tasks</b><br/>
<a href="tteamsup.html" title="">Using team support</a><br/>
<!-- TODODeferred after RSE 1.0
<a href="tworkuseract.html" title="">Managing user actions (user options)</a><br/>
-->
</p>
</div>
</body>

13
rse/doc/org.eclipse.rse.doc.user/toc.xml
View file

@ -1,8 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="RSE User Guide">
<topic label="Universal Systems" href="concepts/cuniversal.html"/>
<topic label="Getting Started" href="gettingstarted/gstart.html">
<topic label="Installing the Remote System Explorer" href="gettingstarted/g1installing.html"/>
<topic label="First Steps with the Remote System Explorer" href="gettingstarted/g2firststeps.html"/>
<topic label="Using Remote Connections" href="gettingstarted/gusing.html"/>
</topic>
<topic label="Remote System Explorer Connections" href="concepts/cbegin.html">
<topic label="Universal Systems" href="concepts/cuniversal.html"/>
<topic label="Connecting to a remote Linux or UNIX server" href="tasks/tbeginlinux.html"/>
<topic label="Connecting to a remote Windows server" href="tasks/tbeginwindows.html"/>
<topic label="Disconnecting from a remote server" href="tasks/tbegindiscon.html"/>
@ -29,19 +34,25 @@
<topic label="Running and viewing commands and shells using the Remote Commands view" href="tasks/truncmdsview.html"/>
<topic label="Working with command shells" href="tasks/twrkcmdshl.html"/>
</topic>
<!-- TODODeferred after RSE 1.0
<topic label="User actions" href="concepts/cuseractions.html">
<topic label="Managing user actions" href="tasks/tworkuseract.html"/>
<topic label="Editing an existing type" href="tasks/tedittype.html"/>
<topic label="Removing an existing type" href="tasks/tremtype.html"/>
</topic>
-->
<topic label="Search for text and files on remote servers" href="tasks/tmanagesearch.html">
<topic label="Using search parameters with special characters" href="ref/rsearch.html"/>
</topic>
<!-- TODODeferred after RSE 1.0
<topic label="Compiling programs" href="concepts/cremcompile.html"/>
-->
<topic label="Managing archived files" href="tasks/tarchive.html"/>
<!-- TODODeferred after RSE 1.0
<topic label="Importing resources from a remote file system" href="tasks/tremoimp.html" />
<topic label="Exporting resources to a remote file system" href="tasks/tremoexp.html" />
<topic label="Building programs on a remote system" href="tasks/tbuild.html" />
-->
<topic label="Accessing Remote System Explorer preferences" href="ref/rrsepref.html"/>
<topic label="Saving User IDs and passwords" href="tasks/tbeginpass.html"/>
<topic label="Legal" href="notices.html"/>