summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ct-ng.1.in87
1 files changed, 35 insertions, 52 deletions
diff --git a/docs/ct-ng.1.in b/docs/ct-ng.1.in
index 65a0b0e..4630f30 100644
--- a/docs/ct-ng.1.in
+++ b/docs/ct-ng.1.in
@@ -1,21 +1,21 @@
-." crosstool-NG man page
-." Copyright 2007 Yann E. MORIN
-." Licensed under the Creative Commons BY-SA, v2.5
-."
-." Beautifying URLs
+.\" crosstool-NG man page
+.\" Copyright 2007 Yann E. MORIN
+.\" Licensed under the Creative Commons BY-SA, v2.5
+.\"
+.\" Beautifying URLs
.mso www.tmac
-."
+.\"
.TH crosstool-NG 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
-."
-."
+.\"
+.\"
.SH NAME
@@CT_PROG_NAME@@, crosstool-NG \- Build cross-toolchains
-."
-."
+.\"
+.\"
.SH SYNOPSIS
.B @@CT_PROG_NAME@@ ACTION
-."
-."
+.\"
+.\"
.SH DESCRIPTION
Building a cross-toolchain can be a real pain.
.PP
@@ -23,27 +23,28 @@ Building a cross-toolchain can be a real pain.
makes it easy to build cross-toolchains, and allows you to take all the juice
out of your target by configuring the different components of the toolchain
according to the targeted processor.
-."
-."
+.\"
+.\"
.SH ACTIONS
-Here are the most commonly used actions. For other actions, please see
-.I "@@CT_DOCDIR@@/0 - Table of content.txt"
+Here are the most commonly used actions. For other actions, please see the
+documentation in
+.I @@CT_DOCDIR@@
.TP
.B help
Prints a little help text.
-."
+.\"
.TP
.B menuconfig
Configures
.B crosstool-NG
using a configurator menu very similar to that of the Linux kernel.
-."
+.\"
.TP
.B oldconfig
Apply options found in an existing
.I .config
file, and ask for newer options if there are any.
-."
+.\"
.TP
.B saveconfig
Save the current
@@ -51,14 +52,10 @@ Save the current
configuration, and associated components' config files, into a sample. Samples
are saved in their own sub-directory, named after the target's tuple, in the
.I samples
-sub-directory of the current directory.
-If that was not clear:
-.I `pwd`/samples/${CT_TARGET}/
-
-Samples can be later recalled by calling
+sub-directory of the current directory. Samples can be later recalled by calling
.B @@CT_PROG_NAME@@
with the target tuple they represent.
-."
+.\"
.TP
.B savedefconfig
Save the current configuration to a mini-defconfig file, that contains only
@@ -85,7 +82,7 @@ is saved. Config files for the components are
saved. Use
.B saveconfig
for that
-."
+.\"
.TP
.B defconfig
Configure
@@ -99,17 +96,17 @@ unless the variable
is set, in which case the mini-defconfig will be read from the file referenced
by
.B $DEFCONFIG
-."
+.\"
.TP
.B build
Builds the configured toolchain.
-."
+.\"
.TP
.B clean
Remove files generated by
.B crosstool-NG
for itself (these are mostly the configurators' binaries).
-."
+.\"
.TP
.B distclean
Same as
@@ -118,14 +115,14 @@ Same as
.I .config
configuration file. The generated toolchain is left untouched, as well as
samples which are not removed.
-."
+.\"
.TP
.B regtest
Calls the
.B crosstool-NG
regression test suite. All samples are build, and the regression test suite is
run against every one of them.
-."
+.\"
.TP
.B updatetools
Updates the
@@ -135,7 +132,7 @@ and
scripts. These scripts are used by
.B crosstool-NG
to canonicalise the machines' name (host, build and target machines).
-."
+.\"
.SH ENVIRONMENT
.TP
.B STOP, RESTART
@@ -144,7 +141,7 @@ step, a previous build should have run at least to that step, or further.
The list of steps is viewable with the action
.BR list-steps .
-."
+.\"
.SH EXIT VALUE
The
.B @@CT_PROG_NAME@@
@@ -153,19 +150,7 @@ frontend is in fact a
script. See the man page for
.BR make (1)
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 all parts of
-.B crosstool-NG
-are going to be installed. Each part is needed to build a tarball, as it
-contains all that is needed to rebuild the toolchain from scratch: toolchain
-components' sources,
-.B crosstool-NG
-configuration, but also all
-.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
@@ -179,15 +164,13 @@ entire important directories could be removed (eg.
although
.B crosstool-NG
will refuse to install toolchains in some well known critical directories.
-."
+.\"
.SH AUTHORS
-Please consult the file
-.I @@CT_DOCDIR@@/A - Credits.txt
-for a list of contributors.
-."
+Yann E. MORIN and a lot of contributors.
+.\"
.SH SEE ALSO
You can find more in-depth documentation in
-.IR "@@CT_DOCDIR@@/0 - Table of content.txt" .
+.IR "@@CT_DOCDIR@@" .
Please have a look at the
.URL "http://www.kegel.com/crosstool" "original crosstool" " by Daniel KEGEL"