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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC

…		…
105		105
106	=item B<-j>\|B<+j>	106	=item B<-j>\|B<+j>
107		107
108	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
109		109
110	=item B<-ip>\|B<+ip>	110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
111		111
112	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
113	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
114		114
115	=item B<-fade> I<number>	115	=item B<-fade> I<number>
116		116
117	Fade the text by the given percentage when focus is lost. resource B<fading>.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
118		125
119	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
120		127
121	Tint the transparent background pixmap with the given colour when	128	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	129	transparency is enabled with B<-tr> or B<-ip>. This only works for
123	option that can be used to brighten or darken the image in addition to	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		135
126	=item B<-sh>	136	=item B<-sh>
127		137
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	139	background image in addition to tinting it (i.e. B<-tint> must be
…		…
192	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
193		203
194	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile font-styles: The bold italic font list to use when bold characters are to
195	be printed. See resource B<boldItalicFont> for details.	205	be printed. See resource B<boldItalicFont> for details.
196		206
		207	=item B<-is>\|B<+is>
		208
		209	Compile font-styles: Bold/Italic font styles imply high intensity
		210	foreground/background (default). See resource B<intensityStyles> for
		211	details.
		212
197	=item B<-name> I<name>	213	=item B<-name> I<name>
198		214
199	Specify the application name under which resources are to be obtained,	215	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	216	rather than the default executable file name. Name should not contain
201	`.' or `*' characters. Also sets the icon and title name.	217	`.' or `*' characters. Also sets the icon and title name.
…		…
238		254
239	Put scrollbar on right/left; resource B<scrollBar_right>.	255	Put scrollbar on right/left; resource B<scrollBar_right>.
240		256
241	=item B<-st>\|B<+st>	257	=item B<-st>\|B<+st>
242		258
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	259	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	260	resource B<scrollBar_floating>.
245		261
246	=item B<-ptab>\|B<+ptab>	262	=item B<-ptab>\|B<+ptab>
247		263
248	If enabled (default), "Horizontal Tab" characters are being stored as	264	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
303	given on the command line. If this option is used, it must be the last	319	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	320	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	321	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	322	failing that, I<sh(1)>.
307		323
		324	Please note that you must specify a program with arguments. If you want to
		325	run shell commands, you have to specify the shell, like this:
		326
		327	@@RXVT_NAME@@ -e sh -c "shell commands"
		328
308	=item B<-title> I<text>	329	=item B<-title> I<text>
309		330
310	Window title (B<-T> still respected); the default title is the basename	331	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	332	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	333	application name; resource B<title>.
…		…
368	=item B<-ssr>\|B<+ssr>	389	=item B<-ssr>\|B<+ssr>
369		390
370	Turn on/off secondary screen scroll (default enabled); resource	391	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	392	B<secondaryScroll>.
372		393
		394	=item B<-hold>\|B<+hold>
		395
		396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		397	will not immediately destroy its window when the program executed within
		398	it exits. Instead, it will wait till it is being killed or closed by the
		399	user; resource B<hold>.
		400
373	=item B<-keysym.>I<sym>: I<string>	401	=item B<-keysym.>I<sym> I<string>
374		402
375	Remap a key symbol. See resource B<keysym>.	403	Remap a key symbol. See resource B<keysym>.
376		404
377	=item B<-embed>: I<windowid>	405	=item B<-embed> I<windowid>
378		406
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380	which enables applications to easily embed a terminal.	408	which enables applications to easily embed a terminal.
381		409
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
…		…
389	It might be useful to know that @@RXVT_NAME@@ will not close file	417	It might be useful to know that @@RXVT_NAME@@ will not close file
390	descriptors passed to it (except for stdin/out/err, of course), so you	418	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	419	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	420	terminal. This works regardless of wether the C<-embed> option was used or
393	not.	421	not.
		422
		423	Here is a short Gtk2-perl snippet that illustrates how this option can be
		424	used (a longer example is in F<doc/embed>):
		425
		426	my $rxvt = new Gtk2::Socket;
		427	$rxvt->signal_connect_after (realize => sub {
		428	my $xid = $_[0]->window->get_xid;
		429	system "@@RXVT_NAME@@ -embed $xid &";
		430	});
		431
		432	=item B<-pty-fd> I<fileno>
		433
		434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		435	pair but instead use the given filehandle as the tty master. This is
		436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		437	without having to run a program within it.
		438
		439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		440	entries and will not tinker with pty/tty permissions - you have to do that
		441	yourself if you want that.
		442
		443	Here is a example in perl that illustrates how this option can be used (a
		444	longer example is in F<doc/pty-fd>):
		445
		446	use IO::Pty;
		447	use Fcntl;
		448
		449	my $pty = new IO::Pty;
		450	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		451	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		452	close $pty;
		453
		454	# now communicate with rxvt
		455	my $slave = $pty->slave;
		456	while (<$slave>) { print $slave "got <$_>\n" }
394		457
395	=back	458	=back
396		459
397	=head1 RESOURCES (available also as long-options)	460	=head1 RESOURCES (available also as long-options)
398		461
…		…
513	artificial transparency. B<False>: do not inherit the parent windows'	576	artificial transparency. B<False>: do not inherit the parent windows'
514	pixmap.	577	pixmap.
515		578
516	=item B<fading:> I<number>	579	=item B<fading:> I<number>
517		580
518	Fade the text by the given percentage when focus is lost.	581	Fade the text by the given percentage when focus is lost; option B<-fade>.
		582
		583	=item B<fadeColor:> I<colour>
		584
		585	Fade to this colour, when fading is used (see B<fading:>). The default
		586	colour is black; option B<-fadecolor>.
519		587
520	=item B<tintColor:> I<colour>	588	=item B<tintColor:> I<colour>
521		589
522	Tint the transparent background pixmap with the given colour.	590	Tint the transparent background pixmap with the given colour; option
		591	B<-tint>.
523		592
524	=item B<shading:> I<number>	593	=item B<shading:> I<number>
525		594
526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	595	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
527	image in addition to tinting it.	596	image in addition to tinting it.
…		…
531	Use the specified colour for the scrollbar [default #B2B2B2].	600	Use the specified colour for the scrollbar [default #B2B2B2].
532		601
533	=item B<troughColor:> I<colour>	602	=item B<troughColor:> I<colour>
534		603
535	Use the specified colour for the scrollbar's trough area [default	604	Use the specified colour for the scrollbar's trough area [default
536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	605	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537		606
538	=item B<borderColor:> I<colour>	607	=item B<borderColor:> I<colour>
539		608
540	The colour of the border around the text area and between the scrollbar	609	The colour of the border around the text area and between the scrollbar
541	and the text.	610	and the text.
…		…
624	not possible, replacement fonts of the desired shape will be tried.	693	not possible, replacement fonts of the desired shape will be tried.
625		694
626	If set, but empty, then this specific style is disabled and the normal	695	If set, but empty, then this specific style is disabled and the normal
627	text font will being used for the given style.	696	text font will being used for the given style.
628		697
		698	=item B<intensityStyles:> I<boolean>
		699
		700	When font styles are not enabled, or this option is enabled (B<True>,
		701	option B<-is>, the default), bold and italic font styles imply high
		702	intensity foreground/backround colours. Disabling this option (B<False>,
		703	option B<+is>) disables this behaviour, the high intensity colours are not
		704	reachable.
		705
629	=item B<selectstyle:> I<mode>	706	=item B<selectstyle:> I<mode>
630		707
631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
632	xterm style with 2.20 old word selection, or anything else which gives	709	xterm style with 2.20 old word selection, or anything else which gives
633	xterm style selection.	710	xterm style selection.
634		711
635	=item B<scrollstyle:> I<mode>	712	=item B<scrollstyle:> I<mode>
636		713
637	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
638	the author's favourite..	715	the author's favourite.
639		716
640	=item B<title:> I<string>	717	=item B<title:> I<string>
641		718
642	Set window title string, the default title is the command-line	719	Set window title string, the default title is the command-line
643	specified after the B<-e> option, if any, otherwise the application	720	specified after the B<-e> option, if any, otherwise the application
…		…
675		752
676	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	753	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
677	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	754	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
678	B<Shift-Print> to include the scrollback as well.	755	B<Shift-Print> to include the scrollback as well.
679		756
		757	The string will be interpreted as if typed into the shell as-is.
		758
		759	Example:
		760
		761	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		762
		763	This creates a new file in your home directory with the screen contents
		764	everytime you hit C<Print>.
		765
680	=item B<scrollBar:> I<boolean>	766	=item B<scrollBar:> I<boolean>
681		767
682	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683	disable the scrollbar; option B<+sb>.	769	disable the scrollbar; option B<+sb>.
684		770
…		…
704	B<+si>.	790	B<+si>.
705		791
706	=item B<scrollWithBuffer:> I<boolean>	792	=item B<scrollWithBuffer:> I<boolean>
707		793
708	B<True>: scroll with scrollback buffer when tty receives new lines (and	794	B<True>: scroll with scrollback buffer when tty receives new lines (and
709	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
710	with scrollback buffer when tty recieves new lines; option B<-sw>.	796	with scrollback buffer when tty recieves new lines; option B<+sw>.
711		797
712	=item B<scrollTtyKeypress:> I<boolean>	798	=item B<scrollTtyKeypress:> I<boolean>
713		799
714	B<True>: scroll to bottom when a non-special key is pressed. Special keys	800	B<True>: scroll to bottom when a non-special key is pressed. Special keys
715	are those which are intercepted by rxvt-unicode for special handling and	801	are those which are intercepted by rxvt-unicode for special handling and
…		…
780		866
781	Mouse pointer background colour.	867	Mouse pointer background colour.
782		868
783	=item B<pointerBlankDelay:> I<number>	869	=item B<pointerBlankDelay:> I<number>
784		870
785	Specifies number of seconds before blanking the pointer [default 2].	871	Specifies number of seconds before blanking the pointer [default 2]. Use a
		872	large number (e.g. C<987654321>) to effectively disable the timeout.
786		873
787	=item B<backspacekey:> I<string>	874	=item B<backspacekey:> I<string>
788		875
789	The string to send when the backspace key is pressed. If set to B<DEC>	876	The string to send when the backspace key is pressed. If set to B<DEC>
790	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	877	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
837	=item B<insecure:> I<boolean>	924	=item B<insecure:> I<boolean>
838		925
839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	926	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
840	echo arbitrary strings like the icon name or the locale. This could be	927	echo arbitrary strings like the icon name or the locale. This could be
841	abused if somebody gets 8-bit-clean access to your display, whether	928	abused if somebody gets 8-bit-clean access to your display, whether
842	throuh a mail client displaying mail bodies unfiltered or though	929	through a mail client displaying mail bodies unfiltered or through
843	write(1). Therefore, these sequences are disabled by default. (Note	930	write(1) or any other means. Therefore, these sequences are disabled by
844	that other terminals, including xterm, have these sequences	931	default. (Note that many other terminals, including xterm, have these
845	enabled by default). You can enable them by setting this boolean	932	sequences enabled by default, which doesn't make it safer, though).
846	resource or specifying B<-insecure> as an option. At the moment, this	933
847	enabled display-answer, locale, findfont, icon label and window title	934	You can enable them by setting this boolean resource or specifying
848	requests as well as dynamic menubar dispatch.	935	B<-insecure> as an option. At the moment, this enables display-answer,
		936	locale, findfont, icon label and window title requests as well as dynamic
		937	menubar dispatch.
849		938
850	=item B<modifier:> I<modifier>	939	=item B<modifier:> I<modifier>
851		940
852	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	941	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
853	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	942	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
867		956
868	Turn on/off secondary screen scroll (default enabled). If the this	957	Turn on/off secondary screen scroll (default enabled). If the this
869	option is enabled, scrolls on the secondary screen will change the	958	option is enabled, scrolls on the secondary screen will change the
870	scrollback buffer and switching to/from the secondary screen will	959	scrollback buffer and switching to/from the secondary screen will
871	instead scroll the screen up.	960	instead scroll the screen up.
		961
		962	=item B<hold>: I<bool>
		963
		964	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		965	will not immediately destroy its window when the program executed within
		966	it exits. Instead, it will wait till it is being killed or closed by the
		967	user.
872		968
873	=item B<keysym.>I<sym>: I<string>	969	=item B<keysym.>I<sym>: I<string>
874		970
875	Compile I<frills>: Associate I<string> with keysym I<sym>. The	971	Compile I<frills>: Associate I<string> with keysym I<sym>. The
876	intervening resource name B<keysym.> cannot be omitted.	972	intervening resource name B<keysym.> cannot be omitted.
…		…
921	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1017	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
922	example the following means "change the current locale to C<zh_CN.GBK>	1018	example the following means "change the current locale to C<zh_CN.GBK>
923	when Control-Meta-c is being pressed":	1019	when Control-Meta-c is being pressed":
924		1020
925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1021	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1022
		1023	Due the the large number of modifier combinations, a defined key mapping
		1024	will match if at I<at least> the specified identifiers are being set, and
		1025	no other key mappings with those and more bits are being defined. That
		1026	means that defining a key map for C<a> will automatically provide
		1027	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1028	mappings themselves.
		1029
		1030	Unfortunately, this will override built-in key mappings. For example
		1031	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1032	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1033	user-defined keymap using the C<builtin:> replacement:
		1034
		1035	URxvt.keysym.Insert: <my insert key sequence>
		1036	URxvt.keysym.S-Insert: builtin:
		1037
		1038	The first line defines a mapping for C<Insert> and I<any> combination
		1039	of modifiers. The second line re-establishes the default mapping for
		1040	C<Shift-Insert>.
926		1041
927	The following example will map Control-Meta-1 and Control-Meta-2 to	1042	The following example will map Control-Meta-1 and Control-Meta-2 to
928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1043	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929	font-switching at runtime:	1044	font-switching at runtime:
930		1045
…		…
978	to select a word; Left triple-click to select the entire logical line	1093	to select a word; Left triple-click to select the entire logical line
979	(which can span multiple screen lines), unless modified by resource	1094	(which can span multiple screen lines), unless modified by resource
980	B<tripleclickwords>.	1095	B<tripleclickwords>.
981		1096
982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1097	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
983	(Compile: I<frills>) will create a rectangular selection instead of a normal	1098	(Compile: I<frills>) will create a rectangular selection instead of a
984	one.	1099	normal one. In this mode, every selected row becomes its own line in the
		1100	selection, and trailing whitespace is visually underlined and removed from
		1101	the selection.
985		1102
986	=item B<Insertion>:	1103	=item B<Insertion>:
987		1104
988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1105	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
989	an B<@@RXVT_NAME@@> window causes the current text selection to be	1106	an B<@@RXVT_NAME@@> window causes the current text selection to be
…		…
997	supported in rxvt-unicode. Bug me if you need this.	1114	supported in rxvt-unicode. Bug me if you need this.
998		1115
999	You can, however, switch fonts at runtime using escape sequences (and	1116	You can, however, switch fonts at runtime using escape sequences (and
1000	therefore using the menubar), e.g.:	1117	therefore using the menubar), e.g.:
1001		1118
1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1119	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1003		1120
1004	rxvt-unicode will automatically re-apply these fonts to the output so far.	1121	rxvt-unicode will automatically re-apply these fonts to the output so far.
1005		1122
1006	=head1 ISO 14755 SUPPORT	1123	=head1 ISO 14755 SUPPORT
1007		1124
…		…
1183	=item B<RXVT_SOCKET>	1300	=item B<RXVT_SOCKET>
1184		1301
1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1302	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186	@@RXVT_NAME@@d(1).	1303	@@RXVT_NAME@@d(1).
1187		1304
1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1305	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1189		1306
1190	=item B<HOME>	1307	=item B<HOME>
1191		1308
1192	Used to locate the default directory for the unix domain socket for	1309	Used to locate the default directory for the unix domain socket for
1193	daemon communications and to locate various resource files (such as	1310	daemon communications and to locate various resource files (such as
…		…
1214		1331
1215	=back	1332	=back
1216		1333
1217	=head1 SEE ALSO	1334	=head1 SEE ALSO
1218		1335
1219	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1336	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1220
1221	=head1 BUGS
1222
1223	Check the BUGS file for an up-to-date list.
1224
1225	Cursor change support is not yet implemented.
1226
1227	Click-and-drag doesn't work with X11 mouse report overriding.
1228		1337
1229	=head1 CURRENT PROJECT COORDINATOR	1338	=head1 CURRENT PROJECT COORDINATOR
1230		1339
1231	=over 4	1340	=over 4
1232		1341

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs. Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.57 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC