commit 861a4c293c452b8a06b2373df8130559c6fc0d4e
parent eeb9b7c2f689a965395a50f08f5b2ab51a589851
Author: Slack Coder <slackcoder@server.ky>
Date: Tue, 3 Dec 2024 09:01:10 -0500
Update documentation
- Include email address for bug reports.
- Update README.
- Note about compat32.
Diffstat:
11 files changed, 51 insertions(+), 14 deletions(-)
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
### Changed
+ - Update README and documentation.
- Use the more standard MIT license.
## [2.7.1] - 2024-11-24
diff --git a/README.md b/README.md
@@ -1,29 +1,38 @@
# sbotools2
-**[sbotools](https://pink-mist.github.io/sbotools/)** provides a ports-like interface to [slackbuilds.org](http://www.slackbuilds.org/).
+**sbotools2** provides a ports-like interface to [slackbuilds.org](http://www.slackbuilds.org/).
-Here is an unofficial maintenance fork for sbotools. Development for the original has stopped for a number of years.
+This is the maintenance fork of the [original sbotools](https://https://pink-mist.github.io/sbotools/)
+version 2 by a new maintainer. Changes are listed in the [ChangeLog](ChangeLog.md).
+
+Another has taken over [sbotools](https://pghvlaans.github.io/sbotools/) for version 3.
+
+## Project To Do's
+
+Planned improvements and known bugs are listed on the project's
+[todo branch](https://git.server.ky/slackcoder/sbotools2/tree?h=todo).
## Auditing Changes
You can audit the forked changes by asking git to show commits since the last known official commit.
-```
+```sh
git remote add pink-mist https://github.com/pink-mist/sbotools
git fetch pink-mist
git show pink-mist/master..
```
The latest changes on the master branch can be verified using the maintainer's
-[GPG Key](./GPG-KEY) included in the project. The 'FINGERPRINT' should not
+[GPG Key](GPG-KEY) included in the project. The 'FINGERPRINT' should not
change unless the maintainer does.
-```
+```sh
FINGERPRINT=D0CFFD1075CAB8DA329975078D147EEA19EFF029
if ! gpg2 --list-keys | grep "$FINGERPRINT" >/dev/null; then
gpg2 --import ./GPG-KEY
fi
+
if git verify-commit origin/master; then
echo "verification ok"
else
diff --git a/man1/sbocheck.1 b/man1/sbocheck.1
@@ -21,7 +21,7 @@ Show version information.
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -32,3 +32,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sboclean.1 b/man1/sboclean.1
@@ -46,7 +46,7 @@ sboclean can exit with the following codes:
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -57,3 +57,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sboconfig.1 b/man1/sboconfig.1
@@ -79,7 +79,7 @@ sboconfig can exit with the following codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sbofind(1), sboinstall(1), sboremove(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -90,3 +90,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sbofind.1 b/man1/sbofind.1
@@ -59,7 +59,7 @@ sbofind can exit with the following exit codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sboconfig(1), sboinstall(1), sboremove(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -70,3 +70,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sboinstall.1 b/man1/sboinstall.1
@@ -45,7 +45,7 @@ If numeric (2,5,10, etc), then that number will be fed to the "-j" argument to m
.P
-p|--compat32
.RS
-Create a -compat32 package instead of a normal x86_64 package on multilib x86_64 systems. This requires /usr/sbin/convertpkg-compat32; this can at least be obtained from AlienBob's compat32-tools package - see http://alien.slackbook.org/blog/. Note that this may or may not be foolproof, and is not supported by anyone; not me, not AlienBob, not Slackware, etc. I recommend using this with the -i option so that the created package can be inspected prior to installation. If you find that a particular slackbuild needs additional help to be created as -compat32 package, contact me at j@dawnrazor.net.
+Create a -compat32 package instead of a normal x86_64 package on multilib x86_64 systems. This requires /usr/sbin/convertpkg-compat32; this can at least be obtained from AlienBob's compat32-tools package - see http://alien.slackbook.org/blog/. Note that this may or may not be foolproof, and is not supported by anyone; not me, not AlienBob, not Slackware, etc. I recommend using this with the -i option so that the created package can be inspected prior to installation. Note this option is kept for posterity, but lacked good support, it is best avoided.
.RE
.P
-r|--nointeractive
@@ -111,7 +111,7 @@ sboinstall can exit with the following exit codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboremove(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -122,3 +122,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sboremove.1 b/man1/sboremove.1
@@ -36,7 +36,7 @@ sboremove can exit with the following codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sbosnap(1), sboupgrade(1), sbotools.conf(5)
@@ -47,3 +47,6 @@ Luke Williams <xocel@iquidus.org>
Jacob Pipkin <j@dawnrazor.net>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sbosnap.1 b/man1/sbosnap.1
@@ -45,7 +45,7 @@ sbosnap can exit with the following codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1), sboupgrade(1), sbotools.conf(5)
@@ -56,3 +56,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man1/sboupgrade.1 b/man1/sboupgrade.1
@@ -100,7 +100,7 @@ sboupgrade can exit with the following exit codes:
.RE
.SH BUGS
.P
-None known, but there may be some. Please report any found to https://github.com/pink-mist/sbotools/issues ; patches are always welcome.
+None known, but there may be some. Please report any found to slackcoder@server.ky ; patches are always welcome.
.SH SEE ALSO
.P
sbocheck(1), sboclean(1), sboconfig(1), sbofind(1), sboinstall(1), sboremove(1), sbosnap(1), sbotools.conf(5)
@@ -111,3 +111,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
diff --git a/man5/sbotools.conf.5 b/man5/sbotools.conf.5
@@ -57,3 +57,6 @@ Jacob Pipkin <j@dawnrazor.net>
Luke Williams <xocel@iquidus.org>
.P
Andreas Guldstrand <andreas.guldstrand@gmail.com>
+.SH MAINTAINER
+.P
+Slack Coder <slackcoder@server.ky>
