3 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1992, 1993 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
23 #include <ac/string.h>
34 int len; /* command length */
38 printf("->print_help(%s)\n", s);
44 if (!strcasecmp(s, "commands"))
48 /* print general help, or just on topic 's' if provided */
50 printf("\n Here are brief descriptions of available commands:\n\n");
51 printf(" ? To print this list.\n");
52 printf(" bind [who] To bind (authenticate) to the directory.\n");
53 printf(" cb [where] To change the search base.\n");
54 printf(" change [entry] To change information associated with an entry.\n");
55 printf(" create [group] To create a new group entry.\n");
56 printf(" dereference To toggle dereferencing of aliases.\n");
60 printf(" vedit [entry] To edit a complete Directory entry using your editor.\n");
64 printf(" find [entry] To find an entry in the directory.\n");
66 printf(" groupbase [where] To change the group base.\n");
67 printf(" help [command] To display detailed help for a particular command.\n");
68 printf(" join [group] To subscribe to a group.\n");
69 printf(" list [who] To list the groups owned by someone.\n");
70 printf(" memberships [who] To list out the groups in which someone is a member.\n");
71 printf(" purge [group] To remove obsolete entries from a group.\n");
72 printf(" quit To terminate the program.\n");
73 printf(" remove [group] To remove a group entry.\n");
74 printf(" resign [group] To unsubscribe from a group.\n");
75 printf(" status To display directory connection status.\n");
76 printf(" tidy To unsubscribe from groups that no longer exist.\n");
77 printf(" verbose To toggle the verbose switch.\n");
79 printf("\n Type \"help <command-name>\" to get help about a particular command.");
80 printf("\n Type \"help options\" to get help about options in brackets above.\n");
82 printf("\n Bugs in ud should be reported via e-mail to: OpenLDAP-its@OpenLDAP.org\n" );
83 printf("\n For more assistance with ud, contact the ITD Consultants by phoning\n" );
84 printf(" 764-HELP or by sending e-mail to: consulting.help@umich.edu\n" );
87 else if (!strncasecmp("options", s, len)) {
89 format("Most commands need additional information in order to work. For example, the 'remove' command needs to know the name of the group to remove. This can be specified along with the 'remove' command, or the program will prompt you for the information.", 75, 2);
91 printf(" [entry] An entry needs to be specified. This may be a person or a\n");
92 format("group. The name can be specified as either a ordinary name (e.g., 'Jane Doe'), or as some other identifying characteristic (e.g., 'uid=babs').", 75, 15);
94 printf(" [group] A group in the Directory needs to be specified. This name\n");
95 format("should be specified as a ordinary name (e.g., 'Friends of maX500').", 75, 15);
97 printf(" [where] A place in the Directory needs to be specified. This name\n");
98 format("should be specified as an LDAP-style name (e.g., 'ou=people, o=University of Michigan, c=United States of America'). In most cases, it is easier to omit the [where] and allow the program to guide you.", 75, 15);
100 printf(" [who] A person in the Directory needs to be specified. This name\n");
101 format("can be specified as either a ordinary name (e.g., 'Jane Doe'), or as some other identifying characteristic (e.g., 'uid=babs').", 75, 15);
103 else if (!strncasecmp("list", s, len)) {
104 printf(" list [who]\n\n");
105 format("Prints out the list of groups owned by the person specified.", 75, 2);
107 else if (!strncasecmp("memberships", s, len)) {
108 printf(" memberships [who]\n\n");
109 format("Prints out the list of groups in which the person specified is a member.", 75, 2);
111 else if (!strncasecmp("vedit", s, len)) {
112 printf(" vedit [entry]\n\n");
113 format("Looks up the specified person in the Directory, and then writes this entry into a file. It then uses the EDITOR environment variable to select an editor, and then loads this file into the editor. The entry can now be modified in any way desired, and when the editor is exited, the entry will be written back into the Directory.", 75, 2);
115 else if (!strncasecmp("status", s, len)) {
116 printf(" status\n\n");
117 format("Prints out the current connection status. Lists the name of the current LDAP server, the current search base, the current group base, and the identity to which you are bound. If you have not bound as anyone then ud considers you bound as Nobody. cd is an alias for cb.", 75, 2);
119 else if (!strncasecmp("groupbase", s, len)) {
120 printf(" groupbase [where]\n\n");
121 format("The syntax and use of this command is identical to the more commonly used 'cb' command. This command sets the base which is used to create groups in the LDAP Directory. Setting the base to a certain value does not necessarily grant the person write-access to that part of the Directory in order to successfully create a group.", 75, 2);
123 else if (!strncasecmp("cd", s, len) || !strncasecmp("cb", s,len)) {
124 printf(" cb [where]\n");
125 printf(" cd [where]\n\n");
126 format("The cb command changes the search base. By default, this program looks only in the local part of the Directory. By using the cb command, you can search other parts of the Directory.", 75, 2);
127 printf("\n Examples:\n");
128 printf("\n * cb ..\n\n");
129 format("changes the search base so that it is one level higher in the Directory. Note that if you perform several of these in a row you will move to the root of the Directory tree.", 75, 2);
130 printf("\n * cb ?\n\n");
131 format("prints out a list of the possible areas to search below the current search base. This is useful once you have moved high in the tree and wish to snoop about.", 75, 2);
132 printf("\n * cb default\n\n");
133 format("sets the search base to its original default value.", 75, 2);
134 printf("\n * cb o=Merit Computer Network, c=US\n\n");
135 format("sets the search base to organization given, the Merit Computer Network in this case. This comamnd checks the validity of the specified search base, and rejects it if it is not a valid Distinguished Name (DN). A DN uniquely identifies a portion of the global LDAP namespace.", 75, 2);
137 else if (!strncasecmp("quit", s, len) || !strncasecmp("stop",s, len)) {
140 printf(" Quits the program. 'stop' is an alias for 'quit'.\n");
142 else if (!strncasecmp("find", s, len) || !strncasecmp("display", s, len) || !strncasecmp("show", s, len)) {
143 printf(" find [entry]\n");
144 printf(" show [entry]\n");
145 printf(" display [entry]\n\n");
146 format("Displays information about the person specified. If the name specified matches more than one person, one will be presented a list from which to make a choice. 'show' and 'display' are aliases for 'find.'", 75, 2);
148 else if (!strncasecmp("bind", s, len)) {
149 printf(" bind [who]\n\n");
150 format("Binds (authenticates) to the Directory. It is generally necessary to bind to the Directory in order to look at privileged entries or to modify an entry. Allows one to authenticate prior to issuing a 'change' or 'modify' command. Most often used by administrators to bind to an identity.", 75, 2);
152 else if (!strncasecmp("modify", s, len) || !strncasecmp("change", s, len)) {
153 printf(" modify [entry]\n");
154 printf(" change [entry]\n\n");
155 format("Changes information associated with an entry in the LDAP Directory. 'change' is an alias for 'modify'.", 75, 2);
157 else if (!strncasecmp("verbose", s, len)) {
158 printf(" verbose\n\n");
159 format("Turns on long and windy messages which might be useful to new users of this program. If verbose mode is already on, this turns it off.", 75, 2);
161 else if (!strncasecmp("dereference", s, len)) {
162 printf(" dereference\n\n");
163 format("Turns off following of aliases when searching, etc. If alias dereferencing has already been turned off, this turns it back on.", 75, 2);
165 else if (!strncasecmp("create", s, len)) {
166 printf(" create [group]\n\n");
167 format("Creates a new group in the Directory.", 75, 2);
169 else if (!strncasecmp("join", s, len) || !strncasecmp("subscribe", s, len)) {
170 printf(" join [group]\n");
171 printf(" subscribe [group]\n\n");
172 format("Adds the person as a subscriber to the specified group.", 75, 2);
174 else if (!strncasecmp("purge", s, len)) {
175 printf(" purge [group]\n\n");
176 format("Goes through the specified group looking for Distinguished Names that cannot be found. As it finds each one, it gives the person an opportunity to delete it.", 75, 2);
178 else if (!strncasecmp("resign", s, len) || !strncasecmp("unsubscribe", s, len)) {
179 printf(" resign [group]\n");
180 printf(" unsubscribe [group]\n\n");
181 format("Deletes the person from the specified group.", 75, 2);
183 else if (!strncasecmp("remove", s, len)) {
184 printf(" remove [group]\n\n");
185 format("Removes a group from the Directory.", 75, 2);
187 else if (!strncasecmp("help", s, len)) {
188 format("Prints out a brief description of each command.", 75, 2);
190 else if (!strncasecmp("tidy", s, len)) {
192 format("Unsubscribes you from non-existent groups. Useful when you cannot resign from a group because, while your LDAP entry still contains a pointer to it, someone has removed a group of which you were a subscriber.", 75, 2);
194 else if (*s == '?') {
195 format("Prints out a brief description of each command. Same as typing 'help help'.", 75, 2);
198 printf(" Don't recognize <%s>\n", s);