aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2013-06-22 08:54:13 +0000
committerIngo Schwarze <schwarze@openbsd.org>2013-06-22 08:54:13 +0000
commit96e6e83e17f5003f6ac34cd0fbf047b1d99b37dc (patch)
tree3e0c6faaae064fac84fbe8382d6b954ee02ccf4f
parent114032c297cb0cb196cf5356723060c257a60f4d (diff)
downloadmandoc-96e6e83e17f5003f6ac34cd0fbf047b1d99b37dc.tar.gz
mandoc-96e6e83e17f5003f6ac34cd0fbf047b1d99b37dc.tar.zst
mandoc-96e6e83e17f5003f6ac34cd0fbf047b1d99b37dc.zip
A very simple utility script to automatically compare groff and mandoc
output on collections of manual source files. I'm using this for quite some time now, and it has proven to be rather useful. Obviously, this will not be installed on user's systems.
-rw-r--r--gmdiff35
1 files changed, 35 insertions, 0 deletions
diff --git a/gmdiff b/gmdiff
new file mode 100644
index 00000000..a5bca9d3
--- /dev/null
+++ b/gmdiff
@@ -0,0 +1,35 @@
+#!/bin/sh
+# Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+if [ `id -u` -eq 0 ]; then
+ echo "$0: do not run me as root"
+ exit 1
+fi
+
+if [ $# -eq 0 ]; then
+ echo "usage: $0 manual_source_file ..."
+ exit 1
+fi
+
+while [ -n "$1" ]; do
+ file=$1
+ shift
+ echo " ========== $file ========== "
+ tbl $file | groff -mandoc -Tascii -P -c 2>&1 > /tmp/groff.out
+ mandoc -Ios='OpenBSD ports' -Werror $file 2>&1 > /tmp/mandoc.out
+ diff -au /tmp/groff.out /tmp/mandoc.out 2>&1
+done
+
+exit 0