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 .SH DESCRIPTION
  28 .B ldpd
  29 is a component that works with the
  30 .B @PACKAGE_FULLNAME@
  31 routing engine.
  32 .SH OPTIONS
  33 Options available for the
  34 .B ldpd
  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 default to \fB\fI@CFG_SYSCONF@/ldpd.conf\fR.
  43 .TP
  44 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  45 Specify the group to run as. Default is \fI@enable_group@\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 ldpd starts its process identifier is written to
  52 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  53 restart ldpd.  The default is \fB\fI@CFG_STATE@/ldpd.pid\fR.
  54 .TP
  55 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  56 Specify the port that the ldpd VTY will listen on. This defaults to
  57 2612, 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 ldpd 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 \fI@enable_user@\fR.
  65 .TP
  66 \fB\-v\fR, \fB\-\-version\fR
  67 Print the version and exit.
  68 .SH FILES
  69 .TP
  70 .BI @CFG_SBIN@/ldpd
  71 The default location of the
  72 .B ldpd
  73 binary.
  74 .TP
  75 .BI @CFG_SYSCONF@/ldpd.conf
  76 The default location of the
  77 .B ldpd
  78 config file.
  79 .TP
  80 .BI $(PWD)/ldpd.log
  81 If the
  82 .B ldpd
  83 process is config'd to output logs to a file, then you will find this
  84 file in the directory where you started \fBldpd\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 \fB@PACKAGE_NAME@\fR.
  88 .SH DIAGNOSTICS
  89 The ldpd process may log to standard output, to a VTY, to a log
  90 file, or through syslog to the system logs. \fBldpd\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 isisd (8),
  99 .BR zebra (8),
 100 .BR vtysh (1)
 101 .SH BUGS
 102 .B ldpd
 103 eats bugs for breakfast. If you have food for the maintainers try
 104 .BI @PACKAGE_BUGREPORT@
 105 .SH AUTHORS
 106 See
 107 .BI @PACKAGE_URL@
 108 or the Info file for an accurate list of authors.
 109