/usr/share/doc/gnat-gps/html/Files.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: Files</title>

<meta name="description" content="Using the GNAT Programming Studio: Files">
<meta name="keywords" content="Using the GNAT Programming Studio: Files">
<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="Environment.html#Environment" rel="up" title="Environment">
<link href="Reporting-Suggestions-and-Bugs.html#Reporting-Suggestions-and-Bugs" rel="next" title="Reporting Suggestions and Bugs">
<link href="Running-GPS-on-Mac-OS-X.html#Running-GPS-on-Mac-OS-X" rel="previous" title="Running GPS on Mac OS X">
<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="Files"></a>
<div class="header">
<p>
Next: <a href="Reporting-Suggestions-and-Bugs.html#Reporting-Suggestions-and-Bugs" accesskey="n" rel="next">Reporting Suggestions and Bugs</a>, Previous: <a href="Running-GPS-on-Mac-OS-X.html#Running-GPS-on-Mac-OS-X" accesskey="p" rel="previous">Running GPS on Mac OS X</a>, Up: <a href="Environment.html#Environment" accesskey="u" rel="up">Environment</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Files-1"></a>
<h3 class="section">17.4 Files</h3>
<a name="index-files"></a>


<dl compact="compact">
<dt><samp>$HOME/.gps</samp></dt>
<dd><a name="index-Windows-5"></a>
<a name="index-HOME"></a>
<p>GPS state directory. Defaults to C:\.gps under Windows systems if HOME or
USERPROFILE environment variables are not defined.
</p>
</dd>
<dt><samp>$HOME/.gps/log</samp></dt>
<dd><a name="index-log"></a>
<a name="log-file"></a><p>Log file created automatically by GPS.
When GPS is running, it will create a file named <samp>log.&lt;pid&gt;</samp>, where
<samp>&lt;pid&gt;</samp> is the GPS process id, so that multiple GPS sessions do not
clobber each other&rsquo;s log. In case of a successful session, this
file is renamed <samp>log</samp> when exiting; in case of an unexpected exit
(a bug box will be displayed), the log file is kept under its original name.
</p>
<p>Note that the name of the log file is configured by the <samp>traces.cfg</samp>
file.
</p>
</dd>
<dt><samp>$HOME/.gps/aliases</samp></dt>
<dd><a name="index-aliases-3"></a>
<p>File containing the user-defined aliases (see <a href="Defining-text-aliases.html#Defining-text-aliases">Defining text aliases</a>).
</p>
</dd>
<dt><samp>$HOME/.gps/plug-ins</samp></dt>
<dd><p>Directory containing files with user-defined plug-ins.
All xml and python files found under this directory are loaded by GPS during
start up.
You can create/edit these files to add your own menu/tool-bar entries in GPS,
or define support for new languages.
see <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files">Customizing through XML and Python files</a> and
see <a href="Adding-support-for-new-languages.html#Adding-support-for-new-languages">Adding support for new languages</a>.
</p>
</dd>
<dt><samp>$HOME/.gps/keys.xml</samp></dt>
<dd><p>Contains all the key bindings for the actions defined in GPS or in the
custom files. This only contains the key bindings overridden through the
key shortcuts editor (see <a href="The-Key-Manager-Dialog.html#The-Key-Manager-Dialog">The Key Manager Dialog</a>).
</p>
</dd>
<dt><samp>$HOME/.gps/gtkrc</samp></dt>
<dd><a name="index-Dynamic-Key-Binding"></a>
<a name="index-gtkrc"></a>
<p>Configuration and theme file for gtkrc. This file can be edited to activate
gtk+ specific aspects, or change the look of GPS in some measure. Mostly,
everything can be done through the standard GPS preferences, but this file
can be used to get access to the old GPS preference &quot;Dynamic Key Binding&quot;.
This preference activated a gtk+ behavior were key shortcuts for menu can be
changed by simply pressing the appropriate key combination when the mouse is
over that menu. It has various dangereous aspects and is not fully supported
by GPS, so was removed as a preference, but you can add the following line
in <samp>gtkrc</samp> to get this back:
</p><div class="smallexample">
<pre class="smallexample">gtk-can-change-accels=1
</pre></div>

