home *** CD-ROM | disk | FTP | other *** search
/ ftp.cse.unsw.edu.au / 2014.06.ftp.cse.unsw.edu.au.tar / ftp.cse.unsw.edu.au / pub / doc / manuals / fred.1 next >
Encoding:
Text File  |  1992-10-18  |  12.1 KB  |  357 lines

  1. FRED(1C)                  USER COMMANDS                  FRED(1C)
  2.  
  3.  
  4.  
  5. NAME
  6.      fred - a white pages user interface (FRont-End to Dish)
  7.  
  8. SYNOPSIS
  9.      fred [options] [command arguments ...]
  10.  
  11.      whois arguments ...  (as in "fred whois rose -org psi")
  12.  
  13. DESCRIPTION
  14.      The fred program is a front-end to the OSI Directory, and in
  15.      particular  the  dish (1c) program.  It is most useful as an
  16.      interface to the white pages service.
  17.  
  18.      The fred program is meant to be similar to the WHOIS service
  19.      familiar  to  most  users  of  the  network.  There are some
  20.      differences however.
  21.  
  22.      First, users in the white pages are uniquely  identified  by
  23.      their distinguished name, e.g.,
  24.  
  25.           "@c=US@o=NYSERNet Inc.@cn=Manager"
  26.  
  27.      In contrast, users of the WHOIS service are uniquely identi-
  28.      fied by their WHOIS handle, a brief key, e.g., "MTR".  Since
  29.      distinguished names are much longer than WHOIS handles, fred
  30.      maintains  a  list of aliases during its execution.  When an
  31.      entry for something is retrieved, it is assigned  a  numeric
  32.      alias for its name.
  33.  
  34.      Second, searches in the  white  pages  are  relative  to  an
  35.      "area".   The default area is set by your system administra-
  36.      tor.  It can be changed using the area command.  Because the
  37.      white  pages  are  distributed, searches occurring at higher
  38.      areas are  more  expensive  in  terms  of  time,  networking
  39.      resources, etc.
  40.  
  41.      Third, the white pages are highly structured.  As such,  you
  42.      can  potentially  retrieve  much  more  detailed information
  43.      about an entry.  Although the fred should prove  useful  for
  44.      the  majority  of queries, it is purposefully limited in its
  45.      searching capabilities.   Users  desiring  a  more  powerful
  46.      interface, should use dish (1c) directly.
  47.  
  48. EXAMPLES
  49.      The command syntax, while meant to be intuitive, is tedious.
  50.      Here are a few simple examples:
  51.  
  52.      whois "smith"
  53.           looks for any entries with this  name  in  the  default
  54.           area  (choice  of  matching  on  the entry's surname or
  55.           fullname is based on  the  value  of  the  `namesearch'
  56.           variable).
  57.  
  58.      whois surname "smith"
  59.           looks for any entries with this surname.
  60.  
  61.      whois fullname "john smith"
  62.           looks for any entries with this fullname.
  63.  
  64.      whois "smith" -org nyser
  65.           looks for any entries with this name in  any  organiza-
  66.           tion  with  "nyser"  in its name.  This is probably the
  67.           most common usage of the program.
  68.  
  69.      whois "smith" -area "@c=US@o=NYSERNet Inc."
  70.           could be used if you already know the "area"  that  the
  71.           user resides in.
  72.  
  73.      whois "smith" -area 17
  74.           could be used if an alias were already established  for
  75.           this area.
  76.  
  77.      whois @c=US@cn=Manager
  78.           looks for the entry with this distinguished name  (han-
  79.           dle).
  80.  
  81.      whois !7
  82.           could be used if an alias were already established  for
  83.           this entry.
  84.  
  85.      whois mrose@cheetah.nyser.net
  86.           looks for any entries with the given mailbox.
  87.  
  88.      whois -title operator
  89.           looks for any entries who are operators.
  90.  
  91.      whois -org *
  92.           reports on all registered organizations (in the default
  93.           geographical area).
  94.  
  95.      whois -org * -geo @c=GB
  96.           reports on all registered organizations under @c=GB.
  97.  
  98.      Here is a somewhat more common example:
  99.  
  100.           fred> whois schoffstall -org psi
  101.           Trying @c=US@o=Performance Systems International ...
  102.           3 matches found.
  103.             2. Marvin Schoffstall                         marv@psi.com
  104.             3. Martin Schoffstall                         schoff@psi.com
  105.             4. Steve Schoffstall                          steve@psi.com
  106.  
  107.           fred> whois !3
  108.           Martin Schoffstall (3)                          schoff@psi.com
  109.               ...
  110.  
  111. COMMANDS
  112.      On start-up, fred will read a  file  called  fredrc  in  the
  113.      ISODE  system  directory  (usually /usr/local/etc/ ).  Then,
  114.      fred reads the file .fredrc in the  user's  home  directory.
  115.      These  files,  if present, contain user-preference commands.
  116.      Afterwards, fred prompts for commands.
  117.  
  118.      Typing INTR at the top-level does  nothing,  but  typing  it
  119.      twice in a row at the top-level terminates fred; typing INTR
  120.      during additional prompting causes fred to  abort  the  com-
  121.      mand.
  122.  
  123.      alias [name]
  124.           With no arguments, prints all aliases defined for  this
  125.           session.  With an argument, defines a numeric alias for
  126.           that name.
  127.  
  128.      area [[record-type] location]
  129.           With no arguments, prints the default area used by  the
  130.           whois  command when consulting the white pages.  With a
  131.           single argument, this sets the default area.  The  dis-
  132.           tinguished value ".." may be used to go up one level in
  133.           the tree.  If the value is  relative  (i.e.,  does  not
  134.           start  with  the  "@"-sign), then the value is appended
  135.           onto the current location.  With  two  arguments,  this
  136.           sets  the  default  area  for searches of the indicated
  137.           record type (which are described in the next  section).
  138.           This  is  particularly  useful  since  it also provides
  139.           heuristics to the whois command as to the depth  to  be
  140.           used for searching.
  141.  
  142.      edit Invokes an editor to modify the  user's  entry  in  the
  143.           white pages.
  144.  
  145.      help [command ...]
  146.           Prints help information.  For detailed information, try
  147.           "help ?".
  148.  
  149.      manual
  150.           Prints this detailed documentation about fred.
  151.  
  152.      quit Terminates fred.
  153.  
  154.      report [subject]
  155.           Allows you to enter a report that  is  mailed  to  your
  156.           local white pages manager.
  157.  
  158.      set [variable [value]]
  159.           Manipulates fred's settings:
  160.  
  161.                variable    function
  162.                debug       debug fred
  163.                manager     mail address of local white pages manager
  164.                namesearch  type of name used for matching
  165.                            (either "fullname" or "surname")
  166.                pager       program to use for terminal pagination
  167.                phone       always display phone numbers
  168.                            in one-liner
  169.                query       confirm two-step operations
  170.                soundex     use soundex for matching
  171.                            when no wildcards are present
  172.                timelimit   maximum number of seconds to
  173.                            spend searching
  174.                verbose     verbose interaction
  175.                watch       watch dialogue with dish
  176.  
  177.      thisis [name [password]]
  178.           Tells the white pages service who  you  are.   This  is
  179.           only  needed  when  you  want to modify your own entry.
  180.           Normally, this is determined  automatically  when  fred
  181.           starts.
  182.  
  183.      whois [arguments ...]
  184.           Consults the white pages.
  185.  
  186. WHOIS
  187.      The syntax of the whois command is similar to that  provided
  188.      by the WHOIS service:
  189.  
  190.           input-field [record-type] [area-designator] [output-control]
  191.  
  192.      These four components may occur  in  any  order.   Only  the
  193.      input-field need be present.
  194.  
  195.   INPUT FIELD
  196.      This component tells the white pages what to look for.
  197.  
  198.      .<name> or name <name>
  199.           gives the name of the target.
  200.           surname <name>
  201.           fullname <name>
  202.  
  203.           Searching for names follows these rules:  if  the  "*"-
  204.           sign  appears  at the beginning and/or end of the name,
  205.           then wildcard-style  matching  is  used:  the  "*"-sign
  206.           matches zero or more characters at the beginning or end
  207.           of a name.  Otherwise, if soundex has been enabled (set
  208.           the  variable `soundex' to `on'), then imprecise match-
  209.           ing occurs according to a  Soundex  algorithm.   Other-
  210.           wise,  if searching is to occur for a person's surname,
  211.           then a case-insensitive match is used.  Finally,  as  a
  212.           last   resort,   fred   will  force  a  rather  liberal
  213.           wildcard-style match.
  214.  
  215.  
  216.  
  217.  
  218. Sun Release 4.0     Last change: 06 Jan 1990                    4
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225. FRED(1C)                  USER COMMANDS                  FRED(1C)
  226.  
  227.  
  228.  
  229.           For compatibility with  the  WHOIS  service,  an  input
  230.           field of "NAME." is equivalent to "NAME*" (i.e., a par-
  231.           tial match for names having the given  prefix).   Simi-
  232.           larly,  an  input  field  of  "*NAME"  is equivalent to
  233.           "NAME expand".  Thus, to have wildcard matching at  the
  234.           beginning of the name, use two "*"-signs, e.g., "**inc"
  235.           matches names ending in "inc".  (A terrible  hack,  but
  236.           that's  the  price  one  pays to be consistent with the
  237.           WHOIS service.)
  238.  
  239.      !<handle> or handle <handle>
  240.           gives the unique handle  (distinguished  name)  of  the
  241.           target.   This  may  be  an  alias  rather  than a dis-
  242.           tinguished name.
  243.  
  244.      mailbox <mailbox>
  245.           gives the mailbox of the target.
  246.  
  247.      If a keyword is not given,  then  fred  attempts  to  intuit
  248.      which kind of input field is being provided.  In most cases,
  249.      fred will treat field as a  name,  unless  it  contains  the
  250.      "@"-sign, which makes it either a handle or a mailbox.
  251.  
  252.   RECORD TYPE
  253.      This component tells the white pages what kind of  entry  to
  254.      look for.
  255.  
  256.           person or -title NAME,
  257.           organization,
  258.           unit (a division under an organization),
  259.           role (a role within an organization),
  260.           locality, or
  261.           dsa (a white pages server).
  262.  
  263.      If this component is not present, fred will  not  limit  its
  264.      search to any particular kind of entry.
  265.  
  266.   AREA DESIGNATOR
  267.      This component takes one of two forms.  The most common form
  268.      is one of the switches:
  269.  
  270.           -org (short for -organization ),
  271.           -unit, or,
  272.           -locality,
  273.  
  274.      followed by a name.  For example,
  275.  
  276.           -org nyser
  277.  
  278.      tells fred to limit the search to those organizations  whose
  279.      name contains "nyser".
  280.  
  281.      In addition the switch `-geo' followed by a location in  the
  282.      white  pages  may  be  used to override the default area for
  283.      searching for these objects.  For example,
  284.  
  285.           -org ucl -area @c=GB
  286.  
  287.      tells fred to limit the search to those organizations  whose
  288.      name contains "ucl" that reside directly under @c=GB.
  289.  
  290.      In the second form, the  area  designator  consists  of  the
  291.      switch  -area  followed  by  a  location in the white pages;
  292.      e.g.,
  293.  
  294.           -area "@c=US@o=NYSERNet Inc."
  295.  
  296.      Note the use of double-quotes to make the  string  following
  297.      area  appear  as a single argument.  If an alias has already
  298.      been established for this location, then the number  of  the
  299.      alias can be used instead.
  300.  
  301.   OUTPUT CONTROL
  302.      expand or *
  303.           give a detailed listing and show  children  of  matched
  304.           entries.
  305.  
  306.      ~    The opposite of expand.   (Included  for  compatibility
  307.           with the WHOIS service.)
  308.  
  309.      subdisplay or %
  310.           give a one-line listing and show  children  of  matched
  311.           entries.
  312.  
  313.      full or |
  314.           give a detailed listing, even on ambiguous matches
  315.  
  316.      summary or $
  317.           give a one-line listing, even on unique matches.
  318.  
  319. OPTIONS
  320.      -f   Inhibits reading of the user's .fredrc on startup.
  321.  
  322.      -v   Sets verbose (default for interactive use).
  323.  
  324.      -w   Sets watch.
  325.  
  326. FILES
  327.      /usr/local/etc/dsaptailor  system QUIPU tailoring file
  328.      $HOME/.quipurc             user's QUIPU tailoring file
  329.      /usr/local/etc/fredrc      system runcom file
  330.      $HOME/.fredrc              user's runcom file
  331.  
  332. SEE ALSO
  333.      dish(1c),
  334.      NYSERNet White Pages Pilot Project: User's Guide,
  335.      The ISO Development Environment:  User's  Manual--Volume  5:
  336.      QUIPU
  337.  
  338. DIAGNOSTICS
  339.      All obvious.
  340.  
  341. AUTHOR
  342.      Marshall T. Rose, NYSERNet Inc.
  343.  
  344. BUGS
  345.      The emulation of the old whois command format is  imperfect.
  346.      Most  notably,  you  need to quote names so they appear as a
  347.      single token to the fred.  For example:
  348.  
  349.           % fred whois "Dal Santo"
  350.  
  351.      won't work, whilst
  352.  
  353.           % fred whois '"Dal Santo"'
  354.  
  355.      will work (the shell  strips  off  one  layer  of  quoting).
  356.      That's progress for you.
  357.