← Back to branch summary

~ubuntu-branches/debian/sid/apt-dater/sid

« back to all changes in this revision

Viewing changes to man/apt-dater.config.html

  • Committer: Package Import Robot
  • Author(s): Patrick Matthäi
  • Date: 2015-07-07 17:33:08 UTC
  • mfrom: (1.2.5)
  • Revision ID: package-import@ubuntu.com-20150707173308-7rkjhxnlq7gsykif
Tags: 1.0.2-1
http://bugs.debian.org/776392
http://bugs.debian.org/789648
* New upstream release.
  - Set the default of the opt-cmd-flags host option to "-t" since this is
    essential.
    Closes: #776392
  - Add new build dependency vim-common.
* Replace screen dependency with tmux.
* Create apt-dater group for session sharing.
* Add missing directories.
* Make the build reproducible.
  Closes: #789648
* Drop automake and autoconf build dependencies.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/apt-dater.config.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>APT-DATER</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idp43210240"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>apt-dater.config &#8212; configuration file of apt-dater(8)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><p><span class="symbol">Group</span>:
2
 
{
3
 
          </p></dd><dt></dt><dd><p><span class="symbol">parameter</span>=<em class="replaceable"><code>value</code></em>;</p></dd><dt></dt><dd><p>}</p></dd></dl></div></div><div class="refsect1"><a name="idp43031088"></a><h2>DESCRIPTION</h2><p>The file <em class="replaceable"><code>apt-dater.config</code></em> is the
4
 
      configuration file for <span class="command"><strong>apt-dater</strong></span>(8).
5
 
      <span class="command"><strong>apt-dater</strong></span>(8) is a program to manage package updats 
6
 
      on a large number of remote hosts using SSH.
7
 
      This man page descripes briefly the parameters of the file
8
 
      <em class="replaceable"><code>apt-dater.config</code></em>. 
9
 
      The default location of this file is <em class="replaceable"><code>$XDG_CONFIG_HOME/apt-dater/apt-dater.config</code></em>.
10
 
    </p><p>
11
 
      The configuration file is parsed using libconfig. Please be aware that config statements are case sensitive.
12
 
      Look at libconfig's documentation for more details about the required file syntax.
13
 
    </p></div><div class="refsect1"><a name="idp43021584"></a><h2>OPTIONS</h2><div class="refsect2"><a name="idp43022256"></a><h3>Group '<span class="symbol">Paths</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">HostsFile</span>="<em class="replaceable"><code>$XDG_CONFIG_HOME/apt-dater/hosts.config</code></em>";</span></dt><dd><p>The location of the file contains all host which will be managed with <span class="command"><strong>apt-dater</strong></span>. (optional)</p></dd><dt><span class="term"><span class="symbol">StatsDir</span>="<em class="replaceable"><code>$XDG_DATA_HOME/apt-dater</code></em>";</span></dt><dd><p>The location of the directory which contains the status files of any host. (optional)</p></dd></dl></div></div><div class="refsect2"><a name="idp43162064"></a><h3>Group '<span class="symbol">Screen</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">RCFile</span>="<em class="replaceable"><code>$XDG_CONFIG_HOME/apt-dater/screenrc</code></em>";</span></dt><dd><p>Location of screen(1) config file. (optional)</p></dd><dt><span class="term"><span class="symbol">Title</span>="<em class="replaceable"><code>%m # %u@%h:%p</code></em>";</span></dt><dd><p>Template for screen titles using string escapes. (optional)</p></dd><dt><span class="term"><span class="symbol">NoDumps</span>=<em class="replaceable"><code>false</code></em>;</span></dt><dd><p>Enables/disables support of screen dumps. (optional)</p></dd><dt><span class="term"><span class="symbol">QueryMaintainer</span>=<em class="replaceable"><code>0</code></em>;</span></dt><dd><p>If set to 1, apt-dater will ask for the maintainers name on startup. If set to 2, apt-dater will only ask if no MAINTAINER environment variable is set.</p></dd></dl></div></div><div class="refsect2"><a name="idp47027968"></a><h3>Group '<span class="symbol">SSH</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">Cmd</span>="<em class="replaceable"><code>/usr/bin/ssh</code></em>";</span></dt><dd><p>The location of ssh-client binary.</p></dd><dt><span class="term"><span class="symbol">SFTPCmd</span></span></dt><dd><p>The command to initiate sftp file transfer e.g. <span class="command"><strong>/usr/bin/sftp</strong></span></p></dd><dt><span class="term"><span class="symbol">OptionalCmdFlags</span></span></dt><dd><p>Additional ssh-client command flags, which will be appended.</p></dd><dt><span class="term"><span class="symbol">SpawnAgent</span>=<em class="replaceable"><code>false</code></em>;</span></dt><dd><p>If enabled, apt-dater tries to spawn ssh-agent(1) if none is already running. ssh-add(1) will be called to load your private keys.</p></dd><dt><span class="term"><span class="symbol">AddKeys</span></span></dt><dd><p>List of private keys which should be loaded when apt-dater calls ssh-add(1).</p></dd></dl></div></div><div class="refsect2"><a name="idp43057200"></a><h3>Group '<span class="symbol">Commands</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">CmdRefresh</span>="<em class="replaceable"><code>apt-dater-host refresh</code></em>";</span></dt><dd><p>The command which will be used to refresh the status of the managed host.</p></dd><dt><span class="term"><span class="symbol">CmdUpgrade</span>="<em class="replaceable"><code>apt-dater-host upgrade</code></em>";</span></dt><dd><p>The command which will be used to intitate a upgrade of a managed host.</p></dd><dt><span class="term"><span class="symbol">CmdInstall</span>="<em class="replaceable"><code>apt-dater-host install %s</code></em>";</span></dt><dd><p>The command which will be used to update a single package. <em class="replaceable"><code>%s</code></em> will be replaced by the name of the package.</p></dd></dl></div></div><div class="refsect2"><a name="idp43065968"></a><h3>Group '<span class="symbol">Appearance</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">Colors</span></span></dt><dd><p>Set your own color style of the ui components. To highlight colors you can use the <em class="replaceable"><code>bright</code></em>* keyword.
14
 
          Example: Colors=menu brightgreen blue;status brightgreen blue;selector black red;</p>.
15
 
   <p>Components are:</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd></dl></div><p>Colors are:</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd><dt></dt><dd></dd></dl></div></dd></dl></div></div><div class="refsect2"><a name="idp48098944"></a><h3>Group '<span class="symbol">AutoRef</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">enabled</span>=<em class="replaceable"><code>true</code></em>;</span></dt><dd><p>Enabled the auto refresh feature if compiled in (see README.autoref).</p></dd></dl></div></div><div class="refsect2"><a name="idp48102656"></a><h3>Group '<span class="symbol">Notify</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">bell</span>=<em class="replaceable"><code>true</code></em>;</span></dt><dd><p>Enables user notification by terminal bell.</p></dd><dt><span class="term"><span class="symbol">flash</span>=<em class="replaceable"><code>true</code></em>;</span></dt><dd><p>Enables user notification by terminal flashing.</p></dd></dl></div></div><div class="refsect2"><a name="idp48108544"></a><h3>Group '<span class="symbol">History</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">ErrPattern</span>="<em class="replaceable"><code>((?&lt;!no )error|warning|fail)</code></em>";</span></dt><dd><p>
16
 
          A regular expression pattern to match the screen output. A match indicates
17
 
          the user should be asked to review the output (using less). (Optional)</p></dd><dt><span class="term"><span class="symbol">record</span>=<em class="replaceable"><code>true</code></em>;</span></dt><dd><p>Enables session recording using script(1). (Optional)</p></dd></dl></div></div><div class="refsect2"><a name="idp48114608"></a><h3>Group '<span class="symbol">Hooks</span>'</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="symbol">PreUpdate</span>="<em class="replaceable"><code>/etc/apt-dater/pre-upg.d</code></em>";, </span><span class="term"><span class="symbol">PreRefresh</span>="<em class="replaceable"><code>/etc/apt-dater/pre-ref.d</code></em>";, </span><span class="term"><span class="symbol">PreInstall</span>="<em class="replaceable"><code>/etc/apt-dater/pre-ins.d</code></em>";, </span><span class="term"><span class="symbol">PreConnect</span>="<em class="replaceable"><code>/etc/apt-dater/pre-con.d</code></em>";, </span><span class="term"><span class="symbol">PostUpdate</span>="<em class="replaceable"><code>/etc/apt-dater/post-upg.d</code></em>";, </span><span class="term"><span class="symbol">PostRefresh</span>="<em class="replaceable"><code>/etc/apt-dater/post-ref.d</code></em>";, </span><span class="term"><span class="symbol">PostInstall</span>="<em class="replaceable"><code>/etc/apt-dater/post-ins.d</code></em>";, </span><span class="term"><span class="symbol">PostConnect</span>="<em class="replaceable"><code>/etc/apt-dater/post-con.d</code></em>";</span></dt><dd><p>
18
 
            Hooks to be run before and after an action on a host is done.
19
 
            The values should be path names, any executable script within
20
 
            these directories will be run by <span class="command"><strong>run-parts</strong></span>(8).
21
 
          </p></dd></dl></div></div></div><div class="refsect1"><a name="idp48126432"></a><h2>STRING ESCAPES</h2><span class="command"><strong>apt-dater</strong></span>(8) provides an string escape mechanism. The escape character is '%'.
22
 
 
23
 
    <div class="table"><table>List of supported escapes.<thead><tr>
24
 
        <td>escape</td>
25
 
        <td>replaced by</td>
26
 
      </tr></thead><tbody><tr>
27
 
        <td>%</td>
28
 
        <td>escape character</td>
29
 
      </tr><tr>
30
 
        <td>h</td>
31
 
        <td>hostname</td>
32
 
      </tr><tr>
33
 
        <td>H</td>
34
 
        <td>SSH hostname used for connecting</td>
35
 
      </tr><tr>
36
 
        <td>m</td>
37
 
        <td>maintainer name</td>
38
 
      </tr><tr>
39
 
        <td>p</td>
40
 
        <td>SSH port number</td>
41
 
      </tr><tr>
42
 
        <td>u</td>
43
 
        <td>SSH username</td>
44
 
      </tr><tr>
45
 
        <td>U</td>
46
 
        <td>SSH username appended by '@', empty string if no SSH username is configured.</td>
47
 
      </tr></tbody></table></div></div><div class="refsect1"><a name="idp48138672"></a><h2>FILES</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>apt-dater.config</code></em></span></dt><dd><p>The configuration file of apt-dater.</p></dd><dt><span class="term"><em class="replaceable"><code>hosts.config</code></em></span></dt><dd><p>Contains all hosts you would like to manage.</p></dd></dl></div></div><div class="refsect1"><a name="idp48143152"></a><h2>SEE ALSO</h2><p>apt-dater(8), apt-get(1), debtrack, screen(1), script(1), ssh(1), <a class="ulink" href="http://www.freedesktop.org/Standards/basedir-spec" target="_top">XDG Base Directory Specification</a>, <a class="ulink" href="http://www.hyperrealm.com/libconfig/libconfig_manual.html" target="_top">libconfig documentation</a>.</p></div></div></body></html>