ltsp-update-image(8)

ltsp-update-image8

Generate an nbd image from an ltsp chroot

Usage

ltsp-update-image [OPTION] [CHROOT ...]

Overview

Generates a compressed squashfs NBD image from an LTSP chroot and exports it with nbd-server. Chroot can be a full path or a subdirectory of the LTSP base directory, and it defaults to the host architecture if unset.

Options

-b, --base[=PATH]

The LTSP base directory Defaults to /opt/ltsp if unspecified.

-c, --cleanup

Temporarily remove user accounts, logs, caches etc from the chroot before exporting the image. The chroot arch is required to be compatible with the server arch.

--compression[=TYPE]

Compress the resulting image with TYPE (gzip, lzo, xz, lz4). If unspecified, use mksquashfs default.

-e, --exclude[=LIST]

List of dirs/files to exclude from the image. This is in addition to /etc/ltsp/ltsp-update-image.excludes.

-f, --config-nbd

Generate appropriate nbd-server configuration files. It's automatically set if NFS isn't used or if other LTSP generated nbd-server configuration files already exist.

-h, --help

Displays the ltsp-update-image help message.

-m, --no-compress

Don't compress the generated image.

-n, --no-backup

Don't backup chroot.img to chroot.img.old.

-r, --revert

Swap chroot.img with chroot.img.old and update kernels.

--version

Output version information and exit.

Files

/etc/ltsp/<tool>.conf: Upon execution the tool will read a configuration file to override built-in defaults.

Values are NAME="VALUE" pairs, with # representing commented lines. most commandline options have an equivalent. an example Debian based system with an alternate base location, architecture, and distribution:

# set alternate default location for ltsp chroot (--base)
BASE="/srv/ltsp"
# build an amd64 chroot by default (--arch)
ARCH="amd64"
# build a Debian sid environment (--dist)
DIST="sid"

/etc/ltsp/ltsp-server.conf: Each LTSP server tool will read a generic configuration file. This file is typically used for setting BASE, TFTP_DIRS and TFTP_BOOT_DIR. These settings are overwritten by those set in specific tool configs.

Releases

6 releases since Debian 5.0 (Lenny); the text changed 5 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10

--base since Debian 8 (Jessie); --cleanup since Debian 7 (Wheezy); --compression since Debian 10 (Buster); --config-nbd since Debian 7 (Wheezy); --exclude since Debian 8 (Jessie); --help since Debian 7 (Wheezy); --no-backup since Debian 7 (Wheezy); --no-compress since Debian 7 (Wheezy); --revert since Debian 7 (Wheezy); --version since Debian 8 (Jessie); -b since Debian 8 (Jessie); -c since Debian 7 (Wheezy); -e since Debian 8 (Jessie); -f since Debian 7 (Wheezy); -h since Debian 7 (Wheezy); -m since Debian 7 (Wheezy); -n since Debian 7 (Wheezy); -r since Debian 7 (Wheezy).

Availability

Part of the ltsp package and the latest versions are available in source form from https://launchpad.net/products/ltsp.

Author

Autogenerated from the script source code with help2man. Distributed under the terms of the GNU General Public License version 2 or any later version.

Reporting bugs

Report bugs to https://bugs.launchpad.net/ltsp.

From ltsp-server 5.18.12-3 in Debian 10 (Buster). Parsed by carta from the page's man source.