docs/manpages/import-users-from-passwd.1.sgml

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   3
   4 <!ENTITY % dakent SYSTEM "dak.ent">
   5 %dakent;
   6
   7 ]>
   8
   9 <refentry>
  10   &dak-docinfo;
  11
  12   <refmeta>
  13     <refentrytitle>dak_import-users-from-passwd</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>dak import-users-from-passwd</>
  20     <refpurpose>Utility to sync PostgreSQL users with system users</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>dak import-users-from-passwd</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28     </cmdsynopsis>
  29   </refsynopsisdiv>
  30
  31   <RefSect1><Title>Description</>
  32     <para>
  33       <command>dak import-users-from-passwd</command> is a utility to sync PostgreSQL's user database with the system's users.  It is designed to allow the use of 'peer sameuser' authentication.  It simply adds any users in the password file into PostgreSQL's pg_user table if they are already not there.  It will also warn you about users who are in the pg_user table but not in the password file.
  34     </PARA>
  35   </REFSECT1>
  36
  37   <RefSect1><Title>Options</>
  38
  39     <VariableList>
  40       <VarListEntry><term><option>-n/--no-action<replaceable></replaceable></option></>
  41         <ListItem>
  42           <Para>Don't actually do anything.</PARA>
  43         </LISTITEM>
  44       </VarListEntry>
  45
  46       <VarListEntry><term><option>-q/--quiet<replaceable></replaceable></option></>
  47         <ListItem>
  48           <Para>Be quiet, i.e. display as little output as possible.</PARA>
  49         </LISTITEM>
  50       </VarListEntry>
  51
  52       <VarListEntry><term><option>-v/--verbose</option></>
  53         <ListItem>
  54           <Para>Be verbose, i.e. display more output than normal.</PARA>
  55         </LISTITEM>
  56       </VarListEntry>
  57
  58       <VarListEntry><term><option>-h/--help</option></>
  59         <ListItem>
  60           <Para>Show help and then exit.</PARA>
  61         </LISTITEM>
  62       </VarListEntry>
  63
  64     </VariableList>
  65   </RefSect1>
  66
  67   <refsect1>
  68     <title>Configuration</title>
  69     <para><command>dak import-users-from-passwd</command> uses dak's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd.  Apart from being able to alter the defaults for command line options, the following configuration items are used:</para>
  70     <variablelist>
  71       <varlistentry>
  72         <term>Import-Users-From-Passwd::ValidGID</term>
  73         <listitem>
  74           <para>Each user's primary GID is compared with this, if it's not blank.  If they match, the user will be processed, if they don't, the user will be skipped.</para>
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term>Import-Users-From-Passwd::KnownPostgresUsers</term>
  79         <listitem>
  80           <para>This is a comma-separated list of users who are in PostgreSQL's pg_user table but are not in the password file.</para>
  81         </listitem>
  82       </varlistentry>
  83     </variablelist>
  84   </refsect1>
  85
  86   <RefSect1><Title>Diagnostics</>
  87     <para>
  88       <command>dak import-users-from-passwd</command> returns zero on normal operation, non-zero on error.
  89     </PARA>
  90   </RefSect1>
  91
  92   &manauthor;
  93
  94 </refentry>