mirror of
https://github.com/sbopkg/sbopkg
synced 2024-11-09 19:50:25 +03:00
clean up docs
This commit is contained in:
chess.griffin
parent
d1998b53de
commit
f47761e68a
@ -1,51 +1,51 @@
|
||||
# $Id$
|
||||
|
||||
Sbopkg README
|
||||
Copyright 2007-2008 Chess Griffin <chess@chessgriffin.com>
|
||||
|
||||
Homepage: http://code.google.com/p/sbopkg
|
||||
|
||||
ABOUT
|
||||
|
||||
Sbopkg is a command-line and dialog-based tool to synchronize with the
|
||||
SlackBuilds.org ("SBo") repository, a collection of third-party
|
||||
SlackBuild scripts to build Slackware packages. Sbopkg will allow the
|
||||
user to create, synchronize, search, and browse a local copy of the
|
||||
SBo repository, read the ChangeLog, list the installed SBo packages,
|
||||
display potential updates to SlackBuilds.org packages, view the
|
||||
README, SlackBuild, .info, and slack-desc files for each package, and
|
||||
make manual edits to a copy of the original SlackBuild. Sbopkg will
|
||||
also allow the user to select packages to build and it will download
|
||||
the source code, check the md5sum, and build a Slackware package. It
|
||||
will not check dependencies, automatically install the package, or
|
||||
otherwise track what has been installed. There are already package
|
||||
tools for Slackware that do those things. Sbopkg is one thing and one
|
||||
thing only: a medium to easily browse a local copy of the
|
||||
SlackBuilds.org repository and build packages from it.
|
||||
|
||||
Sbopkg can be also be used strictly from the command line without the
|
||||
dialog interface to do most of the above items. Typing sbopkg -h
|
||||
will display the command line options.
|
||||
|
||||
HELP
|
||||
|
||||
Sbopkg comes with two man pages: sbopkg.conf(5) and sbopkg(8). These
|
||||
man pages are kept up-to-date with functional changes in the script
|
||||
itself, so they are a good source of information on how to use sbopkg.
|
||||
|
||||
If the man pages are not sufficient, please consider joining the
|
||||
sbopkg mailing list and posting your question there. You can reach
|
||||
the list at: http://groups.google.com/group/sbopkg-discuss.
|
||||
Additionally, you find me (Chess Griffin - nick _chess_) on IRC in the
|
||||
very quiet #sbopkg channel on irc.freenode.com or in the ##slackware
|
||||
and #slackbuilds channels, also on freenode.
|
||||
|
||||
CONTRIBUTORS
|
||||
|
||||
I welcome bug reports, suggestions, patches, or feature requests.
|
||||
Please post any of these to the Issue tracker (kind of like a
|
||||
Bugzilla) on the project's home page (click the Issues tab) at
|
||||
http://code.google.com/p/sbopkg so I can keep track of them. There
|
||||
have been many contributors so far, and they are all mentioned near
|
||||
the top of the sbopkg script itself. Thanks to everyone who has
|
||||
helped make this script better.
|
||||
# $Id$
|
||||
|
||||
Sbopkg README
|
||||
Copyright 2007-2008 Chess Griffin <chess@chessgriffin.com>
|
||||
|
||||
Homepage: http://code.google.com/p/sbopkg
|
||||
|
||||
ABOUT
|
||||
|
||||
Sbopkg is a command-line and dialog-based tool to synchronize with the
|
||||
SlackBuilds.org ("SBo") repository, a collection of third-party
|
||||
SlackBuild scripts to build Slackware packages. Sbopkg will allow the
|
||||
user to create, synchronize, search, and browse a local copy of the
|
||||
SBo repository, read the ChangeLog, list the installed SBo packages,
|
||||
display potential updates to SlackBuilds.org packages, view the
|
||||
README, SlackBuild, .info, and slack-desc files for each package, and
|
||||
make manual edits to a copy of the original SlackBuild. Sbopkg will
|
||||
also allow the user to select packages to build and it will download
|
||||
the source code, check the md5sum, and build a Slackware package. It
|
||||
will not check dependencies, automatically install the package, or
|
||||
otherwise track what has been installed. There are already package
|
||||
tools for Slackware that do those things. Sbopkg is one thing and one
|
||||
thing only: a medium to easily browse a local copy of the
|
||||
SlackBuilds.org repository and build packages from it.
|
||||
|
||||
Sbopkg can be also be used strictly from the command line without the
|
||||
dialog interface to do most of the above items. Typing sbopkg -h
|
||||
will display the command line options.
|
||||
|
||||
HELP
|
||||
|
||||
Sbopkg comes with two man pages: sbopkg.conf(5) and sbopkg(8). These
|
||||
man pages are kept up-to-date with functional changes in the script
|
||||
itself, so they are a good source of information on how to use sbopkg.
|
||||
|
||||
If the man pages are not sufficient, please consider joining the
|
||||
sbopkg mailing list and posting your question there. You can reach
|
||||
the list at: http://groups.google.com/group/sbopkg-discuss.
|
||||
Additionally, you find me (Chess Griffin - nick _chess_) on IRC in the
|
||||
very quiet #sbopkg channel on irc.freenode.com or in the ##slackware
|
||||
and #slackbuilds channels, also on freenode.
|
||||
|
||||
CONTRIBUTORS
|
||||
|
||||
I welcome bug reports, suggestions, patches, or feature requests.
|
||||
Please post any of these to the Issue tracker (kind of like a
|
||||
Bugzilla) on the project's home page (click the Issues tab) at
|
||||
http://code.google.com/p/sbopkg so I can keep track of them. There
|
||||
have been many contributors so far, and they are all mentioned near
|
||||
the top of the sbopkg script itself. Thanks to everyone who has
|
||||
helped make this script better.
|
||||
|
||||
@ -1,29 +1,29 @@
|
||||
# $Id$
|
||||
|
||||
Sbopkg TODO (in no particular order)
|
||||
* Add ability to manually edit a package's files (i.e. SlackBuild)
|
||||
from within sbopkg -- perhaps call $EDITOR. This creates the issue of
|
||||
how to keep the changes after an rsync, which will clobber everything.
|
||||
Possibly do something like append ".sbopkg" to a copy of the SlackBuild
|
||||
and then add "--exclude='*.sbopkg'" to the rsync call. See discussion on
|
||||
SBo mailing list on 2008-03-24. UPDATED: This is working in 0.0.4
|
||||
for the dialog interface, but not the cli yet.
|
||||
* When using the dialog interface, change the listing of packages to
|
||||
be a checklist or radiolist whereby the user can select more than
|
||||
one package to build at a time. This would possibly change how the
|
||||
user would be able to view the README, slack-desc etc. since a
|
||||
checklist or radiolist would not present the current 'view' menu.
|
||||
Not sure how the order of packages selected would be set.
|
||||
* Add ability to view more than just the README from the command line.
|
||||
This was added, but it needs to be improved. UPDATED: This works
|
||||
much better now.
|
||||
* Include ability to work with more than one repo with different
|
||||
Slackware versions, i.e. /home/sbo/11.0 and /home/sbo/12.0. The
|
||||
first menu in the dialog after selecting "Browse" would be a menu
|
||||
showing the various Slackware versions in the local mirror. UPDATED:
|
||||
This was added to version 0.0.6.
|
||||
* Include ability to search and display updates to installed SBo packages.
|
||||
UPDATE: Preliminary experimental code for this feature first
|
||||
appeared in version 0.0.8.
|
||||
* More error checking.
|
||||
* General code cleanups.
|
||||
# $Id$
|
||||
|
||||
Sbopkg TODO (in no particular order)
|
||||
* Add ability to manually edit a package's files (i.e. SlackBuild)
|
||||
from within sbopkg -- perhaps call $EDITOR. This creates the issue of
|
||||
how to keep the changes after an rsync, which will clobber everything.
|
||||
Possibly do something like append ".sbopkg" to a copy of the SlackBuild
|
||||
and then add "--exclude='*.sbopkg'" to the rsync call. See discussion on
|
||||
SBo mailing list on 2008-03-24. UPDATED: This is working in 0.0.4
|
||||
for the dialog interface, but not the cli yet.
|
||||
* When using the dialog interface, change the listing of packages to
|
||||
be a checklist or radiolist whereby the user can select more than
|
||||
one package to build at a time. This would possibly change how the
|
||||
user would be able to view the README, slack-desc etc. since a
|
||||
checklist or radiolist would not present the current 'view' menu.
|
||||
Not sure how the order of packages selected would be set.
|
||||
* Add ability to view more than just the README from the command line.
|
||||
This was added, but it needs to be improved. UPDATED: This works
|
||||
much better now.
|
||||
* Include ability to work with more than one repo with different
|
||||
Slackware versions, i.e. /home/sbo/11.0 and /home/sbo/12.0. The
|
||||
first menu in the dialog after selecting "Browse" would be a menu
|
||||
showing the various Slackware versions in the local mirror. UPDATED:
|
||||
This was added to version 0.0.6.
|
||||
* Include ability to search and display updates to installed SBo packages.
|
||||
UPDATE: Preliminary experimental code for this feature first
|
||||
appeared in version 0.0.8.
|
||||
* More error checking.
|
||||
* General code cleanups.
|
||||
|
||||
@ -1,51 +1,51 @@
|
||||
Starting with sbopkg version 0.0.8, there is a feature that displays
|
||||
potential updates to SBo packages installed on a user's system. This
|
||||
feature is still a work in progress, and bugs are expected. Most bugs
|
||||
will manifest themselves as either (a) missing updates -- those
|
||||
updates that should appear in the list but do not or (b) false
|
||||
positives -- updates listed in the list that are not really updates at
|
||||
all. If you run into either of these problems, please do the
|
||||
following in order to assist me with bug-reporting:
|
||||
|
||||
As a root user, please open up /usr/bin/sbopkg in your favorite text
|
||||
editor and uncomment the following line in the "Variables" section
|
||||
near the top of the file:
|
||||
|
||||
#UPDATE_DEBUG="1"
|
||||
|
||||
so that it looks like this:
|
||||
|
||||
UPDATE_DEBUG="1"
|
||||
|
||||
This variable turns on a more detailed update list. This more
|
||||
detailed list will list all SlackBuilds.org packages, and will list
|
||||
package updates, packages that have no updates, packages that are not
|
||||
in the repo, and packages for which the installed version is newer
|
||||
than the repo version. This variable also saves the update list as a
|
||||
permanent log, described below.
|
||||
|
||||
After this variable has been uncommented, save the sbopkg file and
|
||||
rerun sbopkg. Please select the update feature as normal and then
|
||||
exit sbopkg. The permanent log of the update list will now be saved
|
||||
in $TMP/sbopkg-debug-updatelist.
|
||||
|
||||
Finally, in order to compare this permanent log with the actual list
|
||||
of installed packages, please do as a root user:
|
||||
|
||||
# cd /var/log/packages; ls *SBo* > mypackagelist.txt
|
||||
|
||||
Please forward the permanent log and the mypackagelist.txt files to me
|
||||
via email to chess@chessgriffin.com or post them in the sbopkg mailing
|
||||
list, which can be found at the project's homepage:
|
||||
http://code.google.com/p/sbopkg.
|
||||
|
||||
Once you have forwarded or copied the log and the mypackagelist.txt to
|
||||
a safe location, feel free to comment out that single line in
|
||||
/usr/bin/sbopkg again, which will then disable the creation of the
|
||||
permanent update log, keeping your $TMP clean. Of course, leaving the
|
||||
line uncommented is fine as well and will create a new
|
||||
$TMP/sbopkg-debug-updatelist each time the update feature is used as
|
||||
well as display the detailed update list each time you use the update
|
||||
feature.
|
||||
|
||||
Thanks for your help!
|
||||
Starting with sbopkg version 0.0.8, there is a feature that displays
|
||||
potential updates to SBo packages installed on a user's system. This
|
||||
feature is still a work in progress, and bugs are expected. Most bugs
|
||||
will manifest themselves as either (a) missing updates -- those
|
||||
updates that should appear in the list but do not or (b) false
|
||||
positives -- updates listed in the list that are not really updates at
|
||||
all. If you run into either of these problems, please do the
|
||||
following in order to assist me with bug-reporting:
|
||||
|
||||
As a root user, please open up /usr/bin/sbopkg in your favorite text
|
||||
editor and uncomment the following line in the "Variables" section
|
||||
near the top of the file:
|
||||
|
||||
#UPDATE_DEBUG="1"
|
||||
|
||||
so that it looks like this:
|
||||
|
||||
UPDATE_DEBUG="1"
|
||||
|
||||
This variable turns on a more detailed update list. This more
|
||||
detailed list will list all SlackBuilds.org packages, and will list
|
||||
package updates, packages that have no updates, packages that are not
|
||||
in the repo, and packages for which the installed version is newer
|
||||
than the repo version. This variable also saves the update list as a
|
||||
permanent log, described below.
|
||||
|
||||
After this variable has been uncommented, save the sbopkg file and
|
||||
rerun sbopkg. Please select the update feature as normal and then
|
||||
exit sbopkg. The permanent log of the update list will now be saved
|
||||
in $TMP/sbopkg-debug-updatelist.
|
||||
|
||||
Finally, in order to compare this permanent log with the actual list
|
||||
of installed packages, please do as a root user:
|
||||
|
||||
# cd /var/log/packages; ls *SBo* > mypackagelist.txt
|
||||
|
||||
Please forward the permanent log and the mypackagelist.txt files to me
|
||||
via email to chess@chessgriffin.com or post them in the sbopkg mailing
|
||||
list, which can be found at the project's homepage:
|
||||
http://code.google.com/p/sbopkg.
|
||||
|
||||
Once you have forwarded or copied the log and the mypackagelist.txt to
|
||||
a safe location, feel free to comment out that single line in
|
||||
/usr/bin/sbopkg again, which will then disable the creation of the
|
||||
permanent update log, keeping your $TMP clean. Of course, leaving the
|
||||
line uncommented is fine as well and will create a new
|
||||
$TMP/sbopkg-debug-updatelist each time the update feature is used as
|
||||
well as display the detailed update list each time you use the update
|
||||
feature.
|
||||
|
||||
Thanks for your help!
|
||||
|
||||
Loading…
Reference in New Issue
Block a user