Annotation of 43BSDReno/contrib/isode-beta/doc/manual/q-fred.tex, revision 1.1.1.1

1.1       root        1: % run this through LaTeX with the appropriate wrapper
                      2: 
                      3: \chapter{FRED}
                      4: \label{DUA:fred}
                      5: \pgm{fred} is a DUA optimised for White Pages queries, it is actually
                      6: implemented as an interface to \pgm{dish}, hence the name FRED -- FRont End
                      7: to Dish.
                      8: 
                      9: \section      {Giving Commands to Fred}\label{fred:commands}
                     10: After invoking \pgm{fred},
                     11: you are prompted with ``\verb"fred> "'' indicating that \pgm{fred} is ready.
                     12: 
                     13: If \pgm{fred} is invoked interactively,
                     14: it will look for a file in your home directory called \file{.fredrc}.
                     15: It will execute the commands contained in this file just as if you had typed
                     16: them directly to \pgm{fred}.
                     17: Following this,
                     18: you are given the ``\verb"fred>"'' prompt.
                     19: 
                     20: \section      {Let your Fingers do the Walking}
                     21: Although \pgm{fred} has several commands,
                     22: the most interesting command is \verb"whois",
                     23: which performs a white pages query.
                     24: 
                     25: Let's begin with some simple examples and introduce the other commands along
                     26: the way.
                     27: If you already know the handle of the person you're interested in finding out
                     28: about,
                     29: just give the handle:
                     30: \begin{quote}\smaller\begin{verbatim}
                     31: fred> whois @c=US@cn=Manager
                     32: Manager (1)
                     33: 
                     34: Handle:        @c=US@cn=Manager
                     35: \end{verbatim}\end{quote}
                     36: 
                     37: \subsection    {The Alias Command}
                     38: Since handles are long strings,
                     39: \pgm{fred} will automatically maintain a list of aliases of the entries you
                     40: have seen in the current session.
                     41: The alias is always a number.
                     42: When an entry is displayed,
                     43: it appears on the first line in parenthesis after the name of the object.
                     44: In the example above,
                     45: the alias is \verb"1".
                     46: 
                     47: To find out what aliases are currently defined,
                     48: use the \verb"alias" command:
                     49: \begin{quote}\smaller\begin{verbatim}
                     50: fred> alias
                     51: 1    @c=US@cn=Manager
                     52: \end{verbatim}\end{quote}
                     53: Thus,
                     54: the previous \verb"whois" command could have been shortened to simply:
                     55: \begin{quote}\small\begin{verbatim}
                     56: fred> whois !1
                     57: Manager (1)
                     58: 
                     59: Handle:        @c=US@cn=Manager
                     60: \end{verbatim}\end{quote}
                     61: Each time you invoke \pgm{fred},
                     62: its list of aliases is empty.
                     63: If there are few handles which you use often,
                     64: you might wish to define them in your \file{.fredrc} file,
                     65: e.g.,
                     66: \begin{quote}\small\begin{verbatim}
                     67: alias "@c=US@o=NYSERNet Inc.@cn=Manager"
                     68: \end{verbatim}\end{quote}
                     69: Of course,
                     70: the ordering of aliases is important.
                     71: \pgm{fred} will start numbering from~1 starting with the first \verb"alias"
                     72: command.
                     73: 
                     74: \subsection    {Back to Searching}
                     75: Suppose however,
                     76: that you don't know the handle for the person.
                     77: In this case,
                     78: you need to specify some search parameters.
                     79: Logically,
                     80: the first step is to ascertain the organization which the person is likely to
                     81: be associated with, e.g.,
                     82: ``NYSERNet, Inc.''.
                     83: This is done as:
                     84: \begin{quote}\smaller\begin{verbatim}
                     85: fred> whois organization nyser
                     86: NYSERNet Inc. (2)               +1 518-283-8860
                     87:   165 Jordan Road
                     88:   Troy
                     89:   New York
                     90:   12180
                     91: 
                     92: FAX:       +1 518-283-8904
                     93: 
                     94: Not-for-profit organization providing network services and software
                     95: 
                     96: See Also:      @c=US@o=NYSERNet Inc.@cn=Manager
                     97: 
                     98: Handle:        @c=US@o=NYSERNet Inc.
                     99: \end{verbatim}\end{quote}
                    100: Second,
                    101: to search for a particular person,
                    102: you might use:
                    103: \begin{quote}\small\begin{verbatim}
                    104: fred> whois rose -area 2
                    105: Marshall Rose (3)            [email protected]
                    106:     aka: Marshall T. Rose
                    107: 
                    108:     Principal Scientist
                    109:     PSI, Inc.
                    110:     PSI California Office
                    111:     POB 391776
                    112:     Mountain View, CA  94039
                    113: 
                    114: Telephone:    +1 415-961-3380
                    115: FAX:          +1 415-961-3282
                    116: 
                    117: Mailbox information:
                    118:     Internet: [email protected]
                    119:     UUCP:     nyser!mrose
                    120: 
                    121: Principal Implementor of the ISO Development Environment
                    122: 
                    123: Handle:        @c=US@o=NYSERNet Inc.@ou=Research ...
                    124: \end{verbatim}\end{quote}
                    125: Note the use of the alias \verb"2".
                    126: The command could also have been:
                    127: \begin{quote}\small\begin{verbatim}
                    128: fred> whois rose -area "@c=US@o=NYSERNet Inc."
                    129:     ...
                    130: \end{verbatim}\end{quote}
                    131: Double-quotes are used so that the DN appears as a single token to \pgm{fred}.
                    132: 
                    133: Of course,
                    134: this two-step process,
                    135: whilst logical, is tedious.
                    136: Thus, you can combine them like this:
                    137: \begin{quote}\small\begin{verbatim}
                    138: fred> whois rose -org nyser
                    139:     ...
                    140: \end{verbatim}\end{quote}
                    141: which says to look for any organizations with ``nyser'' in its name.
                    142: Then, for each of these,
                    143: look for something called ``rose''.
                    144: 
                    145: \subsection    {The Area Command}
                    146: Suppose
                    147: you want information on several persons belonging to an organization.
                    148: You can use the \verb"area" command,
                    149: by itself,
                    150: to tell \pgm{fred} where to search for subsequent commands.
                    151: For example,
                    152: \begin{quote}\small\begin{verbatim}
                    153: fred> area "@c=US@o=NYSERNet Inc."
                    154: \end{verbatim}\end{quote}
                    155: or simply
                    156: \begin{quote}\small\begin{verbatim}
                    157: fred> area 2
                    158: \end{verbatim}\end{quote}
                    159: both tell \pgm{fred} the default area used by the \verb"whois" command.
                    160: Of course,
                    161: you can still use the \switch"area" area with the \verb"whois" command to
                    162: override the default area.
                    163: Thus,
                    164: \begin{quote}\small\begin{verbatim}
                    165: fred> whois alan -area "@c=US@o=Columbia University"
                    166: \end{verbatim}\end{quote}
                    167: will do what you expect.
                    168: 
                    169: If you use the \verb"area" command without any arguments,
                    170: \pgm{fred} will tell you what its default area is:
                    171: \begin{quote}\small\begin{verbatim}
                    172: fred> area
                    173: @c=US@o=Yoyodyne
                    174: \end{verbatim}\end{quote}
                    175: This indicates the default area for all commands,
                    176: {\em including\/} any subsequent \verb"area" commands.
                    177: Thus,
                    178: issuing:
                    179: \begin{quote}\small\begin{verbatim}
                    180: fred> area @c=US@o=Yoyodyne
                    181: @c=US@o=Yoyodyne
                    182: 
                    183: fred> area ou=Research
                    184: @c=US@o=Yoyodyne@ou=Research
                    185: \end{verbatim}\end{quote}
                    186: is equivalent to
                    187: \begin{quote}\small\begin{verbatim}
                    188: fred> area @c=US@o=Yoyodyne@ou=Research
                    189: @c=US@o=Yoyodyne@ou=Research
                    190: \end{verbatim}\end{quote}
                    191: because a leading \verb"`@'"-sign was not used before \verb"ou=Research".
                    192: 
                    193: As you might expect,
                    194: there is a special string ``\verb".."'' which may be used to move up one level:
                    195: \begin{quote}\small\begin{verbatim}
                    196: fred> area ..
                    197: @c=US@o=Yoyodyne
                    198: \end{verbatim}\end{quote}
                    199: Combinations are possible as well,
                    200: such as:
                    201: \begin{quote}\small\begin{verbatim}
                    202: fred> area ..@"NYSERNet Inc."
                    203: @c=US@o=NYSERNet Inc.
                    204: \end{verbatim}\end{quote}
                    205: which moves up a level and then down to \verb"o=NYSERNet Inc."
                    206: 
                    207: \subsection    {Getting Help}
                    208: For a brief summary of \pgm{fred} commands,
                    209: type:
                    210: \begin{quote}\small\begin{verbatim}
                    211: fred> help ?
                    212: \end{verbatim}\end{quote}
                    213: This will list the commands that \pgm{fred} knows about
                    214: along with a one-line summary of their function.
                    215: 
                    216: For help on a particular command,
                    217: type the name of the command followed by \switch"help",
                    218: e.g.,
                    219: \begin{quote}\small\begin{verbatim}
                    220: fred> alias -help
                    221: \end{verbatim}\end{quote}
                    222: 
                    223: If you need more help,
                    224: try
                    225: \begin{quote}\small\begin{verbatim}
                    226: fred> manual
                    227: \end{verbatim}\end{quote}
                    228: which is the same as
                    229: \begin{quote}\small\begin{verbatim}
                    230: % man fred
                    231: \end{verbatim}\end{quote}
                    232: from the shell.
                    233: 
                    234: \subsection    {Quitting}
                    235: To terminate \pgm{fred},
                    236: simply use:
                    237: \begin{quote}\small\begin{verbatim}
                    238: fred> quit
                    239: \end{verbatim}\end{quote}
                    240: 
                    241: \section {Advanced Usage}
                    242: 
                    243: This Chapter has given a very brief overview of the basic Fred commands, 
                    244: for full details you should consult~\cite{NYSER.Fred}, which tells you how
                    245: to make more complex search requests, edit your own entry and how to use
                    246: Fred to compose mail addresses using the \MH/ mail system.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.