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.61 by root, Sat Feb 19 01:07:57 2005 UTC vs.
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC

… …
112Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
114 114
115=item B<-fade> I<number> 115=item B<-fade> I<number>
116 116
117Fade the text by the given percentage when focus is lost. resource B<fading>. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
118 125
119=item B<-tint> I<colour> 126=item B<-tint> I<colour>
120 127
121Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
123option that can be used to brighten or darken the image in addition to 130option that can be used to brighten or darken the image in addition to
124tinting it. 131tinting it; resource I<tintColor>.
125 132
126=item B<-sh> 133=item B<-sh>
127 134
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 135I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 136background image in addition to tinting it (i.e. B<-tint> must be
… …
238 245
239Put scrollbar on right/left; resource B<scrollBar_right>. 246Put scrollbar on right/left; resource B<scrollBar_right>.
240 247
241=item B<-st>|B<+st> 248=item B<-st>|B<+st>
242 249
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 250Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 251resource B<scrollBar_floating>.
245 252
246=item B<-ptab>|B<+ptab> 253=item B<-ptab>|B<+ptab>
247 254
248If enabled (default), "Horizontal Tab" characters are being stored as 255If enabled (default), "Horizontal Tab" characters are being stored as
… …
548artificial transparency. B<False>: do not inherit the parent windows' 555artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 556pixmap.
550 557
551=item B<fading:> I<number> 558=item B<fading:> I<number>
552 559
553Fade the text by the given percentage when focus is lost. 560Fade the text by the given percentage when focus is lost; option B<-fade>.
561
562=item B<fadeColor:> I<colour>
563
564Fade to this colour, when fading is used (see B<fading:>). The default
565colour is black; option B<-fadecolor>.
554 566
555=item B<tintColor:> I<colour> 567=item B<tintColor:> I<colour>
556 568
557Tint the transparent background pixmap with the given colour. 569Tint the transparent background pixmap with the given colour; option
570B<-tint>.
558 571
559=item B<shading:> I<number> 572=item B<shading:> I<number>
560 573
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 574Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 575image in addition to tinting it.
… …
566Use the specified colour for the scrollbar [default #B2B2B2]. 579Use the specified colour for the scrollbar [default #B2B2B2].
567 580
568=item B<troughColor:> I<colour> 581=item B<troughColor:> I<colour>
569 582
570Use the specified colour for the scrollbar's trough area [default 583Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 584#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 585
573=item B<borderColor:> I<colour> 586=item B<borderColor:> I<colour>
574 587
575The colour of the border around the text area and between the scrollbar 588The colour of the border around the text area and between the scrollbar
576and the text. 589and the text.
… …
668xterm style selection. 681xterm style selection.
669 682
670=item B<scrollstyle:> I<mode> 683=item B<scrollstyle:> I<mode>
671 684
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 685Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 686the author's favourite.
674 687
675=item B<title:> I<string> 688=item B<title:> I<string>
676 689
677Set window title string, the default title is the command-line 690Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 691specified after the B<-e> option, if any, otherwise the application
… …
709=item B<print-pipe:> I<string> 722=item B<print-pipe:> I<string>
710 723
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 724Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 725B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 726B<Shift-Print> to include the scrollback as well.
727
728The string will be interpreted as if typed into the shell as-is.
729
730Example:
731
732 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
733
734This creates a new file in your home directory with the screen contents
735everytime you hit C<Print>.
714 736
715=item B<scrollBar:> I<boolean> 737=item B<scrollBar:> I<boolean>
716 738
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 739B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 740disable the scrollbar; option B<+sb>.
… …
815 837
816Mouse pointer background colour. 838Mouse pointer background colour.
817 839
818=item B<pointerBlankDelay:> I<number> 840=item B<pointerBlankDelay:> I<number>
819 841
820Specifies number of seconds before blanking the pointer [default 2]. 842Specifies number of seconds before blanking the pointer [default 2]. Use a
843large number (e.g. C<987654321>) to effectively disable the timeout.
821 844
822=item B<backspacekey:> I<string> 845=item B<backspacekey:> I<string>
823 846
824The string to send when the backspace key is pressed. If set to B<DEC> 847The string to send when the backspace key is pressed. If set to B<DEC>
825or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 848or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
… …
956is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
957example the following means "change the current locale to C<zh_CN.GBK> 980example the following means "change the current locale to C<zh_CN.GBK>
958when Control-Meta-c is being pressed": 981when Control-Meta-c is being pressed":
959 982
960 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 983 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
984
985Due the the large number of modifier combinations, a defined key mapping
986will match if at I<at least> the specified identifiers are being set, and
987no other key mappings with those and more bits are being defined. That
988means that defining a key map for C<a> will automatically provide
989definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
990mappings themselves.
991
992Unfortunately, this will override built-in key mappings. For example
993if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
994C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
995user-defined keymap using the C<builtin:> replacement:
996
997 URxvt.keysym.Insert: <my insert key sequence>
998 URxvt.keysym.S-Insert: builtin:
999
1000The first line defines a mapping for C<Insert> and I<any> combination
1001of modifiers. The second line re-establishes the default mapping for
1002C<Shift-Insert>.
961 1003
962The following example will map Control-Meta-1 and Control-Meta-2 to 1004The following example will map Control-Meta-1 and Control-Meta-2 to
963the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1005the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime: 1006font-switching at runtime:
965 1007
… …
1218=item B<RXVT_SOCKET> 1260=item B<RXVT_SOCKET>
1219 1261
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and 1262The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1). 1263@@RXVT_NAME@@d(1).
1222 1264
1223Default C<< $HOME/.rxvt-unicode-<nodename >>. 1265Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1224 1266
1225=item B<HOME> 1267=item B<HOME>
1226 1268
1227Used to locate the default directory for the unix domain socket for 1269Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as 1270daemon communications and to locate various resource files (such as
… …
1249 1291
1250=back 1292=back
1251 1293
1252=head1 SEE ALSO 1294=head1 SEE ALSO
1253 1295
1254@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1296@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1255 1297
1256=head1 BUGS 1298=head1 BUGS
1257 1299
1258Check the BUGS file for an up-to-date list. 1300Check the BUGS file for an up-to-date list.
1259 1301

Diff Legend

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