mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 18:56:02 +02:00
Code Issues Wiki Activity

[168186] Add Terminal User Docs

Browse source
This commit is contained in:
Martin Oberhuber 2008-05-07 14:48:03 +00:00
parent c6048ad0dd
commit e07b69d8be
13 changed files with 388 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
org.eclipse.tm.terminal.view/HelpContexts.xml Normal file
View file

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.contexts"?>
<!--
Copyright (c) 2008 Wind River Systems, Inc.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<contexts>
<context id="terminal_page">
<description>The Terminal View supports direct connections to target boards via serial or network connections.
</description>
<topic label="Terminal View" href="doc/html/01_terminalview.html" />
<topic label="Terminal Emulation" href="doc/html/04_terminal_emulation.html" />
</context>
<context id="terminal_settings">
<description>The Terminal Settings Dialog provides the controls for making terminal connections.
</description>
<topic label="Terminal Settings Dialog" href="doc/html/03_terminal_settings.html#terminal_settings"/>
<topic label="Terminal View Quick Reference" href="doc/html/02_terminal_page.html#terminal_page"/>
</context>
</contexts>

12
org.eclipse.tm.terminal.view/build.properties
View file

@ -1,5 +1,5 @@
################################################################################
# Copyright (c) 2003, 2006 Wind River Systems, Inc. and others.
# Copyright (c) 2003, 2008 Wind River Systems, Inc. and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@ -21,6 +21,12 @@ bin.includes = META-INF/,\
plugin.xml,\
icons/,\
plugin.properties,\
about.html,about.ini,about.mappings,about.properties,\
eclipse32.png
about.html,\
about.ini,\
about.mappings,\
about.properties,\
eclipse32.png,\
HelpContexts.xml,\
doc/,\
toc.xml
src.includes = about.html

1
org.eclipse.tm.terminal.view/doc/book.css Normal file
View file

@ -0,0 +1 @@
@import "../../PRODUCT_PLUGIN/book.css";

44
org.eclipse.tm.terminal.view/doc/html/01_terminalview.html Normal file
View file

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="copyright" content="Copyright (c) 2004, 2008 Wind River Systems, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." />
<link rel="stylesheet" type="text/css" href="../book.css" />
<title>Terminal View</title>
</head>
<!--
Copyright (c) 2004, 2008 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<body id="terminalview"><a name="terminalview"><!-- --></a>
<h1 class="topictitle1">Terminal View</h1>
<div class="p">
<p>
The <b>Terminal</b> view provides a raw serial or network connection to your target board.
This view is useful for monitoring output on a target's serial port or making a telnet
connection to a device.
</p></div>
<ul>
<li><a href="02_terminal_page.html">Terminal View Quick Reference</a></li>
<li><a href="03_terminal_settings.html">Terminal Settings Dialog</a></li>
<li><a href="04_terminal_emulation.html">Terminal Emulation</a></li>
<li><a href="notice.html">Legal Notice</a></li>
</ul>
Multiple <b>Terminal</b> view instances can be active at the same time, connected
to a number of remote systems or disconnected and just holding their settings
ready for re-connect.
<p></p>
<div class="p">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <a href="02_terminal_page.html">Next &gt;</a></div>
</body>
</html>

