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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY docbook "<productname>DocBook</productname>">
<!ENTITY sgml "<abbrev>SGML</abbrev>">
]>
<!-- Manual page for aub, DocBook source file
(C) 2002 Mako Hill <mako@debian.org> -->
<refentry>
<refentryinfo>
<address>
<email>mako@debian.org</email>
</address>
<author>
<firstname>Benjamin</firstname>
<surname>Hill</surname>
<othername>Mako</othername>
</author>
<date>2002-03-10</date>
</refentryinfo>
<refmeta>
<refentrytitle>aub</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>aub</refname>
<refpurpose>Assembles binary files from USENET</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>aub</command>
<arg><replaceable>option</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>aub</command> accesses news either remotely via the
NNTP protocol or locally, by scanning a news spool directory,
and searches for new pieces of split, encoded binaries that
have recently been received. Binaries are expected to contain
subject lines conforming to de-facto Usenet standards; aub
may not be able to identify pieces of binaries which are not
named according to accepted conventional practice. If new
binaries are found, aub retrieves, organizes and decodes them,
leaving the decoded files in a configurable location.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>Most of aub's configuration is done in the it's main
configuration file, $HOME/.aubconf, which is required. Invoke
aub with the -M flag to learn about the structure of
configuration files. This will also present a full discussion
of aub and its capabilities. aub understands the following
options, all of which are discussed in detail in the internal
documentation:</para>
<variablelist>
<varlistentry>
<term><option>-c</option></term>
<listitem>
<para>Catch-up mode; binaries are processed but not
assembled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term<option>-n</option></term>
<listitem>
<para>No-checkpoint mode; the user's .aubrc file is not
modified.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option><replaceable>N</replaceable></term>
<listitem>
<para>Specifies the debug level that aub is to run at.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option></term>
<listitem>
<para>Prints a summary of the manual.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-M</option></term>
<listitem>
<para>Prints the manual.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-C</option></term>
<listitem>
<para>Lists changes since the last version of aub.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>Print version number</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>~/.aubconf</filename></term>
<listitem>
<para>aub's main configuration file. This file is required for
aub to run at all. Read the <filename>aubconf</filename>
documentation or run <command>aub -M</command> to find out
more about the structure of this file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>~/.aubrc</filename></term>
<listitem>
<para>Historical data maintained by and for
<command>aub</command> about which articles it has assembled
into files (or checked and decided to pass) and which it has
not. In the vast majority of cases you won't need to touch
this file</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/bin/perl</filename></term>
<listitem>
<para>The Perl interpreter.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term><envar>AUBDIR</envar></term>
<listitem>
<para>Default location for decoded binaries</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>AUBDESC</envar></term>
<listitem>
<para>Default location for description file</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>AUBHOOK</envar></term>
<listitem>
<para>Default hook program</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>NNTPSERVER</envar></term>
<listitem>
<para>Potential NNTP server</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>HOME </envar></term>
<listitem>
<para>Your home directory</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHORS</title>
<para>Mark Stantz (No valid email address known)</para>
<para>Brandon Long <email>blong@fiction.net</email></para>
<para>Avinash Chopde <email>avinash@acm.org</email></para>
<para>Mako Hill <email>mako@debian.org</email> (responsible for
this document)</para>
</refsect1>
<refsect1>
<title>COPYRIGHT</title>
<para>Copyright (c) 1992-2002 Mark Stantz, Brandon Long, Avinash
Chopde, Mako Hill</para>
<para>This code is offered as-is. Anyone is welcome to make
improvements, provided that my notice of authorship is retained.
I accept no responsibility for loss or damage caused by this
program, nor do I accept responsibility for supporting
it.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><filename>aubconf(1)</filename>; the
<filename>INTRODUCING_AUB</filename> document</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|