summaryrefslogtreecommitdiff
path: root/docs/ct-ng.1.in
diff options
context:
space:
mode:
authorYann E. MORIN" <yann.morin.1998@anciens.enib.fr>2007-07-02 19:40:54 (GMT)
committerYann E. MORIN" <yann.morin.1998@anciens.enib.fr>2007-07-02 19:40:54 (GMT)
commit9265403b8bfd3c1f20f81a52a3f2c6f7711dffb5 (patch)
treea1191f479d39cf9db1858fa4ebaee6c9aac68601 /docs/ct-ng.1.in
parent928ccb1f4172c14c01991ca64783c8ac0aeecbaf (diff)
Get rid of eclipse fiels once and for all.
Homogenise the references to crosstool-NG: - the project is named "crosstool-NG" - the front-end is named "ct-ng" - don't use shortcuts (such as "ct-ng" to stand for "crosstool-NG") Default action is to print help. Don't speak of make rules when dumping help, just speak of actions.
Diffstat (limited to 'docs/ct-ng.1.in')
-rw-r--r--docs/ct-ng.1.in38
1 files changed, 17 insertions, 21 deletions
diff --git a/docs/ct-ng.1.in b/docs/ct-ng.1.in
index ac033dc..fdf51e2 100644
--- a/docs/ct-ng.1.in
+++ b/docs/ct-ng.1.in
@@ -1,15 +1,15 @@
-." crosstool-ng man page
+." 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"
+.TH crosstool-NG 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
."
."
.SH NAME
-ct-ng, crosstool-ng \- Build cross-toolchains
+ct-ng, crosstool-NG \- Build cross-toolchains
."
."
.SH SYNOPSIS
@@ -19,7 +19,7 @@ ct-ng, crosstool-ng \- Build cross-toolchains
.SH DESCRIPTION
Building a cross-toolchain can be a real pain.
.PP
-.B ct-ng
+.B crosstool-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.
@@ -35,7 +35,7 @@ Prints a little help text.
.TP
.B menuconfig
Configures
-.B ct-ng
+.B crosstool-NG
using a configurator menu very similar to that of the Linux kernel.
."
.TP
@@ -47,7 +47,7 @@ file, and ask for newer options if there are any.
.TP
.B saveconfig
Save the current
-.B ct-ng
+.B crosstool-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
@@ -61,11 +61,7 @@ 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.
+Builds the configured toolchain.
."
.TP
.B liststeps
@@ -76,7 +72,7 @@ below).
.TP
.B clean
Remove files generated by
-.B ct-ng
+.B crosstool-NG
for itself (these are mostly the configurators' binaries).
."
.TP
@@ -91,7 +87,7 @@ samples which are not removed.
.TP
.B regtest
Calls the
-.B ct-ng
+.B crosstool-NG
regression test suite. All samples are build, and the regression test suite is
run against every one of them.
."
@@ -102,12 +98,12 @@ Updates the
and
.I config.sub
scripts. These scripts are used by
-.B ct-ng
+.B crosstool-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
+.B crosstool-NG
that are needed to rebuild the target, and also saving the tarballs of the
componnents that were used.
."
@@ -132,27 +128,27 @@ 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
+.B crosstool-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
+.B crosstool-NG
configuration, but also all
-.B ct-ng
+.B crosstool-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
+.B crosstool-NG
removes entire directories. If you run as root, and there is a bug or you
mis-configured
-.BR ct-ng ,
+.BR crosstool-NG ,
entire important directories could be removed (eg.
.IR /usr ),
although
-.B ct-ng
+.B crosstool-NG
will refuse to install in some well known critical directories.
."
.SH AUTHORS