/usr/share/doc/gnat-gps/html/Defining-a-remote-connection-tool.html is in gnat-gps-doc 5.0-16.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2002-2010 AdaCore.
This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, see http://www.gnu.org/licenses/.
A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: Defining a remote connection tool</title>
<meta name="description" content="Using the GNAT Programming Studio: Defining a remote connection tool">
<meta name="keywords" content="Using the GNAT Programming Studio: Defining a remote connection tool">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Remote-programming-customization.html#Remote-programming-customization" rel="up" title="Remote programming customization">
<link href="Defining-a-shell.html#Defining-a-shell" rel="next" title="Defining a shell">
<link href="Remote-programming-customization.html#Remote-programming-customization" rel="previous" title="Remote programming customization">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
pre.smallexample {background-color:rgb(240,240,240);
font-family: courier new,courier,fixed;
font-size: 14px;
margin: 0px 40px 0px 40px;
border-width: 1px 2px 2px 1px;
border-top-style: dotted;
border-left-style: dotted;
border-right-style: solid;
border-bottom-style: solid;
border-color: black;}
code {color:black;
font-family: courier new,courier,fixed;
font-size: 14px;}
body {font-family: arial,helvetica,sans-serif;
font-size: 16px;
max-width: 800px;
text-align: justify}
samp {font-family: courier new,courier,fixed;
font-size: 14px}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Defining-a-remote-connection-tool"></a>
<div class="header">
<p>
Next: <a href="Defining-a-shell.html#Defining-a-shell" accesskey="n" rel="next">Defining a shell</a>, Up: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="u" rel="up">Remote programming customization</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Defining-a-remote-connection-tool-1"></a>
<h4 class="subsubsection">16.5.19.1 Defining a remote connection tool</h4>
<a name="index-remote-2"></a>
<p>Several remote access tools are already defined in GPS: ssh, rsh,
telnet and plink. It is possible to add other tools, using the node
<code>remote_connection_config</code>.
</p>
<p>The attributes for this node are:
</p>
<dl compact="compact">
<dt><code>name (string) (mandatory)</code></dt>
<dd><p>The name of the tool. This name does not necessarilly correspond to
the command used to launch the tool.
</p>
</dd>
</dl>
<p>The following children are defined:
</p>
<dl compact="compact">
<dt><code>start_command (mandatory)</code></dt>
<dd><p>The command used to launch the tool.
This tag supports the <code>use_pipes</code> attribute. This attribute selects on
Windows the way GPS will launch the remote tools, and can take the following
values:
</p><dl compact="compact">
<dt><code>true</code></dt>
<dd><p>use pipes to launch the tool.
</p></dd>
<dt><code>false (default)</code></dt>
<dd><p>use a tty emulation, which is a bit slower but allow
password prompts retrieval with some tools.
</p></dd>
</dl>
<p>Note that this argument has effects only on Windows platforms.
</p>
</dd>
<dt><code>start_command_common_args (optional)</code></dt>
<dd><p>The arguments that are provided to the tool. This string can contain the
following replacement macros:
</p><dl compact="compact">
<dt><code>%C</code></dt>
<dd><p>is replaced by the command executed on the remote host (e.g. the shell command)
</p></dd>
<dt><code>%h</code></dt>
<dd><p>is replaced by the remote host name
</p></dd>
<dt><code>%U</code></dt>
<dd><p>is replaced by the start_command_user_args, if a user is specified
</p></dd>
<dt><code>%u</code></dt>
<dd><p>is replaced by the user name
</p></dd>
</dl>
<p>Note that if neither %u nor %U is found, and a user is specified in the remote
connection configuration, then the start_command_user_args is placed at the
beginning of the arguments.
</p>
</dd>
<dt><code>start_command_user_args (optional)</code></dt>
<dd><p>The arguments used to define a specific user during connection. %u is replaced
by the user name
</p>
</dd>
<dt><code>send_interrupt (optional)</code></dt>
<dd><p>The characters sequence to send to the remote tool to interrupt the remote
application. If unset, then an Interrupt signal is sent directly to the remote
tool.
</p>
</dd>
<dt><code>user_prompt_ptrn (optional)</code></dt>
<dd><p>A regular expression, used to catch user name prompts from the
connection tool. If undefined, a default regular expression is used.
</p>
</dd>
<dt><code>password_prompt_ptrn (optional)</code></dt>
<dd><a name="index-password-4"></a>
<p>A regular expression, used to catch password prompts from the
connection tool. If undefined, a default regular expression is used.
</p>
</dd>
<dt><code>passphrase_prompt_ptrn (optional)</code></dt>
<dd><p>A regular expression, used to catch passphrase prompts from the
connection tool. If undefined, a default regular expression is used.
</p>
</dd>
<dt><code>extra_ptrn (optional)</code></dt>
<dd><p>Complex child. Used to catch extra prompts from the connection tool,
other than password, passphrase or usename prompts. This tag has an
attribute <code>auto_answer</code> telling if GPS automatically answers to
this prompt, or ask the user. If auto_answer is <code>true</code>, then this
tag needs an <code>answer</code> child, whose value is used for the answer. If
auto_answer is <code>false</code>, then this tag needs a <code>question</code> child,
whose value is used as question to the end user.
</p>
</dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Defining-a-shell.html#Defining-a-shell" accesskey="n" rel="next">Defining a shell</a>, Up: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="u" rel="up">Remote programming customization</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|