Two problems with my first commit:
[mirror/userdir-ldap.git] / doc / ud-userimport.8.yo
1 mailto(admin@db.debian.org)
2 manpage(ud-userimport)(1)(17 Sep 1999)(userdir-ldap)()
3 manpagename(ud-userimport)(Perform initial import of date)
4
5 manpagesynopsis()
6   ud-userimport [options]
7    
8 manpagedescription()
9
10 ud-userimport is the utility that is used to initially load data into the
11 directory. It takes as input a set of normal unix password, group and shadow
12 files and loads their contents. Also it provide enough functionality to
13 allow simple additions at a later date. 
14
15 Before attempting to import the data the passwd file should be sanitized
16 of any system entries and the GECOs fields should be cleaned of any
17 strangeness users may have inserted.
18
19 Next the passwd file alone should be added using the command
20 verb(ud-userimport -a -p passwd)
21 The passwd file will be loaded into the
22 empty directory and new entries created for all the users.
23
24 The shadow file does not have to be santized, importing it without the -a
25 option will automatically skip any records that are not needed.
26 The command to use is verb(ud-userimport -s shadow)
27
28 Like the passwd file the group file needs to be cleaned of system groups and
29 groups that are no longer needed. It is not necessary to remove non-existant
30 users from the group lists, they will be automatically ignored. Like for
31 the shadow file the command is verb(ud-userimport -a -g group)
32
33 After the initial import is completed the ud-info tool can be used to
34 manipulate the user records, however new groups can most easially be created 
35 by giving a file containing only a single group (and its initial membership)
36 to ud-userimport.
37
38 The importer is optimized to get good speed on updates through the use
39 of the async ldap mechanism. If errors are found in the import of the 
40 passwd file or shadow file it is possible to re-run the import command 
41 (without the -a option) to freshen the data set.
42
43 Aside from the evident transformations, the splitter also processes the 
44 unix gecos field into split first/last/middle names and it also sanitizes
45 the gecos field to follow normal Debian convetions.
46
47 manpageoptions()
48 startdit()
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(-x))
55 Do not write new passwords into the directory. This is usefull if other
56 information is being freshened but users have changed their passwords.
57
58 dit(bf(-p))
59 Specify the passwd file to import.
60
61 dit(bf(-g))
62 Specify the group file to import.
63
64 dit(bf(-s))
65 Specify the shadow file to import.
66 enddit()
67
68 manpagefiles()
69 itemize(
70   it() /etc/userdir-ldap/userdir-ldap.conf
71   Configuration variables to select what server and what base DN to use.
72 )
73         
74 manpageauthor()
75 userdir-ldap was written by Jason Gunthorpe <jgg@debian.org>.
76