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.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.21 by root, Fri Apr 22 02:09:39 2005 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 , is a colour vt102 terminal emulator intended as 9 rxvt-unicode, version 5.5, is a colour vt102 terminal emulator intended
10 an *xterm*(1) replacement for users who do not require features such as 10 as an *xterm*(1) replacement for users who do not require features such
11 Tektronix 4014 emulation and toolkit-style configurability. As a result, 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 rxvt-unicode uses much less swap space -- a significant advantage on a 12 result, rxvt-unicode uses much less swap space -- a significant
13 machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
… …
311 311
312 -ssr|+ssr 312 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 313 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 314 secondaryScroll.
315 315
316 -keysym.*sym*: *string* 316 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 317 Remap a key symbol. See resource keysym.
318 318
319 -xrm *resourcestring* 319 -embed *windowid*
320 No effect on rxvt-unicode. Simply passes through an argument to be 320 Tells rxvt to embed it's windows into an already-existing window,
321 made available in the instance's argument list. Appears in 321 which enables applications to easily embed a terminal.
322 *WM_COMMAND* in some window managers. 322
323 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone.
327
328 The window will not be destroyed when rxvt exits.
329
330 It might be useful to know that rxvt will not close file descriptors
331 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was
334 used or not.
335
336 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed):
338
339 my $rxvt = new Gtk2::Socket;
340 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &";
343 });
344
345 -pty-fd *fileno*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it.
350
351 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that.
354
355 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd):
357
358 use IO::Pty;
359 use Fcntl;
360
361 my $pty = new IO::Pty;
362 fcntl $pty, F_SETFD, 0; # clear close-on-exec
363 system "rxvt -pty-fd " . (fileno $pty) . "&";
364 close $pty;
365
366 # now communicate with rxvt
367 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" }
323 369
324RESOURCES (available also as long-options) 370RESOURCES (available also as long-options)
325 Note: `rxvt --help' gives a list of all resources (long options) 371 Note: `rxvt --help' gives a list of all resources (long options)
326 compiled into your version. 372 compiled into your version.
327 373
… …
588 True: scroll to bottom when tty receives output; option -si. False: 634 True: scroll to bottom when tty receives output; option -si. False:
589 do not scroll to bottom when tty receives output; option +si. 635 do not scroll to bottom when tty receives output; option +si.
590 636
591 scrollWithBuffer: *boolean* 637 scrollWithBuffer: *boolean*
592 True: scroll with scrollback buffer when tty receives new lines (and 638 True: scroll with scrollback buffer when tty receives new lines (and
593 scrollTtyOutput is False); option +sw. False: do not scroll with 639 scrollTtyOutput is False); option -sw. False: do not scroll with
594 scrollback buffer when tty recieves new lines; option -sw. 640 scrollback buffer when tty recieves new lines; option +sw.
595 641
596 scrollTtyKeypress: *boolean* 642 scrollTtyKeypress: *boolean*
597 True: scroll to bottom when a non-special key is pressed. Special 643 True: scroll to bottom when a non-special key is pressed. Special
598 keys are those which are intercepted by rxvt-unicode for special 644 keys are those which are intercepted by rxvt-unicode for special
599 handling and are not passed onto the shell; option -sk. False: do 645 handling and are not passed onto the shell; option -sk. False: do
… …
651 pointerColor2: *colour* 697 pointerColor2: *colour*
652 Mouse pointer background colour. 698 Mouse pointer background colour.
653 699
654 pointerBlankDelay: *number* 700 pointerBlankDelay: *number*
655 Specifies number of seconds before blanking the pointer [default 2]. 701 Specifies number of seconds before blanking the pointer [default 2].
702 Use a large number (e.g. 987654321) to effectively disable the
703 timeout.
656 704
657 backspacekey: *string* 705 backspacekey: *string*
658 The string to send when the backspace key is pressed. If set to DEC 706 The string to send when the backspace key is pressed. If set to DEC
659 or unset it will send Delete (code 127) or, if shifted, Backspace 707 or unset it will send Delete (code 127) or, if shifted, Backspace
660 (code 8) - which can be reversed with the appropriate DEC private 708 (code 8) - which can be reversed with the appropriate DEC private
… …
776 is interpreted and executed as rxvt's control sequence. For example 824 is interpreted and executed as rxvt's control sequence. For example
777 the following means "change the current locale to "zh_CN.GBK" when 825 the following means "change the current locale to "zh_CN.GBK" when
778 Control-Meta-c is being pressed": 826 Control-Meta-c is being pressed":
779 827
780 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
829
830 Due the the large number of modifier combinations, a defined key
831 mapping will match if at *at least* the specified identifiers are
832 being set, and no other key mappings with those and more bits are
833 being defined. That means that defining a key map for "a" will
834 automatically provide definitions for "Meta-a", "Shift-a" and so on,
835 unless some of those are defined mappings themselves.
836
837 Unfortunately, this will override built-in key mappings. For example
838 if you overwrite the "Insert" key you will disable rxvt's
839 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
840 the user-defined keymap using the "builtin:" replacement:
841
842 URxvt.keysym.Insert: <my insert key sequence>
843 URxvt.keysym.S-Insert: builtin:
844
845 The first line defines a mapping for "Insert" and *any* combination
846 of modifiers. The second line re-establishes the default mapping for
847 "Shift-Insert".
781 848
782 The following example will map Control-Meta-1 and Control-Meta-2 to 849 The following example will map Control-Meta-1 and Control-Meta-2 to
783 the fonts "suxuseuro" and "9x15bold", so you can have some limited 850 the fonts "suxuseuro" and "9x15bold", so you can have some limited
784 font-switching at runtime: 851 font-switching at runtime:
785 852

Diff Legend

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