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

.TH DPHYS2PXE 1 "2004.10.08" "dphys2 Installation Tools"

.SH NAME

dphys2pxe \- generate and automatic install boot server files

.SH SYNOPSIS

.B dphys2pxe
\fB-dir\fP [\fB-D\fP]
.PP
.B dphys2pxe
\fB-g\fP [\fB-w\fP \fIworkdir\fP] [\fB-D\fP]
.PP
.B dphys2pxe
\fB-h\fP

.SH DESCRIPTION

dphys2pxe 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 original Debian or dphys2 rescue and root image
files from an Debian distribution server or mirror or own install server
.TP
.B \-g
generate: Generate/extract dphys2 custom kernel and root floppy image
.TP
.BI \-w \ workdir
workdir: Select work directory for doing all compiling and image generating.
Defaults to \fI./.dphys2pxe\fP
.TP
.B \-n
nodelete: Do not delete work directory after generating. Usefull for debugging
.TP
.B \-i
install: install/upload kernel and root image to PXE boot server
.TP
.B \-r
remove: Delete Debian and dphys2 files, after installing
.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 \fB-r\fP or
\fB-i\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/dphys2\fP (normal style), \fI/etc/default/dphys2\fP
(Debian style), \fI~/.dphys2\fP (personal) and \fI./dphys2\fP (particular
project) allow the admin and users to set up the working environment for
dphys2pxe (and all other dphys2 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 dphys2pxe are:
.TP
.B CONF_DEBSERVER
Base URL from which all Debian stuff can be downloaded. Defaults to
\fIhttp://ftp.debian.org/debian\fP. Needs to be set if you want to use an
mirror.
.TP
.B CONF_KERNEL_24
Whether we are generating an 2.2 (no) or 2.4 (yes) style kernel. Defaults to
\fIno\fP. Needs to be set if you are using any form of 2.4 based stuff, leave
it for 2.2 based
.TP
.B CONF_KERNEL_OWN
Filename used by \fBdphys2rescue\fP to compile the custom kernel. Here it just
indicates to use the custom kernels rescue floppy image and drivers archive
instead of Debians ones. Defaults to empty (= use original Debian kernels).
.TP
.B CONF_OWNSERVER
Base URL to download dphys2 rescue 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_DISKSVERSION
Subdirectory on server where to upload and download rescue and root floppy
images. Defaults to \fIcustom\fP. Can be left if you only have one
configuration, else needs to be set different for each.
.TP
.B CONF_INST_PXE
The boot server 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. Your admin 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/dphys2
normal style site config
.TP
.B /etc/default/dphys2
Debian style site config
.TP
.B ~/.dphys2
users personal config
.TP
.B ./dphys2
individual projects config

.SH EXAMPLES

The following allows the sysadmin to tell all users how to get Debian stuff:
.PP
In \fI/etc/dphys2\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/dphys2\fP:
.PP
.nf
  CONF_INST_PXE=tftp@boot.phys.ethz.ch:/tftp
  CONF_INST_GROUP=""
.fi
.PP
The following then allows the user to specify using an custom kernel and
where on the server the rescue and root images for this are:
.PP
In \fI./dphys2\fP:
.PP
.nf
  CONF_KERNEL_24=yes
  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
\fIdphys2pxe \-dgir\fP

.SH SEE ALSO

\fIdphys2\fP(7), \fIdphys2rescue\fP(1), \fIdphys2root\fP(1), \fIdphys2cd\fP(1)

.SH AUTHOR

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