From eda7476539d2c2db4cc1f484f598507aa4d758e3 Mon Sep 17 00:00:00 2001 From: kefren Date: Fri, 18 Oct 2013 10:49:19 +0000 Subject: [PATCH] Attempt to write a manpage for ldpd.conf --- distrib/sets/lists/man/mi | 5 +- usr.sbin/ldpd/Makefile | 4 +- usr.sbin/ldpd/ldpd.conf.5 | 127 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 133 insertions(+), 3 deletions(-) create mode 100644 usr.sbin/ldpd/ldpd.conf.5 diff --git a/distrib/sets/lists/man/mi b/distrib/sets/lists/man/mi index a6ef1ffbb560..d8bcbe96fde1 100644 --- a/distrib/sets/lists/man/mi +++ b/distrib/sets/lists/man/mi @@ -1,4 +1,4 @@ -# $NetBSD: mi,v 1.1438 2013/10/15 19:20:19 jdc Exp $ +# $NetBSD: mi,v 1.1439 2013/10/18 10:49:19 kefren Exp $ # # Note: don't delete entries from here - mark them as "obsolete" instead. # @@ -2037,6 +2037,7 @@ ./usr/share/man/cat5/lastlogx.0 man-sys-catman .cat ./usr/share/man/cat5/ld.so.conf.0 man-sys-catman .cat ./usr/share/man/cat5/ldap_table.0 man-postfix-catman postfix,.cat +./usr/share/man/cat5/ldpd.conf.0 man-router-catman .cat ./usr/share/man/cat5/link.0 man-sys-catman .cat ./usr/share/man/cat5/lkm.conf.0 man-obsolete obsolete ./usr/share/man/cat5/locale.alias.0 man-sys-catman .cat @@ -4929,6 +4930,7 @@ ./usr/share/man/html5/lastlogx.html man-sys-htmlman html ./usr/share/man/html5/ld.so.conf.html man-sys-htmlman html ./usr/share/man/html5/ldap_table.html man-postfix-htmlman postfix,html +./usr/share/man/html5/ldpd.conf.html man-router-htmlman html ./usr/share/man/html5/link.html man-sys-htmlman html ./usr/share/man/html5/lkm.conf.html man-obsolete obsolete ./usr/share/man/html5/locale.alias.html man-sys-htmlman html @@ -7767,6 +7769,7 @@ ./usr/share/man/man5/lastlogx.5 man-sys-man .man ./usr/share/man/man5/ld.so.conf.5 man-sys-man .man ./usr/share/man/man5/ldap_table.5 man-postfix-man postfix,.man +./usr/share/man/man5/ldpd.conf.5 man-router-man .man ./usr/share/man/man5/link.5 man-sys-man .man ./usr/share/man/man5/lkm.conf.5 man-obsolete obsolete ./usr/share/man/man5/locale.alias.5 man-sys-man .man diff --git a/usr.sbin/ldpd/Makefile b/usr.sbin/ldpd/Makefile index 3553b2e82d18..f0969a18b14f 100644 --- a/usr.sbin/ldpd/Makefile +++ b/usr.sbin/ldpd/Makefile @@ -1,9 +1,9 @@ -# $NetBSD: Makefile,v 1.4 2012/11/12 18:39:00 kefren Exp $ +# $NetBSD: Makefile,v 1.5 2013/10/18 10:49:19 kefren Exp $ .include PROG= ldpd -MAN= ldpd.8 +MAN= ldpd.8 ldpd.conf.5 SRCS= conffile.c \ fsm.c \ diff --git a/usr.sbin/ldpd/ldpd.conf.5 b/usr.sbin/ldpd/ldpd.conf.5 new file mode 100644 index 000000000000..7ae3d9889bf3 --- /dev/null +++ b/usr.sbin/ldpd/ldpd.conf.5 @@ -0,0 +1,127 @@ +.\" $NetBSD: ldpd.conf.5,v 1.1 2013/10/18 10:49:19 kefren Exp $ +.\" +.\" Copyright (c) 2013 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd October 18, 2013 +.Dt LDPD.CONF 5 +.Os +.Sh NAME +.Nm ldpd.conf +.Nd ldpd configuration file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +The +.Nm +file defines the +.Xr ldpd 8 +initial setup and may contain information about LDP identificator, network, +neighbour and interface parameters. +Blank lines are allowed and comments lines should start with +.Sq # . +Non block lines should end with a semicolon. +.Sh FILES +.Bl -tag -width /etc/ldpd.conf -compact +.It Pa /etc/ldpd.conf +The file +.Nm +resides in +.Pa /etc . +.El +.Sh CONFIGURATION +The following options are accepted: +.Bl -tag -width "keepalive-time" +.It Li command-port +Control and command TCP port (default: 2626) +.It Li hello-time +Interval in seconds on which hellos are sent out on interfaces (default: 6s) +.It Li interface +Interface block commands (see below) +.It Li keepalive-time +Keepalive interval in seconds for established peers (default: 4s) +.It Li ldp-id +Force using a certain LDP Identificator (default autogenerated, highest INET4 +address set on an interface excluding 127/8 range) +.It Li min-label +Minimum number used for generated labels (default: 16) +.It Li max-label +Maximum number used for generated labels (default: 1048576) +.It Li neighbour +Neighbour block subcommands (see below) +.It Li no-default-route +If set to 0 +.Xr ldpd 8 +will try to tag also the default route (default: 1) +.El +.Pp +Interface block supports the following parameters +.Bl -tag -width "transport-address" +.It Li passive +Doesn't send hellos on interface +.It Li transport-address +Transport INET4 address advertised in hellos sent on the mentioned interface +.El +.Pp +Neighbour block supports the following parameters +.Bl -tag -width "authenticate" +.It Li authenticate +Authenticates peer using TCP MD5 signature - needs options TCP_SIGNATURE. +Default: off +.El +.Sh EXAMPLES +The following is an example +.Pa /etc/ldpd.conf +file: +.Pp +.Bd -literal +# Transport address needs to be an alias for this interface +interface re0 { + transport-address 192.168.2.2 +} + +# Don't send hellos on en0 +interface en0 { + passive +} + +# Force a certain LDP ID +ldp-id 10.5.1.1; + +# Tag also the default route +no-default-route 0; + +neighbour 192.168.2.1 { +# TCP MD5 authentication - requires options TCP_SIGNATURE + authenticate +} +.Ed +.Sh SEE ALSO +.Xr ldpd 8 , +.Xr mpls 4 , +.Sh HISTORY +Support for +.Nm +first appeared in +.Nx 6.0 .