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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC

…		…
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
21		23
22	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
23		25
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
91		93
92	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
93	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
94	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
95		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<frills>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
96	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
97		104
98	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
99		106
100	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
…		…
103		110
104	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
105		112
106	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
107		114
108	=item B<-ip>\|B<+ip>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
109		116
110	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
111	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
112		119
113	=item B<-fade> I<number>	120	=item B<-fade> I<number>
114		121
115	Fade the text by the given percentage when focus is lost.	122	Fade the text by the given percentage when focus is lost. Small values
		123	fade a little only, 100 completely replaces all colours by the fade
		124	colour; resource B<fading>.
		125
		126	=item B<-fadecolor> I<colour>
		127
		128	Fade to this colour when fading is used (see B<-fade>). The default colour
		129	is black. resource B<fadeColor>.
116		130
117	=item B<-tint> I<colour>	131	=item B<-tint> I<colour>
118		132
119	Tint the transparent background pixmap with the given colour when	133	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	134	transparency is enabled with B<-tr> or B<-ip>. This only works for
121	option that can be used to brighten or darken the image in addition to	135	non-tiled backgrounds, currently. See also the B<-sh> option that can be
122	tinting it.	136	used to brighten or darken the image in addition to tinting it; resource
		137	I<tintColor>. Example:
		138
		139	@@RXVT_NAME@@ -tr -tint blue -sh 40
123		140
124	=item B<-sh>	141	=item B<-sh>
125		142
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	144	background image in addition to tinting it (i.e. B<-tint> must be
128	specified, too).	145	specified, too, e.g. C<-tint white>).
129		146
130	=item B<-bg> I<colour>	147	=item B<-bg> I<colour>
131		148
132	Window background colour; resource B<background>.	149	Window background colour; resource B<background>.
133		150
…		…
136	Window foreground colour; resource B<foreground>.	153	Window foreground colour; resource B<foreground>.
137		154
138	=item B<-pixmap> I<file[;geom]>	155	=item B<-pixmap> I<file[;geom]>
139		156
140	Compile I<XPM>: Specify XPM file for the background and also optionally	157	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to add	158	specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	159	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	160	command-line; resource B<backgroundPixmap>.
144		161
145	=item B<-cr> I<colour>	162	=item B<-cr> I<colour>
146		163
147	The cursor colour; resource B<cursorColor>.	164	The cursor colour; resource B<cursorColor>.
…		…
160	resource B<borderColor>.	177	resource B<borderColor>.
161		178
162	=item B<-fn> I<fontlist>	179	=item B<-fn> I<fontlist>
163		180
164	Select the fonts to be used. This is a comma separated list of font names	181	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	182	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	183	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	184	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	185	font list is always appended to it. See resource B<font> for more details.
		186
		187	In short, to specify an X11 core font, just specify it's name or prefix it
		188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		189	e.g.:
		190
		191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		193
170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	194	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171	section of @@RXVT_NAME@@(7).	195	section of @@RXVT_NAME@@(7).
172		196
173	=item B<-fb> I<fontlist>	197	=item B<-fb> I<fontlist>
174		198
175	Compile font-styles: The bold font list to use when bold characters are to	199	Compile I<font-styles>: The bold font list to use when B<bold> characters
176	be printed. See resource B<boldFont> for details.	200	are to be printed. See resource B<boldFont> for details.
177		201
178	=item B<-fi> I<fontlist>	202	=item B<-fi> I<fontlist>
179		203
180	Compile font-styles: The italic font list to use when bold characters are to	204	Compile I<font-styles>: The italic font list to use when I<italic>
181	be printed. See resource B<italicFont> for details.	205	characters are to be printed. See resource B<italicFont> for details.
182		206
183	=item B<-fbi> I<fontlist>	207	=item B<-fbi> I<fontlist>
184		208
185	Compile font-styles: The bold italic font list to use when bold characters are to	209	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
186	be printed. See resource B<boldItalicFont> for details.	210	italic> >> characters are to be printed. See resource B<boldItalicFont>
		211	for details.
		212
		213	=item B<-is>\|B<+is>
		214
		215	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		216	foreground/background (default). See resource B<intensityStyles> for
		217	details.
187		218
188	=item B<-name> I<name>	219	=item B<-name> I<name>
189		220
190	Specify the application name under which resources are to be obtained,	221	Specify the application name under which resources are to be obtained,
191	rather than the default executable file name. Name should not contain	222	rather than the default executable file name. Name should not contain
…		…
229		260
230	Put scrollbar on right/left; resource B<scrollBar_right>.	261	Put scrollbar on right/left; resource B<scrollBar_right>.
231		262
232	=item B<-st>\|B<+st>	263	=item B<-st>\|B<+st>
233		264
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	265	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235	resource B<scrollBar_floating>.	266	resource B<scrollBar_floating>.
		267
		268	=item B<-ptab>\|B<+ptab>
		269
		270	If enabled (default), "Horizontal Tab" characters are being stored as
		271	actual wide characters in the screen buffer, which makes it possible to
		272	select and paste them. Since a horizontal tab is a cursor movement and
		273	not an actual glyph, this can sometimes be visually annoying as the cursor
		274	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		275
237	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
238		277
239	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
240		279
…		…
263		302
264	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	303	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265	if honoured by the WM, the rxvt-unicode window will not have window	304	if honoured by the WM, the rxvt-unicode window will not have window
266	decorations; resource B<borderLess>.	305	decorations; resource B<borderLess>.
267		306
		307	=item B<-override-redirect>
		308
		309	Compile I<frills>: Sets override-redirect on the window; resource
		310	B<override-redirect>.
		311
		312	=item B<-sbg>
		313
		314	Compile I<frills>: Disable the usage of the built-in block graphics/line
		315	drawing characters and just rely on what the specified fonts provide. Use
		316	this if you have a good font and want to use its block graphic glyphs;
		317	resource B<skipBuiltinGlyphs>.
		318
