summaryrefslogtreecommitdiff
path: root/ifdata.docbook
blob: 47f414301c47a69a81694c3b5affd71261207d49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<?xml version="1.0" encoding="utf-8"?>

<!--

Copyright 2006 Joey Hess

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[]>

<refentry>

	<refentryinfo>
		<author>
			<firstname>Joey</firstname>
			<surname>Hess</surname>
		</author>
		<date>2006-03-07</date>
	</refentryinfo>

	<refmeta>
		<refentrytitle>ifdata</refentrytitle>
		<manvolnum>1</manvolnum>
		<refmiscinfo class="manual">moreutils</refmiscinfo>
		<refmiscinfo class="source">moreutils</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>ifdata</refname> 
		<refpurpose>get network interface info without
		parsing ifconfig output</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>ifdata</command>
			<arg>options</arg>
			<arg choice="req"><replaceable>iface</replaceable></arg>
		</cmdsynopsis>
	</refsynopsisdiv>
  
	<refsect1>
		<title>DESCRIPTION</title>
	
		<para>
			<command>ifdata</command> can be used to check for
			the existence of a network interface, or to get
			information abut the interface, such as its IP
			address. Unlike <command>ifconfig</command> or
			<command>ip</command>, <command>ifdata</command>
			has simple to parse output that is designed to be
			easily used by a shell script.
		</para>
	
	</refsect1>
  
	<refsect1>
		<title>OPTIONS</title>
	
		<variablelist>
	
		<varlistentry>
			<term><option>-h</option></term>
			<listitem>
				<para>Print out a help summary.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-e</option></term>
			<listitem>
				<para>Test to see if the interface exists,
					exit nonzero if it does not.</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><option>-p</option></term>
			<listitem>
				<para>Prints out the whole configuration of
					the interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pe</option></term>
			<listitem>
				<para>Prints "yes" or "no" if the interface
					exists or not.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pa</option></term>
			<listitem>
				<para>Prints the IPv4 address of the
					interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pn</option></term>
			<listitem>
				<para>Prints the netmask of the
					interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pN</option></term>
			<listitem>
				<para>Prints the network address of the
					interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pb</option></term>
			<listitem>
				<para>Prints the broadcast address of the
					interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-pm</option></term>
			<listitem>
				<para>Prints the MTU of the interface.</para>
			</listitem>
		</varlistentry>

		</variablelist>
	
		<para>Following options are Linux only.</para>

		<variablelist>
			
		<varlistentry>
			<term><option>-ph</option></term>
			<listitem>
				<para>Prints the hardware address of the
					interface.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-pf</option></term>
			<listitem>
				<para>Prints the flags of the 
					interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-si</option></term>
			<listitem>
				<para>Prints out all the input statistics
					of the interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sip</option></term>
			<listitem>
				<para>Prints the number of input packets.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sib</option></term>
			<listitem>
				<para>Prints the number of input bytes.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sie</option></term>
			<listitem>
				<para>Prints the number of input errors.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sid</option></term>
			<listitem>
				<para>Prints the number of dropped input
					packets.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sif</option></term>
			<listitem>
				<para>Prints the number of input fifo overruns.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-sic</option></term>
			<listitem>
				<para>Print the number of compressed input
					packets.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sim</option></term>
			<listitem>
				<para>Prints the number of input
					multicast packets.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-so</option></term>
			<listitem>
				<para>Prints out all the output statistics
					of the interface.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sop</option></term>
			<listitem>
				<para>Prints the number of output packets.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sob</option></term>
			<listitem>
				<para>Prints the number of output bytes.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-soe</option></term>
			<listitem>
				<para>Prints the number of output errors.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sod</option></term>
			<listitem>
				<para>Prints the number of dropped
					output packets.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-sof</option></term>
			<listitem>
				<para>Prints the number of output fifo overruns.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-sox</option></term>
			<listitem>
				<para>Print the number of output collisions.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-soc</option></term>
			<listitem>
				<para>Prints the number of output carrier
					losses.</para>
			</listitem>
		</varlistentry>
	
		<varlistentry>
			<term><option>-som</option></term>
			<listitem>
				<para>Prints the number of output multicast
					packets.</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><option>-bips</option></term>
			<listitem>
				<para>Prints the number of bytes of
				incoming traffic measured in one second.</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><option>-bops</option></term>
			<listitem>
				<para>Prints the number of bytes of
                                outgoing traffic measured in one second.</para>
			</listitem>
		</varlistentry>

	</variablelist>
	</refsect1>
	
	<refsect1>
		<title>AUTHOR</title>
	
		<para>
			Benjamin BAYART
		</para>
	</refsect1>
</refentry>