# HG changeset patch # User Carl Byington # Date 1407165012 25200 # Node ID 7eb24880b111ca7fcd2ed4a630e84d4d581e20dd # Parent 93621e9633035e781bd95a4ee0458ea6db0b80f8 add help files to the web documentation diff -r 93621e963303 -r 7eb24880b111 Makefile --- a/Makefile Sun Aug 03 11:26:03 2014 -0700 +++ b/Makefile Mon Aug 04 08:10:12 2014 -0700 @@ -18,6 +18,7 @@ builder: sed -i -e 's/android:debuggable=".*"/android:debuggable="$(debuggable)"/g' AndroidManifest.xml rm -rf gen bin + (cd help; make) ndk-build clean; V=1 ndk-build android update project -p . -t android-16 ant $(style) @@ -27,6 +28,7 @@ docs: (cd xml; make) + (cd help; make) install: cp $(apk) $(dest) diff -r 93621e963303 -r 7eb24880b111 assets/help/5250Keys.html --- a/assets/help/5250Keys.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,14 +0,0 @@ - - - - -

5250 Keys

- - - - - diff -r 93621e963303 -r 7eb24880b111 assets/help/About.html --- a/assets/help/About.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,110 +0,0 @@ - - - - -

510ConnectBot

- -

Copyright © 2014 Carl Byington -<carl@five-ten-sg.com>

- -

This is an enhanced version of the popular open-source telnet and -secure shell (SSH) client ConnectBot. It now includes tn5250 emulation.

- -

It is licensed under -the GPLv3 or later -license.

- -

The complete source code for this application is available at -http://www.five-ten-sg.com/510Connectbot

- -

Credits

- -

-This software is based on VX Connectbot provided under the Apache -License, Version 2.0. Copyright © 2012 Martin Matuska -http://connectbot.vx.sk -

- -

-Based on Irssiconnectbot provided under the Apache License, Version -2.0. Copyright © 2013 Iiro Uusitalo and Ville Kerminen -https://github.com/irssiconnectbot/irssiconnectbot -

- -

-Based on ConnectBot provided under the Apache License, Version -2.0. Copyright © 2007-2008 Kenny Root -http://the-b.org and Jeffrey Sharkey http://jsharkey.org -

- -

-Based on the Ganymed SSH2 client provided under a BSD-style -license. Copyright © 2005 - 2006 Swiss Federal Institute of -Technology (ETH Zurich), Department of Computer -Science http://www.inf.ethz.ch, -Christian Plattner. Copyright © 2006 - 2013 Christian Plattner. -http://code.google.com/p/ganymed-ssh-2/ -The Java implementations of the AES, Blowfish and 3DES ciphers have been -taken (and slightly modified) from the cryptography package released by -"The Legion Of The Bouncy Castle". -Copyright © 2000 - 2004 The Legion Of The Bouncy Castle -http://www.bouncycastle.org -The following disclaimer applies: -

- -

-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. -

- -

-Based on JTA Telnet/SSH client provided under the GPLv2 license. -Copyright © 1996-2005 Matthias L. Jugel and Marcus -Meiner http://www.javassh.org -

- -

-Based on TN5250J terminal emulator provided under the GPLv2 -license. Copyright © 2001 Kenneth J. Pouncey. -http://tn5250j.sourceforge.net -

- -

-Includes the JSOCKS library, provided under the GNU LGPL -license. http://jsocks.sourceforge.net -

- -

-Includes JZlib provided under a BSD-style license. Copyright © -2000-2004 JCraft, Inc. -http://www.jcraft.com -

- -

-Includes the ssh-agent service developed by Roberto Tyley -https://github.com/rtyley -

- -

-SCP file transfer support is based on -https://github.com/staktrace/connectbot/commits/filetransfer -modifications by Kartikaya Gupta. -

- -

-Internal file selection dialog is based on -http://code.google.com/p/android-file-dialog Android File -Dialog by Alexander Ponomarev, provided under a BSD-style -license. -

- - diff -r 93621e963303 -r 7eb24880b111 assets/help/Hints.html --- a/assets/help/Hints.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,14 +0,0 @@ - - - - -

Helpful hints

- -

When you have multiple sessions open, you can 'pan' between them by swiping your finger left-to-right or right-to-left over the screen.

- -

Long-press on your Android desktop to create direct shortcuts to frequently-used SSH hosts.

- -

Slide your finger up/down on the right-half of the terminal screen to look at the scrollback history. Slide up/down on the left-half to send the page up/down keys.

- - - diff -r 93621e963303 -r 7eb24880b111 assets/help/PhysicalKeyboard.html --- a/assets/help/PhysicalKeyboard.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,111 +0,0 @@ - - - - -

Physical Keyboard

- -

Here are some keyboard shortcuts available when a hardware -keyboard is present. If you're using a phone where the main input -type is a virtual keyboard, please see the VirtualKeyboard help topic. -

-

Note: the side that shift, alt, -slash, and tab uses can be changed in -preferences between left, right, and disabled.

-

Note: to use advanced Sony Ericsson Xperia (mini) pro key mappings you -have to activate the appropriate option in application settings.

- - - - - - - - - - - - - - - diff -r 93621e963303 -r 7eb24880b111 assets/help/ScreenGestures.html --- a/assets/help/ScreenGestures.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ - - - - -

Screen Gestures

- -

Gestures in ConnectBot allow a user to do several things for -which there's no keyboard equivalent. If the gestures seem -backward, then imagine that you're grabbing the text and moving it -with your finger.

- -

Page Up / Page Down

- -

Swiping your finger up and down on the left third of the screen -will send a page up and page down key to the remote host. Many programs -map this to scrolling back into history such as irssi or tinyfugue.

- -

Scroll back / Scroll forward

- -

Swiping your finger up on the right side of the screen allows you -to scroll backward and forward in the local terminal buffer history.

- -

Switching hosts

- -

Swiping your finger from one side of the screen to the other will -switch between currently connected hosts.

- - diff -r 93621e963303 -r 7eb24880b111 assets/help/VirtualKeyboard.html --- a/assets/help/VirtualKeyboard.html Sun Aug 03 11:26:03 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,65 +0,0 @@ - - - - -

Virtual Keyboard

- -

Since ConnectBot doesn't use any of the normal TextView -widgets, Android's IME structure isn't designed to directly -support it.

-

The best way to use Android with a virtual keyboard is in Portrait -mode. By default, ConnectBot is set to use Portrait -mode when no hardware keyboard is present. To change this setting, go to -Preferences from the Host List.

-

In Landscape mode, the Android virtual keyboard -(or other IMEs) will take up the entire screen. Android provides no way -for ConnectBot to resize the terminal view in Landscape. -However, you may use a work-around: Force Resize -to fit above the virtual keyboard if desired.

-

On devices without a hardware keyboard, you may press and hold -the MENU button to bring up the virtual keyboard. NOTE: -This applies to any program on the Android platform; it is not -ConnectBot specific.

- -

How to Enter Control, Alt, Escape, and Function Keys

-

You can enter any key combination with ConnectBot and the virtual -keyboard, but you must know how keys are mapped on a normal console. For -instance, usually combinations of ALT+letter on a PC keyboard are -actually mapped to sending, sequentially, ESC key then the letter.

-

Note there are also screen gestures: see the ScreenGestures help topic. -for Page Up and Page Down.

- - -

On-Screen symbols

-

By touching the bottom line of your screen a pop-up list of - on-screen symbols will appear:

- - -

Examples

- - - - diff -r 93621e963303 -r 7eb24880b111 help/5250Keys.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/5250Keys.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,7 @@ +

5250 Keys

+ + diff -r 93621e963303 -r 7eb24880b111 help/About.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/About.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,104 @@ +

510ConnectBot

+ +

Copyright © 2014 Carl Byington +<carl@five-ten-sg.com>

+ +

This is an enhanced version of the popular open-source telnet and +secure shell (SSH) client ConnectBot. It now includes tn5250 emulation.

+ +

It is licensed under +the GPLv3 or later +license.

+ +

The complete source code for this application is available at +http://www.five-ten-sg.com/510Connectbot

+ +

Credits

+ +

+This software is based on VX Connectbot provided under the Apache +License, Version 2.0. Copyright © 2012 Martin Matuska +http://connectbot.vx.sk +

+ +

+Based on Irssiconnectbot provided under the Apache License, Version +2.0. Copyright © 2013 Iiro Uusitalo and Ville Kerminen +https://github.com/irssiconnectbot/irssiconnectbot +

+ +

+Based on ConnectBot provided under the Apache License, Version +2.0. Copyright © 2007-2008 Kenny Root +http://the-b.org and Jeffrey Sharkey http://jsharkey.org +

+ +

+Based on the Ganymed SSH2 client provided under a BSD-style +license. Copyright © 2005 - 2006 Swiss Federal Institute of +Technology (ETH Zurich), Department of Computer +Science http://www.inf.ethz.ch, +Christian Plattner. Copyright © 2006 - 2013 Christian Plattner. +http://code.google.com/p/ganymed-ssh-2/ +The Java implementations of the AES, Blowfish and 3DES ciphers have been +taken (and slightly modified) from the cryptography package released by +"The Legion Of The Bouncy Castle". +Copyright © 2000 - 2004 The Legion Of The Bouncy Castle +http://www.bouncycastle.org +The following disclaimer applies: +

+ +

+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. +

+ +

+Based on JTA Telnet/SSH client provided under the GPLv2 license. +Copyright © 1996-2005 Matthias L. Jugel and Marcus +Meiner http://www.javassh.org +

+ +

+Based on TN5250J terminal emulator provided under the GPLv2 +license. Copyright © 2001 Kenneth J. Pouncey. +http://tn5250j.sourceforge.net +

+ +

+Includes the JSOCKS library, provided under the GNU LGPL +license. http://jsocks.sourceforge.net +

+ +

+Includes JZlib provided under a BSD-style license. Copyright © +2000-2004 JCraft, Inc. +http://www.jcraft.com +

+ +

+Includes the ssh-agent service developed by Roberto Tyley +https://github.com/rtyley +

+ +

+SCP file transfer support is based on +https://github.com/staktrace/connectbot/commits/filetransfer +modifications by Kartikaya Gupta. +

+ +

+Internal file selection dialog is based on +http://code.google.com/p/android-file-dialog Android File +Dialog by Alexander Ponomarev, provided under a BSD-style +license. +

diff -r 93621e963303 -r 7eb24880b111 help/Hints.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/Hints.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,7 @@ +

Helpful hints

+ +

When you have multiple sessions open, you can 'pan' between them by swiping your finger left-to-right or right-to-left over the screen.

+ +

Long-press on your Android desktop to create direct shortcuts to frequently-used SSH hosts.

+ +

Slide your finger up/down on the right-half of the terminal screen to look at the scrollback history. Slide up/down on the left-half to send the page up/down keys.

diff -r 93621e963303 -r 7eb24880b111 help/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/Makefile Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,11 @@ +a:=../assets/help +b:=../html + +all: + [ -d $(a) ] || mkdir -p $(a) + [ -d $(b) ] || mkdir -p $(b) + for i in *.html.in; do \ + f=$$(basename $$i .in); \ + cat header.android $$i footer >$(a)/$$f; \ + cat header.browser $$i footer >$(b)/$$f; \ + done diff -r 93621e963303 -r 7eb24880b111 help/PhysicalKeyboard.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/PhysicalKeyboard.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,104 @@ +

Physical Keyboard

+ +

Here are some keyboard shortcuts available when a hardware +keyboard is present. If you're using a phone where the main input +type is a virtual keyboard, please see the VirtualKeyboard help topic. +

+

Note: the side that shift, alt, +slash, and tab uses can be changed in +preferences between left, right, and disabled.

+

Note: to use advanced Sony Ericsson Xperia (mini) pro key mappings you +have to activate the appropriate option in application settings.

+ + + + + + + + + + + + diff -r 93621e963303 -r 7eb24880b111 help/ScreenGestures.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/ScreenGestures.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,23 @@ +

Screen Gestures

+ +

Gestures in ConnectBot allow a user to do several things for +which there's no keyboard equivalent. If the gestures seem +backward, then imagine that you're grabbing the text and moving it +with your finger.

+ +

Page Up / Page Down

+ +

Swiping your finger up and down on the left third of the screen +will send a page up and page down key to the remote host. Many programs +map this to scrolling back into history such as irssi or tinyfugue.

+ +

Scroll back / Scroll forward

+ +

Swiping your finger up on the right side of the screen allows you +to scroll backward and forward in the local terminal buffer history.

+ +

Switching hosts

+ +

Swiping your finger from one side of the screen to the other will +switch between currently connected hosts.

+ diff -r 93621e963303 -r 7eb24880b111 help/VirtualKeyboard.html.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/VirtualKeyboard.html.in Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,58 @@ +

Virtual Keyboard

+ +

Since ConnectBot doesn't use any of the normal TextView +widgets, Android's IME structure isn't designed to directly +support it.

+

The best way to use Android with a virtual keyboard is in Portrait +mode. By default, ConnectBot is set to use Portrait +mode when no hardware keyboard is present. To change this setting, go to +Preferences from the Host List.

+

In Landscape mode, the Android virtual keyboard +(or other IMEs) will take up the entire screen. Android provides no way +for ConnectBot to resize the terminal view in Landscape. +However, you may use a work-around: Force Resize +to fit above the virtual keyboard if desired.

+

On devices without a hardware keyboard, you may press and hold +the MENU button to bring up the virtual keyboard. NOTE: +This applies to any program on the Android platform; it is not +ConnectBot specific.

+ +

How to Enter Control, Alt, Escape, and Function Keys

+

You can enter any key combination with ConnectBot and the virtual +keyboard, but you must know how keys are mapped on a normal console. For +instance, usually combinations of ALT+letter on a PC keyboard are +actually mapped to sending, sequentially, ESC key then the letter.

+

Note there are also screen gestures: see the ScreenGestures help topic. +for Page Up and Page Down.

+ + +

On-Screen symbols

+

By touching the bottom line of your screen a pop-up list of + on-screen symbols will appear:

+ + +

Examples

+ diff -r 93621e963303 -r 7eb24880b111 help/footer --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/footer Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,2 @@ + + diff -r 93621e963303 -r 7eb24880b111 help/header.android --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/header.android Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,93 @@ + + + + + 510 ConnectBot + + + diff -r 93621e963303 -r 7eb24880b111 help/header.browser --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/help/header.browser Mon Aug 04 08:10:12 2014 -0700 @@ -0,0 +1,93 @@ + + + + + 510 ConnectBot + + + diff -r 93621e963303 -r 7eb24880b111 html/null.file diff -r 93621e963303 -r 7eb24880b111 xml/Makefile --- a/xml/Makefile Sun Aug 03 11:26:03 2014 -0700 +++ b/xml/Makefile Mon Aug 04 08:10:12 2014 -0700 @@ -1,12 +1,14 @@ ver:=$(shell grep versionName ../AndroidManifest.xml | cut -d'"' -f2) pkg:=510Connectbot +t:=../html all: sed -e 's/@PACKAGE@/$(pkg)/g' -e 's/@VERSION@/$(ver)/g' <510connectbot.in >510connectbot cat header.xml 510connectbot >510connectbot.xml cat header.sgml 510connectbot >510connectbot.sgml - rm -f ../html/*html - rm -f ../html/*pdf - xmlto -o ../html xhtml 510connectbot.xml - xmlto -o ../html pdf 510connectbot.xml + [ -d $(t) ] || mkdir $(t) + rm -f $(t)/*html + rm -f $(t)/*pdf + xmlto -o $(t) xhtml 510connectbot.xml + xmlto -o $(t) pdf 510connectbot.xml rm -f 510connectbot.xml 510connectbot.sgml