doc/nhrpd.8

   1 .TH NHRP 8 "24 January 2017" "Quagga NHRP daemon" "Version 1.1"
   2 .SH NAME
   3 nhrpd \- a Next Hop Routing Protocol routing engine for use with Quagga routing software.
   4 .SH SYNOPSIS
   5 .B nhrpd
   6 [
   7 .B \-dhv
   8 ] [
   9 .B \-f
  10 .I config-file
  11 ] [
  12 .B \-i
  13 .I pid-file
  14 ] [
  15 .B \-P
  16 .I port-number
  17 ] [
  18 .B \-A
  19 .I vty-address
  20 ] [
  21 .B \-u
  22 .I user
  23 ] [
  24 .B \-g
  25 .I group
  26 ]
  27 .SH DESCRIPTION
  28 .B nhrpd
  29 is a routing component that works with the
  30 .B Quagga
  31 routing engine.
  32 .SH OPTIONS
  33 Options available for the
  34 .B nhrpd
  35 command:
  36 .TP
  37 \fB\-d\fR, \fB\-\-daemon\fR
  38 Runs in daemon mode, forking and exiting from tty.
  39 .TP
  40 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  41 Specifies the config file to use for startup. If not specified this
  42 option will likely default to \fB\fI/usr/local/etc/nhrpd.conf\fR.
  43 .TP
  44 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  45 Specify the group to run as. Default is \fIquagga\fR.
  46 .TP
  47 \fB\-h\fR, \fB\-\-help\fR
  48 A brief message.
  49 .TP
  50 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  51 When nhrpd starts its process identifier is written to
  52 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  53 restart nhrpd.  The likely default is \fB\fI/var/run/nhrpd.pid\fR.
  54 .TP
  55 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  56 Specify the port that the nhrpd VTY will listen on. This defaults to
  57 2608, as specified in \fB\fI/etc/services\fR.
  58 .TP
  59 \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  60 Specify the address that the nhrpd VTY will listen on. Default is all
  61 interfaces.
  62 .TP
  63 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  64 Specify the user to run as. Default is \fIquagga\fR.
  65 .TP
  66 \fB\-v\fR, \fB\-\-version\fR
  67 Print the version and exit.
  68 .SH FILES
  69 .TP
  70 .BI /usr/local/sbin/nhrpd
  71 The default location of the
  72 .B nhrpd
  73 binary.
  74 .TP
  75 .BI /usr/local/etc/nhrpd.conf
  76 The default location of the
  77 .B nhrpd
  78 config file.
  79 .TP
  80 .BI $(PWD)/nhrpd.log
  81 If the
  82 .B nhrpd
  83 process is config'd to output logs to a file, then you will find this
  84 file in the directory where you started \fBnhrpd\fR.
  85 .SH WARNING
  86 This man page is intended to be a quick reference for command line
  87 options. The definitive document is the Info file \fBQuagga\fR.
  88 .SH DIAGNOSTICS
  89 The nhrpd process may log to standard output, to a VTY, to a log
  90 file, or through syslog to the system logs. \fBnhrpd\fR supports many
  91 debugging options, see the Info file, or the source for details.
  92 .SH "SEE ALSO"
  93 .BR bgpd (8),
  94 .BR ripd (8),
  95 .BR ripngd (8),
  96 .BR ospfd (8),
  97 .BR ospf6d (8),
  98 .BR zebra (8),
  99 .BR vtysh (1)
 100
 101 .B nhrpd
 102 eats bugs for breakfast. If you have food for the maintainers try
 103 .BI http://bugzilla.quagga.net
 104 .SH AUTHORS
 105 Timo Teräs <timo.teras@iki.fi>