src/packaging/Debian/pt_util.sgml

   1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!ENTITY dhfirstname "<firstname>Sam</firstname>">
   5   <!ENTITY dhsurname   "<surname>Hartman</surname>">
   6   <!-- Please adjust the date whenever revising the manpage. -->
   7   <!ENTITY dhdate      "<date>November 23, 2000</date>">
   8   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   9        allowed: see man(7), man(1). -->
  10   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  11   <!ENTITY dhemail     "<email>hartmans@mit.edu</email>">
  12   <!ENTITY dhusername  "Sam Hartman">
  13   <!ENTITY dhucpackage "<refentrytitle>OPENAFS-PTUTIL</refentrytitle>">
  14   <!ENTITY dhpackage   "openafs-ptutil">
  15
  16   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  17   <!ENTITY gnu         "<acronym>GNU</acronym>">
  18 ]>
  19
  20 <refentry>
  21   <docinfo>
  22     <address>
  23       &dhemail;
  24     </address>
  25     <author>
  26       &dhfirstname;
  27       &dhsurname;
  28     </author>
  29     <copyright>
  30       <year>2000</year>
  31       <holder>&dhusername;</holder>
  32     </copyright>
  33     &dhdate;
  34   </docinfo>
  35   <refmeta>
  36
  37     <refentrytitle>pt_util</refentrytitle>
  38     &dhsection;
  39   </refmeta>
  40   <refnamediv>
  41     <refname>pt_util</refname>
  42
  43     <refpurpose>Utility to load/dump AFS protection database</refpurpose>
  44   </refnamediv>
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>pt_util</command>
  48           <arg><option>-w</option></arg>
  49           <arg><option>-u</option></arg>
  50           <arg><option>-g</option></arg>
  51           <arg><option>-m</option></arg>
  52           <arg><option>-n</option></arg>
  53           <arg><option>-s</option></arg>
  54           <arg><option>-x</option></arg>
  55           <arg><option>-d <replaceable>datafile</replaceable></option></arg>
  56           <arg><option>-p <replaceable>prdb</replaceable></option></arg>
  57
  58     </cmdsynopsis>
  59   </refsynopsisdiv>
  60   <refsect1>
  61     <title>DESCRIPTION</title>
  62
  63         <para>This manual page documents <command>pt_util</command>, a
  64         utility for dumping, loading and creating AFS protection
  65         databases.  The protection database is normally made available
  66         by the <command>ptserver</command> daemon running on the AFS
  67         database servers.  However, <command>pt_util</command>
  68         provides a mechanism for manipulating the database when
  69         <command>ptserver</command> is unavailable.  This is useful to
  70         create an initial database, to effect large batch changes or
  71         when the database has a damaged
  72         <literal>system:administrators</literal> group.</para>
  73
  74         <para>By default, <command>pt_util</command> opens the
  75         database and prints the version.  Options allow extraction of
  76         information from the database or writing new entries into the
  77         database.</para>
  78
  79
  80   </refsect1>
  81   <refsect1>
  82     <title>OPTIONS</title>
  83
  84     <variablelist>
  85       <varlistentry>
  86         <term><option>-h</option>
  87         </term>
  88         <listitem>
  89           <para>Show summary of options.</para>
  90         </listitem>
  91       </varlistentry>
  92           <varlistentry>
  93             <term><option>-w</option></term>
  94             <listitem>
  95               <para>Update PRDB with contents of data file or standard input if the <option>-d</option> is not used</para>
  96             </listitem>
  97           </varlistentry>
  98           <varlistentry>
  99             <term><option>-u</option></term>
 100             <listitem>
 101               <para>List users in the database.</para>
 102             </listitem>
 103           </varlistentry>
 104           <varlistentry>
 105             <term><option>-g</option></term>
 106             <listitem>
 107               <para>List groups in the database.</para>
 108             </listitem>
 109           </varlistentry>
 110           <varlistentry>
 111             <term><option>-m</option></term>
 112             <listitem>
 113               <para>List group members.</para>
 114             </listitem>
 115           </varlistentry>
 116           <varlistentry>
 117             <term><option>-n</option></term>
 118             <listitem>
 119               <para>Follow name hash chains instead of ID hashes.</para>
 120             </listitem>
 121           </varlistentry>
 122           <varlistentry>
 123             <term><option>-s</option></term>
 124             <listitem>
 125               <para>List only <literal>system:</literal> groups.  Used by MIT's Moira.</para>
 126             </listitem>
 127           </varlistentry>
 128       <varlistentry>
 129         <term><option>-d <replaceable>datafile</replaceable></option></term>
 130         <listitem>
 131           <para>Read from or write printable representation of the
 132           database from <replaceable>datafile</replaceable>.</para>
 133         </listitem>
 134       </varlistentry>
 135       <varlistentry>
 136         <term><option>-p <replaceable>prdb</replaceable></option></term>
 137         <listitem>
 138           <para>Manipulate the protection database
 139           <replaceable>prdb</replaceable>.  The running protection
 140           database is
 141           <filename>/var/lib/openafs/db/prdb.DB0</filename></para>
 142         </listitem>
 143       </varlistentry>
 144     </variablelist>
 145   </refsect1>
 146   <refsect1>
 147     <title>SEE ALSO</title>
 148
 149         <para>ptserver(8)</para>
 150
 151
 152   </refsect1>
 153   <refsect1>
 154     <title>AUTHOR</title>
 155
 156     <para>This manual page was written by &dhusername; &dhemail; for
 157       the &debian; system (but may be used by others).</para>
 158
 159     <!-- <para>Permission is granted to copy, distribute and/or modify
 160       this document under the terms of the <acronym>GNU</acronym> Free
 161       Documentation License, Version 1.1 or any later version
 162       published by the Free Software Foundation; with no Invariant
 163       Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
 164       of the license can be found under
 165       <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
 166
 167   </refsect1>
 168 </refentry>
 169
 170 <!-- Keep this comment at the end of the file
 171 Local variables:
 172 mode: sgml
 173 sgml-omittag:t
 174 sgml-shorttag:t
 175 sgml-minimize-attributes:nil
 176 sgml-always-quote-attributes:t
 177 sgml-indent-step:2
 178 sgml-indent-data:t
 179 sgml-parent-document:nil
 180 sgml-default-dtd-file:nil
 181 sgml-exposed-tags:nil
 182 sgml-local-catalogs:nil
 183 sgml-local-ecat-files:nil
 184 End: