Ajiiannotatelabsblogpresssupportabout
 Reference
TouchTerm Pro Reference
ref_optionsref_eventsref_actionsfullindex

Profile Options:
Terminal | Display | Gesture | Selection | Text Completion | SSH Protocol | Misc. | Advanced

Global Options:
General | Security | Gesture Engine

Terminal

  • Translucent Keyboard
    • When this option is turned On, the standard Keyboard becomes translucent, and TouchTerm displays the Terminal output behind the Keyboard, allowing the full device screen to be used for displaying text. Note that the degree of transparency of the keyboard is controlled by the 'Interface Transparency' Option.
  • Interface Transparency
    • This Option controls the degree of transparency of all buttons and Keypads that are overlaid above the Terminal display: this includes the Settings, Help, and Close buttons, as well as all Keypads. If the 'Translucent Keyboard' Option is enabled, then this Option also controls the degree of transparency of the Keyboard.
      Raising this value (sliding the dot to the right) causes the interface to become more transparent (see through), and lowering it causes it to become less transparent (more opaque).
  • Allow Scrollback
    • When this option is turned On, TouchTerm includes the entire contents of the session history in the Terminal display, and you can scroll back to view the results of previous output. This is usually the preferred setting when working at a shell prompt.
      When this option is turned Off, TouchTerm restricts the Terminal display to the standard 80x24 size. This is usually preferred when using screen-based programs such as emacs or vi.
  • Auto-Scroll To Cursor
    • When this option is turned On, TouchTerm will automatically scroll the Terminal display to ensure that the cursor is always visible.
      Note that this option only has an effect when the Keyboard is visible; when the Keyboard is hidden, TouchTerm will never automatically scroll the Terminal display.
  • Text Encoding
    • Use this Option to select the Text Encoding used by the remote host. Most major character encodings are supported (please let us know if you need any others!). When TouchTerm encounters an invalidly coded character, it will display a '?' in the Terminal output.
      Note that you may have to set the locale or appropriate environment variables in the remote shell in order for the shell's encoding to match TouchTerm's.
      Also note that changes in this Option will not take effect until a new Terminal session is initiated.
  • Sticky Keyboard
    • By default, when this Option is turned Off, the keyboard behaves in the same way as normal iPhone usage. When this Option is On, the keyboard is 'sticky', when using the Shift key, or when using special characters -- in other words, it retains its state without changing back after a single keypress.
  • Audible BEL
    • Use this Option to control whether or not a sound effect is played when a BEL character is received from the remote host.

Display

  • Font Size
    • Use this Option to control the Font Size of the text in the Terminal display.
  • Font Face
    • Select the font to be used for text in the Terminal view. Note that not all fonts support the full Unicode character set, so alternate fonts may be used when necessary.
  • Foreground Color
    • Use this Option to select the foreground (text) color in the Terminal display.
  • Background Color
    • Use this Option to select the background color in the Terminal display.
  • Cursor Color
    • Use this Option to select the cursor color.

Gesture

  • Lock Scrolling
    • Use this Option to lock the position of the Terminal display, and to cause all touch gestures to be handled by the Gesture Engine (and therefore recognized as Taps, Swipes, etc).
      When this Option is turned Off, swipe gestures are used to control the scroll position of the Terminal display.
      Note that when this Option is turned On, and scrolling is locked, it's still possible to use Actions to control the scroll position of the Terminal display; for example, when using the default Event Mappings, use a Swipe-and-Tap gesture to scroll the display to the top, bottom, left, or right edges of the screen.
  • Gesture Feedback
    • When this Option is turned On, TouchTerm provides graphical feedback whenever a gesture that is mapped to an Action is successfully recognized. Turn this Option Off in order to disable this graphical feedback.
  • Gesture Report Mode
    • Use this Option to have TouchTerm always display feedback based on the most specific Gesture recognized by the Gesture Engine. This is useful when acclimating to the TouchTerm Gestures, and also when adjusting the Gesture Engine parameters.
      Note that when this Option is turned On, only the first Gesture to be recognized will be fired: even if it does not have any Actions bound to it, and even if Gestures that would otherwise have fired have Actions bound to them. For example, if there is an Action bound to a single Tap, but no Action bound to a Double-Tap, and a Double-Tap is performed, then the Tap Action will be ignored, even though the Double-Tap gesture had no Action configured.
      Note that the 'Gesture Feedback' Option must be On in order to see the feedback graphics used in this mode.

