README
1 Win32 `Readline Console'
2
3Author: Jan Wielemaker
4E-mail: jan@swi.psy.uva.nl
5
6
7Purpose
8=======
9
10The `readline console' provides a simple, but reasonable powerful
11console window for running standard I/O based applications that may wish
12to access Windows functions.
13
14The console window is inspired by both the X11 xterm application and the
15GNU readline library. The text is buffered to provide for window
16resizing and scroll-back. When reading input by line, an Emacs like
17editor is provided for editing the input line. Old input lines are
18remembered and used by the history system.
19
20
21Edit functions
22==============
23
24The following edit functions are provided:
25
26 Control-A Beginning of line
27 Control-B Character backward
28 Control-C Generate interrupt
29 Control-D Delete character forwards, or end-of-file
30 Control-E End of line
31 Control-F Character forwards
32 Control-I (TAB) Complete (filename, may be programmed)
33 Control-J (NL) Enter (make line available)
34 Control-K Delete to end-of-line
35 Control-M (RET) Enter (make line available)
36 Control-N Next line in history
37 Control-P Previous line in history
38 Control-T Toggle characters around caret
39 Control-U Empty line
40 Control-V Paste
41 Control-Z End-of-file
42 DEL Delete character forwards
43 BACKSPACE Delete character backwards
44 <-, -> Move caret in line, with SHIFT down, move
45 by word.
46 Up, down Move in history list
47
48Mouse-bindings:
49
50 Left: Start selection, dragging extends the selection.
51 Double-click selects in `word-mode'. The
52 selection is placed on the Windows clipboard.
53 Middle: Paste the Windows clipboard (also Control-V).
54 Right: Extends the selection.
55
56
57Compilation:
58============
59
60Includes a project file for MSVC 4.2. Please inspect the settings first.
61plterm.dll is made from console.c, edit.c and history.c
62
63
64Settings:
65=========
66
67Settings are kept in the Windows registry under the key
68
69 Software\<vendor>\<program>\Console
70
71Where
72
73 <vendor> is SWI, unless compiled with a different setting for
74 RLC_VENDOR
75 <program> is the basename of the program without extension
76 (i.e. plwin for the program C:\Program
77 Files\pl\bin\plwin.exe).
78
79Maintained values on this key are:
80
81 Name Type Description
82 ================================================================
83 SaveLines int (200-100000) # lines saved for scrollback
84 Width int (20-300) # width in characters
85 Height int (5-100) # height in characters
86 X int (0-screen-width) # X-position of window
87 Y int (0-screen-height) # Y-position of window
88 FaceName str # Font info (settable using
89 FontFamily int # extension of Windows menu)
90 FontSize int
91 FontWeight int
92 FontCharSet int
93