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.165 by root, Thu Oct 2 17:06:50 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
… …
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
… …
713 730
714Specify background blending type; option B<-blt>. 731Specify background blending type; option B<-blt>.
715 732
716=item B<blurRadius:> I<number> 733=item B<blurRadius:> I<number>
717 734
718Apply Gaussian Blurr with the specified radius to the transparent 735Apply gaussian blur with the specified radius to the transparent
719background 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>.
720 741
721=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
722 743
723Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
724 745
… …
791it 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
792wide and 15 pixels high. 813wide and 15 pixels high.
793 814
794The 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
795the base font, likewise the third, which is unfortunately non-bold, but 816the 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 817the bold version of the font does contain fewer characters, so this is a
797useful supplement. 818useful supplement.
798 819
799The 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
800are 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
801contains other characters, but we are not interested in them. 822contains other characters, but we are not interested in them.
… …
852=item B<urgentOnBell:> I<boolean> 873=item B<urgentOnBell:> I<boolean>
853 874
854B<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.
855B<False>: do not set the urgency hint [default]. 876B<False>: do not set the urgency hint [default].
856 877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
857=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
858 881
859B<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>.
860B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
861 884
… …
984 1007
985=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
986 1009
987B<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];
988option 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>.
989 1017
990=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
991 1019
992B<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
993of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
… …
1160when Control-Meta-c is being pressed": 1188when Control-Meta-c is being pressed":
1161 1189
1162 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
1163 1191
1164If 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>
1165is 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)
1166manpage. For example, the F<selection> extension (activated via 1194manpage. For example, the F<selection> extension (activated via
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1196
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1197 URxvt.keysym.M-C-c: perl:selection:rot13
1170 1198
… …
1228all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1229 1257
1230=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1231 1259
1232Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1233the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1234will be ignored when running setuid/setgid.
1235 1262
1236=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1237 1264
1238Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1239scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1240@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1241F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1242will be ignored when running setuid/setgid.
1243 1269
1244See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1245 1271
1246=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1247 1273
… …
1269 1295
1270=item B<override-redirect>: I<boolean> 1296=item B<override-redirect>: I<boolean>
1271 1297
1272Compile I<frills>: Sets override-redirect for the terminal window, making 1298Compile I<frills>: Sets override-redirect for the terminal window, making
1273it 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).
1274 1304
1275=item B<iso14755_52:> I<boolean> 1305=item B<iso14755_52:> I<boolean>
1276 1306
1277Turn on/off ISO 14755 5.2 mode (default enabled). 1307Turn on/off ISO 14755 5.2 mode (default enabled).
1278 1308
… …
1470Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1471always swapping the foreground/background colours. This is in contrast to 1501always swapping the foreground/background colours. This is in contrast to
1472I<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
1473been specified. For example, 1503been specified. For example,
1474 1504
1475=over 4
1476
1477=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1478 1506
1479would 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
1480on White. 1508White.
1481
1482=back
1483 1509
1484=head2 ALPHA CHANNEL SUPPORT 1510=head2 ALPHA CHANNEL SUPPORT
1485 1511
1486If 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
1487their 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