Add a man page, why not

Signed-off-by: Adam Jackson <ajax@redhat.com>

2 files changed, 46 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index 314d03b..c064a14 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
 # ZSH OR DIE, PUNKS
 
 bindir ?= /usr/bin
+mandir ?= /usr/share/man
 
 edid-decode: edid-decode.c
 	$(CC) -g -Wall -o $@ $<
@@ -12,3 +13,5 @@ clean:
 install:
 	mkdir -p $(DESTDIR)$(bindir)
 	install -m 0755 edid-decode $(DESTDIR)$(bindir)
+	mkdir -p $(DESTDIR)$(mandir)/man1
+	install -m 0644 edid-decode.1 $(DESTDIR)$(mandir)/man1
diff --git a/edid-decode.1 b/edid-decode.1
new file mode 100644
index 0000000..119b3bc
--- /dev/null
+++ b/edid-decode.1
@@ -0,0 +1,43 @@
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH edid-decode 1
+.SH NAME
+edid-decode - Decode EDID data in human-readable format
+.SH SYNOPSIS
+.B edid-decode [in] [out]
+.SH DESCRIPTION
+.B edid-decode
+decodes EDID monitor description data in human-readable format.  It takes
+zero, one, or two arguments.  If invoked with no arguments it reads from
+standard input and writes to standard output.  With one argument, the file
+named by the argument is read instead.  With two arguments, normal output
+is suppressed, and the binary EDID blob is written to the file named by
+the second argument.
+.PP
+Input files may be raw binaries or ASCII text.  ASCII input is scanned for
+hex dumps; heuristics are included to search for hexdumps in
+.B xrandr(1)
+property output and
+.B Xorg(1)
+log file formats, otherwise the data is treated as a raw hexdump.  EDID blocks
+for connected monitors can be found in
+.B /sys/class/drm/*/edid
+on modern Linux systems with kernel modesetting support.
+.PP
+.SH NOTES
+Not all fields are decoded, or decoded completely.  Some fields' decoding
+may appear to corrupt the output (for example, detailed string sections
+have their contents printed literally).
+.B edid-decode
+does attempt to validate its input against the relevant standards, but its
+opinions have not been double-checked with the relevant standards bodies,
+so they may be wrong.  Do not rely on the output format, as it will likely
+change in future versions of the tool as additional fields and extensions are
+added.
+.SH "SEE ALSO"
+Xorg(1), xrandr(1)
+.SH AUTHORS
+edid-decode was written by Adam Jackson, with contributions from Eric
+Anholt, Damien Lespiau, and others.  For complete history and the latest
+version, see
+.B http://cgit.freedesktop.org/xorg/app/edid-decode/