Updating documentation
authorTom Sutcliffe <thomas.sutcliffe@accenture.com>
Tue, 24 Aug 2010 11:54:30 +0100
changeset 34 284c68d7a3ac
parent 33 cfabd0207208
child 35 f8e05215af4a
Updating documentation
documentation/change_history.pod
documentation/getting_started.pod
documentation/pod-list.txt
plugins/consoles/docs/consoles.pod
plugins/consoles/terminalkeyboardcons/terminalkeyboardcons.pod
plugins/consoles/vt100cons/doc/vt100cons.pod
--- a/documentation/change_history.pod	Mon Aug 23 18:10:31 2010 +0100
+++ b/documentation/change_history.pod	Tue Aug 24 11:54:30 2010 +0100
@@ -14,12 +14,16 @@
 
 =head1 FShell Change History
 
-=head2 Release 000.4
+=head2 Release 001 [Not yet officially made]
 
 =over 5
 
 =item *
 
+Added L<terminal keyboard|terminalkeyboardcons> console, for platforms that support Terminal Keyboard and Trace Core.
+
+=item *
+
 Fixed a defect in iosrv.exe that caused a panic if a foreground read object was attached to a different end point. This was due to the read object being notified of a change in foreground before its iEndPoint member was updated. This member is now updated before attempting the attach, and is set to NULL in the event of a leave (resulting in the read object being left in an unattached state).
 
 =item *
@@ -28,11 +32,7 @@
 
 =item *
 
-Added C<--codesegs> option to C<ps>.
-
-=head2 Release 000.2, 000.3
-
-Build fixes.
+Added C<--codesegs> option to L<ps|commands::ps>.
 
 =head2 Release 000.1
 
--- a/documentation/getting_started.pod	Mon Aug 23 18:10:31 2010 +0100
+++ b/documentation/getting_started.pod	Tue Aug 24 11:54:30 2010 +0100
@@ -16,6 +16,8 @@
 
 =head1 Getting started with FShell
 
+B< I<Note:> > This guide is in the process of being migrated to the wiki, here: http://developer.symbian.org/wiki/index.php/Fshell/Getting_Started
+
 =head1 Retreiving the FShell Source Code
 
 fshell is hosted on the Symbian Foundation here: http://developer.symbian.org/main/source/packages/fshell
--- a/documentation/pod-list.txt	Mon Aug 23 18:10:31 2010 +0100
+++ b/documentation/pod-list.txt	Tue Aug 24 11:54:30 2010 +0100
@@ -25,6 +25,7 @@
 pod ..\plugins\consoles\rcons\documentation\rcons.exe.pod          fshell\plugins\consoles\rcons.exe.html
 pod ..\plugins\consoles\rcons\documentation\rcons.pod              fshell\plugins\consoles\rcons.html
 pod ..\plugins\consoles\vt100cons\doc\vt100cons.pod                fshell\plugins\consoles\vt100cons.html
+pod ..\plugins\consoles\terminalkeyboardcons\terminalkeyboardcons.pod fshell\plugins\consoles\terminalkeyboardcons.html
 
 index fshell\plugins\networking
 pod ..\plugins\networking\tcpcsy\doc\tcpcsy.pod                    fshell\plugins\networking\tcpcsy.html
--- a/plugins/consoles/docs/consoles.pod	Mon Aug 23 18:10:31 2010 +0100
+++ b/plugins/consoles/docs/consoles.pod	Tue Aug 24 11:54:30 2010 +0100
@@ -164,7 +164,7 @@
 
 This is the console of choice for running on a handset with a full graphical ROM, if remote connectivity is not available.
 
-=head3 L<vt100cons.dll|vt100cons>
+=head3 L<vt100cons|vt100cons>
 
 A console implementation that will communicate with a VT100 compatible terminal (or terminal emulator such as HyperTerminal) via a serial connection. There are variants that work over TCP connnections (F<vt100tcpcons.dll>), Bluetooth (F<vt100btcons.dll>) and USB (F<vt100usbcons.dll>).
 
@@ -202,7 +202,37 @@
 
 This is the remote console of choice when running on target (i.e. non-emulated) hardware.
 
-=head3 L<rcons.dll|rcons>
+=head3 L<terminalkeyboardcons|terminalkeyboardcons>
+
+On platforms that support the Terminal Keyboard and Trace Core, this console allows the Carbide Terminal Keyboard plugin to be used directly with fshell, even in gui environments when the normal eshell terminalkeyboard plugin won't work.
+
+Pros:
+
+=over 5
+
+=item *
+
+Works over whatever transport that TraceCore can use (so will work over XTI even when no physical serial ports are available).
+
+=item *
+
+Works in GUI (DFS) builds - unlike the standard eshell plugin.
+
+=back
+
+Cons:
+
+=item *
+
+Requires Carbide and the Carbide Terminal Keyboard plugin to be installed.
+
+=item *
+
+Limited by what the Carbide Terminal Keyboard plugin allows - so no ymodem support.
+
+=back
+
+=head3 L<rcons|rcons>
 
 A console implementation that connects via TCP to a Win32 executable (called L<rcons.exe|rcons.exe>) that hosts console windows remotely.
 
