~ubuntu-branches/ubuntu/jaunty/rxvt-unicode/jaunty-proposed

« back to all changes in this revision

Viewing changes to README.configure

  • Committer: Bazaar Package Importer
  • Author(s): Decklin Foster
  • Date: 2006-09-01 14:44:58 UTC
  • mfrom: (1.2.1 upstream) (9 edgy)
  • mto: (3.2.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 10.
  • Revision ID: james.westby@ubuntu.com-20060901144458-3jn5sjka9gpg0v9i
* Edit the comments in the app-defaults file, and disable all settings by
  default. If font autoselection fails, I would prefer to open a new bug
  specifically for that. (Closes: #385481)
* Reorganize and edit README.Debian, pushing as much as possible into FAQ
  format (with resource setting issues first).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
CONFIGURE OPTIONS
2
2
    General hint: if you get compile errors, then likely your configuration
3
 
    hasn't been tested well. Either try with --enable-everything or use the
4
 
    ./reconf script as a base for experiments. ./reconf is used by myself,
5
 
    so it should generally be a working config. Of course, you should always
6
 
    report when a combination doesn't work, so it can be fixed. Marc Lehmann
7
 
    <rxvt@schmorp.de>.
 
3
    hasn't been tested well. Either try with "--enable-everything" or use
 
4
    the ./reconf script as a base for experiments. ./reconf is used by
 
5
    myself, so it should generally be a working config. Of course, you
 
6
    should always report when a combination doesn't work, so it can be
 
7
    fixed. Marc Lehmann <rxvt@schmorp.de>.
 
8
 
 
9
    All
8
10
 
9
11
    --enable-everything
10
 
        Add support for all non-multichoice options listed in "./configure
11
 
        --help". Note that unlike other enable options this is order
12
 
        dependant. You can specify this and then disable options which this
13
 
        enables by *following* this with the appropriate commands.
14
 
 
15
 
    --enable-xft
 
12
        Add (or remove) support for all non-multichoice options listed in
 
13
        "./configure --help".
 
14
 
 
15
        You can specify this and then disable options you do not like by
 
16
        *following* this with the appropriate "--disable-..." arguments, or
 
17
        you can start with a minimal configuration by specifying
 
18
        "--disable-everything" and than adding just the "--enable-..."
 
19
        arguments you want.
 
20
 
 
21
    --enable-xft (default: enabled)
16
22
        Add support for Xft (anti-aliases, among others) fonts. Xft fonts
17
23
        are slower and require lots of memory, but as long as you don't use
18
24
        them, you don't pay for them.
19
25
 
20
 
    --enable-font-styles
 
26
    --enable-font-styles (default: on)
21
27
        Add support for bold, *italic* and *bold italic* font styles. The
22
28
        fonts can be set manually or automatically.
23
29
 
24
 
    --with-codesets=NAME,...
25
 
        Compile in support for additional codeset (encoding) groups (eu, vn
26
 
        are always compiled in, which includes most 8-bit character sets).
27
 
        These codeset tables are currently only used for driving X11 core
28
 
        fonts, they are not required for Xft fonts. Compiling them in will
29
 
        make your binary bigger (together about 700kB), but it doesn't
30
 
        increase memory usage unless you use an X11 font requiring one of
31
 
        these encodings.
32
 
 
33
 
           all             all available codeset groups 
34
 
           zh              common chinese encodings 
35
 
           zh_ext          rarely used but very big chinese encodigs 
36
 
           jp              common japanese encodings 
37
 
           jp_ext          rarely used but big japanese encodings 
38
 
           kr              korean encodings 
39
 
 
40
 
    --enable-xim
 
30
    --with-codesets=NAME,... (default: all)
 
31
        Compile in support for additional codeset (encoding) groups ("eu",
 
32
        "vn" are always compiled in, which includes most 8-bit character
 
33
        sets). These codeset tables are used for driving X11 core fonts,
 
34
        they are not required for Xft fonts, although having them compiled
 
35
        in lets rxvt-unicode choose replacement fonts more intelligently.
 
36
        Compiling them in will make your binary bigger (all of together cost
 
37
        about 700kB), but it doesn't increase memory usage unless you use a
 
38
        font requiring one of these encodings.
 
39
 
 
40
   all             all available codeset groups 
 
41
   zh              common chinese encodings 
 
42
   zh_ext          rarely used but very big chinese encodigs 
 
43
   jp              common japanese encodings 
 
44
   jp_ext          rarely used but big japanese encodings 
 
45
   kr              korean encodings 
 
46
    --enable-xim (default: on)
41
47
        Add support for XIM (X Input Method) protocol. This allows using
42
48
        alternative input methods (e.g. kinput2) and will also correctly set
43
49
        up the input for people using dead keys or compose keys.
44
50
 
45
 
    --enable-unicode3
 
51
    --enable-unicode3 (default: off)
 
52
        Recommended to stay off unless you really need non-BMP characters.
 
53
 
46
54
        Enable direct support for displaying unicode codepoints above 65535
47
55
        (the basic multilingual page). This increases storage requirements
48
56
        per character from 2 to 4 bytes. X11 fonts do not yet support these
54
62
        switch), and right now rxvt-unicode cannot display them
55
63
        (input/output and cut&paste still work, though).
56
64
 
57
 
    --enable-combining
 
65
    --enable-combining (default: on)
58
66
        Enable automatic composition of combining characters into composite
59
67
        characters. This is required for proper viewing of text where
60
68
        accents are encoded as seperate unicode characters. This is done by
62
70
        pseudo-characters when no precomposed form exists.
63
71
 
64
72
        Without --enable-unicode3, the number of additional precomposed
65
 
        characters is rather limited (2048, if this is full, rxvt-unicode
66
 
        will use the private use area, extending the number of combinations
67
 
        to 8448). With --enable-unicode3, no practical limit exists.
 
73
        characters is somewhat limited (the 6400 private use characters will
 
74
        be (ab-)used). With --enable-unicode3, no practical limit exists.
68
75
 
69
76
        This option will also enable storage (but not display) of characters
70
77
        beyond plane 0 (>65535) when --enable-unicode3 was not specified.
73
80
        forms, but these are not currently used. Bug me if you want these to
74
81
        be used (and tell me how these are to be used...).
75
82
 
76
 
    --enable-fallback(=CLASS)
77
 
        When reading resource settings, also read settings for class CLASS
78
 
        (default: Rxvt). To disable resource fallback use
79
 
        --disable-fallback.
80
 
 
81
 
    --with-res-name=NAME
82
 
        Use the given name (default: urxvt) as default application name when
83
 
        reading resources. Specify --with-res-name=rxvt to replace rxvt.
84
 
 
85
 
    --with-res-class=CLASS
86
 
        Use the given class (default: URxvt) as default application class
87
 
        when reading resources. Specify --with-res-class=Rxvt to replace
88
 
        rxvt.
89
 
 
90
 
    --enable-utmp
 
83
    --enable-fallback(=CLASS) (default: Rxvt)
 
84
        When reading resource settings, also read settings for class CLASS.
 
85
        To disable resource fallback use --disable-fallback.
 
86
 
 
87
    --with-res-name=NAME (default: urxvt)
 
88
        Use the given name as default application name when reading
 
89
        resources. Specify --with-res-name=rxvt to replace rxvt.
 
90
 
 
91
    --with-res-class=CLASS /default: URxvt)
 
