Initial import
[mirror/userdir-ldap.git] / doc / ud-info.1.yo
1 mailto(admin@db.debian.org)
2 manpage(ud-info)(1)(17 Sep 1999)(userdir-ldap)()
3 manpagename(ud-info)(Command line LDAP user record manipulator)
4
5 manpagesynopsis()
6   ud-info [options]
7    
8 manpagedescription()
9
10 ud-info is the command-line tool for end users to manipulate their own
11 database information and to view other users information. It also provides
12 root functions which when combined with sufficient LDAP privilages allow
13 an administrator to completely manipulate a users record.
14
15 The defined fields are:
16 itemize(
17   it() cn - Common (first) name. [root]
18   it() mn - Middle name or initial. [root]
19   it() sn - Surname (last name). [root]
20   it() cn - ISO 3166 country code, see file(/usr/share/zoneinfo/iso3166.tab)
21             Should be upper case.
22   it() ircnick - IRC nickname.
23   it() l - City name, state/province. The part of a mailing address that is
24            not the street address. e.g.: Dallas, Texas
25   it() postalcode - Postal Code or ZIP Code 
26   it() postaladdress - Complete mailing address including postal codes and
27            country designations. Newlines are seperated by a $ character. The
28            address should be formed exactly as it would appear on a parcel.
29   it() latitude/longitude - The physical latitude and longitude. This 
30            information is typically used to generate an xearth marker file. 
31            See the discussion below on position formats.
32   it() facsimiletelephonenumber - FAX phone number, do not forget to specify a
33            country code [North Armerica is +1].
34   it() telephonenumber - Voice phone number. 
35   it() loginshell - Full path to the prefered Unix login shell. e.g. file(/bin/bash)
36   it() emailforward - Destination email address.
37   it() userpassword - Encrypted version of the password. [root]
38   it() supplementarygid - A list of group names that the user belongs.
39            This field emulates the functionality of the traditional Unix group
40            file. [root]
41   it() onvacation - A message indicating that the user is on vacation. The
42            time of departure and expected return date should be included as
43            well as any special instructions.
44   it() comment - Administrative comment about the account. [root]
45   it() labeledurl - User's web site.
46 )  
47
48 When prompted for a password it is possible to enter a blank password and
49 access the database anonymously. This is useful to check PGP key
50 fingerprints, for instance.
51
52 manpagesection(SECURITY AND PRIVACY)
53 Three levels of information security are provided by the database. The first
54 is completely public information that anyone can see either by issuing an
55 LDAP query or by visiting the web site. The next level is "maintainer-only"
56 information that requires authentication to the directory before it can be
57 accessed. The final level is admin-only or user-only information; this
58 information can only be viewed by the user or an administrator. 
59
60 Maintainer-only information includes precise location information
61 [postalcode, postal address, lat/long] telephone numbers, and the vacation
62 message.
63
64 Admin-only/maintainer-only information includes email forwarding and the 
65 encrypted password. Note that email forwarding is necessarily publicly viewable 
66 from accounts on the actual machines.
67
68 manpagesection(LAT/LONG POSITION)
69 There are three possible formats for giving position information and several
70 online sites that can give an accurate position fix based on mailing address.
71
72 startdit()
73 dit(Decimal Degrees)
74 The format is +-DDD.DDDDDDDDDDDDDDD. This is the format programs like
75 bf(xearth)
76 use and the format that many positioning web sites use. However typically
77 the precision is limited to 4 or 5 decimals.
78
79 dit(Degrees Minutes (DGM))
80 The format is +-DDDMM.MMMMMMMMMMMMM. It is not an arithmetic type, but a
81 packed representation of two seperate units, degrees and minutes. This
82 output is common from some types of hand held GPS units and from NMEA format
83 GPS messages.
84
85 dit(Degrees Minutes Seconds (DGMS))
86 The format is +-DDDMMSS.SSSSSSSSSSS. Like DGM, it is not an arithmetic type but
87 a packed representation of three seperate units, degrees minutes and
88 seconds. This output is typically derived from web sites that give 3 values
89 for each position. For instance 34:50:12.24523 North might be the position
90 given, in DGMS it would be +0345012.24523.
91 enddit()
92
93 For Latitude + is North, for Longitude + is East. It is important to specify
94 enough leading zeros to dis-ambiguate the format that is being used if your
95 position is less than 2 degrees from a zero point.
96
97 So locations to find positioning information are:
98
99 itemize(
100  it() Good starting point - http://www.ckdhr.com/dns-loc/finding.html
101  it() AirNav - GPS locations for airports around the world http://www.airnav.com/
102  it() GeoCode - US index by ZIP Code http://www.geocode.com/eagle.html-ssi
103  it() Map Blast! Canadian, US and some European maps - http://www.mapblast.com/
104  it() Australian Database http://www.environment.gov.au/database/MAN200R.html
105  it() Canadian Database http://GeoNames.NRCan.gc.ca/
106  it() GNU Timezone database, organized partially by country /usr/share/zoneinfo/zone.tab
107 )
108
109 Remember that we are after reasonable coordinates for drawing an xearth
110 graph and looking for people to sign keys, not for coordinates accurate
111 enough to land an ICBM on your doorstop!
112
113 manpagesection(Editing Supplemental GIDs)
114 When the root function is activated then the supplemental GIDs can be
115 manipulated as a list of items. It is possible to add and remove items from
116 the list by name. Proper prompts are given.
117
118 manpageoptions()
119 startdit()
120 dit(bf(-a))
121 Set the authentication user. This is the user whose authority is used when 
122 accessing the LDAP directory. The default is to use the current system user
123 name.
124
125 dit(bf(-u))
126 Select the user whose fields will be displayed/edited. The default is to use
127 the current system user name.
128
129 dit(bf(-c))
130 Set both the authentication user and the target user. This option is useful
131 if the login name does not match the user who is operating the program.
132
133 dit(bf(-r))
134 Enable root functions. This enables more options to allow changing
135 any entry in the directory. This function only has meaning if the
136 authentication user has the necessary permissions at the LDAP server.
137
138 dit(bf(-n))
139 No actions. Anonymously bind and show the information for the user and then
140 exit.
141 enddit()
142
143 manpagefiles()
144 itemize(
145   it() /etc/userdir-ldap/userdir-ldap.conf
146   Configuration variables to select what server and what base DN to use.
147 )
148         
149 manpageauthor()
150 userdir-ldap was written by Jason Gunthorpe <jgg@debian.org>.
151