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

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

v5.fake.build

Arguments Module

Module for working with an `Arguments` instance

Functions and values

Function or value Description

append s a

Full Usage: append s a

Parameters:
Returns: Arguments

Append all arguments after the current arguments

s : seq<string>
a : Arguments
Returns: Arguments

appendIf value paramName a

Full Usage: appendIf value paramName a

Parameters:
    value : bool
    paramName : string
    a : Arguments

Returns: Arguments

Append an argument to a command line if a condition is true.

value : bool
paramName : string
a : Arguments
Returns: Arguments

appendNotEmpty paramName paramValue a

Full Usage: appendNotEmpty paramName paramValue a

Parameters:
    paramName : string
    paramValue : string
    a : Arguments

Returns: Arguments

Append an argument prefixed by another if the value is not null or empty

paramName : string
paramValue : string
a : Arguments
Returns: Arguments

appendOption paramName paramValue a

Full Usage: appendOption paramName paramValue a

Parameters:
    paramName : string
    paramValue : string option
    a : Arguments

Returns: Arguments

Append an argument prefixed by another if the value is Some.

paramName : string
paramValue : string option
a : Arguments
Returns: Arguments

appendRaw s a

Full Usage: appendRaw s a

Parameters:
Returns: Arguments

Appends the given raw argument to the command line, you can not use other methods for this to work This method is only required if you NEED quotes WITHIN your argument (some old Microsoft Tools). "raw" methods are not compatible with non-raw methods.

s : string
a : Arguments
Returns: Arguments

appendRawEscaped argPrefix paramValue a

Full Usage: appendRawEscaped argPrefix paramValue a

Parameters:
    argPrefix : string
    paramValue : string
    a : Arguments

Returns: Arguments

Appends the given raw argument to the command line, you can not use other methods for this to work This allows unusal quoting with the given prefix, like /k:"myarg" ("/k:" would be the argPrefix) This method is only required if you NEED quotes WITHIN your argument (some old Microsoft Tools). "raw" methods are not compatible with non-raw methods.

argPrefix : string
paramValue : string
a : Arguments
Returns: Arguments

appendRawEscapedIf b argPrefix paramValue a

Full Usage: appendRawEscapedIf b argPrefix paramValue a

Parameters:
    b : bool
    argPrefix : string
    paramValue : string
    a : Arguments

Returns: Arguments

Append an argument prefixed by another if the value is Some. This method is only required if you NEED quotes WITHIN your argument (some old Microsoft Tools). "raw" methods are not compatible with non-raw methods.

b : bool
argPrefix : string
paramValue : string
a : Arguments
Returns: Arguments

appendRawEscapedNotEmpty argPrefix paramValue a

Full Usage: appendRawEscapedNotEmpty argPrefix paramValue a

Parameters:
    argPrefix : string
    paramValue : string
    a : Arguments

Returns: Arguments

Append an argument prefixed by another if the value is Some. This method is only required if you NEED quotes WITHIN your argument (some old Microsoft Tools). "raw" methods are not compatible with non-raw methods.

argPrefix : string
paramValue : string
a : Arguments
Returns: Arguments

appendRawEscapedOption argPrefix paramValue a

Full Usage: appendRawEscapedOption argPrefix paramValue a

Parameters:
    argPrefix : string
    paramValue : string option
    a : Arguments

Returns: Arguments

Append an argument prefixed by another if the value is Some. This method is only required if you NEED quotes WITHIN your argument (some old Microsoft Tools). "raw" methods are not compatible with non-raw methods.

argPrefix : string
paramValue : string option
a : Arguments
Returns: Arguments

ofList a

Full Usage: ofList a

Parameters:
    a : string list

Returns: Arguments

Create a arguments instance from a list.

a : string list
Returns: Arguments

toArray a

Full Usage: toArray a

Parameters:
Returns: string array

Convert the arguments instance to a string array

a : Arguments
Returns: string array

toLinuxShellCommandLine a

Full Usage: toLinuxShellCommandLine a

Parameters:
Returns: string

Escape the given argument list according to a unix shell (bash)

a : Arguments
Returns: string

toList a

Full Usage: toList a

Parameters:
Returns: string list

Convert the arguments instance to a string list

a : Arguments
Returns: string list

toStartInfo a

Full Usage: toStartInfo a

Parameters:
Returns: string

Create a new command line string which can be used in a ProcessStartInfo object. If given, returns the exact input of `OfWindowsCommandLine` otherwise `ToWindowsCommandLine` (with some special code for `mono`) is used.

a : Arguments
Returns: string

toWindowsCommandLine a

Full Usage: toWindowsCommandLine a

Parameters:
Returns: string

This is the reverse of https://msdn.microsoft.com/en-us/library/17w5ykft.aspx

a : Arguments
Returns: string

withPrefix s a

Full Usage: withPrefix s a

Parameters:
Returns: Arguments

Append the given arguments before all current arguments

s : seq<string>
a : Arguments
Returns: Arguments