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

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

.SH NAME

dphys3pxe \- extract and automatic upload boot server files

.SH SYNOPSIS

.B dphys3pxe
\fB-d\fP [\fB-qvD\fP]
.PP
.B dphys3pxe
\fB-g\fP [\fB-qvD\fP]
.PP
.B dphys3pxe
\fB-u\fP [\fB-qvD\fP]
.PP
.B dphys3pxe
\fB-r\fP [\fB-qvD\fP]
.PP
.B dphys3pxe
\fB-h\fP

.SH DESCRIPTION

dphys3pxe downloads, extracts, uploads and removes boot server files from
\fIdphys3preseed\fP(1) generated automatic installer boot+root floppy images.

.SH COMMAND/FUNCTION/ACTION LETTERS

One or multiple of the following commands must be used, else dphys3cd
defaults to doing nothing. If one or multiple of these are selected, only those
actions are taken, no other default action.
.PP
If multiple of these are used, they are always processed in the row they appear
here, not the row they are typed on the command line.
.TP
.B \-d
download: Download dphys3 boot and root floppy images from own install server
.TP
.B \-x
extract: extract kernel from boot image and initrd from root image
.TP
.B \-u
upload: upload kernel and initrd to PXE boot server
.TP
.B \-r
remove: Delete dphys3 files, use this after uploading

.SH OPTIONS

.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

.SH CONFIG

The config files \fI/etc/dphys3\fP (sitewiede), \fI~/.dphys3\fP (personal) and
\fI./dphys3\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.
Standard sh syntax rules apply. Assignments relevant for dphys3pxe are:
.TP
.B CONF_DISKSVERSION
Subdirectory on server where download boot floppy image from. Path below
dists/sarge/local/main/installer-${SYS_ARCH}. Defaults to \fIdphys3-custom\fP.
Can be left if you only have one configuration, else needs to be set different
for each.
.TP
.B CONF_OWNSERVER
Base URL from which all dphys3preseed generated images can be downloaded.
Defaults also to error message generating
\fIhttp://not-configured-server/not/configured/directory\fP.
Your admin must set this.
.TP
.B CONF_PXE_SERVER
The boot server to connect to, to upload the extracted boot files to. Must have
the format user@server:/directory for remote copying. Defaults to error message
generating invalid \fInot-configured-user@server:/dir\fP, as there is no
sensible default possible. Your admin must set this.
.TP
.B CONF_PXE_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 your 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 then allows the sysadmin to tell where on the server the boot and
root images are to be found:
.PP
In \fI/etc/dphys3\fP:
.PP
.nf
  CONF_OWNSERVER=http://debian.ethz.ch/pub/debian-local
.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_PXE_SERVER=tftp@boot.phys.ethz.ch:/tftpboot/dphys3
  CONF_PXE_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_DISKSVERSION=user-foo
.fi
.PP
The user can now download an boot and root image, extract the kernel and
initrd from them, and upload these to an boot server, and then delete
these with:
.PP
\fIdphys3pxe \-dxur\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/