initial commit

1 files changed, 288 insertions, 0 deletions

diff --git a/sbolint.1 b/sbolint.1
new file mode 100644
index 0000000..8ee2499
--- /dev/null
+++ b/sbolint.1
@@ -0,0 +1,288 @@
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+.    ds C`
+.    ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+.    if \nF \{\
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{\
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "SBOLINT 1"
+.TH SBOLINT 1 "2022-04-03" "0.4" "SBoStuff"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+sbolint \- check SlackBuild directories or tarballs for common errors.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBsbolint\fR [\-a] [\-g] [\-q] [\-u] [\-n] [build [build ...]]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+sbolint checks for common errors in SlackBuilds.org scripts. It's
+intended for slackbuild authors and maintainers, and can cut down on
+\&\*(L"There was a problem with your upload\*(R" errors from the submission form.
+.PP
+The [build] arguments must be either directories or tarballs, each
+containing a SlackBuild script, slack-desc, \s-1README,\s0 and .info file.
+With no [build] arguments, the current directory is checked.
+.PP
+sbolint will flag errors for problems that would prevent the build from
+being accepted by the upload form (or by the SBo admins, if if passes
+the upload checks). There may also be warnings, which are things that
+(probably) won't stop your build from being accepted, but may cause the
+SBo admins extra work.
+.PP
+sbolint was not written by the SlackBuilds.org team, and shares no code
+with the upload form's submission checker. Lack of errors/warnings from
+sbolint does not guarantee that your build will be accepted!
+.PP
+sbolint doesn't check built packages, and never executes the build
+script. If you want a lint tool for binary Slackware packages, try
+pprkut's \fBlintpkg\fR.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-a\fR" 4
+.IX Item "-a"
+Check all builds in the git repository. This must be run from within a
+git tree (e.g. one made with \*(L"git clone\*(R").
+.IP "\fB\-q\fR" 4
+.IX Item "-q"
+Quiet. Suppresses 'xxx checks out \s-1OK\s0' and the total errors/warnings summary.
+.IP "\fB\-u\fR" 4
+.IX Item "-u"
+\&\s-1URL\s0 check. Uses \fBcurl\fR to make \s-1HTTP HEAD\s0 requests for the \fB\s-1HOMEPAGE\s0\fR,
+\&\fB\s-1DOWNLOAD\s0\fR, and \fBDOWNLOAD_x86_64\fR links. This won't guarantee that
+the links are good, but some kinds of failure (e.g. site down, 404)
+means they're definitely bad. Unfortunately a lot of sites have stopped
+responding to \s-1HEAD\s0 requests in the name of \*(L"security\*(R", so your mileage
+man vary.
+.IP "\fB\-n\fR" 4
+.IX Item "-n"
+Suppress warnings. Only errors will be listed. This also affects the
+exit status (see below).
+.SH "CHECKS"
+.IX Header "CHECKS"
+For tar files only:
+.IP "\-" 4
+File size must not be bigger than the upload form's limit (currently one
+megabyte).
+.IP "\-" 4
+File must be a tar archive, possibly compressed with gzip, bzip2, or xz,
+extractable by the \fBtar\fR(1) command.
+.IP "\-" 4
+Filename extension must match compression type.
+.IP "\-" 4
+Archive must contain a directory with the same name as the archive's base name,
+e.g. \fIfoo.tar.gz\fR must contain \fIfoo/\fR. Everything else in the archive must be
+inside this directory.
+.IP "\-" 4
+Archive must contain \fIdirname/Idirname.SlackBuild\fR.
+.PP
+For all builds:
+.IP "\-" 4
+The SlackBuild, .info, \s-1README\s0 files must have Unix \en line endings (not
+\&\s-1DOS\s0 \er\en), and the last line of each must have a \en.
+.IP "\-" 4
+The SlackBuild script must exist, with mode 0755 (or 0644, if in a git repo),
+and be a \fI#!/bin/bash\fR script.
+.IP "\-" 4
+The script must contain the standard variable assignments for \s-1PRGNAM,
+VERSION, BUILD,\s0 and \s-1TAG. BUILD\s0 must be numeric.
+.IP "\-" 4
+\&\fI\s-1PRGNAM\s0\fR in the script must match \fI\s-1PRGNAM\s0\fR in the .info file. Both must
+match the script name (\fI\s-1PRGNAM\s0.SlackBuild\fR) and the directory name.
+.IP "\-" 4
+\&\fI\s-1VERSION\s0\fR must match the \fI\s-1VERSION\s0\fR in the .info file.
+.IP "\-" 4
+TAG=${TAG:\-_SBo} must occur in the script.
+.IP "\-" 4
+The \fI\s-1VERSION\s0\fR, \fI\s-1BUILD\s0\fR, and \fI\s-1TAG\s0\fR variables must respect the environment.
+.IP "\-" 4
+The script must install the slack-desc in \fI\f(CI$PKG\fI/install\fR.
+.IP "\-" 4
+If there is a doinst.sh script, the SlackBuild must install it to \fI\f(CI$PKG\fI/install\fR.
+.IP "\-" 4
+Template boilerplate comments should be removed, e.g. \fI\*(L"\s-1REMOVE THIS ENTIRE BLOCK OF TEXT\*(R"\s0\fR
+or \fI\*(L"Automatically determine the architecture we're building on\*(R"\fR.
+.IP "\-" 4
+Script must contain exactly one \fBmakepkg\fR command.
+.IP "\-" 4
+\&\s-1README\s0 must exist, have mode 0644, its character encoding must be
+either \s-1ASCII\s0 or \s-1UTF\-8\s0 without \s-1BOM,\s0 and it may not contain tab characters.
+.IP "\-" 4
+slack-desc must exist, have mode 0644, its character encoding must be \s-1ASCII,\s0
+and it may not contain tab characters.
+.IP "\-" 4
+slack-desc contents must match the SBo template, including the \*(L"handy-ruler\*(R",
+comments, and correct spacing/indentation.
+.IP "\-" 4
+\&.info file must exist, have mode 0644, and match the SBo template.
+.IP "\-" 4
+\&.info file URLs must be valid URLs (for a very loose definition of \*(L"valid\*(R": they
+must begin with \fBftp://\fR, \fBhttp://\fR, or \fBhttps://\fR).
+.IP "\-" 4
+Optionally, .info file URLs can be checked for existence with an \s-1HTTP HEAD\s0
+request (see the \fB\-u\fR option).
+.PP
+The following tests are only done when sbolint's starting directory
+was \s-1NOT\s0 in a git repo:
+.IP "\-" 4
+Any files other than the .SlackBuild, .info, slack-desc, and \s-1README\s0 are
+checked for permissions (should be 0644) and excessive size.
+.IP "\-" 4
+The source archive(s) must not exist. Also sbolint attempts to detect
+extracted source trees (but isn't all that good at it).
+.IP "\-" 4
+Files named 'build.log' or 'strace.out*' must not exist. The \fBsbrun\fR
+tool creates these.
+.PP
+The rationale for skipping the above tests when in a git repo is that
+maintainers will be using git to track files and push changes, so we
+don't need to check them here.
+.SH "EXIT STATUS"
+.IX Header "EXIT STATUS"
+Exit status from sbolint will normally be 0 (success) if there were no
+errors or warnings in any of the builds checked. With the \fB\-n\fR option,
+exit status will be 0 if there are no errors.
+.PP
+Exit status 1 indicates there was at least one warning or error (or, with
+\&\fB\-n\fR, at least one error).
+.PP
+Any other exit status means sbolint itself failed somehow (e.g. called
+with nonexistent filename).
+.SH "BUGS"
+.IX Header "BUGS"
+Probably quite a few. Watch this space for details.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+B. Watson (yalhcru at gmail dot com, or Urchlay on Libera \s-1IRC\s0)
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBsbofixinfo\fR(1), \fBsbosearch\fR(1)