← 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.xml

  • 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.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4
 
 
5
 
<!--
6
 
 
7
 
Process this file with an XSLT processor: `xsltproc \
8
 
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
9
 
manpages/docbook.xsl manpage.dbk'.  A manual page
10
 
<package>.<section> will be generated.  You may view the
11
 
manual page with: nroff -man <package>.<section> | less'.  A
12
 
typical entry in a Makefile or Makefile.am is:
13
 
 
14
 
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
15
 
manpages/docbook.xsl
16
 
XP=xsltproc -''-nonet
17
 
 
18
 
manpage.1: manpage.dbk
19
 
        $(XP) $(DB2MAN) $<
20
 
    
21
 
The xsltproc binary is found in the xsltproc package.  The
22
 
XSL files are in docbook-xsl.  Please remember that if you
23
 
create the nroff version in one of the debian/rules file
24
 
targets (such as build), you will need to include xsltproc
25
 
and docbook-xsl in your Build-Depends control field.
26
 
 
27
 
-->
28
 
 
29
 
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
30
 
  <!ENTITY dhfirstname "<firstname>Thomas</firstname>">
31
 
  <!ENTITY dhsurname   "<surname>Liske</surname>">
32
 
  <!-- Please adjust the date whenever revising the manpage. -->
33
 
  <!ENTITY dhdate      "<date>October 22, 2014</date>">
34
 
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
35
 
       allowed: see man(7), man(1). -->
36
 
  <!ENTITY dhsection   "<manvolnum>5</manvolnum>">
37
 
  <!ENTITY dhemail     "<email>lliske@ibh.de</email>">
38
 
  <!ENTITY dhusername  "Thomas Liske">
39
 
  <!ENTITY dhucpackage "<refentrytitle>APT-DATER</refentrytitle>">
40
 
  <!ENTITY dhpackage   "apt-dater">
41
 
 
42
 
  <!ENTITY debian      "<productname>Debian</productname>">
43
 
  <!ENTITY gnu         "<acronym>GNU</acronym>">
44
 
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
45
 
]>
46
 
 
47
 
<refentry class="manual">
48
 
  <info>
49
 
    <productname>apt-dater</productname>
50
 
    <author>
51
 
      <personname>Thomas Liske</personname>
52
 
      <email>liske@ibh.de</email>
53
 
      <contrib>maintainer</contrib>
54
 
    </author>
55
 
  </info>
56
 
  <refentryinfo>
57
 
    <copyright>
58
 
      <year>2008-2014</year>
59
 
      <holder>IBH IT-Service GmbH [<ulink url="https://www.ibh.de/">https://www.ibh.de/</ulink>]</holder>
60
 
    </copyright>
61
 
    &dhdate;
62
 
    <authorgroup>
63
 
      <othercredit>
64
 
        <firstname>Andre</firstname>
65
 
        <surname>Ellguth</surname>
66
 
        <contrib>ex-maintainer</contrib>
67
 
      </othercredit>
68
 
    </authorgroup>
69
 
  </refentryinfo>
70
 
  <refmeta>
71
 
    <refmiscinfo class="source">apt-dater</refmiscinfo>
72
 
    <refmiscinfo class="manual">Config File Manual</refmiscinfo>
73
 
    &dhucpackage;
74
 
 
75
 
    &dhsection;
76
 
  </refmeta>
77
 
  <refnamediv>
78
 
    <refname>&dhpackage;.config</refname>
79
 
 
80
 
    <refpurpose>configuration file of &dhpackage;(8)</refpurpose>
81
 
  </refnamediv>
82
 
  <refsynopsisdiv>
83
 
    <variablelist>
84
 
      <varlistentry>
85
 
        <listitem>
86
 
          <para><symbol>Group</symbol>:
87
 
{
88
 
          </para>
89
 
        </listitem>
90
 
      </varlistentry>
91
 
      <varlistentry>
92
 
        <listitem>
93
 
          <para><symbol>parameter</symbol>=<replaceable>value</replaceable>;</para>
94
 
        </listitem>
95
 
      </varlistentry>
96
 
      <varlistentry>
97
 
        <listitem>
98
 
          <para>}</para>
99
 
        </listitem>
100
 
      </varlistentry>
101
 
    </variablelist>
102
 
  </refsynopsisdiv>
103
 
  <refsect1>
104
 
    <title>DESCRIPTION</title>
105
 
 
106
 
    <para>The file <replaceable>&dhpackage;.config</replaceable> is the
107
 
      configuration file for <command>&dhpackage;</command>(8).
108
 
      <command>&dhpackage;</command>(8) is a program to manage package updats 
109
 
      on a large number of remote hosts using SSH.
110
 
      This man page descripes briefly the parameters of the file
111
 
      <replaceable>&dhpackage;.config</replaceable>. 
112
 
      The default location of this file is <replaceable>$XDG_CONFIG_HOME/apt-dater/apt-dater.config</replaceable>.
113
 
    </para>
114
 
    <para>
115
 
      The configuration file is parsed using libconfig. Please be aware that config statements are case sensitive.
116
 
      Look at libconfig's documentation for more details about the required file syntax.
117
 
    </para>
118
 
  </refsect1>
119
 
  <refsect1>
120
 
    <title>OPTIONS</title>
121
 
 
122
 
    <refsect2>
123
 
        <title>Group '<symbol>Paths</symbol>'</title>
124
 
 
125
 
    <variablelist>
126
 
      <varlistentry>
127
 
        <term><symbol>HostsFile</symbol>="<replaceable>$XDG_CONFIG_HOME/apt-dater/hosts.config</replaceable>";</term>
128
 
        <listitem>
129
 
          <para>The location of the file contains all host which will be managed with <command>&dhpackage;</command>. (optional)</para>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
      <varlistentry>
133
 
        <term><symbol>StatsDir</symbol>="<replaceable>$XDG_DATA_HOME/apt-dater</replaceable>";</term>
134
 
        <listitem>
135
 
          <para>The location of the directory which contains the status files of any host. (optional)</para>
136
 
        </listitem>
137
 
      </varlistentry>
138
 
    </variablelist>
139
 
    </refsect2>
140
 
 
141
 
    <refsect2>
142
 
        <title>Group '<symbol>Screen</symbol>'</title>
143
 
 
144
 
    <variablelist>
145
 
      <varlistentry>
146
 
        <term><symbol>RCFile</symbol>="<replaceable>$XDG_CONFIG_HOME/apt-dater/screenrc</replaceable>";</term>
147
 
        <listitem>
148
 
          <para>Location of screen(1) config file. (optional)</para>
149
 
        </listitem>
150
 
      </varlistentry>
151
 
      <varlistentry>
152
 
        <term><symbol>Title</symbol>="<replaceable>%m # %u@%h:%p</replaceable>";</term>
153
 
        <listitem>
154
 
          <para>Template for screen titles using string escapes. (optional)</para>
155
 
        </listitem>
156
 
      </varlistentry>
157
 
      <varlistentry>
158
 
        <term><symbol>NoDumps</symbol>=<replaceable>false</replaceable>;</term>
159
 
        <listitem>
160
 
          <para>Enables/disables support of screen dumps. (optional)</para>
161
 
        </listitem>
162
 
      </varlistentry>
163
 
      <varlistentry>
164
 
        <term><symbol>QueryMaintainer</symbol>=<replaceable>0</replaceable>;</term>
165
 
        <listitem>
166
 
          <para>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.</para>
167
 
        </listitem>
168
 
      </varlistentry>
169
 
    </variablelist>
170
 
    </refsect2>
171
 
 
172
 
    <refsect2>
173
 
        <title>Group '<symbol>SSH</symbol>'</title>
174
 
 
175
 
    <variablelist>
176
 
      <varlistentry>
177
 
        <term><symbol>Cmd</symbol>="<replaceable>/usr/bin/ssh</replaceable>";</term>
178
 
        <listitem>
179
 
          <para>The location of ssh-client binary.</para>
180
 
        </listitem>
181
 
      </varlistentry>
182
 
      <varlistentry>
183
 
        <term><symbol>SFTPCmd</symbol></term>
184
 
        <listitem>
185
 
          <para>The command to initiate sftp file transfer e.g. <command>/usr/bin/sftp</command></para>
186
 
        </listitem>
187
 
      </varlistentry>
188
 
      <varlistentry>
189
 
        <term><symbol>OptionalCmdFlags</symbol></term>
190
 
        <listitem>
191
 
          <para>Additional ssh-client command flags, which will be appended.</para>
192
 
        </listitem>
193
 
      </varlistentry>
194
 
      <varlistentry>
195
 
        <term><symbol>SpawnAgent</symbol>=<replaceable>false</replaceable>;</term>
196
 
        <listitem>
197
 
          <para>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.</para>
198
 
        </listitem>
199
 
      </varlistentry>
200
 
      <varlistentry>
201
 
        <term><symbol>AddKeys</symbol></term>
202
 
        <listitem>
203
 
          <para>List of private keys which should be loaded when apt-dater calls ssh-add(1).</para>
204
 
        </listitem>
205
 
      </varlistentry>
206
 
    </variablelist>
207
 
    </refsect2>
208
 
 
209
 
    <refsect2>
210
 
        <title>Group '<symbol>Commands</symbol>'</title>
211
 
    
212
 
    <variablelist>
213
 
      <varlistentry>
214
 
        <term><symbol>CmdRefresh</symbol>="<replaceable>apt-dater-host refresh</replaceable>";</term>
215
 
        <listitem>
216
 
          <para>The command which will be used to refresh the status of the managed host.</para>
217
 
        </listitem>
218
 
      </varlistentry>
219
 
      <varlistentry>
220
 
        <term><symbol>CmdUpgrade</symbol>="<replaceable>apt-dater-host upgrade</replaceable>";</term>
221
 
        <listitem>
222
 
          <para>The command which will be used to intitate a upgrade of a managed host.</para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      <varlistentry>
226
 
        <term><symbol>CmdInstall</symbol>="<replaceable>apt-dater-host install %s</replaceable>";</term>
227
 
        <listitem>
228
 
          <para>The command which will be used to update a single package. <replaceable>%s</replaceable> will be replaced by the name of the package.</para>
229
 
        </listitem>
230
 
      </varlistentry>
231
 
    </variablelist>
232
 
    </refsect2>
233
 
 
234
 
    <refsect2>
235
 
        <title>Group '<symbol>Appearance</symbol>'</title>
236
 
 
237
 
    <variablelist>
238
 
      <varlistentry>
239
 
        <term><symbol>Colors</symbol></term>
240
 
        <listitem>
241
 
          <para>Set your own color style of the ui components. To highlight colors you can use the <replaceable>bright</replaceable>* keyword.
242
 
          Example: Colors=menu brightgreen blue;status brightgreen blue;selector black red;</para>.
243
 
   <para>Components are:</para>
244
 
          <variablelist>
245
 
            <varlistentry><para><symbol>default</symbol></para></varlistentry>
246
 
            <varlistentry><para><symbol>menu</symbol></para></varlistentry>
247
 
            <varlistentry><para><symbol>status</symbol></para></varlistentry>
248
 
            <varlistentry><para><symbol>selector</symbol></para></varlistentry>
249
 
            <varlistentry><para><symbol>hoststatus</symbol></para></varlistentry>
250
 
            <varlistentry><para><symbol>query</symbol></para></varlistentry>
251
 
            <varlistentry><para><symbol>input</symbol></para></varlistentry>
252
 
          </variablelist>
253
 
 
254
 
          <para>Colors are:</para>
255
 
          <variablelist>
256
 
            <varlistentry><para><constant>default</constant></para></varlistentry>
257
 
            <varlistentry><para><constant>black</constant></para></varlistentry>
258
 
            <varlistentry><para><constant>cyan</constant></para></varlistentry>
259
 
            <varlistentry><para><constant>green</constant></para></varlistentry>
260
 
            <varlistentry><para><constant>magenta</constant></para></varlistentry>
261
 
            <varlistentry><para><constant>red</constant></para></varlistentry>
262
 
            <varlistentry><para><constant>white</constant></para></varlistentry>
263
 
            <varlistentry><para><constant>yellow</constant></para></varlistentry>
264
 
          </variablelist>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
    </variablelist>
268
 
    </refsect2>
269
 
 
270
 
    <refsect2>
271
 
        <title>Group '<symbol>AutoRef</symbol>'</title>
272
 
 
273
 
    <variablelist>
274
 
      <varlistentry>
275
 
        <term><symbol>enabled</symbol>=<replaceable>true</replaceable>;</term>
276
 
        <listitem>
277
 
          <para>Enabled the auto refresh feature if compiled in (see README.autoref).</para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
    </variablelist>
281
 
    </refsect2>
282
 
 
283
 
    <refsect2>
284
 
        <title>Group '<symbol>Notify</symbol>'</title>
285
 
 
286
 
    <variablelist>
287
 
      <varlistentry>
288
 
        <term><symbol>bell</symbol>=<replaceable>true</replaceable>;</term>
289
 
        <listitem>
290
 
          <para>Enables user notification by terminal bell.</para>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
 
294
 
      <varlistentry>
295
 
        <term><symbol>flash</symbol>=<replaceable>true</replaceable>;</term>
296
 
        <listitem>
297
 
          <para>Enables user notification by terminal flashing.</para>
298
 
        </listitem>
299
 
      </varlistentry>
300
 
    </variablelist>
301
 
    </refsect2>
302
 
 
303
 
    <refsect2>
304
 
        <title>Group '<symbol>History</symbol>'</title>
305
 
 
306
 
    <variablelist>
307
 
      <varlistentry>
308
 
        <term><symbol>ErrPattern</symbol>="<replaceable>((?&lt;!no )error|warning|fail)</replaceable>";</term>
309
 
        <listitem>
310
 
          <para>
311
 
          A regular expression pattern to match the screen output. A match indicates
312
 
          the user should be asked to review the output (using less). (Optional)</para>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
 
316
 
      <varlistentry>
317
 
        <term><symbol>record</symbol>=<replaceable>true</replaceable>;</term>
318
 
        <listitem>
319
 
          <para>Enables session recording using script(1). (Optional)</para>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
    </variablelist>
323
 
    </refsect2>
324
 
 
325
 
    <refsect2>
326
 
        <title>Group '<symbol>Hooks</symbol>'</title>
327
 
 
328
 
    <variablelist>
329
 
      <varlistentry>
330
 
        <term><symbol>PreUpdate</symbol>="<replaceable>/etc/apt-dater/pre-upg.d</replaceable>";</term>
331
 
        <term><symbol>PreRefresh</symbol>="<replaceable>/etc/apt-dater/pre-ref.d</replaceable>";</term>
332
 
        <term><symbol>PreInstall</symbol>="<replaceable>/etc/apt-dater/pre-ins.d</replaceable>";</term>
333
 
        <term><symbol>PreConnect</symbol>="<replaceable>/etc/apt-dater/pre-con.d</replaceable>";</term>
334
 
        <term><symbol>PostUpdate</symbol>="<replaceable>/etc/apt-dater/post-upg.d</replaceable>";</term>
335
 
        <term><symbol>PostRefresh</symbol>="<replaceable>/etc/apt-dater/post-ref.d</replaceable>";</term>
336
 
        <term><symbol>PostInstall</symbol>="<replaceable>/etc/apt-dater/post-ins.d</replaceable>";</term>
337
 
        <term><symbol>PostConnect</symbol>="<replaceable>/etc/apt-dater/post-con.d</replaceable>";</term>
338
 
        <listitem>
339
 
          <para>
340
 
            Hooks to be run before and after an action on a host is done.
341
 
            The values should be path names, any executable script within
342
 
            these directories will be run by <command>run-parts</command>(8).
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
 
    </variablelist>
347
 
    </refsect2>
348
 
  </refsect1>
349
 
 
350
 
  <refsect1>
351
 
    <title>STRING ESCAPES</title>
352
 
 
353
 
    <command>&dhpackage;</command>(8) provides an string escape mechanism. The escape character is '%'.
354
 
 
355
 
    <table>
356
 
      <title>List of supported escapes.</title>
357
 
      <thead>
358
 
      <tr>
359
 
        <td>escape</td>
360
 
        <td>replaced by</td>
361
 
      </tr>
362
 
      </thead>
363
 
      <tbody>
364
 
      <tr>
365
 
        <td>%</td>
366
 
        <td>escape character</td>
367
 
      </tr>
368
 
      <tr>
369
 
        <td>h</td>
370
 
        <td>hostname</td>
371
 
      </tr>
372
 
      <tr>
373
 
        <td>H</td>
374
 
        <td>SSH hostname used for connecting</td>
375
 
      </tr>
376
 
      <tr>
377
 
        <td>m</td>
378
 
        <td>maintainer name</td>
379
 
      </tr>
380
 
      <tr>
381
 
        <td>p</td>
382
 
        <td>SSH port number</td>
383
 
      </tr>
384
 
      <tr>
385
 
        <td>u</td>
386
 
        <td>SSH username</td>
387
 
      </tr>
388
 
      <tr>
389
 
        <td>U</td>
390
 
        <td>SSH username appended by '@', empty string if no SSH username is configured.</td>
391
 
      </tr>
392
 
      </tbody>
393
 
    </table>
394
 
  </refsect1>
395
 
 
396
 
  <refsect1>
397
 
    <title>FILES</title>
398
 
 
399
 
    <variablelist>
400
 
      <varlistentry>
401
 
        <term><replaceable>apt-dater.config</replaceable></term>
402
 
        <listitem>
403
 
          <para>The configuration file of apt-dater.</para>
404
 
        </listitem>
405
 
      </varlistentry>
406
 
      <varlistentry>
407
 
        <term><replaceable>hosts.config</replaceable></term>
408
 
        <listitem>
409
 
          <para>Contains all hosts you would like to manage.</para>
410
 
        </listitem>
411
 
      </varlistentry>
412
 
    </variablelist>
413
 
  </refsect1>
414
 
  <refsect1>
415
 
    <title>SEE ALSO</title>
416
 
        
417
 
    <para>apt-dater(8), apt-get(1), debtrack, screen(1), script(1), ssh(1), <ulink url="http://www.freedesktop.org/Standards/basedir-spec">XDG Base Directory Specification</ulink>, <ulink url="http://www.hyperrealm.com/libconfig/libconfig_manual.html">libconfig documentation</ulink>.</para>
418
 
  </refsect1>
419
 
</refentry>