From a0ceefde775b5c73f4108f8c3a33d78cb2874a78 Mon Sep 17 00:00:00 2001
From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Mon, 9 Jan 2012 21:23:33 +0000
Subject: [PATCH] manpage

---
 Makefile                    |  3 +-
 update-xfonts-traditional.8 | 95 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 97 insertions(+), 1 deletion(-)
 create mode 100644 update-xfonts-traditional.8

diff --git a/Makefile b/Makefile
index caf5fd0..b914bd5 100644
--- a/Makefile
+++ b/Makefile
@@ -15,8 +15,9 @@ all:
 install:
 	perl -pe 's#^(our \$$prefix=").*("\;\s*)$$#$$1$(prefix)$$2#' \
 		<$(utility) >$(utility).sedded
-	$(install) -m755 -d $(DESTDIR)$(prefix)/{bin,share/$(package)/rules}
+	$(install) -m755 -d $(DESTDIR)$(prefix)/{bin,share/{man/man8,$(package)/rules}}
 	$(install) -m755 $(utility).sedded $(DESTDIR)$(prefix)/bin/$(utility)
+	$(install) -m755 $(utility).8 $(DESTDIR)$(prefix)/man/man8/.
 	$(install) -m644 rules/* $(DESTDIR)$(prefix)/share/$(package)/rules/
 
 clean:
diff --git a/update-xfonts-traditional.8 b/update-xfonts-traditional.8
new file mode 100644
index 0000000..4787ee0
--- /dev/null
+++ b/update-xfonts-traditional.8
@@ -0,0 +1,95 @@
+.\" Hey, Emacs!  This is an -*- nroff -*- source file.
+.TH UPDATE\-XFONTS\-TRADITIONAL 8 "2012" "Greenend" "chiark utilities"
+.SH NAME
+update\-xfonts\-traditional \- generate traditional ASCII fixed-with fonts
+.SH SYNOPSIS
+.B update\-xfonts\-traditional --bdf-filter
+.LP
+.B update\-xfonts\-traditional --process-pcf \fIin.pcf.gz\fP \fIout.pcf.gz\fP
+.LP
+.B update\-xfonts\-traditional --process-fontdirs \fIfontdir\fR ...
+.LP
+.B update\-xfonts\-traditional --process-fonttrees \fIfonttree\fR ...
+.SH DESCRIPTION
+.B update\-xfonts\-traditional
+generates versions of X11 PCF fonts which have been edited to restore
+compatibility with traditional versions of US-ASCII, and to restore
+some of the glyphs to more traditional appearance.
+.SH MODES
+.TP
+.BI --bdf-filter
+Takes a BDF on standard input and tries to generate an edited BDF on
+standard output.
+.TP
+.BI --process-pcf
+Takes to PCF filename arguments; the input PCF is uncompressed,
+decompiled to a BDF, processed, recompiled to a PCF and recompressed.
+.TP
+.BI --process-fontdirs
+In each
+.I fontdir
+all files
+.IB font .pcf.gz
+are processed, to generate where applicable corresponding
+.BI trad-- font .pcf.gz
+files.  The mtime, ctime and inode number of the input files are
+recorded so that reprocessing the same directory later will be fast.
+.TP
+.BI --process-fonttrees
+Each
+.I fonttree
+is searched for font directories which are processed as above.
+.TP
+.BI --update
+Each built in font tree location is searched for font directories
+which are processed as above.
+.SH OPTIONS
+.TP
+\fB-R\fP|\fB--rules-path\fP \fIrulespath\fP
+Prepend
+.I rulespath
+to the path of directories from which to load glyph editing rules.
+.TP
+\fB--share-dir\fP \fIshare-dir\fP
+Use
+.I share-dir
+instead of
+.BR "/usr[/local]/share/xfonts-traditional" .
+.SH FILES
+.TP
+.B xfonts-traditional.done
+In each font directory, records information about processed fonts, so
+as to optimise away unnecessary reprocessing.
+.TP
+.B xfonts-traditional.log
+In each font directory, records a lot of which fonts were processed
+and to a certain extent if not why not.
+.TP
+.B /usr/share/fonts/X11 /usr/local/share/fonts/X11
+Default font tree paths for --update.
+.TP
+.BI trad-- font .pcf.gz
+In any font directory, our output files.  Any other files matching
+this pattern may be overwritten or deleted.
+.SH EXIT STATUS
+.TP
+.B 0
+All went well and there were no warnings.
+.TP
+.B 2
+With
+.B --bdf-filter
+and
+.B --process-pcf
+only, indicates that the input font did not need to
+be edited, or was not suitable for editing, and has
+.B not
+been written out, so the output is incomplete, but this is not an
+error.
+.TP
+any other
+There were problems.
+.SH BUGS
+Only the 6x13 font conventionally called \"fixed\" is currently
+supported.  This package comes too late to rescue Unix from an
+incompatible change to its character set.
-- 
2.11.0