1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/ct-ng.1.in Mon Jul 02 17:47:17 2007 +0000
1.3 @@ -0,0 +1,174 @@
1.4 +." crosstool-ng man page
1.5 +." Copyright 2007 Yann E. MORIN
1.6 +." Licensed under the Creative Commons BY-SA, v2.5
1.7 +."
1.8 +." Beautifying URLs
1.9 +.mso www.tmac
1.10 +."
1.11 +.TH ct-ng 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
1.12 +."
1.13 +."
1.14 +.SH NAME
1.15 +ct-ng, crosstool-ng \- Build cross-toolchains
1.16 +."
1.17 +."
1.18 +.SH SYNOPSIS
1.19 +.B ct-ng ACTION
1.20 +."
1.21 +."
1.22 +.SH DESCRIPTION
1.23 +Building a cross-toolchain can be a real pain.
1.24 +.PP
1.25 +.B ct-ng
1.26 +makes it easy to build cross-toolchains, and allows you to take all the juice
1.27 +out of your target by configuring the differents components of the toolchain
1.28 +accordingly to the targeted processor.
1.29 +."
1.30 +."
1.31 +.SH ACTIONS
1.32 +Here are the most commonly used actions. For other actions, please see
1.33 +.I @@CT_DOCDIR@@/overview.txt
1.34 +.TP
1.35 +.B help
1.36 +Prints a little help text.
1.37 +."
1.38 +.TP
1.39 +.B menuconfig
1.40 +Configures
1.41 +.B ct-ng
1.42 +using a configurator menu very similar to that of the Linux kernel.
1.43 +."
1.44 +.TP
1.45 +.B oldconfig
1.46 +Apply options found in an existing
1.47 +.I .config
1.48 +file, and ask for newer options if there are any.
1.49 +."
1.50 +.TP
1.51 +.B saveconfig
1.52 +Save the current
1.53 +.B ct-ng
1.54 +configuration, and associated components' config files, into a sample. Samples
1.55 +are saved in their own sub-directory, named after the target's triplet, in the
1.56 +.I samples
1.57 +sub-directory of the current directory.
1.58 +If that was not clear:
1.59 +.I `pwd`/samples/${CT_TARGET}/
1.60 +
1.61 +Samples can be later recalled by calling
1.62 +.B ct-ng
1.63 +with the target triplet they represent.
1.64 +."
1.65 +.TP
1.66 +.B build
1.67 +Builds the configured toolchain. If
1.68 +.B ct-ng
1.69 +is called without action, then
1.70 +.B build
1.71 +is impiled.
1.72 +."
1.73 +.TP
1.74 +.B liststeps
1.75 +Lists all build steps available (see
1.76 +.BR ENVIRONMENT,
1.77 +below).
1.78 +."
1.79 +.TP
1.80 +.B clean
1.81 +Remove files generated by
1.82 +.B ct-ng
1.83 +for itself (these are mostly the configurators' binaries).
1.84 +."
1.85 +.TP
1.86 +.B distclean
1.87 +Same as
1.88 +.B clean
1.89 +, but also removes the toolchain build directory, the downloaded files and the
1.90 +.I .config
1.91 +configuration file. The generated toolchain is left untouched, as well as
1.92 +samples which are not removed.
1.93 +."
1.94 +.TP
1.95 +.B regtest
1.96 +Calls the
1.97 +.B ct-ng
1.98 +regression test suite. All samples are build, and the regression test suite is
1.99 +run against every one of them.
1.100 +."
1.101 +.TP
1.102 +.B updatetools
1.103 +Updates the
1.104 +.I config.guess
1.105 +and
1.106 +.I config.sub
1.107 +scripts. These scripts are used by
1.108 +.B ct-ng
1.109 +to canonicalise the machines' name (host, build and target machines).
1.110 +.TP
1.111 +.B tarball
1.112 +Builds a tarball of the generated toolchain, also saving the scripts from
1.113 +.B ct-ng
1.114 +that are needed to rebuild the target, and also saving the tarballs of the
1.115 +componnents that were used.
1.116 +."
1.117 +.SH ENVIRONMENT
1.118 +.TP
1.119 +.B STOP, START
1.120 +Respectively stops and restarts the build just before this step. To restart a
1.121 +step, a previous build should have run at least to that step, or further.
1.122 +
1.123 +The list of steps is vailable with the action
1.124 +.BR liststeps .
1.125 +."
1.126 +.SH EXIT VALUE
1.127 +The
1.128 +.B ct-ng
1.129 +frontend is in fact a
1.130 +.BR make (1)
1.131 +script. See the man page for
1.132 +.BR make (1)
1.133 +to have the meaning of the exit values.
1.134 +."
1.135 +.SH BUGS
1.136 +As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to
1.137 +foresee how every parts of
1.138 +.B ct-ng
1.139 +are going to be installed. Each parts is needed to build a tarball, as it
1.140 +contains all that is needed to rebuild the toolchain from scratch: toolchain
1.141 +components' sources,
1.142 +.B ct-ng
1.143 +configuration, but also all
1.144 +.B ct-ng
1.145 +scripts.
1.146 +."
1.147 +.SH SECURITY
1.148 +.B Don't run as root!
1.149 +Great care has been taken to avoid mistakes, but bug-free programs don't
1.150 +exist. During normal operation,
1.151 +.B ct-ng
1.152 +removes entire directories. If you run as root, and there is a bug or you
1.153 +mis-configured
1.154 +.BR ct-ng ,
1.155 +entire important directories could be removed (eg.
1.156 +.IR /usr ),
1.157 +although
1.158 +.B ct-ng
1.159 +will refuse to install in some well known critical directories.
1.160 +."
1.161 +.SH AUTHORS
1.162 +.MTO "yann.morin.1998@anciens.enib.fr" "Yann E. MORIN" ""
1.163 +.URL "http://ymorin.is-a-geek.org" "" ""
1.164 +reordered
1.165 +.B crosstool
1.166 +(see section titled
1.167 +.BR "SEE ALSO" )
1.168 +scripts to be more easily maintainable, added the Kconfig configurator, some
1.169 +patches.
1.170 +
1.171 +Please consult the file
1.172 +.I @@CT_DOCDIR@@/CREDITS
1.173 +for a list of contributors.
1.174 +."
1.175 +.SH SEE ALSO
1.176 +Please have a look at the
1.177 +.URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"