freebsd-ports/ports-mgmt/pkg_jail/files/pkg_jail.1
2012-06-30 07:28:16 +00:00

84 lines
2 KiB
Groff

.\" $Id$
.TH PKG_JAIL 1 "April 2010" "FreeBSD" "User Manuals"
.SH NAME
pkg_jail \- Easy handling of a jail for package-builds.
.SH SYNOPSIS
.TP
.B pkg_jail [command]
.SH DESCRIPTION
.B pkg_jail
is a script to handle an clean jail for package-builds.
.SH ARGUMENTS
.TP
.B init
Creates or updates a clean jail with "installworld" and populate /etc inside the jail.
You need to have a sucessful "buildword" made in /usr/src before this.
.TP
.B start
Start the jail as a guest server.
You should have setup sshd inside the jail to login and maintain it with this option.
.TP
.B shell
Start the jail and give a shell back. You can build packages now.
.TP
.B list
Show processes running in the jail.
You need to have /proc mounted (readonly) in the host.
.TP
.B stop
Kill processes running in the jail.
You need to have /proc mounted (readonly) in the host.
.TP
.B restart
Same as "stop" and "start"
.SH "IMPLEMENTATION NOTES"
.TP
.B /proc
/proc will be mounted readonly via procfs inside the jail.
.TP
.B /usr/src
if /usr/src/Makefile does not exists inside the jail,
/usr/src will be mounted readonly via nullfs from the the host into the jail.
.TP
.B pkg_jail_hostname
The hostname of the jail.
.TP
.B pkg_jail_short
A short name for the jail.
.TP
.B pkg_jail_ip
The ip-address for the jail.
.TP
.B pkg_jail_dir
The new root for the jail.
.TP
.B pkg_jail_rule
The rulset number the script uses for the devfs inside the jail.
.SH RETURN VALUES
undefined.
.SH "FILES"
The variables can be set in /etc/rc.conf or in $PREFIX/etc/pkg_jail.conf.
.SH "EXAMPLES"
.B Setting up the Jail Directory Tree
.P
Install all Files with the following comands on the host:
.IP
cd /usr/src && make buildworld
.br
pkg_jail init
.TP
.B Creating a Package
.P
Change to your management directory and execute pkg_upgrade:
.IP
cd /usr/ports/local/update
.br
sh pkg_update make-packages devel/gmake
.SH "SEE ALSO"
.TP
.B pkg_update(1)
The tool to create packages inside the jail.
.SH "HISTORY"
http://www.dinoex.net/training/package.html
.SH "AUTHOR"
Dirk Meyer, dinoex@FreeBSD.org