/usr/share/doc/gnat-gps/html/Defining-a-shell.html

<!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 shell</title>

<meta name="description" content="Using the GNAT Programming Studio: Defining a shell">
<meta name="keywords" content="Using the GNAT Programming Studio: Defining a shell">
<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="Configuring-rsync-usage.html#Configuring-rsync-usage" rel="next" title="Configuring rsync usage">
<link href="Defining-a-remote-connection-tool.html#Defining-a-remote-connection-tool" rel="previous" title="Defining a remote connection tool">
<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-shell"></a>
<div class="header">
<p>
Next: <a href="Configuring-rsync-usage.html#Configuring-rsync-usage" accesskey="n" rel="next">Configuring rsync usage</a>, Previous: <a href="Defining-a-remote-connection-tool.html#Defining-a-remote-connection-tool" accesskey="p" rel="previous">Defining a remote connection tool</a>, Up: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="u" rel="up">Remote programming customization</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Defining-a-shell-1"></a>
<h4 class="subsubsection">16.5.19.2 Defining a shell</h4>
<a name="index-remote-3"></a>

<p>Several shells are already defined in GPS: sh, bash, csh, tcsh and
cmd.exe (Windows). It is possible to add other shells, using the node
<code>remote_shell_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 shell. This name does not necessarilly correspond to
the command used to launch the shell.
</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 shell. If arguments are required, they
should be put here, separated with spaces.
</p>
</dd>
<dt><code>generic_prompt (optional)</code></dt>
<dd><p>The regular expression used to identify a prompt after the initial
connection. If not set, a default value is used.
</p>
</dd>
<dt><code>gps_prompt (mandatory)</code></dt>
<dd><p>The regular expression used to identify a prompt after the initial
setup is performed. If not set, a default value is used.
</p>
</dd>
<dt><code>filesystem (mandatory)</code></dt>
<dd><p>Takes the following values: <code>unix</code> or <code>windows</code>. This is the
filesystem used by the shell.
</p>
</dd>
<dt><code>init_commands (optional)</code></dt>
<dd><p>Complex child. Each <code>cmd</code> child contains a command used to
initialise a new session.
</p>
</dd>
<dt><code>exit_commands (optional)</code></dt>
<dd><p>Complex child. Each <code>cmd</code> child contains a command used to
exit a session.
</p>
</dd>
<dt><code>no_echo_command (optional)</code></dt>
<dd><p>Command used to suppress the echo of the remote shell.
</p>
</dd>
<dt><code>cd_command (mandatory)</code></dt>
<dd><p>Command used to go to a directory. <code>%d</code> is replaced by the
directory&rsquo;s full name.
</p>
</dd>
<dt><code>get_status_command (mandatory)</code></dt>
<dd><p>Command used to retrieve the status of the last command launched.
</p>
</dd>
<dt><code>get_status_ptrn (mandatory)</code></dt>
<dd><p>Regular expression used to retrieve the status returned by
<code>get_status_command</code>. A pair of parenthesis is required, and
identifies the status.
</p>
</dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Configuring-rsync-usage.html#Configuring-rsync-usage" accesskey="n" rel="next">Configuring rsync usage</a>, Previous: <a href="Defining-a-remote-connection-tool.html#Defining-a-remote-connection-tool" accesskey="p" rel="previous">Defining a remote connection tool</a>, Up: <a href="Remote-programming-customization.html#Remote-programming-customization" accesskey="u" rel="up">Remote programming customization</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Defining-a-shell.html
