.\" /usr/share/man/man1/dphys3oxe.1(.gz)
.\" author Neil Franklin, last modification 2005.04.15
.\" copyright ETH Zuerich Physics Departement
.\"   use under either modified/non-advertising BSD or GPL license

.TH DPHYS3PXE 1 "2005.04.15" "dphys3 Installation Tools"

.SH NAME

dphys3pxe \- generate and automatic install boot server files

.SH SYNOPSIS

.B dphys3pxe
\fB-dgir\fP [\fB-qvD\fP]
.PP
.B dphys3pxe
\fB-h\fP

.SH DESCRIPTION

dphys3pxe downloads, generates, installs and removes automatic installer
boot server files, including custom kernels, and
automatic installer root floppy images including drivers subsets.

.SH OPTIONS

.TP
.B \-d
download: Download dphys3 boot and root image file from own install server
.TP
.B \-g
generate: Generate/extract dphys3 custom kernel and root floppy image
.TP
.B \-i
install: install/upload kernel and root image to PXE boot server
.TP
.B \-r
remove: Delete dphys3 files, after installing
.TP
.B \-q
quiet: Don't produce an running report of activities
.TP
.B \-v
verbose: Give large volume output, where sensible
.TP
.B \-D
Debug: Activate an debug option. See source for how to use this.
.TP
.B \-h
help: Output help text, and then abort operation
.PP
If multiple of \fB-d\fP \fB-g\fP \fB-i\fP or \fB-r\fP are used, they are
processed in the order they appear here in the man page section, not the order
they are typed on the command line. Other options modify behaviour.

.SH CONFIG

The config files \fI/etc/dphys3\fP (sitewiede), \fI~/.dphys3\fP (personal) and
\fIdphys3\fP (particular project) allow the admin and users to set up the
working environment for dphys3pxe (and all other dphys3 tools).
.PP
These config files are sh script fragments full of assignments, which are
sourced, in above row, later config files assignments overriding earlier ones.
Assignments relevant for dphys3pxe are:
.TP
.B CONF_DISKSVERSION
Subdirectory on server where to download boot and root floppy images from.
Defaults to \fIcustom\fP. Can be left if you only have one configuration, else
needs to be set different for each.
.TP
.B CONF_OWNSERVER
Base URL to download dphys3 boot and root floppy images from. Defaults also
to error message generating
\fIhttp://not-configured-server/not/configured/directory\fP.
Your admin must set this.
.TP
.B CONF_INST_PXE
The boot server user@host:/path to connect to, to upload the boot files to.
Defaults to error message generating invalid \fInot-configured-server\fP, as
there is no sensible default possible. You must set this.
.TP
.B CONF_INST_GROUP
Make all uploaded files writable by any user in this group.
For use so that all members of this group can work on the boot server
(adding or replacing files). Defaults to nothing, as this is usable for single
user and no sensible group value can be defaulted. Usually the admin will set
this.

.SH FILES

.TP
.B /etc/dphys3
site admin config
.TP
.B ~/.dphys3
users personal config
.TP
.B ./dphys3
individual projects config

.SH EXAMPLES

The following allows the sysadmin to tell all users how to get Debian stuff:
.PP
In \fI/etc/dphys3\fP:
.PP
.nf
  CONF_DEBSERVER=http://debian.ethz.ch/mirror/debian
.fi
.PP
The following allows the sysadmin to tell how all users upload to the
boot server:
.PP
In \fI/etc/dphys3\fP:
.PP
.nf
  CONF_INST_PXE=tftp@boot.phys.ethz.ch:/tftpboot/dphys3
  CONF_INST_GROUP=""
.fi
.PP
The following then allows the user to specify using an custom kernel and
where on the server the boot and root images for this are:
.PP
In \fI./dphys3\fP:
.PP
.nf
  CONF_KERNEL_OWN=anything-here-for-custom
  CONF_DISKSVERSION=user-foo
.fi
.PP
The user now can generate/extract and install on boot server and delete files
with:
.PP
\fIdphys3pxe \-dgir\fP

.SH SEE ALSO

\fIdphys3\fP(7), \fIdphys3boot\fP(1), \fIdphys3cd\fP(1),
\fIdphys3kernel\fP(1), \fIdphys3preseed\fP(1), \fIdphys3root\fP(1)

.SH AUTHOR

franklin@phys.ethz.ch, http://www.phys.ethz.ch/~franklin/