doc: rename man pages to frr-*

The vrrpd one conflicts with the standalone vrrpd package; also we're
installing daemons to /usr/lib/frr on some systems so they're not on
PATH.

Signed-off-by: David Lamparter <equinox@diac24.net>
This commit is contained in:
David Lamparter 2020-01-15 00:00:32 +01:00
parent f014634e85
commit 429576883e
43 changed files with 102 additions and 102 deletions

View File

@ -8,7 +8,7 @@ sbin_PROGRAMS += bfdd/bfdd
dist_examples_DATA += bfdd/bfdd.conf.sample
vtysh_scan += $(top_srcdir)/bfdd/bfdd_vty.c
vtysh_scan += $(top_srcdir)/bfdd/bfdd_cli.c
man8 += $(MANBUILD)/bfdd.8
man8 += $(MANBUILD)/frr-bfdd.8
endif
bfdd_libbfd_a_SOURCES = \

View File

@ -46,7 +46,7 @@ endif
if BGP_BMP
module_LTLIBRARIES += bgpd/bgpd_bmp.la
endif
man8 += $(MANBUILD)/bgpd.8
man8 += $(MANBUILD)/frr-bgpd.8
endif
bgpd_libbgp_a_SOURCES = \

28
debian/frr.manpages vendored
View File

@ -1,16 +1,16 @@
doc/manpages/_build/man/frr-bgpd.8
doc/manpages/_build/man/frr-eigrpd.8
doc/manpages/_build/man/frr-fabricd.8
doc/manpages/_build/man/frr-isisd.8
doc/manpages/_build/man/frr-ldpd.8
doc/manpages/_build/man/frr-nhrpd.8
doc/manpages/_build/man/frr-ospf6d.8
doc/manpages/_build/man/frr-ospfd.8
doc/manpages/_build/man/frr-pimd.8
doc/manpages/_build/man/frr-ripd.8
doc/manpages/_build/man/frr-ripngd.8
doc/manpages/_build/man/frr-watchfrr.8
doc/manpages/_build/man/frr-zebra.8
doc/manpages/_build/man/frr.1
doc/manpages/_build/man/bgpd.8
doc/manpages/_build/man/pimd.8
doc/manpages/_build/man/eigrpd.8
doc/manpages/_build/man/ldpd.8
doc/manpages/_build/man/nhrpd.8
doc/manpages/_build/man/ospf6d.8
doc/manpages/_build/man/ospfd.8
doc/manpages/_build/man/ripd.8
doc/manpages/_build/man/ripngd.8
doc/manpages/_build/man/vtysh.1
doc/manpages/_build/man/zebra.8
doc/manpages/_build/man/isisd.8
doc/manpages/_build/man/watchfrr.8
doc/manpages/_build/man/mtracebis.8
doc/manpages/_build/man/fabricd.8
doc/manpages/_build/man/vtysh.1

View File

@ -313,28 +313,28 @@ latex_documents = [
fwfrr = "{0} routing engine for use with FRRouting."
man_pages = [
('bgpd', 'bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4- "), [], 8),
('eigrpd', 'eigrpd', fwfrr.format("an EIGRP "), [], 8),
('ospf6d', 'ospf6d', fwfrr.format("an OSPFv3 "), [], 8),
('ospfd', 'ospfd', fwfrr.format("an OSPFv2 "), [], 8),
('isisd', 'isisd', fwfrr.format("an IS-IS "), [], 8),
('ospfclient', 'ospfclient', 'an example ospf-api client', [], 8),
('ldpd', 'ldpd', fwfrr.format("an LDP "), [], 8),
('nhrpd', 'nhrpd', fwfrr.format("a Next Hop Routing Protocol "), [], 8),
('pimd', 'pimd', fwfrr.format("a PIM "), [], 8),
('pbrd', 'pbrd', fwfrr.format("a PBR "), [], 8),
('sharpd', 'sharpd', fwfrr.format("a SHARP "), [], 8),
('staticd', 'staticd', fwfrr.format("a static route manager "), [], 8),
('mtracebis', 'mtracebis', "a multicast trace client", [], 8),
('ripd', 'ripd', fwfrr.format("a RIP "), [], 8),
('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8),
('zebra', 'zebra', 'a routing manager for use with associated FRRouting components.', [], 8),
('watchfrr', 'watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8),
('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1),
('frr-bfdd', 'frr-bfdd', fwfrr.format("a bfd"), [], 8),
('frr-bgpd', 'frr-bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4-"), [], 8),
('frr-eigrpd', 'frr-eigrpd', fwfrr.format("an EIGRP"), [], 8),
('frr-fabricd', 'frr-fabricd', fwfrr.format("an OpenFabric"), [], 8),
('frr-isisd', 'frr-isisd', fwfrr.format("an IS-IS"), [], 8),
('frr-ldpd', 'frr-ldpd', fwfrr.format("an LDP"), [], 8),
('frr-nhrpd', 'frr-nhrpd', fwfrr.format("a Next Hop Routing Protocol"), [], 8),
('frr-ospf6d', 'frr-ospf6d', fwfrr.format("an OSPFv3"), [], 8),
('frr-ospfclient', 'frr-ospfclient', 'an example ospf-api client', [], 8),
('frr-ospfd', 'frr-ospfd', fwfrr.format("an OSPFv2"), [], 8),
('frr-pbrd', 'frr-pbrd', fwfrr.format("a PBR"), [], 8),
('frr-pimd', 'frr-pimd', fwfrr.format("a PIM"), [], 8),
('frr-ripd', 'frr-ripd', fwfrr.format("a RIP"), [], 8),
('frr-ripngd', 'frr-ripngd', fwfrr.format("a RIPNG"), [], 8),
('frr-sharpd', 'frr-sharpd', fwfrr.format("a SHARP"), [], 8),
('frr-staticd', 'frr-staticd', fwfrr.format("a static route manager"), [], 8),
('frr-vrrpd', 'frr-vrrpd', fwfrr.format("a VRRP"), [], 8),
('frr-watchfrr', 'frr-watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8),
('frr-zebra', 'frr-zebra', 'a routing manager for use with associated FRRouting components.', [], 8),
('frr', 'frr', 'a systemd interaction script', [], 1),
('bfdd', 'bfdd', fwfrr.format("a bfd"), [], 8),
('fabricd', 'fabricd', fwfrr.format("an OpenFabric "), [], 8),
('vrrpd', 'vrrpd', fwfrr.format("a VRRP"), [], 8),
('mtracebis', 'mtracebis', "a multicast trace client", [], 8),
('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1),
]
# -- Options for Texinfo output -------------------------------------------

View File

@ -1,3 +1,3 @@
.. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path]
.. |synopsis-options-hv| replace:: [-h] [-v]
.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), pbrd(8), ldpd(8), eigrpd(8), staticd(8), fabricd(8), vrrpd(8), mtracebis(8)
.. |seealso-programs| replace:: frr-zebra(8), vtysh(1), frr-ripd(8), frr-ripngd(8), frr-ospfd(8), frr-ospf6d(8), frr-bgpd(8), frr-isisd(8), frr-babeld(8), frr-nhrpd(8), frr-pimd(8), frr-pbrd(8), frr-ldpd(8), frr-eigrpd(8), frr-staticd(8), frr-fabricd(8), frr-vrrpd(8), mtracebis(8)

View File

@ -6,25 +6,25 @@
.. toctree::
:maxdepth: 2
bfdd
bgpd
eigrpd
isisd
fabricd
ldpd
nhrpd
ospf6d
ospfclient
ospfd
pimd
pbrd
mtracebis
ripd
ripngd
sharpd
staticd
watchfrr
zebra
vtysh
vrrpd
frr
frr-bfdd
frr-bgpd
frr-eigrpd
frr-isisd
frr-fabricd
frr-ldpd
frr-nhrpd
frr-ospf6d
frr-ospfclient
frr-ospfd
frr-pimd
frr-pbrd
frr-ripd
frr-ripngd
frr-sharpd
frr-staticd
frr-watchfrr
frr-zebra
frr-vrrpd
mtracebis
vtysh

View File

@ -3,34 +3,34 @@
#
man_RSTFILES = \
doc/manpages/bgpd.rst \
doc/manpages/bfd-options.rst \
doc/manpages/common-options.rst \
doc/manpages/conf.py \
doc/manpages/defines.rst \
doc/manpages/eigrpd.rst \
doc/manpages/epilogue.rst \
doc/manpages/fabricd.rst \
doc/manpages/frr-bfdd.rst \
doc/manpages/frr-bgpd.rst \
doc/manpages/frr-eigrpd.rst \
doc/manpages/frr-fabricd.rst \
doc/manpages/frr-isisd.rst \
doc/manpages/frr-ldpd.rst \
doc/manpages/frr-nhrpd.rst \
doc/manpages/frr-ospf6d.rst \
doc/manpages/frr-ospfclient.rst \
doc/manpages/frr-ospfd.rst \
doc/manpages/frr-pbrd.rst \
doc/manpages/frr-pimd.rst \
doc/manpages/frr-ripd.rst \
doc/manpages/frr-ripngd.rst \
doc/manpages/frr-sharpd.rst \
doc/manpages/frr-staticd.rst \
doc/manpages/frr-vrrpd.rst \
doc/manpages/frr-watchfrr.rst \
doc/manpages/frr-zebra.rst \
doc/manpages/frr.rst \
doc/manpages/index.rst \
doc/manpages/isisd.rst \
doc/manpages/ldpd.rst \
doc/manpages/mtracebis.rst \
doc/manpages/nhrpd.rst \
doc/manpages/ospf6d.rst \
doc/manpages/ospfclient.rst \
doc/manpages/ospfd.rst \
doc/manpages/pimd.rst \
doc/manpages/ripd.rst \
doc/manpages/pbrd.rst \
doc/manpages/ripngd.rst \
doc/manpages/sharpd.rst \
doc/manpages/staticd.rst \
doc/manpages/vtysh.rst \
doc/manpages/watchfrr.rst \
doc/manpages/zebra.rst \
doc/manpages/bfdd.rst \
doc/manpages/bfd-options.rst \
doc/manpages/vrrpd.rst \
# end
EXTRA_DIST += $(man_RSTFILES)

View File

@ -12,7 +12,7 @@ vtysh_scan += \
$(top_srcdir)/eigrpd/eigrp_vty.c \
# end
# $(top_srcdir)/eigrpd/eigrp_routemap.c
man8 += $(MANBUILD)/eigrpd.8
man8 += $(MANBUILD)/frr-eigrpd.8
endif
eigrpd_libeigrp_a_SOURCES = \

View File

@ -14,7 +14,7 @@ vtysh_scan += \
$(top_srcdir)/isisd/isis_vty_fabricd.c \
$(top_srcdir)/isisd/isisd.c \
# end
man8 += $(MANBUILD)/isisd.8
man8 += $(MANBUILD)/frr-isisd.8
endif
if FABRICD

View File

@ -7,7 +7,7 @@ noinst_LIBRARIES += ldpd/libldp.a
sbin_PROGRAMS += ldpd/ldpd
dist_examples_DATA += ldpd/ldpd.conf.sample
vtysh_scan += $(top_srcdir)/ldpd/ldp_vty_cmds.c
man8 += $(MANBUILD)/ldpd.8
man8 += $(MANBUILD)/frr-ldpd.8
endif
ldpd_libldp_a_SOURCES = \

View File

@ -5,7 +5,7 @@
if NHRPD
sbin_PROGRAMS += nhrpd/nhrpd
vtysh_scan += $(top_srcdir)/nhrpd/nhrp_vty.c
man8 += $(MANBUILD)/nhrpd.8
man8 += $(MANBUILD)/frr-nhrpd.8
endif
nhrpd_nhrpd_LDADD = lib/libfrr.la lib/libfrrcares.la $(LIBCAP)

View File

@ -26,7 +26,7 @@ vtysh_scan += \
if SNMP
module_LTLIBRARIES += ospf6d/ospf6d_snmp.la
endif
man8 += $(MANBUILD)/ospf6d.8
man8 += $(MANBUILD)/frr-ospf6d.8
endif
ospf6d_libospf6_a_SOURCES = \

View File

@ -5,7 +5,7 @@
if OSPFCLIENT
lib_LTLIBRARIES += ospfclient/libfrrospfapiclient.la
noinst_PROGRAMS += ospfclient/ospfclient
man8 += $(MANBUILD)/ospfclient.8
man8 += $(MANBUILD)/frr-ospfclient.8
endif
ospfclient_libfrrospfapiclient_la_LDFLAGS = -version-info 0:0:0

View File

@ -19,7 +19,7 @@ vtysh_scan += \
if SNMP
module_LTLIBRARIES += ospfd/ospfd_snmp.la
endif
man8 += $(MANBUILD)/ospfd.8
man8 += $(MANBUILD)/frr-ospfd.8
endif
ospfd_libfrrospf_a_SOURCES = \

View File

@ -10,7 +10,7 @@ vtysh_scan += \
$(top_srcdir)/pbrd/pbr_vty.c \
$(top_srcdir)/pbrd/pbr_debug.c \
# end
man8 += $(MANBUILD)/pbrd.8
man8 += $(MANBUILD)/frr-pbrd.8
endif
pbrd_libpbr_a_SOURCES = \

View File

@ -9,7 +9,7 @@ bin_PROGRAMS += pimd/mtracebis
noinst_PROGRAMS += pimd/test_igmpv3_join
dist_examples_DATA += pimd/pimd.conf.sample
vtysh_scan += $(top_srcdir)/pimd/pim_cmd.c
man8 += $(MANBUILD)/pimd.8
man8 += $(MANBUILD)/frr-pimd.8
man8 += $(MANBUILD)/mtracebis.8
endif

View File

@ -15,7 +15,7 @@ vtysh_scan += \
if SNMP
module_LTLIBRARIES += ripd/ripd_snmp.la
endif
man8 += $(MANBUILD)/ripd.8
man8 += $(MANBUILD)/frr-ripd.8
endif
ripd_librip_a_SOURCES = \

View File

@ -10,7 +10,7 @@ vtysh_scan += \
$(top_srcdir)/ripngd/ripng_debug.c \
$(top_srcdir)/ripngd/ripngd.c \
# end
man8 += $(MANBUILD)/ripngd.8
man8 += $(MANBUILD)/frr-ripngd.8
endif
ripngd_libripng_a_SOURCES = \

View File

@ -7,7 +7,7 @@ noinst_LIBRARIES += sharpd/libsharp.a
sbin_PROGRAMS += sharpd/sharpd
dist_examples_DATA += sharpd/sharpd.conf.sample
vtysh_scan += $(top_srcdir)/sharpd/sharp_vty.c
man8 += $(MANBUILD)/sharpd.8
man8 += $(MANBUILD)/frr-sharpd.8
endif
sharpd_libsharp_a_SOURCES = \

View File

@ -8,10 +8,10 @@ d none @mandir@=$DESTDIR/@mandir@ 0755 root bin
d none @mandir@/man1=$DESTDIR/@mandir@/man1 0755 root bin
f none @mandir@/man1/vtysh.1=$DESTDIR/@mandir@/man1/vtysh.1 0644 root bin
d none @mandir@/man8=$DESTDIR/@mandir@/man8 0755 root bin
f none @mandir@/man8/bgpd.8=$DESTDIR/@mandir@/man8/bgpd.8 0644 root bin
f none @mandir@/man8/ospf6d.8=$DESTDIR/@mandir@/man8/ospf6d.8 0644 root bin
f none @mandir@/man8/ospfd.8=$DESTDIR/@mandir@/man8/ospfd.8 0644 root bin
f none @mandir@/man8/ripd.8=$DESTDIR/@mandir@/man8/ripd.8 0644 root bin
f none @mandir@/man8/ripngd.8=$DESTDIR/@mandir@/man8/ripngd.8 0644 root bin
f none @mandir@/man8/zebra.8=$DESTDIR/@mandir@/man8/zebra.8 0644 root bin
f none @mandir@/man8/isisd.8=$DESTDIR/@mandir@/man8/isisd.8 0644 root bin
f none @mandir@/man8/frr-bgpd.8=$DESTDIR/@mandir@/man8/bgpd.8 0644 root bin
f none @mandir@/man8/frr-ospf6d.8=$DESTDIR/@mandir@/man8/frr-ospf6d.8 0644 root bin
f none @mandir@/man8/frr-ospfd.8=$DESTDIR/@mandir@/man8/frr-ospfd.8 0644 root bin
f none @mandir@/man8/frr-ripd.8=$DESTDIR/@mandir@/man8/frr-ripd.8 0644 root bin
f none @mandir@/man8/frr-ripngd.8=$DESTDIR/@mandir@/man8/frr-ripngd.8 0644 root bin
f none @mandir@/man8/frr-zebra.8=$DESTDIR/@mandir@/man8/frr-zebra.8 0644 root bin
f none @mandir@/man8/frr-isisd.8=$DESTDIR/@mandir@/man8/frr-isisd.8 0644 root bin

View File

@ -7,7 +7,7 @@ noinst_LIBRARIES += staticd/libstatic.a
sbin_PROGRAMS += staticd/staticd
dist_examples_DATA += staticd/staticd.conf.sample
vtysh_scan += $(top_srcdir)/staticd/static_vty.c
man8 += $(MANBUILD)/staticd.8
man8 += $(MANBUILD)/frr-staticd.8
endif
staticd_libstatic_a_SOURCES = \

View File

@ -7,7 +7,7 @@ noinst_LIBRARIES += vrrpd/libvrrp.a
sbin_PROGRAMS += vrrpd/vrrpd
# dist_examples_DATA += staticd/staticd.conf.sample
vtysh_scan += $(top_srcdir)/vrrpd/vrrp_vty.c
man8 += $(MANBUILD)/vrrpd.8
man8 += $(MANBUILD)/frr-vrrpd.8
endif
vrrpd_libvrrp_a_SOURCES = \

View File

@ -5,7 +5,7 @@
if WATCHFRR
sbin_PROGRAMS += watchfrr/watchfrr
vtysh_scan += $(top_srcdir)/watchfrr/watchfrr_vty.c
man8 += $(MANBUILD)/watchfrr.8
man8 += $(MANBUILD)/frr-watchfrr.8
endif
noinst_HEADERS += \

View File

@ -36,7 +36,7 @@ if LINUX
module_LTLIBRARIES += zebra/zebra_cumulus_mlag.la
endif
man8 += $(MANBUILD)/zebra.8
man8 += $(MANBUILD)/frr-zebra.8
## endif ZEBRA
endif