docs/ct-ng.1.in
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Fri Jan 15 22:21:12 2010 +0100 (2010-01-15)
changeset 1738 4baa6a9f6415
parent 335 f0d84f1d4c93
child 2227 5158aa602e58
permissions -rw-r--r--
libc/uClibc: rename patches for 0.9.30.2
     1 ." crosstool-NG man page
     2 ." Copyright 2007 Yann E. MORIN
     3 ." Licensed under the Creative Commons BY-SA, v2.5
     4 ."
     5 ." Beautifying URLs
     6 .mso www.tmac
     7 ."
     8 .TH crosstool-NG 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
     9 ."
    10 ."
    11 .SH NAME
    12 ct-ng, crosstool-NG \- Build cross-toolchains
    13 ."
    14 ."
    15 .SH SYNOPSIS
    16 .B ct-ng ACTION
    17 ."
    18 ."
    19 .SH DESCRIPTION
    20 Building a cross-toolchain can be a real pain.
    21 .PP
    22 .B crosstool-NG
    23 makes it easy to build cross-toolchains, and allows you to take all the juice
    24 out of your target by configuring the different components of the toolchain
    25 accordingly to the targeted processor.
    26 ."
    27 ."
    28 .SH ACTIONS
    29 Here are the most commonly used actions. For other actions, please see
    30 .I @@CT_DOCDIR@@/overview.txt
    31 .TP
    32 .B help
    33 Prints a little help text.
    34 ."
    35 .TP
    36 .B menuconfig
    37 Configures
    38 .B crosstool-NG
    39 using a configurator menu very similar to that of the Linux kernel.
    40 ."
    41 .TP
    42 .B oldconfig
    43 Apply options found in an existing
    44 .I .config
    45 file, and ask for newer options if there are any.
    46 ."
    47 .TP
    48 .B saveconfig
    49 Save the current
    50 .B crosstool-NG
    51 configuration, and associated components' config files, into a sample. Samples
    52 are saved in their own sub-directory, named after the target's tuple, in the
    53 .I samples
    54 sub-directory of the current directory.
    55 If that was not clear:
    56 .I `pwd`/samples/${CT_TARGET}/
    57 
    58 Samples can be later recalled by calling
    59 .B ct-ng
    60 with the target tuple they represent.
    61 ."
    62 .TP
    63 .B build
    64 Builds the configured toolchain.
    65 ."
    66 .TP
    67 .B clean
    68 Remove files generated by
    69 .B crosstool-NG
    70 for itself (these are mostly the configurators' binaries).
    71 ."
    72 .TP
    73 .B distclean
    74 Same as
    75 .B clean
    76 , but also removes the toolchain build directory, the downloaded files and the
    77 .I .config
    78 configuration file. The generated toolchain is left untouched, as well as
    79 samples which are not removed.
    80 ."
    81 .TP
    82 .B regtest
    83 Calls the
    84 .B crosstool-NG
    85 regression test suite. All samples are build, and the regression test suite is
    86 run against every one of them.
    87 ."
    88 .TP
    89 .B updatetools
    90 Updates the
    91 .I config.guess
    92 and
    93 .I config.sub
    94 scripts. These scripts are used by
    95 .B crosstool-NG
    96 to canonicalise the machines' name (host, build and target machines).
    97 .TP
    98 .B tarball
    99 Builds a tarball of the generated toolchain, also saving the scripts from
   100 .B crosstool-NG
   101 that are needed to rebuild the target, and also saving the tarballs of the
   102 componnents that were used.
   103 ."
   104 .SH ENVIRONMENT
   105 .TP
   106 .B STOP, START
   107 Respectively stops and restarts the build just before this step. To restart a
   108 step, a previous build should have run at least to that step, or further.
   109 
   110 The list of steps is vailable with the action
   111 .BR list-steps .
   112 ."
   113 .SH EXIT VALUE
   114 The
   115 .B ct-ng
   116 frontend is in fact a
   117 .BR make (1)
   118 script. See the man page for
   119 .BR make (1)
   120 to have the meaning of the exit values.
   121 ."
   122 .SH BUGS
   123 As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to
   124 foresee how every parts of
   125 .B crosstool-NG
   126 are going to be installed. Each parts is needed to build a tarball, as it
   127 contains all that is needed to rebuild the toolchain from scratch: toolchain
   128 components' sources,
   129 .B crosstool-NG
   130 configuration, but also all
   131 .B crosstool-NG
   132 scripts.
   133 ."
   134 .SH SECURITY
   135 .B Don't run as root!
   136 Great care has been taken to avoid mistakes, but bug-free programs don't
   137 exist. During normal operation,
   138 .B crosstool-NG
   139 removes entire directories. If you run as root, and there is a bug or you
   140 mis-configured
   141 .BR crosstool-NG ,
   142 entire important directories could be removed (eg.
   143 .IR /usr ),
   144 although
   145 .B crosstool-NG
   146 will refuse to install toolchains in some well known critical directories.
   147 ."
   148 .SH AUTHORS
   149 Please consult the file
   150 .I @@CT_DOCDIR@@/CREDITS
   151 for a list of contributors.
   152 ."
   153 .SH SEE ALSO
   154 You can find more in-depth documentation in
   155 .IR @@CT_DOCDIR@@/overview.txt .
   156 
   157 Please have a look at the
   158 .URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"