/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-08 18:18:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text.  Better text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2012-01-01">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-06">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2012</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
37
    <xi:include href="legalnotice.xml"/>
41
38
  </refentryinfo>
42
 
  
 
39
 
43
40
  <refmeta>
44
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
    <manvolnum>8mandos</manvolnum>
51
48
      Run Mandos plugins, pass data from first to succeed.
52
49
    </refpurpose>
53
50
  </refnamediv>
54
 
  
 
51
 
55
52
  <refsynopsisdiv>
56
53
    <cmdsynopsis>
57
54
      <command>&COMMANDNAME;</command>
58
55
      <group rep="repeat">
59
56
        <arg choice="plain"><option>--global-env=<replaceable
60
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
61
58
        >value</replaceable></option></arg>
62
59
        <arg choice="plain"><option>-G
63
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
64
61
        >value</replaceable> </option></arg>
65
62
      </group>
66
63
      <sbr/>
173
170
    <variablelist>
174
171
      <varlistentry>
175
172
        <term><option>--global-env
176
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
177
174
        >value</replaceable></option></term>
178
175
        <term><option>-G
179
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
180
177
        >value</replaceable></option></term>
181
178
        <listitem>
182
179
          <para>
250
247
          </para>
251
248
        </listitem>
252
249
      </varlistentry>
253
 
      
 
250
 
254
251
      <varlistentry>
255
252
        <term><option>--disable
256
253
        <replaceable>PLUGIN</replaceable></option></term>
261
258
            Disable the plugin named
262
259
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
263
260
            started.
264
 
          </para>
 
261
          </para>       
265
262
        </listitem>
266
263
      </varlistentry>
267
 
      
 
264
 
268
265
      <varlistentry>
269
266
        <term><option>--enable
270
267
        <replaceable>PLUGIN</replaceable></option></term>
279
276
          </para>
280
277
        </listitem>
281
278
      </varlistentry>
282
 
      
 
279
 
283
280
      <varlistentry>
284
281
        <term><option>--groupid
285
282
        <replaceable>ID</replaceable></option></term>
292
289
          </para>
293
290
        </listitem>
294
291
      </varlistentry>
295
 
      
 
292
 
296
293
      <varlistentry>
297
294
        <term><option>--userid
298
295
        <replaceable>ID</replaceable></option></term>
305
302
          </para>
306
303
        </listitem>
307
304
      </varlistentry>
308
 
      
 
305
 
309
306
      <varlistentry>
310
307
        <term><option>--plugin-dir
311
308
        <replaceable>DIRECTORY</replaceable></option></term>
368
365
          </para>
369
366
        </listitem>
370
367
      </varlistentry>
371
 
      
 
368
 
372
369
      <varlistentry>
373
370
        <term><option>--version</option></term>
374
371
        <term><option>-V</option></term>
380
377
      </varlistentry>
381
378
    </variablelist>
382
379
  </refsect1>
383
 
  
 
380
 
384
381
  <refsect1 id="overview">
385
382
    <title>OVERVIEW</title>
386
383
    <xi:include href="overview.xml"/>
406
403
      code will make this plugin-runner output the password from that
407
404
      plugin, stop any other plugins, and exit.
408
405
    </para>
409
 
    
 
406
 
410
407
    <refsect2 id="writing_plugins">
411
408
      <title>WRITING PLUGINS</title>
412
409
      <para>
580
577
      <para>
581
578
 
582
579
<!-- do not wrap this line -->
583
 
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
 
580
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
584
581
 
585
582
      </para>
586
583
    </informalexample>
618
615
  <refsect1 id="see_also">
619
616
    <title>SEE ALSO</title>
620
617
    <para>
621
 
      <citerefentry><refentrytitle>intro</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
618
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
624
619
      <manvolnum>8</manvolnum></citerefentry>,
625
620
      <citerefentry><refentrytitle>crypttab</refentrytitle>