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

    <manvolnum>8</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</refname>

    <refpurpose>userland AppleTalk network manager daemon</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>atalkd<indexterm>
          <primary>atalkd</primary>
        </indexterm><indexterm>
          <primary>RTMP</primary>

          <secondary>Routing Table Maintenance Protocol</secondary>
        </indexterm><indexterm>
          <primary>NBP</primary>

          <secondary>Name Binding Protocol</secondary>
        </indexterm><indexterm>
          <primary>ZIP</primary>

          <secondary>Zone Information Protocol</secondary>
        </indexterm><indexterm>
          <primary>AEP</primary>

          <secondary>Apple Echo Protocol</secondary>
        </indexterm><indexterm>
          <primary>Phase</primary>

          <secondary>AppleTalk phase 1 or 2</secondary>
        </indexterm></command>

      <arg>-f <replaceable>configfile</replaceable></arg>

      <arg>-P <replaceable>pidfile</replaceable></arg>

      <arg>-1</arg>

      <arg>-2</arg>

      <arg>-d</arg>

      <arg>-t</arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>atalkd</command>

      <group>
        <arg choice="plain">-v</arg>

        <arg choice="plain">-V</arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>atalkd</command> is responsible for all user level
    AppleTalk network management. This includes routing, name registration and
    lookup, zone lookup, and the AppleTalk Echo Protocol (similar to
    <citerefentry>
        <refentrytitle>ping</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>). Specifically, this corresponds to the RTMP, NBP, ZIP,
    and AEP protocols in the AppleTalk protocol family.</para>

    <para>The init system of your OS will typically start the
    <command>atalkd</command> daemon at bootup. The daemon first reads from
    its configuration file, <filename>atalkd.conf</filename>. If there is no
    configuration file, or if no interfaces have been defined,
    <command>atalkd</command> will attempt to configure all available
    interfaces and will create a configuration file. See <citerefentry>
        <refentrytitle>atalkd.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry> for details on the configuration file format.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <variablelist>
      <varlistentry>
        <term>-1</term>

        <listitem>
          <para>Forces AppleTalk Phase 1.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-2</term>

        <listitem>
          <para>Forces AppleTalk Phase 2.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-d</term>

        <listitem>
          <para>Do not disassociate daemon from terminal. Writes some additional
          debugging information to stdout.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-f <replaceable>configfile</replaceable></term>

        <listitem>
          <para>Consult <replaceable>configfile</replaceable> instead of
          <filename>atalkd.conf</filename> for the configuration
          information.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-P <replaceable>pidfile</replaceable></term>

        <listitem>
          <para>Specifies the file in which <command>atalkd</command> stores
          its process id.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-t</term>

        <listitem>
          <para>Turns on transition routing.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-v | -V</term>

        <listitem>
          <para>Print version information and exit.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Routing</title>

    <para>If you are connecting an <command>atalkd</command> router to an
    existing AppleTalk network, you should first contact your local network
    administrators to obtain appropriate network addresses.</para>

    <para><command>atalkd</command> can provide routing between interfaces by
    configuring multiple interfaces. Each interface must be assigned a unique
    net-range<indexterm>
        <primary>net-range</primary>

        <secondary>AppleTalk net-range</secondary>
      </indexterm> between 1 and 65279 (0 and 65535 are illegal, and addresses
    between 65280 and 65534 are reserved for startup). It is best to choose
    the smallest useful net-range, i.e. if you have three machines on a LAN,
    choose a net-range below 1000. Each net-range may have an arbitrary list
    of zones associated with it.</para>

    <para>Note that <command>atalkd</command> automatically acts as a router
    if there is more than one interface, and no other configurations are
    present.</para>
  </refsect1>

  <refsect1>
    <title>Files</title>

    <para><filename>atalkd.conf</filename> configuration file</para>
  </refsect1>

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

    <para><citerefentry>
        <refentrytitle>atalkd.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry></para>
  </refsect1>

  <refsect1>
      <title>Author</title>

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