/usr/share/doc/gnat-gps/html/Adding-New-Help-Files.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 | <html lang="en">
<head>
<title>Adding New Help Files - 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="Online-Help.html#Online-Help" title="Online Help">
<link rel="prev" href="The-Help-Menu.html#The-Help-Menu" title="The Help Menu">
<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="Adding-New-Help-Files"></a>
<p>
Previous: <a rel="previous" accesskey="p" href="The-Help-Menu.html#The-Help-Menu">The Help Menu</a>,
Up: <a rel="up" accesskey="u" href="Online-Help.html#Online-Help">Online Help</a>
<hr>
</div>
<h3 class="section">3.2 Adding New Help Files</h3>
<p><a name="index-gps_005findex_002exml-105"></a>GPS will search for the help files in the list of directories set in
the environment variable <code>GPS_DOC_PATH</code> (a colon-separated list
of directories on Unix systems, or semicolon-separated list of
directories on Windows systems). In addition, the
default directory <code><prefix>/share/doc/gps/html</code> is also searched. If the
file cannot be found in any of these directories, the corresponding
menu item will be disabled.
<p>The environment variable <code>GPS_DOC_PATH</code> can either be set by each
user in his own environment, or can be set system-wide by modifying
the small wrapper script <samp><span class="file">gps</span></samp> itself on Unix systems.
<p>It can also be set programmatically through the GPS shell or any of the
scripting languages. This is done with
<pre class="smallexample"> GPS.add_doc_directory ("/home/foo")
</pre>
<p>The specific list of files shown in the menus is set by reading the
index files in each of the directories in <code>GPS_DOC_PATH</code>. These
index files must be called <samp><span class="file">gps_index.xml</span></samp>.
<p>The format of these index files is specified in see <a href="Adding-documentation.html#Adding-documentation">Adding documentation</a>.
<!-- -->
</body></html>
|