diff -r 000000000000 -r 223c84ec2d90 docs/ct-ng.1.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/ct-ng.1.in Sun Jul 01 19:04:20 2007 +0000 @@ -0,0 +1,174 @@ +." crosstool-ng man page +." Copyright 2007 Yann E. MORIN +." Licensed under the Creative Commons BY-SA, v2.5 +." +." Beautifying URLs +.mso www.tmac +." +.TH ct-ng 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands" +." +." +.SH NAME +ct-ng, crosstool-ng \- Build cross-toolchains +." +." +.SH SYNOPSIS +.B ct-ng ACTION +." +." +.SH DESCRIPTION +Building a cross-toolchain can be a real pain. +.PP +.B ct-ng +makes it easy to build cross-toolchains, and allows you to take all the juice +out of your target by configuring the differents components of the toolchain +accordingly to the targeted processor. +." +." +.SH ACTIONS +Here are the most commonly used actions. For other actions, please see +.I @@CT_DOCDIR@@/overview.txt +.TP +.B help +Prints a little help text. +." +.TP +.B menuconfig +Configures +.B ct-ng +using a configurator menu very similar to that of the Linux kernel. +." +.TP +.B oldconfig +Apply options found in an existing +.I .config +file, and ask for newer options if there are any. +." +.TP +.B saveconfig +Save the current +.B ct-ng +configuration, and associated components' config files, into a sample. Samples +are saved in their own sub-directory, named after the target's triplet, in the +.I samples +sub-directory of the current directory. +If that was not clear: +.I `pwd`/samples/${CT_TARGET}/ + +Samples can be later recalled by calling +.B ct-ng +with the target triplet they represent. +." +.TP +.B build +Builds the configured toolchain. If +.B ct-ng +is called without action, then +.B build +is impiled. +." +.TP +.B liststeps +Lists all build steps available (see +.BR ENVIRONMENT, +below). +." +.TP +.B clean +Remove files generated by +.B ct-ng +for itself (these are mostly the configurators' binaries). +." +.TP +.B distclean +Same as +.B clean +, but also removes the toolchain build directory, the downloaded files and the +.I .config +configuration file. The generated toolchain is left untouched, as well as +samples which are not removed. +." +.TP +.B regtest +Calls the +.B ct-ng +regression test suite. All samples are build, and the regression test suite is +run against every one of them. +." +.TP +.B updatetools +Updates the +.I config.guess +and +.I config.sub +scripts. These scripts are used by +.B ct-ng +to canonicalise the machines' name (host, build and target machines). +.TP +.B tarball +Builds a tarball of the generated toolchain, also saving the scripts from +.B ct-ng +that are needed to rebuild the target, and also saving the tarballs of the +componnents that were used. +." +.SH ENVIRONMENT +.TP +.B STOP, START +Respectively stops and restarts the build just before this step. To restart a +step, a previous build should have run at least to that step, or further. + +The list of steps is vailable with the action +.BR liststeps . +." +.SH EXIT VALUE +The +.B ct-ng +frontend is in fact a +.BR make (1) +script. See the man page for +.BR make (1) +to have the meaning of the exit values. +." +.SH BUGS +As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to +foresee how every parts of +.B ct-ng +are going to be installed. Each parts is needed to build a tarball, as it +contains all that is needed to rebuild the toolchain from scratch: toolchain +components' sources, +.B ct-ng +configuration, but also all +.B ct-ng +scripts. +." +.SH SECURITY +.B Don't run as root! +Great care has been taken to avoid mistakes, but bug-free programs don't +exist. During normal operation, +.B ct-ng +removes entire directories. If you run as root, and there is a bug or you +mis-configured +.BR ct-ng , +entire important directories could be removed (eg. +.IR /usr ), +although +.B ct-ng +will refuse to install in some well known critical directories. +." +.SH AUTHORS +.MTO "yann.morin.1998@anciens.enib.fr" "Yann E. MORIN" "" +.URL "http://ymorin.is-a-geek.org" "" "" +reordered +.B crosstool +(see section titled +.BR "SEE ALSO" ) +scripts to be more easily maintainable, added the Kconfig configurator, some +patches. + +Please consult the file +.I @@CT_DOCDIR@@/CREDITS +for a list of contributors. +." +.SH SEE ALSO +Please have a look at the +.URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"