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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC

…		…
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
…		…
42	because the author couldn't get C<mlterm> to use one font for latin1 and	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
95	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
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
98	=item B<-depth> I<bitdepth>	98	=item B<-depth> I<bitdepth>
99		99
100	Compile I<frills>: Attempt to find a visual with the given bit depth;	100	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	101	resource B<depth>.
102		102
103	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
104		104
105	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
…		…
114		114
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
116		116
117	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
118	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
		119
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions! Read the FAQ (man 7
		122	@@RXVT_NAME@@)!>
119		123
120	=item B<-fade> I<number>	124	=item B<-fade> I<number>
121		125
122	Fade the text by the given percentage when focus is lost. Small values	126	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	127	fade a little only, 100 completely replaces all colours by the fade
124	colour; resource B<fading>.	128	colour; resource B<fading>.
125		129
126	=item B<-fadecolor> I<colour>	130	=item B<-fadecolor> I<colour>
127		131
128	Fade to this colour when fading is used (see B<-fade>). The default colour	132	Fade to this colour when fading is used (see B<-fade>). The default colour
129	is black. resource B<fadeColor>.	133	is opaque black. resource B<fadeColor>.
130		134
131	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
132		136
133	Tint the transparent background pixmap with the given colour when	137	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	138	transparency is enabled with B<-tr> or B<-ip>. This only works for
…		…
182	that are checked in order when trying to find glyphs for characters. The	186	that are checked in order when trying to find glyphs for characters. The
183	first font defines the cell size for characters; other fonts might be	187	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	188	smaller, but not (in general) larger. A (hopefully) reasonable default
185	font list is always appended to it. See resource B<font> for more details.	189	font list is always appended to it. See resource B<font> for more details.
186		190
187	In short, to specify an X11 core font, just specify it's name or prefix it	191	In short, to specify an X11 core font, just specify its name or prefix it
188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	192	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	193	e.g.:
190		194
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	195	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	196	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
420		424
421	Remap a key symbol. See resource B<keysym>.	425	Remap a key symbol. See resource B<keysym>.
422		426
423	=item B<-embed> I<windowid>	427	=item B<-embed> I<windowid>
424		428
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	429	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	430	which enables applications to easily embed a terminal.
427		431
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	432	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	433	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	434	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
512		516
513	=over 4	517	=over 4
514		518
515	=item B<depth:> I<bitdepth>	519	=item B<depth:> I<bitdepth>
516		520
517	Compile I<frills>: Attempt to find a visual with the given bit depth;	521	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	522	option B<-depth>.
519		523
520	=item B<geometry:> I<geom>	524	=item B<geometry:> I<geom>
521		525
522	Create the window with the specified X window geometry [default 80x24];	526	Create the window with the specified X window geometry [default 80x24];
…		…
596	=item B<inheritPixmap:> I<boolean>	600	=item B<inheritPixmap:> I<boolean>
597		601
598	B<True>: make the background inherit the parent windows' pixmap, giving	602	B<True>: make the background inherit the parent windows' pixmap, giving
599	artificial transparency. B<False>: do not inherit the parent windows'	603	artificial transparency. B<False>: do not inherit the parent windows'
600	pixmap.	604	pixmap.
		605
		606	I<Please note that transparency of any kind if completely unsupported by
		607	the author. Don't bug him with installation questions!>
601		608
602	=item B<fading:> I<number>	609	=item B<fading:> I<number>
603		610
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	611	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		612
…		…
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.	1031	can start or end with whitespace.
1025		1032
1026	Please note that you need to double the C<\> in resource files, as	1033	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	1034	Xlib itself does its 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	1035	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029	processing).	1036	processing).
1030		1037
1031	You can define a range of keysyms in one shot by providing a I<string>	1038	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 `/'	1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
…		…
1267	This mode lets you input characters representing the keycap symbols of	1274	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1275	your keyboard, if representable in the current locale encoding.
1269		1276
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1277	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1278	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1279	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1280	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1281	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1282	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1283	reverse tab (Shift-Tab).
1277		1284
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1347	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1349	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1350	color0-color15.
1344		1351
1345	If Xft support has been compiled in and as long as Xft/Xrender don't get	1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346	their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB>	1353	additional 72 colours. The first 64 of those (with indices 16 to 79)
1347	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1354	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348	provided by X, where the additional A component specifies alpha (opacity)	1355	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1349	values (0 is completely transparent and the maximum is opaque). You	1356
1350	probably need to specify B<"-depth 32">, too, as X is far from just	1357	Together, all those colours implement the 88 colour xterm colours. Only
1351	supporting ARGB visuals out of the box.	1358	the first 16 can be changed using resources currently, the rest can only
		1359	be changed via command sequences ("escape codes").
1352		1360
1353	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354	always swapping the foreground/background colours. This is in contrast to	1362	always swapping the foreground/background colours. This is in contrast to
1355	I<xterm>(1) where the colours are only swapped if they have not otherwise	1363	I<xterm>(1) where the colours are only swapped if they have not otherwise
1356	been specified. For example,	1364	been specified. For example,
…		…
1361		1369
1362	would yield White on Black, while on I<xterm>(1) it would yield Black	1370	would yield White on Black, while on I<xterm>(1) it would yield Black
1363	on White.	1371	on White.
1364		1372
1365	=back	1373	=back
		1374
		1375	=head2 ALPHA CHANNEL SUPPORT
		1376
		1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1378	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1380	in addition to the ones provided by X, where the additional A component
		1381	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1382	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1383	to four hex digits specifiying the opacity value.
		1384
		1385	You probably need to specify B<"-depth 32">, too, and have the luck that
		1386	your X-server uses ARGB pixel layout, as X is far from just supporting
		1387	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1388
		1389	For example, the following selects an almost completely transparent red
		1390	background, and an almost opaque pink foreground:
		1391
		1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1393
		1394	I<Please note that transparency of any kind if completely unsupported by
		1395	the author. Don't bug him with installation questions!>
1366		1396
1367	=head1 ENVIRONMENT	1397	=head1 ENVIRONMENT
1368		1398
1369	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1370		1400
…		…
1403	C<--with-terminfo=PATH>.	1433	C<--with-terminfo=PATH>.
1404		1434
1405	=item B<DISPLAY>	1435	=item B<DISPLAY>
1406		1436
1407	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408	display in it's child processes.	1438	display in its child processes.
1409		1439
1410	=item B<SHELL>	1440	=item B<SHELL>
1411		1441
1412	The shell to be used for command execution, defaults to C</bin/sh>.	1442	The shell to be used for command execution, defaults to C</bin/sh>.
1413		1443
…		…
1455		1485
1456	=item Project Coordinator	1486	=item Project Coordinator
1457		1487
1458	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1488	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459		1489
1460	L<http://software.schmorp.de/#rxvt-unicode>	1490	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461		1491
1462	=back	1492	=back
1463		1493
1464	=head1 AUTHORS	1494	=head1 AUTHORS
1465		1495

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs. Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.117 by root, Fri Jul 28 09:14:10 2006 UTC