.\" generated with Ronn-NG/v0.8.0
.\" http://github.com/apjanke/ronn-ng/tree/0.8.0
.TH "LTSP" "8" "October 2019" "LTSP 19.10-1" "LTSP Manual"
.SH "NAME"
\fBltsp\fR \- entry point to Linux Terminal Server Project applets
.SH "SYNOPSIS"
\fBltsp\fR [\fB\-b\fR \fIbase\-dir\fR] [\fB\-h\fR] [\fB\-m\fR \fIhome\-dir\fR] [\fB\-o\fR] [\fB\-t\fR \fItftp\-dir\fR] [\fB\-V\fR] [\fIapplet\fR] [\fIapplet\-options\fR]
.SH "DESCRIPTION"
Run the specified LTSP \fIapplet\fR with \fIapplet\-options\fR\. To get help with applets and their options, run `\fBman ltsp\fR \fIapplet\fR` or `\fBltsp \-\-help\fR \fIapplet\fR`\.
.SH "APPLETS"
The following applets are currently defined:
.IP "\[ci]" 4
\fBdnsmasq\fR: configure dnsmasq for LTSP
.IP "\[ci]" 4
\fBimage\fR: generate a squashfs image from an image source
.IP "\[ci]" 4
\fBinfo\fR: gather support information about the LTSP installation
.IP "\[ci]" 4
\fBinitrd\fR: create the ltsp\.img initrd add\-on
.IP "\[ci]" 4
\fBipxe\fR: install iPXE binaries and configuration in TFTP
.IP "\[ci]" 4
\fBkernel\fR: copy the kernel and initrd from an image to TFTP
.IP "\[ci]" 4
\fBnfs\fR: configure NFS exports for LTSP
.IP "" 0
.P
LTSP clients also have some additional applets, like \fBinitrd\-bottom\fR, \fBinit\fR and \fBlogin\fR, but they\'re not runnable by the user\.
.SH "OPTIONS"
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\fR, \fB\-\-base\-dir=\fR\fI/srv/ltsp\fR
This is where the chroots, squashfs images and virtual machine symlinks are; so when you run \fBltsp kernel img_name\fR, it will search either for a squashfs image named \fB/srv/ltsp/images/img_name\.img\fR, or for a chroot named \fB/srv/ltsp/img_name\fR, if it\'s a directory that contains /proc\. Additionally, \fBltsp image img_name\fR will also search for a symlink to a VM disk named \fB/srv/ltsp/img_name\.img\fR\. $BASE_DIR is exported read\-only by NFSv3, so do not put sensitive data there\.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a help message\.
.TP
\fB\-m\fR, \fB\-\-home\-dir=\fR\fI/home\fR
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 \fBltsp nfs\fR to export the correct directory, if it\'s different to /home, and by LTSP clients to mount it\.
.TP
\fB\-o\fR, \fB\-\-overwrite\fR
Overwrite all existing files\. Usually applets refuse to overwrite configuration files that may have been modified by the user, like ltsp\.ipxe\.
.TP
\fB\-t\fR, \fB\-\-tftp\-dir=\fR\fI/srv/tftp\fR
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\fR, \fB\-\-version\fR
Display the version information\.
.SH "FILES"
.TP
\fB/etc/ltsp/ltsp\.conf\fR
All the long options can also be specified as variables in the \fBltsp\.conf\fR configuration file in UPPER_CASE, using underscores instead of hyphens\.
.SH "ENVIRONMENT"
All the long options can also be specified as environment variables in UPPER_CASE, for example:
.IP "" 4
.nf
BASE_DIR=/opt/ltsp ltsp kernel \|\.\|\.\|\.
.fi
.IP "" 0
.SH "EXAMPLES"
The following are the typical commands to install and maintain LTSP in chrootless mode:
.IP "" 4
.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
.IP "" 0
.P
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:
.IP "" 4
.nf
ln \-rs $HOME/VirtualBox\e VMs/x86_32/x86_32\-flat\.vmdk /srv/ltsp/x86_32\.img
ltsp image x86_32
ltsp \-o ipxe  # note, this overwrites ltsp\.ipxe
.fi
.IP "" 0
.SH "COPYRIGHT"
Copyright 2019 the LTSP team, see AUTHORS
.SH "SEE ALSO"
\fBltsp\fR(8), \fBltsp\.conf\fR(5), \fBltsp\-dnsmasq\fR(8), \fBltsp\-image\fR(8), \fBltsp\-info\fR(8), \fBltsp\-initrd\fR(8), \fBltsp\-ipxe\fR(8), \fBltsp\-kernel\fR(8), \fBltsp\-nfs\fR(8)