Ship man pages in the GIT and tarball, not just xml files.
authorAndriy Grytsenko <andrej@rep.kiev.ua>
Mon, 22 Sep 2014 11:57:10 +0000 (14:57 +0300)
committerAndriy Grytsenko <andrej@rep.kiev.ua>
Mon, 22 Sep 2014 11:57:10 +0000 (14:57 +0300)
The XML files are not changed for years and doubtfully ever will.
There is no big reason to generate pages on each make or even ask
everyone to provide all the XML/XSL stuff for each GIT build.
Also it is possible that stylesheet may change over time and also
ROFF page is smaller than XML so it may be better to edit it instead.

.gitignore
acinclude.m4 [deleted file]
autogen.sh
configure.ac
man/Makefile.am
man/lxpanel.1 [new file with mode: 0644]
man/lxpanelctl.1 [new file with mode: 0644]

index 27ea37e..b715bd6 100644 (file)
@@ -50,7 +50,6 @@ Makefile
 src/lxpanel
 src/lxpanelctl
 stamp-h1
-man/*.1
 debian/files
 debian/lxpanel.debhelper.log
 debian/lxpanel.substvars
diff --git a/acinclude.m4 b/acinclude.m4
deleted file mode 100644 (file)
index be626c5..0000000
+++ /dev/null
@@ -1,55 +0,0 @@
-# Checks the location of the XML Catalog
-# Usage:
-#   JH_PATH_XML_CATALOG([ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])
-# Defines XMLCATALOG and XML_CATALOG_FILE substitutions
-AC_DEFUN([JH_PATH_XML_CATALOG],
-[
-  # check for the presence of the XML catalog
-  AC_ARG_WITH([xml-catalog],
-              AC_HELP_STRING([--with-xml-catalog=CATALOG],
-                             [path to xml catalog to use]),,
-              [with_xml_catalog=/etc/xml/catalog])
-  jh_found_xmlcatalog=true
-  XML_CATALOG_FILE="$with_xml_catalog"
-  AC_SUBST([XML_CATALOG_FILE])
-  AC_MSG_CHECKING([for XML catalog ($XML_CATALOG_FILE)])
-  if test -f "$XML_CATALOG_FILE"; then
-    AC_MSG_RESULT([found])
-  else
-    jh_found_xmlcatalog=false
-    AC_MSG_RESULT([not found])
-  fi
-
-  # check for the xmlcatalog program
-  AC_PATH_PROG(XMLCATALOG, xmlcatalog, no)
-  if test "x$XMLCATALOG" = xno; then
-    jh_found_xmlcatalog=false
-  fi
-
-  if $jh_found_xmlcatalog; then
-    ifelse([$1],,[:],[$1])
-  else
-    ifelse([$2],,[AC_MSG_ERROR([could not find XML catalog])],[$2])
-  fi
-])
-
-# Checks if a particular URI appears in the XML catalog
-# Usage:
-#   JH_CHECK_XML_CATALOG(URI, [FRIENDLY-NAME], [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])
-AC_DEFUN([JH_CHECK_XML_CATALOG],
-[
-  AC_REQUIRE([JH_PATH_XML_CATALOG],[JH_PATH_XML_CATALOG(,[:])])dnl
-  AC_MSG_CHECKING([for ifelse([$2],,[$1],[$2]) in XML catalog])
-  if $jh_found_xmlcatalog && \
-     AC_RUN_LOG([$XMLCATALOG --noout "$XML_CATALOG_FILE" "$1" >&2]); then
-    AC_MSG_RESULT([found])
-    ifelse([$3],,,[$3
-])dnl
-  else
-    AC_MSG_RESULT([not found])
-    ifelse([$4],,
-       [AC_MSG_ERROR([could not find ifelse([$2],,[$1],[$2]) in XML catalog])],
-       [$4])
-  fi
-])
-
index c4e45fc..8a986ef 100755 (executable)
@@ -1,7 +1,12 @@
 #! /bin/sh
 set -ex
 
+test -d m4 || mkdir m4
 autoreconf -i -f
 intltoolize -c --automake --force
+#xsltproc -o man/lxpanel.1 -nonet \
+#    http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl man/lxpanel.xml
+#xsltproc -o man/lxpanelctl.1 -nonet \
+#    http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl man/lxpanelctl.xml
 
 rm -rf autom4te.cache
index 8c49f8f..58a85cf 100644 (file)
@@ -105,13 +105,6 @@ AC_SUBST(ADDITIONAL_FLAGS)
 PACKAGE_CFLAGS="$PACKAGE_CFLAGS $MENU_CACHE_CFLAGS $ADDITIONAL_FLAGS"
 PACKAGE_LIBS="$PACKAGE_LIBS $MENU_CACHE_LIBS"
 
-AC_ARG_ENABLE(man,
-       [AC_HELP_STRING([--enable-man],
-               [regenerate roff man pages from Docbook @<:@default=no@:>@])],
-       [enable_man="${enableval}"],
-       [enable_man=no]
-)
-
 dnl linker tweaking
 # The function of the link flag --as-needed is to prevent unnecesary linking.
 # Example: A -> B -> C
@@ -365,21 +358,6 @@ AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE", [Gettext package.])
 
 AM_GLIB_GNU_GETTEXT
 
-if test x"$enable_man" = x"yes"; then
-       AC_PATH_PROG([XSLTPROC], [xsltproc])
-       if test -z "$XSLTPROC"; then
-               enable_man=no
-       fi
-
-       dnl check for DocBook DTD and stylesheets in the local catalog.
-       JH_CHECK_XML_CATALOG([-//OASIS//DTD DocBook XML V4.1.2//EN],
-               [DocBook XML DTD V4.1.2], [], enable_man=no)
-       JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl],
-               [DocBook XSL Stylesheets >= 1.70.1], [], enable_man=no)
-fi
-
-AM_CONDITIONAL(ENABLE_REGENERATE_MAN, test "x$enable_man" != "xno")
-
 AC_ARG_ENABLE(debug,
     [AC_HELP_STRING([--enable-debug],
         [enable debug support @<:@default=no@:>@])],
index 96fa3ba..413166a 100644 (file)
@@ -2,32 +2,4 @@ man_MANS = \
        lxpanel.1 \
        lxpanelctl.1
 
-man_XMANS = \
-       lxpanel.xml \
-       lxpanelctl.xml
-
-EXTRA_DIST = \
-       $(man_MANS) \
-       $(man_XMANS)
-
-
-if ENABLE_REGENERATE_MAN
-
-lxpanel.1: lxpanel.xml
-       $(XSLTPROC) -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
-
-lxpanelctl.1: lxpanelctl.xml
-       $(XSLTPROC) -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<        
-
-CLEANFILES = $(man_MANS) 
-else
-
-$(man_MANS):
-       @echo ""
-       @echo "Error: you need to run configure with '--enable-man'"
-       @echo "       in order to regenerate man pages."
-       @echo ""
-       @false
-endif
-
-
+EXTRA_DIST = $(man_MANS)
diff --git a/man/lxpanel.1 b/man/lxpanel.1
new file mode 100644 (file)
index 0000000..3046d66
--- /dev/null
@@ -0,0 +1,202 @@
+'\" t
+.\"     Title: LXPANEL
+.\"    Author: Ying-Chun Liu
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: March  2, 2008
+.\"    Manual: http://LXDE.org
+.\"    Source: http://LXDE.org
+.\"  Language: English
+.\"
+.TH "LXPANEL" "1" "March 2, 2008" "http://LXDE\&.org" "http://LXDE.org"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+lxpanel \- a lightweight GTK2\-based panel for the LXDE desktop\&.
+.SH "SYNOPSIS"
+.HP \w'\fBlxpanel\fR\ 'u
+\fBlxpanel\fR
+.SH "DESCRIPTION"
+.PP
+This manual page documents briefly the
+\fBlxpanel\fR
+command\&.
+.PP
+\fBlxpanel\fR
+is a program that provides a panel for the desktop, usually for LXDE\&. It is a lightweight GTK+ 2\&.x based desktop panel\&.
+.PP
+.PP
+\fBFeatures\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+User\-friendly application menu automatically generated from
+\&.desktop
+files on the system\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Launcher bar (small icons clicked to launch apps)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Task bar supporting ICCCM/EWMH `urgency\*(Aq hint (Pidgin IM windows can flash on new incoming messages)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Notification area (system tray)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Digital clock
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Run dialog (type command to run, without opening a terminal )
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Net status icon plug\-in (optional)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Volume control plug\-in (optional)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+lxpanelctl, an external controller lets you control lxpanel in other programs\&. For example, "lxpanelctl run" will show the Run dialog in lxpanel, and "lxpanelctl menu" will show the application menu\&. This is useful in key bindings provided by window managers\&.
+.RE
+.sp
+.SH "OPTIONS"
+.PP
+This program follows the usual
+GNU
+command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
+.PP
+\fB\-h\fR \fB\-\-help\fR
+.RS 4
+Print help on the options\&.
+.RE
+.PP
+\fB\-v\fR \fB\-\-version\fR
+.RS 4
+Print the program version\&.
+.RE
+.PP
+\fB\-\-log \fR\fB\fIlevel\fR\fR
+.RS 4
+Set the logging level in the range 0 (silent) through 5 (verbose)\&.
+.RE
+.PP
+\fB\-p \fR\fB\fINAME\fR\fR, \fB\-\-profile \fR\fB\fINAME\fR\fR
+.RS 4
+Set the profile to be loaded\&.
+.RE
+.SH "FILES"
+.PP
+~/\&.config/lxpanel/\fIPROFILE\fR
+.RS 4
+config file, can be edited by preference dialog\&.
+.RE
+.SH "SEE ALSO"
+.PP
+lxsession (1), lxpanelctl (1)\&.
+.SH "AUTHOR"
+.PP
+This manual page was written by paulliu
+grandpaul@gmail\&.com
+for the
+Debian
+system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
+GNU
+General Public License, Version 2 any later version published by the Free Software Foundation\&.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
+.SH "AUTHOR"
+.PP
+\fBYing\-Chun Liu\fR
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2008 paulliu
+.br
diff --git a/man/lxpanelctl.1 b/man/lxpanelctl.1
new file mode 100644 (file)
index 0000000..0780bee
--- /dev/null
@@ -0,0 +1,92 @@
+'\" t
+.\"     Title: LXPANEL
+.\"    Author: Ying-Chun Liu
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: March  2, 2008
+.\"    Manual: http://LXDE.org
+.\"    Source: http://LXDE.org
+.\"  Language: English
+.\"
+.TH "LXPANEL" "1" "March 2, 2008" "http://LXDE\&.org" "http://LXDE.org"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+lxpanelctl \- controller for lxpanel\&.
+.SH "SYNOPSIS"
+.HP \w'\fBlxpanelctl\fR\ 'u
+\fBlxpanelctl\fR {command}
+.SH "DESCRIPTION"
+.PP
+This manual page documents briefly the
+\fBlxpanelctl\fR
+command\&.
+.PP
+\fBlxpanelctl\fR
+is a program that controls lxpanel\&.
+.SH "COMMANDS"
+.PP
+\fBmenu\fR
+.RS 4
+Show the system menu\&.
+.RE
+.PP
+\fBrun\fR
+.RS 4
+Show the run dialog\&.
+.RE
+.PP
+\fBconfig\fR
+.RS 4
+Show the panel configuration dialog\&. If more than one panel is configured, it is undefined which panel configuration dialog will be shown\&.
+.RE
+.PP
+\fBrestart\fR
+.RS 4
+Restart lxpanel\&.
+.RE
+.PP
+\fBexit\fR
+.RS 4
+Exit lxpanel\&.
+.RE
+.SH "SEE ALSO"
+.PP
+lxpanel (1)\&.
+.SH "AUTHOR"
+.PP
+This manual page was written by paulliu
+grandpaul@gmail\&.com
+for the
+Debian
+system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
+GNU
+General Public License, Version 2 any later version published by the Free Software Foundation\&.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
+.SH "AUTHOR"
+.PP
+\fBYing\-Chun Liu\fR
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2008 paulliu
+.br