92
        Use the given class as default application class when reading
 
93
        resources. Specify --with-res-class=Rxvt to replace rxvt.
 
94
 
 
95
    --enable-utmp (default: on)
91
96
        Write user and tty to utmp file (used by programs like w) at start
92
97
        of rxvt execution and delete information when rxvt exits.
93
98
 
94
 
    --enable-wtmp
 
99
    --enable-wtmp (default: on)
95
100
        Write user and tty to wtmp file (used by programs like last) at
96
101
        start of rxvt execution and write logout when rxvt exits. This
97
102
        option requires --enable-utmp to also be specified.
98
103
 
99
 
    --enable-lastlog
 
104
    --enable-lastlog (default: on)
100
105
        Write user and tty to lastlog file (used by programs like lastlogin)
101
106
        at start of rxvt execution. This option requires --enable-utmp to
102
107
        also be specified.
103
108
 
104
 
    --enable-xpm-background
 
109
    --enable-xpm-background (default: on)
105
110
        Add support for XPM background pixmaps.
106
111
 
107
 
    --enable-transparency
 
112
    --enable-transparency (default: on)
108
113
        Add support for inheriting parent backgrounds thus giving a fake
109
114
        transparency to the term.
110
115
 
111
 
    --enable-fading
112
 
        Add support for fading the text when focus is lost.
113
 
 
114
 
    --enable-tinting