Selection

  • Select Across Lines
    • Use this Option to control the scope of the selected text when performing a multi-line Copy operation. When this Option is turned On, all text from the Start Marker to the End Marker is selected, by moving rightwards from the Start Marker and line-wrapping for each subsequent line until reaching the End Marker (i.e., getting all of the text that you might see if you were to begin reading at the Start marker and continue to the End marker).
      When this Option is turned Off, the rectangular region bounded by the two Markers (i.e., corner-to-corner) is copied to the Clipboard.
  • Auto-Copy Selection
    • When this Option is turned On, the Clipboard contents are updated automatically whenever the Selection Markers are placed or moved. When this Option is turned Off, a 'Copy' Action is required in order to copy the Selection text to the Clipboard.
  • Mark Color
    • Use this Setting to control the color used for the Selection Markers.
  • Right-Hand Mode
    • When dragging the Selection Markers, the popup-zoom views are usually placed in the area above your finger, to make them easily visible. However, when the Marker is near the top of the Terminal display, the popup-zoom views must be placed to one side.
      When this Option is turned On, the popup-zoom views are placed in a way that is more easily visible for right-handed users; when this Option is turned Off, they are placed in a way that is more visible for left-handed users.

Text Completion

  • Auto-Completion Mode
    • When this Option is turned On, the Text Completion interface is displayed automatically, whenever there are two characters typed that have some matching completions in the database. If no completions are available, the Completion interface remains hidden.
      Note that when this Option is turned Off, the Text Completion interface can still be displayed by executing the 'Show Completion UI' Action (which can be done using a Right-Edge Tap if you are using the default Profile settings).
  • Dismiss on Completion
    • When this Option is turned On, the Text Completion interface dismisses whenever an entry is selected from the list of Completions. When this Option is turned Off, selecting an entry causes it to be filled in the Completion text field, and the Completion interface remains displayed, re-filtering the list of Completions based on the selected entry.
  • Index Output
    • This Option controls whether or not all text displayed on the Terminal screen is added to the Completion engine's database. When this Option is turned Off, none of the Terminal output is added to the Completions index.
  • Index Individual Input Words
    • If the 'Index Input' Option is turned On, this Option controls whether or not individual words in the input are added to the Completions index. When this Option is turned Off, only entire input lines (separated by the 'return' key) are added to the Completions index; when this Option is turned On, both entire input lines and all alphanumeric words contained in them (of sufficient length) are added to the index.
      As an example, suppose you have typed 'echo Hello from TouchTerm.' at a shell prompt. When this Option is turned Off, only the entire command is indexed as one string; when this Option is turned On, the terms 'echo', 'Hello', 'from', and 'TouchTerm' are also added to the index (in addition to the full command).
      Note that this Option has no effect when the 'Index Input' Option is turned Off.
  • Index Input
    • This Option controls whether or not input (typed) terms are added to the Completions index. When this Option is turned On, all commands and terms (of sufficient length) that are typed in are added to the Completions index.
      Indexed input is also given a small 'score' preference over output terms, which means that previous inputs will appear higher in the Completions list than terms that have only been seen in the Terminal output display.
  • Index Punctuation
    • If the 'Index Output' Option is turned On, this Option controls whether or not terms containing non-word characters are indexed in the Completions database. When this Option is turned On, all terms, including those with punctuation or special characters, are indexed; when this Option is turned Off, only terms containing alphanumeric characters only are added to the index. In both cases, any alphanumeric substrings (of sufficient length) of terms in the Terminal output are indexed.
      As an example, suppose the Terminal display shows 'bash-3.2$ echo ' -- when this Option is turned Off, only the terms 'bash' and 'echo' are added to the index. When this Option is turned On, the terms 'bash', 'bash-3.2$', and 'echo' are added to the index.
      Note that this Option has no effect when the 'Index Output' Option is turned Off.

SSH Protocol

  • Cipher
    • Use this Option to force TouchTerm to use the specified cipher. See the OpenSSH client (ssh) manual page for more details on cipher selection.
      If you have selected a particular cipher and are experiencing problems connecting to a host, it may be due to the fact that remote host does not support the selected cipher. In this case, it is recommended that you use the Default setting, which allows the client and server to negotiate a commonly shared cipher.
      Note that TouchTerm only supports a subset of the possible ciphers available in OpenSSH. If there is another cipher that you'd like to see supported, please contact technical support, and we will make every effort to support it in the next possible update.
  • SSH Compression
    • Use this Option to enable SSH compression. Enabling compression can reduce bandwidth needed for a connection and improve speed over slow connections, but note that it can also cause higher processor usage and potentially slow things down on fast connections.
  • Allow Connection Timeout
    • Use this Option to disable the default 10-second connection timeout. If you are experiencing Connection Timeout errors, and you expect unusually long connection delays, then disabling this Option will allow more time for the connection process to succeed.
  • Force SSH Protocol v1
    • If you are connecting to a host that requires SSH protocol version 1, use this Option to force TouchTerm to try the v1 protocol only.
  • Set TOUCHTERM Env Var
    • When this Option is On, TouchTerm requests that the TOUCHTERM environment variable be set in the remote shell (to the value of 'PRO', for the TT Pro client). Turn off this Option to disable this request.
      Note that in order for this to work, the ssh server to which you are connecting must be configured to allow the TOUCHTERM environment variable to be passed from the client (many SSH servers have this disabled by default). See the 'AcceptEnv' section in sshd_config man page for information about configuring this for the OpenSSH server.

