---
name: "ltsp-update-image"
section: "8"
platform: "linux"
package: "ltsp-server"
version: "5.18.12-3"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/ltsp-update-image"
---

# ltsp-update-image(8)

generate an NBD image from an LTSP chroot

## NAME

ltsp-update-image - generate an NBD image from an LTSP chroot

## SYNOPSIS

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

## DESCRIPTION

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.

## AVAILABILITY

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

## 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.

## 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*.

## SEE ALSO

[**ltsp-build-client**(8)](/ltsp-build-client/8.md), [**ltsp-update-kernels**(8)](/ltsp-update-kernels/8.md), [**ltsp-update-sshkeys**(8)](/ltsp-update-sshkeys/8.md), [**mksquashfs**(1)](/mksquashfs/1.md), [**nbd-server**(1)](/nbd-server/1.md)