/mandos/trunk

<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "plugin-runner">
<!ENTITY TIMESTAMP "2008-08-31">
]>

<refentry>
  <refentryinfo>
    <title>Mandos Manual</title>
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
    <productname>Mandos</productname>
    <productnumber>&VERSION;</productnumber>
    <date>&TIMESTAMP;</date>
    <authorgroup>
      <author>
	<firstname>Björn</firstname>
	<surname>Påhlsson</surname>
	<address>
	  <email>belorn@fukt.bsnet.se</email>
	</address>
      </author>
      <author>
	<firstname>Teddy</firstname>
	<surname>Hogeborn</surname>
	<address>
	  <email>teddy@fukt.bsnet.se</email>
	</address>
      </author>
    </authorgroup>
    <copyright>
      <year>2008</year>
      <holder>Teddy Hogeborn</holder>
      <holder>Björn Påhlsson</holder>
    </copyright>
    <legalnotice>
      <para>
	This manual page is free software: 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.
      </para>

      <para>
	This manual page 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.
      </para>

      <para>
	You should have received a copy of the GNU General Public
	License along with this program; If not, see
	<ulink url="http://www.gnu.org/licenses/"/>.
      </para>
    </legalnotice>
  </refentryinfo>

  <refmeta>
    <refentrytitle>&COMMANDNAME;</refentrytitle>
    <manvolnum>8mandos</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname><command>&COMMANDNAME;</command></refname>
    <refpurpose>
      Run Mandos plugins.  Pass data from first succesful one.
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group rep="repeat">
	<arg choice="plain"><option>--global-envs=<replaceable
	>VAR</replaceable><literal>=</literal><replaceable
	>value</replaceable></option></arg>
	<arg choice="plain"><option>-e
	<replaceable>VAR</replaceable><literal>=</literal><replaceable
	>value</replaceable> </option></arg>
      </group>
      <sbr/>
      <group rep="repeat">
	<arg choice="plain"><option>--envs-for=<replaceable
	>PLUGIN</replaceable><literal>:</literal><replaceable
	>ENV</replaceable><literal>=</literal><replaceable
	>value</replaceable></option></arg>
	<arg choice="plain"><option>-f<replaceable>
	PLUGIN</replaceable><literal>:</literal><replaceable
	>ENV</replaceable><literal>=</literal><replaceable
	>value</replaceable> </option></arg>
      </group>
      <sbr/>
      <group rep="repeat">
	<arg choice="plain"><option>--global-options=<replaceable
	>OPTIONS</replaceable></option></arg>
	<arg choice="plain"><option>-g<replaceable>
	OPTIONS</replaceable> </option></arg>
      </group>
      <sbr/>
      <group rep="repeat">
	<arg choice="plain"><option>--options-for=<replaceable
	>PLUGIN</replaceable><literal>:</literal><replaceable
	>OPTIONS</replaceable></option></arg>
	<arg choice="plain"><option>-f<replaceable>
	PLUGIN</replaceable><literal>:</literal><replaceable
	>OPTIONS</replaceable> </option></arg>
      </group>
      <sbr/>
      <group rep="repeat">
	<arg choice="plain"><option>--disable=<replaceable
	>PLUGIN</replaceable></option></arg>
	<arg choice="plain"><option>-d
	<replaceable>PLUGIN</replaceable> </option></arg>
      </group>
      <sbr/>
      <arg><option>--groupid=<replaceable
      >ID</replaceable></option></arg>
      <sbr/>
      <arg><option>--userid=<replaceable
      >ID</replaceable></option></arg>
      <sbr/>
      <arg><option>--plugin-dir=<replaceable
      >DIRECTORY</replaceable></option></arg>
      <sbr/>
      <arg><option>--debug</option></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="req">
	<arg choice='plain'><option>--help</option></arg>
	<arg choice='plain'><option>-?</option></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'><option>--usage</option></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="req">
	<arg choice='plain'><option>--version</option></arg>
	<arg choice='plain'><option>-V</option></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>
      <command>&COMMANDNAME;</command> is a plugin runner that waits
      for any of its plugins to return sucessfull with a password, and
      passes it to cryptsetup as stdout message. This command is not
      meant to be invoked directly, but is instead meant to be run by
      cryptsetup by being specified in /etc/crypttab as a keyscript
      and subsequlently started in the initrd environment. See
      <citerefentry><refentrytitle>crypttab</refentrytitle>
      <manvolnum>5</manvolnum></citerefentry> for more information on
      keyscripts.
    </para>

    <para>
      plugins is looked for in the plugins directory which by default will be
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
	<term><option>--global-options
	<replaceable>OPTIONS</replaceable></option></term>
	<term><option>-g
	<replaceable>OPTIONS</replaceable></option></term>
	<listitem>
	  <para>
	    Global options given to all plugins as additional start
	    arguments.  Options are specified with a -o flag followed
	    by a comma separated string of options.
	  </para>	
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--options-for
	<replaceable>PLUGIN</replaceable><literal>:</literal
	><replaceable>OPTION</replaceable></option></term>
	<term><option>-o
	<replaceable>PLUGIN</replaceable><literal>:</literal
	><replaceable>OPTION</replaceable></option></term>
	<listitem>
	  <para>
	    Plugin specific options given to the plugin as additional
	    start arguments.  Options are specified with a -o flag
	    followed by a comma separated string of options.
	  </para>	
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option> --disable
	<replaceable>PLUGIN</replaceable></option></term>
	<term><option>-d
	<replaceable>PLUGIN</replaceable></option></term>
	<listitem>
	  <para>
	    Disable a specific plugin
	  </para>	
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--groupid
	<replaceable>ID</replaceable></option></term>
	<listitem>
	  <para>
	    Group ID the plugins will run as
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--userid
	<replaceable>ID</replaceable></option></term>
	<listitem>
	  <para>
	    User ID the plugins will run as
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--plugin-dir
	<replaceable>DIRECTORY</replaceable></option></term>
	<listitem>
	  <para>
	    Specify a different plugin directory
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--debug</option></term>
	<listitem>
	  <para>
	    Debug mode
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--help</option></term>
	<term><option>-?</option></term>
	<listitem>
	  <para>
	    Gives a help message
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--usage</option></term>
	<listitem>
	  <para>
	    Gives a short usage message
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--version</option></term>
	<term><option>-V</option></term>
	<listitem>
	  <para>
	    Prints the program version
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="exit_status">
    <title>EXIT STATUS</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="file">
    <title>FILES</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="notes">
    <title>NOTES</title>
    <para>
    </para>
  </refsect1>
  
  <refsect1 id="bugs">
    <title>BUGS</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="examples">
    <title>EXAMPLE</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="security">
    <title>SECURITY</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
      <manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>mandos</refentrytitle>
      <manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
      <manvolnum>8mandos</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>password-request</refentrytitle>
      <manvolnum>8mandos</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>
<!-- Local Variables: -->
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
<!-- time-stamp-end: "[\"']>" -->
<!-- time-stamp-format: "%:y-%02m-%02d" -->
<!-- End: -->