[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.62 by root, Sun Apr 17 22:36:13 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
…		…
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
…		…
678	B<+si>.	739	B<+si>.
679		740
680	=item B<scrollWithBuffer:> I<boolean>	741	=item B<scrollWithBuffer:> I<boolean>
681		742
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	743	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	744	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	745	with scrollback buffer when tty recieves new lines; option B<+sw>.
685		746
686	=item B<scrollTtyKeypress:> I<boolean>	747	=item B<scrollTtyKeypress:> I<boolean>
687		748
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	749	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	750	are those which are intercepted by rxvt-unicode for special handling and
…		…
754		815
755	Mouse pointer background colour.	816	Mouse pointer background colour.
756		817
757	=item B<pointerBlankDelay:> I<number>	818	=item B<pointerBlankDelay:> I<number>
758		819
759	Specifies number of seconds before blanking the pointer [default 2].	820	Specifies number of seconds before blanking the pointer [default 2]. Use a
		821	large number (e.g. C<987654321>) to effectively disable the timeout.
760		822
761	=item B<backspacekey:> I<string>	823	=item B<backspacekey:> I<string>
762		824
763	The string to send when the backspace key is pressed. If set to B<DEC>	825	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>	826	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	993	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	994	(Alt) key while performing the desired mouse action.
933		995
934	If mouse reporting mode is active, the normal scrollbar actions are	996	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	997	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	998	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	999	(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),	1000	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1001	respectively.
940		1002
941	=head1 TEXT SELECTION AND INSERTION	1003	=head1 TEXT SELECTION AND INSERTION
942		1004
943	The behaviour of text selection and insertion mechanism is similar to	1005	The behaviour of text selection and insertion mechanism is similar to
…		…
1098		1160
1099	=back	1161	=back
1100		1162
1101	=head1 ENVIRONMENT	1163	=head1 ENVIRONMENT
1102		1164
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1165	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	1166
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1167	=over 4
1106	sets the environment variable B<DISPLAY> to specify which display	1168
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1169	=item B<TERM>
1108	B<RXVTPATH> and B<PATH> to find XPM files.	1170
		1171	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1172	resources or on the commandline.
		1173
		1174	=item B<COLORTERM>
		1175
		1176	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1177	compiled with XPM support, and optionally with the added extension
		1178	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1179
		1180	=item B<COLORFGBG>
		1181
		1182	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1183	the colour code used as default foreground/text colour (or the string
		1184	C<default> to indicate that the default-colour escape sequence is to be
		1185	used), C<bg> is the colour code used as default background colour (or the
		1186	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1187	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1188	(and do) use this information to optimize screen output.
		1189
		1190	=item B<WINDOWID>
		1191
		1192	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1193	window, which usually has subwindows for the scrollbar, the terminal
		1194	window and so on).
		1195
		1196	=item B<TERMINFO>
		1197
		1198	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1199	C<--with-terminfo=PATH>.
		1200
		1201	=item B<DISPLAY>
		1202
		1203	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1204	display in it's child processes.
		1205
		1206	=item B<SHELL>
		1207
		1208	The shell to be used for command execution, defaults to C</bin/sh>.
		1209
		1210	=item B<RXVTPATH>
		1211
		1212	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
		1213	files.
		1214
		1215	=item B<PATH>
		1216
		1217	Used in the same way as C<RXVTPATH>.
		1218
		1219	=item B<RXVT_SOCKET>
		1220
		1221	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1222	@@RXVT_NAME@@d(1).
		1223
		1224	Default C<< $HOME/.rxvt-unicode-<nodename >>.
		1225
		1226	=item B<HOME>
		1227
		1228	Used to locate the default directory for the unix domain socket for
		1229	daemon communications and to locate various resource files (such as
		1230	C<.Xdefaults>)
		1231
		1232	=item B<XAPPLRESDIR>
		1233
		1234	Directory where various X resource files are being located.
		1235
		1236	=item B<XENVIRONMENT>
		1237
		1238	If set and accessible, gives the name of a X resource file to be loaded by
		1239	@@RXVT_NAME@@.
		1240
		1241	=back
1109		1242
1110	=head1 FILES	1243	=head1 FILES
1111		1244
1112	=over 4	1245	=over 4
1113		1246
…		…
1133		1266
1134	=over 4	1267	=over 4
1135		1268
1136	=item Project Coordinator	1269	=item Project Coordinator
1137		1270
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1271	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1272
1140	=item Web page maintainter	1273	L<http://software.schmorp.de/#rxvt-unicode>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1274
1146	=back	1275	=back
1147		1276
1148	=head1 AUTHORS	1277	=head1 AUTHORS
1149		1278
…		…
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1303	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1304
1176	Rewrote screen display and text selection routines. Project Coordinator	1305	Rewrote screen display and text selection routines. Project Coordinator
1177	(changes.txt 2.4.6 - rxvt-unicode)	1306	(changes.txt 2.4.6 - rxvt-unicode)
1178		1307
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1308	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1309
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1310	Forked rxvt-unicode, rewrote most of the display code and internal
1182	character handling to store text in unicode, improve xterm	1311	character handling to store text in unicode, improve xterm
1183	compatibility and apply numerous other bugfixes and extensions.	1312	compatibility and apply numerous other bugfixes and extensions.
1184		1313

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.62 by root, Sun Apr 17 22:36:13 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.62 by root, Sun Apr 17 22:36:13 2005 UTC