scutil.tproj/scutil.8

   1 .\"
   2 .\"     @(#)scutil.8
   3 .\"
   4 .Dd November 4, 2003
   5 .Dt SCUTIL 8
   6 .Os Mac OS X
   7 .Sh NAME
   8 .Nm scutil
   9 .Nd Manage system configuration parameters
  10 .Sh SYNOPSIS
  11 .Nm
  12 .Br
  13 .Nm
  14 .Fl r Bro "" Ar nodename | Ar address | Ar local-address remote-address "" Brc
  15 .Br
  16 .Nm
  17 .Fl w Ar dynamic-store-key Op Fl t Ar timeout
  18 .Br
  19 .Nm
  20 .Fl -get Ar pref
  21 .Br
  22 .Nm
  23 .Fl -set Ar pref Op Ar newval
  24 .\".Br
  25 .\".Nm
  26 .\".Fl -net
  27 .Sh DESCRIPTION
  28 Invoked with no options,
  29 .Nm
  30 provides a command line interface to the
  31 .Qq dynamic store
  32 data maintained by
  33 .Xr configd 8 .
  34 Interaction with this data (using the SystemConfiguration.framework
  35 SCDynamicStore APIs) is handled with a set of commands read from
  36 standard input.
  37 A list of the available commands is available by entering the
  38 .Ar help
  39 directive.
  40 .Pp
  41 The
  42 .Fl r
  43 option provides a means of checking the network reachability of a host, an IP
  44 address, or a pair of local and remote IP addresses.
  45 Network
  46 .Qq reachability
  47 is a term that indicates whether network communication is possible between
  48 the current host and the specified host.
  49 .Pp
  50 The
  51 .Fl w
  52 option provides a means of checking for (and optionally waiting for the
  53 creation of) a dynamic store key.
  54 .Pp
  55 The
  56 .Fl -get
  57 and
  58 .Fl -set
  59 options provide a means of reporting and updating a select group of
  60 persistent system preferences.
  61 .\".Pp
  62 .\"Lastly, the
  63 .\".Fl -net
  64 .\"option provides a means of managing the system's network configuration.
  65 .Sh OPTIONS
  66 .Bl -tag -width xx
  67 .It Fl r Bro "" Ar nodename | Ar address | Ar local-address remote-address "" Brc
  68 Check the network reachability of the specified host name, IP address, or a
  69 pair of local and remote IP addresses.
  70 One or more of the following strings will be reported to standard output.
  71 .Pp
  72 .Bl -tag -width "Transient Connection"
  73 .It Not Reachable
  74 The specified nodename/address cannot be reached using the current network
  75 configuration.
  76 .It Reachable
  77 The specified nodename/address can be reached using the current network
  78 configuration.
  79 .It Transient Connection
  80 The specified nodename/address can be reached via a transient (e.g. PPP)
  81 connection.
  82 .It Connection Required
  83 The specified nodename/address can be reached using the current network
  84 configuration but a connection must first be established.
  85 As an example, this status would be returned for a dialup connection
  86 that was not currently active but could handle network traffic for the
  87 target system.
  88 .It Connection Automatic
  89 The specified nodename/address can be reached using the current network
  90 configuration but a connection must first be established.
  91 Any traffic directed to the specified name/address will initiate the
  92 connection.
  93 .It Local Address
  94 The specified nodename/address is one associated with a network interface
  95 on the system.
  96 .It Directly Reachable Addresss
  97 Network traffic to the specified nodename/address will not go through a
  98 gateway but is routed directly to one of the interfaces on the system.
  99 .El
 100 .Pp
 101 A zero exit status will be returned when the reachability status is reported correctly.
 102 A non-zero exit status will be returned if errors are detected with an error reported to standard error.
 103 .It Fl w Ar dynamic-store-key Op Fl t Ar timeout
 104 Check if the specified key exists in the
 105 .Qq dynamic store
 106 data maintained by
 107 .Xr configd 8 .
 108 If present,
 109 .Nm
 110 will return with a zero exit status.
 111 If not present,
 112 .Nm
 113 will wait for the specified time for the key to be established.
 114 A non-zero exit status will be returned if the key was not created within the specified time.
 115 .Pp
 116 .Nm
 117 will wait indefinitely if a timeout of 0 seconds is specified.
 118 The default timeout is 15 seconds.
 119 .It Fl -get Ar pref
 120 Retrieves the specified preference.  The current value will be reported on standard output.
 121 .Pp
 122 Supported preferences include:
 123 ComputerName
 124 LocalHostName
 125 .It Fl -set Ar pref Op Ar newval
 126 Updates the specified preference with the new value.
 127 If the new value is not specified on the command line then it will be read from standard input.
 128 .Pp
 129 Supported preferences include:
 130 ComputerName
 131 LocalHostName
 132 .Pp
 133 The
 134 .Fl -set
 135 option requires super-user access.
 136 .\".It Fl -net
 137 .\"Provides a command line interface to the
 138 .\".Qq network configuration .
 139 .\"Interaction with this data (using the SystemConfiguration.framework
 140 .\"SCNetworkConfiguration APIs) is handled with a set of commands read
 141 .\"from standard input.  A list of the available commands is available
 142 .\"by entering the help directive.
 143 .\".Pp
 144 .\"The
 145 .\".Fl -net
 146 .\"option requires super-user access.
 147 .El
 148 .Sh SEE ALSO
 149 .Xr configd 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 command appeared in Mac OS X Public Beta.