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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.36 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.43 by root, Thu Jan 12 05:37:34 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
… …
371 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
373 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
374 }); 374 });
375 375
376 -pty-fd *fileno* 376 -pty-fd *file descriptor*
377 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
378 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
379 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
380 without having to run a program within it. 380 without having to run a program within it.
381 381
382 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
383 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
384 yourself if you want that. 384 yourself if you want that.
385 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
386 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
387 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
388 391
389 use IO::Pty; 392 use IO::Pty;
390 use Fcntl; 393 use Fcntl;
… …
397 # now communicate with rxvt 400 # now communicate with rxvt
398 my $slave = $pty->slave; 401 my $slave = $pty->slave;
399 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
400 403
401 -pe *string* 404 -pe *string*
402 Colon-separated list of perl extension scripts to use in this 405 Comma-separated list of perl extension scripts to use (or not to
403 terminal instance. See resource perl-ext. 406 use) in this terminal instance. See resource perl-ext for details.
404 407
405RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
406 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
407 compiled into your version. 410 compiled into your version.
408 411
409 There are two different methods that rxvt can use to get the Xresource
410 data: using the X libraries (Xrm*-functions) or internal Xresources
411 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
412 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
413 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
414 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
415 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
416 416
417 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 422
423 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
424 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
425 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
426 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
427 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
428 resources, rxvt recognizes two class names: XTerm and URxvt. The class
429 name Rxvt allows resources common to both rxvt and the original *rxvt*
430 to be easily configured, while the class name URxvt allows resources
431 unique to rxvt, notably colours and key-handling, to be shared between
432 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
433 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
434 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):
435 432
436 geometry: *geom* 433 geometry: *geom*
437 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
438 80x24]; option -geometry. 435 80x24]; option -geometry.
439 436
… …
871 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
872 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
873 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
874 it can start or end with whitespace. 871 it can start or end with whitespace.
875 872
876 Please note that you need to double the "\" when using 873 Please note that you need to double the "\" in resource files, as
877 "--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
878 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
879 both Xt and rxvt's own processing). 876 processing).
880 877
881 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
882 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
883 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
884 881
… …
938 URxvt.keysym.M-C-3: command:\033[8;25;80t 935 URxvt.keysym.M-C-3: command:\033[8;25;80t
939 URxvt.keysym.M-C-4: command:\033[8;48;110t 936 URxvt.keysym.M-C-4: command:\033[8;48;110t
940 937
941 perl-ext-common: *string* 938 perl-ext-common: *string*
942 perl-ext: *string* 939 perl-ext: *string*
943 Colon-separated list(s) of perl extension scripts to use in this 940 Comma-separated list(s) of perl extension scripts (default:
944 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
945 directories, loaded if necessary, and bound to the current terminal 956 necessary, and bound to the current terminal instance.
946 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
947 interpreter will not be initialized. The idea behind two options is 959 interpreter will not be initialized. The idea behind two options is
948 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
949 available to all instances, while perl-ext is used for specific 961 available to all instances, while perl-ext is used for specific
950 instances; option -pe. 962 instances.
951 963
952 perl-eval: *string* 964 perl-eval: *string*
953 Perl code to be evaluated when all extensions have been registered. 965 Perl code to be evaluated when all extensions have been registered.
954 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.
955 968
956 perl-lib: *path* 969 perl-lib: *path*
957 Colon-separated list of additional directories that hold extension 970 Colon-separated list of additional directories that hold extension
958 scripts. When looking for extensions specified by the "perl" 971 scripts. When looking for extensions specified by the "perl"
959 resource, rxvt will first look in these directories and then in 972 resource, rxvt will first look in these directories and then in
960 /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.
961 975
962 See the rxvtperl(3) manpage. 976 See the rxvtperl(3) manpage.
977
978 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s").
981
982 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions.
985
986 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw.
963 988
964THE SCROLLBAR 989THE SCROLLBAR
965 Lines of text that scroll off the top of the rxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
966 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
967 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is

Diff Legend

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