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.18 by root, Fri Feb 18 12:15:07 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.2, 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::DrawingArea;
340 $...->add ($rxvt); # important to add it somewhere first
341 $rxvt->realize; # now it can be realized
342 my $xid = $rxvt->window->get_xid;
343
344 system "rxvt -embed $xid &";
345
346 -pty-fd *fileno*
347 Tells rxvt NOT to execute any commands or create a new pty/tty pair
348 but instead use the given filehandle as the tty master. This is
349 useful if you want to drive rxvt as a generic terminal emulator
350 without having to run a program within it.
351
352 If this switch is given, rxvt will not create any utmp/wtmp entries
353 and will not tinker with pty/tty permissions - you have to do that
354 yourself if you want that.
355
356 Here is a example in perl that illustrates how this option can be
357 used (a longer example is in doc/pty-fd):
358
359 use IO::Pty;
360 use Fcntl;
361
362 my $pty = new IO::Pty;
363 fcntl $pty, F_SETFD, 0; # clear close-on-exec
364 system "rxvt -pty-fd " . (fileno $pty) . "&";
365 close $pty;
366
367 # now communicate with rxvt
368 my $slave = $pty->slave;
369 while (<$slave>) { print $slave "got <$_>\n" }
323 370
324RESOURCES (available also as long-options) 371RESOURCES (available also as long-options)
325 Note: `rxvt --help' gives a list of all resources (long options) 372 Note: `rxvt --help' gives a list of all resources (long options)
326 compiled into your version. 373 compiled into your version.
327 374
588 True: scroll to bottom when tty receives output; option -si. False: 635 True: scroll to bottom when tty receives output; option -si. False:
589 do not scroll to bottom when tty receives output; option +si. 636 do not scroll to bottom when tty receives output; option +si.
590 637
591 scrollWithBuffer: *boolean* 638 scrollWithBuffer: *boolean*
592 True: scroll with scrollback buffer when tty receives new lines (and 639 True: scroll with scrollback buffer when tty receives new lines (and
593 scrollTtyOutput is False); option +sw. False: do not scroll with 640 scrollTtyOutput is False); option -sw. False: do not scroll with
594 scrollback buffer when tty recieves new lines; option -sw. 641 scrollback buffer when tty recieves new lines; option +sw.
595 642
596 scrollTtyKeypress: *boolean* 643 scrollTtyKeypress: *boolean*
597 True: scroll to bottom when a non-special key is pressed. Special 644 True: scroll to bottom when a non-special key is pressed. Special
598 keys are those which are intercepted by rxvt-unicode for special 645 keys are those which are intercepted by rxvt-unicode for special
599 handling and are not passed onto the shell; option -sk. False: do 646 handling and are not passed onto the shell; option -sk. False: do

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines