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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.54 by root, Fri Feb 11 18:55:39 2005 UTC

… …
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
… …
366=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
367 369
368Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
369B<secondaryScroll>. 371B<secondaryScroll>.
370 372
373=item B<-keysym.>I<sym>: I<string>
374
375Remap a key symbol. See resource B<keysym>.
376
371=item B<-xrm> I<resourcestring> 377=item B<-xrm> I<resourcestring>
372 378
373No effect on rxvt-unicode. Simply passes through an argument to be made 379No effect on rxvt-unicode. Simply passes through an argument to be made
374available in the instance's argument list. Appears in I<WM_COMMAND> in 380available in the instance's argument list. Appears in I<WM_COMMAND> in
375some window managers. 381some window managers.
… …
383 389
384There are two different methods that @@RXVT_NAME@@ can use to get the 390There are two different methods that @@RXVT_NAME@@ can use to get the
385Xresource data: using the X libraries (Xrm*-functions) or internal 391Xresource data: using the X libraries (Xrm*-functions) or internal
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 392Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 393B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
388resources using X11 tools like B<xset>. Many distribution do also load 394resources using X11 tools like B<xrdb>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts. 395settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396will consult the following files/resources in order, with later settings
397overwriting earlier ones:
398
399 1. system-wide app-defaults file, either locale-dependent OR global
400 2. app-defaults file in $XAPPLRESDIR
401 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402 4. SCREEN_RESOURCES for the current screen
403 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390 404
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 405If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 406lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 407set in XAPPLOADDIR/URxvt (compile-time defined: usually
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 408B</usr/lib/X11/app-defaults/URxvt>) and resources set in
… …
931the normal text selection/insertion, hold either the Shift or the Meta 945the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 946(Alt) key while performing the desired mouse action.
933 947
934If mouse reporting mode is active, the normal scrollbar actions are 948If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 949disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 950application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 951(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 952up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 953respectively.
940 954
941=head1 TEXT SELECTION AND INSERTION 955=head1 TEXT SELECTION AND INSERTION
942 956
943The behaviour of text selection and insertion mechanism is similar to 957The behaviour of text selection and insertion mechanism is similar to
… …
1098 1112
1099=back 1113=back
1100 1114
1101=head1 ENVIRONMENT 1115=head1 ENVIRONMENT
1102 1116
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1117B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1118
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1119=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1120
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1121=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1122
1123Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124resources or on the commandline.
1125
1126=item B<COLORTERM>
1127
1128Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1129compiled with XPM support, and optionally with the added extension
1130C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1131
1132=item B<COLORFGBG>
1133
1134Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135the colour code used as default foreground/text colour (or the string
1136C<default> to indicate that the default-colour escape sequence is to be
1137used), C<bg> is the colour code used as default background colour (or the
1138string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1140(and do) use this information to optimize screen output.
1141
1142=item B<WINDOWID>
1143
1144Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145window, which usually has subwindows for the scrollbar, the terminal
1146window and so on).
1147
1148=item B<TERMINFO>
1149
1150Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1151C<--with-terminfo=PATH>.
1152
1153=item B<DISPLAY>
1154
1155Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1156display in it's child processes.
1157
1158=item B<SHELL>
1159
1160The shell to be used for command execution, defaults to C</bin/sh>.
1161
1162=item B<RXVTPATH>
1163
1164The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165files.
1166
1167=item B<PATH>
1168
1169Used in the same way as C<RXVTPATH>.
1170
1171=item B<RXVT_SOCKET>
1172
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1).
1175
1176Default C<< $HOME/.rxvt-unicode-<nodename >>.
1177
1178=item B<HOME>
1179
1180Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as
1182C<.Xdefaults>)
1183
1184=item B<XAPPLRESDIR>
1185
1186Directory where various X resource files are being located.
1187
1188=item B<XENVIRONMENT>
1189
1190If set and accessible, gives the name of a X resource file to be loaded by
1191@@RXVT_NAME@@.
1192
1193=back
1109 1194
1110=head1 FILES 1195=head1 FILES
1111 1196
1112=over 4 1197=over 4
1113 1198
… …
1134=over 4 1219=over 4
1135 1220
1136=item Project Coordinator 1221=item Project Coordinator
1137 1222
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1139
1140=item Web page maintainter
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143 1224
1144L<@@RXVT_WEBPAGE@@> 1225L<@@RXVT_WEBPAGE@@>
1145 1226
1146=back 1227=back
1147 1228

Diff Legend

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