Skip to content

Commit

Permalink
manpages: chop off first header (coredns#2764)
Browse files Browse the repository at this point in the history 
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>
  • Loading branch information
@miekg
miekg authored Apr 6, 2019
1 parent 5a4e4d9 commit b780f49
Show file tree
Hide file tree
Showing 39 changed files with 1 addition and 48 deletions.
1 change: 1 addition & 0 deletions Makefile.doc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion man/coredns-auto.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-autopath.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-bind.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-cache.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-cancel.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-chaos.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-debug.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-dnssec.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-dnstap.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-erratic.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-errors.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-etcd.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-federation.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-file.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 0 additions & 6 deletions man/coredns-forward.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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:
Expand Down
1 change: 0 additions & 1 deletion man/coredns-grpc.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-health.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 0 additions & 3 deletions man/coredns-hosts.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion man/coredns-import.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 0 additions & 4 deletions man/coredns-k8s_external.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.

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

1 change: 0 additions & 1 deletion man/coredns-kubernetes.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-loadbalance.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-log.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-loop.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-metadata.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-metrics.7
View file
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion man/coredns-nsid.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-pprof.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-ready.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-reload.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-rewrite.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-root.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-route53.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-secondary.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-template.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-tls.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-trace.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 0 additions & 1 deletion man/coredns-whoami.7
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit b780f49

Please sign in to comment.