Adding share/man.

Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>

4 files changed, 242 insertions, 0 deletions

diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644
index 0000000..9091169
--- /dev/null
+++ b/share/man/Makefile
@@ -0,0 +1,59 @@
+# Open Infrastructure: root-shell
+
+# 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/>.
+
+# Depends: python3-docutils
+
+RST2MAN = rst2man \
+	--no-datestamp \
+	--no-generator \
+	--strict \
+	--strip-comments \
+	--tab-width=4 \
+	--verbose
+
+VERSION := $(shell cat ../../VERSION.txt)
+
+SHELL := sh -e
+
+all: build
+
+build: man
+
+rebuild: clean build
+
+man: man.in *.rst
+	@echo -n "Creating manpages... "
+
+	@for FILE in *.rst; \
+	do \
+		cp man.in $$(basename $${FILE} .rst); \
+		$(RST2MAN) $${FILE} | \
+		sed	-e '/^.\\" Man page generated/d' \
+			-e '/^.\\" Generated by/d' \
+			-e "s|^\(.TH .*\) \(\"\" \"\"\) |\1 $${VERSION} root-shell |" \
+		>> $$(basename $${FILE} .rst); \
+		echo -n "."; \
+	done
+
+	@echo " done."
+
+clean:
+	rm -f *.[0-9]
+
+.PHONY: all clean build rebuild man
diff --git a/share/man/man.in b/share/man/man.in
new file mode 100644
index 0000000..543056d
--- /dev/null
+++ b/share/man/man.in
@@ -0,0 +1,19 @@
+.\" Open Infrastructure: root-shell
+.\"
+.\" 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/share/man/root-shell.1.rst b/share/man/root-shell.1.rst
new file mode 100644
index 0000000..20b914c
--- /dev/null
+++ b/share/man/root-shell.1.rst
@@ -0,0 +1,71 @@
+.. Open Infrastructure: root-shell
+
+.. 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/>.
+
+==========
+root-shell
+==========
+
+--------------------------------
+FIXME
+--------------------------------
+
+:manual section: 1
+:manual group: Open Infrastructure
+
+Synopsis
+========
+
+| **root-shell** ['OPTIONS']
+
+Description
+===========
+
+FIXME
+
+Options
+=======
+
+The following **root-shell** common options are available:
+
+FIXME:
+  FIXME.
+
+See also
+========
+
+| root-shell(7)
+
+Homepage
+========
+
+More information about root-shell and the Open Infrastructure project can be
+found on the homepage (https://open-infrastructure.net).
+
+Contact
+=======
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<software@lists.open-infrastructure.net>.
+
+Authors
+=======
+
+root-shell was written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.
diff --git a/share/man/root-shell.7.rst b/share/man/root-shell.7.rst
new file mode 100644
index 0000000..d5d7132
--- /dev/null
+++ b/share/man/root-shell.7.rst
@@ -0,0 +1,93 @@
+.. Open Infrastructure: root-shell
+
+.. 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/>.
+
+==========
+root-shell
+==========
+
+--------------------------------
+FIXME
+--------------------------------
+
+:manual section: 7
+:manual group: Open Infrastructure
+
+Description
+===========
+
+FIXME.
+
+Download
+========
+
+| Upstream Releases:
+| https://get.open-infrastructure.net/software/root-shell/upstream
+
+| Upstream Sources:
+| https://git.open-infrastructure.net/software/root-shell
+
+| Debian Releases:
+| https://get.open-infrastructure.net/software/root-shell/debian
+
+| Debian Sources:
+| https://git.open-infrastructure.net/software/root-shell
+
+Installation
+============
+
+Source
+------
+
+| $ sudo apt install git make python3-docutils
+| $ git clone https://git.open-infrastructure.net/software/root-shell
+| $ cd root-shell && sudo make install
+
+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).
+
+Usage
+=====
+
+Download package:
+  wget ...
+
+Install package:
+  sudo apt install ...
+
+Start root shell:
+  /bin/root-shell
+
+See also
+========
+
+| root-shell(1),
+| setuid(7).
+
+Authors
+=======
+
+root-shell was written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.