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.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 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
… …
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.
… …
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.
714 742
715The string will be interpreted as if typed into the shell as-is. 743The string will be interpreted as if typed into the shell as-is.
716 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>.
751
717=item B<scrollBar:> I<boolean> 752=item B<scrollBar:> I<boolean>
718 753
719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 754B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
720disable the scrollbar; option B<+sb>. 755disable the scrollbar; option B<+sb>.
721 756
… …
875=item B<insecure:> I<boolean> 910=item B<insecure:> I<boolean>
876 911
877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
878echo 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
879abused if somebody gets 8-bit-clean access to your display, whether 914abused if somebody gets 8-bit-clean access to your display, whether
880throuh a mail client displaying mail bodies unfiltered or though 915through a mail client displaying mail bodies unfiltered or through
881write(1). Therefore, these sequences are disabled by default. (Note 916write(1) or any other means. Therefore, these sequences are disabled by
882that other terminals, including xterm, have these sequences 917default. (Note that many other terminals, including xterm, have these
883enabled by default). You can enable them by setting this boolean 918sequences enabled by default, which doesn't make it safer, though).
884resource or specifying B<-insecure> as an option. At the moment, this 919
885enabled display-answer, locale, findfont, icon label and window title 920You can enable them by setting this boolean resource or specifying
886requests 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.
887 924
888=item B<modifier:> I<modifier> 925=item B<modifier:> I<modifier>
889 926
890Set 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>,
891B<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
… …
905 942
906Turn on/off secondary screen scroll (default enabled). If the this 943Turn on/off secondary screen scroll (default enabled). If the this
907option is enabled, scrolls on the secondary screen will change the 944option is enabled, scrolls on the secondary screen will change the
908scrollback buffer and switching to/from the secondary screen will 945scrollback buffer and switching to/from the secondary screen will
909instead 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.
910 954
911=item B<keysym.>I<sym>: I<string> 955=item B<keysym.>I<sym>: I<string>
912 956
913Compile I<frills>: Associate I<string> with keysym I<sym>. The 957Compile I<frills>: Associate I<string> with keysym I<sym>. The
914intervening resource name B<keysym.> cannot be omitted. 958intervening resource name B<keysym.> cannot be omitted.
… …
1054supported in rxvt-unicode. Bug me if you need this. 1098supported in rxvt-unicode. Bug me if you need this.
1055 1099
1056You can, however, switch fonts at runtime using escape sequences (and 1100You can, however, switch fonts at runtime using escape sequences (and
1057therefore using the menubar), e.g.: 1101therefore using the menubar), e.g.:
1058 1102
1059 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1103 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1060 1104
1061rxvt-unicode will automatically re-apply these fonts to the output so far. 1105rxvt-unicode will automatically re-apply these fonts to the output so far.
1062 1106
1063=head1 ISO 14755 SUPPORT 1107=head1 ISO 14755 SUPPORT
1064 1108
… …
1240=item B<RXVT_SOCKET> 1284=item B<RXVT_SOCKET>
1241 1285
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and 1286The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1). 1287@@RXVT_NAME@@d(1).
1244 1288
1245Default C<< $HOME/.rxvt-unicode-<nodename >>. 1289Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1246 1290
1247=item B<HOME> 1291=item B<HOME>
1248 1292
1249Used to locate the default directory for the unix domain socket for 1293Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as 1294daemon communications and to locate various resource files (such as
… …
1271 1315
1272=back 1316=back
1273 1317
1274=head1 SEE ALSO 1318=head1 SEE ALSO
1275 1319
1276@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1320@@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)
1277
1278=head1 BUGS
1279
1280Check the BUGS file for an up-to-date list.
1281
1282Cursor change support is not yet implemented.
1283
1284Click-and-drag doesn't work with X11 mouse report overriding.
1285 1321
1286=head1 CURRENT PROJECT COORDINATOR 1322=head1 CURRENT PROJECT COORDINATOR
1287 1323
1288=over 4 1324=over 4
1289 1325

Diff Legend

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