home *** CD-ROM | disk | FTP | other *** search
/ Internet Publisher's Toolbox 1.0 / Image.iso / toolbox / lynx / readme.txt < prev   
Encoding:
Text File  |  1994-08-11  |  22.6 KB  |  632 lines
  1.  
  2.  
  3.            DOSLYNX V0.8 ALPHA RELEASE INFORMATION 
  4.  
  5. Contents: 
  6.  
  7.    Introduction 
  8.    System Requirements 
  9.    Obtaining DosLynx 
  10.    Required Files 
  11.    Installing DosLynx 
  12.    Configuring DosLynx 
  13.    Command Line Options 
  14.    Using DosLynx 
  15.    Special Notes on Usage 
  16.    New DosLynx Features 
  17.    Distributing DosLynx 
  18.    Credits 
  19.  
  20.  
  21.  
  22. Introduction
  23.  
  24.    This is an alpha release of DosLynx for DOS compatible computers written
  25.    by Garrett Arch Blythe for The University of Kansas.
  26.  
  27.    DosLynx is a distributed hypertext browser with some World Wide Web
  28.    capabilities.
  29.  
  30.    This file provides information about installing, configuring, and using
  31.    DosLynx v0.8a.
  32.  
  33.    DosLynx is copyrighted by the University of Kansas and is free for
  34.    instructional and research educational use. Non-educational use will be
  35.    licensed at a later date.
  36.  
  37.    DosLynx is available in its source and binary forms.
  38.  
  39.  
  40.  
  41. System Requirements
  42.  
  43.    One of DosLynx's goals is to provide support for as many DOS users as
  44.    possible. We have scaled DosLynx towards this end.
  45.  
  46.    The known system requirements are:   
  47.  
  48.    CPU    8086 compatible. 
  49.  
  50.    Memory 512 kilobytes free or more recommended. 
  51.  
  52.    Hard Drive
  53.       Required. 2 megabytes free or more recommended. 
  54.  
  55.    Monitor
  56.       Monochrome, Black and White, and Color supported. 
  57.  
  58.    Graphics capability
  59.       Optional. 
  60.  
  61.    Mouse  Optional. 
  62.  
  63.    Network
  64.       None, or Class 1 (ethernet) packet driver connected to 
  65.       a TCP/IP network. You may, of course, emulate a Class 1 packet
  66.       driver 
  67.       if you have the required software for your particular system
  68.       (i.e. 
  69.       PPP, ODI, SLIP, etc). 
  70.  
  71.  
  72.    DosLynx is known not to work on the following systems:       
  73.  
  74.    DOS    Versions below 3.0 will not work properly. 
  75.  
  76.  
  77.    Release 0.7a stated erroneously that computers using Lan Workplace for
  78.    DOS (or any other comparable TCP/IP stack) were not compatible with
  79.    DosLynx. See the Installating DosLynx section on how to properly setup
  80.    your computer when running an existing TCP/IP stack like Lan Workplace
  81.    but would like to use DosLynx.
  82.  
  83.    If your system is also not supportable, we would very much like to know
  84.    your system configuration. Please mail the DosLynx developer at this
  85.    Internet address:
  86.  
  87.  
  88.     lynx-help@ukanaix.cc.ukans.edu
  89.  
  90.  
  91.  
  92. Obtaining DosLynx
  93.  
  94.    DosLynx v0.8a is available via binary anonymous FTP at ftp2.cc.ukans.edu
  95.    in the pub/WWW/DosLynx directory. DosLynx version 0.8 alpha will be the
  96.    file named DLX0_8A.EXE which is a self-extracting archive.
  97.  
  98.    URL notation is ftp://ftp2.cc.ukans.edu/pub/WWW/DosLynx/DLX0_8A.EXE
  99.  
  100.    DosLynx will be updated periodically as new changes are made to the
  101.    application. You will be able to find the new versions via binary
  102.    anonymous FTP to ftp2.cc.ukans.edu in the pub/WWW/DosLynx directory
  103.    under an appropriately named archive.
  104.  
  105.    URL notation for the directory is
  106.    ftp://ftp2.cc.ukans.edu/pub/WWW/DosLynx/
  107.  
  108.  
  109.  
  110. Required Files
  111.  
  112.    DosLynx version 0.8 alpha has the following files shipped with it. If
  113.    you do not have all of the files listed below we suggest obtaining a
  114.    complete release from the Internet address listed above. 
  115.  
  116.  
  117.  
  118.    DOSLYNX.EXE
  119.       The DosLynx v0.8a executable. 
  120.  
  121.    DOSLYNX.CFG
  122.       The DosLynx v0.8a configuration file. 
  123.  
  124.    README.HTM
  125.       The HTML equivalent of this file. 
  126.  
  127.    README.TXT
  128.       The text equivalent of this file. 
  129.  
  130.    ERROR.HTM
  131.       The default DosLynx HTML error page. 
  132.  
  133.    HOTLIST.HTM
  134.       The default DosLynx HTML hotlist. 
  135.  
  136.  
  137.  
  138.  
  139. Installing DosLynx
  140.  
  141.    This section assumes that you have not already installed DosLynx version
  142.    0.8 alpha on your hard drive. If you already have, you may skip this
  143.    section.
  144.  
  145.    Obtain a copy of DosLynx and place it in an appropriately named
  146.    directory on your hard drive.
  147.  
  148.    Enter the command "DLX0_8A" from your DOS prompt in the directory which
  149.    you placed the DosLynx v0.8a archive.
  150.  
  151.    The required files should be written by the self-extracting archive into
  152.    the directory. You may now remove the DLX0_8A.EXE from the directory if
  153.    you wish by entering the command "del DLX0_8A.EXE".
  154.  
  155.    For those users with a TCP/IP stack already loaded (such as Lan
  156.    Workplace for DOS) you will need to configure your computer so that you
  157.    can unload the TCP/IP stack at your convienience. When you are ready to
  158.    run DosLynx, you must first unload your TCP/IP stack; for LWP, the
  159.    command is "tcpip /u". Next, if need be, load a packet driver emulator
  160.    for your system configuration. You should now be ready to run DosLynx.
  161.    After using DosLynx, you may want to return your system to its previous
  162.    configuration. Do this by unloading the packet driver emulator if one
  163.    was loaded. Load your TCP/IP stack again to finish this process.
  164.  
  165.  
  166.  
  167. Configuring DosLynx
  168.  
  169.    Edit the DosLynx v0.8a configuration file named DOSLYNX.CFG with any
  170.    text editor. Go through each keyword and provide the appropriate value.
  171.    Ample configuration instructions are included in the distribution
  172.    configuration file. Once finished, save the modifed file as ASCII text.
  173.    If you wish to save your hotlist which was used in your old version of
  174.    DosLynx, simply change the hotlist keyword in the configuration file to
  175.    point to your old hotlist file.
  176.  
  177.  
  178.  
  179. Command Line Options
  180.  
  181.    DosLynx has the following command line switches and options. All command
  182.    line options supercede their configuration file equivalents. All command
  183.    line options are case insensitive except for URLs.
  184.  
  185.  
  186.  
  187.    /B     This option will hide the clock, socket activity, free 
  188.       free temporary disk space, free heap space, and message window 
  189.       for the duration of the current DosLynx session. This option 
  190.       was added to not clutter the screen for blind users as this 
  191.       causes some problems with screen readers, but makes for an 
  192.       all around cleaner display for all users if you wish to use /B. 
  193.  
  194.    /P     This is the most important command line option. If you will 
  195.       be executing DosLynx from a directory other than the one you 
  196.       installed DosLynx in, you must use the /P option. /P specifies 
  197.       the directory in which DosLynx may find its configuration file 
  198.       DOSLYNX.CFG and the errorhtml file ERROR.HTM. If you installed 
  199.       DosLynx in the directory C:\DLX then you should use the /P option
  200.  
  201.       as follows:
  202.       doslynx /PC:\DLX
  203.       To avoid having to retype the /P option every time you wish to 
  204.       use DosLynx, create a DOS batch file automatically specifying 
  205.       the /P option for you and place the batch file a directory 
  206.       specified in your DOS PATH environment variable. 
  207.  
  208.    /T     This option specifies the temporary directory where DosLynx 
  209.       will create its temporary files. If you wanted to use the 
  210.       directory C:\TEMP as the place to store temporary files, then you
  211.  
  212.       would use /T in the following manner:
  213.       doslynx /TC:\TEMP\
  214.  
  215.    /L     This option tells DosLynx how many loaded documents to keep 
  216.       in memory before it starts releasing the oldest unviewed file. If
  217.  
  218.       you wanted DosLynx to keep the last 5 ready in memory, then you 
  219.       would use the /L option in the follwing way:
  220.       doslynx /L5
  221.  
  222.    /V     This option tells DosLynx what text mode to begin in. /VLOW 
  223.       tells DosLynx to use the 25 row text mode. /VHIGH tells DosLynx 
  224.       to attempt to use the 43 or 50 row text modes available to EGA
  225.       and 
  226.       VGA compatible video adapters. 
  227.  
  228.    /H     This option tells DosLynx if it should load the home page 
  229.       you specified in the configuration file. /HON tells DosLynx to 
  230.       load the home page on startup. /HOFF tells DosLynx to not load 
  231.       the home page on startup. /HOFF is automatically assumed if you 
  232.       also use a URL on the command line unless /HON follows the
  233.       command 
  234.       line URL. 
  235.  
  236.    /N     This option tells DosLynx if it will allow network access. 
  237.       To turn off network access, use /NNO. To allow network access, 
  238.       use /NYES. 
  239.  
  240.    URL    This command line option is actually any URL that you would 
  241.       like DosLynx to load from the command line. It can be any valid 
  242.       URL or it can be a DOS path to a file. Once a URL is specified on
  243.  
  244.       the command line, your home page will not be loaded unless you 
  245.       also append the /HON to your command line following the URL. To 
  246.       have DosLynx load this document on startup, execute one of the 
  247.       following commands from the directory in which you installed 
  248.       DosLynx:
  249.  
  250.       doslynx readme.htm
  251.  
  252.       doslynx file:///readme.htm
  253.  
  254.  
  255.  
  256.  
  257. Using DosLynx
  258.  
  259.    DosLynx is a straightforward menu driven application.
  260.  
  261.    A user has several ways to activate the DosLynx menu; pressing F10,
  262.    pressing ALT and one of the highlighted menu letters, and by a single
  263.    left button mouse click.
  264.  
  265.    Following are a listing of all menu items and their functionality. Menu
  266.    titles and the appropriate menu choice are presented side by side with
  267.    the '|' character as a separator.
  268.  
  269.  
  270.  
  271.    File|Open URL
  272.       Allows you to enter a user specified URL. Once 
  273.       entered, DosLynx will attempt to load the URL. 
  274.  
  275.    File|Open Local
  276.       Allows you to select a local file from an 
  277.       available DOS path. DosLynx will convert the file name into 
  278.       a URL and attempt to load the file. 
  279.  
  280.    File|Close
  281.       When this menu item is selected, DosLynx will close 
  282.       the currently active window so that it is no longer viewable 
  283.       on your display. 
  284.  
  285.    File|Save Rendering
  286.       When selected, DosLynx will prompt you 
  287.       for a local file name in which to save the document in the
  288.       currently 
  289.       active window as ASCII text exactly as seen on your display. 
  290.  
  291.    File|Print Rendering
  292.       When selected, DosLynx will prompt you 
  293.       for a DOS device to which to print the rendering. The appropriate
  294.  
  295.       DOS device to enter is the one to which your line printer is 
  296.       connected, such as LPT1. 
  297.  
  298.    File|Dos Shell
  299.       DosLynx spawns your command interpreter so that 
  300.       you may take action outside of DosLynx while it is still 
  301.       running. After selecting this item, you should always exit 
  302.       the command interpreter and return to DosLynx after you are 
  303.       finished. 
  304.  
  305.    File|Exit
  306.       This will cause the DosLynx application to exit 
  307.       therefore ending your session inside DosLynx. 
  308.  
  309.    Navigate|Find
  310.       Allows you to enter a search string that 
  311.       DosLynx will find in your currently active window. 
  312.  
  313.    Navigate|Find Again
  314.       DosLynx will again find the last 
  315.       entered search string from the find command. 
  316.  
  317.    Navigate|Next Anchor
  318.       This will move you to the next selectable 
  319.       anchor in the active window. 
  320.  
  321.    Navigate|Previous Anchor
  322.       This will move you to the previous 
  323.       selectable anchor in the active window. 
  324.  
  325.    Navigate|Activate Anchor
  326.       This will cause DosLynx to attempt to 
  327.       load the destination URL of the currently active anchor. 
  328.  
  329.    Navigate|Prior Document
  330.       This will cause DosLynx to attempt to 
  331.       load the last visited URL in the currently active window. 
  332.  
  333.    Navigate|Search Index
  334.       Some loaded documents are searchable 
  335.       indexes. To cause DosLynx to search the index of the currently 
  336.       active window, select this command. This command will not 
  337.       be active if the window contains no searchable index. 
  338.  
  339.    Navigate|Show Destination URL
  340.       Select this if you desire to 
  341.       view the URL of the currently active anchor. 
  342.  
  343.    Options|Toggle Low/High Text Mode
  344.       Allows you to switch back 
  345.       and forth between the default 25 line text mode and the 43 or 
  346.       50 line text mode of EGA or VGA video adapters. 
  347.  
  348.    Window|Messages
  349.       This will cause the window containing all 
  350.       DosLynx message to appear as the active window. 
  351.  
  352.    Window|Clone Window
  353.       Use this if you wish to create a duplicate 
  354.       of the currently active window. The window should be the 
  355.       same in every respect except for window number and size. 
  356.  
  357.    Window|Zoom
  358.       Use this command to switch a window to its maximum 
  359.       possible size and its previous size before Zoom. 
  360.  
  361.    Window|Cascade
  362.       Use this command to organize all open windows 
  363.       in a cascading arrangement on your display. 
  364.  
  365.    Window|Tile
  366.       Use this command to organize all open windows 
  367.       in a tiled arrangement on your display. 
  368.  
  369.    Hotlist|View
  370.       This command causes DosLynx to load the user 
  371.       specified HotList file for easy access to anchors which you 
  372.       speicify. 
  373.  
  374.    Hotlist|Add current to Hotlist
  375.       This command will add the URL 
  376.       of the currently active window to your hotlist file and then 
  377.       prompt you for a name by which to remember the URL. 
  378.  
  379.    Hotlist|Home Page
  380.       Use this command to open a new window with 
  381.       the user specified home page loaded within. 
  382.  
  383.    Help|About DosLynx
  384.       Miscellaneous information regarding DosLynx. 
  385.  
  386.    Help|Mail Developer
  387.       Use this command to send a suggestion or 
  388.       bug report to the developer of DosLynx if you are connected 
  389.       to a network. 
  390.  
  391.  
  392.    DosLynx also has many other ways of obtaining user input.
  393.  
  394.    All hotkey equivalents are listed beside the menu choices while running
  395.    DosLynx.
  396.  
  397.    In addition to the listed keys, you can use the UNIX vi keys (HJKL) or
  398.    your numeric keypad with your number lock on for anchor navigation. This
  399.    differs from the 0.7a release of DosLynx that allowed the user to use
  400.    the Lynx arrow keys for anchor navigation which is no longer supported
  401.    as the arrow keys are reserved for scrolling only.
  402.  
  403.    Page up, page down, the arrow keys, and the space bar allow you to look
  404.    through a document that is longer than your display itself. Further, if
  405.    you utilize a mouse with DosLynx, you can select an anchor by using a
  406.    single left button click, and activate an anchor by using a double left
  407.    button click. A special case arises when attempting to select an inline
  408.    image which also is has a destination; see the Special Notes section.
  409.  
  410.    Items contained in the status bar (the bottom line of your screen while
  411.    running DosLynx) correlate directly with items in the navigate menu
  412.    which are selectable by the mouse only. In addition, the right mouse
  413.    button is the same as issuing the Window|Clone Window command.
  414.  
  415.  
  416.  
  417. Special Notes on Usage
  418.  
  419.    As of the DosLynx v0.8a release, only the following URL types are
  420.    supported: 
  421.  
  422.  
  423.     file
  424.     ftp
  425.     gopher
  426.     http
  427.     news
  428.     wais
  429.  
  430.  
  431.    If you notice extremely poor system performace, such as the hard drive
  432.    being continually accessed, install a disk cache such as SMARTDRV.
  433.  
  434.    When attempting to select an inline image with a mouse, it may not work
  435.    as you expect. Some inline images also have destinations, in which case
  436.    you will be taken to that destination. Use the keyboard to specifically
  437.    select an inline image which also has a destination.
  438.  
  439.    For the best DosLynx performance, specify the temporary file directory
  440.    in your configuration file or on the command line to be a directory on a
  441.    RAMDRIVE. See your DOS documentation for setting up a RAMDRIVE specific
  442.    to your system.
  443.  
  444.    DosLynx is a MDI (multiple document interface) application. This may
  445.    confuse new users that are used to other World Wide Web clients. As a
  446.    rule of thumb, when you open any URL or document through DosLynx's menu
  447.    or equivalent hotkeys, then it will exists in it's very own window.
  448.    Windows are numbered in their upper right corner and you can switch
  449.    between windows by pressing the ALT key and the window number
  450.    simultaneously.
  451.  
  452.    Each window represents an open file at any given time. If you open more
  453.    windows than you have FILES specified in your CONFIG.SYS file then
  454.    DosLynx may crash. Increase the number of open files your machine can
  455.    have if you plan to use multiple windows a lot.
  456.  
  457.    When DosLynx has used most of your computer's memory attempting to use
  458.    the File|Dos Shell command will not work. Your computer simply does not
  459.    have enough memory to execute your command interpretor.
  460.  
  461.    When you ftp a file or activate an anchor that DosLynx cannot display as
  462.    text, you are asked to give a file name to save the information in; a
  463.    filename is now suggested by DosLynx. These files are not removed by
  464.    DosLynx when you exit the application. This allows you as the user to do
  465.    what you will with such files after exiting DosLynx. If you are prompted
  466.    to save a file that is already on your hard drive (such as a local
  467.    image) do not use the same name in the same directory. This option is
  468.    being left in since some users may wish to use DosLynx on a LAN and copy
  469.    the selected files to their workstation's hard drive.
  470.  
  471.    DosLynx has been known to crash when it encounters a file containing a
  472.    large number of selectable anchors in it. This is due to an unavoidable
  473.    memory limitation. Large files with few anchors will be loaded fine.
  474.    Future releases of DosLynx will address this problem in a more stable
  475.    manner.
  476.  
  477.    When DosLynx terminates unexpectedly, the temporary files it creates
  478.    remain in the temporary file directory you specified in the
  479.    configuration file or on the command line. The temporary files follow
  480.    the pattern of DLX*.$$$. You will have to remove these files yourself if
  481.    this occurs. As DosLynx is improved upon you can expect it to become a
  482.    more stable application and prevent you from having to worry about this
  483.    temporary file problem.
  484.  
  485.    If you are wondering, the menu bar contains the current time in the
  486.    upper right had corner. In the status bar are three numbers in the lower
  487.    right corner. The numbers are from left to right the current network
  488.    activity in bytes, the size in bytes of the temporary drive you
  489.    specified, and the amount of available heap memory in bytes. These were
  490.    originally run-time debugging tools for the developer of DosLynx but
  491.    were left in as they are harmless and give the user some information of
  492.    what is currently happening when DosLynx is at work. They can be turned
  493.    off with the /B command line option.
  494.  
  495.    If your computer does not use a packet driver, which DosLynx requires,
  496.    to access the network, ask your local network administrator if there is
  497.    a packet emulator available for your particular workstation
  498.    configuration. For instance, if your computer utilizes an ODI driver for
  499.    network access, in order to use DosLynx you will need to install the a
  500.    packet driver emulator if one is available to you.
  501.  
  502.    Once one program is utilizing your computer's packet driver, like
  503.    DosLynx, no other program may do so at the same time. If you have need
  504.    to run more than one packet driver utilizing program at the same time,
  505.    we suggest asking your local network administrator if your computer can
  506.    be configured to use a packet multiplexor. If so, you will need to find
  507.    a suitable packet multiplexor and install it on your computer.
  508.  
  509.    To correctly view the ISO Latin I characters supported by HTML, you must
  510.    configure DOS to use multilingual code page of 850. Consult your DOS
  511.    manuals on how to specify the appropriate code page for your computer.
  512.  
  513.    To force DosLynx into a supported black and white video mode, type "mode
  514.    BW80" at your DOS prompt. Consider doing this if you monitor is black
  515.    and white but DosLynx considers it a color monitor (monochrome EGA
  516.    monitors).
  517.  
  518.    If you are interested in registering with the DosLynx development
  519.    listserv group, send a mail message to listserv@ukanaix.cc.ukans.edu.
  520.    Please do not send subscribe requests to the doslynx-dev list directly.
  521.    In the body of the message, send only the following information where
  522.    username@node is your internet mailing address: 
  523.  
  524.  
  525.         subscribe doslynx-dev Your Name Here
  526.  
  527.  
  528.    Remember that this version of DosLynx is an alpha and has been released
  529.    as a feedback tool only. Expect problems, and when you encounter one
  530.    please mail the developer at the following address and inform the
  531.    creator of the problem you encountered and your system configuration.
  532.  
  533.  
  534.     lynx-bug@falcon.cc.ukans.edu
  535.  
  536.  
  537.  
  538. New DosLynx Features
  539.  
  540.    The following new features were added in this release of DosLynx:    
  541.  
  542.    Inline Images
  543.       DosLynx can now download any inline image and 
  544.       display inline GIFs. 
  545.  
  546.    Blind Support
  547.       The /B command line option was implemented to 
  548.       aid blind users using DosLynx with a screen reader. 
  549.  
  550.    Mail Developer
  551.       The mail developer command now takes much less 
  552.       time to send the message you enter, and no longer hangs your 
  553.       computer. 
  554.  
  555.    Local GIFs
  556.       Local GIFs will now load correctly. 
  557.  
  558.    Suggested Filenames
  559.       DosLynx will now suggest a 
  560.       filename when prompting the user to save a file. 
  561.  
  562.  
  563.  
  564.  
  565. Distributing DosLynx
  566.  
  567.    You may distribute DosLynx version 0.8 alpha at your convenience so long
  568.    that you distribute the orignal self-extracting archive obtained by the
  569.    means listed in the Obtaining DosLynx section of this document.
  570.  
  571.  
  572.  
  573. Credits
  574.  
  575.    The University of Kansas would like to thank the following organizations
  576.    and people for their aid in the creation of DosLynx. 
  577.  
  578.  
  579.     Generous financial assistance given by O'Reilly and Associates
  580.         and Intel Corporation.
  581.     Fundamental GIF display routines by David Koblas
  582.     GIF support and dithering routines by Thomas Boutell
  583.     World Wide Web Source Library by CERN
  584.     Waterloo TCP by Erick Engelke
  585.     FTP code from James W. Matthews, Dartmouth Software Development
  586.     Borland C/C++ and TurboVision by Borland International
  587.  
  588.  
  589.    Further, The University by Kansas recognizes the following:  
  590.  
  591.    Borland C/C++ and TurboVision
  592.       Trademarks of and Copyright by Borland International. 
  593.  
  594.    World Wide Web Source Library
  595.       Copyright by CERN, Geneva, Switzeralnd. 
  596.  
  597.    Waterloo TCP Library
  598.       Copyright by Erick Engelke. 
  599.  
  600.    FTP code
  601.       Portions Copyright 1994 Trustees by Dartmouth College. 
  602.  
  603.    GIF display routines
  604.       Copyright by David Koblas along with the following notice: 
  605.  
  606.  
  607.  
  608. /* +-------------------------------------------------------------------+ */
  609. /* | Copyright 1990, David Koblas.                                     | */
  610. /* |   Permission to use, copy, modify, and distribute this software   | */
  611. /* |   and its documentation for any purpose and without fee is hereby | */
  612. /* |   granted, provided that the above copyright notice appear in all | */
  613. /* |   copies and that both that copyright notice and this permission  | */
  614. /* |   notice appear in supporting documentation.  This software is    | */
  615. /* |   provided "as is" without express or implied warranty.           | */
  616. /* +-------------------------------------------------------------------+ */
  617.  
  618.  
  619.    Last Modified: 08-11-94 by Garrett Arch Blythe
  620.  
  621.    Report errors to the following address:
  622.  
  623.  
  624.     lynx-bug@ukanaix.cc.ukans.edu
  625.  
  626.    Request help from the following address:
  627.  
  628.  
  629.     lynx-help@ukanaix.cc.ukans.edu
  630.  
  631.  
  632.