Added man pages, Daniel

6 files changed, 190 insertions, 7 deletions

diff --git a/ChangeLog b/ChangeLog
index 861561b2..ff671b5e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Sat Aug 19 18:45:40 CEST 2000 Daniel Veillard <Daniel.Veillard@w3.org>
+
+	* libxml.4  xmllint.1 Makefile.am libxml.spec.in: added man pages
+
 Sat Aug 19 18:38:53 CEST 2000 Daniel Veillard <Daniel.Veillard@w3.org>
 
 	* doc/xml.html libxml.* structure.*: updated the doc a bit
@@ -29,7 +33,6 @@ Mon Aug 14 10:26:09 EDT 2000 Daniel Veillard <Daniel.Veillard@w3.org>
 	* config.in: Removed @LIBS@ from xml-config because @XML_LIBS@
 	  includes @LIBS@
 
->>>>>>> 1.186
 Sat Aug 12 23:19:42 CEST 2000 Daniel Veillard <Daniel.Veillard@w3.org>
 
 	* doc/* : rebuilt the docs
diff --git a/Makefile.am b/Makefile.am
index 367d004f..ea393ab7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -59,6 +59,8 @@ xmlinc_HEADERS = \
 DEPS = $(top_builddir)/libxml.la
 LDADDS = $(top_builddir)/libxml.la @Z_LIBS@ @M_LIBS@
 
+man_MANS = xmllint.1 libxml.4
+
 xmllint_SOURCES=xmllint.c
 xmllint_LDFLAGS = 
 xmllint_DEPENDENCIES = $(DEPS)
@@ -331,7 +333,8 @@ CLEANFILES=xmlConf.sh
 confexecdir=$(libdir)
 confexec_DATA = xmlConf.sh
 EXTRA_DIST = xmlConf.sh.in libxml.spec.in libxml.spec \
-             example/Makefile.am example/gjobread.c example/gjobs.xml
+             example/Makefile.am example/gjobread.c example/gjobs.xml \
+	     $(man_MANS)
 
 xmlConf.sh: xmlConf.sh.in Makefile
 ## Use sed and then mv to avoid problems if the user interrupts.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index aa10555e..e83c1a5e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -36,9 +36,6 @@ clean-local:
 maintainer-clean-local: clean
 	rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt 
 
-# docdatadir = $(datadir)/aclocal
-# docdata_DATA = xml.html FAQ.html structure.gif DOM.gif
-
 gnome-xml-decl-list.txt : templates
 
 gnome-xml-sections.txt : scan
@@ -48,12 +45,12 @@ rebuild: gnome-xml-sections.txt templates sgml html
 
 install-data-local: 
 	$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
-	-@INSTALL@ -m 0644 $(srcdir)/xml.html $(srcdir)/FAQ.html $(srcdir)/structure.gif $(srcdir)/DOM.gif $(DESTDIR)$(TARGET_DIR)
+	-@INSTALL@ -m 0644 $(srcdir)/xml.html $(srcdir)/encoding.html $(srcdir)/FAQ.html $(srcdir)/structure.gif $(srcdir)/DOM.gif $(DESTDIR)$(TARGET_DIR)
 	-@INSTALL@ -m 0644 $(srcdir)/html/*.html $(DESTDIR)$(TARGET_DIR)
 	-@INSTALL@ -m 0644 $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR)
 	-(cd $(DESTDIR); gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR))
 
 dist-hook:
-	(cd $(srcdir) ; tar cvf - xml.html FAQ.html structure.gif DOM.gif html/*.html html/*.sgml) | (cd $(distdir); tar xf -)
+	(cd $(srcdir) ; tar cvf - xml.html FAQ.html encoding.html structure.gif DOM.gif html/*.html html/*.sgml) | (cd $(distdir); tar xf -)
 
 .PHONY : html sgml templates scan
diff --git a/libxml.4 b/libxml.4
new file mode 100644
index 00000000..5aa868f3
--- /dev/null
+++ b/libxml.4
@@ -0,0 +1,66 @@
+.TH libxml 4 "12 April 2000"
+.SH NAME
+libxml \- library used to parse XML files
+.SH DESCRIPTION
+The
+.I  libxml
+library is used to parse XML files. 
+Its internal document repesentation is as close as possible to the 
+.I DOM 
+(Document Object Model) interface,
+an API for accessing XML or HTML structured documents.
+.LP
+The
+.I libxml
+library also has a 
+.IR SAX -like
+interface, 
+which is designed to be compatible with 
+.IR expat (1).
+NOTE:
+.IR SAX , 
+the Simple API for XML,
+is a standard interface for event-based XML parsing,
+developed collaboratively by the members of the XML-DEV mailing list, 
+currently hosted by OASIS.
+The
+.I expat
+library is a XML 1.0 parser written in C,
+which aims to be fully conforming. 
+It is currently not a validating XML processor.
+.LP
+The
+.I libxml 
+library now includes a nearly complete 
+.I XPath 
+implementation. 
+The
+.I XPath
+(XML Path Language) is a language for addressing parts of an 
+XML document,
+designed to be used by both 
+.I XSLT 
+and 
+.IR XPointer .
+.LP
+The
+.I libxml 
+library exports Push and Pull type parser interfaces for both XML and 
+.IR html . 
+.SH FILES
+.TP 2.2i
+.B /depot/lib/libxml_2.0.0/libxml.a
+static library
+.TP
+.B /depot/lib/libxml_2.0.0/libxml.so
+shareable library
+.TP
+.B /depot/package/libxml_2.0.0/bin/xmllint
+binary application for parsing XML files
+.SH AUTHORS
+Daniel Veillard (Daniel.Veillard@w3.org).
+If you download and install this package please send the author email.
+Manual page by Ziying Sherwin (sherwin@nlm.nih.gov),
+Lister Hill National Center for Biomedical Communications,
+U.S. National Library of Medicine.
+.\" end of manual page
diff --git a/libxml.spec.in b/libxml.spec.in
index e348e135..b28e1e74 100644
--- a/libxml.spec.in
+++ b/libxml.spec.in
@@ -77,6 +77,8 @@ fi
 %install
 rm -rf $RPM_BUILD_ROOT
 
+install -d $RPM_BUILD_ROOT/usr/man/man1
+install -d $RPM_BUILD_ROOT/usr/man/man4
 make prefix=$RPM_BUILD_ROOT%{prefix} install
 
 %clean
@@ -90,6 +92,9 @@ rm -rf $RPM_BUILD_ROOT
 %defattr(-, root, root)
 
 %doc AUTHORS ChangeLog NEWS README COPYING COPYING.LIB TODO
+%doc /usr/man/man1/xmllint.1
+%doc /usr/man/man4/libxml.4
+
 %{prefix}/lib/lib*.so.*
 %{prefix}/bin/xmllint
 
diff --git a/xmllint.1 b/xmllint.1
new file mode 100644
index 00000000..c2cc694b
--- /dev/null
+++ b/xmllint.1
@@ -0,0 +1,109 @@
+.TH XMLLINT 1 "12 April 2000" 
+.SH NAME
+xmllint \- parse XML files and print the result of parsing
+.SH SYNOPSIS
+.B xmllint
+.RB [ \-\-compress ]
+.RB [ \-\-copy ]
+.RB [ \-\-debug ]
+.RB [ \-\-debugent ]
+.RB [ \-\-htmlout ]
+.RB [ \-\-insert ]
+.RB [ \-\-noblanks ]
+.RB [ \-\-noent ]
+.RB [ \-\-noout ]
+.RB [ \-\-nowarning ]
+.RB [ \-\-nowarp ]
+.RB [ \-\-postvalid ]
+.RB [ \-\-push ]
+.RB [ \-\-recover ]
+.RB [ \-\-repeat ]
+.RB [ \-\-shell ]
+.RB [ \-\-testIO ]
+.RB [ \-\-valid ]
+.IR xmlfile ...
+.SH DESCRIPTION
+The 
+.IR xmllint 
+program parses one or more XML files,
+specified on the command line as 
+.IR xmlfile ....
+It prints various types of output
+(depending upon the options selected).
+It is useful for detecting errors both in XML code and in the 
+XML parser itself.
+.SH OPTIONS
+.TP 12
+.B \-\-compress
+Do 
+.IR gzip (1)
+compression for the output.
+.TP 
+.B \-\-copy
+Test the internal copy implementation.
+.TP
+.B \-\-debug
+Dump a debug tree of the in-memory document.
+.TP
+.B \-\-debugent
+Debug the entities defined in the document.
+.TP
+.B \-\-htmlout
+Output results in
+.I html
+format.
+.TP
+.B \-\-insert
+Test for valid insertion.
+.TP
+.B \-\-noblanks
+Drop blanks from the output.
+.TP
+.B \-\-noent
+Substitute entity references by their value.
+.TP
+.B \-\-noout
+Do not output the result tree.
+.TP
+.B \-\-nowarning
+Do not print warning messages from the parser or validator.
+.TP
+.B \-\-nowarp
+Do not put 
+.I html
+document wrapper.
+.TP
+.B \-\-postvalid
+Do a
+.I posteriori
+validation.
+.TP
+.B \-\-push
+Use the push mode for the parser.
+.TP
+.B \-\-recover
+Output what was parsable on broken XML documents.
+.TP
+.B \-\-repeat
+Repeat the process 100 times, for the purpose of timing and profiling.
+.TP
+.B \-\-shell
+Run a navigating shell.
+.TP
+.B \-\-testIO
+Test user i/o support.
+.TP
+.B \-\-valid
+Validate the document in addition to std well-formed.
+.SH FILES
+.TP 2.2i
+.B /depot/package/libxml_2.0.0/bin/xmllint
+executable 
+.SH "SEE ALSO"
+.BR libxml (4)
+.SH AUTHOR
+Daniel Veillard (Daniel.Veillard@w3.org)
+Manual page by Ziying Sherwin,
+Lister Hill National Center for Biomedical Communication,
+U.S. National Library of Medicine (sherwin@nlm.nih.gov).
+.\" end of manual page