<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Vincent</firstname>">
  <!ENTITY dhsurname   "<surname>Deffontaines</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>march 18, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>vincent@inl.fr</email>">
  <!ENTITY dhemail2    "<email>eric@inl.fr</email>">
  <!ENTITY dhusername  "Vincent Deffontaines">
  <!ENTITY dhucpackage "<refentrytitle>nutop</refentrytitle>">
  <!ENTITY dhpackage   "nutop">

  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">

]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>display top NUFW Users</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-help</option></arg>
      <arg><option>-c <replaceable>config file</replaceable></option></arg>
      <arg><option>-delay <replaceable>refresh delay (seconds)</replaceable></option></arg>
      <arg><option>-line <replaceable>number of lines to display</replaceable></option></arg>
      <arg><option>-databasetype <replaceable> mysql/pgsql</replaceable></option></arg>
      <arg><option>-host <replaceable>db host</replaceable></option></arg>
      <arg><option>-user <replaceable>db username</replaceable></option></arg>
      <arg><option>-pass <replaceable>db password</replaceable></option></arg>
      <arg><option>-databasename <replaceable>db database name</replaceable></option></arg>
      <arg><option>-tablename <replaceable>db table</replaceable></option></arg>
      <arg><option>-port <replaceable>db port</replaceable></option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents the
      <command>&dhpackage;</command> command.</para>

      <para>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.</para>
      <para>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.</para>
      <para>Original packaging and informations and help can be found from http://www.nufw.org/</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-help</option>
        </term>
        <listitem>
          <para>Issues usage details and exits.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c <replaceable>config file</replaceable></option>
        </term>
        <listitem>
          <para>Specifies config file to read SQL parameters from. Default is
          /etc/nufw/nutop.conf</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-delay <replaceable>number</replaceable></option>
        </term>
        <listitem>
          <para>Specifies a rate to refresh display. This parameter is
          interpeted as a number of seconds. Default is 2s.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-line <replaceable>number</replaceable></option>
        </term>
        <listitem>
          <para>Number of lines to display. Default : 20</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-databasetype <replaceable>mysql/pgsql</replaceable></option>
        </term>
        <listitem>
          <para>Type of database to connect to. Default is mysql. This setting
          also sets the default port setting.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-host <replaceable>hostname/IP</replaceable></option>
        </term>
        <listitem>
          <para>IP address or FQDN of database we connect to.  Default value : 127.0.0.1</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-user <replaceable>username</replaceable></option>
        </term>
        <listitem>
          <para>Database username to connect as. Default is "nutop"</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-pass <replaceable>password</replaceable></option>
        </term>
        <listitem>
          <para>Password to use to connect to database.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-databasename <replaceable>name of database</replaceable></option>
        </term>
        <listitem>
          <para>Name of database we connect to. Default is "nulog"</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-tablename <replaceable>name of table</replaceable></option>
        </term>
        <listitem>
          <para>Name of SQL table to use for queries. Default is "ulog"</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-port <replaceable>TCP port</replaceable></option>
        </term>
        <listitem>
          <para>TCP numeric port to use for database connection. Default is 3306
          if databasetype is mysql, 5432 if pgsql.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>nuauth(8), nufw(8)</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>Nufw was designed and coded by Eric Leblond, aka Regit (&dhemail2;) , and Vincent
    Deffontaines, aka gryzor (&dhemail;). Original idea in 2001, while working on NSM Ldap
    support.</para>

    <para>This manual page was written by &dhusername;</para>
      <para>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.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->