xmalloc: put __hidden behind signature
[netsniff-ng.git] / Documentation / Manpages / astraceroute.8
blob08c24997c48f0a8f1d565e56e7479c79896cc8a5
1 =head1 NAME
3 astraceroute - autonomous system (AS) trace route utility
5 =head1 SYNOPSIS
7   astraceroute [-Hpi46nNfmqxSAFPUREtGXZlwWvh]
8     [-H|--host <host>]     [-p|--port <port>]
9     [-i|-d|--dev <dev>]           [-4|--ipv4]
10     [-6|--ipv6]                [-n|--numeric]
11     [-N|--dns]          [-f|--init-ttl <ttl>]
12     [-m|--max-ttl <ttl>]    [-q|--num-probes]
13     [-x|--timeout <sec>]           [-S|--syn]
14     [-A|--ack]                     [-F|--fin]
15     [-P|--psh]                     [-U|--urg]
16     [-R|--rst]                 [-E|--ecn-syn]
17     [-t|--tos <tos>]            [-G|--nofrag]
18     [-X|--payload <string>][-Z|--show-packet]
19     [-l|--totlen <len>] [-w|--whois <server>]
20     [-W|--wport <port>]    [--city-db <path>]
21     [--country-db <path>]      [-v|--version]
22     [-h|--help]
23   astraceroute6 [options]
25 =head1 DESCRIPTION
27 astraceroute provides traceroute-like AS and estimated geographical information
28 on each hop between the client and the targeted host. Unlike L<traceroute(1)>,
29 it uses TCP-based packets (e.g. a TCP-SYN packet for opening a new connection)
30 in order to prevent being filtered by firewalls. It automatically falls back to
31 ICMP-based probes in case a timeout occurred after no answer was received and
32 the probe times threshold was exceeded. Also, unlike L<tcptraceroute(1)>, the
33 packet flags are fully customizable and AS information such as the AS number of
34 the hop as well as country code, country and city are provided with estimated
35 longitude and latitude. Furthermore, astraceroute provides the reverse DNS name
36 of the hop, its IP address, the network prefix of the AS, the registry name of
37 the AS, a registered since of the AS and the human readable AS name.
39 =head1 EXAMPLES
41 =over
43 =item astraceroute -i eth0 -N -E -H netsniff-ng.org
45 IPv4 trace of AS with TCP ECN SYN probe
47 =item astraceroute -i eth0 -N -S -H netsniff-ng.org
49 IPv4 trace of AS with TCP SYN probe
51 =item astraceroute -i eth0 -N -F -H netsniff-ng.org
53 IPv4 trace of AS with TCP FIN probe
55 =item astraceroute -i eth0 -N -FPU -H netsniff-ng.org
57 IPv4 trace of AS with Xmas probe
59 =item astraceroute -i eth0 -N -H netsniff-ng.org -X "censor-me" -Z
61 IPv4 trace of AS with Null probe with ASCII payload
63 =item astraceroute -6 -S -i eth0 -H netsniff-ng.org
65 IPv6 trace of AS up to netsniff-ng.org
67 =back
69 =head1 OPTIONS
71 =over
73 =item -h|--help
75 Print help text and lists all options.
77 =item -v|--version
79 Print version.
81 =item -H|--host <host>
83 Host/IPv4/IPv6 to lookup AS route to
85 =item i-|-d|--dev <netdev>
87 Networking device, i.e. eth0
89 =item -p|--port <port>
91 Hosts port to lookup AS route to
93 =item -4|--ipv4
95 Use IPv4 requests (default)
97 =item -6|--ipv6
99 Use IPv6 requests
101 =item -n|--numeric
103 Do not do reverse DNS lookup for hops
105 =item -N|--dns
107 Do a reverse DNS lookup for hops
109 =item -f|--init-ttl <ttl>
111 Set initial TTL
113 =item -m|--max-ttl <ttl>
115 Set maximum TTL (default: 30)
117 =item -q|--num-probes <num>
119 Number of max probes for each hop (default: 3)
121 =item -x|--timeout <sec>
123 Probe response timeout in sec (default: 3)
125 =item -S|--syn
127 Set TCP SYN flag in packets
129 =item -A|--ack
131 Set TCP ACK flag in packets
133 =item -F|--fin
135 Set TCP FIN flag in packets
137 =item -P|--psh
139 Set TCP PSH flag in packets
141 =item -U|--urg
143 Set TCP URG flag in packets
145 =item -R|--rst
147 Set TCP RST flag in packets
149 =item -E|--ecn-syn
151 Send ECN SYN packets (RFC3168)
153 =item -t|--tos <tos>
155 Set the IP TOS field
157 =item -w|--whois <server>
159 Use a different AS whois DB server
160 (default: /etc/netsniff-ng/whois.conf)
162 =item -W|--wport <port>
164 Use a different port to AS whois server
165 (default: /etc/netsniff-ng/whois.conf)
167 =item --city-db <path>
169 Specifiy path for geoip city database
171 =item --country-db <path>
173 Specifiy path for geoip country database
175 =back
177 =head1 AVAILABILITY
179 astraceroute is part of the netsniff-ng toolkit. More information about the
180 toolkit can be obtained from its website: http://netsniff-ng.org/
182 =head1 GIT
184 All source code is available under the terms of the GNU GPL, version 2.0.
185 Obtain it via Git from: git://github.com/gnumaniacs/netsniff-ng.git
187 =head1 AUTHOR
189 astraceroute was written by Daniel Borkmann <daniel@netsniff-ng.org>.
191 =head1 DOCUMENTATION
193 The documentation was written by Emmanuel Roullit <emmanuel@netsniff-ng.org>
194 and Daniel Borkmann <daniel@netsniff-ng.org>.
196 =head1 BUGS
198 Please report bugs to <bugs@netsniff-ng.org>.
200 =head1 SEE ALSO
202 L<traceroute(1)>, L<tcptraceroute(1)>, L<ping(8)>
204 =cut