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.166 by root, Fri Oct 10 13:23:56 2008 UTC vs.
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 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
360=item B<-lsp> I<number> 370=item B<-lsp> I<number>
361 371
362Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
363the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
364B<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>.
365 382
366=item B<-tn> I<termname> 383=item B<-tn> I<termname>
367 384
368This 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
369B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
629=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
630 647
631Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
632foreground colour is the default. 649foreground colour is the default.
633 650
634=item B<colorRV:> I<colour>
635
636Use the specified colour as the background for reverse video characters
637when OPTION_HC is disabled (--disable-frills).
638
639=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
640 652
641If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
642itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
643 665
644=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
645 667
646Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
647foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
713 735
714Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
715 737
716=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
717 739
718Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
719background image; option B<-blr>. 741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
720 746
721=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
722 748
723Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
724 750
791it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
792wide and 15 pixels high. 818wide and 15 pixels high.
793 819
794The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
795the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
796the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
797useful supplement. 823useful supplement.
798 824
799The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
800are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
801contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
852=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
853 879
854B<True>: set the urgency hint for the wm on receipt of a bell character. 880B<True>: set the urgency hint for the wm on receipt of a bell character.
855B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
856 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
857=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
858 886
859B<True>: use visual bell on receipt of a bell character; option B<-vb>. 887B<True>: use visual bell on receipt of a bell character; option B<-vb>.
860B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
861 889
984 1012
985=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
986 1014
987B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
988option B<-bc>. 1016option B<-bc>.
1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
989 1022
990=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
991 1024
992B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
993of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
1160when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1161 1194
1162 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1163 1196
1164If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1165is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1166manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1201
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1170 1203
1267 1300
1268=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1269 1302
1270Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1271it almost invisible to window managers; option B<-override-redirect>. 1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1272 1309
1273=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1274 1311
1275Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1276 1313
1468Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1469always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1470I<xterm>(1) where the colours are only swapped if they have not otherwise 1507I<xterm>(1) where the colours are only swapped if they have not otherwise
1471been specified. For example, 1508been specified. For example,
1472 1509
1473=over 4
1474
1475=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1476 1511
1477would yield White on Black, while on I<xterm>(1) it would yield Black 1512would yield White on Black, while on I<xterm>(1) it would yield Black on
1478on White. 1513White.
1479
1480=back
1481 1514
1482=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1483 1516
1484If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1485their act together, rxvt-unicode will do it's own alpha channel management: 1518their act together, rxvt-unicode will do it's own alpha channel management:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines