Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ATF-SH(1)		    General Commands Manual		     ATF-SH(1)

NAME
       atf-sh -- interpreter for shell-based test programs

SYNOPSIS
       atf-sh [-s shell] script

DESCRIPTION
       atf-sh is an interpreter	that runs the test program given in script af-
       ter loading the atf-sh(3) library.

       atf-sh  is  not	a real interpreter though: it is just a	wrapper	around
       the system-wide shell defined by	ATF_SHELL.  atf-sh executes the	inter-
       preter, loads the atf-sh(3) library and then runs the script.  You must
       consider	atf-sh to be a POSIX shell by default and thus should not  use
       any non-standard	extensions.

       The following options are available:

       -s shell	    Specifies  the  shell to use instead of the	value provided
		    by ATF_SHELL.

ENVIRONMENT
       ATF_LIBEXECDIR	 Overrides the builtin directory where atf-sh  is  lo-
			 cated.	 Should	not be overridden other	than for test-
			 ing purposes.
       ATF_PKGDATADIR	 Overrides  the	builtin	directory where	libatf-sh.subr
			 is located.  Should not be overridden other than  for
			 testing purposes.
       ATF_SHELL	 Path  to the system shell to be used in the generated
			 scripts.  Scripts must	not rely on this variable  be-
			 ing set to select a specific interpreter.

EXAMPLES
       Scripts using atf-sh(3) should start with:

	     #!	/usr/bin/env atf-sh

       Alternatively,  if  you	want to	explicitly choose a shell interpreter,
       you cannot rely on env(1) to find atf-sh.  Instead, you have  to	 hard-
       code the	path to	atf-sh in the script and then use the -s option	after-
       wards as	a single parameter:

	     #!	/path/to/bin/atf-sh -s/bin/bash

SEE ALSO
       atf-sh(3)

FreeBSD	Ports 14.quarterly    September	27, 2014		     ATF-SH(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=atf-sh&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help