<?xml version="1.0" encoding="UTF-8"?>
<refentry id="atalkd.conf.5">
  <refmeta>
    <refentrytitle>atalkd.conf</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo class="date">24 May 2024</refmiscinfo>

    <refmiscinfo class="source">Netatalk</refmiscinfo>
    <refmiscinfo class="manual">Netatalk AFP Fileserver Manual</refmiscinfo>
    <refmiscinfo class="version">@netatalk_version@</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>atalkd.conf</refname>

    <refpurpose>Configuration file used by <command>atalkd</command>(8) to
    configure the interfaces used by AppleTalk<indexterm>
        <primary>atalkd.conf</primary>
      </indexterm><indexterm>
        <primary>ALLMULTI</primary>

        <secondary>NIC multicast settings</secondary>
      </indexterm><indexterm>
        <primary>Phase</primary>

        <secondary>AppleTalk phase 1 or 2</secondary>
      </indexterm></refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>

    <para><emphasis remap="B">atalkd.conf</emphasis> is the configuration file
    used by atalkd to configure the Appletalk interfaces and their
    behavior</para>

    <para>Any line not prefixed with <emphasis remap="B">#</emphasis> is
    interpreted. Each interface has be configured on an uninterrupted line,
    with no support for split lines. The configuration line format is:</para>

    <para><emphasis remap="I">interface</emphasis> [ <option>-seed</option> ]
    [ <option>-phase</option> <replaceable>number</replaceable> ] [
    <option>-net</option> <replaceable>net-range</replaceable> ] [
    <option>-addr</option> <replaceable>address</replaceable> ] [
    <option>-zone</option> <replaceable>zonename</replaceable> ] ...</para>

    <para>The simplest case is to have either no atalkd.conf, or to have one
    that has no active lines. In this case, atalkd will auto-discover the
    local interfaces on the machine and write to the atalkd.conf file,
    creating it if one does not exist.</para>

    <para>The interface is the network interface that this to work over, such
    as <emphasis remap="B">eth0</emphasis> for Linux, or <emphasis
    remap="B">le0</emphasis> for Solaris.</para>

    <para>Note that all fields except the interface are optional. The loopback
    interface is configured automatically. If <option>-seed</option> is
    specified, all other fields must be present. Also,
    <command>atalkd</command> will exit during startup if a router disagrees
    with its seed information. If <option>-seed</option> is not given, all
    other information may be overridden during auto-configuration. If no
    <option>-phase</option> option is given, the default phase as given on the
    command line is used (the default is 2). If <option>-addr</option> is
    given and <option>-net</option> is not, a net-range of one is
    assumed.</para>

    <para>The first -zone directive for each interface is the ``default''
    zone. Under Phase 1, there is only one zone. Under Phase 2, all routers on
    the network are configured with the default zone and must agree.
    <command>atalkd</command> maps ``*'' to the default zone of the first
    interface. Note: The default zone for a machine is determined by the
    configuration of the local routers; to appear in a non-default zone, each
    service, e.g. <command>afpd</command>, must individually specify the
    desired zone. See also <citerefentry>
        <refentrytitle>nbp_name</refentrytitle>

        <manvolnum>3</manvolnum>
      </citerefentry>.</para>

    <para>The possible options and their meanings are:</para>

    <variablelist remap="TP">
      <varlistentry>
        <term><option>-addr
        <replaceable>net.node</replaceable></option></term>

        <listitem>
          <para>Allows specification of the net and node numbers for this
          interface, specified in AppleTalk numbering format (example:
          <option>-addr 66.6</option>).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-dontroute</option></term>

        <listitem>
          <para>Disables AppleTalk routing. It is the inverse of
          <option>-router</option>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-net first[-last]</option></term>

        <listitem>
          <para>Allows the available net to be set, optionally as a
          range.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-phase ( 1 | 2 )</option></term>

        <listitem>
          <para>Specifies the AppleTalk phase that this interface is to use
          (either Phase 1 or Phase 2).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-router</option></term>

        <listitem>
          <para>Seed an AppleTalk router on a single interface. The inverse
          option is <option>-dontroute</option>. Akin to
          <option>-seed</option>, but allows single interface routing.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-seed</option></term>

        <listitem>
          <para>Seed an AppleTalk router. This requires two or more interfaces
          to be configured. If you have a single network interface, use
          <option>-route</option> instead. It also causes all missing
          arguments to be automagically configured from the network.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-zone
        <replaceable>zonename</replaceable></option></term>

        <listitem>
          <para>Specifies a specific zone that this interface should appear on
          (example: <option>-zone "Parking Lot"</option>). Please note that
          zones with spaces and other special characters should be enclosed in
          quotation marks.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <para>Single interface on Solaris with auto-detected
    parameters.<programlisting>   le0</programlisting></para>

    <para>The same on Linux.<programlisting>   eth0</programlisting></para>

    <para>Below is an example configuration file from a Sun 4/40. The machine
    has two interfaces, ``le0'' and ``le1''. The ``le0'' interface is
    configured automatically from other routers on the network. The machine is
    the only router for the ``le1'' interface.</para>

    <para><programlisting>   le0
   le1 -seed -net 9461-9471 -zone netatalk -zone Argus</programlisting></para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para><citerefentry>
        <refentrytitle>atalkd</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry></para>
  </refsect1>

  <refsect1>
      <title>Author</title>

      <para>See <ulink url='https://netatalk.io/contributors'>CONTRIBUTORS</ulink></para>
  </refsect1>
</refentry>
