getc(3) and putc(3): document xxx_unlocked() functions from FreeBSD
[dragonfly.git] / usr.sbin / spray / spray.8
blob20ed9290f09681b610a0a26cb9d9ecda33c5d893
1 .\"
2 .\" Copyright (c) 1994 James A. Jegers
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. The name of the author may not be used to endorse or promote products
11 .\"    derived from this software without specific prior written permission
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 .\"
24 .\" $FreeBSD: src/usr.sbin/spray/spray.8,v 1.5.2.5 2003/03/11 22:31:33 trhodes Exp $
25 .\" $DragonFly: src/usr.sbin/spray/spray.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
26 .\"
27 .Dd July 10, 1995
28 .Dt SPRAY 8
29 .Os
30 .Sh NAME
31 .Nm spray
32 .Nd send many packets to host
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl c Ar count
36 .Op Fl d Ar delay
37 .Op Fl l Ar length
38 .Ar host
39 .Sh DESCRIPTION
40 The
41 .Nm
42 utility sends multiple RPC packets to
43 .Ar host
44 and records how many of them were correctly received and how long it took.
45 .Pp
46 The options are as follows:
47 .Bl -tag -width indent
48 .It Fl c Ar count
49 Send
50 .Ar count
51 packets.
52 .It Fl d Ar delay
53 Pause
54 .Ar delay
55 microseconds between sending each packet.
56 .It Fl l Ar length
57 Set the length of the packet that holds the RPC call message to
58 .Ar length
59 bytes.
60 Not all values of
61 .Ar length
62 are possible because RPC data is encoded using XDR.
63 The
64 .Nm
65 utility rounds up to the nearest possible value.
66 .El
67 .Pp
68 The
69 .Nm
70 utility is intended for use in network testing, measurement, and management.
71 This command
72 .Em "can be very hard on a network and should be used with caution" .
73 .Sh SEE ALSO
74 .Xr netstat 1 ,
75 .Xr ifconfig 8 ,
76 .Xr ping 8 ,
77 .Xr rpc.sprayd 8