mirror of the now-defunct rocklinux.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

397 lines
14 KiB

  1. # --- ROCK-COPYRIGHT-NOTE-BEGIN ---
  2. #
  3. # This copyright note is auto-generated by ./scripts/Create-CopyPatch.
  4. # Please add additional copyright information _after_ the line containing
  5. # the ROCK-COPYRIGHT-NOTE-END tag. Otherwise it might get removed by
  6. # the ./scripts/Create-CopyPatch script. Do not edit this copyright text!
  7. #
  8. # ROCK Linux: rock-src/scripts/config.hlp
  9. # ROCK Linux is Copyright (C) 1998 - 2006 Clifford Wolf
  10. #
  11. # This program is free software; you can redistribute it and/or modify
  12. # it under the terms of the GNU General Public License as published by
  13. # the Free Software Foundation; either version 2 of the License, or
  14. # (at your option) any later version. A copy of the GNU General Public
  15. # License can be found at Documentation/COPYING.
  16. #
  17. # Many people helped and are helping developing ROCK Linux. Please
  18. # have a look at http://www.rocklinux.org/ and the Documentation/TEAM
  19. # file for details.
  20. #
  21. # --- ROCK-COPYRIGHT-NOTE-END ---
  22. COMMENT_ARCHCPUOPT
  23. In this section you are able to select the architecture, the CPU and
  24. whether you are cross-building/porting to another architecture.
  25. COMMENT_TARGET
  26. In this section you can select which distribution target you would like
  27. to use.
  28. COMMENT_BUILD_SYS_CONF
  29. Here you can set some basic options for our beautiful distribution
  30. build system.
  31. ROCKCFG_ARCH
  32. This option controls the target architecture like alpha, ia64, mips,
  33. ppc, sparc or x86.
  34. ROCKCFG_CROSSBUILD
  35. This option needs to be selected to perform a cross-build to another
  36. architecture.
  37. ROCKCFG_CROSS_TESTALL
  38. If enabled, try to cross-build packages which are not known to support
  39. cross-compilation.
  40. USE WITH CARE: cross-building packages which don't support cross-compilation
  41. might overwrite files on your real root filesystem, rendering your system
  42. unusable!
  43. ROCKCFG_PSEUDONATIVE
  44. Many packages cannot be cross-build, but building them natively might
  45. considerably slow down the build process (e.g. on old hardware).
  46. Pseudo-native builds combine the advantages of cross-builds (fast hardware)
  47. and native builds (being able to execute compiled programs): like in
  48. cross-builds, most of the build is done on a non-native machine; programs
  49. that require native execution, however, are transparently run on another,
  50. native machine.
  51. ROCKCFG_PSEUDONATIVE_NATIVEHOST
  52. The IP adress of the native host for pseudo-native builds.
  53. ROCKCFG_PSEUDONATIVE_NFSROOT
  54. The NFS root to be mounted on the native host for pseudo-native builds.
  55. ROCKCFG_DISABLE_BROKEN
  56. If you select this option packages that have not built in the last
  57. referency build will not be built.
  58. ROCKCFG_TARGET
  59. Please select the Target you want to build. Here's a short overview:
  60. - Boot-, Install- and Rescue-System:
  61. The boot-system. You need this if you want to install the system
  62. you built with CD or floppy-disk.
  63. - Desktop ROCK Linux:
  64. Intended for use on workstations / desktops.
  65. - Diet LibC based ROCK Linux:
  66. A distribution using Diet LibC instead of GLibC. DietLibC is
  67. a light-weight C-Library useful for embedded systems and other
  68. low-memory devices.
  69. - Epiam ROCK Linux:
  70. A distribution specially for VIA Epiam processors.
  71. - Generic ROCK Linux:
  72. A generic, all-purpose distribution that has simply everything.
  73. - ROCK Linux LiveCD:
  74. A system that can boot and run directly from CD without the need
  75. to install anything on a hard disk.
  76. - ROCK Linux Video Player (lvp):
  77. A distribution that works as a video player and boots from CD.
  78. - Minimal ROCK Linux:
  79. A basic system that has only minimally more than a LFS.
  80. - Reference-Build for creating *.cache files:
  81. This target is for internal use only. It's purpose is to create
  82. package/*/*/*.cache files which are used to validate a package
  83. and consolidate its various information.
  84. - ROCK Router Linux:
  85. This is a _very_ minimal system with only routing-capabilities.
  86. - ROCK Linux Server:
  87. This target is intended to build a not blown up server distribution
  88. to install web-, mail-, fileserver or similar.
  89. ROCKCFG_LINGUAS
  90. Here you can choose the languages for which message translation
  91. catalogs should be installed.
  92. Note that not all programs provide translations for each language.
  93. If set to 'all', all available translations will be installed, and
  94. none if set to 'none'.
  95. ROCKCFG_PARALLEL
  96. Select this option if you want to perform a parallel build on several
  97. machines or if you build on a multiprocessor machine.
  98. See Documentation/BUILD-CLUSTER for more details.
  99. ROCKCFG_PARALLEL_MAX
  100. This options controls the maximum number of simultaneous build jobs.
  101. ROCKCFG_PARALLEL_ADDJOB
  102. If you're using an external command scheduler, enter it here.
  103. See Documentation/BUILD-CLUSTER for more details.
  104. ROCKCFG_ABORT_ON_ERROR
  105. If selected the build will stop on each package build error.
  106. ROCKCFG_RETRY_BROKEN
  107. This options controls whether the Build-System should try to build a
  108. package that has not built flawlessly during the last build.
  109. ROCKCFG_DISABLE_BROKEN
  110. Please check here if you want to skip building packages which are marked
  111. as broken. Note that this differs from ROCKCFG_RETRY_BROKEN. The reason
  112. a package is deemed 'broken' can also be missing *.cache file or others.
  113. ROCKCFG_NOBROKENDEPS
  114. Do not try building packages if any of their build-time dependencies failed.
  115. ROCKCFG_ALWAYS_CLEAN
  116. When a package built flawlessly then the temporary directory which was
  117. used for building is deleted. Select this options if you also want this
  118. cleanup for packages with build error. (This safes disk-space but makes
  119. debugging hard ...)
  120. ROCKCFG_XTRACE
  121. Please check here if you want additional (debug)-output in the build
  122. log-files.
  123. ROCKCFG_SRC_TMPFS
  124. Check here if you want package builds to use tmpfs instead of the regular
  125. filesystem on which ROCK resides.
  126. ROCKCFG_SRC_TMPFS_OPT
  127. Please enter the tmpfs mount options here. For example:
  128. size=800M,nr_inodes=100k
  129. will mount an 800 Megabyte tmp-filesystem with 100,000 inodes.
  130. size=4G,nr_inodes=500k
  131. will mount a 4 Gigabyte tmp-filesystem with 500,000 inodes.
  132. Please make sure that the filesystem is big enough to hold
  133. - package-sources (unpacked)
  134. - compile-time binaries
  135. - and the binary package
  136. The filesystem size also must not be so big as to hog all your RAM or
  137. else your system might crash or start swapping.
  138. ROCKCFG_SRC_TMPFS_LOG
  139. Please enter the path to the tmpfs logfile.
  140. ROCKCFG_SENDMAIL
  141. If enabled, Build-Target will send emails when special events happen,
  142. currently on failed package builds and on completed target builds.
  143. ROCKCFG_SENDMAIL_BIN
  144. The program used by the build scripts for sending email notifications.
  145. ROCKCFG_SENDMAIL_TO
  146. Email notifications about build events will be sent to this email address.
  147. ROCKCFG_MYTHTVOSD
  148. Use a Myth TV on-screen display for certain output of the build scripts.
  149. ROCKCFG_OUTPUT_HTML
  150. Write the output of the build scripts to HTML files.
  151. ROCKCFG_OUTPUT_HTML_DIR
  152. The directory which build output should be written to.
  153. ROCKCFG_OUTPUT_TTS
  154. Use a text-to-speech system for certain output of the build scripts.
  155. ROCKCFG_OUTPUT_TERM_COLOR
  156. Use ANSI colors for output to a terminal.
  157. ROCKCFG_VERBOSE
  158. If enabled, all output during builds is not only written to the respective
  159. build log but also displayed on the console.
  160. ROCKCFG_EXPERT
  161. This button will enable a lot of additional configuration options.
  162. Some of these will make small changes to what the system will look
  163. like while others will have a huge impact on performance, stability
  164. and usability of the final system.
  165. Don't touch these if you don't know what you are doing.
  166. YOU HAVE BEEN WARNED!
  167. ROCKCFG_CREATE_CKSUM
  168. Disable Checksum creation. Leave this enabled unless you know why you
  169. want to disable it.
  170. ROCKCFG_CREATE_TARBZ2
  171. If selected binary packages in .tar.bz2 format will be created.
  172. ROCKCFG_CREATE_GEM
  173. If selected binary packages in .gem format will be created.
  174. ROCKCFG_PKGFILE_VER
  175. If selected the package version number will be added to the binary
  176. package filenme.
  177. ROCKCFG_SPLIT_DOC
  178. If enabled, each binary package is split, with one split containing
  179. only documentation files, e.g. kdelibs.gem and kdelibs:doc.gem. This
  180. allows to easily distribute and install package splits separately.
  181. Altough man and info pages are documentation files as well, they are
  182. not included in :doc splits because they are considered too important.
  183. ROCKCFG_SPLIT_DEV
  184. If enabled, each binary package is split, with one split containing
  185. only files required for software development, e.g. kdelibs.gem and
  186. kdelibs:dev.gem. This allows to easily distribute and install package
  187. splits separately.
  188. Files required solely for the purpose of software development include
  189. static libraries and C header files.
  190. ROCKCFG_PKGSEL
  191. If selected you can modify the package list for the build.
  192. ROCKCFG_PKGSEL_TPL
  193. Package preselection templates are sets of package selection rules, where
  194. each template is used for a distinct set of packages.
  195. Package preselection templates (together with the default package
  196. selections of each target) can be seen as starting points for creating
  197. your own package selection (using "Custom package selection").
  198. MENU_PKGSEL_RULES
  199. Here you can modify the package list for the build. You have the
  200. choice between enable, disable or complete removal. A disabled
  201. package can still be reenabled by a target, while a removed one
  202. can not be selected by a target.
  203. Use "X <pattern>" to enable packages
  204. Use "O <pattern>" to disable packages
  205. Use "- <pattern>" to remove packages
  206. For example:
  207. "- gnome*"
  208. will not build Gnome at all.
  209. ROCKCFG_SHOW_PKGLIST
  210. This will display the complete, current package list.
  211. ROCKCFG_CONFOPT_FILE:0
  212. Here you can specify additional parameters passed to every ./configure
  213. script.
  214. Use "--with-option" to enable a feature
  215. Use "--without-option" to disable a feature
  216. Use "--option[=value]" to specify a custom option
  217. The Build-System will always check whether the configure script supports
  218. the options before the options is really passed as argument.
  219. COMMENT_FLIST
  220. Please see the help for the choice menu.
  221. ROCKCFG_FLIST
  222. This help is taken from Rolling ROCK Issue #2 2003
  223. The ROCK Linux build scripts auto-detect which files are created
  224. by a package build and use this information to create the package
  225. file list. There are three techniques which can be used to auto-detect
  226. this file list
  227. * flist-wrapper
  228. The flist-wrapper is the recommended way of doing it. It's an "elf
  229. preload library". This is a library which is loaded _before_ the
  230. c-library and so can overwrite functions of the c library. The
  231. flist-wrapper lib is overwriting all functions which can be used
  232. to create files and is writing the filenames to a log file before
  233. running the original c library function.
  234. This log file is used to create the package file list after the
  235. build has been completed. The problem with the flist-wrapper lib is
  236. that it doesn't work with statically built binaries or with non
  237. glibc c libraries. In such environments (e.g. when building a
  238. dietlibc based system), other techniques - such as those described
  239. below - must be used for creating the file list.
  240. * strace
  241. This one is rather easy: The whole build is running in a process-
  242. tree which is monitored by strace. The log file created by strace is
  243. later used to create the package file list. However: this does only
  244. work on architectures which do have an strace command - which is not
  245. the case for all architectures the Linux kernel and glibc have been
  246. ported to.
  247. * find
  248. This one is rather ugly (but sometimes the only alternative): When
  249. the build is started, a 'timestamp-file' is created. After the build
  250. has been completed, the find program is used to find all files which
  251. are newer than the 'timestamp-file'. This is really slow now and has
  252. the disadvantage that nothing else than the build process may create
  253. or modify files while the build is running. This should only be used
  254. if no other system for creating the file list can be used.
  255. ROCKCFG_USE_CROSSCC
  256. This option controls whether to use a pseudo-cross compiler even
  257. for native (non-cross) builds. This is needed when the host and
  258. target gcc or glibc differ in the ABI.
  259. THIS IS STRONGLY RECOMMENDED!
  260. ROCKCFG_DO_REBUILD_STAGE
  261. This options controls whether to rebuild all packages in the final
  262. rebuild stage.
  263. Each and every package is rebuilt in stage 9 once more and only then
  264. are the binary packages created. This has the advantage that
  265. circular dependencies are resolved, but it also almost doubles the
  266. build time.
  267. In former times this was recommended - but nowadays this is only a
  268. paranoia thing.
  269. ROCKCFG_DO_CHECK
  270. This options enables to run a make check / test target for packages
  271. with support for this. This can be used as extended quality assurance
  272. to make sure the resulting binaries work correct.
  273. ROCKCFG_OPT
  274. With this option, the type of optimisation can be selected.
  275. ROCKCFG_C_FLAGS
  276. These parameters (flags) will be used for every invocation of gcc.
  277. ROCKCFG_CONFIGURE_OPTS
  278. These parameters will be used for every invocation of GNU configure.
  279. ROCKCFG_CREATE_DOCS
  280. If enabled, the build scripts will automatically install documentation files
  281. like README, INSTALL and Changelog, contained in each packages sources.
  282. ROCKCFG_DEBUG
  283. Enable this option if you want to have debug symbols in your binaries.
  284. ROCKCFG_LIMITCXX
  285. Check here if you want to disable the C++ exceptions run-time type
  286. identification. This can make the C++ binaries about 25% smaller,
  287. but any C++ sources using exceptions or rtti, for example QT/KDE,
  288. will fail to compile. If you don't know, don't touch.
  289. ROCKCFG_STATIC
  290. Create statically linked binaries.
  291. ROCKCFG_MULTILIB
  292. Enable installing several versions of the same library.
  293. ROCKCFG_AUTOPCH
  294. Compiling C++ headers more than once (e.g. when included from different
  295. files) often causes a significant increase in build time.
  296. Enable this option and a wrapper for the C++ compiler will try to make
  297. sure the time-expensive part of compiling C++ headers is done only once
  298. at most.
  299. ROCKCFG_DISABLE_NLS
  300. Please check here if you do not want to use Native Language Support.
  301. ROCKCFG_CREATE_CACHE
  302. Please check here if you want to create *.cache files after a build
  303. has completed. This is the same as a reference build.
  304. ROCKCFG_PARANOIA_CHECK
  305. Please check here if you want to run sanity checks before building.
  306. THIS IS STRONGLY RECOMMENDED!
  307. ROCKCFG_IDCKSUM
  308. Please check here if you want to use a checksum instead of the long
  309. explanatory ROCKCFG-ID.