Merge branch 'manpages'

* manpages:
  manpages: Add mxqsub.1
  Makefile: Add rules for manpages

.gitignore

@@ -15,6 +15,7 @@ mxq_log.o
 mx_mysql.o
 
 mxqsub
+/mxqsub.1
 mxqdump
 mxqkill
 mxqd

Makefile

@@ -113,6 +113,18 @@ quiet-installforuser = $(call quiet-command,install -m ${1} -o ${2} -g ${3} ${4}
 
 ########################################################################
 
+.SECONDARY:
+
+MAN1DIR := ${MANDIR}/man1
+
+manpages/%: manpages/%.xml
+	$(call quiet-command,xmlto --stringparam man.output.quietly=1 man $^ -o manpages, "  XMLTO $@")
+
+%: manpages/% Makefile
+	$(call quiet-command,sed -e "s/@MXQ_VERSION@/${MXQ_VERSION}/" $< >$@, "    GEN $@")
+
+########################################################################
+
 .PHONY: all
 .PHONY: build
 
@@ -129,8 +141,11 @@ test:
 
 ########################################################################
 
+.PHONY: mrproper
+mrproper: clean
+
 .PHONY: clean
-clean:
+mrproper clean:
 	@for i in $(CLEAN) ; do \
 	    if [ -e "$$i" ] ; then \
 			if [ "$(V)" = 1 ] ; then \
@@ -146,7 +161,7 @@ clean:
 
 .PHONY: fix
 fix:
-	@for i in *.c *.h Makefile mysql/create_tables mxqdctl-hostconfig.sh ; do \
+	@for i in *.c *.h Makefile mysql/create_tables mxqdctl-hostconfig.sh manpages/*.xml ; do \
 	    if grep -q -m 1 -E '\s+$$' $$i ; then \
 	        echo "FIX   $$i" ; \
 	        sed -i $$i -e 's/\s*$$//g' ; \
@@ -156,10 +171,14 @@ fix:
 ########################################################################
 
 .PHONY: install
+
 install:: build
+
+install::
 	$(call quiet-installdir,0755,${DESTDIR}${BINDIR})
 	$(call quiet-installdir,0755,${DESTDIR}${SBINDIR})
 	$(call quiet-installdir,0755,${DESTDIR}${SYSCONFDIR}/mxq)
+	$(call quiet-installdir,0755,${DESTDIR}${MAN1DIR})
 
 ########################################################################
 
@@ -391,6 +410,15 @@ install:: mxqdctl-hostconfig.sh
 
 ########################################################################
 
+build: mxqsub.1
+
+mrproper: CLEAN += manpages/mxqsub.1
+clean: CLEAN += mxqsub.1
+#install:: mxqsub.1
+#	$(call quiet-install,0644,mxqsub.1,${DESTDIR}${MAN1DIR}/mxqsub.1)
+
+########################################################################
+
 test_mx_util.o: $(mx_util.h)
 clean: CLEAN += test_mx_util.o
 

manpages/mxqsub.1.xml

@@ -0,0 +1,97 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+    manpage of mxqsub
+
+    Copyright (C) 2015 Marius Tolzmann <tolzmann@molgen.mpg.de>
+
+    This file is part of MXQ.
+-->
+
+<refentry id="mxqsub">
+        <refentryinfo>
+                <title>MXQ - mariux64 queueing system</title>
+                <productname>MXQ @MXQ_VERSION@</productname>
+
+                <authorgroup>
+                    <author>
+                        <contrib>Developer</contrib>
+                        <firstname>Marius</firstname>
+                        <surname>Tolzmann</surname>
+                        <email>tolzmann@molgen.mpg.de</email>
+                    </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>mxqsub</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>mxqsub</refname>
+                <refpurpose>Submit a job</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>mxqsub</command>
+                        <arg choice="opt">options</arg>
+                        <arg choice="plain"><replaceable>&lt;command&gt;</replaceable></arg>
+                        <arg choice="opt"><replaceable>arguments</replaceable></arg>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>
+                    <command>mxqsub</command> is used to
+                      queue a job to be executed on a cluster node.
+  &lt;command&gt; [arguments] will be executed on a node that offers
+  enough resources to run the job. The [options] can
+  influence the job environment and the scheduling decisions made
+  by the cluster
+                </para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>-t <replaceable>&lt;time&gt;</replaceable></option></term>
+                                <term><option>--runtime=<replaceable>&lt;time&gt;</replaceable></option></term>
+
+                                <listitem><para>specify the estimated runtime.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>Environment</title>
+
+                <variablelist>
+                    <varlistentry>
+                        <term><option>MXQ_MYSQL_DEFAULTFILE</option></term>
+                        <listitem><para>default for --mysql-default-file</para></listitem>
+                    </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>Bugs</title>
+                <para>
+                Please report bugs to helpdesk@molgen.mpg.de or directly to the author.
+                </para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>MXQ</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                </para>
+        </refsect1>
+</refentry>