From ae7fa25c732e52528c357b5d67b7f9ab1a4fcf16 Mon Sep 17 00:00:00 2001 From: "Zane U. Ji" Date: Wed, 4 Jun 2014 21:09:42 +0800 Subject: [PATCH] Added a manual --- data/Makefile.am | 5 ++- data/Makefile.in | 81 ++++++++++++++++++++++++++++++++++++++------ data/xmlcopyeditor.1 | 61 +++++++++++++++++++++++++++++++++ 3 files changed, 135 insertions(+), 12 deletions(-) create mode 100644 data/xmlcopyeditor.1 diff --git a/data/Makefile.am b/data/Makefile.am index 7ecf4b8..63cdf43 100644 --- a/data/Makefile.am +++ b/data/Makefile.am @@ -10,9 +10,12 @@ appdata_in_files = xmlcopyeditor.appdata.xml.in appdata_DATA = $(appdata_in_files:.xml.in=.xml) @INTLTOOL_XML_RULE@ +man_MANS = xmlcopyeditor.1 + EXTRA_DIST = \ $(appdata_in_files) \ - $(desktop_in_files) + $(desktop_in_files) \ + $(man_MANS) CLEANFILES = \ $(appdata_DATA) \ diff --git a/data/Makefile.in b/data/Makefile.in index 2bed658..ec798e0 100644 --- a/data/Makefile.in +++ b/data/Makefile.in @@ -72,7 +72,11 @@ am__uninstall_files_from_dir = { \ || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ $(am__cd) "$$dir" && rm -f $$files; }; \ } -am__installdirs = "$(DESTDIR)$(appdatadir)" "$(DESTDIR)$(desktopdir)" +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(appdatadir)" \ + "$(DESTDIR)$(desktopdir)" +NROFF = nroff +MANS = $(man_MANS) DATA = $(appdata_DATA) $(desktop_DATA) DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ @@ -230,9 +234,11 @@ desktop_DATA = $(desktop_in_files:.desktop.in=.desktop) appdatadir = $(datadir)/appdata appdata_in_files = xmlcopyeditor.appdata.xml.in appdata_DATA = $(appdata_in_files:.xml.in=.xml) +man_MANS = xmlcopyeditor.1 EXTRA_DIST = \ $(appdata_in_files) \ - $(desktop_in_files) + $(desktop_in_files) \ + $(man_MANS) CLEANFILES = \ $(appdata_DATA) \ @@ -277,6 +283,42 @@ mostlyclean-libtool: clean-libtool: -rm -rf .libs _libs +install-man1: $(man_MANS) + @$(NORMAL_INSTALL) + test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" + @list=''; test -n "$(man1dir)" || exit 0; \ + { for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.1[a-z]*$$/p'; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ + done; } + +uninstall-man1: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man1dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.1[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) install-appdataDATA: $(appdata_DATA) @$(NORMAL_INSTALL) test -z "$(appdatadir)" || $(MKDIR_P) "$(DESTDIR)$(appdatadir)" @@ -321,6 +363,19 @@ CTAGS: distdir: $(DISTFILES) + @list='$(MANS)'; if test -n "$$list"; then \ + list=`for p in $$list; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + if test -f "$$d$$p"; then echo "$$d$$p"; else :; fi; done`; \ + if test -n "$$list" && \ + grep 'ab help2man is required to generate this page' $$list >/dev/null; then \ + echo "error: found man pages containing the \`missing help2man' replacement text:" >&2; \ + grep -l 'ab help2man is required to generate this page' $$list | sed 's/^/ /' >&2; \ + echo " to fix them, install help2man, remove and regenerate the man pages;" >&2; \ + echo " typically \`make maintainer-clean' will remove them" >&2; \ + exit 1; \ + else :; fi; \ + else :; fi @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ list='$(DISTFILES)'; \ @@ -353,9 +408,9 @@ distdir: $(DISTFILES) check-am: all-am $(MAKE) $(AM_MAKEFLAGS) check-local check: check-am -all-am: Makefile $(DATA) +all-am: Makefile $(MANS) $(DATA) installdirs: - for dir in "$(DESTDIR)$(appdatadir)" "$(DESTDIR)$(desktopdir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(appdatadir)" "$(DESTDIR)$(desktopdir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -409,7 +464,7 @@ info: info-am info-am: -install-data-am: install-appdataDATA install-desktopDATA +install-data-am: install-appdataDATA install-desktopDATA install-man install-dvi: install-dvi-am @@ -425,7 +480,7 @@ install-info: install-info-am install-info-am: -install-man: +install-man: install-man1 install-pdf: install-pdf-am @@ -453,7 +508,10 @@ ps: ps-am ps-am: -uninstall-am: uninstall-appdataDATA uninstall-desktopDATA +uninstall-am: uninstall-appdataDATA uninstall-desktopDATA \ + uninstall-man + +uninstall-man: uninstall-man1 .MAKE: check-am install-am install-strip @@ -463,12 +521,13 @@ uninstall-am: uninstall-appdataDATA uninstall-desktopDATA install-am install-appdataDATA install-data install-data-am \ install-desktopDATA install-dvi install-dvi-am install-exec \ install-exec-am install-html install-html-am install-info \ - install-info-am install-man install-pdf install-pdf-am \ - install-ps install-ps-am install-strip installcheck \ - installcheck-am installdirs maintainer-clean \ + install-info-am install-man install-man1 install-pdf \ + install-pdf-am install-ps install-ps-am install-strip \ + installcheck installcheck-am installdirs maintainer-clean \ maintainer-clean-generic mostlyclean mostlyclean-generic \ mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ - uninstall-appdataDATA uninstall-desktopDATA + uninstall-appdataDATA uninstall-desktopDATA uninstall-man \ + uninstall-man1 @INTLTOOL_DESKTOP_RULE@ @INTLTOOL_XML_RULE@ diff --git a/data/xmlcopyeditor.1 b/data/xmlcopyeditor.1 new file mode 100644 index 0000000..5d8b34e --- /dev/null +++ b/data/xmlcopyeditor.1 @@ -0,0 +1,61 @@ +.\" +.\" Copyright (C) 2009-2013, Miriam Ruiz +.\" Copyright 2014 Zane U. Ji +.\" + +.TH "xmlcopyeditor" 1 "4 June 2014" "" "XML Copy Editor" + +.SH NAME +xmlcopyeditor \- fast, free, validating XML editor + +.SH SYNOPSIS +.B xmlcopyeditor +.BI [ +.BI --version +.BI | +.BI --help +.BI | +.BI FILE... +.BI ] + +.SH DESCRIPTION +.I XML Copy Editor +is an XML editor focusing on editing document markup +languages like DITA, DocBook, WordprocessingML. Features: DTD/XML +Schema/RELAX NG validation, XSLT, XPath, Pretty\-printing, Syntax +highlighting, Folding, Tag completion, Tag locking, Tag\-free editing, +Built\-in support for XHTML, XSL, DocBook and TEI, Generating XML +Schema, Spelling and style check with built\-in spell/style checker. + +.PP +.I XML Copy Editor +is free software released under the GNU General Public License. + +.SH OPTIONS +.B +.IP --version +Display version information and exit. + +.B +.IP --help +Print a help message and exit. + +.B +.IP FILE... +Specifies the file to open when +.B xmlcopyeditor +starts. + +.SH AUTHOR +Gerald Schmidt (gnschmidt@users.sourceforge.net) + +.SH "SEE ALSO" +.BR iconv (1), +.BR xmlcatalog (1), +.BR xmllint (1), +.BR xsltproc (1) + +You can find more information in the +.I Help +menu inside the program and in its homepage at +http://xml\-copy\-editor.sourceforge.net/