summaryrefslogtreecommitdiffstats
path: root/debian/exim4-localscan-plugin-config.1.xml
blob: c7e9ef1debdb01d888628821f420edad7f879378 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

  <!ENTITY dhfirstname "<firstname>Magnus</firstname>">
  <!ENTITY dhsurname   "<surname>Holmgren</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>2007-06-08</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>magnus@kibibyte.se</email>">
  <!ENTITY dhusername  "Magnus Holmgren">
  <!ENTITY dhucpackage "<refentrytitle>EXIM4-LOCALSCAN-PLUGIN-CONFIG</refentrytitle>">
  <!ENTITY dhpackage   "exim4-localscan-plugin-config">

  <!ENTITY debian      "<productname>Debian</productname>">
]>

<refentry>
  <refentryinfo>
    <productname>exim4</productname>
    <address>
      &dhemail;
    </address>
    <copyright>
      <year>2007</year>
      <holder>&dhusername;</holder>
    </copyright>
    <legalnotice>
      <para>
        This manual page was written by &dhusername; for
        the &debian; system (but may be used by others).  Permission is
        granted to copy, distribute and/or modify this document without
        any restrictions whatsoever.
      </para>
    </legalnotice>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>get information necessary to build and package exim4
     plugins</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg choice="plain"><option>--localscan-abiversion</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>

    <para><command>&dhpackage;</command> is a tool that is used to determine
    various things needed to build plugins (shared libraries) for the 
    Exim MTA. Currently there is one such plugin API - the 
    <function>local_scan</function> API. In addition to local_scan plugins,
    this API is also available to shared libraries used with the 
    ${dlfunc ...} expansion item.</para>
  </refsect1>
  <refsect1>
    <title>Options</title>
    <para>Since <command>&dhpackage;</command> is &debian;-specific,
    it currently takes a single mandatory option parameter,
    <option>--localscan-apiversion</option>, outputting the API/ABI 
    version (<replaceable role="variable">ver</replaceable>). 
    Packages containing local_scan plugins should depend on 
    exim4-localscanapi-<replaceable role="variable">ver</replaceable></para>
  </refsect1>
  <refsect1>
    <title>See also</title>
    <simplelist type="inline">
      <member><citerefentry>
        <refentrytitle>exim4</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry></member>
      <member>Chapter 42 of the Exim specification</member>
    </simplelist>
  </refsect1>
</refentry>