Misc.

  • Auto-Save Profile
    • Use this Option to control whether or not TouchTerm automatically saves the Active Profile whenever changes are made in the Options or Event Mappings.
      When this Option is turned Off, use the 'Save Profile' Action to save any changes made to the Active Profile. Otherwise, changes are lost when switching Profiles or exiting TouchTerm.
  • Persistent Connections
    • Use this Option to enable Persistent Connections using GNU screen. When this Option is enabled, TouchTerm will attempt to use GNU screen on the remote host in order to persist terminal sessions across multiple sessions; in practice, this ends up behaving as though TouchTerm has 're-connected' to the same, pre-existing session when re-launched. Since the iPhone SDK does not currently support maintaining connections after TouchTerm has terminated, this is an effective alternative for most situations.
      In order for this Option to work, the remote host must have GNU screen installed and available at '/usr/bin/screen'. (Although, see the 'Advanced' Options if this is not the case.)
      Please note that due to incompatibilities between GNU screen and the VT100 standard used by TouchTerm, there may be some terminal emulation problems when using screen-based applications such as emacs and vi. We also recommend that you set the 'Allow Scrollback' Option to Off when using any screen-based application with Persistent Connections enabled, as this tends to reduce errors caused by the emulation incompatibility. However, if you make frequent use of such programs, we recommend that you leave this Option disabled.
      Also note that any changes in this Option will not take effect until the next time a new Connection is established.
  • Auto-Reconnect
    • When this Option is turned On, TouchTerm remembers if you were in the middle of an active Terminal session when last quit. If so, then when next started up, TouchTerm will automatically reconnect to that Saved Connection.
      Note that this Option may be especially convenient in conjunction with the Persistent Connections Option; when used together, you can quit TouchTerm and switch to another app, and when coming back you will be returned to the same state at which you exited TouchTerm.
  • QuickZoom Scale
    • Use this Option to control the scale factor used by the QuickZoom feature: when this value is high, QuickZoom will use a large scale factor (high magnification); when this value is low, QuickZoom will use a smaller scale factor.
  • E-Mail Subject
    • Use this Option to choose the default value for the subject of E-Mail messages that are sent from TouchTerm. Of course, you can always change the e-mail subject before sending it using the Mail application.
  • List .* Files
    • When this Option is turned On, all files (including hidden files, those starting with '.') are displayed in the Directory Navigation interface. When this Option is turned Off, files starting with '.' are not displayed. Note that in both scenarios, '.' and '..' are always excluded from the list.
  • List Directories Only
    • Use this Option to request that the Directory Navigation interface display directories only, and not normal files.
  • Disable Device Sleep
    • When this option is turned on, TouchTerm disables the device's idle timer, so that it will not go to sleep, even after a long period of inactivity. This can be useful for ensuring that your connection is not lost when the device goes to sleep during periods of inactivity; however, note that this can also cause your battery to drain more quickly.
  • Verbose Debug Logs
    • When there is problem making a connection to a remote host, TouchTerm will report some debugging information to help diagnose the problem. When this Option is turned On, this debugging information is considerably more verbose.

