.nh
.TH LTSP 8 "2023-08-19" "LTSP 23.02-1+deb12u1" "LTSP Manual"
.SH NAME
.PP
\fBltsp\fP - entry point to Linux Terminal Server Project applets

.SH SYNOPSIS
.PP
\fBltsp\fP [\fB-b\fP \fIbase-dir\fP] [\fB-h\fP] [\fB-m\fP \fIhome-dir\fP] [\fB-o\fP \fIoverwrite\fP] [\fB-t\fP \fItftp-dir\fP] [\fB-V\fP] [\fIapplet\fP] [\fIapplet-options\fP]

.SH DESCRIPTION
.PP
Run the specified LTSP \fIapplet\fP with \fIapplet-options\fP\&. To get help with applets
and their options, run `\fBman ltsp\fP \fIapplet\fP` or `\fBltsp --help\fP \fIapplet\fP`\&.

.SH APPLETS
.PP
The following applets are currently defined:

.RS
.IP \(bu 2
\fBdnsmasq\fP: configure dnsmasq for LTSP
.IP \(bu 2
\fBimage\fP: generate a squashfs image from an image source
.IP \(bu 2
\fBinfo\fP: gather support information about the LTSP installation
.IP \(bu 2
\fBinitrd\fP: create the ltsp.img initrd add-on
.IP \(bu 2
\fBipxe\fP: install iPXE binaries and configuration in TFTP
.IP \(bu 2
\fBkernel\fP: copy the kernel and initrd from an image to TFTP
.IP \(bu 2
\fBnfs\fP: configure NFS exports for LTSP

.RE

.PP
LTSP clients also have some additional applets, like \fBinitrd-bottom\fP,
\fBinit\fP and \fBlogin\fP, but they're not runnable by the user.

.SH OPTIONS
.PP
LTSP directories can be configured by passing one or more of the following
parameters, but it's recommended that an /etc/ltsp/ltsp.conf configuration
file is created instead, so that you don't have to pass them in each ltsp
command.

.TP
\fB-b\fP, \fB--base-dir\fP=\fI/srv/ltsp\fP
This is where the chroots, squashfs images and virtual machine symlinks are;
so when you run \fB\fCltsp kernel img_name\fR, it will search either for a squashfs
image named \fB/srv/ltsp/images/img_name.img\fP, or for a chroot named
\fB/srv/ltsp/img_name\fP, if it's a directory that contains /proc. Additionally,
\fB\fCltsp image img_name\fR will also search for a symlink to a VM disk named
\fB/srv/ltsp/img_name.img\fP\&. $BASE_DIR is exported read-only by NFSv3, so do
not put sensitive data there.

.TP
\fB-h\fP, \fB--help\fP
Display a help message.

.TP
\fB-m\fP, \fB--home-dir\fP=\fI/home\fP
The default method of making /home available to LTSP clients is SSHFS.
In some cases security isn't an issue, and sysadmins prefer the insecure
NFSv3 speed over SSHFS. $HOME_DIR is used by \fB\fCltsp nfs\fR to export the correct
directory, if it's different to /home, and by LTSP clients to mount it.

.TP
\fB-o\fP, \fB--overwrite\fP[=\fI0|1\fP]
Overwrite existing files. Defaults to 1 as administrators are not supposed
to manually edit LTSP autogenerated files, but maintain local content into
separate files (e.g. /etc/exports.d/local.exports). If you manually maintain
ltsp.ipxe, it might be a good idea to set OVERWRITE=0 in ltsp.conf.

.TP
\fB-t\fP, \fB--tftp-dir\fP=\fI/srv/tftp\fP
LTSP places the kernels, initrds and iPXE files in /srv/tftp/ltsp, to be
retrieved by the clients via the TFTP protocol. The TFTP server of dnsmasq
and tftpd-hpa are configured to use /srv/tftp as the TFTP root.

.TP
\fB-V\fP, \fB--version\fP
Display the version information.

.SH FILES
.TP
\fB/etc/ltsp/ltsp.conf\fP
All the long options can also be specified as variables in the \fBltsp.conf\fP
configuration file in UPPER_CASE, using underscores instead of hyphens.

.SH ENVIRONMENT
.PP
All the long options can also be specified as environment variables in
UPPER_CASE, for example:

.PP
.RS

.nf
BASE_DIR=/opt/ltsp ltsp kernel ...
.fi
.RE

.SH EXAMPLES
.PP
The following are the typical commands to install and maintain LTSP in
chrootless mode:

.PP
.RS

.nf
# To install:
ltsp image /
ltsp dnsmasq
ltsp nfs
ltsp ipxe

# To update the exported image, after changes in the server software:
ltsp image /
.fi
.RE

.PP
The following are the typical commands to provide an additional x86_32
image, assuming one uses VirtualBox. If you specifically name it x86_32,
then the ltsp.ipxe code automatically prefers it for 32bit clients:

.PP
.RS

.nf
ln -rs $HOME/VirtualBox\\ VMs/x86_32/x86_32-flat.vmdk /srv/ltsp/x86_32.img
ltsp image x86_32
ltsp ipxe
.fi
.RE

.SH COPYRIGHT
.PP
Copyright 2019-2022 the LTSP team, see AUTHORS.

.SH SEE ALSO
.PP
\fBltsp.conf\fP(5), \fBltsp-dnsmasq\fP(8), \fBltsp-image\fP(8),
\fBltsp-info\fP(8), \fBltsp-initrd\fP(8), \fBltsp-ipxe\fP(8), \fBltsp-kernel\fP(8),
\fBltsp-nfs\fP(8), \fBltsp-remoteapps\fP(8)

.PP
Online documentation is available on https://ltsp.org