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.75 by root, Tue Dec 27 01:50:00 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
303given on the command line. If this option is used, it must be the last 313given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 314on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 315run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 316failing that, I<sh(1)>.
307 317
318Please note that you must specify a program with arguments. If you want to
319run shell commands, you have to specify the shell, like this:
320
321 @@RXVT_NAME@@ -e sh -c "shell commands"
322
308=item B<-title> I<text> 323=item B<-title> I<text>
309 324
310Window title (B<-T> still respected); the default title is the basename 325Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 326of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 327application name; resource B<title>.
367 382
368=item B<-ssr>|B<+ssr> 383=item B<-ssr>|B<+ssr>
369 384
370Turn on/off secondary screen scroll (default enabled); resource 385Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 386B<secondaryScroll>.
387
388=item B<-hold>|B<+hold>
389
390Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
391will not immediately destroy its window when the program executed within
392it exits. Instead, it will wait till it is being killed or closed by the
393user; resource B<hold>.
372 394
373=item B<-keysym.>I<sym> I<string> 395=item B<-keysym.>I<sym> I<string>
374 396
375Remap a key symbol. See resource B<keysym>. 397Remap a key symbol. See resource B<keysym>.
376 398
548artificial transparency. B<False>: do not inherit the parent windows' 570artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 571pixmap.
550 572
551=item B<fading:> I<number> 573=item B<fading:> I<number>
552 574
553Fade the text by the given percentage when focus is lost. 575Fade the text by the given percentage when focus is lost; option B<-fade>.
576
577=item B<fadeColor:> I<colour>
578
579Fade to this colour, when fading is used (see B<fading:>). The default
580colour is black; option B<-fadecolor>.
554 581
555=item B<tintColor:> I<colour> 582=item B<tintColor:> I<colour>
556 583
557Tint the transparent background pixmap with the given colour. 584Tint the transparent background pixmap with the given colour; option
585B<-tint>.
558 586
559=item B<shading:> I<number> 587=item B<shading:> I<number>
560 588
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 589Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 590image in addition to tinting it.
566Use the specified colour for the scrollbar [default #B2B2B2]. 594Use the specified colour for the scrollbar [default #B2B2B2].
567 595
568=item B<troughColor:> I<colour> 596=item B<troughColor:> I<colour>
569 597
570Use the specified colour for the scrollbar's trough area [default 598Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 599#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 600
573=item B<borderColor:> I<colour> 601=item B<borderColor:> I<colour>
574 602
575The colour of the border around the text area and between the scrollbar 603The colour of the border around the text area and between the scrollbar
576and the text. 604and the text.
668xterm style selection. 696xterm style selection.
669 697
670=item B<scrollstyle:> I<mode> 698=item B<scrollstyle:> I<mode>
671 699
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 700Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 701the author's favourite.
674 702
675=item B<title:> I<string> 703=item B<title:> I<string>
676 704
677Set window title string, the default title is the command-line 705Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 706specified after the B<-e> option, if any, otherwise the application
709=item B<print-pipe:> I<string> 737=item B<print-pipe:> I<string>
710 738
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 739Specify 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 740B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 741B<Shift-Print> to include the scrollback as well.
742
743The string will be interpreted as if typed into the shell as-is.
744
745Example:
746
747 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748
749This creates a new file in your home directory with the screen contents
750everytime you hit C<Print>.
714 751
715=item B<scrollBar:> I<boolean> 752=item B<scrollBar:> I<boolean>
716 753
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 754B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 755disable the scrollbar; option B<+sb>.
815 852
816Mouse pointer background colour. 853Mouse pointer background colour.
817 854
818=item B<pointerBlankDelay:> I<number> 855=item B<pointerBlankDelay:> I<number>
819 856
820Specifies number of seconds before blanking the pointer [default 2]. 857Specifies number of seconds before blanking the pointer [default 2]. Use a
858large number (e.g. C<987654321>) to effectively disable the timeout.
821 859
822=item B<backspacekey:> I<string> 860=item B<backspacekey:> I<string>
823 861
824The string to send when the backspace key is pressed. If set to B<DEC> 862The 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> 863or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
872=item B<insecure:> I<boolean> 910=item B<insecure:> I<boolean>
873 911
874Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
875echo arbitrary strings like the icon name or the locale. This could be 913echo arbitrary strings like the icon name or the locale. This could be
876abused if somebody gets 8-bit-clean access to your display, whether 914abused if somebody gets 8-bit-clean access to your display, whether
877throuh a mail client displaying mail bodies unfiltered or though 915through a mail client displaying mail bodies unfiltered or through
878write(1). Therefore, these sequences are disabled by default. (Note 916write(1) or any other means. Therefore, these sequences are disabled by
879that other terminals, including xterm, have these sequences 917default. (Note that many other terminals, including xterm, have these
880enabled by default). You can enable them by setting this boolean 918sequences enabled by default, which doesn't make it safer, though).
881resource or specifying B<-insecure> as an option. At the moment, this 919
882enabled display-answer, locale, findfont, icon label and window title 920You can enable them by setting this boolean resource or specifying
883requests as well as dynamic menubar dispatch. 921B<-insecure> as an option. At the moment, this enables display-answer,
922locale, findfont, icon label and window title requests as well as dynamic
923menubar dispatch.
884 924
885=item B<modifier:> I<modifier> 925=item B<modifier:> I<modifier>
886 926
887Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 927Set 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 928B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
902 942
903Turn on/off secondary screen scroll (default enabled). If the this 943Turn on/off secondary screen scroll (default enabled). If the this
904option is enabled, scrolls on the secondary screen will change the 944option is enabled, scrolls on the secondary screen will change the
905scrollback buffer and switching to/from the secondary screen will 945scrollback buffer and switching to/from the secondary screen will
906instead scroll the screen up. 946instead scroll the screen up.
947
948=item B<hold>: I<bool>
949
950Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951will not immediately destroy its window when the program executed within
952it exits. Instead, it will wait till it is being killed or closed by the
953user.
907 954
908=item B<keysym.>I<sym>: I<string> 955=item B<keysym.>I<sym>: I<string>
909 956
910Compile I<frills>: Associate I<string> with keysym I<sym>. The 957Compile I<frills>: Associate I<string> with keysym I<sym>. The
911intervening resource name B<keysym.> cannot be omitted. 958intervening resource name B<keysym.> cannot be omitted.
956is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1003is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
957example the following means "change the current locale to C<zh_CN.GBK> 1004example the following means "change the current locale to C<zh_CN.GBK>
958when Control-Meta-c is being pressed": 1005when Control-Meta-c is being pressed":
959 1006
960 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1007 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1008
1009Due the the large number of modifier combinations, a defined key mapping
1010will match if at I<at least> the specified identifiers are being set, and
1011no other key mappings with those and more bits are being defined. That
1012means that defining a key map for C<a> will automatically provide
1013definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1014mappings themselves.
1015
1016Unfortunately, this will override built-in key mappings. For example
1017if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1018C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1019user-defined keymap using the C<builtin:> replacement:
1020
1021 URxvt.keysym.Insert: <my insert key sequence>
1022 URxvt.keysym.S-Insert: builtin:
1023
1024The first line defines a mapping for C<Insert> and I<any> combination
1025of modifiers. The second line re-establishes the default mapping for
1026C<Shift-Insert>.
961 1027
962The following example will map Control-Meta-1 and Control-Meta-2 to 1028The 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 1029the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime: 1030font-switching at runtime:
965 1031
1013to select a word; Left triple-click to select the entire logical line 1079to select a word; Left triple-click to select the entire logical line
1014(which can span multiple screen lines), unless modified by resource 1080(which can span multiple screen lines), unless modified by resource
1015B<tripleclickwords>. 1081B<tripleclickwords>.
1016 1082
1017Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1083Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1018(Compile: I<frills>) will create a rectangular selection instead of a normal 1084(Compile: I<frills>) will create a rectangular selection instead of a
1019one. 1085normal one. In this mode, every selected row becomes its own line in the
1086selection, and trailing whitespace is visually underlined and removed from
1087the selection.
1020 1088
1021=item B<Insertion>: 1089=item B<Insertion>:
1022 1090
1023Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1091Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1024an B<@@RXVT_NAME@@> window causes the current text selection to be 1092an B<@@RXVT_NAME@@> window causes the current text selection to be
1032supported in rxvt-unicode. Bug me if you need this. 1100supported in rxvt-unicode. Bug me if you need this.
1033 1101
1034You can, however, switch fonts at runtime using escape sequences (and 1102You can, however, switch fonts at runtime using escape sequences (and
1035therefore using the menubar), e.g.: 1103therefore using the menubar), e.g.:
1036 1104
1037 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1105 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1038 1106
1039rxvt-unicode will automatically re-apply these fonts to the output so far. 1107rxvt-unicode will automatically re-apply these fonts to the output so far.
1040 1108
1041=head1 ISO 14755 SUPPORT 1109=head1 ISO 14755 SUPPORT
1042 1110
1218=item B<RXVT_SOCKET> 1286=item B<RXVT_SOCKET>
1219 1287
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and 1288The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1). 1289@@RXVT_NAME@@d(1).
1222 1290
1223Default C<< $HOME/.rxvt-unicode-<nodename >>. 1291Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1224 1292
1225=item B<HOME> 1293=item B<HOME>
1226 1294
1227Used to locate the default directory for the unix domain socket for 1295Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as 1296daemon communications and to locate various resource files (such as
1249 1317
1250=back 1318=back
1251 1319
1252=head1 SEE ALSO 1320=head1 SEE ALSO
1253 1321
1254@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1322@@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 1323
1264=head1 CURRENT PROJECT COORDINATOR 1324=head1 CURRENT PROJECT COORDINATOR
1265 1325
1266=over 4 1326=over 4
1267 1327

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines