From 79adfa16a707d74e122f4e448dd2844483cf3d91 Mon Sep 17 00:00:00 2001 From: "chess.griffin" Date: Wed, 12 May 2010 20:31:21 +0000 Subject: [PATCH] add an explanation to sbopkg.8 man page about why 'su -' is strongly encouraged instead of just 'su'; we can change this to 'now required' if we make other changes requiring 'su -' but I wanted to at least get some sort of explanation we can point to if folks have issues with 'su'. --- src/usr/man/man8/sbopkg.8 | 54 ++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/src/usr/man/man8/sbopkg.8 b/src/usr/man/man8/sbopkg.8 index 1211707..370cb61 100644 --- a/src/usr/man/man8/sbopkg.8 +++ b/src/usr/man/man8/sbopkg.8 @@ -26,31 +26,37 @@ Before sbopkg can be used, a configuration file must be created at (5) for more information about the configuration file. Sbopkg can be run from the command line by simply invoking "sbopkg." -Doing so will launch the dialog-based interface, and the menus -provided should be fairly self-explanatory. The main menu allows the -user to rsync with the SlackBuilds.org repository (currently, the size -of a local copy of the SBo repository is less than 50MB), view the -SlackBuilds.org Changelog, check for potential updates to SBo -packages, display the contents of the local cache directory where -source tarballs are saved, display the permanent build log, and browse -or search the local copy of the SBo repository. Once the browse -function is chosen, the user can select the category of software to -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 .info file and +Sbopkg must be run as the root user (since the SlackBuild scrips at +SlackBuilds.org are written with the intention of being run as root). +Furthermore, using 'su -' instead of 'su' is strongly encouraged. +The reason is that some SlackBuild scripts rely on certain tools that +are only available in root's $PATH (i.e. texmf to build man pages) and +root's $PATH is not inherited when only using 'su'. In any evnet, +invoking 'sbopkg' from the command line will launch the dialog-based +interface, and the menus provided should be fairly self-explanatory. +The main menu allows the user to rsync with the SlackBuilds.org +repository (currently, the size of a local copy of the SBo repository +is less than 50MB), view the SlackBuilds.org Changelog, check for +potential updates to SBo packages, display the contents of the local +cache directory where source tarballs are saved, display the permanent +build log, and browse or search the local copy of the SBo repository. +Once the browse function is chosen, the user can select the category +of software to 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 .info file and SlackBuild and the edited files will remain after doing an rsync. -Additionally, 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 chose. -Alternatively, the user can choose to automatically build or build and -install individual packages or several packages in a build queue. -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. +Additionally, 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 chose. Alternatively, the user can choose to +automatically build or build and install individual packages or +several packages in a build queue. 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