</dd>
<dt><samp>$HOME/.gps/actions.xml</samp></dt>
<dd><p>Contains the definition of all the actions that were defined through the
graphical interface. This is loaded last, and overrides all actions defined
elsewhere.
</p>
</dd>
<dt><samp>$HOME/.gps/perspectives.xml</samp></dt>
<dd><p>Desktop file in XML format (using the menu <code>File-&gt;Save More-&gt;Desktop</code>),
loaded automatically if found.
</p>
</dd>
<dt><samp>$HOME/.gps/locations.xml</samp></dt>
<dd><p>This file contains the list of locations that GPS has previously edited. It
corresponds to the history navigation (<code>Navigate-&gt;Back</code> and
<code>Navigate-&gt;Forward</code>)
</p>
</dd>
<dt><samp>$HOME/.gps/properties.xml</samp></dt>
<dd><p>This file is used to store file-specific properties across GPS sessions. In
particular, it contains the encoding to use for various files when the
default encoding isn&rsquo;t appropriate.
</p>
</dd>
<dt><samp>$HOME/.gps/histories.xml</samp></dt>
<dd><a name="index-history-1"></a>
<p>Contains the state and history of combo boxes (e.g. the
<code>Run-&gt;Custom...</code> dialog).
</p>
</dd>
<dt><samp>$HOME/.gps/targets.xml</samp></dt>
<dd><a name="index-targets"></a>
<p>Contains the build targets defined by the user.
</p>
</dd>
<dt><samp>$HOME/.gps/preferences</samp></dt>
<dd><a name="index-preferences-8"></a>
<p>Contains all the preferences in XML format, as specified in the
preferences menu.
</p>
</dd>
<dt><samp>$HOME/.gps/traces.cfg</samp></dt>
<dd><p>Default configuration for the system traces. These traces are used to analyze
problems with GPS.
By default, they are sent to the file <samp>$HOME/.gps/log.&lt;pid&gt;</samp>.
</p>
<p>This file is created automatically when the <samp>$HOME/.gps/</samp> directory is
created. If you remove it manually, it won&rsquo;t be recreated the next time you
start GPS.
</p>
</dd>
<dt><samp>$HOME/.gps/startup.xml</samp></dt>
<dd><p>This file contains the list of scripts to load at startup, as well as
additional code that need to be executed to setup the script.
</p>
</dd>
<dt><samp>$HOME/.gpe/activity_log.tmplt</samp></dt>
<dd><p>Template file used to generate activities&rsquo; group commit-log and patch
file&rsquo;s header. If not present the system wide template (see below) is
used. The set of configurable tags are described into this template.
<a name="index-activity-log-template"></a>
<a name="index-activity_002c-log-template"></a>
</p>
</dd>
<dt><samp><i>prefix</i></samp></dt>
<dd><p>The prefix directory where GPS is installed, e.g <samp>/opt/gps</samp>.
</p>
</dd>
<dt><samp><i>prefix</i>/bin</samp></dt>
<dd><p>The directory containing the GPS executables.
</p>
</dd>
<dt><samp><i>prefix</i>/etc/gps</samp></dt>
<dd><p>The directory containing global configuration files for GPS.
</p>
</dd>
<dt><samp><i>prefix</i>/lib</samp></dt>
<dd><p>This directory contains the shared libraries used by GPS.
</p>
</dd>
<dt><samp><i>prefix</i>/share/doc/gps/html</samp></dt>
<dd><p>GPS will look for all the documentation files under this directory.
</p>
</dd>
<dt><samp><i>prefix</i>/share/examples/gps</samp></dt>
<dd><p>This directory contains source code examples.
</p>
</dd>
<dt><samp><i>prefix</i>/share/examples/gps/language</samp></dt>
<dd><p>This directory contains sources showing how to provide a shared library to
dynamically define a new language. See <a href="Adding-support-for-new-languages.html#Adding-support-for-new-languages">Adding support for new languages</a>.
</p>
</dd>
<dt><samp><i>prefix</i>/share/examples/gps/tutorial</samp></dt>
<dd><p>This directory contains the sources used by the GPS tutorial.
<a name="index-url-1"></a>
See <a href="/usr/share/doc/gnat-gps/tutorial.html">/usr/share/doc/gnat-gps/tutorial.html</a>.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/plug-ins</samp></dt>
<dd><p>Directory containing files with system-wide plug-ins (xml and python files)
loaded automatically at start-up.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/library</samp></dt>
<dd><p>Directory containing files with system-wide plug-ins (xml and python files)
that are not loaded automatically at startup, but can be selected in the
Plug-ins editor.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/gps-animation.png</samp></dt>
<dd><a name="index-png-2"></a>
<p>Default image displayed in the top right corner of GPS when GPS is idle.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/gps-animation.gif</samp></dt>
<dd><a name="index-gif-1"></a>
<p>Animated image displayed in the top right corner of GPS to indicate that
actions (e.g compilation) are on going. If you remove this file, the idle
image (<samp>gps-animation.png</samp>) will always be displayed.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/gps-splash.png</samp></dt>
<dd><a name="index-png-3"></a>
<p>Splash screen displayed by default when GPS is started.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/perspectives.xml</samp></dt>
<dd><a name="index-default-desktop"></a>
<a name="index-desktop_002c-default"></a>
<p>This is the description of the default desktop that GPS uses when the user
hasn&rsquo;t defined his own default desktop and no project specific desktop exists.
You can modify this file if you want, knowing that this will impact all users
of GPS sharing this installation.
The format of this file is the same as $HOME/.gps/perspectives.xml, which can be
copied from your own directory if you wish.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/default.gpr</samp></dt>
<dd><a name="index-default-project"></a>
<p>Default project used by GPS. Can be modified after installation time to
provide useful default for a given system or project.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/readonly.gpr</samp></dt>
<dd><p>Project used by GPS as the default project when working in a read-only
directory.
</p>
</dd>
<dt><samp><i>prefix</i>/share/gps/activity_log.tmplt</samp></dt>
<dd><p>Template file used by default to generate activities&rsquo; group commit-log
and patch file&rsquo;s header. This file can be copied into user home
directory and customized (see above).
</p>
</dd>
<dt><samp><i>prefix</i>/share/locale</samp></dt>
<dd><p>Directory used to retrieve the translation files, when relevant.
</p>
</dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Reporting-Suggestions-and-Bugs.html#Reporting-Suggestions-and-Bugs" accesskey="n" rel="next">Reporting Suggestions and Bugs</a>, Previous: <a href="Running-GPS-on-Mac-OS-X.html#Running-GPS-on-Mac-OS-X" accesskey="p" rel="previous">Running GPS on Mac OS X</a>, Up: <a href="Environment.html#Environment" accesskey="u" rel="up">Environment</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 / Files.html
