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.94 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.108 by root, Sun Jan 29 21:45:47 2006 UTC

93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
172resource B<borderColor>. 177resource B<borderColor>.
173 178
174=item B<-fn> I<fontlist> 179=item B<-fn> I<fontlist>
175 180
176Select the fonts to be used. This is a comma separated list of font names 181Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 182that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 183first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 184smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 185font list is always appended to it. See resource B<font> for more details.
181 186
182In short, to specify an X11 core font, just specify it's name or prefix it 187In short, to specify an X11 core font, just specify it's name or prefix it
296=item B<-bl> 301=item B<-bl>
297 302
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 303Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 304if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 305decorations; resource B<borderLess>.
306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
301 311
302=item B<-sbg> 312=item B<-sbg>
303 313
304Compile I<frills>: Disable the usage of the built-in block graphics/line 314Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 315drawing characters and just rely on what the specified fonts provide. Use
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 511extensions not documented here):
502 512
503=over 4 513=over 4
504 514
515=item B<depth:> I<bitdepth>
516
517Compile I<frills>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
519
505=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
506 521
507Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 523option B<-geometry>.
509 524
627of 1 displays the image without any scaling. A scale of 2 to 9 642of 1 displays the image without any scaling. A scale of 2 to 9
628specifies an integer number of images in that direction. No image will 643specifies an integer number of images in that direction. No image will
629be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
630scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
631 646
632=item B<menu:> I<file[;tag]>
633
634Read in the specified menu file (note the `.menu' extension is
635optional) and also optionally specify a starting tag to find. See the
636reference documentation for details on the syntax for the menuBar.
637
638=item B<path:> I<path> 647=item B<path:> I<path>
639 648
640Specify the colon-delimited search path for finding files (XPM and 649Specify the colon-delimited search path for finding XPM files.
641menus), in addition to the paths specified by the B<RXVTPATH> and
642B<PATH> environment variables.
643 650
644=item B<font:> I<fontlist> 651=item B<font:> I<fontlist>
645 652
646Select the fonts to be used. This is a comma separated list of font 653Select the fonts to be used. This is a comma separated list of font names
647names that are used in turn when trying to display Unicode characters. 654that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 657font list is always appended to it; option B<-fn>.
651 658
652Each font can either be a standard X11 core font (XLFD) name, with 659Each font can either be a standard X11 core font (XLFD) name, with
653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 660optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 661
655In addition, each font can be prefixed with additional hints and 662In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 664hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 665fonts.
659 666
660For example, this font resource 667For example, this font resource
661 668
662 URxvt*font: 9x15bold,\ 669 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 670 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 671 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 673 xft:Code2000:antialias=false
667 674
764 771
765The string will be interpreted as if typed into the shell as-is. 772The string will be interpreted as if typed into the shell as-is.
766 773
767Example: 774Example:
768 775
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 777
771This creates a new file in your home directory with the screen contents 778This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 779everytime you hit C<Print>.
773 780
774=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
899pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 907with the B<Execute> key.
901 908
902=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
903 910
904The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
905built-in default: 912(whitespace delimiting is added automatically if resource is given).
913
914When the selection extension is in use (the default if compiled in, see
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
916will be created (if the resource exists, otherwise, no regex will be
917created). In this mode, characters outside ISO-8859-1 can be used.
918
919When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used:
906 921
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 923
909=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
910 925
946default. (Note that many other terminals, including xterm, have these 961default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 962sequences enabled by default, which doesn't make it safer, though).
948 963
949You can enable them by setting this boolean resource or specifying 964You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 965B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 966locale, findfont, icon label and window title requests.
952menubar dispatch.
953 967
954=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
955 969
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 970Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 971B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 975
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 976Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 978in the entry on B<keysym> following.
965 979
966=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
967 981
968Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
969 983
970=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
971 985
972Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
973option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 989instead scroll the screen up.
976 990
977=item B<hold>: I<bool> 991=item B<hold>: I<boolean>
978 992
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 994will not immediately destroy its window when the program executed within
981it exits. Instead, it will wait till it is being killed or closed by the 995it exits. Instead, it will wait till it is being killed or closed by the
982user. 996user.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1130will be ignored when running setuid/setgid.
1117 1131
1118See the @@RXVT_NAME@@perl(3) manpage. 1132See the @@RXVT_NAME@@perl(3) manpage.
1119 1133
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135
1136Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1137details.
1138
1139=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140
1141Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142for details.
1143
1120=item B<searchable-scrollback:> I<keysym> 1144=item B<searchable-scrollback:> I<keysym>
1121 1145
1122Sets the hotkey that starts the incremental scrollback buffer search 1146Sets the hotkey that starts the incremental scrollback buffer search
1123(default: C<M-s>). 1147(default: C<M-s>).
1124 1148
1127Specifies the program to be started with a URL argument. Used by the 1151Specifies the program to be started with a URL argument. Used by the
1128C<selection-popup> and C<mark-urls> perl extensions. 1152C<selection-popup> and C<mark-urls> perl extensions.
1129 1153
1130=item B<transient-for>: I<windowid> 1154=item B<transient-for>: I<windowid>
1131 1155
1132Sets the WM_TRANSIENT_FOR property to the given window iw. 1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157
1158=item B<override-redirect>: I<boolean>
1159
1160Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>.
1133 1162
1134=back 1163=back
1135 1164
1136=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
1137 1166
1179selection, and trailing whitespace is visually underlined and removed from 1208selection, and trailing whitespace is visually underlined and removed from
1180the selection. 1209the selection.
1181 1210
1182=item B<Insertion>: 1211=item B<Insertion>:
1183 1212
1184Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1185an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
1186inserted as if it had been typed on the keyboard. 1215Meta modifier) to be inserted as if it had been typed on the keyboard.
1216
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too.
1187 1219
1188=back 1220=back
1189 1221
1190=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
1191 1223
1192Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
1193supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
1194 1226
1195You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
1196therefore using the menubar), e.g.:
1197 1228
1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1229 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1230
1231You can use keyboard shortcuts, too:
1232
1233 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1234 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1199 1235
1200rxvt-unicode will automatically re-apply these fonts to the output so far. 1236rxvt-unicode will automatically re-apply these fonts to the output so far.
1201 1237
1202=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
1203 1239
1274=head1 COLORS AND GRAPHICS 1310=head1 COLORS AND GRAPHICS
1275 1311
1276In addition to the default foreground and background colours, 1312In addition to the default foreground and background colours,
1277B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1278high-intensity bold/blink versions of the same). Here is a list of the 1314high-intensity bold/blink versions of the same). Here is a list of the
1279colours with their B<rgb.txt> names. 1315colours with their names.
1280 1316
1281=begin table 1317=begin table
1282 1318
1283 B<color0> (black) = Black 1319 B<color0> (black) = Black
1284 B<color1> (red) = Red3 1320 B<color1> (red) = Red3
1304It is also possible to specify the colour values of B<foreground>, 1340It is also possible to specify the colour values of B<foreground>,
1305B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1306a number 0-15, as a convenient shorthand to reference the colour name of 1342a number 0-15, as a convenient shorthand to reference the colour name of
1307color0-color15. 1343color0-color15.
1308 1344
1345If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1346their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1347(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>
1348and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
1349provided by X, where the additional A component specifies alpha (opacity)
1350values (0 is completely transparent and the maximum is opaque). You
1351probably need to specify B<"-depth 32">, too, and have the luck that your
1352X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1353visuals out of the box, and rxvt-unicode just fudges around.
1354
1309Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1355Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1310always swapping the foreground/background colours. This is in contrast to 1356always swapping the foreground/background colours. This is in contrast to
1311I<xterm>(1) where the colours are only swapped if they have not otherwise 1357I<xterm>(1) where the colours are only swapped if they have not otherwise
1312been specified. For example, 1358been specified. For example,
1313 1359
1365 1411
1366=item B<SHELL> 1412=item B<SHELL>
1367 1413
1368The shell to be used for command execution, defaults to C</bin/sh>. 1414The shell to be used for command execution, defaults to C</bin/sh>.
1369 1415
1370=item B<RXVTPATH>
1371
1372The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1373files.
1374
1375=item B<PATH>
1376
1377Used in the same way as C<RXVTPATH>.
1378
1379=item B<RXVT_SOCKET> 1416=item B<RXVT_SOCKET>
1380 1417
1381The unix domain socket path used by @@RXVT_NAME@@c(1) and 1418The unix domain socket path used by @@RXVT_NAME@@c(1) and
1382@@RXVT_NAME@@d(1). 1419@@RXVT_NAME@@d(1).
1383 1420
1452 1489
1453Project Coordinator (changes.txt 2.21a to 2.4.5) 1490Project Coordinator (changes.txt 2.21a to 2.4.5)
1454 1491
1455=item Geoff Wing L<< <gcw@pobox.com> >> 1492=item Geoff Wing L<< <gcw@pobox.com> >>
1456 1493
1457Rewrote screen display and text selection routines. Project Coordinator 1494Rewrote screen display and text selection routines.
1495
1458(changes.txt 2.4.6 - rxvt-unicode) 1496Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1459 1497
1460=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1498=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1499
1462Forked rxvt-unicode, rewrote most of the display code and internal 1500Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1463character handling to store text in unicode, improve xterm 1501extension, random hacks, numerous bugfixes and extensions.
1464compatibility and apply numerous other bugfixes and extensions.
1465 1502
1466Project Coordinator (Changes 1.0 -) 1503Project Coordinator (Changes 1.0 -)
1467 1504
1505=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1506
1507Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1508
1468=back 1509=back
1469 1510

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines