[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Listar help file
** LISTAR HELP FILE - First draft by Jeremy Blackman **
This is an extremely preliminary helpfile. Listar is still not a
release system by ANY means. This also doesn't go into all the nifty
things admins can do or whatnot.
Messages sent to Listar will have the subject parsed (to check for
any valid subject commands, such as subscribe or unsubscribe).
Then the body itself will be parsed, until it reaches the end of
the message or an 'end' command. (Use the 'end' command if your
provider automatically tacks a signature or advertisement onto the
end of your e-mail.) Commands are given one-per-line.
Listar will say that some commands have 'changed the list context'.
Listar remembers what list you were last talking about, and if you
don't provide a list for the next command, it will assume you are
referring to the same list as before.
To subscribe to a list, you can send e-mail to the listar account with
'subscribe <listname>' in the message body. Alternatively, most sites
will have the <listname>-request system set up, where you can mail
'<listname>-request' at the site and simply put 'subscribe' in the
This is done in the same way as subscribing, only with 'unsubscribe'
instead of 'subscribe'. :)
CHECKING LIST SUBSCRIBERS:
The 'who [<listname>]' command will return a list of subscribers for
a given list (or if the list is omitted, the current contextual list).
If a list is set so that only list members can view membership and you
are not a list member, you will not be permitted to view the roster.
Admins will see everyone on the list, others will only see people who
have not set the 'HIDDEN' flag on themselves.
'set [<listname>] <flag>' or 'unset [<listname>] <flag>' sets or
unsets a given Listar flag. As Listar plugins can define their own
new sets of flags, to get a list of the currently available flags on
a Listar server, send the command 'flags'.
CHECKING YOUR OWN STATUS:
'stats [<listname>]' will return what flags you currently have set.
RETRIEVING A LIST OF LISTS:
'lists' will return a list of what is available from this Listar server.
RETRIEVING A LIST OF COMMANDS:
'commands' will list what commands are currently available (not counting
admin commands). They don't provide information on what parameters
they take, as the list is built from Listar's internal command table.
This is useful, however, for seeing what commands various plugins might
add; Listar has a plug-in architecture so new commands and flags can
be added by new modules.
Yeah, that's REALLY basic, but... I know I need to write a more advanced
manual. That should be enough to get by, though. :)
Listar v0.124a - job execution complete.
To UNSUBSCRIBE, email to email@example.com
with a subject of "unsubscribe". Trouble? Contact firstname.lastname@example.org