INTRODUCTION
============

BOScript is a scriptable interface to the Back Orifice Remote Administration
Server. BOScript code is based largely on the BO Unix client written by Dildog
and LadyAda of the Cult of the Dead Cow (http://www.cultdeadcow.com).  BOScript
was also created using SWIG, the Simplified Wrapper and Interface Generator
(http://www.cs.utah.edu/~beazley/SWIG/).  Although currently implemented to
use Perl as the scripting language, it should be easily extendable to include
Python, Guile, and other languages supported by SWIG.

You can obtain BOScript at http://blevins.simplenet.com/boscript/
Any bug reports, bitches, or code contributions should be sent to
mitch_blevins@mindspring.com.

INSTALLATION
============

See the INSTALL file included with this distribution.

USING BOSCRIPT
==============

To use BOScript, you need two files, boscript.so and boscript.pm.  Both files
must be installed in the proper paths to be accessed from your script.  For a
list of functions availabe, see the docs directory.  Example scripts can be
found in the examples directory.

Unless otherwise specified, all functions return a 1 for failure, and a 0 or
success.  This return value is based on the success/failure of the program
_on_the_client_side_, meaning that a successful function call only guarantees
that the command was sent to the BO Server.  The script is expected to check
the return text from the BO Server to determine if the command succeeded on
the server. All output from the server is accessible using the gettext()
function.

Before using any other boscript functions, the script is expected to call the
initiate() function.  Athelete's foot and other nasty things can result from
a failure to do this.  Also, the set_host() function needs to be called before
any functions that access a server.  The set_port() and set_password()
functions will then need to be called if not using the default port/password
(31337/blank).

Most functions duplicate those found in the cDc's bounix client.  Users are
encouraged to get a copy of this client for interactive expirementation and
additional help instructions for each function.  The cDc unix client is
available at http://www.cultdeadcow.com.

BOScript is meant to be an educational and administration tool.  Please use it
responsibly, as I cannot be held liable for nefarious uses.

Have fun.

COPYRIGHT
=========

BOScript v.0.2
A scriptable interface to the Back Orific Remote Administration Server
Copyright (C) 1998 Mitch Blevins (mitch_blevins@mindspring.com)
http://blevins.simplenet.com/boscript

Original Back Orifice Unix Client
Written by Dildog (dildog@cultdeadcow.com)
      and LadyAda (ladyada@cybercom.net)
Copyright (c) 1998 Cult of the Dead Cow
http://www.cultdeadcow.com

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
