source: archive/tin.xml@ 54bd123

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY tin-download-http "http://gd.tuwien.ac.at/infosys/newsreaders/tin/v1.8/tin-&tin-version;.tar.bz2">
  <!ENTITY tin-download-ftp  "ftp://ftp.tin.org/pub/news/clients/tin/v1.8/tin-&tin-version;.tar.bz2">
  <!ENTITY tin-md5sum        "e6ed45205020665c097556822b0d575b">
  <!ENTITY tin-size          "1.4 MB">
  <!ENTITY tin-buildsize     "12.4 MB">
  <!ENTITY tin-time          "0.4 SBU">
]>

<sect1 id="tin" xreflabel="tin-&tin-version;">
  <?dbhtml filename="tin.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>TIN-&tin-version;</title>

  <indexterm zone="tin">
    <primary sortas="a-TIN">TIN</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to TIN</title>

    <para><application>TIN</application> is a threaded NNTP and spool based
    console-mode UseNet newsreader. It supports threading, scoring,
    different charsets, and many other useful things. It has also support for
    different languages.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Download (HTTP): <ulink url="&tin-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&tin-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &tin-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &tin-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &tin-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &tin-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">TIN Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="pcre"/>,
    <xref linkend="libidn"/>,
    an <xref linkend="server-mail"/> that provides the
    <command>sendmail</command> command or <xref linkend="mailx"/>,
    <xref linkend="gnupg"/>,
    <!-- a spell checker (<xref linkend="ispell"/> or <xref linkend="aspell"/>), -->
    <xref linkend="aspell"/>,
    <ulink url="http://www.isc.org/index.pl?/sw/inn/">INN</ulink>,
    <ulink url="http://www.fpx.de/fp/Software/UUDeview/">UUDeview</ulink>,
    <ulink url="http://www.inet.no/dante/">Socks</ulink>,
    <ulink
    url="http://ftp4.de.freesbie.org/pub/misc/metamail/mm2.7.tar.Z">Metamail</ulink>,
    and
    <ulink url="http://dmalloc.com/">Dmalloc</ulink>
    or
    <ulink url="ftp://invisible-island.net/dbmalloc/">dbmalloc</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/Tin"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of TIN</title>

    <para>Install <application>TIN</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --with-screen=ncursesw \
    --enable-nntp-only --disable-printing &amp;&amp;
