home | help
GUARDS(1)	       User Contributed Perl Documentation	       GUARDS(1)

NAME
     guards - select from a list of files guarded by conditions

SYNOPSIS
     guards [--prefix=dir] [--path=dir1:dir2:...] [--default=<0|1>]
     [--check|--list] [--invert-match] [--with-guards] [--config=<file>] symbol
     ...

DESCRIPTION
     The script reads a configuration file that may contain so-called guards,
     file names, and comments, and writes those file names that satisfy all
     guards to standard output. The script takes a list of symbols as its argu-
     ments. Each line in the configuration file is processed separately. Lines
     may start with a number of guards. The following guards are defined:

	 +xxx Include the file(s) on this line if the symbol xxx is defined.

	 -xxx Exclude the file(s) on this line if the symbol xxx is defined.

	 +!xxx Include the file(s) on this line if the symbol xxx is not de-
	 fined.

	 -!xxx Exclude the file(s) on this line if the symbol xxx is not de-
	 fined.

	 - Exclude this file. Used to avoid spurious --check messages.

     The guards are processed left to right. The last guard that matches deter-
     mines if the file is included. If no guard is specified, the --default set-
     ting determines if the file is included.

     If no configuration file is specified, the script reads from standard in-
     put.

     The --check option is used to compare the specification file against the
     file system. If files are referenced in the specification that do not ex-
     ist, or if files are not enlisted in the specification file warnings are
     printed. The --path option can be used to specify which directory or direc-
     tories to scan.  Multiple directories are separated by a colon (":") char-
     acter. The --prefix option specifies the location of the files. Alterna-
     tively, the --path=@<file> syntax can be used to specify a file from which
     the file names will be read.

     Use --list to list all files independent of any rules. Use --invert-match
     to list only the excluded patches. Use --with-guards to also include all
     inclusion and exclusion rules.

AUTHOR
     Andreas Gruenbacher <agruen@suse.de>, SUSE Labs

perl v5.42.3			   2026-08-29			       GUARDS(1)

home | help