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.63 by root, Fri Apr 22 02:09:39 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 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
… …
192=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
193 203
194Compile font-styles: The bold italic font list to use when bold characters are to 204Compile font-styles: The bold italic font list to use when bold characters are to
195be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
196 206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
212
197=item B<-name> I<name> 213=item B<-name> I<name>
198 214
199Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
201`.' or `*' characters. Also sets the icon and title name. 217`.' or `*' characters. Also sets the icon and title name.
… …
238 254
239Put scrollbar on right/left; resource B<scrollBar_right>. 255Put scrollbar on right/left; resource B<scrollBar_right>.
240 256
241=item B<-st>|B<+st> 257=item B<-st>|B<+st>
242 258
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 260resource B<scrollBar_floating>.
245 261
246=item B<-ptab>|B<+ptab> 262=item B<-ptab>|B<+ptab>
247 263
248If enabled (default), "Horizontal Tab" characters are being stored as 264If enabled (default), "Horizontal Tab" characters are being stored as
… …
303given on the command line. If this option is used, it must be the last 319given 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 320on 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, 321run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 322failing that, I<sh(1)>.
307 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
308=item B<-title> I<text> 329=item B<-title> I<text>
309 330
310Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 333application name; resource B<title>.
… …
367 388
368=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
369 390
370Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 392B<secondaryScroll>.
393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
372 400
373=item B<-keysym.>I<sym> I<string> 401=item B<-keysym.>I<sym> I<string>
374 402
375Remap a key symbol. See resource B<keysym>. 403Remap a key symbol. See resource B<keysym>.
376 404
… …
548artificial transparency. B<False>: do not inherit the parent windows' 576artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 577pixmap.
550 578
551=item B<fading:> I<number> 579=item B<fading:> I<number>
552 580
553Fade the text by the given percentage when focus is lost. 581Fade the text by the given percentage when focus is lost; option B<-fade>.
582
583=item B<fadeColor:> I<colour>
584
585Fade to this colour, when fading is used (see B<fading:>). The default
586colour is black; option B<-fadecolor>.
554 587
555=item B<tintColor:> I<colour> 588=item B<tintColor:> I<colour>
556 589
557Tint the transparent background pixmap with the given colour. 590Tint the transparent background pixmap with the given colour; option
591B<-tint>.
558 592
559=item B<shading:> I<number> 593=item B<shading:> I<number>
560 594
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 595Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 596image in addition to tinting it.
… …
566Use the specified colour for the scrollbar [default #B2B2B2]. 600Use the specified colour for the scrollbar [default #B2B2B2].
567 601
568=item B<troughColor:> I<colour> 602=item B<troughColor:> I<colour>
569 603
570Use the specified colour for the scrollbar's trough area [default 604Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 605#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 606
573=item B<borderColor:> I<colour> 607=item B<borderColor:> I<colour>
574 608
575The colour of the border around the text area and between the scrollbar 609The colour of the border around the text area and between the scrollbar
576and the text. 610and the text.
… …
659not possible, replacement fonts of the desired shape will be tried. 693not possible, replacement fonts of the desired shape will be tried.
660 694
661If set, but empty, then this specific style is disabled and the normal 695If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 696text font will being used for the given style.
663 697
698=item B<intensityStyles:> I<boolean>
699
700When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not
704reachable.
705
664=item B<selectstyle:> I<mode> 706=item B<selectstyle:> I<mode>
665 707
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
667xterm style with 2.20 old word selection, or anything else which gives 709xterm style with 2.20 old word selection, or anything else which gives
668xterm style selection. 710xterm style selection.
669 711
670=item B<scrollstyle:> I<mode> 712=item B<scrollstyle:> I<mode>
671 713
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 715the author's favourite.
674 716
675=item B<title:> I<string> 717=item B<title:> I<string>
676 718
677Set window title string, the default title is the command-line 719Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 720specified after the B<-e> option, if any, otherwise the application
… …
709=item B<print-pipe:> I<string> 751=item B<print-pipe:> I<string>
710 752
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 753Specify 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 754B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 755B<Shift-Print> to include the scrollback as well.
756
757The string will be interpreted as if typed into the shell as-is.
758
759Example:
760
761 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762
763This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>.
714 765
715=item B<scrollBar:> I<boolean> 766=item B<scrollBar:> I<boolean>
716 767
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 769disable the scrollbar; option B<+sb>.
… …
873=item B<insecure:> I<boolean> 924=item B<insecure:> I<boolean>
874 925
875Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 926Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876echo arbitrary strings like the icon name or the locale. This could be 927echo arbitrary strings like the icon name or the locale. This could be
877abused if somebody gets 8-bit-clean access to your display, whether 928abused if somebody gets 8-bit-clean access to your display, whether
878throuh a mail client displaying mail bodies unfiltered or though 929through a mail client displaying mail bodies unfiltered or through
879write(1). Therefore, these sequences are disabled by default. (Note 930write(1) or any other means. Therefore, these sequences are disabled by
880that other terminals, including xterm, have these sequences 931default. (Note that many other terminals, including xterm, have these
881enabled by default). You can enable them by setting this boolean 932sequences enabled by default, which doesn't make it safer, though).
882resource or specifying B<-insecure> as an option. At the moment, this 933
883enabled display-answer, locale, findfont, icon label and window title 934You can enable them by setting this boolean resource or specifying
884requests as well as dynamic menubar dispatch. 935B<-insecure> as an option. At the moment, this enables display-answer,
936locale, findfont, icon label and window title requests as well as dynamic
937menubar dispatch.
885 938
886=item B<modifier:> I<modifier> 939=item B<modifier:> I<modifier>
887 940
888Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 941Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 942B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
903 956
904Turn on/off secondary screen scroll (default enabled). If the this 957Turn on/off secondary screen scroll (default enabled). If the this
905option is enabled, scrolls on the secondary screen will change the 958option is enabled, scrolls on the secondary screen will change the
906scrollback buffer and switching to/from the secondary screen will 959scrollback buffer and switching to/from the secondary screen will
907instead scroll the screen up. 960instead scroll the screen up.
961
962=item B<hold>: I<bool>
963
964Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965will not immediately destroy its window when the program executed within
966it exits. Instead, it will wait till it is being killed or closed by the
967user.
908 968
909=item B<keysym.>I<sym>: I<string> 969=item B<keysym.>I<sym>: I<string>
910 970
911Compile I<frills>: Associate I<string> with keysym I<sym>. The 971Compile I<frills>: Associate I<string> with keysym I<sym>. The
912intervening resource name B<keysym.> cannot be omitted. 972intervening resource name B<keysym.> cannot be omitted.
… …
1033to select a word; Left triple-click to select the entire logical line 1093to select a word; Left triple-click to select the entire logical line
1034(which can span multiple screen lines), unless modified by resource 1094(which can span multiple screen lines), unless modified by resource
1035B<tripleclickwords>. 1095B<tripleclickwords>.
1036 1096
1037Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1097Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1038(Compile: I<frills>) will create a rectangular selection instead of a normal 1098(Compile: I<frills>) will create a rectangular selection instead of a
1039one. 1099normal one. In this mode, every selected row becomes its own line in the
1100selection, and trailing whitespace is visually underlined and removed from
1101the selection.
1040 1102
1041=item B<Insertion>: 1103=item B<Insertion>:
1042 1104
1043Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1105Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1044an B<@@RXVT_NAME@@> window causes the current text selection to be 1106an B<@@RXVT_NAME@@> window causes the current text selection to be
… …
1052supported in rxvt-unicode. Bug me if you need this. 1114supported in rxvt-unicode. Bug me if you need this.
1053 1115
1054You can, however, switch fonts at runtime using escape sequences (and 1116You can, however, switch fonts at runtime using escape sequences (and
1055therefore using the menubar), e.g.: 1117therefore using the menubar), e.g.:
1056 1118
1057 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1119 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1058 1120
1059rxvt-unicode will automatically re-apply these fonts to the output so far. 1121rxvt-unicode will automatically re-apply these fonts to the output so far.
1060 1122
1061=head1 ISO 14755 SUPPORT 1123=head1 ISO 14755 SUPPORT
1062 1124
… …
1238=item B<RXVT_SOCKET> 1300=item B<RXVT_SOCKET>
1239 1301
1240The unix domain socket path used by @@RXVT_NAME@@c(1) and 1302The unix domain socket path used by @@RXVT_NAME@@c(1) and
1241@@RXVT_NAME@@d(1). 1303@@RXVT_NAME@@d(1).
1242 1304
1243Default C<< $HOME/.rxvt-unicode-<nodename >>. 1305Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1244 1306
1245=item B<HOME> 1307=item B<HOME>
1246 1308
1247Used to locate the default directory for the unix domain socket for 1309Used to locate the default directory for the unix domain socket for
1248daemon communications and to locate various resource files (such as 1310daemon communications and to locate various resource files (such as
… …
1269 1331
1270=back 1332=back
1271 1333
1272=head1 SEE ALSO 1334=head1 SEE ALSO
1273 1335
1274@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1336@@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)
1275
1276=head1 BUGS
1277
1278Check the BUGS file for an up-to-date list.
1279
1280Cursor change support is not yet implemented.
1281
1282Click-and-drag doesn't work with X11 mouse report overriding.
1283 1337
1284=head1 CURRENT PROJECT COORDINATOR 1338=head1 CURRENT PROJECT COORDINATOR
1285 1339
1286=over 4 1340=over 4
1287 1341

Diff Legend

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