DOS-DE                                                          version 1.0
------                                                          Andy Powell
                                                         University of Bath
                                                        A.Powell@bath.ac.uk
                                                                 April 1993
Introduction
------------
`DE (which stands for Directory Enquiries) is a directory user interface
primarily intended to serve as a public access user interface.  However, the
burgeoning number of configurable options are making DE highly suitable as
an interface to be used as a personally customised tool.  This trend will
continue with further releases of DE. It is primarily aimed at the novice
user, although more sophisticated users should find that it is flexible.'

This is a release of DE for MS-DOS machines.  It uses LDAP (the Lightweight
Directory Access Protocol) which runs over several TCP/IP stacks on the PC
including the NCSA Telnet stack, SUN's PC-NFS and Novell's LAN Workplace.
It contains the source to build any of

NFS-DE.EXE	A version of DE compiled to run over SUN PC-NFS.
NCSA-DE.EXE	A version of DE compiled to run with the NCSA telnet
		package.
LWP-DE		A version of DE compiled to run over Novell's LAN Workplace.

With little or no modification to the code it should be possible to build
DE against LDAP libraries built to run over any TCP/IP stack.

In addition to the source files, the release contains

README.TXT	This file.
DE.CFG		A configuration file for DE (the UNIX release of DE
		refers to this file as `detailor').
DE.UFN		The DE UFN (User Friendly Naming) configuration file.  (The
		UNIX release of DE uses the standard ISODE tailor file
		`ufnrc' for this).
DE.HLP		Run-time help for DE.
TAILOR.TXT	A document describing the use and configuration of the UNIX
		version of DE.  See `Differences between DOS-DE and the UNIX
		version of DE' (later in this document) for DOS-DE specific
		features.
DE.PIF		An MS Windows 3.1 PIF file for DE.  (Only the PC-NFS version of
		DOS-DE has been tested against Windows).

DOS-DE requires MS C version 7.0 to build it and you must have already built
the LDAP libraries for DOS on your PC.

Building DOS-DE
---------------
First build a ZIP file containing the source and other files required to
build and run DOS-DE.  On UNIX type

$ ./makezip

The `makezip' script may have to be told where your UNIX `zip' command lives.
Transfer the `dosdes.zip' file to your PC and un-ZIP it.  Edit the `MAKEFILE'
to reflect your set-up - in particular look for lines containing PC-NFS or
NCSA and comment out the relevant lines so that you build the right version.
You will also have to put the location of your version of LDAP for DOS
which you will have to build before building DOS-DE.

Installing the PC-NFS version of DE
-----------------------------------
NFS-DE.EXE file should be installed as DE.EXE in a directory listed in
your `PATH' environment variable.  The support files (DE.CFG, DE.HLP and
DE.UFN) can either be installed into the same directory or they can be put
into a directory pointed to by the `DE' environment variable.

Note that this version of DOS-DE will only run over SUN PC-NFS version 4.0a.

Installing the NCSA version of DE
---------------------------------
The NCSA-DE.EXE file should be installed as DE.EXE in a directory listed in
your `PATH' environment variable.  This directory must also contain a
CONFIG.TEL file configured for your environment.  The support files (DE.CFG,
DE.HLP and DE.UFN) can either be installed into the same directory or they
can be put into a directory pointed to by the `DE' environment variable.

Configuring DE
--------------
Follow the instructions given in the TAILOR.TXT file about configuring DE.
(Note that the DOS version of DE runs over the LDAP protocol).
The important things to tailor are...

ldapServer: ldaphost
username: cn=Directory Enquiries, ou=Bath University Computing Services, o=University of Bath, c=GB
default_country: GB
default_org: University of Bath
default_dept:

where, `ldapServer' is the name of the machine that is running your LDAP daemon
(an entry for this host must appear in your \NFS\HOSTS file for the PC-NFS
version, or your CONFIG.TEL file for the NCSA version).

Read the comments in the DE.UFN file for details of how to configure UFN
searching.

Running DE
----------
Just type `DE'...

DE Environment Variables
------------------------
When DE is run it will look for all its support files (DE.CFG, DE.HLP and
DE.UFN) in three places.  First in the current directory, second in the
directory pointed to by the `DE' environment variable (if set) and then
thirdly in any directory on your current `PATH'.

Differnces between DOS-DE and the UNIX version of DE
----------------------------------------------------
- The DOS-DE file DE.CFG is the UNIX file $(ETCDIR)/de/detailor.
- The DOS-DE file DE.UFN is the UNIX file $(ETCDIR)/ufnrc.
- The DOS-DE help file DE.HLP is a text file containing all the UNIX help
  files from the $(ETCDIR)/de directory.
- There are three extra tailoring options in DE.CFG to configure the colours
  that DE uses.  They are...

textColour: BrightWhite
boldColour: blue
backgroundColour: darkgray

  (Note that `boldColour' is the colour that is used where the UNIX version
  of DE uses reverse video).
  Colours can be selected from the following list...

  Black, Blue, Green, Cyan, Red, Magenta, Brown, White, DarkGray, LightBlue,
  LightGreen, LightCyan, LightRed, LightMagenta, Yellow, BrightWhite.

Bugs/Restrictions
-----------------
- Because of a slight problem with CTRL-C handling in the DOS version of DE
  the following applies in this release.  Pressing CTRL-C at any time during
  the execution of DOS-DE will result in it terminating (after abandoning any
  outstanding X.500 searches if necessary) and returning  you to the DOS
  prompt.  Pressing ESC (the ESCAPE key) will do what you would expect if you
  typed CTRL-C to the UNIX version of DE; i.e. if the ESC key is pressed
  during a search then the search will be abandoned and you will be returned
  to the DE prompt.  The run-time help files have been modified to reflect
  this change - the TAILOR.TXT file hasn't.
- This version of DOS-DE is built without power searching enabled by
  default at the moment.  This is because there appear to be memory
  problems if power searching is enabled.  If you would like to experiment
  with power searching delete the /DNOPOWER option in the CFLAGS definition
  in the `MAKEFILE'.
- The `Quality of Service' code is not supported in DOS-DE.

Availability and Support
------------------------
DOS-DE (an X.500 DUA for MS-DOS based personal computers)
Version 1.0 (IC-1)
Copyright (C) 1993 - see below

This version of DE is freely available to anyone for any lawful,
non-commercial purpose.  It is supplied as is without any express 
or implied warranty but bug reports will be dealt with on a best 
effort basis.

Please send any bug reports to A.Powell@bath.ac.uk.

Copyright Notice
----------------
The major part of the DE computer program was developed at
Universtiy College London with funding from the COSINE PARADISE
project.  The copyright for this part of the software belongs
jointly to RARE (Reseaux Associes pour la Recherche Europeene)
and the CEC (Commission of the European Communities).  The parts
of this version of the DE computer program which enable DE to run
over LDAP (Lightweight Directory Access Protocol), using routines
written at the University of Michigan, were written by Andy Powell
and are the copyright of the University of Bath.
