Tuesday, June 12, 2012

Nsn man page

Nsn man page, obtain nsn from here
SYNOPSIS
       nsn [ -tbvVqh?q ] [ eventtype ] [ -f logfile ] [ -l --link-down-command
       command ] [ -L --link-up-command command ] [ -a  --addr-removed-command
       command ] [ -A --addr-added-command command ] [ -r --route-removed-com‐
       mand command ] [ -R --route-added-command command ]



DESCRIPTION
       nsn(8) is a network status monitoring tool. It does  listening  changes
       in  network configuration using netlink sockets, and prints informative
       messages to console or log file. nsn(8) was written to be used as debug
       tool  with  network  problems. It can also serve as simple example code
       for using netlink sockets to listen network changes.


       As   of   version   0.2   it   supports    executing    command    when
       route/address/interface  state changes. Nsn uses 'de facto' fork(2) and
       exec(3) method to execute commands as new processes. See -l -L -a -A -r
       -R OPTIONS below for further details.


OPTIONS
       -s     one  of following event types we wish to monitor. It is possible
              to specify multiple events by specifying multiple -s options

       Supported suboptions for -s

              route4 Listens IPv4 routing table changes

              route6 Listens IPv6 routing table changes

              addr6 Listens for IPv6 address changes

              link6 Listens for changes in IPv6 interfaces

              rule6 Listens for IPv6 rules

              neigh Listens for changes in neighbour cache (arp/ndp)

              By default changes in IPv4 routes and interfaces are listened.



       -f     followed by name of log file. Enables logging to file.

       -t

       -b     Start at background


       -l --link-down-command, -L --link-up-command
              prefix  lenght  of  address  are given as parameters to command.
              Also the address is given as last parameter  (if  available)  If
              address is not available, zero is passed instead of address. See
              rtnetlink(7) for more accurate explanation of these parameters

       -r --route-removed-command, -R --route-added-command
              -r and -R install commands to be executed when route is added  /
              removed  from  routing  tables.  Address family, destination (if
              available) and destination lenght (in format  xxx/len),  routing
              table,  route type, gateway address and source address are given
              as parameters to command being executed. If destination  is  not
              given (like may be for default gateway), zero is given as desti‐
              nation. Similarly if gateway or source addresses are not  given,
              zero  is  passed as missing address to program being called. See
              rtnetlink(7) for more accurate explanation of these parameters




       Supported suboptions for -s

              route4 Listens IPv4 routing table changes

              route6 Listens IPv6 routing table changes

              addr6 Listens for IPv6 address changes

              link6 Listens for changes in IPv6 interfaces




       -V     Verbose, print details from nlmsgs

       -q     Quiet, print only errors.

       -v     display version and exit

       -h     display help and exit

       -?     display help and exit


FILES
       N/A
              N/A

BUGS
       Version 0.2 - Fall of Rome
              The event notifications should not be  interpreted  as  absolute
              state  information,  since  monitored  state  may  change  again
              between kernel sending notification of change, and  nsn  calling

v0.2 - Fall of Rome              04 June 2012                           nsn(8)

2 comments:

  1. I believe I should make a note about nsn versioning and man pages.

    I write man pages to describe functionalities in certain versions. The version of nsn I have written manpage for is visible at the bottom left corner of man page. I try to keep old commandline options compatible between releases, but sometimes there may be channges - as there was when jumping from 0.1 to 0.2. (-r option has different meaning)

    This man page is written for 0.2 - whis is not tagged yet (12th June 2012). However this functionality is already in trunk - although largely untested. And because I just had a new baby boy, it may be it remains in this state for a while. That's why I would be gratefull if users would report trunk either working or buggy - if there is any users that is =) I guess I could make a tag based on usability reports if nsn is relatively bug free =)

    ReplyDelete
  2. forgot to mention, trunk can be found from
    http://xp-dev.com/svn/nsn/trunk

    ReplyDelete