summaryrefslogtreecommitdiffstats
path: root/apache/share/man
diff options
context:
space:
mode:
Diffstat (limited to 'apache/share/man')
-rw-r--r--apache/share/man/Makefile43
-rw-r--r--apache/share/man/man.in19
-rw-r--r--apache/share/man/service-tools.7.rst124
-rw-r--r--apache/share/man/service-tools.7.txt120
4 files changed, 173 insertions, 133 deletions
diff --git a/apache/share/man/Makefile b/apache/share/man/Makefile
index 2fe75b5..ff27677 100644
--- a/apache/share/man/Makefile
+++ b/apache/share/man/Makefile
@@ -1,4 +1,6 @@
-# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+# Open Infrastructure: service-tools
+
+# Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net>
#
# SPDX-License-Identifier: GPL-3.0+
#
@@ -13,30 +15,45 @@
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+# Depends: python3-docutils
-# Depends: asciidoc dblatex docbook-xsl libxml2-utils source-highlight
+RST2MAN = rst2man \
+ --no-datestamp \
+ --no-generator \
+ --strict \
+ --strip-comments \
+ --tab-width=4 \
+ --verbose
-A2X = a2x \
- --asciidoc-opts "-a revdate=$(shell cat ../../VERSION.txt)" \
- --doctype=manpage
+VERSION := $(shell cat ../../../VERSION.txt)
SHELL := sh -e
all: build
-clean:
- rm -f *.[0-9]
- rm -f *.xml
-
build: man
rebuild: clean build
-man: *.txt
- for FILE in *.txt; \
+man: man.in *.rst
+ @echo -n "Creating manpages... "
+
+ @for FILE in *.rst; \
do \
- $(A2X) --format=manpage $${FILE}; \
+ cp man.in $$(basename $${FILE} .rst); \
+ $(RST2MAN) $${FILE} | \
+ sed -e '/^.\\" Man page generated/d' \
+ -e '/^.\\" Generated by/d' \
+ -e "s|^\(.TH .*\) \(\"\" \"\"\) |\1 $${VERSION} service-tools |" \
+ >> $$(basename $${FILE} .rst); \
+ echo -n "."; \
done
+ @echo " done."
+
+clean:
+ rm -f *.[0-9]
+
.PHONY: all clean build rebuild man
diff --git a/apache/share/man/man.in b/apache/share/man/man.in
new file mode 100644
index 0000000..b7acdb7
--- /dev/null
+++ b/apache/share/man/man.in
@@ -0,0 +1,19 @@
+.\" Open Infrastructure: service-tools
+.\"
+.\" Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+.\"
+.\" SPDX-License-Identifier: GPL-3.0+
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <https://www.gnu.org/licenses/>.
+.\"
diff --git a/apache/share/man/service-tools.7.rst b/apache/share/man/service-tools.7.rst
new file mode 100644
index 0000000..63f0258
--- /dev/null
+++ b/apache/share/man/service-tools.7.rst
@@ -0,0 +1,124 @@
+.. Open Infrastructure: apache-tools
+
+.. Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+..
+.. SPDX-License-Identifier: GPL-3.0+
+..
+.. This program is free software: you can redistribute it and/or modify
+.. it under the terms of the GNU General Public License as published by
+.. the Free Software Foundation, either version 3 of the License, or
+.. (at your option) any later version.
+..
+.. This program is distributed in the hope that it will be useful,
+.. but WITHOUT ANY WARRANTY; without even the implied warranty of
+.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.. GNU General Public License for more details.
+..
+.. You should have received a copy of the GNU General Public License
+.. along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+============
+apache-tools
+============
+
+----------------------------------
+Extra tools for Apache HTTP server
+----------------------------------
+
+:manual section: 7
+:manual group: Open Infrastructure
+
+Description
+===========
+
+This package is a collection of extra tools for the Apache HTTP server,
+currently containing:
+
+ * alternative icons for Apache autoindex
+ (Tango Icons and Font Awesome based themes)
+
+Download
+========
+
+| Upstream Releases:
+| https://get.open-infrastructure.net/software/service-tools/upstream
+
+| Upstream Sources:
+| https://git.open-infrastructure.net/software/service-tools
+
+| Debian Releases:
+| https://get.open-infrastructure.net/software/service-tools/debian
+
+| Debian Sources:
+| https://git.progress-linux.org/users/daniel/debian/packages/open-infrastructure-service-tools
+
+Installation
+============
+
+Source
+------
+
+| $ sudo apt install git make python3-docutils
+| $ git clone https://git.open-infrastructure.net/software/service-tools
+| $ cd service-tools/apache && sudo make install
+
+Debian 9 (stretch) and newer
+----------------------------
+
+| $ sudo apt install apache-tools
+
+Development
+===========
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+(https://lists.open-infrastructure.net/listinfo/software).
+
+Please base patches against the 'next' Git branch using common sense
+(https://www.kernel.org/doc/Documentation/SubmittingPatches).
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(https://bugs.debian.org).
+
+Known limitations
+=================
+
+Changing from one icon set to the other requires a reload of the apache webserver.
+
+Usage
+=====
+
+The default icon theme is determined by the /usr/share/apache-icons/default
+(and /usr/share/apache-icons/default.conf respectivly) file.
+
+On Debian based system "sudo update-alternatives --config apache-icons" can be
+used to automatically select the active icon theme (including the default apache
+icons).
+
+The following themes are available:
+
+ * awesome-png: Fork Awesome based, PNG format
+ * awesome-svg: Fork Awesome based, SVG format
+ * tango-png: Tango Icons based, PNG format
+ * tango-svg: Tango Icons based, SVG format
+
+The SVG themes are preferable because they are sharper and scale losless.
+Very old browser can not render SVG icons, use PNG if that is a concern.
+
+An example of the tango-svg theme can be seen on
+https://get.open-infrastructure.net.
+
+Links
+=====
+
+| * Fork Awesome
+| (https://forkaweso.me)
+
+| * Tango Desktop Project
+| (http://tango.freedesktop.org)
+
+Authors
+=======
+
+service-tools were written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.
diff --git a/apache/share/man/service-tools.7.txt b/apache/share/man/service-tools.7.txt
deleted file mode 100644
index 01cec5f..0000000
--- a/apache/share/man/service-tools.7.txt
+++ /dev/null
@@ -1,120 +0,0 @@
-// Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net>
-//
-// SPDX-License-Identifier: GPL-3.0+
-//
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-APACHE-ICONS(7)
-===============
-:doctype: manpage
-:man manual: Open Infrastructure
-:man source: service-tools
-:man version: {revnumber}
-
-
-NAME
-----
-apache-icons - Alternative icons for Apache autoindex
-
-
-DESCRIPTION
------------
-"The Apache HTTP Server is the world's most used web server software."
- -- Wikipedia (https://en.wikipedia.org/wiki/Apache_HTTP_Server)
-
-apache-icons provides alternative icons for Apache autoindex.
-
-
-DOWNLOAD
---------
- * Upstream Releases: https://get.open-infrastructure.net/software/service-tools/upstream
- * Upstream Sources: https://git.open-infrastructure.net/software/service-tools
- * Debian Releases: https://get.open-infrastructure.net/software/service-tools/debian
- * Debian Sources: https://git.progress-linux.org/users/daniel.baumann/debian/packages/open-infrastructure-service-tools
-
-
-INSTALLATION
-------------
-
-SOURCE
-~~~~~~
- 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc imagemagick librsvg2-bin
- 2. git clone https://git.open-infrastructure.net/software/service-tools
- 3. cd service-tools && sudo make install
-
-DEBIAN 9 (STRETCH) AND NEWER
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- * sudo apt install apache-icons
-
-DEBIAN 10 (BUSTER) AND NEWER
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- * sudo apt install apache-tools
-
-
-DEVELOPMENT
------------
-Bug reports, feature requests, help, patches, support and everything else
-are welcome on the Open Infrastructure Software Mailing List:
-
- * https://lists.open-infrastructure.net/listinfo/software
-
-Please base patches against the 'next' Git branch using common sense:
-
- * https://www.kernel.org/doc/Documentation/SubmittingPatches
-
-Debian specific bugs can also be reported in the Debian Bug Tracking System:
-
- * https://bugs.debian.org
-
-
-KNOWN LIMITATIONS
------------------
-Changing from one icon set to the other requires a reload of the apache webserver.
-
-
-USAGE
------
-The default icon theme is determined by the /usr/share/apache-icons/default
-(and /usr/share/apache-icons/default.conf respectivly) file.
-
-On Debian based system "sudo update-alternatives --config apache-icons" can be
-used to automatically select the active icon theme (including the default apache
-icons).
-
-The following themes are available:
-
- * awesome-png: Fork Awesome based, PNG format
- * awesome-svg: Fork Awesome based, SVG format
- * tango-png: Tango Icons based, PNG format
- * tango-svg: Tango Icons based, SVG format
-
-The SVG themes are preferable because they are sharper and scale losless.
-They require somewhat modern browsers though.
-
-An example of the tango-svg theme can be seen on
-https://get.open-infrastructure.net.
-
-
-LINKS
------
-*Fork Awesome:*::
- https://https://forkaweso.me
-
-*Tango Desktop Project:*::
- http://tango.freedesktop.org/
-
-
-AUTHORS
--------
- * Daniel Baumann <daniel.baumann@open-infrastructure.net>