doc/ldpd.8.in

   1 .TH LDPD 8 "29 March 2016" "@PACKAGE_FULLNAME@ LDP daemon" "Version @PACKAGE_VERSION@"
   2 .SH NAME
   3 ldpd \- an LDP engine for use with @PACKAGE_FULLNAME@.
   4 .SH SYNOPSIS
   5 .B ldpd
   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 .B \-M
  28 .I module:options
  29 ]
  30 .SH DESCRIPTION
  31 .B ldpd
  32 is a component that works with the
  33 .B @PACKAGE_FULLNAME@
  34 routing engine.
  35 .SH OPTIONS
  36 Options available for the
  37 .B ldpd
  38 command:
  39 .TP
  40 \fB\-d\fR, \fB\-\-daemon\fR
  41 Runs in daemon mode, forking and exiting from tty.
  42 .TP
  43 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  44 Specifies the config file to use for startup. If not specified this
  45 option will default to \fB\fI@CFG_SYSCONF@/ldpd.conf\fR.
  46 .TP
  47 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  48 Specify the group to run as. Default is \fI@enable_group@\fR.
  49 .TP
  50 \fB\-h\fR, \fB\-\-help\fR
  51 A brief message.
  52 .TP
  53 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  54 When ldpd starts its process identifier is written to
  55 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  56 restart ldpd.  The default is \fB\fI@CFG_STATE@/ldpd.pid\fR.
  57 .TP
  58 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  59 Specify the port that the ldpd VTY will listen on. This defaults to
  60 2612, as specified in \fB\fI/etc/services\fR.
  61 .TP
  62 \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  63 Specify the address that the ldpd VTY will listen on. Default is all
  64 interfaces.
  65 .TP
  66 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  67 Specify the user to run as. Default is \fI@enable_user@\fR.
  68 .TP
  69 \fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
  70 Load a module at startup.  May be specified more than once.
  71 There are currently no such modules for
  72 \fBldpd\fR in the base package.
  73 .TP
  74 \fB\-v\fR, \fB\-\-version\fR
  75 Print the version and exit.
  76 .SH FILES
  77 .TP
  78 .BI @CFG_SBIN@/ldpd
  79 The default location of the
  80 .B ldpd
  81 binary.
  82 .TP
  83 .BI @CFG_SYSCONF@/ldpd.conf
  84 The default location of the
  85 .B ldpd
  86 config file.
  87 .TP
  88 .BI $(PWD)/ldpd.log
  89 If the
  90 .B ldpd
  91 process is config'd to output logs to a file, then you will find this
  92 file in the directory where you started \fBldpd\fR.
  93 .SH WARNING
  94 This man page is intended to be a quick reference for command line
  95 options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
  96 .SH DIAGNOSTICS
  97 The ldpd process may log to standard output, to a VTY, to a log
  98 file, or through syslog to the system logs. \fBldpd\fR supports many
  99 debugging options, see the Info file, or the source for details.
 100 .SH "SEE ALSO"
 101 .BR bgpd (8),
 102 .BR ripd (8),
 103 .BR ripngd (8),
 104 .BR ospfd (8),
 105 .BR ospf6d (8),
 106 .BR isisd (8),
 107 .BR zebra (8),
 108 .BR vtysh (1)
 109 .SH BUGS
 110 .B ldpd
 111 eats bugs for breakfast. If you have food for the maintainers try
 112 .BI @PACKAGE_BUGREPORT@
 113 .SH AUTHORS
 114 See
 115 .BI @PACKAGE_URL@
 116 or the Info file for an accurate list of authors.
 117