home *** CD-ROM | disk | FTP | other *** search
/ Plex 2 / Plex2.mdf / u_linux / xcept.rea < prev    next >
Text File  |  1994-06-02  |  9KB  |  246 lines
  1. XCept Version 2.0
  2.  
  3. Copyright (c) 1992, 1993 Arno Augustin, Frank Hoering, University of
  4. Erlangen-Nuremberg, Germany.
  5. All rights reserved.
  6.  
  7. Redistribution and use in source and binary forms, with or without
  8. modification, are permitted provided that the following conditions
  9. are met:
  10. 1. Redistributions of source code must retain the above copyright
  11.    notice, this list of conditions and the following disclaimer.
  12. 2. Redistributions in binary form must reproduce the above copyright
  13.    notice, this list of conditions and the following disclaimer in the
  14.    documentation and/or other materials provided with the distribution.
  15. 3. All advertising materials mentioning features or use of this software
  16.    must display the following acknowledgement:
  17.     This product includes software developed by the University of
  18.     Erlangen-Nuremberg, Germany.
  19. 4. Neither the name of the University nor the names of its contributors
  20.    may be used to endorse or promote products derived from this software
  21.    without specific prior written permission.
  22.  
  23. THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  24. IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
  26. EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  28. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  29. OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  30. WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  31. OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  32. ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33.  
  34.  
  35. WHAT IS XCEPT?
  36.  
  37. XCept is an X11 implementation of the CEPT videotext protocol terminal. It has
  38. been extensively tested against the German Telekom's BTX version of the CEPT
  39. videotext service.
  40.  
  41. This is the second release of this software. We have done some bug fixes, 
  42. added support for ISDN access (tested with BinTec boards on a Sun machine), 
  43. sped up the X11 client, and more. As there already is a shareware package 
  44. called XBtx (running under MS-DOS) with which we have nothing in common, we 
  45. decided to rename our software XCept, which is quite easy to memorize for two
  46. reasons:
  47.  
  48.     o X CEPT decoder => xcept
  49.     o We hope to have provided eXCeptionally software 8=)
  50.  
  51.  
  52. WHAT ARE XBTXs CAPABILITIES?
  53.  
  54. XCept supports
  55.  
  56.      o  color and black & white displays
  57.      o  multiple server, multiple clients (though at any given time only one
  58.         client can be served by a server) 
  59.      o  built-in script language
  60.      o  accounting (connect time and user)
  61.      o  allow files (users, machines, and user@machine)
  62.      o  session logging & off-line playback
  63.      o  saving CEPT pages as ASCII or PBM (even if in black & white mode with
  64.         the all the original color information)
  65.      o  background mode (i.e. no X11 display is opened) for automated retrieval
  66.      o  Perl interface
  67.      o  modem configuration file
  68.      o  access over modem or ISDN
  69.      o    UUCP style locking
  70.      o  Software downloading
  71.  
  72.  
  73. STRUCTURE OF XCEPT
  74.  
  75. XCept utilizes the well-known client-server paradigm: The server deals with the
  76. link layer protocol and takes care of 
  77.      
  78.      o  talking to the modem
  79.      o  setting up and maintaining the connection to the videotext provider
  80.         (e.g. the BTX-Zentrale of the German Telekom)
  81.      o  dealing with the link layer protocol (OSI-2)
  82.      o  closing down the connection once the videotext session is terminated
  83.  
  84. The client(s) talk(s) to the server via a TCP connection and take care of the
  85. presentation layer protocol (OSI-6). At the same time the clients entertain the
  86. user interface. Due to the single threaded nature of a CEPT videotext session
  87. only one client can at any given time deal with one server (currently one
  88. btxserver can only support one modem).
  89.  
  90.  
  91. RESTRICTIONS
  92.  
  93. There are none, except those noted in the copyrights.
  94.  
  95. N.B. for German users: The German Bundesamt fⁿr Zulassungen in der
  96. Telekommunikation tells us that no BZT approval for software CEPT decoders is
  97. necessary anymore.
  98.  
  99. You are free to use the software for any purpose you want PROVIDED
  100. YOU KEEP ALL THE COPYRIGHT NOTICES AND THE DISCLAIMERS INTACT AND OBEY WHAT
  101. THEY TELL YOU AND ALLOW YOU TO DO.
  102.  
  103.  
  104. HOW TO INSTALL
  105.  
  106. As of version 2.1 we have merged in a couple of patches supplied to us by 
  107. various people for various Unix version and Unix look-a-likes (e.g. Linux).
  108. The only makefile you should have a look at is ceptd/makefile. Depending on
  109. what kind of Unix variant you're planning to use XCept you need to define
  110. appropriate defines here. An example for Lunix, oops, Linux is provided. 
  111. The xcept client should compile out of the box 8=) unless you want to set
  112. the default XCept-Server to something different then localhost. But it
  113. might be a good idea to look over xcept's makefile and make sure everything
  114. is, where it's supposed to be.
  115.  
  116.  
  117. Installing ceptd
  118.  
  119. Look at ceptd/makefile.shipped and copy it to ceptd/makefile. Then
  120. change the following definitions
  121.  
  122. OWNER= cept
  123. GROUP= cept    or    uucp
  124. EXECMODE= 755
  125.  
  126. BINDIR= /local/cept/bin#     directory for the executable ceptd-server
  127. MANDIR= /local/cept/man/man8#     directory for the ceptd-servers manpage 
  128. ETCDIR= /local/cept/etc#     directory for 'init file' and 'users file'
  129.  
  130. # defaults for the ceptd-server :
  131.  
  132. DEFAULTINITFILENAME=     $(ETCDIR)/init.cept#     modems default init file
  133. DEFAULTUSERSFILENAME=     $(ETCDIR)/users.cept#     file with allowed users
  134. DEFAULTLOGFILENAME=     /local/btx/log/log.cept# logfile for user online times
  135. DEFAULTMODEM=         /dev/com0#        char. special file for modem
  136. DEFAULTSPEED=         2400#             modem baud rate
  137. DEFAULTSOCKETPORT=     20005#            socket port for connections
  138.  
  139. Next look at xcept/makefile and change 
  140.  
  141. #define ceptd's hostname (Only used when not overridden by
  142. #   environment variable XCEPTHOST or by command line optin '-h').
  143. SERVERHOST = localhost
  144.  
  145. SERVERHOST should probably left as `localhost' if you're running both client
  146. and server on one machine only, and else to the name of the server machine.
  147. This can however be overridden at run time by either XCEPTHOST or by the
  148. command line option -h servername. 
  149.  
  150. #define directory pathname where the scripts are located which
  151. #   should be displayed in the scripts menu. (Only used when not
  152. #   overridden by enironment variable XCEPTSCRIPTS or by command line
  153. #   option '-S').
  154. SCRIPTSDIR = /local/cept/lib
  155.  
  156. Our setup is
  157.  
  158.     /local/cept/
  159.                 bin     - here live ceptd and/or xcept
  160.                 etc     - here live init.cept and users.cept (only needed 
  161.                       for the server) 
  162.                 lib     - here live the script files and xcept.pl
  163.                 man     - here live the man pages for ceptd and xcept.
  164.  
  165.  
  166. #define compiler and X11 include+library pathes 
  167. CC    = cc
  168. XINC    = -I/usr/include/X11
  169. XLIB    = -L/usr/X11/lib
  170. #WARN    = -Wunused -Wswitch -Wcomment -Wshadow -Wpointer-arith -Wcast-qual
  171.  
  172.  
  173. #define location of the xcept binary and online manual (for 'make install').
  174. OWNER    = cept
  175. GROUP    = cept
  176. MODE    = 755
  177. BINDIR    = /local/cept/bin
  178. MANDIR    = /local/cept/man/man1
  179.  
  180. Next go into ceptd and do
  181.  
  182.      % make
  183.      % make install
  184.  
  185. and the same in the xcept directory.
  186.  
  187. Finally create the lib directory (in our example /local/cept/lib), change the
  188. DEST definition in lib/makefile, go into lib and do a
  189.  
  190.      % make install
  191.  
  192. TAKE CARE TO FOLLOW THE INSTRUCTIONS THAT THE VARIOUS MAKEFILES MIGHT ADVISE
  193. YOU TO PERFORM.
  194.  
  195.  
  196. ADVICE
  197.  
  198.         o  Some modems need to be told to NOT use the internal buffer (AT&M2)!
  199.     o  Some modems need to be told to NOT try and connect with compression,
  200.        use AT&K0
  201.         o  If using Ceptd and XCept on the same machine, make sure the name
  202.            you're using for the XCept-Server (e.g. 'localhost') is known to
  203.            your machine (i.e. entered into /etc/hosts or DNS)           
  204.  
  205. ENVIRONMENT VARS
  206.  
  207. Xcept pays attention to
  208.  
  209.      XCEPTHOST       which server to use
  210.      XCEPTSCRIPTS    path(s) where scripts might live --- xbtx will look at all
  211.                     the files it finds along the path and if they contain the
  212.                     token `#XCEPT' as the first characters include them in its
  213.                     list of known scripts (which it knows how to locate and
  214.                     which will be included in the `Scripts' menu)
  215.  
  216. WHAT ELSE?
  217.  
  218. Have fun, take a look at the scripts in lib, enjoy your life, send in bug fixes
  219. and improvements, spread the source, ...
  220.  
  221. Oh, and you might want to try out the playbacks, too.
  222.  
  223.  
  224. WHERE TO SEND BUGFIXES AND IMPROVEMENTS
  225.  
  226. I'll be happy to accept improvements and bug fixes. --- and `yes' if you really
  227. don't get along you might try and send me a mail, too (although I certainly don't
  228. guarantee same day response 8=):
  229.  
  230.           husemann@informatik.uni-erlangen.de
  231.  
  232. Going were no man has gone before ...
  233.  
  234.         Dirk Husemann
  235.  
  236. Dirk Husemann
  237. University of Erlangen-Nuremberg
  238. Department of Computer Science IV
  239. Martenstrasse 1        
  240. D-W 8520 Erlangen, Germany
  241.  
  242. Dirk.Husemann@informatik.uni-erlangen.de
  243. /C=de/A=dbp/P=uni-erlangen/OU=informatik/S=husemann/G=dirk/
  244.  
  245.  
  246.