diff --git a/src/usr/doc/README b/src/usr/doc/README index 4da9d14..3a4d9ab 100644 --- a/src/usr/doc/README +++ b/src/usr/doc/README @@ -14,13 +14,14 @@ 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, build a Slackware package, and, if -using the dialog interface, install the package. It will not check -dependencies since that is not a feature native to Slackware. 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. +make manual edits to a copy of the original .info or SlackBuild files. +Sbopkg will also allow the user to select packages to build and it +will download the source code, check the md5sum, build a Slackware +package, and, if using the dialog interface, install the package. It +will not check dependencies since that is not a feature native to +Slackware. 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 diff --git a/src/usr/doc/TODO b/src/usr/doc/TODO index 3ffd368..6ca2b88 100644 --- a/src/usr/doc/TODO +++ b/src/usr/doc/TODO @@ -7,7 +7,7 @@ Sbopkg TODO (in no particular order) the current -b switch. * Add in ability to edit the *.info file so folks can quickly change the version or download link (though they'd also have to change the - MD5SUM). + MD5SUM). UPDATE: this is now part of sbopkg 0.12.0. * Perhaps make the MD5SUM check a variable that a user can turn off? * When using the dialog interface, change the listing of packages to be a checklist or radiolist whereby the user can select more than diff --git a/src/usr/man/man8/sbopkg.8 b/src/usr/man/man8/sbopkg.8 index 77ebe3d..7560c9b 100644 --- a/src/usr/man/man8/sbopkg.8 +++ b/src/usr/man/man8/sbopkg.8 @@ -32,16 +32,16 @@ view. After choosing a category, the user can then view the various software packages available in that category within the local SBo repository. Selecting a package will display another menu allowing the user to view the package's README, SlackBuild, .info, or -slack-desc files. The user can also edit the SlackBuild and the -edited SlackBuild will remain after doing an rsync. Additionally, if -sbopkg is run with root privileges, then the user can choose to build -a package as well using either the original SlackBuild or the -locally-edited one, if present. If using the dialog interface, and if -sbopkg finds a built package for a particular piece of software in the -OUTPUT directory, then sbopkg will automatically add a new menu entry -allowing the user to install the package if he so choosed. Finally, -if KEEPLOG is set to YES in the sbopkg.conf file then a permanent log -of the build process is saved in /tmp/sbopkg-build-log. +slack-desc files. The user can also edit the .info file and +SlackBuild and the edited files will remain after doing an rsync. +Additionally, if sbopkg is run with root privileges, then the user can +choose to build a package as well using either the original SlackBuild +or the locally-edited one, if present. If using the dialog interface, +and if sbopkg finds a built package for a particular piece of software +in the OUTPUT directory, then sbopkg will automatically add a new menu +entry allowing the user to install the package if he so choosed. +Finally, if KEEPLOG is set to YES in the sbopkg.conf file then a +permanent log of the build process is saved in /tmp/sbopkg-build-log. Alternatively, sbopkg can be run from the command line without using the dialog interface. Executing "sbopkg -h" will display a list of @@ -49,14 +49,14 @@ options available from the command line. Certain features of sbopkg rely on outside binaries, such as a pager to view the text files when sbopkg is run from the comamnd line, and -an editor to edit the SlackBuild. The pager function will look to the -environmental variable $PAGER and if that variable is not defined then -it will default to 'more.' Similarly, the edit SlackBuild function -found when sbopkg is used with the dialog interface will look to -$EDITOR and will default to 'vi' if no $EDITOR has been defined. If -the user wants sbopkg to use another EDITOR, such as nano, then adding -the requisite information in ~/.bashrc or other similar configuration -file to export EDITOR will suffice. +an editor to edit the .info or SlackBuild files. The pager function +will look to the environmental variable $PAGER and if that variable is +not defined then it will default to 'more.' Similarly, the edit +function found when sbopkg is used with the dialog interface will look +to $EDITOR and will default to 'vi' if no $EDITOR has been defined. +If the user wants sbopkg to use another $EDITOR, such as nano, then +adding the requisite information in ~/.bashrc, /etc/profile, or other +similar configuration file to export $EDITOR will suffice. .SH OPTIONS .TP 5