utils/amd-udi/udi/sunudi.5

   1 .\" t
   2 .\" The above line must be present to tell man to process through tbl.
   3 .\" @(#)sunudi.5        2.2, AMD
   4 .\"Copyright (c) 1989, 1990, 1991 by Advanced Micro Devices, Inc.
   5 .\"All rights reserved.  No part of this publication may be reproduced,
   6 .\"stored in a retrieval system, or transmitted in any form or by any
   7 .\"means, electronic, mechanical, photocopying, recording or otherwise,
   8 .\"without the prior written permission of Advanced Micro Devices, Inc.
   9 .\"
  10 .\"You must change the date in these files for a release!
  11 .\"The commands used to generate output from this input are:
  12 .\"    tbl udi.1 | nroff -man - > filename      (Goes to a unix file)
  13 .\"    tbl udi.1 | ptroff -man -                (Goes to PostScript printer)
  14 .\"
  15 .TH UDI 5 "05 Feb 1992" "UDI Files"
  16 .UC 4
  17 .SH NAME
  18 \fBudi\fP \- UDI Configuration Files for SUN hosts.
  19 .sp
  20 .sp
  21 .SH DESCRIPTION
  22 A UDI conformant Debugger Front End (DFE) specifies the Target
  23 Interface Process (TIP) that it wishes to connect to and
  24 the options that it wishes to pass to that TIP by referencing
  25 a configuration in the "UDI configuration file".
  26 This man page explains the format of the UDI Configuration file
  27 for Sun hosts.
  28 .sp
  29 The search rules that the DFE uses to locate the UDI Configuration
  30 file are:
  31 .IP
  32 the complete filename specified by the environment variable, UDICONF.
  33 .IP
  34 the file udi_soc in the current directory.
  35 .IP
  36 the file udi_soc in each of the directories specified by the PATH environment
  37 variable.
  38 .sp
  39 .LP
  40 A line of the UDI Configuration File can have two different formats
  41 depending on whether the address family is AF_UNIX or AF_INET.
  42 The two formats are:
  43 .IP
  44 .I tip_config_name  AF_UNIX  socket_name  tip_executable  [tip_options]
  45 .IP
  46 .I tip_config_name  AF_INET  host_name  port_number  [tip_options]
  47 .TP 10
  48 .I tip_config_name
  49 An arbitrary name which the DFE will use to refer to this configuration.
  50 Each line in the UDI Configuration File must have a different tip_config_name field.
  51 .TP
  52 .I AF_UNIX
  53 This address family should be used
  54 when the DFE and TIP are running on the same host.
  55 This is the typical case.
  56 .TP
  57 .I AF_INET
  58 This address family should be used
  59 when the DFE and TIP are running on different hosts.
  60 .TP
  61 .I socket_name
  62 Used with AF_UNIX configurations only.
  63 Specifies the socket file name
  64 which will be used to communicate between
  65 the DFE and TIP. The special socket_name "*" indicates that a unique
  66 socket file name should be automatically generated by the IPC layer.
  67 This is useful if you want to have multiple DFEs connecting
  68 to the same configuration name.
  69 If the socket_name is explictly specified, be aware that
  70 if any two AF_UNIX TIP configurations are being used simultaneously, they
  71 must have unique socket_names.
  72 For DFEs who wish to disconnect from a TIP and then reconnect to that
  73 same TIP at some later time, an explicit socket_name is required.
  74 .TP
  75 .I tip_executable
  76 Used with AF_UNIX configurations only.
  77 The DFE will use the tip_executable filename
  78 to spawn the TIP if the TIP is not already running
  79 and listening at the indicated socket_name.
  80 If a full pathname is not specified, the PATH environment variable
  81 is used to locate the executable file.
  82 Note that when the socket_name is "*", a new TIP executable
  83 is always spawned.
  84 .sp
  85 .TP
  86 .I host_name
  87 Used with AF_INET configurations only.
  88 This specifies the name of the host where the TIP
  89 is running.
  90 .TP
  91 .I port_number
  92 Used with AF_INET configurations only.
  93 This specifies the port_number at which the TIP
  94 on the remote host is listening.
  95   Note that in an AF_INET configuration
  96 the TIP cannot be spawned by the DFE and must
  97 already be running at the time of the connection.
  98 The TIP on the remote host should be started with
  99 a command line of
 100 .br
 101         tip_executable_name AF_INET port_number
 102
 103 .TP
 104 .I tip_options
 105 Valid with both AF_UNIX and  AF_INET configurations.
 106 This optional string of parmeters is passed through to
 107 the TIP at connect time and is usually interpreted
 108 by the TIP as a set of startup parameters.
 109 .sp
 110 .SH EXAMPLES OF UDI CONFIGURATION FILE ENTRIES
 111 .sp
 112 The following are examples of entries in the UDI configuration
 113 file on SUN hosts.
 114 .LP
 115 \fB iss050  AF_UNIX  *  isstip -29050 -r osboot \fR
 116 .IP
 117 The above entry associates the TIP configuration name "iss050" with the
 118 \fBisstip\fR executable with the parameters
 119 "-29050 -r osboot" being passed to isstip
 120 when the connection is made.
 121 The AF_UNIX address family with an automatically generated
 122 socket name will be used  to communicate between DFE and TIP.
 123 Because of the automatic socket name generation,
 124 a new invocation of isstip will always be created when the iss050
 125 configuration is specified.
 126 .LP
 127 \fB iss050x AF_UNIX  sock_iss50  isstip -29050 -r osboot \fR
 128 .IP
 129 The above entry associates the TIP configuration name "iss050x" with the
 130 same \fBisstip\fR executable and same startup parameters
 131 as the previous example.
 132 The AF_UNIX address family and the explicit socket file name
 133 sock_iss50 will be used to communicate between DFE and TIP.
 134 If isstip is not already running and listening on sock_iss50,
 135 an instance of isstip will be created.
 136 .LP
 137 \fB iss50_remote AF_INET  fasthost 7000 -29050 -r osboot \fR
 138 .IP
 139 The above entry assumes that some TIP is already running on the host
 140 named fasthost and listening at port 7000. For example,
 141 isstip could have been started on fasthost with the command line
 142 .br
 143         isstip AF_INET  7000
 144 .br
 145 The parameters "-29050 -r osboot" will be passed to
 146 the remote TIP at connect time.
 147 .sp
 148 .SH TRADEMARKS
 149 AMD is a registered trademark of Advanced Micro Devices, Inc.
 150 MiniMON29K, 29K, Am29000, Am29005, Am29030, Am29035, Am29200,
 151 and Am29050 are trademarks of Advanced Micro Devices, Inc.