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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 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
…		…
236		238
237	Put scrollbar on right/left; resource B<scrollBar_right>.	239	Put scrollbar on right/left; resource B<scrollBar_right>.
238		240
239	=item B<-st>\|B<+st>	241	=item B<-st>\|B<+st>
240		242
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	243	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.	244	resource B<scrollBar_floating>.
243		245
244	=item B<-ptab>\|B<+ptab>	246	=item B<-ptab>\|B<+ptab>
245		247
246	If enabled (default), "Horizontal Tab" characters are being stored as	248	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
366	=item B<-ssr>\|B<+ssr>	368	=item B<-ssr>\|B<+ssr>
367		369
368	Turn on/off secondary screen scroll (default enabled); resource	370	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	371	B<secondaryScroll>.
370		372
371	=item B<-xrm> I<resourcestring>	373	=item B<-keysym.>I<sym> I<string>
372		374
373	No effect on rxvt-unicode. Simply passes through an argument to be made	375	Remap a key symbol. See resource B<keysym>.
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	376
375	some window managers.	377	=item B<-embed> I<windowid>
		378
		379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		380	which enables applications to easily embed a terminal.
		381
		382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		384	quite a bit, so don't expect it to keep some specific state. It's best to
		385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		386
		387	The window will not be destroyed when @@RXVT_NAME@@ exits.
		388
		389	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
		391	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
		393	not.
		394
		395	Here is a short Gtk2-perl snippet that illustrates how this option can be
		396	used (a longer example is in F<doc/embed>):
		397
		398	my $rxvt = new Gtk2::Socket;
		399	$rxvt->signal_connect_after (realize => sub {
		400	my $xid = $_[0]->window->get_xid;
		401	system "@@RXVT_NAME@@ -embed $xid &";
		402	});
		403
		404	=item B<-pty-fd> I<fileno>
		405
		406	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		407	pair but instead use the given filehandle as the tty master. This is
		408	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		409	without having to run a program within it.
		410
		411	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		412	entries and will not tinker with pty/tty permissions - you have to do that
		413	yourself if you want that.
		414
		415	Here is a example in perl that illustrates how this option can be used (a
		416	longer example is in F<doc/pty-fd>):
		417
		418	use IO::Pty;
		419	use Fcntl;
		420
		421	my $pty = new IO::Pty;
		422	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		423	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		424	close $pty;
		425
		426	# now communicate with rxvt
		427	my $slave = $pty->slave;
		428	while (<$slave>) { print $slave "got <$_>\n" }
