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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.53 by root, Fri Feb 11 18:14:07 2005 UTC vs.
Revision 1.61 by root, Sat Feb 19 01:07:57 2005 UTC

368=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
369 369
370Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 371B<secondaryScroll>.
372 372
373=item B<-keysym.>I<sym>: I<string> 373=item B<-keysym.>I<sym> I<string>
374 374
375Remap a key symbol. See resource B<keysym>. 375Remap a key symbol. See resource B<keysym>.
376 376
377=item B<-xrm> I<resourcestring> 377=item B<-embed> I<windowid>
378 378
379No effect on rxvt-unicode. Simply passes through an argument to be made 379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380available in the instance's argument list. Appears in I<WM_COMMAND> in 380which enables applications to easily embed a terminal.
381some window managers. 381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
388
389It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or
393not.
394
395Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>):
397
398 my $rxvt = new Gtk2::Socket;
399 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &";
402 });
403
404=item B<-pty-fd> I<fileno>
405
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it.
410
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that.
414
415Here is a example in perl that illustrates how this option can be used (a
416longer example is in F<doc/pty-fd>):
417
418 use IO::Pty;
419 use Fcntl;
420
421 my $pty = new IO::Pty;
422 fcntl $pty, F_SETFD, 0; # clear close-on-exec
423 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
424 close $pty;
425
426 # now communicate with rxvt
427 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" }
382 429
383=back 430=back
384 431
385=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
386 433
692B<+si>. 739B<+si>.
693 740
694=item B<scrollWithBuffer:> I<boolean> 741=item B<scrollWithBuffer:> I<boolean>
695 742
696B<True>: scroll with scrollback buffer when tty receives new lines (and 743B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 744B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 745with scrollback buffer when tty recieves new lines; option B<+sw>.
699 746
700=item B<scrollTtyKeypress:> I<boolean> 747=item B<scrollTtyKeypress:> I<boolean>
701 748
702B<True>: scroll to bottom when a non-special key is pressed. Special keys 749B<True>: scroll to bottom when a non-special key is pressed. Special keys
703are those which are intercepted by rxvt-unicode for special handling and 750are those which are intercepted by rxvt-unicode for special handling and
1134Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1181Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135the colour code used as default foreground/text colour (or the string 1182the colour code used as default foreground/text colour (or the string
1136C<default> to indicate that the default-colour escape sequence is to be 1183C<default> to indicate that the default-colour escape sequence is to be
1137used), C<bg> is the colour code used as default background colour (or the 1184used), C<bg> is the colour code used as default background colour (or the
1138string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1185string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139was compiled with XPM support. Libraries like C<slang> can (and do) use 1186was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1140this information to optimize screen output. 1187(and do) use this information to optimize screen output.
1141 1188
1142=item B<WINDOWID> 1189=item B<WINDOWID>
1143 1190
1144Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1191Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145window, which usually has subwindows for the scrollbar, the terminal 1192window, which usually has subwindows for the scrollbar, the terminal
1218 1265
1219=over 4 1266=over 4
1220 1267
1221=item Project Coordinator 1268=item Project Coordinator
1222 1269
1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1270Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224 1271
1225L<@@RXVT_WEBPAGE@@> 1272L<http://software.schmorp.de/#rxvt-unicode>
1226 1273
1227=back 1274=back
1228 1275
1229=head1 AUTHORS 1276=head1 AUTHORS
1230 1277
1255=item Geoff Wing L<< <gcw@pobox.com> >> 1302=item Geoff Wing L<< <gcw@pobox.com> >>
1256 1303
1257Rewrote screen display and text selection routines. Project Coordinator 1304Rewrote screen display and text selection routines. Project Coordinator
1258(changes.txt 2.4.6 - rxvt-unicode) 1305(changes.txt 2.4.6 - rxvt-unicode)
1259 1306
1260=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1307=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261 1308
1262Forked rxvt-unicode, rewrote most of the display code and internal 1309Forked rxvt-unicode, rewrote most of the display code and internal
1263character handling to store text in unicode, improve xterm 1310character handling to store text in unicode, improve xterm
1264compatibility and apply numerous other bugfixes and extensions. 1311compatibility and apply numerous other bugfixes and extensions.
1265 1312

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines