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.57 by root, Mon Feb 14 18:50:57 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
371=item B<-xrm> I<resourcestring> 373=item B<-keysym.>I<sym>: I<string>
372 374
373No effect on rxvt-unicode. Simply passes through an argument to be made 375Remap a key symbol. See resource B<keysym>.
374available in the instance's argument list. Appears in I<WM_COMMAND> in 376
375some window managers. 377=item B<-embed>: I<windowid>
378
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal.
381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
388
389It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or
393not.
376 394
377=back 395=back
378 396
379=head1 RESOURCES (available also as long-options) 397=head1 RESOURCES (available also as long-options)
380 398
383 401
384There are two different methods that @@RXVT_NAME@@ can use to get the 402There are two different methods that @@RXVT_NAME@@ can use to get the
385Xresource data: using the X libraries (Xrm*-functions) or internal 403Xresource data: using the X libraries (Xrm*-functions) or internal
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 404Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 405B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
388resources using X11 tools like B<xset>. Many distribution do also load 406resources using X11 tools like B<xrdb>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts. 407settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
408will consult the following files/resources in order, with later settings
409overwriting earlier ones:
410
411 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390 416
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 417If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 418lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 419set in XAPPLOADDIR/URxvt (compile-time defined: usually
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 420B</usr/lib/X11/app-defaults/URxvt>) and resources set in
931the normal text selection/insertion, hold either the Shift or the Meta 957the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 958(Alt) key while performing the desired mouse action.
933 959
934If mouse reporting mode is active, the normal scrollbar actions are 960If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 961disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 962application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 963(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), 964up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 965respectively.
940 966
941=head1 TEXT SELECTION AND INSERTION 967=head1 TEXT SELECTION AND INSERTION
942 968
943The behaviour of text selection and insertion mechanism is similar to 969The behaviour of text selection and insertion mechanism is similar to
1098 1124
1099=back 1125=back
1100 1126
1101=head1 ENVIRONMENT 1127=head1 ENVIRONMENT
1102 1128
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1129B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1130
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1131=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1132
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1133=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1134
1135Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1136resources or on the commandline.
1137
1138=item B<COLORTERM>
1139
1140Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1141compiled with XPM support, and optionally with the added extension
1142C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1143
1144=item B<COLORFGBG>
1145
1146Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1147the colour code used as default foreground/text colour (or the string
1148C<default> to indicate that the default-colour escape sequence is to be
1149used), C<bg> is the colour code used as default background colour (or the
1150string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1151was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1152(and do) use this information to optimize screen output.
1153
1154=item B<WINDOWID>
1155
1156Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1157window, which usually has subwindows for the scrollbar, the terminal
1158window and so on).
1159
1160=item B<TERMINFO>
1161
1162Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1163C<--with-terminfo=PATH>.
1164
1165=item B<DISPLAY>
1166
1167Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1168display in it's child processes.
1169
1170=item B<SHELL>
1171
1172The shell to be used for command execution, defaults to C</bin/sh>.
1173
1174=item B<RXVTPATH>
1175
1176The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1177files.
1178
1179=item B<PATH>
1180
1181Used in the same way as C<RXVTPATH>.
1182
1183=item B<RXVT_SOCKET>
1184
1185The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186@@RXVT_NAME@@d(1).
1187
1188Default C<< $HOME/.rxvt-unicode-<nodename >>.
1189
1190=item B<HOME>
1191
1192Used to locate the default directory for the unix domain socket for
1193daemon communications and to locate various resource files (such as
1194C<.Xdefaults>)
1195
1196=item B<XAPPLRESDIR>
1197
1198Directory where various X resource files are being located.
1199
1200=item B<XENVIRONMENT>
1201
1202If set and accessible, gives the name of a X resource file to be loaded by
1203@@RXVT_NAME@@.
1204
1205=back
1109 1206
1110=head1 FILES 1207=head1 FILES
1111 1208
1112=over 4 1209=over 4
1113 1210
1133 1230
1134=over 4 1231=over 4
1135 1232
1136=item Project Coordinator 1233=item Project Coordinator
1137 1234
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1235Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139 1236
1140=item Web page maintainter 1237L<http://software.schmorp.de/#rxvt-unicode>
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144L<@@RXVT_WEBPAGE@@>
1145 1238
1146=back 1239=back
1147 1240
1148=head1 AUTHORS 1241=head1 AUTHORS
1149 1242
1174=item Geoff Wing L<< <gcw@pobox.com> >> 1267=item Geoff Wing L<< <gcw@pobox.com> >>
1175 1268
1176Rewrote screen display and text selection routines. Project Coordinator 1269Rewrote screen display and text selection routines. Project Coordinator
1177(changes.txt 2.4.6 - rxvt-unicode) 1270(changes.txt 2.4.6 - rxvt-unicode)
1178 1271
1179=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1272=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180 1273
1181Forked rxvt-unicode, rewrote most of the display code and internal 1274Forked rxvt-unicode, rewrote most of the display code and internal
1182character handling to store text in unicode, improve xterm 1275character handling to store text in unicode, improve xterm
1183compatibility and apply numerous other bugfixes and extensions. 1276compatibility and apply numerous other bugfixes and extensions.
1184 1277

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines