.\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .TH JNETTOP 8 "April 8, 2006" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME jnettop \- View hosts/ports taking up the most network traffic .SH SYNOPSIS .B jnettop [options] [-i interface] [-d filename] [-f filename] [-x rule] .SH DESCRIPTION This manual page documents briefly the .B jnettop command. This manual page is OBSOLETE. Please use jnettop -h as a main source of information about usage. .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. \fBjnettop\fP captures traffic coming across the host it is running on and displays streams sorted by bandwidth they use. Result is a nice listing of communication on network by host and port, how many bytes went through this transport and the bandwidth it is consuming. .SH OPTIONS These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below. .TP .B \-h, \-\-help Show summary of options. .TP .B \-v, \-\-version Show version of program. .TP .B \-c, \-\-content-filter disable content filtering .TP .B \-d, \-\-debug filename write debug information into file .TP .B \-f, \-\-config-file filename reads configuration from filename. defaults to ~/.jnettop. an example can be found at /usr/share/doc/jnettop/dot.jnettop. .TP .B \-i, \-\-interface name capture packets on specified interface .TP .B \-\-local-aggr [none|host|port|host+port] set local aggregation to specified value .TP .B \-n, \-\-no-resolver disable resolving of ip addresses .TP .B \-p, \-\-promiscuous enables promiscuous mode on the sniffed interface .TP .B \-\-remote-aggr [none|host|port|host+port] set remote aggregation to specified value .TP .B \-s, \-\-select-rule name selects one of the rules defined in .jnettop configuration file (by it's name) .TP .B \-x, \-\-filter rule allows for specification of custom filtering rule. this allows for .BR tcpdump(1) style syntax. don't forget to enclolse the filter into quotes when running from a shell. .SH CONFIGURATION Program looks for settings in the file specified by parameter \fB-f\fP, which defaults to ~/.jnettop. Configuration file is an ordinary text file with keywords and their arguments. You HAVE to enclose arguments into double quotes. Available keywords are: .TP \fBinterface ""\fR The \fBinterface\fP keyword specifies network interface on which to start listening. Example: .RS .PP interface "eth0" .RE .TP \fBlocal_aggregation [none|host|port|host+port]\fR The \fBlocal_aggregation\fP keyword specifies initial active local aggregation. Valid values are \fBnone\fP, \fBhost\fP, \fBport\fP, and \fBhost+port\fP. Example: .RS .PP local_aggregation host .RE .TP \fBpromisc [on|off]\fR The \fBpromisc\fP keyword specifies, whether jnettop captures packets in promiscuous mode. Example: .RS .PP promisc on .RE .TP \fBremote_aggregation [none|host|port|host+port]\fR The \fBremote_aggregation\fP keyword specifies initial active remote aggregation. Valid values are \fBnone\fP, \fBhost\fP, \fBport\fP, and \fBhost+port\fP. Example: .RS .PP remote_aggregation port .RE .TP \fBresolve [on|off]\fR The \fBresolve\fP keyword specifies, whether resolving is performed on the IP addresses or not. .RS .PP resolve off .RE .TP \fBresolve_rule "" "" [normal|external] ( ...)\fR The \fBresolve_rule\fP keyword adds one resolver into list of resolvers for specified address. When resolving, jnettop examines all the rules in the order how they were specified in configuration file. If the network address matches specified range, declared resolver is used. Resolver can be \fBnormal\fP, which means the standard DNS lookup or \fBexternal\fP, which executes specified external program to perform resolving. This can be used with bundled jnettop-lookup-nmb script, which looks up IP addresses using nmblookup(1) tool. If a tool returns empty string or DNS is not found, next rule is examined. If jnettop runs out of rules, than the standard DNS lookup is executed. .RS .PP resolve_rule "192.168.0.0" "255.255.255.0" normal .br resolve_rule "192.168.0.0" "255.255.255.0" external "/usr/share/jnettop/jnettop-lookup-nbm" .RE .TP \fBrule "" ""\fR The \fBrule\fP keyword defines a set of predefined tcpdump(1)-like filters to apply. You can specify various filters as "show me what 192.168.1.32" sends: .RS .PP rule "show 192.168.1.32" "src 192.168.1.32" .RE .TP \fBselect_rule ""\fR The \fBselect_rule\fP keyword specifies initial active predefined rule. The rule must be defined before this keyword is used. Example: .RS .PP select_rule "show 192.168.1.32" .RE .TP \fBvariable "" ""\fR The \fBvariable\fP keyword introduces a string variable for use in future rule definitions. It can be used to shorten rule definitions. Example: .RS .PP variable "intranet" "net 192.168.0.0/16 or 10.0.0.0/8 or 172.16.0.0/12" .RE .TP For more information, see README file or .jnettop example configuration file included in distribution. .SH AUTHOR This manual page was originally written by Ari Pollak , for the Debian GNU/Linux system. Small changes were introduced by Jakub Skopal