FAKE - F# Make - A DSL for build tasks and more FAKE
6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

ProcessUtils Module

Contains functions which can be used to start other tools.

Functions and values

Function or value Description

ProcessUtils.findFile dirs tool

Full Usage: ProcessUtils.findFile dirs tool

Parameters:
    dirs : seq<string> - The directories list
    tool : string - The file name (tool) to search for

Returns: string

Searches the given directories for the given file, failing if not found. Considers PATHEXT on Windows.

dirs : seq<string>

The directories list

tool : string

The file name (tool) to search for

Returns: string

ProcessUtils.findFiles dirs tool

Full Usage: ProcessUtils.findFiles dirs tool

Parameters:
    dirs : seq<string> - The directories list
    tool : string - The file name (tool) to search for

Returns: seq<string>

Searches the given directories for all occurrences of the given file name, on windows PATHEXT is considered (and preferred when searching)

dirs : seq<string>

The directories list

tool : string

The file name (tool) to search for

Returns: seq<string>

ProcessUtils.findFilesOnPath tool

Full Usage: ProcessUtils.findFilesOnPath tool

Parameters:
    tool : string - The file name (tool) to search for

Returns: seq<string>

Searches the current directory and in PATH for the given file and returns the result ordered by precedence. Considers PATHEXT on Windows.

tool : string

The file name (tool) to search for

Returns: seq<string>

ProcessUtils.findLocalTool envVar tool recursiveDirs

Full Usage: ProcessUtils.findLocalTool envVar tool recursiveDirs

Parameters:
    envVar : string - The environment variable name
    tool : string - The file name (tool) to search for
    recursiveDirs : seq<string> - The list of directories to use

Returns: string

Like tryFindLocalTool but returns the tool string if nothing is found (will probably error later, but this function is OK to be used for fake default values.

envVar : string

The environment variable name

tool : string

The file name (tool) to search for

recursiveDirs : seq<string>

The list of directories to use

Returns: string

ProcessUtils.findPath fallbackValue tool

Full Usage: ProcessUtils.findPath fallbackValue tool

Parameters:
    fallbackValue : seq<string>
    tool : string

Returns: string

Tries to find the tool via Env-Var. If no path has the right tool we are trying the PATH system variable. Considers PATHEXT on Windows.

fallbackValue : seq<string>
tool : string
Returns: string

ProcessUtils.tryFindFile dirs tool

Full Usage: ProcessUtils.tryFindFile dirs tool

Parameters:
    dirs : seq<string> - The directories list
    tool : string - The file name (tool) to search for

Returns: string option

Searches the given directories for all occurrences of the given file name. Considers PATHEXT on Windows.

dirs : seq<string>

The directories list

tool : string

The file name (tool) to search for

Returns: string option

ProcessUtils.tryFindFileOnPath tool

Full Usage: ProcessUtils.tryFindFileOnPath tool

Parameters:
    tool : string

Returns: string option

Searches the current directory and the directories within the PATH environment variable for the given file. If successful returns the full path to the file. Considers PATHEXT on Windows.

tool : string
Returns: string option

ProcessUtils.tryFindLocalTool envVar tool recursiveDirs

Full Usage: ProcessUtils.tryFindLocalTool envVar tool recursiveDirs

Parameters:
    envVar : string - The environment variable name
    tool : string - The file name (tool) to search for
    recursiveDirs : seq<string> - The list of directories to use

Returns: string option

Find a local tool in the given envar the given directories, the current directory or PATH (in this order) Recommended usage tryFindLocalTool "TOOL" "tool" [ "." ]

envVar : string

The environment variable name

tool : string

The file name (tool) to search for

recursiveDirs : seq<string>

The list of directories to use

Returns: string option

ProcessUtils.tryFindPath additionalDirs tool

Full Usage: ProcessUtils.tryFindPath additionalDirs tool

Parameters:
    additionalDirs : seq<string> - The list of directories to consider in search
    tool : string - The file name (tool) to search for

Returns: string option

Tries to find the tool via given directories. If no path has the right tool we are trying the current directory and the PATH system variable. Considers PATHEXT on Windows.

additionalDirs : seq<string>

The list of directories to consider in search

tool : string

The file name (tool) to search for

Returns: string option

ProcessUtils.tryFindTool envVar tool

Full Usage: ProcessUtils.tryFindTool envVar tool

Parameters:
    envVar : string - The environment variable name
    tool : string - The file name (tool) to search for

Returns: string option

Tries to find the tool via Env-Var. If no path has the right tool we are trying the PATH system variable. Considers PATHEXT on Windows.

envVar : string

The environment variable name

tool : string

The file name (tool) to search for

Returns: string option