ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.35 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.42 by root, Wed Jan 11 23:08:54 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
… …
163 163
164 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
166 166
167 -fb *fontlist* 167 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
170 170
171 -fi *fontlist* 171 -fi *fontlist*
172 Compile font-styles: The italic font list to use when *italic* 172 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
174 174
175 -fbi *fontlist* 175 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when *bold 176 Compile *font-styles*: The bold italic font list to use when *bold
177 italic* characters are to be printed. See resource boldItalicFont 177 italic* characters are to be printed. See resource boldItalicFont
178 for details. 178 for details.
179 179
180 -is|+is 180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 182 foreground/background (default). See resource intensityStyles for
183 details. 183 details.
184 184
185 -name *name* 185 -name *name*
186 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
… …
251 externalBorder. 251 externalBorder.
252 252
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 254 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs.
256 262
257 -lsp *number* 263 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
260 linespace. 266 linespace.
… …
365 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
368 }); 374 });
369 375
370 -pty-fd *fileno* 376 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 379 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it. 380 without having to run a program within it.
375 381
376 If this switch is given, rxvt will not create any utmp/wtmp entries 382 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 384 yourself if you want that.
379 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
380 Here is a example in perl that illustrates how this option can be 389 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
382 391
383 use IO::Pty; 392 use IO::Pty;
384 use Fcntl; 393 use Fcntl;
… …
391 # now communicate with rxvt 400 # now communicate with rxvt
392 my $slave = $pty->slave; 401 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
394 403
395 -pe *string* 404 -pe *string*
396 Colon-separated list of perl extension scripts to use in this 405 Comma-separated list of perl extension scripts to use (or not to
397 terminal instance. See resource perl-ext. 406 use) in this terminal instance. See resource perl-ext for details.
398 407
399RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
400 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
401 compiled into your version. 410 compiled into your version.
402 411
403 There are two different methods that rxvt can use to get the Xresource
404 data: using the X libraries (Xrm*-functions) or internal Xresources
405 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
406 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
407 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
408 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
409 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
410 416
411 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416 422
417 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
418 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
419 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
420 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
421 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
422 resources, rxvt recognizes two class names: XTerm and URxvt. The class
423 name Rxvt allows resources common to both rxvt and the original *rxvt*
424 to be easily configured, while the class name URxvt allows resources
425 unique to rxvt, notably colours and key-handling, to be shared between
426 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
427 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
428 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
429 432
430 geometry: *geom* 433 geometry: *geom*
431 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
432 80x24]; option -geometry. 435 80x24]; option -geometry.
433 436
… …
711 borderLess: *boolean* 714 borderLess: *boolean*
712 Set MWM hints to request a borderless window, i.e. if honoured by 715 Set MWM hints to request a borderless window, i.e. if honoured by
713 the WM, the rxvt-unicode window will not have window decorations; 716 the WM, the rxvt-unicode window will not have window decorations;
714 option -bl. 717 option -bl.
715 718
719 skipBuiltinGlyphs: *boolean*
720 Compile *frills*: Disable the usage of the built-in block
721 graphics/line drawing characters and just rely on what the specified
722 fonts provide. Use this if you have a good font and want to use its
723 block graphic glyphs; option -sbg.
724
716 termName: *termname* 725 termName: *termname*
717 Specifies the terminal type name to be set in the TERM environment 726 Specifies the terminal type name to be set in the TERM environment
718 variable; option -tn. 727 variable; option -tn.
719 728
720 linespace: *number* 729 linespace: *number*
… …
859 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
860 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
861 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
862 it can start or end with whitespace. 871 it can start or end with whitespace.
863 872
864 Please note that you need to double the "\" when using 873 Please note that you need to double the "\" in resource files, as
865 "--enable-xgetdefault", as X itself does it's own de-escaping (you 874 Xlib itself does it's own de-escaping (you can use "\033" instead of
866 can use "\033" instead of "\e" (and so on), which will work with 875 "\e" (and so on), which will work with both Xt and rxvt's own
867 both Xt and rxvt's own processing). 876 processing).
868 877
869 You can define a range of keysyms in one shot by providing a 878 You can define a range of keysyms in one shot by providing a
870 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
871 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
872 881
… …
926 URxvt.keysym.M-C-3: command:\033[8;25;80t 935 URxvt.keysym.M-C-3: command:\033[8;25;80t
927 URxvt.keysym.M-C-4: command:\033[8;48;110t 936 URxvt.keysym.M-C-4: command:\033[8;48;110t
928 937
929 perl-ext-common: *string* 938 perl-ext-common: *string*
930 perl-ext: *string* 939 perl-ext: *string*
931 Colon-separated list(s) of perl extension scripts to use in this 940 Comma-separated list(s) of perl extension scripts (default:
932 terminal instance. Each extension is looked up in the library 941 "default") to use in this terminal instance; option -pe.
942
943 Extension names can be prefixed with a "-" sign to prohibit using
944 them. This can be useful to selectively disable some extensions
945 loaded by default, or specified via the "perl-ext-common" resource.
946 For example, "default,-selection" will use all the default extension
947 except "selection".
948
949 Extension names can also be followed by an argument in angle
950 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
951 for searchable scorllback to Alt/Meta-s). Mentioning the same
952 extension multiple times with different arguments will pass multiple
953 arguments to the extension.
954
955 Each extension is looked up in the library directories, loaded if
933 directories, loaded if necessary, and bound to the current terminal 956 necessary, and bound to the current terminal instance.
934 instance. If this resource is empty or missing, then the perl 957
958 If both of these resources are the empty string, then the perl
935 interpreter will not be initialized. The idea behind two options is 959 interpreter will not be initialized. The idea behind two options is
936 that perl-ext-common will be used for extensions that should be 960 that perl-ext-common will be used for extensions that should be
937 available to all instances, while perl-ext is used for specific 961 available to all instances, while perl-ext is used for specific
938 instances; option -pe. 962 instances.
939 963
940 perl-eval: *string* 964 perl-eval: *string*
941 Perl code to be evaluated when all extensions have been registered. 965 Perl code to be evaluated when all extensions have been registered.
942 See the rxvtperl(3) manpage. 966 See the rxvtperl(3) manpage. Due to security reasons, this resource
967 will be ignored when running setuid/setgid.
943 968
944 perl-lib: *path* 969 perl-lib: *path*
945 Colon-separated list of additional directories that hold extension 970 Colon-separated list of additional directories that hold extension
946 scripts. When looking for extensions specified by the "perl" 971 scripts. When looking for extensions specified by the "perl"
947 resource, rxvt will first look in these directories and then in 972 resource, rxvt will first look in these directories and then in
948 /opt/rxvt/lib/urxvt/perl/. 973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid.
949 975
950 See the rxvtperl(3) manpage. 976 See the rxvtperl(3) manpage.
977
978 urlLauncher: *string*
979 Specifies the program to be started with a URL argument. Used by the
980 "selection-popup" and "mark-urls" perl extensions.
981
982 transient-for: *windowid*
983 Sets the WM_TRANSIENT_FOR property to the given window iw.
951 984
952THE SCROLLBAR 985THE SCROLLBAR
953 Lines of text that scroll off the top of the rxvt window (resource: 986 Lines of text that scroll off the top of the rxvt window (resource:
954 saveLines) and can be scrolled back using the scrollbar or by 987 saveLines) and can be scrolled back using the scrollbar or by
955 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 988 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is

Diff Legend

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