--- rxvt-unicode/doc/rxvt.7.txt 2006/01/11 05:29:40 1.37 +++ rxvt-unicode/doc/rxvt.7.txt 2006/01/19 19:26:31 1.48 @@ -20,6 +20,46 @@ . FREQUENTLY ASKED QUESTIONS + The new selection selects pieces that are too big, how can I select + single words? + Yes. For example, if you want to select alphanumeric words, you can + use the following resource: + + URxvt.selection.pattern-0: ([[:word:]]+) + + If you click more than twice, the selection will be extended more + and more. + + To get a selection that is very similar to the old code, try this + pattern: + + URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) + + Please also note that the *LeftClick Shift-LeftClik* combination + also selects words like the old code. + + I don't like the new selection/popups/hotkeys/perl, how do I + change/disable it? + You can disable the perl extension completely by setting the + perl-ext-common resource to the empty string, which also keeps + rxvt-unicode from initialising perl, saving memory. + + If you only want to disable specific features, you first have to + identify which perl extension is responsible. For this, read the + section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For + example, to disable the selection-popup and option-popup, specify + this perl-ext-common resource: + + URxvt.perl-ext-common: default,-selection-popup,-option-popup + + This will keep the default extensions, but disable the two popup + extensions. Some extensions can also be configured, for example, + scrollback search mode is triggered by M-s. You can move it to any + other combination either by setting the searchable-scrollback + resource: + + URxvt.searchable-scrollback: CM-s + Isn't rxvt supposed to be small? Don't all those features bloat? I often get asked about this, and I think, no, they didn't cause extra bloat. If you compare a minimal rxvt and a minimal urxvt, you @@ -111,13 +151,14 @@ I am using Debian GNU/Linux and have a problem... The Debian GNU/Linux package of rxvt-unicode in sarge contains large - patches that considerably change the behaviour of rxvt-unicode. - Before reporting a bug to the original rxvt-unicode author please - download and install the genuine version - () and try to reproduce the - problem. If you cannot, chances are that the problems are specific - to Debian GNU/Linux, in which case it should be reported via the - Debian Bug Tracking System (use "reportbug" to report the bug). + patches that considerably change the behaviour of rxvt-unicode (but + unfortunately this notice has been removed). Before reporting a bug + to the original rxvt-unicode author please download and install the + genuine version () and try + to reproduce the problem. If you cannot, chances are that the + problems are specific to Debian GNU/Linux, in which case it should + be reported via the Debian Bug Tracking System (use "reportbug" to + report the bug). For other problems that also affect the Debian package, you can and probably should use the Debian BTS, too, because, after all, it's @@ -148,22 +189,21 @@ I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? - Likely not. While I honestly try to make it secure, and am probably - not bad at it, I think it is simply unreasonable to expect all of - freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to - all be secure. Also, rxvt-unicode disables some options when it - detects that it runs setuid or setgid, which is not nice. - - Elevated privileges are only required for utmp and pty operations on - some systems (for example, GNU/Linux doesn't need any extra - privileges for ptys, but some need it for utmp support). If - rxvt-unicode doesn't support the library/setuid helper that your OS - needs I'll be happy to assist you in implementing support for it. - - So, while setuid/setgid operation is supported and not a problem on - your typical single-user-no-other-logins unix desktop, always - remember that its an awful lot of code, most of which isn't checked - for security issues regularly. + It should be, starting with release 7.1. You are encouraged to + properly install urxvt with privileges necessary for your OS now. + + When rxvt-unicode detects that it runs setuid or setgid, it will + fork into a helper process for privileged operations (pty handling + on some systems, utmp/wtmp/lastlog handling on others) and drop + privileges immediately. This is much safer than most other terminals + that keep privileges while running (but is more relevant to urxvt, + as it contains things as perl interpreters, which might be "helpful" + to attackers). + + This forking is done as the very first within main(), which is very + early and reduces possible bugs to initialisation code run before + main(), or things like the dynamic loader of your system, which + should result in very little risk. When I log-in to another system it tells me about missing terminfo data? The terminal description used by rxvt-unicode is not as widely @@ -561,7 +601,7 @@ You can specify separate locales for the input method and the rest of the terminal, using the resource "imlocale": - URxvt*imlocale: ja_JP.EUC-JP + URxvt.imlocale: ja_JP.EUC-JP Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and still use your input method. Please note, however, that you will not @@ -614,7 +654,7 @@ some editors prematurely may leave the mouse in mouse report mode. I've heard that tcsh may use mouse reporting unless it otherwise specified. A quick check is to see if cut/paste works when the Alt - or Shift keys are depressed. See rxvt(7) + or Shift keys are depressed. What's with this bold/blink stuff? If no bold colour is set via "colorBD:", bold will invert text using @@ -710,7 +750,7 @@ $ stty erase ^? $ rxvt - Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). + Toggle with "ESC [ 36 h" / "ESC [ 36 l". For an existing rxvt-unicode: @@ -832,8 +872,8 @@ DESCRIPTION The rest of this document describes various technical aspects of rxvt-unicode. First the description of supported command sequences, - followed by menu and pixmap support and last by a description of all - features selectable at "configure" time. + followed by pixmap support and last by a description of all features + selectable at "configure" time. Definitions "c" The literal character c. @@ -1212,10 +1252,6 @@ h Send Mouse X & Y on button press. l No mouse reporting. - "Ps = 10" (rxvt) - h menuBar visible - l menuBar invisible - "Ps = 25" h Visible cursor {cnorm/cvvis} l Invisible cursor {civis} @@ -1311,14 +1347,13 @@ Ps = 17 Change colour of highlight characters to Pt Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] - Ps = 20 Change default background to Pt + Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM). Ps = 39 Change default foreground colour to Pt. Ps = 46 Change Log File to Pt unimplemented Ps = 49 Change default background colour to Pt. Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n Ps = 55 Log all scrollback buffer and all of screen to Pt Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). - Ps = 703 Menubar command Pt (Compile menubar). Ps = 704 Change colour of italic characters to Pt Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). Ps = 706 Change colour of bold characters to Pt @@ -1333,334 +1368,6 @@ -menuBar - The exact syntax used is *almost* solidified. In the menus, DON'T try to - use menuBar commands that add or remove a menuBar. - - Note that in all of the commands, the */path/* *cannot* be omitted: use - ./ to specify a menu relative to the current menu. - - Overview of menuBar operation - For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of - "Pt" can be used for a variety of tasks: - - At the top level is the current menuBar which is a member of a circular - linked-list of other such menuBars. - - The menuBar acts as a parent for the various drop-down menus, which in - turn, may have labels, separator lines, menuItems and subMenus. - - The menuItems are the useful bits: you can use them to mimic keyboard - input or even to send text or escape sequences back to rxvt. - - The menuBar syntax is intended to provide a simple yet robust method of - constructing and manipulating menus and navigating through the menuBars. - - The first step is to use the tag [menu:*name*] which creates the menuBar - called *name* and allows access. You may now or menus, subMenus, and - menuItems. Finally, use the tag [done] to set the menuBar access as - readonly to prevent accidental corruption of the menus. To re-access the - current menuBar for alterations, use the tag [menu], make the - alterations and then use [done] - - - - Commands - [menu:+*name*] - access the named menuBar for creation or alteration. If a new - menuBar is created, it is called *name* (max of 15 chars) and the - current menuBar is pushed onto the stack - - [menu] - access the current menuBar for alteration - - [title:+*string*] - set the current menuBar's title to *string*, which may contain the - following format specifiers: - - B<%n> rxvt name (as per the B<-name> command-line option) - B<%v> rxvt version - B<%%> literal B<%> character - - [done] - set menuBar access as readonly. End-of-file tag for [read:+*file*] - operations. - - [read:+*file*] - read menu commands directly from *file* (extension ".menu" will be - appended if required.) Start reading at a line with [menu] or - [menu:+*name* and continuing until [done] is encountered. - - Blank and comment lines (starting with #) are ignored. Actually, - since any invalid menu commands are also ignored, almost anything - could be construed as a comment line, but this may be tightened up - in the future ... so don't count on it!. - - [read:+*file*;+*name*] - The same as [read:+*file*], but start reading at a line with - [menu:+*name*] and continuing until [done:+*name*] or [done] is - encountered. - - [dump] - dump all menuBars to the file /tmp/rxvt-PID in a format suitable for - later rereading. - - [rm:name] - remove the named menuBar - - [rm] [rm:] - remove the current menuBar - - [rm*] [rm:*] - remove all menuBars - - [swap] - swap the top two menuBars - - [prev] - access the previous menuBar - - [next] - access the next menuBar - - [show] - Enable display of the menuBar - - [hide] - Disable display of the menuBar - - [pixmap:+*name*] - [pixmap:+*name*;*scaling*] - (set the background pixmap globally - - A Future implementation *may* make this local to the menubar) - - [:+*command*:] - ignore the menu readonly status and issue a *command* to or a menu - or menuitem or change the ; a useful shortcut for setting the quick - arrows from a menuBar. - - - - Adding and accessing menus - The following commands may also be + prefixed. - - /+ access menuBar top level - - ./+ access current menu level - - ../+ - access parent menu (1 level up) - - ../../ - access parent menu (multiple levels up) - - */path/*menu - add/access menu - - */path/*menu/* - add/access menu and clear it if it exists - - */path/*{-} - add separator - - */path/*{item} - add item as a label - - */path/*{item} action - add/alter *menuitem* with an associated *action* - - */path/*{item}{right-text} - add/alter *menuitem* with right-text as the right-justified text and - as the associated *action* - - */path/*{item}{rtext} action - add/alter *menuitem* with an associated *action* and with rtext as - the right-justified text. - - Special characters in *action* must be backslash-escaped: - \a \b \E \e \n \r \t \octal - - or in control-character notation: - ^@, ^A .. ^Z .. ^_, ^? - - To send a string starting with a NUL (^@) character to the program, - start *action* with a pair of NUL characters (^@^@), the first of which - will be stripped off and the balance directed to the program. Otherwise - if *action* begins with NUL followed by non-+NUL characters, the leading - NUL is stripped off and the balance is sent back to rxvt. - - As a convenience for the many Emacs-type editors, *action* may start - with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if - missed from M-x commands. - - As a convenience for issuing XTerm ESC ] sequences from a menubar (or - quick arrow), a BEL (^G) will be appended if needed. - - For example, - M-xapropos is equivalent to \Exapropos\r - - and \E]703;mona;100 is equivalent to \E]703;mona;100\a - - The option {*right-rtext*} will be right-justified. In the absence of a - specified action, this text will be used as the *action* as well. - - For example, - /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F - - The left label *is* necessary, since it's used for matching, but - implicitly hiding the left label (by using same name for both left and - right labels), or explicitly hiding the left label (by preceeding it - with a dot), makes it possible to have right-justified text only. - - For example, - /File/{Open}{Open} Open-File-Action - - or hiding it - /File/{.anylabel}{Open} Open-File-Action - - - - Removing menus - -/*+ - remove all menus from the menuBar, the same as [clear] - - -+*/path*menu+ - remove menu - - -+*/path*{item}+ - remove item - - -+*/path*{-} - remove separator) - - -/path/menu/* - remove all items, separators and submenus from menu - - - - Quick Arrows - The menus also provide a hook for *quick arrows* to provide easier user - access. If nothing has been explicitly set, the default is to emulate - the curror keys. The syntax permits each arrow to be altered - individually or all four at once without re-entering their common - beginning/end text. For example, to explicitly associate cursor actions - with the arrows, any of the following forms could be used: - - +*Right* - +*Left* - +*Up* - +*Down* - Define actions for the respective arrow buttons - - +*Begin* - +*End* - Define common beginning/end parts for *quick arrows* which used in - conjunction with the above constructs - - For example, define arrows individually, - \E[A - - \E[B - - \E[C - - \E[D - - or all at once - \E[AZ<>\E[BZ<>\E[CZ<>\E[D - - or more compactly (factoring out common parts) - \E[AZ<>BZ<>CZ<>D - - - - Command Summary - A short summary of the most *common* commands: - - [menu:name] - use an existing named menuBar or start a new one - - [menu] - use the current menuBar - - [title:string] - set menuBar title - - [done] - set menu access to readonly and, if reading from a file, signal EOF - - [done:name] - if reading from a file using [read:file;name] signal EOF - - [rm:name] - remove named menuBar(s) - - [rm] [rm:] - remove current menuBar - - [rm*] [rm:*] - remove all menuBar(s) - - [swap] - swap top two menuBars - - [prev] - access the previous menuBar - - [next] - access the next menuBar - - [show] - map menuBar - - [hide] - unmap menuBar - - [pixmap;file] - [pixmap;file;scaling] - set a background pixmap - - [read:file] - [read:file;name] - read in a menu from a file - - [dump] - dump out all menuBars to /tmp/rxvt-PID - - / access menuBar top level - - ./ - ../ - ../../ - access current or parent menu level - - /path/menu - add/access menu - - /path/{-} - add separator - - /path/{item}{rtext} action - add/alter menu item - - -/* remove all menus from the menuBar - - -/path/menu - remove menu items, separators and submenus from menu - - -/path/menu - remove menu - - -/path/{item} - remove item - - -/path/{-} - remove separator - - BeginRightLeftUpDownEnd - menu quick arrows - XPM For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" can be the name of the background pixmap followed by a sequence of @@ -1925,11 +1632,6 @@ Add support for tinting of transparent backgrounds (requires "--enable-transparency"). - --enable-menubar (default: off) [DEPRECATED] - Add support for our menu bar system (this interacts badly with - dynamic locale switching currently). This option is DEPRECATED and - will be removed in the future. - --enable-rxvt-scroll (default: on) Add support for the original rxvt scrollbar. @@ -1944,10 +1646,6 @@ the favourite of the rxvt-unicode author, having used it for many years. - --enable-half-shadow (default: off) - Make shadows on the scrollbar only half the normal width & height. - only applicable to rxvt scrollbars. - --enable-ttygid (default: off) Change tty device setting to group "tty" - only use this if your system uses this type of security. @@ -1963,22 +1661,6 @@ --disable-resources Removes any support for resource checking. - --enable-xgetdefault - Make resources checking via XGetDefault() instead of our small - version which only checks ~/.Xdefaults, or if that doesn't exist - then ~/.Xresources. - - Please note that nowadays, things like XIM will automatically pull - in and use the full X resource manager, so the overhead of using it - might be very small, if nonexistant. - - --enable-strings (default: off) - Add support for our possibly faster memset() function and other - various routines, overriding your system's versions which may have - been hand-crafted in assembly or may require extra libraries to link - in. (this breaks ANSI-C rules and has problems on many GNU/Linux - systems). - --disable-swapscreen Remove support for secondary/swap screen.