]> git.michaelhowe.org Git - packages/o/openafs.git/commitdiff
* Use the upstream man page for pt_util, which lets us remove the
authorRuss Allbery <rra@debian.org>
Mon, 20 Aug 2007 05:38:39 +0000 (05:38 +0000)
committerRuss Allbery <rra@debian.org>
Mon, 20 Aug 2007 05:38:39 +0000 (05:38 +0000)
  docbook-to-man build dependency.

debian/changelog
debian/control
debian/openafs-dbserver.install
debian/patches/pt_util-man-page [new file with mode: 0644]
debian/patches/series
debian/pt_util.sgml [deleted file]
debian/rules

index 304ee3ae2d691d8ec1ef81396610dd22a5474a40..f1d5522909a7660426141965890d8d8fedc5a644 100644 (file)
@@ -1,6 +1,8 @@
 openafs (1.4.4.dfsg1-7) unstable; urgency=low
 
   * Switch to quilt for managing patches to the upstream source.
+  * Use the upstream man page for pt_util, which lets us remove the
+    docbook-to-man build dependency.
   * Restructure the source for the module package.  The build files for
     the module build are now in debian/module in the source package and
     there is a completely separate rules file.  This way, the module build
index 5c941631e92c3f715f3502e963ea497c6f7dfcea..fdc960c46a942ebe5ec75c4d4895bca23f961747 100644 (file)
@@ -4,8 +4,7 @@ Priority: optional
 Maintainer: Sam Hartman <hartmans@debian.org>
 Uploaders: Russ Allbery <rra@debian.org>
 Build-Depends: debhelper (>= 5), libncurses5-dev, libpam0g-dev, bison,
- docbook-to-man, flex, perl, comerr-dev, libkrb5-dev, autoconf, automake,
- quilt (>= 0.40)
+ flex, perl, comerr-dev, libkrb5-dev, autoconf, automake, quilt (>= 0.40)
 Standards-Version: 3.7.2
 
 Package: openafs-client
index 04fd4670951bce026a0d129314ab0db4d0b4523f..dc1a856ee353a5d4a3fa3829f8f3bfcd9e75baed 100644 (file)
@@ -19,6 +19,7 @@ debian/tmp/usr/share/man/man5/vldb.DB0.5              usr/share/man/man5
 
 debian/tmp/usr/share/man/man8/buserver.8              usr/share/man/man8
 debian/tmp/usr/share/man/man8/prdb_check.8            usr/share/man/man8
+debian/tmp/usr/share/man/man8/pt_util.8               usr/share/man/man8
 debian/tmp/usr/share/man/man8/ptserver.8              usr/share/man/man8
 debian/tmp/usr/share/man/man8/vldb_check.8            usr/share/man/man8
 debian/tmp/usr/share/man/man8/vlserver.8              usr/share/man/man8
