Return to Readme.dos CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / jove

Annotation of 43BSDReno/contrib/jove/Readme.dos, revision 1.1

1.1     ! root        1: ###########################################################################
        !             2: # This program is Copyright (C) 1986, 1987, 1988 by Jonathan Payne.  JOVE #
        !             3: # is provided to you without charge, and with no warranty.  You may give  #
        !             4: # away copies of JOVE, including sources, provided that this notice is    #
        !             5: # included in all the files.                                              #
        !             6: ###########################################################################
        !             7: 
        !             8: HOW TO GET STARTED WITH JOVE:
        !             9: =============================
        !            10: 
        !            11: You can immediately start using Jove if you have an IBMPC
        !            12: compatible PC, XT or AT. You can fine tune some things by setting
        !            13: certain environment variables, but it's not really necessary
        !            14: If your computer is not IBM BIOS compatible, you have to set some 
        !            15: environment variables before starting Jove.
        !            16: What follows is a description of those variables.
        !            17: 
        !            18: ENVIRONMENT VARIABLES USED BY JOVE:
        !            19: ===================================
        !            20: 
        !            21: TMP (or TMPDIR)
        !            22: Jove uses the value of TMP to determine the directory where it should
        !            23: put its temporary file. The default is the current directory, and this
        !            24: is probably not what you want. In general editing is faster, if TMP
        !            25: points to a ramdisk, like "set tmp=d:". You have to know however that
        !            26: the temporary file can grow quite big when editing many big files at
        !            27: once. So please make sure that you have enough space available on your
        !            28: ramdisk. If Jove runs out of space on the device which holds the
        !            29: temporary file, you have to leave the editor immediately. You can save
        !            30: your work without any trouble, but you have to start over. Please note
        !            31: also that the current version of Jove has a big cache for the
        !            32: temporary file in memory, which makes it quite fast even if you don't
        !            33: have a ramdisk.
        !            34: 
        !            35: DESCRIBE
        !            36: This variable tells Jove, where it can find the file that holds the
        !            37: online documentation. You should set DESCRIBE to the complete
        !            38: path-specification of the file "cmds.doc", which is included as part
        !            39: of the documentation. The default for DESCRIBE is "c:/unix/cmds.doc".
        !            40: 
        !            41: JOVERC
        !            42: This is the complete path for Jove's startup file. All commands in the
        !            43: file, that JOVERC points to, are executed every time when you run
        !            44: Jove. If there is a file called "jove.rc" in the current directory,
        !            45: then it is also "sourced", ie. the commands in that file are executed.
        !            46: That way you can customize Jove to your own taste.
        !            47: 
        !            48: The next two variables are not used by the IBMPC version, and have to
        !            49: do with specifying the type of terminal in use on a generic msdos
        !            50: computer.
        !            51: 
        !            52: TERM
        !            53: This variable should specify the name of the terminal you are using.
        !            54: For example, if you have a DEC vt-100 terminal attached to your msdos
        !            55: computer, you should give the command "set TERM=vt100" prior to
        !            56: starting Jove.
        !            57: 
        !            58: TERMCAP
        !            59: This environment variable holds the name of a database with
        !            60: descriptions of different terminal types. If you are familiar with the
        !            61: Unix operating system, you probably know about TERMCAP. For each
        !            62: terminal type, specified by TERM, the TERMCAP database holds an entry,
        !            63: which describes how to set the cursor, how to scroll, and many other
        !            64: things, for that particular terminal. A small example TERMCAP file
        !            65: comes with Jove. If your terminal is not included there, you should ask a
        !            66: local Unix guru for help. If you don't have one, you can ask me.
        !            67: 
        !            68: METAKEY
        !            69: Some kinds of terminals have a special shift key that Jove can recognize, 
        !            70: the so called MetaKey. When the environment variable METAKEY is set, Jove
        !            71: assumes that you have such a terminal, and treats the codes that your
        !            72: terminal sends in a slightly different way. Pressing down the MetaKey
        !            73: and another key at the same time is a then a shorthand for pressing
        !            74: first the "esc" key, and then the other key.
        !            75: 
        !            76: 
        !            77: DIFFERENT VERSIONS OF JOVE:
        !            78: ===========================
        !            79: 
        !            80: The text above already indicated that Jove comes in different versions
        !            81: for different types of computers. Not only that, there also exist
        !            82: versions that differ in the way they use the memory of the computer. 
        !            83: 
        !            84: The "large" versions of Jove use all the memory available if it is
        !            85: necessary. The temporary file can grow infinitely large in those
        !            86: versions. The number of lines that can be edited with the large
        !            87: version is about 20000 to 25000 on a PC with 640 kB of memory. Note
        !            88: that there is no limit on the size of the file itself.
        !            89: The "medium" versions of Jove are more conservative in their use of
        !            90: memory. They always take up about 130 kB of memory, which leaves a big
        !            91: rest for executing large programs, like the C-Compiler from within
        !            92: Jove. The size of the temporary file is also limited to 512 kB in the
        !            93: medium versions. The leads to a limit of approximately 4500 to 5000
        !            94: lines that can be edited at one time. 
        !            95: The standard executable files that are distributed in binary form, are
        !            96: usually the large ones. If you need a medium version, you either have
        !            97: to recompile Jove from the sources (see below), or you can get get
        !            98: it from someone else who has compiled it, for example from me.
        !            99: 
        !           100: There currently exist versions of Jove for three different types of
        !           101: msdos computers. PCJOVE is for IBMPC compatible computers. Compatible
        !           102: means here that the ROM Bios of your computer has to support the same
        !           103: Video output calls as the PC's. So even if your "clone" has trouble
        !           104: with many other programs, there's a high chance that Jove will work.
        !           105: MSJOVE should generally run on any computer that runs the msdos
        !           106: operating system. It strictly uses only well documented system calls
        !           107: to do its task. RBJOVE is a special version of MSJOVE for DEC Rainbow
        !           108: computers, which uses the Rainbows Bios for screen output and keyboard
        !           109: input. This makes it much faster than MSJOVE on the Rainbow.
        !           110: 
        !           111: 
        !           112: DIFFERENCES BETWEEN JOVE UNDER MSDOS AND UNIX JOVE:
        !           113: ===================================================
        !           114: 
        !           115: The msdos version of Jove currently supports all of the features that
        !           116: are possible to implement under msdos in a reasonable way.
        !           117: Version 4.8b in particular supports:
        !           118:        filename completion
        !           119:        comment filling 
        !           120:        creation of backup files
        !           121:        word abbreviation mode
        !           122:        Lisp mode
        !           123:        change directory within Jove
        !           124:        executing commands from within Jove
        !           125:        filtering regions through msdos commands
        !           126: You have to look into the manual for more explanations of these
        !           127: features. The things that are missing under msdos are:
        !           128:        spell-buffer (obsolete under msdos)
        !           129:        interactive shells in a window (not possible)
        !           130: There are however some features added, which are specific to the PC
        !           131: version.
        !           132: 
        !           133: Variables:
        !           134:  Background-color specifies the background color of the screen. The default
        !           135:     value is 0, which stands for black.
        !           136:  Foreground-color specifies the foreground color of the screen. The default
        !           137:     is 1, which stands for white. The attribute used for writing to the
        !           138:     screen is formed by (bg&7)<<4 & (fg&7).
        !           139:  Mode-line-color specifies the color of the modeline. Its default
        !           140:     value is 0, and in that case it is drawn in reverse video. If it has
        !           141:     any other value, this value is used as the attribute in Bios calls. 
        !           142:  (note that on a monochrome monitor the best thing is to leave the
        !           143:  default colors - anything else can lead to blank screens very easily)
        !           144: 
        !           145: Commands:
        !           146:  Scroll-previous-page continuously scrolls down screen-full lines.
        !           147:  Scroll-next-page continuously scrolls up screen-full lines.
        !           148:  Select-buffer-n, where n is in the range 0 to 9, selects buffer n as the
        !           149:     working buffer. These commands are bound to the <alt>[0-9] keys by
        !           150:     default. For example, pressing the alt key and 3 at the same time
        !           151:     switches immediately to buffer 3.
        !           152: 
        !           153: General:
        !           154:  PCJOVE supports the whole 8 bit character set of the IBMPC. You can
        !           155:  use all the line drawing characters in your files. It also knows
        !           156:  about some special foreign characters (Umlaute), which are treated
        !           157:  correctly as part of words and in case conversions.
        !           158: 
        !           159: 
        !           160: VIDEO MODES ON THE IBMPC:
        !           161: =========================
        !           162: 
        !           163: This concerns PCJOVE only. When Jove is started, it automatically
        !           164: checks which video mode is currently used, and adjusts itself
        !           165: correspondingly. This means that Jove will work correctly even in
        !           166: 40x25 mode. If you have an Ega card, and want to use the special mode
        !           167: with 43 lines, set the environment variable TERM to the value EGA, or
        !           168: set the variable EGA to any value. This will tell Jove to set the
        !           169: screen in 80x43 mode. The regular 80x25 mode is restored upon exit.
        !           170: On a color monitor, you can change the screen colors by using the
        !           171: commands mentioned above.
        !           172: There is a problem in using Jove together with Hershey
        !           173: MicroComputing's FansiConsole screen driver. FansiConsole doesn't
        !           174: properly set some of the values in the Bios control area. This usually
        !           175: leads to a crash when Jove starts. You can restore the information
        !           176: Jove needs by giving the command "mode co80" before starting Jove.
        !           177: Note that Kermit version 2.30 has the same problem, and that it can
        !           178: only be fixed by fixing FansiConsole.
        !           179: 
        !           180: 
        !           181: COMPILING JOVE UNDER MSDOS:
        !           182: ===========================
        !           183: 
        !           184: Jove can currently only be compiled with the Version 5.0 of the
        !           185: Microsoft C Compiler. Jove uses some library function calls that were
        !           186: not included with version 4.0 or earlier of Microsoft C. The makefile
        !           187: that is included with the sources will not work with Microsofts lousy
        !           188: make. I recommend that you use ndmake, a public domain (or is it
        !           189: shareware) make utility, which is much better than Microsofts.
        !           190: Jove can be compiled with the medium, or the large memory model. To
        !           191: get the IBMPC version, the option "-DIBMPC" should be given at the
        !           192: command line for the Compiler. Similarly, the define for the Rainbow
        !           193: version is RAINBOW. The variable MSDOS is always defined by the
        !           194: compiler. If you want to disable some features you can do so by making
        !           195: changes to tune.h.
        !           196: If you want to give away the version of Jove you are compiling to
        !           197: other people, don't use the loop optimizations or intrinsic
        !           198: functions!!! The compiler currently has some bugs in the optimizer,
        !           199: which causes it to produce wrong code sometimes, and in unpredictable
        !           200: places. Look at the function DoJustify(), in paragraph.c, for an
        !           201: example. Note that the #pragma is commented out. because compilers on
        !           202: other machines don't like it. If you find that the version you just
        !           203: compiled behaves strange in some way, and you compiled with
        !           204: optimizations on, check whether it works ok with optimizations
        !           205: disabled before you tell all the world about a new bug in Jove.
        !           206: If you want to compile MSJOVE or RBJOVE, you need the library MTERMLIB
        !           207: or LTERMLIB, for medium or large memory model, respectively. These
        !           208: libraries contain the functions for dealing with the termcap database.
        !           209: 
        !           210: If you want to compile Jove with Turbo-C, the port has already been
        !           211: done by Brian Campbell ([email protected]). A separate file with the
        !           212: diffs is currently available from him, and will probably be included
        !           213: as ifdefs in future versions.
        !           214: 
        !           215: If you find a bug in Jove, have some questions, or some suggestions,
        !           216: you are always welcome. Just send mail to me. My address is:
        !           217: 
        !           218:           Karl Gegenfurtner
        !           219: 
        !           220: arpa:     [email protected]
        !           221: uucp      {ihnp4|seismo|allegra}!cmcl2!xp!hipl!karl
        !           222: usps:     New York University
        !           223:           Dept. of Psychology
        !           224:           6 Washington Place 8th floor
        !           225:           New York, NY 10003

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.