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.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.109 by root, Sun Jan 29 22:27:04 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<xft>: 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
… …
476=head1 RESOURCES (available also as long-options) 486=head1 RESOURCES (available also as long-options)
477 487
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 489options) compiled into your version.
480 490
481There are two different methods that @@RXVT_NAME@@ can use to get the 491You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 492distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 493starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 494with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 495
490 1. system-wide app-defaults file, either locale-dependent OR global 496 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 497 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 499 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 501
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 505configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 506B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 507configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 508be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 509settings. The following resources are supported (you might want to
509resources are allowed: 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
511extensions not documented here):
510 512
511=over 4 513=over 4
514
515=item B<depth:> I<bitdepth>
516
517Compile I<xft>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
512 519
513=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
514 521
515Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 523option B<-geometry>.
… …
635of 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
636specifies an integer number of images in that direction. No image will 643specifies an integer number of images in that direction. No image will
637be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
638scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
639 646
640=item B<menu:> I<file[;tag]>
641
642Read in the specified menu file (note the `.menu' extension is
643optional) and also optionally specify a starting tag to find. See the
644reference documentation for details on the syntax for the menuBar.
645
646=item B<path:> I<path> 647=item B<path:> I<path>
647 648
648Specify the colon-delimited search path for finding files (XPM and 649Specify the colon-delimited search path for finding XPM files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 650
652=item B<font:> I<fontlist> 651=item B<font:> I<fontlist>
653 652
654Select 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
655names that are used in turn when trying to display Unicode characters. 654that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 657font list is always appended to it; option B<-fn>.
659 658
660Each 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
661optional 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:>.
662 661
663In addition, each font can be prefixed with additional hints and 662In addition, each font can be prefixed with additional hints and
… …
665hint 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
666fonts. 665fonts.
667 666
668For example, this font resource 667For example, this font resource
669 668
670 URxvt*font: 9x15bold,\ 669 URxvt.font: 9x15bold,\
671 -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,\
672 -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, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 673 xft:Code2000:antialias=false
675 674
… …
772 771
773The 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.
774 773
775Example: 774Example:
776 775
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 777
779This 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
780everytime you hit C<Print>. 779everytime you hit C<Print>.
781 780
782=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
… …
907pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 907with the B<Execute> key.
909 908
910=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
911 910
912The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
913built-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:
914 921
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
916 923
917=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
918 925
… …
954default. (Note that many other terminals, including xterm, have these 961default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 962sequences enabled by default, which doesn't make it safer, though).
956 963
957You can enable them by setting this boolean resource or specifying 964You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 965B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 966locale, findfont, icon label and window title requests.
960menubar dispatch.
961 967
962=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
963 969
964Set 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>,
965B<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
… …
969 975
970Specify 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)
971character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 978in the entry on B<keysym> following.
973 979
974=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
975 981
976Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
977 983
978=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
979 985
980Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
981option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 989instead scroll the screen up.
984 990
985=item B<hold>: I<bool> 991=item B<hold>: I<boolean>
986 992
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 994will not immediately destroy its window when the program executed within
989it 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
990user. 996user.
… …
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace. 1024can start or end with whitespace.
1019 1025
1020Please note that you need to double the C<\> when using 1026Please note that you need to double the C<\> in resource files, as
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1023@@RXVT_NAME@@'s own processing). 1029processing).
1024 1030
1025You can define a range of keysyms in one shot by providing a I<string> 1031You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1027should be a character not used by the strings. 1033should be a character not used by the strings.
1028 1034
… …
1123F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124will be ignored when running setuid/setgid. 1130will be ignored when running setuid/setgid.
1125 1131
1126See the @@RXVT_NAME@@perl(3) manpage. 1132See the @@RXVT_NAME@@perl(3) manpage.
1127 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
1144=item B<searchable-scrollback:> I<keysym>
1145
1146Sets the hotkey that starts the incremental scrollback buffer search
1147(default: C<M-s>).
1148
1128=item B<urlLauncher>: I<string> 1149=item B<urlLauncher>: I<string>
1129 1150
1130Specifies 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
1131C<selection-popup> and C<mark-urls> perl extensions. 1152C<selection-popup> and C<mark-urls> perl extensions.
1132 1153
1133=item B<transient-for>: I<windowid> 1154=item B<transient-for>: I<windowid>
1134 1155
1135Sets 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>.
1136 1162
1137=back 1163=back
1138 1164
1139=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
1140 1166
… …
1182selection, and trailing whitespace is visually underlined and removed from 1208selection, and trailing whitespace is visually underlined and removed from
1183the selection. 1209the selection.
1184 1210
1185=item B<Insertion>: 1211=item B<Insertion>:
1186 1212
1187Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1188an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
1189inserted 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.
1190 1219
1191=back 1220=back
1192 1221
1193=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
1194 1223
1195Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
1196supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
1197 1226
1198You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
1199therefore using the menubar), e.g.:
1200 1228
1201 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
1202 1235
1203rxvt-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.
1204 1237
1205=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
1206 1239
… …
1277=head1 COLORS AND GRAPHICS 1310=head1 COLORS AND GRAPHICS
1278 1311
1279In addition to the default foreground and background colours, 1312In addition to the default foreground and background colours,
1280B<@@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
1281high-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
1282colours with their B<rgb.txt> names. 1315colours with their names.
1283 1316
1284=begin table 1317=begin table
1285 1318
1286 B<color0> (black) = Black 1319 B<color0> (black) = Black
1287 B<color1> (red) = Red3 1320 B<color1> (red) = Red3
… …
1307It is also possible to specify the colour values of B<foreground>, 1340It is also possible to specify the colour values of B<foreground>,
1308B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1309a 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
1310color0-color15. 1343color0-color15.
1311 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
1312Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1355Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1313always swapping the foreground/background colours. This is in contrast to 1356always swapping the foreground/background colours. This is in contrast to
1314I<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
1315been specified. For example, 1358been specified. For example,
1316 1359
… …
1368 1411
1369=item B<SHELL> 1412=item B<SHELL>
1370 1413
1371The 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>.
1372 1415
1373=item B<RXVTPATH>
1374
1375The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1376files.
1377
1378=item B<PATH>
1379
1380Used in the same way as C<RXVTPATH>.
1381
1382=item B<RXVT_SOCKET> 1416=item B<RXVT_SOCKET>
1383 1417
1384The unix domain socket path used by @@RXVT_NAME@@c(1) and 1418The unix domain socket path used by @@RXVT_NAME@@c(1) and
1385@@RXVT_NAME@@d(1). 1419@@RXVT_NAME@@d(1).
1386 1420
… …
1455 1489
1456Project Coordinator (changes.txt 2.21a to 2.4.5) 1490Project Coordinator (changes.txt 2.21a to 2.4.5)
1457 1491
1458=item Geoff Wing L<< <gcw@pobox.com> >> 1492=item Geoff Wing L<< <gcw@pobox.com> >>
1459 1493
1460Rewrote screen display and text selection routines. Project Coordinator 1494Rewrote screen display and text selection routines.
1495
1461(changes.txt 2.4.6 - rxvt-unicode) 1496Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1462 1497
1463=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1498=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1464 1499
1465Forked rxvt-unicode, rewrote most of the display code and internal 1500Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1466character handling to store text in unicode, improve xterm 1501extension, random hacks, numerous bugfixes and extensions.
1467compatibility and apply numerous other bugfixes and extensions.
1468 1502
1469Project Coordinator (Changes 1.0 -) 1503Project Coordinator (Changes 1.0 -)
1470 1504
1505=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1506
1507Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1508
1471=back 1509=back
1472 1510

Diff Legend

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