]> git.decadent.org.uk Git - dak.git/blob - docs/julia.1.sgml
add s390 to arch list, autobuilding from accepted bits
[dak.git] / docs / julia.1.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % katieent SYSTEM "katie.ent">
5 %katieent;
6
7 ]>
8
9 <refentry>
10   &katie-docinfo;
11
12   <refmeta>
13     <refentrytitle>julia</>
14     <manvolnum>1</>
15   </refmeta>
16
17   <!-- Man page title -->
18   <refnamediv>
19     <refname>julia</>
20     <refpurpose>Utility to sync PostgreSQL with a (LDAP-generated) passwd file</>
21   </refnamediv>
22
23   <!-- Arguments -->
24   <refsynopsisdiv>
25     <cmdsynopsis>
26       <command>julia</>
27       <arg><option><replaceable>options</replaceable></></arg>
28       <arg choice="plain"><replaceable>passwd file</replaceable></arg>
29     </cmdsynopsis>
30   </refsynopsisdiv>
31
32   <RefSect1><Title>Description</>
33     <para>
34       <command>julia</command> is a utility to sync PostgreSQL's user database with a passwd file.  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.
35     </PARA>
36   </REFSECT1>
37
38   <RefSect1><Title>Options</>
39
40     <VariableList>
41       <VarListEntry><term><option>-q/--quiet<replaceable></replaceable></option></>
42         <ListItem>
43           <Para>Be quiet, i.e. display as little output as possible.</PARA>
44         </LISTITEM>
45       </VarListEntry>
46
47       <VarListEntry><term><option>-v/--verbose</option></>
48         <ListItem>
49           <Para>Be verbose, i.e. display more output than normal.</PARA>
50         </LISTITEM>
51       </VarListEntry>
52
53       <VarListEntry><term><option>-h/--help</option></>
54         <ListItem>
55           <Para>Show help and then exit.</PARA>
56         </LISTITEM>
57       </VarListEntry>
58
59     </VariableList>
60   </RefSect1>
61
62   <refsect1>
63     <title>Configuration</title>
64     <para><command>julia</command> uses katie'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>
65     <variablelist>
66       <varlistentry>
67         <term>Julia::ValidGID</term>
68         <listitem>
69           <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>
70         </listitem>
71       </varlistentry>
72       <varlistentry>
73         <term>Julia::KnownPostgresUsers</term>
74         <listitem>
75           <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>
76         </listitem>
77       </varlistentry>
78     </variablelist>
79   </refsect1>
80
81   <RefSect1><Title>Diagnostics</>
82     <para>
83       <command>julia</command> returns zero on normal operation, non-zero on error.
84     </PARA>
85   </RefSect1>
86
87   &manauthor;
88
89 </refentry>