--- rxvt-unicode/doc/rxvt.1.txt 2006/01/11 02:13:55 1.41 +++ rxvt-unicode/doc/rxvt.1.txt 2006/08/07 16:17:30 1.62 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended + rxvt-unicode, version 7.9, is a colour vt102 terminal emulator intended as an *xterm*(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- a significant @@ -26,39 +26,39 @@ scripts like mongolian or scripts requiring extremely complex combining rules, like tibetan or devenagari. Don't expect pretty output when using these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. - should work fine, though. A somewhat difficult case are left-to-right + should work fine, though. A somewhat difficult case are right-to-left scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional algorithms belong into the application, not the terminal emulator (too many things -- such as cursor-movement while editing -- break otherwise), but that might change. If you are looking for a terminal that supports more exotic scripts, let - me recommend "mlterm", which is a very userfriendly, lean and clean + me recommend "mlterm", which is a very user friendly, lean and clean terminal emulator. In fact, the reason rxvt-unicode was born was solely because the author couldn't get "mlterm" to use one font for latin1 and another for japanese. Therefore another design rationale was the use of multiple fonts to display characters: The idea of a single unicode font which many other - programs force onto it's users never made sense to me: You should be - able to choose any font for any script freely. + programs force onto its users never made sense to me: You should be able + to choose any font for any script freely. Apart from that, rxvt-unicode is also much better internationalised than - it's predecessor, supports things such as XFT and ISO 14755 that are - handy in i18n-environments, is faster, and has a lot less bugs than the + its predecessor, supports things such as XFT and ISO 14755 that are + handy in i18n-environments, is faster, and has a lot bugs less than the original rxvt. This all in addition to dozens of other small improvements. It is still faithfully following the original rxvt idea of being lean and nice on resources: for example, you can still configure rxvt-unicode - without most of it's features to get a lean binary. It also comes with a + without most of its features to get a lean binary. It also comes with a client/daemon pair that lets you open any number of terminal windows from within a single process, which makes startup time very fast and drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) (client). It also makes technical information about escape sequences (which have - been extended) easier accessible: see rxvt(7) for technical reference + been extended) more accessible: see rxvt(7) for technical reference documentation (escape sequences etc.). OPTIONS @@ -86,6 +86,10 @@ respected). In the absence of this option, the display specified by the DISPLAY environment variable is used. + -depth *bitdepth* + Compile *xft*: Attempt to find a visual with the given bit depth; + resource depth. + -geometry *geom* Window geometry (-g still respected); resource geometry. @@ -99,6 +103,10 @@ Turn on/off inheriting parent window's pixmap. Alternative form is -tr; resource inheritPixmap. + *Please note that transparency of any kind if completely unsupported + by the author. Don't bug him with installation questions! Read the + FAQ (man 7 rxvt)!* + -fade *number* Fade the text by the given percentage when focus is lost. Small values fade a little only, 100 completely replaces all colours by @@ -106,7 +114,7 @@ -fadecolor *colour* Fade to this colour when fading is used (see -fade). The default - colour is black. resource fadeColor. + colour is opaque black. resource fadeColor. -tint *colour* Tint the transparent background pixmap with the given colour when @@ -148,13 +156,13 @@ -fn *fontlist* Select the fonts to be used. This is a comma separated list of font - names that are used in turn when trying to display Unicode + names that are checked in order when trying to find glyphs for characters. The first font defines the cell size for characters; other fonts might be smaller, but not (in general) larger. A (hopefully) reasonable default font list is always appended to it. See resource font for more details. - In short, to specify an X11 core font, just specify it's name or + In short, to specify an X11 core font, just specify its name or prefix it with "x:". To specify an XFT-font, you need to prefix it with "xft:", e.g.: @@ -254,6 +262,10 @@ if honoured by the WM, the rxvt-unicode window will not have window decorations; resource borderLess. + -override-redirect + Compile *frills*: Sets override-redirect on the window; resource + override-redirect. + -sbg Compile *frills*: Disable the usage of the built-in block graphics/line drawing characters and just rely on what the specified @@ -348,7 +360,7 @@ Remap a key symbol. See resource keysym. -embed *windowid* - Tells rxvt to embed it's windows into an already-existing window, + Tells rxvt to embed its windows into an already-existing window, which enables applications to easily embed a terminal. Right now, rxvt will first unmap/map the specified window, so it @@ -361,7 +373,7 @@ It might be useful to know that rxvt 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 "-embed" option was + terminal. This works regardless of whether the "-embed" option was used or not. Here is a short Gtk2-perl snippet that illustrates how this option @@ -375,7 +387,7 @@ -pty-fd *file descriptor* Tells rxvt NOT to execute any commands or create a new pty/tty pair - but instead use the given filehandle as the tty master. This is + but instead use the given file descriptor as the tty master. This is useful if you want to drive rxvt as a generic terminal emulator without having to run a program within it. @@ -409,13 +421,10 @@ Note: `rxvt --help' gives a list of all resources (long options) compiled into your version. - There are two different methods that rxvt can use to get the Xresource - data: using the X libraries (Xrm*-functions) or internal Xresources - reader (~/.Xdefaults). For the first method (ie. rxvt -h lists - XGetDefaults), you can set and change the resources using X11 tools like - xrdb. Many distribution do also load settings from the ~/.Xresources - file when X starts. rxvt will consult the following files/resources in - order, with later settings overwriting earlier ones: + You can set and change the resources using X11 tools like xrdb. Many + distribution do also load settings from the ~/.Xresources file when X + starts. rxvt 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 @@ -423,18 +432,19 @@ 4. SCREEN_RESOURCES for the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- - If compiled with internal Xresources support (i.e. rxvt -h lists - .Xdefaults) then rxvt accepts application defaults set in - XAPPLOADDIR/URxvt (compile-time defined: usually - /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or - ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X - resources, rxvt recognizes two class names: XTerm and URxvt. The class - name Rxvt allows resources common to both rxvt and the original *rxvt* - to be easily configured, while the class name URxvt allows resources - unique to rxvt, notably colours and key-handling, to be shared between - different rxvt configurations. If no resources are specified, suitable - defaults will be used. Command-line arguments can be used to override - resource settings. The following resources are allowed: + Note that when reading X resources, rxvt recognizes two class names: + Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt + and the original *rxvt* to be easily configured, while the class name + URxvt allows resources unique to rxvt, to be shared between different + rxvt configurations. If no resources are specified, suitable defaults + will be used. Command-line arguments can be used to override resource + settings. The following resources are supported (you might want to check + the rxvtperl(3) manpage for additional settings by perl extensions not + documented here): + + depth: *bitdepth* + Compile *xft*: Attempt to find a visual with the given bit depth; + option -depth. geometry: *geom* Create the window with the specified X window geometry [default @@ -506,6 +516,9 @@ artificial transparency. False: do not inherit the parent windows' pixmap. + *Please note that transparency of any kind if completely unsupported + by the author. Don't bug him with installation questions!* + fading: *number* Fade the text by the given percentage when focus is lost; option -fade. @@ -544,23 +557,16 @@ will be magnified beyond 10 times its original size. The maximum permitted scale is 1000. [default 0x0+50+50] - menu: *file[;tag]* - Read in the specified menu file (note the `.menu' extension is - optional) and also optionally specify a starting tag to find. See - the reference documentation for details on the syntax for the - menuBar. - path: *path* - Specify the colon-delimited search path for finding files (XPM and - menus), in addition to the paths specified by the RXVTPATH and PATH - environment variables. + Specify the colon-delimited search path for finding XPM files. font: *fontlist* Select the fonts to be used. This is a comma separated list of font - names that are used in turn when trying to display Unicode + names that are checked in order when trying to find glyphs for characters. The first font defines the cell size for characters; - other fonts might be smaller, but not larger. A reasonable default - font list is always appended to it; option -fn. + other fonts might be smaller, but not (in general) larger. A + (hopefully) reasonable default font list is always appended to it; + option -fn. Each font can either be a standard X11 core font (XLFD) name, with optional prefix "x:" or a Xft font (Compile *xft*), prefixed with @@ -573,7 +579,7 @@ For example, this font resource - URxvt*font: 9x15bold,\ + URxvt.font: 9x15bold,\ -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ @@ -619,7 +625,7 @@ intensityStyles: *boolean* When font styles are not enabled, or this option is enabled (True, option -is, the default), bold and italic font styles imply high - intensity foreground/backround colours. Disabling this option + intensity foreground/background colours. Disabling this option (False, option +is) disables this behaviour, the high intensity colours are not reachable. @@ -669,10 +675,10 @@ Example: - URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) + URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) This creates a new file in your home directory with the screen - contents everytime you hit "Print". + contents every time you hit "Print". scrollBar: *boolean* True: enable the scrollbar [default]; option -sb. False: disable the @@ -697,7 +703,7 @@ scrollWithBuffer: *boolean* True: scroll with scrollback buffer when tty receives new lines (and scrollTtyOutput is False); option -sw. False: do not scroll with - scrollback buffer when tty recieves new lines; option +sw. + scrollback buffer when tty receives new lines; option +sw. scrollTtyKeypress: *boolean* True: scroll to bottom when a non-special key is pressed. Special @@ -780,8 +786,17 @@ associated with the Execute key. cutchars: *string* - The characters used as delimiters for double-click word selection. - The built-in default: + The characters used as delimiters for double-click word selection + (whitespace delimiting is added automatically if resource is given). + + When the selection extension is in use (the default if compiled in, + see the rxvtperl(3) manpage), a suitable regex using these + characters will be created (if the resource exists, otherwise, no + regex will be created). In this mode, characters outside ISO-8859-1 + can be used. + + When the selection extension is not used, only ISO-8859-1 characters + can be used. If not specified, the built-in default is used: BACKSLASH `"'&()*,;<=>?@[]{|} @@ -822,8 +837,7 @@ You can enable them by setting this boolean resource or specifying -insecure as an option. At the moment, this enables display-answer, - locale, findfont, icon label and window title requests as well as - dynamic menubar dispatch. + locale, findfont, icon label and window title requests. modifier: *modifier* Set the key to be interpreted as the Meta key to: alt, meta, hyper, @@ -834,16 +848,16 @@ (control-E) character is passed through. It may contain escape values as described in the entry on keysym following. - secondaryScreen: *bool* + secondaryScreen: *boolean* Turn on/off secondary screen (default enabled). - secondaryScroll: *bool* + secondaryScroll: *boolean* Turn on/off secondary screen scroll (default enabled). If the this option is enabled, scrolls on the secondary screen will change the scrollback buffer and switching to/from the secondary screen will instead scroll the screen up. - hold: *bool* + hold: *boolean* Turn on/off hold window after exit support. If enabled, rxvt will not immediately destroy its window when the program executed within it exits. Instead, it will wait till it is being killed or closed by @@ -876,13 +890,13 @@ "^@": null, "^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 "\" when using - "--enable-xgetdefault", as X itself does it's own de-escaping (you - can use "\033" instead of "\e" (and so on), which will work with - both Xt and rxvt's own processing). + Please note that you need to double the "\" in resource files, as + Xlib itself does its own de-escaping (you can use "\033" instead of + "\e" (and so on), which will work with both Xt and rxvt's own + processing). You can define a range of keysyms in one shot by providing a - *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter + *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/' should be a character not used by the strings. Its usage can be demonstrated by an example: @@ -954,7 +968,7 @@ Extension names can also be followed by an argument in angle brackets (e.g. "searchable-scrollback", which binds the hotkey - for searchable scorllback to Alt/Meta-s). Mentioning the same + for searchable scrollback to Alt/Meta-s). Mentioning the same extension multiple times with different arguments will pass multiple arguments to the extension. @@ -981,12 +995,30 @@ See the rxvtperl(3) manpage. + selection.pattern-*idx*: *perl-regex* + Additional selection patterns, see the rxvtperl(3) manpage for + details. + + selection-autotransform.*idx*: *perl-transform* + Selection auto-transform patterns, see the rxvtperl(3) manpage for + details. + + searchable-scrollback: *keysym* + Sets the hotkey that starts the incremental scrollback buffer search + (default: "M-s"). + urlLauncher: *string* Specifies the program to be started with a URL argument. Used by the "selection-popup" and "mark-urls" perl extensions. transient-for: *windowid* - Sets the WM_TRANSIENT_FOR property to the given window iw. + Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given + window id. + + override-redirect: *boolean* + Compile *frills*: Sets override-redirect for the terminal window, + making it almost invisible to window managers; option + -override-redirect. THE SCROLLBAR Lines of text that scroll off the top of the rxvt window (resource: @@ -1028,19 +1060,27 @@ removed from the selection. Insertion: - Pressing and releasing the Middle mouse button (or Shift-Insert) in - an rxvt window causes the current text selection to be inserted as - if it had been typed on the keyboard. + Pressing and releasing the Middle mouse button in an rxvt window + causes the value of the PRIMARY selection (or CLIPBOARD with the + Meta modifier) to be inserted as if it had been typed on the + keyboard. + + Pressing Shift-Insert causes the value of the PRIMARY selection to + be inserted too. CHANGING FONTS Changing fonts (or font sizes, respectively) via the keypad is not yet supported in rxvt-unicode. Bug me if you need this. - You can, however, switch fonts at runtime using escape sequences (and - therefore using the menubar), e.g.: + You can, however, switch fonts at runtime using escape sequences, e.g.: printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" + You can use keyboard shortcuts, too: + + URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 + URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 + rxvt-unicode will automatically re-apply these fonts to the output so far. @@ -1051,7 +1091,8 @@ the rest is available when rxvt-unicode was compiled with "--enable-iso14755". - * 5.1: Basic method + * 5.1: Basic method + This allows you to enter unicode characters using their hexcode. Start by pressing and holding both "Control" and "Shift", then enter @@ -1067,25 +1108,28 @@ easily by pressing "Control" and "Shift", followed by "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. - * 5.2: Keyboard symbols entry method + * 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. Start by pressing "Control" and "Shift" together, then releasing them. The next special key (cursor keys, home etc.) you enter will - not invoke it's usual function but instead will insert the + not invoke its usual function but instead will insert the corresponding keycap symbol. The symbol will only be entered when the key has been released, otherwise pressing e.g. "Shift" would enter the symbol for "ISO Level 2 Switch", although your intention might have been to enter a reverse tab (Shift-Tab). - * 5.3: Screen-selection entry method + * 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. - * 5.4: Feedback method for identifying displayed characters for later - input + * 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. @@ -1112,33 +1156,40 @@ COLORS AND GRAPHICS In addition to the default foreground and background colours, rxvt can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink - versions of the same). Here is a list of the colours with their rgb.txt - names. - - color0 (black) = Black - color1 (red) = Red3 - color2 (green) = Green3 - color3 (yellow) = Yellow3 - color4 (blue) = Blue3 - color5 (magenta) = Magenta3 - color6 (cyan) = Cyan3 - color7 (white) = AntiqueWhite - color8 (bright black) = Grey25 - color9 (bright red) = Red - color10 (bright green) = Green - color11 (bright yellow) = Yellow - color12 (bright blue) = Blue - color13 (bright magenta) = Magenta - color14 (bright cyan) = Cyan - color15 (bright white) = White - foreground = Black - background = White + versions of the same). Here is a list of the colours with their names. + color0 (black) = Black + color1 (red) = Red3 + color2 (green) = Green3 + color3 (yellow) = Yellow3 + color4 (blue) = Blue3 + color5 (magenta) = Magenta3 + color6 (cyan) = Cyan3 + color7 (white) = AntiqueWhite + color8 (bright black) = Grey25 + color9 (bright red) = Red + color10 (bright green) = Green + color11 (bright yellow) = Yellow + color12 (bright blue) = Blue + color13 (bright magenta) = Magenta + color14 (bright cyan) = Cyan + color15 (bright white) = White + foreground = Black + background = White It is also possible to specify the colour values of foreground, background, cursorColor, cursorColor2, colorBD, colorUL as a number 0-15, as a convenient shorthand to reference the colour name of color0-color15. + In addition to the colours defined above, rxvt offers an additional 72 + colours. The first 64 of those (with indices 16 to 79) consist of a + 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed + by 8 additional shades of gray (with indices 80 to 87). + + Together, all those colours implement the 88 colour xterm colours. Only + the first 16 can be changed using resources currently, the rest can only + be changed via command sequences ("escape codes"). + Note that -rv ("reverseVideo: True") simulates reverse video by always swapping the foreground/background colours. This is in contrast to *xterm*(1) where the colours are only swapped if they have not otherwise @@ -1148,15 +1199,37 @@ would yield White on Black, while on *xterm*(1) it would yield Black on White. + ALPHA CHANNEL SUPPORT + If Xft support has been compiled in and as long as Xft/Xrender/X don't + get their act together, rxvt-unicode will support + "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 + digits/component) colour specifications, in addition to the ones + provided by X, where the additional A component specifies opacity + (alpha) values. The minimum value of 0 is completely transparent). You + can also prefix any color with "[a]", where "a" is on to four hex digits + specifiying the opacity value. + + You probably need to specify "-depth 32", too, and have the luck that + your X-server uses ARGB pixel layout, as X is far from just supporting + ARGB visuals out of the box, and rxvt-unicode just fudges around. + + For example, the following selects an almost completely transparent red + background, and an almost opaque pink foreground: + + rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" + + *Please note that transparency of any kind if completely unsupported by + the author. Don't bug him with installation questions!* + ENVIRONMENT rxvt sets and/or uses the following environment variables: TERM Normally set to "rxvt-unicode", unless overwritten at configure - time, via resources or on the commandline. + time, via resources or on the command line. COLORTERM - Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled + Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled with XPM support, and optionally with the added extension "-mono" to indicate that rxvt-unicode runs on a monochrome screen. @@ -1180,18 +1253,11 @@ DISPLAY Used by rxvt to connect to the display and set to the correct - display in it's child processes. + display in its child processes. SHELL The shell to be used for command execution, defaults to "/bin/sh". - RXVTPATH - The path where rxvt looks for support files such as menu and xpm - files. - - PATH - Used in the same way as "RXVTPATH". - RXVT_SOCKET The unix domain socket path used by rxvtc(1) and rxvtd(1). @@ -1221,7 +1287,7 @@ Project Coordinator Marc A. Lehmann - + AUTHORS John Bovey @@ -1242,13 +1308,16 @@ Project Coordinator (changes.txt 2.21a to 2.4.5) Geoff Wing - Rewrote screen display and text selection routines. Project - Coordinator (changes.txt 2.4.6 - rxvt-unicode) + Rewrote screen display and text selection routines. + + Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) Marc Alexander Lehmann - Forked rxvt-unicode, rewrote most of the display code and internal - character handling to store text in unicode, improve xterm - compatibility and apply numerous other bugfixes and extensions. + Forked rxvt-unicode, unicode support, rewrote almost all the code, + perl extension, random hacks, numerous bugfixes and extensions. Project Coordinator (Changes 1.0 -) + Emanuele Giaquinta + Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. +