Move /var/svc/log to /var/log/svc
[unleashed/lotheac.git] / share / man / man8 / inetconv.8
blobe54139977016657dd205ef34ae5d2e7ccdcb7d22
1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc.
3 .\" All Rights Reserved
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH INETCONV 8 "Oct 21, 2004"
8 .SH NAME
9 inetconv \- convert \fBinetd.conf\fR entries into smf service manifests, import
10 them into smf repository
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fBinetconv\fR \fB-?\fR
15 .fi
17 .LP
18 .nf
19 \fBinetconv\fR [\fB-f\fR] [\fB-n\fR] [\fB-i\fR \fIsrcfile\fR] [\fB-o\fR \fIdestdir\fR]
20 .fi
22 .LP
23 .nf
24 \fBinetconv\fR \fB-e\fR [\fB-n\fR] [\fB-i\fR \fIsrcfile\fR]
25 .fi
27 .SH DESCRIPTION
28 .sp
29 .LP
30 The \fBinetconv\fR utility converts a file containing records of
31 \fBinetd.conf\fR(4) into \fBsmf\fR(5) service manifests, and then import those
32 manifests into the \fBsmf\fR repository. Once the \fBinetd.conf\fR file has
33 been converted, the only way to change aspects of an inet service is to use the
34 \fBinetadm\fR(8) utility.
35 .sp
36 .LP
37 There is a one-to-one correspondence between a service line in the input file
38 and the manifest generated. By default, the manifests are named using the
39 following template:
40 .sp
41 .in +2
42 .nf
43 \fI<svcname>\fR-\fI<proto>\fR\fB\&.xml\fR
44 .fi
45 .in -2
47 .sp
48 .LP
49 The \fI<svcname>\fR token is replaced by the service's name and the
50 \fI<proto>\fR token by the service's protocol. Any slash (\fB/\fR) characters
51 that exist in the source line for the service name or protocol are replaced
52 with underscores (\fB_\fR).
53 .sp
54 .LP
55 The service line is recorded as a property of the converted service.
56 .sp
57 .LP
58 During the conversion process, if a service line is found to be malformed or to
59 be for an internal \fBinetd\fR service, no manifest is generated and that
60 service line is skipped.
61 .sp
62 .LP
63 The input file is left untouched by the conversion process.
64 .SH OPTIONS
65 .sp
66 .LP
67 The following options are supported:
68 .sp
69 .ne 2
70 .na
71 \fB\fB-?\fR\fR
72 .ad
73 .RS 14n
74 Display a usage message.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB-e\fR\fR
81 .ad
82 .RS 14n
83 Enable \fBsmf\fR services which are listed in the input file.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB-f\fR\fR
90 .ad
91 .RS 14n
92 If a service manifest of the same name as the one to be generated is found in
93 the destination directory, \fBinetconv\fR will overwrite that manifest if this
94 option is specified. Otherwise, an error message is generated and the
95 conversion of that service is not performed.
96 .RE
98 .sp
99 .ne 2
101 \fB\fB-i\fR \fIsrcfile\fR\fR
103 .RS 14n
104 Permits the specification of an alternate input file \fIsrcfile\fR. If this
105 option is not specified, then the \fBinetd.conf\fR(4) file is used as input.
109 .ne 2
111 \fB\fB-n\fR\fR
113 .RS 14n
114 Turns off the auto-import of the manifests generated during the conversion
115 process. Later, if you want to import a generated manifest into the
116 \fBsmf\fR(5) repository, you can do so through the use of the \fBsvccfg\fR(8)
117 utility.
119 If the \fB-e\fR option is specified, the \fB-n\fR option only displays the
120 \fBsmf\fR services that would be enabled.
124 .ne 2
126 \fB\fB-o\fR\fR
128 .RS 14n
129 Permits the specification of an alternate destination directory \fIdestdir\fR
130 for the generated manifests. If this option is not specified, then the
131 manifests are placed in \fB/var/svc/manifest/network/rpc\fR, if the service is
132 a RPC service, or \fB/var/svc/manifest/network\fR otherwise.
135 .SH EXAMPLES
137 \fBExample 1 \fRGenerating \fBsmf\fR Manifests from \fBinetd.conf\fR
140 The following command generates \fBsmf\fR(5) manifests from \fBinetd.conf\fR(4)
141 and places them in \fB/var/tmp\fR, overwriting any preexisting manifests of the
142 same name, and then imports them into the \fBsmf\fR repository.
145 .in +2
147 # inetconv -f -o /var/tmp
148 100232/10 -> /var/tmp/100232_10-rpc_udp.xml
149 Importing 100232_10-rpc_udp.xml ...Done
150 telnet -> /var/tmp/telnet-tcp6.xml
151 Importing telnet-tcp6.xml ...Done
153 .in -2
156 \fBExample 2 \fRGenerating Manifests from an Alternate Input File
159 The following command specifies a different input file and does not load the
160 resulting manifests into the \fBsmf\fR repository.
163 .in +2
165 # inetconv -n -i /export/test/inet.svcs -o /var/tmp
166 100232/10 -> /var/tmp/100232_10-rpc_udp.xml
167 telnet -> /var/tmp/telnet-tcp6.xml
169 .in -2
171 .SH EXIT STATUS
174 The following exit values are returned:
176 .ne 2
178 \fB\fB0\fR\fR
180 .RS 5n
181 Operation completed successfully (no errors).
185 .ne 2
187 \fB\fB1\fR\fR
189 .RS 5n
190 Invalid options specified.
194 .ne 2
196 \fB\fB2\fR\fR
198 .RS 5n
199 One or more service lines are malformed, and thus no manifest(s) were generated
200 for them.
204 .ne 2
206 \fB\fB3\fR\fR
208 .RS 5n
209 An error occurred importing one or more of the generated manifests.
213 .ne 2
215 \fB\fB4\fR\fR
217 .RS 5n
218 A system error occurred.
221 .SH FILES
223 .ne 2
225 \fB\fB/var/svc/manifest/network/{rpc}/\fI<svcname>\fR-\fI<proto>\fR\&.xml\fR\fR
227 .sp .6
228 .RS 4n
229 default output manifest file name
232 .SH ATTRIBUTES
235 See \fBattributes\fR(5) for descriptions of the following attributes:
240 box;
241 c | c
242 l | l .
243 ATTRIBUTE TYPE  ATTRIBUTE VALUE
245 Interface Stability     Evolving
248 .SH SEE ALSO
251 \fBinetadm\fR(8), \fBinetd\fR(8), \fBsvccfg\fR(8), \fBinetd.conf\fR(4),
252 \fBattributes\fR(5), \fBsmf\fR(5)