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

FreeBSD Manual Pages

  
 
  

home | help
App::Yath::Command::spUser3Contributed Perl DocumeApp::Yath::Command::spawn(3)

NAME
       App::Yath::Command::spawn - Launch a perl script	from the preloaded
       environment

DESCRIPTION
       This will launch	the specified script from the preloaded	yath process.

       NOTE: environment variables are not automatically passed	to the spawned
       process.	You must use -e	or -E (see help) to specify what environment
       variables you care about.

USAGE
	   $ yath [YATH	OPTIONS] spawn [COMMAND	OPTIONS]

   YATH	OPTIONS
       Developer

       --dev-lib
       --dev-lib=lib
       -D
       -D=lib
       -Dlib
       --no-dev-lib
	   Add paths to	@INC before loading ANYTHING. This is what you use if
	   you are developing yath or yath plugins to make sure	the yath
	   script finds	the local code instead of the installed	versions of
	   the same code. You can provide an argument (-Dfoo) to provide a
	   custom path,	or you can just	use -D without and arg to add lib,
	   blib/lib and	blib/arch.

	   Can be specified multiple times

       Environment

       --persist-dir ARG
       --persist-dir=ARG
       --no-persist-dir
	   Where to find persistence files.

       --persist-file ARG
       --persist-file=ARG
       --pfile ARG
       --pfile=ARG
       --no-persist-file
	   Where to find the persistence file. The default is
	   /{system-tempdir}/project-yath-persist.json.	If no project is
	   specified then it will fall back to the current directory. If the
	   current directory is	not writable it	will default to
	   /tmp/yath-persist.json which	limits you to one persistent runner on
	   your	system.

       --project ARG
       --project=ARG
       --project-name ARG
       --project-name=ARG
       --no-project
	   This	lets you provide a label for your current project/codebase.
	   This	is best	used in	a .yath.rc file. This is necessary for a
	   persistent runner.

       Help and	Debugging

       --show-opts
       --no-show-opts
	   Exit	after showing what yath	thinks your options mean

       --version
       -V
       --no-version
	   Exit	after showing a	helpful	usage message

       Plugins

       --no-scan-plugins
       --no-no-scan-plugins
	   Normally yath scans for and loads all App::Yath::Plugin::* modules
	   in order to bring in	command-line options they may provide. This
	   flag	will disable that. This	is useful if you have a	naughty	plugin
	   that	it loading other modules when it should	not.

       --plugins PLUGIN
       --plugins +App::Yath::Plugin::PLUGIN
       --plugins PLUGIN=arg1,arg2,...
       --plugin	PLUGIN
       --plugin	+App::Yath::Plugin::PLUGIN
       --plugin	PLUGIN=arg1,arg2,...
       -pPLUGIN
       --no-plugins
	   Load	a yath plugin.

	   Can be specified multiple times

   COMMAND OPTIONS
       Git Options

       --git-change-base master
       --git-change-base HEAD^
       --git-change-base df22abe4
       --no-git-change-base
	   Find	files changed by all commits in	the current branch from	most
	   recent stopping when	a commit is found that is also present in the
	   history of the branch/commit	specified as the change	base.

       Help and	Debugging

       --dummy
       -d
       --no-dummy
	   Dummy run, do not actually execute anything

	   Can also be set with	the following environment variables:
	   "T2_HARNESS_DUMMY"

       --help
       -h
       --no-help
	   exit	after showing help information

       --keep-dirs
       --keep_dir
       -k
       --no-keep-dirs
	   Do not delete directories when done.	This is	useful if you want to
	   inspect the directories used	for various commands.

       YathUI Options

       --yathui-api-key	ARG
       --yathui-api-key=ARG
       --no-yathui-api-key
	   Yath-UI API key. This is not	necessary if your Yath-UI instance is
	   set to single-user

       --yathui-grace
       --no-yathui-grace
	   If yath cannot connect to yath-ui it	normally throws	an error, use
	   this	to make	it fail	gracefully. You	get a warning, but things keep
	   going.

       --yathui-long-duration 10
       --no-yathui-long-duration
	   Minimum duration length (seconds) before a test goes	from MEDIUM to
	   LONG

       --yathui-medium-duration	5
       --no-yathui-medium-duration
	   Minimum duration length (seconds) before a test goes	from SHORT to
	   MEDIUM

       --yathui-mode summary
       --yathui-mode qvf
       --yathui-mode qvfd
       --yathui-mode complete
       --no-yathui-mode
	   Set the upload mode (default	'qvfd')

       --yathui-project	ARG
       --yathui-project=ARG
       --no-yathui-project
	   The Yath-UI project for your	test results

       --yathui-retry
       --no-yathui-retry
	   How many times to try an operation before giving up

	   Can be specified multiple times

       --yathui-url http://my-yath-ui.com/...
       --uri http://my-yath-ui.com/...
       --no-yathui-url
	   Yath-UI url

       spawn options

       --copy-env HOME
       --copy-env SHELL
       --copy-env /PERL_.*/i
       -e HOME
       -e SHELL
       -e /PERL_.*/i
       --no-copy-env
	   Specify environment variables to pass along with their current
	   values, can also use	a regex

	   Can be specified multiple times

       --env-var VAR=VAL
       -EVAR=VAL
       -E VAR=VAL
       --no-env-var
	   Set environment variables for the spawn

	   Can be specified multiple times

       --stage foo
       -s foo
       --no-stage
	   Specify the stage to	be used	for launching the script

SOURCE
       The source code repository for Test2-Harness can	be found at
       http://github.com/Test-More/Test2-Harness/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2020 Chad Granum <exodist7@gmail.com>.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       See http://dev.perl.org/licenses/

perl v5.32.1			  2020-11-18	  App::Yath::Command::spawn(3)

NAME | DESCRIPTION | USAGE | SOURCE | MAINTAINERS | AUTHORS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=App::Yath::Command::spawn&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help