summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@open-infrastructure.net>2016-11-03 17:23:12 +0000
committerDaniel Baumann <daniel.baumann@open-infrastructure.net>2016-11-15 06:35:40 +0000
commit8dcbd0083921de7a45898d1dbc5bc356101d0485 (patch)
tree01105686d31e1b184101c2f78592e08716722e64 /share
parentAdding gitignore file. (diff)
downloadsystem-images-8dcbd0083921de7a45898d1dbc5bc356101d0485.tar.xz
system-images-8dcbd0083921de7a45898d1dbc5bc356101d0485.zip
Rewriting manpage from scratch.
Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>
Diffstat (limited to 'share')
-rw-r--r--share/man/Makefile43
-rw-r--r--share/man/system-images.7.txt110
2 files changed, 153 insertions, 0 deletions
diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644
index 0000000..40982a8
--- /dev/null
+++ b/share/man/Makefile
@@ -0,0 +1,43 @@
+# Makefile
+
+# system-images - Debian based live and installer images
+# Copyright (C) 2006-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/system-images.7.txt b/share/man/system-images.7.txt
new file mode 100644
index 0000000..7322eb6
--- /dev/null
+++ b/share/man/system-images.7.txt
@@ -0,0 +1,110 @@
+// system-images - Debian based live and installer images
+// Copyright (C) 2006-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/>.
+
+SYSTEM-IMAGES(7)
+================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: system-images
+:man version: {revnumber}
+
+
+NAME
+----
+system-images - Debian based live and installer images
+
+
+DESCRIPTION
+-----------
+"In computing, configuration files, or config files configure the initial
+settings for some computer programs."
+
+ -- Wikipedia (https://en.wikipedia.org/wiki/Configuration_file)
+
+system-images contains configuration trees of some Debian based live and
+installer images.
+
+
+DOWNLOAD
+--------
+ * Upstream Releases: https://files.open-infrastructure.net/software/system-images/upstream
+ * Upstream Sources: https://sources.open-infrastructure.net/software/system-images
+ * Debian Releases: https://files.open-infrastructure.net/software/system-images/debian
+ * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-system-images
+
+
+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/system-images
+ 3. cd system-images && sudo make install
+
+DEBIAN 9 (STRETCH) AND NEWER
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * sudo apt install system-images
+
+
+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
+
+
+USAGE
+-----
+The following configuration trees are available:
+
+ * base-system: a Debian based, minmal system,
+ see https://debian.org
+
+ * container-server: a Container Server system using container-tools,
+ see https://open-infrastructure.net/software/container-tools
+
+ * gnome-desktop: a GNOME Desktop system using GNOME,
+ see https://gnome.org
+
+A software called system-build can be used to automatically build images from
+this configuration tree.
+
+system-build can be obtained from https://open-infrastructure.net/software/system-build.
+
+On Debian based systems, system-build can be installed with:
+
+ # apt-get install system-build
+
+system-build can be used to build this image with the following command executed
+in this directory::
+
+ # lb build
+
+
+AUTHORS
+-------
+
+ * Daniel Baumann <daniel.baumann@open-infrastructure.net>