@database ShellScr.guide
@author Kyzer/CSG
@$VER: ShellScr.guide 1.0 (14.6.96)
@remark you can read this in a text viewer, if you need to.
@node main "ShellScr v1.0 documentation"

@{u}ShellScr v1.0@{uu}

 @{"  " link intro} Introduction
 @{"  " link usage} Usage
 @{"  " link future} Future development
 @{"  " link credits} Credits

*** begin anti-american text

COPYRIGHT: THE AUTHOR HOLDS ALL COPYRIGHTS ON THIS SOFTWARE AND ITS
ACCOMPANYING DOCUMENTATION AND SOURCE. THE AUTHOR SPECIFIES THAT ALL
USERS ARE ALLOWED TO REDISTRIBUTE THE PROGRAM PROVIDED THAT THEY DO NOT
CHARGE ANYTHING BEYOND REDISTRIBUTION FEES, AND ALSO THAT THEY DISTRIBUTE
THE SOFTWARE IN IT'S ENTIRETY, WHICH IS THE UNMODIFIED FILES SHELLSCR,
SHELLSCR.INFO, SHELLSCR.GUIDE AND SHELLSCR.E

SHELLSCR MAY BE USED IN COMMERCIAL PACKAGES PROVIDED THE AUTHOR IS
CREDITED AND ALL FILES ARE INCLUDED UNMODIFIED. ANY PART OF THE SOURCE
CODE MAY BE USED FOR ANY PURPOSE.

DISCLAIMER: SHELLSCR IS 100% SYSTEM GUIDE COMPLIANT AND 100% FREE OF
ERROR. ANY COMPUTER FAILURE CAUSING OR NOT CAUSING LOSS OF DATA OR
OTHERWISE RELATING TO OR NOT RELATING TO THE USAGE OF SHELLSCR IS THE
FAULT OF OTHER THIRD-PARTY SOFTWARE AND NOT SHELLSCR. SHELLSCR IS NOT,
HOWEVER, PROVIDED WITH ANY WARRANTY DUE TO THE FACT IT IS GIVEN TO THE
USER FREE OF CHARGE.

*** end anti-american text

@endnode
@node intro "Introduction"
ShellScr is a tool I have been using for years.
Finally, I have decided to release it to the public.

ShellScr simply opens a new screen and puts a full screen-sized shell on
it, allowing a SAFE 80 column shell.

ShellScr makes no assumptions about how the shell works, so all user
changes are safe and acceptable. It simply opens a public screen and
puts a borderless backdrop console window on it, using the command:

NewShell CON:0/3/x/y//BACKDROP/NOBORDER/SCREENsc

where x and y are the screen dimensions and sc is the unique public screen
name ShellScr makes for itself.

After all the windows on the public screen close, the screen closes.

Sweet and simple, and programmed in Amiga E for stability.
@endnode

@node usage "Usage"
ShellScr requires Workbench 2 or better. What doesn't nowadays?

Simply double-click on ShellScr's icon, or type "ShellScr" at a shell.
You will then get a shell on it's own screen. The screen is a clone of
the default public screen (usually the Workbench screen), so if you want
a 640x512 shell then set your Workbench to 640x512.

You can launch as many copies of ShellScr as you want.

The shell can be closed at any time, by pressing CTRL-\ or typing
'EndShell' at the shell prompt. However, the screen will only close when
all the windows on it are closed. Usually the shell is the only window,
so the screen goes away when the shell does.

There are no tooltypes or arguments for ShellScr.

WARNING: The AmigaOS has many bugs in the creation process of a new shell.
Do _not_ try to open a shell very quickly after closing an old one! The
system may crash with error $81000005 or likewise!
@endnode

@node future "Future developments"
In the future, I may or may not add these options.

- Tooltypes and argument parsing, allowing theses options:
  FULLSCREEN/S - A full screen with no titlebar, allowing 80x32 or bigger
  SCRIPT - allow to start from another script rather than S:Shell-startup
  TITLE - the name of the screen and window

- Setting a local shell variable $SHELLSCR, with the name of the public
  screen so you can easily use the same screen as the shell.

- A Magic Workbench styled icon.

- Any other options the public (you!) wants me to add.
@endnode

@credits "Credits"
ShellScr was concieved from the assembler program 'scrsh' by Kyzer/CSG.

ShellScr was written by Kyzer/CSG in Amiga E 3.1i, based on the source
scrsh.asm and the RKM source clonescreen.c

Contact:

Kyzer/CSG,
49 Fairview Road,
AB22 8ZG, Scotland.

(01224) 704117
intl: +441224704117
after 7pm GMT please! :)

or email: u01aggm@ugrad.abdn.ac.uk  - this is shared with a friend, so
please mark mails with 'KYZER' in the subject. After september 1996 it
becomes u01sac@ugrad.abdn.ac.uk - this is not shared :)

or see me playing the MUD Adamant, at 130.83.9.19 port 4711. Log on either
as a new character or a guest. If I am not there you can "mail kyzer" if
you want to leave a message for me. It gets checked more often than my
email :)
@endnode