From b162c161e73f4146b6a5e7a6522c12244a2e4387 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Wed, 25 Nov 2020 21:53:26 -0500 Subject: update README for recent changes --- README | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index 1efe42c..ffd8263 100644 --- a/README +++ b/README @@ -1,18 +1,22 @@ sbostuff - Miscellaneous tools for working with SlackBuild.org (SBo) -build scripts. Included tools: +build scripts. These are intended more for developers than end-users, +and for shell users rather than GUI users (sbopkg already has the GUI +end of things covered). + +Included tools: checkpkg - check that an installed package's files are still present mkslackdesc - make a valid slack-desc from a README -mkslackinfo - generate .info and template SlackBuild +mkslackinfo[*] - generate .info and template SlackBuild sbodeps - generate a queue file based on .info file contents sbodl - download the sources (from the .info file) sbofindsrc - search for missing source files in various archives sbofixdesc - try to fix malformed slack-desc files sbofixinfo - try to fix malformed .info files sbolint - examine a SBo tarball or dir, look for common errors -sbonewmaint - change MAINTAINER and EMAIL in .info file +sbonewmaint[*] - change MAINTAINER and EMAIL in .info file sbosearch - search local SBo repo -sboul - submit slackbuild tarballs to SBo, from command line +sboul[*] - submit slackbuild tarballs to SBo, from command line sbrename - rename a build sbrun - run a build, with filesystem tracking and without network sbosrc - simple client script for sbosrcarch archives @@ -26,3 +30,17 @@ the form of comments in the scripts. Some of these are shell scripts, some are perl. Comments are hopefully in English :) + +There's also modified git hook (see the git/ dir) and an 'elvi' for +surfraw, to search for SBo packages from the command line. + +Before using this stuff, you'll want to add a line to your ~/.bashrc or +~/.bash_profile, to source the sbostuff function library. Example: + +source ~/sbostuff/sbostuff.sh + +Also, there's a config file sbostuff.cfg that you should copy to +~/.sbostuff.cfg and edit. + +Scripts marked with an [*] won't work until you've done this. + -- cgit v1.2.3