--- rxvt-unicode/doc/rxvt.1.pod 2005/01/16 19:22:16 1.43 +++ rxvt-unicode/doc/rxvt.1.pod 2005/02/17 15:07:48 1.59 @@ -16,8 +16,10 @@ =head1 FREQUENTLY ASKED QUESTIONS -See @@RXVT_NAME@@(7) (try C) for a list of frequently -asked questions and answer to them and some common problems. +See @@RXVT_NAME@@(7) (try C) for a list of +frequently asked questions and answer to them and some common +problems. That document is also accessible on the World-Wide-Web at +L. =head1 RXVT-UNICODE VS. RXVT @@ -330,10 +332,21 @@ =item B<-imlocale> I -The locale to use for opening the IM. You can use an LC_CTYPE of e.g. -de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input -extension to be able to input japanese characters while staying in -another locale. +The locale to use for opening the IM. You can use an C of e.g. +C for normal text processing but C for the +input extension to be able to input japanese characters while staying in +another locale. resource B. + +=item B<-imfont> I + +Set the font set to use for the X Input Method, see resource B +for more info. + +=item B<-tcw> + +Change the meaning of triple-click selection with the left mouse +button. Instead of selecting a full line it will extend the selection the +end of the logical line only. resource B. =item B<-insecure> @@ -357,11 +370,63 @@ Turn on/off secondary screen scroll (default enabled); resource B. -=item B<-xrm> I +=item B<-keysym.>I I + +Remap a key symbol. See resource B. + +=item B<-embed> I + +Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal. + +Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it +shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it +quite a bit, so don't expect it to keep some specific state. It's best to +create an extra subwindow for @@RXVT_NAME@@ and leave it alone. + +The window will not be destroyed when @@RXVT_NAME@@ exits. + +It might be useful to know that @@RXVT_NAME@@ will not close file +descriptors passed to it (except for stdin/out/err, of course), so you +can use file descriptors to communicate with the programs within the +terminal. This works regardless of wether the C<-embed> option was used or +not. + +Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in F): + + my $rxvt = new Gtk2::DrawingArea; + $...->add ($rxvt); # important to add it somewhere first + $rxvt->realize; # now it can be realized + my $xid = $rxvt->window->get_xid; + + system "@@RXVT_NAME@@ -embed $xid &"; + +=item B<-pty-fd> I + +Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty +pair but instead use the given filehandle as the tty master. This is +useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator +without having to run a program within it. + +If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp +entries and will not tinker with pty/tty permissions - you have to do that +yourself if you want that. -No effect on rxvt-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in I in -some window managers. +Here is a example in perl that illustrates how this option can be used (a +longer example is in F): + + use IO::Pty; + use Fcntl; + + my $pty = new IO::Pty; + fcntl $pty, F_SETFD, 0; # clear close-on-exec + + system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; + + # now communicate with rxvt + my $slave = $pty->slave; + while (<$slave>) { print $slave "got <$_>\n" } =back @@ -374,8 +439,16 @@ Xresource data: using the X libraries (Xrm*-functions) or internal Xresources reader (B<~/.Xdefaults>). For the first method (ie. B<@@RXVT_NAME@@ -h> lists B), you can set and change the -resources using X11 tools like B. Many distribution do also load -settings from the B<~/.Xresources> file when X starts. +resources using X11 tools like B. Many distribution do also load +settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ +will consult the following files/resources in order, with later settings +overwriting earlier ones: + + 1. system-wide app-defaults file, either locale-dependent OR global + 2. app-defaults file in $XAPPLRESDIR + 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults + 4. SCREEN_RESOURCES for the current screen + 5. $XENVIRONMENT file OR $HOME/.Xdefaults- If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults @@ -669,8 +742,8 @@ =item B I B: scroll with scrollback buffer when tty receives new lines (and -B is False); option B<+sw>. B: do not scroll -with scrollback buffer when tty recieves new lines; option B<-sw>. +B is False); option B<-sw>. B: do not scroll +with scrollback buffer when tty recieves new lines; option B<+sw>. =item B I @@ -777,11 +850,26 @@ =item B I -The locale to use for opening the IM. You can use an LC_CTYPE of e.g. -de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input -extension to be able to input japanese characters while staying in +The locale to use for opening the IM. You can use an C of e.g. +C for normal text processing but C for the +input extension to be able to input japanese characters while staying in another locale. option B<-imlocale>. +=item B I + +Specify the font-set used for XIM styles C or +C. It must be a standard X font set (XLFD patterns separated +by commas), i.e. it's not in the same format as the other font lists used +in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found +found, preferably one or two pixels differing in size to the base font. +option B<-imfont>. + +=item B I + +Change the meaning of triple-click selection with the left mouse +button. Instead of selecting a full line it will extend the selection to +the end of the logical line only. option B<-tcw>. + =item B I Enables "insecure" mode. Rxvt-unicode offers some escape sequences that @@ -831,7 +919,7 @@ The B, B and B modifiers are usually aliased to whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr -keys are being mapped. B is a artificial modifier mapped to the +keys are being mapped. B is a synthetic modifier mapped to the current application keymap mode state. The spellings of I can be obtained by using B(1) command or @@ -846,24 +934,44 @@ C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it can start or end with whitespace. +Please note that you need to double the C<\> when using +C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can +use C<\033> instead of C<\e> (and so on), which will work with both Xt and +@@RXVT_NAME@@'s own processing). + You can define a range of keysyms in one shot by providing a I with pattern B, where the delimeter `/' should be a character not used by the strings. Its usage can be demonstrated by an example: - URxvt.keysym.M-C-0x61: list|\e + URxvt.keysym.M-C-0x61: list|\033 The above line is equivalent to the following three lines: - URxvt.keysym.Meta-Control-0x61: \e - URxvt.keysym.Meta-Control-0x62: \e - URxvt.keysym.Meta-Control-0x63: \e - -If I takes the form of C, the specified B is -interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, -C means: change the current locale to -C. + URxvt.keysym.Meta-Control-0x61: \033 + URxvt.keysym.Meta-Control-0x62: \033 + URxvt.keysym.Meta-Control-0x63: \033 + +If I takes the form of C, the specified B +is interpreted and executed as @@RXVT_NAME@@'s control sequence. For +example the following means "change the current locale to C +when Control-Meta-c is being pressed": + + URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 + +The following example will map Control-Meta-1 and Control-Meta-2 to +the fonts C and C<9x15bold>, so you can have some limited +font-switching at runtime: + + URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 + URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 + +Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more +info): + + URxvt.keysym.M-C-3: command:\033[8;25;80t + URxvt.keysym.M-C-4: command:\033[8;48;110t =back @@ -887,9 +995,9 @@ If mouse reporting mode is active, the normal scrollbar actions are disabled -- on the assumption that we are using a fullscreen -application. Instead, pressing Button1 and Button3 sends B -(Next) and B (Prior), respectively. Similarly, clicking on the -up and down arrows sends B (Up) and B (Down), +application. Instead, pressing Button1 and Button3 sends B +(Next) and B (Prior), respectively. Similarly, clicking on the +up and down arrows sends B (Up) and B (Down), respectively. =head1 TEXT SELECTION AND INSERTION @@ -901,10 +1009,11 @@ =item B: -Left click at the beginning of the region, drag to the end of the -region and release; Right click to extend the marked region; Left -double-click to select a word; Left triple-click to select the entire -line. +Left click at the beginning of the region, drag to the end of the region +and release; Right click to extend the marked region; Left double-click +to select a word; Left triple-click to select the entire logical line +(which can span multiple screen lines), unless modified by resource +B. Starting a selection while pressing the B key (or B keys) (Compile: I) will create a rectangular selection instead of a normal @@ -940,7 +1049,7 @@ =over 4 -=item 5.1: Basic method +=item * 5.1: Basic method This allows you to enter unicode characters using their hexcode. @@ -957,7 +1066,7 @@ by pressing C and C, followed by C<6-7-1-D-SPACE-6-5-E-5>, followed by releasing the modifier keys. -=item 5.2: Keyboard symbols entry method +=item * 5.2: Keyboard symbols entry method This mode lets you input characters representing the keycap symbols of your keyboard, if representable in the current locale encoding. @@ -970,12 +1079,12 @@ C, although your intention might have been to enter a reverse tab (Shift-Tab). -=item 5.3: Screen-selection entry method +=item * 5.3: Screen-selection entry method While this is implemented already (it's basically the selection mechanism), it could be extended by displaying a unicode character map. -=item 5.4: Feedback method for identifying displayed characters for later input +=item * 5.4: Feedback method for identifying displayed characters for later input This method lets you display the unicode character code associated with characters already displayed. @@ -997,10 +1106,10 @@ =head1 LOGIN STAMP -B<@@RXVT_NAME@@> tries to write an entry into the I(5) file so -that it can be seen via the I command, and can accept messages. -To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on -some systems. +B<@@RXVT_NAME@@> tries to write an entry into the I(5) file so that +it can be seen via the I command, and can accept messages. To +allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root +on some systems or setgid to root or to some other group on others. =head1 COLORS AND GRAPHICS @@ -1053,20 +1162,87 @@ =head1 ENVIRONMENT -B<@@RXVT_NAME@@> sets the environment variables B, B -and B. The environment variable B is set to the X -window id number of the B<@@RXVT_NAME@@> window and it also uses and -sets the environment variable B to specify which display -terminal to use. B<@@RXVT_NAME@@> uses the environment variables -B and B to find XPM files. - -=head1 FILES +B<@@RXVT_NAME@@> sets and/or uses the following environment variables: =over 4 -=item B +=item B + +Normally set to C, unless overwritten at configure time, via +resources or on the commandline. -System file for login records. +=item B + +Either C, C, depending on wether @@RXVT_NAME@@ was +compiled with XPM support, and optionally with the added extension +C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. + +=item B + +Set to a string of the form C or C, where C is +the colour code used as default foreground/text colour (or the string +C to indicate that the default-colour escape sequence is to be +used), C is the colour code used as default background colour (or the +string C), and C is the string C if @@RXVT_NAME@@ +was compiled with XPM support. Libraries like C and C can +(and do) use this information to optimize screen output. + +=item B + +Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel +window, which usually has subwindows for the scrollbar, the terminal +window and so on). + +=item B + +Set to the terminfo directory iff @@RXVT_NAME@@ was configured with +C<--with-terminfo=PATH>. + +=item B + +Used by @@RXVT_NAME@@ to connect to the display and set to the correct +display in it's child processes. + +=item B + +The shell to be used for command execution, defaults to C. + +=item B + +The path where @@RXVT_NAME@@ looks for support files such as menu and xpm +files. + +=item B + +Used in the same way as C. + +=item B + +The unix domain socket path used by @@RXVT_NAME@@c(1) and +@@RXVT_NAME@@d(1). + +Default C<< $HOME/.rxvt-unicode->. + +=item B + +Used to locate the default directory for the unix domain socket for +daemon communications and to locate various resource files (such as +C<.Xdefaults>) + +=item B + +Directory where various X resource files are being located. + +=item B + +If set and accessible, gives the name of a X resource file to be loaded by +@@RXVT_NAME@@. + +=back + +=head1 FILES + +=over 4 =item B @@ -1092,13 +1268,9 @@ =item Project Coordinator -@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> - -=item Web page maintainter - -@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> +Marc A. Lehmann L<< >> -L<@@RXVT_WEBPAGE@@> +L =back @@ -1133,7 +1305,7 @@ Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) -=item Marc Alexander Lehmann L<< >> +=item Marc Alexander Lehmann L<< >> Forked rxvt-unicode, rewrote most of the display code and internal character handling to store text in unicode, improve xterm