Added host ACL
[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() allowedhosts - Permits access to hosts outside of the group list. [root]
42   it() onvacation - A message indicating that the user is on vacation. The
43            time of departure and expected return date should be included as
44            well as any special instructions.
45   it() comment - Administrative comment about the account. [root]
46   it() labeledurl - User's web site.
47 )  
48
49 When prompted for a password it is possible to enter a blank password and
50 access the database anonymously. This is useful to check PGP key
51 fingerprints, for instance.
52
53 manpagesection(SECURITY AND PRIVACY)
54 Three levels of information security are provided by the database. The first
55 is completely public information that anyone can see either by issuing an
56 LDAP query or by visiting the web site. The next level is "maintainer-only"
57 information that requires authentication to the directory before it can be
58 accessed. The final level is admin-only or user-only information; this
59 information can only be viewed by the user or an administrator. 
60
61 Maintainer-only information includes precise location information
62 [postalcode, postal address, lat/long] telephone numbers, and the vacation
63 message.
64
65 Admin-only/maintainer-only information includes email forwarding and the 
66 encrypted password. Note that email forwarding is necessarily publicly viewable 
67 from accounts on the actual machines.
68
69 manpagesection(LAT/LONG POSITION)
70 There are three possible formats for giving position information and several
71 online sites that can give an accurate position fix based on mailing address.
72
73 startdit()
74 dit(Decimal Degrees)
75 The format is +-DDD.DDDDDDDDDDDDDDD. This is the format programs like
76 bf(xearth)
77 use and the format that many positioning web sites use. However typically
78 the precision is limited to 4 or 5 decimals.
79
80 dit(Degrees Minutes (DGM))
81 The format is +-DDDMM.MMMMMMMMMMMMM. It is not an arithmetic type, but a
82 packed representation of two seperate units, degrees and minutes. This
83 output is common from some types of hand held GPS units and from NMEA format
84 GPS messages.
85
86 dit(Degrees Minutes Seconds (DGMS))
87 The format is +-DDDMMSS.SSSSSSSSSSS. Like DGM, it is not an arithmetic type but
88 a packed representation of three seperate units, degrees minutes and
89 seconds. This output is typically derived from web sites that give 3 values
90 for each position. For instance 34:50:12.24523 North might be the position
91 given, in DGMS it would be +0345012.24523.
92 enddit()
93
94 For Latitude + is North, for Longitude + is East. It is important to specify
95 enough leading zeros to dis-ambiguate the format that is being used if your
96 position is less than 2 degrees from a zero point.
97
98 So locations to find positioning information are:
99
100 itemize(
101  it() Good starting point - http://www.ckdhr.com/dns-loc/finding.html
102  it() AirNav - GPS locations for airports around the world http://www.airnav.com/
103  it() GeoCode - US index by ZIP Code http://www.geocode.com/eagle.html-ssi
104  it() Map Blast! Canadian, US and some European maps - http://www.mapblast.com/
105  it() Australian Database http://www.environment.gov.au/database/MAN200R.html
106  it() Canadian Database http://GeoNames.NRCan.gc.ca/
107  it() Atlas of the World, indexed by city http://www.astro.com/atlas/
108  it() GNU Timezone database, organized partially by country /usr/share/zoneinfo/zone.tab
109 )
110
111 Remember that we are after reasonable coordinates for drawing an xearth
112 graph and looking for people to sign keys, not for coordinates accurate
113 enough to land an ICBM on your doorstop!
114
115 manpagesection(Editing Supplemental GIDs)
116 When the root function is activated then the supplemental GIDs can be
117 manipulated as a list of items. It is possible to add and remove items from
118 the list by name. Proper prompts are given.
119
120 manpageoptions()
121 startdit()
122 dit(bf(-a))
123 Set the authentication user. This is the user whose authority is used when 
124 accessing the LDAP directory. The default is to use the current system user
125 name.
126
127 dit(bf(-u))
128 Select the user whose fields will be displayed/edited. The default is to use
129 the current system user name.
130
131 dit(bf(-c))
132 Set both the authentication user and the target user. This option is useful
133 if the login name does not match the user who is operating the program.
134
135 dit(bf(-r))
136 Enable root functions. This enables more options to allow changing
137 any entry in the directory. This function only has meaning if the
138 authentication user has the necessary permissions at the LDAP server.
139
140 dit(bf(-n))
141 No actions. Anonymously bind and show the information for the user and then
142 exit.
143 enddit()
144
145 manpagefiles()
146 itemize(
147   it() /etc/userdir-ldap/userdir-ldap.conf
148   Configuration variables to select what server and what base DN to use.
149 )
150         
151 manpageauthor()
152 userdir-ldap was written by Jason Gunthorpe <jgg@debian.org>.
153