;  NBYEUSER.DOC  --  Specifications for the NBYEUSER.INC file for NBYE.MAC
;
;			Gary Case
;			585 Big Sky Court
;			Colorado Springs, CO
;				       80919
;			(303) 599-0744
;
;
;******************************************************************************
;
;
;   NBYE.MAC calls the following 5 routines at the times indicated.  These
;   routines must be located in the NBYEUSER.INC file, and are included to
;   allow special implementation-dependent functions to be performed without
;   cluttering up the NBYE code itself.  This .DOC file is written so it will
;   work as the NBYEUSER.INC file if no special functions are required.
;
;
;******************************************************************************
;
;
;
USRWBOOT:	;This routine is jumped to by NBYE to complete a warm boot.
		;When entered, the original BIOS warm boot entry is in HL.
		;Normally, this routine consists of a single 'PCHL' to vector
		;to the BIOS warm boot point.  The entry is provided for
		;special systems which require other processing.
		;
;
	PCHL			;WARM BOOT ENTIRELY THROUGH THE BIOS
;
;
;
USRINIT:	;This routine is called by NBYE after it has initialized the
		;MODEM and is preparing to wait for a call.  If no special
		;processing is required, just 'RET'.
		;
		;	May destroy all registers.
		;
;
	RET			;NO SPECIAL INITIALIZATION
;
;
;
USRFINI:	;This routine is called when the SYSOP has exited NBYE to CP/M.
		;
		;	May destroy all registers.
		;
;
	RET			;NO SPECIAL PROCESSING NEEDED BEFORE EXIT
;
;
;
USRLOGD:	;This routine is called when NBYE has answered the phone,
		;received a carrier tone, and successfully logged in a new
		;user.
		;
		;	May destroy all registers.
		;
;
	RET			;NO SPECIAL PROCESSING NEEDED
;
;
;
USRFUNC:	;This routine is called when the SYSOP has pressed Control-U
		;while function keys are enabled.  This allows any special
		;functions desired to be implemented without changing NBYE.MAC.
		;Note that if additional characters are needed from the local
		;console this routine should 'CALL BIOSVECT+9'.  It MUST NOT
		;call the 'LCIN' routine, as this would be a recursive call.
		;
		;	May destroy all registers.
		;
		;	Must Return Acc=0
		;
;
	XRA	A		;NO SPECIAL USER FUNCTION IMPLEMENTED
	RET			;JUST RETURN WITH ACC=0 PER SPECIFICATION
;
;
;	***  End of Special User Routines  ***
;
;******************************************************************************