contrib/bind9/bin/tools/named-journalprint.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2009  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!-- $Id: named-journalprint.docbook,v 1.2 2009/12/04 21:59:23 marka Exp $ -->
  21 <refentry id="man.named-journalprint">
  22   <refentryinfo>
  23     <date>Feb 18, 2009</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>named-journalprint</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>named-journalprint</application></refname>
  34     <refpurpose>print zone journal in human-readable form</refpurpose>
  35   </refnamediv>
  36
  37   <docinfo>
  38     <copyright>
  39       <year>2009</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42   </docinfo>
  43
  44   <refsynopsisdiv>
  45     <cmdsynopsis>
  46       <command>named-journalprint</command>
  47       <arg choice="req"><replaceable class="parameter">journal</replaceable></arg>
  48     </cmdsynopsis>
  49   </refsynopsisdiv>
  50
  51   <refsect1>
  52     <title>DESCRIPTION</title>
  53     <para>
  54       <command>named-journalprint</command>
  55       prints the contents of a zone journal file in a human-readable
  56       form.
  57     </para>
  58     <para>
  59       Journal files are automatically created by <command>named</command>
  60       when changes are made to dynamic zones (e.g., by
  61       <command>nsupdate</command>).  They record each addition
  62       or deletion of a resource record, in binary format, allowing the
  63       changes to be re-applied to the zone when the server is
  64       restarted after a shutdown or crash.  By default, the name of
  65       the journal file is formed by appending the extension
  66       <filename>.jnl</filename> to the name of the corresponding
  67       zone file.
  68     </para>
  69     <para>
  70       <command>named-journalprint</command> converts the contents of a given
  71       journal file into a human-readable text format.  Each line begins
  72       with "add" or "del", to indicate whether the record was added or
  73       deleted, and continues with the resource record in master-file
  74       format.
  75     </para>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>SEE ALSO</title>
  80     <para>
  81       <citerefentry>
  82         <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
  83       </citerefentry>,
  84       <citerefentry>
  85         <refentrytitle>nsupdate</refentrytitle><manvolnum>8</manvolnum>
  86       </citerefentry>,
  87       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
  88     </para>
  89   </refsect1>
  90
  91   <refsect1>
  92     <title>AUTHOR</title>
  93     <para><corpauthor>Internet Systems Consortium</corpauthor>
  94     </para>
  95   </refsect1>
  96
  97 </refentry><!--
  98  - Local variables:
  99  - mode: sgml
 100  - End:
 101 -->