From 9bccc3ff031e140dfc2a3a6975ef50fdad01301f Mon Sep 17 00:00:00 2001 From: Ilya Maximets Date: Mon, 29 Oct 2018 17:46:33 +0300 Subject: [PATCH] manpages: Include ovs.tmac in most man roots. This allows to not redefine common macroses in every single file and allowes using things like .EX without warying about compatibility. manpages.mk updated automatically. Files that are already complete pages (i.e. has no *.in sources) wasn't touched, because this will require additional file manipulations and changes in makefiles/specs without serious profit. Signed-off-by: Ilya Maximets Signed-off-by: Ben Pfaff --- lib/colors.man | 5 --- lib/common.man | 5 --- lib/ofp-version.man | 5 --- lib/ssl.man | 5 --- lib/vlog-unixctl.man | 5 --- lib/vlog.man | 5 --- manpages.mk | 56 +++++++++++++++++++++----- ovn/utilities/ovn-detrace.1.in | 1 + ovn/utilities/ovn-sbctl.8.in | 12 +----- ovsdb/ovsdb-client.1.in | 7 +--- ovsdb/ovsdb-server.1.in | 6 +-- ovsdb/ovsdb-tool.1.in | 7 +--- utilities/bugtool/ovs-bugtool.8.in | 6 +-- utilities/ovs-appctl.8.in | 6 +-- utilities/ovs-dpctl-top.8.in | 6 +-- utilities/ovs-dpctl.8.in | 6 +-- utilities/ovs-l3ping.8.in | 6 +-- utilities/ovs-ofctl.8.in | 6 +-- utilities/ovs-pcap.1.in | 1 + utilities/ovs-pki.8.in | 6 +-- utilities/ovs-tcpdump.8.in | 1 + utilities/ovs-tcpundump.1.in | 1 + utilities/ovs-testcontroller.8.in | 6 +-- utilities/ovs-vlan-bug-workaround.8.in | 6 +-- utilities/ovs-vsctl.8.in | 12 +----- vtep/vtep-ctl.8.in | 12 +----- 26 files changed, 66 insertions(+), 134 deletions(-) diff --git a/lib/colors.man b/lib/colors.man index 12fa7a609..f93d816b1 100644 --- a/lib/colors.man +++ b/lib/colors.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .IP "\fB\-\-color\fR[\fB=\fR\fIwhen\fR] . Colorize the output (for some commands); \fIwhen\fR can be \fBnever\fR, diff --git a/lib/common.man b/lib/common.man index 4cbed0df9..41b8e2f96 100644 --- a/lib/common.man +++ b/lib/common.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .IP "\fB\-h\fR" .IQ "\fB\-\-help\fR" Prints a brief help message to the console. diff --git a/lib/ofp-version.man b/lib/ofp-version.man index 0ab70891d..39e4477d1 100644 --- a/lib/ofp-version.man +++ b/lib/ofp-version.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .IP "\fB\-O \fR[\fIversion\fR[\fB,\fIversion\fR]...]\fR" .IQ "\fB\-\-protocols=\fR[\fIversion\fR[\fB,\fIversion\fR]...]\fR" Sets the OpenFlow protocol versions that are allowed when establishing diff --git a/lib/ssl.man b/lib/ssl.man index 5f0215c01..44a95fd68 100644 --- a/lib/ssl.man +++ b/lib/ssl.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .IP "\fB\-p\fR \fIprivkey.pem\fR" .IQ "\fB\-\-private\-key=\fIprivkey.pem\fR" Specifies a PEM file containing the private key used as \fB\*(PN\fR's diff --git a/lib/vlog-unixctl.man b/lib/vlog-unixctl.man index 7372a7ef4..8539a89b5 100644 --- a/lib/vlog-unixctl.man +++ b/lib/vlog-unixctl.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .SS "VLOG COMMANDS" These commands manage \fB\*(PN\fR's logging settings. .IP "\fBvlog/set\fR [\fIspec\fR]" diff --git a/lib/vlog.man b/lib/vlog.man index bad80e3d2..e09bbc505 100644 --- a/lib/vlog.man +++ b/lib/vlog.man @@ -1,8 +1,3 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. .IP "\fB\-v\fR[\fIspec\fR] .IQ "\fB\-\-verbose=\fR[\fIspec\fR] . diff --git a/manpages.mk b/manpages.mk index 0fd986e00..5f43aa387 100644 --- a/manpages.mk +++ b/manpages.mk @@ -3,15 +3,18 @@ ovn/utilities/ovn-detrace.1: \ ovn/utilities/ovn-detrace.1.in \ lib/common-syn.man \ - lib/common.man + lib/common.man \ + lib/ovs.tmac ovn/utilities/ovn-detrace.1.in: lib/common-syn.man: lib/common.man: +lib/ovs.tmac: ovn/utilities/ovn-sbctl.8: \ ovn/utilities/ovn-sbctl.8.in \ lib/common.man \ lib/db-ctl-base.man \ + lib/ovs.tmac \ lib/ssl-bootstrap.man \ lib/ssl.man \ lib/table.man \ @@ -19,6 +22,7 @@ ovn/utilities/ovn-sbctl.8: \ ovn/utilities/ovn-sbctl.8.in: lib/common.man: lib/db-ctl-base.man: +lib/ovs.tmac: lib/ssl-bootstrap.man: lib/ssl.man: lib/table.man: @@ -30,6 +34,7 @@ ovsdb/ovsdb-client.1: \ lib/common.man \ lib/daemon-syn.man \ lib/daemon.man \ + lib/ovs.tmac \ lib/ssl-bootstrap-syn.man \ lib/ssl-bootstrap.man \ lib/ssl-connect-syn.man \ @@ -45,6 +50,7 @@ lib/common-syn.man: lib/common.man: lib/daemon-syn.man: lib/daemon.man: +lib/ovs.tmac: lib/ssl-bootstrap-syn.man: lib/ssl-bootstrap.man: lib/ssl-connect-syn.man: @@ -64,6 +70,7 @@ ovsdb/ovsdb-server.1: \ lib/daemon-syn.man \ lib/daemon.man \ lib/memory-unixctl.man \ + lib/ovs.tmac \ lib/service-syn.man \ lib/service.man \ lib/ssl-bootstrap-syn.man \ @@ -86,6 +93,7 @@ lib/coverage-unixctl.man: lib/daemon-syn.man: lib/daemon.man: lib/memory-unixctl.man: +lib/ovs.tmac: lib/service-syn.man: lib/service.man: lib/ssl-bootstrap-syn.man: @@ -106,47 +114,59 @@ ovsdb/ovsdb-tool.1: \ ovsdb/ovsdb-tool.1.in \ lib/common-syn.man \ lib/common.man \ + lib/ovs.tmac \ lib/vlog-syn.man \ lib/vlog.man \ ovsdb/ovsdb-schemas.man ovsdb/ovsdb-tool.1.in: lib/common-syn.man: lib/common.man: +lib/ovs.tmac: lib/vlog-syn.man: lib/vlog.man: ovsdb/ovsdb-schemas.man: utilities/bugtool/ovs-bugtool.8: \ - utilities/bugtool/ovs-bugtool.8.in + utilities/bugtool/ovs-bugtool.8.in \ + lib/ovs.tmac utilities/bugtool/ovs-bugtool.8.in: +lib/ovs.tmac: utilities/ovs-appctl.8: \ utilities/ovs-appctl.8.in \ - lib/common.man + lib/common.man \ + lib/ovs.tmac utilities/ovs-appctl.8.in: lib/common.man: +lib/ovs.tmac: utilities/ovs-dpctl-top.8: \ - utilities/ovs-dpctl-top.8.in + utilities/ovs-dpctl-top.8.in \ + lib/ovs.tmac utilities/ovs-dpctl-top.8.in: +lib/ovs.tmac: utilities/ovs-dpctl.8: \ utilities/ovs-dpctl.8.in \ lib/common.man \ lib/dpctl.man \ + lib/ovs.tmac \ lib/vlog.man utilities/ovs-dpctl.8.in: lib/common.man: lib/dpctl.man: +lib/ovs.tmac: lib/vlog.man: utilities/ovs-l3ping.8: \ utilities/ovs-l3ping.8.in \ lib/common-syn.man \ - lib/common.man + lib/common.man \ + lib/ovs.tmac utilities/ovs-l3ping.8.in: lib/common-syn.man: lib/common.man: +lib/ovs.tmac: utilities/ovs-ofctl.8: \ utilities/ovs-ofctl.8.in \ @@ -154,6 +174,7 @@ utilities/ovs-ofctl.8: \ lib/common.man \ lib/daemon.man \ lib/ofp-version.man \ + lib/ovs.tmac \ lib/ssl.man \ lib/unixctl.man \ lib/vconn-active.man \ @@ -163,6 +184,7 @@ lib/colors.man: lib/common.man: lib/daemon.man: lib/ofp-version.man: +lib/ovs.tmac: lib/ssl.man: lib/unixctl.man: lib/vconn-active.man: @@ -171,34 +193,43 @@ lib/vlog.man: utilities/ovs-pcap.1: \ utilities/ovs-pcap.1.in \ lib/common-syn.man \ - lib/common.man + lib/common.man \ + lib/ovs.tmac utilities/ovs-pcap.1.in: lib/common-syn.man: lib/common.man: +lib/ovs.tmac: utilities/ovs-pki.8: \ - utilities/ovs-pki.8.in + utilities/ovs-pki.8.in \ + lib/ovs.tmac utilities/ovs-pki.8.in: +lib/ovs.tmac: utilities/ovs-tcpdump.8: \ utilities/ovs-tcpdump.8.in \ - lib/common.man + lib/common.man \ + lib/ovs.tmac utilities/ovs-tcpdump.8.in: lib/common.man: +lib/ovs.tmac: utilities/ovs-tcpundump.1: \ utilities/ovs-tcpundump.1.in \ lib/common-syn.man \ - lib/common.man + lib/common.man \ + lib/ovs.tmac utilities/ovs-tcpundump.1.in: lib/common-syn.man: lib/common.man: +lib/ovs.tmac: utilities/ovs-testcontroller.8: \ utilities/ovs-testcontroller.8.in \ lib/common.man \ lib/daemon.man \ lib/ofp-version.man \ + lib/ovs.tmac \ lib/ssl-peer-ca-cert.man \ lib/ssl.man \ lib/unixctl.man \ @@ -209,6 +240,7 @@ utilities/ovs-testcontroller.8.in: lib/common.man: lib/daemon.man: lib/ofp-version.man: +lib/ovs.tmac: lib/ssl-peer-ca-cert.man: lib/ssl.man: lib/unixctl.man: @@ -219,15 +251,18 @@ lib/vlog.man: utilities/ovs-vlan-bug-workaround.8: \ utilities/ovs-vlan-bug-workaround.8.in \ lib/common.man \ + lib/ovs.tmac \ utilities/ovs-vlan-bugs.man utilities/ovs-vlan-bug-workaround.8.in: lib/common.man: +lib/ovs.tmac: utilities/ovs-vlan-bugs.man: utilities/ovs-vsctl.8: \ utilities/ovs-vsctl.8.in \ lib/common.man \ lib/db-ctl-base.man \ + lib/ovs.tmac \ lib/ssl-bootstrap.man \ lib/ssl-peer-ca-cert.man \ lib/ssl.man \ @@ -238,6 +273,7 @@ utilities/ovs-vsctl.8: \ utilities/ovs-vsctl.8.in: lib/common.man: lib/db-ctl-base.man: +lib/ovs.tmac: lib/ssl-bootstrap.man: lib/ssl-peer-ca-cert.man: lib/ssl.man: @@ -290,6 +326,7 @@ vtep/vtep-ctl.8: \ vtep/vtep-ctl.8.in \ lib/common.man \ lib/db-ctl-base.man \ + lib/ovs.tmac \ lib/ssl-bootstrap.man \ lib/ssl-peer-ca-cert.man \ lib/ssl.man \ @@ -298,6 +335,7 @@ vtep/vtep-ctl.8: \ vtep/vtep-ctl.8.in: lib/common.man: lib/db-ctl-base.man: +lib/ovs.tmac: lib/ssl-bootstrap.man: lib/ssl-peer-ca-cert.man: lib/ssl.man: diff --git a/ovn/utilities/ovn-detrace.1.in b/ovn/utilities/ovn-detrace.1.in index 2e5e514a2..2f662d4fe 100644 --- a/ovn/utilities/ovn-detrace.1.in +++ b/ovn/utilities/ovn-detrace.1.in @@ -1,3 +1,4 @@ +.so lib/ovs.tmac .TH ovn\-detrace 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in index c86e3bbdf..659b44d70 100644 --- a/ovn/utilities/ovn-sbctl.8.in +++ b/ovn/utilities/ovn-sbctl.8.in @@ -1,15 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. -.de ST -. PP -. RS -0.15in -. I "\\$1" -. RE -.. +.so lib/ovs.tmac .TH ovn\-sbctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovn\-sbctl diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in index d0763b13f..46a3e38dd 100644 --- a/ovsdb/ovsdb-client.1.in +++ b/ovsdb/ovsdb-client.1.in @@ -1,10 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. -.\" -*- nroff -*- +.so lib/ovs.tmac .TH ovsdb\-client 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovsdb\-client diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in index 4d9f4a6a3..2d80dafff 100644 --- a/ovsdb/ovsdb-server.1.in +++ b/ovsdb/ovsdb-server.1.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovsdb\-server 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovsdb\-server diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in index 8f255b046..ec85e14c4 100644 --- a/ovsdb/ovsdb-tool.1.in +++ b/ovsdb/ovsdb-tool.1.in @@ -1,10 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. -.\" -*- nroff -*- +.so lib/ovs.tmac .TH ovsdb\-tool 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovsdb\-tool . diff --git a/utilities/bugtool/ovs-bugtool.8.in b/utilities/bugtool/ovs-bugtool.8.in index 872921460..f9dd62f15 100644 --- a/utilities/bugtool/ovs-bugtool.8.in +++ b/utilities/bugtool/ovs-bugtool.8.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-bugtool 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovs\-bugtool diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in index 43c9a9517..9c3bd12e4 100644 --- a/utilities/ovs-appctl.8.in +++ b/utilities/ovs-appctl.8.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-appctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-appctl . diff --git a/utilities/ovs-dpctl-top.8.in b/utilities/ovs-dpctl-top.8.in index 410e99959..c3be34556 100644 --- a/utilities/ovs-dpctl-top.8.in +++ b/utilities/ovs-dpctl-top.8.in @@ -1,8 +1,4 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-dpctl\-top "8" "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in index e9cd09177..4d0c7cbb7 100644 --- a/utilities/ovs-dpctl.8.in +++ b/utilities/ovs-dpctl.8.in @@ -1,8 +1,4 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-dpctl . diff --git a/utilities/ovs-l3ping.8.in b/utilities/ovs-l3ping.8.in index d6a3f948a..95a00b7bc 100644 --- a/utilities/ovs-l3ping.8.in +++ b/utilities/ovs-l3ping.8.in @@ -1,8 +1,4 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-l3ping 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 659406de5..ea55008b1 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-ofctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-ofctl . diff --git a/utilities/ovs-pcap.1.in b/utilities/ovs-pcap.1.in index 8f794be8f..84b1870ee 100644 --- a/utilities/ovs-pcap.1.in +++ b/utilities/ovs-pcap.1.in @@ -1,3 +1,4 @@ +.so lib/ovs.tmac .TH ovs\-pcap 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/utilities/ovs-pki.8.in b/utilities/ovs-pki.8.in index a1bcc11ee..f8f5f063a 100644 --- a/utilities/ovs-pki.8.in +++ b/utilities/ovs-pki.8.in @@ -1,8 +1,4 @@ -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-pki 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .SH NAME diff --git a/utilities/ovs-tcpdump.8.in b/utilities/ovs-tcpdump.8.in index ecd093791..79820e466 100644 --- a/utilities/ovs-tcpdump.8.in +++ b/utilities/ovs-tcpdump.8.in @@ -1,3 +1,4 @@ +.so lib/ovs.tmac .TH ovs\-tcpdump 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/utilities/ovs-tcpundump.1.in b/utilities/ovs-tcpundump.1.in index 133c04231..ec2c1505d 100644 --- a/utilities/ovs-tcpundump.1.in +++ b/utilities/ovs-tcpundump.1.in @@ -1,3 +1,4 @@ +.so lib/ovs.tmac .TH ovs\-tcpundump 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" . .SH NAME diff --git a/utilities/ovs-testcontroller.8.in b/utilities/ovs-testcontroller.8.in index df3c35fbf..0f5c60344 100644 --- a/utilities/ovs-testcontroller.8.in +++ b/utilities/ovs-testcontroller.8.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-testcontroller 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-testcontroller . diff --git a/utilities/ovs-vlan-bug-workaround.8.in b/utilities/ovs-vlan-bug-workaround.8.in index 51ea4abda..4bb4bb773 100644 --- a/utilities/ovs-vlan-bug-workaround.8.in +++ b/utilities/ovs-vlan-bug-workaround.8.in @@ -1,9 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .TH ovs\-vlan\-bug\-workaround 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-vlan\-bug\-workaround . diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in index 9f6ea6d65..7c09df79b 100644 --- a/utilities/ovs-vsctl.8.in +++ b/utilities/ovs-vsctl.8.in @@ -1,15 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. -.de ST -. PP -. RS -0.15in -. I "\\$1" -. RE -.. +.so lib/ovs.tmac .TH ovs\-vsctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovs\-vsctl diff --git a/vtep/vtep-ctl.8.in b/vtep/vtep-ctl.8.in index abf5e1673..f855ec27b 100644 --- a/vtep/vtep-ctl.8.in +++ b/vtep/vtep-ctl.8.in @@ -1,15 +1,5 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. -.de ST -. PP -. RS -0.15in -. I "\\$1" -. RE -.. +.so lib/ovs.tmac .TH vtep\-ctl 8 "March 2013" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN vtep\-ctl -- 2.39.5