67
org.eclipse.tm.terminal.view/doc/html/02_terminal_page.html Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="copyright" content="Copyright (c) 2004, 2008 Wind River Systems, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." />
<link rel="stylesheet" type="text/css" href="../book.css" />
<title>Terminal View Quick Reference</title>
</head>
<!--
Copyright (c) 2004, 2008 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<body><a name="terminal_page"><!-- --></a>
<h2 class="topictitle2">Terminal View Quick Reference</h2>
<div align="left">
<table border="0" cellspacing="6">
<caption></caption>
<tr align="left" valign="top">
<td><p><b>Button</b></p></td>
<td><p><b>Description</b></p></td>
</tr>
<tr align="left" valign="top">
<td><p><img src="../../icons/clcl16/newterminal.gif" border="0" hspace="0" vspace="0"/></p></td>
<td><p>Open another instance of the <b>Terminal</b> view.</p></td>
</tr>
<tr align="left" valign="top">
<td><p><img src="../../icons/clcl16/connect_co.gif" border="0" hspace="0" vspace="0"/></p></td>
<td><p>Connect to selected port.</p></td>
</tr>
<tr align="left" valign="top">
<td><p><img src="../../icons/clcl16/disconnect_co.gif" border="0" hspace="0" vspace="0"/></p></td>
<td><p>Disconnect from selected port.</p></td>
</tr>
<tr align="left" valign="top">
<td><p><img src="../../icons/clcl16/properties_tsk.gif" border="0" hspace="0" vspace="0"/></p></td>
<td><p>Open the <a href="03_terminal_settings.html"><b>Terminal Settings</b></a> dialog.
Only available when disconnected.</p></td>
</tr>
<tr align="left" valign="top">
<td><p><img src="../../icons/clcl16/command_input_field.gif" border="0" hspace="0" vspace="0"/></p></td>
<td><p>Toggle the <a href="04_terminal_emulation.html"><b>Command Input</b></a> field,
for editing complex command lines on dumb terminals.</p></td>
</tr>
</table>
</div>
<p>
</p>
<table class="steptable"><tr><td>
Each instance of the <b>Terminal</b> view can be connected to a different remote endpoint
(either serial or network). Of course, the number of serial connections is limited by the
number of serial ports.
</td></tr></table>
<p></p>
<div class="p"><a href="01_terminalview.html">&lt; Prev</a> | <a href="03_terminal_settings.html">Next &gt;</a></div>
</body>
</html>

101
org.eclipse.tm.terminal.view/doc/html/03_terminal_settings.html Normal file
View file

@ -0,0 +1,101 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="copyright" content="Copyright (c) 2004, 2008 Wind River Systems, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." />
<link rel="stylesheet" type="text/css" href="../book.css" />
<title>Terminal Settings Dialog</title>
</head>
<!--
Copyright (c) 2004, 2008 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<body><a name="terminal_settings"><!-- --></a>
<h2 class="topictitle2">Terminal Settings Dialog</h2>
<table class="steptable"><tr><td class="S_step_text">
Use the <b>Terminal Settings</b> dialog to configure your connection.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
In the <b>Connection Type</b> field choose <b>Serial</b>, <b>SSH</b> or <b>Telnet</b>.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
The <b>View Title</b> field allows giving a name to your <b>Terminal</b> View instance.
</td></tr></table>
<h4>Serial Connection</h4>
<table class="steptable"><tr><td class="S_step_text">
If you choose a serial connection, the <b>Settings</b> area has seven options:
<b>Port</b>, <b>Baud Rate</b>, <b>Data Bits</b>, <b>Stop Bits</b>, <b>Parity</b>, <b>Flow Control</b>,
and <b>Timeout</b>.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
When you have entered your settings, click <b>OK</b>. This initiates your connection.</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
Your connection information appears in the header of the <b>Terminal</b> view.
A cursor appears in the view itself. Hit <b>ENTER</b> to get a <b>&gt;NET&gt;</b>
prompt.</td></tr></table>
<p></p>
<div align="left">
<table class="N1_note" border="0" cellpadding="0" cellspacing="6">
<caption></caption>
<tr align="left" valign="top"><td></td><td class="N1_note_content">
<p><b>NOTE:</b>When using the <b>Terminal</b> view on Linux or Solaris,
serial ports <b>ttyS0</b> and <b>ttyS1</b> must have appropriate permissions
set in order to connect to them, unless you are running the Workbench as root.
</p></td></tr>
<tr align="left" valign="top"><td>&#160;</td><td>&#160;</td>
</tr>
</table>
</div>
<p></p>
<h4>SSH Connection</h4>
<table class="steptable"><tr><td class="S_step_text">
If you choose an SSH connection, the <b>Settings</b> area has six options.
In the <b>Host</b> and <b>Port</b> fields, enter the IP Address and port of the host
you wish to connect to.
The <b>User</b> field specifies the remote user id to use.
The <b>Password</b> field is optional, since SSH can re-use your private keys
as specified on the Eclipse Preferences, General, Network Page.
The <b>Timeout</b> can be changed for very slow networks. The
<b>KeepAlive</b> value specifies an interval in seconds, by which the Terminal
automatically sends a packet to the remote host in order to keep the connection
alive even in case of inactivity.
<p>When all settings are specified, click
<b>OK</b>. This initiates your connection.</td></tr></table>
<p></p>
<h4>Telnet Connection</h4>
<table class="steptable"><tr><td class="S_step_text">
If you choose a Telnet connection, the <b>Settings</b> area has three options.
In the <b>Host</b> field, enter the IP Address of the host you wish to connect to.
In the <b>Port</b> field, select the network port you wish to use.
The <b>Timeout</b> can be changed for very slow networks. Then click
<b>OK</b>. This initiates your connection.</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
Your connection information appears in the header of the <b>Terminal</b> view.
A cursor appears in the view itself. Hit <b>ENTER</b> to get a <b>&gt;NET&gt; </b>prompt.
</td></tr></table>
<p></p>
<div class="p"><a href="02_terminal_page.html">&lt; Prev</a> | <a href="04_terminal_emulation.html">Next &gt;</a></div>
</body>
</html>

