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 <miek@miek.nl>
This commit is contained in:
Miek Gieben 2019-04-06 14:09:05 +01:00 committed by GitHub
parent 5a4e4d92ef
commit b780f49ccf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
39 changed files with 1 additions and 48 deletions

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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:

View file

@ -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.

View file

@ -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.

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.