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.73 by root, Thu Dec 15 18:14:08 2005 UTC

… …
105 105
106=item B<-j>|B<+j> 106=item B<-j>|B<+j>
107 107
108Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
109 109
110=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 111
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>. This only works for
123option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 135
126=item B<-sh> 136=item B<-sh>
127 137
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
… …
238 248
239Put scrollbar on right/left; resource B<scrollBar_right>. 249Put scrollbar on right/left; resource B<scrollBar_right>.
240 250
241=item B<-st>|B<+st> 251=item B<-st>|B<+st>
242 252
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 254resource B<scrollBar_floating>.
245 255
246=item B<-ptab>|B<+ptab> 256=item B<-ptab>|B<+ptab>
247 257
248If enabled (default), "Horizontal Tab" characters are being stored as 258If enabled (default), "Horizontal Tab" characters are being stored as
… …
548artificial transparency. B<False>: do not inherit the parent windows' 558artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 559pixmap.
550 560
551=item B<fading:> I<number> 561=item B<fading:> I<number>
552 562
553Fade the text by the given percentage when focus is lost. 563Fade the text by the given percentage when focus is lost; option B<-fade>.
564
565=item B<fadeColor:> I<colour>
566
567Fade to this colour, when fading is used (see B<fading:>). The default
568colour is black; option B<-fadecolor>.
554 569
555=item B<tintColor:> I<colour> 570=item B<tintColor:> I<colour>
556 571
557Tint the transparent background pixmap with the given colour. 572Tint the transparent background pixmap with the given colour; option
573B<-tint>.
558 574
559=item B<shading:> I<number> 575=item B<shading:> I<number>
560 576
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 577Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 578image in addition to tinting it.
… …
566Use the specified colour for the scrollbar [default #B2B2B2]. 582Use the specified colour for the scrollbar [default #B2B2B2].
567 583
568=item B<troughColor:> I<colour> 584=item B<troughColor:> I<colour>
569 585
570Use the specified colour for the scrollbar's trough area [default 586Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 587#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 588
573=item B<borderColor:> I<colour> 589=item B<borderColor:> I<colour>
574 590
575The colour of the border around the text area and between the scrollbar 591The colour of the border around the text area and between the scrollbar
576and the text. 592and the text.
… …
668xterm style selection. 684xterm style selection.
669 685
670=item B<scrollstyle:> I<mode> 686=item B<scrollstyle:> I<mode>
671 687
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 688Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 689the author's favourite.
674 690
675=item B<title:> I<string> 691=item B<title:> I<string>
676 692
677Set window title string, the default title is the command-line 693Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 694specified after the B<-e> option, if any, otherwise the application
… …
709=item B<print-pipe:> I<string> 725=item B<print-pipe:> I<string>
710 726
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 727Specify 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 728B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 729B<Shift-Print> to include the scrollback as well.
730
731The string will be interpreted as if typed into the shell as-is.
732
733Example:
734
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736
737This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>.
714 739
715=item B<scrollBar:> I<boolean> 740=item B<scrollBar:> I<boolean>
716 741
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 742B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 743disable the scrollbar; option B<+sb>.
… …
815 840
816Mouse pointer background colour. 841Mouse pointer background colour.
817 842
818=item B<pointerBlankDelay:> I<number> 843=item B<pointerBlankDelay:> I<number>
819 844
820Specifies number of seconds before blanking the pointer [default 2]. 845Specifies number of seconds before blanking the pointer [default 2]. Use a
846large number (e.g. C<987654321>) to effectively disable the timeout.
821 847
822=item B<backspacekey:> I<string> 848=item B<backspacekey:> I<string>
823 849
824The string to send when the backspace key is pressed. If set to B<DEC> 850The 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> 851or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
… …
872=item B<insecure:> I<boolean> 898=item B<insecure:> I<boolean>
873 899
874Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
875echo arbitrary strings like the icon name or the locale. This could be 901echo arbitrary strings like the icon name or the locale. This could be
876abused if somebody gets 8-bit-clean access to your display, whether 902abused if somebody gets 8-bit-clean access to your display, whether
877throuh a mail client displaying mail bodies unfiltered or though 903through a mail client displaying mail bodies unfiltered or through
878write(1). Therefore, these sequences are disabled by default. (Note 904write(1) or any other means. Therefore, these sequences are disabled by
879that other terminals, including xterm, have these sequences 905default. (Note that many other terminals, including xterm, have these
880enabled by default). You can enable them by setting this boolean 906sequences enabled by default, which doesn't make it safer, though).
881resource or specifying B<-insecure> as an option. At the moment, this 907
882enabled display-answer, locale, findfont, icon label and window title 908You can enable them by setting this boolean resource or specifying
883requests as well as dynamic menubar dispatch. 909B<-insecure> as an option. At the moment, this enables display-answer,
910locale, findfont, icon label and window title requests as well as dynamic
911menubar dispatch.
884 912
885=item B<modifier:> I<modifier> 913=item B<modifier:> I<modifier>
886 914
887Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 915Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
888B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 916B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
956is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
957example the following means "change the current locale to C<zh_CN.GBK> 985example the following means "change the current locale to C<zh_CN.GBK>
958when Control-Meta-c is being pressed": 986when Control-Meta-c is being pressed":
959 987
960 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
989
990Due the the large number of modifier combinations, a defined key mapping
991will match if at I<at least> the specified identifiers are being set, and
992no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide
994definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
995mappings themselves.
996
997Unfortunately, this will override built-in key mappings. For example
998if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
999C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1000user-defined keymap using the C<builtin:> replacement:
1001
1002 URxvt.keysym.Insert: <my insert key sequence>
1003 URxvt.keysym.S-Insert: builtin:
1004
1005The first line defines a mapping for C<Insert> and I<any> combination
1006of modifiers. The second line re-establishes the default mapping for
1007C<Shift-Insert>.
961 1008
962The following example will map Control-Meta-1 and Control-Meta-2 to 1009The 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 1010the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime: 1011font-switching at runtime:
965 1012
… …
1032supported in rxvt-unicode. Bug me if you need this. 1079supported in rxvt-unicode. Bug me if you need this.
1033 1080
1034You can, however, switch fonts at runtime using escape sequences (and 1081You can, however, switch fonts at runtime using escape sequences (and
1035therefore using the menubar), e.g.: 1082therefore using the menubar), e.g.:
1036 1083
1037 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1038 1085
1039rxvt-unicode will automatically re-apply these fonts to the output so far. 1086rxvt-unicode will automatically re-apply these fonts to the output so far.
1040 1087
1041=head1 ISO 14755 SUPPORT 1088=head1 ISO 14755 SUPPORT
1042 1089
… …
1218=item B<RXVT_SOCKET> 1265=item B<RXVT_SOCKET>
1219 1266
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and 1267The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1). 1268@@RXVT_NAME@@d(1).
1222 1269
1223Default C<< $HOME/.rxvt-unicode-<nodename >>. 1270Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1224 1271
1225=item B<HOME> 1272=item B<HOME>
1226 1273
1227Used to locate the default directory for the unix domain socket for 1274Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as 1275daemon communications and to locate various resource files (such as
… …
1249 1296
1250=back 1297=back
1251 1298
1252=head1 SEE ALSO 1299=head1 SEE ALSO
1253 1300
1254@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1301@@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
1256=head1 BUGS
1257
1258Check the BUGS file for an up-to-date list.
1259
1260Cursor change support is not yet implemented.
1261
1262Click-and-drag doesn't work with X11 mouse report overriding.
1263 1302
1264=head1 CURRENT PROJECT COORDINATOR 1303=head1 CURRENT PROJECT COORDINATOR
1265 1304
1266=over 4 1305=over 4
1267 1306

Diff Legend

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