diff --git a/debian/patches/pt_util-man-page b/debian/patches/pt_util-man-page
new file mode 100644 (file)
index 0000000..1210958
--- /dev/null
@@ -0,0 +1,193 @@
+Man page for pt_util.  Pulled from the upstream stable branch, will be in
+1.4.5.
+
+--- /dev/null
++++ openafs/doc/man-pages/pod8/pt_util.pod
+@@ -0,0 +1,187 @@
++=head1 NAME
++
++pt_util - Load or dump a Protection Server database
++
++=head1 SYNOPSIS
++
++=for html
++<div class="synopsis">
++
++B<pt_util>
++   S<<< [B<-w>] >>> S<<< [B<-user>] >>> S<<< [B<-group>] >>>
++   S<<< [B<-members>] >>> S<<< [B<-name>] >>> S<<< [B<-system>] >>>
++   S<<< [B<-xtra>] >>> S<<< [B<-prdb> <I<prdb file>>] >>>
++   S<<< [B<-datafile> <I<data file>>] >>> S<<< [B<-help>] >>>
++
++=for html
++</div>
++
++=head1 DESCRIPTION
++
++The B<pt_util> command can be used to load or dump the protection
++database.  It should only be used when B<ptserver> is not running.
++
++The most likely reason to use it is to initialize the protection database
++when bringing up a new cell.  The current syntax for this, presented
++below, needs improvement.  B<pt_util> can also be used when problems are
++suspected with the database.  It can be used to dump the database or
++portions thereof, in several different ways, and to reload it.
++
++The textual representation of the database has the following form:
++For users,
++
++    name flags/quota viceid ownerid creatorid
++
++For groups,
++
++    name flags/quota viceid ownerid creatorid
++     a-username a-user-viceid
++
++The second line is repeated for each member of the group.  When reading
++the database, membership is not reported unless B<-members> is also
++included.
++
++=head1 OPTIONS
++
++If you don't specify any options, the only thing you'll learn is the ubik
++database epoch and version.
++
++=over 4
++
++=item B<-w>
++
++Write to the protection database instead of reading.  Only the file
++arguments make sense in combination with this argument.
++
++=item B<-user>
++
++When reading, display users.
++
++=item B<-group>
++
++When reading, display groups (but not necessarily members).
++
++=item B<-members>
++
++When reading, display groups and also group members.
++
++=item B<-name>
++
++When reading,
++follow name hashes, instead of id hashes.
++This may print different information if the database was corrupted.
++Otherwise, it should print exactly the same information, except
++in a different order.
++
++=item B<-system>
++
++When reading, display system data, or more precisely, do not display
++entries with a viced <= -32768 or >= +97537.
++
++=item B<-xtra>
++
++When reading, display extra users and groups, or more precisely, do not
++display entries that are in the range -32767...+97536 inclusive.
++
++=item B<-prdb> <I<prdb file>>
++
++Specifies the complete pathname of the file in which the Protection
++Database resides.  Provide the complete name, including the ending
++F<.DB0>.
++
++=item B<-datafile> <I<data file>>
++
++Specify the file to which to dump (or B<-w> from which to read) textual
++database records.
++
++=back
++
++=head1 CAUTIONS
++
++The file dump format does not include supergroup information, so should
++not be used if you have and are using groups within groups.
++
++In all cases, entry timestamps and other information is also not
++preserved.
++
++The epoch and version are reported on standard error.  On little-endian
++machines, they'll be byte swapped, so may be very random.
++
++=head1 EXAMPLES
++
++The following example shows how to initialize the database from scratch.
++
++Before you do this, make sure B<ptserver> is not running.  If you have
++multiple database servers, make sure F<prdb.*> does not exist on any
++server machine.
++
++Now, type this in EXACTLY, including the leading space on the line
++indicated.  But do use Control-D at the end, not up-arrow D.
++
++    pt_util -w
++    admin 128/20 1 -204 -204
++    system:administrators 130/20 -204 -204 -204
++     admin 1
++    ^D
++
++You will see this:
++
++    # pt_util -w
++    pt_util: /usr/afs/db/prdb.DB0: Bad UBIK_MAGIC. Is 0 should be 354545
++    Ubik Version is: 2.0
++    admin 128/20 1 -204 -204
++    system:administrators 130/20 -204 -204 -204
++    Error while creating system:administrators: Entry for id already exists
++     admin 1
++    pt_util: Ubik Version number changed during execution.
++    Old Version = 2.0, new version = 33554432.0
++    #
++
++To make a complete copy of the database,
++
++    # pt_util -user -members -datafile /tmp/out
++
++To load from the complete copy,
++
++    # pt_util -w -datafile /tmp/out
++
++Don't do this until you read cautions, above.
++
++=head1 PRIVILEGE REQUIRED
++
++The issuer must be logged in as the superuser C<root> on a file server
++machine to use B<pt_util>.
++
++=head1 SEE ALSO
++
++L<prdb.DB0(5)>,
++L<ptserver(8)>
++
++=head1 COPYRIGHT
++
++The following copyright covers this documentation:
++
++Copyright (c) 2005 The Regents of the University of Michigan.  ALL RIGHTS
++RESERVED.
++
++Permission is granted to use, copy, create derivative works and
++redistribute this software and such derivative works for any purpose, so
++long as the name of the University of Michigan is not used in any
++advertising or publicity pertaining to the use or distribution of this
++software without specific, written prior authorization.  If the above
++copyright notice or any other identification of the University of Michigan
++is included in any copy of any portion of this software, then the
++disclaimer below must also be included.
++
++This software is provided as is, without representation from the
++University of Michigan as to its fitness for any purpose, and without
++warranty by the University of Michigan of any kind, either express or
++implied, including without limitation the implied warranties of
++merchantability and fitness for a particular purpose.  The regents of the
++University of Michigan shall not be liable for any damages, including
++special, indirect, incidental, or consequential damages, with respect to
++any claim arising out of or in connection with the use of the software,
++even if it has been or is hereafter advised of the possibility of such
++damages.
++
++=cut
index 203a6a449446a4aa271f73f56e77a469a3d5baf1..b018bdcdc6576f61612b0b031703dc8285bbb88c 100644 (file)
@@ -15,4 +15,5 @@ null-uuid-client
 null-uuid-server
 pag-cleanup-lock
 ucontext-everywhere
+pt_util-man-page
 paravirt-workaround
