From b780f49ccfe1e413d4f3ddf499b7e54587b3c41e Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Sat, 6 Apr 2019 14:09:05 +0100 Subject: [PATCH] manpages: chop off first header (#2764) each readme starts with the plugin's name as a header, this needs to be chopped off to provide a good manual page. Signed-off-by: Miek Gieben --- Makefile.doc | 1 + man/coredns-auto.7 | 1 - man/coredns-autopath.7 | 1 - man/coredns-bind.7 | 1 - man/coredns-cache.7 | 1 - man/coredns-cancel.7 | 1 - man/coredns-chaos.7 | 1 - man/coredns-debug.7 | 1 - man/coredns-dnssec.7 | 1 - man/coredns-dnstap.7 | 1 - man/coredns-erratic.7 | 1 - man/coredns-errors.7 | 1 - man/coredns-etcd.7 | 1 - man/coredns-federation.7 | 1 - man/coredns-file.7 | 1 - man/coredns-forward.7 | 6 ------ man/coredns-grpc.7 | 1 - man/coredns-health.7 | 1 - man/coredns-hosts.7 | 3 --- man/coredns-import.7 | 1 - man/coredns-k8s_external.7 | 4 ---- man/coredns-kubernetes.7 | 1 - man/coredns-loadbalance.7 | 1 - man/coredns-log.7 | 1 - man/coredns-loop.7 | 1 - man/coredns-metadata.7 | 1 - man/coredns-metrics.7 | 1 - man/coredns-nsid.7 | 1 - man/coredns-pprof.7 | 1 - man/coredns-ready.7 | 1 - man/coredns-reload.7 | 1 - man/coredns-rewrite.7 | 1 - man/coredns-root.7 | 1 - man/coredns-route53.7 | 1 - man/coredns-secondary.7 | 1 - man/coredns-template.7 | 1 - man/coredns-tls.7 | 1 - man/coredns-trace.7 | 1 - man/coredns-whoami.7 | 1 - 39 files changed, 1 insertion(+), 48 deletions(-) diff --git a/Makefile.doc b/Makefile.doc index cccbbd654..3a426f931 100644 --- a/Makefile.doc +++ b/Makefile.doc @@ -36,6 +36,7 @@ man/coredns-%.7: plugin/%/README.md @/bin/echo -e "%%%\n title = \"`basename $@ | sed s\/\.7\/\/` 7\"\n" \ 'area = "CoreDNS"\n workgroup = "CoreDNS Plugins"\n%%%\n\n' > $@.header @cat $@.header $< > $@.md && rm $@.header + @sed -i '/^# .*/d' $@.md $(MMARK) $@.md > $@ && rm $@.md PHONY: clean diff --git a/man/coredns-auto.7 b/man/coredns-auto.7 index 83f8698b9..828767d98 100644 --- a/man/coredns-auto.7 +++ b/man/coredns-auto.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-AUTO" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH AUTO .SH NAME .PP \fIauto\fP - enables serving zone data from an RFC 1035-style master file, which is automatically picked up from disk. diff --git a/man/coredns-autopath.7 b/man/coredns-autopath.7 index 7e77ded0e..db54bcc57 100644 --- a/man/coredns-autopath.7 +++ b/man/coredns-autopath.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-AUTOPATH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH AUTOPATH .SH NAME .PP \fIautopath\fP - allows for server-side search path completion. diff --git a/man/coredns-bind.7 b/man/coredns-bind.7 index 49142734f..cffaac026 100644 --- a/man/coredns-bind.7 +++ b/man/coredns-bind.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-BIND" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH BIND .SH NAME .PP \fIbind\fP - overrides the host to which the server should bind. diff --git a/man/coredns-cache.7 b/man/coredns-cache.7 index e5fe54f10..42323a654 100644 --- a/man/coredns-cache.7 +++ b/man/coredns-cache.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-CACHE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH CACHE .SH NAME .PP \fIcache\fP - enables a frontend cache. diff --git a/man/coredns-cancel.7 b/man/coredns-cancel.7 index 9bd669ed7..9ceeff451 100644 --- a/man/coredns-cancel.7 +++ b/man/coredns-cancel.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-CANCEL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH CANCEL .SH NAME .PP \fIcancel\fP - a plugin that cancels a request's context after 5001 milliseconds. diff --git a/man/coredns-chaos.7 b/man/coredns-chaos.7 index d4e2fe56e..fca9a7620 100644 --- a/man/coredns-chaos.7 +++ b/man/coredns-chaos.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-CHAOS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH CHAOS .SH NAME .PP \fIchaos\fP - allows for responding to TXT queries in the CH class. diff --git a/man/coredns-debug.7 b/man/coredns-debug.7 index d41d6f55c..cf21cb102 100644 --- a/man/coredns-debug.7 +++ b/man/coredns-debug.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-DEBUG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH DEBUG .SH NAME .PP \fIdebug\fP - disables the automatic recovery upon a crash so that you'll get a nice stack trace. diff --git a/man/coredns-dnssec.7 b/man/coredns-dnssec.7 index 1f657bead..d3c6a050b 100644 --- a/man/coredns-dnssec.7 +++ b/man/coredns-dnssec.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-DNSSEC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH DNSSEC .SH NAME .PP \fIdnssec\fP - enable on-the-fly DNSSEC signing of served data. diff --git a/man/coredns-dnstap.7 b/man/coredns-dnstap.7 index dd7ad61dc..7165b9f41 100644 --- a/man/coredns-dnstap.7 +++ b/man/coredns-dnstap.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-DNSTAP" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH DNSTAP .SH NAME .PP \fIdnstap\fP - enable logging to dnstap. diff --git a/man/coredns-erratic.7 b/man/coredns-erratic.7 index b580f0235..4af47b009 100644 --- a/man/coredns-erratic.7 +++ b/man/coredns-erratic.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-ERRATIC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH ERRATIC .SH NAME .PP \fIerratic\fP - a plugin useful for testing client behavior. diff --git a/man/coredns-errors.7 b/man/coredns-errors.7 index ba83e3257..8829c0d2a 100644 --- a/man/coredns-errors.7 +++ b/man/coredns-errors.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-ERRORS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH ERRORS .SH NAME .PP \fIerrors\fP - enable error logging. diff --git a/man/coredns-etcd.7 b/man/coredns-etcd.7 index ea6e2d8f7..b589f7baa 100644 --- a/man/coredns-etcd.7 +++ b/man/coredns-etcd.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-ETCD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH ETCD .SH NAME .PP \fIetcd\fP - enables reading zone data from an etcd version 3 instance. diff --git a/man/coredns-federation.7 b/man/coredns-federation.7 index e10f867ba..2f857062c 100644 --- a/man/coredns-federation.7 +++ b/man/coredns-federation.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-FEDERATION" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH FEDERATION .SH NAME .PP \fIfederation\fP - enables federated queries to be resolved via the kubernetes plugin. diff --git a/man/coredns-file.7 b/man/coredns-file.7 index 92dfeafab..9da36797a 100644 --- a/man/coredns-file.7 +++ b/man/coredns-file.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-FILE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH FILE .SH NAME .PP \fIfile\fP - enables serving zone data from an RFC 1035-style master file. diff --git a/man/coredns-forward.7 b/man/coredns-forward.7 index 5e1f8bf94..647b48e79 100644 --- a/man/coredns-forward.7 +++ b/man/coredns-forward.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-FORWARD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH FORWARD .SH NAME .PP \fIforward\fP - facilitates proxying DNS messages to upstream resolvers. @@ -26,11 +25,6 @@ connect to a random upstream (which may or may not work). .PP This plugin can only be used once per Server Block. -.PP -How does \fIforward\fP relate to \fIproxy\fP? This plugin is the "new" version of \fIproxy\fP and is faster -because it re-uses connections to the upstreams. It also does in-band health checks - using DNS -instead of HTTP. Since it is newer it has a little less (production) mileage on it. - .SH SYNTAX .PP In its most basic form, a simple forwarder uses this syntax: diff --git a/man/coredns-grpc.7 b/man/coredns-grpc.7 index c896ffbdc..ce1d5a0b8 100644 --- a/man/coredns-grpc.7 +++ b/man/coredns-grpc.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-GRPC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH GRPC .SH NAME .PP \fIgrpc\fP - facilitates proxying DNS messages to upstream resolvers via gRPC protocol. diff --git a/man/coredns-health.7 b/man/coredns-health.7 index 6c7538d9d..dab43035e 100644 --- a/man/coredns-health.7 +++ b/man/coredns-health.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-HEALTH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH HEALTH .SH NAME .PP \fIhealth\fP - enables a health check endpoint. diff --git a/man/coredns-hosts.7 b/man/coredns-hosts.7 index 50e3da020..089aeae7c 100644 --- a/man/coredns-hosts.7 +++ b/man/coredns-hosts.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-HOSTS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH HOSTS .SH NAME .PP \fIhosts\fP - enables serving zone data from a \fB\fC/etc/hosts\fR style file. @@ -31,11 +30,9 @@ Examples: .RS .nf -# The following lines are desirable for IPv4 capable hosts 127.0.0.1 localhost 192.168.1.10 example.com example -# The following lines are desirable for IPv6 capable hosts ::1 localhost ip6\-localhost ip6\-loopback fdfc:a744:27b5:3b0e::1 example.com example diff --git a/man/coredns-import.7 b/man/coredns-import.7 index f14b44ea7..8d7768da4 100644 --- a/man/coredns-import.7 +++ b/man/coredns-import.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-IMPORT" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH IMPORT .SH NAME .PP \fIimport\fP - include files or reference snippets from a Corefile. diff --git a/man/coredns-k8s_external.7 b/man/coredns-k8s_external.7 index 065a6fe54..c939b7d52 100644 --- a/man/coredns-k8s_external.7 +++ b/man/coredns-k8s_external.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-K8S_EXTERNAL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH K8S_EXTERNAL .SH NAME .PP \fIk8s_external\fP - resolve load balancer and external IPs from outside kubernetes clusters. @@ -83,7 +82,6 @@ k8s\_external [ZONE...] { \fB\fCttl\fR allows you to set a custom \fBTTL\fP for responses. The default is 5 (seconds). -.SH EXAMPLES .PP Enable names under \fB\fCexample.org\fR to be resolved to in cluster DNS addresses. @@ -99,14 +97,12 @@ Enable names under \fB\fCexample.org\fR to be resolved to in cluster DNS address .fi .RE -.SH ALSO SEE .PP For some background see resolve external IP address \[la]https://github.com/kubernetes/dns/issues/242\[ra]. And A records for services with Load Balancer IP \[la]https://github.com/coredns/coredns/issues/1851\[ra]. -.SH BUGS .PP PTR queries for the reverse zone is not supported. diff --git a/man/coredns-kubernetes.7 b/man/coredns-kubernetes.7 index a42d93d69..5b06c8d64 100644 --- a/man/coredns-kubernetes.7 +++ b/man/coredns-kubernetes.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-KUBERNETES" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH KUBERNETES .SH NAME .PP \fIkubernetes\fP - enables the reading zone data from a Kubernetes cluster. diff --git a/man/coredns-loadbalance.7 b/man/coredns-loadbalance.7 index 210eb4b2f..875db74f3 100644 --- a/man/coredns-loadbalance.7 +++ b/man/coredns-loadbalance.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-LOADBALANCE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH LOADBALANCE .SH NAME .PP \fIloadbalance\fP - randomize the order of A, AAAA and MX records. diff --git a/man/coredns-log.7 b/man/coredns-log.7 index c0a6d38fe..e39b46800 100644 --- a/man/coredns-log.7 +++ b/man/coredns-log.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-LOG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH LOG .SH NAME .PP \fIlog\fP - enables query logging to standard output. diff --git a/man/coredns-loop.7 b/man/coredns-loop.7 index 6666b7e31..e5d1d8cc1 100644 --- a/man/coredns-loop.7 +++ b/man/coredns-loop.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-LOOP" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH LOOP .SH NAME .PP \fIloop\fP - detect simple forwarding loops and halt the server. diff --git a/man/coredns-metadata.7 b/man/coredns-metadata.7 index 714450b3d..edf22f705 100644 --- a/man/coredns-metadata.7 +++ b/man/coredns-metadata.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-METADATA" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH METADATA .SH NAME .PP \fImetadata\fP - enable a meta data collector. diff --git a/man/coredns-metrics.7 b/man/coredns-metrics.7 index 07b7a5b71..c84480acd 100644 --- a/man/coredns-metrics.7 +++ b/man/coredns-metrics.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-METRICS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH PROMETHEUS .SH NAME .PP \fIprometheus\fP - enables Prometheus diff --git a/man/coredns-nsid.7 b/man/coredns-nsid.7 index bd219ecf9..9f679ee15 100644 --- a/man/coredns-nsid.7 +++ b/man/coredns-nsid.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-NSID" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH NSID .SH NAME .PP \fInsid\fP - adds an identifier of this server to each reply. diff --git a/man/coredns-pprof.7 b/man/coredns-pprof.7 index 07e9cdc7d..c842710ab 100644 --- a/man/coredns-pprof.7 +++ b/man/coredns-pprof.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-PPROF" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH PPROF .SH NAME .PP \fIpprof\fP - publishes runtime profiling data at endpoints under \fB\fC/debug/pprof\fR. diff --git a/man/coredns-ready.7 b/man/coredns-ready.7 index 2ae2aa7ca..7e709c077 100644 --- a/man/coredns-ready.7 +++ b/man/coredns-ready.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-READY" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH READY .SH NAME .PP \fIready\fP - enables a readiness check HTTP endpoint. diff --git a/man/coredns-reload.7 b/man/coredns-reload.7 index 0bd8094d3..79ca87861 100644 --- a/man/coredns-reload.7 +++ b/man/coredns-reload.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-RELOAD" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH RELOAD .SH NAME .PP \fIreload\fP - allows automatic reload of a changed Corefile. diff --git a/man/coredns-rewrite.7 b/man/coredns-rewrite.7 index 11a7b71d0..ea0ecd481 100644 --- a/man/coredns-rewrite.7 +++ b/man/coredns-rewrite.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-REWRITE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH REWRITE .SH NAME .PP \fIrewrite\fP - performs internal message rewriting. diff --git a/man/coredns-root.7 b/man/coredns-root.7 index e87d3fc06..86cb1e178 100644 --- a/man/coredns-root.7 +++ b/man/coredns-root.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-ROOT" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH ROOT .SH NAME .PP \fIroot\fP - simply specifies the root of where to find (zone) files. diff --git a/man/coredns-route53.7 b/man/coredns-route53.7 index c5df66712..a9c078b7e 100644 --- a/man/coredns-route53.7 +++ b/man/coredns-route53.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-ROUTE53" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH ROUTE53 .SH NAME .PP \fIroute53\fP - enables serving zone data from AWS route53. diff --git a/man/coredns-secondary.7 b/man/coredns-secondary.7 index ff313b619..df5c869d4 100644 --- a/man/coredns-secondary.7 +++ b/man/coredns-secondary.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-SECONDARY" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH SECONDARY .SH NAME .PP \fIsecondary\fP - enables serving a zone retrieved from a primary server. diff --git a/man/coredns-template.7 b/man/coredns-template.7 index 7b80fdd6f..b183fd24d 100644 --- a/man/coredns-template.7 +++ b/man/coredns-template.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-TEMPLATE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH TEMPLATE .SH NAME .PP \fItemplate\fP - allows for dynamic responses based on the incoming query. diff --git a/man/coredns-tls.7 b/man/coredns-tls.7 index 36e18b93b..2a8c01218 100644 --- a/man/coredns-tls.7 +++ b/man/coredns-tls.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-TLS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH TLS .SH NAME .PP \fItls\fP - allows you to configure the server certificates for the TLS and gRPC servers. diff --git a/man/coredns-trace.7 b/man/coredns-trace.7 index 6706c3c71..78f66d377 100644 --- a/man/coredns-trace.7 +++ b/man/coredns-trace.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-TRACE" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH TRACE .SH NAME .PP \fItrace\fP - enables OpenTracing-based tracing of DNS requests as they go through the plugin chain. diff --git a/man/coredns-whoami.7 b/man/coredns-whoami.7 index 5b0761c0f..d952ddba9 100644 --- a/man/coredns-whoami.7 +++ b/man/coredns-whoami.7 @@ -1,7 +1,6 @@ .\" Generated by Mmark Markdown Processer - mmark.nl .TH "COREDNS-WHOAMI" "7" "April 2019" "CoreDNS" "CoreDNS Plugins" -.SH WHOAMI .SH NAME .PP \fIwhoami\fP - returns your resolver's local IP address, port and transport.