diff options
Diffstat (limited to 'doc/sphinx/_build/man/kea-lfc.8')
-rw-r--r-- | doc/sphinx/_build/man/kea-lfc.8 | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/doc/sphinx/_build/man/kea-lfc.8 b/doc/sphinx/_build/man/kea-lfc.8 new file mode 100644 index 0000000..4f020b2 --- /dev/null +++ b/doc/sphinx/_build/man/kea-lfc.8 @@ -0,0 +1,144 @@ +.\" Man page generated from reStructuredText. +. +.TH "KEA-LFC" "8" "Jul 26, 2022" "2.2.0" "Kea" +.SH NAME +kea-lfc \- Lease File Cleanup process in Kea +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBkea\-lfc\fP [\fB\-4**|\fP\-6**] [\fB\-c\fP config\-file] [\fB\-p\fP pid\-file] [\fB\-x\fP previous\-file] [\fB\-i\fP copy\-file] [\fB\-o\fP output\-file] [\fB\-f\fP finish\-file] [\fB\-v\fP] [\fB\-V\fP] [\fB\-W\fP] [\fB\-d\fP] [\fB\-h\fP] +.SH DESCRIPTION +.sp +The \fBkea\-lfc\fP service process removes redundant information from the +files used to provide persistent storage for the memfile database +backend. The service is written to run as a stand\-alone process. While +it can be started externally, there is usually no need to do this. It +is run periodically by the Kea DHCP servers. +.SH ARGUMENTS +.sp +The arguments are as follows: +.INDENT 0.0 +.TP +.B \fB\-4 | \-6\fP +Indicates the protocol version of the lease files; must be either 4 or 6. +.TP +.B \fB\-c config\-file\fP +Specifies the file with the configuration for the \fBkea\-lfc\fP +process. It may also contain configuration entries for other Kea +services. Currently \fBkea\-lfc\fP gets all of its arguments from the +command line. +.TP +.B \fB\-p pid\-file\fP +Specifies the PID file. When the \fBkea\-lfc\fP process starts, it attempts to +determine if another instance of the process is already running, by +examining the PID file. If one is already running, the new process is +terminated. If one is not running, Kea writes its PID into the PID file. +.TP +.B \fB\-x previous\-file\fP +Specifies the previous or ex\-lease file. When \fBkea\-lfc\fP starts, this is the +result of any previous run of \fBkea\-lfc\fP; when \fBkea\-lfc\fP finishes, +it is the result of the current run. If \fBkea\-lfc\fP is interrupted before +completing, this file may not exist. +.TP +.B \fB\-i copy\-file\fP +Specifies the input or copy of lease file. Before the DHCP server invokes +\fBkea\-lfc\fP, it moves the current lease file here and then calls +\fBkea\-lfc\fP with this file. +.TP +.B \fB\-o output\-file\fP +Specifies the output lease file, which is the temporary file \fBkea\-lfc\fP should use to +write the leases. Once this file is finished writing, it is +moved to the finish file (see below). +.TP +.B \fB\-f finish\-file\fP +Specifies the finish or completion file, another temporary file \fBkea\-lfc\fP uses +for bookkeeping. When \fBkea\-lfc\fP finishes writing the output file, +it moves it to this file name. After \fBkea\-lfc\fP finishes deleting +the other files (previous and input), it moves this file to the previous +lease file. By moving the files in this fashion, the \fBkea\-lfc\fP and +the DHCP server processes can determine the correct file to use even +if one of the processes was interrupted before completing its task. +.TP +.B \fB\-v\fP +Causes the version stamp to be printed. +.TP +.B \fB\-V\fP +Causes a longer form of the version stamp to be printed. +.TP +.B \fB\-W\fP +Displays the configuration report. +.TP +.B \fB\-d\fP +Sets the logging level to debug with extra verbosity. This is primarily for +development purposes in stand\-alone mode. +.TP +.B \fB\-h\fP +Causes the usage string to be printed. +.UNINDENT +.SH DOCUMENTATION +.sp +Kea comes with an extensive Kea Administrator Reference Manual that covers +all aspects of running the Kea software \- compilation, installation, +configuration, configuration examples, and much more. Kea also features a +Kea Messages Manual, which lists all possible messages Kea can print +with a brief description for each of them. Both documents are +available in various formats (.txt, .html, .pdf) with the Kea +distribution. The Kea documentation is available at +\fI\%https://kea.readthedocs.io\fP\&. +.sp +Kea source code is documented in the Kea Developer\(aqs Guide, +available at \fI\%https://reports.kea.isc.org/dev_guide/\fP\&. +.sp +The Kea project website is available at \fI\%https://kea.isc.org\fP\&. +.SH MAILING LISTS AND SUPPORT +.sp +There are two public mailing lists available for the Kea project. \fBkea\-users\fP +(kea\-users at lists.isc.org) is intended for Kea users, while \fBkea\-dev\fP +(kea\-dev at lists.isc.org) is intended for Kea developers, prospective +contributors, and other advanced users. Both lists are available at +\fI\%https://lists.isc.org\fP\&. The community provides best\-effort support +on both of those lists. +.sp +ISC provides professional support for Kea services. See +\fI\%https://www.isc.org/kea/\fP for details. +.SH HISTORY +.sp +The \fBkea\-lfc\fP process was first coded in January 2015 by the ISC +Kea/DHCP team. +.SH SEE ALSO +.sp +\fBkea\-dhcp4(8)\fP, \fBkea\-dhcp6(8)\fP, \fBkea\-dhcp\-ddns(8)\fP, +\fBkea\-ctrl\-agent(8)\fP, \fBkea\-admin(8)\fP, \fBkeactrl(8)\fP, +\fBperfdhcp(8)\fP, \fBkea\-netconf(8)\fP, Kea Administrator Reference Manual. +.SH AUTHOR +Internet Systems Consortium +.SH COPYRIGHT +2019-2022, Internet Systems Consortium +.\" Generated by docutils manpage writer. +. |