docs/ct-ng.1.in
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sat Jul 28 21:34:41 2007 +0000 (2007-07-28)
changeset 301 2be7232a73ac
parent 197 9383bf4a2e2e
child 306 1984d7bcea28
permissions -rw-r--r--
Bump version to 0.2.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 differents 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 triplet, 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 triplet they represent.
    61 ."
    62 .TP
    63 .B build
    64 Builds the configured toolchain.
    65 ."
    66 .TP
    67 .B liststeps
    68 Lists all build steps available (see 
    69 .BR ENVIRONMENT,
    70 below).
    71 ."
    72 .TP
    73 .B clean
    74 Remove files generated by
    75 .B crosstool-NG
    76 for itself (these are mostly the configurators' binaries).
    77 ."
    78 .TP
    79 .B distclean
    80 Same as
    81 .B clean
    82 , but also removes the toolchain build directory, the downloaded files and the
    83 .I .config
    84 configuration file. The generated toolchain is left untouched, as well as
    85 samples which are not removed.
    86 ."
    87 .TP
    88 .B regtest
    89 Calls the
    90 .B crosstool-NG
    91 regression test suite. All samples are build, and the regression test suite is
    92 run against every one of them.
    93 ."
    94 .TP
    95 .B updatetools
    96 Updates the
    97 .I config.guess
    98 and
    99 .I config.sub
   100 scripts. These scripts are used by
   101 .B crosstool-NG
   102 to canonicalise the machines' name (host, build and target machines).
   103 .TP
   104 .B tarball
   105 Builds a tarball of the generated toolchain, also saving the scripts from
   106 .B crosstool-NG
   107 that are needed to rebuild the target, and also saving the tarballs of the
   108 componnents that were used.
   109 ."
   110 .SH ENVIRONMENT
   111 .TP
   112 .B STOP, START
   113 Respectively stops and restarts the build just before this step. To restart a
   114 step, a previous build should have run at least to that step, or further.
   115 
   116 The list of steps is vailable with the action
   117 .BR liststeps .
   118 ."
   119 .SH EXIT VALUE
   120 The
   121 .B ct-ng
   122 frontend is in fact a
   123 .BR make (1)
   124 script. See the man page for
   125 .BR make (1)
   126 to have the meaning of the exit values.
   127 ."
   128 .SH BUGS
   129 As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to
   130 foresee how every parts of
   131 .B crosstool-NG
   132 are going to be installed. Each parts is needed to build a tarball, as it
   133 contains all that is needed to rebuild the toolchain from scratch: toolchain
   134 components' sources,
   135 .B crosstool-NG
   136 configuration, but also all
   137 .B crosstool-NG
   138 scripts.
   139 ."
   140 .SH SECURITY
   141 .B Don't run as root!
   142 Great care has been taken to avoid mistakes, but bug-free programs don't
   143 exist. During normal operation,
   144 .B crosstool-NG
   145 removes entire directories. If you run as root, and there is a bug or you
   146 mis-configured
   147 .BR crosstool-NG ,
   148 entire important directories could be removed (eg.
   149 .IR /usr ),
   150 although
   151 .B crosstool-NG
   152 will refuse to install in some well known critical directories.
   153 ."
   154 .SH AUTHORS
   155 .MTO "yann.morin.1998@anciens.enib.fr" "Yann E. MORIN" ""
   156 .URL "http://ymorin.is-a-geek.org" "" ""
   157 reordered
   158 .B crosstool
   159 (see section titled
   160 .BR "SEE ALSO" )
   161 scripts to be more easily maintainable, added the Kconfig configurator, some
   162 patches, support for linux headers installation, and support for uClibc-based
   163 toolchains.
   164 
   165 Please consult the file
   166 .I @@CT_DOCDIR@@/CREDITS
   167 for a list of contributors.
   168 ."
   169 .SH SEE ALSO
   170 You can find more in-depth documentation in
   171 .IR @@CT_DOCDIR@@/overview.txt .
   172 
   173 Please have a look at the
   174 .URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"