Add documentation for -A and -U
[grml-live.git] / docs / grml-live.txt
index 8cc0955..966f8ac 100644 (file)
@@ -12,7 +12,8 @@ Synopsis
 
 grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g
 <grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
-<suite>] [-t <template_directory>] [-v <version_number>] [-bBFnNquVz]
+<suite>] [-t <template_directory>] [-v <version_number>] [-U <username>] [
+-AbBFnNquVz]
 
 CAUTION: Please check out <<current_state,the 'Current state of grml-live with
 squashfs-tools and kernel' section>> for details about current state of involved
@@ -54,6 +55,11 @@ for details).
 Options
 -------
 
+  -A::
+
+Clean up output directories before attempting the build. Packs the chroot
+into a tar archive, and removes chroot and iso build directories before exiting.
+
   -a **ARCHITECTURE**::
 
 Use the specified architecture instead of the currently running one.  This
@@ -206,6 +212,10 @@ Specify place of the templates used for building the ISO. By default
 Update existing chroot instead of rebuilding it from scratch. This option is
 based on the softupdate feature of FAI.
 
+  -U **USERNAME**::
+
+Sets ownership of all build output files to specified username before exiting.
+
   -v **VERSION_NUMBER**::
 
 Specify version number of the release.
@@ -464,7 +474,7 @@ The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
 default being /var/log/fai/grml/.
 
 If you are using the grml-live buildd you will find the logs of the grml-live
-run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
+run at /var/log/grml-buildd.log.
 
 If you want to store build information in a database just install the
 grml-live-db Debian package. Further details available in the grml-live-db
@@ -835,18 +845,6 @@ points to the specified directory instead of using /etc/grml/fai and all the
 configuration files, scripts and hooks will be taken from your
 '$GRML_FAI_CONFIG' directory.
 
-[[fai-on-etch]]
-Help, I'm using Debian etch and I don't have FAI version >3.2
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-  wget http://fai-project.org/download/etch/fai-client_3.2.8_all.deb \
-       http://fai-project.org/download/etch/fai-server_3.2.8_all.deb \
-       http://fai-project.org/download/etch/fai-doc_3.2.8_all.deb
-  dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb
-
-or check out the link:http://fai-project.org/[FAI-homepage] for
-further details.
-
 [[how-to-debug]]
 I've problems with the build process. How to start debugging?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -940,6 +938,9 @@ taken as first entry in the generated sources.list so it's preferred over
 non-local mirrors. Using a fallback mirror (via providing several mirrors in
 GRML_LIVE_SOURCES as used by default) is a recommended setting.
 
+If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:
+APT_PROXY="http://localhost:3142/"
+
 [[add-additional-debian-packages]]
 How do I add additional Debian package(s) to my CD/ISO?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1020,25 +1021,20 @@ or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
 Existing base.tgz can be found at http://daily.grml.org/
 
 [[apt-cacher]]
-Set up apt-cacher / apt-cacher-ng for use with grml-live
+Set up apt-cacher-ng for use with grml-live
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
+Make sure /etc/grml/grml-live.local provides according APT_PROXY and
 FAI_DEBOOTSTRAP:
 
-  # cat /etc/grml/grml-live.conf
+  # cat /etc/grml/grml-live.local
   [...]
-  GRML_LIVE_SOURCES="
-  deb http://localhost:3142/deb.grml.org grml-stable  main
-  deb http://localhost:3142/deb.grml.org grml-testing main
-  deb http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free
-  "
+  APT_PROXY="http://localhost:3142/"
   [...]
   FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"
 
-Make sure apt-cacher / apt-cacher-ng is running ('/etc/init.d/apt-cacher
-restart' or '/etc/init.d/apt-cacher-ng restart'). That's it.  All downloaded
-files will be cached in /var/cache/apt-cacher/ or /var/cache/apt-cacher-ng then.
+Make sure apt-cacher-ng is running ('/etc/init.d/apt-cacher-ng restart').
+That's it.  All downloaded files will be cached in /var/cache/apt-cacher-ng then.
 
 [[approx]]
 Set up approx for use with grml-live