This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/swi/console
2013-03-05 15:50:38 -06:00
..
clp change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
common.h change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
complete.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
console_i.h change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
console.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
console.h change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
edit.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
history.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
history.h change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
Makefile.in change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
menu.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
menu.h change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
README change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00
registry.c change SWI stuff to swi directory. 2013-03-05 15:50:38 -06:00

			Win32 `Readline Console'

Author: Jan Wielemaker
E-mail: jan@swi.psy.uva.nl


Purpose
=======

The `readline console'  provides  a   simple,  but  reasonable  powerful
console window for running standard I/O based applications that may wish
to access Windows functions.

The console window is inspired by both the X11 xterm application and the
GNU readline library.  The  text  is   buffered  to  provide  for window
resizing and scroll-back. When reading  input   by  line,  an Emacs like
editor is provided for editing  the  input   line.  Old  input lines are
remembered and used by the history system.


Edit functions
==============

The following edit functions are provided:

	Control-A	Beginning of line
	Control-B	Character backward
	Control-C	Generate interrupt
	Control-D	Delete character forwards, or end-of-file
	Control-E	End of line
	Control-F	Character forwards
	Control-I (TAB)	Complete (filename, may be programmed)
	Control-J (NL)	Enter (make line available)
	Control-K	Delete to end-of-line
	Control-M (RET)	Enter (make line available)
	Control-N	Next line in history
	Control-P	Previous line in history
	Control-T	Toggle characters around caret
	Control-U	Empty line
	Control-V	Paste
	Control-Z	End-of-file
	DEL		Delete character forwards
	BACKSPACE	Delete character backwards
	<-, ->		Move caret in line, with SHIFT down, move
			by word.
	Up, down	Move in history list

Mouse-bindings:

	Left:		Start selection, dragging extends the selection.
			Double-click selects in `word-mode'. The
			selection is placed on the Windows clipboard.
	Middle:		Paste the Windows clipboard (also Control-V).
	Right:		Extends the selection.


Compilation:
============

Includes a project file for MSVC 4.2. Please inspect the settings first.
plterm.dll is made from console.c, edit.c and history.c


Settings:
=========

Settings are kept in the Windows registry under the key

	Software\<vendor>\<program>\Console

Where
		
	<vendor>  is SWI, unless compiled with a different setting for
		  RLC_VENDOR
        <program> is the basename of the program without extension
		  (i.e. plwin for the program C:\Program
		  Files\pl\bin\plwin.exe).

Maintained values on this key are:

	Name		Type			Description
	================================================================
	SaveLines	int (200-100000)	# lines saved for scrollback
	Width		int (20-300)		# width in characters
	Height		int (5-100)		# height in characters
	X		int (0-screen-width)	# X-position of window
	Y		int (0-screen-height)	# Y-position of window
	FaceName	str			# Font info (settable using
	FontFamily	int			# extension of Windows menu)
	FontSize	int
	FontWeight	int
	FontCharSet	int