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.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.120 by root, Sat Aug 12 01:37:11 2006 UTC

… …
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
… …
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119 119
120I<Please note that transparency of any kind if completely unsupported by 120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!> 121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
122 123
123=item B<-fade> I<number> 124=item B<-fade> I<number>
124 125
125Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
… …
436The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
437 438
438It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
439descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
442not. 443not.
443 444
444Here is a short Gtk2-perl snippet that illustrates how this option can be 445Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
446 447
… …
451 }); 452 });
452 453
453=item B<-pty-fd> I<file descriptor> 454=item B<-pty-fd> I<file descriptor>
454 455
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456pair but instead use the given filehandle as the tty master. This is 457pair but instead use the given file descriptor as the tty master. This is
457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it. 459without having to run a program within it.
459 460
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461entries and will not tinker with pty/tty permissions - you have to do that 462entries and will not tinker with pty/tty permissions - you have to do that
… …
718 719
719=item B<intensityStyles:> I<boolean> 720=item B<intensityStyles:> I<boolean>
720 721
721When font styles are not enabled, or this option is enabled (B<True>, 722When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
725reachable. 726reachable.
726 727
727=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
728 729
… …
780Example: 781Example:
781 782
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783 784
784This creates a new file in your home directory with the screen contents 785This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>. 786every time you hit C<Print>.
786 787
787=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
788 789
789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
… …
812 813
813=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
814 815
815B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817with scrollback buffer when tty recieves new lines; option B<+sw>. 818with scrollback buffer when tty receives new lines; option B<+sw>.
818 819
819=item B<scrollTtyKeypress:> I<boolean> 820=item B<scrollTtyKeypress:> I<boolean>
820 821
821B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
822are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
… …
1025 1026
1026I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1028C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030can start or end with whitespace. 1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1031 1033
1032Please note that you need to double the C<\> in resource files, as 1034Please note that you need to double the C<\> in resource files, as
1033Xlib itself does its own de-escaping (you can use C<\033> instead of 1035Xlib itself does its own de-escaping (you can use C<\033> instead of
1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035processing). 1037processing).
1036 1038
1037You can define a range of keysyms in one shot by providing a I<string> 1039You can define a range of keysyms in one shot by providing a I<string>
1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039should be a character not used by the strings. 1041should be a character not used by the strings.
1040 1042
1041Its usage can be demonstrated by an example: 1043Its usage can be demonstrated by an example:
1042 1044
1043 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1045 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
1107example, C<default,-selection> will use all the default extension except 1109example, C<default,-selection> will use all the default extension except
1108C<selection>. 1110C<selection>.
1109 1111
1110Extension names can also be followed by an argument in angle brackets 1112Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1113(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension 1114searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to 1115multiple times with different arguments will pass multiple arguments to
1114the extension. 1116the extension.
1115 1117
1116Each extension is looked up in the library directories, loaded if 1118Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance. 1119necessary, and bound to the current terminal instance.
… …
1400=over 4 1402=over 4
1401 1403
1402=item B<TERM> 1404=item B<TERM>
1403 1405
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1406Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline. 1407resources or on the command line.
1406 1408
1407=item B<COLORTERM> 1409=item B<COLORTERM>
1408 1410
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1411Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension 1412compiled with XPM support, and optionally with the added extension
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1413C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1412 1414
1413=item B<COLORFGBG> 1415=item B<COLORFGBG>
1414 1416

Diff Legend

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