@@ -240,7 +270,7 @@
 
 This console has been largely superceded by L<vt100cons|vt100cons> (or one of its variants) for target use. However, it is still useful on the emulator because a) it is easy to get up an running, and b) new windows automatically appear (rather than needing to explicitly connect a terminal emulator).
 
-=head3 win32cons.dll
+=head3 win32cons
 
 A specialized console for running the WINSCW emulator directly in a DOS box. A batch file F<\epoc32\tools\fshell.bat> is provided for convenience.
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/plugins/consoles/terminalkeyboardcons/terminalkeyboardcons.pod	Tue Aug 24 11:54:30 2010 +0100
@@ -0,0 +1,69 @@
+# terminalkeyboardcons.pod
+#
+# Copyright (c) 2010 Accenture. All rights reserved.
+# This component 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 the URL "http://www.eclipse.org/legal/epl-v10.html".
+#
+# Initial Contributors:
+# Accenture - Initial contribution
+#
+
+__END__
+
+=head1 terminalkeyboardcons
+
+=head2 Introduction
+
+On platforms that support the Terminal Keyboard and Trace Core, this console allows the Carbide Terminal Keyboard plugin to be used directly with fshell via the tracecore connection, even in gui environments when the normal eshell terminalkeyboard plugin won't work. See the L<main consoles page|consoles> for a comparison of the various consoles.
+
+=head2 Usage
+
+There are no major configuration options to use terminalkeyboardcons. If it is supported on your platform, you just need to launch:
+
+    fshell --console terminalkeyboardcons
+
+And start the Carbide Terminal Keyboard plugin. Assuming tracing is set up correctly fshell should sucessfully piggyback the tracecore connection. You shouldn't specify any of the terminalkeyboard rombuild macros, they may interfere with fshell's implementation.
+
+You can specify the size of the terminal keyboard window using the C<--console-size> option (the default size is 80x24). There is a debug option which prints additional logging, although this won't be of interest to anyone except the fshell maintainers.
+
+    fshell --console terminalkeyboardcons [--console-size WIDTH,HEIGHT] [--console-title debug]
+
+=head2 Custom escape sequences
+
+The Carbide Terminal Keyboard (at the time of writing) does not pass through certain keypresses such as control keys, which limits the usefulness of the shell. Therefore this console supports a set of custom escape sequences using the backtick C<`> key as a modifier. The sequence C<backtick-space> means press and release the backtick key, then press and release the space bar.
+
+=over 5
+
+=item C<backtick-backtick>
+
+The escape key.
+
+=item C<backtick-1>
+
+Tab.
+
+=item C<backtick-uparrow>
+
+Up arrow (normally pressing the up cursor key just sends a numeric '2' to fshell, so technically this sequence is C<backtick-2>.)
+
+=item C<backtick-downarrow>, C<backtick-leftarrow>, C<backtick-rightarrow>
+
+Down, left, right.
+
+=item C<backtick-space>
+
+The literal backtick character C<`>.
+
+=item C<backtick-a> through C<backtick-z>
+
+The control keys CTRL-A through CTRL-Z.
+
+=back
+
+=head1 Copyright
+
+Copyright (c) 2008-2010 Accenture. All rights reserved.
+
+=cut
--- a/plugins/consoles/vt100cons/doc/vt100cons.pod	Mon Aug 23 18:10:31 2010 +0100
+++ b/plugins/consoles/vt100cons/doc/vt100cons.pod	Tue Aug 24 11:54:30 2010 +0100
@@ -16,7 +16,7 @@
 
 =head2 Introduction
 
-A Symbian console implementation (sub-class of C<CConsoleBase>) for communicating with a VT100 terminal (or, more likely, a terminal emulator such as the Windows HyperTerminal program) over a C32 hosted serial connection. This console makes it possible to run console based tools on any handset that can be connected to via a serial connection.
+A Symbian console implementation (sub-class of C<CConsoleBase>) for communicating with a VT100 terminal (or, more likely, a terminal emulator such as the Windows HyperTerminal program) over a C32 hosted serial connection. This console makes it possible to run console based tools on any handset that can be connected to via a serial connection. See the L<main consoles page|consoles> for a comparison of the various consoles.
 
 Note, the console provides no mechanism for remote clients to automatically connect and launch console tools. The launching of the required console tool must be initiated on the handset, causing F<vt100cons.dll> to be loaded. It will then attempt to establish a serial connection to the terminal that is expected to be listening on the other end of the connection.