![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to fred.1c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [CSRG BSD Unix] / 43BSDReno / contrib / isode-beta / others / quipu / uips / fred|
Return to fred.1c CVS log | Up to [CSRG BSD Unix] / 43BSDReno / contrib / isode-beta / others / quipu / uips / fred |
1.1 root 1: .TH FRED 1C "06 Jan 1990"
2: .\" $Header: /f/osi/others/quipu/uips/fred/RCS/fred.1c,v 7.5 90/07/09 14:41:12 mrose Exp $
3: .\"
4: .\"
5: .\" $Log: fred.1c,v $
6: .\" Revision 7.5 90/07/09 14:41:12 mrose
7: .\" sync
8: .\"
9: .\" Revision 7.4 90/06/11 10:55:09 mrose
10: .\" UFN
11: .\"
12: .\" Revision 7.3 90/03/22 08:36:32 mrose
13: .\" touch-up
14: .\"
15: .\" Revision 7.2 90/03/08 08:05:04 mrose
16: .\" phone
17: .\"
18: .\" Revision 7.1 90/01/11 18:36:25 mrose
19: .\" real-sync
20: .\"
21: .\" Revision 7.0 89/11/23 22:08:54 mrose
22: .\" Release 6.0
23: .\"
24: .SH NAME
25: fred \- a white pages user interface (FRont-End to Dish)
26: .SH SYNOPSIS
27: .in +.5i
28: .ti -.5i
29: .B fred
30: \%[options]
31: \%[command\0arguments\0...]
32: .sp
33: .ti -.5i
34: .B whois
35: arguments\0...
36: (as in \*(lq\fBfred\0whois\fR\0rose\0\fB-org\fR\0psi\*(rq)
37: .in -.5i
38: .SH DESCRIPTION
39: The \fIfred\fR program is a front-end to the OSI Directory,
40: and in particular the \fIdish\fR\0(1c) program.
41: It is most useful as an interface to the white pages service.
42: .PP
43: The \fIfred\fR program is meant to be similar to the WHOIS service
44: familiar to most users of the network.
45: There are some differences however.
46: .PP
47: First,
48: users in the white pages are uniquely identified by
49: their \fIdistinguished name\fR, e.g.,
50: .sp
51: .in +.5i
52: .nf
53: \*(lq@c=US@o=NYSERNet Inc.@cn=Manager\*(rq
54: .fi
55: .in -.5i
56: .sp
57: In contrast,
58: users of the WHOIS service are uniquely identified by their WHOIS
59: handle,
60: a brief key, e.g., \*(lqMTR\*(rq.
61: Since distinguished names are much longer than WHOIS handles,
62: \fIfred\fR maintains a list of aliases during its execution.
63: When an entry for something is retrieved,
64: it is assigned a numeric alias for its name.
65: .PP
66: Second,
67: searches in the white pages are relative to an \*(lqarea\*(rq.
68: The default area is set by your system administrator.
69: It can be changed using the \fIarea\fR command.
70: Because the white pages are distributed,
71: searches occurring at higher areas are more expensive in terms of
72: time,
73: networking resources, etc.
74: .PP
75: Third,
76: the white pages are highly structured.
77: As such,
78: you can potentially retrieve much more detailed information about an entry.
79: Although the \fIfred\fR should prove useful for the majority of
80: queries,
81: it is purposefully limited in its searching capabilities.
82: Users desiring a more powerful interface,
83: should use \fIdish\fR\0(1c) directly.
84: .SH EXAMPLES
85: The command syntax,
86: while meant to be intuitive,
87: is tedious.
88: Here are a few simple examples:
89: .IP whois\0\*(lqsmith\*(rq
90: looks for any entries with this name in the default area
91: (choice of matching on the entry's surname or fullname is based on the
92: value of the `namesearch' variable).
93: .IP whois\0surname\0\*(lqsmith\*(rq
94: looks for any entries with this surname.
95: .IP whois\0fullname\0\*(lqjohn\0smith\*(rq
96: looks for any entries with this fullname.
97: .IP whois\0\*(lqsmith\*(rq\0\-org\0nyser
98: looks for any entries with this name in any organization with
99: \*(lqnyser\*(rq in its name.
100: This is probably the most common usage of the program.
101: .IP whois\0\*(lqsmith\*(rq\0\-area\0\*(lq@c=US@o=NYSERNet\0Inc.\*(rq
102: could be used if you already know the \*(lqarea\*(rq that the user resides in.
103: .IP whois\0\*(lqsmith\*(rq\0\-area\017
104: could be used if an alias were already established for this area.
105: .IP whois\0@c=US@cn=Manager
106: looks for the entry with this distinguished name (handle).
107: .IP whois\0!7
108: could be used if an alias were already established for this entry.
109: .IP whois\[email protected]
110: looks for any entries with the given mailbox.
111: .IP whois\0\-title\0operator
112: looks for any entries who are operators.
113: .IP whois\0-org\0*
114: reports on all registered organizations (in the default geographical area).
115: .IP whois\0-org\0*\0-geo\0@c=GB
116: reports on all registered organizations under @c=GB.
117: .PP
118: Here is a somewhat more common example:
119: .sp
120: .in +.5i
121: .nf
122: fred> whois schoffstall -org psi
123: Trying @c=US@o=Performance Systems International ...
124: 3 matches found.
125: 2. Marvin Schoffstall [email protected]
126: 3. Martin Schoffstall [email protected]
127: 4. Steve Schoffstall [email protected]
128:
129: fred> whois !3
130: Martin Schoffstall (3) [email protected]
131: ...
132: .fi
133: .in -.5i
134: .SH COMMANDS
135: On start-up, \fIfred\fR will read a file called \fBfredrc\fR in the
136: ISODE system directory (usually \fB\*(ED\fR\0).
137: Then,
138: \fIfred\fR reads the file \fB\&.fredrc\fR in the user's home directory.
139: These files, if present, contain user-preference commands.
140: Afterwards,
141: \fIfred\fR prompts for commands.
142: .PP
143: Typing INTR at the top\-level does nothing,
144: but typing it twice in a row at the top\-level terminates \fIfred\fR;
145: typing INTR during additional prompting causes \fIfred\fR to abort
146: the command.
147: .TP
148: .B alias\fR\0\%[name]
149: With no arguments,
150: prints all aliases defined for this session.
151: With an argument,
152: defines a numeric alias for that name.
153: .TP
154: .B area\fR\0\%[\%[record-type] location]
155: With no arguments,
156: prints the default area used by the \fIwhois\fR command when
157: consulting the white pages.
158: With a single argument,
159: this sets the default area.
160: The distinguished value \*(lq\&.\&.\*(rq may be used to go up one
161: level in the tree.
162: If the value is relative (i.e., does not start with the
163: \*(lq@\*(rq-sign),
164: then the value is appended onto the current location.
165: With two arguments,
166: this sets the default area for searches of the indicated record type
167: (which are described in the next section).
168: This is particularly useful since it also provides heuristics to the
169: \fIwhois\fR command as to the depth to be used for searching.
170: .TP
171: .B edit
172: Invokes an editor to modify the user's entry in the white pages.
173: .TP
174: .B help\fR\0\%[command\0...]
175: Prints help information.
176: For detailed information, try \*(lqhelp\0?\*(rq.
177: .TP
178: .B manual
179: Prints this detailed documentation about \fIfred\fR.
180: .TP
181: .B quit
182: Terminates \fIfred\fR.
183: .TP
184: .B report\fR\0\%[subject]
185: Allows you to enter a report that is mailed to your local white pages manager.
186: .TP
187: .B set\fR\0\%[variable\0\%[value]]
188: Manipulates \fIfred\fR's settings:
189: .sp
190: .in +.5i
191: .nf
192: .ta \w'\fBnamesearch\fR 'u
193: \fBvariable\fR \fBfunction\fR
194: debug debug \fIfred\fR
195: manager mail address of local white pages manager
196: namesearch type of name used for matching,
197: either \*(lqfullname\*(rq, \*(lqsurname\*(rq,
198: or \*(lqfriendly\*(rq
199: pager program to use for terminal pagination
200: phone display phone numbers in one-liner
201: query confirm two-step operations
202: soundex use soundex for matching,
203: when no wildcards are present
204: timelimit maximum number of seconds to
205: spend searching
206: verbose verbose interaction
207: watch watch dialogue with \fIdish\fR
208: .re
209: .fi
210: .in -.5i
211: .TP
212: .B thisis\fR\0\%[name\0\%[password]]
213: Tells the white pages service who you are.
214: This is only needed when you want to modify your own entry.
215: Normally,
216: this is determined automatically when \fIfred\fR starts.
217: .TP
218: .B whois\fR\0\%[arguments\0...]
219: Consults the white pages.
220: .SH WHOIS
221: If the value of the `namesearch' variable is \*(lqfriendly\*(rq,
222: then Kille's user-friendly name notation is used.
223: Kille's notation is ordered but untyped,
224: with components separated by commas.
225: Typical names include:
226: .sp
227: .in +.5i
228: .nf
229: rose, psi
230: kille, cs, ucl, gb
231: L. Eagle, \*(lqSue, Grabbit and Runn\*(rq, GB
232: .fi
233: .in -.5i
234: .sp
235: Note that you don't have to know all of the components\0--\0just list
236: what you know, left-to-right, starting with the person's name.
237: The user-friendly searching algorithim will usually figure out what
238: you mean.
239: This is the preferred syntax as it is the most intuitive.
240: .PP
241: Otherwise,
242: the syntax of the \fIwhois\fR command is similar to that provided by
243: the WHOIS service:
244: .sp
245: .in +.5i
246: .nf
247: input-field \%[record-type] \%[area-designator] \%[output-control]
248: .fi
249: .in -.5i
250: .sp
251: These four components may occur in any order.
252: Only the \fIinput-field\fR need be present.
253: .SS "INPUT FIELD"
254: This component tells the white pages what to look for.
255: .TP
256: .B \&.<name>\fR\0or\0\fBname\fR\0<name>
257: gives the name of the target.
258: .br
259: .B \fBsurname\fR\0<name>
260: .br
261: .B \fBfullname\fR\0<name>
262: .sp
263: Searching for names follows these rules:
264: if the \*(lq*\*(rq-sign appears at the beginning and/or end of the name,
265: then wildcard-style matching is used:
266: the \*(lq*\*(rq-sign matches zero or more characters at the beginning
267: or end of a name.
268: Otherwise,
269: if soundex has been enabled (set the variable `soundex' to `on'),
270: then imprecise matching occurs according to a Soundex algorithm.
271: Otherwise,
272: if searching is to occur for a person's surname,
273: then a case-insensitive match is used.
274: Finally,
275: as a last resort,
276: \fIfred\fR will force a rather liberal wildcard-style match.
277: .sp
278: For compatibility with the WHOIS service,
279: an input field of \*(lqNAME.\*(rq is equivalent to \*(lqNAME*\*(rq
280: (i.e., a partial match for names having the given prefix).
281: Similarly,
282: an input field of \*(lq*NAME\*(rq is equivalent to
283: \*(lqNAME\0expand\*(rq.
284: Thus, to have wildcard matching at the beginning of the name,
285: use two \*(lq*\*(rq-signs,
286: e.g., \*(lq**inc\*(rq matches names ending in \*(lqinc\*(rq.
287: (A terrible hack, but that's the price one pays to be consistent with the
288: WHOIS service.)
289: .TP
290: .B !<handle>\fR\0or\0\fBhandle\fR\0<handle>
291: gives the unique handle (distinguished name) of the target.
292: This may be an alias rather than a distinguished name.
293: .TP
294: .B mailbox\fR\0<mailbox>
295: gives the mailbox of the target.
296: .PP
297: If a keyword is not given,
298: then \fIfred\fR attempts to intuit which kind of input field is being provided.
299: In most cases,
300: \fIfred\fR will treat field as a name,
301: unless it contains the \*(lq@\*(rq-sign,
302: which makes it either a handle or a mailbox.
303: .SS "RECORD TYPE"
304: This component tells the white pages what kind of entry to look for.
305: .sp
306: .in +.5i
307: .nf
308: \fIperson\fR or \fI-title\fR\0NAME,
309: \fIorganization\fR,
310: \fIunit\fR (a division under an organization),
311: \fIrole\fR (a role within an organization),
312: \fIlocality\fR, or
313: \fIdsa\fR (a white pages server).
314: .fi
315: .in -.5i
316: .sp
317: If this component is not present,
318: \fIfred\fR will not limit its search to any particular kind of entry.
319: .SS "AREA DESIGNATOR"
320: This component takes one of two forms.
321: The most common form is one of the switches:
322: .sp
323: .in +.5i
324: .nf
325: \fI-org\fR (short for \fI-organization\fR\0),
326: \fI-unit\fR, or,
327: \fI-locality\fR,
328: .fi
329: .in -.5i
330: .sp
331: followed by a name.
332: For example,
333: .sp
334: .in +.5i
335: .nf
336: \&\-org nyser
337: .fi
338: .in -.5i
339: .sp
340: tells \fIfred\fR to limit the search to those organizations whose name
341: contains \*(lqnyser\*(rq.
342: .PP
343: In addition
344: the switch `-geo' followed by a location in the white pages may be
345: used to override the default area for searching for these objects.
346: For example,
347: .sp
348: .in +.5i
349: .nf
350: \&\-org ucl \&\-area @c=GB
351: .fi
352: .in -.5i
353: .sp
354: tells \fIfred\fR to limit the search to those organizations whose name
355: contains \*(lqucl\*(rq that reside directly under @c=GB.
356: .PP
357: In the second form,
358: the area designator consists of the switch \fI-area\fR followed by a
359: location in the white pages;
360: e.g.,
361: .sp
362: .in +.5i
363: .nf
364: \&\-area \*(lq@c=US@o=NYSERNet Inc.\*(rq
365: .fi
366: .in -.5i
367: .sp
368: Note the use of double-quotes to make the string following area appear
369: as a single argument.
370: If an alias has already been established for this location,
371: then the number of the alias can be used instead.
372: .SS "OUTPUT CONTROL"
373: .TP
374: .B expand\fR\0or\0\fB*\fR
375: give a detailed listing and show children of matched entries.
376: .TP
377: .B \~
378: The opposite of \fIexpand\fR.
379: (Included for compatibility with the WHOIS service.)
380: .TP
381: .B subdisplay\fR\0or\0\fB%\fR
382: give a one-line listing and show children of matched entries.
383: .TP
384: .B full\fR\0or\0\fB|\fR
385: give a detailed listing,
386: even on ambiguous matches
387: .TP
388: .B summary\fR\0or\0\fB$\fR
389: give a one-line listing,
390: even on unique matches.
391: .SH OPTIONS
392: .TP
393: .B \-f
394: Inhibits reading of the user's \fB\&.fredrc\fR on startup.
395: .TP
396: .B \-v
397: Sets \fBverbose\fR (default for interactive use).
398: .TP
399: .B \-w
400: Sets \fBwatch\fR.
401: .SH FILES
402: .nf
403: .ta \w'\*(EDdsaptailor 'u
404: \*(EDdsaptailor system QUIPU tailoring file
405: $HOME/\&.quipurc user's QUIPU tailoring file
406: \*(EDfredrc system runcom file
407: $HOME/\&.fredrc user's runcom file
408: .re
409: .fi
410: .SH "SEE ALSO"
411: dish(1c),
412: .br
413: \fINYSERNet White Pages Pilot Project: User's Guide\fR,
414: .br
415: \fIUsing the OSI Directory to achieve User Friendly Naming\fR,
416: .br
417: \fIThe ISO Development Environment: User's Manual--Volume 5: QUIPU\fR
418: .SH DIAGNOSTICS
419: All obvious.
420: .SH AUTHOR
421: Marshall T. Rose,
422: NYSERNet Inc.
423: .SH BUGS
424: The emulation of the old \fIwhois\fR command format is imperfect.
425: Most notably,
426: you need to quote names so they appear as a single token to the \fIfred\fR.
427: For example:
428: .sp
429: .in +.5i
430: % fred whois\0\*(lqDal\0Santo\*(rq
431: .in -.5i
432: .sp
433: won't work,
434: whilst
435: .sp
436: .in +.5i
437: % fred whois\0'\*(lqDal\0Santo\*(rq'
438: .in -.5i
439: .sp
440: will work (the shell strips off one layer of quoting).
441: That's progress for you.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.