/usr/share/doc/pyxplot/html/sect0225.html is in pyxplot-doc 0.8.4-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="generator" content="plasTeX" />
<meta content="text/html; charset=utf-8" http-equiv="content-type" />
<title>PyXPlot Users' Guide: Configuration Files</title>
<link href="sect0226.html" title="An Example Configuration File" rel="next" />
<link href="ch-configuration.html" title="Configuring PyXPlot" rel="prev" />
<link href="ch-configuration.html" title="Configuring PyXPlot" rel="up" />
<link rel="stylesheet" href="styles/styles.css" />
</head>
<body>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="ch-configuration.html" title="Configuring PyXPlot"><img alt="Previous: Configuring PyXPlot" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="ch-configuration.html" title="Configuring PyXPlot"><img alt="Up: Configuring PyXPlot" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sect0226.html" title="An Example Configuration File"><img alt="Next: An Example Configuration File" border="0" src="icons/next.gif" width="32" height="32" /></a></td>
<td class="navtitle" align="center">PyXPlot Users' Guide</td>
<td><a href="index.html" title="Table of Contents"><img border="0" alt="" src="icons/contents.gif" width="32" height="32" /></a></td>
<td><a href="sect0255.html" title="Index"><img border="0" alt="" src="icons/index.gif" width="32" height="32" /></a></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
</tr>
</table>
</div>
<div class="breadcrumbs">
<span>
<span>
<a href="index.html">PyXPlot Users' Guide</a> <b>:</b>
</span>
</span><span>
<span>
<a href="sect0075.html">Reference Manual</a> <b>:</b>
</span>
</span><span>
<span>
<a href="ch-configuration.html">Configuring PyXPlot</a> <b>:</b>
</span>
</span><span>
<span>
<b class="current">Configuration Files</b>
</span>
</span>
<hr />
</div>
<div><h1 id="a0000000226">8.1 Configuration Files</h1>
<p>Configuration files for PyXPlot have the filename <tt class="tt">.pyxplotrc</tt>, and may be placed either in a user’s home directory, in which case they globally affect all of that user’s PyXPlot sessions, or in particular directories, in which case they only affect PyXPlot sessions which are instantiated with that particular directory as the current working directory. When configuration files are present in both locations, both are read; settings found in the <tt class="tt">.pyxplotrc</tt> file in the current working directory take precedence over those found in the user’s home directory. Configuration files are read only once, upon startup, and subsequent changes to the configuration files do not affect copies of PyXPlot which are already running. </p><p>Changes to settings made in configuration files affect not only the values that these settings have upon startup; they also changes the values to which the <tt class="tt">unset</tt> command<a name="a0000001525" id="a0000001525"></a> returns settings. Thus, whilst the command </p><pre>
unset multiplot
</pre><p> ordinarily turns off multiplot mode, it may turn it on if a configuration file contains the line </p><pre>
MultiPlot=On
</pre><p> When coloured terminal output is enabled, the colour-coding of the <tt class="tt">show</tt> command<a name="a0000001526" id="a0000001526"></a> also reflects the current default configuration: settings which match their default values are shown in green<a href="#a0000001527" class="footnote"><sup class="footnotemark">1</sup></a> whilst those settings which have been changed from their default values are shown in amber<a href="#a0000001528" class="footnote"><sup class="footnotemark">2</sup></a>. </p><p>Configuration files should take the form of a series of sections, each headed by a section heading enclosed in square brackets. Each section heading should be followed by a series of settings, which often take the form of </p><pre>
Setting_Name = Value
</pre><p> In <i class="it">most</i> cases, neither the setting name nor the value are case sensitive. </p><p>The following sections are used, although they do not all need to be present in any given file, and they may appear in any order: </p><ul class="itemize">
<li><p><tt class="tt">colours</tt> – contains a single setting <tt class="tt">palette</tt>, which should be set to a comma-separated list of colours which should make up the palette used to plot datasets. The first will be called colour 1 in PyXPlot, the second colour 2, etc. A list of recognised colour names is given in Section <a href="sec-colour_names.html">8.4</a>. </p></li><li><p><tt class="tt">filters</tt> – can be used to define input filters which should be used for certain file types (see Section <a href="sec-filters.html">5.1</a>). </p></li><li><p><tt class="tt">functions</tt> – contains user-defined function definitions which become predefined in PyXPlot’s mathematical environment, for example </p><pre>
sinc(x) = sin(x)/(x)
</pre></li><li><p><tt class="tt">latex</tt> – contains a single setting <tt class="tt">preamble</tt>, which is prefixed to the beginning of all L<sup style="font-variant:small-caps; margin-left:-0.3em">a</sup>T<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X text items, before the <tt class="tt">\begin{document}</tt> statement. It can be used to define custom L<sup style="font-variant:small-caps; margin-left:-0.3em">a</sup>T<sub style="text-transform:uppercase; margin-left:-0.2em">e</sub>X macros or to include packages using the <tt class="tt">\includepackage{}</tt> command. The preamble can be also changed using the <tt class="tt">set preamble</tt> command<a name="a0000001529" id="a0000001529"></a>. </p></li><li><p><tt class="tt">script</tt> – can contain a list of <tt class="tt">set</tt> command<a name="a0000001530" id="a0000001530"></a>s, using the same syntax which would be used to enter them at a PyXPlot command prompt. This section provides an alternative and more general way of controlling the settings which can be changed in the <tt class="tt">settings</tt> section. Note that this section may only contain instances of the <tt class="tt">set</tt> command<a name="a0000001531" id="a0000001531"></a>; other PyXPlot commands may not be used. The <tt class="tt">set</tt> command<a name="a0000001532" id="a0000001532"></a>’s <tt class="tt">item</tt> modifier may not be used. </p></li><li><p><tt class="tt">settings</tt> – contains settings similar to those which can be set with the <tt class="tt">set</tt> command<a name="a0000001533" id="a0000001533"></a>. A complete list is given in Section <a href="sec-configfile_settings.html">8.3.2</a> below. </p></li><li><p><tt class="tt">styling</tt> – contains settings which control various detailed aspects of the graphical output which PyXPlot produces. These settings cannot be accessed by any other means. </p></li><li><p><tt class="tt">terminal</tt> – contains settings for altering the behaviour and appearance of PyXPlot’s interactive terminal. These cannot be changed with the <tt class="tt">set</tt> command<a name="a0000001534" id="a0000001534"></a>, and can only be controlled via configuration files. A complete list of the available settings is given in Section <a href="sec-configfile_terminal.html">8.3.4</a>. </p></li><li><p><tt class="tt">units</tt> – can be used to define new physical units for use in PyXPlot’s mathematical environment. </p></li><li><p><tt class="tt">variables</tt> – contains variable definitions, in the format </p><pre>
variable = value
</pre><p> Any variables defined in this section will be pre-defined in PyXPlot’s mathematical environment upon startup. </p></li>
</ul></div>
<div id="footnotes">
<p><b>Footnotes</b></p>
<ol>
<li id="a0000001527">This colour can be changed using the <tt class="tt">Colour_Rep</tt> setting in a configuration file.</li><li id="a0000001528">This colour can be changed using the <tt class="tt">Colour_Wrn</tt> setting in a configuration file.</li>
</ol>
</div>
<div class="navigation">
<table cellspacing="2" cellpadding="0" width="100%">
<tr>
<td><a href="ch-configuration.html" title="Configuring PyXPlot"><img alt="Previous: Configuring PyXPlot" border="0" src="icons/previous.gif" width="32" height="32" /></a></td>
<td><a href="ch-configuration.html" title="Configuring PyXPlot"><img alt="Up: Configuring PyXPlot" border="0" src="icons/up.gif" width="32" height="32" /></a></td>
<td><a href="sect0226.html" title="An Example Configuration File"><img alt="Next: An Example Configuration File" border="0" src="icons/next.gif" width="32" height="32" /></a></td>
<td class="navtitle" align="center">PyXPlot Users' Guide</td>
<td><a href="index.html" title="Table of Contents"><img border="0" alt="" src="icons/contents.gif" width="32" height="32" /></a></td>
<td><a href="sect0255.html" title="Index"><img border="0" alt="" src="icons/index.gif" width="32" height="32" /></a></td>
<td><img border="0" alt="" src="icons/blank.gif" width="32" height="32" /></td>
</tr>
</table>
</div>
<script language="javascript" src="icons/imgadjust.js" type="text/javascript"></script>
</body>
</html>
|