PORTCHECK(1)

💅 PORTCHECK(1) — the glow-up your port needs before you submit it 💅

okay bestie, so this is the portcheck manpage from section 1 (General Commands Manual) of the manual, and it's genuinely about to save you from embarrassing yourself in front of the ports maintainers. no cap.

---

✨ NAME ✨

portcheck — validate a port before submitting 🫶

---

🌸 SYNOPSIS 🌸

portcheck [-dNP] [-p portsdir] [-x pattern]

portcheck -A [-dP] [-p portsdir] [-x pattern] [subdir ...]

---

🦋 DESCRIPTION 🦋

so portcheck is literally the vibe check for your OpenBSD port or port hierarchy in the current directory. you run it before you submit your ports for review, and it catches all the common mistakes you'd otherwise be roasted for. it verifies that the directory and file structure for a port is actually in place and that no bogus files are lurking around like uninvited guests. 🚫

when it's done doing its thing, portcheck prints the detected value of your port's PKGPATH to standard output — unless it fails in detection, in which case you should've given it the -p option. all its other (error) messages end up on standard error output, so no confusion about where to look. 😌

by default, portcheck automatically picks up the nearest parent directory named “ports”, with an optional “mystuff” or “openbsd-wip” subdirectory component, as the ports root directory. for example: if the port being imported is located in /home/joe/cvs/ports/openbsd-wip/devel/p5-Foo, then the root ports directory will be detected as being /home/joe/cvs/ports/openbsd-wip. iconic autodetection behavior fr fr. but if you want to override this behaviour, see the -p option below. 💖

the following options are available:

🎀 OPTIONS 🎀

• -A — intended for running portcheck on the whole ports tree, i.e., the one lying in PORTSDIR. this option adds several ignore patterns (see -x option description) and disables some other checks (e.g., for missing distinfo). PKGPATH determining and printing won't be done. implicit change of working directory to the ports tree root is done before starting any checks. also, in this mode one or more subdir arguments could be specified, to narrow the check only for given subdirectories of ports tree root. that's a big slay for whole-tree auditing. 🔥
• -d — show debugging information such as calling of check routines. lowkey useful when you're like "wait, why did it flag that?" 👀
• -P — disable expensive checks that use “print-plist-with-depends” target, e.g., proper usage of gtk-update-icon-cache(1), update-desktop-database(1) and update-mime-database(1). basically it says "skip the fancy integrations, i just want speed." 💨
• -p portsdir — forces the given directory to be treated as ports root directory. cancels autodetection of the root ports directory made by default. this option is useful, e.g., when you have a temporary ports tree in a non-standard location. so if your tree is living somewhere weird (no judgment), just tell portcheck where it's at. 📍
• -N — intended to be used when working on new ports. enables the checks like the presence of REVISION markers and non-0.0 SHARED_LIBS. it also enables checks for the presence of CVS directories that could be left by mistake when creating a new port based on another one. so basically: making sure your new baby isn't carrying around someone else's leftover baggage. 🧳✨
• -x — excludes files and subdirectories matching given shell globbing pattern from any checks. note that matching is done against relative path, and not against absolute path or base name either. i.e., to exclude the “x11/kde4/libs/logs” from checks, you must pass the whole line as argument, not just “logs”. multiple -x options may be specified. so you can ghost as many annoying files as you want, just be specific about it. 🙈

---

🌈 EXAMPLES 🌈

to validate a new port you've just prepared, go to port's directory and run:

$ portcheck -N

if you were working on updating of an existing port in CVS tree:

$ portcheck

to run a global check of the whole “devel” category in ports tree, use the -A option instead:

$ portcheck -Ap /usr/ports devel

---

👑 SEE ALSO 👑

portimport(1) — because sometimes checking is just step one, and importing is the whole main character moment. 💅

---

⭐ HISTORY ⭐

this utility was split from portimport(1) in 2013 and first appeared in OpenBSD 5.5. so it's been out here doing the work for a minute. respect the elders. 🧚‍♀️

---

that's the whole thing bestie. now go forth and portcheck before you submit, or the maintainers will 👀 and you'll be 😭. you got this. 🫶💖

Debian · May 29, 2019 · and that's the portcheck(1) manual page — periodt. 🎀