1 =================================
2 Configuration targets and editors
3 =================================
4
5 This file contains some assistance for using `
6
7 Use ``make help`` to list all of the possible
8
9 The xconfig ('qconf'), menuconfig ('mconf'), a
10 programs also have embedded help text. Be sur
11 navigation, search, and other general help tex
12
13 The gconfig ('gconf') program has limited help
14
15
16 General
17 =======
18
19 New kernel releases often introduce new config
20 important, new kernel releases may rename conf
21 this happens, using a previously working .conf
22 "make oldconfig" won't necessarily produce a w
23 for you, so you may find that you need to see
24 symbols have been introduced.
25
26 To see a list of new config symbols, use::
27
28 cp user/some/old.config .config
29 make listnewconfig
30
31 and the config program will list any new symbo
32
33 Alternatively, you can use the brute force met
34
35 make oldconfig
36 scripts/diffconfig .config.old .config | l
37
38
39 Environment variables
40 =====================
41
42 Environment variables for ``*config``:
43
44 ``KCONFIG_CONFIG``
45 This environment variable can be used to s
46 file name to override the default name of
47
48 ``KCONFIG_DEFCONFIG_LIST``
49 This environment variable specifies a list
50 used as a base configuration in case the .
51 Entries in the list are separated with whi
52 the first one that exists is used.
53
54 ``KCONFIG_OVERWRITECONFIG``
55 If you set KCONFIG_OVERWRITECONFIG in the
56 break symlinks when .config is a symlink t
57
58 ``KCONFIG_WARN_UNKNOWN_SYMBOLS``
59 This environment variable makes Kconfig wa
60 symbols in the config input.
61
62 ``KCONFIG_WERROR``
63 If set, Kconfig treats warnings as errors.
64
65 ``CONFIG_``
66 If you set ``CONFIG_`` in the environment,
67 with its value when saving the configurati
68 default, ``CONFIG_``.
69
70 Environment variables for ``{allyes/allmod/all
71
72 ``KCONFIG_ALLCONFIG``
73 The allyesconfig/allmodconfig/allnoconfig/
74 use the environment variable KCONFIG_ALLCO
75 that contains config symbols that the user
76 specific value. If KCONFIG_ALLCONFIG is u
77 KCONFIG_ALLCONFIG == "" or KCONFIG_ALLCONF
78 checks for a file named "all{yes/mod/no/de
79 (corresponding to the ``*config`` command
80 that are to be forced. If this file is no
81 file named "all.config" to contain forced
82
83 This enables you to create "miniature" con
84 config files containing just the config sy
85 in. Then the kernel config system generat
86 including symbols of your miniconfig file.
87
88 This ``KCONFIG_ALLCONFIG`` file is a confi
89 (usually a subset of all) preset config sy
90 settings are still subject to normal depen
91
92 Examples::
93
94 KCONFIG_ALLCONFIG=custom-notebook.conf
95
96 or::
97
98 KCONFIG_ALLCONFIG=mini.config make all
99
100 or::
101
102 make KCONFIG_ALLCONFIG=mini.config all
103
104 These examples will disable most options (
105 disable the options that are explicitly li
106 mini-config files.
107
108 Environment variables for ``randconfig``:
109
110 ``KCONFIG_SEED``
111 You can set this to the integer value used
112 to somehow debug the behaviour of the kcon
113 If not set, the current time will be used.
114
115 ``KCONFIG_PROBABILITY``
116 This variable can be used to skew the prob
117 be unset or empty, or set to three differe
118
119 ======================= ==============
120 KCONFIG_PROBABILITY y:n split
121 ======================= ==============
122 unset or empty 50 : 50
123 N N : 100-N
124 [1] N:M N+M : 100-(N+M
125 [2] N:M:L N : 100-N
126 ======================= ==============
127
128 where N, M and L are integers (in base 10) in
129 that:
130
131 [1] N+M is in the range [0,100]
132
133 [2] M+L is in the range [0,100]
134
135 Examples::
136
137 KCONFIG_PROBABILITY=10
138 10% of booleans will be set to 'y', 90
139 5% of tristates will be set to 'y', 5%
140 KCONFIG_PROBABILITY=15:25
141 40% of booleans will be set to 'y', 60
142 15% of tristates will be set to 'y', 2
143 KCONFIG_PROBABILITY=10:15:15
144 10% of booleans will be set to 'y', 90
145 15% of tristates will be set to 'y', 1
146
147 Environment variables for ``syncconfig``:
148
149 ``KCONFIG_NOSILENTUPDATE``
150 If this variable has a non-blank value, it
151 config updates (requires explicit updates)
152
153 ``KCONFIG_AUTOCONFIG``
154 This environment variable can be set to sp
155 "auto.conf" file. Its default value is "i
156
157 ``KCONFIG_AUTOHEADER``
158 This environment variable can be set to sp
159 "autoconf.h" (header) file.
160 Its default value is "include/generated/au
161
162
163 menuconfig
164 ==========
165
166 Searching in menuconfig:
167
168 The Search function searches for kernel co
169 names, so you have to know something close
170 looking for.
171
172 Example::
173
174 /hotplug
175 This lists all config symbols that con
176 e.g., HOTPLUG_CPU, MEMORY_HOTPLUG.
177
178 For search help, enter / followed by TAB-T
179 <Help>) and Enter. This will tell you tha
180 regular expressions (regexes) in the searc
181 are not interested in MEMORY_HOTPLUG, you
182
183 /^hotplug
184
185 When searching, symbols are sorted thus:
186
187 - first, exact matches, sorted alphabetica
188 is when the search matches the complete
189 - then, other matches, sorted alphabetical
190
191 For example, ^ATH.K matches:
192
193 ATH5K ATH9K ATH5K_AHB ATH5K_DEBUG [...
194 [...] ATH9K_AHB ATH9K_BTCOEX_SUPPORT A
195
196 of which only ATH5K and ATH9K match exactl
197 first (and in alphabetical order), then co
198 sorted in alphabetical order.
199
200 In this menu, pressing the key in the (#)
201 directly to that location. You will be ret
202 search results after exiting this new menu
203
204 User interface options for 'menuconfig':
205
206 ``MENUCONFIG_COLOR``
207 It is possible to select different color t
208 MENUCONFIG_COLOR. To select a theme use::
209
210 make MENUCONFIG_COLOR=<theme> menuconf
211
212 Available themes are::
213
214 - mono => selects colors suitable
215 - blackbg => selects a color scheme w
216 - classic => theme with blue backgrou
217 - bluetitle => a LCD friendly version o
218
219 ``MENUCONFIG_MODE``
220 This mode shows all sub-menus in one large
221
222 Example::
223
224 make MENUCONFIG_MODE=single_menu menuc
225
226
227 nconfig
228 =======
229
230 nconfig is an alternate text-based configurato
231 keys across the bottom of the terminal (window
232 You can also just use the corresponding numeri
233 commands unless you are in a data entry window
234 for Save, you can just press 6.
235
236 Use F1 for Global help or F3 for the Short hel
237
238 Searching in nconfig:
239
240 You can search either in the menu entry "p
241 or in the configuration symbols.
242
243 Use / to begin a search through the menu e
244 not support regular expressions. Use <Dow
245 Next hit and Previous hit, respectively.
246 terminate the search mode.
247
248 F8 (SymSearch) searches the configuration
249 given string or regular expression (regex)
250
251 In the SymSearch, pressing the key in the
252 jump directly to that location. You will b
253 current search results after exiting this
254
255 Environment variables:
256
257 ``NCONFIG_MODE``
258 This mode shows all sub-menus in one large
259
260 Example::
261
262 make NCONFIG_MODE=single_menu nconfig
263
264
265 xconfig
266 =======
267
268 Searching in xconfig:
269
270 The Search function searches for kernel co
271 names, so you have to know something close
272 looking for.
273
274 Example::
275
276 Ctrl-F hotplug
277
278 or::
279
280 Menu: File, Search, hotplug
281
282 lists all config symbol entries that conta
283 the symbol name. In this Search dialog, y
284 config setting for any of the entries that
285 You can also enter a different search stri
286 to return to the main menu.
287
288
289 gconfig
290 =======
291
292 Searching in gconfig:
293
294 There is no search command in gconfig. Ho
295 have several different viewing choices, mo
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.