debian/exim4-localscan-plugin-config.1.xml

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   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   <!ENTITY dhfirstname "<firstname>Magnus</firstname>">
   6   <!ENTITY dhsurname   "<surname>Holmgren</surname>">
   7   <!-- Please adjust the date whenever revising the manpage. -->
   8   <!ENTITY dhdate      "<date>2007-06-08</date>">
   9   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  10   <!ENTITY dhemail     "<email>magnus@kibibyte.se</email>">
  11   <!ENTITY dhusername  "Magnus Holmgren">
  12   <!ENTITY dhucpackage "<refentrytitle>EXIM4-LOCALSCAN-PLUGIN-CONFIG</refentrytitle>">
  13   <!ENTITY dhpackage   "exim4-localscan-plugin-config">
  14
  15   <!ENTITY debian      "<productname>Debian</productname>">
  16 ]>
  17
  18 <refentry>
  19   <refentryinfo>
  20     <productname>exim4</productname>
  21     <address>
  22       &dhemail;
  23     </address>
  24     <copyright>
  25       <year>2007</year>
  26       <holder>&dhusername;</holder>
  27     </copyright>
  28     <legalnotice>
  29       <para>
  30         This manual page was written by &dhusername; for
  31         the &debian; system (but may be used by others).  Permission is
  32         granted to copy, distribute and/or modify this document without
  33         any restrictions whatsoever.
  34       </para>
  35     </legalnotice>
  36     &dhdate;
  37   </refentryinfo>
  38   <refmeta>
  39     &dhucpackage;
  40     &dhsection;
  41   </refmeta>
  42   <refnamediv>
  43     <refname>&dhpackage;</refname>
  44     <refpurpose>get information necessary to build and package exim4
  45      plugins</refpurpose>
  46   </refnamediv>
  47   <refsynopsisdiv>
  48     <cmdsynopsis>
  49       <command>&dhpackage;</command>
  50       <arg choice="plain"><option>--localscan-abiversion</option></arg>
  51     </cmdsynopsis>
  52   </refsynopsisdiv>
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para><command>&dhpackage;</command> is a tool that is used to determine
  57     various things needed to build plugins (shared libraries) for the
  58     Exim MTA. Currently there is one such plugin API - the
  59     <function>local_scan</function> API. In addition to local_scan plugins,
  60     this API is also available to shared libraries used with the
  61     ${dlfunc ...} expansion item.</para>
  62   </refsect1>
  63   <refsect1>
  64     <title>Options</title>
  65     <para>Since <command>&dhpackage;</command> is &debian;-specific,
  66     it currently takes a single mandatory option parameter,
  67     <option>--localscan-apiversion</option>, outputting the API/ABI
  68     version (<replaceable role="variable">ver</replaceable>).
  69     Packages containing local_scan plugins should depend on
  70     exim4-localscanapi-<replaceable role="variable">ver</replaceable></para>
  71   </refsect1>
  72   <refsect1>
  73     <title>See also</title>
  74     <simplelist type="inline">
  75       <member><citerefentry>
  76         <refentrytitle>exim4</refentrytitle>
  77         <manvolnum>8</manvolnum>
  78       </citerefentry></member>
  79       <member>Chapter 42 of the Exim specification</member>
  80     </simplelist>
  81   </refsect1>
  82 </refentry>