gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Defining-a-remote-connection-tool.html

This file is indexed.

/usr/share/doc/gnat-gps/html/Defining-a-remote-connection-tool.html is in gnat-gps-doc 5.0-6.

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
<html lang="en">
<head>
<title>Defining a remote connection tool - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Remote-programming-customization.html#Remote-programming-customization" title="Remote programming customization">
<link rel="next" href="Defining-a-shell.html#Defining-a-shell" title="Defining a shell">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
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 3 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/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
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>
<div class="node">
<a name="Defining-a-remote-connection-tool"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Defining-a-shell.html#Defining-a-shell">Defining a shell</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Remote-programming-customization.html#Remote-programming-customization">Remote programming customization</a>
<hr>
</div>

<h5 class="subsubsection">16.5.19.1 Defining a remote connection tool</h5>

<p><a name="index-remote-844"></a><!--  -->

<p class="noindent">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>The attributes for this node are:

     <dl>
<dt><code>name (string) (mandatory)</code><dd>The name of the tool. This name does not necessarilly correspond to
the command used to launch the tool.

   </dl>

   <p>The following children are defined:

     <dl>
<dt><code>start_command (mandatory)</code><dd>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:
          <dl>
<dt><code>true</code><dd>use pipes to launch the tool. 
<br><dt><code>false (default)</code><dd>use a tty emulation, which is a bit slower but allow
 password prompts retrieval with some tools. 
</dl>
     Note that this argument has effects only on Windows platforms.

     <br><dt><code>start_command_common_args (optional)</code><dd>The arguments that are provided to the tool. This string can contain the
following replacement macros:
          <dl>
<dt><code>%C</code><dd>is replaced by the command executed on the remote host (e.g. the shell command)
<br><dt><code>%h</code><dd>is replaced by the remote host name
<br><dt><code>%U</code><dd>is replaced by the start_command_user_args, if a user is specified
<br><dt><code>%u</code><dd>is replaced by the user name
</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.

     <br><dt><code>start_command_user_args (optional)</code><dd>The arguments used to define a specific user during connection. %u is replaced
 by the user name

     <br><dt><code>send_interrupt (optional)</code><dd>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.

     <br><dt><code>user_prompt_ptrn (optional)</code><dd>A regular expression, used to catch user name prompts from the
connection tool. If undefined, a default regular expression is used.

     <br><dt><code>password_prompt_ptrn (optional)</code><dd><a name="index-password-845"></a>A regular expression, used to catch password prompts from the
connection tool. If undefined, a default regular expression is used.

     <br><dt><code>passphrase_prompt_ptrn (optional)</code><dd>A regular expression, used to catch passphrase prompts from the
connection tool. If undefined, a default regular expression is used.

     <br><dt><code>extra_ptrn (optional)</code><dd>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.

     <!-- ??? need an example -->
   </dl>

<!--  -->
   </body></html>

APT Browse - Built by Thomas Orozco.