376		429
377	=back	430	=back
378		431
379	=head1 RESOURCES (available also as long-options)	432	=head1 RESOURCES (available also as long-options)
380		433
…		…
383		436
384	There are two different methods that @@RXVT_NAME@@ can use to get the	437	There are two different methods that @@RXVT_NAME@@ can use to get the
385	Xresource data: using the X libraries (Xrm*-functions) or internal	438	Xresource data: using the X libraries (Xrm*-functions) or internal
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	439	Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	440	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
388	resources using X11 tools like B<xset>. Many distribution do also load	441	resources using X11 tools like B<xrdb>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.	442	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
		443	will consult the following files/resources in order, with later settings
		444	overwriting earlier ones:
		445
		446	1. system-wide app-defaults file, either locale-dependent OR global
		447	2. app-defaults file in $XAPPLRESDIR
		448	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
		449	4. SCREEN_RESOURCES for the current screen
		450	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390		451
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	452	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	453	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	454	set in XAPPLOADDIR/URxvt (compile-time defined: usually
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	455	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
…		…
505	Use the specified colour for the scrollbar [default #B2B2B2].	566	Use the specified colour for the scrollbar [default #B2B2B2].
506		567
507	=item B<troughColor:> I<colour>	568	=item B<troughColor:> I<colour>
508		569
509	Use the specified colour for the scrollbar's trough area [default	570	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	571	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		572
512	=item B<borderColor:> I<colour>	573	=item B<borderColor:> I<colour>
513		574
514	The colour of the border around the text area and between the scrollbar	575	The colour of the border around the text area and between the scrollbar
515	and the text.	576	and the text.
…		…
607	xterm style selection.	668	xterm style selection.
608		669
609	=item B<scrollstyle:> I<mode>	670	=item B<scrollstyle:> I<mode>
610		671
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	672	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..	673	the author's favourite.
613		674
614	=item B<title:> I<string>	675	=item B<title:> I<string>
615		676
616	Set window title string, the default title is the command-line	677	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	678	specified after the B<-e> option, if any, otherwise the application
…		…
649		710
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	711	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	712	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652	B<Shift-Print> to include the scrollback as well.	713	B<Shift-Print> to include the scrollback as well.
653		714
		715	The string will be interpreted as if typed into the shell as-is.
		716
654	=item B<scrollBar:> I<boolean>	717	=item B<scrollBar:> I<boolean>
655		718
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	719	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	720	disable the scrollbar; option B<+sb>.
658		721
…		…
678	B<+si>.	741	B<+si>.
679		742
680	=item B<scrollWithBuffer:> I<boolean>	743	=item B<scrollWithBuffer:> I<boolean>
681		744
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	745	B<True>: scroll with scrollback buffer when tty receives new lines (and
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	746	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	747	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		748
686	=item B<scrollTtyKeypress:> I<boolean>	749	=item B<scrollTtyKeypress:> I<boolean>
687		750
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	751	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	752	are those which are intercepted by rxvt-unicode for special handling and
…		…
754		817
755	Mouse pointer background colour.	818	Mouse pointer background colour.
756		819
757	=item B<pointerBlankDelay:> I<number>	820	=item B<pointerBlankDelay:> I<number>
758		821
759	Specifies number of seconds before blanking the pointer [default 2].	822	Specifies number of seconds before blanking the pointer [default 2]. Use a
		823	large number (e.g. C<987654321>) to effectively disable the timeout.
760		824
761	=item B<backspacekey:> I<string>	825	=item B<backspacekey:> I<string>
762		826
763	The string to send when the backspace key is pressed. If set to B<DEC>	827	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	828	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
896	example the following means "change the current locale to C<zh_CN.GBK>	960	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	961	when Control-Meta-c is being pressed":
898		962
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	963	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		964
		965	Due the the large number of modifier combinations, a defined key mapping
		966	will match if at I<at least> the specified identifiers are being set, and
		967	no other key mappings with those and more bits are being defined. That
		968	means that defining a key map for C<a> will automatically provide
		969	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		970	mappings themselves.
		971
		972	Unfortunately, this will override built-in key mappings. For example
		973	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		974	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		975	user-defined keymap using the C<builtin:> replacement:
		976
		977	URxvt.keysym.Insert: <my insert key sequence>
		978	URxvt.keysym.S-Insert: builtin:
		979
		980	The first line defines a mapping for C<Insert> and I<any> combination
		981	of modifiers. The second line re-establishes the default mapping for
		982	C<Shift-Insert>.
		983
901	The following example will map Control-Meta-1 and Control-Meta-2 to	984	The following example will map Control-Meta-1 and Control-Meta-2 to
902	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	985	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	986	font-switching at runtime:
904		987
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	988	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1014	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1015	(Alt) key while performing the desired mouse action.
933		1016
934	If mouse reporting mode is active, the normal scrollbar actions are	1017	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1018	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1019	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1020	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1021	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1022	respectively.
940		1023
941	=head1 TEXT SELECTION AND INSERTION	1024	=head1 TEXT SELECTION AND INSERTION
942		1025
943	The behaviour of text selection and insertion mechanism is similar to	1026	The behaviour of text selection and insertion mechanism is similar to
…		…
1098		1181
1099	=back	1182	=back
1100		1183
1101	=head1 ENVIRONMENT	1184	=head1 ENVIRONMENT
1102		1185
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1186	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1187
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1188	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1189
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1190	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1191
		1192	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1193	resources or on the commandline.
		1194
		1195	=item B<COLORTERM>
		1196
		1197	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1198	compiled with XPM support, and optionally with the added extension
		1199	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1200
		1201	=item B<COLORFGBG>
		1202
		1203	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1204	the colour code used as default foreground/text colour (or the string
		1205	C<default> to indicate that the default-colour escape sequence is to be
		1206	used), C<bg> is the colour code used as default background colour (or the
		1207	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1208	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1209	(and do) use this information to optimize screen output.
		1210
		1211	=item B<WINDOWID>
		1212
		1213	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1214	window, which usually has subwindows for the scrollbar, the terminal
		1215	window and so on).
		1216
		1217	=item B<TERMINFO>
		1218
		1219	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1220	C<--with-terminfo=PATH>.
		1221
		1222	=item B<DISPLAY>
		1223
		1224	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1225	display in it's child processes.
		1226
		1227	=item B<SHELL>
		1228
		1229	The shell to be used for command execution, defaults to C</bin/sh>.
		1230
		1231	=item B<RXVTPATH>
		1232
		1233	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1234	files.
		1235
		1236	=item B<PATH>
		1237
		1238	Used in the same way as C<RXVTPATH>.
		1239
		1240	=item B<RXVT_SOCKET>
		1241
		1242	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1243	@@RXVT_NAME@@d(1).
		1244
		1245	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1246
		1247	=item B<HOME>
		1248
		1249	Used to locate the default directory for the unix domain socket for
		1250	daemon communications and to locate various resource files (such as
		1251	C<.Xdefaults>)
		1252
		1253	=item B<XAPPLRESDIR>
		1254
		1255	Directory where various X resource files are being located.
		1256
		1257	=item B<XENVIRONMENT>
		1258
		1259	If set and accessible, gives the name of a X resource file to be loaded by
		1260	@@RXVT_NAME@@.
		1261
		1262	=back
1109		1263
1110	=head1 FILES	1264	=head1 FILES
1111		1265
1112	=over 4	1266	=over 4
1113		1267
…		…
1133		1287
1134	=over 4	1288	=over 4
1135		1289
1136	=item Project Coordinator	1290	=item Project Coordinator
1137		1291
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1292	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1293
1140	=item Web page maintainter	1294	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1295
1146	=back	1296	=back
1147		1297
1148	=head1 AUTHORS	1298	=head1 AUTHORS
1149		1299
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1324	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1325
1176	Rewrote screen display and text selection routines. Project Coordinator	1326	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1327	(changes.txt 2.4.6 - rxvt-unicode)
1178		1328
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1329	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1330
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1331	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1332	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1333	compatibility and apply numerous other bugfixes and extensions.
1184		1334

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs. Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC