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