Debian Codegraph @

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