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.30 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.41 by root, Wed Jan 11 02:13:55 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.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.3, 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 bold 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 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 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;
390 399
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 -perl *string* 404 -pe *string*
396 Used by perl extension. See resource perl. 405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details.
397 407
398RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
399 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
400 compiled into your version. 410 compiled into your version.
401 411
710 borderLess: *boolean* 720 borderLess: *boolean*
711 Set MWM hints to request a borderless window, i.e. if honoured by 721 Set MWM hints to request a borderless window, i.e. if honoured by
712 the WM, the rxvt-unicode window will not have window decorations; 722 the WM, the rxvt-unicode window will not have window decorations;
713 option -bl. 723 option -bl.
714 724
725 skipBuiltinGlyphs: *boolean*
726 Compile *frills*: Disable the usage of the built-in block
727 graphics/line drawing characters and just rely on what the specified
728 fonts provide. Use this if you have a good font and want to use its
729 block graphic glyphs; option -sbg.
730
715 termName: *termname* 731 termName: *termname*
716 Specifies the terminal type name to be set in the TERM environment 732 Specifies the terminal type name to be set in the TERM environment
717 variable; option -tn. 733 variable; option -tn.
718 734
719 linespace: *number* 735 linespace: *number*
884 the following means "change the current locale to "zh_CN.GBK" when 900 the following means "change the current locale to "zh_CN.GBK" when
885 Control-Meta-c is being pressed": 901 Control-Meta-c is being pressed":
886 902
887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 903 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
888 904
905 If *string* takes the form "perl:STRING", then the specified STRING
906 is passed to the "on_keyboard_command" perl handler. See the
907 rxvtperl(3) manpage. For example, the selection extension (activated
908 via "rxvt -pe selection") listens for "selection:rot13" events:
909
910 URxvt.keysym.M-C-c: perl:selection:rot13
911
889 Due the the large number of modifier combinations, a defined key 912 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are 913 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are 914 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will 915 being defined. That means that defining a key map for "a" will
893 automatically provide definitions for "Meta-a", "Shift-a" and so on, 916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
916 info): 939 info):
917 940
918 URxvt.keysym.M-C-3: command:\033[8;25;80t 941 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t 942 URxvt.keysym.M-C-4: command:\033[8;48;110t
920 943
944 perl-ext-common: *string*
921 perl: *string* 945 perl-ext: *string*
922 Used by perl extension and is free for any use, as it is not 946 Comma-separated list(s) of perl extension scripts (default:
923 interpreted by rxvt-unicode itself; option perl. 947 "default") to use in this terminal instance; option -pe.
948
949 Extension names can be prefixed with a "-" sign to prohibit using
950 them. This can be useful to selectively disable some extensions
951 loaded by default, or specified via the "perl-ext-common" resource.
952 For example, "default,-selection" will use all the default extension
953 except "selection".
954
955 Extension names can also be followed by an argument in angle
956 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
957 for searchable scorllback to Alt/Meta-s). Mentioning the same
958 extension multiple times with different arguments will pass multiple
959 arguments to the extension.
960
961 Each extension is looked up in the library directories, loaded if
962 necessary, and bound to the current terminal instance.
963
964 If both of these resources are the empty string, then the perl
965 interpreter will not be initialized. The idea behind two options is
966 that perl-ext-common will be used for extensions that should be
967 available to all instances, while perl-ext is used for specific
968 instances.
924 969
925 perl-eval: *string* 970 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See 971 Perl code to be evaluated when all extensions have been registered.
927 the rxvtperl(3) manpage. 972 See the rxvtperl(3) manpage. Due to security reasons, this resource
973 will be ignored when running setuid/setgid.
928 974
929 perl-lib: *path* 975 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded 976 Colon-separated list of additional directories that hold extension
931 and enabled for this terminal instance, in addition to scripts 977 scripts. When looking for extensions specified by the "perl"
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all 978 resource, rxvt will first look in these directories and then in
933 terminal instances. 979 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
980 will be ignored when running setuid/setgid.
934 981
935 See the rxvtperl(3) manpage. 982 See the rxvtperl(3) manpage.
983
984 urlLauncher: *string*
985 Specifies the program to be started with a URL argument. Used by the
986 "selection-popup" and "mark-urls" perl extensions.
987
988 transient-for: *windowid*
989 Sets the WM_TRANSIENT_FOR property to the given window iw.
936 990
937THE SCROLLBAR 991THE SCROLLBAR
938 Lines of text that scroll off the top of the rxvt window (resource: 992 Lines of text that scroll off the top of the rxvt window (resource:
939 saveLines) and can be scrolled back using the scrollbar or by 993 saveLines) and can be scrolled back using the scrollbar or by
940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 994 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines