'\" t
.\"     Title: portreserve
.\"    Author: Tim Waugh <twaugh@redhat.com>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 1 July 2008
.\"    Manual: TCP port reservation utility
.\"    Source: portreserve
.\"  Language: English
.\"
.TH "PORTRESERVE" "1" "1 July 2008" "portreserve" "TCP port reservation utility"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
portreserve \- reserve ports to prevent portmap mapping them
.SH "SYNOPSIS"
.HP \w'\fBportreserve\fR\ 'u
\fBportreserve\fR
.SH "DESCRIPTION"
.PP
The
\fBportreserve\fR
program aims to help services with well\-known ports that lie in the
\fBbindresvport\fR
range\&. It prevents portmap (or other programs using
\fBbindresvport\fR) from occupying a real service\*(Aqs port by occupying it itself, until the real service tells it to release the port (generally in its init script)\&.
.PP
It is intended that
\fBportreserve\fR
runs from an initscript of its own, and services wishing to interact with it should use
\fBportrelease\fR\&.
.PP
When the
\fBportreserve\fR
daemon is started, it examines the
/etc/portreserve/
directory\&. Each file not containing
\(lq\&.\(rq
or
\(lq~\(rq
in its name is considered to be a service configuration file, and must contain a service name (as listed in
/etc/services) or a port number\&. UDP services may be specified by appending "/udp" to the service name, and TCP services by "/tcp"\&. Several services may be specified, one per line\&.
.PP
For example,
/etc/portreserve/cups
might contain the string
\(lqipp\(rq
or, equivalently,
\(lqipp/tcp\(rq
and
\(lqipp/udp\(rq
on separate lines\&.
.PP
For each service configuration file, a socket is created and bound to the appropriate port\&. A service wishing to bind to its port must first run
\fBportrelease\fR, which instructs
\fBportreserve\fR
to release the port associated with the service\&.
.PP
Once all the reserved ports have been released, the daemon exits\&.
.SH "FILES"
.PP
/etc/portreserve/*
.RS 4
Service configuration files
.RE
.PP
/var/run/portreserve/socket
.RS 4
communication socket for
\fBportrelease\fR
.RE
.SH "SEE ALSO"
.PP
\fBportrelease\fR(1)
.SH "AUTHOR"
.PP
\fBTim Waugh\fR <\&twaugh@redhat\&.com\&>
.RS 4
Author.
.RE