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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines