Debian Codegraph @

upstream/mageia-cauldron/man1/jed.1

raw
1 .\" ==================================================================
2 .\" Jed programmers editor, this manpage was writen by
3 .\" "Boris D. Beletsky" <[email protected]> copyright(c) 1996
4 .\" This manpage may be freely distrebuted as part of GNU Debian Linux
5 .\" ==================================================================
6 .TH JED 1 "OCT 1996" Debian "User Manuals"
7 .SH NAME
8 Jed \- programmers editor
9 .SH SYNOPSIS
10 .B jed \-\-version
11 .br
12 .B jed\-script \-\-version
13 .br
14 .B xjed \-\-version
15 .sp
16 .B jed [\-\-secure] [\-\-batch|\-\-script|\-\-help] [options]
17 .I file
18 .B ...
19 .br
20 .B jed\-script [\-\-secure]
21 .I script file
22 .B [script options] ...
23 .br
24 .B xjed [\-\-secure] [X options] [\-\-batch|\-\-script|\-\-help] [options]
25 .I file
26 .B ...
27 .SH DESCRIPTION
28 .B Jed - programmers editor
29 .LP
30 Features:
31 .LP
32 Color syntax
33 .I highlighting.
34 Emulation of
35 .B Emacs,
36 .B EDT,
37 .B Wordstar,
38 and Brief editors.
39 Extensible in a language resembling C. Completely customizable.
40 Editing TeX files with AUC-TeX style editing (BiBTeX support too).
41 Folding support, and much more...
42 .LP
43 For complete documentation, see GNU info files, this manual only
44 provides brief tutorial.
45 .SH OPTIONS
46 .SS major options
47 .LP
48 .I \-\-version
49 .RS
50 prints the version and compiletime variables.
51 .RE
52 .I \-\-help
53 .RS
54 prints usage information.
55 .RE
56 .I \-\-secure
57 .RS
58 runs Jed in secure mode, e.g. you can't run any external commands with
59 .I system()
60 or
61 .I run_shell_cmd().
62 .RE
63 .I \-\-batch
64 .RS
65 run Jed in batch mode.
66 This is a non-interactive mode.
67 .RE
68 .I \-\-script
69 .RS
70 this is a mode like
71 .I \-\-batch
72 but jed does not eval the startup files. It behaves like
73 .I slsh.
74 You must give the file that should be evaluated as second argument. It's
75 the same as calling
76 .B jed\-script.
77 .SS minor options
78 .LP
79 .I \-n
80 .RS
81 do not load
82 .I .jedrc
83 file.
84 .RE
85 .I \-a 'file'
86 .RS
87 load
88 .I file
89 as user configuration file instead of .jedrc.
90 .RE
91 .I + 'n'
92 .RS
93 goto line
94 .I n
95 in buffer (notice that in order to this option to take effect, if must
96 appear before the file name in the command line, like 'jed +3 file')
97 .RE
98 .I \-g 'n'
99 .RS
100 goto line
101 .I n
102 in buffer (notice that in order to this option to take effect, if must
103 appear after the file name in the command line, like 'jed file \-g 3')
104 .RE
105 .I \-l 'file'
106 .RS
107 load
108 .I file
109 as S\-Lang code.
110 .RE
111 .I \-f 'function'
112 .RS
113 execute S\-Lang function named
114 .I function
115 .RE
116 .I \-s 'string'
117 .RS
118 search forward for
119 .I string
120 .RE
121 .I \-2
122 .RS
123 split window
124 .RE
125 .I \-i 'file'
126 .RS
127 insert
128 .I file
129 into current buffer.
130 .RE
131 .LP
132 .SS X options
133 .B xjed
134 accapts the common options like
135 .I \-display, \-name, \-fn and \-geometry.
136 Additionaly it accepts
137 .LP
138 .I \-facesize SIZE, \-fs SIZE
139 .RS
140 if build with XRENDERFONT support, selects the font size
141 .I SIZE.
142 Use it with the option
143 .I \-fn
144 to select a scalable font.
145 .RE
146 .I \-foreground COLOR, \-fg COLOR
147 .RS
148 sets the foreground color.
149 .RE
150 .I \-background COLOR, \-bg COLOR
151 .RS
152 sets the background color.
153 .RE
154 .I \-fgMouse COLOR, \-mfg COLOR
155 .RS
156 sets the foreground color of the mouse pointer.
157 .RE
158 .I \-bgMouse COLOR, \-mbg COLOR
159 .RS
160 sets the background color of the mouse pointer.
161 .RE
162 .I \-Iconic, \-ic
163 .RS
164 start iconified.
165 .RE
166 .I \-title NAME
167 .RS
168 sets the window title to
169 .I NAME.
170 .RE
171 .LP
172 For more options look at
173 .B xterm.c.
174 .SH CONFIGURATION
175 .RS
176 .I Emulating Other Editors
177 .RE
178 .LP
179 JED's ability to create new functions using the
180 .I S\-Lang
181 programming language as well as allowing the user to choose key bindings,
182 makes the emulation of other editors possible. Currently, JED provides
183 reasonable emulation of the
184 .I Emacs, EDT, and Wordstar
185 editors.
186 .LP
187 .RS
188 .I Emacs Emulation
189 .RE
190 .LP
191 .I Emacs Emulation
192 is provided by the S\-Lang code in
193 .I emacs.sl.
194 The
195 basic functionality of Emacs is emulated; most Emacs users
196 should have no problem with JED. To enable Emacs emulation in JED, make sure
197 that the line:
198 .LP
199 .RS
200 .I () = evalfile ("emacs");
201 .RE
202 .LP
203 is in your
204 .I jed.rc
205 (.jedrc) startup file. JED is distributed
206 with this line already present in the default jed.rc file.
207 .LP
208 .RS
209 .I EDT Emulation
210 .RE
211 .LP
212 For
213 .I EDT
214 emulation,
215 .I edt.sl
216 must be loaded. This is accomplished by
217 ensuring that the line:
218 .LP
219 .RS
220 .I () = evalfile ("edt");
221 .RE
222 .LP
223 is in present in the jed.rc (.jedrc) Startup File.
224 .LP
225 .RS
226 .I Wordstar Emulation
227 .RE
228 .LP
229 wordstar.sl contains the S\-Lang code for JED's Wordstar
230 emulation. Adding the line
231 .LP
232 .RS
233 .I () = evalfile ("wordstar");
234 .RE
235 .LP
236 to your jed.rc (.jedrc) startup file will enable JED's
237 Wordstar emulation.
238 .SH RUN TIME
239 .LP
240 .RS
241 .I Status line and Windows
242 .RE
243 .LP
244 .I JED
245 supports multiple windows. Each window may contain the same
246 buffer or
247 different buffers. A status line is displayed immediately below
248 each
249 window. The status line contains information such as the JED
250 version
251 number, the buffer name,
252 .I mode,
253 etc. Please beware of the
254 following indicators:
255 .LP
256 .I **
257 .RS
258 buffer has been modified since last save.
259 .RE
260 .I %%
261 .RS
262 buffer is read only.
263 .RE
264 .I m
265 .RS
266 Mark set indicator. This means a region is being defined.
267 .RE
268 .I d
269 .RS
270 File changed on disk indicator. This indicates that the
271 file associated with the buffer is newer than the
272 buffer itself.
273 .RE
274 .I s
275 .RS
276 spot pushed indicator.
277 .RE
278 .I +
279 .RS
280 Undo is enabled for the buffer.
281 .RE
282 .I [Narrow]
283 .RS
284 Buffer is narrowed to a region of LINES.
285 .RE
286 .I [Macro]
287 .RS
288 A macro is being defined.
289 .RE
290 .LP
291 .RS
292 .I Mini-Buffer.
293 .RE
294 .LP
295 The
296 .I Mini-Buffer
297 consists of a single line located at the bottom of the
298 screen. Much of the dialog between the user and JED takes place in this
299 buffer. For example, when you search for a string, JED will prompt you
300 for the string in the Mini-Buffer.
301 .LP
302 The
303 .I Mini-Buffer
304 also provides a direct link to the S\-Lang interpreter.
305 To access the interpreter, press
306 .I Ctrl-X Esc
307 and the
308 .I S\-Lang>
309 prompt will appear in the Mini-Buffer. Enter any valid S\-Lang expression for
310 evaluation by the interpreter.
311 .LP
312 It is possible to recall data previously entered into the
313 .I Mini-Buffer
314 by using the up and down arrow keys. This makes it possible to use and edit
315 previous expressions in a convenient and efficient manner.
316 .LP
317 .RS
318 .I Basic Editing
319 .RE
320 .LP
321 .I Editing with JED
322 is pretty easy - most keys simply insert themselves.
323 Movement around the buffer is usually done using the
324 .I arrow keys or page up and page down keys.
325 If
326 .I edt.sl
327 is loaded, the keypads on
328 VTxxx
329 terminals function as well. Here, only the
330 highlights are
331 touched upon
332 (cut/paste operations are not considered `highlights').
333 In the following, any character prefixed by the
334 .I ^
335 character denotes a
336 Control character. On keyboards without an explicit Escape key,
337 .I "Ctrl-["
338 will most likely generate and Escape character.
339 .LP
340 A
341 .I prefix argument
342 to a command may be generated by first hitting the
343 .I Esc
344 key, then entering the number followed by pressing the desired
345 key. Normally, the prefix argument is used simply for
346 repetition. For
347 example,
348 to move to the right 40 characters, one would press
349 .I "Esc 4 0"
350 followed immediately by the right arrow key.
351 This illustrates the use of the repeat argument for repetition.
352 However, the
353 prefix argument may be used in other ways as well. For example,
354 to begin
355 defining a region, one would press the
356 .I "Ctrl-@"
357 key. This sets the mark and begins highlighting.
358 Pressing the
359 .I "Ctrl-@"
360 key with a prefix
361 argument will abort the act of defining the region and to pop the
362 mark.
363
364 The following list of useful keybindings assumes that
365 .I emacs.sl
366 has been loaded.
367 .LP
368 .I Ctrl-L
369 .RS
370 Redraw screen.
371 .RE
372 .I Ctrl-_
373 .RS
374 Undo (Control-underscore, also Ctrl-X u').
375 .RE
376 .I Esc q
377 .RS
378 Reformat paragraph (wrap mode). Used with a prefix
379 argument. will justify the paragraph as well.
380 .RE
381 .I Esc n
382 .RS
383 narrow paragraph
384 (wrap mode). Used with a prefix
385 argument will justify the paragraph as well.
386 .RE
387 .I Esc ;
388 .RS
389 Make Language comment (Fortran
390 and C)
391 .RE
392 .I Esc \\\\
393 .RS
394 Trim whitespace around point
395 .RE
396 .I Esc !
397 .RS
398 Execute shell command
399 .RE
400 .I Esc $
401 .RS
402 Ispell word
403 .RE
404 .I Ctrl-X ?
405 .RS
406 Show line/column information.
407 .RE
408 .I `
409 .RS
410 quoted_insert --- insert
411 next char as is (backquote key)
412 .RE
413 .I Esc s
414 .RS
415 Center line.
416 .RE
417 .I Esc u
418 .RS
419 Upcase word.
420 .RE
421 .I Esc d
422 .RS
423 Downcase word.
424 .RE
425 .I Esc c
426 .RS
427 Capitalize word.
428 .RE
429 .I Esc x
430 .RS
431 Get M-x minibuffer prompt with command
432 completion
433 .RE
434 .I Ctrl-X Ctrl-B
435 .RS
436 pop up a list of buffers
437 .RE
438 .I Ctrl-X Ctrl-C
439 .RS
440 exit JED
441 .RE
442 .I Ctrl-X 0
443 .RS
444 Delete
445 Current Window
446 .RE
447 .I Ctrl-X 1
448 .RS
449 One Window.
450 .RE
451 .I Ctrl-X 2
452 .RS
453 Split Window.
454 .RE
455 .RS
456 .I Ctrl-X o
457 .RE
458 .RS
459 Other window.
460 .RE
461 .I Ctrl-X b
462 .RS
463 switch to buffer
464 .RE
465 .I Ctrl-X k
466 .RS
467 kill buffer
468 .RE
469 .I Ctrl-X s
470 .RS
471 save some buffers
472 .RE
473 .I Ctrl-X Esc
474 .RS
475 Get "S\-Lang>" prompt for interface to the S\-Lang
476 interpreter.
477 .RE
478 .I Esc .
479 .RS
480 Find tag
481 .RE
482 .I Ctrl-@
483 .RS
484 Set Mark (Begin defining a region). Used with a
485 prefix argument aborts the act
486 of defining the region and
487 pops the Mark.
488 .RE
489 .RE
490 .\"---------------------------------------------------------
491 .SH FILES
492 .I JED_ROOT/lib/*.sl
493 .RS
494 these are the default runtime jed slang files
495 .RE
496 .I JED_ROOT/lib/site.sl
497 .RS
498 This is the default startup file.
499 .RE
500 .I /etc/jed.rc
501 .RS
502 The system wide configuration file.
503 .RE
504 .I ~/.jedrc
505 .RS
506 Per user configuration file.
507 .SH AUTHOR
508 .I "John E. Davis" <[email protected]>
509 .RS
510 Jed's Author
511 .RE
512
513
514 --- This document was
515 .I translated
516 to nroff
517 by "Boris D. Beletsky" <[email protected]>