From e1b1e0e52ee714a513c11df4ffc6b9a0b6ce7938 Mon Sep 17 00:00:00 2001 From: "chess.griffin" Date: Thu, 14 Aug 2008 00:30:05 +0000 Subject: [PATCH] clean up whitespace in docs and man pages --- src/usr/doc/README | 21 +++++++++++---------- src/usr/doc/TODO | 6 +++--- src/usr/doc/UPDATELIST-DEBUGGING | 2 +- src/usr/man/man5/sbopkg.conf.5 | 8 ++++---- src/usr/man/man8/sbopkg.8 | 14 +++++++------- 5 files changed, 26 insertions(+), 25 deletions(-) diff --git a/src/usr/doc/README b/src/usr/doc/README index 891ba0f..e7a901c 100644 --- a/src/usr/doc/README +++ b/src/usr/doc/README @@ -8,17 +8,18 @@ Homepage: http://code.google.com/p/sbopkg Sbopkg is a command-line and dialog-based tool to synchronize with the SlackBuilds.org repository, a collection of third-party SlackBuild scripts to build Slackware packages. Sbopkg will allow the user to -browse his or her local copy of the repository, read the ChangeLog, display -potential updates to SlackBuilds.org packages, and view the README, SlackBuild, -.info, and slack-desc files for each package. 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. +browse his or her local copy of the repository, read the ChangeLog, +display potential updates to SlackBuilds.org packages, and view the +README, SlackBuild, .info, and slack-desc files for each package. +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 rsync, read the ChangeLog, view package files, and build packages. Typing sbopkg -h will display the command line -options. +options. diff --git a/src/usr/doc/TODO b/src/usr/doc/TODO index d80bdc1..fc4ec00 100644 --- a/src/usr/doc/TODO +++ b/src/usr/doc/TODO @@ -7,7 +7,7 @@ Sbopkg TODO (in no particular order) 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. + 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 @@ -15,7 +15,7 @@ Sbopkg TODO (in no particular order) 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 + 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 @@ -26,4 +26,4 @@ Sbopkg TODO (in no particular order) UPDATE: Preliminary experimental code for this feature first appeared in version 0.0.8. * More error checking. -* General code cleanups. +* General code cleanups. diff --git a/src/usr/doc/UPDATELIST-DEBUGGING b/src/usr/doc/UPDATELIST-DEBUGGING index f19e578..c645737 100644 --- a/src/usr/doc/UPDATELIST-DEBUGGING +++ b/src/usr/doc/UPDATELIST-DEBUGGING @@ -27,7 +27,7 @@ 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. +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: diff --git a/src/usr/man/man5/sbopkg.conf.5 b/src/usr/man/man5/sbopkg.conf.5 index 926e287..bed2c87 100644 --- a/src/usr/man/man5/sbopkg.conf.5 +++ b/src/usr/man/man5/sbopkg.conf.5 @@ -5,7 +5,7 @@ .SH DESCRIPTION -The sbopkg.conf file contains configuration settings for +The sbopkg.conf file contains configuration settings for .B sbopkg (8), a tool for interacting with the SlackBuilds.org ("SBo") repository, a collection of third-party SlackBuild scripts to build @@ -25,7 +25,7 @@ The default value of RSYNCMIRROR is slackbuilds.org::slackbuilds. .TP 5 .B SLACKVER .br -This option allows the user to set the default Slackware version in +This option allows the user to set the default Slackware version in order to rsync with the matching SBo repository. The default value of SLACKVER is 12.1. @@ -49,7 +49,7 @@ The default value of SRCDIR is /var/cache/sbopkg. .TP 5 .B TMP .br -This options sets the default directory where certain working +This options sets the default directory where certain working files are saved on a temporary basis. The default value of TMP is /tmp. @@ -73,7 +73,7 @@ The default value of KEEPLOG is YES. It is possible to set or override environmental variables and pass them to the SlackBuild scripts when they are built from within sbopkg. For example, using the following in sbopkg.conf instead of a TMP line: - + export TMP:${TMP:-/home/sbo/tmp} will set $TMP to /home/sbo/tmp for sbopkg purposes (i.e. where sbopkg logs are diff --git a/src/usr/man/man8/sbopkg.8 b/src/usr/man/man8/sbopkg.8 index fe3abea..b33b59f 100644 --- a/src/usr/man/man8/sbopkg.8 +++ b/src/usr/man/man8/sbopkg.8 @@ -17,7 +17,7 @@ Before sbopkg can be used, a configuration file must be created at /etc/sbopkg/sbopkg.conf. A sample file is provided at /etc/sbopkg/sbopkg.conf.sample. See .B sbopkg.conf -(5) for more information about the configuration file. +(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 @@ -71,16 +71,16 @@ Display list of installed SBo packages and potential updates. This is an experimental feature. Please see UPDATELIST-DEBUGGING in the sbopkg documentation directory to assist with bug reporting. -.TP 5 +.TP 5 .B -d DIRECTORY -Manually specify the full path to the DIRECTORY containing the +Manually specify the full path to the DIRECTORY containing the local SBo repository. .TP 5 .B -f Override the default configuration file, which is located by default at /etc/sbopkg/sbopkg.conf, with another configuration -file. +file. .TP 5 .B -h @@ -94,9 +94,9 @@ Display the SBo ChangeLog.txt and quit. .B -q PACKAGE(s) Query for PACKAGE(s) by glob. For example: -#sbopkg -q nv +#sbopkg -q nv -will return a list of matches, such as the nvidia packages, +will return a list of matches, such as the nvidia packages, konversation, and other packages with 'nv' in their name. If more than one glob is specified, they must be in quotes. @@ -108,7 +108,7 @@ Rsync the local repository with SlackBuilds.org and quit. .B -s PACKAGE(s) Search for PACKAGE(s) by specific PACKAGE name and, if found, display the README, SlackBuild, .info, and slack-desc files in that order -using $PAGER, which defaults to 'more' as described above. If more +using $PAGER, which defaults to 'more' as described above. If more than one package is specified, they must be in quotes. For example: #sbopkg -s "foo bar"