64
org.eclipse.tm.terminal.view/doc/html/04_terminal_emulation.html Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="copyright" content="Copyright (c) 2004, 2008 Wind River Systems, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." />
<link rel="stylesheet" type="text/css" href="../book.css" />
<title>Terminal Emulation</title>
</head>
<!--
Copyright (c) 2004, 2008 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<body><a name="terminal_emulation"><!-- --></a>
<h2 class="topictitle2">Terminal Emulation</h2>
<table class="steptable"><tr><td class="S_step_text">
The <b>Terminal</b> view is an ANSI-conformant terminal emulator. You can use the
<b>Terminal</b> view to telnet into a remote UNIX host.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
To do so, set the <b>TERM</b> environment variable on the remote host to <b>ansi</b>.
This enables programs on the remote host, such as <b>vi</b> and <b>Emacs</b>,
to display text properly.
The <b>Terminal</b> view does not currently support other emulation modes, such as VT100.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
The <b>size</b> of the terminal window as understood by the remote is automatically
adjusted as the size of your <b>Terminal</b> view changes.
The <b>colors</b> and <b>font</b> used by the Terminal can be configured in the
Eclipse Preferences, Appearance section. A separate <b>Terminal</b> Preference
Page allows inverting the terminal colors easily if desired.
</td></tr></table>
<h4>Optional Command Input Field</h4>
<table class="steptable"><tr><td class="S_step_text">
The optional <b>Command Input Field</b> can be enabled when sending commands to a dumb
terminal that does not support cursor keys for editing. In such a case, the <b>
Command Input Field</b> provides a full editor that supports cursor navigation, copy
and paste, as well as a history of previous commands that can be accessed by
<b>Ctrl+Space</b> content assist.
</td></tr></table>
<table class="steptable"><tr><td class="S_step_text">
If more space than the default single editing line is needed for very complex commands,
the <b>Command Input Field</b> can be enlarged by dragging its upper handle up with
the mouse.
</td></tr></table>
<p></p>
<div class="p"><a href="03_terminal_settings.html">&lt; Prev</a> | </div>
</body>
</html>

30
org.eclipse.tm.terminal.view/doc/html/notice.html Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="copyright" content="Copyright (c) 2004, 2008 Wind River Systems, Inc. and others. This page is made available under license. For full details see the LEGAL notice in the documentation book that contains this page." />
<link rel="stylesheet" type="text/css" href="../book.css" />
<title>Legal Notice</title>
</head>
<!--
Copyright (c) 2004, 2008 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<body><a name="terminal_legal"><!-- --></a>
<h2 class="topictitle2">Legal Notice</h2>
<p>
The material in this guide is Copyright (c) Wind River Systems, Inc. and others 2004, 2008.
</p>
<p>
<a href="../../about.html">Terms and conditions regarding the use of this guide.</a>
</p>
</body>
</html>

13
org.eclipse.tm.terminal.view/plugin.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.0"?>
<!--
# Copyright (c) 2003, 2007 Wind River Systems, Inc. and others.
# Copyright (c) 2003, 2008 Wind River Systems, Inc. and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@ -77,4 +77,15 @@
point="org.eclipse.core.runtime.preferences">
<initializer class="org.eclipse.tm.internal.terminal.view.TerminalPreferenceInitializer"/>
</extension>
<!-- ============================================ -->
<!-- Define Help Context -->
<!-- ============================================ -->
<extension point="org.eclipse.help.contexts">
<contexts file="HelpContexts.xml"/>
</extension>
<extension point="org.eclipse.help.toc">
<toc file="toc.xml"/>
</extension>
</plugin>

4
org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java
View file

