<p4sync>

[This is preliminary documentation and subject to change.]

Synchronize client space to a Perforce depot view.

Parameters

Attribute	Type	Description	Required
force	bool	Force a refresh of files. The default is false.	False
label	string	Label to sync client to; optional.	False
client	string	The p4 client spec to use. The default is the current client.	False
failonerror	bool	Determines if task failure stops the build, or is just reported. The default is true.	False
if	bool	If true then the task will be executed; otherwise, skipped. The default is true.	False
port	string	The p4 server and port to connect to. The default is "perforce:1666".	False
script	bool	Prepends a descriptive field (for example, text:, info:, error:, exit:) to each line of output produced by a Perforce command. This is most often used when scripting. The default is false.	False
timeout	int	The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.	False
unless	bool	Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false.	False
user	string	The p4 username. The default is the current user.	False
verbose	bool	Determines whether the task should report detailed build log messages. The default is false.	False
view	string	The client, branch or label view to operate upon. The default is "//...".	False

Framework-configurable parameters

Attribute	Type	Description	Required
useruntimeengine	bool	Specifies whether the external program should be executed using a runtime engine, if configured. The default is false.	False

Nested Elements:

<arg>

The command-line arguments for the external program.

Represents a command-line argument.

Parameters

Attribute	Type	Description	Required
file	file	The name of a file as a single command-line argument; will be replaced with the absolute filename of the file.	False
if	bool	Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true.	False
line	string	List of command-line arguments; will be passed to the executable as is.	False
path	<path>	The value for a PATH-like command-line argument; you can use `:` or `;` as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables.	False
unless	bool	Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false.	False
value	string	A single command-line argument; can contain space characters.	False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

A single command-line argument containing a space character.
```
<arg value="-l -a" />
    
```
Two separate command-line arguments.
```
<arg line="-l -a" />
    
```
A single command-line argument with the value \dir;\dir2;\dir3 on DOS-based systems and /dir:/dir2:/dir3 on Unix-like systems.
```
<arg path="/dir;/dir2:\dir3" />
    
```

</arg>

Examples

Sync to head using P4USER, P4PORT and P4CLIENT settings specified.

<p4Sync 
    view="//projects/foo/main/source/..."
    user="fbloggs"
    port="km01:1666"
    client="fbloggsclient"
/>

Sync to head using default p4 environment variables.

<p4sync view="//projects/foo/main/source/..." />

Force a re-sync to head, refreshing all files.

<p4sync force="true" view="//projects/foo/main/source/..." />

Sync to a label.
```
<p4sync label="myPerforceLabel" />
    
```

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1932.0)