268	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
269		320
270	Compile I<linespace>: Lines (pixel height) to insert between each row	321	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	322	the display. Useful to work around font rendering problems; resource
		323	B<linespace>.
272		324
273	=item B<-tn> I<termname>	325	=item B<-tn> I<termname>
274		326
275	This option specifies the name of the terminal type to be set in the	327	This option specifies the name of the terminal type to be set in the
276	B<TERM> environment variable. This terminal type must exist in the	328	B<TERM> environment variable. This terminal type must exist in the
…		…
285	given on the command line. If this option is used, it must be the last	337	given on the command line. If this option is used, it must be the last
286	on the command-line. If there is no B<-e> option then the default is to	338	on the command-line. If there is no B<-e> option then the default is to
287	run the program specified by the B<SHELL> environment variable or,	339	run the program specified by the B<SHELL> environment variable or,
288	failing that, I<sh(1)>.	340	failing that, I<sh(1)>.
289		341
		342	Please note that you must specify a program with arguments. If you want to
		343	run shell commands, you have to specify the shell, like this:
		344
		345	@@RXVT_NAME@@ -e sh -c "shell commands"
		346
290	=item B<-title> I<text>	347	=item B<-title> I<text>
291		348
292	Window title (B<-T> still respected); the default title is the basename	349	Window title (B<-T> still respected); the default title is the basename
293	of the program specified after the B<-e> option, if any, otherwise the	350	of the program specified after the B<-e> option, if any, otherwise the
294	application name; resource B<title>.	351	application name; resource B<title>.
…		…
312		369
313	Compile I<XIM>: input method name. resource B<inputMethod>.	370	Compile I<XIM>: input method name. resource B<inputMethod>.
314		371
315	=item B<-imlocale> I<string>	372	=item B<-imlocale> I<string>
316		373
317	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	374	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	375	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319	extension to be able to input japanese characters while staying in	376	input extension to be able to input japanese characters while staying in
320	another locale.	377	another locale. resource B<imLocale>.
		378
		379	=item B<-imfont> I<fontset>
		380
		381	Set the font set to use for the X Input Method, see resource B<imFont>
		382	for more info.
		383
		384	=item B<-tcw>
		385
		386	Change the meaning of triple-click selection with the left mouse
		387	button. Instead of selecting a full line it will extend the selection the
		388	end of the logical line only. resource B<tripleclickwords>.
321		389
322	=item B<-insecure>	390	=item B<-insecure>
323		391
324	Enable "insecure" mode, which currently enables most of the escape	392	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	393	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>\|B<+ssr>	407	=item B<-ssr>\|B<+ssr>
340		408
341	Turn on/off secondary screen scroll (default enabled); resource	409	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	410	B<secondaryScroll>.
343		411
		412	=item B<-hold>\|B<+hold>
		413
		414	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		415	will not immediately destroy its window when the program executed within
		416	it exits. Instead, it will wait till it is being killed or closed by the
		417	user; resource B<hold>.
		418
		419	=item B<-keysym.>I<sym> I<string>
		420
		421	Remap a key symbol. See resource B<keysym>.
		422
		423	=item B<-embed> I<windowid>
		424
		425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		426	which enables applications to easily embed a terminal.
		427
		428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		429	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		430	quite a bit, so don't expect it to keep some specific state. It's best to
		431	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		432
		433	The window will not be destroyed when @@RXVT_NAME@@ exits.
		434
		435	It might be useful to know that @@RXVT_NAME@@ will not close file
		436	descriptors passed to it (except for stdin/out/err, of course), so you
		437	can use file descriptors to communicate with the programs within the
		438	terminal. This works regardless of wether the C<-embed> option was used or
		439	not.
		440
		441	Here is a short Gtk2-perl snippet that illustrates how this option can be
		442	used (a longer example is in F<doc/embed>):
		443
		444	my $rxvt = new Gtk2::Socket;
		445	$rxvt->signal_connect_after (realize => sub {
		446	my $xid = $_[0]->window->get_xid;
		447	system "@@RXVT_NAME@@ -embed $xid &";
		448	});
		449
		450	=item B<-pty-fd> I<file descriptor>
		451
		452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		453	pair but instead use the given filehandle as the tty master. This is
		454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		455	without having to run a program within it.
		456
		457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		458	entries and will not tinker with pty/tty permissions - you have to do that
		459	yourself if you want that.
		460
		461	As an extremely special case, specifying C<-1> will completely suppress
		462	pty/tty operations.
		463
		464	Here is a example in perl that illustrates how this option can be used (a
		465	longer example is in F<doc/pty-fd>):
		466
		467	use IO::Pty;
		468	use Fcntl;
		469
		470	my $pty = new IO::Pty;
		471	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		472	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		473	close $pty;
		474
		475	# now communicate with rxvt
		476	my $slave = $pty->slave;
		477	while (<$slave>) { print $slave "got <$_>\n" }
		478
