.\"
.\" sc_ally.1
.\"
.\" Author: Matthew Luckie <mjl@luckie.org.nz>
.\"
.\" Copyright (c) 2011 University of Waikato
.\"                    All rights reserved
.\"
.\" $Id: sc_ally.1,v 1.3 2013/08/19 21:02:57 mjl Exp $
.\"
.\"  nroff -man sc_ally.1
.\"  groff -man -Tascii sc_ally.1 | man2html -title sc_ally.1
.\"
.Dd March 1, 2011
.Dt SC_ALLY 1
.Os
.Sh NAME
.Nm sc_ally
.Nd scamper driver to run Ally on a list of candidate aliases.
.Sh SYNOPSIS
.Nm
.Bk -words
.Op Fl ?D
.Op Fl i Ar infile
.Op Fl o Ar outfile
.Op Fl p Ar port
.Op Fl U Ar unix-socket
.Op Fl w Ar waittime
.Op Fl q Ar attempts
.Op Fl t Ar logfile
.Ek
.\""""""""""""
.Sh DESCRIPTION
The
.Nm
utility provides the ability to connect to a running
.Xr scamper 1
instance and have a set of IPv4 address-pairs tested for aliases using the
Ally technique.
For each address pair in the file,
.Nm
establishes which probe methods (UDP, TCP-ack, ICMP-echo) solicit an
incrementing IP-ID value, and then uses the Ally technique on pairs where
a probe method is able to obtain an incrementing IP-ID for both addresses.
The output is written to a warts file.
The options are as follows:
.Bl -tag -width Ds
.It Fl ?
prints a list of command line options and a synopsis of each.
.It Fl D
causes
.Nm
to detach and become a daemon.
.It Fl i Ar infile
specifies the name of the input file which consists of a sequence of
IPv4 address-pairs, one pair per line.
.It Fl o Ar outfile
specifies the name of the output file to be written.
The output file will use the warts format.
.It Fl p Ar port
specifies the port on the local host where
.Xr scamper 1
is accepting control socket connections.
.It Fl U Ar unix-socket
specifies the name of a unix domain socket where
.Xr scamper 1
is accepting control socket connections.
.It Fl w Ar waittime
specifies the minimum length of time, in seconds, to wait between completing
a measurement to a particular IP address and issuing the next.
.It Fl q Ar attempts
specifies the number of times to try Ally when one of the addresses is
unresponsive.
.It Fl t Ar logfile
specifies the name of a file to log output from
.Nm
generated at run time.
.El
.\""""""""""""
.Sh EXAMPLE
Given a set of IPv4-address pairs in a file named infile.txt:
.Pp
.in +.3i
.nf
192.0.2.1 192.0.32.10
192.0.2.2 192.0.31.8
192.0.2.3 192.0.30.64
.fi
.in -.3i
.Pp
and a
.Xr scamper 1
daemon listening on port 31337, then these address-pairs can be tested for
aliases using
.Pp
sc_ally -i infile.txt -o outfile.warts -p 31337
.\""""""""""""
.Sh SEE ALSO
.Rs
.%A "N. Spring"
.%A "R. Mahajan"
.%A "D. Wetherall"
.%T "Measuring ISP topologies with Rocketfuel"
.%O "Proc. ACM SIGCOMM 2002"
.Re
.Xr scamper 1 ,
.Xr sc_wartsdump 1 ,
.Xr sc_warts2text 1
.Sh AUTHORS
.Nm
is written by Matthew Luckie <mjl@luckie.org.nz>.