Documentation/man1/prtcheck.1

43 lines
1.6 KiB
Groff

.\"
.\" prtcheck manual page.
.\" (C) 2003 by Martin Opel <mo@obbl-net.de>
.\"
.TH prtcheck 1
.SH NAME
prtcheck \- check the port in the current directory
.SH SYNOPSIS
.PP
.B prtcheck
[ \-\-root ]
.SH DESCRIPTION
The \fIprtcheck\fP script checks the following things: existence of
Pkgfile, \.footprint, and \.signature. It warns, if any files with non-root
user/group appear in the \.footprint, or if any of the fields Description, URL,
Packager, "Depends on" were omitted from the Pkgfile, or if any source
needed for compiling and verifying the package is unsigned.
\fIprtcheck\fP returns with an exit status of -1 if it encounters serious
violations of port correctness, >0 if it only finds easily-fixed violations,
and 0 if all checks were passed.
.SH OPTIONS
The following option is supported:
.TP
.I "\--root"
This option is helpful if you create ports as a normal user. Even after
debugging those Makefiles or source code packages that try to install directly
in /usr/local or ignore DESTDIR variables, the .footprint might contain
uid/gid entries matching the uid/gid of the user who called \fIpkgmk\fP (since
\fIfakeroot\fP is no requirement in a basic CRUX installation).
\fIprtcheck\fP normally just issues a warning if it finds such uid/gid entries,
but passing the --root option lets you create a new footprint, replacing the invalid
uid/gid entries with root/root. Follow up with \fIprtverify(1)\fP to additionally
check that your port's footprint respects CRUX filesystem conventions.
.PP
.SH AUTHORS
\fIprtcheck\fP was written by Martin Opel <mo@obbl-net.de> for CRUX Linux,
revised by John McQuah <jmcquah@disroot.org> to address FS#1763.