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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 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
…		…
238		248
239	Put scrollbar on right/left; resource B<scrollBar_right>.	249	Put scrollbar on right/left; resource B<scrollBar_right>.
240		250
241	=item B<-st>\|B<+st>	251	=item B<-st>\|B<+st>
242		252
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	253	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	254	resource B<scrollBar_floating>.
245		255
246	=item B<-ptab>\|B<+ptab>	256	=item B<-ptab>\|B<+ptab>
247		257
248	If enabled (default), "Horizontal Tab" characters are being stored as	258	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	313	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	314	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,	315	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	316	failing that, I<sh(1)>.
307		317
		318	Please note that you must specify a program with arguments. If you want to
		319	run shell commands, you have to specify the shell, like this:
		320
		321	@@RXVT_NAME@@ -e sh -c "shell commands"
		322
308	=item B<-title> I<text>	323	=item B<-title> I<text>
309		324
310	Window title (B<-T> still respected); the default title is the basename	325	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	326	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	327	application name; resource B<title>.
…		…
367		382
368	=item B<-ssr>\|B<+ssr>	383	=item B<-ssr>\|B<+ssr>
369		384
370	Turn on/off secondary screen scroll (default enabled); resource	385	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	386	B<secondaryScroll>.
		387
		388	=item B<-hold>\|B<+hold>
		389
		390	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		391	will not immediately destroy its window when the program executed within
		392	it exits. Instead, it will wait till it is being killed or closed by the
		393	user; resource B<hold>.
372		394
373	=item B<-keysym.>I<sym> I<string>	395	=item B<-keysym.>I<sym> I<string>
374		396
375	Remap a key symbol. See resource B<keysym>.	397	Remap a key symbol. See resource B<keysym>.
376		398
…		…
393	not.	415	not.
394		416
395	Here is a short Gtk2-perl snippet that illustrates how this option can be	417	Here is a short Gtk2-perl snippet that illustrates how this option can be
396	used (a longer example is in F<doc/embed>):	418	used (a longer example is in F<doc/embed>):
397		419
398	my $rxvt = new Gtk2::DrawingArea;	420	my $rxvt = new Gtk2::Socket;
399	$...->add ($rxvt); # important to add it somewhere first	421	$rxvt->signal_connect_after (realize => sub {
400	$rxvt->realize; # now it can be realized
401	my $xid = $rxvt->window->get_xid;	422	my $xid = $_[0]->window->get_xid;
402
403	system "@@RXVT_NAME@@ -embed $xid &";	423	system "@@RXVT_NAME@@ -embed $xid &";
		424	});
404		425
405	=item B<-pty-fd> I<fileno>	426	=item B<-pty-fd> I<fileno>
406		427
407	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	428	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408	pair but instead use the given filehandle as the tty master. This is	429	pair but instead use the given filehandle as the tty master. This is
…		…
419	use IO::Pty;	440	use IO::Pty;
420	use Fcntl;	441	use Fcntl;
421		442
422	my $pty = new IO::Pty;	443	my $pty = new IO::Pty;
423	fcntl $pty, F_SETFD, 0; # clear close-on-exec	444	fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";	445	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		446	close $pty;
426		447
427	# now communicate with rxvt	448	# now communicate with rxvt
428	my $slave = $pty->slave;	449	my $slave = $pty->slave;
429	while (<$slave>) { print $slave "got <$_>\n" }	450	while (<$slave>) { print $slave "got <$_>\n" }
430		451
…		…
549	artificial transparency. B<False>: do not inherit the parent windows'	570	artificial transparency. B<False>: do not inherit the parent windows'
550	pixmap.	571	pixmap.
551		572
552	=item B<fading:> I<number>	573	=item B<fading:> I<number>
553		574
554	Fade the text by the given percentage when focus is lost.	575	Fade the text by the given percentage when focus is lost; option B<-fade>.
		576
		577	=item B<fadeColor:> I<colour>
		578
		579	Fade to this colour, when fading is used (see B<fading:>). The default
		580	colour is black; option B<-fadecolor>.
555		581
556	=item B<tintColor:> I<colour>	582	=item B<tintColor:> I<colour>
557		583
558	Tint the transparent background pixmap with the given colour.	584	Tint the transparent background pixmap with the given colour; option
		585	B<-tint>.
