logo

checksrc

Check directory for potential non-source files git clone https://anongit.hacktivis.me/git/checksrc.git

checksrc.1 (1032B)

    

  1. .\" SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+checksrc@hacktivis.me>
  2. .\" SPDX-License-Identifier: MPL-2.0
  3. .Dd 2025-09-24
  4. .Dt CHECKSRC 1
  5. .Os
  6. .Sh NAME
  7. .Nm checksrc
  8. .Nd Check directory for potential non-source files
  9. .Sh SYNOPSIS
  10. .Nm
  11. .Op Fl v
  12. .Op Fl d Ar workdir
  13. .Op Fl e Ar excluded_path ...
  14. .Sh DESCRIPTION
  15. The
  16. .Nm
  17. utility uses heuristics to find files which might not be Source Code.
  18. .Sh OPTIONS
  19. .Bl -tag -width Ds
  20. .It Fl d Ar workdir
  21. Directory to be scanned rather than the current working directory on execution.
  22. .It Fl e Ar excluded path
  23. Paths to be excluded from removal, accepts shell-style globbing
  24. without forcing slash to be present as path separator.
  25. .br
  26. Pass the option multiple times to do multiple exclusions.
  27. .El
  28. .Sh EXIT STATUS
  29. The
  30. .Nm
  31. utility exits with the following statuses:
  32. .Bl -tag -width _
  33. .It 0
  34. Nothing major was found
  35. .It 1
  36. An error occurred
  37. .It 2
  38. Major hint of non-source were found in some files.
  39. .El
  40. .Sh AUTHORS
  41. .An Haelwenn (lanodan) Monnier Aq Mt contact+checksrc-mdoc@hacktivis.me