improve "lxc-create -t debian -h" help text

- document environment variables - add missing --packages switch to command line - describe how to pass template options to lxc-create (since lxc-create -h doesn't tell you) - render help text in the same pretty format as lxc-create does Signed-off-by: Tomáš Posíšek <tpo_deb@sourcepole.ch> Acked-by: Stéphane Graber <stgraber@ubuntu.com>

improve "lxc-create -t debian -h" help text
9cbffb9f · Tomas Pospisek · Stéphane Graber · 46cd2845 · 9cbffb9f
Commit 9cbffb9f authored Jan 25, 2015 by Tomas Pospisek Committed by Stéphane Graber Jan 25, 2015
Hide whitespace changes
Inline Side-by-side

Showing with 32 additions and 7 deletions

lxc-debian.in templates/lxc-debian.in +32 -7

No files found.
--- a/templates/lxc-debian.in
+++ b/templates/lxc-debian.in
@@ -430,13 +430,38 @@ clean()
 usage()
 {
    cat <<EOF
-$1 -h|--help -p|--path=<path> [-a|--arch] [-c|--clean] [--mirror=<mirror>] [-r|--release=<release>] [--security-mirror=<security mirror>]
+Template specific options can be passed to lxc-create after a '--' like this:
-clean: purge the download cache after installation
-arch: the container architecture (e.g. amd64): defaults to host arch
+  lxc-create --name=NAME [-lxc-create-options] -- [-template-options]
-release: the debian release (e.g. wheezy): defaults to current stable
-mirror: debain mirror to use during installation
+Usage: $1 -h|--help -p|--path=<path> [-c|--clean] [-a|--arch=<arch>] [-r|--release=<release>]
-security mirror: debain mirror to use for security updates
+                                     [--mirror=<mirror>] [--security-mirror=<security mirror>]
-packages: list of packages to add comma separated
+                                     [--package=<package_name1,package_name2,...>]
+Options :
+  -h, --help             print this help text
+  -p, --path=PATH        directory where config and rootfs of this VM will be kept
+  -a, --arch=ARCH        The container architecture. Can be one of: i686, x86_64,
+                         amd64, armhf, armel, powerpc. Defaults to host arch.
+  -r, --release=RELEASE  Debian release. Can be one of: squeeze, wheezy, jessie, sid.
+                         Defaults to current stable.
+  --mirror=MIRROR        Debian mirror to use during installation. Overrides the MIRROR
+                         environment variable (see below).
+  --security-mirror=SECURITY_MIRROR
+                         Debian mirror to use for security updates. Overrides the
+                         SECURITY_MIRROR environment variable (see below).
+  --packages=PACKAGE_NAME1,PACKAGE_NAME2,...
+                         List of additional packages to install. Comma separated, without space.
+  -c, --clean            only clean up the cache and terminate
+Environment variables:
+  MIRROR                 The Debian package mirror to use. See also the --mirror switch above.
+                         Defaults to '$MIRROR'
+  SECURITY_MIRROR        The Debian package security mirror to use. See also the --security-mirror switch above.
+                         Defaults to '$SECURITY_MIRROR'
 EOF
    return 0
 }