559		586
560	=item B<shading:> I<number>	587	=item B<shading:> I<number>
561		588
562	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
563	image in addition to tinting it.	590	image in addition to tinting it.
…		…
567	Use the specified colour for the scrollbar [default #B2B2B2].	594	Use the specified colour for the scrollbar [default #B2B2B2].
568		595
569	=item B<troughColor:> I<colour>	596	=item B<troughColor:> I<colour>
570		597
571	Use the specified colour for the scrollbar's trough area [default	598	Use the specified colour for the scrollbar's trough area [default
572	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	599	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573		600
574	=item B<borderColor:> I<colour>	601	=item B<borderColor:> I<colour>
575		602
576	The colour of the border around the text area and between the scrollbar	603	The colour of the border around the text area and between the scrollbar
577	and the text.	604	and the text.
…		…
669	xterm style selection.	696	xterm style selection.
670		697
671	=item B<scrollstyle:> I<mode>	698	=item B<scrollstyle:> I<mode>
672		699
673	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	700	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674	the author's favourite..	701	the author's favourite.
675		702
676	=item B<title:> I<string>	703	=item B<title:> I<string>
677		704
678	Set window title string, the default title is the command-line	705	Set window title string, the default title is the command-line
679	specified after the B<-e> option, if any, otherwise the application	706	specified after the B<-e> option, if any, otherwise the application
…		…
710	=item B<print-pipe:> I<string>	737	=item B<print-pipe:> I<string>
711		738
712	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	739	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	740	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
714	B<Shift-Print> to include the scrollback as well.	741	B<Shift-Print> to include the scrollback as well.
		742
		743	The string will be interpreted as if typed into the shell as-is.
		744
		745	Example:
		746
		747	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		748
		749	This creates a new file in your home directory with the screen contents
		750	everytime you hit C<Print>.
715		751
716	=item B<scrollBar:> I<boolean>	752	=item B<scrollBar:> I<boolean>
717		753
718	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719	disable the scrollbar; option B<+sb>.	755	disable the scrollbar; option B<+sb>.
…		…
816		852
817	Mouse pointer background colour.	853	Mouse pointer background colour.
818		854
819	=item B<pointerBlankDelay:> I<number>	855	=item B<pointerBlankDelay:> I<number>
820		856
821	Specifies number of seconds before blanking the pointer [default 2].	857	Specifies number of seconds before blanking the pointer [default 2]. Use a
		858	large number (e.g. C<987654321>) to effectively disable the timeout.
822		859
823	=item B<backspacekey:> I<string>	860	=item B<backspacekey:> I<string>
824		861
825	The string to send when the backspace key is pressed. If set to B<DEC>	862	The string to send when the backspace key is pressed. If set to B<DEC>
826	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	863	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
873	=item B<insecure:> I<boolean>	910	=item B<insecure:> I<boolean>
874		911
875	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876	echo arbitrary strings like the icon name or the locale. This could be	913	echo arbitrary strings like the icon name or the locale. This could be
877	abused if somebody gets 8-bit-clean access to your display, whether	914	abused if somebody gets 8-bit-clean access to your display, whether
878	throuh a mail client displaying mail bodies unfiltered or though	915	through a mail client displaying mail bodies unfiltered or through
879	write(1). Therefore, these sequences are disabled by default. (Note	916	write(1) or any other means. Therefore, these sequences are disabled by
880	that other terminals, including xterm, have these sequences	917	default. (Note that many other terminals, including xterm, have these
881	enabled by default). You can enable them by setting this boolean	918	sequences enabled by default, which doesn't make it safer, though).
882	resource or specifying B<-insecure> as an option. At the moment, this	919
883	enabled display-answer, locale, findfont, icon label and window title	920	You can enable them by setting this boolean resource or specifying
884	requests as well as dynamic menubar dispatch.	921	B<-insecure> as an option. At the moment, this enables display-answer,
		922	locale, findfont, icon label and window title requests as well as dynamic
		923	menubar dispatch.
885		924
886	=item B<modifier:> I<modifier>	925	=item B<modifier:> I<modifier>
887		926
888	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	927	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	928	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
903		942
904	Turn on/off secondary screen scroll (default enabled). If the this	943	Turn on/off secondary screen scroll (default enabled). If the this
905	option is enabled, scrolls on the secondary screen will change the	944	option is enabled, scrolls on the secondary screen will change the
906	scrollback buffer and switching to/from the secondary screen will	945	scrollback buffer and switching to/from the secondary screen will
907	instead scroll the screen up.	946	instead scroll the screen up.
		947
		948	=item B<hold>: I<bool>
		949
		950	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		951	will not immediately destroy its window when the program executed within
		952	it exits. Instead, it will wait till it is being killed or closed by the
		953	user.
908		954
909	=item B<keysym.>I<sym>: I<string>	955	=item B<keysym.>I<sym>: I<string>
910		956
911	Compile I<frills>: Associate I<string> with keysym I<sym>. The	957	Compile I<frills>: Associate I<string> with keysym I<sym>. The
912	intervening resource name B<keysym.> cannot be omitted.	958	intervening resource name B<keysym.> cannot be omitted.
…		…
957	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1003	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
958	example the following means "change the current locale to C<zh_CN.GBK>	1004	example the following means "change the current locale to C<zh_CN.GBK>
959	when Control-Meta-c is being pressed":	1005	when Control-Meta-c is being pressed":
960		1006
961	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1007	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1008
		1009	Due the the large number of modifier combinations, a defined key mapping
		1010	will match if at I<at least> the specified identifiers are being set, and
		1011	no other key mappings with those and more bits are being defined. That
		1012	means that defining a key map for C<a> will automatically provide
		1013	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1014	mappings themselves.
		1015
		1016	Unfortunately, this will override built-in key mappings. For example
		1017	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1018	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1019	user-defined keymap using the C<builtin:> replacement:
		1020
		1021	URxvt.keysym.Insert: <my insert key sequence>
		1022	URxvt.keysym.S-Insert: builtin:
		1023
		1024	The first line defines a mapping for C<Insert> and I<any> combination
		1025	of modifiers. The second line re-establishes the default mapping for
		1026	C<Shift-Insert>.
962		1027
963	The following example will map Control-Meta-1 and Control-Meta-2 to	1028	The following example will map Control-Meta-1 and Control-Meta-2 to
964	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1029	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965	font-switching at runtime:	1030	font-switching at runtime:
966		1031
…		…
1033	supported in rxvt-unicode. Bug me if you need this.	1098	supported in rxvt-unicode. Bug me if you need this.
1034		1099
1035	You can, however, switch fonts at runtime using escape sequences (and	1100	You can, however, switch fonts at runtime using escape sequences (and
1036	therefore using the menubar), e.g.:	1101	therefore using the menubar), e.g.:
1037		1102
1038	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1103	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1039		1104
1040	rxvt-unicode will automatically re-apply these fonts to the output so far.	1105	rxvt-unicode will automatically re-apply these fonts to the output so far.
1041		1106
1042	=head1 ISO 14755 SUPPORT	1107	=head1 ISO 14755 SUPPORT
1043		1108
…		…
1219	=item B<RXVT_SOCKET>	1284	=item B<RXVT_SOCKET>
1220		1285
1221	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1286	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222	@@RXVT_NAME@@d(1).	1287	@@RXVT_NAME@@d(1).
1223		1288
1224	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1289	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225		1290
1226	=item B<HOME>	1291	=item B<HOME>
1227		1292
1228	Used to locate the default directory for the unix domain socket for	1293	Used to locate the default directory for the unix domain socket for
1229	daemon communications and to locate various resource files (such as	1294	daemon communications and to locate various resource files (such as
…		…
1250		1315
1251	=back	1316	=back
1252		1317
1253	=head1 SEE ALSO	1318	=head1 SEE ALSO
1254		1319
1255	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1320	@@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)
1256
1257	=head1 BUGS
1258
1259	Check the BUGS file for an up-to-date list.
1260
1261	Cursor change support is not yet implemented.
1262
1263	Click-and-drag doesn't work with X11 mouse report overriding.
1264		1321
1265	=head1 CURRENT PROJECT COORDINATOR	1322	=head1 CURRENT PROJECT COORDINATOR
1266		1323
1267	=over 4	1324	=over 4
1268		1325

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs. Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC