1
0
mirror of https://github.com/bgp/bgpq4.git synced 2024-05-11 05:55:05 +00:00

Improve manpage

This commit is contained in:
Job Snijders
2021-08-19 14:59:58 +00:00
parent 2391fdb317
commit 78f57867cc
2 changed files with 24 additions and 5 deletions

View File

@@ -7,7 +7,7 @@ AM_CPPFLAGS += -I$(top_srcdir)/compat
AUTOMAKE_OPTIONS=foreign subdir-objects
bin_PROGRAMS=bgpq4
dist_man8_MANS=bgpq4.8
man8_MANS=bgpq4.8
bgpq4_LDADD = $(PLATFORM_LDADD) $(PROG_LDADD)

27
bgpq4.8
View File

@@ -251,10 +251,29 @@ ipfw add pass all from 193.193.192.0/19 to any
.Ed
.fi
.Pp
Recognized format characters: %n - network, %l - mask length,
%a - aggregate low mask length, %A - aggregate high mask length,
%N - object name, %m - object mask and %i - inversed mask.
Recognized escape characters: \\n - new line, \\t - tabulation.
Recognized format sequences are:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm %n
network
.It Cm %l
mask length
.It Cm %a
aggregate low mask length
.It Cm %A
aggregate high mask length
.It Cm %N
object name
.It Cm %m
object mask
.It Cm %i
inversed mask
.It Cm \en
new line
.It Cm \et
tabulation
.El
.Pp
Please note that no new lines inserted automatically after each sentence,
you have to add them into format string manually, elsewhere output will
be in one line (sometimes it makes sense):