
Beemail AreaFix Help
====================

AreaFix is a program which makes changes to your node
configuration, sends you a list of available message areas,
connects and disconnects your node from message areas.

AreaFix reads netmail message and performs commands listed in
message text and message header. AreaFix then creates a reply
message with request results.

Message header
==============

Send a message to 'AreaFix' (without quotes). Put your AreaFix
password as the first word on message subject line. The rest of
subject line can be empty or it can be a set of following
switches:

   -H - send AreaFix help (this text file).
   -I - send information about your node settings.

   -L - send list of available areas.
   -Q - send list of areas that your node is linked to.
   -U - send list of areas available but not linked.

   -R - rescan areas listed in message body.

Message header example:

   From: 1:1/1
   To: 1:1/2
   Subject: my_password -L -H -I

Message body
============

A message to AreaFix can be empty or it can contain commands.
Commands are lines starting with '%', '+' or '-'. Comment lines
start with ';'. All empty and comment lines are copied to
AreaFix reply message and skipped.

Command '+'is used to connect (link) and command '-' is used
to disconnect (unlink) from message areas.

'%' commands perform some actions or act as switches for some
other commands.

   ; Get AreaFix help file.
   ;
   %Help

   ; Link to BEEMAIL and BEEMAIL_BETA, unlink from BEEMAIL_GURU.
   ;
   +BEEMAIL
   -BEEMAIL_GURU
   BEEMAIL_BETA

Note that you can ommit '+' from '+' commands, as in the
example. That is, all lines which are not ';%-' commands, are
assumed to be '+' commands.

Also, you can use wildcard characters '*' and '?' in area names
in '+' and '-' commands. Example:

   ; Request list of areas which were connected before this
   ; AreaFix request.
   ;
   %Query

   ; Disconnect from all areas, then connect to all Beemail areas
   ; and some game areas.
   ;
   -*
   BEEMAIL*
   ???.GAMES.*

   ; Request a list of currently connected areas.
   ;
   %Query

AreaFix commands
================

All commands must be placed in message body, one command on a
line.  Note that you may be not allowed to use some commands
like %From or %Rescan on some systems.

   ; Comment lines must start with a semicolon.

   %Help - send AreaFix help.

   %From XXX - set 'Fix address' to XXX.
   %Info - send information about node configuration.
   %List - send list of available areas for a node.
   %Query - send list of areas that a node is linked to.
   %Unlinked - send list of areas available but not linked.
   %OrderByGroup - order areas by group in listings.
   %OrderByName - order areas by name in listings (default).

   %NodeName - change node name.
   %SysopName - change sysop name.
   %SessionPwd PPP - change node session password.
   %PktPwd PPP - change password for FTS-001 packets.
   %Pwd PPP - change AreaFix password.

   %Compress ? - get a list of available archivers.
   %Compress AAA - set archiver to use for Xmail archives.
   %Compress * - set default archiver.

   %Pause - stop receiving echomail areas.
   %Resume - resume receiving echomail areas.
   %RescanLinked - rescan all linked areas.

   %Rescan - set rescan mode On.
   %NoRescan - set rescan mode Off.
   %Days NNN - age of messages to rescan (default is 10, use 0
                to rescan all messages).
   %Msgs NNN - number of messages to rescan in each area
                (default is 100, use 0 to rescan all messages).

   %Groups - send a list of available message area groups.
   %GroupLink ABC - link to areas in groups ABC.
   %GroupUnlink ABC - unlink from areas in groups ABC.

%From
=====

Use %From to make changes to other nodes. There must be an
'Allow %From' option set for your Node settings in order to use
this command.

%From can be used several times in the same message, example:

   %Info

   %From 1:1/1
   %Info

   %From 1:1/2
   %Info

If %From is not used in a message, then changes are made to a
node from which AreaFix request is received.

%Info
=====

Send current configuration of your node. Try putting one %Info
in front of a message and another one at the end of a message to
see how AreaFix commands affect your node settings, example:

   %Info
   %NodeName I Have Just Changed My Node's Name!!!
   %Info

%Compress
=========

AAA in %Compress command is a tag (short name) for a compression
program. Use %Compress ? command to get a list of all archivers
availabe on a system. Then use %Compress AAA if you want to
change your archiver:

   %Compress ?

... and in your next message:

   %Compress Zip
   %Info

... or if you choose to use a default archiver:

   %Compress *
   %Info

%List, %Query & %Unlinked
=========================

Sends a list of available areas. %List command lists all areas
available to you, while %Query and %Unlinked list only those
which are linked or unlinked.

%OrderByGroup & %OrderByName
==============================

Set order by which areas are listed in area listings:

   %OrderByName
   %Query

   %OrderByGroup
   %List

   %OrderByName
   %List

%Pause, %Resume & %RescanLinked
===============================

Use %Pause and %Resume to temporary stop receiving echomail
instead of unlinking from all areas and then linking them all
again, example:

   %Pause
   %Info

And then, when you're back from holiday:

   %Resume
   %Info
   %Query

   %Days 3
   %RescanLinked

%Rescan and %NoRescan
=====================

These commands only affect areas which are listed after the
command until the end of a message or until the next %Rescan or
%NoRescan. You can have multiple %Rescan and %NoRescan commands
in one message.

Note that %RescanLinked is a command, while %Rescan and
%NoRescan are just switches, which do not perform any immediate
action.

%GroupLink and %GroupUnlink
===========================

These two commands are useful to connect to a number of areas
covering similar topics (in fact those belong to the same area
group).  Note that your %GroupLink request may fail if an area
also belongs to some other groups that you have no access to.
However, %GroupUnlink request will always succeed, even if you
do not have access to specified groups.

You cannot use %GroupLink to connect to areas that do not belong
to any groups.

End of Help
===========
