dhcpd-pools/man/dhcpd-pools.1
Sami Kerola 625cde6b9c Version 2.7
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-07-11 14:09:20 +02:00

96 lines
2.3 KiB
Groff

.\" Sami Kerola
.\" http://www.iki.fi/kerolasa/
.\" kerolasa@iki.fi
.\"
.TH DHCPD-POOLS 1 "May 18 2008 - version 2.7"
.SH NAME
dhcpd-pools \- ISC dhcp pools usage analysis
.SH SYNOPSIS
.B dhcpd-pools
[-c file] [-l file] [-f thc] [-s nimcptTe] [-r] [-o file] [-L nr] [-v] [-h]
.SH DESCRIPTION
The program counts ISC dhcp shared network and pool usage
analysis and outputs it in selected format.
.SH FIELDS
.TP
.I "shared net name"
Name of the shared-network for the range.
.TP
.I "first ip"
First IP in lease pool range.
.TP
.I "last ip"
Last IP in lease pool range.
.TP
.I "max"
Number of IPs which exist on pool, shared network or all together.
.TP
.I "cur"
Number of leases currently in use.
.TP
.I "percent"
Percent of IPs currently in use compared to max.
.TP
.I "touch"
Number of leases which are not actively. This number should indicate how
much there are clients which are turned off.
.TP
.I "t+c"
Touched leases and currently in use together.
.TP
.I "t+c perc"
Percent of touched and currently in use together compared to max.
.SH ARGUMENTS
.TP
.I "\-c, \-\-config"
Path to the dhcpd.conf file.
.TP
.I "\-l, \-\-leases"
Path to the dhcpd.leases file.
.TP
.I "\-s, \-\-sort"
Sort ranges by chosen fields as a sorting keys. Maximum of five
sort keys can be defined. Keys weight from left to right IE if
more weighting keys are equal next one is used. The IP field is
default sort key.
.TP
.I "\-r, \-\-reverse"
Sort results in reverse order.
.TP
.I "\-f, \-\-format"
Output format. Currently there is text, html and csv
(comma-separated values). Default is text.
.TP
.I "\-o, \-\-output"
File where output is written. Default is stdout.
.TP
.I "\-L, \-\-limit"
Limit what will be printed. Syntax is similar to chmod permission
string. The limit string uses two digits which vary between 0 to
7. First digit will cause on headers and second numeric analysis
tables to included or dropped from output.
.TP
.I "\-v, \-\-version"
Print version information to standard output and exit successfully.
.TP
.I "\-h, \-\-help"
Print help to standard output and exit successfully.
.SH FILES
.if n .ta 2.8i
.if t .ta 2.1i
/etc/dhcpd.conf
.br
ISC dhcpd configuration file.
.br
.br
/var/lib/dhcp/dhcpd.leases
.br
ISC dhcpd lease file.
.SH AUTHOR
Sami Kerola <kerolasa@iki.fi>
.br
http://dhcpd-pools.sourceforge.net/
.SH "SEE ALSO"
.BR dhcpd.leases (5),
.BR dhcpd.conf (5),
.BR chmod (1)