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

    <manvolnum>1</manvolnum>

    <refmiscinfo class="date">24 June 2004</refmiscinfo>

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

  <refnamediv>
	<refname>nbp</refname>

    <refname>nbplkup</refname>

    <refname>nbprgstr</refname>

    <refname>nbpunrgstr</refname>

    <refpurpose>access NBP database</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>nbplkup<indexterm><primary>nbp</primary></indexterm><indexterm><primary>nbplkup</primary></indexterm> </command>

      <arg>-r <replaceable>maxresponses</replaceable></arg>

      <arg>-A <replaceable>address</replaceable></arg>

      <arg>-m <replaceable>maccodepage</replaceable></arg>

      <arg><replaceable>nbpname</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>nbprgstr<indexterm><primary>nbprgstr</primary></indexterm> </command>

      <arg>-A <replaceable>address</replaceable></arg>

      <arg>-p <replaceable>port</replaceable></arg>

      <arg>-m <replaceable>maccodepage</replaceable></arg>

      <arg><replaceable>nbpname</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>nbpunrgstr<indexterm><primary>nbpunrgstr</primary></indexterm> </command>

      <arg>-A <replaceable>address</replaceable></arg>

      <arg>-m <replaceable>maccodepage</replaceable></arg>

      <arg><replaceable>nbpname</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>nbprgstr</command> registers <replaceable>nbpname</replaceable>
    with <citerefentry><refentrytitle>atalkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
    at the given <replaceable>port</replaceable>. <command>nbpunrgstr</command>
    informs <emphasis remap="B">atalkd</emphasis> that
    <replaceable>nbpname</replaceable> is no longer to be advertised.</para>

    <para><command>nbplkup</command> displays up to
    <replaceable>maxresponses</replaceable> (default 1000) entities registered
    on the AppleTalk internet. <emphasis remap="I"><replaceable>nbpname</replaceable></emphasis>
    is parsed by <citerefentry><refentrytitle>nbp_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
    An `<emphasis remap="B">=</emphasis>&#39; for the <emphasis remap="I">object</emphasis>
    or <emphasis remap="I">type</emphasis> matches anything, and an `<emphasis
    remap="B">*</emphasis>&#39; for <emphasis remap="I">zone</emphasis> means
    the local zone. The default values are taken from the <emphasis remap="B">NBPLKUP</emphasis>
    environment variable, parsed as an <replaceable>nbpname</replaceable>.</para>
  </refsect1>

  <refsect1>
    <title>Environment Variables</title>

    <variablelist>
      <varlistentry>
        <term>NBPLKUP</term>

        <listitem>
          <para>default nbpname for nbplkup</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ATALK_MAC_CHARSET</term>

        <listitem>
          <para>the codepage used by the clients on the Appletalk network</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ATALK_UNIX_CHARSET</term>

        <listitem>
          <para>the codepage used to display extended characters on this
          shell.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Example</title>

    <para>Find all devices of type <emphasis remap="B">LaserWriter</emphasis>
    in the local zone.</para>

    <screen><prompt>example%</prompt> <userinput>nbplkup :LaserWriter</userinput>
<computeroutput> <computeroutput>              Petoskey:LaserWriter        7942.129:218
             Gloucester:LaserWriter        8200.188:186
                 Rahway:LaserWriter        7942.2:138
             517 Center:LaserWriter        7942.2:132
                  ionia:LaserWriter        7942.2:136
     Evil DEC from Hell:LaserWriter        7942.2:130
              Hamtramck:LaserWriter        7942.2:134
         Iron Mountain :LaserWriter        7942.128:250</computeroutput></computeroutput>
<prompt>example%</prompt>
</screen>
  </refsect1>

  <refsect1>
    <title>See also</title>

    <para><citerefentry><refentrytitle>nbp_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    <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>
