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

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.7 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.12 by root, Fri Feb 11 18:14:07 2005 UTC

… …
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" "" 39. ds L" ""
40. ds R" "" 40. ds R" ""
41. ds C` 41. ds C` ""
42. ds C' 42. ds C' ""
43'br\} 43'br\}
44.el\{\ 44.el\{\
45. ds -- \|\(em\| 45. ds -- \|\(em\|
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-02-03" "4.9" "RXVT-UNICODE" 132.TH rxvt 1 "2005-02-11" "5.0" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
142require features such as Tektronix 4014 emulation and toolkit-style 142require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 144a significant advantage on a machine serving many X sessions.
145.SH "FREQUENTLY ASKED QUESTIONS" 145.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 146.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently 147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148asked questions and answer to them and some common problems. 148frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
149.SH "RXVT-UNICODE VS. RXVT" 151.SH "RXVT-UNICODE VS. RXVT"
150.IX Header "RXVT-UNICODE VS. RXVT" 152.IX Header "RXVT-UNICODE VS. RXVT"
151Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
152internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
153world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
… …
439\&\fBsecondaryScreen\fR. 441\&\fBsecondaryScreen\fR.
440.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
441.IX Item "-ssr|+ssr" 443.IX Item "-ssr|+ssr"
442Turn on/off secondary screen scroll (default enabled); resource 444Turn on/off secondary screen scroll (default enabled); resource
443\&\fBsecondaryScroll\fR. 445\&\fBsecondaryScroll\fR.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4
447.IX Item "-keysym.sym: string"
448Remap a key symbol. See resource \fBkeysym\fR.
444.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 449.IP "\fB\-xrm\fR \fIresourcestring\fR" 4
445.IX Item "-xrm resourcestring" 450.IX Item "-xrm resourcestring"
446No effect on rxvt\-unicode. Simply passes through an argument to be made 451No effect on rxvt\-unicode. Simply passes through an argument to be made
447available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 452available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in
448some window managers. 453some window managers.
… …
453.PP 458.PP
454There are two different methods that @@RXVT_NAME@@ can use to get the 459There are two different methods that @@RXVT_NAME@@ can use to get the
455Xresource data: using the X libraries (Xrm*\-functions) or internal 460Xresource data: using the X libraries (Xrm*\-functions) or internal
456Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 461Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
457\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 462\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the
458resources using X11 tools like \fBxset\fR. Many distribution do also load 463resources using X11 tools like \fBxrdb\fR. Many distribution do also load
459settings from the \fB~/.Xresources\fR file when X starts. 464settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
465will consult the following files/resources in order, with later settings
466overwriting earlier ones:
467.PP
468.Vb 5
469\& 1. system-wide app-defaults file, either locale-dependent OR global
470\& 2. app-defaults file in $XAPPLRESDIR
471\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
472\& 4. SCREEN_RESOURCES for the current screen
473\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
474.Ve
460.PP 475.PP
461If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 476If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
462lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 477lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
463set in XAPPLOADDIR/URxvt (compile\-time defined: usually 478set in XAPPLOADDIR/URxvt (compile\-time defined: usually
464\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 479\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
… …
876\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, 891\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
877\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, 892\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
878\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it 893\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
879can start or end with whitespace. 894can start or end with whitespace.
880.Sp 895.Sp
896Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
897\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
898use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
899@@RXVT_NAME@@'s own processing).
900.Sp
881You can define a range of keysyms in one shot by providing a \fIstring\fR 901You can define a range of keysyms in one shot by providing a \fIstring\fR
882with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 902with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
883should be a character not used by the strings. 903should be a character not used by the strings.
884.Sp 904.Sp
885Its usage can be demonstrated by an example: 905Its usage can be demonstrated by an example:
886.Sp 906.Sp
887.Vb 1 907.Vb 1
888\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 908\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
889.Ve 909.Ve
890.Sp 910.Sp
891The above line is equivalent to the following three lines: 911The above line is equivalent to the following three lines:
892.Sp 912.Sp
893.Vb 3 913.Vb 3
894\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 914\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
895\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 915\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
896\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 916\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
897.Ve 917.Ve
898.Sp 918.Sp
899If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 919If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
900is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 920is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
901example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 921example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
902when Control-Meta-c is being pressed": 922when Control-Meta-c is being pressed":
903.Sp 923.Sp
904.Vb 1 924.Vb 1
905\& URxvt.keysym.M-C-c: proto:\e033]701;zh_CN.GBK\e007 925\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
906.Ve 926.Ve
907.Sp 927.Sp
908The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 928The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
909the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you cna have some limited 929the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
910font-switching at runtime: 930font-switching at runtime:
911.Sp 931.Sp
912.Vb 2 932.Vb 2
913\& URxvt.keysym.M-C-1: proto:\e033]50;suxuseuro\e007 933\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
914\& URxvt.keysym.M-C-2: proto:\e033]50;9x15bold\e007 934\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
915.Ve 935.Ve
916.Sp 936.Sp
917\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to 937Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
918\&\f(CW\*(C`zh_CN.GBK\*(C'\fR. 938info):
939.Sp
940.Vb 2
941\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
942\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
943.Ve
919.SH "THE SCROLLBAR" 944.SH "THE SCROLLBAR"
920.IX Header "THE SCROLLBAR" 945.IX Header "THE SCROLLBAR"
921Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 946Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
922(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 947(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
923or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 948or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
933the normal text selection/insertion, hold either the Shift or the Meta 958the normal text selection/insertion, hold either the Shift or the Meta
934(Alt) key while performing the desired mouse action. 959(Alt) key while performing the desired mouse action.
935.PP 960.PP
936If mouse reporting mode is active, the normal scrollbar actions are 961If mouse reporting mode is active, the normal scrollbar actions are
937disabled \*(-- on the assumption that we are using a fullscreen 962disabled \*(-- on the assumption that we are using a fullscreen
938application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 963application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
939(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 964(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
940up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), 965up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
941respectively. 966respectively.
942.SH "TEXT SELECTION AND INSERTION" 967.SH "TEXT SELECTION AND INSERTION"
943.IX Header "TEXT SELECTION AND INSERTION" 968.IX Header "TEXT SELECTION AND INSERTION"
944The behaviour of text selection and insertion mechanism is similar to 969The behaviour of text selection and insertion mechanism is similar to
945\&\fIxterm\fR(1). 970\&\fIxterm\fR(1).
… …
1076.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1101.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1077would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1102would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1078on White. 1103on White.
1079.SH "ENVIRONMENT" 1104.SH "ENVIRONMENT"
1080.IX Header "ENVIRONMENT" 1105.IX Header "ENVIRONMENT"
1081\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1106\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1082and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X 1107.IP "\fB\s-1TERM\s0\fR" 4
1083window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1108.IX Item "TERM"
1084sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1109Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1085terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1110resources or on the commandline.
1086\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1111.IP "\fB\s-1COLORTERM\s0\fR" 4
1112.IX Item "COLORTERM"
1113Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1114compiled with \s-1XPM\s0 support, and optionally with the added extension
1115\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1116.IP "\fB\s-1COLORFGBG\s0\fR" 4
1117.IX Item "COLORFGBG"
1118Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1119the colour code used as default foreground/text colour (or the string
1120\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1121used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1122string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1123was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`slang\*(C'\fR can (and do) use
1124this information to optimize screen output.
1125.IP "\fB\s-1WINDOWID\s0\fR" 4
1126.IX Item "WINDOWID"
1127Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1128window, which usually has subwindows for the scrollbar, the terminal
1129window and so on).
1130.IP "\fB\s-1TERMINFO\s0\fR" 4
1131.IX Item "TERMINFO"
1132Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1133\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1134.IP "\fB\s-1DISPLAY\s0\fR" 4
1135.IX Item "DISPLAY"
1136Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1137display in it's child processes.
1138.IP "\fB\s-1SHELL\s0\fR" 4
1139.IX Item "SHELL"
1140The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1141.IP "\fB\s-1RXVTPATH\s0\fR" 4
1142.IX Item "RXVTPATH"
1143The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1144files.
1145.IP "\fB\s-1PATH\s0\fR" 4
1146.IX Item "PATH"
1147Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1148.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1149.IX Item "RXVT_SOCKET"
1150The unix domain socket path used by @@RXVT_NAME@@c(1) and
1151@@RXVT_NAME@@d(1).
1152.Sp
1153Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR.
1154.IP "\fB\s-1HOME\s0\fR" 4
1155.IX Item "HOME"
1156Used to locate the default directory for the unix domain socket for
1157daemon communications and to locate various resource files (such as
1158\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1159.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1160.IX Item "XAPPLRESDIR"
1161Directory where various X resource files are being located.
1162.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1163.IX Item "XENVIRONMENT"
1164If set and accessible, gives the name of a X resource file to be loaded by
1165@@RXVT_NAME@@.
1087.SH "FILES" 1166.SH "FILES"
1088.IX Header "FILES" 1167.IX Header "FILES"
1089.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1168.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1090.IX Item "/usr/lib/X11/rgb.txt" 1169.IX Item "/usr/lib/X11/rgb.txt"
1091Color names. 1170Color names.
… …
1102.SH "CURRENT PROJECT COORDINATOR" 1181.SH "CURRENT PROJECT COORDINATOR"
1103.IX Header "CURRENT PROJECT COORDINATOR" 1182.IX Header "CURRENT PROJECT COORDINATOR"
1104.IP "Project Coordinator" 4 1183.IP "Project Coordinator" 4
1105.IX Item "Project Coordinator" 1184.IX Item "Project Coordinator"
1106@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1185@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@
1107.IP "Web page maintainter" 4
1108.IX Item "Web page maintainter"
1109@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
1110.Sp 1186.Sp
1111@@RXVT_WEBPAGE@@ 1187@@RXVT_WEBPAGE@@
1112.SH "AUTHORS" 1188.SH "AUTHORS"
1113.IX Header "AUTHORS" 1189.IX Header "AUTHORS"
1114.IP "John Bovey" 4 1190.IP "John Bovey" 4

Diff Legend

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