From 6ba6e01206d28376b1d4daeca2560b7c004c74b9 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 8 Oct 2021 13:22:42 +0200 Subject: Using rst to generate manpage. Signed-off-by: Daniel Baumann --- manpages/Makefile | 59 ++++++++++++++++++++++++++++++ manpages/bfh-metapackages.7 | 47 ------------------------ manpages/bfh-metapackages.7.rst | 81 +++++++++++++++++++++++++++++++++++++++++ manpages/manpages.in | 19 ++++++++++ 4 files changed, 159 insertions(+), 47 deletions(-) create mode 100644 manpages/Makefile delete mode 100644 manpages/bfh-metapackages.7 create mode 100644 manpages/bfh-metapackages.7.rst create mode 100644 manpages/manpages.in diff --git a/manpages/Makefile b/manpages/Makefile new file mode 100644 index 0000000..b4ec2ba --- /dev/null +++ b/manpages/Makefile @@ -0,0 +1,59 @@ +# BFH metapackages + +# Copyright (C) 2013-2021 Daniel Baumann +# +# 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 . + +# 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: manpages + +rebuild: clean build + +manpages: manpages.in *.rst + @echo -n "Creating manpages... " + + @for FILE in *.rst; \ + do \ + cp manpages.in $$(basename $${FILE} .rst); \ + $(RST2MAN) $${FILE} | \ + sed -e '/^.\\" Man page generated/d' \ + -e '/^.\\" Generated by/d' \ + -e "s|^\(.TH .*\) \(\"\" \"\"\) |\1 $${VERSION} compute-tools |" \ + >> $$(basename $${FILE} .rst); \ + echo -n "."; \ + done + + @echo " done." + +clean: + rm -f *.[0-9] + +.PHONY: all clean build rebuild manpages diff --git a/manpages/bfh-metapackages.7 b/manpages/bfh-metapackages.7 deleted file mode 100644 index b8150e5..0000000 --- a/manpages/bfh-metapackages.7 +++ /dev/null @@ -1,47 +0,0 @@ -.\" Copyright (C) 2021 Daniel Baumann -.\" -.\" 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 . - -.TH BFH\-METAPACKAGES 7 2021\-01\-01 20210101 "BFH Metapackages" - -.SH NAME -\fBBFH Metapackages\fR \- Package selection for Bern University of Applied Sciences - -.SH DESCRIPTION -Bern University of Applied Sciences (BFH) provides Debian-based images and -systems to its users and everyone else interested in the form of a Debian -Derrivative. -.TP -The following main metapackages are available: - -.IP "\fBbfh-base\-system\fR" 4 -The BFH Base System includes packages that provide a reasonably small but not -too limited character-mode system. - -.IP "\fBbfh-container\-server\fR" 4 -The BFH Container Server is a complete system configured as a server for -systemd\-nspawn based containers. - -.IP "\fBbfh-gnome\-desktop\fR" 4 -The BFH GNOME Desktop is a complete system configured as a desktop for power -users. - -.SH HOMEPAGE -More information about BFH and Team Linux & Infrastructure Servicescan be found -on the homepage at <\fIhttps://bfh.science\fR>. - -.SH AUTHOR -This manpage was written by Daniel Baumann <\fIdaniel.baumann@bfh.ch\fR>. diff --git a/manpages/bfh-metapackages.7.rst b/manpages/bfh-metapackages.7.rst new file mode 100644 index 0000000..5c2ebb6 --- /dev/null +++ b/manpages/bfh-metapackages.7.rst @@ -0,0 +1,81 @@ +.. BFH metapackages + +.. Copyright (C) 2013-2021 Daniel Baumann +.. +.. 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 . + +================ +bfh-metapackages +================ + +--------------------------------------------------------- +Package selection for Bern University of Applied Sciences +--------------------------------------------------------- + +:manual section: 7 +:manual group: BFH + +Description +=========== + +Bern University of Applied Sciences (BFH) provides Debian-based images and +systems to its users and everyone else interested in the form of a Debian +Derrivative. + +The following main metapackages are available: + +bfh-base-system +--------------- + +| The BFH Base System includes packages that provide a reasonably small but not +| too limited character-mode system. + +bfh-container-server +-------------------- + +| The BFH Container Server is a complete system configured as a server for +| systemd-nspawn based containers. + +bfh-gnome-desktop +----------------- + +| The BFH GNOME Desktop is a complete system configured as a desktop for power +| users. + + +Development +=========== + +Bug reports, feature requests, help, patches, support and everything else are +welcome on the BFH Linux Users Mailing List +(https://lists.bfh.science/listinfo/bfh-linux-users/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). + +Homepage +======== + +More information about BFH and Team Linux & Infrastructure Services can be found +on the homepage (https://bfh.science). + +Authors +======= + +bfh-metapackages were written by Daniel Baumann and others. diff --git a/manpages/manpages.in b/manpages/manpages.in new file mode 100644 index 0000000..70e22db --- /dev/null +++ b/manpages/manpages.in @@ -0,0 +1,19 @@ +.\" BFH metapackages + +.\" Copyright (C) 2013-2021 Daniel Baumann +.\" +.\" 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 . +.\" -- cgit v1.2.3