.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "NUTOP" "8" "18 mars 2007" "" ""

.SH NAME
nutop \- display top NUFW Users
.SH SYNOPSIS

\fBnutop\fR [ \fB-help\fR ] [ \fB-c \fIconfig file\fB\fR ] [ \fB-delay \fIrefresh delay (seconds)\fB\fR ] [ \fB-line \fInumber of lines to display\fB\fR ] [ \fB-databasetype \fI mysql/pgsql\fB\fR ] [ \fB-host \fIdb host\fB\fR ] [ \fB-user \fIdb username\fB\fR ] [ \fB-pass \fIdb password\fB\fR ] [ \fB-databasename \fIdb database name\fB\fR ] [ \fB-tablename \fIdb table\fB\fR ] [ \fB-port \fIdb port\fB\fR ]

.SH "DESCRIPTION"
.PP
This manual page documents the
\fBnutop\fR command.
.PP
Nutop is to be used by administrators willing to view users activity
on a NuFW server, in real time. The display is designed to look a lot like
the well known top command, as far as general layout is concerned.
.PP
The default configuration file (containing SQL connections
parameters) is located at /etc/nufw/nutop.conf. If decided to
customize it to their needs, care should be taken about file permissions
on that file, as it might let any user of the system access to the NuFW
connection tracking database.
.PP
Original packaging and informations and help can be found from http://www.nufw.org/
.SH "OPTIONS"
.TP
\fB-help \fR
Issues usage details and exits.
.TP
\fB-c \fIconfig file\fB \fR
Specifies config file to read SQL parameters from. Default is
/etc/nufw/nutop.conf
.TP
\fB-delay \fInumber\fB \fR
Specifies a rate to refresh display. This parameter is
interpeted as a number of seconds. Default is 2s.
.TP
\fB-line \fInumber\fB \fR
Number of lines to display. Default : 20
.TP
\fB-databasetype \fImysql/pgsql\fB \fR
Type of database to connect to. Default is mysql. This setting
also sets the default port setting.
.TP
\fB-host \fIhostname/IP\fB \fR
IP address or FQDN of database we connect to.  Default value : 127.0.0.1
.TP
\fB-user \fIusername\fB \fR
Database username to connect as. Default is "nutop"
.TP
\fB-pass \fIpassword\fB \fR
Password to use to connect to database.
.TP
\fB-databasename \fIname of database\fB \fR
Name of database we connect to. Default is "nulog"
.TP
\fB-tablename \fIname of table\fB \fR
Name of SQL table to use for queries. Default is "ulog"
.TP
\fB-port \fITCP port\fB \fR
TCP numeric port to use for database connection. Default is 3306
if databasetype is mysql, 5432 if pgsql.
.SH "SEE ALSO"
.PP
nuauth(8), nufw(8)
.SH "AUTHOR"
.PP
Nufw was designed and coded by Eric Leblond, aka Regit (<eric@inl.fr>) , and Vincent
Deffontaines, aka gryzor (<vincent@inl.fr>). Original idea in 2001, while working on NSM Ldap
support.
.PP
This manual page was written by Vincent Deffontaines
.PP
Permission is
granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation
License, Version 2 as published by the Free
Software Foundation; with no Invariant Sections, no Front-Cover
Texts and no Back-Cover Texts.