~ubuntu-branches/ubuntu/utopic/rxvt-unicode/utopic

« back to all changes in this revision

Viewing changes to doc/rxvt.1.man.in

  • Committer: Package Import Robot
  • Author(s): Ryan Kavanagh, Ryan Kavanagh, James M Leddy
  • Date: 2013-12-21 16:17:07 UTC
  • mfrom: (1.1.24)
  • Revision ID: package-import@ubuntu.com-20131221161707-898w5z8uls5mr4jw
Tags: 9.19-1
[ Ryan Kavanagh ]
* Imported Upstream version 9.19 (Closes: #731334)
* Drop the following patches, applied upstream:
  + 13_section_mismatch.diff
  + 14_pod_errors.diff
  + 15_perl_518.diff
* Update standards version to 3.9.5
* Offer both 16x16 and 32x32 icons in menu (Closes: #723889)
* Allow urxvt and urxvtd to update utmp (Closes: #500230)
  + Override lintian warning setgid-binary for /usr/bin/urxvt and
    /usr/bin/urxvtd

[ James M Leddy ]
* Added .desktop files so that we work with window managers like Gnome and
  Unity (Closes: #724623)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
 
1
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2
2
.\"
3
3
.\" Standard preamble:
4
4
.\" ========================================================================
38
38
.    ds PI \(*p
39
39
.    ds L" ``
40
40
.    ds R" ''
 
41
.    ds C`
 
42
.    ds C'
41
43
'br\}
42
44
.\"
43
45
.\" Escape single quotes in literal strings from groff's Unicode transform.
48
50
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49
51
.\" entries marked with X<> in POD.  Of course, you'll have to process the
50
52
.\" output yourself in some meaningful fashion.
51
 
.ie \nF \{\
52
 
.    de IX
53
 
.    tm Index:\\$1\t\\n%\t"\\$2"
54
 
..
55
 
.    nr % 0
56
 
.    rr F
57
 
.\}
58
 
.el \{\
59
 
.    de IX
60
 
..
61
 
.\}
 
53
.\"
 
54
.\" Avoid warning from groff about undefined register 'F'.
 
55
.de IX
 
56
..
 
57
.nr rF 0
 
58
.if \n(.g .if rF .nr rF 1
 
59
.if (\n(rF:(\n(.g==0)) \{
 
60
.    if \nF \{
 
61
.        de IX
 
62
.        tm Index:\\$1\t\\n%\t"\\$2"
 
63
..
 
64
.        if !\nF==2 \{
 
65
.            nr % 0
 
66
.            nr F 2
 
67
.        \}
 
68
.    \}
 
69
.\}
 
70
.rr rF
62
71
.\"
63
72
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64
73
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
124
133
.\" ========================================================================
125
134
.\"
126
135
.IX Title "@@RXVT_NAME@@ 1"
127
 
.TH @@RXVT_NAME@@ 1 "2013-03-24" "@@RXVT_VERSION@@" "RXVT-UNICODE"
 
136
.TH @@RXVT_NAME@@ 1 "2013-10-27" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128
137
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129
138
.\" way too many mistakes in technical documents.
130
139
.if n .ad l
143
152
a significant advantage on a machine serving many X sessions.
144
153
.PP
145
154
This document is also available on the World-Wide-Web at
146
 
http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
 
155
<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
147
156
.SH "FREQUENTLY ASKED QUESTIONS"
148
157
.IX Header "FREQUENTLY ASKED QUESTIONS"
149
158
See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
150
159
frequently asked questions and answer to them and some common
151
160
problems. That document is also accessible on the World-Wide-Web at
152
 
http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
 
161
<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
153
162
.SH "RXVT-UNICODE VS. RXVT"
154
163
.IX Header "RXVT-UNICODE VS. RXVT"
155
164
Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
177
186
to choose any font for any script freely.
178
187
.PP
179
188
Apart from that, rxvt-unicode is also much better internationalised than
180
 
its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy
 
189
its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO 14755\s0 that are handy
181
190
in i18n\-environments, is faster, and has a lot bugs less than the original
182
191
rxvt. This all in addition to dozens of other small improvements.
183
192
.PP
385
394
.IP "\fB\-bl\fR" 4
386
395
.IX Item "-bl"
387
396
Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
388
 
if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
 
397
if honoured by the \s-1WM,\s0 the rxvt-unicode window will not have window
389
398
decorations; resource \fBborderLess\fR. If the window manager does not
390
399
support \s-1MWM\s0 hints (e.g. kwin), enables override-redirect mode.
391
400
.IP "\fB\-override\-redirect\fR" 4
453
462
Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
454
463
.IP "\fB\-imlocale\fR \fIstring\fR" 4
455
464
.IX Item "-imlocale string"
456
 
The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
 
465
The locale to use for opening the \s-1IM.\s0 You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
457
466
\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
458
467
input extension to be able to input japanese characters while staying in
459
468
another locale. resource \fBimLocale\fR.
633
642
high-intensity (bold = bright foreground, blink = bright background)
634
643
colours. The canonical names are as follows: 0=black, 1=red, 2=green,
635
644
3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
636
 
names used are listed in the \fB\s-1COLOURS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
 
645
names used are listed in the \fB\s-1COLOURS AND GRAPHICS\s0\fR section.
637
646
.Sp
638
647
Colours higher than 15 cannot be set using resources (yet), but can be
639
648
changed using an escape command (see @@RXVT_NAME@@(7)).
678
687
.IX Item "reverseVideo: boolean"
679
688
\&\fBTrue\fR: simulate reverse video by foreground and background colours;
680
689
option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
681
 
\&\fB+rv\fR. See note in \fB\s-1COLOURS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
 
690
\&\fB+rv\fR. See note in \fB\s-1COLOURS AND GRAPHICS\s0\fR section.
682
691
.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
683
692
.IX Item "jumpScroll: boolean"
684
693
\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
757
766
useful supplement.
758
767
.Sp
759
768
The third font is an Xft font with aliasing turned off, and the characters
760
 
are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
 
769
are limited to the \fB\s-1JIS 0208\s0\fR codeset (i.e. japanese kanji). The font
761
770
contains other characters, but we are not interested in them.
762
771
.Sp
763
772
The last font is a useful catch-all font that supplies most of the
896
905
.IP "\fBborderLess:\fR \fIboolean\fR" 4
897
906
.IX Item "borderLess: boolean"
898
907
Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
899
 
\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
 
908
\&\s-1WM,\s0 the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
900
909
.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
901
910
.IX Item "skipBuiltinGlyphs: boolean"
902
911
Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
979
988
\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
980
989
.IP "\fBimLocale:\fR \fIname\fR" 4
981
990
.IX Item "imLocale: name"
982
 
The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
 
991
The locale to use for opening the \s-1IM.\s0 You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
983
992
\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
984
993
input extension to be able to input japanese characters while staying in
985
994
another locale; option \fB\-imlocale\fR.
1016
1025
\&\fB\-mod\fR.
1017
1026
.IP "\fBanswerbackString:\fR \fIstring\fR" 4
1018
1027
.IX Item "answerbackString: string"
1019
 
Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control-E)
 
1028
Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ \s0(control-E)
1020
1029
character is passed through. It may contain escape values as described
1021
1030
in the entry on \fBkeysym\fR following.
1022
1031
.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
1204
1213
it almost invisible to window managers; option \fB\-override\-redirect\fR.
1205
1214
.IP "\fBiso14755:\fR \fIboolean\fR" 4
1206
1215
.IX Item "iso14755: boolean"
1207
 
Turn on/off \s-1ISO\s0 14755 (default enabled).
 
1216
Turn on/off \s-1ISO 14755 \s0(default enabled).
1208
1217
.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1209
1218
.IX Item "iso14755_52: boolean"
1210
 
Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
 
1219
Turn on/off \s-1ISO 14755 5.2\s0 mode (default enabled).
1211
1220
.SH "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1212
1221
.IX Header "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1213
1222
.IP "\fB\-pixmap\fR \fIfile[;oplist]\fR" 4
1380
1389
rxvt-unicode will automatically re-apply these fonts to the output so far.
1381
1390
.SH "ISO 14755 SUPPORT"
1382
1391
.IX Header "ISO 14755 SUPPORT"
1383
 
\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
 
1392
\&\s-1ISO 14755\s0 is a standard for entering and viewing unicode characters
1384
1393
and character codes using the keyboard. It consists of 4 parts. The
1385
1394
first part is available if rxvt-unicode has been compiled with
1386
1395
\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1437
1446
always be drawn using the built-in support font.
1438
1447
.PP
1439
1448
With respect to conformance, rxvt-unicode is supposed to be compliant to
1440
 
both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
 
1449
both scenario A and B of \s-1ISO 14755,\s0 including part 5.2.
1441
1450
.SH "LOGIN STAMP"
1442
1451
.IX Header "LOGIN STAMP"
1443
1452
\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1512
1521
.PP
1513
1522
would yield White on Black, while on \fIxterm\fR(1) it would yield Black on
1514
1523
White.
1515
 
.SS "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
 
1524
.SS "\s-1ALPHA CHANNEL SUPPORT\s0"
1516
1525
.IX Subsection "ALPHA CHANNEL SUPPORT"
1517
1526
If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1518
1527
their act together, rxvt-unicode will do its own alpha channel management:
1554
1563
background image shows instead), regardless of how it was specified, while
1555
1564
other colours will either be transparent as specified (the background
1556
1565
image will show through) on servers supporting the \s-1RENDER\s0 extension, or
1557
 
fully opaque on servers not supporting the \s-1RENDER\s0 \s-1EXTENSION\s0.
 
1566
fully opaque on servers not supporting the \s-1RENDER EXTENSION.\s0
1558
1567
.PP
1559
1568
Please note that due to bugs in Xft, specifying alpha values might result
1560
1569
in garbage being displayed when the X\-server does not support the \s-1RENDER\s0
1637
1646
.IX Header "CURRENT PROJECT COORDINATOR"
1638
1647
.IP "Project Coordinator" 4
1639
1648
.IX Item "Project Coordinator"
1640
 
Marc A. Lehmann <rxvt\-unicode@schmorp.de>
 
1649
Marc A. Lehmann <rxvt\-unicode@schmorp.de>.
1641
1650
.Sp
1642
 
http://software.schmorp.de/pkg/rxvt\-unicode.html <http://software.schmorp.de/pkg/rxvt-unicode.html>
 
1651
<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1643
1652
.SH "AUTHORS"
1644
1653
.IX Header "AUTHORS"
1645
1654
.IP "John Bovey" 4
1670
1679
extension, random hacks, numerous bugfixes and extensions.
1671
1680
.Sp
1672
1681
Project Coordinator (Changes 1.0 \-)
1673
 
.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1674
 
.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
 
1682
.IP "Emanuele Giaquinta <emanuele.giaquinta@gmail.com>" 4
 
1683
.IX Item "Emanuele Giaquinta <emanuele.giaquinta@gmail.com>"
1675
1684
pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1676
 
.SH "POD ERRORS"
1677
 
.IX Header "POD ERRORS"
1678
 
Hey! \fBThe above document had some coding errors, which are explained below:\fR
1679
 
.IP "Around line 1210:" 4
1680
 
.IX Item "Around line 1210:"
1681
 
You forgot a '=back' before '=head1'
1682
 
.IP "Around line 1212:" 4
1683
 
.IX Item "Around line 1212:"
1684
 
\&'=item' outside of any '=over'