Advanced

  • Hide Settings Button
    • Use this to hide the Settings button, displayed by by default near the upper-left corner of the Terminal Display.
      WARNING: note that if this Option is turned Off, and you have not mapped a gesture to access the Settings screen, there will be no way to access Settings without terminating the active Terminal session!
  • Disable Drawing Lock
    • By default, TouchTerm locks the screen against drawing updates when there is a large amount data incoming. This usually helps with performance and responsiveness during high data transmission, and provides user feedback in the form of an activity spinner. However, some users may prefer to disable this option, and have TouchTerm continuously update and redraw the screen for all new incoming data. Be warned, however, that in certain situations this can require TouchTerm to do lots of screen re-drawing, and therefore become unresponsive.
  • Screen Command
    • This Option allows you to make adjustments to the default command used to launch GNU screen for Persistent Connections support. DO NOT CHANGE THIS OPTION unless you have been instructed by technical support, or you understand exactly the effects that your changes will have.
      For reference, the default value for this Option is:
      /usr/bin/screen -S TouchTerm -T vt100 -D -R -U -A -l -m -e^Aa -c /dev/null
  • List Files Command
    • This Option allows you change the command used to generate the 'normal' file list used by the Directory Navigation interface. Note that Directory Navigation requires the '-1' and '-F' options to be set in order to properly parse the results. Do not change this value unless directed by technical support, or if you have a specific problem with Directory Navigation and understand exactly what this Option does.
  • List .* Files Command
    • This Option allows you change the command used to generate the 'long' file list used by the Directory Navigation interface. Note that Directory Navigation requires the '-1' and '-F' options to be set in order to properly parse the results. Do not change this value unless directed by technical support, or if you have a specific problem with Directory Navigation and understand exactly what this Option does.
  • Directory Grep Command
    • Use this Option to modify the command used to filter out directories in Directory Navigation Mode. Note that this Option only has an effect when the 'List Directories Only' Option is turned On. For reference, the default value for this Option is 'grep /'.
      If you are having problems when listing directories only, or 'grep' is not available on your remote system, then a workaround is to change this Option to 'cat'. This will cause all files and directories to be listed by the remote host and transferred over the network; however, only the directories will be displayed by the Directory Navigation interface.
  • Magic Token
    • When using Directory Navigation Mode, TouchTerm makes use of a 'Magic Token' in order to verify the server's response and properly process the command output. This Option must be a string that does not appear in any filenames on your system in order for Directory Navigation to function properly.
      DO NOT CHANGE this value unless directed by technical support, or in the unlikely event that you have a filename on your system which matches the default value.

General

  • Help Mode
    • When this Option is turned On, TouchTerm displays '?' icons in many places throughout the application which, when tapped, bring up Help topics similar to this one. Turn this Option off to hide these help icons.
  • Show Action Reference Help
    • When this Option is turned On, TouchTerm displays a '?' button in top-center of the Terminal display. When tapped, this brings up a reference screen for the Active Profile, which lists all of the Actions that can currently be performed using Gestures. The Actions are in alphabetic order, making it easy to quickly determine which Gesture is required to perform a certain Action.
  • Full-Screen Mode
    • This option controls whether or not the iPhone or iPod status bar (which displays the time, network signal strength, battery life, etc.) is visible while using TouchTerm. In Full-Screen mode, the status bar is invisible and this screen area can be used by the terminal display. Note that any changes in this option will only take effect after TouchTerm is restarted.
  • Carrier Network Activation
    • Due to the method that TouchTerm uses to initiate network connections, it is sometimes required to 'activate' the carrier (EDGE/3G) network before attempting to connect to a server. By default, TouchTerm does this when required by making an HTTP request to an empty webpage ('http://www.jbrink.net/blank.html').
      You can disable this behavior by turning this Option off. In this case, note that it will sometimes be the case that TouchTerm will be unable to connect when using EDGE/3G, especially if it's immediately after 'waking up' the device. As a workaround, you can quit TouchTerm, and launch Safari and open any web page; this will 'activate' the carrier network. After this, you should be able to re-launch TouchTerm and successfully make any connections.

Security

  • Save Passwords
    • When this Option is turned On, TouchTerm allows you to save passwords along with Connections. Turn this Option off to force TouchTerm to never store any passwords.
      It should be noted that stored passwords are NOT encrypted: they are stored in plain-text in the TouchTerm configuration database. Normally, this file is not accessible by any application or service except TouchTerm; however, if your device is lost or stolen, it may be possible to break the iPhone's protections and retrieve the contents of this file, which would include your account passwords. Also, it may be possible to retrieve this information from a backup of your device, as is usually performed by iTunes when synchronizing.
      Also, there is the risk that if you have TouchTerm save your passwords, then in the event that your device is lost or stolen (and not locked, or successfully unlocked), an unauthorized person would be able to connect to your accounts or use your identification keys without needing a password.
      Please understand and be aware of the security risks involved before enabling this Option.
  • Host Key Notification
    • Use this Option to be notified by TouchTerm whenever you connect to server that has an unrecognized public key fingerprint. Note that these fingerprints are available in the Connection Details screen for all servers that you have connected to at least once.
  • Application Lock
    • Use this Option to control whether or not TouchTerm is locked upon and startup, and requires a password to be unlocked. This Option can be useful if you'd like to store passwords on your device for convenience, but want the additional security of requiring a 'master password' to access TouchTerm.
      If you use the Application Lock, be sure to see also the 'Allow Password Reset' Option. Note that when this Option is Off, there is no way to access TouchTerm if the Application Lock password is lost or forgotten.
      Note that you can use the 'Change Lock Password' Action (under 'Misc.' Actions) to set or change the master password.
  • Allow Password Reset
    • When the Application Lock is On, this Option controls whether or not it's possible to bypass the Application Lock by forcing TouchTerm to reset all passwords before granting access. This mainly provides a convenience against losing all of your configuration data in the case that the Application password is lost or reset.
      For additional security and to protect access to even your configuration settings (especially if you store sensitive information like passowrds in automated commands), this option should be turned Off. This will prevent any access to TouchTerm without the proper password; although, if the password is lost or forgotten, then there is no way to access TouchTerm or recover the configuration data.

Gesture Engine

  • Multi-Gesture Delay
    • Use this Option to control the speed required to recognize multi-tap and combination Gestures. For example, when this Option is very low, two Taps must be performed in very rapid succession in order to be recognized as a Double-Tap; on the other hand, when this Option is set very high, then two successive Taps can be performed with a longer interim delay between them and still be recognized as a Double-Tap.
  • Multi-Tap Distance Threshold
    • Use this Option to adjust the distance that your finger can move between taps in the Double-Tap and Triple-Tap gestures. When this Option is low, the successive taps must be in almost exactly the same place; when this Option is high, the successive taps can be further apart.
      If you find that some your Double-Tap and Triple-Tap gestures are being recognized as a single Taps, try raising this Option.
  • Tap-and-Hold Time
    • Use this Option to control the amount of time you must hold your finger on the display in order for a tap gesture to be recognized as a Tap-and-Hold gesture. A low setting means that a relatively short hold duration will qualify, and a high setting means that a relatively long hold is required.
  • Corner Sensitivity
    • Use this Option to control the size of the 'Hot Corners' used to recognize Corner Tap gestures. When this Option is low, the Hot Corners are very small; when this Option is high, the Hot Corners are larger.
  • Edge Sensitivity
    • Use this Option to control the size of the 'Hot Edges' used to recognize Edge Tap gestures. When this Option is low, the Hot Edges are very small; when this Option is high, the Hot Edges are larger.
  • Minimum Swipe Length
    • Use this Option to control the minimum distance required in order for a gesture to qualify as a Swipe. When this Option is low, very short swipes will qualify; when this Option is high, a swipe must be very long in order to qualify.
  • Swipe Line Sensitivity
    • Use this Option to control 'how close' to a straight line a gesture has to be in order to be recognized as a Swipe. When this Option is low, the Swipe must be an almost exactly straight line in order to be recognized; when this Option is set to a high value, TouchTerm allows a fair bit of curvature and 'wiggling' when recognizing Swipe gestures.
  • Swipe Slope Sensitivity
    • Use this Option to control how close to the 8 Swipe Directions (Up, Left, Down, Right, and the four diagonals) a swipe has to be in order to qualify as a Swipe gesture. When this Option is low, the swipe must be almost exactly a horizontal, vertical, or diagonal line; when this Option is very high, almost any line will be recognized as a Swipe and assigned to the nearest of the 8 directions.
  • Gesture Fade Time
    • When 'Gesture Feedback' is turned On, this Option controls the amount of time it takes for the feedback graphics fade out. The higher the Option value, the more time that the feedback graphics remain on the display.
  • Ignore Duplicate Gestures
    • When this Option is On (the default), TouchTerm applies a small delay after a Gesture is fired, in order to avoid having multiple gestures recognized in rapid succession. Usually, this is the desired behavior; however, this Option can be turned Off, in which case TouchTerm will fire all Gestures, regardless of how quickly they occur.
      If you find that you often are performing multiple different gestures in succession, and that TouchTerm is 'ignoring' the latter gestures, then you may want to consider setting this option to Off, or reducing the value of the 'Gesture Ignore Threshold' Option.
      When this Option is turned On, use the 'Gesture Ignore Threshold' Option to configure how long TouchTerm waits, ignoring potential Gestures, before re-enabling the recognition of subsequent Gestures.
  • Gesture Ignore Threshold
    • When the 'Ignore Duplicate Gestures' Option is On, this Option controls the amount of time after a gesture is recognized during which TouchTerm will ignore potential subsequent gestures; a low value means a short delay, and a high value means a longer delay. See the help topic for the 'Ignore Duplicate Gestures' for a more detailed description of when adjusting this Option is appropriate.