344	=item B<-xrm> I<resourcestring>	479	=item B<-pe> I<string>
345		480
346	No effect on rxvt-unicode. Simply passes through an argument to be made	481	Comma-separated list of perl extension scripts to use (or not to use) in
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	482	this terminal instance. See resource B<perl-ext> for details.
348	some window managers.
349		483
350	=back	484	=back
351		485
352	=head1 RESOURCES (available also as long-options)	486	=head1 RESOURCES (available also as long-options)
353		487
354	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355	options) compiled into your version.	489	options) compiled into your version.
356		490
357	There are two different methods that @@RXVT_NAME@@ can use to get the	491	You can set and change the resources using X11 tools like B<xrdb>. Many
358	Xresource data: using the X libraries (Xrm*-functions) or internal	492	distribution do also load settings from the B<~/.Xresources> file when X
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	494	with later settings overwriting earlier ones:
361	resources using X11 tools like B<xset>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.
363		495
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	496	1. system-wide app-defaults file, either locale-dependent OR global
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	497	2. app-defaults file in $XAPPLRESDIR
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	499	4. SCREEN_RESOURCES for the current screen
368	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		501
369	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	502	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	503	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
371	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	504	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372	easily configured, while the class name B<URxvt> allows resources	505	configured, while the class name B<URxvt> allows resources unique to
373	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	506	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374	shared between different B<@@RXVT_NAME@@> configurations. If no	507	configurations. If no resources are specified, suitable defaults will
375	resources are specified, suitable defaults will be used. Command-line	508	be used. Command-line arguments can be used to override resource
376	arguments can be used to override resource settings. The following	509	settings. The following resources are supported (you might want to
377	resources are allowed:	510	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		511	extensions not documented here):
378		512
379	=over 4	513	=over 4
		514
		515	=item B<depth:> I<bitdepth>
		516
		517	Compile I<frills>: Attempt to find a visual with the given bit depth;
		518	option B<-depth>.
380		519
381	=item B<geometry:> I<geom>	520	=item B<geometry:> I<geom>
382		521
383	Create the window with the specified X window geometry [default 80x24];	522	Create the window with the specified X window geometry [default 80x24];
384	option B<-geometry>.	523	option B<-geometry>.
…		…
412		551
413	=item B<colorIT:> I<colour>	552	=item B<colorIT:> I<colour>
414		553
415	Use the specified colour to display bold or italic characters when the	554	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	555	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	556	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		557
419	=item B<colorUL:> I<colour>	558	=item B<colorUL:> I<colour>
420		559
421	Use the specified colour to display underlined characters when the	560	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	561	foreground colour is the default.
423		562
424	=item B<colorRV:> I<colour>	563	=item B<colorRV:> I<colour>
425		564
426	Use the specified colour as the background for reverse video	565	Use the specified colour as the background for reverse video
427	characters.	566	characters.
		567
		568	=item B<underlineColor:> I<colour>
		569
		570	If set, use the specified colour as the colour for the underline
		571	itself. If unset, use the foreground colour.
428		572
429	=item B<cursorColor:> I<colour>	573	=item B<cursorColor:> I<colour>
430		574
431	Use the specified colour for the cursor. The default is to use the	575	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	576	foreground colour; option B<-cr>.
…		…
455	artificial transparency. B<False>: do not inherit the parent windows'	599	artificial transparency. B<False>: do not inherit the parent windows'
456	pixmap.	600	pixmap.
457		601
458	=item B<fading:> I<number>	602	=item B<fading:> I<number>
459		603
460	Fade the text by the given percentage when focus is lost.	604	Fade the text by the given percentage when focus is lost; option B<-fade>.
		605
		606	=item B<fadeColor:> I<colour>
		607
		608	Fade to this colour, when fading is used (see B<fading:>). The default
		609	colour is black; option B<-fadecolor>.
461		610
462	=item B<tintColor:> I<colour>	611	=item B<tintColor:> I<colour>
463		612
464	Tint the transparent background pixmap with the given colour.	613	Tint the transparent background pixmap with the given colour; option
		614	B<-tint>.
465		615
466	=item B<shading:> I<number>	616	=item B<shading:> I<number>
467		617
468	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469	image in addition to tinting it.	619	image in addition to tinting it.
470		620
471	=item B<fading:> I<number>
472
473	Scale the tint colour by the given percentage.
474
475	=item B<scrollColor:> I<colour>	621	=item B<scrollColor:> I<colour>
476		622
477	Use the specified colour for the scrollbar [default #B2B2B2].	623	Use the specified colour for the scrollbar [default #B2B2B2].
478		624
479	=item B<troughColor:> I<colour>	625	=item B<troughColor:> I<colour>
480		626
481	Use the specified colour for the scrollbar's trough area [default	627	Use the specified colour for the scrollbar's trough area [default
482	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	628	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483		629
484	=item B<borderColor:> I<colour>	630	=item B<borderColor:> I<colour>
485		631
486	The colour of the border around the text area and between the scrollbar	632	The colour of the border around the text area and between the scrollbar
487	and the text.	633	and the text.
…		…
496	of 1 displays the image without any scaling. A scale of 2 to 9	642	of 1 displays the image without any scaling. A scale of 2 to 9
497	specifies an integer number of images in that direction. No image will	643	specifies an integer number of images in that direction. No image will
498	be magnified beyond 10 times its original size. The maximum permitted	644	be magnified beyond 10 times its original size. The maximum permitted
499	scale is 1000. [default 0x0+50+50]	645	scale is 1000. [default 0x0+50+50]
500		646
501	=item B<menu:> I<file[;tag]>
502
503	Read in the specified menu file (note the `.menu' extension is
504	optional) and also optionally specify a starting tag to find. See the
505	reference documentation for details on the syntax for the menuBar.
506
507	=item B<path:> I<path>	647	=item B<path:> I<path>
508		648
509	Specify the colon-delimited search path for finding files (XPM and	649	Specify the colon-delimited search path for finding XPM files.
510	menus), in addition to the paths specified by the B<RXVTPATH> and
511	B<PATH> environment variables.
512		650
513	=item B<font:> I<fontlist>	651	=item B<font:> I<fontlist>
514		652
515	Select the fonts to be used. This is a comma separated list of font	653	Select the fonts to be used. This is a comma separated list of font names
516	names that are used in turn when trying to display Unicode characters.	654	that are checked in order when trying to find glyphs for characters. The
517	The first font defines the cell size for characters; other fonts might	655	first font defines the cell size for characters; other fonts might be
518	be smaller, but not larger. A reasonable default font list is always	656	smaller, but not (in general) larger. A (hopefully) reasonable default
519	appended to it. option B<-fn>.	657	font list is always appended to it; option B<-fn>.
520		658
521	Each font can either be a standard X11 core font (XLFD) name, with	659	Each font can either be a standard X11 core font (XLFD) name, with
522	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	660	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
523		661
524	In addition, each font can be prefixed with additional hints and	662	In addition, each font can be prefixed with additional hints and
525	specifications enclosed in square brackets (C<[]>). The only available	663	specifications enclosed in square brackets (C<[]>). The only available
526	hint currently is C<codeset=codeset-name>, and this is only used for Xft	664	hint currently is C<codeset=codeset-name>, and this is only used for Xft
527	fonts.	665	fonts.
528		666
529	For example, this font resource	667	For example, this font resource
530		668
531	URxvt*font: 9x15bold,\	669	URxvt.font: 9x15bold,\
532	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	670	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
533	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	671	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
534	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	672	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
535	xft:Code2000:antialias=false	673	xft:Code2000:antialias=false
536		674
537	specifies five fonts to be used. The first one is C<9x15bold> (actually	675	specifies five fonts to be used. The first one is C<9x15bold> (actually
538	the iso8859-1 version of the second font), which is the base font (because	676	the iso8859-1 version of the second font), which is the base font (because
539	it is named first) and thus defines the character cell grid to be 9 pixels	677	it is named first) and thus defines the character cell grid to be 9 pixels
540	wide and 15 pixels high.	678	wide and 15 pixels high.
541		679
542	the second font is just used to add additional unicode characters not in	680	The second font is just used to add additional unicode characters not in
543	the base font, likewise the third, which is unfortunately non-bold, but	681	the base font, likewise the third, which is unfortunately non-bold, but
544	the bold version of the font does contain less characters, so this is a	682	the bold version of the font does contain less characters, so this is a
545	useful supplement.	683	useful supplement.
546		684
547	The third font is an Xft font with aliasing turned off, and the characters	685	The third font is an Xft font with aliasing turned off, and the characters
…		…
570	not possible, replacement fonts of the desired shape will be tried.	708	not possible, replacement fonts of the desired shape will be tried.
571		709
572	If set, but empty, then this specific style is disabled and the normal	710	If set, but empty, then this specific style is disabled and the normal
573	text font will being used for the given style.	711	text font will being used for the given style.
574		712
		713	=item B<intensityStyles:> I<boolean>
		714
		715	When font styles are not enabled, or this option is enabled (B<True>,
		716	option B<-is>, the default), bold and italic font styles imply high
		717	intensity foreground/backround colours. Disabling this option (B<False>,
		718	option B<+is>) disables this behaviour, the high intensity colours are not
		719	reachable.
		720
575	=item B<selectstyle:> I<mode>	721	=item B<selectstyle:> I<mode>
576		722
577	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
578	xterm style with 2.20 old word selection, or anything else which gives	724	xterm style with 2.20 old word selection, or anything else which gives
579	xterm style selection.	725	xterm style selection.
580		726
581	=item B<scrollstyle:> I<mode>	727	=item B<scrollstyle:> I<mode>
582		728
583	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
584	the author's favourite..	730	the author's favourite.
585		731
586	=item B<title:> I<string>	732	=item B<title:> I<string>
587		733
588	Set window title string, the default title is the command-line	734	Set window title string, the default title is the command-line
589	specified after the B<-e> option, if any, otherwise the application	735	specified after the B<-e> option, if any, otherwise the application
…		…
621		767
622	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	768	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
623	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	769	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624	B<Shift-Print> to include the scrollback as well.	770	B<Shift-Print> to include the scrollback as well.
625		771
		772	The string will be interpreted as if typed into the shell as-is.
		773
		774	Example:
		775
		776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		777
		778	This creates a new file in your home directory with the screen contents
		779	everytime you hit C<Print>.
		780
626	=item B<scrollBar:> I<boolean>	781	=item B<scrollBar:> I<boolean>
627		782
628	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629	disable the scrollbar; option B<+sb>.	784	disable the scrollbar; option B<+sb>.
630		785
…		…
650	B<+si>.	805	B<+si>.
651		806
652	=item B<scrollWithBuffer:> I<boolean>	807	=item B<scrollWithBuffer:> I<boolean>
653		808
654	B<True>: scroll with scrollback buffer when tty receives new lines (and	809	B<True>: scroll with scrollback buffer when tty receives new lines (and
655	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656	with scrollback buffer when tty recieves new lines; option B<-sw>.	811	with scrollback buffer when tty recieves new lines; option B<+sw>.
657		812
658	=item B<scrollTtyKeypress:> I<boolean>	813	=item B<scrollTtyKeypress:> I<boolean>
659		814
660	B<True>: scroll to bottom when a non-special key is pressed. Special keys	815	B<True>: scroll to bottom when a non-special key is pressed. Special keys
661	are those which are intercepted by rxvt-unicode for special handling and	816	are those which are intercepted by rxvt-unicode for special handling and
…		…
680	=item B<borderLess:> I<boolean>	835	=item B<borderLess:> I<boolean>
681		836
682	Set MWM hints to request a borderless window, i.e. if honoured by the	837	Set MWM hints to request a borderless window, i.e. if honoured by the
683	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	838	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
684		839
		840	=item B<skipBuiltinGlyphs:> I<boolean>
		841
		842	Compile I<frills>: Disable the usage of the built-in block graphics/line
		843	drawing characters and just rely on what the specified fonts provide. Use
		844	this if you have a good font and want to use its block graphic glyphs;
		845	option B<-sbg>.
		846
685	=item B<termName:> I<termname>	847	=item B<termName:> I<termname>
686		848
687	Specifies the terminal type name to be set in the B<TERM> environment	849	Specifies the terminal type name to be set in the B<TERM> environment
688	variable; option B<-tn>.	850	variable; option B<-tn>.
689		851
…		…
699		861
700	=item B<mouseWheelScrollPage:> I<boolean>	862	=item B<mouseWheelScrollPage:> I<boolean>
701		863
702	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	864	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703	scrolls five lines [default].	865	scrolls five lines [default].
		866
		867	=item B<pastableTabs:> I<boolean>
		868
		869	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		870	movement only; option C<-ptab>.
704		871
705	=item B<cursorBlink:> I<boolean>	872	=item B<cursorBlink:> I<boolean>
706		873
707	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	874	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708	option B<-bc>.	875	option B<-bc>.
…		…
721		888
722	Mouse pointer background colour.	889	Mouse pointer background colour.
723		890
724	=item B<pointerBlankDelay:> I<number>	891	=item B<pointerBlankDelay:> I<number>
725		892
726	Specifies number of seconds before blanking the pointer [default 2].	893	Specifies number of seconds before blanking the pointer [default 2]. Use a
		894	large number (e.g. C<987654321>) to effectively disable the timeout.
727		895
728	=item B<backspacekey:> I<string>	896	=item B<backspacekey:> I<string>
729		897
730	The string to send when the backspace key is pressed. If set to B<DEC>	898	The string to send when the backspace key is pressed. If set to B<DEC>
731	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	899	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
738	pressed. If unset it will send the sequence traditionally associated	906	pressed. If unset it will send the sequence traditionally associated
739	with the B<Execute> key.	907	with the B<Execute> key.
740		908
741	=item B<cutchars:> I<string>	909	=item B<cutchars:> I<string>
742		910
743	The characters used as delimiters for double-click word selection. The	911	The characters used as delimiters for double-click word selection
744	built-in default:	912	(whitespace delimiting is added automatically if resource is given).
		913
		914	When the selection extension is in use (the default if compiled in, see
		915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		916	will be created (if the resource exists, otherwise, no regex will be
		917	created). In this mode, characters outside ISO-8859-1 can be used.
		918
		919	When the selection extension is not used, only ISO-8859-1 characters can
		920	be used. If not specified, the built-in default is used:
745		921
746	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
747		923
748	=item B<preeditType:> I<style>	924	=item B<preeditType:> I<style>
749		925
…		…
753		929
754	I<name> of inputMethod to use; option B<-im>.	930	I<name> of inputMethod to use; option B<-im>.
755		931
756	=item B<imLocale:> I<name>	932	=item B<imLocale:> I<name>
757		933
758	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	934	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
759	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	935	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
760	extension to be able to input japanese characters while staying in	936	input extension to be able to input japanese characters while staying in
761	another locale. option B<-imlocale>.	937	another locale; option B<-imlocale>.
		938
		939	=item B<imFont:> I<fontset>
		940
		941	Specify the font-set used for XIM styles C<OverTheSpot> or
		942	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		943	by commas), i.e. it's not in the same format as the other font lists used
		944	in @@RXVT_NAME@@. The default will be set-up to chose any suitable found
		945	found, preferably one or two pixels differing in size to the base font.
		946	option B<-imfont>.
		947
		948	=item B<tripleclickwords:> I<boolean>
		949
		950	Change the meaning of triple-click selection with the left mouse
		951	button. Instead of selecting a full line it will extend the selection to
		952	the end of the logical line only; option B<-tcw>.
762		953
763	=item B<insecure:> I<boolean>	954	=item B<insecure:> I<boolean>
764		955
765	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	956	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766	echo arbitrary strings like the icon name or the locale. This could be	957	echo arbitrary strings like the icon name or the locale. This could be
767	abused if somebody gets 8-bit-clean access to your display, whether	958	abused if somebody gets 8-bit-clean access to your display, whether
768	throuh a mail client displaying mail bodies unfiltered or though	959	through a mail client displaying mail bodies unfiltered or through
769	write(1). Therefore, these sequences are disabled by default. (Note	960	write(1) or any other means. Therefore, these sequences are disabled by
770	that other terminals, including xterm, have these sequences	961	default. (Note that many other terminals, including xterm, have these
771	enabled by default). You can enable them by setting this boolean	962	sequences enabled by default, which doesn't make it safer, though).
772	resource or specifying B<-insecure> as an option. At the moment, this	963
773	enabled display-answer, locale, findfont, icon label and window title	964	You can enable them by setting this boolean resource or specifying
774	requests as well as dynamic menubar dispatch.	965	B<-insecure> as an option. At the moment, this enables display-answer,
		966	locale, findfont, icon label and window title requests.
775		967
776	=item B<modifier:> I<modifier>	968	=item B<modifier:> I<modifier>
777		969
778	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	970	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
779	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	971	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
783		975
784	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	976	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
785	character is passed through. It may contain escape values as described	977	character is passed through. It may contain escape values as described
786	in the entry on B<keysym> following.	978	in the entry on B<keysym> following.
787		979
788	=item B<secondaryScreen:> I<bool>	980	=item B<secondaryScreen:> I<boolean>
789		981
790	Turn on/off secondary screen (default enabled).	982	Turn on/off secondary screen (default enabled).
791		983
792	=item B<secondaryScroll:> I<bool>	984	=item B<secondaryScroll:> I<boolean>
793		985
794	Turn on/off secondary screen scroll (default enabled). If the this	986	Turn on/off secondary screen scroll (default enabled). If the this
795	option is enabled, scrolls on the secondary screen will change the	987	option is enabled, scrolls on the secondary screen will change the
796	scrollback buffer and switching to/from the secondary screen will	988	scrollback buffer and switching to/from the secondary screen will
797	instead scroll the screen up.	989	instead scroll the screen up.
798		990
		991	=item B<hold>: I<boolean>
		992
		993	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		994	will not immediately destroy its window when the program executed within
		995	it exits. Instead, it will wait till it is being killed or closed by the
		996	user.
		997
799	=item B<keysym.>I<sym>: I<string>	998	=item B<keysym.>I<sym>: I<string>
800		999
801	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1000	Compile I<frills>: Associate I<string> with keysym I<sym>. The
802	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1001	intervening resource name B<keysym.> cannot be omitted.
803	newline, \r: return, \t:	1002
		1003	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1004	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1005	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1006	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1007	B<2>, B<3>, B<4>, B<5>.
		1008
		1009	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1010	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1011	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1012	current application keymap mode state.
		1013
		1014	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1015	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1016	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1017	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1018	performed in an exact manner; however, the closest match is assured.
		1019
		1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805	^A ...) and may enclosed with double quotes so that it can start or end	1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806	with whitespace. The intervening resource name B<keysym.> cannot be	1024	can start or end with whitespace.
807	omitted. This resource is only available when compiled with	1025
808	KEYSYM_RESOURCE.	1026	Please note that you need to double the C<\> in resource files, as
		1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of
		1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1029	processing).
		1030
		1031	You can define a range of keysyms in one shot by providing a I<string>
		1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1033	should be a character not used by the strings.
		1034
		1035	Its usage can be demonstrated by an example:
		1036
		1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
		1038
		1039	The above line is equivalent to the following three lines:
		1040
		1041	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1042	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1043	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1044
		1045	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1046	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1047	example the following means "change the current locale to C<zh_CN.GBK>
		1048	when Control-Meta-c is being pressed":
		1049
		1050	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1051
		1052	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1053	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1054	manpage. For example, the F<selection> extension (activated via
		1055	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1056
		1057	URxvt.keysym.M-C-c: perl:selection:rot13
		1058
		1059	Due the the large number of modifier combinations, a defined key mapping
		1060	will match if at I<at least> the specified identifiers are being set, and
		1061	no other key mappings with those and more bits are being defined. That
		1062	means that defining a key map for C<a> will automatically provide
		1063	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1064	mappings themselves.
		1065
		1066	Unfortunately, this will override built-in key mappings. For example
		1067	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1068	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1069	user-defined keymap using the C<builtin:> replacement:
		1070
		1071	URxvt.keysym.Insert: <my insert key sequence>
		1072	URxvt.keysym.S-Insert: builtin:
		1073
		1074	The first line defines a mapping for C<Insert> and I<any> combination
		1075	of modifiers. The second line re-establishes the default mapping for
		1076	C<Shift-Insert>.
		1077
		1078	The following example will map Control-Meta-1 and Control-Meta-2 to
		1079	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1080	font-switching at runtime:
		1081
		1082	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1083	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1084
		1085	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1086	info):
		1087
		1088	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1089	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1090
		1091	=item B<perl-ext-common>: I<string>
		1092
		1093	=item B<perl-ext>: I<string>
		1094
		1095	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1096	use in this terminal instance; option B<-pe>.
		1097
		1098	Extension names can be prefixed with a C<-> sign to prohibit using
		1099	them. This can be useful to selectively disable some extensions loaded
		1100	by default, or specified via the C<perl-ext-common> resource. For
		1101	example, C<default,-selection> will use all the default extension except
		1102	C<selection>.
		1103
		1104	Extension names can also be followed by an argument in angle brackets
		1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1107	multiple times with different arguments will pass multiple arguments to
		1108	the extension.
		1109
		1110	Each extension is looked up in the library directories, loaded if
		1111	necessary, and bound to the current terminal instance.
		1112
		1113	If both of these resources are the empty string, then the perl
		1114	interpreter will not be initialized. The idea behind two options is that
		1115	B<perl-ext-common> will be used for extensions that should be available to
		1116	all instances, while B<perl-ext> is used for specific instances.
		1117
		1118	=item B<perl-eval>: I<string>
		1119
		1120	Perl code to be evaluated when all extensions have been registered. See
		1121	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1122	will be ignored when running setuid/setgid.
		1123
		1124	=item B<perl-lib>: I<path>
		1125
		1126	Colon-separated list of additional directories that hold extension
		1127	scripts. When looking for extensions specified by the C<perl> resource,
		1128	@@RXVT_NAME@@ will first look in these directories and then in
		1129	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1130	will be ignored when running setuid/setgid.
		1131
		1132	See the @@RXVT_NAME@@perl(3) manpage.
		1133
		1134	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1135
		1136	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1137	details.
		1138
		1139	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1140
		1141	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1142	for details.
		1143
		1144	=item B<searchable-scrollback:> I<keysym>
		1145
		1146	Sets the hotkey that starts the incremental scrollback buffer search
		1147	(default: C<M-s>).
		1148
		1149	=item B<urlLauncher>: I<string>
		1150
		1151	Specifies the program to be started with a URL argument. Used by the
		1152	C<selection-popup> and C<mark-urls> perl extensions.
		1153
		1154	=item B<transient-for>: I<windowid>
		1155
		1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1157
		1158	=item B<override-redirect>: I<boolean>
		1159
		1160	Compile I<frills>: Sets override-redirect for the terminal window, making
		1161	it almost invisible to window managers; option B<-override-redirect>.
809		1162
810	=back	1163	=back
811		1164
812	=head1 THE SCROLLBAR	1165	=head1 THE SCROLLBAR
813		1166
…		…
827	the normal text selection/insertion, hold either the Shift or the Meta	1180	the normal text selection/insertion, hold either the Shift or the Meta
828	(Alt) key while performing the desired mouse action.	1181	(Alt) key while performing the desired mouse action.
829		1182
830	If mouse reporting mode is active, the normal scrollbar actions are	1183	If mouse reporting mode is active, the normal scrollbar actions are
831	disabled -- on the assumption that we are using a fullscreen	1184	disabled -- on the assumption that we are using a fullscreen
832	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
834	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835	respectively.	1188	respectively.
836		1189
837	=head1 TEXT SELECTION AND INSERTION	1190	=head1 TEXT SELECTION AND INSERTION
838		1191
839	The behaviour of text selection and insertion mechanism is similar to	1192	The behaviour of text selection and insertion mechanism is similar to
…		…
841		1194
842	=over 4	1195	=over 4
843		1196
844	=item B<Selection>:	1197	=item B<Selection>:
845		1198
846	Left click at the beginning of the region, drag to the end of the	1199	Left click at the beginning of the region, drag to the end of the region
847	region and release; Right click to extend the marked region; Left	1200	and release; Right click to extend the marked region; Left double-click
848	double-click to select a word; Left triple-click to select the entire	1201	to select a word; Left triple-click to select the entire logical line
849	line.	1202	(which can span multiple screen lines), unless modified by resource
		1203	B<tripleclickwords>.
850		1204
851	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1205	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
852	(Compile: frills) will create a rectangular selection instead of a normal	1206	(Compile: I<frills>) will create a rectangular selection instead of a
853	one.	1207	normal one. In this mode, every selected row becomes its own line in the
		1208	selection, and trailing whitespace is visually underlined and removed from
		1209	the selection.
854		1210
855	=item B<Insertion>:	1211	=item B<Insertion>:
856		1212
857	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
858	an B<@@RXVT_NAME@@> window causes the current text selection to be	1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the
859	inserted as if it had been typed on the keyboard.	1215	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1216
		1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1218	inserted too.
860		1219
861	=back	1220	=back
862		1221
863	=head1 CHANGING FONTS	1222	=head1 CHANGING FONTS
864		1223
865	Changing fonts (or font sizes, respectively) via the keypad is not yet	1224	Changing fonts (or font sizes, respectively) via the keypad is not yet
866	supported in rxvt-unicode. Bug me if you need this.	1225	supported in rxvt-unicode. Bug me if you need this.
867		1226
868	You can, however, switch fonts at runtime using escape sequences (and	1227	You can, however, switch fonts at runtime using escape sequences, e.g.:
869	therefore using the menubar), e.g.:
870		1228
871	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1229	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1230
		1231	You can use keyboard shortcuts, too:
		1232
		1233	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1234	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
872		1235
873	rxvt-unicode will automatically re-apply these fonts to the output so far.	1236	rxvt-unicode will automatically re-apply these fonts to the output so far.
874		1237
875	=head1 ISO 14755 SUPPORT	1238	=head1 ISO 14755 SUPPORT
876		1239
…		…
880	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881	with C<--enable-iso14755>.	1244	with C<--enable-iso14755>.
882		1245
883	=over 4	1246	=over 4
884		1247
885	=item 5.1: Basic method	1248	=item * 5.1: Basic method
886		1249
887	This allows you to enter unicode characters using their hexcode.	1250	This allows you to enter unicode characters using their hexcode.
888		1251
889	Start by pressing and holding both C<Control> and C<Shift>, then enter	1252	Start by pressing and holding both C<Control> and C<Shift>, then enter
890	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1253	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
897	address, which you cannot type. Fortunately, the card has the e-mail	1260	address, which you cannot type. Fortunately, the card has the e-mail
898	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1261	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
899	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1262	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900	followed by releasing the modifier keys.	1263	followed by releasing the modifier keys.
901		1264
902	=item 5.2: Keyboard symbols entry method	1265	=item * 5.2: Keyboard symbols entry method
903		1266
904	This mode lets you input characters representing the keycap symbols of	1267	This mode lets you input characters representing the keycap symbols of
905	your keyboard, if representable in the current locale encoding.	1268	your keyboard, if representable in the current locale encoding.
906		1269
907	Start by pressing C<Control> and C<Shift> together, then releasing	1270	Start by pressing C<Control> and C<Shift> together, then releasing
…		…
910	keycap symbol. The symbol will only be entered when the key has been	1273	keycap symbol. The symbol will only be entered when the key has been
911	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for
912	C<ISO Level 2 Switch>, although your intention might have been to enter a	1275	C<ISO Level 2 Switch>, although your intention might have been to enter a
913	reverse tab (Shift-Tab).	1276	reverse tab (Shift-Tab).
914		1277
915	=item 5.3: Screen-selection entry method	1278	=item * 5.3: Screen-selection entry method
916		1279
917	While this is implemented already (it's basically the selection	1280	While this is implemented already (it's basically the selection
918	mechanism), it could be extended by displaying a unicode character map.	1281	mechanism), it could be extended by displaying a unicode character map.
919		1282
920	=item 5.4: Feedback method for identifying displayed characters for later input	1283	=item * 5.4: Feedback method for identifying displayed characters for later input
921		1284
922	This method lets you display the unicode character code associated with	1285	This method lets you display the unicode character code associated with
923	characters already displayed.	1286	characters already displayed.
924		1287
925	You enter this mode by holding down C<Control> and C<Shift> together, then	1288	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
937	With respect to conformance, rxvt-unicode is supposed to be compliant to	1300	With respect to conformance, rxvt-unicode is supposed to be compliant to
938	both scenario A and B of ISO 14755, including part 5.2.	1301	both scenario A and B of ISO 14755, including part 5.2.
939		1302
940	=head1 LOGIN STAMP	1303	=head1 LOGIN STAMP
941		1304
942	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1305	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
943	that it can be seen via the I<who(1)> command, and can accept messages.	1306	it can be seen via the I<who(1)> command, and can accept messages. To
944	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1307	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945	some systems.	1308	on some systems or setgid to root or to some other group on others.
946		1309
947	=head1 COLORS AND GRAPHICS	1310	=head1 COLORS AND GRAPHICS
948		1311
949	In addition to the default foreground and background colours,	1312	In addition to the default foreground and background colours,
950	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1313	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
993		1356
994	=back	1357	=back
995		1358
996	=head1 ENVIRONMENT	1359	=head1 ENVIRONMENT
997		1360
998	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1361	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1362
1000	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1363	=over 4
1001	sets the environment variable B<DISPLAY> to specify which display	1364
1002	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1365	=item B<TERM>
1003	B<RXVTPATH> and B<PATH> to find XPM files.	1366
		1367	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1368	resources or on the commandline.
		1369
		1370	=item B<COLORTERM>
		1371
		1372	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1373	compiled with XPM support, and optionally with the added extension
		1374	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1375
		1376	=item B<COLORFGBG>
		1377
		1378	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1379	the colour code used as default foreground/text colour (or the string
		1380	C<default> to indicate that the default-colour escape sequence is to be
		1381	used), C<bg> is the colour code used as default background colour (or the
		1382	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1383	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1384	(and do) use this information to optimize screen output.
		1385
		1386	=item B<WINDOWID>
		1387
		1388	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1389	window, which usually has subwindows for the scrollbar, the terminal
		1390	window and so on).
		1391
		1392	=item B<TERMINFO>
		1393
		1394	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1395	C<--with-terminfo=PATH>.
		1396
		1397	=item B<DISPLAY>
		1398
		1399	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1400	display in it's child processes.
		1401
		1402	=item B<SHELL>
		1403
		1404	The shell to be used for command execution, defaults to C</bin/sh>.
		1405
		1406	=item B<RXVT_SOCKET>
		1407
		1408	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1409	@@RXVT_NAME@@d(1).
		1410
		1411	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1412
		1413	=item B<HOME>
		1414
		1415	Used to locate the default directory for the unix domain socket for
		1416	daemon communications and to locate various resource files (such as
		1417	C<.Xdefaults>)
		1418
		1419	=item B<XAPPLRESDIR>
		1420
		1421	Directory where various X resource files are being located.
		1422
		1423	=item B<XENVIRONMENT>
		1424
		1425	If set and accessible, gives the name of a X resource file to be loaded by
		1426	@@RXVT_NAME@@.
		1427
		1428	=back
1004		1429
1005	=head1 FILES	1430	=head1 FILES
1006		1431
1007	=over 4	1432	=over 4
1008		1433
1009	=item B</etc/utmp>
1010
1011	System file for login records.
1012
1013	=item B</usr/lib/X11/rgb.txt>	1434	=item B</usr/lib/X11/rgb.txt>
1014		1435
1015	Color names.	1436	Color names.
1016		1437
1017	=back	1438	=back
1018		1439
1019	=head1 SEE ALSO	1440	=head1 SEE ALSO
1020		1441
1021	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1442	@@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)
1022
1023	=head1 BUGS
1024
1025	Check the BUGS file for an up-to-date list.
1026
1027	Cursor change support is not yet implemented.
1028
1029	Click-and-drag doesn't work with X11 mouse report overriding.
1030		1443
1031	=head1 CURRENT PROJECT COORDINATOR	1444	=head1 CURRENT PROJECT COORDINATOR
1032		1445
1033	=over 4	1446	=over 4
1034		1447
1035	=item Project Coordinator	1448	=item Project Coordinator
1036		1449
1037	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1450	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038		1451
1039	=item Web page maintainter	1452	L<http://software.schmorp.de/#rxvt-unicode>
1040
1041	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043	L<@@RXVT_WEBPAGE@@>
1044		1453
1045	=back	1454	=back
1046		1455
1047	=head1 AUTHORS	1456	=head1 AUTHORS
1048		1457
…		…
1070		1479
1071	Project Coordinator (changes.txt 2.21a to 2.4.5)	1480	Project Coordinator (changes.txt 2.21a to 2.4.5)
1072		1481
1073	=item Geoff Wing L<< <gcw@pobox.com> >>	1482	=item Geoff Wing L<< <gcw@pobox.com> >>
1074		1483
1075	Rewrote screen display and text selection routines. Project Coordinator	1484	Rewrote screen display and text selection routines.
		1485
1076	(changes.txt 2.4.6 - rxvt-unicode)	1486	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1077		1487
1078	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1488	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079		1489
1080	Forked rxvt-unicode, rewrote most of the display code and internal	1490	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1081	character handling to store text in unicode, improve xterm	1491	extension, random hacks, numerous bugfixes and extensions.
1082	compatibility and apply numerous other bugfixes and extensions.
1083		1492
1084	Project Coordinator (Changes 1.0 -)	1493	Project Coordinator (Changes 1.0 -)
1085		1494
		1495	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1496
		1497	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1498
1086	=back	1499	=back
1087		1500

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs. Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC