Debian Codegraph @

README

raw
1 ##########################################################################
2 # This program is Copyright (C) 1986-2002 by Jonathan Payne. JOVE is #
3 # provided by Jonathan and Jovehacks without charge and without #
4 # warranty. You may copy, modify, and/or distribute JOVE, provided that #
5 # this notice is included in all the source files and documentation. #
6 ##########################################################################
7
8 [Updated in 2026 Jul]
9
10 JOVE on UNIX/Linux/MacOS X/*BSD/CygWin Systems
11 ----------------------------------------------
12
13 JOVE is Jonathan's Own Version of Emacs. It is an interactive
14 screen-oriented text editor that was meant to be compatible with EMACS,
15 but is also very small, fast and efficient. It is written in C, and
16 designed for use by C programmers.
17
18 Getting JOVE
19 ------------
20
21 JOVE releases are available at http://github.com/jonmacs/jove/ in
22 various source (github's automatically packed tar.gz, or a manually
23 packed .tgz which are essentialy identical, as well as a manually packed
24 .zip or .exe for MS-DOS), and some binary forms for various OS architectures
25 (Linux, DOS, Windows). All distributions include formatted manuals
26 (PDF, text) -- in the doc/ subdirectory for source and some binary,
27 or in share/doc/jove, share/jove or man/man1 (relative to
28 a top-level installation directory, such as /usr or /usr/local)
29
30 For information about other systems, see the other README files in
31 the source, zip or exe distributions:
32 README.dos for MS-DOS
33 README.win for MS Win32
34
35 Quick Summary of Installation
36 -----------------------------
37
38 Unpack the tar file somewhere convenient and cd into it:
39 tar xzf jove-VERSION.tgz
40 cd jove-VERSION
41 For old Unix, gunzip this the file on a modern platform, them copy the tar
42 over and use
43 tar xf jove-VERSION.tgz
44
45 Ensure you have the tools required to build Jove. You need a C compiler
46 (classic Unix cc, gcc or clang should work), the make utility,
47 and basic headers for libc, which may require extra packages on
48 some Linux distributions. groff is needed to format printed documentation,
49 though pre-formatted versions are often included in pre-packaged distributions.
50 ctags of some form is needed to generate tags file for Jove's find-tag commands.
51
52 Debian, Ubuntu, Mint: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends gcc make ncurses-dev pkg-config exuberant-ctags
53 Fedora, Red Hat and derivatives: yum install make gcc ncurses-devel groff-base ctags
54 Alpine: apk update && apk add gcc make musl-dev ncurses-dev pkgconfig ctags
55 MacOSX/Darwin: brew install make ncurses
56 Nix: nix-shell -p gnumake
57 Arch: pacman -Sy gcc make pkgconf ncurses groff ctags
58 Gentoo: # comes with gcc and make and headers by default!
59
60 For many modern systems (Linux, various BSDs, MacOSX/Darwin,
61 Solaris, OpenIndiana), an auxiliary script called
62 jmake.sh is provided that auto-detects what the SYSDEFS
63 and EXTRALIBS should be, and then invokes 'make'
64 without any manual configuration needed: just
65 specify JOVEHOME to change where you want jove installed
66 (default JOVEHOME is /usr/local, which puts the binaries in
67 $JOVEHOME/bin, manuals in $JOVEHOME/man/man1, other
68 documents and help and config in $JOVEHOME/share/jove,
69 helper programs in $JOVEHOME/lib/jove e.g. to put jove in
70 /opt/jove/{bin,share,...}
71
72 ./jmake.sh JOVEHOME=/opt/jove # to build
73 ./jmake.sh JOVEHOME=/opt/jove install # to install
74
75 To build a relocatable version of Jove (i.e. an install
76 directory that can be copied or moved freely to other paths)
77 in /foo
78
79 ./jmake.sh DESTDIR=/foo/ JOVEHOME= JBINDIR= JSHAREDIR=doc JLIBDIR= clean install
80
81 If jmake.sh does not work, please do file a bug, indicating
82 your system. One can also pass SYSDEFS, TERMCAPLIB and
83 EXTRALIBS (and other variables in the Makefile) by hand.
84
85 modern (Net|Open|Free)BSD/Darwin/Mac OS X:
86 use the first of the following that works:
87 make install
88 make SYSDEFS=-DXBSD install
89 make SYSDEFS="-DBSDPOSIX_STDC -DUSE_OPENPTY -DHAS_LIBUTILS_H" LDLIBS=-lutil install
90 make SYSDEFS="-DBSDPOSIX_STDC" install
91 make SYSDEFS="-DBSDPOSIX" install
92
93 classic BSD4.[0123]:
94 make SYDEFS=-DBSD4 JTMPDIR=/usr/tmp JRECDIR=/usr/preserve MKDIRP=mkdir LDLIBS=-ltermcap install
95
96 Linux:
97 Using RPM (if sufficiently close to Red Hat; make sure RPMHOME is correct
98 in the Makefile, that you have the rpm-build package, a compiler and
99 and use:
100 make rpm
101 and them install the resulting rpm from
102 $HOME/rpmbuild/RPMS with "rpm -i"
103
104 To compile and install from source, set JOVEHOME
105 appropriately. By default, Jove has internal support for
106 ansi/vt[1234]xx terminals that are emulated by every
107 modern desktop environment (i.e xterm, rxvt, st, vte,
108 konsole, {gnome,mate}-terminal, ...), so unless you have
109 some very special terminal, you should not need a general
110 purpose terminal handling library like termcap or curses.
111 But if you need one, the packages go by different names on
112 various Linux. If you install pkgconf (for the pkg-config
113 program) and the ncurses (which sometimes goes by names
114 like ncursesw, ncurses-base, ncurses-dev, ncurses-devel,
115 libncurses-dev, libtinfo-dev, sys-libs), that should be
116 enough on most Linux systems. Otherwise, you can
117 explicitly ask for it is using something like
118 make SYSDEFS=-D`uname` LDLIBS=-lncursesw
119
120 If you link with one of the general terminal handling
121 libraries rather than using Jove's builtin handling, then
122 you will also need to ensure you have terminal
123 descriptions, which are sometimes in separate packages
124 (e.g. called ncurses-terminfo-base or ncurses-base or ncurses-term)
125
126 Older Linux may need either SYSDEFS=-DXLINUX or SYSDEFS=-DBSDPOSIX_STDC
127 (but do test how interactive-shell works once built; the main
128 issues are pty-handling, even if they seem to compile without error)
129
130 Solaris 5.1 or newer:
131 make install
132
133 Other systems:
134 Read comments about SYSDEFS settings below, check sysdep.h
135 for recently tested system settings or old/sysdep.h for once-working
136 but currently untested settings that will need to be copied into sysdep.h,
137 or just set on the command-line with SYSDEFS="-D...", LDLIBS
138 if needed.
139
140 Cross-Compiling:
141
142 If your cross-compiler for some target FOO is FOO-gcc, then
143 you can probably cross-compile with
144 env JMAKE_UNAME=FOO-gcc ./jmake.sh
145 e.g.
146 env JMAKE_UNAME=i686-w64-mingw32 ./jmake.sh
147 or
148 env JMAKE_UNAME=i486-linux-musl ./jmake.sh
149
150 More generally, the Jove Makefile has some support for
151 cross-compiling. You need to set CC to the cross-compiler,
152 but please do not override CFLAGS, which consists of
153 SYSDEFS, (for any -I or -D cross-compiler options) and
154 OPTFLAGS (for any optimizer flags or special cross-compiler
155 options e.g. target arch).
156
157 For linking, you can set LDFLAGS (e.g. -L) or
158 LDLIBS for the cross-linker for the target system, while you
159 can set LOCALCC, LOCALCFLAGS, LOCALLDFLAGS, LOCALEXTRALIBS
160 and LOCALEXT for the local host machine compiler and linker
161 (usually none other than LOCALCC are needed, since they are
162 used when locally building the setmaps program on the host,
163 which is run to generate keys.c, which will then be
164 cross-compiled for the target) e.g.
165 make CC=/cross/bin/cc-armv7 SYSDEFS="-DLinux -DJTC" OPTFLAGS=-O2 LDFLAGS="-L/cross/lib" LDLIBS="-lutil" LOCALCC=cc
166
167 For another example, see README.win for cross-compiling
168 using MinGW for a Windows target.
169
170 Please help us keep up with new systems. If your system
171 isn't covered in jmake.sh or on in the SYSDEFS section
172 of Makefile, tell us what works. If your system is covered,
173 but the documented procedure doesn't work, tell us by filing
174 a bug on http://github.com/jonmacs/jove
175
176 Full Story of Installation
177 --------------------------
178
179 JOVE does not use any automatic configuring mechanism other
180 than the very simple jmake.sh script, which only works
181 on modern Linux/*BSD/MacOSX/Darwin/Solaris. System-specific
182 configuring is done by defining specific symbols from sysdep.h
183 in SYSDEFS in the Makefile (in most situations it is
184 handier to override definitions by supplying them on the make
185 command line rather than the classic technique of editing the Makefile).
186
187 JOVE has been around for a *long* time, and a lot of care has been taken
188 to make it work on many systems, new and old. For current systems,
189 less configuring is require -- hurray for standards!
190
191 Makefile specifies paths for installing JOVE components (JOVEHOME,
192 JSHAREDIR, JLIBDIR, JBINDIR, JMANDIR, MANEXT), tempfiles (JTMPDIR, JRECDIR),
193 and the default shell (DFLTSHELL). Although the defaults are
194 reasonable, you may wish to change them.
195
196 For many systems, you will need to change the definition of SYSDEFS.
197 to the symbol that identifies your system's characteristics, using the
198 notation for a macro-setting flag to the C compiler. For modern
199 systems, that symbol is often the output of the uname command.
200 For example, on a machine running NetBSD, use "SYSDEFS=-DNetBSD".
201 The Makefile describes suitable settings of SYSDEFS for many configurations.
202 If yours isn't mentioned, use "grep System: sysdep.h" to find all
203 currently supported system configurations. If there is no canned
204 configuration for your system, you will have to define a new symbol
205 and edit sysdep.h suitably. See "sysdep.txt" for the possible set of
206 system-dependent aspects that you can select/tune.
207
208 On some systems, you may need to change the flags passed to
209 the compiler (SYSDEFS, OPTFLAGS) or the linker (LDFLAGS,
210 LDLIBS). [These supersede the older Jove-specific
211 conventions of defining OPTFLAGS, SYSDEFS, TERMCAPLIB,
212 EXTRALIBS, which should still work]
213
214 Systems on which 4.17 was tested include the following
215 (and their SYSDEFS and LDLIBS will usually be
216 correctly set by the jmake.sh script that can be used
217 to to invoke make with auto-guessed values)
218
219 The following explicit settings also work
220 and may provide a guide to customization.
221
222 # Cygwin 3.1.2 SYSDEFS=-DCYGWIN LDLIBS= # builtin vt100/xterm/rxvt etc support, no need for curses dependency
223 # Darwin aka MacOS X onwards SYSDEFS=-DDarwin LDLIBS=-ltermcap
224 # FreeBSD 12.1 SYSDEFS=-DFreeBSD LDLIBS="-ltermcap -lutil"
225 # Linux (modern, glibc pty.h) SYSDEFS=-DLinux LDLIBS="-lncursesw -lutil"
226 # Linux (recent, UNIX98 PTYS) SYSDEFS=-DXLINUX LDLIBS=-lncursesw
227 # Linux (old, BSD PTYS) SYSDEFS=-DBSDPOSIX_STDC LDLIBS=-lncurses
228 # NetBSD 8.1 SYSDEFS=-DNetBSD LDLIBS="-ltermcap -lutil"
229 # OpenBSD 6.6 SYSDEFS=-DOpenBSD LDLIBS="-ltermcap -lutil"
230 # SunOS5.1 onwards (Solaris/OpenIndiana/Illumos/Joyent) SYSDEFS=-DSunOS LDLIBS=-ltermcap
231 # Debian Hurd 0.9 SYSDEFS="-DGNU -DJTC" LDLIBS=-lutil # LDLIBS="-lncursesw -lutil" might work, did not try
232
233 Next you may edit "tune.h" to select the compile time features you care
234 about. See "tune.txt" for a description of all the compile time options.
235 The default options are quite reasonable so, in most cases, you should
236 leave them alone. If you are really short on space, or are porting JOVE
237 to a new system, you may want to define -DBAREBONES in SYSDEFS to avoid
238 some of the less-portable features of JOVE initially.
239
240 You can type "make" to compile "jjove", "portsrv" (this is compiled on
241 every system, but is only used if JOVE is compiled with the PIPEPROCS
242 feature selection, typically on UNIX systems without pseudo ttys),
243 "recover" and "teachjove". Test jjove to see if it works (remember that it
244 won't be able to access its subsidiary files until they are installed, so
245 you will need to call it with "./jjove -l . -s doc ..." -- assuming you are
246 in the main JOVE directory). If it works, type "make install" to install
247 everything where it belongs.
248
249 Here are some things to consider when choosing a definition for
250 JTMPDIR, the directory where JOVE puts temporary files. The obvious
251 place is /tmp, but many systems delete all files in /tmp when they are
252 rebooting. If you hope to recover buffers from a system crash, TMPDIR
253 lets you specify a safer place. If your system does not remove
254 subdirectories of /tmp on reboot (lots do remove them these days) then
255 it makes sense to make TMPDIR be /tmp/jove; otherwise, /var/tmp may be
256 better. But if you use /tmp and want to recover buffers on system
257 crashes, you should put the lines:
258 (echo preserving JOVE files) >/dev/console
259 (cd /tmp; /usr/local/lib/jovelib/recover -syscrash) >/dev/console
260 in the /etc/rc file BEFORE /tmp is cleared, so that you can recover
261 files after reboots (hint: look for the equivalent code to preserve vi
262 tempfiles). You should then create a crontab entry to clear out old files
263 in /usr/preserve.
264
265 If you plan on using JOVE with a xterm, look at doc/XTermresource.
266 This file contains resource declarations that allow JOVE to respond to
267 more function keys and mouse gestures.
268
269 For RPM-based Linux, jspec.in specifies how an RPM should be created.
270 On most modern Red Hat Linux (Fedora, CentOS, etc), "make rpm" will build
271 source and binary RPMs -- rpm looks inside the .tgz to find jove.spec.
272 (Need to 'yum install rpm-build groff' or similar first)
273
274 It is possible to build a widely portable Linux binary using
275 static compilation, perhaps using the musl library to keep
276 size small. E.g., using the small Alpine Linux docker image,
277 with srcdir set to a directory with the unpacked Jove source code,
278 one can use:
279 docker pull alpine
280 docker run -v $srcdir:/src --rm -it alpine
281 apk add gcc musl-dev make
282 cd /src
283 make 'CC=gcc --static'
284 The resulting jjove can be run standalone pretty-much anywhere,
285 though the doc/jove.rc file might also be useful.
286
287 Some features.
288 --------------
289
290 "doc/jove.rc" and "doc/example.rc" are JOVE initialization
291 files. "jove.rc" is the recommended "system" rc file (until
292 you are ready to roll your own, that is). It gets read
293 every time JOVE starts up FOR EVERYONE ("make install"
294 should copy it to the right place automatically). After
295 that JOVE reads the initialization file .joverc in the
296 user's home directory. "example.rc" is taken from a
297 personal .joverc.
298
299 The files intro.nr and cmds.nr in the doc directory are the
300 official JOVE manual. Jonathan got permission from Richard
301 Stallman to use his manual for the original EMACS, modifying
302 it where necessary for JOVE. Lots of work was done by Brian
303 Harvey on this manual. When formatted, these are usually
304 in some system doc directory, typically /usr/share/doc/jove/
305 or /usr/local/share/doc/jove, as a PDF and a text form.
306 There is also a quick-reference card with most JOVE key-bindings,
307 commands and variables, best printed in landscape mode.
308
309 There are Unix-style manual pages for jove and teachjove. Teachjove is
310 an interactive tutorial for people who have never used EMACS style
311 editors -- it can be started from within JOVE as the "teach-jove"
312 command, usually bound to ESC t or historically, using the special Unix
313 command "teachjove". It is THE tutorial written by Stallman for the
314 original EMACS, only slightly modified for JOVE in the appropriate
315 places. The manual pages are hopefully up to date.
316
317 Optionally, if you want to use Jove to work with C source code, and
318 know/like tags, you will need ctags or etags on your system so that you
319 can generate tags files to use with jove -t or Jove's find-tag command
320 (bound to the keys "^X t").
321
322 If you use Jove to work with text documents, and use the built-in
323 spell-check support (i.e. Jove's spell-buffer command), you will
324 need to install spell-checker program (spell on classic Unix, aspell
325 on Linux/BSD).
326
327 Optionally, if you want to modify, rebuild or reformat the
328 documents, you will need a troff-style formatter (the package
329 called groff on modern Linux/*BSD. You will also need the "ms"
330 macros, should be included with most modern groff, though not
331 in the scaled-down groff-base packages)
332
333 Optionally, if you want to use 'make zip' to build a source
334 archive suited to DOS/Windows, you will need the zip program
335 (generally, a package called zip on most Linux/*BSD)
336
337 Older, once-working systems
338 ----------------------------
339 For the pdp11 version there was once the Ovmakefile, which had only been
340 tested on 2.9bsd once upon a very long ago. It supposedly worked.
341 and it was possible to turn on all the compile time options with that
342 version. Maybe someone will try a PDP-11 emulator one day with 2.11BSD
343 and report back?!
344
345 The following used to work circa Jove 4.16 in the 1990s and have probably not
346 been tested in the 21st century, so their definitions were deleted from
347 sysdep.h, copies are still in old/sysdep.h. They may still build but some of
348 this ancient support may be deleted from Jove at some point, we welcome any
349 recent success stories from jove builders/packagers to refresh or maintain
350 these. Pretty please! (e.g. a 2023 test with simh emulating a vax running
351 4.3BSD produced the fixes in 4.17.5.4) Most need LDLIBS=-ltermcap, but if you
352 get link errors for tputs or tparm, try LDLIBS=-lcurses
353
354 # Apple A/UX on macIIs SYSDEFS=-DA_UX
355 # BSD4.1 SYSDEFS=-DBSD4 LDLIBS="-ljobs -ltermcap"
356 # BSDI, 386BSD, BSD4.4 SYSDEFS=-DBSDPOSIX
357 # Consensys V4 SYSDEFS="-DSYSVR4 -DGRANTPT_BUG"
358 # Compaq Tru64 UNIX V4.0g, 5.1 SYSDEFS=-DSYSVR4
359 # DEC OSF R1.3MK SYSDEFS=-DSYSVR4
360 # DEC OSF/1 V1.3 SYSDEFS="-DBSDPOSIX -DNO_TIOCREMOTE -DNO_TIOCSIGNAL"
361 # DEC OSF/1 V2.0 and later SYSDEFS=-DSYSVR4
362 # DEC Ultrix 4.2 SYSDEFS=-DBSDPOSIX
363 # DEC Ultrix 4.3 SYSDEFS="-DBSDPOSIX -DJVDISABLE=255"
364 # Digital UNIX V4.0 and later SYSDEFS="-DSYSVR4 -DGRANTPT_BUG"
365 # DG AViiON 5.3R4 SYSDEFS="-DSYSVR4 -DBSD_SIGS"
366 # HP/UX 8 or 9 SYSDEFS="-DHPUX -Ac"
367 # HP/UX 11 (-Ac redundant) SYSDEFS=-DHPUX
368 # IBM AIX 3.2 SYSDEFS=-DAIX3_2
369 # IBM AIX 4.2, 5.2 SYSDEFS="-DAIX4_2" LDLIBS="-lcurses -ltermcap -ls"
370 # Irix 3.3-4.0.5 SYSDEFS="-DIRIX -DIRIX4"
371 # Irix 5.0 onwards SYSDEFS="-DIRIX -prototypes"
372 # Linux (ancient e.g. RedHat 4,5) SYSDEFS=-DBSDPOSIX
373 # MIPS RiscOS4.x SYSDEFS="-systype bsd43 -DBSD4"
374 # SCO Unix SYSDEFS=-DSCO LDLIBS=-lcurses
375 # SunOS3.x SYSDEFS=-DSUNOS3
376 # SunOS4.0* SYSDEFS=-DSUNOS40
377 # SunOS4.1* SYSDEFS=-DSUNOS41
378 # SunOS5.0 (Solaris 2.0) SYSDEFS="-DSYSVR4 -DGRANTPT_BUG"
379 # Sys III, Sys V R 2,3 SYSDEFS=-DSYSV PORTSRVINST='$(PORTSRV)' LDLIBS=-lcurses
380 # Sys V Release 4.0 SYSDEFS="-DSYSVR4 -DGRANTPT_BUG" LDLIBS=-lcurses
381 # Sys V Release 4.x SYSDEFS=-DSYSVR4 LDLIBS=-lcurses
382 #
383 Some systems based on System V release 4 have a bug affecting interactive
384 processes. This bug can be worked around by defining GRANTPT_BUG.
385 Read the explanation of GRANTPT_BUG in sysdep.txt.
386
387 Notes for invoking make:
388
389 # For SYSVR4 (/usr/ucb/cc will NOT work because of setjmp.h):
390 # CC = /usr/bin/cc
391 # To use the SunPro compiler under SunOS 4.n:
392 # CC = acc
393 # To use the official Sun compiler under Solaris 2.n:
394 # CC = /opt/SUNWspro/bin/cc
395 # For DG AViiON, expect compile errors unless you use the GNU C compiler:
396 # CC=gcc
397
398 LDCC is the load invocation of CC which can be changed to invoke
399 link-time tools e.g. to use Purify(TM), try:
400 LDCC = purify $(CC)
401
402 Systems that used to need LDFLAGS
403 # SysV Rel. 2: LDFLAGS = -Ml
404 # SCO Xenix: LDFLAGS = -Ml -F 3000
405 # AIX Unix: LDFLAGS = -bloadmap:[email protected] # only if loadmap
406 #
407 # To optimize the use of the address spaces, add to the LDFLAGS:
408 # PDP-11 with separate I&D: -i
409 # PDP-11 without separate I&D: -n
410
411
412 For SCO Xenix, this might need to be set
413 # LOCALCFLAGS = -Mle
414 # OPTFLAGS = -LARGE -O -F 3000 -K -Mle (say -Mle2 for an 80286)
415
416
417 For compiler OPTFLAGS set in the Makefile:
418 # On the official Sun ANSI C compiler and the standard System V Release 4
419 # compiler, adding -Xa -v will increase compiler checking.
420 # On DEC OSF/1 and Digital UNIX VV4.0, add -std1 to enable ANSI C features
421 # and perhaps -g3 for more debugging info with optimization.
422 # Some old versions of the HPUX C compiler have a bug in handling forward
423 # struct tag declarations. Using the -Ac flag in place of -Ae will avoid
424 # this problem (and reduce the compiler's error checking, unfortunately).
425
426 # For install on 4BSD, SunOS
427 #XINSTALL=/usr/ucb/install $(INSTALLFLAGS) -c -m 755 # -s
428 #TINSTALL=/usr/ucb/install $(INSTALLFLAGS) -c -m 644
429 # newer Solaris 2.x aka SunOS 5.x
430 #XINSTALL=/usr/gnu/bin/install $(INSTALLFLAGS) -m 755
431 #TINSTALL=/usr/gnu/bin/install $(INSTALLFLAGS) -m 444
432 # SysV-derivatives, or non-BSD Unix (V7, etc)
433 #XINSTALL=cp
434 #TINSTALL=cp
435
436 Some acknowledgments.
437 ---------------------
438
439 Thanks to Jay (hack) Fenlason for writing the original pty code.
440
441 Thanks to Dave Curry at Purdue for putting in tons of time and effort
442 into getting JOVE ready. It just wouldn't be working without his help.
443
444 Thanks to Jeff Mc Carrell at Berkeley for finding bugs and adding
445 features, in particular, the comment formatter.
446
447 Thanks to Karl Gegenfurtner for making the PC version.
448
449 Thanks to Ken Mitchum for the Macintosh version.
450
451 Thanks to Hugh Redelmeier for his input, his experience, countless bug
452 fixes, and ... that's it, I guess.
453
454 Thanks to Arlindo da Silva and Dave Curry for the original Cygwin ports.
455
456 Thanks to Ken Mitchum for the original Mac port.
457
458 (Thanks to Brian Harvey for teaching me about linked lists ...)
459
460 Good luck, have fun.
461
462 Jonathan Payne (once [email protected], sun.com, marimba.com :-)
463
464 Thanks to Charles Lindsey for the xjove/jovetool and xterm mouse support.
465
466 Thanks to Jim Patterson for the Win 32 port.
467
468 Thanks to the other JoveHacks for testing and for contributing numerous
469 fixes, portability enhancements, and pieces of sage advice.
470
471 D. Hugh Redelmeier
472
473 Thanks to Cord Beermann for Debian packaging, Peter Cock for conda packaging,
474 Paul Vixie for FreeBSD packaging and many fixes.
475
476 Mark Moraes
477
478 Changes in 4.17.*
479 -----------------
480
481 - github
482 - Portability fixes, mainly removal of overlapping strcpy
483 for Linux, *BSD, Darwin/MacOS, but also Windows and MinGW
484 fixes, FreeDOS (!), OpenIndiana. 4.3BSD tested again!
485 - Much build cleanup/revamp. Remove some ancient systems from
486 sysdep.h since there seems no hope of testing them.
487 - Use aspell if available on Linux
488 - Handle terminals wider than 256 chars!
489 - Handle line-numbering correctly if >1M lines!
490 - Default line length max to 32K now
491 - Fast/simple code to directly handle 99.9% of all currently
492 used terminals (vt100+ derivatives) without needing termcap/terminfo/curses.
493 - Do not allow writeback of files if lines were too long, and thus truncated,
494 do not conflate shell output windows with files of the same name.
495 - Horizontal scroll of the minibuffer.
496
497 Changes in 4.16.*
498 ------------------
499
500 - Portability fixes. Most important: work around a never-to-be-fixed
501 bug in ncurses (the freely redistributable termcap/terminfo
502 database).
503
504 - Various minor bug fixes. Highlights:
505 + use mkstemp to avoid a security loophole
506 + avoid bad interaction between metakey and xterm mouse support
507 in windows wider than 95 characters
508 + handle symlinks better
509 + obscure bug in text justification that could hang JOVE
510 + misuse of stat that only misbehaved on LINUX
511
512 Changes since 4.16beta
513 ----------------------
514
515 - Added the variable paragraph-delimiter-pattern to customize paragraph
516 recognition.
517
518 - Ported to Win 32 (but not Win 32s)
519
520 - Several variables have been renamed to more clearly indicate their function.
521 The old name will still work, but eventually it will be eliminated.
522 allow-bad-filenames => allow-bad-characters-in-filenames
523 display-bad-filenames => display-filenames-with-bad-extensions
524 internal-tabstop => tab-width
525
526 - Several minor bugs fixed. Several portability improvements.
527 + MSDOS: avoid date rollover problem
528 + Borland C: support version 4
529 + Borland and Microsoft C: enable HIGHLIGHTING
530 + NetBSD: dodge ssize_t redefinition
531 + SCO UNIX: use <ctype.h>
532 + SunOS + Solaris: make charp effective
533 + generic: Ensure screen is maintained during non-interactive processes,
534 even if the user has typed ahead
535
536 - The xterm mousing interface has been completely revamped.
537 Some small ancillary consequences of this are
538 + A next-line (prev-line) landing in the middle of a Tab selects the Tab
539 character (rather than the following one)
540 + A yank-pop is no longer permitted to follow a copy-region.
541
542 Changes since version 4.14.6.
543 -----------------------------
544
545 JOVE now works on many newer systems. For example, it compiles
546 under Solaris 2.n (SYSDEFS=-DSYSVR4).
547
548 The uninstalled binary in the JOVE directory is jjove instead of xjove
549 (xjove is now something else).
550
551 The new command line flag -J inhibits the reading of the global
552 jove.rc file. Similarly, -j inhibits ~/.joverc.
553
554 JOVE's auxiliary files are kept in two directories (actually, they can be
555 the same directory). The sharedir holds the system jove.rc and cmds.txt,
556 the data used to implement the describe-command and describe-variable
557 commands; these files are meant to be machine-independent. The libdir
558 holds portsrv and recover; these are compiled programs, and are
559 machine-dependent.
560
561 There are three ways JOVE uses to determine each of the directories, two
562 of them new. If JOVE was invoked with -l dirname, dirname is taken as
563 the LibDir; otherwise, if the environment contains JOVELIB, its value is
564 taken as the LibDir; otherwise, the value of the make variable $(LIBDIR)
565 when JOVE was compiled is used as LibDir. Similarly, -s dirname,
566 JOVESHARE, and $(SHAREDIR) specify ShareDir. As a shortcut, -ls dirname
567 specifies both directories. Now, a good way to test an uninstalled
568 version of JOVE is to say, within the JOVE directory,
569 jjove -s doc -l . other_parameters
570
571 A new command "pushlibd" effectively does a pushd command with ShareDir as
572 the operand. This is for use within startup files such as jove.rc.
573
574 The global startup file is now in doc/jove.rc (was doc/system.rc), so the
575 -s flag can find it as above. It contains lots of goodies (you might not
576 want all of them), including an ability to call up additional TERMinal
577 specific startup files depending on the $TERM environment variable.
578 Among other things, these provide support for the many wacky keys that
579 terminal makers provide. See doc/README.
580
581 The old make-keymap and bind-keymap-to-key commands are no longer needed.
582 Instead, bind-to-key can accept character strings of any length (they had
583 better not be a prefix of any other binding). This enables, among other
584 things, binding commands to the function keys on Sun keyboards. Buffer-
585 specific bindings are now supported (local-bind-* commands).
586
587 All system dependencies are now gathered together in the file sysdep.h, to
588 make it easier to select the bits of code which should or should not be
589 included for various flavors of UNIX.
590
591 The position of the mark is now indicated by underlining it (the position of
592 point is, of course, indicated by the cursor, so the extent of the region is
593 now easily seen). The bad news is that, although this works well on
594 terminals, underlining is broken in some environments (notably SunView
595 and the versions of OpenWindows with SUNOS4.1.x and Solaris 2.0 -- Solaris
596 2.1+ is OK). For the broken OpenWindows versions, you can include the
597 following in your .Xdefaults file
598 term.boldStyle: Offset_X_and_Y
599 term.underlineStyle: Same_as_Bold
600 The stock X11 terminfo entry for xterm was broken until X11R6 in a way that
601 will cause the screen to be scrambled when JOVE tries to use underlining.
602 The following fixes to the entry solve this problem and more:
603 replace "blink=@," with "blink@,"
604 replace "rs2=@" with "rs2@," [note the added comma!]
605 add "kf1=\EOP," [if not already be present]
606 delete "smul@," and "rmul@," [if present]
607 add "smul=\E[4m, rmul=\E[m," [xterm does support underlining]
608
609 The portion of the buffer visible in the window is now indicated by
610 "uninverting" a part of the modeline in proportion. This feature is really
611 intended for use with "xjove" (described next), and there is a variable
612 "scroll-bar" to enable it.
613
614 xjove is a complete front-end for JOVE which will be found in the directory
615 xjove (see the README there). It enables setting of point and mark with the
616 mouse, cutting and pasting of text via the region, and scrolling by pointing
617 into the modeline. It is written using the XView library (supplied with
618 Suns, or with the X-distribution from MIT); there is also a version for
619 Sunview known as jovetool. See its man entry in doc/xjove.nr.
620
621 An alternative way of using the mouse is provided in the form of commands
622 designed to recognize the mouse events coded by Xterm. These facilities
623 are not nearly as extensive or convenient as those provided via xjove or
624 jovetool.
625
626 Within SHELL windows, the TERM environment variable is now set to "dumb",
627 mainly to discourage running programs which might have depended on something
628 else. Some shells (tcsh, for example) might prefer the emacs
629 terminal type; JOVE also sets the INSIDE_JOVE variable, which can
630 be used to set things up for shells, as well as the proc-env-export,
631 and proc-env-unset commands for subshells and corresponding
632 iproc-env-export and iproc-env-unset commands for interactive processes.
633
634 By default, commands requiring a "y" or "n" response require a Return as
635 well. When variable "one-key-confirmation" is set "on", a single
636 character "y" or "n" is expected.
637
638 Some features have been removed. Marks always float, so the variable
639 "marks-should-float" is gone. The IBMPC-specific commands scroll-*-page
640 are gone.
641
642 JOVE is now 8-bit clean (the old behavior can be retained by setting NCHARS
643 to 128 in sysdep.h, but no known system requires this setting). In operating
644 systems with the necessary support (USE_CTYPE set in sysdep.h) it is
645 possible to set the environment variable LC_CTYPE (or the JOVE variable
646 lc-ctype) to a "locale" such as "iso_8859_1", whereupon characters with the
647 8th bit set sent from the keyboard (using the Alt Graph key, or the Compose
648 key, or the Meta key, or whatever the particular hardware provides) will be
649 displayed correctly, and will be treated as upper/lower case, etc in the
650 correct manner. The default locale is "C", which reverts to 7-bit ASCII with
651 the top 128 characters being displayed in octal.
652
653 The format of the "jrec" file (now "jr*" ) has changed.
654 This means that previous versions of recover cannot deal
655 with the files left by crashes of the new JOVE, and vice versa.
656 4.17+ recover will realize this.
657
658 Here is a list of reasons why your .joverc might no longer work. JOVE
659 places diagnostics about the user and system .joverc files in the buffer
660 "RC errors".
661
662 - JOVE no longer ignores extra stuff on the end of binding commands.
663
664 - All keymap creation is implicit. You no longer can or need to create
665 new keymaps explicitly.
666
667 - auto-execute-command no longer magically supplies a numeric argument
668 for its command. If the command is intended to set a mode, you should
669 supply the argument. If you don't set the numeric argument, the mode
670 will be flipped. Here is an example from the system jove.rc:
671 1 auto-execute-command c-mode .*\.[chy]$
672
673 - Within regular expressions, alternatives are separated by "\|".
674 Previously, alternatives within braces were separated by ",".
675 For example, "/tmp/\{Re,article,rnmail,pn\}" must be changed to
676 "/tmp/\{Re\|article\|rnmail\|pn\}".
677
678 - auto-execute-command and auto-execute-macro both require explicit
679 patterns. Previously, the pattern would default to match every filename.
680
681 - Certain commands and variables have been eliminated or renamed:
682
683 bind-keymap-to-key, make-keymap, process-bind-keymap-to-key --
684 no longer needed
685 unbind-key -- bind the "unbound" command instead
686 marks-should-float -- they always do now
687 physical-tabstop -- now picked up from termcap
688 scroll-next-page, scroll-previous-page -- IBM PC only, and useless
689 background-color => background-attribute -- IBM PC only
690 foreground-color => foreground-attribute
691 mode-line-color => mode-line-attribute
692
693 - On the IBM PC, the Delete key now generates the ASCII DEL character;
694 Control-@ and Control-Space now generate the ASCII NUL character.
695
696
697 Known problems
698 --------------
699
700 In an interactive process buffer, JOVE sometimes fails to
701 receive an end-of-file through the pseudo-tty, reporting
702 "[Process i-shell: Exited 0; not EOFed]" rather than
703 "[Process i-shell: Done]". In this case, the process window
704 will not be considered done, even though the child and all
705 its ancestors are dead. The only consequences are that the
706 status display continues to report that the process is not
707 done and that another process may not be started up in that
708 buffer. This only happens on certain systems, not sure why.
709 For example, this worked fine upto Debian 9, and broke in
710 Debian 10 (using SYSVR4 ptys), and is fixed by switching to
711 GLIBCPTY. e.g. https://github.com/jonmacs/jove/issues/6
712
713 If a window-find command is issued while the current window's lines
714 are numbered, the numbering may become wrong temporarily. We are
715 working on this bug.
716
717 JOVE can not handle lines longer than JBUFSIZ characters
718 (usually 4096, but 512 on some small systems). Eliminating
719 this limit is not easy. JBUFSIZ is 2^LG_JBUFSIZ, which can
720 be raised; JOVE keeps NBUF such buffers in memory and
721 reads/writes these from/to a temporary file, and lines may
722 not exceed a buffer, so making LG_JBUFSIZ larger increases
723 the max line length. However, it increases memory
724 consumption, though that only matters on machines in the
725 sub-megabyte range.
726
727 JOVE can not handle NUL characters in the buffer. In most cases,
728 they are discarded silently, another dubious feature.
729
730 JOVE does not handle Unicode (aka UTF-8), it silently ignores LANG,
731 locale etc. Fixing this limitation is not easy.
732
733 Bug Reports and Maintenance.
734 ----------------------------
735
736 Jonathan Payne no longer works on JOVE.
737
738 A group of JOVE maintainers supports the
739 github.com/jonmacs/jove releases and welcomes:
740
741 - help or success reports or issues with porting for additional systems
742
743 - bug reports (we may already have an explanation or fix)
744
745 - suggestions for and implementations of improvements or additional
746 features (we do try to keep JOVE small)
747
748 See https://github.com/jonmacs/jove for JOVE updates.
749
750 A mailing list for discussions and mutual help amongst JOVE users exists
751 at jove-users _at_ freelists _DOT_ org