Debian Codegraph @

doc/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 README this file
9
10 cmds.macros.nr nroff macros used to format cmds.nr to produce cmds.txt
11 intro.nr introductory part of JOVE manual; combined with cmds.nr
12 to produce complete manual (nroff input)
13 cmds.nr descriptions of JOVE commands (and variables) (nroff input)
14
15 jove.nr JOVE manpage (nroff input)
16 teachjove.nr teachjove manpage (nroff input)
17 jovetool.nr jovetool manpage (nroff input)
18 xjove.nr xjove manpage (nroff input)
19
20 jove.qref JOVE quick reference documentation
21
22 teach-jove text used by teachjove program
23
24 example.rc sample user .joverc (startup file)
25
26 jove.rc standard system startup file
27 jem.txt Jove Beginner Easy Menu help text file
28
29 jove.rc.3022 startup files for specific terminals
30 jove.rc.sun
31 jove.rc.sun-cmd
32 jove.rc.vt100
33 jove.rc.wyse
34 jove.rc.xterm
35 jove.rc.xterm-256color
36 jove.rc.z29
37
38 test*.rc these are tests for JOVE's joverc code, developer use only
39
40 keychart.3022 keyboard binding descriptions for specific terminals
41 keychart.sun
42 keychart.sun-cmd
43 keychart.vt100
44 keychart.wyse
45 keychart.xterm
46 keychart.xterm-256color
47 keychart.z29
48
49 XTermresource X Window System resource file to improve the codes
50 generated by XTerm. See comments in the file.
51
52 The Makefile in the parent directory contains recipes for building
53 and installing documentation and for installing the various startup
54 files.
55
56 The file jove.rc is intended to be 'source'd before each run of jove
57 (except when the -J flag is given). This file contains various
58 initializations, some of which are pretty well essential and some of which
59 are suggestions for sysadmins to experiment with. See the comments in
60 this file. Note that if you hack this file, you must take precautions to
61 avoid your changes being lost if you upgrade Jove. See jove-local.rc
62 and /etc/jove/jove.rc below for alternatives for performing local
63 customizations that should not be lost on new installs.
64
65 jem.txt is a simple startup help window that is displayed (from jove.rc)
66 if (on Un*x systems) the user does not have a.joverc file. It can also be
67 suppressed by setting the environment JOVENOHELP=1 (useful for non-Un*x).
68
69 A files jove.rc.$TERM, where $TERM is the value of the TERM environment
70 variable, is 'source'd near the end the generic jove.rc, and provides
71 suggested bindings for the function keys on the various terminals. The
72 selection of terminals given is somewhat arcane, and suggestions for
73 bindings for other terminals would be welcomed. See the comments in these
74 files.
75
76 After jove.rc.$TERM is source'd, a file jove-local.rc is source'd if it
77 exists. Local settings can be placed in this file that will add to or
78 override previous settings from jove.rc and/or jove.rc.TERM files.
79 jove-local.rc may contain terminal bindings but is not terminal specific;
80 if a site does a lot of terminal key binding customization for multiple
81 terminal types, it should likely create a local terminal file and source
82 it from this file (see jove.rc for an example of how to do this).
83 Finally, if a file called /etc/jove/jove.rc is found, it is sourced.
84 That file is expected to contain per-host or per-distro settings.
85
86 The user's $HOME/.joverc will be 'source'd after jove.rc.$TERM and
87 jove-local.rc . User preferences belong in this file.
88
89 The files keychart.TERM, where TERM is the value of the $TERM environment
90 variable, are intended to display a map of the Function Keys on the
91 particular keyboard showing what they are bound to. This file will be
92 displayed when the user gives the 'keychart' macro (which should usually
93 be bound to the Help key, if there is one). Some of these files also
94 contain setup information for the terminal.
95
96 We welcome contributions to our collection of terminal support files.
97 We don't have the resources to create more than a few ourselves.