doc: use POSIX shell syntax in the man page examples.
authorMichael Orlitzky <michael@orlitzky.com>
Sat, 2 Mar 2019 03:10:42 +0000 (22:10 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Sat, 2 Mar 2019 03:10:42 +0000 (22:10 -0500)
The shell examples given in the man page use the "haeredes <<< foo"
syntax to feed the string "foo" into haeredes on stdin. That's a
Bash-only shortcut for "echo foo | haeredes", however, and the latter
works in all POSIX-compatible shells. So, this commit updates the
documentation to use the more reliable syntax.

doc/man1/haeredes.1

index 100a75e7c3973f2160db8126430ab35f1750bedd..197b7e8eadd7f62a0b4c2397a9dc7a2acd2396a2 100644 (file)
@@ -131,7 +131,7 @@ Make sure example.com has the expected name servers,
 [ab].iana-servers.net:
 
 .nf
-.I $ haeredes a.iana-servers.net b.iana-servers.net <<< \(dqexample.com\(dq
+.I $ echo \(dqexample.com\(dq | haeredes a.iana-servers.net b.iana-servers.net
 .fi
 
 .IP \[bu] 2
@@ -140,9 +140,8 @@ must remember to supply the trailing dot yourself. Otherwise, you'll
 get false positives.
 
 .nf
-.I $ haeredes \-\-no\-append\-root \\\\
-.I "          a.iana-servers.net b.iana-servers.net" \\\\
-.I "          <<< \(dqexample.com\(dq"
+.I $ echo \(dqexample.com\(dq | \\\\
+.I "    haeredes \-\-no\-append\-root a.iana-servers.net b.iana-servers.net"
 Domain \(dqexample.com\(dq delegates somewhere else:
 \(dqb.iana-servers.net.\(dq \(dqa.iana-servers.net.\(dq
 .fi
@@ -151,14 +150,15 @@ Check orlitzky.com against the expected name servers, using
 a root nameserver (this checks the registrar configuration):
 
 .nf
-.I $ haeredes --server d.gtld-servers.net dns1.viabit.com dns2.viabit.com \\\\
-.I "           <<< \(dqorlitzky.com\(dq"
+.I $ echo \(dqorlitzky.com\(dq | \\\\
+.I "    haeredes --server d.gtld-servers.net" \\\\
+.I "    dns1.viabit.com dns2.viabit.com"
 .fi
 .IP \[bu]
 Check orlitzky.com against only one of the expected two nameservers:
 
 .nf
-.I $ haeredes dns1.viabit.com <<< \(dqorlitzky.com\(dq
+.I $ echo \(dqorlitzky.com\(dq | haeredes dns1.viabit.com
 Domain \(dqorlitzky.com.\(dq delegates somewhere else: \
 \(dqdns2.viabit.com.\(dq
 .fi
@@ -167,7 +167,7 @@ Check a nonexistent domain (we provide no delegates, since we
 know .doesnt-exist will not be delegated):
 
 .nf
-.I $ haeredes <<< \(dqfoo.doesnt-exist\(dq
+.I $ echo \(dqfoo.doesnt-exist\(dq | haeredes
 Domain \(dqfoo.doesnt-exist.\(dq not delegated.
 .fi
 .IP \[bu]
@@ -176,8 +176,8 @@ nameserver. This should result in a timeout, which will be ignored per
 the discussion in \fBDNS ERRORS\fR:
 
 .nf
-.I $ haeredes --timeout=1 --server 10.1.46.12 ns1.example.com \\\\
-.I "           <<< \(dqexample.com\(dq"
+.I $ echo \(dqexample.com\(dq | \\\\
+.I "    haeredes --timeout=1 --server 10.1.46.12 ns1.example.com"
 .fi
 .SH BUGS
 .P