commit: a66135963e4fc1ee9fabf26f82ec5af4736e624d parent 00bcc40015fa0358eff706ca50463f69f9e06efa Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me> Date: Fri, 18 Feb 2022 01:09:14 +0100 deblob.1: Add manpageDiffstat:
| A | deblob.1 | 58 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 58 insertions(+), 0 deletions(-)diff --git a/deblob.1 b/deblob.1@@ -0,0 +1,58 @@ +.\" Copyright © 2019-2022 Haelwenn (lanodan) Monnier <contact+deblob-notice@hacktivis.me> +.\" SPDX-License-Identifier: BSD-3-Clause +.Dd 2022-02-18 +.Dt DEBLOB 1 +.Os +.Sh NAME +.Nm deblob +.Nd remove binary executables ("blobs") from a directory +.Sh SYNOPSIS +.Nm +.Op Fl n +.Op Fl e Ar excluded path ... +.Op Fl d Ar working directory +.Sh DESCRIPTION +The +.Nm +utility cleans a directory from binary executables ("blobs"). +Useful to clean a source tree to make sure it fully builds from source. +.Pp +Scanning for blobs inside source files is considered to be out-of-scope as +.Lk https://www.fsfla.org/svn/fsfla/software/linux-libre/scripts/ linux-libre deblob script +already exists. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl n +Scan the files but do not actually delete them. +.It Fl e Ar excluded path +Paths to be excluded from removal, accepts shell-style globbing. +Pass the option multiple times to do multiple exclusions. +.It Fl d Ar working directory +Directory to be scanned rather than the current working directory on execution. +.El +.Pp +Blobs scanned against are the following: +.Bl -dash -compact +.It +ELF files by the magic-header +.It +.Xr ar 1 +files by the magic-header +.It +x86 IBM PC BIOS Option Rom +.El +.Sh EXAMPLES +The following code block show how it is intended to be used in Gentoo's +.Pa /etc/portage/bashrc : +.Bd -literal +if [ "${EBUILD_PHASE}" == "prepare" ] +then + deblob -e 'test*' -e '*/test*' -d "${WORKDIR}" +fi +.Ed +.Sh HISTORY +This tool was originally implemented in Go as "go-deblob" and got rewritten +to hare as "deblob". +.Sh AUTHORS +.An Haelwenn (lanodan) Monnier Aq Mt contact+deblob-mdoc@hacktivis.me