diff --git a/debian/pt_util.sgml b/debian/pt_util.sgml
deleted file mode 100644 (file)
index 9d93e91..0000000
+++ /dev/null
@@ -1,185 +0,0 @@
-<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-
-  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
-  <!ENTITY dhfirstname "<firstname>Sam</firstname>">
-  <!ENTITY dhsurname   "<surname>Hartman</surname>">
-  <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>November 23, 2000</date>">
-  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
-       allowed: see man(7), man(1). -->
-  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
-  <!ENTITY dhemail     "<email>hartmans@mit.edu</email>">
-  <!ENTITY dhusername  "Sam Hartman">
-  <!ENTITY dhucpackage "<refentrytitle>OPENAFS-PTUTIL</refentrytitle>">
-  <!ENTITY dhpackage   "openafs-ptutil">
-
-  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
-  <!ENTITY gnu         "<acronym>GNU</acronym>">
-]>
-
-<refentry>
-  <docinfo>
-    <address>
-      &dhemail;
-    </address>
-    <author>
-      &dhfirstname;
-      &dhsurname;
-    </author>
-    <copyright>
-      <year>2000</year>
-      <holder>&dhusername;</holder>
-    </copyright>
-    &dhdate;
-  </docinfo>
-  <refmeta>
-
-    <refentrytitle>pt_util</refentrytitle>
-    &dhsection;
-  </refmeta>
-  <refnamediv>
-    <refname>pt_util</refname>
-
-    <refpurpose>Utility to load/dump AFS protection database</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <cmdsynopsis>
-      <command>pt_util</command>
-         <arg><option>-w</option></arg>
-         <arg><option>-u</option></arg>
-         <arg><option>-g</option></arg>
-         <arg><option>-m</option></arg>
-         <arg><option>-n</option></arg>
-         <arg><option>-s</option></arg>
-         <arg><option>-x</option></arg>
-         <arg><option>-d <replaceable>datafile</replaceable></option></arg>
-         <arg><option>-p <replaceable>prdb</replaceable></option></arg>
-
-    </cmdsynopsis>
-  </refsynopsisdiv>
-  <refsect1>
-    <title>DESCRIPTION</title>
-
-       <para>This manual page documents <command>pt_util</command>, a
-       utility for dumping, loading and creating AFS protection
-       databases.  The protection database is normally made available
-       by the <command>ptserver</command> daemon running on the AFS
-       database servers.  However, <command>pt_util</command>
-       provides a mechanism for manipulating the database when
-       <command>ptserver</command> is unavailable.  This is useful to
-       create an initial database, to effect large batch changes or
-       when the database has a damaged
-       <literal>system:administrators</literal> group.</para>
-
-       <para>By default, <command>pt_util</command> opens the
-       database and prints the version.  Options allow extraction of
-       information from the database or writing new entries into the
-       database.</para>
-
-
-  </refsect1>
-  <refsect1>
-    <title>OPTIONS</title>
-
-    <variablelist>
-      <varlistentry>
-        <term><option>-h</option>
-        </term>
-        <listitem>
-          <para>Show summary of options.</para>
-        </listitem>
-      </varlistentry>
-         <varlistentry>
-           <term><option>-w</option></term>
-           <listitem>
-             <para>Update PRDB with contents of data file or standard input if the <option>-d</option> is not used</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>-u</option></term>
-           <listitem>
-             <para>List users in the database.</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>-g</option></term>
-           <listitem>
-             <para>List groups in the database.</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>-m</option></term>
-           <listitem>
-             <para>List group members.</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>-n</option></term>
-           <listitem>
-             <para>Follow name hash chains instead of ID hashes.</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>-s</option></term>
-           <listitem>
-             <para>List only <literal>system:</literal> groups.  Used by MIT's Moira.</para>
-           </listitem>
-         </varlistentry>
-      <varlistentry>
-       <term><option>-d <replaceable>datafile</replaceable></option></term>
-       <listitem>
-         <para>Read from or write printable representation of the
-         database from <replaceable>datafile</replaceable>.</para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term><option>-p <replaceable>prdb</replaceable></option></term>
-       <listitem>
-         <para>Manipulate the protection database
-         <replaceable>prdb</replaceable>.  The running protection
-         database is
-         <filename>/var/lib/openafs/db/prdb.DB0</filename></para>
-       </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsect1>
-  <refsect1>
-    <title>SEE ALSO</title>
-
-       <para>ptserver(8)</para>
-
-
-  </refsect1>
-  <refsect1>
-    <title>AUTHOR</title>
-
-    <para>This manual page was written by &dhusername; &dhemail; for
-      the &debian; system (but may be used by others).</para>
-
-    <!-- <para>Permission is granted to copy, distribute and/or modify
-      this document under the terms of the <acronym>GNU</acronym> Free
-      Documentation License, Version 1.1 or any later version
-      published by the Free Software Foundation; with no Invariant
-      Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
-      of the license can be found under
-      <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
-
-  </refsect1>
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:2
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:nil
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
--->
index a01f1be98e12aa6482f9d67e9600bbe8250b4a9b..573880e52a1ca16f6f55f7f41c9062d6560ec8f4 100755 (executable)
@@ -136,8 +136,6 @@ install: build
            debian/libpam-openafs-kaserver/lib/security/pam_afs.krb.so
 
        install -d debian/openafs-dbserver/usr/share/man/man8
-       /usr/bin/docbook-to-man debian/pt_util.sgml \
-           >debian/openafs-dbserver/usr/share/man/man8/pt_util.8
        ( cd debian && pod2man --section 8 --center "Debian GNU/Linux" \
            afs-rootvol ) \
            >debian/openafs-dbserver/usr/share/man/man8/afs-rootvol.8