Miroirs/sbopkg
1
0
Fork 0
mirror of https://github.com/sbopkg/sbopkg synced 2024-12-27 09:58:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Modified documentation to (almost) auto-update

Browse source 
Replaced variable data with 'xxxDATAxxx' tags. The tags are replaced by
the revised release script. This way, only that file needs to have,
e.g., 'size' changed and it will propagate to the README and both
manpages, rather than requiring three separate edits. Also, sbopkg.conf
and sbopkg.conf(5) will always automatically be in sync.
This commit is contained in:
slakmagik 2010-06-08 02:59:46 +00:00
parent 8ecc889b18
commit a441d09eba
3 changed files with 24 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/usr/doc/README
View file

@ -18,7 +18,7 @@ locally-maintained repository.
Sbopkg will allow the user to create, synchronize, search, and browse a copy
of the active repository (currently, the size of a local copy of the SBo
repository is about 70MB), read the ChangeLog (if available), list the
repository is xxxSIZExxx), read the ChangeLog (if available), 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 .info or SlackBuild files. Sbopkg

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

@ -1,5 +1,5 @@
.\"=====================================================================
.TH SBOPKG.CONF 5 "May 2010" sbopkg-SVN ""
.TH SBOPKG.CONF 5 "xxxDATExxx" sbopkg-SVN ""
.\"=====================================================================
.SH NAME
sbopkg.conf \- configuration file for sbopkg
@ -74,7 +74,7 @@ Take care.
.IP
The default assignment is:
.IP
\fCALLOW_MULTI=NO\fP
\fCxxxALLOW_MULTIxxx\fP
.\"---------------------------------------------------------------------
.TP
.B CLEANUP
@ -102,7 +102,7 @@ setting is ignored.
.IP
The default assignment is:
.IP
\fCCLEANUP=NO\fP
\fCxxxCLEANUPxxx\fP
.\"---------------------------------------------------------------------
.TP
.B DEBUG_UPDATES
@ -136,7 +136,7 @@ may be helpful if it appears the updatelist might be missing an update.
.IP
The default assignment is:
.IP
\fCDEBUG_UPDATES={$DEBUG_UPDATES:-0}\fP
\fCxxxDEBUG_UPDATESxxx\fP
.\"---------------------------------------------------------------------
.TP
.B DIFF
@ -148,7 +148,7 @@ displays differences between edited files.
.IP
The default assignment is:
.IP
\fCDIFF=${DIFF:-diff}\fP
\fCxxxDIFFxxx\fP
.\"---------------------------------------------------------------------
.TP
.B DIFFOPTS
@ -162,7 +162,7 @@ displays differences between edited files.
.IP
The default assignment is:
.IP
\fCDIFFOPTS=${DIFFOPTS:--u}\fP
\fCxxxDIFFOPTSxxx\fP
.\"---------------------------------------------------------------------
.TP
.B KEEPLOG
@ -179,7 +179,7 @@ for the location of this log.
.IP
The default assignment is:
.IP
\fCKEEPLOG=YES\fP
\fCxxxKEEPLOGxxx\fP
.\"---------------------------------------------------------------------
.TP
.B LOGFILE
@ -192,7 +192,7 @@ is set to
.IP
The default assignment is:
.IP
\fCLOGFILE=${LOGFILE:-/var/log/sbopkg/sbopkg-build-log}\fP
\fCxxxLOGFILExxx\fP
.\"---------------------------------------------------------------------
.TP
.B MKDIR_PROMPT
@ -211,7 +211,7 @@ to
.IP
The default assignment is:
.IP
\fCMKDIR_PROMPT=YES\fP
\fCxxxMKDIR_PROMPTxxx\fP
.\"---------------------------------------------------------------------
.TP
.B OUTPUT
@ -227,7 +227,7 @@ is therefore the same as in the SBo SlackBuilds.
.IP
The default assignment is:
.IP
\fCexport OUTPUT=${OUTPUT:-/tmp}\fP
\fCxxxOUTPUTxxx\fP
.\"---------------------------------------------------------------------
.TP
.B QUEUEDIR
@ -238,7 +238,7 @@ kept.
.IP
The default assignment is:
.IP
\fCQUEUEDIR=${QUEUEDIR:-/var/lib/sbopkg/queues}\fP
\fCxxxQUEUEDIRxxx\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_BRANCH
@ -257,7 +257,7 @@ files and can also be listed by issuing
.IP
The default assignment is:
.IP
\fCREPO_BRANCH=${REPO_BRANCH:-13.1}\fP
\fCxxxREPO_BRANCHxxx\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_NAME
@ -283,7 +283,7 @@ documentation directory.
.IP
The default assignment is:
.IP
\fCREPO_NAME=${REPO_NAME:-SBo}\fP
\fCxxxREPO_NAMExxx\fP
.\"---------------------------------------------------------------------
.TP
.B REPO_ROOT
@ -291,11 +291,11 @@ Path.
.IP
This option allows the user to set the location of the local mirrors of
the remote repositories.
Currently, the size of a local copy of the SBo repository is about 70MB.
Currently, the size of a local copy of the SBo repository is xxxSIZExxx.
.IP
The default assignment is:
.IP
\fCREPO_ROOT=${REPO_ROOT:-/var/lib/sbopkg}\fP
\fCxxxREPO_ROOTxxx\fP
.\"---------------------------------------------------------------------
.TP
.B RSYNCFLAGS
@ -331,7 +331,7 @@ is a useful option to play with if getting syncing errors.
.IP
The default assignment is:
.IP
\fCRSYNCFLAGS="--verbose --timeout=30"\fP
\fCxxxRSYNCFLAGSxxx\fP
.\"---------------------------------------------------------------------
.TP
.B SBOPKGTMP
@ -344,7 +344,7 @@ are saved on a temporary basis.
.IP
The default assignment is:
.IP
\fCSBOPKGTMP=${SBOPKGTMP:-/tmp/sbopkg}\fP
\fCxxxSBOPKGTMPxxx\fP
.\"---------------------------------------------------------------------
.TP
.B SRCDIR
@ -355,7 +355,7 @@ downloads will be saved.
.IP
The default assignment is:
.IP
\fCSRCDIR=${SRCDIR:-/var/cache/sbopkg}\fP
\fCxxxSRCDIRxxx\fP
.\"---------------------------------------------------------------------
.TP
.B TMP
@ -378,7 +378,7 @@ setting is ignored.
.IP
The default assignment is:
.IP
\fCexport TMP=${TMP:-/tmp/SBo}\fP
\fCxxxTMPxxx\fP
.\"---------------------------------------------------------------------
.TP
.B WGETFLAGS
@ -410,7 +410,7 @@ is a useful option to play with if getting download errors.
.IP
The default assignment is:
.IP
\fCWGETFLAGS="--continue --progress=bar:force --timeout=30 --tries=5"\fP
\fCxxxWGETFLAGSxxx\fP
.\"=====================================================================
.SH NOTES
.\"---------------------------------------------------------------------

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

@ -1,5 +1,5 @@
.\"=====================================================================
.TH SBOPKG 8 "May 2010" sbopkg-SVN ""
.TH SBOPKG 8 "xxxDATExxx" sbopkg-SVN ""
.\"=====================================================================
.SH NAME
sbopkg \- the SlackBuilds.org package browser
@ -71,7 +71,8 @@ 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.
Currently, the size of a local copy of the SBo repository is about
xxxSIZExxx.
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