summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>2020-11-04 15:55:13 +0100
committerMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>2020-11-04 15:55:13 +0100
commit5b3a141a670ee2e01785a2cda0095fc201100077 (patch)
tree0d583e2228825ecffd52cb04d6b6909f7af9ed14
parentc9e4bf8b1d5445051f49ee0c456345f305e11dd7 (diff)
README: Add a few details
Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
-rw-r--r--README17
1 files changed, 13 insertions, 4 deletions
diff --git a/README b/README
index 2230bd3..df2ccb3 100644
--- a/README
+++ b/README
@@ -1,16 +1,25 @@
Conversion of Open Group's troff sources to POSIX man pages
===========================================================
+This directory contains files and scripts that are used to convert
+the POSIX manual pages to 'man' format, suitable for release by the
+Linux man-pages project.
+
1. Necessary data:
==================
-- obtainable from The Open Group
- - directory with the troff sources
+* obtainable from The Open Group
+ - directory with the troff sources [1]
- file ,xref.5 containing information to crossreferences
- file _strings.def containing information to references to other
standards
-- obtainable online
- - the HTML version of the standard
+* obtainable online
+ - the HTML version of the standard [2]
+
+[1] The troff sources are not part of this repository, and must be
+ obtained by contacting The Open Group.
+[2] As at November 2020, the HTML version of the standard can be
+ downloaded from https://pubs.opengroup.org/onlinepubs/9699919799/.
The directory of troff sources contains four directories: "Builtins",