share/man/man8/hostconfig.8

   1 '\" te
   2 .\"  Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH HOSTCONFIG 8 "Nov 6, 2000"
   7 .SH NAME
   8 hostconfig \- configure a system's host parameters
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/hostconfig\fR \fB-p\fR \fIprotocol\fR [\fB-d\fR] [ \fB-h\fR] [\fB-n\fR] [\fB-v\fR]
  13      [\fB-i\fR \fIinterface\fR] [\fB-f\fR \fIhostname\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The  \fBhostconfig\fR program uses a network protocol to acquire a machine's
  20 \fBhost parameters\fR and set these parameters on the system.
  21 .sp
  22 .LP
  23 The program selects which protocol to use based on the argument to the required
  24 \fB-p\fR flag. Different protocols may set different host parameters.
  25 Currently, only one protocol (\fBbootparams\fR) is defined.
  26 .SH OPTIONS
  27 .sp
  28 .LP
  29 The following options are supported:
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fB-d\fR\fR
  34 .ad
  35 .RS 16n
  36 Enable \fBdebug\fR output.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-f\fR\fI hostname\fR\fR
  43 .ad
  44 .RS 16n
  45 Run the protocol as if this machine were named \fBhostname\fR.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-h\fR\fR
  52 .ad
  53 .RS 16n
  54 Echo the received \fBhostname\fR to \fBstdout\fR, rather than setting
  55 \fBhostname\fR using the system name directly.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-i\fR\fI interface\fR\fR
  62 .ad
  63 .RS 16n
  64 Use only the named network interface to run the protocol.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB-n\fR\fR
  71 .ad
  72 .RS 16n
  73 Run the network protocol, but do not set the acquired parameters into the
  74 system.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-p\fR \fIprotocol\fR\fR
  81 .ad
  82 .RS 16n
  83 Run \fBhostconfig\fR using \fIprotocol\fR. Currently, only one protocol
  84 (\fBbootparams\fR) is available. This option is required.
  85 .sp
  86 Specifying the \fB-p\fR \fBbootparams\fR option uses the \fBwhoami\fR call of
  87 the RPC \fBbootparams\fR protocol. This sets the system's  \fBhostname\fR,
  88 \fBdomainname\fR, and default IP router parameters.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-v\fR\fR
  95 .ad
  96 .RS 16n
  97 Enable verbose output.
  98 .RE
  99
 100 .SH EXAMPLES
 101 .LP
 102 \fBExample 1 \fRConfiguring Host Parameters with Verbose Output
 103 .sp
 104 .LP
 105 The following command configures a machine's host parameters using the
 106 \fBwhoami\fR call of the RPC \fBbootparams\fR protocol with a verbose output.
 107
 108 .sp
 109 .in +2
 110 .nf
 111 example# hostconfig \fB-p\fR bootparams \fB-v\fR
 112 .fi
 113 .in -2
 114 .sp
 115
 116 .LP
 117 \fBExample 2 \fRDisplaying Host Parameters
 118 .sp
 119 .LP
 120 The following command displays the parameters that would be set using the
 121 \fBwhoami\fR call of the RPC \fBbootparams\fR protocol.
 122
 123 .sp
 124 .in +2
 125 .nf
 126 example# hostconfig \fB-p\fR bootparams \fB-n\fR \fB-v\fR
 127 .fi
 128 .in -2
 129 .sp
 130
 131 .LP
 132 \fBExample 3 \fRConfiguring Host Parameters Less the System Name
 133 .sp
 134 .LP
 135 The following command configures a machine's host parameters, less the system
 136 name, using  the \fBwhoami\fR call of the RPC \fBbootparams\fR protocol.
 137
 138 .sp
 139 .in +2
 140 .nf
 141 example# hostconfig='hostconfig \fB-p\fR bootparams \fB-h\fR'
 142 .fi
 143 .in -2
 144 .sp
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBhostname\fR(1), \fBdomainname\fR(8), \fBroute\fR(8), \fBattributes\fR(5)