Update docs/overview.txt to match the new way to call crosstool-ng: "ct-ng [action]" in lieu of "make [action]".
1 ." crosstool-ng man page
2 ." Copyright 2007 Yann E. MORIN
3 ." Licensed under the Creative Commons BY-SA, v2.5
8 .TH ct-ng 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
12 ct-ng, crosstool-ng \- Build cross-toolchains
20 Building a cross-toolchain can be a real pain.
23 makes it easy to build cross-toolchains, and allows you to take all the juice
24 out of your target by configuring the differents components of the toolchain
25 accordingly to the targeted processor.
29 Here are the most commonly used actions. For other actions, please see
30 .I @@CT_DOCDIR@@/overview.txt
33 Prints a little help text.
39 using a configurator menu very similar to that of the Linux kernel.
43 Apply options found in an existing
45 file, and ask for newer options if there are any.
51 configuration, and associated components' config files, into a sample. Samples
52 are saved in their own sub-directory, named after the target's triplet, in the
54 sub-directory of the current directory.
55 If that was not clear:
56 .I `pwd`/samples/${CT_TARGET}/
58 Samples can be later recalled by calling
60 with the target triplet they represent.
64 Builds the configured toolchain. If
66 is called without action, then
72 Lists all build steps available (see
78 Remove files generated by
80 for itself (these are mostly the configurators' binaries).
86 , but also removes the toolchain build directory, the downloaded files and the
88 configuration file. The generated toolchain is left untouched, as well as
89 samples which are not removed.
95 regression test suite. All samples are build, and the regression test suite is
96 run against every one of them.
104 scripts. These scripts are used by
106 to canonicalise the machines' name (host, build and target machines).
109 Builds a tarball of the generated toolchain, also saving the scripts from
111 that are needed to rebuild the target, and also saving the tarballs of the
112 componnents that were used.
117 Respectively stops and restarts the build just before this step. To restart a
118 step, a previous build should have run at least to that step, or further.
120 The list of steps is vailable with the action
126 frontend is in fact a
128 script. See the man page for
130 to have the meaning of the exit values.
133 As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to
134 foresee how every parts of
136 are going to be installed. Each parts is needed to build a tarball, as it
137 contains all that is needed to rebuild the toolchain from scratch: toolchain
140 configuration, but also all
145 .B Don't run as root!
146 Great care has been taken to avoid mistakes, but bug-free programs don't
147 exist. During normal operation,
149 removes entire directories. If you run as root, and there is a bug or you
152 entire important directories could be removed (eg.
156 will refuse to install in some well known critical directories.
159 .MTO "yann.morin.1998@anciens.enib.fr" "Yann E. MORIN" ""
160 .URL "http://ymorin.is-a-geek.org" "" ""
165 scripts to be more easily maintainable, added the Kconfig configurator, some
168 Please consult the file
169 .I @@CT_DOCDIR@@/CREDITS
170 for a list of contributors.
173 Please have a look at the
174 .URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"