Miroirs/sbopkg
1
0
Fork 0
mirror of https://github.com/sbopkg/sbopkg synced 2025-01-13 20:01:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Yet more manpage tweaks and cleanups

Browse source 
In HACKING, I moved two points, modified two points, moved and modified
one point, and added two points. I also separated all points with a
blank line as is consistent with the first list in the file.

In both man pages, I shortened most 'SlackBuilds.org' references to
'SBo'; shortened most 'SlackBuild scripts' references to 'SlackBuilds';
added some missed root prompt symbols; and added a few missed .Bs and
.Is or flipped a wrong one for the right one.

In sbopkg.conf.5, I added 'simultaneously' in ALLOW_MULTI; revised a
line in KEEPLOG, and one in LOGFILE; and flipped a couple of
inconsistent .PP/.RS pairs to .RS/.PP.

In sbopkg.8, I added a comma in a list; redid a sequence of bold/roman
in the '-e' arg list; changed 'another configuration file' to 'FILE';
and flipped the out-of-order -r/-R flags.
This commit is contained in:
slakmagik 2010-06-02 23:05:51 +00:00
parent 1978ab59a9
commit 4b35bdf032
3 changed files with 83 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/usr/doc/HACKING
View file

@ -239,30 +239,44 @@ Manual Page Style Guidelines
* Separate all text header and section header requests with commented lines of
equal (=) signs. Separate all subsections and tagged paragraphs that serve
as subsections with commented lines of minus (-) signs.
* Leave no blank lines in the file. E.g., .PP will often serve under .SH and
.IP under .TP.
* Wrap lines at 72 columns and begin all sentences on new lines.
* If variables are being used in the sense of their value, use $VAL but if
they are being used in reference to themselves, use VAR.
* Where sensible, try to make .TPs have a consistent indent.
* Try to use standard headers where possible, filing other information
under subsections of the relevant section header.
* Add options as .TP 5 (or current default), with \- and bold options,
followed by italic replaceable arguments to those options or bold literal
arguments, if any.
* Refer to the user as 'the user' rather than 'you'.
arguments, if any. Brackets, bars, etc., should be regular font, though.
* More generally, italicize filenames, URLs, replaceable terms (including
references to unspecified variable values ($VARs)).
* Embolden variables (when used literally rather than replaceably), option
values, programs, program flags, and all references to sbopkg itself.
* Make all option dashes in the form \- (or \-\-) unless in a code example.
* Try to refer to the user as 'the user' rather than 'you'.
* Collect all referenced programs (unless used purely as an example) in the
SEE ALSO section. (The SEE ALSO section is not *limited* to referenced
programs, however.)
* Try to be as specific as conveniently possible, where 'convenient' means to
generalize wherever constant updates might be necessary and such
generalization wouldn't compromise clarity and accuracy.
* Italicize filenames, URLs, replaceable terms (including references to
unspecified variable values ($VARs).
* Embolden variables (when used literally rather than replaceably), option
values, programs, program flags, and all references to sbopkg itself.
* Use `` and '' for double-quotes so groff does the fancy stuff for ps output.
* Make all option dashes in the form \- (or \-\-) unless in a code example.
* .EX doesn't seem to be very well supported or necessarily what is wanted -
code examples can be done with the following cookie-cutter code:
.RS
@ -273,8 +287,16 @@ Manual Page Style Guidelines
.RE
If inline, at least embolden them so they're set off in ascii overstrike
output.
In command line examples, prefix the commands with the root prompt (#).
* Start configuration file option sections with a statement of type, a
description, and the following cookie-cutter code:
The default assignment is:
.IP
\fCdefault_assignment\fP
* Try to refer to SlackBuilds as SlackBuilds rather than SlackBuild scripts
unless for a particular need (for instance, explaining what SlackBuilds are
in the first place). And once SlackBuilds.org has been properly introduced,
try to refer to it as SBo.

36
src/usr/man/man5/sbopkg.conf.5
View file

@ -33,7 +33,8 @@ Boolean.
When set to
.BR YES ,
this option allows the user to run multiple instances of
.BR sbopkg .
.B sbopkg
simultaneously.
.IP
Please understand that this option is provided for convenience, but
given the number of potential issues you can face when enabling this
@ -170,11 +171,11 @@ Boolean.
This option allows the user to choose whether to keep a permanent log of
packages that are built with
.B sbopkg
in order to go back and review the build, and any errors, after exiting
.BR sbopkg .
in order to review the builds for historical or troubleshooting
purposes.
See
.B LOGFILE
for where this log is.
for the location of this log.
.IP
The default assignment is:
.IP
@ -250,7 +251,7 @@ files and can also be listed by issuing
.RS
.IP
.nf
\fCsbopkg -V ?\fP
\fC# sbopkg -V ?\fP
.fi
.RE
.IP
@ -267,8 +268,7 @@ See
.B REPO_BRANCH
for how to get an enumeration of standard values.
The ``local'' choice corresponds to a user-maintained repository whose
structure must be the same as the one used by SlackBuilds.org, in the
sense of a
structure must be the same as the one used by SBo, in the sense of a
.I category/package/files
hierarchy.
Note: all of the
@ -277,7 +277,9 @@ variables are affected by the repository files maintained in
.I /etc/sbopkg/repos.d.
Please see the
.I README-repos.d
document in the sbopkg documentation directory.
document in the
.B sbopkg
documentation directory.
.IP
The default assignment is:
.IP
@ -302,7 +304,7 @@ Command options.
.B Rsync
is used by
.B sbopkg
to mirror the SlackBuilds.org repository.
to mirror the SBo repository.
This option allows the user to manually tweak the
.B rsync
flags (options) that are used by
@ -414,14 +416,14 @@ The default assignment is:
.\"---------------------------------------------------------------------
.SS Overriding Environmental Variables
It is possible to set or override environmental variables and pass them
to the SlackBuild scripts when they are built from within
to the SlackBuilds when they are built from within
.BR sbopkg .
This is already demonstrated in the following example line (and others
like it) in the
.I sbopkg.conf
file:
.PP
.RS
.PP
.nf
\fCexport TMP=${TMP:-/tmp/SBo}\fP
.fi
@ -439,8 +441,8 @@ Since this variable is exported, it could be changed for both
and for building SBo packages within
.BR sbopkg .
For example, changing this line so it reads:
.PP
.RS
.PP
.nf
\fCexport TMP=${TMP:-/home/sbo/tmp}\fP
.fi
@ -457,7 +459,7 @@ as
.RS
.PP
.nf
\fCexport TMP=foo; sbopkg\fP
\fC# export TMP=foo; sbopkg\fP
.fi
.RE
.PP
@ -505,7 +507,7 @@ root terminal like
.RS
.PP
.nf
\fCexport ARCH=i686; sbopkg\fP
\fC# export ARCH=i686; sbopkg\fP
.fi
.RE
.PP
@ -518,7 +520,7 @@ is not set by the user and
.B sbopkg
does not detect one of the previously mentioned architectures, then
.B ARCH
will be set by whatever is in the SlackBuild scripts.
will be set by whatever is in the SlackBuilds.
Note that the SlackBuild may, in certain instances, discard or override
previous
.B ARCH
@ -534,7 +536,9 @@ Default file that lists software in the SBo repository that has been
renamed.
See the
.I README-renames.d
document in the sbopkg documentation directory for more information.
document in the
.B sbopkg
documentation directory for more information.
.TP
.I /etc/sbopkg/repos.d/{40-sbo.repo,50-sb64.repo,60-local.repo}
Three default files for various types of

59
src/usr/man/man8/sbopkg.8
View file

@ -18,13 +18,13 @@ packages.
.\"---------------------------------------------------------------------
.SS Instructions
.B Sbopkg
usage assumes an understanding of SlackBuild scripts, generally, and the
third-party repository SlackBuilds.org, specifically.
usage assumes an understanding of SlackBuilds, generally, and the
third-party SBo repository, specifically.
A thorough reading of
.I http://www.slackbuilds.org/howto/
and the pages at
.I http://www.slackwiki.org
about SlackBuild scripts is strongly advised.
about SlackBuilds is strongly advised.
.PP
In order for
.B sbopkg
@ -39,15 +39,15 @@ See
for more information about the configuration file.
.PP
.B Sbopkg
must be run as the root user (since the SlackBuild scripts at
SlackBuilds.org are written with the intention of being run as root).
must be run as the root user (since the SBo SlackBuilds are written with
the intention of being run as root).
Furthermore, using the
.B \-
option with
.B su
is strongly encouraged.
The reason is that some SlackBuild scripts rely on certain tools that
are only available in root's
The reason is that some SlackBuilds rely on certain tools that are only
available in root's
.B PATH
when the scripts in
.I /etc/profile.d
@ -60,19 +60,19 @@ In any event, invoking
.B sbopkg
with no arguments (or with just
.BR \-d ,
.B \-f
.BR \-f ,
or
.BR \-V )
will launch the
.BR dialog -based
interface, and the menus provided should be fairly self-explanatory.
The main menu allows the user to synchronize with the SlackBuilds.org
repository.
.PP
The main menu allows the user to synchronize with the SBo repository.
This is the first step to take (after configuration) with a new install
of
.BR sbopkg .
Currently, the size of a local copy of the SBo repository is about 70MB.
The main menu also allows the user to view the SlackBuilds.org
The main menu also allows the user to view the SBo
.IR ChangeLog ,
check for potential updates to SBo packages, display the contents of the
local cache directory where source tarballs are saved, display the
@ -113,8 +113,10 @@ Alternatively, the user can choose to automatically build, or both build
and install, individual packages or several packages in a build queue.
Finally, if
.B KEEPLOG
is set to YES in the
.B sbopkg.conf
is set to
.B YES
in the
.I sbopkg.conf
file then a permanent log of the build process is saved.
See
.BR sbopkg.conf (5)
@ -129,7 +131,9 @@ Alternatively,
can be run from the command line without using the
.B dialog
interface.
See the OPTIONS section for the available command line options.
See the
.B OPTIONS
section for the available command line options.
.PP
.B Sbopkg
also has the capability of loading, saving, and using user-created
@ -212,7 +216,7 @@ time it is encountered.
.\"---------------------------------------------------------------------
.TP
.B \-c
Display list of installed SBo packages and potential updates.
Display a list of installed SBo packages and potential updates.
.\"---------------------------------------------------------------------
.TP
.BI \-d " DIRECTORY"
@ -221,7 +225,7 @@ Manually specify the full path to the
containing the local SBo repository.
.\"---------------------------------------------------------------------
.TP
.B \-e \fBask\fR|\fBcontinue\fR|\fBstop
.B \-e ask\fR|\fPcontinue\fR|\fPstop
Specify what
.B sbopkg
should do when it encounters an error while building a package.
@ -241,7 +245,8 @@ Stop the processing (act as if the user answered ``No'' to all questions).
.BI \-f " FILE"
Override the default configuration file,
.IR /etc/sbopkg/sbopkg.conf ,
with another configuration file.
with
.IR FILE .
.\"---------------------------------------------------------------------
.TP
.BI \-g " PACKAGE(s)"
@ -313,8 +318,12 @@ and quit.
List the currently installed cached source files which are deemed
obsolete, and optionally delete them.
.IP
Source files are obsolete when no SBo script references it any more,
which is something that can happen after syncing the local repository.
Source files are obsolete when no
.I .info
file's
.B DOWNLOAD
field(s) reference it any more, which is something that can happen after
syncing the local repository.
.IP
Please note that only the currently active repository is used to
identify the obsolete sources, so if the user builds packages with
@ -328,7 +337,7 @@ system and optionally delete them.
.\"---------------------------------------------------------------------
.TP
.B \-p
List installed SlackBuilds.org packages.
List installed SBo packages.
.\"---------------------------------------------------------------------
.TP
.B \-q
@ -337,10 +346,6 @@ When this flag is specified, the output of some of the command-line
options is minimized.
.\"---------------------------------------------------------------------
.TP
.B \-r
Rsync the local repository with SlackBuilds.org and quit.
.\"---------------------------------------------------------------------
.TP
.B \-R
Show all the
.I README
@ -348,6 +353,10 @@ files of the queued packages before starting the build.
This is useful when the user wants to make a final check.
.\"---------------------------------------------------------------------
.TP
.B \-r
``Rsync'' the local repository with SBo and quit.
.\"---------------------------------------------------------------------
.TP
.BI \-s " PACKAGE(s)"
Specific search for
.I PACKAGE(s)
@ -393,7 +402,7 @@ as
.RS
.IP
.nf
\fCsbopkg -V ?\fP
\fC# sbopkg -V ?\fP
.fi
.RE
.IP