make build</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install &amp;&amp;
make install_sysdefs &amp;&amp;
rm -vf doc/*.? &amp;&amp;
install -v -m755 -d /usr/share/doc/tin-&tin-version; &amp;&amp;
install -v -m644 doc/* /usr/share/doc/tin-&tin-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--with-screen=ncursesw</parameter>: This switch forces
    the use of wide-character functions from the ncursesw library (for UTF-8
    and Asian languages support).</para>

    <para><parameter>--enable-nntp-only</parameter>: Reading news from a local
    spool is disabled with this switch.  Don't use this if you have installed
    INN and want to use its spool.</para>

    <para><parameter>--disable-printing</parameter>: This switch disables
    printing since <application>TIN</application> cannot send non-ASCII text
    to the printer correctly. Remove this switch if you can tolerate this
    limitation.</para>

    <para><parameter>--with-editor</parameter>: This switch sets the default
    editor used by <application>TIN</application>.  The default is
    <command>vi</command>.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring TIN</title>

    <sect3 id="tin-config">
      <title>Config Files</title>

      <para><filename>/etc/tin/tinrc</filename>,
      <filename>~/.tin/tinrc</filename>,
      <filename>~/.newsrc</filename>,
      <filename>/etc/tin/tin.defaults</filename>,
      <filename>/etc/tin/mime.types</filename>,
      <filename>/etc/tin/keymap</filename> and
      <filename>/etc/mailcap</filename></para>

      <indexterm zone="tin tin-config">
        <primary sortas="e-etc-tinrc">/etc/tin/tinrc</primary>
      </indexterm>

      <indexterm zone="tin tin-config">
        <primary sortas="e-AA.tinrc">~/.tin/tinrc</primary>
      </indexterm>

      <indexterm zone="tin tin-config">
        <primary sortas="e-AA.newsrc">~/.newsrc</primary>
      </indexterm>

      <indexterm zone="tin tin-config">
        <primary sortas="e-etc-tindefaults">/etc/tin/tin.defaults</primary>
      </indexterm>

      <indexterm zone="tin tin-config">
        <primary sortas="e-etc-tinkeymap">/etc/tin/keymap</primary>
      </indexterm>

      <indexterm zone="tin tin-config">
        <primary sortas="e-etc-mailcap">/etc/mailcap</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>Set some global defaults for <application>TIN</application> by
      running the following commands as the
      <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>cat &gt; /etc/tin/tinrc &lt;&lt; "EOF"
use_mouse=ON
getart_limit=100
translit=ON
EOF</userinput></screen>

      <para>Now, as an unprivileged user, subscribe to some newsgroups,
      specify the news server, and run <command>tin</command>:</para>

<screen><userinput>cat &gt;&gt; ~/.newsrc &lt;&lt; "EOF"
gmane.linux.lfs.devel:
gmane.linux.lfs.beyond.devel:
EOF
export NNTPSERVER=news.gmane.org
tin -Q</userinput></screen>

    <para>For printing, <application>TIN</application> executes the
    <command>lpr</command> command. This can be provided by
    <xref linkend="cups"/> or <xref linkend="LPRng"/>.</para>

    <para>If you do not have the <command>metamail</command> program,
    <application>TIN</application> will use an internal parser for multipart
    MIME articles.  Alternatively, you can use <application>Mutt</application>
    for MIME parsing through the <command>metamutt</command> shell script.
    This requires both the <xref linkend="mutt"/> and
    <xref linkend="procmail"/> programs.  To use <command>metamutt</command>,
    set <option>metamail_prog=metamutt</option> in
    <command>tin</command>.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>tin, rtin, tinews.pl, metamutt, opt-case.pl, w2r.pl,
        and url_handler.sh</seg>
        <seg>None</seg>
        <seg>/etc/tin</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="tin-prog">
        <term><command>tin</command></term>
        <listitem>
          <para>is a UseNet news reader.</para>
          <indexterm zone="tin tin-prog">
            <primary sortas="b-tin">tin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rtin">
        <term><command>rtin</command></term>
        <listitem>
          <para>is a symbolic link to <command>tin</command>.</para>
          <indexterm zone="tin rtin">
            <primary sortas="b-rtin">rtin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tinews.pl">
        <term><command>tinews.pl</command></term>
        <listitem>
          <para>posts and signs an article via NNTP.</para>
          <indexterm zone="tin tinews.pl">
            <primary sortas="b-tinews.pl">tinews.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="metamutt">
        <term><command>metamutt</command></term>
        <listitem>
          <para>is a replacement of <command>metamail</command> using
          <application>Mutt</application>.</para>
          <indexterm zone="tin metamutt">
            <primary sortas="b-metamutt">metamutt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="opt-case.pl">
        <term><command>opt-case.pl</command></term>
        <listitem>
          <para>optimizes case insensitive regexp filters for tin.</para>
          <indexterm zone="tin opt-case.pl">
            <primary sortas="b-opt-case.pl">opt-case.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="w2r.pl">
        <term><command>w2r.pl</command></term>
        <listitem>
          <para>converts tin wildmat filters to tin regexp filters.</para>
          <indexterm zone="tin w2r.pl">
            <primary sortas="b-w2r.pl">w2r.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="url_handler.sh">
        <term><command>url_handler.sh</command></term>
        <listitem>
          <para>calls a web browser for viewing hyperlinks.</para>
          <indexterm zone="tin url_handler.sh">
            <primary sortas="b-url_handler.sh">url_handler.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>