system/fbterm: Add checkfb man page.

Signed-off-by: B. Watson <yalhcru@gmail.com>

Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>

4 files changed, 175 insertions, 17 deletions

diff --git a/system/fbterm/README b/system/fbterm/README
index 3a82f40f73..b64999af82 100644
--- a/system/fbterm/README
+++ b/system/fbterm/README
@@ -1,15 +1,17 @@
-FbTerm is a fast terminal emulator for linux with the frame buffer device
-or a VESA video card.
+fbterm (fast framebuffer based terminal emulator for linux)
+
+FbTerm is a fast terminal emulator for linux with the frame buffer
+device or a VESA video card.
 
 fbterm supports the mouse (provided gpm is running) and is able to
-share the console with (some) other applications, such as "mplayer -vo
-fbdev2". It also uses the same fonts as X, and renders them with lovely
-antialiasing like modern X terminals. fbterm has *much* better Unicode
-support than the plain Linux framebuffer console.
+share the console with (some) other applications, such as "mplayer
+-vo fbdev2". It also uses the same fonts as X, and renders them with
+lovely antialiasing like modern X terminals. fbterm has *much* better
+Unicode support than the plain Linux framebuffer console.
 
 Also included is a handy utility called checkfb, which simply checks
-for the presence and usability of the framebuffer device, and shows its
-resolution and bit depth.
+for the presence and usability of the framebuffer device, and shows
+its resolution and bit depth.
 
 This package uses POSIX filesystem capabilities to execute with
 elevated privileges (required for keyboard shortcuts and console
diff --git a/system/fbterm/checkfb.1 b/system/fbterm/checkfb.1
new file mode 100644
index 0000000000..e15ae92416
--- /dev/null
+++ b/system/fbterm/checkfb.1
@@ -0,0 +1,85 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "CHECKFB" 1 "2021-08-26" "SBo" "SlackBuilds.org"
+.SH NAME
+checkfb \- check for the existence of a framebuffer device
+.\" RST source for checkfb(1) man page. Convert with:
+.
+.\" rst2man.py checkfb.rst > checkfb.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.SH SYNOPSIS
+.sp
+checkfb <[\fIdevice\fP]>
+.SH DESCRIPTION
+.sp
+checkfb attempts to open the Linux framebuffer device read\-only. If successful,
+it reports the display resolution and bit depth.
+.sp
+By default, it opens \fB/dev/fb0\fP\&. The \fIdevice\fP option overrides this.
+.sp
+There are no options.
+.SH EXIT STATUS
+.sp
+0 (success) if the framebuffer exists and can be opened.
+.sp
+Non\-zero means failure: the device doesn\(aqt exist, the permissions
+don\(aqt allow opening it, or possibly the kernel doesn\(aqt support
+framebuffer devices at all.
+.SH EXAMPLES
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# checkfb
+The framebuffer device (/dev/fb0) was opened successfully.
+1920x1080, 32bpp
+The framebuffer device was mapped to memory successfully.
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+.sp
+checkfb is released under the GPL (according to the comments in its source).
+.SH AUTHORS
+.sp
+checkfb was originally written by Trolltech, and was modified by
+Sébastien Ballet.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.SH SEE ALSO
+.sp
+fbset(8)
+.\" Generated by docutils manpage writer.
+.
diff --git a/system/fbterm/checkfb.rst b/system/fbterm/checkfb.rst
new file mode 100644
index 0000000000..9d307c4037
--- /dev/null
+++ b/system/fbterm/checkfb.rst
@@ -0,0 +1,73 @@
+.. RST source for checkfb(1) man page. Convert with:
+..   rst2man.py checkfb.rst > checkfb.1
+.. rst2man.py comes from the SBo development/docutils package.
+
+.. |version| replace:: SBo
+.. |date| date::
+
+
+=======
+checkfb
+=======
+
+-----------------------------------------------
+check for the existence of a framebuffer device
+-----------------------------------------------
+
+:Manual section: 1
+:Manual group: SlackBuilds.org
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+checkfb <[*device*]>
+
+DESCRIPTION
+===========
+
+checkfb attempts to open the Linux framebuffer device read-only. If successful,
+it reports the display resolution and bit depth.
+
+By default, it opens **/dev/fb0**. The *device* option overrides this.
+
+There are no options.
+
+EXIT STATUS
+===========
+
+0 (success) if the framebuffer exists and can be opened.
+
+Non-zero means failure: the device doesn't exist, the permissions
+don't allow opening it, or possibly the kernel doesn't support
+framebuffer devices at all.
+
+EXAMPLES
+========
+
+::
+
+  # checkfb
+  The framebuffer device (/dev/fb0) was opened successfully.
+  1920x1080, 32bpp
+  The framebuffer device was mapped to memory successfully.
+
+COPYRIGHT
+=========
+
+checkfb is released under the GPL (according to the comments in its source).
+
+AUTHORS
+=======
+
+checkfb was originally written by Trolltech, and was modified by
+Sébastien Ballet.
+
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+
+SEE ALSO
+========
+
+fbset(8)
diff --git a/system/fbterm/fbterm.SlackBuild b/system/fbterm/fbterm.SlackBuild
index 8eb94a3f1a..45f2b99da0 100644
--- a/system/fbterm/fbterm.SlackBuild
+++ b/system/fbterm/fbterm.SlackBuild
@@ -9,6 +9,9 @@
 # is licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/
 # for details.
 
+# 20210826 bkw: BUILD=2
+# - add man page for checkfb
+
 # 20170621 bkw:
 # - fix build on -current
 
@@ -26,7 +29,7 @@ cd $(dirname $0) ; CWD=$(pwd)
 
 PRGNAM=fbterm
 VERSION=${VERSION:-1.8}
-BUILD=${BUILD:-1}
+BUILD=${BUILD:-2}
 TAG=${TAG:-_SBo}
 PKGTYPE=${PKGTYPE:-tgz}
 
@@ -38,9 +41,6 @@ if [ -z "$ARCH" ]; then
   esac
 fi
 
-# If the variable PRINT_PACKAGE_NAME is set, then this script will report what
-# the name of the created package would be, and then exit. This information
-# could be useful to other scripts.
 if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then
   echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE"
   exit 0
@@ -73,11 +73,8 @@ rm -rf $PRGNAM-$VERSION
 tar xvf $CWD/$PRGNAM-$VERSION.tar.gz
 cd $PRGNAM-$VERSION
 chown -R root:root .
-find -L . \
- \( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \
-  -o -perm 511 \) -exec chmod 755 {} \; -o \
- \( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \
- -o -perm 440 -o -perm 400 \) -exec chmod 644 {} \;
+find -L .  -perm /111 -a \! -perm 755 -a -exec chmod 755 {} \+ -o \
+        \! -perm /111 -a \! -perm 644 -a -exec chmod 644 {} \+
 
 # without this, /usr gets spammed by 'tic', and the terminfo stuff
 # doesn't become part of the package.
@@ -114,6 +111,7 @@ cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
 # to bundle this with fbterm, for use in Slint. it looks like a useful
 # little utility.
 gcc $SLKCFLAGS -Wl,-s -o $PKG/usr/bin/checkfb $CWD/checkfb.c
+gzip -9c < $CWD/checkfb.1 > $PKG/usr/man/man1/checkfb.1.gz
 
 mkdir -p $PKG/install
 cat $CWD/slack-desc > $PKG/install/slack-desc