summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@open-infrastructure.net>2016-07-03 13:11:09 +0000
committerDaniel Baumann <daniel.baumann@open-infrastructure.net>2016-07-03 13:27:40 +0000
commita2497d5f76d132ef5ae39e6f291faf9cd735369c (patch)
treef9a649a9859af5ae2edef49b987eeae618c69e98
parentMaking makefile more generic. (diff)
downloadservice-tools-a2497d5f76d132ef5ae39e6f291faf9cd735369c.tar.xz
service-tools-a2497d5f76d132ef5ae39e6f291faf9cd735369c.zip
Adding apache-icons(7) manpage.
Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>
-rw-r--r--.gitignore2
-rw-r--r--Makefile27
-rw-r--r--share/man/Makefile43
-rw-r--r--share/man/apache-icons.7.txt118
4 files changed, 189 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 378eac2..1b3d8da 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,3 @@
build
+share/man/*.[0-9]
+share/man/*.xml
diff --git a/Makefile b/Makefile
index f77568c..537f053 100644
--- a/Makefile
+++ b/Makefile
@@ -22,7 +22,9 @@ SOFTWARE = apache-icons
all: build
-build:
+build: share/man/*.txt
+ $(MAKE) -C share/man
+
for ICON in share/icons/*; \
do \
ICON="$$(basename $${ICON})"; \
@@ -62,11 +64,34 @@ install: build
mkdir -p $(DESTDIR)/etc/apache2/mods-available
cp -a share/apache/mods/* $(DESTDIR)/etc/apache2/mods-available
+ for SECTION in $$(seq 1 8); \
+ do \
+ if ls share/man/*.$${SECTION} > /dev/null 2>&1; \
+ then \
+ mkdir -p $(DESTDIR)/usr/share/man/man$${SECTION}; \
+ cp share/man/*.$${SECTION} $(DESTDIR)/usr/share/man/man$${SECTION}; \
+ fi; \
+ done
+
uninstall:
+ for SECTION in $$(seq 1 8); \
+ do \
+ for FILE in share/man/*.$${SECTION}; \
+ do \
+ if [ -e "$${FILE}" ]; \
+ then \
+ rm -f $(DESTDIR)/usr/share/man/man$${SECTION}/$$(basename $${FILE}); \
+ fi; \
+ done; \
+ rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share/man/man$${SECTION} || true; \
+ done
+
rm -rf $(DESTDIR)/usr/share/$(SOFTWARE)/*
rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share/$(SOFTWARE) || true
clean:
+ $(MAKE) -C share/man clean
+
rm -rf build
distclean: clean
diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644
index 0000000..43f6286
--- /dev/null
+++ b/share/man/Makefile
@@ -0,0 +1,43 @@
+# Makefile
+
+# apache-icons - Alternative icons for Apache autoindex
+# Copyright (C) 2014-2016 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+#
+# 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/>.
+
+# Depends: asciidoc dblatex docbook-xsl libxml2-utils source-highlight
+
+A2X = a2x \
+ --asciidoc-opts "-a revdate=$(shell cat ../../VERSION.txt)" \
+ --doctype=manpage
+
+SHELL := sh -e
+
+all: build
+
+clean:
+ rm -f *.[0-9]
+ rm -f *.xml
+
+build: man
+
+rebuild: clean build
+
+man: *.txt
+ for FILE in *.txt; \
+ do \
+ $(A2X) --format=manpage $${FILE}; \
+ done
+
+.PHONY: all clean build rebuild man
diff --git a/share/man/apache-icons.7.txt b/share/man/apache-icons.7.txt
new file mode 100644
index 0000000..48d7abc
--- /dev/null
+++ b/share/man/apache-icons.7.txt
@@ -0,0 +1,118 @@
+// apache-icons - Alternative icons for Apache autoindex
+// Copyright (C) 2014-2016 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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: container-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://files.open-infrastructure.net/software/apache-icons/upstream
+ * Upstream Sources: https://sources.open-infrastructure.net/software/apache-icons
+ * Debian Releases: https://files.open-infrastructure.net/software/apache-icons/debian
+ * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-apache-icons
+
+
+INSTALLATION
+------------
+
+SOURCE
+~~~~~~
+
+ 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc imagemagick librsvg2-bin
+ 2. git clone https://sources.open-infrastructure.net/software/apache-icons
+ 3. cd apache-icons && sudo make install
+
+DEBIAN 9 (STRETCH) AND NEWER
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ * sudo apt install apache-icons
+
+
+DEVELOPMENT
+-----------
+
+Bug reports, feature requests, and patches are welcome via Debian Bug Tracking System:
+
+ * https://bugs.debian.org
+
+Please base them against the 'next' Git branch using common sense:
+
+ * https://www.kernel.org/doc/Documentation/SubmittingPatches
+
+
+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: Font Awesome based, PNG format
+ * awesome-svg: Font 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://files.open-infrastructure.net.
+
+
+LINKS
+-----
+
+*Font Awesome:*::
+ http://fontawesome.io/
+
+*Tango Desktop Project:*::
+ http://tango.freedesktop.org/
+
+
+AUTHORS
+-------
+
+ * Daniel Baumann <daniel.baumann@open-infrastructure.net>