]> git.michaelhowe.org Git - packages/o/openafs.git/commitdiff
Generate and install pt_util manpage
authorSam Hartman <hartmans@debian.org>
Fri, 19 Jan 2001 22:41:49 +0000 (22:41 +0000)
committerSam Hartman <hartmans@debian.org>
Fri, 19 Jan 2001 22:41:49 +0000 (22:41 +0000)
debian/control
debian/pt_util.sgml [new file with mode: 0644]
debian/rules

index 57665b8f588ec15db7d6933654685c4c3a29c53b..422e2b72a37a8164caf5410a266e8024ec9f3b0b 100644 (file)
@@ -2,7 +2,7 @@ Source: openafs
 Section: non-us/main
 Priority: optional
 Maintainer: Sam Hartman <hartmans@debian.org>
-Build-Depends: debhelper (>= 2.1.16), libncurses5-dev, libpam0g-dev, bison
+Build-Depends: debhelper (>= 2.1.16), libncurses5-dev, libpam0g-dev, bison, docbook-to-man
 Standards-Version: 3.1.1
 
 Package: openafs-client
diff --git a/debian/pt_util.sgml b/debian/pt_util.sgml
new file mode 100644 (file)
index 0000000..9d93e91
--- /dev/null
@@ -0,0 +1,185 @@
+<!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 a11669cbae9a11d081224c6b553329d22dff66b3..aea08ec1fb13518024bcdc1755a9738dd5e991d7 100755 (executable)
@@ -55,6 +55,9 @@ build-stamp:
        dh_testdir
 
        $(MAKE) SYS_NAME=$(SYS_NAME)
+       mkdir -p 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
 
        touch build-stamp