Change the comment about tracking changes in the debian changelog
[mirror/userdir-ldap.git] / doc / ud-gpgimport.8.yo
1 mailto(admin@db.debian.org)
2 manpage(ud-gpgimport)(8)(17 Sep 1999)(userdir-ldap)()
3 manpagename(ud-gpgimport)(Key Ring Syncronization utility)
4
5 manpagesynopsis()
6   ud-gpgimport [options] [keyrings]
7    
8 manpagedescription()
9 ud-gpgimport maintains the key fingerprint to user ID mapping in the
10 directory. It takes as input a set of keyrings that represent all keys
11 belonging to all users in the directory. It then reads each key and attempts
12 to match it up to a user already in the directory. This matching process has
13 several steps:
14
15 1) If the key fingerprint already exists in the directory then the key is
16 assumed to be already assigned so it is ignored
17
18 2) If the key email address is in the override table then the key is
19 assigned to the user in the override table
20
21 3) An exact match of first name + last name from the key's primary UID is 
22 performed against the directory. If a single hit is found then the key is
23 assigned to that user
24
25 4) If the email address in the key is within the debian.org domain then the
26 key is assigned to the to the mentioned user if the last name from the
27 directory appears some place in the key UID. This is called an bf(EmailAppend)
28 hit.
29
30 5) Nothing is done, but a soundex matcher is invoked to give some suggestions 
31 on who the key may belong to.
32
33 An override table is used to deal with keys that do not exactly match any
34 user in the directory. The override table takes the email address that
35 appears on a key and maps it to a uid in the directory.
36
37 By default the matcher only generates a report on what it would do but makes
38 no changes. The -a option must be given and an password entered to allow
39 modification.
40
41 GnuPG must be properly installed in the system to extract the key
42 information from the key rings.
43
44 manpageoptions()
45 startdit()
46 dit(bf(-a))
47 Enable modification of the directory.
48
49 dit(bf(-u))
50 Set the authentication user. This is the user who's authority is used when 
51 accessing the LDAP directory. The default is to use the current system user
52 name.
53
54 dit(bf(-m))
55 Set the override file to use. The format of the override file is a map of key
56 email address to uid, eg verb(foo@bar.com: baz)
57 enddit()
58
59 manpagefiles()
60 itemize(
61   it() /etc/userdir-ldap/userdir-ldap.conf
62   Configuration variables to select what server and what base DN to use.
63 )
64         
65 manpageauthor()
66 userdir-ldap was written by Jason Gunthorpe <jgg@debian.org>.
67