115
 
        Add support for tinting of transparent backgrounds.
116
 
 
117
 
    --enable-menubar
118
 
        Add support for our menu bar system (this interacts badly with
119
 
        dynamic locale switching currently).
120
 
 
121
 
    --enable-rxvt-scroll
 
116
    --enable-fading (default: on)
 
117
        Add support for fading the text when focus is lost (requires
 
118
        "--enable-transparency").
 
119
 
 
120
    --enable-tinting (default: on)
 
121
        Add support for tinting of transparent backgrounds (requires
 
122
        "--enable-transparency").
 
123
 
 
124
    --enable-rxvt-scroll (default: on)
122
125
        Add support for the original rxvt scrollbar.
123
126
 
124
 
    --enable-next-scroll
 
127
    --enable-next-scroll (default: on)
125
128
        Add support for a NeXT-like scrollbar.
126
129
 
127
 
    --enable-xterm-scroll
 
130
    --enable-xterm-scroll (default: on)
128
131
        Add support for an Xterm-like scrollbar.
129
132
 
130
 
    --enable-plain-scroll
 
133
    --enable-plain-scroll (default: on)
131
134
        Add support for a very unobtrusive, plain-looking scrollbar that is
132
135
        the favourite of the rxvt-unicode author, having used it for many
133
136
        years.
134
137
 
135
 
    --enable-half-shadow
136
 
        Make shadows on the scrollbar only half the normal width & height.
137
 
        only applicable to rxvt scrollbars.
138
 
 
139
 
    --enable-ttygid
 
138
    --enable-ttygid (default: off)
140
139
        Change tty device setting to group "tty" - only use this if your
141
140
        system uses this type of security.
142
141
 
143
142
    --disable-backspace-key
144
 
        Disable any handling of the backspace key by us - let the X server
 
143
        Removes any handling of the backspace key by us - let the X server
145
144
        do it.
146
145
 
147
146
    --disable-delete-key
148
 
        Disable any handling of the delete key by us - let the X server do
 
147
        Removes any handling of the delete key by us - let the X server do
149
148
        it.
150
149
 
151
150
    --disable-resources
152
 
        Remove all resources checking.
153
 
 
154
 
    --enable-xgetdefault
155
 
        Make resources checking via XGetDefault() instead of our small
156
 
        version which only checks ~/.Xdefaults, or if that doesn't exist
157
 
        then ~/.Xresources.
158
 
 
159
 
        Please note that nowadays, things like XIM will automatically pull
160
 
        in and use the full X resource manager, so the overhead of using it
161
 
        might be very small, if nonexistant.
162
 
 
163
 
    --enable-strings
164
 
        Add support for our possibly faster memset() function and other
165
 
        various routines, overriding your system's versions which may have
166
 
        been hand-crafted in assembly or may require extra libraries to link
167
 
        in. (this breaks ANSI-C rules and has problems on many GNU/Linux
168
 
        systems).
 
151
        Removes any support for resource checking.
169
152
 
170
153
    --disable-swapscreen
171
 
        Remove support for swap screen.
 
154
        Remove support for secondary/swap screen.
172
155
 
173
 
    --enable-frills
 
156
    --enable-frills (default: on)
174
157
        Add support for many small features that are not essential but nice
175
158
        to have. Normally you want this, but for very small binaries you may
176
159
        want to disable this.
180
163
 
181
164
          MWM-hints
182
165
          EWMH-hints (pid, utf8 names) and protocols (ping)
183
 
          seperate underline colour
184
 
          settable border widths and borderless switch
185
 
          settable extra linespacing
 
166
          seperate underline colour (-underlineColor)
 
167
          settable border widths and borderless switch (-w, -b, -bl)
 
168
          visual depth selection (-depth)
 
169
          settable extra linespacing /-lsp)
186
170
          iso-14755-2 and -3, and visual feedback
187
 
          backindex and forwardindex escape sequence
 
171
          tripleclickwords (-tcw)
 
172
          settable insecure mode (-insecure)
 
173
          keysym remapping support
 
174
          cursor blinking and underline cursor (-cb, -uc)
 
175
          XEmbed support (-embed)
 
176
          user-pty (-pty-fd)
 
177
          hold on exit (-hold)
 
178
          skip builtin block graphics (-sbg)
 
179
          separate highlightcolor support (-hc)
 
180
 
 
181
        It also enables some non-essential features otherwise disabled, such
 
182
        as:
 
