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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.49 by root, Fri Jan 20 16:02:20 2006 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 2006 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.1, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.4, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!*
101 108
102 -fade *number* 109 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 110 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 111 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 112 the fade colour; resource fading.
106 113
107 -fadecolor *colour* 114 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 115 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 116 colour is opaque black. resource fadeColor.
110 117
111 -tint *colour* 118 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 119 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 121 non-tiled backgrounds, currently. See also the -sh option that can
432 will be used. Command-line arguments can be used to override resource 439 will be used. Command-line arguments can be used to override resource
433 settings. The following resources are supported (you might want to check 440 settings. The following resources are supported (you might want to check
434 the rxvtperl(3) manpage for additional settings by perl extensions not 441 the rxvtperl(3) manpage for additional settings by perl extensions not
435 documented here): 442 documented here):
436 443
444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth.
447
437 geometry: *geom* 448 geometry: *geom*
438 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
439 80x24]; option -geometry. 450 80x24]; option -geometry.
440 451
441 background: *colour* 452 background: *colour*
501 512
502 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
503 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
504 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
505 pixmap. 516 pixmap.
517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
506 520
507 fading: *number* 521 fading: *number*
508 Fade the text by the given percentage when focus is lost; option 522 Fade the text by the given percentage when focus is lost; option
509 -fade. 523 -fade.
510 524
769 The string to send when the delete key (not the keypad delete key) 783 The string to send when the delete key (not the keypad delete key)
770 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
771 associated with the Execute key. 785 associated with the Execute key.
772 786
773 cutchars: *string* 787 cutchars: *string*
774 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
775 The built-in default: 789 (whitespace delimiting is added automatically if resource is given).
790
791 When the selection extension is in use (the default if compiled in,
792 see the rxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used.
796
797 When the selection extension is not used, only ISO-8859-1 characters
798 can be used. If not specified, the built-in default is used:
776 799
777 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
778 801
779 preeditType: *style* 802 preeditType: *style*
780 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
1034 normal one. In this mode, every selected row becomes its own line in 1057 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and 1058 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection. 1059 removed from the selection.
1037 1060
1038 Insertion: 1061 Insertion:
1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
1040 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
1041 if it had been typed on the keyboard. 1064 Meta modifier) to be inserted as if it had been typed on the
1065 keyboard.
1066
1067 Pressing Shift-Insert causes the value of the PRIMARY selection to
1068 be inserted too.
1042 1069
1043CHANGING FONTS 1070CHANGING FONTS
1044 Changing fonts (or font sizes, respectively) via the keypad is not yet 1071 Changing fonts (or font sizes, respectively) via the keypad is not yet
1045 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
1046 1073
1122 setgid to root or to some other group on others. 1149 setgid to root or to some other group on others.
1123 1150
1124COLORS AND GRAPHICS 1151COLORS AND GRAPHICS
1125 In addition to the default foreground and background colours, rxvt can 1152 In addition to the default foreground and background colours, rxvt can
1126 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1153 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1127 versions of the same). Here is a list of the colours with their rgb.txt 1154 versions of the same). Here is a list of the colours with their names.
1128 names.
1129 1155
1130 color0 (black) = Black 1156 color0 (black) = Black
1131 color1 (red) = Red3 1157 color1 (red) = Red3
1132 color2 (green) = Green3 1158 color2 (green) = Green3
1133 color3 (yellow) = Yellow3 1159 color3 (yellow) = Yellow3
1149 It is also possible to specify the colour values of foreground, 1175 It is also possible to specify the colour values of foreground,
1150 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1176 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1151 0-15, as a convenient shorthand to reference the colour name of 1177 0-15, as a convenient shorthand to reference the colour name of
1152 color0-color15. 1178 color0-color15.
1153 1179
1180 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1181 get their act together, rxvt-unicode will support
1182 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1183 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1184 specifications, in addition to the ones provided by X, where the
1185 additional A component specifies alpha (opacity) values (0 is completely
1186 transparent and the maximum is opaque). You probably need to specify
1187 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1188 layout, as X is far from just supporting ARGB visuals out of the box,
1189 and rxvt-unicode just fudges around.
1190
1191 *Please note that transparency of any kind if completely unsupported by
1192 the author. Don't bug him with installation questions!*
1193
1154 Note that -rv ("reverseVideo: True") simulates reverse video by always 1194 Note that -rv ("reverseVideo: True") simulates reverse video by always
1155 swapping the foreground/background colours. This is in contrast to 1195 swapping the foreground/background colours. This is in contrast to
1156 *xterm*(1) where the colours are only swapped if they have not otherwise 1196 *xterm*(1) where the colours are only swapped if they have not otherwise
1157 been specified. For example, 1197 been specified. For example,
1158 1198

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines