crosstool-ng: docs/ct-ng.1.in@223c84ec2d90

     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 ct-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 ct-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 ct-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 ct-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}/

    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. If

    65 .B ct-ng

    66 is called without action, then

    67 .B build

    68 is impiled.

    69 ."

    70 .TP

    71 .B liststeps

    72 Lists all build steps available (see

    73 .BR ENVIRONMENT,

    74 below).

    75 ."

    76 .TP

    77 .B clean

    78 Remove files generated by

    79 .B ct-ng

    80 for itself (these are mostly the configurators' binaries).

    81 ."

    82 .TP

    83 .B distclean

    84 Same as

    85 .B clean

    86 , but also removes the toolchain build directory, the downloaded files and the

    87 .I .config

    88 configuration file. The generated toolchain is left untouched, as well as

    89 samples which are not removed.

    90 ."

    91 .TP

    92 .B regtest

    93 Calls the

    94 .B ct-ng

    95 regression test suite. All samples are build, and the regression test suite is

    96 run against every one of them.

    97 ."

    98 .TP

    99 .B updatetools

   100 Updates the

   101 .I config.guess

   102 and

   103 .I config.sub

   104 scripts. These scripts are used by

   105 .B ct-ng

   106 to canonicalise the machines' name (host, build and target machines).

   107 .TP

   108 .B tarball

   109 Builds a tarball of the generated toolchain, also saving the scripts from

   110 .B ct-ng

   111 that are needed to rebuild the target, and also saving the tarballs of the

   112 componnents that were used.

   113 ."

   114 .SH ENVIRONMENT

   115 .TP

   116 .B STOP, START

   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

   121 .BR liststeps .

   122 ."

   123 .SH EXIT VALUE

   124 The

   125 .B ct-ng

   126 frontend is in fact a

   127 .BR make (1)

   128 script. See the man page for

   129 .BR make (1)

   130 to have the meaning of the exit values.

   131 ."

   132 .SH BUGS

   133 As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to

   134 foresee how every parts of

   135 .B ct-ng

   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

   138 components' sources,

   139 .B ct-ng

   140 configuration, but also all

   141 .B ct-ng

   142 scripts.

   143 ."

   144 .SH SECURITY

   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,

   148 .B ct-ng

   149 removes entire directories. If you run as root, and there is a bug or you

   150 mis-configured

   151 .BR ct-ng ,

   152 entire important directories could be removed (eg.

   153 .IR /usr ),

   154 although

   155 .B ct-ng

   156 will refuse to install in some well known critical directories.

   157 ."

   158 .SH AUTHORS

   159 .MTO "yann.morin.1998@anciens.enib.fr" "Yann E. MORIN" ""

   160 .URL "http://ymorin.is-a-geek.org" "" ""

   161 reordered

   162 .B crosstool

   163 (see section titled

   164 .BR "SEE ALSO" )

   165 scripts to be more easily maintainable, added the Kconfig configurator, some

   166 patches.

   168 Please consult the file

   169 .I @@CT_DOCDIR@@/CREDITS

   170 for a list of contributors.

   171 ."

   172 .SH SEE ALSO

   173 Please have a look at the

   174 .URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"

author	"Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
	Sun Jul 01 19:04:20 2007 +0000 (2007-07-01)
changeset 182	223c84ec2d90
child 197	9383bf4a2e2e
permissions	-rw-r--r--