9648c27871eec7bc6db2c251f9e6f1da3e6ba650
[dragonfly.git] / contrib / tcsh-6 / README
1 This is tcsh version 6.15.  Tcsh is a version of the Berkeley
2 C-Shell, with the addition of: a command line editor, command and file
3 name completion, listing, etc. and a bunch of small additions to the
4 shell itself.
5
6 Tcsh has been ported to most unix variants, and can be tinkered to work
7 in unix systems that it has not ported yet. See the Ported file for
8 a more complete list of ported systems and in the config directory for
9 a configuration file that matches your system.
10 Tcsh also runs under VMS/POSIX and OS/2+emx; the OS/2 port is not
11 complete yet.
12
13 Feel free to use it.  These changes to csh may only be included in a
14 commercial product if the inclusion or exclusion does not change the
15 purchase price, level of support, etc.  Please respect the individual
16 authors by giving credit where credit is due (in other words, don't
17 claim that you wrote portions that you haven't, and don't delete the
18 names of the authors from the source code or documentation).  
19
20 To install tcsh:
21
22 0)  Try running "./configure".  If that doesn't work, goto step 1.
23     Run "./configure --help" to see possible options.  After running
24     configure, goto step 3.
25
26 1)  Otherwise copy Makefile.std to Makefile. Look at the Makefile and
27     make sure that you are using the right compilation flags.
28
29 2)  Copy the appropriate for your machine and OS config file from the
30     config subdirectory into config.h.  Consult the file "Ported" for
31     settings known to work on various machines.  If you are trying to
32     compile tcsh on a machine for which there is no config file yet,
33     you will need to create a config file using as a template one of
34     the supplied ones.  If you get tcsh working on a new machine, I'd
35     appreciate a copy of the config file plus additional information
36     about the architecture/OS.  If you are creating a new config file,
37     look very hard at BSDJOBS and BSDTIMES if you are running
38     a non-BSD machine.  For vanila SysV, these would all be #undef-ed,
39     but others may vary (such as A/UX or HPUX).  On a pyramid, compile
40     in the UCB universe even if you are running under the ATT universe
41     usually; it will work anyway, and you get job control for free.
42
43 3)  Look at config_f.h, and enable or disable any features you want.
44     It is configured the way I like it, but you may disagree.
45
46 4)  Look at host.defs to make sure that you have the right defines to set
47     the environment variables "HOSTTYPE", "MACHTYPE", "OSTYPE" and 
48     "VENDOR" correctly.  If you need to make changes, PLEASE SEND THEM 
49     BACK TO ME.
50
51 5)  You may want to adjust the DESTBIN and DESTMAN entries in
52     the Makefile.  These are the directories that tcsh, and the tcsh.1
53     man entry will be placed in when you do a "make install" and "make
54     install.man" respectively.  If you decide to install tcsh somewhere
55     other than in /usr/local/bin/tcsh, you should #define _PATH_TCSHELL
56     "/your/installation/directory/tcsh" in pathnames.h.
57
58 6)  make
59
60 7)  Read the documentation while you are waiting.  The file tcsh.man
61     is in standard [nt]roff -man format. If you like, you can run the
62     tcsh.man2html script (requires Perl) to generate an HTML version of
63     the manpage which you can read with Mosaic, lynx or other HTML browser.
64
65 8)  Test tcsh by typing ./tcsh to see that it has compiled correctly.
66     The history command should give a time stamp on every entry.
67     Typing normal characters should echo each exactly once.  Control-A
68     should put the cursor at the beginning of the input line, but after
69     the prompt.  Typing characters after that should insert them into
70     the line.  If you have job control make sure that stopping and
71     restarting jobs works. Make sure you can ^C in the middle of the
72     input line.  Also make sure that pipelines work correctly and there
73     are no races. Try 'echo | cat | cat | cat | cat | more' a couple of
74     times. If you have job control, try this command in the background
75     and bring it in the foreground when it stops for tty output.  Also
76     make sure that the ioctl() modes are preserved.  Get into vi, enter
77     and exit input mode and suspend it, background it and foreground it
78     again. After all that, lastly make sure that the tty process group
79     manipulation is happening correctly. Try ftp to some host. If your
80     passwd appears on the screen, you have lost /dev/tty. Otherwise
81     everything is fine.
82
83 9)  Once satisfied that tcsh is working correctly, complete the installation
84     by typing "make install" to install the binary, and "make install.man" to
85     install the documentation. Don't forget to look at complete.tcsh for
86     useful completions...
87
88 10) Enjoy.
89
90 12) PLEASE file any bug reports (and fixes), code for new features at:
91
92         http://bugs.gw.com/
93
94     Comments, questions, etc. (even flames) are welcome via email to:
95
96         The tcsh bugs mailing list
97         tcsh-bugs@mx.gw.com
98
99 Various:
100
101 ***************************************************************************
102
103 On sysv versions < 3.0 (not hpux) Doug Gwyn's public domain directory 
104 manipulation library has to be installed. This library is available
105 for anonymous ftp from prep.ai.mit.edu:/pub/gnu/dirent.tar.Z
106 If the network is not installed, then there is a gethostname()
107 routine is tc.os.c
108
109 ***************************************************************************
110
111 On BSDreno, in ttyname() closedir() is called twice and so the same
112 pointer gets free'd twice. tcsh's malloc is picky and it prints an
113 error message to that effect. If you don't like the message:
114
115 1. Apply the following patch:
116
117 *** /usr/src/lib/libc/gen/ttyname.c.orig        Fri Jun  1 17:17:15 1990
118 --- /usr/src/lib/libc/gen/ttyname.c     Tue Oct 29 16:33:12 1991
119 ***************
120 *** 51,57 ****
121                 if (stat(buf, &sb2) < 0 || sb1.st_dev != sb2.st_dev ||
122                     sb1.st_ino != sb2.st_ino)
123                         continue;
124 -               closedir(dp);
125                 rval = buf;
126                 break;
127         }
128 --- 51,56 ----
129
130 Or: Comment the error printing out in tc.alloc.c
131 Or: Compile -DSYSMALLOC
132
133
134 ***************************************************************************
135
136 From: Scott Krotz <krotz@honey.rtsg.mot.com>
137
138 Tcsh has been ported to minix by  Scott Krotz (krotz@honey.rtsg.mot.com).
139 Unfortunately the minix sed is broken, so you'll have to find a way to
140 make tc.const.h, sh.err.h, ed.defns.h which are automatically generated.
141 The easiest way to create them is to make a copy from unix, copying 
142 minix to config.h, and then 'make sh.err.h tc.const.h ed.defns.h'
143
144 The OS/dependent files are in mi.termios.h, mi.wait.h, mi.varargs.h
145
146 You will get some warnings, but dont worry about them, just ignore
147 them.  After tcsh has compiled and the gcc binary is converted to a
148 minix binary, remember to chmem it to give it more memory - it will
149 need it!  How much you need depends on how many aliases you have, etc..
150 Add at least 50000 to it.
151
152 One last thing.  You might have to make some links for include files so
153 that they are in the directories that tcsh is expecting while compiling.
154 I forget if I had to do this or not, but it should be fairly easy to sort
155 out.  If it cant find any include files this is probably the reason.
156
157 If you have any problems, please tell me.  I can be contacted through
158 e-mail at:
159
160 krotz@honey.rtsg.mot.com
161
162 I also read comp.os.minix on a regular basis, so a note there will get
163 my attention also.
164
165 Have fun!
166
167 ps.  The termios functions are provided by Magnus Doell and Bruce Evans.
168      Thanks, guys!
169
170
171 From: Bob Byrnes <byrnes@ee.cornell.edu>
172
173 This is for minix 1.5 (straight out of the box from P-H) plus the i386
174 patches from Bruce Evans.
175
176 I cross-compiled on a Sun using gcc 2.1 with a target of i386-bsd
177 (using the minix include files instead of the bsd versions), and then
178 linked the resulting object files with similarly compiled crtso.o and
179 libc.a on vax (little endian) using a hacked version of ld which I put
180 together to generate minix executables instead of bsd a.out format.
181 What a kludge ...
182
183 I compiled with -O2 -Wall ...  So far I haven't noticed any problems
184 with the optimizer.
185
186 In case anyone is contemplating compiling tcsh with bcc (Bruce Evan's
187 i386 compiler that comes with the minix386 upgrade package), don't bother.
188 It is some serious bugs that kill tcsh when compiled for 16-bit characters.
189 I can provide more details of bugs that I noticed for brave souls who want
190 to try, but it would be hard (and why bother if you can get gcc?).
191
192 I can make the binary available to anyone who wants it (for example people
193 who can't get access to a cross-compiling environment, and who don't yet
194 have gcc running under minix).
195
196
197 ***************************************************************************
198
199 If your compiler cannot handle long symbol names, add 
200
201 #include "snames.h" 
202
203 to your config.h file
204
205              -- Christos Zoulas
206                 christos@zoulas.com
207