[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.txt

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:47 2005 UTC

…		…
4		4
5	SYNOPSIS	5	SYNOPSIS
6	rxvt [options] [-e command [ args ]]	6	rxvt [options] [-e command [ args ]]
7		7
8	DESCRIPTION	8	DESCRIPTION
9	rxvt-unicode, version , is a colour vt102 terminal emulator intended as	9	rxvt-unicode, version 5.6, is a colour vt102 terminal emulator intended
10	an xterm(1) replacement for users who do not require features such as	10	as an xterm(1) replacement for users who do not require features such
11	Tektronix 4014 emulation and toolkit-style configurability. As a result,	11	as Tektronix 4014 emulation and toolkit-style configurability. As a
12	rxvt-unicode uses much less swap space -- a significant advantage on a	12	result, rxvt-unicode uses much less swap space -- a significant
13	machine serving many X sessions.	13	advantage on a machine serving many X sessions.
14		14
15	FREQUENTLY ASKED QUESTIONS	15	FREQUENTLY ASKED QUESTIONS
16	See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions	16	See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17	and answer to them and some common problems. That document is also	17	and answer to them and some common problems. That document is also
18	accessible on the World-Wide-Web at	18	accessible on the World-Wide-Web at
…		…
204		204
205	-sr\|+sr	205	-sr\|+sr
206	Put scrollbar on right/left; resource scrollBar_right.	206	Put scrollbar on right/left; resource scrollBar_right.
207		207
208	-st\|+st	208	-st\|+st
209	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	209	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210	resource scrollBar_floating.	210	resource scrollBar_floating.
211		211
212	-ptab\|+ptab	212	-ptab\|+ptab
213	If enabled (default), "Horizontal Tab" characters are being stored	213	If enabled (default), "Horizontal Tab" characters are being stored
214	as actual wide characters in the screen buffer, which makes it	214	as actual wide characters in the screen buffer, which makes it
…		…
311		311
312	-ssr\|+ssr	312	-ssr\|+ssr
313	Turn on/off secondary screen scroll (default enabled); resource	313	Turn on/off secondary screen scroll (default enabled); resource
314	secondaryScroll.	314	secondaryScroll.
315		315
316	-keysym.sym: string	316	-keysym.sym string
317	Remap a key symbol. See resource keysym.	317	Remap a key symbol. See resource keysym.
318		318
319	-xrm resourcestring	319	-embed windowid
320	No effect on rxvt-unicode. Simply passes through an argument to be	320	Tells rxvt to embed it's windows into an already-existing window,
321	made available in the instance's argument list. Appears in	321	which enables applications to easily embed a terminal.
322	WM_COMMAND in some window managers.	322
		323	Right now, rxvt will first unmap/map the specified window, so it
		324	shouldn't be a top-level window. rxvt will also reconfigure it quite
		325	a bit, so don't expect it to keep some specific state. It's best to
		326	create an extra subwindow for rxvt and leave it alone.
		327
		328	The window will not be destroyed when rxvt exits.
		329
		330	It might be useful to know that rxvt will not close file descriptors
		331	passed to it (except for stdin/out/err, of course), so you can use
		332	file descriptors to communicate with the programs within the
		333	terminal. This works regardless of wether the "-embed" option was
		334	used or not.
		335
		336	Here is a short Gtk2-perl snippet that illustrates how this option
		337	can be used (a longer example is in doc/embed):
		338
		339	my $rxvt = new Gtk2::Socket;
		340	$rxvt->signal_connect_after (realize => sub {
		341	my $xid = $_[0]->window->get_xid;
		342	system "rxvt -embed $xid &";
		343	});
		344
		345	-pty-fd fileno
		346	Tells rxvt NOT to execute any commands or create a new pty/tty pair
		347	but instead use the given filehandle as the tty master. This is
		348	useful if you want to drive rxvt as a generic terminal emulator
		349	without having to run a program within it.
		350
		351	If this switch is given, rxvt will not create any utmp/wtmp entries
		352	and will not tinker with pty/tty permissions - you have to do that
		353	yourself if you want that.
		354
		355	Here is a example in perl that illustrates how this option can be
		356	used (a longer example is in doc/pty-fd):
		357
		358	use IO::Pty;
		359	use Fcntl;
		360
		361	my $pty = new IO::Pty;
		362	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		363	system "rxvt -pty-fd " . (fileno $pty) . "&";
		364	close $pty;
		365
		366	# now communicate with rxvt
		367	my $slave = $pty->slave;
		368	while (<$slave>) { print $slave "got <$_>\n" }
323		369
324	RESOURCES (available also as long-options)	370	RESOURCES (available also as long-options)
325	Note: `rxvt --help' gives a list of all resources (long options)	371	Note: `rxvt --help' gives a list of all resources (long options)
326	compiled into your version.	372	compiled into your version.
327		373
…		…
435	scrollColor: colour	481	scrollColor: colour
436	Use the specified colour for the scrollbar [default #B2B2B2].	482	Use the specified colour for the scrollbar [default #B2B2B2].
437		483
438	troughColor: colour	484	troughColor: colour
439	Use the specified colour for the scrollbar's trough area [default	485	Use the specified colour for the scrollbar's trough area [default
440	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	486	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
441		487
442	borderColor: colour	488	borderColor: colour
443	The colour of the border around the text area and between the	489	The colour of the border around the text area and between the
444	scrollbar and the text.	490	scrollbar and the text.
445		491
…		…
531	xterm style with 2.20 old word selection, or anything else which	577	xterm style with 2.20 old word selection, or anything else which
532	gives xterm style selection.	578	gives xterm style selection.
533		579
534	scrollstyle: mode	580	scrollstyle: mode
535	Set scrollbar style to rxvt, plain, next or xterm. plain is the	581	Set scrollbar style to rxvt, plain, next or xterm. plain is the
536	author's favourite..	582	author's favourite.
537		583
538	title: string	584	title: string
539	Set window title string, the default title is the command-line	585	Set window title string, the default title is the command-line
540	specified after the -e option, if any, otherwise the application	586	specified after the -e option, if any, otherwise the application
541	name; option -title.	587	name; option -title.
…		…
566	print-pipe: string	612	print-pipe: string
567	Specify a command pipe for vt100 printer [default lpr(1)]. Use	613	Specify a command pipe for vt100 printer [default lpr(1)]. Use
568	Print to initiate a screen dump to the printer and Ctrl-Print or	614	Print to initiate a screen dump to the printer and Ctrl-Print or
569	Shift-Print to include the scrollback as well.	615	Shift-Print to include the scrollback as well.
570		616
		617	The string will be interpreted as if typed into the shell as-is.
		618
		619	Example:
		620
		621	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		622
		623	This creates a new file in your home directory with the screen
		624	contents everytime you hit "Print".
		625
571	scrollBar: boolean	626	scrollBar: boolean
572	True: enable the scrollbar [default]; option -sb. False: disable the	627	True: enable the scrollbar [default]; option -sb. False: disable the
573	scrollbar; option +sb.	628	scrollbar; option +sb.
574		629
575	scrollBar_right: boolean	630	scrollBar_right: boolean
…		…
588	True: scroll to bottom when tty receives output; option -si. False:	643	True: scroll to bottom when tty receives output; option -si. False:
589	do not scroll to bottom when tty receives output; option +si.	644	do not scroll to bottom when tty receives output; option +si.
590		645
591	scrollWithBuffer: boolean	646	scrollWithBuffer: boolean
592	True: scroll with scrollback buffer when tty receives new lines (and	647	True: scroll with scrollback buffer when tty receives new lines (and
593	scrollTtyOutput is False); option +sw. False: do not scroll with	648	scrollTtyOutput is False); option -sw. False: do not scroll with
594	scrollback buffer when tty recieves new lines; option -sw.	649	scrollback buffer when tty recieves new lines; option +sw.
595		650
596	scrollTtyKeypress: boolean	651	scrollTtyKeypress: boolean
597	True: scroll to bottom when a non-special key is pressed. Special	652	True: scroll to bottom when a non-special key is pressed. Special
598	keys are those which are intercepted by rxvt-unicode for special	653	keys are those which are intercepted by rxvt-unicode for special
599	handling and are not passed onto the shell; option -sk. False: do	654	handling and are not passed onto the shell; option -sk. False: do
…		…
651	pointerColor2: colour	706	pointerColor2: colour
652	Mouse pointer background colour.	707	Mouse pointer background colour.
653		708
654	pointerBlankDelay: number	709	pointerBlankDelay: number
655	Specifies number of seconds before blanking the pointer [default 2].	710	Specifies number of seconds before blanking the pointer [default 2].
		711	Use a large number (e.g. 987654321) to effectively disable the
		712	timeout.
656		713
657	backspacekey: string	714	backspacekey: string
658	The string to send when the backspace key is pressed. If set to DEC	715	The string to send when the backspace key is pressed. If set to DEC
659	or unset it will send Delete (code 127) or, if shifted, Backspace	716	or unset it will send Delete (code 127) or, if shifted, Backspace
660	(code 8) - which can be reversed with the appropriate DEC private	717	(code 8) - which can be reversed with the appropriate DEC private
…		…
776	is interpreted and executed as rxvt's control sequence. For example	833	is interpreted and executed as rxvt's control sequence. For example
777	the following means "change the current locale to "zh_CN.GBK" when	834	the following means "change the current locale to "zh_CN.GBK" when
778	Control-Meta-c is being pressed":	835	Control-Meta-c is being pressed":
779		836
780	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	837	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		838
		839	Due the the large number of modifier combinations, a defined key
		840	mapping will match if at at least the specified identifiers are
		841	being set, and no other key mappings with those and more bits are
		842	being defined. That means that defining a key map for "a" will
		843	automatically provide definitions for "Meta-a", "Shift-a" and so on,
		844	unless some of those are defined mappings themselves.
		845
		846	Unfortunately, this will override built-in key mappings. For example
		847	if you overwrite the "Insert" key you will disable rxvt's
		848	"Shift-Insert" mapping. To re-enable that, you can poke "holes" into
		849	the user-defined keymap using the "builtin:" replacement:
		850
		851	URxvt.keysym.Insert: <my insert key sequence>
		852	URxvt.keysym.S-Insert: builtin:
		853
		854	The first line defines a mapping for "Insert" and any combination
		855	of modifiers. The second line re-establishes the default mapping for
		856	"Shift-Insert".
781		857
782	The following example will map Control-Meta-1 and Control-Meta-2 to	858	The following example will map Control-Meta-1 and Control-Meta-2 to
783	the fonts "suxuseuro" and "9x15bold", so you can have some limited	859	the fonts "suxuseuro" and "9x15bold", so you can have some limited
784	font-switching at runtime:	860	font-switching at runtime:
785		861
…		…
995	Used in the same way as "RXVTPATH".	1071	Used in the same way as "RXVTPATH".
996		1072
997	RXVT_SOCKET	1073	RXVT_SOCKET
998	The unix domain socket path used by rxvtc(1) and rxvtd(1).	1074	The unix domain socket path used by rxvtc(1) and rxvtd(1).
999		1075
1000	Default "$HOME/.rxvt-unicode-<nodename".	1076	Default $HOME/.rxvt-unicode-<nodename.
1001		1077
1002	HOME	1078	HOME
1003	Used to locate the default directory for the unix domain socket for	1079	Used to locate the default directory for the unix domain socket for
1004	daemon communications and to locate various resource files (such as	1080	daemon communications and to locate various resource files (such as
1005	".Xdefaults")	1081	".Xdefaults")
…		…
1014	FILES	1090	FILES
1015	/usr/lib/X11/rgb.txt	1091	/usr/lib/X11/rgb.txt
1016	Color names.	1092	Color names.
1017		1093
1018	SEE ALSO	1094	SEE ALSO
1019	rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1095	rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
		1096	tty(4), utmp(5)
1020		1097
1021	BUGS	1098	BUGS
1022	Check the BUGS file for an up-to-date list.	1099	Check the BUGS file for an up-to-date list.
1023		1100
1024	Cursor change support is not yet implemented.	1101	Cursor change support is not yet implemented.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.13 by root, Mon Feb 14 10:44:50 2005 UTC vs. Revision 1.23 by root, Thu Jul 7 19:37:47 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:47 2005 UTC