commit: 3de78db1f3179b413b1e27000b75270e9f8c6002
parent 54f6cd8323ae86d77edb75cff6fcfe11ba216ff9
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Wed, 24 Sep 2025 09:17:27 +0200
checksrc.1: new
Diffstat:
| A | checksrc.1 | 41 | +++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 41 insertions(+), 0 deletions(-)
diff --git a/checksrc.1 b/checksrc.1
@@ -0,0 +1,41 @@
+.\" SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+checksrc@hacktivis.me>
+.\" SPDX-License-Identifier: MPL-2.0
+.Dd 2025-09-24
+.Dt CHECKSRC 1
+.Os
+.Sh NAME
+.Nm checksrc
+.Nd Check directory for potential non-source files
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Op Fl d Ar workdir
+.Op Fl e Ar excluded_path ...
+.Sh DESCRIPTION
+The
+.Nm
+utility uses heuristics to find files which might not be Source Code.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl d Ar workdir
+Directory to be scanned rather than the current working directory on execution.
+.It Fl e Ar excluded path
+Paths to be excluded from removal, accepts shell-style globbing
+without forcing slash to be present as path separator.
+.br
+Pass the option multiple times to do multiple exclusions.
+.El
+.Sh EXIT STATUS
+The
+.Nm
+utility exits with the following statuses:
+.Bl -tag -width _
+.It 0
+Nothing major was found
+.It 1
+An error occured
+.It 2
+Major hint of non-source were found in some files.
+.El
+.Sh AUTHORS
+.An Haelwenn (lanodan) Monnier Aq Mt contact+checksrc-mdoc@hacktivis.me