@ -14,6 +14,7 @@
* Michael Scharf (Wind River) - split into core, view and connector plugins
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified
* Martin Oberhuber (Wind River) - [168197] Replace JFace MessagDialog by SWT MessageBox
* Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs
*******************************************************************************/
package org.eclipse.tm.internal.terminal.view;
@ -43,6 +44,7 @@ import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
import org.eclipse.ui.PlatformUI;
class TerminalSettingsDlg extends Dialog {
private Combo fCtlConnTypeCombo;
@ -163,6 +165,8 @@ class TerminalSettingsDlg extends Dialog {
}
protected Control createDialogArea(Composite parent) {
Composite ctlComposite = (Composite) super.createDialogArea(parent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(ctlComposite, TerminalViewPlugin.HELPPREFIX + "terminal_settings"); //$NON-NLS-1$
setupPanel(ctlComposite);
setupListeners();
initFields();

7
org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalView.java
View file

@ -18,6 +18,7 @@
* Michael Scharf (Wind River) - [189774] Ctrl+V does not work in the command input field.
* Michael Scharf (Wind River) - [217999] Duplicate context menu entries in Terminal
* Anna Dushistova (MontaVista) - [227537] moved actions from terminal.view to terminal plugin
* Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs
*******************************************************************************/
package org.eclipse.tm.internal.terminal.view;
@ -65,6 +66,7 @@ import org.eclipse.ui.IViewReference;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.ViewPart;
public class TerminalView extends ViewPart implements ITerminalView, ITerminalListener {
@ -192,7 +194,7 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi
// The second argument to showView() is a unique String identifying the
// secondary view instance. If it ever matches a previously used secondary
// view identifier, then this call will not create a new Terminal view,
// which is undesireable. Therefore, we append the current time in
// which is undesirable. Therefore, we append the current time in
// milliseconds to the secondary view identifier to ensure it is always
// unique. This code runs only when the user clicks the New Terminal
// button, so there is no risk that this code will run twice in a single
@ -367,6 +369,8 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi
setupContextMenus();
setupListeners(wndParent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(wndParent, TerminalViewPlugin.HELPPREFIX + "terminal_page"); //$NON-NLS-1$
onTerminalStatus();
onTerminalFontChanged();
}
@ -392,6 +396,7 @@ public class TerminalView extends ViewPart implements ITerminalView, ITerminalLi
protected void setupControls(Composite wndParent) {
ITerminalConnector[] connectors = makeConnectors();
fCtlTerminal = TerminalViewControlFactory.makeControl(this, wndParent, connectors);
String connectionType=fStore.get(STORE_CONNECTION_TYPE);
for (int i = 0; i < connectors.length; i++) {
connectors[i].load(getStore(connectors[i]));

3
org.eclipse.tm.terminal.view/src/org/eclipse/tm/internal/terminal/view/TerminalViewPlugin.java
View file

@ -14,6 +14,7 @@
* Michael Scharf (Wind River) - split into core, view and connector plugins
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified
* Anna Dushistova (MontaVista) - [227537] moved actions from terminal.view to terminal plugin
* Martin Oberhuber (Wind River) - [168186] Add Terminal User Docs
*******************************************************************************/
package org.eclipse.tm.internal.terminal.view;
@ -31,6 +32,8 @@ import org.eclipse.ui.plugin.AbstractUIPlugin;
public class TerminalViewPlugin extends AbstractUIPlugin {
protected static TerminalViewPlugin fDefault;
public static final String HELPPREFIX = "org.eclipse.tm.terminal.view."; //$NON-NLS-1$
/**
* The constructor.
*/

21
org.eclipse.tm.terminal.view/toc.xml Normal file
View file

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<!--
Copyright (c) 2006, 2008 Wind River Systems, Inc.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
Contributors:
Martin Oberhuber (Wind River) - initial API and implementation
-->
<toc link_to="../org.eclipse.rse.doc.user/toc.xml#rse_user_extensions"
label="Terminal View">
<topic label="Terminal View" href="doc/html/01_terminalview.html">
<topic label="Terminal View Quick Reference" href="doc/html/02_terminal_page.html" />
<topic label="Terminal Settings Page" href="doc/html/03_terminal_settings.html" />
<topic label="Terminal Emulation" href="doc/html/04_terminal_emulation.html" />
<topic label="Legal Notice" href="doc/html/notice.html" />
</topic>
</toc>