183
 
 
184
          some round-trip time optimisations
 
185
          nearest color allocation on pseudocolor screens
 
186
          UTF8_STRING supporr for selection
 
187
          sgr modes 90..97 and 100..107
 
188
          backindex and forwardindex escape sequences
 
189
          view change/zero scorllback esacpe sequences
 
190
          locale switching escape sequence
188
191
          window op and some xterm/OSC escape sequences
189
 
          tripleclickwords
190
 
          settable insecure mode
191
 
          keysym remapping support
192
 
          -embed and -pty-fd options
 
192
          rectangular selections
 
193
          trailing space removal for selections
 
194
          verbose X error handling
193
195
 
194
 
    --enable-iso14755
 
196
    --enable-iso14755 (default: on)
195
197
        Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
196
198
        Basic support (section 5.1) is enabled by "--enable-frills", while
197
199
        support for 5.2, 5.3 and 5.4 is enabled with this switch.
198
200
 
199
 
    --enable-keepscrolling
 
201
    --enable-keepscrolling (default: on)
200
202
        Add support for continual scrolling of the display when you hold the
201
203
        mouse button down on a scrollbar arrow.
202
204
 
203
 
    --enable-mousewheel
 
205
    --enable-mousewheel (default: on)
204
206
        Add support for scrolling via mouse wheel or buttons 4 & 5.
205
207
 
206
 
    --enable-slipwheeling
 
208
    --enable-slipwheeling (default: on)
207
209
        Add support for continual scrolling (using the mouse wheel as an
208
210
        accelerator) while the control key is held down. This option
209
211
        requires --enable-mousewheel to also be specified.
211
213
    --disable-new-selection
212
214
        Remove support for mouse selection style like that of xterm.
213
215
 
214
 
    --enable-dmalloc
 
216
    --enable-dmalloc (default: off)
215
217
        Use Gray Watson's malloc - which is good for debugging See
216
 
        http://www.letters.com/dmalloc/ for details If you use either this
 
218
        <http://www.letters.com/dmalloc/> for details If you use either this
217
219
        or the next option, you may need to edit src/Makefile after
218
220
        compiling to point DINCLUDE and DLIB to the right places.
219
221
 
220
222
        You can only use either this option and the following (should you
221
223
        use either) .
222
224
 
223
 
    --enable-dlmalloc
 
225
    --enable-dlmalloc (default: off)
224
226
        Use Doug Lea's malloc - which is good for a production version See
225
227
        <http://g.oswego.edu/dl/html/malloc.html> for details.
226
228
 
227
 
    --enable-smart-resize
228
 
        Add smart growth/shrink behaviour when changing font size via from
229
 
        hot keys. This should keep in a fixed position the rxvt corner which
230
 
        is closest to a corner of the screen.
231
 
 
232
 
    --enable-cursor-blink
233
 
        Add support for a blinking cursor.
234
 
 
235
 
    --enable-pointer-blank
 
229
    --enable-smart-resize (default: on)
 
230
        Add smart growth/shrink behaviour when changing font size via hot
 
231
        keys. This should keep the window corner which is closest to a
 
232
        corner of the screen in a fixed position.
 
233
 
 
234
    --enable-pointer-blank (default: on)
236
235
        Add support to have the pointer disappear when typing or inactive.
237
236
 
238
 
    --with-name=NAME
239
 
        Set the basename for the installed binaries (default: "urxvt",
240
 
        resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to
241
 
        replace with "rxvt".
242
 
 
243
 
    --with-term=NAME
244
 
        Change the environmental variable for the terminal to NAME (default
245
 
        "rxvt-unicode")
 
237
    --enable-perl (default: on)
 
238
        Enable an embedded perl interpreter. See the rxvtperl(3) manpage
 
239
        (doc/rxvtperl.txt) for more info on this feature, or the files in
 
240
        src/perl-ext/ for the extensions that are installed by default. The
 
241
        perl interpreter that is used can be specified via the "PERL"
 
242
        environment variable when running configure.
 
243
 
 
244
    --with-name=NAME (default: urxvt)
 
245
        Set the basename for the installed binaries, resulting in "urxvt",
 
246
        "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
 
247
 
 
248
    --with-term=NAME (default: rxvt-unicode)
 
249
        Change the environmental variable for the terminal to NAME.
246
250
 
247
251
    --with-terminfo=PATH
248
252
        Change the environmental variable for the path to the terminfo tree