ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.175 by root, Mon Apr 12 17:06:55 2010 UTC

… …
182horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>. 185resource I<blurRadius>.
186 186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
192
187=item B<-bg> I<colour> 193=item B<-bg> I<colour>
188 194
189Window background colour; resource B<background>. 195Window background colour; resource B<background>.
190 196
191=item B<-fg> I<colour> 197=item B<-fg> I<colour>
… …
315 321
316=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
317 323
318Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
319 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
320=item B<-iconic> 330=item B<-iconic>
321 331
322Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 333Alternative form is B<-ic>.
324 334
… …
340 350
341=item B<-bl> 351=item B<-bl>
342 352
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344if honoured by the WM, the rxvt-unicode window will not have window 354if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
346 357
347=item B<-override-redirect> 358=item B<-override-redirect>
348 359
349Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 361B<override-redirect>.
… …
359=item B<-lsp> I<number> 370=item B<-lsp> I<number>
360 371
361Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
364 382
365=item B<-tn> I<termname> 383=item B<-tn> I<termname>
366 384
367This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
712 730
713Specify background blending type; option B<-blt>. 731Specify background blending type; option B<-blt>.
714 732
715=item B<blurRadius:> I<number> 733=item B<blurRadius:> I<number>
716 734
717Apply Gaussian Blurr with the specified radius to the transparent 735Apply gaussian blur with the specified radius to the transparent
718background image; option B<-blr>. 736background image; option B<-blr>.
737
738=item B<iconFile:> I<file>
739
740Set the application icon pixmap; option B<-icon>.
719 741
720=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
721 743
722Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
723 745
… …
790it is named first) and thus defines the character cell grid to be 9 pixels 812it is named first) and thus defines the character cell grid to be 9 pixels
791wide and 15 pixels high. 813wide and 15 pixels high.
792 814
793The second font is just used to add additional unicode characters not in 815The second font is just used to add additional unicode characters not in
794the base font, likewise the third, which is unfortunately non-bold, but 816the base font, likewise the third, which is unfortunately non-bold, but
795the bold version of the font does contain less characters, so this is a 817the bold version of the font does contain fewer characters, so this is a
796useful supplement. 818useful supplement.
797 819
798The third font is an Xft font with aliasing turned off, and the characters 820The third font is an Xft font with aliasing turned off, and the characters
799are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
800contains other characters, but we are not interested in them. 822contains other characters, but we are not interested in them.
… …
851=item B<urgentOnBell:> I<boolean> 873=item B<urgentOnBell:> I<boolean>
852 874
853B<True>: set the urgency hint for the wm on receipt of a bell character. 875B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default]. 876B<False>: do not set the urgency hint [default].
855 877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
856=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
857 881
858B<True>: use visual bell on receipt of a bell character; option B<-vb>. 882B<True>: use visual bell on receipt of a bell character; option B<-vb>.
859B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
860 884
… …
983 1007
984=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
985 1009
986B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1010B<True>: blink the cursor. B<False>: do not blink the cursor [default];
987option B<-bc>. 1011option B<-bc>.
1012
1013=item B<cursorUnderline:> I<boolean>
1014
1015B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1016option B<-uc>.
988 1017
989=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
990 1019
991B<True>: blank the pointer when a key is pressed or after a set number 1020B<True>: blank the pointer when a key is pressed or after a set number
992of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
… …
1159when Control-Meta-c is being pressed": 1188when Control-Meta-c is being pressed":
1160 1189
1161 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162 1191
1163If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1192If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1164is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1193is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1165manpage. For example, the F<selection> extension (activated via 1194manpage. For example, the F<selection> extension (activated via
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167 1196
1168 URxvt.keysym.M-C-c: perl:selection:rot13 1197 URxvt.keysym.M-C-c: perl:selection:rot13
1169 1198
… …
1227all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1228 1257
1229=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1230 1259
1231Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1233will be ignored when running setuid/setgid.
1234 1262
1235=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1236 1264
1237Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1239@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241will be ignored when running setuid/setgid.
1242 1269
1243See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1244 1271
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246 1273
… …
1268 1295
1269=item B<override-redirect>: I<boolean> 1296=item B<override-redirect>: I<boolean>
1270 1297
1271Compile I<frills>: Sets override-redirect for the terminal window, making 1298Compile I<frills>: Sets override-redirect for the terminal window, making
1272it almost invisible to window managers; option B<-override-redirect>. 1299it almost invisible to window managers; option B<-override-redirect>.
1300
1301=item B<iso14755:> I<boolean>
1302
1303Turn on/off ISO 14755 (default enabled).
1273 1304
1274=item B<iso14755_52:> I<boolean> 1305=item B<iso14755_52:> I<boolean>
1275 1306
1276Turn on/off ISO 14755 5.2 mode (default enabled). 1307Turn on/off ISO 14755 5.2 mode (default enabled).
1277 1308
… …
1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470always swapping the foreground/background colours. This is in contrast to 1501always swapping the foreground/background colours. This is in contrast to
1471I<xterm>(1) where the colours are only swapped if they have not otherwise 1502I<xterm>(1) where the colours are only swapped if they have not otherwise
1472been specified. For example, 1503been specified. For example,
1473 1504
1474=over 4
1475
1476=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1477 1506
1478would yield White on Black, while on I<xterm>(1) it would yield Black 1507would yield White on Black, while on I<xterm>(1) it would yield Black on
1479on White. 1508White.
1480
1481=back
1482 1509
1483=head2 ALPHA CHANNEL SUPPORT 1510=head2 ALPHA CHANNEL SUPPORT
1484 1511
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486their act together, rxvt-unicode will do it's own alpha channel management: 1513their act together, rxvt-unicode will do it's own alpha channel management:

Diff Legend

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