xref: /netbsd-src/external/mpl/bind/dist/bin/tools/named-journalprint.rst (revision 8aaca124c0ad52af9550477f296b63debc7b4c98)
1.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
2..
3.. SPDX-License-Identifier: MPL-2.0
4..
5.. This Source Code Form is subject to the terms of the Mozilla Public
6.. License, v. 2.0.  If a copy of the MPL was not distributed with this
7.. file, you can obtain one at https://mozilla.org/MPL/2.0/.
8..
9.. See the COPYRIGHT file distributed with this work for additional
10.. information regarding copyright ownership.
11
12.. highlight: console
13
14.. iscman:: named-journalprint
15.. program:: named-journalprint
16.. _man_named-journalprint:
17
18named-journalprint - print zone journal in human-readable form
19--------------------------------------------------------------
20
21Synopsis
22~~~~~~~~
23
24:program:`named-journalprint` [-c serial] [**-dux**] {journal}
25
26Description
27~~~~~~~~~~~
28
29:program:`named-journalprint` scans the contents of a zone journal file,
30printing it in a human-readable form, or, optionally, converting it
31to a different journal file format.
32
33Journal files are automatically created by :iscman:`named` when changes are
34made to dynamic zones (e.g., by :iscman:`nsupdate`). They record each addition
35or deletion of a resource record, in binary format, allowing the changes
36to be re-applied to the zone when the server is restarted after a
37shutdown or crash. By default, the name of the journal file is formed by
38appending the extension ``.jnl`` to the name of the corresponding zone
39file.
40
41:program:`named-journalprint` converts the contents of a given journal file
42into a human-readable text format. Each line begins with ``add`` or ``del``,
43to indicate whether the record was added or deleted, and continues with
44the resource record in master-file format.
45
46The ``-c`` (compact) option provides a mechanism to reduce the size of
47a journal by removing (most/all) transactions prior to the specified
48serial number. Note: this option *must not* be used while :iscman:`named` is
49running, and can cause data loss if the zone file has not been updated
50to contain the data being removed from the journal. Use with extreme caution.
51
52The ``-x`` option causes additional data about the journal file to be
53printed at the beginning of the output and before each group of changes.
54
55The ``-u`` (upgrade) and ``-d`` (downgrade) options recreate the journal
56file with a modified format version.  The existing journal file is
57replaced.  ``-d`` writes out the journal in the format used by
58versions of BIND up to 9.16.11; ``-u`` writes it out in the format used
59by versions since 9.16.13. (9.16.12 is omitted due to a journal-formatting
60bug in that release.) Note that these options *must not* be used while
61:iscman:`named` is running.
62
63See Also
64~~~~~~~~
65
66:iscman:`named(8) <named>`, :iscman:`nsupdate(1) <nsupdate>`, BIND 9 Administrator Reference Manual.
67